Public Member Functions | List of all members
ConstantRateDevolatilisation< CloudType > Class Template Reference

Constant rate devolatisation model. More...

Inheritance diagram for ConstantRateDevolatilisation< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for ConstantRateDevolatilisation< CloudType >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("constantRateDevolatilisation")
 Runtime type information. More...
 
 ConstantRateDevolatilisation (const dictionary &dict, CloudType &owner)
 Construct from dictionary. More...
 
 ConstantRateDevolatilisation (const ConstantRateDevolatilisation< CloudType > &dm)
 Construct copy. More...
 
virtual autoPtr< DevolatilisationModel< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~ConstantRateDevolatilisation ()
 Destructor. More...
 
virtual void calculate (const scalar dt, const scalar age, const scalar mass0, const scalar mass, const scalar T, const scalarField &YGasEff, const scalarField &YLiquidEff, const scalarField &YSolidEff, label &canCombust, scalarField &dMassDV) const
 Update model. More...
 
- Public Member Functions inherited from DevolatilisationModel< CloudType >
 TypeName ("devolatilisationModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, DevolatilisationModel, dictionary,( const dictionary &dict, CloudType &owner ),(dict, owner))
 Declare runtime constructor selection table. More...
 
 DevolatilisationModel (CloudType &owner)
 Construct null from owner. More...
 
 DevolatilisationModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from dictionary. More...
 
 DevolatilisationModel (const DevolatilisationModel< CloudType > &dm)
 Construct copy. More...
 
virtual ~DevolatilisationModel ()
 Destructor. More...
 
void addToDevolatilisationMass (const scalar dMass)
 Add to devolatilisation mass. More...
 
virtual void info (Ostream &os)
 Write injection info to stream. More...
 
- Public Member Functions inherited from CloudSubModelBase< CloudType >
 CloudSubModelBase (CloudType &owner)
 Construct null from owner cloud. More...
 
 CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from owner cloud without name. More...
 
 CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from owner cloud with name. More...
 
 CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
 Construct as copy. More...
 
virtual ~CloudSubModelBase ()
 Destructor. More...
 
const CloudTypeowner () const
 Return const access to the owner cloud. More...
 
virtual bool outputTime () const
 Flag to indicate when to write a property. More...
 
CloudTypeowner ()
 Return non-const access to the owner cloud for manipulation. More...
 
virtual void write (Ostream &os) const
 Write. More...
 
- Public Member Functions inherited from subModelBase
 subModelBase (dictionary &properties)
 Construct null. More...
 
 subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from components without name. More...
 
 subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from components with name. More...
 
 subModelBase (const subModelBase &smb)
 Construct as copy. More...
 
virtual ~subModelBase ()
 Destructor. More...
 
const wordmodelName () const
 Return const access to the name of the sub-model. More...
 
const dictionarydict () const
 Return const access to the cloud dictionary. More...
 
const wordbaseName () const
 Return const access to the base name of the sub-model. More...
 
const wordmodelType () const
 Return const access to the sub-model type. More...
 
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionaryproperties () const
 Return const access to the properties dictionary. More...
 
virtual bool defaultCoeffs (const bool printMsg) const
 Returns true if defaultCoeffs is true and outputs on printMsg. More...
 
virtual bool active () const
 Return the model 'active' status - default active = true. More...
 
virtual void cacheFields (const bool store)
 Cache dependant sub-model fields. More...
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
 Retrieve generic property from the base model. More...
 
template<class Type >
void getBaseProperty (const word &entryName, Type &value) const
 Retrieve generic property from the base model. More...
 
template<class Type >
void setBaseProperty (const word &entryName, const Type &value)
 Add generic property to the base model. More...
 
template<class Type >
void getModelProperty (const word &entryName, Type &value) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
Type getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
void setModelProperty (const word &entryName, const Type &value)
 Add generic property to the sub-model. More...
 

Additional Inherited Members

- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 
- Static Public Member Functions inherited from DevolatilisationModel< CloudType >
static autoPtr< DevolatilisationModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 
- Protected Attributes inherited from DevolatilisationModel< CloudType >
scalar dMass_
 Mass of lagrangian phase converted. More...
 
- Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudTypeowner_
 Reference to the cloud. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 Reference to properties dictionary e.g. for restart. More...
 
const dictionary dict_
 Copy of dictionary used during construction. More...
 
const word baseName_
 Name of the sub-model base class. More...
 
const word modelType_
 Type of the sub-model. More...
 
const dictionary coeffDict_
 Coefficients dictionary. More...
 

Detailed Description

template<class CloudType>
class Foam::ConstantRateDevolatilisation< CloudType >

Constant rate devolatisation model.

- need to set vapourisation temperature to 600 K

Definition at line 46 of file ConstantRateDevolatilisation.H.

Constructor & Destructor Documentation

ConstantRateDevolatilisation ( const dictionary dict,
CloudType owner 
)

Construct from dictionary.

Definition at line 32 of file ConstantRateDevolatilisation.C.

References Foam::endl(), forAll, Foam::Info, Foam::nl, and WarningIn.

Here is the call graph for this function:

Construct copy.

Definition at line 80 of file ConstantRateDevolatilisation.C.

Destructor.

Definition at line 95 of file ConstantRateDevolatilisation.C.

References ConstantRateDevolatilisation< CloudType >::calculate().

Referenced by ConstantRateDevolatilisation< CloudType >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

TypeName ( "constantRateDevolatilisation"  )

Runtime type information.

virtual autoPtr<DevolatilisationModel<CloudType> > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements DevolatilisationModel< CloudType >.

Definition at line 87 of file ConstantRateDevolatilisation.H.

References ConstantRateDevolatilisation< CloudType >::calculate(), Foam::T(), and ConstantRateDevolatilisation< CloudType >::~ConstantRateDevolatilisation().

Here is the call graph for this function:

void calculate ( const scalar  dt,
const scalar  age,
const scalar  mass0,
const scalar  mass,
const scalar  T,
const scalarField YGasEff,
const scalarField YLiquidEff,
const scalarField YSolidEff,
label canCombust,
scalarField dMassDV 
) const
virtual

Update model.

Implements DevolatilisationModel< CloudType >.

Definition at line 103 of file ConstantRateDevolatilisation.C.

References forAll, and Foam::min().

Referenced by ConstantRateDevolatilisation< CloudType >::clone(), and ConstantRateDevolatilisation< CloudType >::~ConstantRateDevolatilisation().

Here is the call graph for this function:

Here is the caller graph for this function:


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