Calculates particle Brownian motion force. More...

Inheritance diagram for BrownianMotionForce< CloudType >:

Collaboration diagram for BrownianMotionForce< CloudType >:

[legend]

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
	Return const access to the molecular free path length [m]. More...

bool	turbulence () const
	Return const access to the turbulence flag. 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 non-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
	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 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...

Private Member Functions
scalar	erfInv (const scalar y) const
	Inverse erf for Gaussian distribution. More...

tmp< volScalarField >	kModel () const
	Return the k field from the turbulence model. More...

Private Attributes
cachedRandom &	rndGen_
	Reference to the cloud random number generator. More...

const scalar	lambda_
	Molecular free path length [m]. More...

bool	turbulence_
	Turbulence flag. More...

const volScalarField *	kPtr_
	Pointer to the turbulence kinetic energy field. More...

bool	ownK_
	Flag that indicates ownership of turbulence k field. 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.

Source files

Definition at line 51 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 88 of file BrownianMotionForce.C.

◆ BrownianMotionForce() [2/2]

BrownianMotionForce ( const BrownianMotionForce< CloudType > & bmf )

Construct copy.

Definition at line 105 of file BrownianMotionForce.C.

◆ ~BrownianMotionForce()

~BrownianMotionForce

virtual

Destructor.

Definition at line 121 of file BrownianMotionForce.C.

Member Function Documentation

◆ erfInv()

Foam::scalar erfInv ( const scalar y ) const

private

Inverse erf for Gaussian distribution.

Definition at line 36 of file BrownianMotionForce.C.

References Foam::constant::universal::h, k, Foam::log(), Foam::constant::mathematical::pi(), Foam::sqrt(), x, and y.

Here is the call graph for this function:

◆ kModel()

Foam::tmp< Foam::volScalarField > kModel

private

Return the k field from the turbulence model.

Definition at line 56 of file BrownianMotionForce.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, objectRegistry::foundObject(), Foam::constant::atomic::group, IOobject::groupName(), turbulenceModel::k(), objectRegistry::lookupObject(), Foam::nl, turbulenceModel::propertiesName, HashTable::sortedToc(), and U.

Here is the call graph for this function:

◆ 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 102 of file BrownianMotionForce.H.

◆ lambda()

Foam::scalar lambda

inline

Return const access to the molecular free path length [m].

Definition at line 29 of file BrownianMotionForceI.H.

◆ turbulence()

bool turbulence

inline

Return const access to the turbulence flag.

Definition at line 36 of file BrownianMotionForceI.H.

◆ cacheFields()

void cacheFields ( const bool store )

virtual

Cache fields.

Reimplemented from ParticleForce< CloudType >.

Definition at line 128 of file BrownianMotionForce.C.

References Foam::deleteDemandDrivenData(), tmp::isTmp(), and tmp::ptr().

Here is the call graph for this function:

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

Reimplemented from ParticleForce< CloudType >.

Definition at line 160 of file BrownianMotionForce.C.

References Foam::constant::atomic::alpha, Foam::exp(), f(), k, p, Foam::constant::mathematical::pi(), Foam::pow5(), Foam::constant::physicoChemical::sigma, Foam::sqr(), Foam::sqrt(), forceSuSp::Su(), dimensioned::value(), x, and Vector< scalar >::zero.

Here is the call graph for this function:

Field Documentation

◆ rndGen_

cachedRandom& rndGen_

private

Reference to the cloud random number generator.

Definition at line 58 of file BrownianMotionForce.H.

◆ lambda_

const scalar lambda_

private

Molecular free path length [m].

Definition at line 61 of file BrownianMotionForce.H.

◆ turbulence_

bool turbulence_

private

Turbulence flag.

Definition at line 64 of file BrownianMotionForce.H.

◆ kPtr_

const volScalarField* kPtr_

private

Pointer to the turbulence kinetic energy field.

Definition at line 67 of file BrownianMotionForce.H.

◆ ownK_

bool ownK_

private

Flag that indicates ownership of turbulence k field.

Definition at line 70 of file BrownianMotionForce.H.

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
src/lagrangian/turbulence/submodels/Thermodynamic/ParticleForces/BrownianMotion/BrownianMotionForceI.H

Public Member Functions

Private Member Functions

Private Attributes

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

◆ erfInv()

◆ kModel()

◆ TypeName()

◆ clone()

◆ lambda()

◆ turbulence()

◆ cacheFields()

◆ calcCoupled()

Field Documentation

◆ rndGen_

◆ lambda_

◆ turbulence_

◆ kPtr_

◆ ownK_

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