Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
fieldValueDelta Class Reference

This function object provides a differencing option between two 'field value' function objects. More...

Inheritance diagram for fieldValueDelta:
Inheritance graph
[legend]
Collaboration diagram for fieldValueDelta:
Collaboration graph
[legend]

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 writeFiles
 writeFiles (const word &name, const Time &time, const dictionary &dict, const word &prefix)
 Construct from name, Time, dictionary and prefix. More...
 
 writeFiles (const word &name, const objectRegistry &obr, const dictionary &dict, const word &prefix)
 Construct from name, objectRegistry, dictionary and prefix. More...
 
virtual ~writeFiles ()
 Destructor. More...
 
const wordListnames () const
 Return const access to the names. More...
 
OFstreamfile ()
 Return access to the file (if only 1) More...
 
PtrList< OFstream > & files ()
 Return access to the files. More...
 
OFstreamfile (const label i)
 Return file 'i'. More...
 
- Public Member Functions inherited from writeFile
 writeFile (const word &name, const Time &t, const dictionary &dict, const word &prefix)
 Construct from name, Time, dictionary and prefix. More...
 
 writeFile (const word &name, const objectRegistry &obr, const dictionary &dict, const word &prefix)
 Construct from name, objectRegistry, dictionary and prefix. More...
 
virtual ~writeFile ()
 Destructor. 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...
 
- 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 wordtype () 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< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () 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...
 

Static Public Attributes

static const NamedEnum< operationType, 5 > operationTypeNames_
 Operation type names. More...
 
- Static Public Attributes inherited from writeFile
static const word outputPrefix
 Directory prefix. More...
 
static label addChars = 7
 Additional characters for writing. More...
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 Global post-processing mode switch. More...
 

Protected Member Functions

virtual void writeFileHeader (const label i)
 Output file header information. More...
 
- Protected Member Functions inherited from writeFiles
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...
 
 writeFiles (const writeFiles &)
 Disallow default bitwise copy construct. More...
 
void operator= (const writeFiles &)
 Disallow default bitwise assignment. More...
 
- Protected Member Functions inherited from writeFile
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 Omanip< int > valueWidth (const label offset=0) const
 Return the value width when writing to stream with optional offset. More...
 
 writeFile (const writeFile &)
 Disallow default bitwise copy construct. More...
 
void operator= (const writeFile &)
 Disallow default bitwise assignment. 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 field 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (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 writeFile
const word prefix_
 Prefix. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 

Detailed Description

This function object provides a differencing option between two 'field value' function objects.

Example of function object specification:

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

    fieldValue1
    {
        ...
    }
    fieldValue2
    {
        ...
    }
}
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::fieldValue
Source files

Definition at line 124 of file fieldValueDelta.H.

Member Enumeration Documentation

Operation type enumeration.

Enumerator
opAdd 
opSubtract 
opMin 
opMax 
opAverage 

Definition at line 130 of file fieldValueDelta.H.

Constructor & Destructor Documentation

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::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::read().

Referenced by fieldValueDelta::writeFileHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

~fieldValueDelta ( )
virtual

Destructor.

Definition at line 127 of file fieldValueDelta.C.

References fieldValueDelta::read().

Here is the call graph for this function:

Member Function Documentation

void writeFileHeader ( const label  i)
protectedvirtual

Output file header information.

Reimplemented from writeFile.

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< Enum, nEnum >::names().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName ( "fieldValueDelta"  )

Run-time type information.

bool read ( const dictionary dict)
virtual

Read from dictionary.

Reimplemented from regionFunctionObject.

Definition at line 134 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:

bool execute ( )
virtual

Do nothing.

Implements functionObject.

Definition at line 206 of file fieldValueDelta.C.

bool write ( )
virtual

Calculate and write.

Reimplemented from writeFiles.

Definition at line 167 of file fieldValueDelta.C.

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

Here is the call graph for this function:

Member Data Documentation

Operation type names.

Definition at line 140 of file fieldValueDelta.H.

Referenced by NamedEnum< Enum, nEnum >::names().


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