Computes the volume-weighted histogram of an input volScalarField. More...

Inheritance diagram for histogram:

Collaboration diagram for histogram:

Public Member Functions
	TypeName ("histogram")

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

	histogram (const histogram &)=delete

void	operator= (const histogram &)=delete

virtual	~histogram ()=default

virtual bool	read (const dictionary &)

virtual bool	execute ()

virtual bool	write ()

Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)

virtual	~fvMeshFunctionObject ()=default

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)

virtual	~regionFunctionObject ()=default

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)

virtual	~stateFunctionObject ()=default

dictionary &	propertyDict ()

bool	foundProperty (const word &entryName) const

void	clearTrigger ()

label	getTrigger () const

bool	setTrigger (const label triggeri, bool increaseOnly=true)

bool	getDict (const word &entryName, dictionary &dict) const

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getProperty (const word &entryName, Type &value) const

template<class Type >
void	setProperty (const word &entryName, const Type &value)

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)

template<class Type >
void	setResult (const word &entryName, const Type &value)

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const

word	resultType (const word &entryName) const

word	objectResultType (const word &objectName, const word &entryName) const

wordList	objectResultEntries () const

wordList	objectResultEntries (const word &objectName) const

void	writeResultEntries (Ostream &os) const

void	writeResultEntries (const word &objectName, Ostream &os) const

void	writeAllResultEntries (Ostream &os) const

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)

virtual	~timeFunctionObject ()=default

const Time &	time () const

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)

autoPtr< functionObject >	clone () const

virtual	~functionObject ()=default

virtual const word &	type () const =0

const word &	name () const noexcept

bool	useNamePrefix () const noexcept

bool	useNamePrefix (bool on) noexcept

virtual bool	execute (const label subIndex)

virtual bool	end ()

virtual bool	adjustTimeStep ()

virtual bool	filesModified () const

virtual void	updateMesh (const mapPolyMesh &mpm)

virtual void	movePoints (const polyMesh &mesh)

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true)

	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true)

	writeFile (const writeFile &wf)

virtual	~writeFile ()=default

virtual OFstream &	file ()

virtual bool	writeToFile () const

virtual bool	canWriteHeader () const

virtual label	charWidth () const

virtual void	writeCommented (Ostream &os, const string &str) const

virtual void	writeTabbed (Ostream &os, const string &str) const

virtual void	writeHeader (Ostream &os, const string &str) const

virtual void	writeCurrentTime (Ostream &os) const

virtual void	writeBreak (Ostream &os) const

template<class Type >
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)

Public Attributes inherited from functionObject
bool	log

Static Public Attributes inherited from functionObject
static int	debug

static bool	postProcess

static bool	defaultUseNamePrefix

static word	outputPrefix

Static Public Attributes inherited from writeFile
static label	addChars = 8

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete

void	operator= (const fvMeshFunctionObject &)=delete

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const

template<class ObjectType >
bool	foundObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)

bool	writeObject (const word &fieldName)

bool	clearObject (const word &fieldName)

void	clearObjects (const wordList &objNames)

	regionFunctionObject (const regionFunctionObject &)=delete

void	operator= (const regionFunctionObject &)=delete

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const

functionObjects::properties &	stateDict ()

	stateFunctionObject (const stateFunctionObject &)=delete

void	operator= (const stateFunctionObject &)=delete

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)

	timeFunctionObject (const timeFunctionObject &)=delete

void	operator= (const timeFunctionObject &)=delete

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const

Protected Member Functions inherited from writeFile
void	initStream (Ostream &os) const

fileName	baseFileDir () const

fileName	baseTimeDir () const

virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const

virtual autoPtr< OFstream >	createFile (const word &name) const

virtual void	resetFile (const word &name)

Omanip< int >	valueWidth (const label offset=0) const

void	operator= (const writeFile &)=delete

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_

const objectRegistry &	obr_

const objectRegistry *	obrPtr_

Protected Attributes inherited from timeFunctionObject
const Time &	time_

Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_

const fileName	prefix_

word	fileName_

autoPtr< OFstream >	filePtr_

label	writePrecision_

bool	writeToFile_

bool	updateHeader_

bool	writtenHeader_

bool	useUserTime_

scalar	startTime_

Detailed Description

Computes the volume-weighted histogram of an input volScalarField.

Operands:

Operand	Type	Location
`input`	volScalarField	$FOAM_CASE/<time>/<inpField>
`output` file	dat	$FOAM_CASE/postProcessing/<FO>/<time>/<file>
`output` field	-	-

The set written contains two columns, the first the volume averaged values, the second the raw bin count.

Usage

Minimal example by using system/controlDict.functions:

histogram1
{
    // Mandatory entries (unmodifiable)
    type        histogram;
    libs        (fieldFunctionObjects);

    // Mandatory (inherited) entries (runtime modifiable)
    field       p;
    nBins       100;
    setFormat   gnuplot;

    // Optional entries (runtime modifiable)
    max         5;
    min        -5;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`type`	Type name: histogram	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`field`	Name of operand field	word	yes	-
`nBins`	Number of histogram bins	label	yes	-
`setFormat`	Output format	word	yes	-
`max`	Maximum value sampled	scalar	no	fieldMax
`min`	minimum value sampled	scalar	no	0.0

The inherited entries are elaborated in:

Usage by the postProcess utility is not available.

Note: If max is not provided it will use the field's min and max as the bin extremes. If max is provided but not min it will use 0.

See also

Foam::functionObject
Foam::functionObjects::fvMeshFunctionObject
Foam::functionObjects::writeFile
ExtendedCodeGuide::functionObjects::field::histogram

Source files

Definition at line 180 of file histogram.H.

Constructor & Destructor Documentation

◆ histogram() [1/2]

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

Definition at line 76 of file histogram.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ histogram() [2/2]

histogram ( const histogram & )

delete

◆ ~histogram()

virtual ~histogram ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "histogram" )

◆ operator=()

void operator= ( const histogram & )

delete

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from writeFile.

Definition at line 93 of file histogram.C.

References Foam::abort(), dict, Foam::FatalError, FatalErrorInFunction, format(), writer< Type >::New(), regionFunctionObject::read(), and writeFile::read().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Implements functionObject.

Definition at line 119 of file histogram.C.

◆ write()

bool write ( )

virtual

Implements functionObject.

Definition at line 125 of file histogram.C.

References Foam::BitOps::count(), delta, Foam::endl(), field(), forAll, Pstream::listCombineGather(), Log, Foam::mag(), UPstream::master(), Foam::max(), Foam::min(), IOobject::MUST_READ, Foam::name(), Foam::nl, IOobject::NO_WRITE, autoPtr::reset(), Foam::sum(), Foam::type(), autoPtr::valid(), 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/histogram.H
src/functionObjects/field/histogram/histogram.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ histogram() [1/2]

◆ histogram() [2/2]

◆ ~histogram()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ read()

◆ execute()

◆ write()