GravityForce< CloudType > Class Template Reference

Calculates particle gravity force. More...

#include <GravityForce.H>

Inheritance diagram for GravityForce< CloudType >:

Collaboration diagram for GravityForce< CloudType >:

Public Member Functions
	TypeName ("gravity")
	Runtime type information.
	GravityForce (CloudType &owner, const fvMesh &mesh, const dictionary &dict)
	Construct from mesh.
	GravityForce (const GravityForce &gf)
	Construct copy.
virtual autoPtr< ParticleForce< CloudType > >	clone () const
	Construct and return a clone.
virtual	~GravityForce ()
	Destructor.
const vector &	g () const noexcept
	Return the acceleration due to gravity.
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.
Public Member Functions inherited from ParticleForce< CloudType >
	TypeName ("particleForce")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, ParticleForce, dictionary,(CloudType &owner, const fvMesh &mesh, const dictionary &dict),(owner, mesh, dict))
	Declare runtime constructor selection table.
	ParticleForce (CloudType &owner, const fvMesh &mesh, const dictionary &dict, const word &forceType, const bool readCoeffs)
	Construct from mesh.
	ParticleForce (const ParticleForce &pf)
	Construct copy.
virtual	~ParticleForce ()
	Destructor.
const CloudType &	owner () const noexcept
	Return const access to the cloud owner.
CloudType &	owner () noexcept
	Return reference to the cloud owner.
const fvMesh &	mesh () const noexcept
	Return the mesh database.
const dictionary &	coeffs () const noexcept
	Return the force coefficients dictionary.
virtual void	cacheFields (const bool store)
	Cache fields.
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.
virtual scalar	massAdd (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar mass) const
	Return the added mass.

Additional Inherited Members
Public Types inherited from ParticleForce< CloudType >
typedef VectorSpace< Vector< vector >, vector, 2 >	returnType
	Convenience typedef for return type.
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.

Detailed Description

template<class CloudType>
class Foam::GravityForce< CloudType >

Calculates particle gravity force.

Source files

• GravityForce.H
• GravityForceI.H
• GravityForce.C

Definition at line 54 of file GravityForce.H.

Constructor & Destructor Documentation

GravityForce() [1/2]

template<class CloudType>

GravityForce	(	CloudType &	owner,
		const fvMesh &	mesh,
		const dictionary &	dict )

Construct from mesh.

Definition at line 26 of file GravityForce.C.

References dict, g(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, ParticleForce< CloudType >::mesh(), ParticleForce< CloudType >::owner(), and ParticleForce< CloudType >::ParticleForce().

Referenced by clone(), GravityForce(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

GravityForce() [2/2]

template<class CloudType>

GravityForce

(

const GravityForce< CloudType > &

gf

)

Construct copy.

Definition at line 39 of file GravityForce.C.

References GravityForce(), and ParticleForce< CloudType >::ParticleForce().

Here is the call graph for this function:

~GravityForce()

template<class CloudType>

~GravityForce ( )

virtual

Destructor.

Definition at line 49 of file GravityForce.C.

Member Function Documentation

TypeName()

template<class CloudType>

TypeName

(

"gravity"

)

Runtime type information.

References dict, GravityForce(), ParticleForce< CloudType >::mesh(), and ParticleForce< CloudType >::owner().

Here is the call graph for this function:

clone()

template<class CloudType>

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

inlinevirtual

Construct and return a clone.

Reimplemented from ParticleForce< CloudType >.

Definition at line 94 of file GravityForce.H.

References GravityForce().

Here is the call graph for this function:

g()

template<class CloudType>

const vector & g ( ) const

inlinenoexcept

Return the acceleration due to gravity.

Definition at line 116 of file GravityForce.H.

References Foam::noexcept.

Referenced by GravityForce().

Here is the caller graph for this function:

calcNonCoupled()

template<class CloudType>

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 56 of file GravityForce.C.

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

Here is the call graph for this function:

---

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

• src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Gravity/GravityForce.H
• src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Gravity/GravityForce.C