RASModelVariablesI.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2007-2019 PCOpt/NTUA
9  Copyright (C) 2013-2019 FOSS GP
10  Copyright (C) 2019-2020 OpenCFD Ltd.
11 -------------------------------------------------------------------------------
12 License
13  This file is part of OpenFOAM.
14 
15  OpenFOAM is free software: you can redistribute it and/or modify it
16  under the terms of the GNU General Public License as published by
17  the Free Software Foundation, either version 3 of the License, or
18  (at your option) any later version.
19 
20  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
21  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
22  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
23  for more details.
24 
25  You should have received a copy of the GNU General Public License
26  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
27 \*---------------------------------------------------------------------------*/
28 
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace incompressible
34 {
35 
36 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
37 
39 {
40  return TMVar1BaseName_;
41 }
42 
43 
45 {
46  return TMVar2BaseName_;
47 }
48 
49 
50 inline const word& RASModelVariables::nutBaseName() const
51 {
52  return nutBaseName_;
53 }
54 
55 
56 inline bool RASModelVariables::hasTMVar1() const
57 {
58  return bool(TMVar1Ptr_);
59 }
60 
61 
62 inline bool RASModelVariables::hasTMVar2() const
63 {
64  return bool(TMVar2Ptr_);
65 }
66 
67 
68 inline bool RASModelVariables::hasNut() const
69 {
70  return bool(nutPtr_);
71 }
72 
73 
74 inline bool RASModelVariables::hasDist() const
75 {
76  return bool(distPtr_);
77 }
78 
79 
81 {
83  {
84  return TMVar1MeanPtr_.cref();
85  }
86 
87  return TMVar1Ptr_.cref();
88 }
89 
90 
92 {
94  {
95  return TMVar1MeanPtr_.ref();
96  }
97 
98  return TMVar1Ptr_.ref();
99 }
100 
101 
103 {
105  {
106  return TMVar2MeanPtr_.cref();
107  }
108 
109  return TMVar2Ptr_.cref();
110 }
111 
113 {
115  {
116  return TMVar2MeanPtr_.ref();
117  }
118 
119  return TMVar2Ptr_.ref();
120 }
121 
123 {
125  {
126  return nutMeanPtr_.cref();
127  }
128 
129  return nutPtr_.cref();
130 }
131 
132 
134 {
136  {
137  return nutMeanPtr_.ref();
138  }
139 
140  return nutPtr_.ref();
141 }
142 
143 
145 {
146  return distPtr_.cref();
147 }
148 
149 
151 {
152  return distPtr_.ref();
153 }
154 
155 
157 {
158  return TMVar1Ptr_.cref();
159 }
160 
161 
163 {
164  return TMVar1Ptr_.ref();
165 }
166 
167 
169 {
170  return TMVar2Ptr_.cref();
171 }
172 
173 
175 {
176  return TMVar2Ptr_.ref();
177 }
178 
179 
181 {
182  return nutPtr_.cref();
183 }
184 
185 
187 {
188  return nutPtr_.ref();
189 }
190 
191 
192 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
193 
194 } // End namespace incompressible
195 } // End namespace Foam
196 
197 // ************************************************************************* //
Foam::incompressible::RASModelVariables::nutBaseName
const word & nutBaseName() const
Definition: RASModelVariablesI.H:50
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::incompressible::RASModelVariables::d
const volScalarField & d() const
Definition: RASModelVariablesI.H:144
Foam::incompressible::RASModelVariables::TMVar1Inst
const volScalarField & TMVar1Inst() const
return references to instantaneous turbulence fields
Definition: RASModelVariablesI.H:156
Foam::incompressible::RASModelVariables::solverControl_
const solverControl & solverControl_
Definition: RASModelVariables.H:66
Foam::incompressible::RASModelVariables::TMVar2Ptr_
refPtr< volScalarField > TMVar2Ptr_
Definition: RASModelVariables.H:74
Foam::incompressible::RASModelVariables::nutMeanPtr_
refPtr< volScalarField > nutMeanPtr_
Definition: RASModelVariables.H:87
Foam::incompressible::RASModelVariables::TMVar2BaseName_
word TMVar2BaseName_
Definition: RASModelVariables.H:70
Foam::incompressible::RASModelVariables::distPtr_
refPtr< volScalarField > distPtr_
Definition: RASModelVariables.H:76
Foam::incompressible::RASModelVariables::nutRefInst
const volScalarField & nutRefInst() const
Definition: RASModelVariablesI.H:180
Foam::incompressible::RASModelVariables::hasDist
bool hasDist() const
Definition: RASModelVariablesI.H:74
Foam::incompressible::RASModelVariables::hasTMVar2
bool hasTMVar2() const
Definition: RASModelVariablesI.H:62
Foam::incompressible::RASModelVariables::nutBaseName_
word nutBaseName_
Definition: RASModelVariables.H:71
Foam::incompressible::RASModelVariables::nutPtr_
refPtr< volScalarField > nutPtr_
Definition: RASModelVariables.H:75
Foam::solverControl::useAveragedFields
bool useAveragedFields() const
Definition: solverControlI.H:94
Foam::incompressible::RASModelVariables::TMVar1Ptr_
refPtr< volScalarField > TMVar1Ptr_
Definition: RASModelVariables.H:73
Foam::incompressible::RASModelVariables::TMVar1BaseName_
word TMVar1BaseName_
Definition: RASModelVariables.H:69
Foam::incompressible::RASModelVariables::TMVar2Inst
const volScalarField & TMVar2Inst() const
Definition: RASModelVariablesI.H:168
Foam::incompressible::RASModelVariables::nutRef
const volScalarField & nutRef() const
Definition: RASModelVariablesI.H:122
Foam::incompressible::RASModelVariables::hasTMVar1
bool hasTMVar1() const
Bools to idenify which turbulent fields are present.
Definition: RASModelVariablesI.H:56
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::incompressible::RASModelVariables::TMVar1BaseName
const word & TMVar1BaseName() const
Turbulence field names.
Definition: RASModelVariablesI.H:38
Foam::incompressible::RASModelVariables::TMVar2BaseName
const word & TMVar2BaseName() const
Definition: RASModelVariablesI.H:44
bool
bool
Definition: EEqn.H:20
Foam::incompressible::RASModelVariables::TMVar1MeanPtr_
refPtr< volScalarField > TMVar1MeanPtr_
Definition: RASModelVariables.H:85
Foam::incompressible::RASModelVariables::TMVar1
const volScalarField & TMVar1() const
Return references to turbulence fields.
Definition: RASModelVariablesI.H:80
Foam::incompressible::RASModelVariables::TMVar2MeanPtr_
refPtr< volScalarField > TMVar2MeanPtr_
Definition: RASModelVariables.H:86
Foam::incompressible::RASModelVariables::hasNut
bool hasNut() const
Definition: RASModelVariablesI.H:68
Foam::incompressible::RASModelVariables::TMVar2
const volScalarField & TMVar2() const
Definition: RASModelVariablesI.H:102
Foam::GeometricField
Generic GeometricField class.
Definition: areaFieldsFwd.H:53