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:
[legend]
Collaboration diagram for sootModel:
[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 fvMesh & mesh () const
 Reference to the mesh. More...
 
const dictionary & dict () const
 Reference to the dictionary. More...
 
virtual void correct ()=0
 Main update/correction routine. More...
 
virtual const volScalarField & soot () const =0
 Return const reference to soot. More...
 

Static Public Member Functions

static autoPtr< sootModel > New (const dictionary &dict, const fvMesh &mesh)
 Selector. More...
 

Protected Attributes

const dictionary dict_
 Radiation model dictionary. More...
 
const fvMesh & mesh_
 Reference to the fvMesh. More...
 

Detailed Description

Base class for soor models.

Definition at line 55 of file sootModel.H.

Constructor & Destructor Documentation

◆ sootModel()

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

Construct from components.

Definition at line 44 of file sootModel.C.

◆ ~sootModel()

~sootModel ( )
virtual

Destructor.

Definition at line 57 of file sootModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "sootModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

◆ New()

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

Selector.

Definition at line 36 of file sootModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and mesh.

Here is the call graph for this function:

◆ mesh()

const fvMesh& mesh ( ) const
inline

Reference to the mesh.

Definition at line 118 of file sootModel.H.

References sootModel::mesh_.

◆ dict()

const dictionary& dict ( ) const
inline

Reference to the dictionary.

Definition at line 124 of file sootModel.H.

References sootModel::dict_.

◆ correct()

virtual void correct ( )
pure virtual

Main update/correction routine.

Implemented in mixtureFractionSoot< ThermoType >, and noSoot.

◆ soot()

virtual const volScalarField& soot ( ) const
pure virtual

Return const reference to soot.

Implemented in mixtureFractionSoot< ThermoType >, and noSoot.

Member Data Documentation

◆ dict_

const dictionary dict_
protected

Radiation model dictionary.

Definition at line 63 of file sootModel.H.

Referenced by sootModel::dict().

◆ mesh_

const fvMesh& mesh_
protected

Reference to the fvMesh.

Definition at line 66 of file sootModel.H.

Referenced by sootModel::mesh().

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