atmBoundaryLayerInletEpsilonFvPatchScalarField Class Reference

This boundary condition provides a log-law type ground-normal inlet boundary condition for the turbulent kinetic energy dissipation rate (i.e. epsilon) for homogeneous, two-dimensional, dry-air, equilibrium and neutral atmospheric boundary layer modelling. More...

Inheritance diagram for atmBoundaryLayerInletEpsilonFvPatchScalarField:
[legend]
Collaboration diagram for atmBoundaryLayerInletEpsilonFvPatchScalarField:
[legend]

Public Member Functions

 TypeName ("atmBoundaryLayerInletEpsilon")
 Runtime type information. More...
 
 atmBoundaryLayerInletEpsilonFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 atmBoundaryLayerInletEpsilonFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 atmBoundaryLayerInletEpsilonFvPatchScalarField (const atmBoundaryLayerInletEpsilonFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 atmBoundaryLayerInletEpsilonFvPatchScalarField (const atmBoundaryLayerInletEpsilonFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvPatchScalarField &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from atmBoundaryLayer
 atmBoundaryLayer (const Time &time, const polyPatch &pp)
 Construct null from time. More...
 
 atmBoundaryLayer (const Time &time, const polyPatch &pp, const dictionary &dict)
 Construct from the time database and dictionary. More...
 
 atmBoundaryLayer (const atmBoundaryLayer &abl, const fvPatch &patch, const fvPatchFieldMapper &mapper)
 Construct by mapping given atmBoundaryLayer onto a new patch. More...
 
 atmBoundaryLayer (const atmBoundaryLayer &)
 Construct as copy. More...
 
vector flowDir () const
 Return flow direction. More...
 
vector zDir () const
 Return the ground-normal direction. More...
 
tmp< scalarFieldUstar (const scalarField &z0) const
 Return friction velocity. More...
 
void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
void rmap (const atmBoundaryLayer &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
tmp< vectorFieldU (const vectorField &pCf) const
 Return the velocity distribution for the ATM. More...
 
tmp< scalarFieldk (const vectorField &pCf) const
 Return the turbulent kinetic energy distribution for the ATM. More...
 
tmp< scalarFieldepsilon (const vectorField &pCf) const
 Return the turbulent dissipation rate distribution for the ATM. More...
 
tmp< scalarFieldomega (const vectorField &pCf) const
 Return the specific dissipation rate distribution for the ATM. More...
 
void write (Ostream &) const
 Write. More...
 

Additional Inherited Members

- Protected Attributes inherited from atmBoundaryLayer
bool initABL_
 

Detailed Description

This boundary condition provides a log-law type ground-normal inlet boundary condition for the turbulent kinetic energy dissipation rate (i.e. epsilon) for homogeneous, two-dimensional, dry-air, equilibrium and neutral atmospheric boundary layer modelling.

The ground-normal epsilon profile expression:

\[ \epsilon = \frac{(u^*)^3}{\kappa (z - d + z_0)} \sqrt{C_1 \ln \left( \frac{z - d + z_0}{z_0} \right) + C_2} \]

where

\( \epsilon \) = Ground-normal TKE dissipation rate profile [m^2/s^3]
\( u^* \) = Friction velocity [m/s]
\( \kappa \) = von Kármán constant [-]
\( z \) = Ground-normal coordinate component [m]
\( z_0 \) = Aerodynamic roughness length [m]
\( d \) = Ground-normal displacement height [m]
\( C_1 \) = Curve-fitting coefficient for YGCJ profiles [-]
\( C_2 \) = Curve-fitting coefficient for YGCJ profiles [-]

Required fields:

        epsilon   | Turbulent kinetic energy dissipation rate   [m2/s3]
Usage
Example of the boundary condition specification:
inlet
{
    // Mandatory entries (unmodifiable)
    type            atmBoundaryLayerInletEpsilon;

    // Mandatory/Optional (inherited) entries (unmodifiable)
    ...
}

where the entries mean:

Property Description Type Reqd Deflt
type Type name: atmBoundaryLayerInletEpsilon word yes -

The inherited entries are elaborated in:

See also
Source files

Definition at line 156 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ atmBoundaryLayerInletEpsilonFvPatchScalarField() [1/4]

Construct from patch and internal field.

Definition at line 43 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.C.

◆ atmBoundaryLayerInletEpsilonFvPatchScalarField() [2/4]

atmBoundaryLayerInletEpsilonFvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 55 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.C.

References dict, epsilon, dictionary::getOrDefault(), atmBoundaryLayer::initABL_, Field< scalar >::operator=(), p, and UList< T >::size().

Here is the call graph for this function:

◆ atmBoundaryLayerInletEpsilonFvPatchScalarField() [3/4]

Construct by mapping given atmBoundaryLayerInletEpsilonFvPatchScalarField onto a new patch

Definition at line 84 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.C.

◆ atmBoundaryLayerInletEpsilonFvPatchScalarField() [4/4]

Construct as copy setting internal field reference.

Definition at line 98 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "atmBoundaryLayerInletEpsilon"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp< fvPatchScalarField > clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 196 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.H.

◆ clone() [2/2]

virtual tmp< fvPatchScalarField > clone ( const DimensionedField< scalar, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 212 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 112 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.C.

References epsilon.

Referenced by atmAlphatkWallFunctionFvPatchScalarField::updateCoeffs(), inletOutletFaPatchField< Type >::updateCoeffs(), timeVaryingUniformFixedValueFaPatchField< Type >::updateCoeffs(), SRFFreestreamVelocityFvPatchVectorField::updateCoeffs(), advectiveFvPatchField< Type >::updateCoeffs(), cylindricalInletVelocityFvPatchVectorField::updateCoeffs(), fanFvPatchField< Type >::updateCoeffs(), fixedMeanFvPatchField< Type >::updateCoeffs(), fixedPressureCompressibleDensityFvPatchScalarField::updateCoeffs(), fixedProfileFvPatchField< Type >::updateCoeffs(), freestreamPressureFvPatchScalarField::updateCoeffs(), freestreamVelocityFvPatchVectorField::updateCoeffs(), inletOutletFvPatchField< Type >::updateCoeffs(), mappedFieldFvPatchField< Type >::updateCoeffs(), mappedMixedFieldFvPatchField< Type >::updateCoeffs(), mappedFixedValueFvPatchField< Type >::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), mappedMixedFvPatchField< Type >::updateCoeffs(), outletInletFvPatchField< Type >::updateCoeffs(), outletMappedUniformInletFvPatchField< Type >::updateCoeffs(), outletPhaseMeanVelocityFvPatchVectorField::updateCoeffs(), pressurePIDControlInletVelocityFvPatchVectorField::updateCoeffs(), scaledFixedValueFvPatchField< Type >::updateCoeffs(), swirlFlowRateInletVelocityFvPatchVectorField::updateCoeffs(), swirlInletVelocityFvPatchVectorField::updateCoeffs(), timeVaryingMappedFixedValueFvPatchField< Type >::updateCoeffs(), turbulentDigitalFilterInletFvPatchField< Type >::updateCoeffs(), turbulentInletFvPatchField< Type >::updateCoeffs(), uniformFixedGradientFvPatchField< Type >::updateCoeffs(), uniformFixedValueFvPatchField< Type >::updateCoeffs(), uniformInletOutletFvPatchField< Type >::updateCoeffs(), uniformJumpFvPatchField< Type >::updateCoeffs(), uniformJumpAMIFvPatchField< Type >::updateCoeffs(), variableHeightFlowRateInletVelocityFvPatchVectorField::updateCoeffs(), cellMotionFvPatchField< Type >::updateCoeffs(), angularOscillatingDisplacementPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), oscillatingDisplacementPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), timeVaryingMappedFixedValuePointPatchField< Type >::updateCoeffs(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), waveDisplacementPointPatchVectorField::updateCoeffs(), lumpedPointDisplacementPointPatchVectorField::updateCoeffs(), uniformFixedValuePointPatchField< Type >::updateCoeffs(), timeVaryingUniformFixedValuePointPatchField< Type >::updateCoeffs(), adjointOutletFluxFvPatchField< Type >::updateCoeffs(), waWallFunctionFvPatchScalarField::updateCoeffs(), velocityFilmShellFvPatchVectorField::updateCoeffs(), thermalShellFvPatchScalarField::updateCoeffs(), vibrationShellFvPatchScalarField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), energyJumpFvPatchScalarField::updateCoeffs(), energyJumpAMIFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), waveAlphaFvPatchScalarField::updateCoeffs(), waveVelocityFvPatchVectorField::updateCoeffs(), waveMakerPointPatchVectorField::updateCoeffs(), and prghPermeableAlphaTotalPressureFvPatchScalarField::updateSnGrad().

◆ autoMap()

void autoMap ( const fvPatchFieldMapper m)
virtual

Map (and resize as needed) from self given a mapping object.

Definition at line 125 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.C.

References atmBoundaryLayer::autoMap().

Here is the call graph for this function:

◆ rmap()

void rmap ( const fvPatchScalarField psf,
const labelList addr 
)
virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 135 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.C.

References atmBoundaryLayer::rmap().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 150 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.C.

References os(), ObukhovLength::write(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

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