Base class for particle lift force models. More...

#include <LiftForce.H>

Inheritance diagram for LiftForce< CloudType >:

[legend]

Collaboration diagram for LiftForce< CloudType >:

[legend]

Public Member Functions
	LiftForce (CloudType &owner, const fvMesh &mesh, const dictionary &dict, const word &forceType)
	Construct from mesh.
	LiftForce (const LiftForce &lf)
	Construct copy.
virtual autoPtr< ParticleForce< CloudType > >	clone () const
	Construct and return a clone.
virtual	~LiftForce ()
	Destructor.
const interpolation< vector > &	curlUcInterp () const
	Return the curl of the carrier phase velocity interpolator.
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 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 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.
virtual scalar	massAdd (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar mass) const
	Return the added mass.

Protected Member Functions
virtual scalar	Cl (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const vector &curlUc, const scalar Re, const scalar muc) const
	Calculate the lift coefficient.

Protected Attributes
const word	UName_
	Name of velocity field.
autoPtr< interpolation< vector > >	curlUcInterpPtr_
	Curl of carrier phase velocity interpolator.

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

Base class for particle lift force models.

Source files

Definition at line 53 of file LiftForce.H.

Constructor & Destructor Documentation

◆ LiftForce() [1/2]

template<class CloudType>

LiftForce	(	CloudType &	owner,
		const fvMesh &	mesh,
		const dictionary &	dict,
		const word &	forceType )

Construct from mesh.

Definition at line 45 of file LiftForce.C.

References ParticleForce< CloudType >::coeffs(), curlUcInterpPtr_, dict, ParticleForce< CloudType >::mesh(), ParticleForce< CloudType >::owner(), ParticleForce< CloudType >::ParticleForce(), and UName_.

Referenced by Cl(), clone(), LiftForce(), SaffmanMeiLiftForce< CloudType >::SaffmanMeiLiftForce(), SaffmanMeiLiftForce< CloudType >::SaffmanMeiLiftForce(), TomiyamaLiftForce< CloudType >::TomiyamaLiftForce(), and TomiyamaLiftForce< CloudType >::TomiyamaLiftForce().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LiftForce() [2/2]

template<class CloudType>

LiftForce ( const LiftForce< CloudType > & lf )

Construct copy.

Definition at line 60 of file LiftForce.C.

References curlUcInterpPtr_, LiftForce(), ParticleForce< CloudType >::ParticleForce(), and UName_.

Here is the call graph for this function:

◆ ~LiftForce()

template<class CloudType>

~LiftForce ( )

virtual

Destructor.

Definition at line 71 of file LiftForce.C.

Member Function Documentation

◆ Cl()

template<class CloudType>

virtual scalar Cl	(	const typename CloudType::parcelType &	p,
		const typename CloudType::parcelType::trackingData &	td,
		const vector &	curlUc,
		const scalar	Re,
		const scalar	muc ) const

protectedvirtual

Calculate the lift coefficient.

Reimplemented in SaffmanMeiLiftForce< CloudType >, and TomiyamaLiftForce< CloudType >.

References dict, LiftForce(), ParticleForce< CloudType >::mesh(), ParticleForce< CloudType >::owner(), p, Foam::Re(), and td().

Referenced by calcCoupled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone()

template<class CloudType>

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

inlinevirtual

Construct and return a clone.

Reimplemented from ParticleForce< CloudType >.

Reimplemented in SaffmanMeiLiftForce< CloudType >, and TomiyamaLiftForce< CloudType >.

Definition at line 110 of file LiftForce.H.

References LiftForce().

Here is the call graph for this function:

◆ curlUcInterp()

template<class CloudType>

const Foam::interpolation< Foam::vector > & curlUcInterp ( ) const

inline

Return the curl of the carrier phase velocity interpolator.

Definition at line 26 of file LiftForceI.H.

References Foam::abort(), curlUcInterpPtr_, Foam::FatalError, and FatalErrorInFunction.

Referenced by calcCoupled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cacheFields()

template<class CloudType>

void cacheFields ( const bool store )

virtual

Cache fields.

Reimplemented from ParticleForce< CloudType >.

Definition at line 78 of file LiftForce.C.

References regIOobject::checkOut(), Foam::fvc::curl(), curlUcInterpPtr_, mesh, interpolation< Type >::New(), ParticleForce< CloudType >::owner(), regIOobject::store(), and UName_.

Here is the call graph for this function:

◆ calcCoupled()

template<class CloudType>

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

Reimplemented from ParticleForce< CloudType >.

Definition at line 121 of file LiftForce.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ UName_

template<class CloudType>

const word UName_

protected

Name of velocity field.

Definition at line 64 of file LiftForce.H.

Referenced by cacheFields(), LiftForce(), and LiftForce().

◆ curlUcInterpPtr_

template<class CloudType>

autoPtr<interpolation<vector> > curlUcInterpPtr_

protected

Curl of carrier phase velocity interpolator.

Definition at line 69 of file LiftForce.H.

Referenced by cacheFields(), curlUcInterp(), LiftForce(), and LiftForce().

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

src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.H
src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.C
src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForceI.H

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LiftForce() [1/2]

◆ LiftForce() [2/2]

◆ ~LiftForce()

Member Function Documentation

◆ Cl()

◆ clone()

◆ curlUcInterp()

◆ cacheFields()

◆ calcCoupled()

Member Data Documentation

◆ UName_

◆ curlUcInterpPtr_