Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
sootModel Class Referenceabstract

Base class for soor models. More...

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

Public Member Functions

 TypeName ("sootModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, sootModel, dictionary,( const dictionary &dict, const fvMesh &mesh, const word &modelType ),(dict, mesh, modelType))
 Declare runtime constructor selection table. More...
 
 sootModel (const dictionary &dict, const fvMesh &mesh, const word &modelType)
 Construct from components. More...
 
virtual ~sootModel ()
 Destructor. More...
 
const fvMeshmesh () const
 Reference to the mesh. More...
 
const dictionarydict () const
 Reference to the dictionary. More...
 
virtual void correct ()=0
 Main update/correction routine. More...
 
virtual const volScalarFieldsoot () const =0
 Return const reference to soot. More...
 

Static Public Member Functions

static autoPtr< sootModelNew (const dictionary &dict, const fvMesh &mesh)
 Selector. More...
 

Protected Attributes

const dictionary dict_
 Radiation model dictionary. More...
 
const fvMeshmesh_
 Reference to the fvMesh. More...
 

Detailed Description

Base class for soor models.

Definition at line 53 of file sootModel.H.

Constructor & Destructor Documentation

sootModel ( const dictionary dict,
const fvMesh mesh,
const word modelType 
)

Construct from components.

Definition at line 42 of file sootModel.C.

~sootModel ( )
virtual

Destructor.

Definition at line 55 of file sootModel.C.

Member Function Documentation

TypeName ( "sootModel"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
sootModel  ,
dictionary  ,
( const dictionary &dict, const fvMesh &mesh, const word &modelType )  ,
(dict, mesh, modelType)   
)

Declare runtime constructor selection table.

Foam::autoPtr< Foam::radiation::sootModel > New ( const dictionary dict,
const fvMesh mesh 
)
static

Selector.

Definition at line 33 of file sootModelNew.C.

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

Here is the call graph for this function:

const fvMesh& mesh ( ) const
inline

Reference to the mesh.

Definition at line 116 of file sootModel.H.

References sootModel::mesh_.

const dictionary& dict ( ) const
inline

Reference to the dictionary.

Definition at line 122 of file sootModel.H.

References sootModel::correct(), sootModel::dict_, and sootModel::soot().

Here is the call graph for this function:

virtual void correct ( )
pure virtual

Main update/correction routine.

Implemented in mixtureFractionSoot< ThermoType >, and noSoot.

Referenced by sootModel::dict().

Here is the caller graph for this function:

virtual const volScalarField& soot ( ) const
pure virtual

Return const reference to soot.

Implemented in mixtureFractionSoot< ThermoType >, and noSoot.

Referenced by sootModel::dict().

Here is the caller graph for this function:

Member Data Documentation

const dictionary dict_
protected

Radiation model dictionary.

Definition at line 61 of file sootModel.H.

Referenced by sootModel::dict().

const fvMesh& mesh_
protected

Reference to the fvMesh.

Definition at line 64 of file sootModel.H.

Referenced by sootModel::mesh().


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