FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

IOOutputFilter< OutputFilter > Class Template Reference

IOdictionary wrapper around OutputFilter to allow them to read from their associated dictionaries. More...

#include <OpenFOAM/IOOutputFilter.H>


Detailed Description

template<class OutputFilter>
class Foam::IOOutputFilter< OutputFilter >

IOdictionary wrapper around OutputFilter to allow them to read from their associated dictionaries.

Source files

Definition at line 55 of file IOOutputFilter.H.

Inheritance diagram for IOOutputFilter< OutputFilter >:
Collaboration diagram for IOOutputFilter< OutputFilter >:

List of all members.

Public Member Functions

 IOOutputFilter (const word &outputFilterName, const objectRegistry &, const fileName &dictName=OutputFilter::typeName()+"Dict", const IOobject::readOption rOpt=IOobject::MUST_READ, const bool loadFromFile=false)
 Construct for given objectRegistry and dictionary.
virtual  ~IOOutputFilter ()
 Destructor.
virtual const word &  name () const
 Return name.
virtual bool  read ()
 Read the probes.
virtual void  write ()
 Sample and write.
virtual void  updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh.
virtual void  movePoints (const pointField &points)
 Update for changes of mesh.

Constructor & Destructor Documentation

IOOutputFilter ( const word &   outputFilterName,
const objectRegistry &   obr,
const fileName &   dictName = OutputFilter::typeName() + "Dict",
const IOobject::readOption   rOpt = IOobject::MUST_READ,
const bool   loadFromFile = false  
)

Construct for given objectRegistry and dictionary.

Allow dictionary to be optional Allow the possibility to load fields from files

Definition at line 33 of file IOOutputFilter.C.

~IOOutputFilter (  ) [virtual]

Destructor.

Definition at line 59 of file IOOutputFilter.C.


Member Function Documentation

virtual const word& name (  ) const [inline, virtual]

Return name.

Reimplemented from IOdictionary.

Definition at line 91 of file IOOutputFilter.H.

bool read (  ) [virtual]

Read the probes.

Reimplemented from regIOobject.

Definition at line 66 of file IOOutputFilter.C.

Referenced by IOOutputFilter< OutputFilter >::movePoints(), and IOOutputFilter< OutputFilter >::updateMesh().

void write (  ) [virtual]

Sample and write.

Definition at line 81 of file IOOutputFilter.C.

virtual void updateMesh ( const mapPolyMesh &   mpm  ) [inline, virtual]

Update for changes of mesh.

Definition at line 103 of file IOOutputFilter.H.

References IOOutputFilter< OutputFilter >::read().

virtual void movePoints ( const pointField &   points  ) [inline, virtual]

Update for changes of mesh.

Definition at line 110 of file IOOutputFilter.H.

References IOOutputFilter< OutputFilter >::read().


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