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

This function object allows specification of different writing frequency of objects registered to the database. It has similar functionality as the main time database through the outputControl setting: timeStep outputTime adjustableTime runTime clockTime cpuTime. More...

Collaboration diagram for writeRegisteredObject:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("writeRegisteredObject")
 Runtime type information. More...
 
 writeRegisteredObject (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~writeRegisteredObject ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the writeRegisteredObject. More...
 
virtual void read (const dictionary &)
 Read the writeRegisteredObject 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 the writeRegisteredObject. 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

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

Protected Attributes

word name_
 Name of this set of writeRegisteredObject. More...
 
bool exclusiveWriting_
 Takes over the writing from Db. More...
 
const objectRegistryobr_
 Refererence to Db. More...
 
wordReList objectNames_
 Names of objects to control. More...
 

Detailed Description

This function object allows specification of different writing frequency of objects registered to the database. It has similar functionality as the main time database through the outputControl setting: timeStep outputTime adjustableTime runTime clockTime cpuTime.

Example of function object specification:

writeRegisteredObject1
{
    type        writeRegisteredObject;
    functionObjectLibs ("libIOFunctionObjects.so");
    exclusiveWriting     true;
    ...
    objectNames (obj1 obj2);
}


Function object usage

Property Description Required Default value
type type name: writeRegisteredObject yes
objectNames objects to write yes
exclusiveWriting Takes over object writing no yes

exclusiveWriting disables automatic writing (i.e through database) of the objects to avoid duplicate writing.

See also
Foam::functionObject Foam::OutputFilterFunctionObject
Source files

Definition at line 114 of file writeRegisteredObject.H.

Constructor & Destructor Documentation

Disallow default bitwise copy construct.

writeRegisteredObject ( 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 writeRegisteredObject.C.

References Foam::read().

Here is the call graph for this function:

~writeRegisteredObject ( )
virtual

Destructor.

Definition at line 59 of file writeRegisteredObject.C.

Member Function Documentation

void operator= ( const writeRegisteredObject )
protected

Disallow default bitwise assignment.

TypeName ( "writeRegisteredObject"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual
void read ( const dictionary dict)
virtual

Read the writeRegisteredObject data.

Definition at line 65 of file writeRegisteredObject.C.

References dictionary::lookup(), and dictionary::readIfPresent().

Referenced by writeRegisteredObject::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 72 of file writeRegisteredObject.C.

Referenced by writeRegisteredObject::name().

Here is the caller graph for this function:

void end ( )
virtual

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

Definition at line 78 of file writeRegisteredObject.C.

Referenced by writeRegisteredObject::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 84 of file writeRegisteredObject.C.

Referenced by writeRegisteredObject::name().

Here is the caller graph for this function:

void write ( )
virtual

Write the writeRegisteredObject.

Definition at line 90 of file writeRegisteredObject.C.

References Foam::endl(), forAll, Foam::Info, IOobject::name(), Foam::nl, IOobject::NO_WRITE, List< T >::size(), Foam::type(), WarningIn, regIOobject::write(), and IOobject::writeOpt().

Referenced by writeRegisteredObject::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 192 of file writeRegisteredObject.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 196 of file writeRegisteredObject.H.

Member Data Documentation

word name_
protected

Name of this set of writeRegisteredObject.

Definition at line 121 of file writeRegisteredObject.H.

Referenced by writeRegisteredObject::name().

bool exclusiveWriting_
protected

Takes over the writing from Db.

Definition at line 124 of file writeRegisteredObject.H.

const objectRegistry& obr_
protected

Refererence to Db.

Definition at line 127 of file writeRegisteredObject.H.

wordReList objectNames_
protected

Names of objects to control.

Definition at line 132 of file writeRegisteredObject.H.


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