src/thermophysicalModels/reactionThermo/reactionThermo/hReactionThermo/hReactionThermo.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::hReactionThermo
  27
  28 Description
  29     Foam::hReactionThermo
  30
  31 SourceFiles
  32     hReactionThermo.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef hReactionThermo_H
  37 #define hReactionThermo_H
  38
  39 #include "basicRhoThermo.H"
  40 #include "basicMultiComponentMixture.H"
  41 #include "autoPtr.H"
  42 #include "runTimeSelectionTables.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                      Class hReactionThermo Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class hReactionThermo
  54 :
  55     public basicRhoThermo
  56 {
  57
  58 protected:
  59
  60     // Protected data
  61
  62         //- Enthalpy field
  63         volScalarField h_;
  64
  65
  66 public:
  67
  68     //- Runtime type information
  69     TypeName("hReactionThermo");
  70
  71
  72     //- Declare run-time constructor selection tables
  73     declareRunTimeSelectionTable
  74     (
  75         autoPtr,
  76         hReactionThermo,
  77         fvMesh,
  78         (const fvMesh& mesh),
  79         (mesh)
  80     );
  81
  82
  83     // Constructors
  84
  85         //- Construct from dictionary and mesh
  86         hReactionThermo(const fvMesh&);
  87
  88
  89     // Selectors
  90
  91         //- Standard selection based on fvMesh
  92         static autoPtr<hReactionThermo> New(const fvMesh&);
  93
  94         //- Select and check that package contains 'thermoType'
  95         static autoPtr<hReactionThermo> NewType
  96         (
  97             const fvMesh&,
  98             const word& thermoType
  99         );
 100
 101
 102     //- Destructor
 103     virtual ~hReactionThermo();
 104
 105
 106     // Member functions
 107
 108         //- Return the composition of the multi-component mixture
 109         virtual basicMultiComponentMixture& composition() = 0;
 110
 111         //- Return the composition of the multi-component mixture
 112         virtual const basicMultiComponentMixture& composition() const = 0;
 113
 114
 115         // Access to thermodynamic state variables
 116
 117             //- Enthalpy [J/kg]
 118             //  Non-const access allowed for transport equations
 119             virtual volScalarField& h()
 120             {
 121                 return h_;
 122             }
 123
 124             //- Enthalpy [J/kg]
 125             virtual const volScalarField& h() const
 126             {
 127                 return h_;
 128             }
 129
 130
 131         //- Sensible enthalpy [J/kg]
 132         virtual tmp<volScalarField> hs() const = 0;
 133
 134         //- Chemical enthalpy [J/kg]
 135         virtual tmp<volScalarField> hc() const = 0;
 136
 137         //- Update properties
 138         virtual void correct() = 0;
 139 };
 140
 141
 142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 143
 144 } // End namespace Foam
 145
 146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 147
 148 #endif
 149
 150 // ************************************************************************* //