FreeFOAM The Cross-Platform CFD Toolkit
Public Member Functions | Static Public Member Functions | Protected Member Functions
PostProcessingModel< CloudType > Class Template Reference

Templated post-processing model class. More...

#include <lagrangianIntermediate/PostProcessingModel.H>

Detailed Description

template<class CloudType>
class Foam::PostProcessingModel< CloudType >

Templated post-processing model class.

Source files

Definition at line 53 of file PostProcessingModel.H.

+ Inheritance diagram for PostProcessingModel< CloudType >:

List of all members.

Public Member Functions

 TypeName ("PostProcessingModel")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, PostProcessingModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table.
 PostProcessingModel (CloudType &owner)
 Construct null from owner.
 PostProcessingModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from dictionary.
virtual ~PostProcessingModel ()
 Destructor.
const dictionary & dict () const
 Return the owner cloud dictionary.
const CloudType & owner () const
 Return const access the owner cloud object.
CloudType & owner ()
 Return non-const access the owner cloud object for manipulation.
const dictionary & coeffDict () const
 Return the coefficients dictionary.
virtual void post ()
 Main post-processing function.
virtual bool active () const =0
 Flag to indicate whether model activates post-processing model.
virtual void postPatch (const typename CloudType::parcelType &p, const label patchI)=0
 Gather post-processing info on patch.

Static Public Member Functions

static autoPtr
< PostProcessingModel
< CloudType > > 		New (const dictionary &dict, CloudType &owner)
 Selector.

Protected Member Functions

virtual void write ()=0
 Write post-processing info.

Constructor & Destructor Documentation

PostProcessingModel ( CloudType &  owner)

Construct null from owner.

Definition at line 31 of file PostProcessingModel.C.

PostProcessingModel ( const dictionary &  dict,
CloudType &  owner,
const word &  type 
)

Construct from dictionary.

Definition at line 41 of file PostProcessingModel.C.

~PostProcessingModel ( )
virtual

Destructor.

Definition at line 56 of file PostProcessingModel.C.

Member Function Documentation

virtual void write ( )
protectedpure virtual

Write post-processing info.

Implemented in PatchPostProcessing< CloudType >, and NoPostProcessing< CloudType >.

TypeName ( "PostProcessingModel< CloudType >"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
PostProcessingModel< CloudType >  ,
dictionary  ,
(const dictionary &dict, CloudType &owner)  ,
(dict, owner)   
)

Declare runtime constructor selection table.

Foam::autoPtr< Foam::PostProcessingModel< CloudType > > New ( const dictionary &  dict,
CloudType &  owner 
)
static

Selector.

Definition at line 33 of file NewPostProcessingModel.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), and Foam::nl.

const Foam::dictionary & dict ( ) const
inline

Return the owner cloud dictionary.

Definition at line 27 of file PostProcessingModelI.H.

const CloudType & owner ( ) const
inline

Return const access the owner cloud object.

Definition at line 34 of file PostProcessingModelI.H.

CloudType & owner ( )
inline

Return non-const access the owner cloud object for manipulation.

Definition at line 41 of file PostProcessingModelI.H.

const Foam::dictionary & coeffDict ( ) const
inline

Return the coefficients dictionary.

Definition at line 48 of file PostProcessingModelI.H.

void post ( )
virtual

Main post-processing function.

Definition at line 63 of file PostProcessingModel.C.

virtual bool active ( ) const
pure virtual

Flag to indicate whether model activates post-processing model.

Implemented in PatchPostProcessing< CloudType >, and NoPostProcessing< CloudType >.

virtual void postPatch ( const typename CloudType::parcelType &  p,
const label  patchI 
)
pure virtual

Gather post-processing info on patch.

Implemented in NoPostProcessing< CloudType >.

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