FreeFOAM The Cross-Platform CFD Toolkit
DevolatilisationModel< CloudType > Class Template Reference

Templated devolatilisation model class. More...

#include <lagrangianIntermediate/DevolatilisationModel.H>


Detailed Description

+ 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 dictionarydict () const
 Return the cloud dictionary.
const dictionarycoeffDict () 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 dictionarydict_
 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
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 SingleKineticRateDevolatilisation< CloudType >, ConstantRateDevolatilisation< CloudType >, and NoDevolatilisation< 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

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: