Calculates and writes particle Reynolds number field on the cloud. The normalisation factors are calculated without thermal effects. More...

Inheritance diagram for KinematicReynoldsNumber< CloudType >:

[legend]

Collaboration diagram for KinematicReynoldsNumber< CloudType >:

[legend]

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

void	operator= (const KinematicReynoldsNumber< CloudType > &)=delete
	No copy assignment. More...

	KinematicReynoldsNumber (const dictionary &dict, CloudType &owner, const word &modelName)
	Construct from dictionary. More...

	KinematicReynoldsNumber (const KinematicReynoldsNumber< CloudType > &vf)
	Copy construct. More...

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

virtual	~KinematicReynoldsNumber ()=default
	Destructor. More...

virtual void	postEvolve (const typename parcelType::trackingData &td)
	Post-evolve hook. More...

Public Member Functions inherited from CloudFunctionObject< CloudType >
	TypeName ("cloudFunctionObject")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, CloudFunctionObject, dictionary,(const dictionary &dict, CloudType &owner, const word &modelName),(dict, owner, modelName))
	Declare runtime constructor selection table. More...

	CloudFunctionObject (CloudType &owner)
	Construct null from owner. More...

	CloudFunctionObject (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)
	Construct from dictionary. More...

	CloudFunctionObject (const CloudFunctionObject< CloudType > &ppm)
	Construct copy. More...

virtual	~CloudFunctionObject ()=default
	Destructor. More...

virtual void	preEvolve (const typename parcelType::trackingData &td)
	Pre-evolve hook. More...

virtual void	postMove (parcelType &p, const scalar dt, const point &position0, bool &keepParticle)
	Post-move hook. More...

virtual void	postPatch (const parcelType &p, const polyPatch &pp, bool &keepParticle)
	Post-patch hook. More...

virtual void	postFace (const parcelType &p, bool &keepParticle)
	Post-face hook. More...

const fileName &	outputDir () const
	Return the output path. More...

fileName	writeTimeDir () const
	Return the output time path. More...

Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud. More...

	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name. More...

	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name. More...

	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Construct as copy. More...

virtual	~CloudSubModelBase ()
	Destructor. More...

const CloudType &	owner () const
	Return const access to the owner cloud. More...

virtual bool	writeTime () const
	Flag to indicate when to write a property. More...

virtual fileName	localPath () const
	Output directory. More...

CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation. More...

virtual void	write (Ostream &os) const
	Write. More...

Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null. More...

	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name. More...

	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name. More...

	subModelBase (const subModelBase &smb)
	Construct as copy. More...

virtual	~subModelBase ()
	Destructor. More...

const word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () const
	Return const access to the properties dictionary. More...

virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg. More...

virtual bool	active () const
	Return the model 'active' status - default active = true. More...

virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the base model. More...

template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model. More...

template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model. More...

bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set. More...

template<class Type >
void	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model. More...

template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the sub-model. More...

template<class Type >
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model. More...

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for. More...

Static Public Member Functions inherited from CloudFunctionObject< CloudType >
static autoPtr< CloudFunctionObject< CloudType > >	New (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)
	Selector. More...

Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line. More...

Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud. More...

Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	Reference to properties dictionary e.g. for restart. More...

const dictionary	dict_
	Copy of dictionary used during construction. More...

const word	baseName_
	Name of the sub-model base class. More...

const word	modelType_
	Type of the sub-model. More...

const dictionary	coeffDict_
	Coefficients dictionary. More...

Detailed Description

template<class CloudType>
class Foam::KinematicReynoldsNumber< CloudType >

Calculates and writes particle Reynolds number field on the cloud. The normalisation factors are calculated without thermal effects.

\[ \mathrm{Re}_p = \frac{\rho_c \, | \mathbf{u}_\mathrm{rel} | \, d_p}{\mu_c} \]

\( \mathrm{Re}_p \)	=	Particle Reynolds number
\( d_p \)	=	Particle diameter
\( \rho_c \)	=	Density of carrier
\( \mu_c \)	=	Dynamic viscosity of carrier
\( \mathbf{u}_\mathrm{rel} \)	=	Relative velocity between particle and carrier

Operands:

Operand	Type	Location
`input`	-	-
`output` file	-	-
`output` field	scalarField	<time>/lagrangian/<cloud>/kinematicRe

Usage

Minimal example by using constant/<CloudProperties>:

cloudFunctions
{
    KinematicReynoldsNumber1
    {
        // Mandatory entries
        type             KinematicReynoldsNumber;
    }
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: KinematicReynoldsNumber	word	yes	-

See also

Foam::ThermoReynoldsNumber

Source files

Definition at line 146 of file KinematicReynoldsNumber.H.

Constructor & Destructor Documentation

◆ KinematicReynoldsNumber() [1/2]

KinematicReynoldsNumber	(	const dictionary &	dict,
		CloudType &	owner,
		const word &	modelName
	)

Construct from dictionary.

Definition at line 34 of file KinematicReynoldsNumber.C.

◆ KinematicReynoldsNumber() [2/2]

KinematicReynoldsNumber ( const KinematicReynoldsNumber< CloudType > & vf )

Copy construct.

Definition at line 46 of file KinematicReynoldsNumber.C.

◆ ~KinematicReynoldsNumber()

virtual ~KinematicReynoldsNumber ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "ReynoldsNumber" )

Runtime type information.

◆ operator=()

void operator= ( const KinematicReynoldsNumber< CloudType > & )

delete

No copy assignment.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 184 of file KinematicReynoldsNumber.H.

◆ postEvolve()

void postEvolve ( const typename parcelType::trackingData & td )

virtual

Post-evolve hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 58 of file KinematicReynoldsNumber.C.

References Foam::constant::universal::c, forAllConstIters(), p, and Foam::Re().

Here is the call graph for this function:

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

src/lagrangian/intermediate/submodels/CloudFunctionObjects/KinematicReynoldsNumber/KinematicReynoldsNumber.H
src/lagrangian/intermediate/submodels/CloudFunctionObjects/KinematicReynoldsNumber/KinematicReynoldsNumber.C

Public Member Functions

Additional Inherited Members