AnisothermalPhaseModel.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-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::AnisothermalPhaseModel
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  AnisothermalPhaseModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef AnisothermalPhaseModel_H
37 #define AnisothermalPhaseModel_H
38 
39 #include "phaseModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class AnisothermalPhaseModel Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class BasePhaseModel>
52 :
53  public BasePhaseModel
54 {
55  // Private Member Functions
56 
57  //- Optionally filter the pressure work term as the phase-fraction -> 0
58  tmp<volScalarField> filterPressureWork
59  (
60  const tmp<volScalarField>& pressureWork
61  ) const;
62 
63 
64 public:
65 
66  // Constructors
67 
69  (
70  const phaseSystem& fluid,
71  const word& phaseName,
72  const bool referencePhase,
73  const label index
74  );
75 
76 
77  //- Destructor
78  virtual ~AnisothermalPhaseModel();
79 
80 
81  // Member Functions
82 
83  //- Correct the thermodynamics
84  virtual void correctThermo();
85 
86  //- Return whether the phase is isothermal
87  virtual bool isothermal() const;
88 
89  //- Return the enthalpy equation
90  virtual tmp<fvScalarMatrix> heEqn();
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #ifdef NoRepository
101  #include "AnisothermalPhaseModel.C"
102 #endif
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
virtual void correctThermo()
Correct the thermodynamics.
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
virtual bool isothermal() const
Return whether the phase is isothermal.
Class which represents a phase for which the temperature (strictly energy) varies. Returns the energy equation and corrects the thermodynamic model.
AnisothermalPhaseModel(const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index)
Class to represent a system of phases and model interfacial transfers between them.
Definition: phaseSystem.H:67
A class for handling words, derived from string.
Definition: word.H:59
phaseSystem & fluid
Definition: createFields.H:11
virtual ~AnisothermalPhaseModel()
Destructor.
A class for managing temporary objects.
Definition: PtrList.H:53
virtual tmp< fvScalarMatrix > heEqn()
Return the enthalpy equation.
Namespace for OpenFOAM.