src/thermophysicalModels/solidChemistryModel/solidChemistryModel/solidChemistryModel.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::solidChemistryModel
  26
  27 Description
  28     Chemistry model for solid thermodynamics
  29
  30 SourceFiles
  31     solidChemistryModelI.H
  32     solidChemistryModel.C
  33     newChemistrySolidModel.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef solidChemistryModel_H
  38 #define solidChemistryModel_H
  39
  40 #include "basicChemistryModel.H"
  41 #include "autoPtr.H"
  42 #include "runTimeSelectionTables.H"
  43 #include "basicSolidThermo.H"
  44
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 // Forward declaration of classes
  52 class fvMesh;
  53
  54 /*---------------------------------------------------------------------------*\
  55                      class solidChemistryModel Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 class solidChemistryModel
  59 :
  60     public basicChemistryModel
  61 {
  62     // Private Member Functions
  63
  64         //- Construct as copy (not implemented)
  65         solidChemistryModel(const solidChemistryModel&);
  66
  67         //- Disallow default bitwise assignment
  68         void operator=(const solidChemistryModel&);
  69
  70
  71 protected:
  72
  73     // Protected data
  74
  75         //- Solid thermo package
  76         autoPtr<basicSolidThermo> solidThermo_;
  77
  78
  79 public:
  80
  81     //- Runtime type information
  82     TypeName("solidChemistryModel");
  83
  84
  85     //- Declare run-time constructor selection tables
  86     declareRunTimeSelectionTable
  87     (
  88         autoPtr,
  89         solidChemistryModel,
  90         fvMesh,
  91         (
  92             const fvMesh& mesh,
  93             const word& compTypeName,
  94             const word& solidThermoTypeName
  95         ),
  96         (mesh, compTypeName, solidThermoTypeName)
  97     );
  98
  99
 100     // Constructors
 101
 102         //- Construct from mesh and thermo type name
 103         solidChemistryModel
 104         (
 105             const fvMesh& mesh,
 106             const word& solidThermoTypeName
 107         );
 108
 109
 110     //- Selector
 111     static autoPtr<solidChemistryModel> New(const fvMesh& mesh);
 112
 113
 114     //- Destructor
 115     virtual ~solidChemistryModel();
 116
 117
 118     // Member Functions
 119
 120         //- Return access to the solid thermo package
 121         inline basicSolidThermo& solidThermo();
 122
 123         //- Return const access to the solid thermo package
 124         inline const basicSolidThermo& solidThermo() const;
 125
 126         //- Return total gases mass source term [kg/m3/s]
 127         virtual tmp<volScalarField> RRg() const = 0;
 128
 129         //- Return total solids mass source term [kg/m3/s]
 130         virtual tmp<volScalarField> RRs() const = 0;
 131
 132         //- Return chemical source terms for solids [kg/m3/s]
 133         virtual tmp<volScalarField> RRs(const label i) const = 0;
 134
 135         //- Return chemical source terms for gases [kg/m3/s]
 136         virtual tmp<volScalarField> RRg(const label i) const = 0;
 137
 138         //- Return sensible enthalpy for gas i [J/Kg]
 139         virtual tmp<volScalarField> gasHs
 140         (
 141             const volScalarField& T,
 142             const label i
 143         ) const = 0;
 144
 145         //- Return specie Table for gases
 146         virtual const speciesTable& gasTable() const = 0;
 147
 148         //- Set reacting status of cell, cellI
 149         virtual void setCellReacting(const label cellI, const bool active) = 0;
 150
 151         //- Calculates the reaction rates
 152         virtual void calculate() = 0;
 153 };
 154
 155
 156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 157
 158 } // End namespace Foam
 159
 160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 161
 162 #include "solidChemistryModelI.H"
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 #endif
 167
 168 // ************************************************************************* //