HeterogeneousReactingModel< CloudType > Class Template Referenceabstract

Base class for heterogeneous reacting models. More...

Inheritance diagram for HeterogeneousReactingModel< CloudType >:
[legend]
Collaboration diagram for HeterogeneousReactingModel< CloudType >:
[legend]

Public Member Functions

 TypeName ("heterogeneousReactionModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, HeterogeneousReactingModel, dictionary,(const dictionary &dict, CloudType &cloud),(dict, cloud))
 Declare runtime constructor selection table. More...
 
 HeterogeneousReactingModel (CloudType &owner)
 Construct null from owner. More...
 
 HeterogeneousReactingModel (const dictionary &dict, CloudType &cloud, const word &type)
 Construct from dictionary. More...
 
 HeterogeneousReactingModel (const HeterogeneousReactingModel< CloudType > &srm)
 Construct copy. More...
 
virtual autoPtr< HeterogeneousReactingModel< CloudType > > clone () const =0
 Construct and return a clone. More...
 
virtual ~HeterogeneousReactingModel ()=default
 Destructor. More...
 
virtual scalar calculate (const scalar dt, const scalar Re, const scalar nu, const label celli, const scalar d, const scalar T, const scalar Tc, const scalar pc, const scalar rhoc, const scalar mass, const scalarField &YSolid, scalarField &F, const scalar N, scalar &NCpW, scalarField &dMassSolid, scalarField &dMassSRCarrier) const =0
 Update surface reactions. More...
 
void addToSurfaceReactionMass (const scalar dMass)
 Add to devolatilisation mass. More...
 
virtual label nReactions () const =0
 Number of reactions in the model. More...
 
virtual label nF () const
 Number of progress variable. 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 writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. 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 dependent sub-model fields. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. More...
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=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...
 
bool getModelDict (const word &entryName, dictionary &dict) const
 Retrieve dictionary, return true if set. More...
 
template<class Type >
bool 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=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...
 
virtual void write (Ostream &os) const
 Write. More...
 

Static Public Member Functions

static autoPtr< HeterogeneousReactingModel< CloudType > > New (const dictionary &dict, CloudType &cloud)
 Selector. More...
 

Protected Attributes

scalar dMass_
 Net mass of lagrangian phase consumed. More...
 
label nF_
 Number of progress variables. 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...
 

Additional Inherited Members

- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 

Detailed Description

template<class CloudType>
class Foam::HeterogeneousReactingModel< CloudType >

Base class for heterogeneous reacting models.

Source files

Definition at line 59 of file HeterogeneousReactingModel.H.

Constructor & Destructor Documentation

◆ HeterogeneousReactingModel() [1/3]

Construct null from owner.

Definition at line 33 of file HeterogeneousReactingModel.C.

◆ HeterogeneousReactingModel() [2/3]

HeterogeneousReactingModel ( const dictionary dict,
CloudType cloud,
const word type 
)

Construct from dictionary.

Definition at line 45 of file HeterogeneousReactingModel.C.

◆ HeterogeneousReactingModel() [3/3]

Construct copy.

Definition at line 59 of file HeterogeneousReactingModel.C.

◆ ~HeterogeneousReactingModel()

virtual ~HeterogeneousReactingModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "heterogeneousReactionModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
HeterogeneousReactingModel< CloudType ,
dictionary  ,
(const dictionary &dict, CloudType &cloud ,
(dict, cloud  
)

Declare runtime constructor selection table.

◆ clone()

virtual autoPtr< HeterogeneousReactingModel< CloudType > > clone ( ) const
pure virtual

Construct and return a clone.

Implemented in MUCSheterogeneousRate< CloudType >, and NoheterogeneousReacting< CloudType >.

◆ New()

Foam::autoPtr< Foam::HeterogeneousReactingModel< CloudType > > New ( const dictionary dict,
CloudType cloud 
)
static

Selector.

Definition at line 34 of file HeterogeneousReactingModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::Info.

Here is the call graph for this function:

◆ calculate()

virtual scalar calculate ( const scalar  dt,
const scalar  Re,
const scalar  nu,
const label  celli,
const scalar  d,
const scalar  T,
const scalar  Tc,
const scalar  pc,
const scalar  rhoc,
const scalar  mass,
const scalarField YSolid,
scalarField F,
const scalar  N,
scalar &  NCpW,
scalarField dMassSolid,
scalarField dMassSRCarrier 
) const
pure virtual

Update surface reactions.

Returns the heat of reaction

Implemented in MUCSheterogeneousRate< CloudType >, and NoheterogeneousReacting< CloudType >.

◆ addToSurfaceReactionMass()

void addToSurfaceReactionMass ( const scalar  dMass)

Add to devolatilisation mass.

Definition at line 73 of file HeterogeneousReactingModel.C.

◆ nReactions()

virtual label nReactions ( ) const
pure virtual

Number of reactions in the model.

Implemented in MUCSheterogeneousRate< CloudType >, and NoheterogeneousReacting< CloudType >.

◆ nF()

Foam::label nF
virtual

Number of progress variable.

Definition at line 83 of file HeterogeneousReactingModel.C.

◆ info()

void info ( Ostream os)
virtual

Write injection info to stream.

Definition at line 90 of file HeterogeneousReactingModel.C.

References Foam::Info, Foam::nl, and Foam::returnReduce().

Here is the call graph for this function:

Member Data Documentation

◆ dMass_

scalar dMass_
protected

Net mass of lagrangian phase consumed.

Definition at line 68 of file HeterogeneousReactingModel.H.

◆ nF_

label nF_
protected

Number of progress variables.

Definition at line 71 of file HeterogeneousReactingModel.H.


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