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 >:

[legend]

Collaboration diagram for KinematicParcel< ParcelType >:

[legend]

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 barycentric &coordinates, const label celli, const label tetFacei, const label tetPti)
	Construct from mesh, coordinates and topology. More...

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

	KinematicParcel (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 &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...

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

Definition at line 60 of file KinematicParcel.H.

Constructor & Destructor Documentation

◆ KinematicParcel() [1/6]

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

inline

Construct from mesh, coordinates and topology.

Other properties initialised as null

Definition at line 74 of file KinematicParcelI.H.

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

Here is the caller graph for this function:

◆ KinematicParcel() [2/6]

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

References KinematicParcel< ParcelType >::KinematicParcel().

Here is the call graph for this function:

◆ KinematicParcel() [3/6]

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

inline

Construct from components.

Definition at line 126 of file KinematicParcelI.H.

◆ KinematicParcel() [4/6]

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() [5/6]

KinematicParcel ( const KinematicParcel< ParcelType > & p )

Construct as a copy.

◆ KinematicParcel() [6/6]

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

Construct as a copy.

Member Function Documentation

◆ calcVelocity() [1/2]

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

TypeName ( "KinematicParcel< ParcelType >" )

Runtime type information.

◆ AddToPropertyList()

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

String representation of properties.

◆ clone() [1/2]

virtual autoPtr<particle> clone ( ) const

inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 373 of file KinematicParcel.H.

References KinematicParcel< ParcelType >::KinematicParcel().

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 379 of file KinematicParcel.H.

References KinematicParcel< ParcelType >::KinematicParcel().

Here is the call graph for this function:

◆ active() [1/2]

bool active ( ) const

inline

Return const access to active flag.

Definition at line 202 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:

◆ typeId() [1/2]

Foam::label typeId ( ) const

inline

Return const access to type id.

Definition at line 209 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:

◆ nParticle() [1/2]

Foam::scalar nParticle ( ) const

inline

Return const access to number of particles.

Definition at line 216 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:

◆ d() [1/2]

Foam::scalar d ( ) const

inline

Return const access to diameter.

Definition at line 223 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:

◆ dTarget() [1/2]

Foam::scalar dTarget ( ) const

inline

Return const access to target diameter.

Definition at line 230 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:

◆ U() [1/2]

const Foam::vector & U ( ) const

inline

Return const access to velocity.

Definition at line 237 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:

◆ rho() [1/2]

Foam::scalar rho ( ) const

inline

Return const access to density.

Definition at line 244 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:

◆ age() [1/2]

Foam::scalar age ( ) const

inline

Return const access to the age.

Definition at line 251 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:

◆ tTurb() [1/2]

Foam::scalar tTurb ( ) const

inline

Return const access to time spent in turbulent eddy.

Definition at line 258 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:

◆ UTurb() [1/2]

const Foam::vector & UTurb ( ) const

inline

Return const access to turbulent velocity fluctuation.

Definition at line 265 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:

◆ rhoc()

Foam::scalar rhoc ( ) const

inline

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

Definition at line 272 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::rhoc_.

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

Here is the caller graph for this function:

◆ Uc()

const Foam::vector & Uc ( ) const

inline

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

Definition at line 279 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::Uc_.

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

Here is the caller graph for this function:

◆ muc()

Foam::scalar muc ( ) const

inline

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

Definition at line 286 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::muc_.

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

Here is the caller graph for this function:

◆ active() [2/2]

bool & active ( )

inline

Return const access to active flag.

Definition at line 293 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::active_.

◆ typeId() [2/2]

Foam::label & typeId ( )

inline

Return access to type id.

Definition at line 300 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::typeId_.

◆ nParticle() [2/2]

Foam::scalar & nParticle ( )

inline

Return access to number of particles.

Definition at line 307 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::nParticle_.

◆ d() [2/2]

Foam::scalar & d ( )

inline

Return access to diameter.

Definition at line 314 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::d_.

◆ dTarget() [2/2]

Foam::scalar & dTarget ( )

inline

Return access to target diameter.

Definition at line 321 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::dTarget_.

◆ U() [2/2]

Foam::vector & U ( )

inline

Return access to velocity.

Definition at line 328 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::U_.

◆ rho() [2/2]

Foam::scalar & rho ( )

inline

Return access to density.

Definition at line 335 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::rho_.

◆ age() [2/2]

Foam::scalar & age ( )

inline

Return access to the age.

Definition at line 342 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::age_.

◆ tTurb() [2/2]

Foam::scalar & tTurb ( )

inline

Return access to time spent in turbulent eddy.

Definition at line 349 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::tTurb_.

◆ UTurb() [2/2]

Foam::vector & UTurb ( )

inline

Return access to turbulent velocity fluctuation.

Definition at line 356 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::massCell(), and KinematicParcel< ParcelType >::UTurb_.

Here is the call graph for this function:

◆ massCell()

Foam::scalar massCell ( const label celli ) const

inline

Cell owner mass.

Definition at line 364 of file KinematicParcelI.H.

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

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

Here is the caller graph for this function:

◆ mass()

Foam::scalar mass ( ) const

inline

Particle mass.

Definition at line 373 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:

◆ momentOfInertia()

Foam::scalar momentOfInertia ( ) const

inline

Particle moment of inertia around diameter axis.

Definition at line 380 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:

◆ volume() [1/2]

Foam::scalar volume ( ) const

inline

Particle volume.

Definition at line 387 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:

◆ volume() [2/2]

Foam::scalar volume ( const scalar d )

inlinestatic

Particle volume for a given diameter.

Definition at line 394 of file KinematicParcelI.H.

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

Here is the call graph for this function:

◆ areaP() [1/2]

Foam::scalar areaP ( ) const

inline

Particle projected area.

Definition at line 401 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::d_.

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

Here is the caller graph for this function:

◆ areaP() [2/2]

Foam::scalar areaP ( const scalar d )

inlinestatic

Projected area for given diameter.

Definition at line 408 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::areaS().

Here is the call graph for this function:

◆ areaS() [1/2]

Foam::scalar areaS ( ) const

inline

Particle surface area.

Definition at line 415 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:

◆ areaS() [2/2]

Foam::scalar areaS ( const scalar d )

inlinestatic

Surface area for given diameter.

Definition at line 422 of file KinematicParcelI.H.

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

Here is the call graph for this function:

◆ Re()

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

inline

Reynolds number.

Definition at line 430 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:

◆ We()

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

inline

Weber number.

Definition at line 443 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:

◆ Eo()

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

inline

Eotvos number.

Definition at line 456 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:

◆ setCellValues()

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(), coordinates(), 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:

◆ cellValueSourceCorrection()

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:

◆ calc()

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(), 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:

◆ move()

bool move	(	TrackData &	td,
		const scalar	trackTime
	)

Move the parcel.

Definition at line 254 of file KinematicParcel.C.

References polyMesh::boundaryMesh(), f(), Foam::mag(), Foam::max(), maxCo, Foam::min(), and s().

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:

◆ hitFace() [1/2]

void hitFace ( int & td )

Overridable function to handle the particle hitting a face.

without trackData

Definition at line 353 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:

◆ hitFace() [2/2]

void hitFace ( TrackData & td )

Overridable function to handle the particle hitting a face.

Definition at line 343 of file KinematicParcel.C.

◆ hitPatch() [1/2]

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 360 of file KinematicParcel.C.

References polyPatch::coupled(), and 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:

◆ hitProcessorPatch()

void hitProcessorPatch	(	const processorPolyPatch &	,
		TrackData &	td
	)

Overridable function to handle the particle hitting a.

processorPatch

Definition at line 410 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:

◆ hitWallPatch()

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

Overridable function to handle the particle hitting a wallPatch.

Definition at line 422 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:

◆ hitPatch() [2/2]

void hitPatch	(	const polyPatch &	,
		TrackData &	td
	)

Overridable function to handle the particle hitting a polyPatch.

Definition at line 435 of file KinematicParcel.C.

◆ transformProperties() [1/2]

void transformProperties ( const tensor & T )

virtual

Transform the physical properties of the particle.

according to the given transformation tensor

Definition at line 445 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:

◆ transformProperties() [2/2]

void transformProperties ( const vector & separation )

virtual

Transform the physical properties of the particle.

according to the given separation vector

Definition at line 455 of file KinematicParcel.C.

References KinematicParcel< ParcelType >::wallImpactDistance().

Here is the call graph for this function:

◆ wallImpactDistance()

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 465 of file KinematicParcel.C.

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

Here is the caller graph for this function:

◆ readFields()

void readFields ( CloudType & c )

static

Read.

Definition at line 102 of file KinematicParcelIO.C.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFields()

void writeFields ( const CloudType & c )

static

Write.

Definition at line 202 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:

◆ calcVelocity() [2/2]

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.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

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

friend

Member Data Documentation

◆ active_

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

◆ typeId_

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

◆ nParticle_

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

◆ d_

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

◆ dTarget_

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

◆ U_

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

◆ rho_

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

◆ age_

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

◆ tTurb_

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

◆ UTurb_

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

◆ rhoc_

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

◆ Uc_

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

◆ muc_

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

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

Constructor & Destructor Documentation

◆ KinematicParcel() [1/6]

◆ KinematicParcel() [2/6]

◆ KinematicParcel() [3/6]

◆ KinematicParcel() [4/6]

◆ KinematicParcel() [5/6]

◆ KinematicParcel() [6/6]

Member Function Documentation

◆ calcVelocity() [1/2]

◆ TypeName()

◆ AddToPropertyList()

◆ clone() [1/2]

◆ clone() [2/2]

◆ active() [1/2]

◆ typeId() [1/2]

◆ nParticle() [1/2]

◆ d() [1/2]

◆ dTarget() [1/2]

◆ U() [1/2]

◆ rho() [1/2]

◆ age() [1/2]

◆ tTurb() [1/2]

◆ UTurb() [1/2]

◆ rhoc()

◆ Uc()

◆ muc()

◆ active() [2/2]

◆ typeId() [2/2]

◆ nParticle() [2/2]

◆ d() [2/2]

◆ dTarget() [2/2]

◆ U() [2/2]

◆ rho() [2/2]

◆ age() [2/2]

◆ tTurb() [2/2]

◆ UTurb() [2/2]

◆ massCell()

◆ mass()

◆ momentOfInertia()

◆ volume() [1/2]

◆ volume() [2/2]

◆ areaP() [1/2]

◆ areaP() [2/2]

◆ areaS() [1/2]

◆ areaS() [2/2]

◆ Re()

◆ We()

◆ Eo()

◆ setCellValues()

◆ cellValueSourceCorrection()

◆ calc()

◆ move()

◆ hitFace() [1/2]

◆ hitFace() [2/2]

◆ hitPatch() [1/2]

◆ hitProcessorPatch()

◆ hitWallPatch()

◆ hitPatch() [2/2]

◆ transformProperties() [1/2]

◆ transformProperties() [2/2]

◆ wallImpactDistance()

◆ readFields()

◆ writeFields()

◆ calcVelocity() [2/2]

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ active_

◆ typeId_

◆ nParticle_

◆ d_

◆ dTarget_

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