src/thermophysicalModels/basic/basicThermo/basicThermo.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::basicThermo
  27
  28 Description
  29     Basic thermodynamic properties
  30
  31 SourceFiles
  32     basicThermo.C
  33     newBasicThermo.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef basicThermo_H
  38 #define basicThermo_H
  39
  40 #include "volFields.H"
  41 #include "typeInfo.H"
  42 #include "IOdictionary.H"
  43 #include "autoPtr.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                         Class basicThermo Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class basicThermo
  55 :
  56     public IOdictionary
  57 {
  58
  59 protected:
  60
  61     // Protected data
  62
  63         // Fields
  64
  65             //- Pressure [Pa]
  66             volScalarField p_;
  67
  68             //- Compressibility [s^2/m^2]
  69             volScalarField psi_;
  70
  71             //- Temperature [K]
  72             volScalarField T_;
  73
  74             //- Laminar dynamic viscosity [kg/m/s]
  75             volScalarField mu_;
  76
  77             //- Laminar thermal diffusuvity [kg/m/s]
  78             volScalarField alpha_;
  79
  80
  81     // Protected member functions
  82
  83         // Enthalpy
  84
  85             //- Return the enthalpy field boundary types by interrogating the
  86             //  temperature field boundary types
  87             wordList hBoundaryTypes();
  88
  89             //- Correct the enthalpy field boundaries
  90             void hBoundaryCorrection(volScalarField& h);
  91
  92
  93         // Internal energy
  94
  95             //- Return the internal energy  field boundary types by
  96             //  interrogating the temperature field boundary types
  97             wordList eBoundaryTypes();
  98
  99             //- Correct the internal energy field boundaries
 100             void eBoundaryCorrection(volScalarField& e);
 101
 102
 103         //- Construct as copy (not implemented)
 104         basicThermo(const basicThermo&);
 105
 106
 107 public:
 108
 109     //- Runtime type information
 110     TypeName("basicThermo");
 111
 112
 113     // Constructors
 114
 115         //- Construct from mesh
 116         basicThermo(const fvMesh&);
 117
 118
 119     //- Destructor
 120     virtual ~basicThermo();
 121
 122
 123     // Member functions
 124
 125         //- Update properties
 126         virtual void correct() = 0;
 127
 128
 129         // Access to thermodynamic state variables
 130
 131             //- Pressure [Pa]
 132             //  Non-const access allowed for transport equations
 133             virtual volScalarField& p();
 134
 135             //- Pressure [Pa]
 136             virtual const volScalarField& p() const;
 137
 138             //- Density [kg/m^3]
 139             virtual tmp<volScalarField> rho() const = 0;
 140
 141             //- Compressibility [s^2/m^2]
 142             virtual const volScalarField& psi() const;
 143
 144             //- Total enthalpy [J/kg]
 145             //  Non-const access allowed for transport equations
 146             virtual volScalarField& h();
 147
 148             //- Enthalpy [J/kg]
 149             virtual const volScalarField& h() const;
 150
 151             //- Enthalpy for cell-set [J/kg]
 152             virtual tmp<scalarField> h
 153             (
 154                 const scalarField& T,
 155                 const labelList& cells
 156             ) const;
 157
 158             //- Enthalpy for patch [J/kg]
 159             virtual tmp<scalarField> h
 160             (
 161                 const scalarField& T,
 162                 const label patchi
 163             ) const;
 164
 165             //- Sensible enthalpy [J/kg]
 166             //  Non-const access allowed for transport equations
 167             virtual volScalarField& hs();
 168
 169             //- Enthalpy [J/kg]
 170             virtual const volScalarField& hs() const;
 171
 172             //- Enthalpy for cell-set [J/kg]
 173             virtual tmp<scalarField> hs
 174             (
 175                 const scalarField& T,
 176                 const labelList& cells
 177             ) const;
 178
 179             //- Enthalpy for patch [J/kg]
 180             virtual tmp<scalarField> hs
 181             (
 182                 const scalarField& T,
 183                 const label patchi
 184             ) const;
 185
 186             //- Internal energy [J/kg]
 187             //  Non-const access allowed for transport equations
 188             virtual volScalarField& e();
 189
 190             //- Internal energy [J/kg]
 191             virtual const volScalarField& e() const;
 192
 193             //- Internal energy for cell-set [J/kg]
 194             virtual tmp<scalarField> e
 195             (
 196                 const scalarField& T,
 197                 const labelList& cells
 198             ) const;
 199
 200             //-Internal energy for patch [J/kg]
 201             virtual tmp<scalarField> e
 202             (
 203                 const scalarField& T,
 204                 const label patchi
 205             ) const;
 206
 207
 208         // Fields derived from thermodynamic state variables
 209
 210             //- Temperature [K]
 211             virtual const volScalarField& T() const;
 212
 213             //- Heat capacity at constant pressure for patch [J/kg/K]
 214             virtual tmp<scalarField> Cp
 215             (
 216                 const scalarField& T,
 217                 const label patchi
 218             ) const;
 219
 220             //- Heat capacity at constant pressure [J/kg/K]
 221             virtual tmp<volScalarField> Cp() const;
 222
 223             //- Heat capacity at constant volume for patch [J/kg/K]
 224             virtual tmp<scalarField> Cv
 225             (
 226                 const scalarField& T,
 227                 const label patchi
 228             ) const;
 229
 230             //- Heat capacity at constant volume [J/kg/K]
 231             virtual tmp<volScalarField> Cv() const;
 232
 233
 234         // Access to transport state variables
 235
 236             //- Dynamic viscosity of mixture [kg/m/s]
 237             virtual const volScalarField& mu() const;
 238
 239             //- Thermal diffusivity for enthalpy of mixture [kg/m/s]
 240             virtual const volScalarField& alpha() const;
 241
 242
 243         //- Read thermophysicalProperties dictionary
 244         virtual bool read();
 245 };
 246
 247
 248 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 249
 250 } // End namespace Foam
 251
 252 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 253
 254 #endif
 255
 256 // ************************************************************************* //