totalEnthalpy.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-2021 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::functionObjects::totalEnthalpy
26 
27 Description
28  Calculates and writes the total enthalpy (ha + K) as the volScalarField
29  'Ha'.
30 
31 See also
32  Foam::functionObjects::fvMeshFunctionObject
33  Foam::functionObjects::writeLocalObjects
34 
35 SourceFiles
36  totalEnthalpy.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef functionObjects_totalEnthalpy_H
41 #define functionObjects_totalEnthalpy_H
42 
43 #include "fieldExpression.H"
44 #include "writeLocalObjects.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 namespace functionObjects
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class totalEnthalpy Declaration
55 \*---------------------------------------------------------------------------*/
56 
57 class totalEnthalpy
58 :
59  public fvMeshFunctionObject,
60  public writeLocalObjects
61 {
62  // Private Data
63 
64  //- The name of the phase
65  word phaseName_;
66 
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("totalEnthalpy");
72 
73 
74  // Constructors
75 
76  //- Construct from Time and dictionary
78  (
79  const word& name,
80  const Time& runTime,
81  const dictionary&
82  );
83 
84 
85  //- Destructor
86  virtual ~totalEnthalpy();
87 
88 
89  // Member Functions
90 
91  //- Read the data
92  virtual bool read(const dictionary&);
93 
94  //- Return the list of fields required
95  virtual wordList fields() const
96  {
97  return wordList::null();
98  }
99 
100  //- Calculate the totalEnthalpy field
101  virtual bool execute();
102 
103  //- Do nothing
104  virtual bool write();
105 };
106 
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 } // End namespace functionObjects
111 } // End namespace Foam
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
const word & name() const
Return the name of this functionObject.
virtual wordList fields() const
Return the list of fields required.
Definition: totalEnthalpy.H:94
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
static const List< T > & null()
Return a null List.
Definition: ListI.H:118
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:69
virtual bool execute()
Calculate the totalEnthalpy field.
Definition: totalEnthalpy.C:82
virtual bool read(const dictionary &)
Read the data.
Definition: totalEnthalpy.C:69
totalEnthalpy(const word &name, const Time &runTime, const dictionary &)
Construct from Time and dictionary.
Definition: totalEnthalpy.C:45
A class for handling words, derived from string.
Definition: word.H:59
virtual ~totalEnthalpy()
Destructor.
Definition: totalEnthalpy.C:62
Calculates and writes the total enthalpy (ha + K) as the volScalarField &#39;Ha&#39;.
Definition: totalEnthalpy.H:56
FunctionObject base class for managing a list of objects on behalf of the inheriting function object...
virtual bool write()
Do nothing.
Specialisation of Foam::functionObject for an Foam::fvMesh, providing a reference to the Foam::fvMesh...
Namespace for OpenFOAM.
TypeName("totalEnthalpy")
Runtime type information.