This boundary condition provides a log-law type ground-normal inlet boundary condition for the turbulent kinetic energy (i.e. k
) for homogeneous, two-dimensional, dry-air, equilibrium and neutral atmospheric boundary layer modelling.
More...
Public Member Functions | |
TypeName ("atmBoundaryLayerInletK") | |
Runtime type information. More... | |
atmBoundaryLayerInletKFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &) | |
Construct from patch and internal field. More... | |
atmBoundaryLayerInletKFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &) | |
Construct from patch, internal field and dictionary. More... | |
atmBoundaryLayerInletKFvPatchScalarField (const atmBoundaryLayerInletKFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &) | |
virtual tmp< fvPatchScalarField > | clone () const |
Construct and return a clone. More... | |
atmBoundaryLayerInletKFvPatchScalarField (const atmBoundaryLayerInletKFvPatchScalarField &, const DimensionedField< scalar, volMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual tmp< fvPatchScalarField > | clone (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< scalarField > | Ustar (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< vectorField > | U (const vectorField &pCf) const |
Return the velocity distribution for the ATM. More... | |
tmp< scalarField > | k (const vectorField &pCf) const |
Return the turbulent kinetic energy distribution for the ATM. More... | |
tmp< scalarField > | epsilon (const vectorField &pCf) const |
Return the turbulent dissipation rate distribution for the ATM. More... | |
tmp< scalarField > | omega (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_ |
This boundary condition provides a log-law type ground-normal inlet boundary condition for the turbulent kinetic energy (i.e. k
) for homogeneous, two-dimensional, dry-air, equilibrium and neutral atmospheric boundary layer modelling.
The ground-normal k
profile expression:
\[ k = \frac{(u^*)^2}{\sqrt{C_\mu}} \sqrt{C_1 \ln \left( \frac{z - d + z_0}{z_0} \right) + C_2} \]
where
\( k \) | = | Ground-normal turbulent kinetic energy profile [m^2/s^3] |
\( u^* \) | = | Friction velocity [m/s] |
\( C_\mu \) | = | Empirical model constant [-] |
\( C_1 \) | = | Curve-fitting coefficient for YGCJ profiles [-] |
\( C_2 \) | = | Curve-fitting coefficient for YGCJ profiles [-] |
Required fields:
k | Turbulent kinetic energy [m2/s2]
inlet { // Mandatory entries (unmodifiable) type atmBoundaryLayerInletK; // Mandatory/Optional (inherited) entries (unmodifiable) ... flowDir (1 0 0); // not used zDir (0 0 1); // not used }
where the entries mean:
Property | Description | Type | Reqd | Deflt |
---|---|---|---|---|
type | Type name: atmBoundaryLayerInletK | word | yes | - |
The inherited entries are elaborated in:
Definition at line 143 of file atmBoundaryLayerInletKFvPatchScalarField.H.
atmBoundaryLayerInletKFvPatchScalarField | ( | const fvPatch & | p, |
const DimensionedField< scalar, volMesh > & | iF | ||
) |
Construct from patch and internal field.
Definition at line 44 of file atmBoundaryLayerInletKFvPatchScalarField.C.
Referenced by atmBoundaryLayerInletKFvPatchScalarField::clone().
atmBoundaryLayerInletKFvPatchScalarField | ( | const fvPatch & | p, |
const DimensionedField< scalar, volMesh > & | iF, | ||
const dictionary & | dict | ||
) |
Construct from patch, internal field and dictionary.
Definition at line 56 of file atmBoundaryLayerInletKFvPatchScalarField.C.
References dict, dictionary::getOrDefault(), k, Field< scalar >::operator=(), p, and Foam::foamVersion::patch.
atmBoundaryLayerInletKFvPatchScalarField | ( | const atmBoundaryLayerInletKFvPatchScalarField & | psf, |
const fvPatch & | p, | ||
const DimensionedField< scalar, volMesh > & | iF, | ||
const fvPatchFieldMapper & | mapper | ||
) |
Construct by mapping given atmBoundaryLayerInletKFvPatchScalarField onto a new patch
Definition at line 85 of file atmBoundaryLayerInletKFvPatchScalarField.C.
atmBoundaryLayerInletKFvPatchScalarField | ( | const atmBoundaryLayerInletKFvPatchScalarField & | psf, |
const DimensionedField< scalar, volMesh > & | iF | ||
) |
Construct as copy setting internal field reference.
Definition at line 99 of file atmBoundaryLayerInletKFvPatchScalarField.C.
TypeName | ( | "atmBoundaryLayerInletK" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone.
Definition at line 183 of file atmBoundaryLayerInletKFvPatchScalarField.H.
References atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField().
|
inlinevirtual |
Construct and return a clone setting internal field reference.
Definition at line 200 of file atmBoundaryLayerInletKFvPatchScalarField.H.
References atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField().
|
virtual |
Update the coefficients associated with the patch field.
Definition at line 111 of file atmBoundaryLayerInletKFvPatchScalarField.C.
References atmBoundaryLayer::k(), and Foam::foamVersion::patch.
|
virtual |
Map (and resize as needed) from self given a mapping object.
Definition at line 125 of file atmBoundaryLayerInletKFvPatchScalarField.C.
References atmBoundaryLayer::autoMap().
|
virtual |
Reverse map the given fvPatchField onto this fvPatchField.
Definition at line 135 of file atmBoundaryLayerInletKFvPatchScalarField.C.
References atmBoundaryLayer::rmap().
|
virtual |
Write.
Definition at line 149 of file atmBoundaryLayerInletKFvPatchScalarField.C.
References os(), atmBoundaryLayer::write(), and fvPatchField< scalar >::write().