Computes a selected operation between multiple function objects. More...

Inheritance diagram for multiFieldValue:

Collaboration diagram for multiFieldValue:

Public Types
enum	operationType { opSum , opAdd , opSubtract , opMin , opMax , opAverage }
	Operation type enumeration. More...

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

	multiFieldValue (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	multiFieldValue (const multiFieldValue &)=delete
	No copy construct. More...

void	operator= (const multiFieldValue &)=delete
	No copy assignment. More...

virtual	~multiFieldValue ()=default
	Destructor. More...

virtual bool	read (const dictionary &dict)
	Read from dictionary. More...

virtual bool	execute ()
	Do nothing. More...

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

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

virtual	~stateFunctionObject ()=default
	Destructor. More...

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

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

void	clearTrigger ()
	Remove the trigger index from the properties. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri)
	Set new trigger index. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

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

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. 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=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. 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=Type(Zero)) const
	Retrieve result. More...

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

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. 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...

wordList	objectResultEntries () const
	Retrieve the result entries. More...

wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

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

virtual	~timeFunctionObject ()=default
	Destructor. More...

const Time &	time () const
	Return time database. More...

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)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

virtual	~functionObject ()=default
	Destructor. More...

virtual const word &	type () const =0
	Runtime type information. More...

const word &	name () const noexcept
	Return the name of this functionObject. More...

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	read (const dictionary &dict)
	Read and set the function object if its data have changed. More...

virtual bool	execute ()=0
	Called at each ++ or += of the time-loop. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

virtual bool	write ()=0
	Called at each ++ or += of the time-loop. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh. More...

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

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

	writeFile (const writeFile &wf)
	Construct copy. More...

virtual	~writeFile ()=default
	Destructor. More...

virtual bool	read (const dictionary &dict)
	Read. More...

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

virtual bool	writeToFile () const
	Flag to allow writing to file. More...

virtual bool	canWriteHeader () const
	Flag to allow writing the header. More...

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

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

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

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

virtual void	writeCurrentTime (Ostream &os) const
	Write the current time to stream. More...

virtual void	writeBreak (Ostream &os) const
	Write a break marker to the 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...

template<class Type >
void	writeValue (Ostream &os, const Type &val) const
	Write a given value to stream with the space delimiter. More...

Static Public Attributes
static const Enum< operationType >	operationTypeNames_
	Operation type names. More...

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

static bool	postProcess
	Global post-processing mode switch. More...

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing. More...

Protected Member Functions
virtual void	writeFileHeader (const wordList &foNames, const List< wordList > &entries, const List< wordList > &types, Ostream &os) const
	Output file header information. More...

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary. More...

functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

void	operator= (const stateFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

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

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

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

virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time. More...

virtual autoPtr< OFstream >	createFile (const word &name) const
	Return autoPtr to a new file using the simulation start time. More...

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

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

void	operator= (const writeFile &)=delete
	No copy assignment. More...

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. More...

Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry. More...

const fileName	prefix_
	Prefix. More...

word	fileName_
	Name of file. More...

autoPtr< OFstream >	filePtr_
	File pointer. More...

label	writePrecision_
	Write precision. More...

bool	writeToFile_
	Flag to enable/disable writing to file. More...

bool	updateHeader_

bool	writtenHeader_
	Flag to identify whether the header has been written. More...

bool	useUserTime_

scalar	startTime_
	Start time value. More...

Detailed Description

Computes a selected operation between multiple function objects.

The operation is applied to all results of each object.

Note: Each object must generate the same number and type of results.

Usage

Minimal example by using system/controlDict.functions:

multiFieldValue1
{
    // Mandatory entries
    type        multiFieldValue;
    libs        (fieldFunctionObjects);
    operation   average;

    // List of fieldValue function objects as dictionaries
    functions
    {
        region1
        {
            ...
            // Optional
            resultFields        (field1 field2);
        }
        region2
        {
            ...
            // Optional
            resultFields        (field1 field2);
        }

        ...

        regionN
        {
            ...
            // Optional
            resultFields        (field1 field2);
        }
    }

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: multiFieldValue	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`operation`	Operation type to apply to values	word	yes	-
`functions`	List of function objects	dict	yes	-

Options for the operation entry:

sum	:	Sum of values
add	:	Add values (same as sum)
subtract	:	Subtract values from first entry
min	:	Minimum value
max	:	Maximum value
average	:	Average value

The resultFields entry can be used to set the name of the function object result fields to process. If omitted, all available values are employed.

The inherited entries are elaborated in:

Source files

Definition at line 186 of file multiFieldValue.H.

Member Enumeration Documentation

◆ operationType

enum operationType

Operation type enumeration.

Enumerator
opSum	Sum of values.
opAdd	Add values (same as sum)
opSubtract	Subtract values from first entry.
opMin	Minimum value.
opMax	Maximum value.
opAverage	Average value.

Definition at line 196 of file multiFieldValue.H.

Constructor & Destructor Documentation

◆ multiFieldValue() [1/2]

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

Construct from Time and dictionary.

Definition at line 104 of file multiFieldValue.C.

References dict, and multiFieldValue::read().

Here is the call graph for this function:

◆ multiFieldValue() [2/2]

multiFieldValue ( const multiFieldValue & )

delete

No copy construct.

◆ ~multiFieldValue()

virtual ~multiFieldValue ( )

virtualdefault

Destructor.

Member Function Documentation

◆ writeFileHeader()

void writeFileHeader	(	const wordList &	foNames,
		const List< wordList > &	entries,
		const List< wordList > &	types,
		Ostream &	os
	)		const

protectedvirtual

Output file header information.

Definition at line 64 of file multiFieldValue.C.

References Foam::endl(), forAll, Foam::name(), Foam::nl, multiFieldValue::operationTypeNames_, os(), writeFile::writeCommented(), writeFile::writeHeaderValue(), and writeFile::writeTabbed().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "multiFieldValue" )

Run-time type information.

◆ operator=()

void operator= ( const multiFieldValue & )

delete

No copy assignment.

◆ read()

bool read ( const dictionary & dict )

virtual

Read from dictionary.

Reimplemented from writeFile.

Definition at line 122 of file multiFieldValue.C.

References dict, dictionary::dictName(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::getOrDefault(), Foam::Info, Foam::name(), Time::New(), Foam::nl, kEpsilonLopesdaCosta< BasicTurbulenceModel >::read(), IOobject::scopedName(), dictionary::set(), Foam::type(), and WarningInFunction.

Referenced by multiFieldValue::multiFieldValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

bool execute ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 330 of file multiFieldValue.C.

◆ write()

bool write ( )

virtual

Calculate and write.

Implements functionObject.

Definition at line 197 of file multiFieldValue.C.

References e, Foam::endl(), Foam::exit(), f(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), forAll, Log, Foam::name(), Foam::nl, List< T >::resize(), and Foam::type().

Here is the call graph for this function:

Member Data Documentation

◆ operationTypeNames_

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

static

Operation type names.

Definition at line 207 of file multiFieldValue.H.

Referenced by multiFieldValue::writeFileHeader().

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

src/functionObjects/field/multiFieldValue/multiFieldValue.H
src/functionObjects/field/multiFieldValue/multiFieldValue.C
src/functionObjects/field/multiFieldValue/multiFieldValueTemplates.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ operationType

Constructor & Destructor Documentation

◆ multiFieldValue() [1/2]

◆ multiFieldValue() [2/2]

◆ ~multiFieldValue()

Member Function Documentation

◆ writeFileHeader()

◆ TypeName()

◆ operator=()

◆ read()

◆ execute()

◆ write()

Member Data Documentation

◆ operationTypeNames_