src/thermophysicalModels/solids/solid/solid.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::solid
  27
  28 Description
  29     The thermophysical properties of a solid
  30
  31 SourceFiles
  32     solid.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef solid_H
  37 #define solid_H
  38
  39 #include "typeInfo.H"
  40 #include "autoPtr.H"
  41 #include "runTimeSelectionTables.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 class solid;
  49
  50 Ostream& operator<<
  51 (
  52      Ostream&,
  53      const solid&
  54 );
  55
  56
  57 /*---------------------------------------------------------------------------*\
  58                             Class solid Declaration
  59 \*---------------------------------------------------------------------------*/
  60
  61 class solid
  62 {
  63
  64     // Private data
  65
  66         //- Density [kg/m3]
  67         scalar rho_;
  68
  69         //- Specific heat capacity [J/(kg.K)]
  70         scalar cp_;
  71
  72         //- Thermal conductivity [W/(m.K)]
  73         scalar K_;
  74
  75         //- Heat of formation [J/kg]
  76         scalar Hf_;
  77
  78         //- Emissivity
  79         scalar emissivity_;
  80
  81
  82 public:
  83
  84     //- Runtime type information
  85     TypeName("solid");
  86
  87
  88     // Declare run-time constructor selection tables
  89
  90     declareRunTimeSelectionTable
  91     (
  92         autoPtr,
  93         solid,
  94         ,
  95         (),
  96         ()
  97     );
  98
  99     declareRunTimeSelectionTable
 100     (
 101         autoPtr,
 102         solid,
 103         Istream,
 104         (Istream& is),
 105         (is)
 106     );
 107
 108
 109     // Constructors
 110
 111         //- Construct from components
 112         solid
 113         (
 114             scalar rho,
 115             scalar cp,
 116             scalar K,
 117             scalar Hf,
 118             scalar emissivity
 119         );
 120
 121         //- Construct from Istream
 122         solid(Istream& is);
 123
 124         //- Return a pointer to a new solid created from input
 125         static autoPtr<solid> New(Istream& is);
 126
 127
 128     // Destructor
 129
 130         virtual ~solid()
 131         {}
 132
 133
 134     // Member Functions
 135
 136         // Phisical constants which define the solid
 137
 138             //- Density [kg/m3]
 139             inline scalar rho() const;
 140
 141             //- Specific heat capacity [J/(kg.K)]
 142             inline scalar cp() const;
 143
 144             //- Thermal conductivity [W/(m.K)]
 145             inline scalar K() const;
 146
 147             //- Heat of formation [J/kg]
 148             inline scalar Hf() const;
 149
 150             //- Emissivity []
 151             inline scalar emissivity() const;
 152
 153
 154         // I-O
 155
 156             //- Write the solid properties
 157             virtual void writeData(Ostream& os) const;
 158
 159
 160         // Ostream Operator
 161
 162         friend Ostream& operator<<(Ostream& os, const solid& s);
 163 };
 164
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 167
 168 #include "solidI.H"
 169
 170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 171
 172 } // End namespace Foam
 173
 174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 175
 176 #endif
 177
 178 // ************************************************************************* //