FreeFOAM The Cross-Platform CFD Toolkit
writeRegisteredObject Class Reference

Takes over the writing of registered IO objects. More...

#include <IOFunctionObjects/writeRegisteredObject.H>


Detailed Description

+ Collaboration diagram for writeRegisteredObject:

List of all members.

Public Member Functions

 TypeName ("writeRegisteredObject")
 Runtime type information.
 writeRegisteredObject (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary.
virtual ~writeRegisteredObject ()
 Destructor.
virtual const wordname () const
 Return name of the writeRegisteredObject.
virtual void read (const dictionary &)
 Read the writeRegisteredObject data.
virtual void execute ()
 Execute, currently does nothing.
virtual void end ()
 Execute at the final time-loop, currently does nothing.
virtual void write ()
 Write the writeRegisteredObject.
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh.
virtual void movePoints (const pointField &)
 Update for changes of mesh.

Protected Member Functions

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

Protected Attributes

word name_
 Name of this set of writeRegisteredObject.
const objectRegistryobr_
bool active_
 On/off switch.
wordList objectNames_
 Names of objects to control.

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.

~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

Return name of the writeRegisteredObject.

Definition at line 114 of file writeRegisteredObject.H.

References writeRegisteredObject::name_.

void read ( const dictionary dict)
virtual

Read the writeRegisteredObject data.

Definition at line 65 of file writeRegisteredObject.C.

References dictionary::lookup().

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 74 of file writeRegisteredObject.C.

void end ( )
virtual

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

Definition at line 80 of file writeRegisteredObject.C.

void write ( )
virtual
virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 132 of file writeRegisteredObject.H.

virtual void movePoints ( const pointField )
inlinevirtual

Update for changes of mesh.

Definition at line 136 of file writeRegisteredObject.H.


Member Data Documentation

word name_
protected

Name of this set of writeRegisteredObject.

Definition at line 64 of file writeRegisteredObject.H.

Referenced by writeRegisteredObject::name().

const objectRegistry& obr_
protected

Definition at line 66 of file writeRegisteredObject.H.

bool active_
protected

On/off switch.

Definition at line 69 of file writeRegisteredObject.H.

wordList objectNames_
protected

Names of objects to control.

Definition at line 75 of file writeRegisteredObject.H.


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