KinematicParcel< ParcelType > Class Template Reference

Kinematic parcel class with rotational motion (as spherical particles only) and one/two-way coupling with the continuous phase. More...

Inheritance diagram for KinematicParcel< ParcelType >:

Collaboration diagram for KinematicParcel< ParcelType >:

Classes
class	constantProperties
	Class to hold kinematic particle constant properties. More...
class	iNew
	Factory class to read-construct particles used for. More...
class	TrackingData

Public Member Functions
	TypeName ("KinematicParcel")
	Runtime type information. More...
	AddToPropertyList (ParcelType," active"+" typeId"+" nParticle"+" d"+" dTarget "+" (Ux Uy Uz)"+" rho"+" age"+" tTurb"+" (UTurbx UTurby UTurbz)")
	String representation of properties. More...
	KinematicParcel (const polyMesh &mesh, const vector &position, const label celli, const label tetFacei, const label tetPtI)
	Construct from owner, position, and cloud owner. More...
	KinematicParcel (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 &torque0, const constantProperties &constProps)
	Construct from components. More...
	KinematicParcel (const polyMesh &mesh, Istream &is, bool readFields=true)
	Construct from Istream. More...
	KinematicParcel (const KinematicParcel &p)
	Construct as a copy. More...
	KinematicParcel (const KinematicParcel &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...
bool	active () const
	Return const access to active flag. More...
label	typeId () const
	Return const access to type id. More...
scalar	nParticle () const
	Return const access to number of particles. More...
scalar	d () const
	Return const access to diameter. More...
scalar	dTarget () const
	Return const access to target diameter. More...
const vector &	U () const
	Return const access to velocity. More...
scalar	rho () const
	Return const access to density. More...
scalar	age () const
	Return const access to the age. More...
scalar	tTurb () const
	Return const access to time spent in turbulent eddy. More...
const vector &	UTurb () const
	Return const access to turbulent velocity fluctuation. More...
scalar	rhoc () const
	Return const access to carrier density [kg/m3]. More...
const vector &	Uc () const
	Return const access to carrier velocity [m/s]. More...
scalar	muc () const
	Return const access to carrier viscosity [Pa.s]. More...
bool &	active ()
	Return const access to active flag. More...
label &	typeId ()
	Return access to type id. More...
scalar &	nParticle ()
	Return access to number of particles. More...
scalar &	d ()
	Return access to diameter. More...
scalar &	dTarget ()
	Return access to target diameter. More...
vector &	U ()
	Return access to velocity. More...
scalar &	rho ()
	Return access to density. More...
scalar &	age ()
	Return access to the age. More...
scalar &	tTurb ()
	Return access to time spent in turbulent eddy. More...
vector &	UTurb ()
	Return access to turbulent velocity fluctuation. More...
label	faceInterpolation () const
	Return the index of the face used in the interpolation routine. More...
scalar	massCell (const label celli) const
	Cell owner mass. More...
scalar	mass () const
	Particle mass. More...
scalar	momentOfInertia () const
	Particle moment of inertia around diameter axis. More...
scalar	volume () const
	Particle volume. More...
scalar	areaP () const
	Particle projected area. More...
scalar	areaS () const
	Particle surface area. More...
scalar	Re (const vector &U, const scalar d, const scalar rhoc, const scalar muc) const
	Reynolds number. More...
scalar	We (const vector &U, const scalar d, const scalar rhoc, const scalar sigma) const
	Weber number. More...
scalar	Eo (const vector &a, const scalar d, const scalar sigma) const
	Eotvos number. 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 >
bool	move (TrackData &td, const scalar trackTime)
	Move the parcel. More...
void	hitFace (int &td)
	Overridable function to handle the particle hitting a face. More...
template<class TrackData >
void	hitFace (TrackData &td)
	Overridable function to handle the particle hitting a face. More...
template<class TrackData >
bool	hitPatch (const polyPatch &p, TrackData &td, const label patchi, const scalar trackFraction, const tetIndices &tetIs)
	Overridable function to handle the particle hitting a patch. More...
template<class TrackData >
void	hitProcessorPatch (const processorPolyPatch &, TrackData &td)
	Overridable function to handle the particle hitting a. More...
template<class TrackData >
void	hitWallPatch (const wallPolyPatch &, TrackData &td, const tetIndices &)
	Overridable function to handle the particle hitting a wallPatch. More...
template<class TrackData >
void	hitPatch (const polyPatch &, TrackData &td)
	Overridable function to handle the particle hitting a polyPatch. More...
virtual void	transformProperties (const tensor &T)
	Transform the physical properties of the particle. More...
virtual void	transformProperties (const vector &separation)
	Transform the physical properties of the particle. More...
virtual scalar	wallImpactDistance (const vector &n) const
	The nearest distance to a wall that the particle can be. More...
template<class TrackData >
const Foam::vector	calcVelocity (TrackData &td, const scalar dt, const label celli, const scalar Re, const scalar mu, const scalar mass, const vector &Su, vector &dUTrans, scalar &Spu) const

Static Public Member Functions
static scalar	volume (const scalar d)
	Particle volume for a given diameter. More...
static scalar	areaP (const scalar d)
	Projected area for given diameter. More...
static scalar	areaS (const scalar d)
	Surface area for given diameter. More...
template<class CloudType >
static void	readFields (CloudType &c)
	Read. More...
template<class CloudType >
static void	writeFields (const CloudType &c)
	Write. More...

Protected Member Functions
template<class TrackData >
const vector	calcVelocity (TrackData &td, const scalar dt, const label celli, const scalar Re, const scalar mu, const scalar mass, const vector &Su, vector &dUTrans, scalar &Spu) const
	Calculate new particle velocity. More...

Protected Attributes
bool	active_
	Active flag - tracking inactive when active = false. More...
label	typeId_
	Parcel type id. More...
scalar	nParticle_
	Number of particles in Parcel. More...
scalar	d_
	Diameter [m]. More...
scalar	dTarget_
	Target diameter [m]. More...
vector	U_
	Velocity of Parcel [m/s]. More...
scalar	rho_
	Density [kg/m3]. More...
scalar	age_
	Age [s]. More...
scalar	tTurb_
	Time spent in turbulent eddy [s]. More...
vector	UTurb_
	Turbulent velocity fluctuation [m/s]. More...
scalar	rhoc_
	Density [kg/m3]. More...
vector	Uc_
	Velocity [m/s]. More...
scalar	muc_
	Viscosity [Pa.s]. More...

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

Detailed Description

template<class ParcelType>
class Foam::KinematicParcel< ParcelType >

Kinematic parcel class with rotational motion (as spherical particles only) and one/two-way coupling with the continuous phase.

Sub-models include:

• drag
• turbulent dispersion
• wall interactions

Source files

• KinematicParcel.H
• KinematicParcelI.H
• KinematicParcel.C
• KinematicParcelIO.C

Definition at line 60 of file KinematicParcel.H.

Constructor & Destructor Documentation

KinematicParcel ( 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 74 of file KinematicParcelI.H.

Referenced by KinematicParcel< ParcelType >::calcVelocity(), KinematicParcel< ParcelType >::clone(), and KinematicParcel< ParcelType >::constantProperties::constantProperties().

Here is the caller graph for this function:

KinematicParcel ( 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 &  torque0, const constantProperties &  constProps  )

inline

Construct from components.

Definition at line 101 of file KinematicParcelI.H.

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

Construct from Istream.

Definition at line 49 of file KinematicParcelIO.C.

References IOstream::check(), IOstream::format(), Istream::read(), Foam::readBool(), Foam::readLabel(), and readScalar.

Here is the call graph for this function:

KinematicParcel

(

const KinematicParcel< ParcelType > &

p

)

Construct as a copy.

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

Construct as a copy.

Member Function Documentation

const vector calcVelocity ( TrackData &  td, const scalar  dt, const label  celli, const scalar  Re, const scalar  mu, const scalar  mass, const vector &  Su, vector &  dUTrans, scalar &  Spu  ) const

protected

Calculate new particle velocity.

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

Here is the caller graph for this function:

TypeName

(

"KinematicParcel< ParcelType >"

)

Runtime type information.

AddToPropertyList	(	ParcelType	,
		" active"+" typeId"+" nParticle"+" d"+" dTarget "+" (Ux Uy Uz)"+" rho"+" age"+" tTurb"+" (UTurbx UTurby UTurbz)"
	)

String representation of properties.

virtual autoPtr<particle> clone ( ) const

inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 364 of file KinematicParcel.H.

References KinematicParcel< ParcelType >::KinematicParcel().

Here is the call graph for this function:

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

inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 370 of file KinematicParcel.H.

References KinematicParcel< ParcelType >::KinematicParcel().

Here is the call graph for this function:

bool active ( ) const

inline

Return const access to active flag.

Definition at line 177 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::active_.

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

Here is the caller graph for this function:

Foam::label typeId ( ) const

inline

Return const access to type id.

Definition at line 184 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::typeId_.

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

Here is the caller graph for this function:

Foam::scalar nParticle ( ) const

inline

Return const access to number of particles.

Definition at line 191 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::nParticle_.

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

Here is the caller graph for this function:

Foam::scalar d ( ) const

inline

Return const access to diameter.

Definition at line 198 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::d_.

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

Here is the caller graph for this function:

Foam::scalar dTarget ( ) const

inline

Return const access to target diameter.

Definition at line 205 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::dTarget_.

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

Here is the caller graph for this function:

const Foam::vector & U ( ) const

inline

Return const access to velocity.

Definition at line 212 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::U_.

Referenced by MPPICParcel< ParcelType >::move(), KinematicParcel< ParcelType >::iNew::operator()(), and KinematicParcel< ParcelType >::writeFields().

Here is the caller graph for this function:

Foam::scalar rho ( ) const

inline

Return const access to density.

Definition at line 219 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::rho_.

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

Here is the caller graph for this function:

Foam::scalar age ( ) const

inline

Return const access to the age.

Definition at line 226 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::age_.

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

Here is the caller graph for this function:

Foam::scalar tTurb ( ) const

inline

Return const access to time spent in turbulent eddy.

Definition at line 233 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::tTurb_.

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

Here is the caller graph for this function:

const Foam::vector & UTurb ( ) const

inline

Return const access to turbulent velocity fluctuation.

Definition at line 240 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::UTurb_.

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

Here is the caller graph for this function:

Foam::scalar rhoc ( ) const

inline

Return const access to carrier density [kg/m3].

Definition at line 247 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::rhoc_.

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

Here is the caller graph for this function:

const Foam::vector & Uc ( ) const

inline

Return const access to carrier velocity [m/s].

Definition at line 254 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::Uc_.

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

Here is the caller graph for this function:

Foam::scalar muc ( ) const

inline

Return const access to carrier viscosity [Pa.s].

Definition at line 261 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::muc_.

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

Here is the caller graph for this function:

bool & active ( )

inline

Return const access to active flag.

Definition at line 268 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::active_.

Foam::label & typeId ( )

inline

Return access to type id.

Definition at line 275 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::typeId_.

Foam::scalar & nParticle ( )

inline

Return access to number of particles.

Definition at line 282 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::nParticle_.

Foam::scalar & d ( )

inline

Return access to diameter.

Definition at line 289 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::d_.

Foam::scalar & dTarget ( )

inline

Return access to target diameter.

Definition at line 296 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::dTarget_.

Foam::vector & U ( )

inline

Return access to velocity.

Definition at line 303 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::U_.

Foam::scalar & rho ( )

inline

Return access to density.

Definition at line 310 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::rho_.

Foam::scalar & age ( )

inline

Return access to the age.

Definition at line 317 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::age_.

Foam::scalar & tTurb ( )

inline

Return access to time spent in turbulent eddy.

Definition at line 324 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::tTurb_.

Foam::vector & UTurb ( )

inline

Return access to turbulent velocity fluctuation.

Definition at line 331 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::UTurb_.

Foam::label faceInterpolation ( ) const

inline

Return the index of the face used in the interpolation routine.

Definition at line 338 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::massCell().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar massCell ( const label  celli ) const

inline

Cell owner mass.

Definition at line 354 of file KinematicParcelI.H.

References mesh, and KinematicParcel< ParcelType >::rhoc_.

Referenced by KinematicParcel< ParcelType >::faceInterpolation(), and KinematicParcel< ParcelType >::iNew::operator()().

Here is the caller graph for this function:

Foam::scalar mass ( ) const

inline

Particle mass.

Definition at line 363 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::rho_, and KinematicParcel< ParcelType >::volume().

Referenced by KinematicParcel< ParcelType >::momentOfInertia(), and KinematicParcel< ParcelType >::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar momentOfInertia ( ) const

inline

Particle moment of inertia around diameter axis.

Definition at line 370 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::d_, KinematicParcel< ParcelType >::mass(), and Foam::sqr().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar volume ( ) const

inline

Particle volume.

Definition at line 377 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::d_.

Referenced by KinematicParcel< ParcelType >::mass(), and KinematicParcel< ParcelType >::iNew::operator()().

Here is the caller graph for this function:

Foam::scalar volume ( const scalar  d )

inlinestatic

Particle volume for a given diameter.

Definition at line 384 of file KinematicParcelI.H.

References Foam::constant::mathematical::pi(), and Foam::pow3().

Here is the call graph for this function:

Foam::scalar areaP ( ) const

inline

Particle projected area.

Definition at line 391 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::d_.

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

Here is the caller graph for this function:

Foam::scalar areaP ( const scalar  d )

inlinestatic

Projected area for given diameter.

Definition at line 398 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::areaS().

Here is the call graph for this function:

Foam::scalar areaS ( ) const

inline

Particle surface area.

Definition at line 405 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::d_.

Referenced by KinematicParcel< ParcelType >::areaP(), and KinematicParcel< ParcelType >::iNew::operator()().

Here is the caller graph for this function:

Foam::scalar areaS ( const scalar  d )

inlinestatic

Surface area for given diameter.

Definition at line 412 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::d(), Foam::constant::mathematical::pi(), and KinematicParcel< ParcelType >::Re().

Here is the call graph for this function:

Foam::scalar Re ( const vector &  U, const scalar  d, const scalar  rhoc, const scalar  muc  ) const

inline

Reynolds number.

Definition at line 420 of file KinematicParcelI.H.

References Foam::mag(), KinematicParcel< ParcelType >::Uc_, and KinematicParcel< ParcelType >::We().

Referenced by KinematicParcel< ParcelType >::areaS(), and KinematicParcel< ParcelType >::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar We ( const vector &  U, const scalar  d, const scalar  rhoc, const scalar  sigma  ) const

inline

Weber number.

Definition at line 433 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::Eo(), Foam::magSqr(), and KinematicParcel< ParcelType >::Uc_.

Referenced by KinematicParcel< ParcelType >::iNew::operator()(), and KinematicParcel< ParcelType >::Re().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar Eo ( const vector &  a, const scalar  d, const scalar  sigma  ) const

inline

Eotvos number.

Definition at line 446 of file KinematicParcelI.H.

References Foam::mag(), KinematicParcel< ParcelType >::rho_, KinematicParcel< ParcelType >::rhoc_, Foam::sqr(), and KinematicParcel< ParcelType >::U_.

Referenced by KinematicParcel< ParcelType >::iNew::operator()(), and KinematicParcel< ParcelType >::We().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Set cell values.

Definition at line 42 of file KinematicParcel.C.

References KinematicParcel< ParcelType >::cellValueSourceCorrection(), Foam::endl(), Foam::nl, and WarningInFunction.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Correct cell values using latest transfer information.

Definition at line 84 of file KinematicParcel.C.

References KinematicParcel< ParcelType >::calc().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Update parcel properties over the time interval.

Definition at line 97 of file KinematicParcel.C.

References KinematicParcel< ParcelType >::calcVelocity(), Foam::Re(), Foam::fvc::Su(), and Foam::Zero.

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

Here is the call graph for this function:

Here is the caller graph for this function:

bool move	(	TrackData &	td,
		const scalar	trackTime
	)

Move the parcel.

Definition at line 254 of file KinematicParcel.C.

References polyMesh::boundaryMesh(), Foam::meshTools::constrainToMeshCentre(), Foam::mag(), maxCo, and Foam::min().

Referenced by KinematicParcel< ParcelType >::calcVelocity(), and KinematicParcel< ParcelType >::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

void hitFace

(

int &

td

)

Overridable function to handle the particle hitting a face.

without trackData

Definition at line 379 of file KinematicParcel.C.

References KinematicParcel< ParcelType >::hitPatch().

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

Here is the call graph for this function:

Here is the caller graph for this function:

void hitFace

(

TrackData &

td

)

Overridable function to handle the particle hitting a face.

Definition at line 369 of file KinematicParcel.C.

bool hitPatch	(	const polyPatch &	p,
		TrackData &	td,
		const label	patchi,
		const scalar	trackFraction,
		const tetIndices &	tetIs
	)

Overridable function to handle the particle hitting a patch.

Executed before other patch-hitting functions

Definition at line 386 of file KinematicParcel.C.

References KinematicParcel< ParcelType >::hitProcessorPatch().

Referenced by KinematicParcel< ParcelType >::hitFace(), KinematicParcel< ParcelType >::hitWallPatch(), and KinematicParcel< ParcelType >::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

void hitProcessorPatch	(	const processorPolyPatch &	,
		TrackData &	td
	)

Overridable function to handle the particle hitting a.

processorPatch

Definition at line 431 of file KinematicParcel.C.

References KinematicParcel< ParcelType >::hitWallPatch().

Referenced by KinematicParcel< ParcelType >::hitPatch(), and KinematicParcel< ParcelType >::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

void hitWallPatch	(	const wallPolyPatch &	wpp,
		TrackData &	td,
		const tetIndices &
	)

Overridable function to handle the particle hitting a wallPatch.

Definition at line 443 of file KinematicParcel.C.

References KinematicParcel< ParcelType >::hitPatch().

Referenced by KinematicParcel< ParcelType >::hitProcessorPatch(), and KinematicParcel< ParcelType >::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

void hitPatch	(	const polyPatch &	,
		TrackData &	td
	)

Overridable function to handle the particle hitting a polyPatch.

Definition at line 456 of file KinematicParcel.C.

void transformProperties ( const tensor &  T )

virtual

Transform the physical properties of the particle.

according to the given transformation tensor

Definition at line 466 of file KinematicParcel.C.

References Foam::transform().

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

Here is the call graph for this function:

Here is the caller graph for this function:

void transformProperties ( const vector &  separation )

virtual

Transform the physical properties of the particle.

according to the given separation vector

Definition at line 476 of file KinematicParcel.C.

References KinematicParcel< ParcelType >::wallImpactDistance().

Here is the call graph for this function:

Foam::scalar wallImpactDistance ( const vector &  n ) const

virtual

The nearest distance to a wall that the particle can be.

in the n direction

Definition at line 486 of file KinematicParcel.C.

Referenced by KinematicParcel< ParcelType >::iNew::operator()(), and KinematicParcel< ParcelType >::transformProperties().

Here is the caller graph for this function:

void readFields ( CloudType &  c )

static

Read.

Definition at line 102 of file KinematicParcelIO.C.

References KinematicParcel< ParcelType >::active_, KinematicParcel< ParcelType >::age_, Cloud< ParticleType >::checkFieldIOobject(), KinematicParcel< ParcelType >::d_, KinematicParcel< ParcelType >::dTarget_, Cloud< ParticleType >::fieldIOobject(), forAllIter, KinematicParcel< ParcelType >::nParticle_, p, Foam::readFields(), rho, KinematicParcel< ParcelType >::rho_, Cloud< ParticleType >::size(), KinematicParcel< ParcelType >::tTurb_, KinematicParcel< ParcelType >::typeId_, U, KinematicParcel< ParcelType >::U_, and KinematicParcel< ParcelType >::UTurb_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

void writeFields ( const CloudType &  c )

static

Write.

Definition at line 166 of file KinematicParcelIO.C.

References KinematicParcel< ParcelType >::active(), KinematicParcel< ParcelType >::age(), KinematicParcel< ParcelType >::d(), KinematicParcel< ParcelType >::dTarget(), Cloud< ParticleType >::fieldIOobject(), forAllConstIter(), KinematicParcel< ParcelType >::nParticle(), p, rho, KinematicParcel< ParcelType >::rho(), Cloud< ParticleType >::size(), KinematicParcel< ParcelType >::tTurb(), KinematicParcel< ParcelType >::typeId(), U, KinematicParcel< ParcelType >::U(), KinematicParcel< ParcelType >::UTurb(), and regIOobject::write().

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

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::vector calcVelocity	(	TrackData &	td,
		const scalar	dt,
		const label	celli,
		const scalar	Re,
		const scalar	mu,
		const scalar	mass,
		const vector &	Su,
		vector &	dUTrans,
		scalar &	Spu
	)		const

Definition at line 148 of file KinematicParcel.C.

References KinematicParcel< ParcelType >::active_, KinematicParcel< ParcelType >::age_, IntegrationScheme< Type >::integrationResult::average(), Foam::meshTools::constrainDirection(), KinematicParcel< ParcelType >::d_, KinematicParcel< ParcelType >::dTarget_, KinematicParcel< ParcelType >::KinematicParcel(), mesh, KinematicParcel< ParcelType >::move(), KinematicParcel< ParcelType >::muc_, KinematicParcel< ParcelType >::nParticle_, p, KinematicParcel< ParcelType >::rho_, KinematicParcel< ParcelType >::rhoc_, forceSuSp::Sp(), Foam::fvc::Su(), forceSuSp::Su(), KinematicParcel< ParcelType >::tTurb_, KinematicParcel< ParcelType >::typeId_, KinematicParcel< ParcelType >::U_, KinematicParcel< ParcelType >::Uc_, KinematicParcel< ParcelType >::UTurb_, and IntegrationScheme< Type >::integrationResult::value().

Here is the call graph for this function:

Friends And Related Function Documentation

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

friend

Member Data Documentation

bool active_

protected

Active flag - tracking inactive when active = false.

Definition at line 236 of file KinematicParcel.H.

Referenced by KinematicParcel< ParcelType >::active(), KinematicParcel< ParcelType >::calcVelocity(), and KinematicParcel< ParcelType >::readFields().

label typeId_

protected

Parcel type id.

Definition at line 239 of file KinematicParcel.H.

Referenced by KinematicParcel< ParcelType >::calcVelocity(), KinematicParcel< ParcelType >::readFields(), and KinematicParcel< ParcelType >::typeId().

scalar nParticle_

protected

Number of particles in Parcel.

Definition at line 242 of file KinematicParcel.H.

Referenced by KinematicParcel< ParcelType >::calcVelocity(), KinematicParcel< ParcelType >::nParticle(), and KinematicParcel< ParcelType >::readFields().

scalar d_

protected

Diameter [m].

Definition at line 245 of file KinematicParcel.H.

Referenced by KinematicParcel< ParcelType >::areaP(), KinematicParcel< ParcelType >::areaS(), KinematicParcel< ParcelType >::calcVelocity(), KinematicParcel< ParcelType >::d(), KinematicParcel< ParcelType >::momentOfInertia(), KinematicParcel< ParcelType >::readFields(), and KinematicParcel< ParcelType >::volume().

scalar dTarget_

protected

Target diameter [m].

Definition at line 248 of file KinematicParcel.H.

Referenced by KinematicParcel< ParcelType >::calcVelocity(), KinematicParcel< ParcelType >::dTarget(), and KinematicParcel< ParcelType >::readFields().

vector U_

protected

Velocity of Parcel [m/s].

Definition at line 251 of file KinematicParcel.H.

Referenced by KinematicParcel< ParcelType >::calcVelocity(), KinematicParcel< ParcelType >::Eo(), KinematicParcel< ParcelType >::readFields(), and KinematicParcel< ParcelType >::U().

scalar rho_

protected

Density [kg/m3].

Definition at line 254 of file KinematicParcel.H.

Referenced by KinematicParcel< ParcelType >::calcVelocity(), KinematicParcel< ParcelType >::Eo(), KinematicParcel< ParcelType >::mass(), KinematicParcel< ParcelType >::readFields(), and KinematicParcel< ParcelType >::rho().

scalar age_

protected

Age [s].

Definition at line 257 of file KinematicParcel.H.

Referenced by KinematicParcel< ParcelType >::age(), KinematicParcel< ParcelType >::calcVelocity(), and KinematicParcel< ParcelType >::readFields().

scalar tTurb_

protected

Time spent in turbulent eddy [s].

Definition at line 260 of file KinematicParcel.H.

Referenced by KinematicParcel< ParcelType >::calcVelocity(), KinematicParcel< ParcelType >::readFields(), and KinematicParcel< ParcelType >::tTurb().

vector UTurb_

protected

Turbulent velocity fluctuation [m/s].

Definition at line 263 of file KinematicParcel.H.

Referenced by KinematicParcel< ParcelType >::calcVelocity(), KinematicParcel< ParcelType >::readFields(), and KinematicParcel< ParcelType >::UTurb().

scalar rhoc_

protected

Density [kg/m3].

Definition at line 269 of file KinematicParcel.H.

Referenced by KinematicParcel< ParcelType >::calcVelocity(), KinematicParcel< ParcelType >::Eo(), KinematicParcel< ParcelType >::massCell(), and KinematicParcel< ParcelType >::rhoc().

vector Uc_

protected

Velocity [m/s].

Definition at line 272 of file KinematicParcel.H.

Referenced by KinematicParcel< ParcelType >::calcVelocity(), KinematicParcel< ParcelType >::Re(), KinematicParcel< ParcelType >::Uc(), and KinematicParcel< ParcelType >::We().

scalar muc_

protected

Viscosity [Pa.s].

Definition at line 275 of file KinematicParcel.H.

Referenced by KinematicParcel< ParcelType >::calcVelocity(), and KinematicParcel< ParcelType >::muc().

---

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

• src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H
• src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.C
• src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcelI.H
• src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcelIO.C