91aba2db2e
- Avoids the need for the 'OutputFilterFunctionObject' wrapper
- Time-control for execution and writing is now provided by the
'timeControlFunctionObject' which instantiates the processing
'functionObject' and controls its operation.
- Alternative time-control functionObjects can now be written and
selected at run-time without the need to compile wrapped version of
EVERY existing functionObject which would have been required in the
old structure.
- The separation of 'execute' and 'write' functions is now formalized in the
'functionObject' base-class and all derived classes implement the
two functions.
- Unnecessary implementations of functions with appropriate defaults
in the 'functionObject' base-class have been removed reducing
clutter and simplifying implementation of new functionObjects.
- The 'coded' 'functionObject' has also been updated, simplified and tested.
- Further simplification is now possible by creating some general
intermediate classes derived from 'functionObject'.
170 lines
4.4 KiB
C++
170 lines
4.4 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2016 OpenFOAM Foundation
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
License
|
|
This file is part of OpenFOAM.
|
|
|
|
OpenFOAM is free software: you can redistribute it and/or modify it
|
|
under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
Class
|
|
Foam::functionObjects::histogram
|
|
|
|
Group
|
|
grpFieldFunctionObjects
|
|
|
|
Description
|
|
Write the volume-weighted histogram of a volScalarField.
|
|
|
|
Example:
|
|
\verbatim
|
|
histogram1
|
|
{
|
|
type histogram;
|
|
|
|
functionObjectLibs ("libfieldFunctionObjects.so");
|
|
|
|
field p;
|
|
nBins 100;
|
|
min -5;
|
|
max 5;
|
|
setFormat gnuplot;
|
|
}
|
|
\endverbatim
|
|
|
|
\heading Function object usage
|
|
\table
|
|
Property | Description | Required | Default value
|
|
type | type name: histogram | yes |
|
|
field | Field to analyse | yes |
|
|
nBins | Number of bins for the histogram | yes|
|
|
max | Maximum value sampled | yes |
|
|
min | minimum value sampled | no | 0
|
|
setFormat | Output format | yes |
|
|
\endtable
|
|
|
|
SeeAlso
|
|
Foam::functionObject
|
|
Foam::functionObjects::writeFile
|
|
|
|
SourceFiles
|
|
histogram.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef functionObjects_histogram_H
|
|
#define functionObjects_histogram_H
|
|
|
|
#include "writer.H"
|
|
#include "writeFile.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
namespace functionObjects
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class histogram Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class histogram
|
|
:
|
|
public writeFile
|
|
{
|
|
// Private data
|
|
|
|
//- Name of field
|
|
word fieldName_;
|
|
|
|
//- Maximum value
|
|
scalar max_;
|
|
|
|
//- Minimum value
|
|
scalar min_;
|
|
|
|
//- Mumber of bins
|
|
label nBins_;
|
|
|
|
//- Output formatter to write
|
|
autoPtr<writer<scalar>> formatterPtr_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
void writeGraph
|
|
(
|
|
const coordSet& coords,
|
|
const word& valueName,
|
|
const scalarField& values
|
|
) const;
|
|
|
|
//- Disallow default bitwise copy construct
|
|
histogram(const histogram&);
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const histogram&);
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("histogram");
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from Time and dictionary
|
|
histogram
|
|
(
|
|
const word& name,
|
|
const Time& runTime,
|
|
const dictionary& dict
|
|
);
|
|
|
|
|
|
// Destructor
|
|
virtual ~histogram();
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- Read the histogram data
|
|
virtual bool read(const dictionary&);
|
|
|
|
//- Execute, currently does nothing
|
|
virtual bool execute(const bool postProcess = false);
|
|
|
|
//- Calculate the histogram and write.
|
|
// postProcess overrides the usual writeControl behaviour and
|
|
// forces writing always (used in post-processing mode)
|
|
virtual bool write(const bool postProcess = false);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace functionObjects
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|