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