This function object provides a 'cell source' variant of the fieldValues function object. Given a list of user-specified fields and a selection of mesh cells, a number of operations can be performed, such as sums, averages and integrations. More...

Inheritance diagram for cellSource:

[legend]

Collaboration diagram for cellSource:

[legend]

Public Types
enum	sourceType { stCellZone, stAll }
	Source type enumeration. More...

enum	operationType { opNone, opSum, opSumMag, opAverage, opWeightedAverage, opVolAverage, opWeightedVolAverage, opVolIntegrate, opMin, opMax, opCoV }
	Operation type enumeration. More...

Public Member Functions
	TypeName ("cellSource")
	Run-time type information. More...

	cellSource (const word &name, const objectRegistry &obr, const dictionary &dict, const bool loadFromFiles=false)
	Construct from components. More...

virtual	~cellSource ()
	Destructor. More...

const sourceType &	source () const
	Return the source type. More...

const labelList &	cellId () const
	Return the local list of cell IDs. More...

virtual void	read (const dictionary &)
	Read from dictionary. More...

virtual void	write ()
	Calculate and write. More...

template<class Type >
bool	writeValues (const word &fieldName, const scalarField &weightField)
	Templated helper function to output field values. More...

template<class Type >
tmp< Field< Type > >	filterField (const Field< Type > &field) const
	Filter a field according to cellIds. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	setFieldValues (const word &fieldName, const bool mustGet) 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. More...

	declareRunTimeSelectionTable (autoPtr, fieldValue, dictionary,(const word &name, const objectRegistry &obr, const dictionary &dict, const bool loadFromFiles),(name, obr, dict, loadFromFiles))

	fieldValue (const word &name, const objectRegistry &obr, const dictionary &dict, const word &valueType, const bool loadFromFiles=false)
	Construct from components. More...

virtual	~fieldValue ()
	Destructor. More...

const word &	name () const
	Return the name of the geometric source. More...

const objectRegistry &	obr () const
	Return the reference to the object registry. More...

const dictionary &	dict () const
	Return the reference to the construction dictionary. More...

bool	active () const
	Return the active flag. More...

const Switch &	log () const
	Return the switch to send output to Info as well as to file. More...

const word &	sourceName () const
	Return the source name. More...

const wordList &	fields () const
	Return the list of field names. More...

const Switch &	valueOutput () const
	Return the output field values flag. More...

const fvMesh &	mesh () const
	Helper function to return the reference to the mesh. More...

virtual void	execute ()
	Execute. More...

virtual void	end ()
	Execute the at the final time-loop, currently does nothing. More...

virtual void	timeSet ()
	Called when time was set at the end of the Time::operator++. More...

virtual void	updateMesh (const mapPolyMesh &)
	Update mesh. More...

virtual void	movePoints (const polyMesh &)
	Move points. More...

template<class Type >
void	combineFields (Field< Type > &field)
	Combine fields from all processor domains into single field. More...

template<class Type >
void	combineFields (tmp< Field< Type > > &)
	Combine fields from all processor domains into single field. More...

Public Member Functions inherited from functionObjectState
	functionObjectState (const objectRegistry &obr, const word &name)
	Construct from components. More...

virtual	~functionObjectState ()
	Destructor. More...

const word &	name () const
	Return the name. More...

bool	active () const
	Return the active flag. More...

const IOdictionary &	stateDict () const
	Return access to the state dictionary. More...

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

template<class Type >
bool	setActive ()
	Set the active status by querying objectRegistry type. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property. More...

template<class Type >
void	getProperty (const word &entryName, Type &value) const
	Retrieve generic property. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property from named object. More...

template<class Type >
void	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Retrieve generic property from named object. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve result from named object. More...

template<class Type >
void	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Retrieve result from named object. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

List< word >	objectResultEntries () const
	Retrieve the result entries. More...

List< word >	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

Public Member Functions inherited from functionObjectFile
	functionObjectFile (const objectRegistry &obr, const word &prefix)
	Construct null. More...

	functionObjectFile (const objectRegistry &obr, const word &prefix, const word &fileName, const dictionary &dict)
	Construct from components and read options from dictionary. More...

virtual	~functionObjectFile ()
	Destructor. More...

void	read (const dictionary &dict)
	Read. More...

OFstream &	file ()
	Return access to the file (if only 1) More...

bool	writeToFile () const
	Return true if can write to file. More...

void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream. More...

void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream. More...

void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream. More...

void	writeTime (Ostream &os) const
	Write the current time to 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...

label	charWidth () const
	Return width of character stream output. More...

Static Public Attributes
static const NamedEnum< sourceType, 2 >	sourceTypeNames_
	Source type names. More...

static const NamedEnum< operationType, 11 >	operationTypeNames_
	Operation type names. More...

Static Public Attributes inherited from functionObjectFile
static const word	outputPrefix = "postProcessing"
	Directory prefix. More...

static label	addChars = 7
	Additional characters for writing. More...

Protected Member Functions
void	initialise (const dictionary &dict)
	Initialise, e.g. cell addressing. More...

template<class Type >
bool	validField (const word &fieldName) const
	Return true if the field name is valid. More...

template<class Type >
tmp< Field< Type > >	setFieldValues (const word &fieldName, const bool mustGet=false) const
	Insert field values into values list. More...

template<class Type >
Type	processValues (const Field< Type > &values, const scalarField &V, const scalarField &weightField) const
	Apply the 'operation' to the values. More...

virtual void	writeFileHeader (Ostream &os) const
	Output file header information. More...

Protected Member Functions inherited from functionObjectState
	functionObjectState (const functionObjectState &)
	Disallow default bitwise copy construct. More...

void	operator= (const functionObjectState &)
	Disallow default bitwise assignment. More...

Protected Member Functions inherited from functionObjectFile
virtual void	initStream (Ostream &os) const
	Initialise the output stream for writing. More...

virtual fileName	baseFileDir () const
	Return the base directory for output. More...

virtual fileName	baseTimeDir () const
	Return the base directory for the current time value. More...

virtual autoPtr< OFstream >	createFile (const word &name) const
	Return an autoPtr to a new file. More...

virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name. More...

virtual Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset. More...

	functionObjectFile (const functionObjectFile &)
	Disallow default bitwise copy construct. More...

void	operator= (const functionObjectFile &)
	Disallow default bitwise assignment. More...

Protected Attributes
sourceType	source_
	Source type. More...

operationType	operation_
	Operation to apply to values. More...

label	nCells_
	Global number of cells. More...

labelList	cellId_
	Local list of cell IDs. More...

word	weightFieldName_
	Weight field name - only used for opWeightedAverage mode. More...

scalar	volume_
	Volume of the cellSource. More...

bool	writeVolume_
	Optionally write the volume of the cellSource. More...

Protected Attributes inherited from fieldValue
const objectRegistry &	obr_
	Database this class is registered to. More...

dictionary	dict_
	Construction dictionary. More...

Switch	log_
	Switch to send output to Info as well as to file. More...

word	sourceName_
	Name of source object. More...

wordList	fields_
	List of field names to operate on. More...

Switch	valueOutput_
	Output field values flag. More...

scalar	scaleFactor_
	Scale factor - optional. More...

Protected Attributes inherited from functionObjectState
const word	name_
	Name of model. More...

bool	active_
	Flag to indicate whether the object is active. More...

IOdictionary &	stateDict_
	Reference to the state dictionary. More...

Protected Attributes inherited from functionObjectFile
bool	writeToFile_
	Flag to enable/disable writing to file. More...

Private Member Functions
void	setCellZoneCells ()
	Set cells to evaluate based on a cell zone. More...

void	setPatchCells ()
	Set cells to evaluate based on a patch. More...

scalar	volume () const
	Calculate and return volume of the cellSource: sum(V) More...

Additional Inherited Members
Static Public Member Functions inherited from fieldValue
static autoPtr< fieldValue >	New (const word &name, const objectRegistry &obr, const dictionary &dict, const bool loadFromFiles=false, const bool output=true)
	Return a reference to the selected fieldValue. More...

Detailed Description

This function object provides a 'cell source' variant of the fieldValues function object. Given a list of user-specified fields and a selection of mesh cells, a number of operations can be performed, such as sums, averages and integrations.

Example of function object specification:

cellSource1
{
    type            cellSource;
    functionObjectLibs ("libfieldFunctionObjects.so");
    ...
    log             true;
    valueOutput     true;
    source          cellZone;
    sourceName      c0;
    operation       volAverage;
    weightField     alpha1;
    fields
    (
        p
        U
    );
}

Function object usage

Property	Description	Required	Default value
`type`	Type name: cellSource	yes
`log`	Write data to standard output	no	no
`valueOutput`	Write the raw output values	yes
`writeVolume`	Write the volume of the cellSource	no
`source`	Cell source: see below	yes
`sourceName`	Name of cell source if required	no
`operation`	Operation to perform	yes
`weightField`	Name of field to apply weighting	no
`fields`	List of fields to operate on	yes

Where source is defined by

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

The operation is one of:

none	:	no operation
sum	:	sum
sumMag	:	sum of component magnitudes
average	:	ensemble average
weightedAverage	:	weighted average
volAverage	:	volume weighted average
weightedVolAverage	:	weighted volume average
volIntegrate	:	volume integral
min	:	minimum
max	:	maximum
CoV	:	coefficient of variation: standard deviation/mean

See also: Foam::fieldValues Foam::functionObject Foam::OutputFilterFunctionObject

Source files

Definition at line 225 of file cellSource.H.

Member Enumeration Documentation

◆ sourceType

enum sourceType

Source type enumeration.

Enumerator
stCellZone
stAll

Definition at line 235 of file cellSource.H.

◆ operationType

enum operationType

Operation type enumeration.

Enumerator
opNone
opSum
opSumMag
opAverage
opWeightedAverage
opVolAverage
opWeightedVolAverage
opVolIntegrate
opMin
opMax
opCoV

Definition at line 246 of file cellSource.H.

Constructor & Destructor Documentation

◆ cellSource()

cellSource	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const bool	loadFromFiles = `false`
	)

Construct from components.

Definition at line 188 of file cellSource.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ ~cellSource()

~cellSource ( )

virtual

Destructor.

Definition at line 213 of file cellSource.C.

Member Function Documentation

◆ setCellZoneCells()

void setCellZoneCells ( )

private

Set cells to evaluate based on a cell zone.

Definition at line 76 of file cellSource.C.

References cellSource::cellId_, polyMesh::cellZones(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, ZoneMesh::findZoneID(), Foam::identity(), fieldValue::mesh(), ZoneMesh::names(), cellSource::nCells_, Foam::nl, Foam::Pout, Foam::returnReduce(), List::size(), cellSource::source_, fieldValue::sourceName_, cellSource::sourceTypeNames_, cellSource::stAll, and cellSource::stCellZone.

Here is the call graph for this function:

◆ setPatchCells()

void setPatchCells ( )

private

Set cells to evaluate based on a patch.

◆ volume()

Foam::scalar volume ( ) const

private

Calculate and return volume of the cellSource: sum(V)

Definition at line 119 of file cellSource.C.

References Foam::gSum(), and mesh.

Here is the call graph for this function:

◆ initialise()

void initialise ( const dictionary & dict )

protected

Initialise, e.g. cell addressing.

Definition at line 127 of file cellSource.C.

References dict, Foam::endl(), Foam::Info, Foam::nl, Foam::type(), and WarningInFunction.

Here is the call graph for this function:

◆ validField()

bool validField ( const word & fieldName ) const

protected

Return true if the field name is valid.

Definition at line 32 of file cellSourceTemplates.C.

References objectRegistry::foundObject(), and fieldValue::obr_.

Here is the call graph for this function:

◆ setFieldValues() [1/2]

tmp<Field<Type> > setFieldValues	(	const word &	fieldName,
		const bool	mustGet = `false`
	)		const

protected

Insert field values into values list.

◆ processValues()

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

protected

Apply the 'operation' to the values.

Definition at line 72 of file cellSourceTemplates.C.

References Foam::cmptMag(), Foam::component(), Foam::gMax(), Foam::gMin(), Foam::gSum(), n, Foam::returnReduce(), Foam::setComponent(), Foam::sqr(), and Foam::sqrt().

Here is the call graph for this function:

◆ writeFileHeader()

void writeFileHeader ( Ostream & os ) const

protectedvirtual

Output file header information.

Definition at line 160 of file cellSource.C.

References Foam::endl(), forAll, and Foam::tab.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "cellSource" )

Run-time type information.

◆ source()

const Foam::fieldValues::cellSource::sourceType & source ( ) const

inline

Return the source type.

Definition at line 31 of file cellSourceI.H.

References cellSource::source_.

◆ cellId()

const Foam::labelList & cellId ( ) const

inline

Return the local list of cell IDs.

Definition at line 38 of file cellSourceI.H.

◆ read()

void read ( const dictionary & dict )

virtual

Read from dictionary.

Reimplemented from fieldValue.

Definition at line 219 of file cellSource.C.

References dict, and fieldValue::read().

Here is the call graph for this function:

◆ write()

void write ( )

virtual

Calculate and write.

Reimplemented from fieldValue.

Definition at line 231 of file cellSource.C.

References Foam::endl(), forAll, Foam::Info, Foam::tab, WarningInFunction, and fieldValue::write().

Here is the call graph for this function:

◆ writeValues()

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

Templated helper function to output field values.

Definition at line 171 of file cellSourceTemplates.C.

References Foam::endl(), Foam::Info, UPstream::master(), mesh, IOobject::NO_READ, IOobject::NO_WRITE, Foam::tab, and regIOobject::write().

Here is the call graph for this function:

◆ filterField() [1/2]

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

Filter a field according to cellIds.

◆ setFieldValues() [2/2]

Foam::tmp<Foam::Field<Type> > setFieldValues	(	const word &	fieldName,
		const bool	mustGet
	)		const

Definition at line 47 of file cellSourceTemplates.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ filterField() [2/2]

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

Definition at line 230 of file cellSourceTemplates.C.

Field Documentation

◆ sourceTypeNames_

const Foam::NamedEnum< Foam::fieldValues::cellSource::sourceType, 2 > sourceTypeNames_

static

Source type names.

Definition at line 242 of file cellSource.H.

Referenced by cellSource::setCellZoneCells().

◆ operationTypeNames_

const Foam::NamedEnum< Foam::fieldValues::cellSource::operationType, 11 > operationTypeNames_

static

Operation type names.

Definition at line 262 of file cellSource.H.

◆ source_

sourceType source_

protected

Source type.

Definition at line 284 of file cellSource.H.

Referenced by cellSource::setCellZoneCells(), and cellSource::source().

◆ operation_

operationType operation_

protected

Operation to apply to values.

Definition at line 287 of file cellSource.H.

◆ nCells_

label nCells_

protected

Global number of cells.

Definition at line 290 of file cellSource.H.

Referenced by cellSource::setCellZoneCells().

◆ cellId_

labelList cellId_

protected

Local list of cell IDs.

Definition at line 293 of file cellSource.H.

Referenced by cellSource::setCellZoneCells().

◆ weightFieldName_

word weightFieldName_

protected

Weight field name - only used for opWeightedAverage mode.

Definition at line 296 of file cellSource.H.

◆ volume_

scalar volume_

protected

Volume of the cellSource.

Definition at line 299 of file cellSource.H.

◆ writeVolume_

bool writeVolume_

protected

Optionally write the volume of the cellSource.

Definition at line 302 of file cellSource.H.

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

src/postProcessing/functionObjects/field/fieldValues/cellSource/cellSource.H
src/postProcessing/functionObjects/field/fieldValues/cellSource/cellSource.C
src/postProcessing/functionObjects/field/fieldValues/cellSource/cellSourceI.H
src/postProcessing/functionObjects/field/fieldValues/cellSource/cellSourceTemplates.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ sourceType

◆ operationType

Constructor & Destructor Documentation

◆ cellSource()

◆ ~cellSource()

Member Function Documentation

◆ setCellZoneCells()

◆ setPatchCells()

◆ volume()

◆ initialise()

◆ validField()

◆ setFieldValues() [1/2]

◆ processValues()

◆ writeFileHeader()

◆ TypeName()

◆ source()

◆ cellId()

◆ read()

◆ write()

◆ writeValues()

◆ filterField() [1/2]

◆ setFieldValues() [2/2]

◆ filterField() [2/2]

Field Documentation

◆ sourceTypeNames_

◆ operationTypeNames_

◆ source_

◆ operation_

◆ nCells_

◆ cellId_

◆ weightFieldName_

◆ volume_

◆ writeVolume_