IsothermalPhaseModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2015 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::IsothermalPhaseModel
26 
27 Description
28  Class which represents a phase for which the temperature (strictly energy)
29  remains constant. Returns an empty energy equation and does nothing when
30  correctThermo is called.
31 
32 SourceFiles
33  IsothermalPhaseModel.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef IsothermalPhaseModel_H
38 #define IsothermalPhaseModel_H
39 
40 #include "phaseModel.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class phaseModel Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class BasePhaseModel>
53 :
54  public BasePhaseModel
55 {
56 public:
57 
58  // Constructors
59 
61  (
62  const phaseSystem& fluid,
63  const word& phaseName,
64  const label index
65  );
66 
67 
68  //- Destructor
69  virtual ~IsothermalPhaseModel();
70 
71 
72  // Member Functions
73 
74  //- Correct the thermodynamics
75  virtual void correctThermo();
76 
77  //- Return the enthalpy equation
78  virtual tmp<fvScalarMatrix> heEqn();
79 };
80 
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 } // End namespace Foam
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 #ifdef NoRepository
89 # include "IsothermalPhaseModel.C"
90 #endif
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 #endif
95 
96 // ************************************************************************* //
multiphaseSystem & fluid
Definition: createFields.H:10
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
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
Namespace for OpenFOAM.
virtual tmp< fvScalarMatrix > heEqn()
Return the enthalpy equation.
Class which represents a phase for which the temperature (strictly energy) remains constant...
virtual void correctThermo()
Correct the thermodynamics.
virtual ~IsothermalPhaseModel()
Destructor.
IsothermalPhaseModel(const phaseSystem &fluid, const word &phaseName, const label index)
A class for managing temporary objects.
Definition: PtrList.H:118