src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutSpalartAllmarasStandardRoughWallFunction/nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 2 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     Foam::incompressible::RASModels::
  27     nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField
  28
  29 Description
  30     Wall function boundary condition for rough walls
  31
  32 SourceFiles
  33     nutSpalartAllmarasStandardWallFunctionFvPatchScalarField.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField_H
  38 #define nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField_H
  39
  40 #include "nutWallFunctionFvPatchScalarField.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46 namespace incompressible
  47 {
  48 namespace RASModels
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52 Class nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField
  56 :
  57     public nutWallFunctionFvPatchScalarField
  58 {
  59     // Private data
  60
  61         // Roughness model parameters
  62
  63             //- Height
  64             scalar roughnessHeight_;
  65
  66             //- Constant
  67             scalar roughnessConstant_;
  68
  69             //- Scale factor
  70             scalar roughnessFudgeFactor_;
  71
  72
  73     // Protected member functions
  74
  75         //- Calculate yPLus
  76         virtual tmp<scalarField> calcYPlus(const scalarField& magUp) const;
  77
  78         //- Calculate the turbulence viscosity
  79         virtual tmp<scalarField> calcNut() const;
  80
  81
  82 public:
  83
  84     //- Runtime type information
  85     TypeName("nutSpalartAllmarasStandardRoughWallFunction");
  86
  87
  88     // Constructors
  89
  90         //- Construct from patch and internal field
  91         nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField
  92         (
  93             const fvPatch&,
  94             const DimensionedField<scalar, volMesh>&
  95         );
  96
  97         //- Construct from patch, internal field and dictionary
  98         nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField
  99         (
 100             const fvPatch&,
 101             const DimensionedField<scalar, volMesh>&,
 102             const dictionary&
 103         );
 104
 105         //- Construct by mapping given
 106         //  nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField
 107         //  onto a new patch
 108         nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField
 109         (
 110             const nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField&,
 111             const fvPatch&,
 112             const DimensionedField<scalar, volMesh>&,
 113             const fvPatchFieldMapper&
 114         );
 115
 116         //- Construct as copy
 117         nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField
 118         (
 119             const nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField&
 120         );
 121
 122         //- Construct and return a clone
 123         virtual tmp<fvPatchScalarField> clone() const
 124         {
 125             return tmp<fvPatchScalarField>
 126             (
 127                 new nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField
 128                 (
 129                     *this
 130                 )
 131             );
 132         }
 133
 134         //- Construct as copy setting internal field reference
 135         nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField
 136         (
 137             const nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField&,
 138             const DimensionedField<scalar, volMesh>&
 139         );
 140
 141         //- Construct and return a clone setting internal field reference
 142         virtual tmp<fvPatchScalarField> clone
 143         (
 144             const DimensionedField<scalar, volMesh>& iF
 145         ) const
 146         {
 147             return tmp<fvPatchScalarField>
 148             (
 149                 new nutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField
 150                 (
 151                     *this,
 152                     iF
 153                 )
 154             );
 155         }
 156
 157
 158     // Member functions
 159
 160         // Access
 161
 162             //- Return the roughness height
 163             const scalar& roughnessHeight() const
 164             {
 165                 return roughnessHeight_;
 166             }
 167
 168             //- Return reference to the roughness height to allow adjustment
 169             scalar& roughnessHeight()
 170             {
 171                 return roughnessHeight_;
 172             }
 173
 174
 175             //- Return the roughness constant scale
 176             const scalar& roughnessConstant() const
 177             {
 178                 return roughnessConstant_;
 179             }
 180
 181             //- Return reference to the roughness constant to allow adjustment
 182             scalar& roughnessConstant()
 183             {
 184                 return roughnessConstant_;
 185             }
 186
 187             //- Return the roughness scale factor
 188             const scalar& roughnessFudgeFactor() const
 189             {
 190                 return roughnessFudgeFactor_;
 191             }
 192
 193             //- Return reference to the roughness scale factor to allow
 194             //  adjustment
 195             scalar& roughnessFudgeFactor()
 196             {
 197                 return roughnessFudgeFactor_;
 198             }
 199
 200
 201     // I-O
 202
 203         // Evaluation functions
 204
 205             //- Calculate and return the yPlus at the boundary
 206             virtual tmp<scalarField> yPlus() const;
 207
 208
 209         // I-O
 210
 211             //- Write
 212             virtual void write(Ostream& os) const;
 213 };
 214
 215
 216 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 217
 218 } // End namespace RASModels
 219 } // End namespace incompressible
 220 } // End namespace Foam
 221
 222 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 223
 224 #endif
 225
 226 // ************************************************************************* //