Calculates particle Brownian motion force. More...

#include <BrownianMotionForce.H>

Inheritance diagram for BrownianMotionForce< CloudType >:

Collaboration diagram for BrownianMotionForce< CloudType >:

Public Member Functions
	TypeName ("BrownianMotion")
	Runtime type information.
	BrownianMotionForce (CloudType &owner, const fvMesh &mesh, const dictionary &dict)
	Construct from mesh.
	BrownianMotionForce (const BrownianMotionForce &bmf)
	Construct copy.
virtual autoPtr< ParticleForce< CloudType > >	clone () const
	Construct and return a clone.
virtual	~BrownianMotionForce ()
	Destructor.
scalar	lambda () const noexcept
	The molecular free path length [m].
bool	turbulence () const noexcept
	The turbulence flag.
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.
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.

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

Calculates particle Brownian motion force.

Reference:

    Li, A., & Ahmadi, G. (1992).
    Dispersion and deposition of spherical particles from point sources
    in a turbulent channel flow.
    Aerosol science and technology,
    16(4), 209-226.

Entries

Property	Description	Type	Reqd	Deflt
`lambda`	Molecular free path length	scalar	yes	-
`turbulence`	Use turbulence	bool	yes	-
`spherical`	Spherical instead of cubic distribution	bool	no	true

Note: The treatment changed from cubic to spherical around v1606. Reinstate support for cubic via spherical (true/false) switch after v2306.

Source files

Definition at line 94 of file BrownianMotionForce.H.

Constructor & Destructor Documentation

◆ BrownianMotionForce() [1/2]

template<class CloudType>

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

Construct from mesh.

Definition at line 63 of file BrownianMotionForce.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BrownianMotionForce() [2/2]

template<class CloudType>

BrownianMotionForce ( const BrownianMotionForce< CloudType > & bmf )

Construct copy.

Definition at line 81 of file BrownianMotionForce.C.

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

Here is the call graph for this function:

◆ ~BrownianMotionForce()

template<class CloudType>

~BrownianMotionForce ( )

virtual

Destructor.

Definition at line 99 of file BrownianMotionForce.C.

References Foam::deleteDemandDrivenData().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

template<class CloudType>

TypeName ( "BrownianMotion" )

Runtime type information.

References BrownianMotionForce(), dict, 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 167 of file BrownianMotionForce.H.

References BrownianMotionForce().

Here is the call graph for this function:

◆ lambda()

template<class CloudType>

scalar lambda ( ) const

inlinenoexcept

The molecular free path length [m].

Definition at line 189 of file BrownianMotionForce.H.

References Foam::noexcept.

◆ turbulence()

template<class CloudType>

bool turbulence ( ) const

inlinenoexcept

The turbulence flag.

Definition at line 194 of file BrownianMotionForce.H.

References Foam::noexcept.

◆ cacheFields()

template<class CloudType>

void cacheFields ( const bool store )

virtual

Cache fields.

Reimplemented from ParticleForce< CloudType >.

Definition at line 112 of file BrownianMotionForce.C.

References tmp< T >::cref(), Foam::deleteDemandDrivenData(), tmp< T >::movable(), and tmp< T >::ptr().

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

Reimplemented from ParticleForce< CloudType >.

Definition at line 144 of file BrownianMotionForce.C.

References alpha, Foam::cos(), Foam::exp(), f(), Random::GaussNormal(), Foam::constant::physicoChemical::k, k, kb, Foam::mag(), ParticleForce< CloudType >::owner(), p, Foam::constant::mathematical::pi(), Foam::pow5(), Foam::Re(), Random::sample01(), Foam::sin(), Foam::sqr(), Foam::sqrt(), 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/turbulence/submodels/Thermodynamic/ParticleForces/BrownianMotion/BrownianMotionForce.H
src/lagrangian/turbulence/submodels/Thermodynamic/ParticleForces/BrownianMotion/BrownianMotionForce.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BrownianMotionForce() [1/2]

◆ BrownianMotionForce() [2/2]

◆ ~BrownianMotionForce()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ lambda()

◆ turbulence()

◆ cacheFields()

◆ calcCoupled()