laminarThermophysicalTransportModel.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) 2020-2026 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::laminarThermophysicalTransportModel
26 
27 Description
28  Templated abstract base class for laminar thermophysical transport models
29 
30 SourceFiles
31  laminarThermophysicalTransportModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef laminarThermophysicalTransportModel_H
36 #define laminarThermophysicalTransportModel_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class laminarThermophysicalTransportModel Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class BasicThermophysicalTransportModel>
51 :
52  public BasicThermophysicalTransportModel
53 {
54 
55 protected:
56 
57  // Protected Member Functions
58 
59  //- Const access to the coefficients dictionary
60  const dictionary& typeDict() const;
61 
62  //- Const access to the coefficients dictionary
63  const dictionary& typeDict(const word&) const;
64 
65  //- Effective thermal turbulent diffusivity of mixture [kg/m/s]
66  // Used for the implicit energy correction on the temperature laplacian
68  {
69  return volScalarField::New
70  (
71  "alphaEff",
72  this->thermo().kappa()/this->thermo().Cpv()
73  );
74  }
75 
76 
77 public:
78 
79  typedef typename BasicThermophysicalTransportModel::alphaField
80  alphaField;
81 
84 
85  typedef typename BasicThermophysicalTransportModel::thermoModel
87 
88 
89  //- Runtime type information
90  TypeName("laminar");
91 
92 
93  // Declare run-time constructor selection table
94 
96  (
97  autoPtr,
99  dictionary,
100  (
101  const momentumTransportModel& momentumTransport,
102  const thermoModel& thermo
103  ),
104  (momentumTransport, thermo)
105  );
106 
107 
108  // Constructors
109 
110  //- Construct from components
112  (
113  const word& type,
114  const momentumTransportModel& momentumTransport,
115  const thermoModel& thermo
116  );
117 
118  //- Disallow default bitwise copy construction
120  (
122  ) = delete;
123 
124 
125  // Selectors
126 
127  //- Return a reference to the selected laminar model
129  (
130  const momentumTransportModel& momentumTransport,
131  const thermoModel& thermo
132  );
133 
134 
135  //- Destructor
137  {}
138 
139 
140  // Member Functions
141 
142  //- Read model coefficients if they have changed
143  virtual bool read();
144 
145  //- Effective thermal turbulent conductivity
146  // of mixture [W/m/K]
147  virtual tmp<volScalarField> kappaEff() const
148  {
149  return volScalarField::New
150  (
151  "kappaEff",
152  this->thermo().kappa()
153  );
154  }
155 
156  //- Effective thermal turbulent conductivity
157  // of mixture for patch [W/m/K]
158  virtual tmp<scalarField> kappaEff(const label patchi) const
159  {
160  return this->thermo().kappa().boundaryField()[patchi];
161  }
162 
163  //- Effective thermal turbulent diffusivity
164  // of mixture for a patch [kg/m/s]
165  virtual tmp<scalarField> alphaEff(const label patchi) const
166  {
167  return
168  this->thermo().kappa().boundaryField()[patchi]
169  /this->thermo().Cpv().boundaryField()[patchi];
170  }
171 
172  //- Predict the laminar transport coefficients if possible
173  // without solving thermophysical transport model equations
174  virtual void predict();
175 
176  //- Solve the thermophysical transport model equations
177  // and correct the laminar transport coefficients
178  virtual void correct();
179 
180 
181  // Member Operators
182 
183  //- Disallow default bitwise assignment
184  void operator=(const laminarThermophysicalTransportModel&) = delete;
185 };
186 
187 
188 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
189 
190 } // End namespace Foam
191 
192 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
193 
194 #ifdef NoRepository
196 #endif
197 
198 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
199 
200 #endif
201 
202 // ************************************************************************* //
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > > New(const word &name, const Internal &, const PtrList< Patch > &, const HashPtrTable< Source > &=HashPtrTable< Source >())
Return a temporary field constructed from name,.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Templated abstract base class for laminar thermophysical transport models.
BasicThermophysicalTransportModel::alphaField alphaField
virtual void correct()
Solve the thermophysical transport model equations.
laminarThermophysicalTransportModel(const word &type, const momentumTransportModel &momentumTransport, const thermoModel &thermo)
Construct from components.
static autoPtr< laminarThermophysicalTransportModel > New(const momentumTransportModel &momentumTransport, const thermoModel &thermo)
Return a reference to the selected laminar model.
declareRunTimeSelectionTable(autoPtr, laminarThermophysicalTransportModel, dictionary,(const momentumTransportModel &momentumTransport, const thermoModel &thermo),(momentumTransport, thermo))
virtual void predict()
Predict the laminar transport coefficients if possible.
const dictionary & typeDict() const
Const access to the coefficients dictionary.
void operator=(const laminarThermophysicalTransportModel &)=delete
Disallow default bitwise assignment.
TypeName("laminar")
Runtime type information.
tmp< volScalarField > alphaEff() const
Effective thermal turbulent diffusivity of mixture [kg/m/s].
BasicThermophysicalTransportModel::thermoModel thermoModel
virtual tmp< volScalarField > kappaEff() const
Effective thermal turbulent conductivity.
BasicThermophysicalTransportModel::momentumTransportModel momentumTransportModel
virtual bool read()
Read model coefficients if they have changed.
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:63
label patchi
compressibleMomentumTransportModel momentumTransportModel
const dimensionedScalar kappa
Coulomb constant: default SI units: [N.m2/C2].
Namespace for OpenFOAM.
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
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488
fluidMulticomponentThermo & thermo
Definition: createFields.H:15