noReaction.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) 2011-2026 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::reactionModels::noReaction
26 
27 Description
28  Dummy reaction model for 'no reaction'
29 
30 SourceFiles
31  noReaction.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef noReaction_H
36 #define noReaction_H
37 
38 #include "reactionModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace reactionModels
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class noReaction Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class noReaction
52 :
53  public reactionModel
54 {
55 public:
56 
57  //- Runtime type information
58  TypeName("none");
59 
60 
61  // Constructors
62 
63  //- Construct from components
65  (
66  const word& modelType,
69  const word& reactionProperties
70  );
71 
72  //- Disallow default bitwise copy construction
73  noReaction(const noReaction&) = delete;
74 
75 
76  //- Destructor
77  virtual ~noReaction();
78 
79 
80  // Member Functions
81 
82  //- Correct reaction rate
83  virtual void correct();
84 
85  //- Specie consumption rate field
86  virtual tmp<volScalarField::Internal> R(const label speciei) const;
87 
88  //- Specie consumption rate matrix
89  virtual tmp<fvScalarMatrix> R(volScalarField& Y) const;
90 
91  //- Heat release rate [kg/m/s^3]
92  virtual tmp<volScalarField> Qdot() const;
93 
94  //- Update properties from given dictionary
95  virtual bool read();
96 
97 
98  // Member Operators
99 
100  //- Disallow default bitwise assignment
101  void operator=(const noReaction&) = delete;
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace reactionModels
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
Generic GeometricField class.
Base class for single-phase compressible momentum transport models.
Base-class for multi-component fluid thermodynamic properties.
Base class for reaction models.
Definition: reactionModel.H:53
const fluidMulticomponentThermo & thermo() const
Return const access to the thermo.
Dummy reaction model for 'no reaction'.
Definition: noReaction.H:53
virtual void correct()
Correct reaction rate.
Definition: noReaction.C:64
void operator=(const noReaction &)=delete
Disallow default bitwise assignment.
TypeName("none")
Runtime type information.
virtual tmp< volScalarField::Internal > R(const label speciei) const
Specie consumption rate field.
Definition: noReaction.C:69
noReaction(const word &modelType, const fluidMulticomponentThermo &thermo, const compressibleMomentumTransportModel &turb, const word &reactionProperties)
Construct from components.
Definition: noReaction.C:45
virtual tmp< volScalarField > Qdot() const
Heat release rate [kg/m/s^3].
Definition: noReaction.C:89
virtual bool read()
Update properties from given dictionary.
Definition: noReaction.C:100
virtual ~noReaction()
Destructor.
Definition: noReaction.C:58
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:63
Namespace for OpenFOAM.
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
PtrList< volScalarField > & Y