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