All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
laminarModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2016-2020 OpenFOAM Foundation
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::laminarModel
26 
27 Description
28  Templated abstract base class for laminar transport models
29 
30 SourceFiles
31  laminarModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef laminarModel_H
36 #define laminarModel_H
37 
38 #include "MomentumTransportModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class laminarModel Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class BasicMomentumTransportModel>
50 class laminarModel
51 :
52  public BasicMomentumTransportModel
53 {
54 
55 protected:
56 
57  // Protected data
58 
59  //- laminar coefficients dictionary
61 
62  //- Flag to print the model coeffs at run-time
64 
65  //- Model coefficients dictionary
67 
68 
69  // Protected Member Functions
70 
71  //- Print model coefficients
72  virtual void printCoeffs(const word& type);
73 
74 
75 public:
76 
77  typedef typename BasicMomentumTransportModel::alphaField alphaField;
78  typedef typename BasicMomentumTransportModel::rhoField rhoField;
79  typedef typename BasicMomentumTransportModel::transportModel transportModel;
80 
81 
82  //- Runtime type information
83  TypeName("laminar");
84 
85 
86  // Declare run-time constructor selection table
87 
89  (
90  autoPtr,
92  dictionary,
93  (
94  const alphaField& alpha,
95  const rhoField& rho,
96  const volVectorField& U,
97  const surfaceScalarField& alphaRhoPhi,
98  const surfaceScalarField& phi,
99  const transportModel& transport
100  ),
101  (alpha, rho, U, alphaRhoPhi, phi, transport)
102  );
103 
104 
105  // Constructors
106 
107  //- Construct from components
109  (
110  const word& type,
111  const alphaField& alpha,
112  const rhoField& rho,
113  const volVectorField& U,
114  const surfaceScalarField& alphaRhoPhi,
115  const surfaceScalarField& phi,
116  const transportModel& transport
117  );
118 
119  //- Disallow default bitwise copy construction
120  laminarModel(const laminarModel&) = delete;
121 
122 
123  // Selectors
124 
125  //- Return a reference to the selected laminar model
127  (
128  const alphaField& alpha,
129  const rhoField& rho,
130  const volVectorField& U,
131  const surfaceScalarField& alphaRhoPhi,
132  const surfaceScalarField& phi,
133  const transportModel& transport
134  );
135 
136 
137  //- Destructor
138  virtual ~laminarModel()
139  {}
140 
141 
142  // Member Functions
143 
144  //- Read model coefficients if they have changed
145  virtual bool read();
146 
147 
148  // Access
149 
150  //- Const access to the coefficients dictionary
151  virtual const dictionary& coeffDict() const
152  {
153  return coeffDict_;
154  }
155 
156  //- Return the turbulence viscosity, i.e. 0 for laminar flow
157  virtual tmp<volScalarField> nut() const;
158 
159  //- Return the turbulence viscosity on patch
160  virtual tmp<scalarField> nut(const label patchi) const;
161 
162  //- Return the effective viscosity, i.e. the laminar viscosity
163  virtual tmp<volScalarField> nuEff() const;
164 
165  //- Return the effective viscosity on patch
166  virtual tmp<scalarField> nuEff(const label patchi) const;
167 
168  //- Return the turbulence kinetic energy, i.e. 0 for laminar flow
169  virtual tmp<volScalarField> k() const;
170 
171  //- Return the turbulence kinetic energy dissipation rate,
172  // i.e. 0 for laminar flow
173  virtual tmp<volScalarField> epsilon() const;
174 
175  //- Return the stress tensor [m^2/s^2], i.e. 0 for laminar flow
176  virtual tmp<volSymmTensorField> sigma() const;
177 
178  //- Correct the laminar transport
179  virtual void correct();
180 
181 
182  // Member Operators
183 
184  //- Disallow default bitwise assignment
185  void operator=(const laminarModel&) = delete;
186 };
187 
188 
189 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
190 
191 } // End namespace Foam
192 
193 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
194 
195 #ifdef NoRepository
196  #include "laminarModel.C"
197 #endif
198 
199 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
200 
201 #endif
202 
203 // ************************************************************************* //
Templated abstract base class for laminar transport models.
Definition: laminarModel.H:49
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual tmp< volScalarField > nuEff() const
Return the effective viscosity, i.e. the laminar viscosity.
Definition: laminarModel.C:210
virtual ~laminarModel()
Destructor.
Definition: laminarModel.H:137
A simple wrapper around bool so that it can be read as a word: true/false, on/off, yes/no, y/n, t/f, or none/any.
Definition: Switch.H:60
void operator=(const laminarModel &)=delete
Disallow default bitwise assignment.
TypeName("laminar")
Runtime type information.
BasicMomentumTransportModel::rhoField rhoField
Definition: laminarModel.H:77
BasicMomentumTransportModel::alphaField alphaField
Definition: laminarModel.H:76
BasicMomentumTransportModel::transportModel transportModel
Definition: laminarModel.H:78
virtual bool read()
Read model coefficients if they have changed.
Definition: laminarModel.C:164
phi
Definition: pEqn.H:104
dictionary laminarDict_
laminar coefficients dictionary
Definition: laminarModel.H:59
A class for handling words, derived from string.
Definition: word.H:59
virtual tmp< volScalarField > epsilon() const
Return the turbulence kinetic energy dissipation rate,.
Definition: laminarModel.C:246
virtual tmp< volScalarField > nut() const
Return the turbulence viscosity, i.e. 0 for laminar flow.
Definition: laminarModel.C:183
virtual tmp< volScalarField > k() const
Return the turbulence kinetic energy, i.e. 0 for laminar flow.
Definition: laminarModel.C:233
virtual void printCoeffs(const word &type)
Print model coefficients.
Definition: laminarModel.C:33
virtual tmp< volSymmTensorField > sigma() const
Return the stress tensor [m^2/s^2], i.e. 0 for laminar flow.
Definition: laminarModel.C:259
declareRunTimeSelectionTable(autoPtr, laminarModel, dictionary,(const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport),(alpha, rho, U, alphaRhoPhi, phi, transport))
laminarModel(const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)
Construct from components.
Definition: laminarModel.C:48
label patchi
U
Definition: pEqn.H:72
virtual void correct()
Correct the laminar transport.
Definition: laminarModel.C:271
Switch printCoeffs_
Flag to print the model coeffs at run-time.
Definition: laminarModel.H:62
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
dictionary coeffDict_
Model coefficients dictionary.
Definition: laminarModel.H:65
volScalarField alpha(IOobject("alpha", runTime.timeName(), mesh, IOobject::READ_IF_PRESENT, IOobject::AUTO_WRITE), lambda *max(Ua &U, zeroSensitivity))
A class for managing temporary objects.
Definition: PtrList.H:53
virtual const dictionary & coeffDict() const
Const access to the coefficients dictionary.
Definition: laminarModel.H:150
static autoPtr< laminarModel > New(const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)
Return a reference to the selected laminar model.
Definition: laminarModel.C:84
Namespace for OpenFOAM.