ParticleForce< CloudType > Class Template Reference

Abstract base class for particle forces. More...

Inheritance diagram for ParticleForce< CloudType >:

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

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

• ParticleForce.H
• ParticleForceI.H
• ParticleForce.C
• ParticleForceNew.C

Definition at line 53 of file ParticleForce.H.

Member Typedef Documentation

returnType

typedef VectorSpace<Vector<vector>, vector, 2> returnType

Convenience typedef for return type.

Definition at line 88 of file ParticleForce.H.

Constructor & Destructor Documentation

ParticleForce() [1/2]

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

Construct from mesh.

Definition at line 31 of file ParticleForce.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and dictionary::isNull().

Here is the call graph for this function:

ParticleForce() [2/2]

ParticleForce

(

const ParticleForce< CloudType > &

pf

)

Construct copy.

Definition at line 61 of file ParticleForce.C.

~ParticleForce()

~ParticleForce

virtual

Destructor.

Definition at line 72 of file ParticleForce.C.

Member Function Documentation

TypeName()

TypeName

(

"particleForce"

)

Runtime type information.

declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

clone()

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

inlinevirtual

Construct and return a clone.

Reimplemented in BrownianMotionForce< CloudType >, VirtualMassForce< CloudType >, ScaledForce< CloudType >, PressureGradientForce< CloudType >, ParamagneticForce< CloudType >, NonInertialFrameForce< CloudType >, TomiyamaLiftForce< CloudType >, SaffmanMeiLiftForce< CloudType >, LiftForce< CloudType >, GravityForce< CloudType >, WenYuDragForce< CloudType >, SphereDragForce< CloudType >, SchillerNaumannDragForce< CloudType >, PlessisMasliyahDragForce< CloudType >, NonSphereDragForce< CloudType >, ErgunWenYuDragForce< CloudType >, and DistortedSphereDragForce< CloudType >.

Definition at line 107 of file ParticleForce.H.

New()

Foam::autoPtr< Foam::ParticleForce< CloudType > > New ( CloudType &  owner, const fvMesh &  mesh, const dictionary &  dict, const word &  forceType  )

static

Selector.

Definition at line 32 of file ParticleForceNew.C.

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

Here is the call graph for this function:

owner() [1/2]

const CloudType & owner

inline

Return const access to the cloud owner.

Definition at line 29 of file ParticleForceI.H.

owner() [2/2]

CloudType & owner

inline

Return references to the cloud owner.

Definition at line 36 of file ParticleForceI.H.

mesh()

const Foam::fvMesh & mesh

inline

Return the mesh database.

Definition at line 43 of file ParticleForceI.H.

coeffs()

const Foam::dictionary & coeffs

inline

Return the force coefficients dictionary.

Definition at line 50 of file ParticleForceI.H.

cacheFields()

void cacheFields ( const bool  store )

virtual

Cache fields.

Reimplemented in VirtualMassForce< CloudType >, PressureGradientForce< CloudType >, ParamagneticForce< CloudType >, NonInertialFrameForce< CloudType >, LiftForce< CloudType >, and DenseDragForce< CloudType >.

Definition at line 79 of file ParticleForce.C.

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 in BrownianMotionForce< CloudType >, VirtualMassForce< CloudType >, ScaledForce< CloudType >, PressureGradientForce< CloudType >, LiftForce< CloudType >, WenYuDragForce< CloudType >, SphereDragForce< CloudType >, SchillerNaumannDragForce< CloudType >, PlessisMasliyahDragForce< CloudType >, NonSphereDragForce< CloudType >, ErgunWenYuDragForce< CloudType >, and DistortedSphereDragForce< CloudType >.

Definition at line 84 of file ParticleForce.C.

References forceSuSp::Sp(), forceSuSp::Su(), and Foam::Zero.

Here is the call 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 in ScaledForce< CloudType >, ParamagneticForce< CloudType >, NonInertialFrameForce< CloudType >, and GravityForce< CloudType >.

Definition at line 103 of file ParticleForce.C.

References forceSuSp::Sp(), forceSuSp::Su(), and Foam::Zero.

Here is the call 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 in VirtualMassForce< CloudType >, ScaledForce< CloudType >, and PressureGradientForce< CloudType >.

Definition at line 122 of file ParticleForce.C.

---

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

• src/lagrangian/parcel/submodels/Momentum/ParticleForces/ParticleForce/ParticleForce.H
• src/lagrangian/parcel/submodels/Momentum/ParticleForces/ParticleForce/ParticleForce.C
• src/lagrangian/parcel/submodels/Momentum/ParticleForces/ParticleForce/ParticleForceI.H
• src/lagrangian/parcel/submodels/Momentum/ParticleForces/ParticleForce/ParticleForceNew.C