src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.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::nutkWallFunctionFvPatchScalarField
  27
  28 Description
  29     Boundary condition for turbulent (kinematic) viscosity when using wall
  30     functions, based on turbulence kinetic energy.
  31     - replicates OpenFOAM v1.5 (and earlier) behaviour
  32
  33 SourceFiles
  34     nutkWallFunctionFvPatchScalarField.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef nutkWallFunctionFvPatchScalarField_H
  39 #define nutkWallFunctionFvPatchScalarField_H
  40
  41 #include "fixedValueFvPatchFields.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47 namespace incompressible
  48 {
  49 namespace RASModels
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53              Class nutkWallFunctionFvPatchScalarField Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class nutkWallFunctionFvPatchScalarField
  57 :
  58     public fixedValueFvPatchScalarField
  59 {
  60 protected:
  61
  62     // Protected data
  63
  64         //- Cmu coefficient
  65         scalar Cmu_;
  66
  67         //- Von Karman constant
  68         scalar kappa_;
  69
  70         //- E coefficient
  71         scalar E_;
  72
  73         //- Y+ at the edge of the laminar sublayer
  74         scalar yPlusLam_;
  75
  76
  77     // Protected member functions
  78
  79         //- Check the type of the patch
  80         virtual void checkType();
  81
  82         //- Calculate the Y+ at the edge of the laminar sublayer
  83         virtual scalar calcYPlusLam(const scalar kappa, const scalar E) const;
  84
  85         //- Calculate the turbulence viscosity
  86         virtual tmp<scalarField> calcNut() const;
  87
  88         //- Write local wall function variables
  89         virtual void writeLocalEntries(Ostream&) const;
  90
  91
  92 public:
  93
  94     //- Runtime type information
  95     TypeName("nutkWallFunction");
  96
  97
  98     // Constructors
  99
 100         //- Construct from patch and internal field
 101         nutkWallFunctionFvPatchScalarField
 102         (
 103             const fvPatch&,
 104             const DimensionedField<scalar, volMesh>&
 105         );
 106
 107         //- Construct from patch, internal field and dictionary
 108         nutkWallFunctionFvPatchScalarField
 109         (
 110             const fvPatch&,
 111             const DimensionedField<scalar, volMesh>&,
 112             const dictionary&
 113         );
 114
 115         //- Construct by mapping given
 116         //  nutkWallFunctionFvPatchScalarField
 117         //  onto a new patch
 118         nutkWallFunctionFvPatchScalarField
 119         (
 120             const nutkWallFunctionFvPatchScalarField&,
 121             const fvPatch&,
 122             const DimensionedField<scalar, volMesh>&,
 123             const fvPatchFieldMapper&
 124         );
 125
 126         //- Construct as copy
 127         nutkWallFunctionFvPatchScalarField
 128         (
 129             const nutkWallFunctionFvPatchScalarField&
 130         );
 131
 132         //- Construct and return a clone
 133         virtual tmp<fvPatchScalarField> clone() const
 134         {
 135             return tmp<fvPatchScalarField>
 136             (
 137                 new nutkWallFunctionFvPatchScalarField(*this)
 138             );
 139         }
 140
 141         //- Construct as copy setting internal field reference
 142         nutkWallFunctionFvPatchScalarField
 143         (
 144             const nutkWallFunctionFvPatchScalarField&,
 145             const DimensionedField<scalar, volMesh>&
 146         );
 147
 148         //- Construct and return a clone setting internal field reference
 149         virtual tmp<fvPatchScalarField> clone
 150         (
 151             const DimensionedField<scalar, volMesh>& iF
 152         ) const
 153         {
 154             return tmp<fvPatchScalarField>
 155             (
 156                 new nutkWallFunctionFvPatchScalarField(*this, iF)
 157             );
 158         }
 159
 160
 161     // Member functions
 162
 163         // Evaluation functions
 164
 165             //- Calculate and return the yPlus at the boundary
 166             virtual tmp<scalarField> yPlus() const;
 167
 168             //- Update the coefficients associated with the patch field
 169             virtual void updateCoeffs();
 170
 171
 172         // I-O
 173
 174             //- Write
 175             virtual void write(Ostream&) const;
 176 };
 177
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 } // End namespace RASModels
 182 } // End namespace incompressible
 183 } // End namespace Foam
 184
 185 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 186
 187 #endif
 188
 189 // ************************************************************************* //