Calculates particle gravity force. More...

Inheritance diagram for GravityForce< CloudType >:

Collaboration diagram for GravityForce< CloudType >:

Public Member Functions
	TypeName ("gravity")
	Runtime type information. More...

	GravityForce (CloudType &owner, const fvMesh &mesh, const dictionary &dict)
	Construct from mesh. More...

	GravityForce (const GravityForce &gf)
	Construct copy. More...

virtual autoPtr< ParticleForce< CloudType > >	clone () const
	Construct and return a clone. More...

virtual	~GravityForce ()
	Destructor. More...

const vector &	g () const
	Return the acceleration due to gravity. 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...

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 CloudType &	owner () const
	Return const access to the cloud owner. More...

CloudType &	owner ()
	Return references to the cloud owner. More...

const fvMesh &	mesh () const
	Return the mesh database. More...

const dictionary &	coeffs () 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 scalar	massAdd (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar mass) const
	Return the added mass. 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::GravityForce< CloudType >

Calculates particle gravity force.

Source files

Definition at line 52 of file GravityForce.H.

Constructor & Destructor Documentation

◆ GravityForce() [1/2]

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

Construct from mesh.

Definition at line 32 of file GravityForce.C.

◆ GravityForce() [2/2]

GravityForce ( const GravityForce< CloudType > & gf )

Construct copy.

Definition at line 44 of file GravityForce.C.

◆ ~GravityForce()

~GravityForce ( )

virtual

Destructor.

Definition at line 54 of file GravityForce.C.

References GravityForce< CloudType >::calcNonCoupled().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "gravity" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Reimplemented from ParticleForce< CloudType >.

Definition at line 82 of file GravityForce.H.

References GravityForce< CloudType >::calcNonCoupled(), GravityForce< CloudType >::g(), p, Foam::Re(), and GravityForce< CloudType >::~GravityForce().

Here is the call graph for this function:

◆ g()

const Foam::vector & g ( ) const

inline

Return the acceleration due to gravity.

Definition at line 29 of file GravityForceI.H.

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

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