src/thermophysicalModels/basic/rhoThermo/basicRhoThermo/basicRhoThermo.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::basicRhoThermo
  27
  28 Description
  29     Basic thermodynamic properties based on density
  30
  31 SourceFiles
  32     basicRhoThermo.C
  33     newBasicRhoThermo.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef basicRhoThermo_H
  38 #define basicRhoThermo_H
  39
  40 #include "basicThermo.H"
  41 #include "runTimeSelectionTables.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                        Class basicRhoThermo Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class basicRhoThermo
  53 :
  54     public basicThermo
  55 {
  56
  57 protected:
  58
  59     // Protected data
  60
  61         //- Density field [kg/m^3]
  62         //  Named 'rhoThermo' to avoid (potential) conflict with solver density
  63         volScalarField rho_;
  64
  65
  66     // Protected member functions
  67
  68         //- Construct as copy (not implemented)
  69         basicRhoThermo(const basicRhoThermo&);
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName("basicRhoThermo");
  76
  77
  78     //- Declare run-time constructor selection table
  79     declareRunTimeSelectionTable
  80     (
  81         autoPtr,
  82         basicRhoThermo,
  83         fvMesh,
  84         (const fvMesh& mesh),
  85         (mesh)
  86     );
  87
  88
  89     // Constructors
  90
  91         //- Construct from mesh
  92         basicRhoThermo(const fvMesh&);
  93
  94
  95     //- Selector
  96     static autoPtr<basicRhoThermo> New(const fvMesh&);
  97
  98
  99     //- Destructor
 100     virtual ~basicRhoThermo();
 101
 102
 103     // Member functions
 104
 105         // Fields derived from thermodynamic state variables
 106
 107             //- Density [kg/m^3]
 108             virtual tmp<volScalarField> rho() const;
 109
 110             //- Return non-const access to the local density field [kg/m^3]
 111             virtual volScalarField& rho();
 112 };
 113
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 } // End namespace Foam
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 #endif
 122
 123 // ************************************************************************* //