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) 1991-2008 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::ode
  27
  28 Description
  29     An ODE solver for chemistry
  30
  31 SourceFiles
  32     ode.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef ode_H
  37 #define ode_H
  38
  39 #include "chemistrySolver.H"
  40 #include "ODESolver.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class ode Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class ode
  52 :
  53     public chemistrySolver
  54 {
  55     // Private data
  56
  57         chemistryModel& chemistry_;
  58
  59         dictionary coeffsDict_;
  60         const word solverName_;
  61         autoPtr<ODESolver> odeSolver_;
  62
  63         // model constants
  64
  65             scalar eps_;
  66             scalar scale_;
  67
  68
  69 public:
  70
  71     //- Runtime type information
  72     TypeName("ODE");
  73
  74
  75     // Constructors
  76
  77         //- Construct from components
  78         ode
  79         (
  80             const dictionary& dict,
  81             chemistryModel& chemistry
  82         );
  83
  84
  85     // Destructor
  86
  87         ~ode();
  88
  89
  90     // Member Functions
  91
  92         scalar solve
  93         (
  94             scalarField& c,
  95             const scalar T,
  96             const scalar p,
  97             const scalar t0,
  98             const scalar dt
  99         ) const;
 100 };
 101
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 } // End namespace Foam
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 #endif
 110
 111 // ************************************************************************* //