src/thermophysicalModels/specie/equationOfState/incompressible/incompressible.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::incompressible
  26
  27 Description
  28     Incompressible gas/liquid equation of state.
  29
  30 SourceFiles
  31     incompressibleI.H
  32     incompressible.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef incompressible_H
  37 #define incompressible_H
  38
  39 #include "specie.H"
  40 #include "autoPtr.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                         Class incompressible Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class incompressible
  52 :
  53     public specie
  54 {
  55     // Private data
  56
  57         //- Density
  58         scalar rho_;
  59
  60
  61 public:
  62
  63     // Constructors
  64
  65         //- Construct from components
  66         inline incompressible(const specie& sp, const scalar rho);
  67
  68         //- Construct from Istream
  69         incompressible(Istream&);
  70
  71         //- Construct from dictionary
  72         incompressible(const dictionary& dict);
  73
  74         //- Construct as named copy
  75         inline incompressible(const word& name, const incompressible&);
  76
  77         //- Construct and return a clone
  78         inline autoPtr<incompressible> clone() const;
  79
  80         // Selector from Istream
  81         inline static autoPtr<incompressible> New(Istream& is);
  82
  83
  84     // Member functions
  85
  86         // Fundamental properties
  87
  88             //- Return density [kg/m^3]
  89             inline scalar rho(scalar p, scalar T) const;
  90
  91             //- Return compressibility rho/p [s^2/m^2]
  92             inline scalar psi(scalar p, scalar T) const;
  93
  94             //- Return compression factor []
  95             inline scalar Z(scalar p, scalar T) const;
  96
  97
  98         // I-O
  99
 100             //- Write to Ostream
 101             void write(Ostream& os) const;
 102
 103
 104     // Member operators
 105
 106         inline void operator+=(const incompressible&);
 107         inline void operator-=(const incompressible&);
 108
 109         inline void operator*=(const scalar);
 110
 111
 112     // Friend operators
 113
 114         inline friend incompressible operator+
 115         (
 116             const incompressible&,
 117             const incompressible&
 118         );
 119
 120         inline friend incompressible operator-
 121         (
 122             const incompressible&,
 123             const incompressible&
 124         );
 125
 126         inline friend incompressible operator*
 127         (
 128             const scalar s,
 129             const incompressible&
 130         );
 131
 132         inline friend incompressible operator==
 133         (
 134             const incompressible&,
 135             const incompressible&
 136         );
 137
 138
 139     // Ostream Operator
 140
 141         friend Ostream& operator<<(Ostream&, const incompressible&);
 142 };
 143
 144
 145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 146
 147 } // End namespace Foam
 148
 149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 150
 151 #include "incompressibleI.H"
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 #endif
 156
 157 // ************************************************************************* //