chemistrySolver.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) 2011-2015 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::chemistrySolver
26 
27 Description
28  An abstract base class for solving chemistry
29 
30 SourceFiles
31  chemistrySolver.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef chemistrySolver_H
36 #define chemistrySolver_H
37 
38 #include "chemistryModel.H"
39 #include "IOdictionary.H"
40 #include "scalarField.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class chemistrySolver Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class ChemistryModel>
52 class chemistrySolver
53 :
54  public ChemistryModel
55 {
56 
57 public:
58 
59  // Constructors
60 
61  //- Construct from components and phase name
62  chemistrySolver(const fvMesh& mesh, const word& phaseName);
63 
64 
65  //- Destructor
66  virtual ~chemistrySolver();
67 
68 
69  // Member Functions
70 
71  //- Update the concentrations and return the chemical time
72  virtual void solve
73  (
74  scalarField &c,
75  scalar& T,
76  scalar& p,
77  scalar& deltaT,
78  scalar& subDeltaT
79  ) const = 0;
80 };
81 
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 } // End namespace Foam
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 #ifdef NoRepository
90 # include "chemistrySolver.C"
91 #endif
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
virtual ~chemistrySolver()
Destructor.
A class for handling words, derived from string.
Definition: word.H:59
An abstract base class for solving chemistry.
dynamicFvMesh & mesh
Namespace for OpenFOAM.
virtual void solve(scalarField &c, scalar &T, scalar &p, scalar &deltaT, scalar &subDeltaT) const =0
Update the concentrations and return the chemical time.
volScalarField & p
Definition: createFields.H:51
chemistrySolver(const fvMesh &mesh, const word &phaseName)
Construct from components and phase name.
const dimensionedScalar c
Speed of light in a vacuum.