Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / thermophysicalModels / chemistryModel / chemistrySolver / EulerImplicit / EulerImplicit.H
bloba65845dd63ed03677800c42481c464ae29c3fc60
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::EulerImplicit
27 Description
28     An Euler implicit solver for chemistry
30 SourceFiles
31     EulerImplicit.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef EulerImplicit_H
36 #define EulerImplicit_H
38 #include "chemistrySolver.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 // Forward declaration of classes
46 template<class CompType, class ThermoType>
47 class EulerImplicit;
49 /*---------------------------------------------------------------------------*\
50                        Class EulerImplicit Declaration
51 \*---------------------------------------------------------------------------*/
53 template<class CompType, class ThermoType>
54 class EulerImplicit
56     public chemistrySolver<CompType, ThermoType>
58     // Private data
60         dictionary coeffsDict_;
62         // Model constants
64             scalar cTauChem_;
65             Switch equil_;
68 public:
70     //- Runtime type information
71     TypeName("EulerImplicit");
74     // Constructors
76         //- Construct from components
77         EulerImplicit
78         (
79             ODEChemistryModel<CompType, ThermoType>& model,
80             const word& modelName
81         );
84     // Destructor
86        virtual ~EulerImplicit();
89     // Member Functions
91         //- Update the concentrations and return the chemical time
92         scalar solve
93         (
94             scalarField &c,
95             const scalar T,
96             const scalar p,
97             const scalar t0,
98             const scalar dt
99         ) const;
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 } // End namespace Foam
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 #ifdef NoRepository
110 #   include "EulerImplicit.C"
111 #endif
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 #endif
117 // ************************************************************************* //