Provides a 'volRegion' specialization of the fieldValue function object. More...

#include <volFieldValue.H>

Inheritance diagram for volFieldValue:

[legend]

Collaboration diagram for volFieldValue:

[legend]

Public Types
enum	operationType { opNone = 0 , opMin , opMax , opSum , opSumMag , opAverage , opVolAverage , opVolIntegrate , opCoV , typeScalar = 0x100 , typeWeighted = 0x200 , opWeightedSum = (opSum \| typeWeighted) , opWeightedAverage = (opAverage \| typeWeighted) , opWeightedVolAverage = (opVolAverage \| typeWeighted) , opWeightedVolIntegrate = (opVolIntegrate \| typeWeighted) , typeAbsolute = 0x400 }
	Operation type enumeration. More...
enum	postOperationType { postOpNone , postOpMag , postOpSqrt }
	Post-operation type enumeration. More...
Public Types inherited from volRegion
enum	regionTypes : char { vrtAll = 0 , vrtCellSet , vrtCellZone }
	Region type enumeration. More...

Public Member Functions
	TypeName ("volFieldValue")
	Declare type-name, virtual type (with debug switch).
	volFieldValue (const word &name, const Time &runTime, const dictionary &dict)
	Construct from name, Time and dictionary.
	volFieldValue (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from name, objectRegistry and dictionary.
	volFieldValue (const volFieldValue &)=delete
	No copy construct.
void	operator= (const volFieldValue &)=delete
	No copy assignment.
virtual	~volFieldValue ()=default
	Destructor.
virtual bool	read (const dictionary &dict)
	Read the function-object dictionary.
virtual bool	write ()
	Write the function-object results.
template<class Type>
Foam::tmp< Foam::Field< Type > >	getFieldValues (const word &fieldName, const bool mandatory) const
template<class Type>
Foam::tmp< Foam::Field< Type > >	filterField (const Field< Type > &field) const
Public Member Functions inherited from fieldValue
	TypeName ("fieldValue")
	Run-time type information.
	declareRunTimeSelectionTable (autoPtr, fieldValue, runTime,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
	fieldValue (const word &name, const Time &runTime, const dictionary &dict, const word &valueType)
	Construct from name, Time and dictionary.
	fieldValue (const word &name, const objectRegistry &obr, const dictionary &dict, const word &valueType)
	Construct from objectRegistry and dictionary.
virtual	~fieldValue ()=default
	Destructor.
const dictionary &	dict () const noexcept
	Return the reference to the construction dictionary.
const word &	regionName () const noexcept
	Return the region name.
const wordList &	fields () const noexcept
	Return the list of field names.
bool	writeFields () const noexcept
	Return the output field values flag.
virtual bool	execute ()
	Execute the function-object operations.
Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information.
	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary.
	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary.
virtual	~fvMeshFunctionObject ()=default
	Destructor.
Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information.
	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary.
	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary.
virtual	~regionFunctionObject ()=default
	Destructor.
template<class ObjectType>
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10).
template<class ObjectType>
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10).
Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components.
virtual	~stateFunctionObject ()=default
	Destructor.
dictionary &	propertyDict ()
	Return access to the property dictionary.
bool	foundProperty (const word &entryName) const
	Return true if the property exists.
void	clearTrigger ()
	Remove the trigger index from the properties.
label	getTrigger () const
	Get the current trigger index.
bool	setTrigger (const label triggeri)
	Set new trigger index.
bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set.
bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set.
template<class Type>
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property.
template<class Type>
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set.
template<class Type>
void	setProperty (const word &entryName, const Type &value)
	Add generic property.
template<class Type>
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object.
template<class Type>
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set.
template<class Type>
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object.
bool	getObjectResultDict (const word &objectName, dictionary &dict) const
template<class Type>
void	setResult (const word &entryName, const Type &value)
	Add result.
template<class Type>
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object.
template<class Type>
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result.
template<class Type>
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object.
template<class Type>
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set.
word	resultType (const word &entryName) const
	Retrieve the result type.
word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result.
wordList	objectResultEntries () const
	Retrieve the result entries.
wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object.
void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream.
void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream.
void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream.
Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time.
virtual	~timeFunctionObject ()=default
	Destructor.
const Time &	time () const
	Return time database.
objectRegistry &	storedObjects ()
	Write access to the output objects ("functionObjectObjects") registered on Time.
const objectRegistry &	storedObjects () const
	Const access to the output objects ("functionObjectObjects") registered on Time.
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)
	Construct from components.
autoPtr< functionObject >	clone () const
	Return clone.
virtual	~functionObject ()=default
	Destructor.
virtual const word &	type () const =0
	Runtime type information.
const word &	name () const noexcept
	Return the name of this functionObject.
bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix.
bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix.
virtual bool	execute (const label subIndex)
	Execute using the specified subIndex.
virtual bool	end ()
	Called when Time::run() determines that the time-loop exits.
virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual bool	filesModified () const
	Did any file get changed during execution?
virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh.
virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh.
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.
Public Member Functions inherited from volRegion
	TypeName ("volRegion")
	Run-time type information.
	volRegion (const fvMesh &mesh, const dictionary &dict)
	Construct from fvMesh and dictionary.
virtual	~volRegion ()=default
	Destructor.
regionTypes	regionType () const noexcept
	The region type.
const labelList &	cellIDs () const
	Return the local list of cell IDs.
label	nCells () const
	Return the total number of cells selected in the region.
scalar	V () const
	Return total volume of the selected region.
bool	update ()
	Update the cached values as required.
virtual void	updateMesh (const mapPolyMesh &)
	Update for changes of mesh.
virtual void	movePoints (const polyMesh &)
	Update for mesh point-motion.

Static Public Attributes
static const Enum< operationType >	operationTypeNames_
	Operation type names.
static const Enum< postOperationType >	postOperationTypeNames_
	Operation type names.
Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content.
static bool	postProcess
	Global post-processing mode switch.
static bool	defaultUseNamePrefix
	Global default for useNamePrefix.
static word	outputPrefix
	Directory prefix.
Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing.
Static Public Attributes inherited from volRegion
static const Enum< regionTypes >	regionTypeNames_
	Region type names.

Protected Member Functions
bool	usesVol () const noexcept
	True if the operation needs the cell-volume.
bool	is_magOp () const noexcept
	True if the operation variant uses mag.
bool	is_weightedOp () const noexcept
	True if the operation variant uses a weight-field.
bool	canWeight (const scalarField &fld) const
	True if field is non-empty on any processor.
template<class Type>
bool	validField (const word &fieldName) const
	Return true if the field name is valid.
template<class Type>
tmp< Field< Type > >	getFieldValues (const word &fieldName, const bool mandatory=false) const
	Insert field values into values list.
template<class Type>
Type	processValues (const Field< Type > &values, const scalarField &V, const scalarField &weightField) const
	Apply the 'operation' to the values.
label	writeAll (const scalarField &V, const scalarField &weightField)
	Helper function to output field values.
template<class Type>
bool	writeValues (const word &fieldName, const scalarField &V, const scalarField &weightField)
	Templated helper function to output field values.
template<class Type>
tmp< Field< Type > >	filterField (const Field< Type > &field) const
	Filter a field according to cellIds.
virtual void	writeFileHeader (Ostream &os) const
	Output file header information.
Protected Member Functions inherited from fieldValue
template<class Type>
void	combineFields (Field< Type > &field)
	Combine fields from all processor domains into single field.
template<class Type>
void	combineFields (tmp< Field< Type > > &)
	Combine fields from all processor domains into single field.
Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct.
void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used.
template<class ObjectType>
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType *	cfindObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType *	findObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
ObjectType *	findObject (const word &fieldName)
	Return non-const pointer to the object of the given Type, (sub) objectRegistry.
template<class ObjectType>
ObjectType *	getObjectPtr (const word &fieldName) const
	Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable.
template<class ObjectType>
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry.
template<class ObjectType>
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry.
template<class ObjectType>
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the field in the (sub) objectRegistry under the given name.
template<class ObjectType>
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
	Store the field in an optional objectRegistry under the given name.
bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry.
bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present.
void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present.
	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct.
void	operator= (const regionFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary.
functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary.
	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct.
void	operator= (const stateFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects".
	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct.
void	operator= (const timeFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name.
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 Member Functions inherited from volRegion
bool	useAllCells () const noexcept
	Use all cells, not the cellIDs.
void	writeFileHeader (const writeFile &wf, Ostream &file) const
	Output file header information.

Protected Attributes
operationType	operation_
	Operation to apply to values.
postOperationType	postOperation_
	Optional post-evaluation operation.
wordList	weightFieldNames_
	Weight field name(s) - optional.
Protected Attributes inherited from fieldValue
bool	writeFields_
	Flag to output field values.
word	regionName_
	Name of region (patch, zone, etc.).
scalar	scaleFactor_
	Scaling factor.
dictionary	dict_
	Construction dictionary.
wordList	fields_
	Names of operand fields.
Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh.
Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry.
const objectRegistry &	obr_
	Reference to the region objectRegistry.
const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry.
Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database.
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.
Protected Attributes inherited from volRegion
regionTypes	regionType_
	Region type.
wordRe	regionName_
	Region name (cellSet, cellZone, ...).

Additional Inherited Members
Static Public Member Functions inherited from fieldValue
static autoPtr< fieldValue >	New (const word &name, const Time &runTime, const dictionary &dict, const bool output=true)
	Return a reference to the selected fieldValue.
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
	Select from dictionary, based on its "type" entry.
Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info.

Detailed Description

Provides a 'volRegion' specialization of the fieldValue function object.

Given a list of user-specified fields and a 'volRegion', a number of operations can be performed, such as sums, averages and integrations.

Usage

Minimal example by using system/controlDict.functions:

volFieldValueFO
{
    // Mandatory entries
    type            volFieldValue;
    libs            (fieldFunctionObjects);
    fields          <wordList>;  // (<field1> <field2> ... <fieldN>);
    regionType      <word>;
    operation       <word>;

    // Optional entries
    postOperation   <word>;
    weightField     <word>;  // alpha1;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: volFieldValue	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`fields`	Names of operand fields	wordList	yes	-
`regionType`	Face regionType: see below	word	yes	-
`operation`	Operation type: see below	word	yes	-
`postOperation`	Post-operation type: see below	word	no	none
`weightField`	Name of field to apply weighting	word	maybe
`weightFields`	Names of fields to apply weighting	wordList	maybe

The inherited entries are elaborated in:

Options for the regionType entry:

cellZone	:	requires a 'name' entry to specify the cellZone
all	:	all cells

Options for the operation entry:

none	:	No operation
min	:	Minimum
max	:	Maximum
sum	:	Sum
sumMag	:	Sum of component magnitudes
average	:	Ensemble average
volAverage	:	Volume weighted average
volIntegrate	:	Volume integral
CoV	:	Coefficient of variation: standard deviation/mean
weightedSum	:	Weighted sum
weightedAverage	:	Weighted average
weightedVolAverage	:	Weighted volume average
weightedVolIntegrate	:	Weighted volume integral

Options for the postOperation entry:

none	:	No additional operation after calculation
mag	:	Component-wise `mag()` after normal operation
sqrt	:	Component-wise `sqrt()` after normal operation

Source files

Definition at line 253 of file volFieldValue.H.

Member Enumeration Documentation

◆ operationType

enum operationType

Operation type enumeration.

Enumerator
opNone	No operation.
opMin	Minimum value.
opMax	Maximum value.
opSum	Sum of values.
opSumMag	Sum of component magnitudes.
opAverage	Ensemble average.
opVolAverage	Volume average.
opVolIntegrate	Volume integral.
opCoV	Coefficient of variation.
typeScalar
typeWeighted
opWeightedSum	Weighted sum.
opWeightedAverage	Weighted average.
opWeightedVolAverage	Weighted volume average.
opWeightedVolIntegrate	Weighted volume integral.
typeAbsolute

Definition at line 265 of file volFieldValue.H.

◆ postOperationType

enum postOperationType

Post-operation type enumeration.

Enumerator
postOpNone	No additional operation after calculation.
postOpMag	Component-wise mag after normal operation.
postOpSqrt	Component-wise sqrt after normal operation.

Definition at line 312 of file volFieldValue.H.

Constructor & Destructor Documentation

◆ volFieldValue() [1/3]

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

Construct from name, Time and dictionary.

Definition at line 166 of file volFieldValue.C.

References fieldValue::dict(), fieldValue::fieldValue(), writeFile::file(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, fvMeshFunctionObject::mesh_, functionObject::name(), operation_, operationTypeNames_, postOperation_, postOperationTypeNames_, postOpNone, read(), runTime, volRegion::volRegion(), weightFieldNames_, and writeFileHeader().

Referenced by operator=(), TypeName(), volFieldValue(), and ~volFieldValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ volFieldValue() [2/3]

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

Construct from name, objectRegistry and dictionary.

Definition at line 193 of file volFieldValue.C.

References fieldValue::dict(), fieldValue::fieldValue(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, fvMeshFunctionObject::mesh_, functionObject::name(), regionFunctionObject::obr(), operation_, operationTypeNames_, postOperation_, postOperationTypeNames_, postOpNone, read(), volRegion::volRegion(), and weightFieldNames_.

Here is the call graph for this function:

◆ volFieldValue() [3/3]

volFieldValue ( const volFieldValue & )

delete

No copy construct.

References volFieldValue().

Here is the call graph for this function:

◆ ~volFieldValue()

virtual ~volFieldValue ( )

virtualdefault

Destructor.

References fieldValue::dict(), read(), volFieldValue(), and write().

Here is the call graph for this function:

Member Function Documentation

◆ usesVol()

bool usesVol ( ) const

protectednoexcept

True if the operation needs the cell-volume.

Definition at line 80 of file volFieldValue.C.

References Foam::noexcept, opCoV, operation_, opVolAverage, opVolIntegrate, opWeightedVolAverage, and opWeightedVolIntegrate.

Referenced by write().

Here is the caller graph for this function:

◆ is_magOp()

bool is_magOp ( ) const

inlineprotectednoexcept

True if the operation variant uses mag.

Definition at line 23 of file volFieldValueI.H.

References Foam::noexcept, operation_, and typeAbsolute.

◆ is_weightedOp()

bool is_weightedOp ( ) const

inlineprotectednoexcept

True if the operation variant uses a weight-field.

Definition at line 31 of file volFieldValueI.H.

References Foam::noexcept, operation_, and typeWeighted.

Referenced by processValues(), and read().

Here is the caller graph for this function:

◆ canWeight()

bool canWeight ( const scalarField & fld ) const

inlineprotected

True if field is non-empty on any processor.

Definition at line 39 of file volFieldValueI.H.

References fld(), and Foam::returnReduceOr().

Referenced by processValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validField()

template<class Type>

bool validField ( const word & fieldName ) const

protected

Return true if the field name is valid.

Definition at line 28 of file volFieldValueTemplates.C.

References regionFunctionObject::obr_.

Referenced by write(), and writeValues().

Here is the caller graph for this function:

◆ getFieldValues() [1/2]

template<class Type>

tmp< Field< Type > > getFieldValues	(	const word &	fieldName,
		const bool	mandatory = false ) const

protected

Insert field values into values list.

References getFieldValues(), processValues(), volRegion::V(), writeAll(), and writeValues().

Referenced by getFieldValues(), write(), and writeValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processValues()

template<class Type>

Type processValues	(	const Field< Type > &	values,
		const scalarField &	V,
		const scalarField &	weightField ) const

protected

Apply the 'operation' to the values.

Definition at line 76 of file volFieldValueTemplates.C.

References canWeight(), Foam::cmptMag(), Foam::component(), Foam::gMax(), Foam::gMin(), Foam::gSum(), is_weightedOp(), n, opAverage, opCoV, operation_, opMax, opMin, opNone, opSum, opSumMag, opVolAverage, opVolIntegrate, opWeightedAverage, opWeightedSum, opWeightedVolAverage, opWeightedVolIntegrate, Foam::returnReduce(), Foam::setComponent(), Foam::sqr(), Foam::sqrt(), typeAbsolute, typeScalar, typeWeighted, volRegion::V(), and Foam::Zero.

Referenced by getFieldValues(), and writeValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeAll()

Foam::label writeAll	(	const scalarField &	V,
		const scalarField &	weightField )

protected

Helper function to output field values.

Definition at line 130 of file volFieldValue.C.

References Foam::endl(), fieldValue::fields_, volRegion::V(), WarningInFunction, and writeValues().

Referenced by getFieldValues(), and write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeValues()

template<class Type>

bool writeValues	(	const word &	fieldName,
		const scalarField &	V,
		const scalarField &	weightField )

protected

Templated helper function to output field values.

Definition at line 193 of file volFieldValueTemplates.C.

References Foam::component(), polyMesh::defaultRegion, UList< T >::empty(), Foam::endl(), writeFile::file(), getFieldValues(), Log, Foam::mag(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, regionFunctionObject::obr_, operation_, operationTypeNames_, opNone, postOperation_, postOperationTypeNames_, postOpMag, postOpNone, postOpSqrt, processValues(), volRegion::regionName_, volRegion::regionType_, volRegion::regionTypeNames_, fieldValue::scaleFactor_, Foam::setComponent(), stateFunctionObject::setResult(), Foam::sqrt(), Foam::tab, typeScalar, volRegion::V(), validField(), regIOobject::write(), and fieldValue::writeFields_.

Referenced by getFieldValues(), and writeAll().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ filterField() [1/2]

template<class Type>

tmp< Field< Type > > filterField ( const Field< Type > & field ) const

protected

Filter a field according to cellIds.

References field(), filterField(), os(), and writeFileHeader().

Referenced by filterField(), getFieldValues(), and write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFileHeader()

void writeFileHeader ( Ostream & os ) const

protectedvirtual

Output file header information.

Definition at line 99 of file volFieldValue.C.

References Foam::endl(), fieldValue::fields_, Foam::flatOutput(), operation_, operationTypeNames_, os(), Foam::tab, weightFieldNames_, writeFile::writeCommented(), volRegion::writeFileHeader(), and writeFile::writeHeaderValue().

Referenced by filterField(), and volFieldValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "volFieldValue" )

Declare type-name, virtual type (with debug switch).

References fieldValue::dict(), functionObject::name(), regionFunctionObject::obr(), runTime, TypeName(), and volFieldValue().

Referenced by TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const volFieldValue & )

delete

No copy assignment.

References volFieldValue().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read the function-object dictionary.

Reimplemented from fieldValue.

Definition at line 221 of file volFieldValue.C.

References fieldValue::dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::flatOutput(), Foam::Info, is_weightedOp(), Foam::nl, operation_, operationTypeNames_, fieldValue::read(), and weightFieldNames_.

Referenced by volFieldValue(), volFieldValue(), and ~volFieldValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

bool write ( )

virtual

Write the function-object results.

Reimplemented from fieldValue.

Definition at line 283 of file volFieldValue.C.

References Foam::abort(), UList< T >::empty(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, writeFile::file(), filterField(), getFieldValues(), Log, UPstream::master(), fvMeshFunctionObject::mesh_, Foam::nl, volRegion::update(), usesVol(), volRegion::V(), validField(), weightFieldNames_, fieldValue::write(), writeAll(), and writeFile::writeCurrentTime().

Referenced by ~volFieldValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldValues() [2/2]

template<class Type>

Foam::tmp< Foam::Field< Type > > getFieldValues	(	const word &	fieldName,
		const bool	mandatory ) const

Definition at line 46 of file volFieldValueTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, filterField(), Foam::New(), Foam::nl, and regionFunctionObject::obr_.

Here is the call graph for this function:

◆ filterField() [2/2]

template<class Type>

Foam::tmp< Foam::Field< Type > > filterField ( const Field< Type > & field ) const

Definition at line 330 of file volFieldValueTemplates.C.

References volRegion::cellIDs(), field(), Foam::New(), and volRegion::useAllCells().

Here is the call graph for this function:

Member Data Documentation

◆ operationTypeNames_

const Foam::Enum< Foam::functionObjects::fieldValues::volFieldValue::operationType > operationTypeNames_

static

Operation type names.

Definition at line 306 of file volFieldValue.H.

Referenced by read(), volFieldValue(), volFieldValue(), writeFileHeader(), and writeValues().

◆ postOperationTypeNames_

const Foam::Enum< Foam::functionObjects::fieldValues::volFieldValue::postOperationType > postOperationTypeNames_

static

Operation type names.

Definition at line 322 of file volFieldValue.H.

Referenced by volFieldValue(), volFieldValue(), and writeValues().

◆ operation_

operationType operation_

protected

Operation to apply to values.

Definition at line 332 of file volFieldValue.H.

Referenced by is_magOp(), is_weightedOp(), processValues(), read(), usesVol(), volFieldValue(), volFieldValue(), writeFileHeader(), and writeValues().

◆ postOperation_

postOperationType postOperation_

protected

Optional post-evaluation operation.

Definition at line 337 of file volFieldValue.H.

Referenced by volFieldValue(), volFieldValue(), and writeValues().

◆ weightFieldNames_

wordList weightFieldNames_

protected

Weight field name(s) - optional.

Definition at line 342 of file volFieldValue.H.

Referenced by read(), volFieldValue(), volFieldValue(), write(), and writeFileHeader().

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

src/functionObjects/field/fieldValues/volFieldValue/volFieldValue.H
src/functionObjects/field/fieldValues/volFieldValue/volFieldValue.C
src/functionObjects/field/fieldValues/volFieldValue/volFieldValueI.H
src/functionObjects/field/fieldValues/volFieldValue/volFieldValueTemplates.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ operationType

◆ postOperationType

Constructor & Destructor Documentation

◆ volFieldValue() [1/3]

◆ volFieldValue() [2/3]

◆ volFieldValue() [3/3]

◆ ~volFieldValue()

Member Function Documentation

◆ usesVol()

◆ is_magOp()

◆ is_weightedOp()

◆ canWeight()

◆ validField()

◆ getFieldValues() [1/2]

◆ processValues()

◆ writeAll()

◆ writeValues()

◆ filterField() [1/2]

◆ writeFileHeader()

◆ TypeName()

◆ operator=()

◆ read()

◆ write()

◆ getFieldValues() [2/2]

◆ filterField() [2/2]

Member Data Documentation

◆ operationTypeNames_

◆ postOperationTypeNames_

◆ operation_

◆ postOperation_

◆ weightFieldNames_