FreeFOAM The Cross-Platform CFD Toolkit
nutSpalartAllmarasStandardWallFunctionFvPatchScalarField.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) 1991-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::RASModels::nutSpalartAllmarasStandardWallFunctionFvPatchScalarField
26 
27 Description
28  Wall function boundary condition for walls
29 
30 SourceFiles
31  nutSpalartAllmarasStandardWallFunctionFvPatchScalarField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef nutSpalartAllmarasStandardWallFunctionFvPatchScalarField_H
36 #define nutSpalartAllmarasStandardWallFunctionFvPatchScalarField_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace incompressible
45 {
46 namespace RASModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class nutSpalartAllmarasStandardWallFunctionFvPatchScalarField Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
56 {
57 protected:
58 
59  // Protected member functions
60 
61  //- Calculate yPLus
62  virtual tmp<scalarField> calcYPlus(const scalarField& magUp) const;
63 
64  //- Calculate the turbulence viscosity
65  virtual tmp<scalarField> calcNut() const;
66 
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("nutSpalartAllmarasStandardWallFunction");
72 
73 
74  // Constructors
75 
76  //- Construct from patch and internal field
78  (
79  const fvPatch&,
81  );
82 
83  //- Construct from patch, internal field and dictionary
85  (
86  const fvPatch&,
88  const dictionary&
89  );
90 
91  //- Construct by mapping given
92  // nutSpalartAllmarasStandardWallFunctionFvPatchScalarField
93  // onto a new patch
95  (
97  const fvPatch&,
99  const fvPatchFieldMapper&
100  );
101 
102  //- Construct as copy
104  (
106  );
107 
108  //- Construct and return a clone
110  {
112  (
114  (
115  *this
116  )
117  );
118  }
119 
120  //- Construct as copy setting internal field reference
122  (
125  );
126 
127  //- Construct and return a clone setting internal field reference
129  (
131  ) const
132  {
134  (
136  (
137  *this,
138  iF
139  )
140  );
141  }
142 
143 
144  // Member functions
145 
146  // Evaluation functions
147 
148  //- Calculate and return the yPlus at the boundary
149  virtual tmp<scalarField> yPlus() const;
150 
151 
152  // I-O
153 
154  //- Write
155  virtual void write(Ostream& os) const;
156 };
157 
158 
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
160 
161 } // End namespace RASModels
162 } // End namespace incompressible
163 } // End namespace Foam
164 
165 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
166 
167 #endif
168 
169 // ************************ vim: set sw=4 sts=4 et: ************************ //