sootModel Class Reference

Base class for soot models. More...

#include <sootModel.H>

Inheritance diagram for sootModel:

Collaboration diagram for sootModel:

Public Member Functions
	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.
	sootModel (const dictionary &dict, const fvMesh &mesh, const word &modelType)
	Construct from components.
virtual	~sootModel ()
	Destructor.
const fvMesh &	mesh () const
	Reference to the mesh.
const dictionary &	dict () const
	Reference to the dictionary.
virtual void	correct ()=0
	Main update/correction routine.
virtual const volScalarField &	soot () const =0
	Return const reference to soot.

Static Public Member Functions
static autoPtr< sootModel >	New (const dictionary &dict, const fvMesh &mesh)
	Selector.

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

Detailed Description

Base class for soot models.

Definition at line 49 of file sootModel.H.

Constructor & Destructor Documentation

sootModel()

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

Construct from components.

Definition at line 36 of file sootModel.C.

References dict(), dict_, mesh(), and mesh_.

Referenced by declareRunTimeSelectionTable(), mixtureFractionSoot< ThermoType >::mixtureFractionSoot(), and noSoot::noSoot().

Here is the call graph for this function:

Here is the caller graph for this function:

~sootModel()

~sootModel ( )

virtual

Destructor.

Definition at line 50 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.

References dict(), mesh(), and sootModel().

Here is the call graph for this function:

New()

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

static

Selector.

Definition at line 28 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 128 of file sootModel.H.

References mesh_.

Referenced by declareRunTimeSelectionTable(), mixtureFractionSoot< ThermoType >::mixtureFractionSoot(), mixtureFractionSoot< Foam::gasHThermoPhysics >::mixtureFractionSoot(), New(), noSoot::noSoot(), sootModel(), and noSoot::TypeName().

Here is the caller graph for this function:

dict()

const dictionary & dict ( ) const

inline

Reference to the dictionary.

Definition at line 136 of file sootModel.H.

References dict_.

Referenced by declareRunTimeSelectionTable(), mixtureFractionSoot< ThermoType >::mixtureFractionSoot(), mixtureFractionSoot< Foam::gasHThermoPhysics >::mixtureFractionSoot(), New(), noSoot::noSoot(), sootModel(), and noSoot::TypeName().

Here is the caller graph for this function:

correct()

virtual void correct ( )

pure virtual

Main update/correction routine.

Implemented in mixtureFractionSoot< ThermoType >, mixtureFractionSoot< Foam::gasEThermoPhysics >, mixtureFractionSoot< Foam::gasHThermoPhysics >, mixtureFractionSoot< gasEThermoPhysics >, mixtureFractionSoot< gasHThermoPhysics >, and noSoot.

soot()

virtual const volScalarField & soot ( ) const

pure virtual

Return const reference to soot.

Implemented in mixtureFractionSoot< ThermoType >, mixtureFractionSoot< Foam::gasEThermoPhysics >, mixtureFractionSoot< Foam::gasHThermoPhysics >, mixtureFractionSoot< gasEThermoPhysics >, mixtureFractionSoot< gasHThermoPhysics >, and noSoot.

Member Data Documentation

dict_

const dictionary dict_

protected

Radiation model dictionary.

Definition at line 59 of file sootModel.H.

Referenced by dict(), and sootModel().

mesh_

const fvMesh& mesh_

protected

Reference to the fvMesh.

Definition at line 64 of file sootModel.H.

Referenced by mixtureFractionSoot< ThermoType >::correct(), mesh(), mixtureFractionSoot< ThermoType >::mixtureFractionSoot(), and sootModel().

---

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

• src/thermophysicalModels/radiation/submodels/sootModel/sootModel/sootModel.H
• src/thermophysicalModels/radiation/submodels/sootModel/sootModel/sootModel.C
• src/thermophysicalModels/radiation/submodels/sootModel/sootModel/sootModelNew.C