Component.hpp
Go to the documentation of this file.
1 // -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 // vi: set et ts=4 sw=4 sts=4:
3 /*
4  This file is part of the Open Porous Media project (OPM).
5 
6  OPM is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 2 of the License, or
9  (at your option) any later version.
10 
11  OPM is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with OPM. If not, see <http://www.gnu.org/licenses/>.
18 
19  Consult the COPYING file in the top-level source directory of this
20  module for the precise wording of the license and the list of
21  copyright holders.
22 */
27 #ifndef OPM_COMPONENT_HPP
28 #define OPM_COMPONENT_HPP
29 
30 #include <opm/common/ErrorMacros.hpp>
31 #include <opm/common/Exceptions.hpp>
32 
33 namespace Opm {
34 
42 template <class ScalarT, class Implementation>
43 class Component
44 {
45 public:
46  typedef ScalarT Scalar;
47 
48  static const bool isTabulated = false;
49 
62  static void init(Scalar /* tempMin */, Scalar /* tempMax */, unsigned /* nTemp */,
63  Scalar /* pressMin */, Scalar /* pressMax */, unsigned /* nPress */)
64  { }
65 
69  static bool gasIsCompressible()
70  { OPM_THROW(std::runtime_error, "Not implemented: Component::gasIsCompressible()"); }
71 
75  static bool gasIsIdeal()
76  { OPM_THROW(std::runtime_error, "Not implemented: Component::gasIsIdeal()"); }
77 
81  static bool liquidIsCompressible()
82  { OPM_THROW(std::runtime_error, "Not implemented: Component::liquidIsCompressible()"); }
83 
87  static const char* name()
88  { OPM_THROW(std::runtime_error, "Not implemented: Component::name()"); }
89 
93  static Scalar molarMass()
94  { OPM_THROW(std::runtime_error, "Not implemented: Component::molarMass()"); }
95 
99  static Scalar criticalTemperature()
100  { OPM_THROW(std::runtime_error, "Not implemented: Component::criticalTemperature()"); }
101 
105  static Scalar criticalPressure()
106  { OPM_THROW(std::runtime_error, "Not implemented: Component::criticalPressure()"); }
107 
111  static Scalar tripleTemperature()
112  { OPM_THROW(std::runtime_error, "Not implemented: Component::tripleTemperature()"); }
113 
117  static Scalar triplePressure()
118  { OPM_THROW(std::runtime_error, "Not implemented: Component::triplePressure()"); }
119 
126  template <class Evaluation>
127  static Evaluation vaporPressure(const Evaluation& /* temperature */)
128  { OPM_THROW(std::runtime_error, "Not implemented: Component::vaporPressure()"); }
129 
136  template <class Evaluation>
137  static Evaluation gasDensity(const Evaluation& /* temperature */, const Evaluation& /* pressure */)
138  { OPM_THROW(std::runtime_error, "Not implemented: Component::gasDensity()"); }
139 
146  template <class Evaluation>
147  static Evaluation liquidDensity(const Evaluation& /* temperature */, const Evaluation& /* pressure */)
148  { OPM_THROW(std::runtime_error, "Not implemented: Component::liquidDensity()"); }
149 
156  template <class Evaluation>
157  static Evaluation gasEnthalpy(const Evaluation& /* temperature */, const Evaluation& /* pressure */)
158  { OPM_THROW(std::runtime_error, "Not implemented: Component::gasEnthalpy()"); }
159 
166  template <class Evaluation>
167  static Evaluation liquidEnthalpy(const Evaluation& /* temperature */, const Evaluation& /* pressure */)
168  { OPM_THROW(std::runtime_error, "Not implemented: Component::liquidEnthalpy()"); }
169 
176  template <class Evaluation>
177  static Evaluation gasInternalEnergy(const Evaluation& /* temperature */, const Evaluation& /* pressure */)
178  { OPM_THROW(std::runtime_error, "Not implemented: Component::gasInternalEnergy()"); }
179 
186  template <class Evaluation>
187  static Evaluation liquidInternalEnergy(const Evaluation& /* temperature */, const Evaluation& /* pressure */)
188  { OPM_THROW(std::runtime_error, "Not implemented: Component::liquidInternalEnergy()"); }
189 
197  template <class Evaluation>
198  static Evaluation gasViscosity(const Evaluation& /* temperature */, const Evaluation& /* pressure */)
199  { OPM_THROW(std::runtime_error, "Not implemented: Component::gasViscosity()"); }
200 
207  template <class Evaluation>
208  static Evaluation liquidViscosity(const Evaluation& /* temperature */, const Evaluation& /* pressure */)
209  { OPM_THROW(std::runtime_error, "Not implemented: Component::liquidViscosity()"); }
210 
214  template <class Evaluation>
215  static Evaluation gasThermalConductivity(const Evaluation& /* temperature */, const Evaluation& /* pressure */)
216  { OPM_THROW(std::runtime_error, "Not implemented: Component::gasThermalConductivity()"); }
217 
221  template <class Evaluation>
222  static Evaluation liquidThermalConductivity(const Evaluation& /* temperature */, const Evaluation& /* pressure */)
223  { OPM_THROW(std::runtime_error, "Not implemented: Component::liquidThermalConductivity()"); }
224 
228  template <class Evaluation>
229  static Evaluation gasHeatCapacity(const Evaluation& /* temperature */, const Evaluation& /* pressure */)
230  { OPM_THROW(std::runtime_error, "Not implemented: Component::gasHeatCapacity()"); }
231 
235  template <class Evaluation>
236  static Evaluation liquidHeatCapacity(const Evaluation& /* temperature */, const Evaluation& /* pressure */)
237  { OPM_THROW(std::runtime_error, "Not implemented: Component::liquidHeatCapacity()"); }
238 };
239 
240 } // namespace Opm
241 
242 #endif
static Evaluation gasDensity(const Evaluation &, const Evaluation &)
The density in of the component at a given pressure in and temperature in .
Definition: Component.hpp:137
static Evaluation liquidDensity(const Evaluation &, const Evaluation &)
The density of the liquid component at a given pressure in and temperature in . ...
Definition: Component.hpp:147
Abstract base class of a pure chemical species.
Definition: Component.hpp:43
static Evaluation gasThermalConductivity(const Evaluation &, const Evaluation &)
Thermal conductivity of the component [W/(m^2 K/m)] as a gas.
Definition: Component.hpp:215
static Evaluation liquidViscosity(const Evaluation &, const Evaluation &)
The dynamic liquid viscosity of the pure component.
Definition: Component.hpp:208
static Scalar criticalPressure()
Returns the critical pressure in of the component.
Definition: Component.hpp:105
static Evaluation vaporPressure(const Evaluation &)
The vapor pressure in of the component at a given temperature in .
Definition: Component.hpp:127
static bool liquidIsCompressible()
Returns true iff the liquid phase is assumed to be compressible.
Definition: Component.hpp:81
static void init(Scalar, Scalar, unsigned, Scalar, Scalar, unsigned)
A default routine for initialization, not needed for components and must not be called.
Definition: Component.hpp:62
static Evaluation liquidEnthalpy(const Evaluation &, const Evaluation &)
Specific enthalpy of the pure component in liquid.
Definition: Component.hpp:167
static Evaluation liquidHeatCapacity(const Evaluation &, const Evaluation &)
Specific isobaric heat capacity of the component [J/kg] as a liquid.
Definition: Component.hpp:236
static Evaluation gasInternalEnergy(const Evaluation &, const Evaluation &)
Specific internal energy of the pure component in gas.
Definition: Component.hpp:177
Definition: Air_Mesitylene.hpp:33
static bool gasIsIdeal()
Returns true iff the gas phase is assumed to be ideal.
Definition: Component.hpp:75
static Evaluation gasEnthalpy(const Evaluation &, const Evaluation &)
Specific enthalpy of the pure component in gas.
Definition: Component.hpp:157
static Evaluation gasViscosity(const Evaluation &, const Evaluation &)
The dynamic viscosity of the pure component at a given pressure in and temperature in ...
Definition: Component.hpp:198
static Scalar triplePressure()
Returns the pressure in at the component&#39;s triple point.
Definition: Component.hpp:117
static Scalar criticalTemperature()
Returns the critical temperature in of the component.
Definition: Component.hpp:99
static Evaluation gasHeatCapacity(const Evaluation &, const Evaluation &)
Specific isobaric heat capacity of the component [J/kg] as a gas.
Definition: Component.hpp:229
static Evaluation liquidThermalConductivity(const Evaluation &, const Evaluation &)
Thermal conductivity of the component [W/(m^2 K/m)] as a liquid.
Definition: Component.hpp:222
static Evaluation liquidInternalEnergy(const Evaluation &, const Evaluation &)
Specific internal energy of pure the pure component in liquid.
Definition: Component.hpp:187
static Scalar tripleTemperature()
Returns the temperature in at the component&#39;s triple point.
Definition: Component.hpp:111
static const char * name()
A human readable name for the component.
Definition: Component.hpp:87
static bool gasIsCompressible()
Returns true iff the gas phase is assumed to be compressible.
Definition: Component.hpp:69
static Scalar molarMass()
The molar mass in of the component.
Definition: Component.hpp:93