My Project
LinearMaterialParams.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_LINEAR_MATERIAL_PARAMS_HPP
28 #define OPM_LINEAR_MATERIAL_PARAMS_HPP
29 
30 #include <cassert>
31 
33 
34 namespace Opm {
35 
40 template<class TraitsT>
42 {
43  enum { numPhases = TraitsT::numPhases };
44 
45  typedef typename TraitsT::Scalar Scalar;
46 
47 public:
49 
50  typedef TraitsT Traits;
51 
58  {
59  for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
60  setPcMinSat(phaseIdx, 0.0);
61  setPcMaxSat(phaseIdx, 0.0);
62  }
63  }
64 
70  Scalar pcMinSat(unsigned phaseIdx) const
71  { EnsureFinalized::check();return pcMinSat_[phaseIdx]; }
72 
78  void setPcMinSat(unsigned phaseIdx, Scalar val)
79  { pcMinSat_[phaseIdx] = val; }
80 
86  Scalar pcMaxSat(unsigned phaseIdx) const
87  { EnsureFinalized::check(); return pcMaxSat_[phaseIdx]; }
88 
94  void setPcMaxSat(unsigned phaseIdx, Scalar val)
95  { pcMaxSat_[phaseIdx] = val; }
96 
97 private:
98  Scalar pcMaxSat_[numPhases];
99  Scalar pcMinSat_[numPhases];
100 };
101 } // namespace Opm
102 
103 #endif
Default implementation for asserting finalization of parameter objects.
Default implementation for asserting finalization of parameter objects.
Definition: EnsureFinalized.hpp:47
void finalize()
Mark the object as finalized.
Definition: EnsureFinalized.hpp:75
Reference implementation of params for the linear M-phase material material.
Definition: LinearMaterialParams.hpp:42
Scalar pcMaxSat(unsigned phaseIdx) const
Return the relative phase pressure at the maximum saturation of a phase.
Definition: LinearMaterialParams.hpp:86
LinearMaterialParams()
The default constructor.
Definition: LinearMaterialParams.hpp:57
void setPcMinSat(unsigned phaseIdx, Scalar val)
Set the relative phase pressure at the minimum saturation of a phase.
Definition: LinearMaterialParams.hpp:78
Scalar pcMinSat(unsigned phaseIdx) const
Return the relative phase pressure at the minimum saturation of a phase.
Definition: LinearMaterialParams.hpp:70
void setPcMaxSat(unsigned phaseIdx, Scalar val)
Set the relative phase pressure at the maximum saturation of a phase.
Definition: LinearMaterialParams.hpp:94