Templated devolatilisation model class. More...

#include <DevolatilisationModel.H>

Inheritance diagram for DevolatilisationModel< CloudType >:

[legend]

Collaboration diagram for DevolatilisationModel< CloudType >:

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.
	DevolatilisationModel (const DevolatilisationModel< CloudType > &dm)
	Construct copy.
virtual autoPtr< DevolatilisationModel< CloudType > >	clone () const =0
	Construct and return a clone.
virtual	~DevolatilisationModel ()
	Destructor.
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 =0
	Update model.
void	addToDevolatilisationMass (const scalar dMass)
	Add to devolatilisation mass.
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< DevolatilisationModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector.

Protected Attributes
scalar	dMass_
	Mass of lagrangian phase converted.
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::DevolatilisationModel< CloudType >

Templated devolatilisation model class.

Source files

Definition at line 54 of file DevolatilisationModel.H.

Constructor & Destructor Documentation

◆ DevolatilisationModel() [1/3]

template<class CloudType>

DevolatilisationModel ( CloudType & owner )

Construct null from owner.

Definition at line 26 of file DevolatilisationModel.C.

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

Referenced by ConstantRateDevolatilisation< CloudType >::ConstantRateDevolatilisation(), ConstantRateDevolatilisation< CloudType >::ConstantRateDevolatilisation(), declareRunTimeSelectionTable(), DevolatilisationModel(), NoDevolatilisation< CloudType >::NoDevolatilisation(), NoDevolatilisation< CloudType >::NoDevolatilisation(), and SingleKineticRateDevolatilisation< CloudType >::SingleKineticRateDevolatilisation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DevolatilisationModel() [2/3]

template<class CloudType>

DevolatilisationModel	(	const dictionary &	dict,
		CloudType &	owner,
		const word &	type )

Construct from dictionary.

Definition at line 37 of file DevolatilisationModel.C.

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

Here is the call graph for this function:

◆ DevolatilisationModel() [3/3]

template<class CloudType>

DevolatilisationModel ( const DevolatilisationModel< CloudType > & dm )

Construct copy.

Definition at line 50 of file DevolatilisationModel.C.

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

Here is the call graph for this function:

◆ ~DevolatilisationModel()

template<class CloudType>

~DevolatilisationModel ( )

virtual

Destructor.

Definition at line 63 of file DevolatilisationModel.C.

Member Function Documentation

◆ TypeName()

template<class CloudType>

TypeName ( "devolatilisationModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

template<class CloudType>

declareRunTimeSelectionTable	(	autoPtr	,
		DevolatilisationModel< CloudType >	,
		dictionary	,
		(const dictionary &dict, CloudType &owner)	,
		(dict, owner)	)

Declare runtime constructor selection table.

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

Here is the call graph for this function:

◆ clone()

template<class CloudType>

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

pure virtual

Construct and return a clone.

Implemented in ConstantRateDevolatilisation< CloudType >, NoDevolatilisation< CloudType >, and SingleKineticRateDevolatilisation< CloudType >.

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

Here is the call graph for this function:

◆ New()

template<class CloudType>

Foam::autoPtr< Foam::DevolatilisationModel< CloudType > > New	(	const dictionary &	dict,
		CloudType &	owner )

static

Selector.

Definition at line 28 of file DevolatilisationModelNew.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 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

pure virtual

Update model.

Implemented in ConstantRateDevolatilisation< CloudType >, NoDevolatilisation< CloudType >, and SingleKineticRateDevolatilisation< CloudType >.

References Foam::T().

Here is the call graph for this function:

◆ addToDevolatilisationMass()

template<class CloudType>

void addToDevolatilisationMass ( const scalar dMass )

Add to devolatilisation mass.

Definition at line 70 of file DevolatilisationModel.C.

References dMass_.

◆ info()

template<class CloudType>

void info ( )

virtual

Write injection info.

Reimplemented from CloudSubModelBase< CloudType >.

Definition at line 80 of file DevolatilisationModel.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

Mass of lagrangian phase converted.

Definition at line 65 of file DevolatilisationModel.H.

Referenced by addToDevolatilisationMass(), DevolatilisationModel(), DevolatilisationModel(), DevolatilisationModel(), and info().

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

src/lagrangian/intermediate/clouds/Templates/ReactingMultiphaseCloud/ReactingMultiphaseCloud.H
src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/DevolatilisationModel/DevolatilisationModel.H
src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/DevolatilisationModel/DevolatilisationModel.C
src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/DevolatilisationModel/DevolatilisationModelNew.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DevolatilisationModel() [1/3]

◆ DevolatilisationModel() [2/3]

◆ DevolatilisationModel() [3/3]

◆ ~DevolatilisationModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ calculate()

◆ addToDevolatilisationMass()

◆ info()

Member Data Documentation

◆ dMass_