Computes ensemble- and/or time-based field averages, with optional windowing, for a user-specified selection of volumetric and/or surface fields. More...

#include <fieldAverage.H>

Inheritance diagram for fieldAverage:

[legend]

Collaboration diagram for fieldAverage:

[legend]

Public Member Functions
	TypeName ("fieldAverage")
	Runtime type information.
	fieldAverage (const word &name, const Time &runTime, const dictionary &)
	Construct from name, Time and dictionary.
	fieldAverage (const fieldAverage &)=delete
	No copy construct.
void	operator= (const fieldAverage &)=delete
	No copy assignment.
virtual	~fieldAverage ()=default
	Destructor.
virtual bool	read (const dictionary &dict)
	Read the function-object dictionary.
virtual bool	execute ()
	Execute the function-object operations.
virtual bool	write ()
	Write the function-object results.
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.

Protected Member Functions
void	initialize ()
	Reset lists (clear existing values) and initialize averaging.
void	restart ()
	Restart averaging for restartOnOutput.
template<class Type>
bool	addMeanFieldType (fieldAverageItem &item)
	Add mean average field to database.
template<class Type>
bool	addMeanField (fieldAverageItem &item)
	Add mean average field to database.
template<class Type1, class Type2>
bool	addPrime2MeanFieldType (fieldAverageItem &item)
	Add prime-squared average field to database.
template<class Type1, class Type2>
bool	addPrime2MeanField (fieldAverageItem &item)
	Add prime-squared average field to database.
virtual void	calcAverages ()
	Main calculation routine.
template<class Type>
void	calculateMeanFields () const
	Calculate mean average fields.
template<class Type1, class Type2>
void	calculatePrime2MeanFields () const
	Calculate prime-squared average fields.
template<class Type1, class Type2>
bool	addMeanSqrToPrime2MeanType (const fieldAverageItem &item) const
	Add mean-squared field value to prime-squared mean field.
template<class Type1, class Type2>
void	addMeanSqrToPrime2Mean () const
	Add mean-squared field value to prime-squared mean field.
template<class Type>
bool	storeWindowFieldType (fieldAverageItem &item)
template<class Type>
void	storeWindowFields ()
template<class Type>
bool	restoreWindowFieldsType (const fieldAverageItem &item)
template<class Type>
void	restoreWindowFields (const fieldAverageItem &item)
virtual void	writeAverages () const
	Write averages.
template<class Type>
bool	writeFieldType (const word &fieldName) const
	Write fields.
template<class Type>
void	writeFields () const
	Write fields.
void	writeAveragingProperties ()
	Write averaging properties - steps and time.
void	readAveragingProperties ()
	Read averaging properties - steps and time.
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 Attributes
label	prevTimeIndex_
	Time at last call, prevents repeated averaging.
bool	initialised_
	Initialised flag.
Switch	restartOnRestart_
	Restart the averaging process on restart.
Switch	restartOnOutput_
	Restart the averaging process on output.
Switch	periodicRestart_
	Periodically restart the averaging process.
scalar	restartPeriod_
	Restart period.
scalar	restartTime_
	Specific restart time.
List< fieldAverageItem >	faItems_
	List of field average items, describing what averages to be calculated and output.
List< label >	totalIter_
	Iteration steps counter.
List< scalar >	totalTime_
	Total time counter.
label	periodIndex_
	Index for periodic restart.
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.

Additional Inherited Members
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.
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.

Detailed Description

Computes ensemble- and/or time-based field averages, with optional windowing, for a user-specified selection of volumetric and/or surface fields.

Fields are entered as a list of sub-dictionaries, which indicate the type of averages to perform, and can be updated during the calculation. The current options include:

mean: arithmetic mean
$\‍[ \overline{x} = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N x_i \‍]$
prime2Mean: prime-squared mean
$\‍[ \overline{x'}^2 = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N (x_i - \overline{x})^2 \‍]$
base: average over 'time', or 'iteration' (N in the above)
window: optional averaging window, specified in 'base' units

Average field names are constructed by concatenating the base field with the averaging type, e.g. when averaging field 'U', the name of resultant fields becomes:

arithmetic mean field, UMean
prime-squared field, UPrime2Mean

Information regarding the number of averaging steps, and total averaging time are written on a per-field basis to the "<functionObject name>Properties" dictionary, located in <time>/uniform.

When restarting form a previous calculation, the averaging is continuous or may be restarted using the restartOnRestart option.

The averaging process may be restarted after each calculation output time using the restartOnOutput option or restarted periodically using the periodicRestart option and setting restartPeriod to the required averaging period.

With the subRegion option, also supports fields on function object surface output (e.g., sampledSurfaces).

Operands:

Operand	Type	Location
`input`	{vol,surface}<Type>Field(s)	<time>/inputFields
`output` file	-	-
`output` field	{vol,surface}<Type>Field(s)	<time>/outputFields

where Type can be one of: Scalar, Vector, SphericalTensor, SymmTensor, or Tensor.

Usage

Minimal example by using system/controlDict.functions:

fieldAverageFO
{
    // Mandatory entries
    type                fieldAverage;
    libs                (fieldFunctionObjects);
    fields
    (
        <field1>
        {
            // Inherited entries
            ...
        }

        ...

        <fieldN>
        {
            ...
        }
    );

    // Optional entries
    restartOnRestart    false;
    restartOnOutput     false;
    periodicRestart     false;
    restartPeriod       0.002;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: fieldAverage	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`fields`	Names of the operand fields and averaging options	dict	yes	-
`restartOnRestart`	Restart the averaging on restart	bool	no	false
`restartOnOutput`	Restart the averaging on output	bool	no	false
`periodicRestart`	Periodically restart the averaging	bool	no	false
`restartPeriod`	Periodic restart period	scalar	conditional	-
`restartTime`	One-shot reset of the averaging	scalar	no	GREAT
`subRegion`	Name for alternative objectRegistry	word	no	""

The inherited entries are elaborated in:

Source files

Definition at line 239 of file fieldAverage.H.

Constructor & Destructor Documentation

◆ fieldAverage() [1/2]

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

Construct from name, Time and dictionary.

Definition at line 263 of file fieldAverage.C.

References dict, faItems_, fvMeshFunctionObject::fvMeshFunctionObject(), initialised_, Foam::name(), periodicRestart_, periodIndex_, prevTimeIndex_, read(), restartOnOutput_, restartOnRestart_, restartPeriod_, restartTime_, and runTime.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fieldAverage() [2/2]

fieldAverage ( const fieldAverage & )

delete

No copy construct.

References fieldAverage().

Here is the call graph for this function:

◆ ~fieldAverage()

virtual ~fieldAverage ( )

virtualdefault

Destructor.

References dict.

Member Function Documentation

◆ initialize()

void initialize ( )

protected

Reset lists (clear existing values) and initialize averaging.

Check requested field averages are valid, populate field lists

Definition at line 41 of file fieldAverage.C.

References addMeanField(), addPrime2MeanField(), Foam::endl(), faItems_, initialised_, Log, functionObject::name(), Foam::nl, regionFunctionObject::obr(), prevTimeIndex_, restoreWindowFields(), functionObject::type(), and WarningInFunction.

Referenced by calcAverages(), and restart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restart()

void restart ( )

protected

Restart averaging for restartOnOutput.

Definition at line 97 of file fieldAverage.C.

References Foam::endl(), faItems_, initialize(), Log, Foam::nl, and regionFunctionObject::obr().

Referenced by calcAverages(), and write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addMeanFieldType()

template<class Type>

bool addMeanFieldType ( fieldAverageItem & item )

protected

Add mean average field to database.

Definition at line 31 of file fieldAverageTemplates.C.

References fieldAverageItem::active(), Foam::endl(), fieldAverageItem::fieldName(), regionFunctionObject::findObject(), found, regionFunctionObject::foundObject(), Log, fieldAverageItem::mean(), fieldAverageItem::meanFieldName(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, regionFunctionObject::obr(), IOobjectOption::READ_IF_PRESENT, restartOnOutput_, startTime, regIOobject::store(), timeFunctionObject::time(), and timeName.

Referenced by addMeanField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addMeanField()

template<class Type>

bool addMeanField ( fieldAverageItem & item )

protected

Add mean average field to database.

Definition at line 93 of file fieldAverageTemplates.C.

References addMeanFieldType(), and fieldAverageItem::mean().

Referenced by initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addPrime2MeanFieldType()

template<class Type1, class Type2>

bool addPrime2MeanFieldType ( fieldAverageItem & item )

protected

Add prime-squared average field to database.

Definition at line 199 of file fieldAverageTemplates.C.

References Foam::endl(), fieldAverageItem::fieldName(), regionFunctionObject::findObject(), found, regionFunctionObject::foundObject(), Log, regionFunctionObject::lookupObject(), fieldAverageItem::meanFieldName(), Foam::nl, IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, regionFunctionObject::obr(), fieldAverageItem::prime2Mean(), fieldAverageItem::prime2MeanFieldName(), IOobjectOption::READ_IF_PRESENT, restartOnOutput_, Foam::sqr(), startTime, timeFunctionObject::time(), and timeName.

Referenced by addPrime2MeanField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addPrime2MeanField()

template<class Type1, class Type2>

bool addPrime2MeanField ( fieldAverageItem & item )

protected

Add prime-squared average field to database.

Definition at line 258 of file fieldAverageTemplates.C.

References addPrime2MeanFieldType(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, fieldAverageItem::fieldName(), fieldAverageItem::mean(), Foam::nl, and fieldAverageItem::prime2Mean().

Referenced by initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcAverages()

void calcAverages ( )

protectedvirtual

Main calculation routine.

Definition at line 112 of file fieldAverage.C.

References addMeanSqrToPrime2Mean(), calculateMeanFields(), calculatePrime2MeanFields(), Foam::endl(), faItems_, forAll, initialised_, initialize(), Log, name, Foam::nl, regionFunctionObject::obr(), periodicRestart_, periodIndex_, prevTimeIndex_, restart(), restartPeriod_, restartTime_, storeWindowFields(), and Foam::type().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateMeanFields()

template<class Type>

void calculateMeanFields ( ) const

protected

Calculate mean average fields.

Definition at line 368 of file fieldAverageTemplates.C.

References faItems_, and regionFunctionObject::obr().

Referenced by calcAverages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculatePrime2MeanFields()

template<class Type1, class Type2>

void calculatePrime2MeanFields ( ) const

protected

Calculate prime-squared average fields.

Definition at line 391 of file fieldAverageTemplates.C.

References faItems_, and regionFunctionObject::obr().

Referenced by calcAverages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addMeanSqrToPrime2MeanType()

template<class Type1, class Type2>

bool addMeanSqrToPrime2MeanType ( const fieldAverageItem & item ) const

protected

Add mean-squared field value to prime-squared mean field.

Definition at line 421 of file fieldAverageTemplates.C.

References fieldAverageItem::fieldName(), regionFunctionObject::foundObject(), regionFunctionObject::lookupObject(), regionFunctionObject::lookupObjectRef(), fieldAverageItem::meanFieldName(), fieldAverageItem::prime2MeanFieldName(), and Foam::sqr().

Referenced by addMeanSqrToPrime2Mean().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addMeanSqrToPrime2Mean()

template<class Type1, class Type2>

void addMeanSqrToPrime2Mean ( ) const

protected

Add mean-squared field value to prime-squared mean field.

Definition at line 442 of file fieldAverageTemplates.C.

References addMeanSqrToPrime2MeanType(), and faItems_.

Referenced by calcAverages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeWindowFieldType()

template<class Type>

bool storeWindowFieldType ( fieldAverageItem & item )

protected

Definition at line 300 of file fieldAverageTemplates.C.

References fieldAverageItem::addToWindow(), DebugInfo, Foam::endl(), fieldAverageItem::fieldName(), regionFunctionObject::findObject(), name, IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, regionFunctionObject::obr(), IOobjectOption::READ_IF_PRESENT, restartOnOutput_, startTime, timeFunctionObject::time(), timeName, and fieldAverageItem::windowFieldName().

Referenced by storeWindowFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeWindowFields()

template<class Type>

void storeWindowFields ( )

protected

Definition at line 344 of file fieldAverageTemplates.C.

References faItems_, and storeWindowFieldType().

Referenced by calcAverages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restoreWindowFieldsType()

template<class Type>

bool restoreWindowFieldsType ( const fieldAverageItem & item )

protected

Definition at line 121 of file fieldAverageTemplates.C.

References DebugInfo, Foam::endl(), fieldAverageItem::fieldName(), regionFunctionObject::findObject(), forAllConstIters, io, IOobjectOption::MUST_READ, Foam::name(), IOobjectOption::NO_WRITE, regionFunctionObject::obr(), IOobjectOption::REGISTER, restartOnOutput_, startTime, timeFunctionObject::time(), timeName, WarningInFunction, and fieldAverageItem::windowFieldNames().

Referenced by restoreWindowFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restoreWindowFields()

template<class Type>

void restoreWindowFields ( const fieldAverageItem & item )

protected

Definition at line 175 of file fieldAverageTemplates.C.

References restoreWindowFieldsType(), and fieldAverageItem::window().

Referenced by initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeAverages()

void writeAverages ( ) const

protectedvirtual

Write averages.

Definition at line 185 of file fieldAverage.C.

References Foam::endl(), Log, and Foam::writeFields().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFieldType()

template<class Type>

bool writeFieldType ( const word & fieldName ) const

protected

Write fields.

Definition at line 474 of file fieldAverageTemplates.C.

References DebugInfo, Foam::endl(), and regionFunctionObject::findObject().

Referenced by writeFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFields()

template<class Type>

void writeFields ( ) const

protected

Write fields.

Definition at line 492 of file fieldAverageTemplates.C.

References faItems_, forAllConstIters, and writeFieldType().

Here is the call graph for this function:

◆ writeAveragingProperties()

void writeAveragingProperties ( )

protected

Write averaging properties - steps and time.

Definition at line 199 of file fieldAverage.C.

References faItems_, propsDict(), and stateFunctionObject::setProperty().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readAveragingProperties()

void readAveragingProperties ( )

protected

Read averaging properties - steps and time.

Definition at line 210 of file fieldAverage.C.

References Foam::endl(), faItems_, stateFunctionObject::foundProperty(), stateFunctionObject::getDict(), Foam::Info, Foam::nl, regionFunctionObject::obr(), restartOnOutput_, and restartOnRestart_.

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "fieldAverage" )

Runtime type information.

References Foam::name(), and runTime.

Here is the call graph for this function:

◆ operator=()

void operator= ( const fieldAverage & )

delete

No copy assignment.

References fieldAverage().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read the function-object dictionary.

Reimplemented from regionFunctionObject.

Definition at line 287 of file fieldAverage.C.

References dict, Foam::endl(), faItems_, Foam::Info, initialised_, name, names, Foam::nl, regionFunctionObject::obr(), periodicRestart_, periodIndex_, DynamicList< T, SizeMin >::push_back(), functionObject::read(), readAveragingProperties(), restartOnOutput_, restartOnRestart_, restartPeriod_, restartTime_, functionObject::scopedName(), UList< T >::size(), Foam::type(), and WarningInFunction.

Referenced by fieldAverage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

bool execute ( )

virtual

Execute the function-object operations.

Implements functionObject.

Definition at line 384 of file fieldAverage.C.

References calcAverages().

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the function-object results.

Implements functionObject.

Definition at line 392 of file fieldAverage.C.

References restart(), restartOnOutput_, writeAverages(), and writeAveragingProperties().

Here is the call graph for this function:

Member Data Documentation

◆ prevTimeIndex_

label prevTimeIndex_

protected

Time at last call, prevents repeated averaging.

Definition at line 250 of file fieldAverage.H.

Referenced by calcAverages(), fieldAverage(), and initialize().

◆ initialised_

bool initialised_

protected

Initialised flag.

Definition at line 255 of file fieldAverage.H.

Referenced by calcAverages(), fieldAverage(), initialize(), and read().

◆ restartOnRestart_

Switch restartOnRestart_

protected

Restart the averaging process on restart.

Definition at line 260 of file fieldAverage.H.

Referenced by fieldAverage(), read(), and readAveragingProperties().

◆ restartOnOutput_

Switch restartOnOutput_

protected

Restart the averaging process on output.

Definition at line 265 of file fieldAverage.H.

Referenced by addMeanFieldType(), addPrime2MeanFieldType(), fieldAverage(), read(), readAveragingProperties(), restoreWindowFieldsType(), storeWindowFieldType(), and write().

◆ periodicRestart_

Switch periodicRestart_

protected

Periodically restart the averaging process.

Definition at line 270 of file fieldAverage.H.

Referenced by calcAverages(), fieldAverage(), and read().

◆ restartPeriod_

scalar restartPeriod_

protected

Restart period.

Definition at line 275 of file fieldAverage.H.

Referenced by calcAverages(), fieldAverage(), and read().

◆ restartTime_

scalar restartTime_

protected

Specific restart time.

Definition at line 280 of file fieldAverage.H.

Referenced by calcAverages(), fieldAverage(), and read().

◆ faItems_

List<fieldAverageItem> faItems_

protected

List of field average items, describing what averages to be calculated and output.

Definition at line 286 of file fieldAverage.H.

Referenced by addMeanSqrToPrime2Mean(), calcAverages(), calculateMeanFields(), calculatePrime2MeanFields(), fieldAverage(), initialize(), read(), readAveragingProperties(), restart(), storeWindowFields(), writeAveragingProperties(), and writeFields().

◆ totalIter_

List<label> totalIter_

protected

Iteration steps counter.

Definition at line 293 of file fieldAverage.H.

◆ totalTime_

List<scalar> totalTime_

protected

Total time counter.

Definition at line 298 of file fieldAverage.H.

◆ periodIndex_

label periodIndex_

protected

Index for periodic restart.

Definition at line 303 of file fieldAverage.H.

Referenced by calcAverages(), fieldAverage(), and read().

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

src/functionObjects/field/fieldAverage/fieldAverage.H
src/functionObjects/field/fieldAverage/fieldAverage.C
src/functionObjects/field/fieldAverage/fieldAverageTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ fieldAverage() [1/2]

◆ fieldAverage() [2/2]

◆ ~fieldAverage()

Member Function Documentation

◆ initialize()

◆ restart()

◆ addMeanFieldType()

◆ addMeanField()

◆ addPrime2MeanFieldType()

◆ addPrime2MeanField()

◆ calcAverages()

◆ calculateMeanFields()

◆ calculatePrime2MeanFields()

◆ addMeanSqrToPrime2MeanType()

◆ addMeanSqrToPrime2Mean()

◆ storeWindowFieldType()

◆ storeWindowFields()

◆ restoreWindowFieldsType()

◆ restoreWindowFields()

◆ writeAverages()

◆ writeFieldType()

◆ writeFields()

◆ writeAveragingProperties()

◆ readAveragingProperties()

◆ TypeName()

◆ operator=()

◆ read()

◆ execute()

◆ write()

Member Data Documentation

◆ prevTimeIndex_

◆ initialised_

◆ restartOnRestart_

◆ restartOnOutput_

◆ periodicRestart_

◆ restartPeriod_

◆ restartTime_

◆ faItems_

◆ totalIter_

◆ totalTime_

◆ periodIndex_