writeDictionary Class Reference

Writes dictionaries on start-up and on change. More...

Inheritance diagram for writeDictionary:
Collaboration diagram for writeDictionary:

Public Member Functions

 TypeName ("writeDictionary")
 Runtime type information. More...
 
 writeDictionary (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 writeDictionary (const writeDictionary &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~writeDictionary ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the writeDictionary data. More...
 
virtual bool execute ()
 Execute, currently does nothing. More...
 
virtual bool write ()
 Write the selected dictionaries. More...
 
void operator= (const writeDictionary &)=delete
 Disallow default bitwise assignment. 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...
 
 functionObject (const functionObject &)=delete
 Disallow default bitwise copy construction. 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...
 
void operator= (const functionObject &)=delete
 Disallow default bitwise assignment. 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

Writes dictionaries on start-up and on change.

Source files

Definition at line 56 of file writeDictionary.H.

Constructor & Destructor Documentation

◆ writeDictionary() [1/2]

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

Construct from Time and dictionary.

Definition at line 101 of file writeDictionary.C.

References Foam::read().

Here is the call graph for this function:

◆ writeDictionary() [2/2]

writeDictionary ( const writeDictionary )
delete

Disallow default bitwise copy construction.

◆ ~writeDictionary()

~writeDictionary ( )
virtual

Destructor.

Definition at line 125 of file writeDictionary.C.

Member Function Documentation

◆ TypeName()

TypeName ( "writeDictionary"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read the writeDictionary data.

Reimplemented from functionObject.

Definition at line 131 of file writeDictionary.C.

References Foam::endl(), forAll, Foam::Info, dictionary::lookup(), Foam::name(), Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Execute, currently does nothing.

Implements functionObject.

Definition at line 157 of file writeDictionary.C.

◆ write()

bool write ( )
virtual

Write the selected dictionaries.

Implements functionObject.

Definition at line 163 of file writeDictionary.C.

References dictionaryName::dictName(), dictionary::digest(), Foam::endl(), forAll, Foam::Info, Foam::name(), Foam::nl, Foam::type(), and IOobject::writeDivider().

Here is the call graph for this function:

◆ operator=()

void operator= ( const writeDictionary )
delete

Disallow default bitwise assignment.


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