Histogram model which groups data into bins of equal width. More...
Public Member Functions | |
TypeName ("equalBinWidth") | |
Runtime type information. More... | |
equalBinWidth (const word &name, const fvMesh &mesh, const dictionary &dict) | |
Construct from components. More... | |
equalBinWidth (const equalBinWidth &)=delete | |
No copy construct. More... | |
void | operator= (const equalBinWidth &)=delete |
No copy assignment. More... | |
virtual | ~equalBinWidth ()=default |
virtual bool | read (const dictionary &dict) |
Read top-level dictionary. More... | |
virtual bool | write (const bool log) |
Write data to stream and files. More... | |
Public Member Functions inherited from histogramModel | |
TypeName ("histogramModel") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, histogramModel, dictionary,(const word &name, const fvMesh &mesh, const dictionary &dict),(name, mesh, dict)) | |
histogramModel (const word &name, const fvMesh &mesh, const dictionary &dict) | |
Construct from components. More... | |
histogramModel (const histogramModel &)=delete | |
No copy construct. More... | |
void | operator= (const histogramModel &)=delete |
No copy assignment. More... | |
virtual | ~histogramModel ()=default |
Destructor. More... | |
const fvMesh & | mesh () const noexcept |
Return const reference to the mesh. More... | |
const word & | fieldName () const noexcept |
Return const reference to the operand field name. More... | |
Public Member Functions inherited from writeFile | |
writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true) | |
Construct from objectRegistry, prefix, fileName. More... | |
writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true) | |
Construct from objectRegistry, prefix, fileName and read options from dictionary. More... | |
writeFile (const writeFile &wf) | |
Construct copy. More... | |
virtual | ~writeFile ()=default |
Destructor. More... | |
virtual OFstream & | file () |
Return access to the file (if only 1) More... | |
virtual bool | writeToFile () const |
Flag to allow writing to file. More... | |
virtual bool | canWriteToFile () const |
Flag to allow writing to the file. More... | |
virtual bool | canResetFile () const |
Flag to allow resetting the file. More... | |
virtual bool | canWriteHeader () const |
Flag to allow writing the header. More... | |
virtual label | charWidth () const |
Return width of character stream output. More... | |
virtual void | writeCommented (Ostream &os, const string &str) const |
Write a commented string to stream. More... | |
virtual void | writeTabbed (Ostream &os, const string &str) const |
Write a tabbed string to stream. More... | |
virtual void | writeHeader (Ostream &os, const string &str) const |
Write a commented header to stream. More... | |
virtual void | writeCurrentTime (Ostream &os) const |
Write the current time to stream. More... | |
virtual void | writeBreak (Ostream &os) const |
Write a break marker to the 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... | |
template<class Type > | |
void | writeValue (Ostream &os, const Type &val) const |
Write a given value to stream with the space delimiter. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from histogramModel | |
static autoPtr< histogramModel > | New (const word &name, const fvMesh &mesh, const dictionary &dict) |
Return a reference to the selected histogram model. More... | |
Static Public Attributes inherited from writeFile | |
static label | addChars = 8 |
Additional characters for writing. More... | |
Protected Member Functions inherited from histogramModel | |
virtual void | writeFileHeader (Ostream &os) |
Output file header information. More... | |
volScalarField & | getOrReadField (const word &fieldName) const |
Return requested field from the object registry or read+register the field to the object registry. More... | |
void | write (scalarField &dataNormalised, const labelField &dataCount, const scalarField &magMidBin) |
Write histogram data. More... | |
Protected Member Functions inherited from writeFile | |
void | initStream (Ostream &os) const |
Initialise the output stream for writing. More... | |
fileName | baseFileDir () const |
Return the base directory for output. More... | |
fileName | baseTimeDir () const |
Return the base directory for the current time value. More... | |
fileName | filePath (const fileName &fName) const |
Return the full path for the supplied file name. More... | |
virtual autoPtr< OFstream > | newFile (const fileName &fName) const |
Return autoPtr to a new file using file name. More... | |
virtual autoPtr< OFstream > | newFileAtTime (const word &name, scalar timeValue) const |
Return autoPtr to a new file for a given time. More... | |
virtual autoPtr< OFstream > | newFileAtStartTime (const word &name) const |
Return autoPtr to a new file using the simulation start time. More... | |
virtual void | resetFile (const word &name) |
Reset internal file pointer to new file with new name. More... | |
Omanip< int > | valueWidth (const label offset=0) const |
Return the value width when writing to stream with optional offset. More... | |
void | operator= (const writeFile &)=delete |
No copy assignment. More... | |
virtual autoPtr< OFstream > | createFile (const word &name, scalar timeValue) const |
Deprecated(2022-09) Return autoPtr to a new file for a given time. More... | |
virtual autoPtr< OFstream > | createFile (const word &name) const |
Deprecated(2022-09) Return autoPtr to a new file using the simulation start time. More... | |
Protected Attributes inherited from writeFile | |
const objectRegistry & | fileObr_ |
Reference to the region objectRegistry. More... | |
const fileName | prefix_ |
Prefix. More... | |
word | fileName_ |
Name of file. More... | |
autoPtr< OFstream > | filePtr_ |
File pointer. More... | |
label | writePrecision_ |
Write precision. More... | |
bool | writeToFile_ |
Flag to enable/disable writing to file. More... | |
bool | updateHeader_ |
Flag to update the header, e.g. on mesh changes. Default is true. More... | |
bool | writtenHeader_ |
Flag to identify whether the header has been written. More... | |
bool | useUserTime_ |
Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true. More... | |
scalar | startTime_ |
Start time value. More... | |
Histogram model which groups data into bins of equal width.
system/controlDict.functions
: histogram1 { // Inherited entries ... // Mandatory entries nBins <label>; // Optional entries min <scalar>; max <scalar>; }
where the entries mean:
Property | Description | Type | Reqd | Deflt |
---|---|---|---|---|
nBins | Number of histogram bins | label | yes | - |
min | Minimum value of histogram data | scalar | no | - |
max | Maximum value of histogram data | scalar | no | - |
max
is not provided, histogram
will use operand field's min and max as the bin extremes.max
is provided without min
, histogram
will use 0 for the min
.Definition at line 104 of file equalBinWidth.H.
equalBinWidth | ( | const word & | name, |
const fvMesh & | mesh, | ||
const dictionary & | dict | ||
) |
Construct from components.
Definition at line 41 of file equalBinWidth.C.
References dict, and Foam::blockMeshTools::read().
|
delete |
No copy construct.
|
virtualdefault |
TypeName | ( | "equalBinWidth" | ) |
Runtime type information.
|
delete |
No copy assignment.
|
virtual |
Read top-level dictionary.
Reimplemented from histogramModel.
Definition at line 57 of file equalBinWidth.C.
References Foam::abort(), dict, Foam::FatalIOError, FatalIOErrorInFunction, histogramModel::read(), and MinMax< T >::reset().
|
virtual |
Write data to stream and files.
Implements histogramModel.
Definition at line 84 of file equalBinWidth.C.
References delta, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, field(), forAll, histogramModel::getOrReadField(), MinMax< T >::good(), Foam::Info, Pstream::listCombineGather(), Foam::log(), Foam::mag(), MinMax< T >::max(), Foam::max(), mesh, MinMax< T >::min(), Foam::min(), p, MinMax< T >::span(), histogramModel::write(), x, and Foam::Zero.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.