src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     atmBoundaryLayerInletVelocityFvPatchVectorField
  27
  28 Description
  29     Boundary condition specifies a atmospheric boundary layer (ABL)
  30     velocity inlet profile given the friction velocity value,
  31     flow direction n and direction of the parabolic coordinate z.
  32
  33     \verbatim
  34         U = (Ustar/K) ln((z - zGround + z0)/z0)
  35
  36     where:
  37
  38         Ustar is the frictional velocity
  39         K is karman's constant
  40         z0 is the surface roughness lenght
  41         z is the verical coordinate
  42         zGround is the minumum coordinate value in z direction.
  43
  44     and:
  45
  46         Ustar = K Uref/ln((Zref + z0)/z0)
  47
  48     where:
  49
  50         Uref is the reference velocity at Zref
  51         Zref is the reference height.
  52
  53     \endverbatim
  54
  55     Reference:
  56     D.M. Hargreaves and N.G. Wright
  57     "On the use of the k-epsilon model in commercial CFD software to model the
  58      neutral atmospheric boundary layer"
  59     Journal of Wind Engineering and Industrial Aerodynamics 95(2007) 355-369.
  60
  61 NOTE: D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the k-epsilon
  62       model should be changed from 1.3 to 1.11 for consistency.
  63       The roughness height (Er) is given by Er = 20 z0 following the same
  64       reference
  65
  66 SourceFiles
  67     atmBoundaryLayerInletVelocityFvPatchVectorField.C
  68
  69 \*---------------------------------------------------------------------------*/
  70
  71 #ifndef atmBoundaryLayerInletVelocityFvPatchVectorField_H
  72 #define atmBoundaryLayerInletVelocityFvPatchVectorField_H
  73
  74 #include "fvPatchFields.H"
  75 #include "fixedValueFvPatchFields.H"
  76
  77
  78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  79
  80 namespace Foam
  81 {
  82 namespace incompressible
  83 {
  84
  85 /*---------------------------------------------------------------------------*\
  86        Class atmBoundaryLayerInletVelocityFvPatchVectorField Declaration
  87 \*---------------------------------------------------------------------------*/
  88
  89 class atmBoundaryLayerInletVelocityFvPatchVectorField
  90 :
  91     public fixedValueFvPatchVectorField
  92 {
  93     // Private data
  94
  95         //- Frictional velocity
  96         scalar Ustar_;
  97
  98         //- Flow direction
  99         vector n_;
 100
 101         //- Direction of the z-coordinate
 102         vector z_;
 103
 104         //- Surface roughness lenght
 105         const scalar z0_;
 106
 107         //- Von Karman constant
 108         const scalar kappa_;
 109
 110         //- Reference velocity
 111         const scalar Uref_;
 112
 113         //- Reference hight
 114         const scalar Href_;
 115
 116         //- Minimum corrdinate value in z direction
 117         scalarField zGround_;
 118
 119
 120 public:
 121
 122     //- Runtime type information
 123     TypeName("atmBoundaryLayerInletVelocity");
 124
 125
 126     // Constructors
 127
 128         //- Construct from patch and internal field
 129         atmBoundaryLayerInletVelocityFvPatchVectorField
 130         (
 131             const fvPatch&,
 132             const DimensionedField<vector, volMesh>&
 133         );
 134
 135         //- Construct from patch, internal field and dictionary
 136         atmBoundaryLayerInletVelocityFvPatchVectorField
 137         (
 138             const fvPatch&,
 139             const DimensionedField<vector, volMesh>&,
 140             const dictionary&
 141         );
 142
 143         //- Construct by mapping given
 144         // atmBoundaryLayerInletVelocityFvPatchVectorField onto a new patch
 145         atmBoundaryLayerInletVelocityFvPatchVectorField
 146         (
 147             const atmBoundaryLayerInletVelocityFvPatchVectorField&,
 148             const fvPatch&,
 149             const DimensionedField<vector, volMesh>&,
 150             const fvPatchFieldMapper&
 151         );
 152
 153         //- Construct and return a clone
 154         virtual tmp<fvPatchVectorField> clone() const
 155         {
 156             return tmp<fvPatchVectorField>
 157             (
 158                 new atmBoundaryLayerInletVelocityFvPatchVectorField(*this)
 159             );
 160         }
 161
 162         //- Construct as copy setting internal field reference
 163         atmBoundaryLayerInletVelocityFvPatchVectorField
 164         (
 165             const atmBoundaryLayerInletVelocityFvPatchVectorField&,
 166             const DimensionedField<vector, volMesh>&
 167         );
 168
 169         //- Construct and return a clone setting internal field reference
 170         virtual tmp<fvPatchVectorField> clone
 171         (
 172             const DimensionedField<vector, volMesh>& iF
 173         ) const
 174         {
 175             return tmp<fvPatchVectorField>
 176             (
 177                 new atmBoundaryLayerInletVelocityFvPatchVectorField(*this, iF)
 178             );
 179         }
 180
 181
 182     // Member functions
 183
 184         //- Return Ustar
 185         scalar& Ustar()
 186         {
 187             return Ustar_;
 188         }
 189
 190         //- Return flow direction
 191         vector& n()
 192         {
 193             return n_;
 194         }
 195
 196         //- Return z direction
 197         vector& z()
 198         {
 199             return z_;
 200         }
 201
 202         //- Update coefficients
 203         virtual void updateCoeffs();
 204
 205         //- Write
 206         virtual void write(Ostream&) const;
 207 };
 208
 209
 210 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 211
 212 } // End namespace incompressible
 213 } // End namespace Foam
 214
 215 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 216
 217 #endif
 218
 219 // ************************************************************************* //