FreeFOAM The Cross-Platform CFD Toolkit
basicChemistryModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2009-2010 OpenCFD Ltd.
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::basicChemistryModel
26 
27 Description
28  Base class for chemistry models
29 
30 SourceFiles
31  basicChemistryModelI.H
32  basicChemistryModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef basicChemistryModel_H
37 #define basicChemistryModel_H
38 
39 #include <OpenFOAM/IOdictionary.H>
40 #include <OpenFOAM/Switch.H>
41 #include <OpenFOAM/scalarField.H>
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 // Forward declaration of classes
50 class fvMesh;
51 
52 /*---------------------------------------------------------------------------*\
53  class basicChemistryModel Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
58  public IOdictionary
59 {
60  // Private Member Functions
61 
62  //- Construct as copy (not implemented)
64 
65  //- Disallow default bitwise assignment
66  void operator=(const basicChemistryModel&);
67 
68 
69 protected:
70 
71  // Protected data
72 
73  //- Reference to the mesh database
74  const fvMesh& mesh_;
75 
76  //- Chemistry activation switch
78 
79  //- Latest estimation of integration step
81 
82 
83  // Protected member functions
84 
85  //- Return non-const access to the latest estimation of integration
86  // step, e.g. for multi-chemistry model
88 
89 
90 public:
91 
92  //- Runtime type information
93  TypeName("basicChemistryModel");
94 
95 
96  // Constructors
97 
98  //- Construct from mesh
100 
101 
102  //- Destructor
103  virtual ~basicChemistryModel();
104 
105 
106  // Member Functions
107 
108  //- Return const access to the mesh database
109  inline const fvMesh& mesh() const;
110 
111  //- Chemistry activation switch
112  inline Switch chemistry() const;
113 
114  //- Return the latest estimation of integration step
115  inline const scalarField& deltaTChem() const;
116 
117 
118  // Functions to be derived in derived classes
119 
120  // Fields
121 
122  //- Return const access to chemical source terms
123  virtual tmp<volScalarField> RR(const label i) const = 0;
124 
125 
126  // Chemistry solution
127 
128  //- Solve the reaction system for the given start time and
129  // timestep and return the characteristic time
130  virtual scalar solve(const scalar t0, const scalar deltaT) = 0;
131 
132  //- Return the chemical time scale
133  virtual tmp<volScalarField> tc() const = 0;
134 
135  //- Return source for enthalpy equation [kg/m/s3]
136  virtual tmp<volScalarField> Sh() const = 0;
137 
138  //- Return the heat release, i.e. enthalpy/sec [m2/s3]
139  virtual tmp<volScalarField> dQ() const = 0;
140 };
141 
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
145 } // End namespace Foam
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 #include "basicChemistryModelI.H"
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 #endif
154 
155 // ************************ vim: set sw=4 sts=4 et: ************************ //