src/regionModels/pyrolysisModels/pyrolysisModel/pyrolysisModel.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::pyrolysisModel
  26
  27 Description
  28
  29 SourceFiles
  30     pyrolysisModelI.H
  31     pyrolysisModel.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef pyrolysisModel_H
  36 #define pyrolysisModel_H
  37
  38 #include "runTimeSelectionTables.H"
  39 #include "volFieldsFwd.H"
  40 #include "solidChemistryModel.H"
  41 #include "basicSolidThermo.H"
  42 #include "regionModel1D.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // Forward declaration of classes
  50 class fvMesh;
  51 class Time;
  52
  53 namespace regionModels
  54 {
  55 namespace pyrolysisModels
  56 {
  57
  58 /*---------------------------------------------------------------------------*\
  59                       Class pyrolysisModel Declaration
  60 \*---------------------------------------------------------------------------*/
  61
  62 class pyrolysisModel
  63 :
  64     public regionModel1D
  65 {
  66 private:
  67
  68     // Private Member Functions
  69
  70         //- Construct fields
  71         void constructMeshObjects();
  72
  73         //- Read pyrolysis controls
  74         void readPyrolysisControls();
  75
  76         //- Disallow default bitwise copy construct
  77         pyrolysisModel(const pyrolysisModel&);
  78
  79         //- Disallow default bitwise assignment
  80         void operator=(const pyrolysisModel&);
  81
  82
  83 protected:
  84
  85     // Protected Data
  86
  87         //- Flag to indicate whether pyrolysis region coupled to a film region
  88         bool filmCoupled_;
  89
  90         //- Pointer to film thickness field
  91         autoPtr<volScalarField> filmDeltaPtr_;
  92
  93         //- Film height below which reactions can occur [m]
  94         scalar reactionDeltaMin_;
  95
  96
  97     // Protected Member Functions
  98
  99         //- Read control parameters
 100         virtual bool read();
 101
 102         //- Read control parameters from dictionary
 103         virtual bool read(const dictionary& dict);
 104
 105
 106 public:
 107
 108     //- Runtime type information
 109     TypeName("pyrolysisModel");
 110
 111
 112     // Declare runtime constructor selection table
 113
 114          declareRunTimeSelectionTable
 115          (
 116              autoPtr,
 117              pyrolysisModel,
 118              mesh,
 119              (
 120                 const word& modelType,
 121                 const fvMesh& mesh
 122              ),
 123              (modelType, mesh)
 124          );
 125
 126          declareRunTimeSelectionTable
 127          (
 128              autoPtr,
 129              pyrolysisModel,
 130              dictionary,
 131              (
 132                 const word& modelType,
 133                 const fvMesh& mesh,
 134                 const dictionary& dict
 135              ),
 136              (modelType, mesh, dict)
 137          );
 138
 139
 140     // Constructors
 141
 142         //- Construct null from mesh
 143         pyrolysisModel(const fvMesh& mesh);
 144
 145         //- Construct from type name and mesh
 146         pyrolysisModel(const word& modelType, const fvMesh& mesh);
 147
 148         //- Construct from type name and mesh and dictionary
 149         pyrolysisModel
 150         (
 151             const word& modelType,
 152             const fvMesh& mesh,
 153             const dictionary& dict
 154         );
 155
 156         //- Return clone
 157         autoPtr<pyrolysisModel> clone() const
 158         {
 159             notImplemented("autoPtr<pyrolysisModel> clone() const");
 160             return autoPtr<pyrolysisModel>(NULL);
 161         }
 162
 163     // Selectors
 164
 165         //- Return a reference to the selected pyrolysis model
 166         static autoPtr<pyrolysisModel> New(const fvMesh& mesh);
 167
 168         //- Return a reference to a named selected pyrolysis model
 169         static autoPtr<pyrolysisModel> New
 170         (
 171             const fvMesh& mesh,
 172             const dictionary& dict
 173         );
 174
 175
 176         //- Return pointer to new pyrolysis created on freestore from Istream
 177         class iNew
 178         {
 179             const fvMesh& mesh_;
 180
 181         public:
 182
 183             iNew(const fvMesh& mesh)
 184             :
 185                 mesh_(mesh)
 186             {}
 187
 188             autoPtr<pyrolysisModel> operator()(Istream& is) const
 189             {
 190                 keyType key(is);
 191                 dictionary dict(is);
 192
 193                 return autoPtr<pyrolysisModel>
 194                 (
 195                     pyrolysisModel::New(mesh_, dict)
 196                 );
 197             }
 198         };
 199
 200
 201     //- Destructor
 202     virtual ~pyrolysisModel();
 203
 204
 205     // Member Functions
 206
 207         // Access
 208
 209             // Fields
 210
 211                 //- Return density [kg/m3]
 212                 virtual const volScalarField& rho() const = 0;
 213
 214                 //- Return const temperature [K]
 215                 virtual const volScalarField& T() const = 0;
 216
 217                 //- Return specific heat capacity [J/kg/K]
 218                 virtual const tmp<volScalarField> Cp() const = 0;
 219
 220                 //- Return the region absorptivity [1/m]
 221                 virtual const volScalarField& kappa() const = 0;
 222
 223                 //- Return the region thermal conductivity [W/m/k]
 224                 virtual const volScalarField& K() const = 0;
 225
 226                 //- Return the total gas mass flux to primary region [kg/m2/s]
 227                 virtual const surfaceScalarField& phiGas() const = 0;
 228
 229             // Sources
 230
 231                 //- External hook to add mass to the primary region
 232                 virtual scalar addMassSources
 233                 (
 234                     const label patchI,
 235                     const label faceI
 236                 );
 237
 238
 239         // Evolution
 240
 241             //- Pre-evolve region
 242             virtual void preEvolveRegion();
 243
 244
 245         // Helper function
 246
 247             //- Mean diffusion number of the solid region
 248             virtual scalar solidRegionDiffNo() const;
 249
 250             //- Return max diffusivity allowed in the solid
 251             virtual scalar maxDiff() const;
 252 };
 253
 254
 255 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 256
 257 } // End namespace pyrolysisModels
 258 } // End namespace regionModels
 259 } // End namespace Foam
 260
 261 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 262
 263 #endif
 264
 265 // ************************************************************************* //