src/thermophysicalModels/specie/reaction/Reactions/NonEquilibriumReversibleReaction/NonEquilibriumReversibleReaction.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-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::NonEquilibriumReversibleReaction
  27
  28 Description
  29     Simple extension of Reaction to handle reversible reactions using
  30     equilibrium thermodynamics.
  31
  32 SourceFiles
  33     NonEquilibriumReversibleReaction.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef NonEquilibriumReversibleReaction_H
  38 #define NonEquilibriumReversibleReaction_H
  39
  40 #include "Reaction.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class NonEquilibriumReversibleReaction Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class ReactionThermo, class ReactionRate>
  52 class NonEquilibriumReversibleReaction
  53 :
  54     public Reaction<ReactionThermo>
  55 {
  56     // Private data
  57
  58         ReactionRate fk_;
  59         ReactionRate rk_;
  60
  61
  62     // Private Member Functions
  63
  64         //- Disallow default bitwise assignment
  65         void operator=
  66         (
  67             const NonEquilibriumReversibleReaction
  68                 <ReactionThermo, ReactionRate>&
  69         );
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName("nonEquilibriumReversible");
  76
  77
  78     // Constructors
  79
  80         //- Construct from components
  81         NonEquilibriumReversibleReaction
  82         (
  83             const Reaction<ReactionThermo>& reaction,
  84             const ReactionRate& forwardReactionRate,
  85             const ReactionRate& reverseReactionRate
  86         );
  87
  88         //- Construct as copy given new speciesTable
  89         NonEquilibriumReversibleReaction
  90         (
  91             const NonEquilibriumReversibleReaction
  92                 <ReactionThermo, ReactionRate>&,
  93             const speciesTable& species
  94         );
  95
  96         //- Construct from Istream
  97         NonEquilibriumReversibleReaction
  98         (
  99             const speciesTable& species,
 100             const HashPtrTable<ReactionThermo>& thermoDatabase,
 101             Istream& is
 102         );
 103
 104         //- Construct and return a clone
 105         virtual autoPtr<Reaction<ReactionThermo> > clone() const
 106         {
 107             return autoPtr<Reaction<ReactionThermo> >
 108             (
 109                 new NonEquilibriumReversibleReaction
 110                     <ReactionThermo, ReactionRate>(*this)
 111             );
 112         }
 113
 114         //- Construct and return a clone with new speciesTable
 115         virtual autoPtr<Reaction<ReactionThermo> > clone
 116         (
 117             const speciesTable& species
 118         ) const
 119         {
 120             return autoPtr<Reaction<ReactionThermo> >
 121             (
 122                 new NonEquilibriumReversibleReaction
 123                     <ReactionThermo, ReactionRate>
 124                     (*this, species)
 125             );
 126         }
 127
 128
 129     // Destructor
 130
 131         virtual ~NonEquilibriumReversibleReaction()
 132         {}
 133
 134
 135     // Member Functions
 136
 137         // NonEquilibriumReversibleReaction rate coefficients
 138
 139             //- Forward rate constant
 140             virtual scalar kf
 141             (
 142                 const scalar T,
 143                 const scalar p,
 144                 const scalarField& c
 145             ) const;
 146
 147             //- Reverse rate constant from the given formard rate constant
 148             virtual scalar kr
 149             (
 150                 const scalar kfwd,
 151                 const scalar T,
 152                 const scalar p,
 153                 const scalarField& c
 154             ) const;
 155
 156             //- Reverse rate constant.
 157             //  Note this evaluates the forward rate constant and divides by the
 158             //  equilibrium constant
 159             virtual scalar kr
 160             (
 161                 const scalar T,
 162                 const scalar p,
 163                 const scalarField& c
 164             ) const;
 165
 166
 167         //- Write
 168         virtual void write(Ostream&) const;
 169 };
 170
 171
 172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 173
 174 } // End namespace Foam
 175
 176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 177
 178 #ifdef NoRepository
 179 #   include "NonEquilibriumReversibleReaction.C"
 180 #endif
 181
 182 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 183
 184 #endif
 185
 186 // ************************************************************************* //