Public Member Functions | List of all members
processorField Class Reference

Writes a scalar field whose value is the local processor ID. The output field name is 'processorID'. More...

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

Public Member Functions

 TypeName ("processorField")
 Runtime type information. More...
 
 processorField (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
virtual ~processorField ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the input data. More...
 
virtual bool execute ()
 Calculate the processorID field. More...
 
virtual bool write ()
 Write the processorID field. More...
 
- Public Member Functions inherited from fvMeshFunctionObject
 TypeName ("fvMeshFunctionObject")
 Runtime type information. More...
 
 fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
virtual ~fvMeshFunctionObject ()
 Destructor. 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 setTimeStep ()
 Called by Time::setDeltaT(). Allows the function object to override. More...
 
virtual scalar timeToNextWrite ()
 Called by Time::adjustTimeStep(). Allows the function object to. 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...
 

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...
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 Global post-processing mode switch. 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 Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 

Detailed Description

Writes a scalar field whose value is the local processor ID. The output field name is 'processorID'.

Example of function object specification:

processorField1
{
    type        processorField;
    libs        ("libfieldFunctionObjects.so");
    ...
}
Usage
Property Description Required Default value
type type name: processorField yes
See also
Foam::functionObjects::fvMeshFunctionObject
Source files

Definition at line 80 of file processorField.H.

Constructor & Destructor Documentation

◆ processorField()

processorField ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from Time and dictionary.

Definition at line 45 of file processorField.C.

References Foam::read().

Here is the call graph for this function:

◆ ~processorField()

~processorField ( )
virtual

Destructor.

Definition at line 59 of file processorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "processorField"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read the input data.

Reimplemented from regionFunctionObject.

Definition at line 65 of file processorField.C.

References regionFunctionObject::read().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Calculate the processorID field.

Implements functionObject.

Definition at line 73 of file processorField.C.

References Foam::dimless, UPstream::myProcNo(), and Foam::name().

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Write the processorID field.

Implements functionObject.

Definition at line 96 of file processorField.C.

References Foam::blockMeshTools::write().

Here is the call graph for this function:

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