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

Inheritance diagram for MomentumParcel< ParcelType >:

[legend]

Collaboration diagram for MomentumParcel< ParcelType >:

[legend]

Classes
class	constantProperties
	Class to hold momentum parcel constant properties. More...

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

class	trackingData

Public Member Functions
	AddToPropertyList (ParcelType, " moving"+" typeId"+" nParticle"+" d"+" dTarget "+" (Ux Uy Uz)"+" rho"+" age"+" tTurb"+" (UTurbx UTurby UTurbz)")
	String representation of properties. More...

	MomentumParcel (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti)
	Construct from mesh, coordinates and topology. More...

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

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

	MomentumParcel (const MomentumParcel &p)
	Construct as a copy. More...

	MomentumParcel (const MomentumParcel &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	moving () const
	Return const access to moving 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...

bool &	moving ()
	Return const access to moving 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 trackingData &td) 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 trackingData &td) const
	Reynolds number. More...

scalar	We (const trackingData &td, const scalar sigma) const
	Weber number. More...

scalar	Eo (const trackingData &td, const scalar sigma) const
	Eotvos number. More...

template<class TrackCloudType >
void	setCellValues (TrackCloudType &cloud, trackingData &td)
	Set cell values. More...

template<class TrackCloudType >
void	calcDispersion (TrackCloudType &cloud, trackingData &td, const scalar dt)
	Apply dispersion to the carrier phase velocity and update. More...

template<class TrackCloudType >
void	cellValueSourceCorrection (TrackCloudType &cloud, trackingData &td, const scalar dt)
	Correct cell values using latest transfer information. More...

template<class TrackCloudType >
void	calc (TrackCloudType &cloud, trackingData &td, const scalar dt)
	Update parcel properties over the time interval. More...

template<class TrackCloudType >
bool	move (TrackCloudType &cloud, trackingData &td, const scalar trackTime)
	Move the parcel. More...

template<class TrackCloudType >
bool	hitPatch (TrackCloudType &cloud, trackingData &td)
	Overridable function to handle the particle hitting a patch. More...

template<class TrackCloudType >
void	hitWallPatch (TrackCloudType &cloud, trackingData &td)
	Overridable function to handle the particle hitting a wallPatch. More...

virtual void	transformProperties (const transformer &)
	Transform the physical properties of the particle. More...

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

static scalar	Re (const scalar rhoc, const vector &U, const vector &Uc, const scalar d, const scalar muc)
	Reynolds number for given conditions. More...

static scalar	We (const scalar rhoc, const vector &U, const vector &Uc, const scalar d, const scalar sigma)
	Weber number for given conditions. More...

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. More...

template<class TrackCloudType >
static void	readFields (TrackCloudType &c)
	Read. More...

template<class TrackCloudType >
static void	writeFields (const TrackCloudType &c)
	Write. More...

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. More...

Protected Attributes
bool	moving_
	Moving flag - tracking stopped when moving = 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/m^3]. More...

scalar	age_
	Age [s]. More...

scalar	tTurb_
	Time spent in turbulent eddy [s]. More...

vector	UTurb_
	Turbulent velocity fluctuation [m/s]. More...

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

Detailed Description

template<class ParcelType>
class Foam::MomentumParcel< ParcelType >

Momentum 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 56 of file MomentumParcel.H.

Constructor & Destructor Documentation

◆ MomentumParcel() [1/5]

MomentumParcel	(	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 MomentumParcelI.H.

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

Here is the caller graph for this function:

◆ MomentumParcel() [2/5]

MomentumParcel	(	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 98 of file MomentumParcelI.H.

◆ MomentumParcel() [3/5]

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

Construct from Istream.

Definition at line 49 of file MomentumParcelIO.C.

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

Here is the call graph for this function:

◆ MomentumParcel() [4/5]

MomentumParcel ( const MomentumParcel< ParcelType > & p )

Construct as a copy.

◆ MomentumParcel() [5/5]

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

Construct as a copy.

Member Function Documentation

◆ calcVelocity() [1/2]

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 MomentumParcel< ParcelType >::calc().

Here is the caller graph for this function:

◆ AddToPropertyList()

AddToPropertyList	(	ParcelType	,
		" moving"+" 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 352 of file MomentumParcel.H.

References MomentumParcel< ParcelType >::MomentumParcel().

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 358 of file MomentumParcel.H.

References MomentumParcel< ParcelType >::MomentumParcel().

Here is the call graph for this function:

◆ moving() [1/2]

bool moving ( ) const

inline

Return const access to moving flag.

Definition at line 163 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::moving_.

Referenced by MomentumParcel< ParcelType >::iNew::operator()(), and MomentumParcel< 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 170 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::typeId_.

Referenced by MomentumParcel< ParcelType >::iNew::operator()(), and MomentumParcel< 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 177 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::nParticle_.

Referenced by MomentumParcel< ParcelType >::iNew::operator()(), and MomentumParcel< 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 184 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::d_.

Referenced by MomentumParcel< ParcelType >::areaS(), MomentumParcel< ParcelType >::iNew::operator()(), and MomentumParcel< 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 191 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::dTarget_.

Referenced by MomentumParcel< ParcelType >::iNew::operator()(), and MomentumParcel< 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 198 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::U_.

Referenced by MomentumParcel< ParcelType >::iNew::operator()(), and MomentumParcel< 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 205 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::rho_.

Referenced by MomentumParcel< ParcelType >::iNew::operator()(), and MomentumParcel< 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 212 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::age_.

Referenced by MomentumParcel< ParcelType >::iNew::operator()(), and MomentumParcel< 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 219 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::tTurb_.

Referenced by MomentumParcel< ParcelType >::iNew::operator()(), and MomentumParcel< 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 226 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::UTurb_.

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

Here is the caller graph for this function:

◆ moving() [2/2]

bool & moving ( )

inline

Return const access to moving flag.

Definition at line 233 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::moving_.

◆ typeId() [2/2]

Foam::label & typeId ( )

inline

Return access to type id.

Definition at line 240 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::typeId_.

◆ nParticle() [2/2]

Foam::scalar & nParticle ( )

inline

Return access to number of particles.

Definition at line 247 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::nParticle_.

◆ d() [2/2]

Foam::scalar & d ( )

inline

Return access to diameter.

Definition at line 254 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::d_.

◆ dTarget() [2/2]

Foam::scalar & dTarget ( )

inline

Return access to target diameter.

Definition at line 261 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::dTarget_.

◆ U() [2/2]

Foam::vector & U ( )

inline

Return access to velocity.

Definition at line 268 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::U_.

◆ rho() [2/2]

Foam::scalar & rho ( )

inline

Return access to density.

Definition at line 275 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::rho_.

◆ age() [2/2]

Foam::scalar & age ( )

inline

Return access to the age.

Definition at line 282 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::age_.

◆ tTurb() [2/2]

Foam::scalar & tTurb ( )

inline

Return access to time spent in turbulent eddy.

Definition at line 289 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::tTurb_.

◆ UTurb() [2/2]

Foam::vector & UTurb ( )

inline

Return access to turbulent velocity fluctuation.

Definition at line 296 of file MomentumParcelI.H.

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

Here is the call graph for this function:

◆ massCell()

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

inline

Cell owner mass.

Definition at line 304 of file MomentumParcelI.H.

References mesh, and MomentumParcel< ParcelType >::trackingData::rhoc().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mass()

Foam::scalar mass ( ) const

inline

Particle mass.

Definition at line 313 of file MomentumParcelI.H.

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

Referenced by MomentumParcel< ParcelType >::momentOfInertia(), and MomentumParcel< 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 320 of file MomentumParcelI.H.

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

Referenced by MomentumParcel< 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 327 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::d_.

Referenced by MomentumParcel< ParcelType >::mass(), and MomentumParcel< 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 334 of file MomentumParcelI.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 341 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::d_.

Referenced by MomentumParcel< 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 348 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::areaS().

Here is the call graph for this function:

◆ areaS() [1/2]

Foam::scalar areaS ( ) const

inline

Particle surface area.

Definition at line 355 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::d_.

Referenced by MomentumParcel< ParcelType >::areaP(), and MomentumParcel< 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 362 of file MomentumParcelI.H.

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

Here is the call graph for this function:

◆ Re() [1/2]

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

inline

Reynolds number.

Definition at line 370 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::d_, MomentumParcel< ParcelType >::trackingData::muc(), MomentumParcel< ParcelType >::trackingData::rhoc(), MomentumParcel< ParcelType >::U_, and MomentumParcel< ParcelType >::trackingData::Uc().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Re() [2/2]

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 380 of file MomentumParcelI.H.

References Foam::mag(), Foam::max(), and MomentumParcel< ParcelType >::We().

Here is the call graph for this function:

◆ We() [1/2]

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

inline

Weber number.

Definition at line 394 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::d_, MomentumParcel< ParcelType >::trackingData::rhoc(), Foam::constant::physicoChemical::sigma, MomentumParcel< ParcelType >::U_, and MomentumParcel< ParcelType >::trackingData::Uc().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ We() [2/2]

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 405 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::Eo(), Foam::magSqr(), and Foam::max().

Here is the call graph for this function:

◆ Eo() [1/2]

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

inline

Eotvos number.

Definition at line 419 of file MomentumParcelI.H.

References MomentumParcel< ParcelType >::d_, MomentumParcel< ParcelType >::trackingData::g(), MomentumParcel< ParcelType >::rho_, MomentumParcel< ParcelType >::trackingData::rhoc(), Foam::constant::physicoChemical::sigma, and MomentumParcel< ParcelType >::U_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Eo() [2/2]

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 430 of file MomentumParcelI.H.

References Foam::mag(), Foam::max(), and Foam::sqr().

Here is the call graph for this function:

◆ setCellValues()

void setCellValues	(	TrackCloudType &	cloud,
		trackingData &	td
	)

Set cell values.

Definition at line 42 of file MomentumParcel.C.

References MomentumParcel< ParcelType >::calcDispersion(), Foam::endl(), interpolation< Type >::interpolate(), MomentumParcel< ParcelType >::trackingData::muc(), MomentumParcel< ParcelType >::trackingData::muInterp(), Foam::nl, MomentumParcel< ParcelType >::trackingData::rhoc(), MomentumParcel< ParcelType >::trackingData::rhoInterp(), MomentumParcel< ParcelType >::trackingData::Uc(), MomentumParcel< ParcelType >::trackingData::UInterp(), and WarningInFunction.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcDispersion()

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

Apply dispersion to the carrier phase velocity and update.

parcel turbulence parameters

Definition at line 72 of file MomentumParcel.C.

References MomentumParcel< ParcelType >::cellValueSourceCorrection(), and MomentumParcel< ParcelType >::trackingData::Uc().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cellValueSourceCorrection()

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

Correct cell values using latest transfer information.

Definition at line 93 of file MomentumParcel.C.

References MomentumParcel< ParcelType >::calc(), and MomentumParcel< ParcelType >::trackingData::Uc().

Referenced by MomentumParcel< ParcelType >::calcDispersion(), and MomentumParcel< ParcelType >::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calc()

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

Update parcel properties over the time interval.

Definition at line 106 of file MomentumParcel.C.

References MomentumParcel< ParcelType >::calcVelocity(), MomentumParcel< ParcelType >::trackingData::muc(), Foam::Re(), Su, and Foam::Zero.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ move()

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

Move the parcel.

Definition at line 279 of file MomentumParcel.C.

References f(), MomentumParcel< ParcelType >::hitPatch(), Foam::mag(), Foam::max(), maxCo, Foam::min(), and s().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hitPatch()

bool hitPatch	(	TrackCloudType &	cloud,
		trackingData &	td
	)

Overridable function to handle the particle hitting a patch.

Executed before other patch-hitting functions

Definition at line 372 of file MomentumParcel.C.

References polyPatch::boundaryMesh(), polyPatch::coupled(), and MomentumParcel< ParcelType >::hitWallPatch().

Referenced by MomentumParcel< ParcelType >::move(), and MomentumParcel< ParcelType >::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hitWallPatch()

void hitWallPatch	(	TrackCloudType &	cloud,
		trackingData &	td
	)

Overridable function to handle the particle hitting a wallPatch.

Definition at line 407 of file MomentumParcel.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, mesh, patchIdentifier::name(), and MomentumParcel< ParcelType >::transformProperties().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transformProperties()

void transformProperties ( const transformer & transform )

virtual

Transform the physical properties of the particle.

according to the given transformation

Definition at line 424 of file MomentumParcel.C.

References transformer::transform().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFields() [1/2]

static void readFields ( TrackCloudType & c )

static

Read.

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

Here is the caller graph for this function:

◆ writeFields() [1/2]

static void writeFields ( const TrackCloudType & c )

static

Write.

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

Here is the caller graph for this function:

◆ calcVelocity() [2/2]

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

◆ readFields() [2/2]

void readFields ( CloudType & c )

◆ writeFields() [2/2]

void writeFields ( const CloudType & c )

Definition at line 199 of file MomentumParcelIO.C.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

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

friend

Member Data Documentation

◆ moving_

bool moving_

protected

Moving flag - tracking stopped when moving = false.

Definition at line 246 of file MomentumParcel.H.

Referenced by MomentumParcel< ParcelType >::calcVelocity(), MomentumParcel< ParcelType >::moving(), and MomentumParcel< ParcelType >::readFields().

◆ typeId_

label typeId_

protected

Parcel type id.

Definition at line 249 of file MomentumParcel.H.

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

◆ nParticle_

scalar nParticle_

protected

Number of particles in Parcel.

Definition at line 252 of file MomentumParcel.H.

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

◆ d_

scalar d_

protected

Diameter [m].

Definition at line 255 of file MomentumParcel.H.

Referenced by MomentumParcel< ParcelType >::areaP(), MomentumParcel< ParcelType >::areaS(), MomentumParcel< ParcelType >::calcVelocity(), MomentumParcel< ParcelType >::d(), MomentumParcel< ParcelType >::Eo(), MomentumParcel< ParcelType >::momentOfInertia(), MomentumParcel< ParcelType >::Re(), MomentumParcel< ParcelType >::readFields(), MomentumParcel< ParcelType >::volume(), and MomentumParcel< ParcelType >::We().

◆ dTarget_

scalar dTarget_

protected

Target diameter [m].

Definition at line 258 of file MomentumParcel.H.

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

◆ U_

vector U_

protected

Velocity of Parcel [m/s].

Definition at line 261 of file MomentumParcel.H.

Referenced by MomentumParcel< ParcelType >::calcVelocity(), MomentumParcel< ParcelType >::Eo(), MomentumParcel< ParcelType >::Re(), MomentumParcel< ParcelType >::readFields(), MomentumParcel< ParcelType >::U(), and MomentumParcel< ParcelType >::We().

◆ rho_

scalar rho_

protected

Density [kg/m^3].

Definition at line 264 of file MomentumParcel.H.

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

◆ age_

scalar age_

protected

Age [s].

Definition at line 267 of file MomentumParcel.H.

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

◆ tTurb_

scalar tTurb_

protected

Time spent in turbulent eddy [s].

Definition at line 270 of file MomentumParcel.H.

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

◆ UTurb_

vector UTurb_

protected

Turbulent velocity fluctuation [m/s].

Definition at line 273 of file MomentumParcel.H.

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

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

src/lagrangian/parcel/parcels/Templates/MomentumParcel/MomentumParcel.H
src/lagrangian/parcel/parcels/Templates/MomentumParcel/MomentumParcel.C
src/lagrangian/parcel/parcels/Templates/MomentumParcel/MomentumParcelI.H
src/lagrangian/parcel/parcels/Templates/MomentumParcel/MomentumParcelIO.C

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<class ParcelType> class Foam::MomentumParcel< ParcelType >

Constructor & Destructor Documentation

◆ MomentumParcel() [1/5]

◆ MomentumParcel() [2/5]

◆ MomentumParcel() [3/5]

◆ MomentumParcel() [4/5]

◆ MomentumParcel() [5/5]

Member Function Documentation

◆ calcVelocity() [1/2]

◆ AddToPropertyList()

◆ clone() [1/2]

◆ clone() [2/2]

◆ moving() [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]

◆ moving() [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() [1/2]

◆ Re() [2/2]

◆ We() [1/2]

◆ We() [2/2]

◆ Eo() [1/2]

◆ Eo() [2/2]

◆ setCellValues()

◆ calcDispersion()

◆ cellValueSourceCorrection()

◆ calc()

◆ move()

◆ hitPatch()

◆ hitWallPatch()

◆ transformProperties()

◆ readFields() [1/2]

◆ writeFields() [1/2]

◆ calcVelocity() [2/2]

◆ readFields() [2/2]

◆ writeFields() [2/2]

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ moving_

◆ typeId_

◆ nParticle_

◆ d_

◆ dTarget_

◆ U_

◆ rho_

◆ age_

◆ tTurb_

◆ UTurb_

template<class ParcelType>
class Foam::MomentumParcel< ParcelType >