src/thermophysicalModels/chemistryModel/chemistryModel/ODEChemistryModel/ODEChemistryModel.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2009-2009 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::ODEChemistryModel
  27
  28 Description
  29     Extends base chemistry model by adding a thermo package, and ODE functions.
  30     Introduces chemistry equation system and evaluation of chemical source
  31     terms.
  32
  33 SourceFiles
  34     ODEChemistryModelI.H
  35     ODEChemistryModel.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef ODEChemistryModel_H
  40 #define ODEChemistryModel_H
  41
  42 #include <reactionThermophysicalModels/hCombustionThermo.H>
  43 #include <specie/Reaction.H>
  44 #include <ODE/ODE.H>
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 // Forward declaration of classes
  52 template<class CompType, class ThermoType>
  53 class chemistrySolver;
  54
  55 /*---------------------------------------------------------------------------*\
  56                       Class ODEChemistryModel Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 template<class CompType, class ThermoType>
  60 class ODEChemistryModel
  61 :
  62     public CompType,
  63     public ODE
  64 {
  65     // Private Member Functions
  66
  67         //- Disallow default bitwise assignment
  68         void operator=(const ODEChemistryModel&);
  69
  70
  71 protected:
  72
  73     // Private data
  74
  75         //- Reference to the field of specie mass fractions
  76         PtrList<volScalarField>& Y_;
  77
  78         //- Reactions
  79         const PtrList<Reaction<ThermoType> >& reactions_;
  80
  81         //- Thermodynamic data of the species
  82         const PtrList<ThermoType>& specieThermo_;
  83
  84         //- Number of species
  85         label nSpecie_;
  86
  87         //- Number of reactions
  88         label nReaction_;
  89
  90         //- Chemistry solver
  91         autoPtr<chemistrySolver<CompType, ThermoType> > solver_;
  92
  93         //- Chemical source term
  94         PtrList<scalarField> RR_;
  95
  96
  97     // Protected Member Functions
  98
  99         //- Write access to chemical source terms
 100         //  (e.g. for multi-chemistry model)
 101         inline PtrList<scalarField>& RR();
 102
 103
 104 public:
 105
 106     //- Runtime type information
 107     TypeName("ODEChemistryModel");
 108
 109
 110     // Constructors
 111
 112         //- Construct from components
 113         ODEChemistryModel
 114         (
 115             const fvMesh& mesh,
 116             const word& compTypeName,
 117             const word& thermoTypeName
 118         );
 119
 120
 121     //- Destructor
 122     virtual ~ODEChemistryModel();
 123
 124
 125     // Member Functions
 126
 127         //- The reactions
 128         inline const PtrList<Reaction<ThermoType> >& reactions() const;
 129
 130         //- Thermodynamic data of the species
 131         inline const PtrList<ThermoType>& specieThermo() const;
 132
 133         //- The number of species
 134         inline label nSpecie() const;
 135
 136         //- The number of reactions
 137         inline label nReaction() const;
 138
 139         //- Return the chemisty solver
 140         inline const chemistrySolver<CompType, ThermoType>& solver() const;
 141
 142         //- dc/dt = omega, rate of change in concentration, for each species
 143         virtual scalarField omega
 144         (
 145             const scalarField& c,
 146             const scalar T,
 147             const scalar p
 148         ) const;
 149
 150         //- Return the reaction rate for reaction r and the reference
 151         //  species and charateristic times
 152         virtual scalar omega
 153         (
 154             const Reaction<ThermoType>& r,
 155             const scalarField& c,
 156             const scalar T,
 157             const scalar p,
 158             scalar& pf,
 159             scalar& cf,
 160             label& lRef,
 161             scalar& pr,
 162             scalar& cr,
 163             label& rRef
 164         ) const;
 165
 166         //- Calculates the reaction rates
 167         virtual void calculate();
 168
 169
 170         // Chemistry model functions (overriding abstract functions in
 171         // chemistryModel.H)
 172
 173             //- Return const access to the chemical source terms
 174             inline tmp<volScalarField> RR(const label i) const;
 175
 176             //- Solve the reaction system for the given start time and time
 177             //  step and return the characteristic time
 178             virtual scalar solve(const scalar t0, const scalar deltaT);
 179
 180             //- Return the chemical time scale
 181             virtual tmp<volScalarField> tc() const;
 182
 183             //- Return the heat release
 184             virtual tmp<volScalarField> dQ() const;
 185
 186
 187         // ODE functions (overriding abstract functions in ODE.H)
 188
 189             //- Number of ODE's to solve
 190             virtual label nEqns() const;
 191
 192             virtual void derivatives
 193             (
 194                 const scalar t,
 195                 const scalarField& c,
 196                 scalarField& dcdt
 197             ) const;
 198
 199             virtual void jacobian
 200             (
 201                 const scalar t,
 202                 const scalarField& c,
 203                 scalarField& dcdt,
 204                 scalarSquareMatrix& dfdc
 205             ) const;
 206 };
 207
 208
 209 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 210
 211 } // End namespace Foam
 212
 213 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 214
 215 #include "ODEChemistryModelI.H"
 216
 217 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 218
 219 #ifdef NoRepository
 220 #   include "ODEChemistryModel.C"
 221 #endif
 222
 223 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 224
 225 #endif
 226
 227 // ************************ vim: set sw=4 sts=4 et: ************************ //