DevolatilisationModel< CloudType > Class Template Reference

Templated devolatilisation model class. More...

#include <lagrangianIntermediate/DevolatilisationModel.H>

---

Detailed Description

template<class CloudType>
class Foam::DevolatilisationModel< CloudType >

Templated devolatilisation model class.

Source files

• src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/DevolatilisationModel/DevolatilisationModel.H
• src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/DevolatilisationModel/DevolatilisationModel.C
• src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/DevolatilisationModel/NewDevolatilisationModel.C

Definition at line 53 of file DevolatilisationModel.H.

Inheritance diagram for DevolatilisationModel< CloudType >:

Collaboration diagram for DevolatilisationModel< CloudType >:

List of all members.

Public Member Functions
	TypeName ("DevolatilisationModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, DevolatilisationModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table.
	DevolatilisationModel (CloudType &owner)
	Construct null from owner.
	DevolatilisationModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from dictionary.
virtual	~DevolatilisationModel ()
	Destructor.
const CloudType &	owner () const
	Return the owner cloud object.
const dictionary &	dict () const
	Return the cloud dictionary.
const dictionary &	coeffDict () const
	Return the coefficient dictionary.
virtual bool	active () const =0
	Flag to indicate whether model activates devolatilisation model.
virtual scalar	calculate (const scalar dt, const scalar mass0, const scalar mass, const scalar T, const scalar YVolatile0, const scalar YVolatile, bool &canCombust) const =0
	Update model.
Static Public Member Functions
static autoPtr < DevolatilisationModel < CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector.
Protected Attributes
const dictionary &	dict_
	The cloud dictionary.
CloudType &	owner_
	Reference to the owner cloud class.
const dictionary	coeffDict_
	The coefficient dictionary.

---

Constructor & Destructor Documentation

DevolatilisationModel

(

CloudType &

owner  )

Construct null from owner.

Definition at line 32 of file DevolatilisationModel.C.

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

Construct from dictionary.

Definition at line 44 of file DevolatilisationModel.C.

~DevolatilisationModel

(

)

[virtual]

Destructor.

Definition at line 59 of file DevolatilisationModel.C.

---

Member Function Documentation

TypeName

(

"DevolatilisationModel< CloudType >"

)

Runtime type information.

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

Declare runtime constructor selection table.

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

Selector.

Definition at line 33 of file NewDevolatilisationModel.C.

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

const CloudType & owner

(

)

const

Return the owner cloud object.

Definition at line 65 of file DevolatilisationModel.C.

const Foam::dictionary & dict

(

)

const

Return the cloud dictionary.

Definition at line 72 of file DevolatilisationModel.C.

const Foam::dictionary & coeffDict

(

)

const

Return the coefficient dictionary.

Definition at line 79 of file DevolatilisationModel.C.

virtual bool active

(

)

const [pure virtual]

Flag to indicate whether model activates devolatilisation model.

Implemented in ConstantRateDevolatilisation< CloudType >, NoDevolatilisation< CloudType >, and SingleKineticRateDevolatilisation< CloudType >.

virtual scalar calculate	(	const scalar	dt,
		const scalar	mass0,
		const scalar	mass,
		const scalar	T,
		const scalar	YVolatile0,
		const scalar	YVolatile,
		bool &	canCombust
	)		const [pure virtual]

Update model.

Implemented in ConstantRateDevolatilisation< CloudType >, NoDevolatilisation< CloudType >, and SingleKineticRateDevolatilisation< CloudType >.

---

Member Data Documentation

const dictionary& dict_ [protected]

The cloud dictionary.

Definition at line 60 of file DevolatilisationModel.H.

CloudType& owner_ [protected]

Reference to the owner cloud class.

Definition at line 63 of file DevolatilisationModel.H.

const dictionary coeffDict_ [protected]

The coefficient dictionary.

Definition at line 66 of file DevolatilisationModel.H.

---

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

• src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/DevolatilisationModel/DevolatilisationModel.H
• src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/DevolatilisationModel/DevolatilisationModel.C
• src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/DevolatilisationModel/NewDevolatilisationModel.C