Write the volume-weighted histogram of a volScalarField. More...
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... | |
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... | |
Public Member Functions inherited from writeFile | |
writeFile (const word &name, const Time &t, const dictionary &dict, const word &prefix) | |
Construct from name, Time, dictionary and prefix. More... | |
writeFile (const word &name, const objectRegistry &obr, const dictionary &dict, const word &prefix) | |
Construct from name, objectRegistry, dictionary and prefix. More... | |
virtual | ~writeFile () |
Destructor. More... | |
void | writeCommented (Ostream &os, const string &str) const |
Write a commented string to stream. More... | |
void | writeTabbed (Ostream &os, const string &str) const |
Write a tabbed string to stream. More... | |
void | writeHeader (Ostream &os, const string &str) const |
Write a commented header to stream. More... | |
void | writeTime (Ostream &os) const |
Write the current time to stream. More... | |
template<class Type > | |
void | writeHeaderValue (Ostream &os, const string &property, const Type &value) const |
Write a (commented) header property and value pair. More... | |
label | charWidth () const |
Return width of character stream output. 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... | |
virtual | ~regionFunctionObject () |
Destructor. More... | |
Public Member Functions inherited from functionObject | |
virtual const word & | type () 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< functionObject > | clone () const |
Return clone. More... | |
virtual | ~functionObject () |
Destructor. More... | |
const word & | name () const |
Return the name of this functionObject. More... | |
virtual bool | end () |
Called when Time::run() determines that the time-loop exits. More... | |
virtual bool | adjustTimeStep () |
Called at the end of Time::adjustDeltaT() if adjustTime is true. 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... | |
Additional Inherited Members | |
Static Public Member Functions inherited from functionObject | |
static autoPtr< functionObject > | New (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... | |
Static Public Attributes inherited from writeFile | |
static const word | outputPrefix |
Directory prefix. More... | |
static label | addChars = 7 |
Additional characters for writing. More... | |
Static Public Attributes inherited from functionObject | |
static int | debug |
static bool | postProcess |
Global post-processing mode switch. More... | |
Protected Member Functions inherited from writeFile | |
virtual void | initStream (Ostream &os) const |
Initialise the output stream for writing. More... | |
virtual fileName | baseFileDir () const |
Return the base directory for output. More... | |
virtual fileName | baseTimeDir () const |
Return the base directory for the current time value. More... | |
virtual void | writeFileHeader (const label i=0) |
File header information. More... | |
virtual Omanip< int > | valueWidth (const label offset=0) const |
Return the value width when writing to stream with optional offset. More... | |
writeFile (const writeFile &) | |
Disallow default bitwise copy construct. More... | |
void | operator= (const writeFile &) |
Disallow default bitwise assignment. 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 > | |
const ObjectType & | lookupObject (const word &fieldName) const |
Lookup field from the objectRegistry. More... | |
template<class ObjectType > | |
bool | store (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 writeFile | |
const word | prefix_ |
Prefix. More... | |
Protected Attributes inherited from regionFunctionObject | |
const Time & | time_ |
Reference to the Time. More... | |
const objectRegistry & | obr_ |
Reference to the region objectRegistry. More... | |
Write the volume-weighted histogram of a volScalarField.
histogram1 { type histogram; libs ("libfieldFunctionObjects.so"); field p; nBins 100; min -5; max 5; setFormat gnuplot; }
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 |
Definition at line 120 of file histogram.H.
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::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::read().
|
virtual |
Definition at line 92 of file histogram.C.
TypeName | ( | "histogram" | ) |
Runtime type information.
|
virtual |
Read the histogram data.
Reimplemented from regionFunctionObject.
Definition at line 98 of file histogram.C.
References format(), dictionary::lookup(), dictionary::lookupOrDefault(), and writer< Type >::New().
|
virtual |
Execute, currently does nothing.
Implements functionObject.
Definition at line 112 of file histogram.C.
|
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 118 of file histogram.C.
References delta, Foam::endl(), forAll, Pstream::listCombineGather(), Log, Foam::mag(), UPstream::master(), mesh, IOobject::MUST_READ, Foam::name(), IOobject::name(), Foam::nl, IOobject::NO_WRITE, Foam::sum(), fvMesh::time(), Time::timeName(), Foam::type(), fvMesh::V(), and x.