src/turbulenceModels/compressible/LES/derivedFvPatchFields/wallFunctions/muSgsWallFunctions/muSgsUSpaldingWallFunction/muSgsUSpaldingWallFunctionFvPatchScalarField.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::compressible::LESModels::
  26         muSgsUSpaldingWallFunctionFvPatchScalarField
  27
  28 Description
  29     Wall function boundary condition for walls, based on velocity, using
  30     Spaldings law to give a continuous muSgs profile to the wall (y+ = 0).
  31
  32 SourceFiles
  33     muSgsUSpaldingWallFunctionFvPatchScalarField.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef muSgsUSpaldingWallFunctionFvPatchScalarField_H
  38 #define muSgsUSpaldingWallFunctionFvPatchScalarField_H
  39
  40 #include "fixedValueFvPatchFields.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46 namespace compressible
  47 {
  48 namespace LESModels
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52        Class muSgsUSpaldingWallFunctionFvPatchScalarField Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class muSgsUSpaldingWallFunctionFvPatchScalarField
  56 :
  57     public fixedValueFvPatchScalarField
  58 {
  59     // Private data
  60
  61         //- Name of velocity field
  62         word UName_;
  63
  64         //- Name of density field
  65         word rhoName_;
  66
  67         //- Name of laminar viscosity field
  68         word muName_;
  69
  70         //- Von Karman constant
  71         scalar kappa_;
  72
  73         //- E coefficient
  74         scalar E_;
  75
  76
  77 public:
  78
  79     //- Runtime type information
  80     TypeName("muSgsUSpaldingWallFunction");
  81
  82
  83     // Constructors
  84
  85         //- Construct from patch and internal field
  86         muSgsUSpaldingWallFunctionFvPatchScalarField
  87         (
  88             const fvPatch&,
  89             const DimensionedField<scalar, volMesh>&
  90         );
  91
  92         //- Construct from patch, internal field and dictionary
  93         muSgsUSpaldingWallFunctionFvPatchScalarField
  94         (
  95             const fvPatch&,
  96             const DimensionedField<scalar, volMesh>&,
  97             const dictionary&
  98         );
  99
 100         //- Construct by mapping given
 101         //  muSgsUSpaldingWallFunctionFvPatchScalarField
 102         //  onto a new patch
 103         muSgsUSpaldingWallFunctionFvPatchScalarField
 104         (
 105             const muSgsUSpaldingWallFunctionFvPatchScalarField&,
 106             const fvPatch&,
 107             const DimensionedField<scalar, volMesh>&,
 108             const fvPatchFieldMapper&
 109         );
 110
 111         //- Construct as copy
 112         muSgsUSpaldingWallFunctionFvPatchScalarField
 113         (
 114             const muSgsUSpaldingWallFunctionFvPatchScalarField&
 115         );
 116
 117         //- Construct and return a clone
 118         virtual tmp<fvPatchScalarField> clone() const
 119         {
 120             return tmp<fvPatchScalarField>
 121             (
 122                 new muSgsUSpaldingWallFunctionFvPatchScalarField(*this)
 123             );
 124         }
 125
 126         //- Construct as copy setting internal field reference
 127         muSgsUSpaldingWallFunctionFvPatchScalarField
 128         (
 129             const muSgsUSpaldingWallFunctionFvPatchScalarField&,
 130             const DimensionedField<scalar, volMesh>&
 131         );
 132
 133         //- Construct and return a clone setting internal field reference
 134         virtual tmp<fvPatchScalarField> clone
 135         (
 136             const DimensionedField<scalar, volMesh>& iF
 137         ) const
 138         {
 139             return tmp<fvPatchScalarField>
 140             (
 141                 new muSgsUSpaldingWallFunctionFvPatchScalarField(*this, iF)
 142             );
 143         }
 144
 145
 146     // Member functions
 147
 148         // Evaluation functions
 149
 150             //- Evaluate the patchField
 151             virtual void evaluate
 152             (
 153                 const Pstream::commsTypes commsType=Pstream::blocking
 154             );
 155
 156         // I-O
 157
 158             //- Write
 159             void write(Ostream&) const;
 160 };
 161
 162
 163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 164
 165 } // End namespace LESModels
 166 } // End namespace compressible
 167 } // End namespace Foam
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 #endif
 172
 173 // ************************************************************************* //