noCombustion.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-2019 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::combustionModels::noCombustion
26 
27 Description
28  Dummy combustion model for 'no combustion'
29 
30 SourceFiles
31  noCombustion.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef noCombustion_H
36 #define noCombustion_H
37 
38 #include "ThermoCombustion.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace combustionModels
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class noCombustion Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class ReactionThermo>
52 class noCombustion
53 :
54  public ThermoCombustion<ReactionThermo>
55 {
56 public:
57 
58  //- Runtime type information
59  TypeName("none");
60 
61 
62  // Constructors
63 
64  //- Construct from components
66  (
67  const word& modelType,
68  ReactionThermo& thermo,
69  const compressibleTurbulenceModel& turb,
70  const word& combustionProperties
71  );
72 
73  //- Disallow default bitwise copy construction
74  noCombustion(const noCombustion&);
75 
76 
77  //- Destructor
78  virtual ~noCombustion();
79 
80 
81  // Member Functions
82 
83  //- Correct combustion rate
84  virtual void correct();
85 
86  //- Fuel consumption rate matrix
87  virtual tmp<fvScalarMatrix> R(volScalarField& Y) const;
88 
89  //- Heat release rate [kg/m/s^3]
90  virtual tmp<volScalarField> Qdot() const;
91 
92  //- Update properties from given dictionary
93  virtual bool read();
94 
95 
96  // Member Operators
97 
98  //- Disallow default bitwise assignment
99  void operator=(const noCombustion&) = delete;
100 };
101 
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 } // End namespace combustionModels
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #ifdef NoRepository
111  #include "noCombustion.C"
112 #endif
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************************************************************* //
virtual ~noCombustion()
Destructor.
Definition: noCombustion.C:47
virtual bool read()
Update properties from given dictionary.
Definition: noCombustion.C:88
TypeName("none")
Runtime type information.
virtual void correct()
Correct combustion rate.
Definition: noCombustion.C:54
Dummy combustion model for &#39;no combustion&#39;.
Definition: noCombustion.H:51
A class for handling words, derived from string.
Definition: word.H:59
virtual ReactionThermo & thermo()
Return access to the thermo package.
Abstract base class for turbulence models (RAS, LES and laminar).
Thermo model wrapper for combustion models.
void operator=(const noCombustion &)=delete
Disallow default bitwise assignment.
noCombustion(const word &modelType, ReactionThermo &thermo, const compressibleTurbulenceModel &turb, const word &combustionProperties)
Construct from components.
Definition: noCombustion.C:33
PtrList< volScalarField > & Y
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.
virtual tmp< fvScalarMatrix > R(volScalarField &Y) const
Fuel consumption rate matrix.
Definition: noCombustion.C:61
virtual tmp< volScalarField > Qdot() const
Heat release rate [kg/m/s^3].
Definition: noCombustion.C:76