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

Inheritance diagram for ReactingMultiphaseParcel< ParcelType >:

Collaboration diagram for ReactingMultiphaseParcel< ParcelType >:

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

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

Public Types
typedef ParcelType::trackingData	trackingData
	Use base tracking data. More...

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

	ReactingMultiphaseParcel (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti)
	Construct from mesh, position and topology. More...

	ReactingMultiphaseParcel (const polyMesh &mesh, const vector &position, const label celli)
	Construct from a position and a cell, searching for the rest of the. 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 TrackCloudType >
void	setCellValues (TrackCloudType &cloud, trackingData &td)
	Set cell values. More...

template<class TrackCloudType >
void	cellValueSourceCorrection (TrackCloudType &cloud, trackingData &td, const scalar dt)
	Correct cell values using latest transfer information. More...

template<class TrackCloudType >
void	calc (TrackCloudType &cloud, trackingData &td, const scalar dt)
	Update parcel properties over the time interval. More...

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

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

template<class TrackCloudType >
Foam::scalar	LEff (TrackCloudType &cloud, trackingData &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 TrackCloudType >
void	calcDevolatilisation (TrackCloudType &cloud, trackingData &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 TrackCloudType >
void	calcSurfaceReactions (TrackCloudType &cloud, trackingData &td, const scalar dt, 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...

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

Detailed Description

template<class ParcelType>
class Foam::ReactingMultiphaseParcel< ParcelType >

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.

Member Typedef Documentation

◆ trackingData

typedef ParcelType::trackingData trackingData

Use base tracking data.

Definition at line 138 of file ReactingMultiphaseParcel.H.

Constructor & Destructor Documentation

◆ ReactingMultiphaseParcel() [1/5]

ReactingMultiphaseParcel	(	const polyMesh &	mesh,
		const barycentric &	coordinates,
		const label	celli,
		const label	tetFacei,
		const label	tetPti
	)

inline

Construct from mesh, position and topology.

Other properties initialised as null

Definition at line 69 of file ReactingMultiphaseParcelI.H.

Referenced by ReactingMultiphaseParcel< ParcelType >::calcSurfaceReactions(), ReactingMultiphaseParcel< ParcelType >::clone(), and ReactingMultiphaseParcel< ParcelType >::constantProperties::constantProperties().

Here is the caller graph for this function:

◆ ReactingMultiphaseParcel() [2/5]

ReactingMultiphaseParcel	(	const polyMesh &	mesh,
		const vector &	position,
		const label	celli
	)

inline

Construct from a position and a cell, searching for the rest of the.

required topology. Other properties are initialised as null.

Definition at line 87 of file ReactingMultiphaseParcelI.H.

◆ ReactingMultiphaseParcel() [3/5]

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

Construct from Istream.

Definition at line 46 of file ReactingMultiphaseParcelIO.C.

References IOstream::check(), and DynamicList< T, SizeInc, SizeMult, SizeDiv >::transfer().

Here is the call graph for this function:

◆ ReactingMultiphaseParcel() [4/5]

ReactingMultiphaseParcel ( const ReactingMultiphaseParcel< ParcelType > & p )

Construct as a copy.

◆ ReactingMultiphaseParcel() [5/5]

ReactingMultiphaseParcel	(	const ReactingMultiphaseParcel< ParcelType > &	p,
		const polyMesh &	mesh
	)

Construct as a copy.

Member Function Documentation

◆ calcDevolatilisation()

void calcDevolatilisation	(	TrackCloudType &	cloud,
		trackingData &	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 502 of file ReactingMultiphaseParcel.C.

References ReactingMultiphaseParcel< ParcelType >::calcSurfaceReactions(), CompositionModel< CloudType >::carrier(), Foam::cbrt(), composition, Cp(), forAll, Foam::isType(), CompositionModel< CloudType >::localToCarrierId(), Foam::max(), Foam::pow(), Foam::constant::physicoChemical::RR, Foam::sqr(), Foam::sqrt(), Foam::sum(), and W().

Referenced by ReactingMultiphaseParcel< ParcelType >::calc().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcSurfaceReactions()

void calcSurfaceReactions	(	TrackCloudType &	cloud,
		trackingData &	td,
		const scalar	dt,
		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 619 of file ReactingMultiphaseParcel.C.

References ReactingMultiphaseParcel< ParcelType >::canCombust_, Foam::isType(), mesh, Foam::min(), N, ReactingMultiphaseParcel< ParcelType >::ReactingMultiphaseParcel(), Foam::sum(), ReactingMultiphaseParcel< ParcelType >::YGas_, ReactingMultiphaseParcel< ParcelType >::YLiquid_, and ReactingMultiphaseParcel< ParcelType >::YSolid_.

Referenced by ReactingMultiphaseParcel< ParcelType >::calcDevolatilisation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 324 of file ReactingMultiphaseParcel.H.

References ReactingMultiphaseParcel< ParcelType >::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 330 of file ReactingMultiphaseParcel.H.

References ReactingMultiphaseParcel< ParcelType >::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 141 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel< ParcelType >::YGas_, and ReactingMultiphaseParcel< ParcelType >::YLiquid().

Referenced by ReactingMultiphaseParcel< ParcelType >::constantProperties::hRetentionCoeff(), ReactingMultiphaseParcel< ParcelType >::iNew::operator()(), and ReactingMultiphaseParcel< ParcelType >::writeFields().

Here is the call graph for this function:

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 149 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel< ParcelType >::YLiquid_, and ReactingMultiphaseParcel< ParcelType >::YSolid().

Referenced by ReactingMultiphaseParcel< ParcelType >::iNew::operator()(), ReactingMultiphaseParcel< ParcelType >::writeFields(), and ReactingMultiphaseParcel< ParcelType >::YGas().

Here is the call graph for this function:

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 157 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel< ParcelType >::YSolid_.

Referenced by ReactingMultiphaseParcel< ParcelType >::iNew::operator()(), ReactingMultiphaseParcel< ParcelType >::writeFields(), and ReactingMultiphaseParcel< ParcelType >::YLiquid().

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 165 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel< ParcelType >::canCombust_.

Referenced by ReactingMultiphaseParcel< ParcelType >::iNew::operator()().

Here is the caller graph for this function:

◆ YGas() [2/2]

Foam::scalarField & YGas ( )

inline

Return access to mass fractions of gases.

Definition at line 172 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel< ParcelType >::YGas_.

◆ YLiquid() [2/2]

Foam::scalarField & YLiquid ( )

inline

Return access to mass fractions of liquids.

Definition at line 179 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel< ParcelType >::YLiquid_.

◆ YSolid() [2/2]

Foam::scalarField & YSolid ( )

inline

Return access to mass fractions of solids.

Definition at line 186 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel< ParcelType >::YSolid_.

◆ canCombust() [2/2]

Foam::label & canCombust ( )

inline

Return access to the canCombust flag.

Definition at line 193 of file ReactingMultiphaseParcelI.H.

References ReactingMultiphaseParcel< ParcelType >::canCombust_.

◆ setCellValues()

void setCellValues	(	TrackCloudType &	cloud,
		trackingData &	td
	)

Set cell values.

Definition at line 141 of file ReactingMultiphaseParcel.C.

References ReactingMultiphaseParcel< ParcelType >::cellValueSourceCorrection().

Referenced by ReactingMultiphaseParcel< ParcelType >::LEff(), and ReactingMultiphaseParcel< ParcelType >::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cellValueSourceCorrection()

void cellValueSourceCorrection	(	TrackCloudType &	cloud,
		trackingData &	td,
		const scalar	dt
	)

Correct cell values using latest transfer information.

Definition at line 153 of file ReactingMultiphaseParcel.C.

References ReactingMultiphaseParcel< ParcelType >::calc().

Referenced by ReactingMultiphaseParcel< ParcelType >::iNew::operator()(), and ReactingMultiphaseParcel< ParcelType >::setCellValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calc()

void calc	(	TrackCloudType &	cloud,
		trackingData &	td,
		const scalar	dt
	)

Update parcel properties over the time interval.

Definition at line 167 of file ReactingMultiphaseParcel.C.

References ReactingMultiphaseParcel< ParcelType >::calcDevolatilisation(), CompositionModel< CloudType >::carrier(), Foam::cbrt(), composition, forAll, CompositionModel< CloudType >::idGas(), CompositionModel< CloudType >::idLiquid(), CompositionModel< CloudType >::idSolid(), CompositionModel< CloudType >::localToCarrierId(), Foam::constant::mathematical::pi(), Foam::pow4(), Foam::Re(), Su, T0, and Foam::Zero.

Referenced by ReactingMultiphaseParcel< ParcelType >::cellValueSourceCorrection(), and ReactingMultiphaseParcel< ParcelType >::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFields() [1/2]

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

static

Read.

Definition at line 101 of file ReactingMultiphaseParcelIO.C.

References Cloud< ParticleType >::fieldIOobject(), forAll, forAllIter, p, Foam::readFields(), List< T >::size(), Cloud< ParticleType >::size(), solidNames(), ReactingMultiphaseParcel< ParcelType >::YGas_, ReactingMultiphaseParcel< ParcelType >::YLiquid_, and ReactingMultiphaseParcel< ParcelType >::YSolid_.

Referenced by ReactingMultiphaseParcel< ParcelType >::iNew::operator()(), and ReactingMultiphaseParcel< ParcelType >::readFields().

Here is the call graph for this function:

Here is the caller 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::readFields(), and ReactingMultiphaseParcel< ParcelType >::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 202 of file ReactingMultiphaseParcelIO.C.

References Cloud< ParticleType >::fieldIOobject(), forAll, forAllConstIter(), p, Cloud< ParticleType >::size(), solidNames(), ReactingMultiphaseParcel< ParcelType >::YGas(), ReactingMultiphaseParcel< ParcelType >::YLiquid(), and ReactingMultiphaseParcel< ParcelType >::YSolid().

Referenced by ReactingMultiphaseParcel< ParcelType >::iNew::operator()(), and ReactingMultiphaseParcel< ParcelType >::writeFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFields() [2/2]

void writeFields ( const CloudType & c )

static

Read - composition supplied.

Definition at line 193 of file ReactingMultiphaseParcelIO.C.

References ReactingMultiphaseParcel< ParcelType >::writeFields().

Here is the call graph for this function:

◆ CpEff()

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

Definition at line 51 of file ReactingMultiphaseParcel.C.

◆ HsEff()

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

Definition at line 71 of file ReactingMultiphaseParcel.C.

◆ LEff()

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

Definition at line 91 of file ReactingMultiphaseParcel.C.

References Foam::max(), and ReactingMultiphaseParcel< ParcelType >::setCellValues().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

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

friend

Referenced by ReactingMultiphaseParcel< ParcelType >::iNew::iNew().

Member Data Documentation

◆ GAS

const Foam::label GAS

static

Definition at line 86 of file ReactingMultiphaseParcel.H.

◆ LIQ

const Foam::label LIQ

static

Definition at line 87 of file ReactingMultiphaseParcel.H.

◆ SLD

const Foam::label SLD

static

Definition at line 88 of file ReactingMultiphaseParcel.H.

◆ YGas_

scalarField YGas_

protected

Mass fractions of gases [].

Definition at line 201 of file ReactingMultiphaseParcel.H.

Referenced by ReactingMultiphaseParcel< ParcelType >::calcSurfaceReactions(), ReactingMultiphaseParcel< ParcelType >::readFields(), and ReactingMultiphaseParcel< ParcelType >::YGas().

◆ YLiquid_

scalarField YLiquid_

protected

Mass fractions of liquids [].

Definition at line 204 of file ReactingMultiphaseParcel.H.

Referenced by ReactingMultiphaseParcel< ParcelType >::calcSurfaceReactions(), ReactingMultiphaseParcel< ParcelType >::readFields(), and ReactingMultiphaseParcel< ParcelType >::YLiquid().

◆ YSolid_

scalarField YSolid_

protected

Mass fractions of solids [].

Definition at line 207 of file ReactingMultiphaseParcel.H.

Referenced by ReactingMultiphaseParcel< ParcelType >::calcSurfaceReactions(), ReactingMultiphaseParcel< ParcelType >::readFields(), and ReactingMultiphaseParcel< ParcelType >::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 215 of file ReactingMultiphaseParcel.H.

Referenced by ReactingMultiphaseParcel< ParcelType >::calcSurfaceReactions(), and ReactingMultiphaseParcel< ParcelType >::canCombust().

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

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<class ParcelType> class Foam::ReactingMultiphaseParcel< ParcelType >

Member Typedef Documentation

◆ trackingData

Constructor & Destructor Documentation

◆ ReactingMultiphaseParcel() [1/5]

◆ ReactingMultiphaseParcel() [2/5]

◆ ReactingMultiphaseParcel() [3/5]

◆ ReactingMultiphaseParcel() [4/5]

◆ ReactingMultiphaseParcel() [5/5]

Member Function Documentation

◆ calcDevolatilisation()

◆ calcSurfaceReactions()

◆ 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()

◆ HsEff()

◆ LEff()

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ GAS

◆ LIQ

◆ SLD

◆ YGas_

◆ YLiquid_

◆ YSolid_

◆ canCombust_

template<class ParcelType>
class Foam::ReactingMultiphaseParcel< ParcelType >