sootModel Class Reference

Base class for soot models. More...

Inheritance diagram for sootModel:

Collaboration diagram for sootModel:

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 soot models.

Definition at line 50 of file sootModel.H.

Constructor & Destructor Documentation

sootModel()

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

Construct from components.

Definition at line 42 of file sootModel.C.

~sootModel()

~sootModel ( )

virtual

Destructor.

Definition at line 55 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::radiationModels::sootModel > New ( const dictionary &  dict, const fvMesh &  mesh  )

static

Selector.

Definition at line 35 of file sootModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::found(), Foam::Info, dictionary::lookup(), mesh, Foam::nl, List< T >::size(), and WarningInFunction.

Here is the call graph for this function:

mesh()

const fvMesh& mesh ( ) const

inline

Reference to the mesh.

Definition at line 112 of file sootModel.H.

References sootModel::mesh_.

dict()

const dictionary& dict ( ) const

inline

Reference to the dictionary.

Definition at line 118 of file sootModel.H.

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

Here is the call graph for this function:

correct()

virtual void correct ( )

pure virtual

Main update/correction routine.

Implemented in mixtureFraction, and noSoot.

Referenced by sootModel::dict().

Here is the caller graph for this function:

soot()

virtual const volScalarField& soot ( ) const

pure virtual

Return const reference to soot.

Implemented in mixtureFraction, and noSoot.

Referenced by sootModel::dict().

Here is the caller graph for this function:

Member Data Documentation

dict_

const dictionary dict_

protected

Radiation model dictionary.

Definition at line 57 of file sootModel.H.

Referenced by sootModel::dict().

mesh_

const fvMesh& mesh_

protected

Reference to the fvMesh.

Definition at line 60 of file sootModel.H.

Referenced by sootModel::mesh().

---

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

• src/radiationModels/sootModels/sootModel/sootModel.H
• src/radiationModels/sootModels/sootModel/sootModel.C
• src/radiationModels/sootModels/sootModel/sootModelNew.C