src/turbulenceModels/incompressible/RAS/backwardsCompatibility/wallFunctions/backwardsCompatibilityWallFunctions.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::incompressible
  27
  28 Description
  29     Auto creation of fields to provide backwards compatibility with
  30     runtime selectable wall functions
  31
  32 SourceFiles
  33     backwardsCompatibilityWallFunctions.C
  34     backwardsCompatibilityWallFunctionsTemplates.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef backwardsCompatibilityWallFunctions_H
  39 #define backwardsCompatibilityWallFunctions_H
  40
  41 #include "fvMesh.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47 namespace incompressible
  48 {
  49     //- nut
  50     tmp<volScalarField> autoCreateNut
  51     (
  52         const word& fieldName,
  53         const fvMesh& mesh
  54     );
  55
  56     //- epsilon
  57     tmp<volScalarField> autoCreateEpsilon
  58     (
  59         const word& fieldName,
  60         const fvMesh& mesh
  61     );
  62
  63     //- omega
  64     tmp<volScalarField> autoCreateOmega
  65     (
  66         const word& fieldName,
  67         const fvMesh& mesh
  68     );
  69
  70     //- k
  71     tmp<volScalarField> autoCreateK
  72     (
  73         const word& fieldName,
  74         const fvMesh& mesh
  75     );
  76
  77     //- Q
  78     tmp<volScalarField> autoCreateQ
  79     (
  80         const word& fieldName,
  81         const fvMesh& mesh
  82     );
  83
  84     //- R
  85     tmp<volSymmTensorField> autoCreateR
  86     (
  87         const word& fieldName,
  88         const fvMesh& mesh
  89     );
  90
  91     //- Helper function to create the new field
  92     template<class Type, class PatchType>
  93     tmp<GeometricField<Type, fvPatchField, volMesh> >
  94     autoCreateWallFunctionField
  95     (
  96         const word& fieldName,
  97         const fvMesh& mesh
  98     );
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace incompressible
 104 } // End namespace Foam
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 #ifdef NoRepository
 109 #   include "backwardsCompatibilityWallFunctionsTemplates.C"
 110 #endif
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 #endif
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //