src/thermophysicalModels/chemistryModel/chemistrySolver/ode/ode.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
   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::ode
  26
  27 Description
  28     An ODE solver for chemistry
  29
  30 SourceFiles
  31     ode.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef ode_H
  36 #define ode_H
  37
  38 #include "chemistrySolver.H"
  39 #include "ODESolver.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                             Class ode Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class ODEChemistryType>
  51 class ode
  52 :
  53     public chemistrySolver<ODEChemistryType>
  54 {
  55     // Private data
  56
  57         dictionary coeffsDict_;
  58         const word solverName_;
  59         autoPtr<ODESolver> odeSolver_;
  60
  61         // Model constants
  62
  63             scalar eps_;
  64
  65
  66 public:
  67
  68     //- Runtime type information
  69     TypeName("ODE");
  70
  71
  72     // Constructors
  73
  74         //- Construct from components
  75         ode
  76         (
  77             const fvMesh& mesh,
  78             const word& ODEModeNewlName,
  79             const word& thermoType
  80         );
  81
  82
  83     //- Destructor
  84     virtual ~ode();
  85
  86
  87     // Member Functions
  88
  89         virtual scalar solve
  90         (
  91             scalarField& c,
  92             const scalar T,
  93             const scalar p,
  94             const scalar t0,
  95             const scalar dt
  96         ) const;
  97 };
  98
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 } // End namespace Foam
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #ifdef NoRepository
 107 #   include "ode.C"
 108 #endif
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #endif
 113
 114 // ************************************************************************* //