AnisothermalPhaseModel.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2015-2018 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::AnisothermalPhaseModel
28 
29 Description
30  Class which represents a phase for which the temperature (strictly energy)
31  varies. Returns the energy equation and corrects the thermodynamic model.
32 
33 SourceFiles
34  AnisothermalPhaseModel.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef AnisothermalPhaseModel_H
39 #define AnisothermalPhaseModel_H
40 
41 #include "phaseModel.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class AnisothermalPhaseModel Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 template<class BasePhaseModel>
54 :
55  public BasePhaseModel
56 {
57  // Private member functions
58 
59  //- Optionally filter the pressure work term as the phase-fraction -> 0
60  tmp<volScalarField> filterPressureWork
61  (
62  const tmp<volScalarField>& pressureWork
63  ) const;
64 
65 
66 public:
67 
68  // Constructors
69 
71  (
72  const phaseSystem& fluid,
73  const word& phaseName,
74  const label index
75  );
76 
77 
78  //- Destructor
79  virtual ~AnisothermalPhaseModel();
80 
81 
82  // Member Functions
83 
84  //- Correct the thermodynamics
85  virtual void correctThermo();
86 
87  //- Return whether the phase is isothermal
88  virtual bool isothermal() const;
89 
90  //- Return the enthalpy equation
91  virtual tmp<fvScalarMatrix> heEqn();
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #ifdef NoRepository
102  #include "AnisothermalPhaseModel.C"
103 #endif
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::AnisothermalPhaseModel::AnisothermalPhaseModel
AnisothermalPhaseModel(const phaseSystem &fluid, const word &phaseName, const label index)
Definition: AnisothermalPhaseModel.C:63
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::AnisothermalPhaseModel::correctThermo
virtual void correctThermo()
Correct the thermodynamics.
Definition: AnisothermalPhaseModel.C:83
Foam::AnisothermalPhaseModel::~AnisothermalPhaseModel
virtual ~AnisothermalPhaseModel()
Destructor.
Definition: AnisothermalPhaseModel.C:76
fluid
twoPhaseSystem & fluid
Definition: setRegionFluidFields.H:3
AnisothermalPhaseModel.C
Foam::AnisothermalPhaseModel::heEqn
virtual tmp< fvScalarMatrix > heEqn()
Return the enthalpy equation.
Definition: AnisothermalPhaseModel.C:100
Foam::AnisothermalPhaseModel
Class which represents a phase for which the temperature (strictly energy) varies....
Definition: AnisothermalPhaseModel.H:52
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::AnisothermalPhaseModel::isothermal
virtual bool isothermal() const
Return whether the phase is isothermal.
Definition: AnisothermalPhaseModel.C:92
Foam::phaseSystem
Class to represent a system of phases and model interfacial transfers between them.
Definition: phaseSystem.H:63