Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
LiftForce< CloudType > Class Template Reference

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

Inheritance diagram for LiftForce< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for LiftForce< CloudType >:
Collaboration graph
[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 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 ~ParticleForce ()
 Destructor. More...
 
const CloudTypeowner () const
 Return const access to the cloud owner. More...
 
CloudTypeowner ()
 Return refernce to the cloud owner. More...
 
const fvMeshmesh () const
 Return the mesh database. More...
 
const dictionarycoeffs () const
 Return the force coefficients dictionary. More...
 
virtual forceSuSp calcNonCoupled (const typename CloudType::parcelType &p, 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 scalar mass) const
 Return the added mass. More...
 

Protected Member Functions

virtual scalar Cl (const typename CloudType::parcelType &p, 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_
 Curk 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 52 of file LiftForce.H.

Constructor & Destructor Documentation

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

Construct from mesh.

Definition at line 49 of file LiftForce.C.

LiftForce ( const LiftForce< CloudType > &  lf)

Construct copy.

Definition at line 63 of file LiftForce.C.

~LiftForce ( )
virtual

Destructor.

Definition at line 74 of file LiftForce.C.

Referenced by LiftForce< CloudType >::clone().

Here is the caller graph for this function:

Member Function Documentation

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

Calculate the lift coefficient.

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

Referenced by LiftForce< CloudType >::calcCoupled().

Here is the caller graph for this function:

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

Construct and return a clone.

Reimplemented from ParticleForce< CloudType >.

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

Definition at line 96 of file LiftForce.H.

References LiftForce< CloudType >::cacheFields(), LiftForce< CloudType >::calcCoupled(), LiftForce< CloudType >::curlUcInterp(), p, Foam::Re(), and LiftForce< CloudType >::~LiftForce().

Here is the call graph for this function:

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

Return the curl of the carrier phase velocity interpolator.

Definition at line 30 of file LiftForceI.H.

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

Referenced by LiftForce< CloudType >::calcCoupled(), and LiftForce< CloudType >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

void cacheFields ( const bool  store)
virtual

Cache fields.

Reimplemented from ParticleForce< CloudType >.

Definition at line 81 of file LiftForce.C.

References LiftForce< CloudType >::calcCoupled(), Foam::fvc::curl(), LiftForce< CloudType >::curlUcInterpPtr_, ParticleForce< CloudType >::mesh(), ParticleForce< CloudType >::owner(), and LiftForce< CloudType >::UName_.

Referenced by LiftForce< CloudType >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::forceSuSp calcCoupled ( const typename CloudType::parcelType p,
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 129 of file LiftForce.C.

References LiftForce< CloudType >::Cl(), LiftForce< CloudType >::curlUcInterp(), forceSuSp::Su(), and Vector< Cmpt >::zero.

Referenced by LiftForce< CloudType >::cacheFields(), and LiftForce< CloudType >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

const word UName_
protected

Name of velocity field.

Definition at line 61 of file LiftForce.H.

Referenced by LiftForce< CloudType >::cacheFields().

autoPtr<interpolation<vector> > curlUcInterpPtr_
protected

Curk of carrier phase velocity interpolator.

Definition at line 64 of file LiftForce.H.

Referenced by LiftForce< CloudType >::cacheFields().


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