src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutRoughWallFunction/nutRoughWallFunctionFvPatchScalarField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2008-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::nutRoughWallFunctionFvPatchScalarField
  27
  28 Description
  29     Boundary condition for turbulent (kinematic) viscosity when using wall
  30     functions for rough walls.
  31
  32     Manipulates the E parameter to account for roughness effects, based on
  33     KsPlus.
  34
  35     - roughness height = sand-grain roughness (0 for smooth walls)
  36     - roughness constant = 0.5-1.0 (0.5 default)
  37
  38 SourceFiles
  39     nutRoughWallFunctionFvPatchScalarField.C
  40
  41 \*---------------------------------------------------------------------------*/
  42
  43 #ifndef nutRoughWallFunctionFvPatchScalarField_H
  44 #define nutRoughWallFunctionFvPatchScalarField_H
  45
  46 #include <incompressibleRASModels/nutWallFunctionFvPatchScalarField.H>
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52 namespace incompressible
  53 {
  54 namespace RASModels
  55 {
  56
  57 /*---------------------------------------------------------------------------*\
  58            Class nutRoughWallFunctionFvPatchScalarField Declaration
  59 \*---------------------------------------------------------------------------*/
  60
  61 class nutRoughWallFunctionFvPatchScalarField
  62 :
  63     public nutWallFunctionFvPatchScalarField
  64 {
  65 protected:
  66
  67     // Protected data
  68
  69         //- Roughness height
  70         scalarField Ks_;
  71
  72         //- Roughness constant
  73         scalarField Cs_;
  74
  75
  76     // Protected member functions
  77
  78         //- Compute the roughness function
  79         virtual scalar fnRough(const scalar KsPlus, const scalar Cs) const;
  80
  81         //- Calculate the turbulence viscosity
  82         virtual tmp<scalarField> calcNut() const;
  83
  84
  85 public:
  86
  87     //- Runtime type information
  88     TypeName("nutRoughWallFunction");
  89
  90
  91     // Constructors
  92
  93         //- Construct from patch and internal field
  94         nutRoughWallFunctionFvPatchScalarField
  95         (
  96             const fvPatch&,
  97             const DimensionedField<scalar, volMesh>&
  98         );
  99
 100         //- Construct from patch, internal field and dictionary
 101         nutRoughWallFunctionFvPatchScalarField
 102         (
 103             const fvPatch&,
 104             const DimensionedField<scalar, volMesh>&,
 105             const dictionary&
 106         );
 107
 108         //- Construct by mapping given
 109         //  nutRoughWallFunctionFvPatchScalarField
 110         //  onto a new patch
 111         nutRoughWallFunctionFvPatchScalarField
 112         (
 113             const nutRoughWallFunctionFvPatchScalarField&,
 114             const fvPatch&,
 115             const DimensionedField<scalar, volMesh>&,
 116             const fvPatchFieldMapper&
 117         );
 118
 119         //- Construct as copy
 120         nutRoughWallFunctionFvPatchScalarField
 121         (
 122             const nutRoughWallFunctionFvPatchScalarField&
 123         );
 124
 125         //- Construct and return a clone
 126         virtual tmp<fvPatchScalarField> clone() const
 127         {
 128             return tmp<fvPatchScalarField>
 129             (
 130                 new nutRoughWallFunctionFvPatchScalarField(*this)
 131             );
 132         }
 133
 134         //- Construct as copy setting internal field reference
 135         nutRoughWallFunctionFvPatchScalarField
 136         (
 137             const nutRoughWallFunctionFvPatchScalarField&,
 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 nutRoughWallFunctionFvPatchScalarField(*this, iF)
 150             );
 151         }
 152
 153
 154     // Member functions
 155
 156         // Mapping functions
 157
 158             //- Map (and resize as needed) from self given a mapping object
 159             virtual void autoMap(const fvPatchFieldMapper&);
 160
 161             //- Reverse map the given fvPatchField onto this fvPatchField
 162             virtual void rmap
 163             (
 164                 const fvPatchScalarField&,
 165                 const labelList&
 166             );
 167
 168
 169         // I-O
 170
 171             //- Write
 172             virtual void write(Ostream&) const;
 173 };
 174
 175
 176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 177
 178 } // End namespace RASModels
 179 } // End namespace incompressible
 180 } // End namespace Foam
 181
 182 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 183
 184 #endif
 185
 186 // ************************ vim: set sw=4 sts=4 et: ************************ //