ThermalPhaseModel.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) 2015-2025 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::ThermalPhaseModel
26 
27 Description
28  Class which represents a phase for which the temperature (strictly energy)
29  varies. Returns the energy equation and corrects the thermodynamic model.
30 
31 SourceFiles
32  ThermalPhaseModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef ThermalPhaseModel_H
37 #define ThermalPhaseModel_H
38 
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class ThermalPhaseModel Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class BasePhaseModel>
53 :
54  public ThermophysicalTransportPhaseModel<BasePhaseModel>
55 {
56  // Private Member Data
57 
58  //- Gravitational acceleration
60 
61 
62  // Private Member Functions
63 
64  //- Optionally filter the pressure work term as the phase-fraction -> 0
65  tmp<volScalarField> filterPressureWork
66  (
67  const tmp<volScalarField>& pressureWork
68  ) const;
69 
70 
71 public:
72 
73  // Constructors
74 
76  (
77  const phaseSystem& fluid,
78  const word& phaseName,
79  const bool referencePhase,
80  const label index
81  );
82 
83 
84  //- Destructor
85  virtual ~ThermalPhaseModel();
86 
87 
88  // Member Functions
89 
90  //- Correct the thermodynamics
91  virtual void correctThermo();
92 
93  //- Return whether the phase is isothermal
94  virtual bool isothermal() const;
95 
96  //- Return the enthalpy equation
97  virtual tmp<fvScalarMatrix> heEqn();
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #ifdef NoRepository
108  #include "ThermalPhaseModel.C"
109 #endif
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
Class which represents a phase for which the temperature (strictly energy) varies....
virtual ~ThermalPhaseModel()
Destructor.
ThermalPhaseModel(const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index)
virtual void correctThermo()
Correct the thermodynamics.
virtual bool isothermal() const
Return whether the phase is isothermal.
virtual tmp< fvScalarMatrix > heEqn()
Return the enthalpy equation.
Class which makes thermophysical transport modelling available to derived classes.
Class to represent a system of phases.
Definition: phaseSystem.H:74
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:62
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