Reacting heterogeneous Parcel. More...

Collaboration diagram for ReactingHeterogeneousParcel< ParcelType >:

Classes
class	constantProperties
	Class to hold reacting 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
	TypeName ("ReactingHeterogeneousParcel")
	Runtime type information. More...

	AddToPropertyList (ParcelType,+" nReactions(F1..FN)")
	String representation of properties. More...

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

	ReactingHeterogeneousParcel (const polyMesh &mesh, const vector &position, const label celli)
	Construct from a position and a cell, searching for the rest of the. More...

	ReactingHeterogeneousParcel (const polyMesh &mesh, const barycentric &coordinates, 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 &Y, const scalarField &F, const constantProperties &constProps)
	Construct from components. More...

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

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

	ReactingHeterogeneousParcel (const ReactingHeterogeneousParcel &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 &	F () const
	Return const access to F. More...

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

scalarField &	F ()
	Return access to F. More...

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

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

void	writeProperties (Ostream &os, const wordRes &filters, const word &delim, const bool namesOnly) const
	Write individual parcel properties to stream. More...

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

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

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

Static Public Member Functions
template<class CloudType , class CompositionType >
static void	readFields (CloudType &c, const CompositionType &compModel)
	Read - composition supplied. 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 - composition supplied. More...

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

template<class CloudType >
static void	readObjects (CloudType &c, const objectRegistry &obr)
	Read particle fields as objects from the obr registry. More...

template<class CloudType , class CompositionType >
static void	readObjects (CloudType &c, const CompositionType &compModel, const objectRegistry &obr)
	Read particle fields as objects from the obr registry. More...

template<class CloudType >
static void	writeObjects (const CloudType &c, objectRegistry &obr)
	Write particle fields as objects into the obr registry. More...

template<class CloudType , class CompositionType >
static void	writeObjects (const CloudType &c, const CompositionType &compModel, objectRegistry &obr)
	Write particle fields as objects into the obr registry. More...

Static Public Attributes
static const std::size_t	sizeofFields
	Size in bytes of the fields. More...

Protected Member Functions
template<class TrackCloudType >
void	calcHeterogeneousReactions (TrackCloudType &cloud, trackingData &td, const scalar dt, const scalar Res, const scalar nu, const scalar d, const scalar T, const scalar mass, const label canCombust, const scalar N, scalar &NCpW, const scalarField &YSolid, scalarField &F, scalarField &dMassSRSolid, scalarField &dMassSRCarrier, scalar &Sh, scalar &dhsTrans) const
	Calculate surface reactions. More...

Protected Attributes
scalarField	F_
	Progress variables for reactions. More...

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

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

Detailed Description

template<class ParcelType>
class Foam::ReactingHeterogeneousParcel< ParcelType >

Reacting heterogeneous Parcel.

Source files

Definition at line 52 of file ReactingHeterogeneousParcel.H.

Member Typedef Documentation

◆ trackingData

typedef ParcelType::trackingData trackingData

Use base tracking data.

Definition at line 109 of file ReactingHeterogeneousParcel.H.

Constructor & Destructor Documentation

◆ ReactingHeterogeneousParcel() [1/6]

ReactingHeterogeneousParcel	(	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 65 of file ReactingHeterogeneousParcelI.H.

Referenced by ReactingHeterogeneousParcel< ParcelType >::clone().

Here is the caller graph for this function:

◆ ReactingHeterogeneousParcel() [2/6]

ReactingHeterogeneousParcel	(	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 81 of file ReactingHeterogeneousParcelI.H.

◆ ReactingHeterogeneousParcel() [3/6]

ReactingHeterogeneousParcel	(	const polyMesh &	mesh,
		const barycentric &	coordinates,
		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 &	Y,
		const scalarField &	F,
		const constantProperties &	constProps
	)

inline

Construct from components.

Definition at line 95 of file ReactingHeterogeneousParcelI.H.

◆ ReactingHeterogeneousParcel() [4/6]

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

Construct from Istream.

Definition at line 50 of file ReactingHeterogeneousParcelIO.C.

References IOstream::check(), F(), FUNCTION_NAME, and Foam::readFields().

Here is the call graph for this function:

◆ ReactingHeterogeneousParcel() [5/6]

ReactingHeterogeneousParcel ( const ReactingHeterogeneousParcel< ParcelType > & p )

Construct as a copy.

◆ ReactingHeterogeneousParcel() [6/6]

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

Construct as a copy.

Member Function Documentation

◆ calcHeterogeneousReactions()

void calcHeterogeneousReactions	(	TrackCloudType &	cloud,
		trackingData &	td,
		const scalar	dt,
		const scalar	Res,
		const scalar	nu,
		const scalar	d,
		const scalar	T,
		const scalar	mass,
		const label	canCombust,
		const scalar	N,
		scalar &	NCpW,
		const scalarField &	YSolid,
		scalarField &	F,
		scalarField &	dMassSRSolid,
		scalarField &	dMassSRCarrier,
		scalar &	Sh,
		scalar &	dhsTrans
	)		const

protected

Calculate surface reactions.

Definition at line 296 of file ReactingHeterogeneousParcel.C.

References F(), Foam::min(), nu, Foam::Re(), Foam::sum(), and Foam::T().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "ReactingHeterogeneousParcel< ParcelType >" )

Runtime type information.

◆ AddToPropertyList()

AddToPropertyList	(	ParcelType	,
		+" nReactions(F1..FN)"
	)

String representation of properties.

◆ clone() [1/2]

virtual autoPtr<particle> clone ( ) const

inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 273 of file ReactingHeterogeneousParcel.H.

References ReactingHeterogeneousParcel< ParcelType >::ReactingHeterogeneousParcel().

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 279 of file ReactingHeterogeneousParcel.H.

References mesh, and ReactingHeterogeneousParcel< ParcelType >::ReactingHeterogeneousParcel().

Here is the call graph for this function:

◆ F() [1/2]

const Foam::scalarField & F ( ) const

inline

Return const access to F.

Definition at line 162 of file ReactingHeterogeneousParcelI.H.

References ReactingHeterogeneousParcel< ParcelType >::F_.

◆ canCombust() [1/2]

Foam::label canCombust ( ) const

inline

Return const access to the canCombust flag.

Definition at line 178 of file ReactingHeterogeneousParcelI.H.

References ReactingHeterogeneousParcel< ParcelType >::canCombust_.

◆ F() [2/2]

Foam::scalarField & F ( )

inline

Return access to F.

Definition at line 170 of file ReactingHeterogeneousParcelI.H.

References ReactingHeterogeneousParcel< ParcelType >::F_.

◆ canCombust() [2/2]

Foam::label & canCombust ( )

inline

Return access to the canCombust flag.

Definition at line 185 of file ReactingHeterogeneousParcelI.H.

References ReactingHeterogeneousParcel< ParcelType >::canCombust_.

◆ calc()

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

Update parcel properties over the time interval.

Definition at line 86 of file ReactingHeterogeneousParcel.C.

References Foam::cbrt(), composition, Cs, forAll, Foam::constant::mathematical::pi(), Foam::pow4(), Foam::Re(), Su, Foam::sum(), T0, Foam::fieldTypes::volume, and Foam::Zero.

Here is the call graph for this function:

◆ readFields() [1/2]

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

static

Read - composition supplied.

Definition at line 85 of file ReactingHeterogeneousParcelIO.C.

References Foam::constant::universal::c, F(), forAll, Foam::name(), p, Foam::readFields(), solidNames(), Y, and Foam::Zero.

Here is the call graph for this function:

◆ readFields() [2/2]

void readFields ( CloudType & c )

static

Read - no composition.

Definition at line 76 of file ReactingHeterogeneousParcelIO.C.

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

Here is the call graph for this function:

◆ writeFields() [1/2]

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

static

Write - composition supplied.

Definition at line 179 of file ReactingHeterogeneousParcelIO.C.

References Foam::constant::universal::c, F(), forAll, Foam::name(), p, p0, solidNames(), Foam::writeFields(), and Y.

Here is the call graph for this function:

◆ writeFields() [2/2]

void writeFields ( const CloudType & c )

static

Read - no composition.

Definition at line 168 of file ReactingHeterogeneousParcelIO.C.

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

Here is the call graph for this function:

◆ writeProperties()

void writeProperties	(	Ostream &	os,
		const wordRes &	filters,
		const word &	delim,
		const bool	namesOnly
	)		const

Write individual parcel properties to stream.

Definition at line 256 of file ReactingHeterogeneousParcelIO.C.

References writeProp.

◆ readObjects() [1/2]

void readObjects	(	CloudType &	c,
		const objectRegistry &	obr
	)

static

Read particle fields as objects from the obr registry.

no composition

Definition at line 279 of file ReactingHeterogeneousParcelIO.C.

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

◆ readObjects() [2/2]

void readObjects	(	CloudType &	c,
		const CompositionType &	compModel,
		const objectRegistry &	obr
	)

static

Read particle fields as objects from the obr registry.

Definition at line 303 of file ReactingHeterogeneousParcelIO.C.

References Foam::constant::universal::c, Foam::nl, and WarningInFunction.

◆ writeObjects() [1/2]

void writeObjects	(	const CloudType &	c,
		objectRegistry &	obr
	)

static

Write particle fields as objects into the obr registry.

no composition

Definition at line 291 of file ReactingHeterogeneousParcelIO.C.

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

◆ writeObjects() [2/2]

void writeObjects	(	const CloudType &	c,
		const CompositionType &	compModel,
		objectRegistry &	obr
	)

static

Write particle fields as objects into the obr registry.

Definition at line 324 of file ReactingHeterogeneousParcelIO.C.

References Foam::constant::universal::c, F(), forAll, Foam::name(), p0, solidNames(), and Y.

Here is the call graph for this function:

◆ CpEff()

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

Definition at line 39 of file ReactingHeterogeneousParcel.C.

References p, and Foam::T().

Here is the call graph for this function:

◆ HsEff()

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

Definition at line 54 of file ReactingHeterogeneousParcel.C.

References p, and Foam::T().

Here is the call graph for this function:

◆ LEff()

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

Definition at line 69 of file ReactingHeterogeneousParcel.C.

References p, and Foam::T().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

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

friend

Member Data Documentation

◆ sizeofFields

const std::size_t sizeofFields

static

Size in bytes of the fields.

Definition at line 73 of file ReactingHeterogeneousParcel.H.

◆ F_

scalarField F_

protected

Progress variables for reactions.

Definition at line 157 of file ReactingHeterogeneousParcel.H.

Referenced by ReactingHeterogeneousParcel< ParcelType >::F().

◆ 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 combust but can change 1 = can devolatilise, can combust -1 = cannot devolatilise or combust, and cannot change

Definition at line 165 of file ReactingHeterogeneousParcel.H.

Referenced by ReactingHeterogeneousParcel< ParcelType >::canCombust().

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

src/lagrangian/intermediate/parcels/Templates/ReactingHeterogeneousParcel/ReactingHeterogeneousParcel.H
src/lagrangian/intermediate/parcels/Templates/ReactingHeterogeneousParcel/ReactingHeterogeneousParcel.C
src/lagrangian/intermediate/parcels/Templates/ReactingHeterogeneousParcel/ReactingHeterogeneousParcelI.H
src/lagrangian/intermediate/parcels/Templates/ReactingHeterogeneousParcel/ReactingHeterogeneousParcelIO.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::ReactingHeterogeneousParcel< ParcelType >

Member Typedef Documentation

◆ trackingData

Constructor & Destructor Documentation

◆ ReactingHeterogeneousParcel() [1/6]

◆ ReactingHeterogeneousParcel() [2/6]

◆ ReactingHeterogeneousParcel() [3/6]

◆ ReactingHeterogeneousParcel() [4/6]

◆ ReactingHeterogeneousParcel() [5/6]

◆ ReactingHeterogeneousParcel() [6/6]

Member Function Documentation

◆ calcHeterogeneousReactions()

◆ TypeName()

◆ AddToPropertyList()

◆ clone() [1/2]

◆ clone() [2/2]

◆ F() [1/2]

◆ canCombust() [1/2]

◆ F() [2/2]

◆ canCombust() [2/2]

◆ calc()

◆ readFields() [1/2]

◆ readFields() [2/2]

◆ writeFields() [1/2]

◆ writeFields() [2/2]

◆ writeProperties()

◆ readObjects() [1/2]

◆ readObjects() [2/2]

◆ writeObjects() [1/2]

◆ writeObjects() [2/2]

◆ CpEff()

◆ HsEff()

◆ LEff()

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ sizeofFields

◆ F_

◆ canCombust_

template<class ParcelType>
class Foam::ReactingHeterogeneousParcel< ParcelType >