src/combustionModels/combustionModel/combustionModel.C

   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
  10     OpenFOAM is free software: you can redistribute it and/or modify it
  11     under the terms of the GNU General Public License as published by
  12     the Free Software Foundation, either version 3 of the License, or
  13     (at your option) any later version.
  14
  15     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  16     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  17     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  18     for more details.
  19
  20     You should have received a copy of the GNU General Public License
  21     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 \*---------------------------------------------------------------------------*/
  24
  25 #include "combustionModel.H"
  26 #include "surfaceFields.H"
  27 #include "fvScalarMatrix.H"
  28
  29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  30
  31 namespace Foam
  32 {
  33     defineTypeNameAndDebug(combustionModel, 0);
  34     defineRunTimeSelectionTable(combustionModel, dictionary);
  35 };
  36
  37
  38 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  39
  40 Foam::combustionModel::combustionModel
  41 (
  42     const dictionary& combustionProps,
  43     hsCombustionThermo& thermo,
  44     const compressible::turbulenceModel& turbulence,
  45     const surfaceScalarField& phi,
  46     const volScalarField& rho
  47 )
  48 :
  49     coeffs_(dictionary::null),
  50     thermo_(thermo),
  51     turbulence_(turbulence),
  52     mesh_(phi.mesh()),
  53     phi_(phi),
  54     rho_(rho)
  55 {}
  56
  57
  58 Foam::combustionModel::combustionModel
  59 (
  60     const word& modelType,
  61     const dictionary& combustionProps,
  62     hsCombustionThermo& thermo,
  63     const compressible::turbulenceModel& turbulence,
  64     const surfaceScalarField& phi,
  65     const volScalarField& rho
  66 )
  67 :
  68     coeffs_(combustionProps.subDict(modelType + "Coeffs")),
  69     thermo_(thermo),
  70     turbulence_(turbulence),
  71     mesh_(phi.mesh()),
  72     phi_(phi),
  73     rho_(rho)
  74 {}
  75
  76
  77 // * * * * * * * * * * * * * * * * Destructors * * * * * * * * * * * * * * * //
  78
  79 Foam::combustionModel::~combustionModel()
  80 {}
  81
  82
  83 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
  84
  85 void Foam::combustionModel::correct()
  86 {
  87     // do nothing
  88 }
  89
  90
  91 Foam::tmp<Foam::fvScalarMatrix> Foam::combustionModel::R
  92 (
  93     volScalarField& Y
  94 ) const
  95 {
  96     return tmp<fvScalarMatrix>
  97     (
  98         new fvScalarMatrix(Y, dimMass/dimTime*Y.dimensions())
  99     );
 100 }
 101
 102
 103 Foam::tmp<Foam::volScalarField> Foam::combustionModel::dQ() const
 104 {
 105     return tmp<Foam::volScalarField>
 106     (
 107         new volScalarField
 108         (
 109             IOobject
 110             (
 111                 "dQ",
 112                 mesh_.time().timeName(),
 113                 mesh_,
 114                 IOobject::NO_READ,
 115                 IOobject::NO_WRITE
 116             ),
 117             mesh_,
 118             dimensionedScalar("zero", dimEnergy/dimVolume/dimTime, 0.0)
 119         )
 120     );
 121 }
 122
 123
 124 Foam::tmp<Foam::volScalarField> Foam::combustionModel::wFuelNorm() const
 125 {
 126     return tmp<Foam::volScalarField>
 127     (
 128         new volScalarField
 129         (
 130             IOobject
 131             (
 132                 "wFuelNorm",
 133                 mesh_.time().timeName(),
 134                 mesh_,
 135                 IOobject::NO_READ,
 136                 IOobject::NO_WRITE
 137             ),
 138             mesh_,
 139             dimensionedScalar("zero", dimMass/dimTime/pow3(dimLength), 0.0)
 140         )
 141     );
 142 }
 143
 144
 145 bool Foam::combustionModel::read(const dictionary& combustionProps)
 146 {
 147     coeffs_ = combustionProps.subDict(type() + "Coeffs");
 148
 149     return true;
 150 }
 151
 152
 153 // ************************************************************************* //