Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
processorField Class Reference

This function object writes a scalar field whose value is the local processor ID. The output field name is 'processorID'. More...

Collaboration diagram for processorField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("processorField")
 Runtime type information. More...
 
 processorField (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~processorField ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the processorField object. More...
 
virtual void read (const dictionary &)
 Read the input data. More...
 
virtual void execute ()
 Execute, currently does nothing. More...
 
virtual void end ()
 Execute at the final time-loop, currently does nothing. More...
 
virtual void timeSet ()
 Called when time was set at the end of the Time::operator++. More...
 
virtual void write ()
 Write. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &)
 Update for changes of mesh. More...
 

Protected Member Functions

 processorField (const processorField &)
 Disallow default bitwise copy construct. More...
 
void operator= (const processorField &)
 Disallow default bitwise assignment. More...
 

Protected Attributes

word name_
 Name of this set of nearWallFields object. More...
 
const objectRegistryobr_
 Reference to the database. More...
 
bool active_
 on/off switch More...
 

Detailed Description

This function object 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;
    functionObjectLibs ("libfieldFunctionObjects.so");
    ...
}


Function object usage

Property Description Required Default value
type type name: processorField yes
See also
Foam::functionObject Foam::OutputFilterFunctionObject
Source files

Definition at line 92 of file processorField.H.

Constructor & Destructor Documentation

processorField ( const processorField )
protected

Disallow default bitwise copy construct.

processorField ( const word name,
const objectRegistry obr,
const dictionary dict,
const bool  loadFromFiles = false 
)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 41 of file processorField.C.

References Foam::dimless, Foam::endl(), mesh, IOobject::NO_READ, IOobject::NO_WRITE, Foam::read(), fvMesh::time(), Time::timeName(), and WarningIn.

Here is the call graph for this function:

~processorField ( )
virtual

Destructor.

Definition at line 98 of file processorField.C.

Member Function Documentation

void operator= ( const processorField )
protected

Disallow default bitwise assignment.

TypeName ( "processorField"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the processorField object.

Definition at line 143 of file processorField.H.

References processorField::end(), processorField::execute(), processorField::name_, processorField::read(), processorField::timeSet(), and processorField::write().

Here is the call graph for this function:

void read ( const dictionary dict)
virtual

Read the input data.

Definition at line 104 of file processorField.C.

Referenced by processorField::name().

Here is the caller graph for this function:

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 110 of file processorField.C.

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

Referenced by processorField::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void end ( )
virtual

Execute at the final time-loop, currently does nothing.

Definition at line 123 of file processorField.C.

Referenced by processorField::name().

Here is the caller graph for this function:

void timeSet ( )
virtual

Called when time was set at the end of the Time::operator++.

Definition at line 132 of file processorField.C.

Referenced by processorField::name().

Here is the caller graph for this function:

void write ( )
virtual

Write.

Definition at line 138 of file processorField.C.

References regIOobject::write().

Referenced by processorField::name().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 164 of file processorField.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 168 of file processorField.H.

Member Data Documentation

word name_
protected

Name of this set of nearWallFields object.

Definition at line 99 of file processorField.H.

Referenced by processorField::name().

const objectRegistry& obr_
protected

Reference to the database.

Definition at line 102 of file processorField.H.

bool active_
protected

on/off switch

Definition at line 105 of file processorField.H.


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