writeVTK Class Reference

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

Inheritance diagram for writeVTK:
Collaboration diagram for writeVTK:

Public Member Functions

 TypeName ("writeVTK")
 Runtime type information. More...
 
 writeVTK (const word &name, const Time &t, const dictionary &)
 Construct from Time and dictionary. More...
 
 writeVTK (const writeVTK &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~writeVTK ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the writeVTK data. More...
 
virtual wordList fields () const
 Return the list of fields required. More...
 
virtual bool execute ()
 Execute, currently does nothing. More...
 
virtual bool write ()
 Write the writeVTK. More...
 
void operator= (const writeVTK &)=delete
 Disallow default bitwise assignment. 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...
 
 fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
 fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~fvMeshFunctionObject ()
 Destructor. More...
 
void operator= (const fvMeshFunctionObject &)=delete
 Disallow default bitwise assignment. 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...
 
 regionFunctionObject (const regionFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~regionFunctionObject ()
 Destructor. More...
 
void operator= (const regionFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from functionObject
 ClassName ("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, const Time &runTime)
 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 executeAtStart () const
 Return true if the functionObject should be executed at the start. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual scalar timeToNextAction ()
 Called by Time::adjustTimeStep(). Allows the functionObject to. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update topology using the given map. More...
 
virtual void topoChange (const polyTopoChangeMap &map)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. 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...
 
Switch executeAtStart_
 Switch write log to Info. More...
 
- Static Public Attributes inherited from functionObject
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 >
void cannotFindObject (const word &fieldName)
 Prints a warning message that fieldName cannot be found. More...
 
void cannotFindObject (const word &fieldName)
 Prints a warning message that fieldName cannot be found. More...
 
template<class ObjectType >
const ObjectType & lookupObject (const word &fieldName) const
 Lookup object from the objectRegistry. More...
 
template<class ObjectType >
ObjectType & lookupObjectRef (const word &fieldName)
 Lookup non-const object reference from the objectRegistry. More...
 
template<class ObjectType >
bool store (const tmp< ObjectType > &tfield)
 Store the given field in the objectRegistry. More...
 
template<class ObjectType >
bool store (const 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 objectRegistryobr_
 Reference to the region objectRegistry. More...
 
- Protected Attributes inherited from functionObject
const Timetime_
 Reference to time. 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 93 of file writeVTK.H.

Constructor & Destructor Documentation

◆ writeVTK() [1/2]

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

Construct from Time and dictionary.

◆ writeVTK() [2/2]

writeVTK ( const writeVTK )
delete

Disallow default bitwise copy construction.

◆ ~writeVTK()

virtual ~writeVTK ( )
virtual

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "writeVTK"  )

Runtime type information.

◆ read()

virtual bool read ( const dictionary )
virtual

Read the writeVTK data.

Reimplemented from regionFunctionObject.

◆ fields()

virtual wordList fields ( ) const
virtual

Return the list of fields required.

Implements functionObject.

◆ execute()

virtual bool execute ( )
virtual

Execute, currently does nothing.

Implements functionObject.

◆ write()

virtual bool write ( )
virtual

Write the writeVTK.

Implements functionObject.

◆ operator=()

void operator= ( const writeVTK )
delete

Disallow default bitwise assignment.


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