Base class for heterogeneous reacting models. More...

#include <HeterogeneousReactingModel.H>

Inheritance diagram for HeterogeneousReactingModel< CloudType >:

[legend]

Collaboration diagram for HeterogeneousReactingModel< CloudType >:

Public Member Functions
	TypeName ("heterogeneousReactionModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, HeterogeneousReactingModel, dictionary,(const dictionary &dict, CloudType &cloud),(dict, cloud))
	Declare runtime constructor selection table.
	HeterogeneousReactingModel (CloudType &owner)
	Construct null from owner.
	HeterogeneousReactingModel (const dictionary &dict, CloudType &cloud, const word &type)
	Construct from dictionary.
	HeterogeneousReactingModel (const HeterogeneousReactingModel< CloudType > &srm)
	Construct copy.
virtual autoPtr< HeterogeneousReactingModel< CloudType > >	clone () const =0
	Construct and return a clone.
virtual	~HeterogeneousReactingModel ()=default
	Destructor.
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.
void	addToSurfaceReactionMass (const scalar dMass)
	Add to devolatilisation mass.
virtual label	nReactions () const =0
	Number of reactions in the model.
virtual label	nF () const
	Number of progress variable.
virtual void	info ()
	Write injection info.
Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud.
	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name.
	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name.
	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Construct as copy.
virtual	~CloudSubModelBase ()=default
	Destructor.
const CloudType &	owner () const
	Return const access to the owner cloud.
virtual bool	writeTime () const
	Flag to indicate when to write a property.
virtual fileName	localPath () const
	Output directory.
CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation.
virtual void	write (Ostream &os) const
	Write to os.
Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null.
	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name.
	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name.
	subModelBase (const subModelBase &smb)
	Construct as copy.
virtual	~subModelBase ()=default
	Destructor.
const word &	modelName () const
	Return const access to the name of the sub-model.
const dictionary &	dict () const
	Return const access to the cloud dictionary.
const word &	baseName () const
	Return const access to the base name of the sub-model.
const word &	modelType () const
	Return const access to the sub-model type.
const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary.
const dictionary &	properties () const
	Return const access to the properties dictionary.
virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg.
virtual bool	active () const
	Return the model 'active' status - default active = true.
virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields.
template<class Type>
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the base model.
template<class Type>
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model.
template<class Type>
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model.
bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set.
template<class Type>
bool	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model.
template<class Type>
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the sub-model.
template<class Type>
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model.

Static Public Member Functions
static autoPtr< HeterogeneousReactingModel< CloudType > >	New (const dictionary &dict, CloudType &cloud)
	Selector.

Protected Attributes
scalar	dMass_
	Net mass of lagrangian phase consumed.
label	nF_
	Number of progress variables.
Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud.
Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model.
dictionary &	properties_
	Reference to properties dictionary e.g. for restart.
const dictionary	dict_
	Copy of dictionary used during construction.
const word	baseName_
	Name of the sub-model base class.
const word	modelType_
	Type of the sub-model.
const dictionary	coeffDict_
	Coefficients dictionary.

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

Detailed Description

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

Base class for heterogeneous reacting models.

Source files

Definition at line 55 of file HeterogeneousReactingModel.H.

Constructor & Destructor Documentation

◆ HeterogeneousReactingModel() [1/3]

template<class CloudType>

HeterogeneousReactingModel ( CloudType & owner )

Construct null from owner.

Definition at line 26 of file HeterogeneousReactingModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), dMass_, nF_, and CloudSubModelBase< CloudType >::owner().

Referenced by declareRunTimeSelectionTable(), HeterogeneousReactingModel(), MUCSheterogeneousRate< CloudType >::MUCSheterogeneousRate(), MUCSheterogeneousRate< CloudType >::MUCSheterogeneousRate(), NoheterogeneousReacting< CloudType >::NoheterogeneousReacting(), and NoheterogeneousReacting< CloudType >::NoheterogeneousReacting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HeterogeneousReactingModel() [2/3]

template<class CloudType>

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

Construct from dictionary.

Definition at line 38 of file HeterogeneousReactingModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), subModelBase::coeffDict(), subModelBase::dict(), dMass_, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, nF_, and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

◆ HeterogeneousReactingModel() [3/3]

template<class CloudType>

HeterogeneousReactingModel ( const HeterogeneousReactingModel< CloudType > & srm )

Construct copy.

Definition at line 52 of file HeterogeneousReactingModel.C.

References CloudSubModelBase< CloudType >::CloudSubModelBase(), dMass_, HeterogeneousReactingModel(), and nF_.

Here is the call graph for this function:

◆ ~HeterogeneousReactingModel()

template<class CloudType>

virtual ~HeterogeneousReactingModel ( )

virtualdefault

Destructor.

References subModelBase::dict().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

template<class CloudType>

TypeName ( "heterogeneousReactionModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

template<class CloudType>

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

Declare runtime constructor selection table.

References subModelBase::dict(), HeterogeneousReactingModel(), and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

◆ clone()

template<class CloudType>

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

pure virtual

Construct and return a clone.

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

◆ New()

template<class CloudType>

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

static

Selector.

Definition at line 27 of file HeterogeneousReactingModelNew.C.

References subModelBase::dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, subModelBase::modelType(), and CloudSubModelBase< CloudType >::owner().

Here is the call graph for this function:

◆ calculate()

template<class CloudType>

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

References F(), N(), nu, Foam::Re(), and Foam::T().

Here is the call graph for this function:

◆ addToSurfaceReactionMass()

template<class CloudType>

void addToSurfaceReactionMass ( const scalar dMass )

Add to devolatilisation mass.

Definition at line 66 of file HeterogeneousReactingModel.C.

References dMass_.

◆ nReactions()

template<class CloudType>

virtual label nReactions ( ) const

pure virtual

Number of reactions in the model.

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

◆ nF()

template<class CloudType>

Foam::label nF ( ) const

virtual

Number of progress variable.

Definition at line 76 of file HeterogeneousReactingModel.C.

References nF_.

◆ info()

template<class CloudType>

void info ( )

virtual

Write injection info.

Reimplemented from CloudSubModelBase< CloudType >.

Definition at line 83 of file HeterogeneousReactingModel.C.

References dMass_, subModelBase::getBaseProperty(), CloudSubModelBase< CloudType >::info(), Log_, Foam::nl, Foam::returnReduce(), subModelBase::setBaseProperty(), and CloudSubModelBase< CloudType >::writeTime().

Here is the call graph for this function:

Member Data Documentation

◆ dMass_

template<class CloudType>

scalar dMass_

protected

Net mass of lagrangian phase consumed.

Definition at line 66 of file HeterogeneousReactingModel.H.

Referenced by addToSurfaceReactionMass(), HeterogeneousReactingModel(), HeterogeneousReactingModel(), HeterogeneousReactingModel(), and info().

◆ nF_

template<class CloudType>

label nF_

protected

Number of progress variables.

Definition at line 71 of file HeterogeneousReactingModel.H.

Referenced by HeterogeneousReactingModel(), HeterogeneousReactingModel(), HeterogeneousReactingModel(), and nF().

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

src/lagrangian/intermediate/clouds/Templates/ReactingHeterogeneousCloud/ReactingHeterogeneousCloud.H
src/lagrangian/intermediate/submodels/HeterogeneousReactingModel/HeterogeneousReactingModel/HeterogeneousReactingModel.H
src/lagrangian/intermediate/submodels/HeterogeneousReactingModel/HeterogeneousReactingModel/HeterogeneousReactingModel.C
src/lagrangian/intermediate/submodels/HeterogeneousReactingModel/HeterogeneousReactingModel/HeterogeneousReactingModelNew.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HeterogeneousReactingModel() [1/3]

◆ HeterogeneousReactingModel() [2/3]

◆ HeterogeneousReactingModel() [3/3]

◆ ~HeterogeneousReactingModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ calculate()

◆ addToSurfaceReactionMass()

◆ nReactions()

◆ nF()

◆ info()

Member Data Documentation

◆ dMass_

◆ nF_