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-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::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:
59 
60  // Private Data
61 
62  //- The name of the phase
63  word phaseName_;
64 
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("Qdot");
70 
71 
72  // Constructors
73 
74  //- Construct from Time and dictionary
75  Qdot
76  (
77  const word& name,
78  const Time& runTime,
79  const dictionary& dict
80  );
81 
82 
83  //- Destructor
84  virtual ~Qdot();
85 
86 
87  // Member Functions
88 
89  //- Read the data
90  virtual bool read(const dictionary&);
91 
92  //- Return the list of fields required
93  virtual wordList fields() const
94  {
95  return wordList::null();
96  }
97 
98  //- Calculate the Qdot field
99  virtual bool execute();
100 
101  //- Do nothing
102  virtual bool write();
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace functionObjects
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
TypeName("Qdot")
Runtime type information.
dictionary dict
const word & name() const
Return the name of this functionObject.
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
virtual ~Qdot()
Destructor.
Definition: Qdot.C:69
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:69
Qdot(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
Definition: Qdot.C:52
virtual bool write()
Do nothing.
Definition: Qdot.C:111
A class for handling words, derived from string.
Definition: word.H:59
Calculates and outputs the heat release rate for the current combustion model.
Definition: Qdot.H:52
virtual bool read(const dictionary &)
Read the data.
Definition: Qdot.C:76
virtual wordList fields() const
Return the list of fields required.
Definition: Qdot.H:92
FunctionObject base class for managing a list of objects on behalf of the inheriting function object...
Specialisation of Foam::functionObject for an Foam::fvMesh, providing a reference to the Foam::fvMesh...
virtual bool execute()
Calculate the Qdot field.
Definition: Qdot.C:89
Namespace for OpenFOAM.