My Project
Loading...
Searching...
No Matches
EclEpsTwoPhaseLawParams.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_ECL_EPS_TWO_PHASE_LAW_PARAMS_HPP
28#define OPM_ECL_EPS_TWO_PHASE_LAW_PARAMS_HPP
29
30#include "EclEpsConfig.hpp"
32
33#include <memory>
34#include <cassert>
35
37
38namespace Opm {
45template <class EffLawT>
47{
48 using EffLawParams = typename EffLawT::Params;
49 using Scalar = typename EffLawParams::Traits::Scalar;
50
51public:
52 using Traits = typename EffLawParams::Traits;
54
56 {
57 }
58
63 void finalize()
64 {
65#ifndef NDEBUG
66 if (config_.enableSatScaling()) {
67 assert(unscaledPoints_);
68 }
69 assert(effectiveLawParams_);
70#endif
71 EnsureFinalized :: finalize();
72 }
73
77 void setConfig(std::shared_ptr<EclEpsConfig> value)
78 { config_ = *value; }
79
83 const EclEpsConfig& config() const
84 { return config_; }
85
89 void setUnscaledPoints(std::shared_ptr<ScalingPoints> value)
90 { unscaledPoints_ = value.get(); }
91
96 { return *unscaledPoints_; }
97
102 { scaledPoints_ = value; }
103
108 { return scaledPoints_; }
109
114 { return scaledPoints_; }
115
119 void setEffectiveLawParams(std::shared_ptr<EffLawParams> value)
120 { effectiveLawParams_ = value.get(); }
121
125 const EffLawParams& effectiveLawParams() const
126 { return *effectiveLawParams_; }
127
128private:
129 EffLawParams* effectiveLawParams_;
130 EclEpsConfig config_;
131 ScalingPoints* unscaledPoints_;
132 ScalingPoints scaledPoints_;
133};
134
135} // namespace Opm
136
137#endif
Specifies the configuration used by the endpoint scaling code.
Default implementation for asserting finalization of parameter objects.
Specifies the configuration used by the endpoint scaling code.
Definition EclEpsConfig.hpp:56
bool enableSatScaling() const
Returns whether saturation scaling is enabled.
Definition EclEpsConfig.hpp:67
Represents the points on the X and Y axis to be scaled if endpoint scaling is used.
Definition EclEpsScalingPoints.hpp:166
A default implementation of the parameters for the material law adapter class which implements ECL en...
Definition EclEpsTwoPhaseLawParams.hpp:47
void finalize()
Calculate all dependent quantities once the independent quantities of the parameter object have been ...
Definition EclEpsTwoPhaseLawParams.hpp:63
void setConfig(std::shared_ptr< EclEpsConfig > value)
Set the endpoint scaling configuration object.
Definition EclEpsTwoPhaseLawParams.hpp:77
const EclEpsConfig & config() const
Returns the endpoint scaling configuration object.
Definition EclEpsTwoPhaseLawParams.hpp:83
ScalingPoints & scaledPoints()
Returns the scaling points which are seen by the physical model.
Definition EclEpsTwoPhaseLawParams.hpp:113
const ScalingPoints & unscaledPoints() const
Returns the scaling points which are seen by the nested material law.
Definition EclEpsTwoPhaseLawParams.hpp:95
void setEffectiveLawParams(std::shared_ptr< EffLawParams > value)
Sets the parameter object for the effective/nested material law.
Definition EclEpsTwoPhaseLawParams.hpp:119
const EffLawParams & effectiveLawParams() const
Returns the parameter object for the effective/nested material law.
Definition EclEpsTwoPhaseLawParams.hpp:125
void setScaledPoints(const ScalingPoints &value)
Set the scaling points which are seen by the physical model.
Definition EclEpsTwoPhaseLawParams.hpp:101
const ScalingPoints & scaledPoints() const
Returns the scaling points which are seen by the physical model.
Definition EclEpsTwoPhaseLawParams.hpp:107
void setUnscaledPoints(std::shared_ptr< ScalingPoints > value)
Set the scaling points which are seen by the nested material law.
Definition EclEpsTwoPhaseLawParams.hpp:89
Default implementation for asserting finalization of parameter objects.
Definition EnsureFinalized.hpp:47
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30