All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ScaledForce< CloudType > Class Template Reference

Particle force model scaled by a constant value. More...

Inheritance diagram for ScaledForce< CloudType >:
Collaboration diagram for ScaledForce< CloudType >:

Public Member Functions

 TypeName ("scaled")
 Runtime type information. More...
 
 ScaledForce (CloudType &owner, const fvMesh &mesh, const dictionary &dict)
 Construct from mesh. More...
 
 ScaledForce (const ScaledForce< CloudType > &df)
 Construct copy. More...
 
virtual autoPtr< ParticleForce< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~ScaledForce ()
 Destructor. 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...
 
- 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 references 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...
 

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

Particle force model scaled by a constant value.

Definition at line 45 of file ScaledForce.H.

Constructor & Destructor Documentation

◆ ScaledForce() [1/2]

ScaledForce ( CloudType owner,
const fvMesh mesh,
const dictionary dict 
)

Construct from mesh.

Definition at line 47 of file ScaledForce.C.

◆ ScaledForce() [2/2]

ScaledForce ( const ScaledForce< CloudType > &  df)

Construct copy.

Definition at line 70 of file ScaledForce.C.

◆ ~ScaledForce()

~ScaledForce ( )
virtual

Destructor.

Definition at line 83 of file ScaledForce.C.

References ScaledForce< CloudType >::calcCoupled().

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

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

Member Function Documentation

◆ TypeName()

TypeName ( "scaled"  )

Runtime type information.

◆ clone()

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

Construct and return a clone.

Reimplemented from ParticleForce< CloudType >.

Definition at line 84 of file ScaledForce.H.

References ScaledForce< CloudType >::calcCoupled(), ScaledForce< CloudType >::calcNonCoupled(), ScaledForce< CloudType >::massAdd(), p, Foam::Re(), and ScaledForce< CloudType >::~ScaledForce().

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

Reimplemented from ParticleForce< CloudType >.

Definition at line 91 of file ScaledForce.C.

References ScaledForce< CloudType >::calcNonCoupled().

Referenced by ScaledForce< CloudType >::clone(), and ScaledForce< CloudType >::~ScaledForce().

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

◆ calcNonCoupled()

Foam::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
virtual

Calculate the non-coupled force.

Reimplemented from ParticleForce< CloudType >.

Definition at line 106 of file ScaledForce.C.

References ScaledForce< CloudType >::massAdd().

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

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

◆ massAdd()

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

Return the added mass.

Reimplemented from ParticleForce< CloudType >.

Definition at line 121 of file ScaledForce.C.

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

Here is the caller graph for this function:

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