histogram Class Reference

Write the volume-weighted histogram of a volScalarField. More...

Inheritance diagram for histogram:
Collaboration diagram for histogram:

Public Member Functions

 TypeName ("histogram")
 Runtime type information. More...
 
 histogram (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 histogram (const histogram &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~histogram ()
 
virtual bool read (const dictionary &)
 Read the histogram data. More...
 
virtual bool execute ()
 Execute, currently does nothing. More...
 
virtual bool write ()
 Calculate the histogram and write. More...
 
void operator= (const histogram &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from fvMeshFunctionObject
 TypeName ("fvMeshFunctionObject")
 Runtime type information. More...
 
 fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
 fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~fvMeshFunctionObject ()
 Destructor. More...
 
void operator= (const fvMeshFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from regionFunctionObject
 TypeName ("regionFunctionObject")
 Runtime type information. More...
 
 regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
 regionFunctionObject (const regionFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~regionFunctionObject ()
 Destructor. More...
 
void operator= (const regionFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from functionObject
 ClassName ("functionObject")
 
virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 
 functionObject (const word &name)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
 functionObject (const functionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool executeAtStart () const
 Return true if the functionObject should be executed at the start. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual scalar timeToNextWrite ()
 Called by Time::adjustTimeStep(). Allows the functionObject to. More...
 
virtual void updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update for changes of mesh. More...
 
void operator= (const functionObject &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &, const dictionary &)
 Select from dictionary, based on its "type" entry. More...
 
- Public Attributes inherited from functionObject
Switch log
 Switch write log to Info. More...
 
Switch executeAtStart_
 Switch write log to Info. More...
 
- Static Public Attributes inherited from functionObject
static bool postProcess
 Global post-processing mode switch. More...
 
- Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool foundObject (const word &fieldName) const
 Find field in the objectRegistry. More...
 
template<class ObjectType >
void cannotFindObject (const word &fieldName)
 Prints a warning message that fieldName cannot be found. More...
 
void cannotFindObject (const word &fieldName)
 Prints a warning message that fieldName cannot be found. More...
 
template<class ObjectType >
const ObjectType & lookupObject (const word &fieldName) const
 Lookup object from the objectRegistry. More...
 
template<class ObjectType >
ObjectType & lookupObjectRef (const word &fieldName)
 Lookup non-const object reference from the objectRegistry. More...
 
template<class ObjectType >
bool store (const tmp< ObjectType > &tfield)
 Store the given field in the objectRegistry. More...
 
template<class ObjectType >
bool store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 Store the given field in the objectRegistry under the given name. More...
 
bool writeObject (const word &fieldName)
 Write field if present in objectRegistry. More...
 
bool clearObject (const word &fieldName)
 Clear field from the objectRegistry if present. More...
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 

Detailed Description

Write the volume-weighted histogram of a volScalarField.

Example:

histogram1
{
    type            histogram;

    libs            ("libfieldFunctionObjects.so");

    field           p;
    nBins           100;
    min             -5;
    max             5;
    setFormat       gnuplot;
}
Usage
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
See also
Foam::functionObject Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::writeFile
Source files

Definition at line 119 of file histogram.H.

Constructor & Destructor Documentation

◆ histogram() [1/2]

histogram ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from Time and dictionary.

Definition at line 72 of file histogram.C.

References Foam::read().

Here is the call graph for this function:

◆ histogram() [2/2]

histogram ( const histogram )
delete

Disallow default bitwise copy construction.

◆ ~histogram()

~histogram ( )
virtual

Definition at line 87 of file histogram.C.

Member Function Documentation

◆ TypeName()

TypeName ( "histogram"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read the histogram data.

Reimplemented from regionFunctionObject.

Definition at line 93 of file histogram.C.

References format(), dictionary::lookup(), dictionary::lookupOrDefault(), and setWriter< Type >::New().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Execute, currently does nothing.

Implements functionObject.

Definition at line 107 of file histogram.C.

◆ write()

bool write ( )
virtual

Calculate the histogram and write.

postProcess overrides the usual writeControl behaviour and forces writing always (used in post-processing mode)

Implements functionObject.

Definition at line 113 of file histogram.C.

References delta, Foam::endl(), field(), forAll, Pstream::listCombineGather(), Log, Foam::mag(), UPstream::master(), IOobject::MUST_READ, Foam::name(), IOobject::name(), Foam::nl, IOobject::NO_WRITE, autoPtr< T >::reset(), Foam::sum(), Foam::type(), autoPtr< T >::valid(), and x.

Here is the call graph for this function:

◆ operator=()

void operator= ( const histogram )
delete

Disallow default bitwise assignment.


The documentation for this class was generated from the following files: