mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ENH: Boundary condition doxygen documentation updates
This commit is contained in:
andy
@ -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
|
||||
@ -25,7 +25,18 @@ Class
|
||||
Foam::calculatedFvPatchField
|
||||
|
||||
Description
|
||||
Foam::calculatedFvPatchField
|
||||
This boundary condition is not designed to be evaluated; it is assmued
|
||||
that the value is assigned via field assignment, and not via a call to
|
||||
e.g. \c updateCoeffs or \c evaluate.
|
||||
|
||||
Example of the boundary condition specification:
|
||||
\verbatim
|
||||
myPatch
|
||||
{
|
||||
type calculated;
|
||||
value uniform (0 0 0); // optional value entry
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
calculatedFvPatchField.C
|
||||
@ -43,7 +54,7 @@ namespace Foam
|
||||
{
|
||||
|
||||
/*---------------------------------------------------------------------------*\
|
||||
Class calculatedFvPatch Declaration
|
||||
Class calculatedFvPatchField Declaration
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
template<class Type>
|
||||
|
||||
@ -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
|
||||
@ -25,10 +25,41 @@ Class
|
||||
Foam::buoyantPressureFvPatchScalarField
|
||||
|
||||
Description
|
||||
Set the pressure gradient boundary condition appropriately for buoyant flow.
|
||||
This boundary condition sets the pressure gradient appropriately for
|
||||
buoyant flow.
|
||||
|
||||
If the variable name is "pd" assume it is p - rho*g.h and set the gradient
|
||||
appropriately. Otherwise assume the variable is the static pressure.
|
||||
If the variable name is one of:
|
||||
\li pd
|
||||
\li p_rgh
|
||||
\li ph_rgh
|
||||
we assume that the pressure variable is \f$ p - rho*g.h\f$ and the gradient
|
||||
set using:
|
||||
\f[
|
||||
grad(pressure) = -snGrad(rho)*(g.h)
|
||||
\f]
|
||||
where
|
||||
\var snGrad = surface-normal gradient operator
|
||||
\var rho = density [kg/m3]
|
||||
\var g = acceleration due to gravity [m/s2]
|
||||
\var h = patch face centres [m]
|
||||
|
||||
Otherwise we assume that it is the static pressure, and the gradient
|
||||
calculated using:
|
||||
\f[
|
||||
grad(pressure) = rho*(g.n)
|
||||
\f]
|
||||
where
|
||||
\var n = patch face normal vectors
|
||||
|
||||
Example of the boundary condition specification:
|
||||
\verbatim
|
||||
myPatch
|
||||
{
|
||||
type buoyantPressure;
|
||||
rho rho; // optional density field name (default = rho)
|
||||
value uniform 0;
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
buoyantPressureFvPatchScalarField.C
|
||||
|
||||
@ -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
|
||||
@ -25,8 +25,23 @@ Class
|
||||
Foam::compressible::RASModels::alphatFilmWallFunctionFvPatchScalarField
|
||||
|
||||
Description
|
||||
Turbulent thermal diffusivity boundary conditions for use with surface
|
||||
film models.
|
||||
Turbulent thermal diffusivity boundary condition for use with surface
|
||||
film models. This condition varies from the standard wall function by
|
||||
taking into account any mass released from the film model.
|
||||
|
||||
Example of the boundary condition specification:
|
||||
\verbatim
|
||||
myPatch
|
||||
{
|
||||
type alphatFilmWallFunction;
|
||||
B 5.5; // B coefficient (default = 5.5)
|
||||
yPlusCrit 11.05; // critical y+ (default = 11.05)
|
||||
Cmu 0.09; // Cmu coefficient (default = 0.09)
|
||||
kappa 0.41; // kappa coefficient (default = 0.41)
|
||||
Prt 0.85; // turbulent Prandtl number (default = 0.85)
|
||||
value uniform 0; // optional value entry
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
alphatFilmWallFunctionFvPatchScalarField.C
|
||||
|
||||
@ -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
|
||||
@ -27,8 +27,25 @@ Class
|
||||
Description
|
||||
Boundary condition for turbulent thermal diffusivity when using wall
|
||||
functions
|
||||
- replicates OpenFOAM v1.5 (and earlier) behaviour
|
||||
- Turbulent Prandtl number defaults to 0.85 if unspecified
|
||||
|
||||
\li replicates OpenFOAM v1.5 (and earlier) behaviour
|
||||
|
||||
Turbulent thermal diffusivity calculated using:
|
||||
|
||||
\f[
|
||||
alphat = mut/Prt
|
||||
\f]
|
||||
|
||||
Example of the boundary condition specification:
|
||||
\verbatim
|
||||
myPatch
|
||||
{
|
||||
type alphatWallFunction;
|
||||
mut mut; // turbulent viscosity field (default = mut)
|
||||
Prt 0.85; // turbulent Prandtl number (default = 085)
|
||||
value uniform 0; // optional value entry
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
alphatWallFunctionFvPatchScalarField.C
|
||||
@ -59,10 +76,10 @@ class alphatWallFunctionFvPatchScalarField
|
||||
{
|
||||
// Private data
|
||||
|
||||
//- Name of turbulent viscosity field
|
||||
//- Name of turbulent viscosity field (default = mut)
|
||||
word mutName_;
|
||||
|
||||
//- Turbulent Prandtl number
|
||||
//- Turbulent Prandtl number (default = 0.85)
|
||||
scalar Prt_;
|
||||
|
||||
|
||||
|
||||
@ -26,38 +26,53 @@ Class
|
||||
atmBoundaryLayerInletEpsilonFvPatchScalarField
|
||||
|
||||
Description
|
||||
Boundary condition specifies a epsilon inlet for the atmospheric boundary
|
||||
layer (ABL). This boundaty is to be used in conjunction with
|
||||
ABLInletVelocity.
|
||||
This boundary condition specifies an inlet value for the turbulence
|
||||
dissipation \c epsilon, appropriate for atmospheric boundary layers (ABL),
|
||||
and designed to be used in conjunction with the \c ABLInletVelocity inlet
|
||||
velocity boundary condition.
|
||||
|
||||
\verbatim
|
||||
epsilon = Ustar^3 / (K(z - zGround + z0))
|
||||
\f[
|
||||
epsilon = Ustar^3 / (K(z - zGround + z0))
|
||||
\f]
|
||||
|
||||
where:
|
||||
|
||||
Ustar is the frictional velocity
|
||||
K is karman's constant
|
||||
z is the verical coordinate
|
||||
z0 is the surface roughness lenght
|
||||
zGround minium vlaue in z direction
|
||||
|
||||
\var Ustar = frictional velocity
|
||||
\var K = Karman's constant
|
||||
\var z = vertical co-ordinate [m]
|
||||
\var z0 = surface roughness length [m]
|
||||
\var zGround = minimum vlaue in z direction [m]
|
||||
|
||||
and:
|
||||
|
||||
Ustar = K Uref/ln((Zref + z0)/z0)
|
||||
\f[
|
||||
Ustar = K Uref/ln((Zref + z0)/z0)
|
||||
\f]
|
||||
|
||||
where:
|
||||
|
||||
Uref is the reference velocity at Zref
|
||||
Zref is the reference height.
|
||||
\var Uref = reference velocity at Zref [m/s]
|
||||
\var Zref = reference height [m]
|
||||
|
||||
Example of the boundary condition specification:
|
||||
\verbatim
|
||||
myPatch
|
||||
{
|
||||
type atmBoundaryLayerInletEpsilon;
|
||||
z 1.0; // vertical co-ordinate [m]
|
||||
kappa 0.41; // kappa coefficient (default = 0.41)
|
||||
Uref 1.0; // reference velocity [m/s]
|
||||
Href 0.0; // reference height [m]
|
||||
z0 uniform 0.0; // surface roughness length [m]
|
||||
zGround uniform 0.0; // minimum z co-ordinate [m]
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Reference:
|
||||
D.M. Hargreaves and N.G. Wright
|
||||
"On the use of the k-epsilon model in commercial CFD software to model the
|
||||
neutral atmospheric boundary layer"
|
||||
Journal of Wind Engineering and Industrial Aerodynamics 95(2007) 355-369.
|
||||
D.M. Hargreaves and N.G. Wright, "On the use of the k-epsilon model
|
||||
in commercial CFD software to model the neutral atmospheric boundary
|
||||
layer", Journal of Wind Engineering and Industrial Aerodynamics
|
||||
95(2007), pp 355-369.
|
||||
|
||||
SourceFiles
|
||||
atmBoundaryLayerInletEpsilonFvPatchScalarField.C
|
||||
@ -96,13 +111,13 @@ class atmBoundaryLayerInletEpsilonFvPatchScalarField
|
||||
//- Reference velocity
|
||||
const scalar Uref_;
|
||||
|
||||
//- Reference hight
|
||||
//- Reference height
|
||||
const scalar Href_;
|
||||
|
||||
//- Surface roughness length
|
||||
scalarField z0_;
|
||||
|
||||
//- Minimum corrdinate value in z direction
|
||||
//- Minimum co-ordinate value in z direction
|
||||
scalarField zGround_;
|
||||
|
||||
//- Frictional velocity
|
||||
|
||||
@ -26,42 +26,60 @@ Class
|
||||
atmBoundaryLayerInletVelocityFvPatchVectorField
|
||||
|
||||
Description
|
||||
Boundary condition specifies a atmospheric boundary layer (ABL)
|
||||
velocity inlet profile given the friction velocity value,
|
||||
flow direction n and direction of the parabolic coordinate z.
|
||||
This boundary condition specifies a velocity inlet profile appropriate
|
||||
for atmospheric boundary layers (ABL). The profile is derived from the
|
||||
friction velocity, flow direction and the direction of the parabolic
|
||||
co-ordinate \c z.
|
||||
|
||||
\verbatim
|
||||
U = (Ustar/K) ln((z - zGround + z0)/z0)
|
||||
\f[
|
||||
U = (Ustar/K) ln((z - zGround + z0)/z0)
|
||||
\f]
|
||||
|
||||
where:
|
||||
|
||||
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.
|
||||
\var Ustar = frictional velocity
|
||||
\var K = Karman's constant
|
||||
\var z = vertical co-ordinate [m]
|
||||
\var z0 = surface roughness length [m]
|
||||
\var zGround = minimum vlaue in z direction [m]
|
||||
|
||||
and:
|
||||
|
||||
Ustar = K Uref/ln((Zref + z0)/z0)
|
||||
\f[
|
||||
Ustar = K Uref/ln((Zref + z0)/z0)
|
||||
\f]
|
||||
|
||||
where:
|
||||
|
||||
Uref is the reference velocity at Zref
|
||||
Zref is the reference height.
|
||||
|
||||
\endverbatim
|
||||
\var Uref = reference velocity at Zref [m/s]
|
||||
\var Zref = reference height [m]
|
||||
|
||||
Reference:
|
||||
D.M. Hargreaves and N.G. Wright
|
||||
"On the use of the k-epsilon model in commercial CFD software to model the
|
||||
neutral atmospheric boundary layer"
|
||||
Journal of Wind Engineering and Industrial Aerodynamics 95(2007) 355-369.
|
||||
D.M. Hargreaves and N.G. Wright, "On the use of the k-epsilon model
|
||||
in commercial CFD software to model the neutral atmospheric boundary
|
||||
layer", Journal of Wind Engineering and Industrial Aerodynamics
|
||||
95(2007), pp 355-369.
|
||||
|
||||
NOTE: D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the k-epsilon
|
||||
model should be changed from 1.3 to 1.11 for consistency.
|
||||
The roughness height (Er) is given by Er = 20 z0 following the same
|
||||
reference
|
||||
\note
|
||||
D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the
|
||||
k-epsilon model should be changed from 1.3 to 1.11 for consistency.
|
||||
The roughness height (Er) is given by Er = 20 z0 following the same
|
||||
reference.
|
||||
|
||||
Example of the boundary condition specification:
|
||||
\verbatim
|
||||
myPatch
|
||||
{
|
||||
type atmBoundaryLayerInletVelocity;
|
||||
n (0 1 0); // flow direction
|
||||
z 1.0; // vertical co-ordinate [m]
|
||||
kappa 0.41; // kappa coefficient (default = 0.41)
|
||||
Uref 1.0; // reference velocity [m/s]
|
||||
Href 0.0; // reference height [m]
|
||||
z0 uniform 0.0; // surface roughness length [m]
|
||||
zGround uniform 0.0; // minimum z co-ordinate [m]
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
SourceFiles
|
||||
atmBoundaryLayerInletVelocityFvPatchVectorField.C
|
||||
|
||||
Reference in New Issue
Block a user