Calculates particle Brownian motion force. More...

Inheritance diagram for BrownianMotionForce< CloudType >:

Collaboration diagram for BrownianMotionForce< CloudType >:

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

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

	BrownianMotionForce (const BrownianMotionForce &bmf)
	Construct copy. More...

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

virtual	~BrownianMotionForce ()
	Destructor. More...

scalar	lambda () const noexcept
	The molecular free path length [m]. More...

bool	turbulence () const noexcept
	The turbulence flag. 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...

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 noexcept
	Return const access to the cloud owner. More...

CloudType &	owner () noexcept
	Return reference to the cloud owner. More...

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

const dictionary &	coeffs () const noexcept
	Return the force coefficients dictionary. 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...

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::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]

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

Construct from mesh.

Definition at line 64 of file BrownianMotionForce.C.

◆ BrownianMotionForce() [2/2]

BrownianMotionForce ( const BrownianMotionForce< CloudType > & bmf )

Construct copy.

Definition at line 82 of file BrownianMotionForce.C.

◆ ~BrownianMotionForce()

~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()

TypeName ( "BrownianMotion" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Reimplemented from ParticleForce< CloudType >.

Definition at line 167 of file BrownianMotionForce.H.

◆ lambda()

scalar lambda ( ) const

inlinenoexcept

The molecular free path length [m].

Definition at line 189 of file BrownianMotionForce.H.

◆ turbulence()

bool turbulence ( ) const

inlinenoexcept

The turbulence flag.

Definition at line 194 of file BrownianMotionForce.H.

◆ cacheFields()

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()

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 145 of file BrownianMotionForce.C.

References Foam::constant::atomic::alpha, Foam::cos(), Foam::exp(), f(), Random::GaussNormal(), k, Foam::constant::physicoChemical::k, kb, Foam::mag(), p, Foam::constant::mathematical::pi(), Foam::pow5(), Random::sample01(), Foam::sin(), Foam::sqr(), Foam::sqrt(), forceSuSp::Su(), Foam::constant::mathematical::twoPi(), dimensioned< Type >::value(), 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

template<class CloudType> class Foam::BrownianMotionForce< CloudType >

Constructor & Destructor Documentation

◆ BrownianMotionForce() [1/2]

◆ BrownianMotionForce() [2/2]

◆ ~BrownianMotionForce()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ lambda()

◆ turbulence()

◆ cacheFields()

◆ calcCoupled()

template<class CloudType>
class Foam::BrownianMotionForce< CloudType >