src/thermophysicalModels/chemistryModel/chemistrySolver/odeSolver/odeChemistrySolver.H

   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.
  10
  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.
  15
  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.
  20
  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/>.
  23
  24 Class
  25     Foam::ode
  26
  27 Description
  28     An ODE solver for chemistry
  29
  30 SourceFiles
  31     odeChemistrySolver.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef odeChemistrySolver_H
  36 #define odeChemistrySolver_H
  37
  38 #include "chemistrySolver.H"
  39 #include "ODESolver.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 // Forward declaration of classes
  47 template<class CompType, class ThermoType>
  48 class ode;
  49
  50 /*---------------------------------------------------------------------------*\
  51                             Class ode Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template<class CompType, class ThermoType>
  55 class ode
  56 :
  57     public chemistrySolver<CompType, ThermoType>
  58 {
  59     // Private data
  60
  61         dictionary coeffsDict_;
  62         const word solverName_;
  63         autoPtr<ODESolver> odeSolver_;
  64
  65         // Model constants
  66
  67             scalar eps_;
  68             scalar scale_;
  69
  70
  71 public:
  72
  73     //- Runtime type information
  74     TypeName("ODE");
  75
  76
  77     // Constructors
  78
  79         //- Construct from components
  80         ode
  81         (
  82             ODEChemistryModel<CompType, ThermoType>& model,
  83             const word& modelName
  84         );
  85
  86
  87     //- Destructor
  88     virtual ~ode();
  89
  90
  91     // Member Functions
  92
  93         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 "odeChemistrySolver.C"
 112 #endif
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 #endif
 117
 118 // ************************************************************************* //