Merge branch 'upstream/OpenFOAM' into master
[freefoam.git] / src / thermophysicalModels / chemistryModel / chemistrySolver / sequential / sequential.H
blobef66a2764984a72a8083b7a9e81357364aecbcec
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::sequential
28 Description
29     Foam::sequential
31 SourceFiles
32     sequentialI.H
33     sequential.C
34     sequentialIO.C
36 \*---------------------------------------------------------------------------*/
38 #ifndef sequential_H
39 #define sequential_H
41 #include <chemistryModel/chemistrySolver.H>
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 namespace Foam
48 // Forward declaration of classes
49 template<class CompType, class ThermoType>
50 class sequential;
52 /*---------------------------------------------------------------------------*\
53                          Class sequential Declaration
54 \*---------------------------------------------------------------------------*/
56 template<class CompType, class ThermoType>
57 class sequential
59     public chemistrySolver<CompType, ThermoType>
61     // Private data
63         dictionary coeffsDict_;
65         // Model constants
67             scalar cTauChem_;
68             Switch equil_;
71 public:
73     //- Runtime type information
74     TypeName("sequential");
77     // Constructors
80         //- Construct from components
81         sequential
82         (
83             ODEChemistryModel<CompType, ThermoType>& model,
84             const word& modelName
85         );
88     //- Destructor
89     virtual ~sequential();
92     // Member Functions
94         //- Update the concentrations and return the chemical time
95         scalar solve
96         (
97             scalarField &c,
98             const scalar T,
99             const scalar p,
100             const scalar t0,
101             const scalar dt
102         ) const;
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 } // End namespace Foam
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 #ifdef NoRepository
113 #   include "sequential.C"
114 #endif
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 #endif
120 // ************************ vim: set sw=4 sts=4 et: ************************ //