FreeFOAM The Cross-Platform CFD Toolkit
backwardsCompatibilityWallFunctions.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2008-2010 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::incompressible
26 
27 Description
28  Auto creation of fields to provide backwards compatibility with
29  runtime selectable wall functions
30 
31 SourceFiles
32  backwardsCompatibilityWallFunctions.C
33  backwardsCompatibilityWallFunctionsTemplates.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef backwardsCompatibilityWallFunctions_H
38 #define backwardsCompatibilityWallFunctions_H
39 
40 #include <finiteVolume/fvMesh.H>
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace incompressible
47 {
48  //- nut
49  tmp<volScalarField> autoCreateNut
50  (
51  const word& fieldName,
52  const fvMesh& mesh
53  );
54 
55  //- nut for Low-Reynolds number models
56  tmp<volScalarField> autoCreateLowReNut
57  (
58  const word& fieldName,
59  const fvMesh& mesh
60  );
61 
62  //- epsilon
63  tmp<volScalarField> autoCreateEpsilon
64  (
65  const word& fieldName,
66  const fvMesh& mesh
67  );
68 
69  //- omega
70  tmp<volScalarField> autoCreateOmega
71  (
72  const word& fieldName,
73  const fvMesh& mesh
74  );
75 
76  //- k
77  tmp<volScalarField> autoCreateK
78  (
79  const word& fieldName,
80  const fvMesh& mesh
81  );
82 
83  //- Q
84  tmp<volScalarField> autoCreateQ
85  (
86  const word& fieldName,
87  const fvMesh& mesh
88  );
89 
90  //- R
91  tmp<volSymmTensorField> autoCreateR
92  (
93  const word& fieldName,
94  const fvMesh& mesh
95  );
96 
97  //- Helper function to create the new field
98  template<class Type, class PatchType>
99  tmp<GeometricField<Type, fvPatchField, volMesh> >
101  (
102  const word& fieldName,
103  const fvMesh& mesh
104  );
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace incompressible
110 } // End namespace Foam
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 #ifdef NoRepository
116 #endif
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #endif
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //