Public Member Functions | List of all members
writeVTK Class Reference

This functionObject writes objects registered to the database in VTK format using the foamToVTK library. More...

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

Public Member Functions

 TypeName ("writeVTK")
 Runtime type information. More...
 
 writeVTK (const word &name, const Time &t, const dictionary &)
 Construct from Time and dictionary. More...
 
virtual ~writeVTK ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the writeVTK data. More...
 
virtual bool execute ()
 Execute, currently does nothing. More...
 
virtual bool write ()
 Write the writeVTK. More...
 
- Public Member Functions inherited from fvMeshFunctionObject
 TypeName ("fvMeshFunctionObject")
 Runtime type information. More...
 
 fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
virtual ~fvMeshFunctionObject ()
 Destructor. More...
 
- Public Member Functions inherited from regionFunctionObject
 TypeName ("regionFunctionObject")
 Runtime type information. More...
 
 regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
virtual ~regionFunctionObject ()
 Destructor. 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...
 
- Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool foundObject (const word &fieldName) const
 Find field in the objectRegistry. More...
 
template<class ObjectType >
const ObjectType & lookupObject (const word &fieldName) const
 Lookup field from the objectRegistry. More...
 
template<class ObjectType >
bool store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 Store the given field in the objectRegistry under the given name. More...
 
bool writeObject (const word &fieldName)
 Write field if present in objectRegistry. More...
 
bool clearObject (const word &fieldName)
 Clear field from the objectRegistry if present. More...
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 

Detailed Description

This functionObject writes objects registered to the database in VTK format using the foamToVTK library.

Currently only the writing of the cell-values of volFields is supported but support for other field types, patch fields, Lagrangian data etc. will be added.

Example of function object specification:

    writeVTK1
    {
        type        writeVTK;
        libs ("libutilityFunctionObjects.so");
        ...
        objectNames (obj1 obj2);
    }
Usage
Property Description Required Default value
type type name: writeVTK yes
objectNames objects to write yes
See also
Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::timeControl
Source files

Definition at line 97 of file writeVTK.H.

Constructor & Destructor Documentation

writeVTK ( const word name,
const Time t,
const dictionary  
)

Construct from Time and dictionary.

virtual ~writeVTK ( )
virtual

Destructor.

Member Function Documentation

TypeName ( "writeVTK"  )

Runtime type information.

virtual bool read ( const dictionary )
virtual

Read the writeVTK data.

Reimplemented from regionFunctionObject.

virtual bool execute ( )
virtual

Execute, currently does nothing.

Implements functionObject.

virtual bool write ( )
virtual

Write the writeVTK.

Implements functionObject.


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