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