All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
FluidStatePressureModules.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 */
28 #ifndef OPM_FLUID_STATE_PRESSURE_MODULES_HPP
29 #define OPM_FLUID_STATE_PRESSURE_MODULES_HPP
30 
32 #include <opm/common/Valgrind.hpp>
33 #include <opm/common/Exceptions.hpp>
34 #include <opm/common/ErrorMacros.hpp>
35 
36 #include <algorithm>
37 
38 namespace Opm {
39 
44 template <class Scalar,
45  unsigned numPhases,
46  class Implementation>
48 {
49 public:
51  { Valgrind::SetUndefined(pressure_); }
52 
56  const Scalar& pressure(unsigned phaseIdx) const
57  { return pressure_[phaseIdx]; }
58 
59 
63  void setPressure(unsigned phaseIdx, const Scalar& value)
64  { pressure_[phaseIdx] = value; }
65 
70  template <class FluidState>
71  void assign(const FluidState& fs)
72  {
73  for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
74  pressure_[phaseIdx] = Opm::decay<Scalar>(fs.pressure(phaseIdx));
75  }
76  }
77 
86  void checkDefined() const
87  {
88  Valgrind::CheckDefined(pressure_);
89  }
90 
91 protected:
92  Scalar pressure_[numPhases];
93 };
94 
99 template <class Scalar>
101 {
102 public:
104  { }
105 
109  const Scalar& pressure(unsigned /* phaseIdx */) const
110  { OPM_THROW(std::logic_error, "Pressure is not provided by this fluid state"); }
111 
112 
117  template <class FluidState>
118  void assign(const FluidState& /* fs */)
119  { }
120 
129  void checkDefined() const
130  { }
131 };
132 
133 } // namespace Opm
134 
135 #endif
A traits class which provides basic mathematical functions for arbitrary scalar floating point values...
const Scalar & pressure(unsigned phaseIdx) const
The pressure of a fluid phase [Pa].
Definition: FluidStatePressureModules.hpp:56
Module for the modular fluid state which stores the pressures explicitly.
Definition: FluidStatePressureModules.hpp:47
void setPressure(unsigned phaseIdx, const Scalar &value)
Set the pressure of a phase [Pa].
Definition: FluidStatePressureModules.hpp:63
void checkDefined() const
Make sure that all attributes are defined.
Definition: FluidStatePressureModules.hpp:86
void checkDefined() const
Make sure that all attributes are defined.
Definition: FluidStatePressureModules.hpp:129
Module for the modular fluid state which does not the pressures but throws std::logic_error instead...
Definition: FluidStatePressureModules.hpp:100
void assign(const FluidState &fs)
Retrieve all parameters from an arbitrary fluid state.
Definition: FluidStatePressureModules.hpp:71
void assign(const FluidState &)
Retrieve all parameters from an arbitrary fluid state.
Definition: FluidStatePressureModules.hpp:118
const Scalar & pressure(unsigned) const
The pressure of a fluid phase [Pa].
Definition: FluidStatePressureModules.hpp:109