noChemistryTabulation.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) 2016-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::chemistryTabulationMethods::none
26 
27 Description
28  A chemistryTabulationMethod which does nothing to allow tabulation to be
29  switched-off.
30 
31 SourceFiles
32  noChemistryTabulation.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef noChemistryTabulation_H
37 #define noChemistryTabulation_H
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
42 
43 namespace Foam
44 {
45 namespace chemistryTabulationMethods
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class none Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class none
53 :
55 {
56 public:
57 
58  //- Runtime type information
59  TypeName("none");
60 
61  // Constructors
62 
63  //- Construct from dictionary
64  none
65  (
66  const dictionary& chemistryProperties,
68  );
69 
70  //- Disallow default bitwise copy construction
71  none(const none&) = delete;
72 
73 
74  // Destructor
75  virtual ~none();
76 
77 
78  // Member Functions
79 
80  //- Return false as this tabulation method does not tabulate
81  virtual bool tabulates()
82  {
83  return false;
84  }
85 
86  //- Find the closest stored leaf of phiQ and store the result in
87  // RphiQ or return false.
88  virtual bool retrieve
89  (
90  const Foam::scalarField& phiq,
91  scalarField& Rphiq
92  )
93  {
94  return false;
95  }
96 
97  // Add information to the tabulation.This function can grow an
98  // existing point or add a new leaf to the binary tree Input : phiq
99  // the new composition to store Rphiq the mapping of the new
100  // composition point
101  virtual label add
102  (
103  const scalarField& phiq,
104  const scalarField& Rphiq,
105  const label nActive,
106  const label li,
107  const scalar deltaT
108  )
109  {
110  return false;
111  }
113  virtual bool update()
114  {
115  return false;
116  }
118  virtual void reset()
119  {}
120 };
121 
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 } // End namespace chemistryTabulationMethods
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #endif
131 
132 // ************************************************************************* //
TypeName("none")
Runtime type information.
virtual bool retrieve(const Foam::scalarField &phiq, scalarField &Rphiq)
Find the closest stored leaf of phiQ and store the result in.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual bool tabulates()
Return false as this tabulation method does not tabulate.
A chemistryTabulationMethod which does nothing to allow tabulation to be switched-off.
basicChemistryModel & chemistry
none(const dictionary &chemistryProperties, const odeChemistryModel &chemistry)
Construct from dictionary.
An abstract class for chemistry tabulation.
virtual label add(const scalarField &phiq, const scalarField &Rphiq, const label nActive, const label li, const scalar deltaT)
Extends base chemistry model adding an ODESystem and the reduction maps needed for tabulation...
Namespace for OpenFOAM.