Histogram model which groups data into bins of equal width. More...

#include <equalBinWidth.H>

Inheritance diagram for equalBinWidth:

Collaboration diagram for equalBinWidth:

Public Member Functions
	TypeName ("equalBinWidth")
	Runtime type information.
	equalBinWidth (const word &name, const fvMesh &mesh, const dictionary &dict)
	Construct from components.
	equalBinWidth (const equalBinWidth &)=delete
	No copy construct.
void	operator= (const equalBinWidth &)=delete
	No copy assignment.
virtual	~equalBinWidth ()=default
virtual bool	read (const dictionary &dict)
	Read the function-object dictionary.
virtual bool	write (const bool log)
	Write data to stream and files.
Public Member Functions inherited from histogramModel
	TypeName ("histogramModel")
	Runtime type information.
	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.
	histogramModel (const histogramModel &)=delete
	No copy construct.
void	operator= (const histogramModel &)=delete
	No copy assignment.
virtual	~histogramModel ()=default
	Destructor.
const fvMesh &	mesh () const noexcept
	Return const reference to the mesh.
const word &	fieldName () const noexcept
	Return const reference to the operand field name.
Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName.
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName and read options from dictionary.
	writeFile (const writeFile &wf)
	Construct copy.
virtual	~writeFile ()=default
	Destructor.
virtual const string &	setExt (const string &ext)
	Set extension.
virtual OFstream &	file ()
	Return access to the file (if only 1).
virtual bool	writeToFile () const
	Flag to allow writing to file.
virtual bool	canWriteToFile () const
	Flag to allow writing to the file.
virtual bool	canResetFile () const
	Flag to allow resetting the file.
virtual bool	canWriteHeader () const
	Flag to allow writing the header.
virtual label	charWidth () const
	Return width of character stream output.
virtual void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream.
virtual void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream.
virtual void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream.
virtual void	writeCurrentTime (Ostream &os) const
	Write the current time to stream.
virtual void	writeBreak (Ostream &os) const
	Write a break marker to the stream.
template<class Type>
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair.
template<class Type>
void	writeValue (Ostream &os, const Type &val) const
	Write a given value to stream with the space delimiter.

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.
Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing.
Protected Member Functions inherited from histogramModel
virtual void	writeFileHeader (Ostream &os)
	Output file header information.
volScalarField &	getOrReadField (const word &fieldName) const
	Return requested field from the object registry or read+register the field to the object registry.
void	write (scalarField &dataNormalised, const labelField &dataCount, const scalarField &magMidBin)
	Write histogram data.
Protected Member Functions inherited from writeFile
void	initStream (Ostream &os) const
	Initialise the output stream for writing.
fileName	baseFileDir () const
	Return the base directory for output.
fileName	baseTimeDir () const
	Return the base directory for the current time value.
fileName	filePath (const fileName &fName) const
	Return the full path for the supplied file name.
virtual autoPtr< OFstream >	newFile (const fileName &fName) const
	Return autoPtr to a new file using file name.
virtual autoPtr< OFstream >	newFileAtTime (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	newFileAtStartTime (const word &name) const
	Return autoPtr to a new file using the simulation start time.
virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name.
Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset.
void	operator= (const writeFile &)=delete
	No copy assignment.
virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Deprecated(2022-09) Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	createFile (const word &name) const
	Deprecated(2022-09) Return autoPtr to a new file using the simulation start time.
Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry.
const fileName	prefix_
	Prefix.
word	fileName_
	Name of file.
autoPtr< OFstream >	filePtr_
	File pointer.
label	writePrecision_
	Write precision.
bool	writeToFile_
	Flag to enable/disable writing to file.
bool	updateHeader_
	Flag to update the header, e.g. on mesh changes. Default is true.
bool	writtenHeader_
	Flag to identify whether the header has been written.
bool	useUserTime_
	Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true.
scalar	startTime_
	Start time value.
string	ext_
	File extension; default = .dat.

Detailed Description

Histogram model which groups data into bins of equal width.

Usage

Minimal example by using system/controlDict.functions:

histogramFO
{
    // 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	-

Note

If max is not provided, histogram will use operand field's min and max as the bin extremes.
If max is provided without min, histogram will use 0 for the min.

Source files

Definition at line 104 of file equalBinWidth.H.

Constructor & Destructor Documentation

◆ equalBinWidth() [1/2]

equalBinWidth	(	const word &	name,
		const fvMesh &	mesh,
		const dictionary &	dict )

Construct from components.

Definition at line 40 of file equalBinWidth.C.

References dict, histogramModel::histogramModel(), histogramModel::mesh(), Foam::name(), and read().

Referenced by equalBinWidth(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ equalBinWidth() [2/2]

equalBinWidth ( const equalBinWidth & )

delete

No copy construct.

References equalBinWidth().

Here is the call graph for this function:

◆ ~equalBinWidth()

virtual ~equalBinWidth ( )

virtualdefault

References dict, and Foam::log().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "equalBinWidth" )

Runtime type information.

References dict, histogramModel::mesh(), and Foam::name().

Here is the call graph for this function:

◆ operator=()

void operator= ( const equalBinWidth & )

delete

No copy assignment.

References equalBinWidth().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read the function-object dictionary.

Reimplemented from histogramModel.

Definition at line 57 of file equalBinWidth.C.

References Foam::abort(), dict, Foam::FatalIOError, FatalIOErrorInFunction, and histogramModel::read().

Referenced by equalBinWidth().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

bool write ( const bool log )

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(), histogramModel::fieldName(), forAll, histogramModel::getOrReadField(), MinMax< T >::good(), Foam::Info, Pstream::listGather(), Foam::log(), Foam::mag(), Foam::max(), MinMax< T >::max(), mesh, Foam::min(), MinMax< T >::min(), p, MinMax< T >::span(), histogramModel::write(), x, and Foam::Zero.

Here is the call graph for this function:

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

src/functionObjects/field/histogram/histogramModels/equalBinWidth/equalBinWidth.H
src/functionObjects/field/histogram/histogramModels/equalBinWidth/equalBinWidth.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ equalBinWidth() [1/2]

◆ equalBinWidth() [2/2]

◆ ~equalBinWidth()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ read()

◆ write()