Public Types | Public Member Functions | Static Public Member Functions | List of all members
ParticleForce< CloudType > Class Template Reference

Abstract base class for particle forces. More...

Inheritance diagram for ParticleForce< CloudType >:
Inheritance graph
[legend]

Public Types

typedef VectorSpace< Vector< vector >, vector, 2 > returnType
 Convenience typedef for return type. More...
 

Public Member Functions

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

Static Public Member Functions

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::ParticleForce< CloudType >

Abstract base class for particle forces.

Source files

Definition at line 53 of file ParticleForce.H.

Member Typedef Documentation

Convenience typedef for return type.

Definition at line 88 of file ParticleForce.H.

Constructor & Destructor Documentation

ParticleForce ( CloudType owner,
const fvMesh mesh,
const dictionary dict,
const word forceType,
const bool  readCoeffs 
)

Construct from mesh.

Definition at line 32 of file ParticleForce.C.

References Foam::exit(), Foam::FatalIOError, and FatalIOErrorIn.

Here is the call graph for this function:

Construct copy.

Definition at line 64 of file ParticleForce.C.

~ParticleForce ( )
virtual

Destructor.

Definition at line 75 of file ParticleForce.C.

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

Here is the caller graph for this function:

Member Function Documentation

TypeName ( "particleForce"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
ParticleForce< CloudType ,
dictionary  ,
( CloudType &owner, const fvMesh &mesh, const dictionary &dict ,
(owner, mesh, dict  
)

Declare runtime constructor selection table.

virtual autoPtr<ParticleForce<CloudType> > clone ( ) const
inlinevirtual
Foam::autoPtr< Foam::ParticleForce< CloudType > > New ( CloudType owner,
const fvMesh mesh,
const dictionary dict,
const word forceType 
)
static

Selector.

Definition at line 33 of file ParticleForceNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, mesh, and Foam::nl.

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

Here is the call graph for this function:

Here is the caller graph for this function:

const CloudType & owner ( ) const
inline

Return const access to the cloud owner.

Definition at line 29 of file ParticleForceI.H.

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

Here is the caller graph for this function:

CloudType & owner ( )
inline

Return refernce to the cloud owner.

Definition at line 36 of file ParticleForceI.H.

const Foam::fvMesh & mesh ( ) const
inline

Return the mesh database.

Definition at line 43 of file ParticleForceI.H.

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

Here is the caller graph for this function:

const Foam::dictionary & coeffs ( ) const
inline

Return the force coefficients dictionary.

Definition at line 50 of file ParticleForceI.H.

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

Here is the caller graph for this function:

void cacheFields ( const bool  store)
virtual
Foam::forceSuSp calcCoupled ( const typename CloudType::parcelType p,
const scalar  dt,
const scalar  mass,
const scalar  Re,
const scalar  muc 
) const
virtual
Foam::forceSuSp calcNonCoupled ( 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 in NonInertialFrameForce< CloudType >, ParamagneticForce< CloudType >, GravityForce< CloudType >, and SRFForce< CloudType >.

Definition at line 106 of file ParticleForce.C.

References ParticleForce< CloudType >::massAdd(), forceSuSp::Sp(), forceSuSp::Su(), and Vector< Cmpt >::zero.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar massAdd ( const typename CloudType::parcelType p,
const scalar  mass 
) const
virtual

Return the added mass.

Reimplemented in PressureGradientForce< CloudType >, and VirtualMassForce< CloudType >.

Definition at line 124 of file ParticleForce.C.

Referenced by ParticleForce< CloudType >::calcNonCoupled(), and ParticleForce< CloudType >::clone().

Here is the caller graph for this function:


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