Templated surface reaction model class. More...

Inheritance diagram for SurfaceReactionModel< CloudType >:

Collaboration diagram for SurfaceReactionModel< CloudType >:

Public Member Functions
	TypeName ("surfaceReactionModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, SurfaceReactionModel, dictionary,(const dictionary &dict, CloudType &cloud),(dict, cloud))
	Declare runtime constructor selection table. More...

	SurfaceReactionModel (CloudType &owner)
	Construct null from owner. More...

	SurfaceReactionModel (const dictionary &dict, CloudType &cloud, const word &type)
	Construct from dictionary. More...

	SurfaceReactionModel (const SurfaceReactionModel< CloudType > &srm)
	Construct copy. More...

virtual autoPtr< SurfaceReactionModel< CloudType > >	clone () const =0
	Construct and return a clone. More...

virtual	~SurfaceReactionModel ()=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 &YGas, const scalarField &YLiquid, const scalarField &YSolid, const scalarField &YMixture, const scalar N, scalarField &dMassGas, scalarField &dMassLiquid, scalarField &dMassSolid, scalarField &dMassSRCarrier) const =0
	Update surface reactions. More...

void	addToSurfaceReactionMass (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 CloudType &	owner () 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...

CloudType &	owner ()
	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 word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () 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< SurfaceReactionModel< CloudType > >	New (const dictionary &dict, CloudType &cloud)
	Selector. More...

Protected Attributes
scalar	dMass_
	Mass of lagrangian phase converted. More...

Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud. More...

Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	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::SurfaceReactionModel< CloudType >

Templated surface reaction model class.

Source files

Definition at line 60 of file SurfaceReactionModel.H.

Constructor & Destructor Documentation

◆ SurfaceReactionModel() [1/3]

SurfaceReactionModel ( CloudType & owner )

Construct null from owner.

Definition at line 34 of file SurfaceReactionModel.C.

◆ SurfaceReactionModel() [2/3]

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

Construct from dictionary.

Definition at line 45 of file SurfaceReactionModel.C.

◆ SurfaceReactionModel() [3/3]

SurfaceReactionModel ( const SurfaceReactionModel< CloudType > & srm )

Construct copy.

Definition at line 58 of file SurfaceReactionModel.C.

◆ ~SurfaceReactionModel()

virtual ~SurfaceReactionModel ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceReactionModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

◆ clone()

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

pure virtual

Construct and return a clone.

Implemented in COxidationDiffusionLimitedRate< CloudType >, COxidationHurtMitchell< CloudType >, COxidationIntrinsicRate< CloudType >, COxidationKineticDiffusionLimitedRate< CloudType >, COxidationMurphyShaddix< CloudType >, and NoSurfaceReaction< CloudType >.

◆ New()

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

static

Selector.

Definition at line 35 of file SurfaceReactionModelNew.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 &	YGas,
		const scalarField &	YLiquid,
		const scalarField &	YSolid,
		const scalarField &	YMixture,
		const scalar	N,
		scalarField &	dMassGas,
		scalarField &	dMassLiquid,
		scalarField &	dMassSolid,
		scalarField &	dMassSRCarrier
	)		const

pure virtual

Update surface reactions.

Returns the heat of reaction

Implemented in COxidationDiffusionLimitedRate< CloudType >, COxidationHurtMitchell< CloudType >, COxidationIntrinsicRate< CloudType >, COxidationKineticDiffusionLimitedRate< CloudType >, COxidationMurphyShaddix< CloudType >, and NoSurfaceReaction< CloudType >.

◆ addToSurfaceReactionMass()

void addToSurfaceReactionMass ( const scalar dMass )

Add to devolatilisation mass.

Definition at line 71 of file SurfaceReactionModel.C.

◆ info()

void info ( Ostream & os )

virtual

Write injection info to stream.

Definition at line 81 of file SurfaceReactionModel.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ dMass_

scalar dMass_

protected

Mass of lagrangian phase converted.

Definition at line 69 of file SurfaceReactionModel.H.

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

src/lagrangian/intermediate/clouds/Templates/ReactingMultiphaseCloud/ReactingMultiphaseCloud.H
src/lagrangian/intermediate/submodels/ReactingMultiphase/SurfaceReactionModel/SurfaceReactionModel/SurfaceReactionModel.H
src/lagrangian/intermediate/submodels/ReactingMultiphase/SurfaceReactionModel/SurfaceReactionModel/SurfaceReactionModel.C
src/lagrangian/intermediate/submodels/ReactingMultiphase/SurfaceReactionModel/SurfaceReactionModel/SurfaceReactionModelNew.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members