STYLE: Corrected GPL text

This commit is contained in:
andy
2012-07-12 17:08:00 +01:00
parent b19eedd095
commit 3eddf5d904
2 changed files with 90 additions and 59 deletions

View File

@ -8,10 +8,10 @@
License License
This file is part of OpenFOAM. This file is part of OpenFOAM.
OpenFOAM is free software; you can redistribute it and/or modify it OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the under the terms of the GNU General Public License as published by
Free Software Foundation; either version 3 of the License, or (at your the Free Software Foundation, either version 3 of the License, or
option) any later version. (at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
@ -19,11 +19,12 @@ License
for more details. for more details.
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation, along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class Class
atmBoundaryLayerInletEpsilonFvPatchScalarField Foam::incompressible::atmBoundaryLayerInletEpsilonFvPatchScalarField
\ingroup grpIcoRASBoundaryConditions grpInletBoundaryConditions
Description Description
This boundary condition specifies an inlet value for the turbulence This boundary condition specifies an inlet value for the turbulence
@ -32,40 +33,54 @@ Description
velocity boundary condition. velocity boundary condition.
\f[ \f[
epsilon = Ustar^3 / (K(z - zGround + z0)) epsilon = (U^*)^3 / (K(z - z_g + z_0))
\f] \f]
where: where
/vartable
\var Ustar = frictional velocity U^* | frictional velocity
\var K = Karman's constant K | Karman's constant
\var z = vertical co-ordinate [m] z | vertical co-ordinate [m]
\var z0 = surface roughness length [m] z_0 | surface roughness length [m]
\var zGround = minimum vlaue in z direction [m] z_g | minimum vlaue in z direction [m]
/endvartable
and: and:
\f[ \f[
Ustar = K Uref/ln((Zref + z0)/z0) U^* = K \frac{U_{ref}}{ln(\frac{Z_{ref} + z_0}{z_0}}
\f] \f]
where: where:
/vartable
U_{ref} | reference velocity at \f$Z_{ref}\f$ [m/s]
Z_{ref} | reference height [m]
/endvartable
\var Uref = reference velocity at Zref [m/s] /heading Patch usage
\var Zref = reference height [m]
/table
Property | Description | Required | Default value
z | vertical co-ordinate [m] | yes |
kappa | Karman's constanat | no | 0.41
Uref | reference velocity [m/s] | yes |
Href | reference height [m] | yes |
z0 | surface roughness length [m] | yes |
zGround | minimum z co-ordinate [m] | yes |
/endtable
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch myPatch
{ {
type atmBoundaryLayerInletEpsilon; type atmBoundaryLayerInletVelocity;
z 1.0; // vertical co-ordinate [m] z 1.0;
kappa 0.41; // kappa coefficient (default = 0.41) kappa 0.41;
Uref 1.0; // reference velocity [m/s] Uref 1.0;
Href 0.0; // reference height [m] Href 0.0;
z0 uniform 0.0; // surface roughness length [m] z0 uniform 0.0;
zGround uniform 0.0; // minimum z co-ordinate [m] zGround uniform 0.0;
} }
\endverbatim \endverbatim
Reference: Reference:

View File

@ -8,10 +8,10 @@
License License
This file is part of OpenFOAM. This file is part of OpenFOAM.
OpenFOAM is free software; you can redistribute it and/or modify it OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the under the terms of the GNU General Public License as published by
Free Software Foundation; either version 3 of the License, or (at your the Free Software Foundation, either version 3 of the License, or
option) any later version. (at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
@ -19,11 +19,12 @@ License
for more details. for more details.
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation, along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class Class
atmBoundaryLayerInletVelocityFvPatchVectorField Foam::incompressible::atmBoundaryLayerInletVelocityFvPatchVectorField
\ingroup grpIcoRASBoundaryConditions grpInletBoundaryConditions
Description Description
This boundary condition specifies a velocity inlet profile appropriate This boundary condition specifies a velocity inlet profile appropriate
@ -32,27 +33,29 @@ Description
co-ordinate \c z. co-ordinate \c z.
\f[ \f[
U = (Ustar/K) ln((z - zGround + z0)/z0) U = \frac{U^*}{K} ln(\frac{z - z_g + z_0}{z_0})
\f] \f]
where: where
/vartable
\var Ustar = frictional velocity U^* | frictional velocity
\var K = Karman's constant K | Karman's constant
\var z = vertical co-ordinate [m] z | vertical co-ordinate [m]
\var z0 = surface roughness length [m] z_0 | surface roughness length [m]
\var zGround = minimum vlaue in z direction [m] z_g | minimum vlaue in z direction [m]
/endvartable
and: and:
\f[ \f[
Ustar = K Uref/ln((Zref + z0)/z0) U^* = K \frac{U_{ref}}{ln(\frac{Z_{ref} + z_0}{z_0})}
\f] \f]
where: where:
/vartable
\var Uref = reference velocity at Zref [m/s] U_{ref} | reference velocity at \f$Z_{ref}\f$ [m/s]
\var Zref = reference height [m] Z_{ref} | reference height [m]
/endvartable
Reference: Reference:
D.M. Hargreaves and N.G. Wright, "On the use of the k-epsilon model D.M. Hargreaves and N.G. Wright, "On the use of the k-epsilon model
@ -66,19 +69,32 @@ Description
The roughness height (Er) is given by Er = 20 z0 following the same The roughness height (Er) is given by Er = 20 z0 following the same
reference. reference.
/heading Patch usage
/table
Property | Description | Required | Default value
n | flow direction | yes |
z | vertical co-ordinate [m] | yes |
kappa | Karman's constanat | no | 0.41
Uref | reference velocity [m/s] | yes |
Href | reference height [m] | yes |
z0 | surface roughness length [m] | yes |
zGround | minimum z co-ordinate [m] | yes |
/endtable
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch myPatch
{ {
type atmBoundaryLayerInletVelocity; type atmBoundaryLayerInletVelocity;
n (0 1 0); // flow direction n (0 1 0);
z 1.0; // vertical co-ordinate [m] z 1.0;
kappa 0.41; // kappa coefficient (default = 0.41) kappa 0.41;
Uref 1.0; // reference velocity [m/s] Uref 1.0;
Href 0.0; // reference height [m] Href 0.0;
z0 uniform 0.0; // surface roughness length [m] z0 uniform 0.0;
zGround uniform 0.0; // minimum z co-ordinate [m] zGround uniform 0.0;
} }
\endverbatim \endverbatim
SourceFiles SourceFiles