src/thermophysicalModels/chemistryModel/chemistrySolver/sequential/sequential.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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::sequential
  26
  27 Description
  28     Foam::sequential
  29
  30 SourceFiles
  31     sequentialI.H
  32     sequential.C
  33     sequentialIO.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef sequential_H
  38 #define sequential_H
  39
  40 #include "chemistrySolver.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                          Class sequential Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class ODEChemistryType>
  52 class sequential
  53 :
  54     public chemistrySolver<ODEChemistryType>
  55 {
  56     // Private data
  57
  58         //- Coefficients dictionary
  59         dictionary coeffsDict_;
  60
  61
  62         // Model constants
  63
  64             //- Chemistry time scale
  65             scalar cTauChem_;
  66
  67             //- Equilibrium rate limiter flag (on/off)
  68             Switch eqRateLimiter_;
  69
  70
  71 public:
  72
  73     //- Runtime type information
  74     TypeName("sequential");
  75
  76
  77     // Constructors
  78
  79         //- Construct from components
  80         sequential
  81         (
  82             const fvMesh& mesh,
  83             const word& ODEModelName,
  84             const word& thermoType
  85         );
  86
  87
  88     //- Destructor
  89     virtual ~sequential();
  90
  91
  92     // Member Functions
  93
  94         //- Update the concentrations and return the chemical time
  95         virtual scalar solve
  96         (
  97             scalarField &c,
  98             const scalar T,
  99             const scalar p,
 100             const scalar t0,
 101             const scalar dt
 102         ) const;
 103 };
 104
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 } // End namespace Foam
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #ifdef NoRepository
 113 #   include "sequential.C"
 114 #endif
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 #endif
 119
 120 // ************************************************************************* //