Multiphase variant of the reacting parcel class with one/two-way coupling with the continuous phase. More...

Collaboration diagram for ReactingMultiphaseParcel:

Data Structures
class	constantProperties
	Class to hold reacting multiphase particle constant properties. More...

class	iNew
	Factory class to read-construct particles used for. More...

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

	AddToPropertyList (ParcelType, " nGas(Y1..YN)"+" nLiquid(Y1..YN)"+" nSolid(Y1..YN)")
	String representation of properties. More...

	ReactingMultiphaseParcel (const polyMesh &mesh, const vector &position, const label cellI, const label tetFaceI, const label tetPtI)
	Construct from owner, position, and cloud owner. More...

	ReactingMultiphaseParcel (const polyMesh &mesh, const vector &position, const label cellI, const label tetFaceI, const label tetPtI, const label typeId, const scalar nParticle0, const scalar d0, const scalar dTarget0, const vector &U0, const vector &f0, const vector &angularMomentum0, const vector &torque0, const scalarField &Y0, const scalarField &YGas0, const scalarField &YLiquid0, const scalarField &YSolid0, const constantProperties &constProps)
	Construct from components. More...

	ReactingMultiphaseParcel (const polyMesh &mesh, Istream &is, bool readFields=true)
	Construct from Istream. More...

	ReactingMultiphaseParcel (const ReactingMultiphaseParcel &p)
	Construct as a copy. More...

	ReactingMultiphaseParcel (const ReactingMultiphaseParcel &p, const polyMesh &mesh)
	Construct as a copy. More...

virtual autoPtr< particle >	clone () const
	Construct and return a (basic particle) clone. More...

virtual autoPtr< particle >	clone (const polyMesh &mesh) const
	Construct and return a (basic particle) clone. More...

const scalarField &	YGas () const
	Return const access to mass fractions of gases. More...

const scalarField &	YLiquid () const
	Return const access to mass fractions of liquids. More...

const scalarField &	YSolid () const
	Return const access to mass fractions of solids. More...

label	canCombust () const
	Return const access to the canCombust flag. More...

scalarField &	YGas ()
	Return access to mass fractions of gases. More...

scalarField &	YLiquid ()
	Return access to mass fractions of liquids. More...

scalarField &	YSolid ()
	Return access to mass fractions of solids. More...

label &	canCombust ()
	Return access to the canCombust flag. More...

template<class TrackData >
void	setCellValues (TrackData &td, const scalar dt, const label cellI)
	Set cell values. More...

template<class TrackData >
void	cellValueSourceCorrection (TrackData &td, const scalar dt, const label cellI)
	Correct cell values using latest transfer information. More...

template<class TrackData >
void	calc (TrackData &td, const scalar dt, const label cellI)
	Update parcel properties over the time interval. More...

template<class TrackData >
Foam::scalar	CpEff (TrackData &td, const scalar p, const scalar T, const label idG, const label idL, const label idS) const

template<class TrackData >
Foam::scalar	HsEff (TrackData &td, const scalar p, const scalar T, const label idG, const label idL, const label idS) const

template<class TrackData >
Foam::scalar	LEff (TrackData &td, const scalar p, const scalar T, const label idG, const label idL, const label idS) const

Static Public Member Functions
template<class CloudType , class CompositionType >
static void	readFields (CloudType &c, const CompositionType &compModel)
	Read. More...

template<class CloudType >
static void	readFields (CloudType &c)
	Read - no composition. More...

template<class CloudType , class CompositionType >
static void	writeFields (const CloudType &c, const CompositionType &compModel)
	Write. More...

template<class CloudType >
static void	writeFields (const CloudType &c)
	Read - composition supplied. More...

Static Public Attributes
static const label	GAS

static const label	LIQ

static const label	SLD

Protected Member Functions
template<class TrackData >
void	calcDevolatilisation (TrackData &td, const scalar dt, const scalar age, const scalar Ts, const scalar d, const scalar T, const scalar mass, const scalar mass0, const scalarField &YGasEff, const scalarField &YLiquidEff, const scalarField &YSolidEff, label &canCombust, scalarField &dMassDV, scalar &Sh, scalar &N, scalar &NCpW, scalarField &Cs) const
	Calculate Devolatilisation. More...

template<class TrackData >
void	calcSurfaceReactions (TrackData &td, const scalar dt, const label cellI, const scalar d, const scalar T, const scalar mass, const label canCombust, const scalar N, const scalarField &YMix, const scalarField &YGas, const scalarField &YLiquid, const scalarField &YSolid, scalarField &dMassSRGas, scalarField &dMassSRLiquid, scalarField &dMassSRSolid, scalarField &dMassSRCarrier, scalar &Sh, scalar &dhsTrans) const
	Calculate surface reactions. More...

Protected Attributes
scalarField	YGas_
	Mass fractions of gases []. More...

scalarField	YLiquid_
	Mass fractions of liquids []. More...

scalarField	YSolid_
	Mass fractions of solids []. More...

label	canCombust_
	Flag to identify if the particle can devolatilise and combust. More...

Private Member Functions
template<class TrackData >
scalar	CpEff (TrackData &td, const scalar p, const scalar T, const label idG, const label idL, const label idS) const
	Return the mixture effective specific heat capacity. More...

template<class TrackData >
scalar	HsEff (TrackData &td, const scalar p, const scalar T, const label idG, const label idL, const label idS) const
	Return the mixture effective sensible enthalpy. More...

template<class TrackData >
scalar	LEff (TrackData &td, const scalar p, const scalar T, const label idG, const label idL, const label idS) const
	Return the mixture effective latent heat. More...

scalar	updateMassFractions (const scalar mass0, const scalarField &dMassGas, const scalarField &dMassLiquid, const scalarField &dMassSolid)
	Update the mass fractions (Y, YGas, YLiquid, YSolid) More...

Static Private Attributes
static const std::size_t	sizeofFields_
	Size in bytes of the fields. More...

Friends
Ostream &	operator (Ostream &, const ReactingMultiphaseParcel< ParcelType > &)

Detailed Description

Multiphase variant of the reacting parcel class with one/two-way coupling with the continuous phase.

Source files

Definition at line 50 of file ReactingMultiphaseParcel.H.

Constructor & Destructor Documentation

◆ ReactingMultiphaseParcel() [1/5]

ReactingMultiphaseParcel	(	const polyMesh &	mesh,
		const vector &	position,
		const label	cellI,
		const label	tetFaceI,
		const label	tetPtI
	)

inline

Construct from owner, position, and cloud owner.

Other properties initialised as null

Definition at line 69 of file ReactingMultiphaseParcelI.H.

Referenced by ReactingMultiphaseParcel::clone().

Here is the caller graph for this function:

◆ ReactingMultiphaseParcel() [2/5]

ReactingMultiphaseParcel	(	const polyMesh &	mesh,
		const vector &	position,
		const label	cellI,
		const label	tetFaceI,
		const label	tetPtI,
		const label	typeId,
		const scalar	nParticle0,
		const scalar	d0,
		const scalar	dTarget0,
		const vector &	U0,
		const vector &	f0,
		const vector &	angularMomentum0,
		const vector &	torque0,
		const scalarField &	Y0,
		const scalarField &	YGas0,
		const scalarField &	YLiquid0,
		const scalarField &	YSolid0,
		const constantProperties &	constProps
	)

inline

Construct from components.

Definition at line 87 of file ReactingMultiphaseParcelI.H.

◆ ReactingMultiphaseParcel() [3/5]

ReactingMultiphaseParcel	(	const polyMesh &	mesh,
		Istream &	is,
		bool	readFields = `true`
	)

Construct from Istream.

◆ ReactingMultiphaseParcel() [4/5]

ReactingMultiphaseParcel ( const ReactingMultiphaseParcel & p )

Construct as a copy.

◆ ReactingMultiphaseParcel() [5/5]

ReactingMultiphaseParcel	(	const ReactingMultiphaseParcel &	p,
		const polyMesh &	mesh
	)

Construct as a copy.

Member Function Documentation

◆ CpEff() [1/2]

scalar CpEff	(	TrackData &	td,
		const scalar	p,
		const scalar	T,
		const label	idG,
		const label	idL,
		const label	idS
	)		const

private

Return the mixture effective specific heat capacity.

◆ HsEff() [1/2]

scalar HsEff	(	TrackData &	td,
		const scalar	p,
		const scalar	T,
		const label	idG,
		const label	idL,
		const label	idS
	)		const

private

Return the mixture effective sensible enthalpy.

◆ LEff() [1/2]

scalar LEff	(	TrackData &	td,
		const scalar	p,
		const scalar	T,
		const label	idG,
		const label	idL,
		const label	idS
	)		const

private

Return the mixture effective latent heat.

◆ updateMassFractions()

Foam::scalar updateMassFractions	(	const scalar	mass0,
		const scalarField &	dMassGas,
		const scalarField &	dMassLiquid,
		const scalarField &	dMassSolid
	)

private

Update the mass fractions (Y, YGas, YLiquid, YSolid)

Definition at line 104 of file ReactingMultiphaseParcel.C.

References Foam::max(), and Foam::sum().

Here is the call graph for this function:

◆ calcDevolatilisation()

void calcDevolatilisation	(	TrackData &	td,
		const scalar	dt,
		const scalar	age,
		const scalar	Ts,
		const scalar	d,
		const scalar	T,
		const scalar	mass,
		const scalar	mass0,
		const scalarField &	YGasEff,
		const scalarField &	YLiquidEff,
		const scalarField &	YSolidEff,
		label &	canCombust,
		scalarField &	dMassDV,
		scalar &	Sh,
		scalar &	N,
		scalar &	NCpW,
		scalarField &	Cs
	)		const

protected

Calculate Devolatilisation.

Definition at line 496 of file ReactingMultiphaseParcel.C.

References beta(), Foam::cbrt(), composition, forAll, Foam::max(), N, Foam::pow(), Foam::constant::thermodynamic::RR, Sh, Foam::sqr(), Foam::sqrt(), Foam::sum(), and Foam::T().

Here is the call graph for this function:

◆ calcSurfaceReactions()

void calcSurfaceReactions	(	TrackData &	td,
		const scalar	dt,
		const label	cellI,
		const scalar	d,
		const scalar	T,
		const scalar	mass,
		const label	canCombust,
		const scalar	N,
		const scalarField &	YMix,
		const scalarField &	YGas,
		const scalarField &	YLiquid,
		const scalarField &	YSolid,
		scalarField &	dMassSRGas,
		scalarField &	dMassSRLiquid,
		scalarField &	dMassSRSolid,
		scalarField &	dMassSRCarrier,
		scalar &	Sh,
		scalar &	dhsTrans
	)		const

protected

Calculate surface reactions.

Definition at line 597 of file ReactingMultiphaseParcel.C.

References coeff, Foam::min(), N, Sh, Foam::sum(), and Foam::T().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "ReactingMultiphaseParcel" )

Runtime type information.

◆ AddToPropertyList()

AddToPropertyList	(	ParcelType	,
		" nGas(Y1..YN)"+" nLiquid(Y1..YN)"+" nSolid(Y1..YN)"
	)

String representation of properties.

◆ clone() [1/2]

virtual autoPtr<particle> clone ( ) const

inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 326 of file ReactingMultiphaseParcel.H.

References ReactingMultiphaseParcel::ReactingMultiphaseParcel().

Here is the call graph for this function:

◆ clone() [2/2]

virtual autoPtr<particle> clone ( const polyMesh & mesh ) const

inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 332 of file ReactingMultiphaseParcel.H.

References mesh, and ReactingMultiphaseParcel::ReactingMultiphaseParcel().

Here is the call graph for this function:

◆ YGas() [1/2]

const Foam::scalarField & YGas ( ) const

inline

Return const access to mass fractions of gases.

Definition at line 173 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel::YGas_.

Referenced by ReactingMultiphaseParcel::writeFields().

Here is the caller graph for this function:

◆ YLiquid() [1/2]

const Foam::scalarField & YLiquid ( ) const

inline

Return const access to mass fractions of liquids.

Definition at line 181 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel::YLiquid_.

Referenced by ReactingMultiphaseParcel::writeFields().

Here is the caller graph for this function:

◆ YSolid() [1/2]

const Foam::scalarField & YSolid ( ) const

inline

Return const access to mass fractions of solids.

Definition at line 189 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel::YSolid_.

Referenced by ReactingMultiphaseParcel::writeFields().

Here is the caller graph for this function:

◆ canCombust() [1/2]

Foam::label canCombust ( ) const

inline

Return const access to the canCombust flag.

Definition at line 197 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel::canCombust_.

◆ YGas() [2/2]

Foam::scalarField & YGas ( )

inline

Return access to mass fractions of gases.

Definition at line 204 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel::YGas_.

◆ YLiquid() [2/2]

Foam::scalarField & YLiquid ( )

inline

Return access to mass fractions of liquids.

Definition at line 211 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel::YLiquid_.

◆ YSolid() [2/2]

Foam::scalarField & YSolid ( )

inline

Return access to mass fractions of solids.

Definition at line 218 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel::YSolid_.

◆ canCombust() [2/2]

Foam::label & canCombust ( )

inline

Return access to the canCombust flag.

Definition at line 225 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel::canCombust_.

◆ setCellValues()

void setCellValues	(	TrackData &	td,
		const scalar	dt,
		const label	cellI
	)

Set cell values.

Definition at line 141 of file ReactingMultiphaseParcel.C.

◆ cellValueSourceCorrection()

void cellValueSourceCorrection	(	TrackData &	td,
		const scalar	dt,
		const label	cellI
	)

Correct cell values using latest transfer information.

Definition at line 154 of file ReactingMultiphaseParcel.C.

◆ calc()

void calc	(	TrackData &	td,
		const scalar	dt,
		const label	cellI
	)

Update parcel properties over the time interval.

Definition at line 168 of file ReactingMultiphaseParcel.C.

References Foam::cbrt(), composition, forAll, Foam::constant::mathematical::pi(), Foam::pow4(), Foam::Re(), Sh, Foam::fvc::Su(), Foam::sum(), and Vector< scalar >::zero.

Here is the call graph for this function:

◆ readFields() [1/2]

void readFields	(	CloudType &	c,
		const CompositionType &	compModel
	)

static

Read.

Definition at line 106 of file ReactingMultiphaseParcelIO.C.

References Foam::constant::universal::c, forAll, forAllIter, IOobject::MUST_READ, p, readFields(), and List::size().

Here is the call graph for this function:

◆ readFields() [2/2]

void readFields ( CloudType & c )

static

Read - no composition.

Definition at line 92 of file ReactingMultiphaseParcelIO.C.

References Foam::constant::universal::c, and readFields().

Here is the call graph for this function:

◆ writeFields() [1/2]

void writeFields	(	const CloudType &	c,
		const CompositionType &	compModel
	)

static

Write.

Definition at line 222 of file ReactingMultiphaseParcelIO.C.

References Foam::constant::universal::c, forAll, forAllConstIter(), IOobject::NO_READ, regIOobject::write(), ReactingMultiphaseParcel::YGas(), ReactingMultiphaseParcel::YLiquid(), and ReactingMultiphaseParcel::YSolid().

Here is the call graph for this function:

◆ writeFields() [2/2]

void writeFields ( const CloudType & c )

static

Read - composition supplied.

Definition at line 213 of file ReactingMultiphaseParcelIO.C.

References Foam::constant::universal::c.

◆ CpEff() [2/2]

Foam::scalar CpEff	(	TrackData &	td,
		const scalar	p,
		const scalar	T,
		const label	idG,
		const label	idL,
		const label	idS
	)		const

Definition at line 48 of file ReactingMultiphaseParcel.C.

References p, and Foam::T().

Here is the call graph for this function:

◆ HsEff() [2/2]

Foam::scalar HsEff	(	TrackData &	td,
		const scalar	p,
		const scalar	T,
		const label	idG,
		const label	idL,
		const label	idS
	)		const

Definition at line 67 of file ReactingMultiphaseParcel.C.

References p, and Foam::T().

Here is the call graph for this function:

◆ LEff() [2/2]

Foam::scalar LEff	(	TrackData &	td,
		const scalar	p,
		const scalar	T,
		const label	idG,
		const label	idL,
		const label	idS
	)		const

Definition at line 86 of file ReactingMultiphaseParcel.C.

References p, and Foam::T().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

Ostream& operator	(	Ostream &	,
		const ReactingMultiphaseParcel< ParcelType > &
	)

friend

Field Documentation

◆ sizeofFields_

const std::size_t sizeofFields_

staticprivate

Size in bytes of the fields.

Definition at line 71 of file ReactingMultiphaseParcel.H.

◆ GAS

const Foam::label GAS

static

Definition at line 78 of file ReactingMultiphaseParcel.H.

◆ LIQ

const Foam::label LIQ

static

Definition at line 79 of file ReactingMultiphaseParcel.H.

◆ SLD

const Foam::label SLD

static

Definition at line 80 of file ReactingMultiphaseParcel.H.

◆ YGas_

scalarField YGas_

protected

Mass fractions of gases [].

Definition at line 186 of file ReactingMultiphaseParcel.H.

Referenced by ReactingMultiphaseParcel::YGas().

◆ YLiquid_

scalarField YLiquid_

protected

Mass fractions of liquids [].

Definition at line 189 of file ReactingMultiphaseParcel.H.

Referenced by ReactingMultiphaseParcel::YLiquid().

◆ YSolid_

scalarField YSolid_

protected

Mass fractions of solids [].

Definition at line 192 of file ReactingMultiphaseParcel.H.

Referenced by ReactingMultiphaseParcel::YSolid().

◆ canCombust_

label canCombust_

protected

Flag to identify if the particle can devolatilise and combust.

Combustion possible only after volatile content falls below threshold value. States include: 0 = can devolatilise, cannot combust but can change 1 = can devolatilise, can combust -1 = cannot devolatilise or combust, and cannot change

Definition at line 200 of file ReactingMultiphaseParcel.H.

Referenced by ReactingMultiphaseParcel::canCombust().

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

src/lagrangian/intermediate/parcels/Templates/ReactingMultiphaseParcel/ReactingMultiphaseParcel.H
src/lagrangian/intermediate/parcels/Templates/ReactingMultiphaseParcel/ReactingMultiphaseParcel.C
src/lagrangian/intermediate/parcels/Templates/ReactingMultiphaseParcel/ReactingMultiphaseParcelI.H
src/lagrangian/intermediate/parcels/Templates/ReactingMultiphaseParcel/ReactingMultiphaseParcelIO.C

Data Structures

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ReactingMultiphaseParcel() [1/5]

◆ ReactingMultiphaseParcel() [2/5]

◆ ReactingMultiphaseParcel() [3/5]

◆ ReactingMultiphaseParcel() [4/5]

◆ ReactingMultiphaseParcel() [5/5]

Member Function Documentation

◆ CpEff() [1/2]

◆ HsEff() [1/2]

◆ LEff() [1/2]

◆ updateMassFractions()

◆ calcDevolatilisation()

◆ calcSurfaceReactions()

◆ TypeName()

◆ AddToPropertyList()

◆ clone() [1/2]

◆ clone() [2/2]

◆ YGas() [1/2]

◆ YLiquid() [1/2]

◆ YSolid() [1/2]

◆ canCombust() [1/2]

◆ YGas() [2/2]

◆ YLiquid() [2/2]

◆ YSolid() [2/2]

◆ canCombust() [2/2]

◆ setCellValues()

◆ cellValueSourceCorrection()

◆ calc()

◆ readFields() [1/2]

◆ readFields() [2/2]

◆ writeFields() [1/2]

◆ writeFields() [2/2]

◆ CpEff() [2/2]

◆ HsEff() [2/2]

◆ LEff() [2/2]

Friends And Related Function Documentation

◆ operator

Field Documentation

◆ sizeofFields_

◆ GAS

◆ LIQ

◆ SLD

◆ YGas_

◆ YLiquid_

◆ YSolid_

◆ canCombust_