src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.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::compressible::RASModels::epsilonWallFunctionFvPatchScalarField
  27
  28 Description
  29     Boundary condition for epsilon when using wall functions
  30     - calculates epsilon and G
  31     - epsilon values added directly into the matrix to act as a constraint
  32
  33 SourceFiles
  34     epsilonWallFunctionFvPatchScalarField.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef compressibleEpsilonWallFunctionFvPatchScalarField_H
  39 #define compressibleEpsilonWallFunctionFvPatchScalarField_H
  40
  41 #include "fixedInternalValueFvPatchField.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47 namespace compressible
  48 {
  49 namespace RASModels
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53            Class epsilonWallFunctionFvPatchScalarField Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class epsilonWallFunctionFvPatchScalarField
  57 :
  58     public fixedInternalValueFvPatchField<scalar>
  59 {
  60     // Private data
  61
  62         //- Name of velocity field
  63         word UName_;
  64
  65         //- Name of turbulence kinetic energy field
  66         word kName_;
  67
  68         //- Name of turbulence generation field
  69         word GName_;
  70
  71         //- Name of density field
  72         word rhoName_;
  73
  74         //- Name of laminar viscosity field
  75         word muName_;
  76
  77         //- Name of turbulent viscosity field
  78         word mutName_;
  79
  80         //- Cmu coefficient
  81         scalar Cmu_;
  82
  83         //- Von Karman constant
  84         scalar kappa_;
  85
  86         //- E coefficient
  87         scalar E_;
  88
  89
  90     // Private member functions
  91
  92         //- Check the type of the patch
  93         void checkType();
  94
  95
  96 public:
  97
  98     //- Runtime type information
  99     TypeName("compressible::epsilonWallFunction");
 100
 101
 102     // Constructors
 103
 104         //- Construct from patch and internal field
 105         epsilonWallFunctionFvPatchScalarField
 106         (
 107             const fvPatch&,
 108             const DimensionedField<scalar, volMesh>&
 109         );
 110
 111         //- Construct from patch, internal field and dictionary
 112         epsilonWallFunctionFvPatchScalarField
 113         (
 114             const fvPatch&,
 115             const DimensionedField<scalar, volMesh>&,
 116             const dictionary&
 117         );
 118
 119         //- Construct by mapping given
 120         //  epsilonWallFunctionFvPatchScalarField
 121         //  onto a new patch
 122         epsilonWallFunctionFvPatchScalarField
 123         (
 124             const epsilonWallFunctionFvPatchScalarField&,
 125             const fvPatch&,
 126             const DimensionedField<scalar, volMesh>&,
 127             const fvPatchFieldMapper&
 128         );
 129
 130         //- Construct as copy
 131         epsilonWallFunctionFvPatchScalarField
 132         (
 133             const epsilonWallFunctionFvPatchScalarField&
 134         );
 135
 136         //- Construct and return a clone
 137         virtual tmp<fvPatchScalarField> clone() const
 138         {
 139             return tmp<fvPatchScalarField>
 140             (
 141                 new epsilonWallFunctionFvPatchScalarField(*this)
 142             );
 143         }
 144
 145         //- Construct as copy setting internal field reference
 146         epsilonWallFunctionFvPatchScalarField
 147         (
 148             const epsilonWallFunctionFvPatchScalarField&,
 149             const DimensionedField<scalar, volMesh>&
 150         );
 151
 152         //- Construct and return a clone setting internal field reference
 153         virtual tmp<fvPatchScalarField> clone
 154         (
 155             const DimensionedField<scalar, volMesh>& iF
 156         ) const
 157         {
 158             return tmp<fvPatchScalarField>
 159             (
 160                 new epsilonWallFunctionFvPatchScalarField(*this, iF)
 161             );
 162         }
 163
 164
 165     // Member functions
 166
 167         // Evaluation functions
 168
 169             //- Update the coefficients associated with the patch field
 170             virtual void updateCoeffs();
 171
 172             //- Evaluate the patchField
 173             virtual void evaluate(const Pstream::commsTypes);
 174
 175
 176         // I-O
 177
 178             //- Write
 179             void write(Ostream&) const;
 180 };
 181
 182
 183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 184
 185 } // End namespace RASModels
 186 } // End namespace compressible
 187 } // End namespace Foam
 188
 189 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 190
 191 #endif
 192
 193 // ************************************************************************* //