src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutSpalartAllmarasStandardWallFunction/mutSpalartAllmarasStandardWallFunctionFvPatchScalarField.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::compressible::RASModels::
  27     mutSpalartAllmarasStandardWallFunctionFvPatchScalarField
  28
  29 Description
  30     Wall function boundary condition for walls
  31
  32 SourceFiles
  33     mutSpalartAllmarasStandardWallFunctionFvPatchScalarField.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef compressibleMutSpalartAllmarasStandardWallFunctionFvPatchScalarField_H
  38 #define compressibleMutSpalartAllmarasStandardWallFunctionFvPatchScalarField_H
  39
  40 #include "mutWallFunctionFvPatchScalarField.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46 namespace compressible
  47 {
  48 namespace RASModels
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52   Class mutSpalartAllmarasStandardWallFunctionFvPatchScalarField Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class mutSpalartAllmarasStandardWallFunctionFvPatchScalarField
  56 :
  57     public mutWallFunctionFvPatchScalarField
  58 {
  59 protected:
  60
  61     // Protected member functions
  62
  63         //- Calculate yPLus
  64         virtual tmp<scalarField> calcYPlus(const scalarField& magUp) const;
  65
  66         //- Calculate the turbulence viscosity
  67         virtual tmp<scalarField> calcMut() const;
  68
  69
  70 public:
  71
  72     //- Runtime type information
  73     TypeName("mutSpalartAllmarasStandardWallFunction");
  74
  75
  76     // Constructors
  77
  78         //- Construct from patch and internal field
  79         mutSpalartAllmarasStandardWallFunctionFvPatchScalarField
  80         (
  81             const fvPatch&,
  82             const DimensionedField<scalar, volMesh>&
  83         );
  84
  85         //- Construct from patch, internal field and dictionary
  86         mutSpalartAllmarasStandardWallFunctionFvPatchScalarField
  87         (
  88             const fvPatch&,
  89             const DimensionedField<scalar, volMesh>&,
  90             const dictionary&
  91         );
  92
  93         //- Construct by mapping given
  94         //  mutSpalartAllmarasStandardWallFunctionFvPatchScalarField
  95         //  onto a new patch
  96         mutSpalartAllmarasStandardWallFunctionFvPatchScalarField
  97         (
  98             const mutSpalartAllmarasStandardWallFunctionFvPatchScalarField&,
  99             const fvPatch&,
 100             const DimensionedField<scalar, volMesh>&,
 101             const fvPatchFieldMapper&
 102         );
 103
 104         //- Construct as copy
 105         mutSpalartAllmarasStandardWallFunctionFvPatchScalarField
 106         (
 107             const mutSpalartAllmarasStandardWallFunctionFvPatchScalarField&
 108         );
 109
 110         //- Construct and return a clone
 111         virtual tmp<fvPatchScalarField> clone() const
 112         {
 113             return tmp<fvPatchScalarField>
 114             (
 115                 new mutSpalartAllmarasStandardWallFunctionFvPatchScalarField
 116                 (
 117                     *this
 118                 )
 119             );
 120         }
 121
 122         //- Construct as copy setting internal field reference
 123         mutSpalartAllmarasStandardWallFunctionFvPatchScalarField
 124         (
 125             const mutSpalartAllmarasStandardWallFunctionFvPatchScalarField&,
 126             const DimensionedField<scalar, volMesh>&
 127         );
 128
 129         //- Construct and return a clone setting internal field reference
 130         virtual tmp<fvPatchScalarField> clone
 131         (
 132             const DimensionedField<scalar, volMesh>& iF
 133         ) const
 134         {
 135             return tmp<fvPatchScalarField>
 136             (
 137                 new mutSpalartAllmarasStandardWallFunctionFvPatchScalarField
 138                 (
 139                     *this,
 140                     iF
 141                 )
 142             );
 143         }
 144
 145
 146     // Member functions
 147
 148         // Evaluation functions
 149
 150             //- Calculate and return the yPlus at the boundary
 151             virtual tmp<scalarField> yPlus() const;
 152
 153
 154         // I-O
 155
 156             //- Write
 157             virtual void write(Ostream& os) const;
 158 };
 159
 160
 161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 162
 163 } // End namespace RASModels
 164 } // End namespace compressible
 165 } // End namespace Foam
 166
 167 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 168
 169 #endif
 170
 171 // ************************************************************************* //