Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
KinematicParcel Class Reference
Lagrangian particle models » Parcels

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

Collaboration diagram for KinematicParcel:
Collaboration graph
[legend]

Classes

class  constantProperties
 
class  iNew
 
class  trackingData
 

Public Member Functions

 TypeName ("KinematicParcel")
 
 AddToPropertyList (ParcelType, " active"+" typeId"+" nParticle"+" d"+" dTarget"+" (Ux Uy Uz)"+" rho"+" age"+" tTurb"+" (UTurbx UTurby UTurbz)"+" (UCorrectx UCorrecty UCorrectz)")
 
 KinematicParcel (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti)
 
 KinematicParcel (const polyMesh &mesh, const vector &position, const label celli)
 
 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)
 
 KinematicParcel (const polyMesh &mesh, Istream &is, bool readFields=true, bool newFormat=true)
 
 KinematicParcel (const KinematicParcel &p)
 
 KinematicParcel (const KinematicParcel &p, const polyMesh &mesh)
 
virtual autoPtr< particle > clone () const
 
virtual autoPtr< particle > clone (const polyMesh &mesh) const
 
bool active () const
 
label typeId () const
 
scalar nParticle () const
 
scalar d () const
 
scalar dTarget () const
 
const vector & U () const
 
scalar rho () const
 
scalar age () const
 
scalar tTurb () const
 
const vector & UTurb () const
 
const vector & UCorrect () const
 
void active (const bool state)
 
label & typeId ()
 
scalar & nParticle ()
 
scalar & d ()
 
scalar & dTarget ()
 
vector & U ()
 
scalar & rho ()
 
scalar & age ()
 
scalar & tTurb ()
 
vector & UTurb ()
 
vector & UCorrect ()
 
scalar massCell (const trackingData &td) const
 
scalar mass () const
 
scalar momentOfInertia () const
 
scalar volume () const
 
scalar areaP () const
 
scalar areaS () const
 
scalar Re (const trackingData &td) const
 
scalar We (const trackingData &td, const scalar sigma) const
 
scalar Eo (const trackingData &td, const scalar sigma) const
 
template<class TrackCloudType >
void setCellValues (TrackCloudType &cloud, trackingData &td)
 
template<class TrackCloudType >
void calcDispersion (TrackCloudType &cloud, trackingData &td, const scalar dt)
 
template<class TrackCloudType >
void cellValueSourceCorrection (TrackCloudType &cloud, trackingData &td, const scalar dt)
 
template<class TrackCloudType >
void calc (TrackCloudType &cloud, trackingData &td, const scalar dt)
 
template<class TrackCloudType >
void calcUCorrection (TrackCloudType &cloud, trackingData &td, const scalar dt)
 
template<class TrackCloudType >
bool move (TrackCloudType &cloud, trackingData &td, const scalar trackTime)
 
template<class TrackCloudType >
bool hitPatch (TrackCloudType &cloud, trackingData &td)
 
template<class TrackCloudType >
void hitProcessorPatch (TrackCloudType &cloud, trackingData &td)
 
template<class TrackCloudType >
void hitWallPatch (TrackCloudType &cloud, trackingData &td)
 
virtual void transformProperties (const tensor &T)
 
virtual void transformProperties (const vector &separation)
 
void writeProperties (Ostream &os, const wordRes &filters, const word &delim, const bool namesOnly=false) const
 
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)
 
static scalar areaP (const scalar d)
 
static scalar areaS (const scalar d)
 
static scalar Re (const scalar rhoc, const vector &U, const vector &Uc, const scalar d, const scalar muc)
 
static scalar We (const scalar rhoc, const vector &U, const vector &Uc, const scalar d, const scalar sigma)
 
static scalar Eo (const vector &g, const scalar rho, const scalar rhoc, const vector &U, const scalar d, const scalar sigma)
 
template<class TrackCloudType >
static void readFields (TrackCloudType &c)
 
template<class TrackCloudType >
static void writeFields (const TrackCloudType &c)
 
template<class CloudType >
static void readObjects (CloudType &c, const objectRegistry &obr)
 
template<class CloudType >
static void writeObjects (const CloudType &c, objectRegistry &obr)
 

Static Public Attributes

static const std::size_t sizeofFields
 

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
 

Protected Attributes

label active_
 
label typeId_
 
scalar nParticle_
 
scalar d_
 
scalar dTarget_
 
vector U_
 
scalar rho_
 
scalar age_
 
scalar tTurb_
 
vector UTurb_
 
vector UCorrect_
 

Friends

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

Detailed Description

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

Sub-models include:

Source files

Definition at line 62 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

Referenced by KinematicParcel::clone().

Here is the caller graph for this function:

◆ KinematicParcel() [2/6]

KinematicParcel ( const polyMesh &  mesh,
const vector &  position,
const label  celli 
)
inline

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

◆ KinematicParcel() [4/6]

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

◆ KinematicParcel() [5/6]

KinematicParcel ( const KinematicParcel &  p)

◆ KinematicParcel() [6/6]

KinematicParcel ( const KinematicParcel &  p,
const polyMesh &  mesh 
)

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

◆ TypeName()

TypeName ( "KinematicParcel"  )

◆ AddToPropertyList()

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

◆ clone() [1/2]

virtual autoPtr<particle> clone ( ) const
inlinevirtual

Definition at line 432 of file KinematicParcel.H.

References KinematicParcel::KinematicParcel().

Here is the call graph for this function:

◆ clone() [2/2]

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

Definition at line 438 of file KinematicParcel.H.

References KinematicParcel::KinematicParcel(), and mesh.

Here is the call graph for this function:

◆ active() [1/2]

bool active ( ) const
inline

Definition at line 189 of file KinematicParcelI.H.

References KinematicParcel::active_.

◆ typeId() [1/2]

Foam::label typeId ( ) const
inline

Definition at line 196 of file KinematicParcelI.H.

References KinematicParcel::typeId_.

◆ nParticle() [1/2]

Foam::scalar nParticle ( ) const
inline

Definition at line 203 of file KinematicParcelI.H.

References KinematicParcel::nParticle_.

◆ d() [1/2]

Foam::scalar d ( ) const
inline

Definition at line 210 of file KinematicParcelI.H.

References KinematicParcel::d_.

Referenced by KinematicParcel::areaP(), KinematicParcel::areaS(), KinematicParcel::Eo(), KinematicParcel::Re(), KinematicParcel::volume(), and KinematicParcel::We().

Here is the caller graph for this function:

◆ dTarget() [1/2]

Foam::scalar dTarget ( ) const
inline

Definition at line 217 of file KinematicParcelI.H.

References KinematicParcel::dTarget_.

◆ U() [1/2]

const Foam::vector & U ( ) const
inline

Definition at line 224 of file KinematicParcelI.H.

References KinematicParcel::U_.

Referenced by KinematicParcel::Eo(), MPPICParcel::move(), KinematicParcel::Re(), and KinematicParcel::We().

Here is the caller graph for this function:

◆ rho() [1/2]

Foam::scalar rho ( ) const
inline

Definition at line 231 of file KinematicParcelI.H.

References KinematicParcel::rho_.

Referenced by KinematicParcel::Eo().

Here is the caller graph for this function:

◆ age() [1/2]

Foam::scalar age ( ) const
inline

Definition at line 238 of file KinematicParcelI.H.

References KinematicParcel::age_.

◆ tTurb() [1/2]

Foam::scalar tTurb ( ) const
inline

Definition at line 245 of file KinematicParcelI.H.

References KinematicParcel::tTurb_.

◆ UTurb() [1/2]

const Foam::vector & UTurb ( ) const
inline

Definition at line 252 of file KinematicParcelI.H.

References KinematicParcel::UTurb_.

◆ UCorrect() [1/2]

const Foam::vector & UCorrect ( ) const
inline

Definition at line 301 of file KinematicParcelI.H.

References KinematicParcel::UCorrect_.

◆ active() [2/2]

void active ( const bool  state)
inline

Definition at line 259 of file KinematicParcelI.H.

References KinematicParcel::active_.

◆ typeId() [2/2]

Foam::label & typeId ( )
inline

Definition at line 266 of file KinematicParcelI.H.

References KinematicParcel::typeId_.

◆ nParticle() [2/2]

Foam::scalar & nParticle ( )
inline

Definition at line 273 of file KinematicParcelI.H.

References KinematicParcel::nParticle_.

◆ d() [2/2]

Foam::scalar & d ( )
inline

Definition at line 280 of file KinematicParcelI.H.

References KinematicParcel::d_.

◆ dTarget() [2/2]

Foam::scalar & dTarget ( )
inline

Definition at line 287 of file KinematicParcelI.H.

References KinematicParcel::dTarget_.

◆ U() [2/2]

Foam::vector & U ( )
inline

Definition at line 294 of file KinematicParcelI.H.

References KinematicParcel::U_.

◆ rho() [2/2]

Foam::scalar & rho ( )
inline

Definition at line 315 of file KinematicParcelI.H.

References KinematicParcel::rho_.

◆ age() [2/2]

Foam::scalar & age ( )
inline

Definition at line 322 of file KinematicParcelI.H.

References KinematicParcel::age_.

◆ tTurb() [2/2]

Foam::scalar & tTurb ( )
inline

Definition at line 329 of file KinematicParcelI.H.

References KinematicParcel::tTurb_.

◆ UTurb() [2/2]

Foam::vector & UTurb ( )
inline

Definition at line 336 of file KinematicParcelI.H.

References KinematicParcel::UTurb_.

◆ UCorrect() [2/2]

Foam::vector & UCorrect ( )
inline

Definition at line 308 of file KinematicParcelI.H.

References KinematicParcel::UCorrect_.

◆ massCell()

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

Definition at line 344 of file KinematicParcelI.H.

References mesh, and KinematicParcel::trackingData::rhoc().

Here is the call graph for this function:

◆ mass()

Foam::scalar mass ( ) const
inline

Definition at line 353 of file KinematicParcelI.H.

References KinematicParcel::rho_, and KinematicParcel::volume().

Referenced by KinematicParcel::momentOfInertia().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ momentOfInertia()

Foam::scalar momentOfInertia ( ) const
inline

Definition at line 360 of file KinematicParcelI.H.

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

Here is the call graph for this function:

◆ volume() [1/2]

Foam::scalar volume ( ) const
inline

Definition at line 367 of file KinematicParcelI.H.

References KinematicParcel::d_.

Referenced by KinematicParcel::mass().

Here is the caller graph for this function:

◆ volume() [2/2]

Foam::scalar volume ( const scalar  d)
inlinestatic

Definition at line 374 of file KinematicParcelI.H.

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

Here is the call graph for this function:

◆ areaP() [1/2]

Foam::scalar areaP ( ) const
inline

Definition at line 381 of file KinematicParcelI.H.

References KinematicParcel::d_.

◆ areaP() [2/2]

Foam::scalar areaP ( const scalar  d)
inlinestatic

Definition at line 388 of file KinematicParcelI.H.

References KinematicParcel::areaS(), and KinematicParcel::d().

Here is the call graph for this function:

◆ areaS() [1/2]

Foam::scalar areaS ( ) const
inline

Definition at line 395 of file KinematicParcelI.H.

References KinematicParcel::d_.

Referenced by KinematicParcel::areaP().

Here is the caller graph for this function:

◆ areaS() [2/2]

Foam::scalar areaS ( const scalar  d)
inlinestatic

Definition at line 402 of file KinematicParcelI.H.

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

Here is the call graph for this function:

◆ Re() [1/2]

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

Definition at line 410 of file KinematicParcelI.H.

References KinematicParcel::d_, KinematicParcel::trackingData::muc(), KinematicParcel::trackingData::rhoc(), KinematicParcel::U_, and KinematicParcel::trackingData::Uc().

Here is the call 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

Definition at line 420 of file KinematicParcelI.H.

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

Here is the call graph for this function:

◆ We() [1/2]

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

Definition at line 434 of file KinematicParcelI.H.

References KinematicParcel::d_, KinematicParcel::trackingData::rhoc(), sigma(), KinematicParcel::U_, and KinematicParcel::trackingData::Uc().

Here is the call 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

Definition at line 445 of file KinematicParcelI.H.

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

Here is the call graph for this function:

◆ Eo() [1/2]

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

Definition at line 459 of file KinematicParcelI.H.

References KinematicParcel::d_, KinematicParcel::trackingData::g(), KinematicParcel::rho_, KinematicParcel::trackingData::rhoc(), sigma(), and KinematicParcel::U_.

Here is the call 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

Definition at line 470 of file KinematicParcelI.H.

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

Here is the call graph for this function:

◆ setCellValues()

void setCellValues ( TrackCloudType &  cloud,
trackingData &  td 
)

Definition at line 39 of file KinematicParcel.C.

References coordinates(), Foam::expressions::patchExpr::debug, Foam::endl(), interpolation::interpolate(), KinematicParcel::trackingData::muc(), KinematicParcel::trackingData::muInterp(), Foam::nl, KinematicParcel::trackingData::rhoc(), KinematicParcel::trackingData::rhoInterp(), KinematicParcel::trackingData::Uc(), KinematicParcel::trackingData::UInterp(), and WarningInFunction.

Here is the call graph for this function:

◆ calcDispersion()

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

Definition at line 69 of file KinematicParcel.C.

References KinematicParcel::trackingData::Uc().

Here is the call graph for this function:

◆ cellValueSourceCorrection()

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

Definition at line 112 of file KinematicParcel.C.

References KinematicParcel::trackingData::Uc().

Here is the call graph for this function:

◆ calc()

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

Definition at line 125 of file KinematicParcel.C.

References KinematicParcel::trackingData::muc(), Foam::Re(), Su, and Foam::Zero.

Here is the call graph for this function:

◆ calcUCorrection()

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

Definition at line 90 of file KinematicParcel.C.

References p, and Foam::Zero.

◆ move()

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

Definition at line 301 of file KinematicParcel.C.

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

Here is the call graph for this function:

◆ hitPatch()

bool hitPatch ( TrackCloudType &  cloud,
trackingData &  td 
)

Definition at line 396 of file KinematicParcel.C.

References polyPatch::constraintType(), and p.

Here is the call graph for this function:

◆ hitProcessorPatch()

void hitProcessorPatch ( TrackCloudType &  cloud,
trackingData &  td 
)

Definition at line 439 of file KinematicParcel.C.

◆ hitWallPatch()

void hitWallPatch ( TrackCloudType &  cloud,
trackingData &  td 
)

Definition at line 451 of file KinematicParcel.C.

◆ transformProperties() [1/2]

void transformProperties ( const tensor &  T)
virtual

Definition at line 461 of file KinematicParcel.C.

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

Here is the call graph for this function:

◆ transformProperties() [2/2]

void transformProperties ( const vector &  separation)
virtual

Definition at line 471 of file KinematicParcel.C.

◆ readFields() [1/2]

static void readFields ( TrackCloudType &  c)
static

◆ writeFields() [1/2]

static void writeFields ( const TrackCloudType &  c)
static

◆ writeProperties()

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

Definition at line 278 of file KinematicParcelIO.C.

References os(), and writeProp.

Here is the call graph for this function:

◆ readObjects()

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

Definition at line 310 of file KinematicParcelIO.C.

References Foam::constant::universal::c, p, rho, and U.

◆ writeObjects()

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

Definition at line 355 of file KinematicParcelIO.C.

References Foam::constant::universal::c, p, rho, and U.

◆ 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

Definition at line 178 of file KinematicParcel.C.

References Foam::meshTools::constrainDirection(), mesh, Foam::constant::physicoChemical::mu, p, Foam::Re(), forceSuSp::Sp(), Su, forceSuSp::Su(), and KinematicParcel::trackingData::Uc().

Here is the call graph for this function:

◆ readFields() [2/2]

void readFields ( CloudType &  c)

Definition at line 114 of file KinematicParcelIO.C.

References Foam::constant::universal::c, IOobject::MUST_READ, p, Foam::readFields(), rho, and U.

Here is the call graph for this function:

◆ writeFields() [2/2]

void writeFields ( const CloudType &  c)

Definition at line 220 of file KinematicParcelIO.C.

References Foam::constant::universal::c, IOobject::NO_READ, p, rho, U, and Foam::writeFields().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

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

Member Data Documentation

◆ sizeofFields

const std::size_t sizeofFields
static

Definition at line 94 of file KinematicParcel.H.

◆ active_

label active_
protected

Definition at line 302 of file KinematicParcel.H.

Referenced by KinematicParcel::active().

◆ typeId_

label typeId_
protected

Definition at line 305 of file KinematicParcel.H.

Referenced by KinematicParcel::typeId().

◆ nParticle_

scalar nParticle_
protected

Definition at line 308 of file KinematicParcel.H.

Referenced by KinematicParcel::nParticle().

◆ d_

scalar d_
protected

Definition at line 311 of file KinematicParcel.H.

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

◆ dTarget_

scalar dTarget_
protected

Definition at line 314 of file KinematicParcel.H.

Referenced by KinematicParcel::dTarget().

◆ U_

vector U_
protected

Definition at line 317 of file KinematicParcel.H.

Referenced by KinematicParcel::Eo(), KinematicParcel::Re(), KinematicParcel::U(), and KinematicParcel::We().

◆ rho_

scalar rho_
protected

Definition at line 320 of file KinematicParcel.H.

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

◆ age_

scalar age_
protected

Definition at line 323 of file KinematicParcel.H.

Referenced by KinematicParcel::age().

◆ tTurb_

scalar tTurb_
protected

Definition at line 326 of file KinematicParcel.H.

Referenced by KinematicParcel::tTurb().

◆ UTurb_

vector UTurb_
protected

Definition at line 329 of file KinematicParcel.H.

Referenced by KinematicParcel::UTurb().

◆ UCorrect_

vector UCorrect_
protected

Definition at line 332 of file KinematicParcel.H.

Referenced by KinematicParcel::UCorrect().

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17