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