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

#include <KinematicParcel.H>

Inheritance diagram for KinematicParcel< ParcelType >:

[legend]

Collaboration diagram for KinematicParcel< ParcelType >:

[legend]

Classes
class	constantProperties
	Class to hold kinematic particle constant properties. More...
class	trackingData
class	iNew
	Factory class to read-construct particles (for parallel transfer). More...

Public Member Functions
	TypeName ("KinematicParcel")
	Runtime type information.
	AddToPropertyList (ParcelType, " active"+" typeId"+" nParticle"+" d"+" dTarget"+" (Ux Uy Uz)"+" rho"+" age"+" tTurb"+" (UTurbx UTurby UTurbz)"+" (UCorrectx UCorrecty UCorrectz)")
	String representation of properties.
	KinematicParcel (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti)
	Construct from mesh, coordinates and topology.
	KinematicParcel (const polyMesh &mesh, const vector &position, const label celli)
	Construct from a position and a cell, searching for the rest of the.
	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 &U0, const constantProperties &constProps)
	Construct from components.
	KinematicParcel (const polyMesh &mesh, Istream &is, bool readFields=true, bool newFormat=true)
	Construct from Istream.
	KinematicParcel (const KinematicParcel &p)
	Construct as a copy.
	KinematicParcel (const KinematicParcel &p, const polyMesh &mesh)
	Construct as a copy.
virtual autoPtr< particle >	clone () const
	Return a (basic particle) clone.
virtual autoPtr< particle >	clone (const polyMesh &mesh) const
	Return a (basic particle) clone.
bool	active () const
	Return const access to active flag.
label	typeId () const
	Return const access to type id.
scalar	nParticle () const
	Return const access to number of particles.
scalar	d () const
	Return const access to diameter.
scalar	dTarget () const
	Return const access to target diameter.
const vector &	U () const
	Return const access to velocity.
scalar	rho () const
	Return const access to density.
scalar	age () const
	Return const access to the age.
scalar	tTurb () const
	Return const access to time spent in turbulent eddy.
const vector &	UTurb () const
	Return const access to turbulent velocity fluctuation.
const vector &	UCorrect () const
	Return const access to correction velocity.
void	active (const bool state)
	Set active flag to the specified state.
label &	typeId ()
	Return access to type id.
scalar &	nParticle ()
	Return access to number of particles.
scalar &	d ()
	Return access to diameter.
scalar &	dTarget ()
	Return access to target diameter.
vector &	U ()
	Return access to velocity.
scalar &	rho ()
	Return access to density.
scalar &	age ()
	Return access to the age.
scalar &	tTurb ()
	Return access to time spent in turbulent eddy.
vector &	UTurb ()
	Return access to turbulent velocity fluctuation.
vector &	UCorrect ()
	Return access to correction velocity.
scalar	massCell (const trackingData &td) const
	Cell owner mass.
scalar	mass () const
	Particle mass.
scalar	momentOfInertia () const
	Particle moment of inertia around diameter axis.
scalar	volume () const
	Particle volume.
scalar	areaP () const
	Particle projected area.
scalar	areaS () const
	Particle surface area.
scalar	Re (const trackingData &td) const
	Reynolds number.
scalar	We (const trackingData &td, const scalar sigma) const
	Weber number.
scalar	Eo (const trackingData &td, const scalar sigma) const
	Eotvos number.
template<class TrackCloudType>
void	setCellValues (TrackCloudType &cloud, trackingData &td)
	Set cell values.
template<class TrackCloudType>
void	calcDispersion (TrackCloudType &cloud, trackingData &td, const scalar dt)
	Apply dispersion to the carrier phase velocity and update.
template<class TrackCloudType>
void	cellValueSourceCorrection (TrackCloudType &cloud, trackingData &td, const scalar dt)
	Correct cell values using latest transfer information.
template<class TrackCloudType>
void	calc (TrackCloudType &cloud, trackingData &td, const scalar dt)
	Update parcel properties over the time interval.
template<class TrackCloudType>
void	calcUCorrection (TrackCloudType &cloud, trackingData &td, const scalar dt)
	Correct U following MP-PIC sub-models.
template<class TrackCloudType>
bool	move (TrackCloudType &cloud, trackingData &td, const scalar trackTime)
	Move the parcel.
template<class TrackCloudType>
bool	hitPatch (TrackCloudType &cloud, trackingData &td)
	Overridable function to handle the particle hitting a patch.
template<class TrackCloudType>
void	hitProcessorPatch (TrackCloudType &cloud, trackingData &td)
	Overridable function to handle the particle hitting a.
template<class TrackCloudType>
void	hitWallPatch (TrackCloudType &cloud, trackingData &td)
	Overridable function to handle the particle hitting a wallPatch.
virtual void	transformProperties (const tensor &T)
	Transform the physical properties of the particle.
virtual void	transformProperties (const vector &separation)
	Transform the physical properties of the particle.
void	writeProperties (Ostream &os, const wordRes &filters, const word &delim, const bool namesOnly=false) const
	Write individual parcel properties to stream.
template<class TrackCloudType>
const Foam::vector	calcVelocity (TrackCloudType &cloud, trackingData &td, const scalar dt, const scalar Re, const scalar mu, const scalar mass, const vector &Su, vector &dUTrans, scalar &Spu) const
template<class CloudType>
void	readFields (CloudType &c)
template<class CloudType>
void	writeFields (const CloudType &c)

Static Public Member Functions
static scalar	volume (const scalar d)
	Particle volume for a given diameter.
static scalar	areaP (const scalar d)
	Projected area for given diameter.
static scalar	areaS (const scalar d)
	Surface area for given diameter.
static scalar	Re (const scalar rhoc, const vector &U, const vector &Uc, const scalar d, const scalar muc)
	Reynolds number for given conditions.
static scalar	We (const scalar rhoc, const vector &U, const vector &Uc, const scalar d, const scalar sigma)
	Weber number for given conditions.
static scalar	Eo (const vector &g, const scalar rho, const scalar rhoc, const vector &U, const scalar d, const scalar sigma)
	Eotvos number for given conditions.
template<class TrackCloudType>
static void	readFields (TrackCloudType &c)
	Read.
template<class TrackCloudType>
static void	writeFields (const TrackCloudType &c)
	Write.
template<class CloudType>
static void	readObjects (CloudType &c, const objectRegistry &obr)
	Read particle fields as objects from the obr registry.
template<class CloudType>
static void	writeObjects (const CloudType &c, objectRegistry &obr)
	Write particle fields as objects into the obr registry.

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

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

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

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

Constructor & Destructor Documentation

◆ KinematicParcel() [1/6]

template<class ParcelType>

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 69 of file KinematicParcelI.H.

References active_, age_, coordinates(), d_, dTarget_, nParticle_, rho_, tTurb_, typeId_, U_, UTurb_, and Foam::Zero.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ KinematicParcel() [2/6]

template<class ParcelType>

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 93 of file KinematicParcelI.H.

References active_, age_, d_, dTarget_, nParticle_, rho_, tTurb_, typeId_, U_, UTurb_, and Foam::Zero.

◆ KinematicParcel() [3/6]

template<class ParcelType>

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 &	U0,
		const constantProperties &	constProps )

inline

Construct from components.

Definition at line 115 of file KinematicParcelI.H.

References active_, age_, coordinates(), d_, dTarget_, nParticle_, rho0, rho_, tTurb_, typeId(), typeId_, U_, UTurb_, and Foam::Zero.

Here is the call graph for this function:

◆ KinematicParcel() [4/6]

template<class ParcelType>

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

Construct from Istream.

Definition at line 45 of file KinematicParcelIO.C.

References active_, age_, IOstreamOption::ASCII, IOstream::check(), d_, dTarget_, IOstream::fatalCheckNativeSizes(), IOstreamOption::format(), FUNCTION_NAME, mesh, nParticle_, Istream::read(), readFields(), rho_, sizeofFields, tTurb_, typeId_, U_, UCorrect_, UTurb_, and Foam::Zero.

Here is the call graph for this function:

◆ KinematicParcel() [5/6]

template<class ParcelType>

KinematicParcel ( const KinematicParcel< ParcelType > & p )

Construct as a copy.

◆ KinematicParcel() [6/6]

template<class ParcelType>

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

Construct as a copy.

Member Function Documentation

◆ calcVelocity() [1/2]

template<class ParcelType>

template<class TrackCloudType>

const vector calcVelocity	(	TrackCloudType &	cloud,
		trackingData &	td,
		const scalar	dt,
		const scalar	Re,
		const scalar	mu,
		const scalar	mass,
		const vector &	Su,
		vector &	dUTrans,
		scalar &	Spu ) const

protected

Calculate new particle velocity.

Referenced by calc().

Here is the caller graph for this function:

◆ TypeName()

template<class ParcelType>

TypeName ( "KinematicParcel< ParcelType >" )

Runtime type information.

◆ AddToPropertyList()

template<class ParcelType>

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

String representation of properties.

◆ clone() [1/2]

template<class ParcelType>

virtual autoPtr< particle > clone ( ) const

inlinevirtual

Return a (basic particle) clone.

Reimplemented in CollidingParcel< KinematicParcel< particle > >, MPPICParcel< KinematicParcel< particle > >, ReactingHeterogeneousParcel< ReactingParcel< ThermoParcel< KinematicParcel< particle > > > >, ReactingMultiphaseParcel< ReactingParcel< ThermoParcel< KinematicParcel< particle > > > >, ReactingParcel< ThermoParcel< KinematicParcel< particle > > >, SprayParcel< ReactingParcel< ThermoParcel< KinematicParcel< particle > > > >, and ThermoParcel< KinematicParcel< particle > >.

Definition at line 564 of file KinematicParcel.H.

◆ clone() [2/2]

template<class ParcelType>

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

inlinevirtual

Return a (basic particle) clone.

Reimplemented in CollidingParcel< KinematicParcel< particle > >, MPPICParcel< KinematicParcel< particle > >, ReactingHeterogeneousParcel< ReactingParcel< ThermoParcel< KinematicParcel< particle > > > >, ReactingMultiphaseParcel< ReactingParcel< ThermoParcel< KinematicParcel< particle > > > >, ReactingParcel< ThermoParcel< KinematicParcel< particle > > >, SprayParcel< ReactingParcel< ThermoParcel< KinematicParcel< particle > > > >, and ThermoParcel< KinematicParcel< particle > >.

Definition at line 572 of file KinematicParcel.H.

◆ active() [1/2]

template<class ParcelType>

bool active ( ) const

inline

Return const access to active flag.

Definition at line 189 of file KinematicParcelI.H.

References active_.

Referenced by readObjects(), and writeObjects().

Here is the caller graph for this function:

◆ typeId() [1/2]

template<class ParcelType>

Foam::label typeId ( ) const

inline

Return const access to type id.

Definition at line 196 of file KinematicParcelI.H.

References typeId_.

Referenced by KinematicParcel(), readObjects(), and writeObjects().

Here is the caller graph for this function:

◆ nParticle() [1/2]

template<class ParcelType>

Foam::scalar nParticle ( ) const

inline

Return const access to number of particles.

Definition at line 203 of file KinematicParcelI.H.

References nParticle_.

Referenced by readObjects(), and writeObjects().

Here is the caller graph for this function:

◆ d() [1/2]

template<class ParcelType>

Foam::scalar d ( ) const

inline

Return const access to diameter.

Definition at line 210 of file KinematicParcelI.H.

References d_.

Referenced by areaP(), areaS(), Eo(), move(), Re(), readObjects(), volume(), We(), and writeObjects().

Here is the caller graph for this function:

◆ dTarget() [1/2]

template<class ParcelType>

Foam::scalar dTarget ( ) const

inline

Return const access to target diameter.

Definition at line 217 of file KinematicParcelI.H.

References dTarget_.

Referenced by readObjects(), and writeObjects().

Here is the caller graph for this function:

◆ U() [1/2]

template<class ParcelType>

const Foam::vector & U ( ) const

inline

Return const access to velocity.

Definition at line 224 of file KinematicParcelI.H.

References U_.

Referenced by Eo(), Re(), readObjects(), KinematicParcel< ParcelType >::trackingData::trackingData(), We(), and writeObjects().

Here is the caller graph for this function:

◆ rho() [1/2]

template<class ParcelType>

Foam::scalar rho ( ) const

inline

Return const access to density.

Definition at line 231 of file KinematicParcelI.H.

References rho_.

Referenced by Eo(), readObjects(), KinematicParcel< ParcelType >::trackingData::trackingData(), and writeObjects().

Here is the caller graph for this function:

◆ age() [1/2]

template<class ParcelType>

Foam::scalar age ( ) const

inline

Return const access to the age.

Definition at line 238 of file KinematicParcelI.H.

References age_.

Referenced by readObjects(), and writeObjects().

Here is the caller graph for this function:

◆ tTurb() [1/2]

template<class ParcelType>

Foam::scalar tTurb ( ) const

inline

Return const access to time spent in turbulent eddy.

Definition at line 245 of file KinematicParcelI.H.

References tTurb_.

Referenced by readObjects(), and writeObjects().

Here is the caller graph for this function:

◆ UTurb() [1/2]

template<class ParcelType>

const Foam::vector & UTurb ( ) const

inline

Return const access to turbulent velocity fluctuation.

Definition at line 252 of file KinematicParcelI.H.

References UTurb_.

Referenced by readObjects(), and writeObjects().

Here is the caller graph for this function:

◆ UCorrect() [1/2]

template<class ParcelType>

const Foam::vector & UCorrect ( ) const

inline

Return const access to correction velocity.

Definition at line 301 of file KinematicParcelI.H.

References UCorrect_.

Referenced by readObjects(), and writeObjects().

Here is the caller graph for this function:

◆ active() [2/2]

template<class ParcelType>

void active ( const bool state )

inline

Set active flag to the specified state.

Definition at line 259 of file KinematicParcelI.H.

References active_.

◆ typeId() [2/2]

template<class ParcelType>

Foam::label & typeId ( )

inline

Return access to type id.

Definition at line 266 of file KinematicParcelI.H.

References typeId_.

◆ nParticle() [2/2]

template<class ParcelType>

Foam::scalar & nParticle ( )

inline

Return access to number of particles.

Definition at line 273 of file KinematicParcelI.H.

References nParticle_.

◆ d() [2/2]

template<class ParcelType>

Foam::scalar & d ( )

inline

Return access to diameter.

Definition at line 280 of file KinematicParcelI.H.

References d_.

◆ dTarget() [2/2]

template<class ParcelType>

Foam::scalar & dTarget ( )

inline

Return access to target diameter.

Definition at line 287 of file KinematicParcelI.H.

References dTarget_.

◆ U() [2/2]

template<class ParcelType>

Foam::vector & U ( )

inline

Return access to velocity.

Definition at line 294 of file KinematicParcelI.H.

References U_.

◆ rho() [2/2]

template<class ParcelType>

Foam::scalar & rho ( )

inline

Return access to density.

Definition at line 315 of file KinematicParcelI.H.

References rho_.

◆ age() [2/2]

template<class ParcelType>

Foam::scalar & age ( )

inline

Return access to the age.

Definition at line 322 of file KinematicParcelI.H.

References age_.

◆ tTurb() [2/2]

template<class ParcelType>

Foam::scalar & tTurb ( )

inline

Return access to time spent in turbulent eddy.

Definition at line 329 of file KinematicParcelI.H.

References tTurb_.

◆ UTurb() [2/2]

template<class ParcelType>

Foam::vector & UTurb ( )

inline

Return access to turbulent velocity fluctuation.

Definition at line 336 of file KinematicParcelI.H.

References UTurb_.

◆ UCorrect() [2/2]

template<class ParcelType>

Foam::vector & UCorrect ( )

inline

Return access to correction velocity.

Definition at line 308 of file KinematicParcelI.H.

References UCorrect_.

◆ massCell()

template<class ParcelType>

Foam::scalar massCell ( const trackingData & td ) const

inline

Cell owner mass.

Definition at line 343 of file KinematicParcelI.H.

References primitiveMesh::cellVolumes(), mesh, and td().

Referenced by cellValueSourceCorrection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mass()

template<class ParcelType>

Foam::scalar mass ( ) const

inline

Particle mass.

Definition at line 353 of file KinematicParcelI.H.

References rho_, and volume().

Referenced by calc(), hitPatch(), and momentOfInertia().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ momentOfInertia()

template<class ParcelType>

Foam::scalar momentOfInertia ( ) const

inline

Particle moment of inertia around diameter axis.

Definition at line 360 of file KinematicParcelI.H.

References d_, mass(), and Foam::sqr().

Here is the call graph for this function:

◆ volume() [1/2]

template<class ParcelType>

Foam::scalar volume ( ) const

inline

Particle volume.

Definition at line 367 of file KinematicParcelI.H.

References d_, and volume().

Referenced by mass(), and volume().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ volume() [2/2]

template<class ParcelType>

Foam::scalar volume ( const scalar d )

inlinestatic

Particle volume for a given diameter.

Definition at line 374 of file KinematicParcelI.H.

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

Here is the call graph for this function:

◆ areaP() [1/2]

template<class ParcelType>

Foam::scalar areaP ( ) const

inline

Particle projected area.

Definition at line 381 of file KinematicParcelI.H.

References areaP(), and d_.

Referenced by areaP().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ areaP() [2/2]

template<class ParcelType>

Foam::scalar areaP ( const scalar d )

inlinestatic

Projected area for given diameter.

Definition at line 388 of file KinematicParcelI.H.

References areaS(), and d().

Here is the call graph for this function:

◆ areaS() [1/2]

template<class ParcelType>

Foam::scalar areaS ( ) const

inline

Particle surface area.

Definition at line 395 of file KinematicParcelI.H.

References areaS(), and d_.

Referenced by areaP(), and areaS().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ areaS() [2/2]

template<class ParcelType>

Foam::scalar areaS ( const scalar d )

inlinestatic

Surface area for given diameter.

Definition at line 402 of file KinematicParcelI.H.

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

Here is the call graph for this function:

◆ Re() [1/2]

template<class ParcelType>

Foam::scalar Re ( const trackingData & td ) const

inline

Reynolds number.

Definition at line 409 of file KinematicParcelI.H.

References d_, Foam::Re(), td(), and U_.

Referenced by calc().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Re() [2/2]

template<class ParcelType>

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

inlinestatic

Reynolds number for given conditions.

Definition at line 419 of file KinematicParcelI.H.

References d(), Foam::mag(), Foam::max(), and U().

Here is the call graph for this function:

◆ We() [1/2]

template<class ParcelType>

Foam::scalar We	(	const trackingData &	td,
		const scalar	sigma ) const

inline

Weber number.

Definition at line 433 of file KinematicParcelI.H.

References d_, sigma(), td(), U_, and We().

Referenced by We().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ We() [2/2]

template<class ParcelType>

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

inlinestatic

Weber number for given conditions.

Definition at line 444 of file KinematicParcelI.H.

References d(), Foam::magSqr(), Foam::max(), sigma(), and U().

Here is the call graph for this function:

◆ Eo() [1/2]

template<class ParcelType>

Foam::scalar Eo	(	const trackingData &	td,
		const scalar	sigma ) const

inline

Eotvos number.

Definition at line 458 of file KinematicParcelI.H.

References d_, Eo(), rho_, sigma(), td(), and U_.

Referenced by Eo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Eo() [2/2]

template<class ParcelType>

Foam::scalar Eo	(	const vector &	g,
		const scalar	rho,
		const scalar	rhoc,
		const vector &	U,
		const scalar	d,
		const scalar	sigma )

inlinestatic

Eotvos number for given conditions.

Definition at line 469 of file KinematicParcelI.H.

References d(), g, Foam::mag(), Foam::max(), rho(), sigma(), Foam::sqr(), and U().

Here is the call graph for this function:

◆ setCellValues()

template<class ParcelType>

template<class TrackCloudType>

void setCellValues	(	TrackCloudType &	cloud,
		trackingData &	td )

Set cell values.

Definition at line 38 of file KinematicParcel.C.

References coordinates(), Foam::endl(), Foam::nl, td(), and WarningInFunction.

Here is the call graph for this function:

◆ calcDispersion()

template<class ParcelType>

template<class TrackCloudType>

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

Apply dispersion to the carrier phase velocity and update.

parcel turbulence parameters

Definition at line 68 of file KinematicParcel.C.

References td(), tTurb_, U_, and UTurb_.

Here is the call graph for this function:

◆ cellValueSourceCorrection()

template<class ParcelType>

template<class TrackCloudType>

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

Correct cell values using latest transfer information.

Definition at line 111 of file KinematicParcel.C.

References massCell(), and td().

Here is the call graph for this function:

◆ calc()

template<class ParcelType>

template<class TrackCloudType>

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

Update parcel properties over the time interval.

Definition at line 124 of file KinematicParcel.C.

References calcVelocity(), mass(), nParticle_, Re(), Foam::Su(), td(), U_, UCorrect_, and Foam::Zero.

Here is the call graph for this function:

◆ calcUCorrection()

template<class ParcelType>

template<class TrackCloudType>

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

Correct U following MP-PIC sub-models.

Definition at line 89 of file KinematicParcel.C.

References p, td(), UCorrect_, and Foam::Zero.

Here is the call graph for this function:

◆ move()

template<class ParcelType>

template<class TrackCloudType>

bool move	(	TrackCloudType &	cloud,
		trackingData &	td,
		const scalar	trackTime )

Move the parcel.

Definition at line 300 of file KinematicParcel.C.

References d(), f(), Foam::mag(), Foam::max(), maxCo, Foam::min(), p, s(), td(), and U_.

Here is the call graph for this function:

◆ hitPatch()

template<class ParcelType>

template<class TrackCloudType>

bool hitPatch	(	TrackCloudType &	cloud,
		trackingData &	td )

Overridable function to handle the particle hitting a patch.

Executed before other patch-hitting functions

Definition at line 395 of file KinematicParcel.C.

References polyPatch::constraintType(), Foam::isA(), mass(), nParticle_, p, pp(), and td().

Here is the call graph for this function:

◆ hitProcessorPatch()

template<class ParcelType>

template<class TrackCloudType>

void hitProcessorPatch	(	TrackCloudType &	cloud,
		trackingData &	td )

Overridable function to handle the particle hitting a.

processorPatch

Definition at line 439 of file KinematicParcel.C.

References td().

Here is the call graph for this function:

◆ hitWallPatch()

template<class ParcelType>

template<class TrackCloudType>

void hitWallPatch	(	TrackCloudType &	cloud,
		trackingData &	td )

Overridable function to handle the particle hitting a wallPatch.

Definition at line 451 of file KinematicParcel.C.

◆ transformProperties() [1/2]

template<class ParcelType>

void transformProperties ( const tensor & T )

virtual

Transform the physical properties of the particle.

according to the given transformation tensor

Reimplemented in CollidingParcel< KinematicParcel< particle > >.

Definition at line 462 of file KinematicParcel.C.

References Foam::T(), Foam::transform(), and U_.

Here is the call graph for this function:

◆ transformProperties() [2/2]

template<class ParcelType>

void transformProperties ( const vector & separation )

virtual

Transform the physical properties of the particle.

according to the given separation vector

Reimplemented in CollidingParcel< KinematicParcel< particle > >.

Definition at line 471 of file KinematicParcel.C.

◆ readFields() [1/2]

template<class ParcelType>

template<class TrackCloudType>

void readFields ( TrackCloudType & c )

static

Read.

Referenced by KinematicParcel().

Here is the caller graph for this function:

◆ writeFields() [1/2]

template<class ParcelType>

template<class TrackCloudType>

void writeFields ( const TrackCloudType & c )

static

Write.

◆ writeProperties()

template<class ParcelType>

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

Write individual parcel properties to stream.

Definition at line 260 of file KinematicParcelIO.C.

References active_, age_, d_, dTarget_, nParticle_, os(), rho_, tTurb_, typeId_, U_, UCorrect_, UTurb_, and writeProp.

Here is the call graph for this function:

◆ readObjects()

template<class ParcelType>

template<class CloudType>

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

static

Read particle fields as objects from the obr registry.

Definition at line 292 of file KinematicParcelIO.C.

References active(), age(), d(), dTarget(), KinematicParcel(), cloud::lookupIOField(), nParticle(), p, rho(), tTurb(), typeId(), U(), UCorrect(), and UTurb().

Here is the call graph for this function:

◆ writeObjects()

template<class ParcelType>

template<class CloudType>

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

static

Write particle fields as objects into the obr registry.

Definition at line 337 of file KinematicParcelIO.C.

References active(), age(), cloud::createIOField(), d(), dTarget(), KinematicParcel(), nParticle(), p, rho(), tTurb(), typeId(), U(), UCorrect(), and UTurb().

Here is the call graph for this function:

◆ calcVelocity() [2/2]

template<class ParcelType>

template<class TrackCloudType>

const Foam::vector calcVelocity	(	TrackCloudType &	cloud,
		trackingData &	td,
		const scalar	dt,
		const scalar	Re,
		const scalar	mu,
		const scalar	mass,
		const vector &	Su,
		vector &	dUTrans,
		scalar &	Spu ) const

Definition at line 177 of file KinematicParcel.C.

◆ readFields() [2/2]

template<class ParcelType>

template<class CloudType>

void readFields ( CloudType & c )

Definition at line 97 of file KinematicParcelIO.C.

◆ writeFields() [2/2]

template<class ParcelType>

template<class CloudType>

void writeFields ( const CloudType & c )

Definition at line 203 of file KinematicParcelIO.C.

◆ operator<<

template<class ParcelType>

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

friend

Member Data Documentation

◆ sizeofFields

template<class ParcelType>

const std::size_t sizeofFields

static

Size in bytes of the fields.

Definition at line 97 of file KinematicParcel.H.

Referenced by KinematicParcel().

◆ active_

template<class ParcelType>

label active_

protected

Active flag - tracking inactive when active = false.

Store as label for data alignment, but only has bool states

Definition at line 392 of file KinematicParcel.H.

Referenced by active(), active(), KinematicParcel(), KinematicParcel(), KinematicParcel(), KinematicParcel(), and writeProperties().

◆ typeId_

template<class ParcelType>

label typeId_

protected

Parcel type id.

Definition at line 397 of file KinematicParcel.H.

Referenced by KinematicParcel(), KinematicParcel(), KinematicParcel(), KinematicParcel(), typeId(), typeId(), and writeProperties().

◆ nParticle_

template<class ParcelType>

scalar nParticle_

protected

Number of particles in Parcel.

Definition at line 402 of file KinematicParcel.H.

Referenced by calc(), hitPatch(), KinematicParcel(), KinematicParcel(), KinematicParcel(), KinematicParcel(), nParticle(), nParticle(), and writeProperties().

◆ d_

template<class ParcelType>

scalar d_

protected

Diameter [m].

Definition at line 407 of file KinematicParcel.H.

Referenced by areaP(), areaS(), d(), d(), Eo(), KinematicParcel(), KinematicParcel(), KinematicParcel(), KinematicParcel(), momentOfInertia(), Re(), volume(), We(), and writeProperties().

◆ dTarget_

template<class ParcelType>

scalar dTarget_

protected

Target diameter [m].

Definition at line 412 of file KinematicParcel.H.

Referenced by dTarget(), dTarget(), KinematicParcel(), KinematicParcel(), KinematicParcel(), KinematicParcel(), and writeProperties().

◆ U_

template<class ParcelType>

vector U_

protected

Velocity of Parcel [m/s].

Definition at line 417 of file KinematicParcel.H.

Referenced by calc(), calcDispersion(), Eo(), KinematicParcel(), KinematicParcel(), KinematicParcel(), KinematicParcel(), move(), Re(), transformProperties(), U(), U(), We(), and writeProperties().

◆ rho_

template<class ParcelType>

scalar rho_

protected

Density [kg/m3].

Definition at line 422 of file KinematicParcel.H.

Referenced by Eo(), KinematicParcel(), KinematicParcel(), KinematicParcel(), KinematicParcel(), mass(), rho(), rho(), and writeProperties().

◆ age_

template<class ParcelType>

scalar age_

protected

Age [s].

Definition at line 427 of file KinematicParcel.H.

Referenced by age(), age(), KinematicParcel(), KinematicParcel(), KinematicParcel(), KinematicParcel(), and writeProperties().

◆ tTurb_

template<class ParcelType>

scalar tTurb_

protected

Time spent in turbulent eddy [s].

Definition at line 432 of file KinematicParcel.H.

Referenced by calcDispersion(), KinematicParcel(), KinematicParcel(), KinematicParcel(), KinematicParcel(), tTurb(), tTurb(), and writeProperties().

◆ UTurb_

template<class ParcelType>

vector UTurb_

protected

Turbulent velocity fluctuation [m/s].

Definition at line 437 of file KinematicParcel.H.

Referenced by calcDispersion(), KinematicParcel(), KinematicParcel(), KinematicParcel(), KinematicParcel(), UTurb(), UTurb(), and writeProperties().

◆ UCorrect_

template<class ParcelType>

vector UCorrect_

protected

Velocity correction due to collisions MPPIC [m/s].

Definition at line 442 of file KinematicParcel.H.

Referenced by calc(), calcUCorrection(), KinematicParcel(), UCorrect(), UCorrect(), and writeProperties().

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

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

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]

◆ UCorrect() [1/2]

◆ 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]

◆ UCorrect() [2/2]

◆ massCell()

◆ mass()

◆ momentOfInertia()

◆ volume() [1/2]

◆ volume() [2/2]

◆ areaP() [1/2]

◆ areaP() [2/2]

◆ areaS() [1/2]

◆ areaS() [2/2]

◆ Re() [1/2]

◆ Re() [2/2]

◆ We() [1/2]

◆ We() [2/2]

◆ Eo() [1/2]

◆ Eo() [2/2]

◆ setCellValues()

◆ calcDispersion()

◆ cellValueSourceCorrection()

◆ calc()

◆ calcUCorrection()

◆ move()

◆ hitPatch()

◆ hitProcessorPatch()

◆ hitWallPatch()

◆ transformProperties() [1/2]

◆ transformProperties() [2/2]

◆ readFields() [1/2]

◆ writeFields() [1/2]

◆ writeProperties()

◆ readObjects()

◆ writeObjects()

◆ calcVelocity() [2/2]

◆ readFields() [2/2]

◆ writeFields() [2/2]

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation