src/thermophysicalModels/specie/specie/specie.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::specie
  27
  28 Description
  29     Base class of the thermophysical property types.
  30
  31 SourceFiles
  32     specieI.H
  33     specie.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef specie_H
  38 #define specie_H
  39
  40 #include "word.H"
  41 #include "scalar.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 class Istream;
  49 class Ostream;
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Class specie Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class specie
  56 {
  57     // Private data
  58
  59         //- Name of specie
  60         word name_;
  61
  62         //- Number of moles of this component in the mixture
  63         scalar nMoles_;
  64
  65         //- Molecular weight of specie [kg/kmol]
  66         scalar molWeight_;
  67
  68
  69     // Private member functions
  70
  71         //- Construct from components without name
  72         inline specie
  73         (
  74             const scalar nMoles,
  75             const scalar molWeight
  76         );
  77
  78
  79 public:
  80
  81     // Public constants
  82
  83         // Thermodynamic constants
  84
  85             //- Universal gas constant [J/(kmol K)]
  86             static const scalar RR;
  87
  88             //- Standard pressure [Pa]
  89             static const scalar Pstd;
  90
  91             //- Standard temperature [K]
  92             static const scalar Tstd;
  93
  94
  95     // Constructors
  96
  97         //- Construct from components with name
  98         inline specie
  99         (
 100             const word& name,
 101             const scalar nMoles,
 102             const scalar molWeight
 103         );
 104
 105         //- Construct as copy
 106         inline specie(const specie&);
 107
 108         //- Construct as named copy
 109         inline specie(const word& name, const specie&);
 110
 111         //- Construct from Istream
 112         specie(Istream&);
 113
 114
 115     // Member Functions
 116
 117         // Access
 118
 119             //- Molecular weight [kg/kmol]
 120             inline scalar W() const;
 121
 122             //- No of moles of this species in mixture
 123             inline scalar nMoles() const;
 124
 125             //- Gas constant [J/(kg K)]
 126             inline scalar R() const;
 127
 128
 129     // Member operators
 130
 131         inline void operator=(const specie&);
 132
 133         inline void operator+=(const specie&);
 134         inline void operator-=(const specie&);
 135
 136         inline void operator*=(const scalar);
 137
 138
 139     // Friend operators
 140
 141         inline friend specie operator+(const specie&, const specie&);
 142         inline friend specie operator-(const specie&, const specie&);
 143
 144         inline friend specie operator*(const scalar, const specie&);
 145
 146         inline friend specie operator==(const specie&, const specie&);
 147
 148
 149     // Ostream Operator
 150
 151         friend Ostream& operator<<(Ostream&, const specie&);
 152 };
 153
 154
 155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 156
 157 } // End namespace Foam
 158
 159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 160
 161 #include "specieI.H"
 162
 163 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 164
 165 #endif
 166
 167 // ************************************************************************* //