src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2010-2011 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
  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::compressible::RASModels::
  26     mutkFilmWallFunctionFvPatchScalarField
  27
  28 Description
  29     Wall function boundary condition for use with surface film models.
  30
  31 SourceFiles
  32     mutkFilmWallFunctionFvPatchScalarField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef compressibleMutSpalartAllmarasWallFunctionFvPatchScalarField_H
  37 #define compressibleMutSpalartAllmarasWallFunctionFvPatchScalarField_H
  38
  39 #include "mutkWallFunctionFvPatchScalarField.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace compressible
  46 {
  47 namespace RASModels
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51          Class mutkFilmWallFunctionFvPatchScalarField Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class mutkFilmWallFunctionFvPatchScalarField
  55 :
  56     public mutkWallFunctionFvPatchScalarField
  57 {
  58 protected:
  59
  60     // Protected data
  61
  62         //- B Coefficient (default = 5.5)
  63         scalar B_;
  64
  65         //- y+ value for laminar -> turbulent transition (default = 11.05)
  66         scalar yPlusCrit_;
  67
  68
  69     // Protected member functions
  70
  71         //- Calculate the turbulence viscosity
  72         virtual tmp<scalarField> calcMut() const;
  73
  74         //- Calculate the friction velocity
  75         virtual tmp<scalarField> calcUTau(const scalarField& magGradU) const;
  76
  77
  78 public:
  79
  80     //- Runtime type information
  81     TypeName("mutkFilmWallFunction");
  82
  83
  84     // Constructors
  85
  86         //- Construct from patch and internal field
  87         mutkFilmWallFunctionFvPatchScalarField
  88         (
  89             const fvPatch&,
  90             const DimensionedField<scalar, volMesh>&
  91         );
  92
  93         //- Construct from patch, internal field and dictionary
  94         mutkFilmWallFunctionFvPatchScalarField
  95         (
  96             const fvPatch&,
  97             const DimensionedField<scalar, volMesh>&,
  98             const dictionary&
  99         );
 100
 101         //- Construct by mapping given
 102         //  mutkFilmWallFunctionFvPatchScalarField
 103         //  onto a new patch
 104         mutkFilmWallFunctionFvPatchScalarField
 105         (
 106             const mutkFilmWallFunctionFvPatchScalarField&,
 107             const fvPatch&,
 108             const DimensionedField<scalar, volMesh>&,
 109             const fvPatchFieldMapper&
 110         );
 111
 112         //- Construct as copy
 113         mutkFilmWallFunctionFvPatchScalarField
 114         (
 115             const mutkFilmWallFunctionFvPatchScalarField&
 116         );
 117
 118         //- Construct and return a clone
 119         virtual tmp<fvPatchScalarField> clone() const
 120         {
 121             return tmp<fvPatchScalarField>
 122             (
 123                 new mutkFilmWallFunctionFvPatchScalarField(*this)
 124             );
 125         }
 126
 127         //- Construct as copy setting internal field reference
 128         mutkFilmWallFunctionFvPatchScalarField
 129         (
 130             const mutkFilmWallFunctionFvPatchScalarField&,
 131             const DimensionedField<scalar, volMesh>&
 132         );
 133
 134         //- Construct and return a clone setting internal field reference
 135         virtual tmp<fvPatchScalarField> clone
 136         (
 137             const DimensionedField<scalar, volMesh>& iF
 138         ) const
 139         {
 140             return tmp<fvPatchScalarField>
 141             (
 142                 new mutkFilmWallFunctionFvPatchScalarField(*this, iF)
 143             );
 144         }
 145
 146
 147     // Member functions
 148
 149         // Evaluation functions
 150
 151             //- Calculate and return the yPlus at the boundary
 152             virtual tmp<scalarField> yPlus() const;
 153
 154
 155         // I-O
 156
 157             //- Write
 158             virtual void write(Ostream& os) const;
 159 };
 160
 161
 162 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 163
 164 } // End namespace RASModels
 165 } // End namespace compressible
 166 } // End namespace Foam
 167
 168 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 169
 170 #endif
 171
 172 // ************************************************************************* //