Commit 4d295c84 authored by Kutalmis Bercin's avatar Kutalmis Bercin
Browse files

DOC-STYLE: various release changes

parent 39c2f16e
...@@ -48,6 +48,7 @@ Foam::epsilonWallFunctionFvPatchScalarField::blendingTypeNames ...@@ -48,6 +48,7 @@ Foam::epsilonWallFunctionFvPatchScalarField::blendingTypeNames
Foam::scalar Foam::epsilonWallFunctionFvPatchScalarField::tolerance_ = 1e-5; Foam::scalar Foam::epsilonWallFunctionFvPatchScalarField::tolerance_ = 1e-5;
// * * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * // // * * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * //
void Foam::epsilonWallFunctionFvPatchScalarField::setMaster() void Foam::epsilonWallFunctionFvPatchScalarField::setMaster()
......
...@@ -74,7 +74,7 @@ Usage ...@@ -74,7 +74,7 @@ Usage
\table \table
Property | Description | Type | Req'd | Dflt Property | Description | Type | Req'd | Dflt
type | Type name: epsilonWallFunction | word | yes | - type | Type name: epsilonWallFunction | word | yes | -
lowReCorrection | Flag for low-Re correction | bool | no | false lowReCorrection | Flag: apply low-Re correction | bool | no | false
blending | Viscous/inertial sublayer blending method <!-- blending | Viscous/inertial sublayer blending method <!--
--> | word | no | stepwise --> | word | no | stepwise
n | Binomial blending exponent | scalar | no | 2.0 n | Binomial blending exponent | scalar | no | 2.0
...@@ -189,8 +189,6 @@ class epsilonWallFunctionFvPatchScalarField ...@@ -189,8 +189,6 @@ class epsilonWallFunctionFvPatchScalarField
: :
public fixedValueFvPatchField<scalar> public fixedValueFvPatchField<scalar>
{ {
private:
// Private Enumerations // Private Enumerations
//- Options for the blending treatment of viscous and inertial sublayers //- Options for the blending treatment of viscous and inertial sublayers
......
...@@ -32,8 +32,10 @@ Group ...@@ -32,8 +32,10 @@ Group
Description Description
This boundary condition provides a simple wrapper around the zero-gradient This boundary condition provides a simple wrapper around the zero-gradient
condition, which can be used for \c k, \c q, and \c R fields for condition, which can be used for the turbulent kinetic energy, i.e. \c k,
the case of high Reynolds number flow using wall functions. square-root of turbulent kinetic energy, i.e. \c q, and Reynolds stress
tensor fields, i.e. \c R, for the cases of high Reynolds number flow
using wall functions.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
......
...@@ -31,8 +31,8 @@ Group ...@@ -31,8 +31,8 @@ Group
grpWallFunctions grpWallFunctions
Description Description
This boundary condition provides a wall constraint on the turbulent This boundary condition provides a wall constraint on the
viscosity, i.e. \c nut for low Reynolds number models. turbulent viscosity, i.e. \c nut, for low Reynolds number models.
It sets \c nut to zero, and provides an access function to calculate \c y+. It sets \c nut to zero, and provides an access function to calculate \c y+.
Usage Usage
......
...@@ -31,8 +31,10 @@ Group ...@@ -31,8 +31,10 @@ Group
Description Description
This boundary condition provides a wall constraint on the turbulent This boundary condition provides a wall constraint on the turbulent
viscosity, i.e. \c nut, when using wall functions based on viscosity, i.e. \c nut, based on velocity, i.e. \c U, using a
a blending of viscous and inertial sublayer contributions. binomial-function wall-function blending method between the viscous
and inertial sublayer predictions of \c nut for low- and high-Reynolds
number turbulence models.
\f[ \f[
u_\tau = (u_{\tau,v}^n + u_{\tau,l}^n)^{1/n} u_\tau = (u_{\tau,v}^n + u_{\tau,l}^n)^{1/n}
...@@ -46,12 +48,13 @@ Description ...@@ -46,12 +48,13 @@ Description
\endvartable \endvartable
Reference: Reference:
See the section that describes 'automatic wall treatment'
\verbatim \verbatim
See the section that describes 'automatic wall treatment':
Menter, F., Ferreira, J. C., Esch, T., Konno, B. (2003). Menter, F., Ferreira, J. C., Esch, T., Konno, B. (2003).
The SST Turbulence Model with Improved Wall Treatment The SST turbulence model with improved wall treatment
for Heat Transfer Predictions in Gas Turbines. for heat transfer predictions in gas turbines.
Proceedings of the International Gas Turbine Congress 2003 Tokyo In Proceedings of the International Gas Turbine Congress.
November, 2003. Tokyo, Japan. pp. 2-7.
\endverbatim \endverbatim
Usage Usage
...@@ -62,7 +65,7 @@ Usage ...@@ -62,7 +65,7 @@ Usage
// Mandatory entries (unmodifiable) // Mandatory entries (unmodifiable)
type nutUBlendedWallFunction; type nutUBlendedWallFunction;
// Optional entries // Optional entries (unmodifiable)
n 4.0; n 4.0;
// Optional (inherited) entries // Optional (inherited) entries
......
...@@ -32,8 +32,8 @@ Group ...@@ -32,8 +32,8 @@ Group
Description Description
This boundary condition provides a wall constraint on the turbulent This boundary condition provides a wall constraint on the turbulent
viscosity, i.e. \c nut, when using wall functions for rough walls, viscosity, i.e. \c nut, based on velocity i.e. \c U, for low- and
based on velocity, \c U. high-Reynolds number turbulence models for rough walls.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
...@@ -74,9 +74,6 @@ Note ...@@ -74,9 +74,6 @@ Note
\c turbulence->validate) returns a slightly different value every time \c turbulence->validate) returns a slightly different value every time
it is called. it is called.
See \link nutUSpaldingWallFunctionFvPatchScalarField.C \endlink. See \link nutUSpaldingWallFunctionFvPatchScalarField.C \endlink.
- Can be avoided by seeding the NR with e.g. the laminar viscosity
or tightening the convergence tolerance to e.g. 1e-7 and the max
number of iterations to 100.
SourceFiles SourceFiles
nutURoughWallFunctionFvPatchScalarField.C nutURoughWallFunctionFvPatchScalarField.C
......
...@@ -32,9 +32,8 @@ Group ...@@ -32,9 +32,8 @@ Group
Description Description
This boundary condition provides a wall constraint on the turbulent This boundary condition provides a wall constraint on the turbulent
viscosity, i.e. \c nut, when using wall functions for rough walls, viscosity, i.e. \c nut, based on velocity, i.e. \c U. Using Spalding's
based on velocity, \c U, using Spalding's law to give a continuous \c nut law gives a continuous \c nut profile to the wall.
profile to the wall (y+ = 0)
\f[ \f[
y^+ = u^+ + \frac{1}{E} \left[exp(\kappa u^+) - 1 - \kappa u^+\, y^+ = u^+ + \frac{1}{E} \left[exp(\kappa u^+) - 1 - \kappa u^+\,
...@@ -81,13 +80,11 @@ Note ...@@ -81,13 +80,11 @@ Note
\c turbulence->validate) returns a slightly different value every time \c turbulence->validate) returns a slightly different value every time
it is called. This is since the seed for the Newton-Raphson iteration it is called. This is since the seed for the Newton-Raphson iteration
uses the current value of \c *this (\c =nut ). uses the current value of \c *this (\c =nut ).
- This can be avoided by overriding the tolerance. This also switches on - This can be avoided by overriding the tolerance. This also switches on
a pre-detection whether the current nut already satisfies the turbulence a pre-detection whether the current nut already satisfies the turbulence
conditions and if so does not change it at all. This means that the nut conditions and if so does not change it at all. This means that the nut
only changes if it 'has really changed'. This probably should be used with only changes if it 'has really changed'. This probably should be used with
a tight tolerance, to make sure to kick every iteration, e.g. a tight tolerance, to make sure to kick every iteration, e.g.
maxIter 100; maxIter 100;
tolerance 1e-7; tolerance 1e-7;
......
...@@ -32,10 +32,10 @@ Group ...@@ -32,10 +32,10 @@ Group
Description Description
This boundary condition provides a wall constraint on the turbulent This boundary condition provides a wall constraint on the turbulent
viscosity, i.e. \c nut, when using wall functions, based on viscosity, i.e. \c nut, based on velocity, i.e. \c U, for low- and
velocity, i.e. \c U. high-Reynolds number turbulence models.
As input, the user specifies a look-up table of \c U+ as a function of As input, the user specifies a look-up table of \c u+ as a function of
near-wall Reynolds number. near-wall Reynolds number.
The table should be located in the \c $FOAM_CASE/constant directory. The table should be located in the \c $FOAM_CASE/constant directory.
...@@ -58,7 +58,7 @@ Usage ...@@ -58,7 +58,7 @@ Usage
\table \table
Property | Description | Type | Req'd | Dflt Property | Description | Type | Req'd | Dflt
type | Type name: nutUTabulatedWallFunction | word | yes | - type | Type name: nutUTabulatedWallFunction | word | yes | -
uPlusTable | U+ as a function of Re table name | word | yes | - uPlusTable | u+ as a function of Re table name | word | yes | -
\endtable \endtable
The inherited entries are elaborated in: The inherited entries are elaborated in:
......
...@@ -32,8 +32,8 @@ Group ...@@ -32,8 +32,8 @@ Group
Description Description
This boundary condition provides a wall constraint on the turbulent This boundary condition provides a wall constraint on the turbulent
viscosity, i.e. \c nut, when using wall functions, based on viscosity, i.e. \c nut, based on velocity, i.e. \c U, for low- and
velocity, \c U. high-Reynolds number turbulence models.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
......
...@@ -35,6 +35,8 @@ Description ...@@ -35,6 +35,8 @@ Description
boundary conditions which provide a wall constraint on various fields, such boundary conditions which provide a wall constraint on various fields, such
as turbulent viscosity, i.e. \c nut, or turbulent kinetic energy dissipation as turbulent viscosity, i.e. \c nut, or turbulent kinetic energy dissipation
rate, i.e. \c epsilon, for low- and high-Reynolds number turbulence models. rate, i.e. \c epsilon, for low- and high-Reynolds number turbulence models.
The class is not an executable itself, yet a provider for common entries
to its derived boundary conditions.
Reference: Reference:
\verbatim \verbatim
...@@ -72,6 +74,7 @@ Usage ...@@ -72,6 +74,7 @@ Usage
E 9.8; E 9.8;
blending stepwise; blending stepwise;
n 4.0; n 4.0;
U U;
// Optional (inherited) entries // Optional (inherited) entries
... ...
...@@ -86,6 +89,7 @@ Usage ...@@ -86,6 +89,7 @@ Usage
E | Wall roughness parameter | scalar | no | 9.8 E | Wall roughness parameter | scalar | no | 9.8
blending | Viscous/inertial sublayer blending | word | no | stepwise blending | Viscous/inertial sublayer blending | word | no | stepwise
n | Binomial blending exponent | scalar | no | 2.0 n | Binomial blending exponent | scalar | no | 2.0
U | Name of the velocity field | word | no | U
\endtable \endtable
The inherited entries are elaborated in: The inherited entries are elaborated in:
...@@ -151,11 +155,8 @@ Usage ...@@ -151,11 +155,8 @@ Usage
\Gamma | \f$0.01 (y^+)^4 / (1.0 + 5.0 y^+)\f$ \Gamma | \f$0.01 (y^+)^4 / (1.0 + 5.0 y^+)\f$
\endvartable \endvartable
Note
- \c nutWallFunction is not directly usable.
See also See also
Foam::fixedValueFvPatchField - Foam::fixedValueFvPatchField
SourceFiles SourceFiles
nutWallFunctionFvPatchScalarField.C nutWallFunctionFvPatchScalarField.C
......
...@@ -32,9 +32,10 @@ Group ...@@ -32,9 +32,10 @@ Group
Description Description
This boundary condition provides a wall constraint on the turbulent This boundary condition provides a wall constraint on the turbulent
kinematic viscosity, i.e. \c nut, when using wall functions for rough walls, viscosity, i.e. \c nut, when using wall functions for rough walls,
based on the turbulent kinetic energy, \c k. The condition manipulates the based on the turbulent kinetic energy, i.e. \c k. The condition
wall roughness parameter, i.e. \c E, to account for roughness effects. manipulates the wall roughness parameter, i.e. \c E, to account
for roughness effects.
Parameter ranges: Parameter ranges:
- roughness height = sand-grain roughness (0 for smooth walls) - roughness height = sand-grain roughness (0 for smooth walls)
...@@ -105,7 +106,7 @@ protected: ...@@ -105,7 +106,7 @@ protected:
//- Compute the roughness function //- Compute the roughness function
virtual scalar fnRough(const scalar KsPlus, const scalar Cs) const; virtual scalar fnRough(const scalar KsPlus, const scalar Cs) const;
//- Calculate the turbulence viscosity //- Calculate the turbulent viscosity
virtual tmp<scalarField> calcNut() const; virtual tmp<scalarField> calcNut() const;
......
...@@ -32,8 +32,8 @@ Group ...@@ -32,8 +32,8 @@ Group
Description Description
This boundary condition provides a wall constraint on the turbulent This boundary condition provides a wall constraint on the turbulent
viscosity, i.e. \c nut, when using wall functions, viscosity, i.e. \c nut, based on the turbulent kinetic energy,
based on the turbulent kinetic energy, \c k. i.e. \c k, for for low- and high-Reynolds number turbulence models.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
......
...@@ -80,11 +80,10 @@ Usage ...@@ -80,11 +80,10 @@ Usage
\table \table
Property | Description | Type | Req'd | Dflt Property | Description | Type | Req'd | Dflt
type | Type name: omegaWallFunction | word | yes | - type | Type name: omegaWallFunction | word | yes | -
blended | Blending switch (Deprecated) | bool | no | true
beta1 | Model coefficient | scalar | no | 0.075 beta1 | Model coefficient | scalar | no | 0.075
blending | Viscous/inertial sublayer blending method <!-- blending | Viscous/inertial sublayer blending method <!--
--> | word | no | binomial2 --> | word | no | binomial2
n | Binomial blending exponent | sclar | no | 2.0 n | Binomial blending exponent | scalar | no | 2.0
\endtable \endtable
The inherited entries are elaborated in: The inherited entries are elaborated in:
...@@ -185,10 +184,10 @@ Note ...@@ -185,10 +184,10 @@ Note
the specified \c nutWallFunction in order to ensure that each patch the specified \c nutWallFunction in order to ensure that each patch
possesses the same set of values for these coefficients. possesses the same set of values for these coefficients.
- The reason why \c binomial2 and \c binomial blending methods exist at - The reason why \c binomial2 and \c binomial blending methods exist at
the same time is to ensure the elementwise backward compatibility with the same time is to ensure the bitwise regression with the previous
the previous versions since \c binomial2 and \c binomial with n=2 will versions since \c binomial2 and \c binomial with \c n=2 will yield
yield slightly different output due to the miniscule differences in the slightly different output due to the miniscule differences in the
implementation of the basic functions (i.e. pow, sqrt, sqr). implementation of the basic functions (i.e. \c pow, \c sqrt, \c sqr).
See also See also
- Foam::epsilonWallFunctionFvPatchScalarField - Foam::epsilonWallFunctionFvPatchScalarField
...@@ -218,8 +217,6 @@ class omegaWallFunctionFvPatchScalarField ...@@ -218,8 +217,6 @@ class omegaWallFunctionFvPatchScalarField
: :
public fixedValueFvPatchField<scalar> public fixedValueFvPatchField<scalar>
{ {
private:
// Private Enumerations // Private Enumerations
//- Options for the blending treatment of viscous and inertial sublayers //- Options for the blending treatment of viscous and inertial sublayers
......
...@@ -31,7 +31,7 @@ Group ...@@ -31,7 +31,7 @@ Group
grpRASBoundaryConditions grpInletBoundaryConditions grpRASBoundaryConditions grpInletBoundaryConditions
Description Description
Base class to set log-law type ground-normal inflow boundary conditions for Base class to set log-law type ground-normal inlet boundary conditions for
wind velocity and turbulence quantities for homogeneous, two-dimensional, wind velocity and turbulence quantities for homogeneous, two-dimensional,
dry-air, equilibrium and neutral atmospheric boundary layer (ABL) modelling. dry-air, equilibrium and neutral atmospheric boundary layer (ABL) modelling.
...@@ -85,15 +85,6 @@ Description ...@@ -85,15 +85,6 @@ Description
C_2 | Curve-fitting coefficient for \c YGCJ profiles [-] C_2 | Curve-fitting coefficient for \c YGCJ profiles [-]
\endvartable \endvartable
Note
- The \c RH expressions are special cases of those in \c YGCJ when \c C1=0
and \c C2=1. Both \c C1 and \c C2 can be determined by nonlinear fitting
of (\c YGCJ:Eq. 19) with an experimental dataset for \c k. By default,
\c atmBoundaryLayerInlet boundary conditions compute \c RH expressions.
- \c z is the ground-normal height relative to the global minimum height
of the inlet patch; therefore, the minimum of \c z is always zero
irrespective of the absolute z-coordinate of the computational patch.
Reference: Reference:
\verbatim \verbatim
The ground-normal profile expressions (tag:RH): The ground-normal profile expressions (tag:RH):
...@@ -135,6 +126,35 @@ Note ...@@ -135,6 +126,35 @@ Note
\endverbatim \endverbatim
Usage Usage
Example of the entries provided for the inherited boundary conditions:
\verbatim
inlet
{
// Mandatory and other optional entries
...
// Mandatory (inherited) entries (runtime modifiable)
flowDir (1 0 0);
zDir (0 0 1);
Uref 10.0;
Zref 0.0;
z0 uniform 0.1;
d uniform 0.0;
// Optional (inherited) entries (unmodifiable)
kappa 0.41;
Cmu 0.09;
initABL true;
phi phi;
C1 0.0;
C2 1.0;
// Conditional mandatory (inherited) entries (runtime modifiable)
value uniform 0; // when initABL=false
}
\endverbatim
where the entries mean:
\table \table
Property | Description | Type | Req'd | Deflt Property | Description | Type | Req'd | Deflt
flowDir | Flow direction | TimeFunction1<vector> | yes | - flowDir | Flow direction | TimeFunction1<vector> | yes | -
...@@ -160,6 +180,13 @@ Usage ...@@ -160,6 +180,13 @@ Usage
\endtable \endtable
Note Note
- The \c RH expressions are special cases of those in \c YGCJ when \c C1=0
and \c C2=1. Both \c C1 and \c C2 can be determined by nonlinear fitting
of (\c YGCJ:Eqs. 19-20) with an experimental dataset for \c k. By default,
\c atmBoundaryLayerInlet boundary conditions compute \c RH expressions.
- \c z is the ground-normal height relative to the global minimum height
of the inlet patch; therefore, the minimum of \c z is always zero
irrespective of the absolute z-coordinate of the computational patch.
- The derived ABL expressions automatically satisfy the simplified transport - The derived ABL expressions automatically satisfy the simplified transport
equation for \c k. Yet the same expressions only satisfy the simplified equation for \c k. Yet the same expressions only satisfy the simplified
transport equation for \c epsilon when the model constants \c sigmaEpsilon transport equation for \c epsilon when the model constants \c sigmaEpsilon
...@@ -176,11 +203,10 @@ Note ...@@ -176,11 +203,10 @@ Note
with obstacles such as trees or buildings" (E:p. 28). with obstacles such as trees or buildings" (E:p. 28).
See also See also
- Foam::atmBoundaryLayer::atmBoundaryLayerInletVelocityFvPatchVectorField - Foam::atmBoundaryLayerInletVelocityFvPatchVectorField
- Foam::atmBoundaryLayer::atmBoundaryLayerInletKFvPatchScalarField - Foam::atmBoundaryLayerInletKFvPatchScalarField
- Foam::atmBoundaryLayer::atmBoundaryLayerInletEpsilonFvPatchScalarField - Foam::atmBoundaryLayerInletEpsilonFvPatchScalarField
- Foam::atmBoundaryLayer::atmBoundaryLayerInletOmegaFvPatchScalarField - Foam::atmBoundaryLayerInletOmegaFvPatchScalarField
- ExtendedCodeGuide::atmBoundaryLayer
SourceFiles SourceFiles
atmBoundaryLayer.C atmBoundaryLayer.C
......
...@@ -31,10 +31,10 @@ Group ...@@ -31,10 +31,10 @@ Group
grpRASBoundaryConditions grpInletBoundaryConditions grpRASBoundaryConditions grpInletBoundaryConditions
Description Description
This boundary condition provides a log-law type ground-normal inflow This boundary condition provides a log-law type ground-normal inlet
boundary condition for turbulent kinetic energy dissipation rate, i.e.