src/turbulenceModels/RAS/incompressible/wallFunctions/nutWallFunctions/nutStandardWallFunction/nutStandardWallFunctionFvPatchScalarField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::nutStandardWallFunctionFvPatchScalarField
  27
  28 Description
  29     Wall function boundary condition for walls
  30
  31 SourceFiles
  32     nutStandardWallFunctionFvPatchScalarField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef nutStandardWallFunctionFvPatchScalarField_H
  37 #define nutStandardWallFunctionFvPatchScalarField_H
  38
  39 #include "fixedValueFvPatchFields.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace incompressible
  46 {
  47 namespace RASModels
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                     Class nutWallFunctionFvPatch Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class nutStandardWallFunctionFvPatchScalarField
  55 :
  56     public fixedValueFvPatchScalarField
  57 {
  58     // Private data
  59
  60
  61 public:
  62
  63     //- Runtime type information
  64     TypeName("nutStandardWallFunction");
  65
  66
  67     // Constructors
  68
  69         //- Construct from patch and internal field
  70         nutStandardWallFunctionFvPatchScalarField
  71         (
  72             const fvPatch&,
  73             const DimensionedField<scalar, volMesh>&
  74         );
  75
  76         //- Construct from patch, internal field and dictionary
  77         nutStandardWallFunctionFvPatchScalarField
  78         (
  79             const fvPatch&,
  80             const DimensionedField<scalar, volMesh>&,
  81             const dictionary&
  82         );
  83
  84         //- Construct by mapping given nutStandardWallFunctionFvPatchScalarField
  85         //  onto a new patch
  86         nutStandardWallFunctionFvPatchScalarField
  87         (
  88             const nutStandardWallFunctionFvPatchScalarField&,
  89             const fvPatch&,
  90             const DimensionedField<scalar, volMesh>&,
  91             const fvPatchFieldMapper&
  92         );
  93
  94         //- Construct as copy
  95         nutStandardWallFunctionFvPatchScalarField
  96         (
  97             const nutStandardWallFunctionFvPatchScalarField&
  98         );
  99
 100         //- Construct and return a clone
 101         virtual tmp<fvPatchScalarField> clone() const
 102         {
 103             return tmp<fvPatchScalarField>
 104             (
 105                 new nutStandardWallFunctionFvPatchScalarField(*this)
 106             );
 107         }
 108
 109         //- Construct as copy setting internal field reference
 110         nutStandardWallFunctionFvPatchScalarField
 111         (
 112             const nutStandardWallFunctionFvPatchScalarField&,
 113             const DimensionedField<scalar, volMesh>&
 114         );
 115
 116         //- Construct and return a clone setting internal field reference
 117         virtual tmp<fvPatchScalarField> clone
 118         (
 119             const DimensionedField<scalar, volMesh>& iF
 120         ) const
 121         {
 122             return tmp<fvPatchScalarField>
 123             (
 124                 new nutStandardWallFunctionFvPatchScalarField(*this, iF)
 125             );
 126         }
 127
 128
 129     // Member functions
 130
 131         // Evaluation functions
 132
 133             //- Evaluate the patchField
 134             virtual void evaluate
 135             (
 136                 const Pstream::commsTypes commsType=Pstream::blocking
 137             );
 138 };
 139
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 } // End namespace RASModels
 144 } // End namespace incompressible
 145 } // End namespace Foam
 146
 147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 148
 149 #endif
 150
 151 // ************************************************************************* //