thermophysicalTransportModel.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-2022 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::thermophysicalTransportModel
26 
27 Description
28  Abstract base class for all fluid and solid thermophysical transport models
29 
30 SourceFiles
31  thermophysicalTransportModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef thermophysicalTransportModel_H
36 #define thermophysicalTransportModel_H
37 
38 #include "IOdictionary.H"
39 #include "fvMatrix.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class thermophysicalTransportModel Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public IOdictionary
53 {
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("thermophysicalTransport");
59 
60 
61  // Constructors
62 
63  //- Construct from mesh and group
65  (
66  const fvMesh& mesh,
67  const word& group
68  );
69 
70  //- Disallow default bitwise copy construction
72  (
74  ) = delete;
75 
76 
77  //- Destructor
79  {}
80 
81 
82  // Member Functions
83 
84  //- Read model coefficients if they have changed
85  virtual bool read() = 0;
86 
87  //- Const access to the coefficients dictionary
88  virtual const dictionary& coeffDict() const = 0;
89 
90  //- Effective thermal turbulent conductivity
91  // of mixture [W/m/K]
92  virtual tmp<volScalarField> kappaEff() const = 0;
93 
94  //- Effective thermal turbulent conductivity
95  // of mixture for patch [W/m/K]
96  virtual tmp<scalarField> kappaEff(const label patchi) const = 0;
97 
98  //- Return the heat flux [W/m^2]
99  virtual tmp<surfaceScalarField> q() const = 0;
100 
101  //- Return the patch heat flux correction [W/m^2]
102  // For isotropic or patch-aligned thermal conductivity qCorr is null
103  virtual tmp<scalarField> qCorr(const label patchi) const = 0;
104 
105  //- Return the source term for the energy equation
106  virtual tmp<fvScalarMatrix> divq(volScalarField& he) const = 0;
107 
108  //- Predict the thermophysical transport coefficients if possible
109  // without solving thermophysical transport model equations
110  virtual void predict() = 0;
111 
112  //- Solve the thermophysical transport model equations
113  // and correct the thermophysical transport coefficients
114  virtual void correct();
115 
116 
117  // Member Operators
118 
119  //- Disallow default bitwise assignment
120  void operator=(const thermophysicalTransportModel&) = delete;
121 };
122 
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #endif
131 
132 // ************************************************************************* //
Generic GeometricField class.
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:57
word group() const
Return group (extension part of name)
Definition: IOobject.C:324
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
Abstract base class for all fluid and solid thermophysical transport models.
void operator=(const thermophysicalTransportModel &)=delete
Disallow default bitwise assignment.
virtual tmp< scalarField > qCorr(const label patchi) const =0
Return the patch heat flux correction [W/m^2].
thermophysicalTransportModel(const fvMesh &mesh, const word &group)
Construct from mesh and group.
virtual void correct()
Solve the thermophysical transport model equations.
virtual const dictionary & coeffDict() const =0
Const access to the coefficients dictionary.
TypeName("thermophysicalTransport")
Runtime type information.
virtual tmp< volScalarField > kappaEff() const =0
Effective thermal turbulent conductivity.
virtual tmp< fvScalarMatrix > divq(volScalarField &he) const =0
Return the source term for the energy equation.
virtual bool read()=0
Read model coefficients if they have changed.
virtual void predict()=0
Predict the thermophysical transport coefficients if possible.
virtual tmp< surfaceScalarField > q() const =0
Return the heat flux [W/m^2].
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:62
label patchi
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
thermo he()