ThermoReynoldsNumber< CloudType > Class Template Reference

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

Inheritance diagram for ThermoReynoldsNumber< CloudType >:
[legend]
Collaboration diagram for ThermoReynoldsNumber< CloudType >:
[legend]

Public Member Functions

 TypeName ("ReynoldsNumber")
 Runtime type information. More...
 
void operator= (const ThermoReynoldsNumber< CloudType > &)=delete
 No copy assignment. More...
 
 ThermoReynoldsNumber (const dictionary &dict, CloudType &owner, const word &modelName)
 Construct from dictionary. More...
 
 ThermoReynoldsNumber (const ThermoReynoldsNumber< CloudType > &vf)
 Copy construct. More...
 
virtual autoPtr< CloudFunctionObject< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~ThermoReynoldsNumber ()=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 autoPtr< CloudFunctionObject< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~CloudFunctionObject ()=default
 Destructor. More...
 
virtual void preEvolve (const typename parcelType::trackingData &td)
 Pre-evolve hook. More...
 
virtual void postEvolve (const typename parcelType::trackingData &td)
 Post-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 fileNameoutputDir () 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 CloudTypeowner () 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...
 
CloudTypeowner ()
 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 wordmodelName () const
 Return const access to the name of the sub-model. More...
 
const dictionarydict () const
 Return const access to the cloud dictionary. More...
 
const wordbaseName () const
 Return const access to the base name of the sub-model. More...
 
const wordmodelType () const
 Return const access to the sub-model type. More...
 
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionaryproperties () 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...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. 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 >
bool 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...
 
virtual void write (Ostream &os) const
 Write. 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 >
CloudTypeowner_
 Reference to the cloud. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 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::ThermoReynoldsNumber< CloudType >

Calculates and writes particle Reynolds number field on the cloud. The normalisation factors are calculated with 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 in the film surrounding particle
\( \mu_c \) = Dynamic viscosity of carrier in the film surrounding particle
\( \mathbf{u}_\mathrm{rel} \) = Relative velocity between particle and carrier

Operands:

Operand Type Location
input - -
output file - -
output field scalarField <time>/lagrangian/<cloud>/Re
Usage
Minimal example by using constant/<CloudProperties>:
cloudFunctions
{
    ThermoReynoldsNumber1
    {
        // Mandatory entries
        type             ReynoldsNumber;
    }
}

where the entries mean:

Property Description Type Reqd Deflt
type Type name: ReynoldsNumber word yes -
Note
  • Normalisation factors rhoc and muc are based on temperature dependent values calculated inside the film surrounding the particle rather than freestream values; therefore, the thermo ReynoldsNumber should not be expected to operate with kinematic (non-thermo) applications.
See also
Source files

Definition at line 152 of file ThermoReynoldsNumber.H.

Constructor & Destructor Documentation

◆ ThermoReynoldsNumber() [1/2]

ThermoReynoldsNumber ( const dictionary dict,
CloudType owner,
const word modelName 
)

Construct from dictionary.

Definition at line 34 of file ThermoReynoldsNumber.C.

◆ ThermoReynoldsNumber() [2/2]

Copy construct.

Definition at line 46 of file ThermoReynoldsNumber.C.

◆ ~ThermoReynoldsNumber()

virtual ~ThermoReynoldsNumber ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "ReynoldsNumber"  )

Runtime type information.

◆ operator=()

void operator= ( const ThermoReynoldsNumber< 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 190 of file ThermoReynoldsNumber.H.

◆ postEvolve()

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

Post-evolve hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 58 of file ThermoReynoldsNumber.C.

References forAllConstIters, IOobject::NO_READ, p, Pr(), Foam::Re(), List< T >::setSize(), and GeometricField< Type, PatchField, GeoMesh >::T().

Here is the call graph for this function:

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