parcel Class Reference

A parcel of particles. More...

Inheritance diagram for parcel:

[legend]

Collaboration diagram for parcel:

[legend]

List of all members.

Public Member Functions
	parcel (const Cloud< parcel > &cloud, const vector &position, const label celli, const vector &n, const scalar d, const scalar T, const scalar m, const scalar y, const scalar yDot, const scalar ct, const scalar ms, const scalar tTurb, const scalar liquidCore, const scalar injector, const vector &U, const vector &Uturb, const scalarField &X, const List< word > &liquidNames)
	Construct from components.
	parcel (const Cloud< parcel > &cloud, Istream &is, bool readFields=true)
	Construct from Istream reading field values if required.
const List< word > &	liquidNames () const
	Return the names of the liquid components.
const List< word > &	fuelNames () const
	Return the names of the liquid fuel components - identical with liquidNames.
scalar	d () const
	Return diameter of droplets in parcel.
scalar &	d ()
	Return diameter of droplets in parcel.
scalar	T () const
	Return temperature of droplets in parcel.
scalar &	T ()
	Return temperature of droplets in parcel.
scalar	m () const
	Return total parcel mass.
scalar &	m ()
	Return total parcel mass.
scalar	dev () const
	Return spherical deviation of droplets in parcel.
scalar &	dev ()
	Return spherical deviation of droplets in parcel.
scalar	ddev () const
	Return rate of change of spherical deviation of.
scalar &	ddev ()
	Return rate of change of spherical deviation of.
scalar	ct () const
	Return characteristic time of droplets in parcel.
scalar &	ct ()
	Return characteristic time of droplets in parcel.
scalar &	ms ()
	Return stripped mass of droplets in parcel.
scalar	ms () const
	Return stripped mass of droplets in parcel.
scalar &	tTurb ()
	Return time spent in turbulent eddy.
scalar	tTurb () const
	Return time spent in turbulent eddy.
scalar &	liquidCore ()
	Return part of liquid liquidCore.
scalar	liquidCore () const
	Return part of liquid liquidCore.
scalar &	injector ()
	Return the injector from which is injected.
scalar	injector () const
	Return the injector from which is injected.
const vector &	U () const
	Return velocity of parcel.
vector &	U ()
	Return velocity of parcel.
const vector &	Uturb () const
	Return turbulent velocity fluctuation.
vector &	Uturb ()
	Return turbulent velocity fluctuation.
const vector &	n () const
	Return the normal used for 2D purposes.
vector &	n ()
	Return the normal used for 2D purposes.
const scalarField &	X () const
	Return the liquid components molar fractions.
scalarField &	X ()
	Return the liquid components molar fractions.
scalar &	tMom ()
	Return the momentum relaxation time of droplets in parcel.
scalar	tMom () const
	Return the momentum relaxation time of droplets in parcel.
scalar	N (const scalar rho) const
	Return statistical number of drops in parcel.
vector	Urel (const vector &) const
	Return relative velocity between given vector and parcel.
scalar	Re (const scalar rho, const vector &U, const scalar mu) const
	Reynolds number based on rho an dynamic viscosity.
scalar	Re (const vector &U, const scalar nu) const
	Reynolds number based on kinematic viscosity.
scalar	We (const vector &U, const scalar rho, const scalar sigma) const
	Weber number.
scalar	Sc (const scalar mu, const scalar rho, const scalar massDiffusion) const
	Schmidt number based on dynamic viscosity and rho.
scalar	Sc (const scalar nu, const scalar massDiffusion) const
	Schmidt number based on kinematic viscosity.
scalar	Pr (const scalar cp, const scalar mu, const scalar kappa) const
	Prandtl number.
scalar	Vd () const
	Volume of one droplet in the parcel.
scalar	V (const scalar rho) const
	Volume of all droplets in parcel.
bool	move (spray &sprayData)
void	transformProperties (const tensor &T)
	Transform the position and physical properties of the particle.
void	transformProperties (const vector &separation)
	Transform the position and physical properties of the particle.
void	correctNormal (const vector &sym)
	fix the 2D plane normal,
Static Public Member Functions
static void	readFields (Cloud< parcel > &c)
	Read the fields associated with the owner cloud.
static void	writeFields (const Cloud< parcel > &c)
	Write the fields associated with the owner cloud.
Friends
class	Cloud< parcel >
Ostream &	operator<< (Ostream &, const parcel &)

---

Detailed Description

A parcel of particles.

Definition at line 41 of file parcel.H.

---

Constructor & Destructor Documentation

parcel	(	const Cloud< parcel > &	cloud,
		const vector &	position,
		const label	celli,
		const vector &	n,
		const scalar	d,
		const scalar	T,
		const scalar	m,
		const scalar	y,
		const scalar	yDot,
		const scalar	ct,
		const scalar	ms,
		const scalar	tTurb,
		const scalar	liquidCore,
		const scalar	injector,
		const vector &	U,
		const vector &	Uturb,
		const scalarField &	X,
		const List< word > &	liquidNames
	)

Construct from components.

Definition at line 41 of file parcel.C.

References Foam::defineParticleTypeNameAndDebug(), and Foam::defineTemplateTypeNameAndDebug().

Here is the call graph for this function:

parcel	(	const Cloud< parcel > &	cloud,
		Istream &	is,
		bool	readFields = true
	)

Construct from Istream reading field values if required.

Definition at line 24 of file parcelIO.C.

References IOstream::ASCII, IOstream::format(), Istream::read(), and Foam::readScalar().

Here is the call graph for this function:

---

Member Function Documentation

const List< word > & liquidNames

(

)

const [inline]

Return the names of the liquid components.

Definition at line 25 of file parcelI.H.

Referenced by parcel::fuelNames().

Here is the caller graph for this function:

const List< word > & fuelNames

(

)

const [inline]

Return the names of the liquid fuel components - identical with liquidNames.

Definition at line 30 of file parcelI.H.

References parcel::liquidNames().

Here is the call graph for this function:

scalar d

(

)

const [inline]

Return diameter of droplets in parcel.

Definition at line 35 of file parcelI.H.

scalar & d

(

)

[inline]

Return diameter of droplets in parcel.

Definition at line 40 of file parcelI.H.

scalar T

(

)

const [inline]

Return temperature of droplets in parcel.

Definition at line 45 of file parcelI.H.

scalar & T

(

)

[inline]

Return temperature of droplets in parcel.

Definition at line 50 of file parcelI.H.

scalar m

(

)

const [inline]

Return total parcel mass.

Definition at line 55 of file parcelI.H.

Referenced by spray::inject().

Here is the caller graph for this function:

scalar & m

(

)

[inline]

Return total parcel mass.

Definition at line 60 of file parcelI.H.

scalar dev

(

)

const [inline]

Return spherical deviation of droplets in parcel.

Definition at line 65 of file parcelI.H.

scalar & dev

(

)

[inline]

Return spherical deviation of droplets in parcel.

Definition at line 70 of file parcelI.H.

scalar ddev

(

)

const [inline]

Return rate of change of spherical deviation of.

droplets in parcel

Definition at line 75 of file parcelI.H.

scalar & ddev

(

)

[inline]

Return rate of change of spherical deviation of.

droplets in parcel

Definition at line 80 of file parcelI.H.

scalar ct

(

)

const [inline]

Return characteristic time of droplets in parcel.

Definition at line 85 of file parcelI.H.

scalar & ct

(

)

[inline]

Return characteristic time of droplets in parcel.

Definition at line 90 of file parcelI.H.

scalar & ms

(

)

[inline]

Return stripped mass of droplets in parcel.

Definition at line 95 of file parcelI.H.

scalar ms

(

)

const [inline]

Return stripped mass of droplets in parcel.

Definition at line 100 of file parcelI.H.

scalar & tTurb

(

)

[inline]

Return time spent in turbulent eddy.

Definition at line 105 of file parcelI.H.

scalar tTurb

(

)

const [inline]

Return time spent in turbulent eddy.

Definition at line 110 of file parcelI.H.

scalar & liquidCore

(

)

[inline]

Return part of liquid liquidCore.

Definition at line 115 of file parcelI.H.

scalar liquidCore

(

)

const [inline]

Return part of liquid liquidCore.

Definition at line 120 of file parcelI.H.

scalar & injector

(

)

[inline]

Return the injector from which is injected.

Definition at line 125 of file parcelI.H.

scalar injector

(

)

const [inline]

Return the injector from which is injected.

Definition at line 130 of file parcelI.H.

const vector & U

(

)

const [inline]

Return velocity of parcel.

Definition at line 135 of file parcelI.H.

vector & U

(

)

[inline]

Return velocity of parcel.

Definition at line 140 of file parcelI.H.

const vector & Uturb

(

)

const [inline]

Return turbulent velocity fluctuation.

Definition at line 145 of file parcelI.H.

vector & Uturb

(

)

[inline]

Return turbulent velocity fluctuation.

Definition at line 150 of file parcelI.H.

const vector & n

(

)

const [inline]

Return the normal used for 2D purposes.

Definition at line 155 of file parcelI.H.

vector & n

(

)

[inline]

Return the normal used for 2D purposes.

Definition at line 160 of file parcelI.H.

const scalarField & X

(

)

const [inline]

Return the liquid components molar fractions.

Definition at line 165 of file parcelI.H.

scalarField & X

(

)

[inline]

Return the liquid components molar fractions.

Definition at line 170 of file parcelI.H.

scalar & tMom

(

)

[inline]

Return the momentum relaxation time of droplets in parcel.

Definition at line 175 of file parcelI.H.

scalar tMom

(

)

const [inline]

Return the momentum relaxation time of droplets in parcel.

Definition at line 180 of file parcelI.H.

scalar N

(

const scalar

rho

)

const

Return statistical number of drops in parcel.

Definition at line 94 of file parcelFunctions.C.

vector Urel

(

const vector &

U

)

const [inline]

Return relative velocity between given vector and parcel.

Definition at line 185 of file parcelI.H.

Referenced by parcel::Re(), parcel::Sc(), and parcel::We().

Here is the caller graph for this function:

scalar Re	(	const scalar	rho,
		const vector &	U,
		const scalar	mu
	)			const

Reynolds number based on rho an dynamic viscosity.

Definition at line 40 of file parcelFunctions.C.

References Foam::mag(), and parcel::Urel().

Referenced by parcel::Re().

Here is the call graph for this function:

Here is the caller graph for this function:

scalar Re	(	const vector &	U,
		const scalar	nu
	)			const

Reynolds number based on kinematic viscosity.

Definition at line 30 of file parcelFunctions.C.

References parcel::Re().

Here is the call graph for this function:

scalar We	(	const vector &	U,
		const scalar	rho,
		const scalar	sigma
	)			const

Weber number.

Definition at line 52 of file parcelFunctions.C.

References Foam::mag(), and parcel::Urel().

Here is the call graph for this function:

scalar Sc	(	const scalar	mu,
		const scalar	rho,
		const scalar	massDiffusion
	)			const

Schmidt number based on dynamic viscosity and rho.

Definition at line 63 of file parcelFunctions.C.

References Foam::mag(), Foam::pow(), and parcel::Urel().

Here is the call graph for this function:

scalar Sc	(	const scalar	nu,
		const scalar	massDiffusion
	)			const

Schmidt number based on kinematic viscosity.

Definition at line 74 of file parcelFunctions.C.

scalar Pr	(	const scalar	cp,
		const scalar	mu,
		const scalar	kappa
	)			const

Prandtl number.

Definition at line 84 of file parcelFunctions.C.

scalar Vd

(

)

const

Volume of one droplet in the parcel.

Definition at line 100 of file parcelFunctions.C.

scalar V

(

const scalar

rho

)

const

Volume of all droplets in parcel.

Definition at line 106 of file parcelFunctions.C.

bool move

(

spray &

sprayData

)

Definition at line 87 of file parcel.C.

Referenced by spray::inject().

Here is the caller graph for this function:

void transformProperties

(

const tensor &

T

)

[virtual]

Transform the position and physical properties of the particle.

according to the given transformation tensor

Reimplemented from Particle< parcel >.

Definition at line 679 of file parcel.C.

void transformProperties

(

const vector &

separation

)

[virtual]

Transform the position and physical properties of the particle.

according to the given separation vector

Reimplemented from Particle< parcel >.

Definition at line 685 of file parcel.C.

void correctNormal

(

const vector &

sym

)

[inline]

fix the 2D plane normal,

when particle hits a face it is slightly perturbed towards the face centre and n_ will no longer be valid

Definition at line 191 of file parcelI.H.

void readFields

(

Cloud< parcel > &

c

)

[static]

Read the fields associated with the owner cloud.

Reimplemented from Particle< parcel >.

Definition at line 91 of file parcelIO.C.

void writeFields

(

const Cloud< parcel > &

c

)

[static]

Write the fields associated with the owner cloud.

Reimplemented from Particle< parcel >.

Definition at line 190 of file parcelIO.C.

---

Friends And Related Function Documentation

friend class Cloud< parcel > [friend]

Definition at line 139 of file parcel.H.

Ostream& operator<<	(	Ostream &	,
		const parcel &
	)			[friend]

---

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

• src/lagrangian/dieselSpray/parcel/parcel.H
• src/lagrangian/dieselSpray/parcel/parcel.C
• src/lagrangian/dieselSpray/parcel/parcelFunctions.C
• src/lagrangian/dieselSpray/parcel/parcelI.H
• src/lagrangian/dieselSpray/parcel/parcelIO.C
• src/lagrangian/dieselSpray/parcel/setRelaxationTimes.C