Public Member Functions | List of all members
writeObjects Class Reference

Allows specification of different writing frequency of objects registered to the database. More...

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

Public Member Functions

 TypeName ("writeObjects")
 Runtime type information. More...
 
 writeObjects (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
virtual ~writeObjects ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the writeObjects data. More...
 
virtual bool execute ()
 Do nothing. More...
 
virtual bool write ()
 Write the registered objects. 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...
 

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

Detailed Description

Allows specification of different writing frequency of objects registered to the database.

It has similar functionality as the main time database through the writeControl setting:

Example of function object specification:

writeObjects1
{
    type        writeObjects;
    libs        ("libutilityFunctionObjects.so");
    exclusiveWriting     true;
    ...
    objects     (obj1 obj2);
}
Usage
Property Description Required Default value
type type name: writeObjects yes
objects 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::functionObjects::timeControl
Source files

Definition at line 115 of file writeObjects.H.

Constructor & Destructor Documentation

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

Construct from Time and dictionary.

Definition at line 52 of file writeObjects.C.

References Foam::read().

Here is the call graph for this function:

~writeObjects ( )
virtual

Destructor.

Definition at line 75 of file writeObjects.C.

Member Function Documentation

TypeName ( "writeObjects"  )

Runtime type information.

bool read ( const dictionary dict)
virtual

Read the writeObjects data.

Reimplemented from functionObject.

Definition at line 81 of file writeObjects.C.

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

Here is the call graph for this function:

bool execute ( )
virtual

Do nothing.

Implements functionObject.

Definition at line 103 of file writeObjects.C.

bool write ( )
virtual

Write the registered objects.

Implements functionObject.

Definition at line 109 of file writeObjects.C.

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

Here is the call graph for this function:


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