Abstract base class for particle forces. More...

Inheritance diagram for ParticleForce< CloudType >:

[legend]

Collaboration diagram for ParticleForce< CloudType >:

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

CloudType &	owner ()
	Return refernce 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 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...

Private Attributes
CloudType &	owner_
	Reference to the owner cloud. More...

const fvMesh &	mesh_
	Reference to the mesh database. More...

const dictionary	coeffs_
	Force coefficients dictaionary. 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

◆ 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 32 of file ParticleForce.C.

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

Here is the call graph for this function:

◆ ParticleForce() [2/2]

ParticleForce ( const ParticleForce< CloudType > & pf )

Construct copy.

Definition at line 56 of file ParticleForce.C.

◆ ~ParticleForce()

~ParticleForce

virtual

Destructor.

Definition at line 67 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.

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 33 of file ParticleForceNew.C.

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

Here is the call graph for this function:

◆ owner() [1/2]

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 refernce to the cloud owner.

◆ 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 NonInertialFrameForce< CloudType >, BrownianMotionForce< CloudType >, LiftForce< CloudType >, ParamagneticForce< CloudType >, PressureGradientForce< CloudType >, SRFForce< CloudType >, and VirtualMassForce< CloudType >.

Definition at line 74 of file ParticleForce.C.

◆ calcCoupled()

Foam::forceSuSp calcCoupled	(	const typename CloudType::parcelType &	p,
		const scalar	dt,
		const scalar	mass,
		const scalar	Re,
		const scalar	muc
	)		const

virtual

Calculate the coupled force.

Reimplemented in NonSphereDragForce< CloudType >, BrownianMotionForce< CloudType >, LiftForce< CloudType >, PressureGradientForce< CloudType >, DistortedSphereDragForce< CloudType >, ErgunWenYuDragForce< CloudType >, PlessisMasliyahDragForce< CloudType >, WenYuDragForce< CloudType >, VirtualMassForce< CloudType >, and SphereDragForce< CloudType >.

Definition at line 80 of file ParticleForce.C.

References forceSuSp::Sp(), forceSuSp::Su(), and Vector< scalar >::zero.

Here is the call graph for this function:

◆ calcNonCoupled()

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 98 of file ParticleForce.C.

References forceSuSp::Sp(), forceSuSp::Su(), and Vector< scalar >::zero.

Here is the call graph for this function:

◆ massAdd()

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 116 of file ParticleForce.C.

Field Documentation

◆ owner_

CloudType& owner_

private

Reference to the owner cloud.

Definition at line 58 of file ParticleForce.H.

◆ mesh_

const fvMesh& mesh_

private

Reference to the mesh database.

Definition at line 61 of file ParticleForce.H.

◆ coeffs_

const dictionary coeffs_

private

Force coefficients dictaionary.

Definition at line 64 of file ParticleForce.H.

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

src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/ParticleForce/ParticleForce.H
src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/ParticleForce/ParticleForce.C
src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/ParticleForce/ParticleForceI.H
src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/ParticleForce/ParticleForceNew.C

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

template<class CloudType> class Foam::ParticleForce< CloudType >

Member Typedef Documentation

◆ returnType

Constructor & Destructor Documentation

◆ ParticleForce() [1/2]

◆ ParticleForce() [2/2]

◆ ~ParticleForce()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ owner() [1/2]

◆ owner() [2/2]

◆ mesh()

◆ coeffs()

◆ cacheFields()

◆ calcCoupled()

◆ calcNonCoupled()

◆ massAdd()

Field Documentation

◆ owner_

◆ mesh_

◆ coeffs_

template<class CloudType>
class Foam::ParticleForce< CloudType >