Reacing spray parcel, with added functionality for atomization and breakup. More...

Collaboration diagram for SprayParcel:

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

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

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

	AddToPropertyList (ParcelType,+" d0"+" position0"+" sigma"+" mu"+" liquidCore"+" KHindex"+" y"+" yDot"+" tc"+" ms"+" injector"+" tMom"+" user")
	String representation of properties. More...

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

	SprayParcel (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 scalar liquidCore, const scalar KHindex, const scalar y, const scalar yDot, const scalar tc, const scalar ms, const scalar injector, const scalar tMom, const scalar user, const typename ParcelType::constantProperties &constProps)
	Construct from components. More...

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

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

	SprayParcel (const SprayParcel &p)
	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...

scalar	d0 () const
	Return const access to initial droplet diameter. More...

const vector &	position0 () const
	Return const access to initial droplet position. More...

scalar	sigma () const
	Return const access to the liquid surface tension. More...

scalar	mu () const
	Return const access to the liquid dynamic viscosity. More...

scalar	liquidCore () const
	Return const access to liquid core. More...

scalar	KHindex () const
	Return const access to Kelvin-Helmholtz breakup index. More...

scalar	y () const
	Return const access to spherical deviation. More...

scalar	yDot () const
	Return const access to rate of change of spherical deviation. More...

scalar	tc () const
	Return const access to atomization characteristic time. More...

scalar	ms () const
	Return const access to stripped parcel mass. More...

scalar	injector () const
	Return const access to injector id. More...

scalar	tMom () const
	Return const access to momentum relaxation time. More...

scalar	user () const
	Return const access to passive user scalar. More...

scalar &	d0 ()
	Return access to initial droplet diameter. More...

vector &	position0 ()
	Return access to initial droplet position. More...

scalar &	sigma ()
	Return access to the liquid surface tension. More...

scalar &	mu ()
	Return access to the liquid dynamic viscosity. More...

scalar &	liquidCore ()
	Return access to liquid core. More...

scalar &	KHindex ()
	Return access to Kelvin-Helmholtz breakup index. More...

scalar &	y ()
	Return access to spherical deviation. More...

scalar &	yDot ()
	Return access to rate of change of spherical deviation. More...

scalar &	tc ()
	Return access to atomization characteristic time. More...

scalar &	ms ()
	Return access to stripped parcel mass. More...

scalar &	injector ()
	Return access to injector id. More...

scalar &	tMom ()
	Return access to momentum relaxation time. More...

scalar &	user ()
	Return access to passive user scalar. More...

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

template<class TrackData >
void	calcAtomization (TrackData &td, const scalar dt, const label cellI)
	Correct parcel properties according to atomization model. More...

template<class TrackData >
void	calcBreakup (TrackData &td, const scalar dt, const label cellI)
	Correct parcel properties according to breakup model. 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	correctSurfaceValues (TrackData &td, const label cellI, const scalar T, const scalarField &Cs, scalar &rhos, scalar &mus, scalar &Pr, scalar &kappa)
	Correct surface values due to emitted species. 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 >
scalar	chi (TrackData &td, const scalarField &X) const
	Calculate the chi-factor for flash-boiling for the. More...

template<class TrackData >
void	solveTABEq (TrackData &td, const scalar dt)
	Solve the TAB equation. More...

template<class TrackData >
Foam::scalar	chi (TrackData &td, const scalarField &X) 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)
	Write - composition supplied. More...

Protected Attributes
scalar	d0_
	Initial droplet diameter. More...

vector	position0_
	Injection position. More...

scalar	sigma_
	Liquid surface tension [N/m]. More...

scalar	mu_
	Liquid dynamic viscosity [Pa.s]. More...

scalar	liquidCore_
	Part of liquid core ( >0.5=liquid, <0.5=droplet ) More...

scalar	KHindex_
	Index for KH Breakup. More...

scalar	y_
	Spherical deviation. More...

scalar	yDot_
	Rate of change of spherical deviation. More...

scalar	tc_
	Characteristic time (used in atomization and/or breakup model) More...

scalar	ms_
	Stripped parcel mass due to breakup. More...

scalar	injector_
	Injected from injector (needed e.g. for calculating distance. More...

scalar	tMom_
	Momentum relaxation time (needed for calculating parcel acc.) More...

scalar	user_
	Passive scalar (extra variable to be defined by user) More...

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

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

Detailed Description

Reacing spray parcel, with added functionality for atomization and breakup.

Definition at line 43 of file SprayParcel.H.

Constructor & Destructor Documentation

◆ SprayParcel() [1/5]

SprayParcel	(	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 108 of file SprayParcelI.H.

◆ SprayParcel() [2/5]

SprayParcel	(	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 scalar	liquidCore,
		const scalar	KHindex,
		const scalar	y,
		const scalar	yDot,
		const scalar	tc,
		const scalar	ms,
		const scalar	injector,
		const scalar	tMom,
		const scalar	user,
		const typename ParcelType::constantProperties &	constProps
	)

inline

Construct from components.

Definition at line 135 of file SprayParcelI.H.

◆ SprayParcel() [3/5]

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

Construct from Istream.

◆ SprayParcel() [4/5]

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

Construct as a copy.

◆ SprayParcel() [5/5]

SprayParcel ( const SprayParcel & p )

Construct as a copy.

Member Function Documentation

◆ TypeName()

TypeName ( "SprayParcel" )

Runtime type information.

◆ AddToPropertyList()

AddToPropertyList	(	ParcelType	,
		+" d0"+" position0"+" sigma"+" mu"+" liquidCore"+" KHindex"+" y"+" yDot"+" tc"+" ms"+" injector"+" tMom"+" user"
	)

String representation of properties.

◆ clone() [1/2]

virtual autoPtr<particle> clone ( ) const

inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 264 of file SprayParcel.H.

◆ clone() [2/2]

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

inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 270 of file SprayParcel.H.

References mesh.

◆ d0() [1/2]

Foam::scalar d0 ( ) const

inline

Return const access to initial droplet diameter.

Definition at line 217 of file SprayParcelI.H.

References SprayParcel::d0_.

Referenced by SprayParcel::calcBreakup().

Here is the caller graph for this function:

◆ position0() [1/2]

const Foam::vector & position0 ( ) const

inline

Return const access to initial droplet position.

Definition at line 224 of file SprayParcelI.H.

References SprayParcel::position0_.

◆ sigma() [1/2]

Foam::scalar sigma ( ) const

inline

Return const access to the liquid surface tension.

Definition at line 231 of file SprayParcelI.H.

References SprayParcel::sigma_.

◆ mu() [1/2]

Foam::scalar mu ( ) const

inline

Return const access to the liquid dynamic viscosity.

Definition at line 238 of file SprayParcelI.H.

References SprayParcel::mu_.

◆ liquidCore() [1/2]

Foam::scalar liquidCore ( ) const

inline

Return const access to liquid core.

Definition at line 245 of file SprayParcelI.H.

References SprayParcel::liquidCore_.

Referenced by SprayParcel::calcBreakup().

Here is the caller graph for this function:

◆ KHindex() [1/2]

Foam::scalar KHindex ( ) const

inline

Return const access to Kelvin-Helmholtz breakup index.

Definition at line 252 of file SprayParcelI.H.

References SprayParcel::KHindex_.

Referenced by SprayParcel::calcBreakup().

Here is the caller graph for this function:

◆ y() [1/2]

Foam::scalar y ( ) const

inline

Return const access to spherical deviation.

Definition at line 259 of file SprayParcelI.H.

References SprayParcel::y_.

Referenced by SprayParcel::calcBreakup().

Here is the caller graph for this function:

◆ yDot() [1/2]

Foam::scalar yDot ( ) const

inline

Return const access to rate of change of spherical deviation.

Definition at line 266 of file SprayParcelI.H.

References SprayParcel::yDot_.

Referenced by SprayParcel::calcBreakup().

Here is the caller graph for this function:

◆ tc() [1/2]

Foam::scalar tc ( ) const

inline

Return const access to atomization characteristic time.

Definition at line 273 of file SprayParcelI.H.

References SprayParcel::tc_.

Referenced by SprayParcel::calcBreakup().

Here is the caller graph for this function:

◆ ms() [1/2]

Foam::scalar ms ( ) const

inline

Return const access to stripped parcel mass.

Definition at line 280 of file SprayParcelI.H.

References SprayParcel::ms_.

Referenced by SprayParcel::calcBreakup().

Here is the caller graph for this function:

◆ injector() [1/2]

Foam::scalar injector ( ) const

inline

Return const access to injector id.

Definition at line 287 of file SprayParcelI.H.

References SprayParcel::injector_.

Referenced by SprayParcel::calcBreakup().

Here is the caller graph for this function:

◆ tMom() [1/2]

Foam::scalar tMom ( ) const

inline

Return const access to momentum relaxation time.

Definition at line 294 of file SprayParcelI.H.

References SprayParcel::tMom_.

Referenced by SprayParcel::calcBreakup().

Here is the caller graph for this function:

◆ user() [1/2]

Foam::scalar user ( ) const

inline

Return const access to passive user scalar.

Definition at line 301 of file SprayParcelI.H.

References SprayParcel::user_.

Referenced by SprayParcel::calcBreakup().

Here is the caller graph for this function:

◆ d0() [2/2]

Foam::scalar & d0 ( )

inline

Return access to initial droplet diameter.

Definition at line 308 of file SprayParcelI.H.

References SprayParcel::d0_.

◆ position0() [2/2]

Foam::vector & position0 ( )

inline

Return access to initial droplet position.

Definition at line 315 of file SprayParcelI.H.

References SprayParcel::position0_.

◆ sigma() [2/2]

Foam::scalar & sigma ( )

inline

Return access to the liquid surface tension.

Definition at line 322 of file SprayParcelI.H.

References SprayParcel::sigma_.

◆ mu() [2/2]

Foam::scalar & mu ( )

inline

Return access to the liquid dynamic viscosity.

Definition at line 329 of file SprayParcelI.H.

References SprayParcel::mu_.

◆ liquidCore() [2/2]

Foam::scalar & liquidCore ( )

inline

Return access to liquid core.

Definition at line 336 of file SprayParcelI.H.

References SprayParcel::liquidCore_.

◆ KHindex() [2/2]

Foam::scalar & KHindex ( )

inline

Return access to Kelvin-Helmholtz breakup index.

Definition at line 343 of file SprayParcelI.H.

References SprayParcel::KHindex_.

◆ y() [2/2]

Foam::scalar & y ( )

inline

Return access to spherical deviation.

Definition at line 350 of file SprayParcelI.H.

References SprayParcel::y_.

◆ yDot() [2/2]

Foam::scalar & yDot ( )

inline

Return access to rate of change of spherical deviation.

Definition at line 357 of file SprayParcelI.H.

References SprayParcel::yDot_.

◆ tc() [2/2]

Foam::scalar & tc ( )

inline

Return access to atomization characteristic time.

Definition at line 364 of file SprayParcelI.H.

References SprayParcel::tc_.

◆ ms() [2/2]

Foam::scalar & ms ( )

inline

Return access to stripped parcel mass.

Definition at line 371 of file SprayParcelI.H.

References SprayParcel::ms_.

◆ injector() [2/2]

Foam::scalar & injector ( )

inline

Return access to injector id.

Definition at line 378 of file SprayParcelI.H.

References SprayParcel::injector_.

◆ tMom() [2/2]

Foam::scalar & tMom ( )

inline

Return access to momentum relaxation time.

Definition at line 385 of file SprayParcelI.H.

References SprayParcel::tMom_.

◆ user() [2/2]

Foam::scalar & user ( )

inline

Return access to passive user scalar.

Definition at line 392 of file SprayParcelI.H.

References SprayParcel::user_.

◆ setCellValues()

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

Set cell values.

Definition at line 36 of file SprayParcel.C.

Referenced by SprayParcel::calcBreakup().

Here is the caller graph for this function:

◆ calcAtomization()

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

Correct parcel properties according to atomization model.

Definition at line 151 of file SprayParcel.C.

References AtomizationModel::calcChi(), composition, Foam::mag(), Foam::max(), Foam::min(), Foam::pos(), R, rho, Foam::constant::thermodynamic::RR, T, AtomizationModel::Taverage(), U, AtomizationModel::update(), and Urel.

Here is the call graph for this function:

◆ calcBreakup()

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

Correct parcel properties according to breakup model.

Definition at line 224 of file SprayParcel.C.

References SprayParcel::d0(), forces::forces(), g, SprayParcel::injector(), SprayParcel::KHindex(), SprayParcel::liquidCore(), Foam::mag(), SprayParcel::ms(), p, R, Foam::Re(), Foam::constant::thermodynamic::RR, SprayParcel::setCellValues(), BreakupModel::solveOscillationEq(), forceSuSp::Sp(), T, SprayParcel::tc(), SprayParcel::tMom(), U, BreakupModel::update(), Urel, SprayParcel::user(), SprayParcel::y(), and SprayParcel::yDot().

Here is the call graph for this function:

◆ cellValueSourceCorrection()

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

Correct cell values using latest transfer information.

Definition at line 49 of file SprayParcel.C.

◆ correctSurfaceValues()

void correctSurfaceValues	(	TrackData &	td,
		const label	cellI,
		const scalar	T,
		const scalarField &	Cs,
		scalar &	rhos,
		scalar &	mus,
		scalar &	Pr,
		scalar &	kappa
	)

Correct surface values due to emitted species.

◆ calc()

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

Update parcel properties over the time interval.

Definition at line 62 of file SprayParcel.C.

References Foam::calc(), Foam::cbrt(), composition, Foam::pow3(), rho, rho0, rho1, T, and X0().

Here is the call graph for this function:

◆ chi() [1/2]

scalar chi	(	TrackData &	td,
		const scalarField &	X
	)		const

Calculate the chi-factor for flash-boiling for the.

atomization model

◆ solveTABEq()

void solveTABEq	(	TrackData &	td,
		const scalar	dt
	)

Solve the TAB equation.

Definition at line 378 of file SprayParcel.C.

References Foam::constant::universal::c, Foam::cos(), Foam::constant::electromagnetic::e, Foam::exp(), rho, s(), Foam::sin(), Foam::sqrt(), U, y, and Foam::y0().

Here is the call graph for this function:

◆ readFields() [1/2]

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

static

Read.

Definition at line 121 of file SprayParcelIO.C.

References Foam::constant::universal::c, forAllIter, Foam::constant::physicoChemical::mu, IOobject::MUST_READ, p, readFields(), Foam::constant::physicoChemical::sigma, and y.

Here is the call graph for this function:

◆ readFields() [2/2]

void readFields ( CloudType & c )

static

Read - no composition.

Definition at line 107 of file SprayParcelIO.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 211 of file SprayParcelIO.C.

References Foam::constant::universal::c, forAllConstIter(), Foam::constant::physicoChemical::mu, IOobject::NO_READ, p, Foam::constant::physicoChemical::sigma, regIOobject::write(), and y.

Here is the call graph for this function:

◆ writeFields() [2/2]

void writeFields ( const CloudType & c )

static

Write - composition supplied.

Definition at line 202 of file SprayParcelIO.C.

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

◆ chi() [2/2]

Foam::scalar chi	(	TrackData &	td,
		const scalarField &	X
	)		const

Definition at line 334 of file SprayParcel.C.

References composition, forAll, liquidProperties::h(), liquidProperties::hl(), Foam::max(), Foam::min(), liquidProperties::pvInvert(), liquidProperties::rho(), and T.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

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

friend

Field Documentation

◆ sizeofFields_

const std::size_t sizeofFields_

staticprivate

Size in bytes of the fields.

Definition at line 64 of file SprayParcel.H.

◆ d0_

scalar d0_

protected

Initial droplet diameter.

Definition at line 136 of file SprayParcel.H.

Referenced by SprayParcel::d0().

◆ position0_

vector position0_

protected

Injection position.

Definition at line 139 of file SprayParcel.H.

Referenced by SprayParcel::position0().

◆ sigma_

scalar sigma_

protected

Liquid surface tension [N/m].

Definition at line 142 of file SprayParcel.H.

Referenced by SprayParcel::sigma().

◆ mu_

scalar mu_

protected

Liquid dynamic viscosity [Pa.s].

Definition at line 145 of file SprayParcel.H.

Referenced by SprayParcel::mu().

◆ liquidCore_

scalar liquidCore_

protected

Part of liquid core ( >0.5=liquid, <0.5=droplet )

Definition at line 148 of file SprayParcel.H.

Referenced by SprayParcel::liquidCore().

◆ KHindex_

scalar KHindex_

protected

Index for KH Breakup.

Definition at line 151 of file SprayParcel.H.

Referenced by SprayParcel::KHindex().

◆ y_

scalar y_

protected

Spherical deviation.

Definition at line 154 of file SprayParcel.H.

Referenced by SprayParcel::y().

◆ yDot_

scalar yDot_

protected

Rate of change of spherical deviation.

Definition at line 157 of file SprayParcel.H.

Referenced by SprayParcel::yDot().

◆ tc_

scalar tc_

protected

Characteristic time (used in atomization and/or breakup model)

Definition at line 160 of file SprayParcel.H.

Referenced by SprayParcel::tc().

◆ ms_

scalar ms_

protected

Stripped parcel mass due to breakup.

Definition at line 163 of file SprayParcel.H.

Referenced by SprayParcel::ms().

◆ injector_

scalar injector_

protected

Injected from injector (needed e.g. for calculating distance.

from injector)

Definition at line 167 of file SprayParcel.H.

Referenced by SprayParcel::injector().

◆ tMom_

scalar tMom_

protected

Momentum relaxation time (needed for calculating parcel acc.)

Definition at line 170 of file SprayParcel.H.

Referenced by SprayParcel::tMom().

◆ user_

scalar user_

protected

Passive scalar (extra variable to be defined by user)

Definition at line 173 of file SprayParcel.H.

Referenced by SprayParcel::user().

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

src/lagrangian/spray/parcels/Templates/SprayParcel/SprayParcel.H
src/lagrangian/spray/parcels/Templates/SprayParcel/SprayParcel.C
src/lagrangian/spray/parcels/Templates/SprayParcel/SprayParcelI.H
src/lagrangian/spray/parcels/Templates/SprayParcel/SprayParcelIO.C

Data Structures

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SprayParcel() [1/5]

◆ SprayParcel() [2/5]

◆ SprayParcel() [3/5]

◆ SprayParcel() [4/5]

◆ SprayParcel() [5/5]

Member Function Documentation

◆ TypeName()

◆ AddToPropertyList()

◆ clone() [1/2]

◆ clone() [2/2]

◆ d0() [1/2]

◆ position0() [1/2]

◆ sigma() [1/2]

◆ mu() [1/2]

◆ liquidCore() [1/2]

◆ KHindex() [1/2]

◆ y() [1/2]

◆ yDot() [1/2]

◆ tc() [1/2]

◆ ms() [1/2]

◆ injector() [1/2]

◆ tMom() [1/2]

◆ user() [1/2]

◆ d0() [2/2]

◆ position0() [2/2]

◆ sigma() [2/2]

◆ mu() [2/2]

◆ liquidCore() [2/2]

◆ KHindex() [2/2]

◆ y() [2/2]

◆ yDot() [2/2]

◆ tc() [2/2]

◆ ms() [2/2]

◆ injector() [2/2]

◆ tMom() [2/2]

◆ user() [2/2]

◆ setCellValues()

◆ calcAtomization()

◆ calcBreakup()

◆ cellValueSourceCorrection()

◆ correctSurfaceValues()

◆ calc()

◆ chi() [1/2]

◆ solveTABEq()

◆ readFields() [1/2]

◆ readFields() [2/2]

◆ writeFields() [1/2]

◆ writeFields() [2/2]

◆ chi() [2/2]

Friends And Related Function Documentation

◆ operator

Field Documentation

◆ sizeofFields_

◆ d0_

◆ position0_

◆ sigma_

◆ mu_

◆ liquidCore_

◆ KHindex_

◆ y_

◆ yDot_

◆ tc_

◆ ms_

◆ injector_

◆ tMom_

◆ user_