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

This function object writes dictionaries on start-up, and on change. More...

Collaboration diagram for writeDictionary:
Collaboration graph
[legend]

Public Member Functions

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

bool tryDirectory (const label dictI, const word &location, bool &firstDict)
 Helper function to write the dictionary if found at location. More...
 
 writeDictionary (const writeDictionary &)
 Disallow default bitwise copy construct. More...
 
void operator= (const writeDictionary &)
 Disallow default bitwise assignment. More...
 

Protected Attributes

word name_
 Name of this set of writeDictionary. More...
 
const objectRegistryobr_
 Reference to the database. More...
 
wordList dictNames_
 Names of dictionaries to monitor. More...
 
List< SHA1Digestdigests_
 List of changed dictionaries (only those registered to database) More...
 

Detailed Description

This function object writes dictionaries on start-up, and on change.

Source files

Definition at line 60 of file writeDictionary.H.

Constructor & Destructor Documentation

writeDictionary ( const writeDictionary )
protected

Disallow default bitwise copy construct.

Referenced by writeDictionary::tryDirectory().

Here is the caller graph for this function:

writeDictionary ( 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 90 of file writeDictionary.C.

References Foam::read().

Here is the call graph for this function:

~writeDictionary ( )
virtual

Destructor.

Definition at line 110 of file writeDictionary.C.

Member Function Documentation

bool tryDirectory ( const label  dictI,
const word location,
bool &  firstDict 
)
protected

Helper function to write the dictionary if found at location.

Definition at line 42 of file writeDictionary.C.

References dict, dictIO(), dictionaryName::dictName(), dictionary::digest(), Foam::endl(), IOobject::headerOk(), Foam::Info, IOobject::MUST_READ, Foam::nl, IOobject::NO_WRITE, Foam::type(), writeDictionary::writeDictionary(), and IOobject::writeDivider().

Here is the call graph for this function:

void operator= ( const writeDictionary )
protected

Disallow default bitwise assignment.

TypeName ( "writeDictionary"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the writeDictionary.

Definition at line 122 of file writeDictionary.H.

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

Here is the call graph for this function:

void read ( const dictionary dict)
virtual

Read the writeDictionary data.

Definition at line 116 of file writeDictionary.C.

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

Referenced by writeDictionary::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 140 of file writeDictionary.C.

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

Referenced by writeDictionary::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 196 of file writeDictionary.C.

Referenced by writeDictionary::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 202 of file writeDictionary.C.

Referenced by writeDictionary::name().

Here is the caller graph for this function:

void write ( )
virtual

Write the writeDictionary.

Definition at line 208 of file writeDictionary.C.

Referenced by writeDictionary::name().

Here is the caller graph for this function:

virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 143 of file writeDictionary.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 147 of file writeDictionary.H.

Member Data Documentation

word name_
protected

Name of this set of writeDictionary.

Definition at line 67 of file writeDictionary.H.

Referenced by writeDictionary::name().

const objectRegistry& obr_
protected

Reference to the database.

Definition at line 70 of file writeDictionary.H.

wordList dictNames_
protected

Names of dictionaries to monitor.

Definition at line 73 of file writeDictionary.H.

List<SHA1Digest> digests_
protected

List of changed dictionaries (only those registered to database)

Definition at line 76 of file writeDictionary.H.


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