src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::incompressible::RASModels::nutUTabulatedWallFunctionFvPatchScalarField
  26
  27 Description
  28     Wall function boundary condition for turbulence kinematic viscosity. Uses a
  29     table to return the value of U+ as a function of near-wall Reynolds number.
  30
  31     Note: the tables are not registered since the same table object may be used
  32     for more than one patch.
  33
  34 SourceFiles
  35     nutUTabulatedWallFunctionFvPatchScalarField.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef nutUTabulatedWallFunctionFvPatchScalarField_H
  40 #define nutUTabulatedWallFunctionFvPatchScalarField_H
  41
  42 #include "nutkWallFunctionFvPatchScalarField.H"
  43 #include "uniformInterpolationTable.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49 namespace incompressible
  50 {
  51 namespace RASModels
  52 {
  53
  54 /*---------------------------------------------------------------------------*\
  55         Class nutUTabulatedWallFunctionFvPatchScalarField Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 class nutUTabulatedWallFunctionFvPatchScalarField
  59 :
  60     public nutkWallFunctionFvPatchScalarField
  61 {
  62 protected:
  63
  64     // Protected data
  65
  66         //- Name of u+ table
  67         word uPlusTableName_;
  68
  69         //- U+ table
  70         uniformInterpolationTable<scalar> uPlusTable_;
  71
  72
  73     // Protected Member Functions
  74
  75         //- Calculate the turbulence viscosity
  76         virtual tmp<scalarField> calcNut() const;
  77
  78         //- Calculate wall u+ from table
  79         virtual tmp<scalarField> calcUPlus(const scalarField& Rey) const;
  80
  81
  82 public:
  83
  84     //- Runtime type information
  85     TypeName("nutTabulatedWallFunction");
  86
  87
  88     // Constructors
  89
  90         //- Construct from patch and internal field
  91         nutUTabulatedWallFunctionFvPatchScalarField
  92         (
  93             const fvPatch&,
  94             const DimensionedField<scalar, volMesh>&
  95         );
  96
  97         //- Construct from patch, internal field and dictionary
  98         nutUTabulatedWallFunctionFvPatchScalarField
  99         (
 100             const fvPatch&,
 101             const DimensionedField<scalar, volMesh>&,
 102             const dictionary&
 103         );
 104
 105         //- Construct by mapping given
 106         //  nutUTabulatedWallFunctionFvPatchScalarField
 107         //  onto a new patch
 108         nutUTabulatedWallFunctionFvPatchScalarField
 109         (
 110             const nutUTabulatedWallFunctionFvPatchScalarField&,
 111             const fvPatch&,
 112             const DimensionedField<scalar, volMesh>&,
 113             const fvPatchFieldMapper&
 114         );
 115
 116         //- Construct as copy
 117         nutUTabulatedWallFunctionFvPatchScalarField
 118         (
 119             const nutUTabulatedWallFunctionFvPatchScalarField&
 120         );
 121
 122         //- Construct and return a clone
 123         virtual tmp<fvPatchScalarField> clone() const
 124         {
 125             return tmp<fvPatchScalarField>
 126             (
 127                 new nutUTabulatedWallFunctionFvPatchScalarField(*this)
 128             );
 129         }
 130
 131         //- Construct as copy setting internal field reference
 132         nutUTabulatedWallFunctionFvPatchScalarField
 133         (
 134             const nutUTabulatedWallFunctionFvPatchScalarField&,
 135             const DimensionedField<scalar, volMesh>&
 136         );
 137
 138         //- Construct and return a clone setting internal field reference
 139         virtual tmp<fvPatchScalarField> clone
 140         (
 141             const DimensionedField<scalar, volMesh>& iF
 142         ) const
 143         {
 144             return tmp<fvPatchScalarField>
 145             (
 146                 new nutUTabulatedWallFunctionFvPatchScalarField(*this, iF)
 147             );
 148         }
 149
 150
 151     // Member functions
 152
 153         // Evaluation functions
 154
 155             //- Calculate and return the yPlus at the boundary
 156             virtual tmp<scalarField> yPlus() const;
 157
 158
 159         // I-O
 160
 161             //- Write
 162             virtual void write(Ostream& os) const;
 163 };
 164
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 167
 168 } // End namespace RASModels
 169 } // End namespace incompressible
 170 } // End namespace Foam
 171
 172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 173
 174 #endif
 175
 176 // ************************************************************************* //