src/regionModels/pyrolysisModels/noPyrolysis/noPyrolysis.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::noPyrolysis
  26
  27 Description
  28     Dummy surface pyrolysis model for 'none'
  29
  30 SourceFiles
  31     noPyrolysis.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef noPyrolysis_H
  36 #define noPyrolysis_H
  37
  38 #include "pyrolysisModel.H"
  39 #include "volFieldsFwd.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace regionModels
  46 {
  47 namespace pyrolysisModels
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                           Class noPyrolysis Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class noPyrolysis
  55 :
  56     public pyrolysisModel
  57 {
  58 private:
  59
  60     // Private member functions
  61
  62         //- Disallow default bitwise copy construct
  63         noPyrolysis(const noPyrolysis&);
  64
  65         //- Disallow default bitwise assignment
  66         void operator=(const noPyrolysis&);
  67
  68
  69 protected:
  70
  71     // Protected member functions
  72
  73         //- Read control parameters from dictionary
  74         virtual bool read();
  75
  76         //- Read control parameters from dictionary
  77         virtual bool read(const dictionary& dict);
  78
  79         //- Reset solidChemistryModel and basicSolidThermo pointers
  80         void constructThermoChemistry();
  81
  82         //- Reference to the solid chemistry model
  83         autoPtr<solidChemistryModel> solidChemistry_;
  84
  85         //- Reference to solid thermo
  86         autoPtr<basicSolidThermo> solidThermo_;
  87
  88
  89 public:
  90
  91     //- Runtime type information
  92     TypeName("none");
  93
  94
  95     // Constructors
  96
  97         //- Construct from type name and mesh
  98         noPyrolysis(const word& modelType, const fvMesh& mesh);
  99
 100         //- Construct from type name and mesh and dict
 101         noPyrolysis
 102         (
 103             const word& modelType,
 104             const fvMesh& mesh,
 105             const dictionary& dict
 106         );
 107
 108
 109     //- Destructor
 110     virtual ~noPyrolysis();
 111
 112
 113     // Member Functions
 114
 115         // Fields
 116
 117             //- Return density [kg/m3]
 118             virtual const volScalarField& rho() const;
 119
 120             //- Return const temperature [K]
 121             virtual const volScalarField& T() const;
 122
 123             //- Return specific heat capacity [J/kg/K]
 124             virtual const tmp<volScalarField> Cp() const;
 125
 126             //- Return the region absorptivity [1/m]
 127             virtual const volScalarField& kappa() const;
 128
 129             //- Return the region thermal conductivity [W/m/k]
 130             virtual const volScalarField& K() const;
 131
 132             //- Return the total gas mass flux to primary region [kg/m2/s]
 133             virtual const surfaceScalarField& phiGas() const;
 134
 135
 136         // Evolution
 137
 138             //- Pre-evolve region
 139             virtual void preEvolveRegion();
 140
 141             //- Evolve the pyrolysis equations
 142             virtual void evolveRegion();
 143
 144 };
 145
 146
 147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 148
 149 } // End namespace pyrolysisModels
 150 } // End namespace regionModels
 151 } // End namespace Foam
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 #endif
 156
 157 // ************************************************************************* //