Provides a differencing option between two 'field value' function objects. More...

Inheritance diagram for fieldValueDelta:

Collaboration diagram for fieldValueDelta:

[legend]

Public Types
enum class	operationType { add , subtract , min , max , average }
	Operation type enumeration. More...

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

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

virtual	~fieldValueDelta ()
	Destructor. More...

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

virtual wordList	fields () const
	Return the list of fields required. More...

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

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

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information. More...

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

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

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

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

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

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const Time &runTime)
	Construct from components. More...

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

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

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

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

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

virtual scalar	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual void	movePoints (const polyMesh &mesh)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &map)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

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

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

	logFiles (const logFiles &)=delete
	Disallow default bitwise copy construction. More...

virtual	~logFiles ()
	Destructor. More...

const wordList &	names () const
	Return const access to the names. More...

PtrList< OFstream > &	files ()
	Return access to the files. More...

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

OFstream &	file (const label i)
	Return file 'i'. More...

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

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

	writeFile (const writeFile &)=delete
	Disallow default bitwise copy construction. More...

	~writeFile ()
	Destructor. More...

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

Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset. 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...

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

Static Public Attributes
static const NamedEnum< operationType, 5 >	operationTypeNames_
	Operation type names. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Static Public Attributes inherited from writeFile
static const word	outputPrefix
	Directory prefix. More...

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

Protected Member Functions
virtual void	writeFileHeader (const label i)
	Output file header information. More...

Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
bool	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
bool	store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Member Functions inherited from logFiles
virtual void	createFiles ()
	Create the output file. More...

virtual void	resetNames (const wordList &names)
	Reset the list of names from a wordList. More...

virtual void	resetName (const word &name)
	Reset the list of names to a single name entry. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch write log to Info. More...

Protected Attributes inherited from regionFunctionObject
const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Protected Attributes inherited from logFiles
wordList	names_
	File names. More...

PtrList< OFstream >	filePtrs_
	File pointer. More...

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

const word	prefix_
	Prefix. More...

Detailed Description

Provides a differencing option between two 'field value' function objects.

Example of function object specification:

fieldValueDelta1
{
    type            fieldValueDelta;
    libs            ("libfieldFunctionObjects.so");
    operation       subtract;

    region1
    {
        ...
    }

    region2
    {
        ...
    }
}

Usage

Property	Description	Required	Default value
`type`	type name: fieldValueDelta	yes

The operation is one of:

add	:	add
subtract	:	subtract
min	:	minimum
max	:	maximum
average	:	average

See also: Foam::functionObject Foam::functionObject::fieldValue Foam::functionObjects::regionFunctionObject Foam::functionObjects::logFiles

Source files

Definition at line 125 of file fieldValueDelta.H.

Member Enumeration Documentation

◆ operationType

enum operationType

strong

Operation type enumeration.

Enumerator
add
subtract
min
max
average

Definition at line 132 of file fieldValueDelta.H.

Constructor & Destructor Documentation

◆ fieldValueDelta()

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

Construct from Time and dictionary.

Definition at line 102 of file fieldValueDelta.C.

References dict, and fieldValueDelta::read().

Here is the call graph for this function:

◆ ~fieldValueDelta()

~fieldValueDelta ( )

virtual

Destructor.

Definition at line 121 of file fieldValueDelta.C.

Member Function Documentation

◆ writeFileHeader()

void writeFileHeader ( const label i )

protectedvirtual

Output file header information.

Implements logFiles.

Definition at line 66 of file fieldValueDelta.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::append(), Foam::endl(), logFiles::file(), Foam::findIndex(), forAll, fieldValueDelta::operationTypeNames_, List< T >::size(), Foam::tab, writeFile::writeCommented(), and writeFile::writeHeaderValue().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "fieldValueDelta" )

Run-time type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read from dictionary.

Reimplemented from regionFunctionObject.

Definition at line 127 of file fieldValueDelta.C.

References dict, Foam::name(), fieldValue::New(), and regionFunctionObject::read().

Referenced by fieldValueDelta::fieldValueDelta().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fields()

Foam::wordList fields ( ) const

virtual

Return the list of fields required.

Implements functionObject.

Definition at line 164 of file fieldValueDelta.C.

◆ execute()

bool execute ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 209 of file fieldValueDelta.C.

◆ write()

bool write ( )

virtual

Calculate and write.

Reimplemented from logFiles.

Definition at line 170 of file fieldValueDelta.C.

References Foam::endl(), Foam::file, found, Log, UPstream::master(), Foam::name(), Foam::type(), and logFiles::write().

Here is the call graph for this function:

Member Data Documentation

◆ operationTypeNames_

const Foam::NamedEnum< Foam::functionObjects::fieldValues::fieldValueDelta::operationType, 5 > operationTypeNames_

static

Operation type names.

Definition at line 142 of file fieldValueDelta.H.

Referenced by fieldValueDelta::writeFileHeader().

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

src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H
src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.C
src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDeltaTemplates.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ operationType

Constructor & Destructor Documentation

◆ fieldValueDelta()

◆ ~fieldValueDelta()

Member Function Documentation

◆ writeFileHeader()

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

Member Data Documentation

◆ operationTypeNames_