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

Inheritance diagram for fieldValueDelta:

Collaboration diagram for fieldValueDelta:

Public Types
enum	operationType { opAdd, opSubtract, opMin, opMax, opAverage }
	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 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...

virtual	~regionFunctionObject ()
	Destructor. More...

Public Member Functions inherited from 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)
	Construct from components. More...

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

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. 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 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 logFiles
	logFiles (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. 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...

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. 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...

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

Static Public Attributes inherited from functionObject
static int	debug

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

Protected Attributes inherited from regionFunctionObject
const Time &	time_
	Reference to the Time. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. 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 128 of file fieldValueDelta.H.

Member Enumeration Documentation

◆ operationType

enum operationType

Operation type enumeration.

Enumerator
opAdd
opSubtract
opMin
opMax
opAverage

Definition at line 135 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 103 of file fieldValueDelta.C.

References Foam::read().

Referenced by fieldValueDelta::writeFileHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~fieldValueDelta()

~fieldValueDelta ( )

virtual

Destructor.

Definition at line 122 of file fieldValueDelta.C.

References fieldValueDelta::read().

Here is the call graph for this function:

Member Function Documentation

◆ writeFileHeader()

void writeFileHeader ( const label i )

protectedvirtual

Output file header information.

Implements logFiles.

Definition at line 67 of file fieldValueDelta.C.

References Foam::endl(), fieldValueDelta::fieldValueDelta(), Foam::findIndex(), forAll, IOstream::name(), List< T >::size(), and Foam::tab.

Referenced by NamedEnum< directionType, 3 >::names().

Here is the call graph for this function:

Here is the caller 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 129 of file fieldValueDelta.C.

References dictionary::lookup(), Foam::name(), fieldValue::New(), regionFunctionObject::read(), and dictionary::subDict().

Referenced by fieldValueDelta::~fieldValueDelta().

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 201 of file fieldValueDelta.C.

◆ write()

bool write ( )

virtual

Calculate and write.

Reimplemented from logFiles.

Definition at line 162 of file fieldValueDelta.C.

References Foam::endl(), 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 145 of file fieldValueDelta.H.

Referenced by NamedEnum< directionType, 3 >::names().

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()

◆ execute()

◆ write()

Member Data Documentation

◆ operationTypeNames_