LiftForce< CloudType > Class Template Reference

Base class for particle lift force models. More...

Inheritance diagram for LiftForce< CloudType >:
[legend]
Collaboration diagram for LiftForce< CloudType >:
[legend]

Public Member Functions

 LiftForce (CloudType &owner, const fvMesh &mesh, const dictionary &dict, const word &forceType)
 Construct from mesh. More...
 
 LiftForce (const LiftForce &lf)
 Construct copy. More...
 
virtual autoPtr< ParticleForce< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~LiftForce ()
 Destructor. More...
 
const interpolation< vector > & curlUcInterp () const
 Return the curl of the carrier phase velocity interpolator. More...
 
virtual void cacheFields (const bool store)
 Cache fields. More...
 
virtual forceSuSp calcCoupled (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
 Calculate the non-coupled force. More...
 
- Public Member Functions inherited from ParticleForce< CloudType >
 TypeName ("particleForce")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, ParticleForce, dictionary,(CloudType &owner, const fvMesh &mesh, const dictionary &dict),(owner, mesh, dict))
 Declare runtime constructor selection table. More...
 
 ParticleForce (CloudType &owner, const fvMesh &mesh, const dictionary &dict, const word &forceType, const bool readCoeffs)
 Construct from mesh. More...
 
 ParticleForce (const ParticleForce &pf)
 Construct copy. More...
 
virtual autoPtr< ParticleForce< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~ParticleForce ()
 Destructor. More...
 
const CloudTypeowner () const
 Return const access to the cloud owner. More...
 
CloudTypeowner ()
 Return reference to the cloud owner. More...
 
const fvMeshmesh () const
 Return the mesh database. More...
 
const dictionarycoeffs () const
 Return the force coefficients dictionary. More...
 
virtual void cacheFields (const bool store)
 Cache fields. More...
 
virtual forceSuSp calcCoupled (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
 Calculate the coupled force. More...
 
virtual forceSuSp calcNonCoupled (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
 Calculate the non-coupled force. More...
 
virtual scalar massAdd (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar mass) const
 Return the added mass. More...
 

Protected Member Functions

virtual scalar Cl (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const vector &curlUc, const scalar Re, const scalar muc) const
 Calculate the lift coefficient. More...
 

Protected Attributes

const word UName_
 Name of velocity field. More...
 
autoPtr< interpolation< vector > > curlUcInterpPtr_
 Curl of carrier phase velocity interpolator. More...
 

Additional Inherited Members

- Public Types inherited from ParticleForce< CloudType >
typedef VectorSpace< Vector< vector >, vector, 2 > returnType
 Convenience typedef for return type. More...
 
- Static Public Member Functions inherited from ParticleForce< CloudType >
static autoPtr< ParticleForce< CloudType > > New (CloudType &owner, const fvMesh &mesh, const dictionary &dict, const word &forceType)
 Selector. More...
 

Detailed Description

template<class CloudType>
class Foam::LiftForce< CloudType >

Base class for particle lift force models.

Source files

Definition at line 57 of file LiftForce.H.

Constructor & Destructor Documentation

◆ LiftForce() [1/2]

LiftForce ( CloudType owner,
const fvMesh mesh,
const dictionary dict,
const word forceType 
)

Construct from mesh.

Definition at line 52 of file LiftForce.C.

◆ LiftForce() [2/2]

LiftForce ( const LiftForce< CloudType > &  lf)

Construct copy.

Definition at line 67 of file LiftForce.C.

◆ ~LiftForce()

~LiftForce
virtual

Destructor.

Definition at line 78 of file LiftForce.C.

Member Function Documentation

◆ Cl()

Foam::scalar Cl ( const typename CloudType::parcelType p,
const typename CloudType::parcelType::trackingData td,
const vector curlUc,
const scalar  Re,
const scalar  muc 
) const
protectedvirtual

Calculate the lift coefficient.

Reimplemented in SaffmanMeiLiftForce< CloudType >, and TomiyamaLiftForce< CloudType >.

Definition at line 35 of file LiftForce.C.

◆ clone()

virtual autoPtr< ParticleForce< CloudType > > clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from ParticleForce< CloudType >.

Reimplemented in SaffmanMeiLiftForce< CloudType >, and TomiyamaLiftForce< CloudType >.

Definition at line 102 of file LiftForce.H.

◆ curlUcInterp()

const Foam::interpolation< Foam::vector > & curlUcInterp
inline

Return the curl of the carrier phase velocity interpolator.

Definition at line 33 of file LiftForceI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ cacheFields()

void cacheFields ( const bool  store)
virtual

Cache fields.

Reimplemented from ParticleForce< CloudType >.

Definition at line 85 of file LiftForce.C.

References regIOobject::checkOut(), Foam::fvc::curl(), mesh, and regIOobject::store().

Here is the call graph for this function:

◆ calcCoupled()

Foam::forceSuSp calcCoupled ( const typename CloudType::parcelType p,
const typename CloudType::parcelType::trackingData td,
const scalar  dt,
const scalar  mass,
const scalar  Re,
const scalar  muc 
) const
virtual

Calculate the non-coupled force.

Reimplemented from ParticleForce< CloudType >.

Definition at line 132 of file LiftForce.C.

References p, Foam::Re(), forceSuSp::Su(), and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ UName_

const word UName_
protected

Name of velocity field.

Definition at line 66 of file LiftForce.H.

◆ curlUcInterpPtr_

autoPtr<interpolation<vector> > curlUcInterpPtr_
protected

Curl of carrier phase velocity interpolator.

Definition at line 69 of file LiftForce.H.


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