src/thermophysicalModels/reactionThermo/mixtures/dieselMixture/dieselMixture.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::dieselMixture
  26
  27 Description
  28     Foam::dieselMixture
  29
  30 SourceFiles
  31     dieselMixture.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef dieselMixture_H
  36 #define dieselMixture_H
  37
  38 #include "basicMultiComponentMixture.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                          Class dieselMixture Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class ThermoType>
  50 class dieselMixture
  51 :
  52     public basicMultiComponentMixture
  53 {
  54     // Private data
  55
  56         static const int nSpecies_ = 2;
  57         static const char* specieNames_[2];
  58
  59         dimensionedScalar stoicRatio_;
  60
  61         ThermoType fuel_;
  62         ThermoType oxidant_;
  63         ThermoType products_;
  64
  65         mutable ThermoType mixture_;
  66
  67         volScalarField& ft_;
  68         volScalarField& fu_;
  69
  70         //- Construct as copy (not implemented)
  71         dieselMixture(const dieselMixture<ThermoType>&);
  72
  73
  74 public:
  75
  76     //- The type of thermodynamics this mixture is instantiated for
  77     typedef ThermoType thermoType;
  78
  79
  80     // Constructors
  81
  82         //- Construct from dictionary and mesh
  83         dieselMixture(const dictionary&, const fvMesh&);
  84
  85
  86     //- Destructor
  87     virtual ~dieselMixture()
  88     {}
  89
  90
  91     // Member functions
  92
  93         const dimensionedScalar& stoicRatio() const
  94         {
  95             return stoicRatio_;
  96         }
  97
  98         const ThermoType& mixture(const scalar, const scalar) const;
  99
 100         const ThermoType& cellMixture(const label celli) const
 101         {
 102             return mixture(ft_[celli], fu_[celli]);
 103         }
 104
 105         const ThermoType& patchFaceMixture
 106         (
 107             const label patchi,
 108             const label facei
 109         ) const
 110         {
 111             return mixture
 112             (
 113                 ft_.boundaryField()[patchi][facei],
 114                 fu_.boundaryField()[patchi][facei]
 115             );
 116         }
 117
 118         const ThermoType& cellReactants(const label celli) const
 119         {
 120             return mixture(ft_[celli], ft_[celli]);
 121         }
 122
 123         const ThermoType& patchFaceReactants
 124         (
 125             const label patchi,
 126             const label facei
 127         ) const
 128         {
 129             return mixture
 130             (
 131                 ft_.boundaryField()[patchi][facei],
 132                 ft_.boundaryField()[patchi][facei]
 133             );
 134         }
 135
 136         const ThermoType& cellProducts(const label celli) const
 137         {
 138             scalar ft = ft_[celli];
 139             return mixture(ft, fres(ft, stoicRatio().value()));
 140         }
 141
 142         const ThermoType& patchFaceProducts
 143         (
 144             const label patchi,
 145             const label facei
 146         ) const
 147         {
 148             scalar ft = ft_.boundaryField()[patchi][facei];
 149             return mixture(ft, fres(ft, stoicRatio().value()));
 150         }
 151
 152         //- Read dictionary
 153         void read(const dictionary&);
 154
 155         //- Return thermo based on index
 156         const ThermoType& getLocalThermo(const label specieI) const;
 157
 158
 159         // Per specie properties
 160
 161             //- Number of moles []
 162             virtual scalar nMoles(const label specieI) const;
 163
 164             //- Molecular weight [kg/kmol]
 165             virtual scalar W(const label specieI) const;
 166
 167
 168         // Per specie thermo properties
 169
 170             //- Heat capacity at constant pressure [J/(kg K)]
 171             virtual scalar Cp(const label specieI, const scalar T) const;
 172
 173             //- Heat capacity at constant volume [J/(kg K)]
 174             virtual scalar Cv(const label specieI, const scalar T) const;
 175
 176             //- Enthalpy [J/kg]
 177             virtual scalar H(const label specieI, const scalar T) const;
 178
 179             //- Sensible enthalpy [J/kg]
 180             virtual scalar Hs(const label specieI, const scalar T) const;
 181
 182             //- Chemical enthalpy [J/kg]
 183             virtual scalar Hc(const label specieI) const;
 184
 185             //- Entropy [J/(kg K)]
 186             virtual scalar S(const label specieI, const scalar T) const;
 187
 188             //- Internal energy [J/kg]
 189             virtual scalar E(const label specieI, const scalar T) const;
 190
 191             //- Gibbs free energy [J/kg]
 192             virtual scalar G(const label specieI, const scalar T) const;
 193
 194             //- Helmholtz free energy [J/kg]
 195             virtual scalar A(const label specieI, const scalar T) const;
 196
 197
 198         // Per specie transport properties
 199
 200             //- Dynamic viscosity [kg/m/s]
 201             virtual scalar mu(const label specieI, const scalar T) const;
 202
 203             //- Thermal conductivity [W/m/K]
 204             virtual scalar kappa(const label specieI, const scalar T) const;
 205
 206             //- Thermal diffusivity [kg/m/s]
 207             virtual scalar alpha(const label specieI, const scalar T) const;
 208 };
 209
 210
 211 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 212
 213 } // End namespace Foam
 214
 215 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 216
 217 #ifdef NoRepository
 218 #   include "dieselMixture.C"
 219 #endif
 220
 221 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 222
 223 #endif
 224
 225 // ************************************************************************* //