Dummy surface reaction model for 'none'. More...

Inheritance diagram for NoSurfaceReaction< CloudType >:

Collaboration diagram for NoSurfaceReaction< CloudType >:

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

	NoSurfaceReaction (const dictionary &dict, CloudType &owner)
	Construct from dictionary. More...

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

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

virtual	~NoSurfaceReaction ()
	Destructor. More...

virtual scalar	calculate (const scalar dt, 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
	Update surface reactions. More...

virtual void	info (Ostream &os)
	Write injection info to stream. More...

Public Member Functions inherited from SurfaceReactionModel< CloudType >
	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	~SurfaceReactionModel ()
	Destructor. More...

void	addToSurfaceReactionMass (const scalar dMass)
	Add to devolatilisation mass. 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)
	Copy constructor. 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...

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)
	Copy constructor. 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 void	cacheFields (const bool store)
	Cache dependent 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...

void	operator= (const subModelBase &)=delete
	Disallow default bitwise assignment. 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 SurfaceReactionModel< CloudType >
static autoPtr< SurfaceReactionModel< CloudType > >	New (const dictionary &dict, CloudType &cloud)
	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 SurfaceReactionModel< CloudType >
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...

Detailed Description

template<class CloudType>
class Foam::NoSurfaceReaction< CloudType >

Dummy surface reaction model for 'none'.

Definition at line 46 of file NoSurfaceReaction.H.

Constructor & Destructor Documentation

◆ NoSurfaceReaction() [1/2]

NoSurfaceReaction	(	const dictionary &	dict,
		CloudType &	owner
	)

Construct from dictionary.

Definition at line 32 of file NoSurfaceReaction.C.

◆ NoSurfaceReaction() [2/2]

NoSurfaceReaction ( const NoSurfaceReaction< CloudType > & srm )

Construct copy.

Definition at line 43 of file NoSurfaceReaction.C.

◆ ~NoSurfaceReaction()

~NoSurfaceReaction ( )

virtual

Destructor.

Definition at line 54 of file NoSurfaceReaction.C.

References NoSurfaceReaction< CloudType >::calculate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "none" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Implements SurfaceReactionModel< CloudType >.

Definition at line 65 of file NoSurfaceReaction.H.

References NoSurfaceReaction< CloudType >::calculate(), NoSurfaceReaction< CloudType >::info(), N, rhoc(), Foam::T(), and NoSurfaceReaction< CloudType >::~NoSurfaceReaction().

Here is the call graph for this function:

◆ calculate()

Foam::scalar calculate	(	const scalar	dt,
		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

virtual

Update surface reactions.

Implements SurfaceReactionModel< CloudType >.

Definition at line 62 of file NoSurfaceReaction.C.

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

Here is the caller graph for this function:

◆ info()

void info ( Ostream & os )

virtual

Write injection info to stream.

Reimplemented from SurfaceReactionModel< CloudType >.

Definition at line 87 of file NoSurfaceReaction.C.

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

Here is the caller graph for this function:

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

src/lagrangian/parcel/submodels/ReactingMultiphase/SurfaceReactionModel/NoSurfaceReaction/NoSurfaceReaction.H
src/lagrangian/parcel/submodels/ReactingMultiphase/SurfaceReactionModel/NoSurfaceReaction/NoSurfaceReaction.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::NoSurfaceReaction< CloudType >

Constructor & Destructor Documentation

◆ NoSurfaceReaction() [1/2]

◆ NoSurfaceReaction() [2/2]

◆ ~NoSurfaceReaction()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ calculate()

◆ info()

template<class CloudType>
class Foam::NoSurfaceReaction< CloudType >