ENH: Boundary condition doxygen documentation updates - incompressible wall functions

This commit is contained in:
andy
2012-07-11 11:44:06 +01:00
parent 55b87980c2
commit 7f84940b5c
14 changed files with 350 additions and 61 deletions

View File

@ -21,6 +21,9 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions
@{
Class
Foam::incompressible::RASModels::epsilonWallFunctionFvPatchScalarField
@ -29,29 +32,43 @@ Description
condition for high Reynolds number, turbulent flow cases.
The condition can be applied to wall boundaries, whereby it
\li calculates \c epsilon and \c G
\li inserts near wall epsilon values directly into the epsilon equation
- calculates \c epsilon and \c G
- inserts near wall epsilon values directly into the epsilon equation
to act as a constraint
where
\var epsilon = turblence dissipation field
\var G = turblence generation field
/vartable
epsilon | turblence dissipation field
G | turblence generation field
/endvartable
/heading Patch usage
/table
Property | Description | Required | Default value
G | turbulence generation field name | no | G
Cmu | model coefficient | no | 0.09
kappa | Von Karman constant | no | 0.41
E | model coefficient | no | 9.8
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type epsilonWallFunction;
G G; // turblence generation field (default = G)
Cmu 0.09; // Cmu model coefficient (default = 0.09)
kappa 0.41; // Von Karman constant (default = 0.41)
E 9.8; // E coefficient (default = 9.8)
}
myPatch
{
type epsilonWallFunction;
}
\endverbatim
SeeAlso
Foam::fixedInternalValueFvPatchField
SourceFiles
epsilonWallFunctionFvPatchScalarField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef epsilonWallFunctionFvPatchScalarField_H

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -21,19 +21,46 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions
@{
Class
Foam::incompressible::RASModels::
kappatJayatillekeWallFunctionFvPatchScalarField
Description
Boundary condition for (kinematic) turbulent thermal conductivity when
using wall functions, using Jayatilleke P function.
This boundary condition provides a kinematic turbulent thermal conductivity
for using wall functions, using the Jayatilleke 'P' function.
Units of m2/s
\note
The units of kinematic turbulent thermal conductivity are m2/s
/heading Patch usage
/table
Property | Description | Required | Default value
Prt | turbulent Prandtl number | no | 0.85
Cmu | model coefficient | no | 0.09
kappa | Von Karman constant | no | 0.41
E | model coefficient | no | 9.8
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type kappatJayatillekeWallFunction;
}
\endverbatim
SeeAlso
Foam::fixedValueFvPatchField
SourceFiles
kappatJayatillekeWallFunctionFvPatchScalarField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef kappatJayatillekeWallFunctionFvPatchScalarField_H

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -21,16 +21,34 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions
@{
Class
Foam::incompressible::RASModels::kqRWallFunctionFvPatchField
Description
Boundary condition for turbulence k, Q, and R when using wall functions.
Simply acts as a zero gradient condition.
This boundary condition is applied to turbulence \c k, \c Q, and \c R
when using wall functions, and simply enforces a zer-gradient condition.
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type kqRWallFunction;
}
\endverbatim
SeeAlso
Foam::zeroGradientFvPatchField
SourceFiles
kqRWallFunctionFvPatchField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef kqRWallFunctionFvPatchField_H

View File

@ -21,18 +21,35 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions
@{
Class
Foam::incompressible::RASModels::nutLowReWallFunctionFvPatchScalarField
Description
Boundary condition for turbulent (kinematic) viscosity when for use with
low Reynolds number models.
This boundary condition provides a turbulent kinematic viscosity condition
for use with low Reynolds number models. It sets \c nut to zero, and
provides an access function to calculate y+.
Sets nut to zero, and provides an access function to calculate y+.
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type nutLowReWallFunction;
}
\endverbatim
SeeAlso
Foam::nutWallFunctionFvPatchScalarField
SourceFiles
nutLowReWallFunctionFvPatchScalarField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef nutLowReWallFunctionFvPatchScalarField_H

View File

@ -21,15 +21,44 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions
@{
Class
Foam::incompressible::RASModels::nutURoughWallFunctionFvPatchScalarField
Description
Wall function boundary condition for rough walls, based on velocity.
This boundary condition provides a turbulent kinematic viscosity condition
when using wall functions for rough walls, based on velocity.
/heading Patch usage
/table
Property | Description | Required | Default value
roughnessHeight | roughness height | yes |
roughnessConstant | roughness constanr | yes |
roughnessFactor | scaling factor |
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type nutURoughWallFunction;
roughnessHeight 1e-5;
roughnessConstant 0.5;
roughnessFactor 1;
}
\endverbatim
SeeAlso
Foam::nutWallFunctionFvPatchScalarField
SourceFiles
nutSpalartAllmarasStandardWallFunctionFvPatchScalarField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef nutURoughWallFunctionFvPatchScalarField_H

View File

@ -21,16 +21,35 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions
@{
Class
Foam::incompressible::RASModels::nutUSpaldingWallFunctionFvPatchScalarField
Description
Wall function boundary condition for walls, based on velocity, using
This boundary condition provides a turbulent kinematic viscosity condition
when using wall functions for rough walls, based on velocity, using
Spaldings law to give a continuous nut profile to the wall (y+ = 0)
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type nutUSpaldingWallFunction;
}
\endverbatim
SeeAlso
Foam::nutWallFunctionFvPatchScalarField
SourceFiles
nutUSpaldingWallFunctionFvPatchScalarField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef nutUSpaldingWallFunctionFvPatchScalarField_H
@ -48,7 +67,7 @@ namespace RASModels
{
/*---------------------------------------------------------------------------*\
Class nutUSpaldingWallFunctionFvPatch Declaration
Class nutUSpaldingWallFunctionFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
class nutUSpaldingWallFunctionFvPatchScalarField

View File

@ -21,19 +21,46 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions
@{
Class
Foam::incompressible::RASModels::nutUTabulatedWallFunctionFvPatchScalarField
Description
Wall function boundary condition for turbulence kinematic viscosity. Uses a
table to return the value of U+ as a function of near-wall Reynolds number.
This boundary condition provides a turbulent kinematic viscosity condition
when using wall functions. As input, the user specifies a look-up table
of U+ as a function of near-wall Reynolds number. The table should be
located in the $FOAM_CASE/constant folder.
Note: the tables are not registered since the same table object may be used
for more than one patch.
\note
the tables are not registered since the same table object may be used for
more than one patch.
/heading Patch usage
/table
Property | Description | Required | Default value
uPlusTable | U+ as a function of Re table name | yes |
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type nutTabulatedWallFunction;
uPlusTable myUPlusTable;
}
\endverbatim
SeeAlso
Foam::nutWallFunctionFvPatchScalarField
SourceFiles
nutUTabulatedWallFunctionFvPatchScalarField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef nutUTabulatedWallFunctionFvPatchScalarField_H

View File

@ -21,15 +21,34 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions
@{
Class
Foam::incompressible::RASModels::nutUWallFunctionFvPatchScalarField
Description
Wall function boundary condition for walls, based on velocity.
This boundary condition provides a turbulent kinematic viscosity condition
when using wall functions, based on velocity.
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type nutUWallFunction;
}
\endverbatim
SeeAlso
Foam::nutWallFunctionFvPatchScalarField
SourceFiles
nutUWallFunctionFvPatchScalarField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef nutUWallFunctionFvPatchScalarField_H
@ -47,7 +66,7 @@ namespace RASModels
{
/*---------------------------------------------------------------------------*\
Class nutUWallFunctionFvPatchScalarField Declaration
Class nutUWallFunctionFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
class nutUWallFunctionFvPatchScalarField

View File

@ -21,17 +21,35 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions
@{
Class
Foam::incompressible::RASModels::nutWallFunctionFvPatchScalarField
Description
Boundary condition for turbulent (kinematic) viscosity when using wall
functions, based on turbulence kinetic energy.
This boundary condition provides a turbulent kinematic viscosity condition
when using wall functions, based on turbulence kinetic energy.
- replicates OpenFOAM v1.5 (and earlier) behaviour
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type nutWallFunction;
}
\endverbatim
SeeAlso
Foam::fixedValueFvPatchField
SourceFiles
nutWallFunctionFvPatchScalarField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef nutWallFunctionFvPatchScalarField_H

View File

@ -40,7 +40,6 @@ namespace RASModels
// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
tmp<scalarField> nutkAtmRoughWallFunctionFvPatchScalarField::calcNut() const
{
const label patchI = patch().index();

View File

@ -21,28 +21,56 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions
@{
Class
Foam::incompressible::RASModels::
nutkAtmRoughWallFunctionFvPatchScalarField
Description
Boundary condition for turbulent (kinematic) viscosity for atmospheric
velocity profiles.
Desinged to be used togheter with atmBoundaryLayerInletVelocity.
It follows U = (Ustar/K) ln((z - zGround + z0)/z0)
This boundary condition provides a turbulent kinematic viscosity for
atmospheric velocity profiles. It is desinged to be used in conjunction
with the atmBoundaryLayerInletVelocity boundary condition. The values
are calculated using:
where:
\f[
U = (U_f/K) ln((z + z_0)/z_0)
\f]
Ustar is the frictional velocity
K is karman's constant
z0 is the surface roughness lenght
z is the verical coordinate
zGround is the minumum coordinate value in z direction.
where
/vartable
U_f | frictional velocity
K | Von Karman's constant
z_0 | surface roughness length
z | vertical co-ordinate
/endvartable
/heading Patch usage
/table
Property | Description | Required | Default value
z0 | surface roughness length| yes |
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type nutkAtmRoughWallFunction;
z0 uniform 0;
}
\endverbatim
SeeAlso
Foam::nutkWallFunctionFvPatchField
SourceFiles
nutkAtmRoughWallFunctionFvPatchScalarField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef nutkAtmRoughWallFunctionFvPatchScalarField_H
@ -60,7 +88,7 @@ namespace RASModels
{
/*---------------------------------------------------------------------------*\
Class nutkAtmRoughWallFunctionFvPatchScalarField Declaration
Class nutkAtmRoughWallFunctionFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
class nutkAtmRoughWallFunctionFvPatchScalarField
@ -71,7 +99,7 @@ protected:
// Protected data
//- Surface roughness lenght
//- Surface roughness length
scalarField z0_;

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -21,22 +21,47 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions
@{
Class
Foam::incompressible::RASModels::nutkRoughWallFunctionFvPatchScalarField
Description
Boundary condition for turbulent (kinematic) viscosity when using wall
functions for rough walls, based on turbulence kinetic energy.
Manipulates the E parameter to account for roughness effects, based on
KsPlus.
This boundary condition provides a turbulent kinematic viscosity condition
when using wall functions for rough walls, based on turbulence kinetic
energy. The condition manipulates the E parameter to account for roughness effects.
Parameter ranges
- roughness height = sand-grain roughness (0 for smooth walls)
- roughness constant = 0.5-1.0 (0.5 default)
- roughness constant = 0.5-1.0
/heading Patch usage
/table
Property | Description | Required | Default value
Ks | sand-grain roughness height | yes |
Cs | roughness constant | yes |
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type nutkAtmRoughWallFunction;
Ks uniform 0;
Cs uniform 0.5;
}
\endverbatim
SeeAlso
Foam::nutkRoughWallFunctionFvPatchScalarField
SourceFiles
nutkRoughWallFunctionFvPatchScalarField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef nutkRoughWallFunctionFvPatchScalarField_H

View File

@ -21,17 +21,35 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions
@{
Class
Foam::incompressible::RASModels::nutkWallFunctionFvPatchScalarField
Description
Boundary condition for turbulent (kinematic) viscosity when using wall
functions, based on turbulence kinetic energy.
This boundary condition provides a turbulent kinematic viscosity condition
when using wall functions, based on turbulence kinetic energy.
- replicates OpenFOAM v1.5 (and earlier) behaviour
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type nutkWallFunction;
}
\endverbatim
SeeAlso
Foam::nutWallFunctionFvPatchScalarField
SourceFiles
nutkWallFunctionFvPatchScalarField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef nutkWallFunctionFvPatchScalarField_H

View File

@ -21,19 +21,26 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions
@{
Class
Foam::incompressible::RASModels::omegaWallFunctionFvPatchScalarField
Description
Provides a wall function boundary condition/constraint on omega
This boundary condition provides a wall function constraint on turbulnce
specific dissipation, omega. The values are computed using:
Computed value is:
omega = sqrt(omega_vis^2 + omega_log^2)
\f[
\omega = sqrt(\omega_{vis}^2 + \omega_{log}^2)
\f]
where
omega_vis = omega in viscous region
omega_log = omega in logarithmic region
/vartable
\omega_{vis} | omega in viscous region
\omega_{log} | omega in logarithmic region
/endvartable
Model described by Eq.(15) of:
\verbatim
@ -43,9 +50,30 @@ Description
Nov. 2001
\endverbatim
/heading Patch usage
/table
Property | Description | Required | Default value
G | turbulence generation field name | no | G
Cmu | model coefficient | no | 0.09
kappa | Von Karman constant | no | 0.41
E | model coefficient | no | 9.8
beta1 | model coefficient | no | 0.075
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type omegaWallFunction;
}
\endverbatim
SourceFiles
omegaWallFunctionFvPatchScalarField.C
@}
\*---------------------------------------------------------------------------*/
#ifndef omegaWallFunctionFvPatchScalarField_H