My Project
Loading...
Searching...
No Matches
MultisegmentWellPrimaryVariables.hpp
1/*
2 Copyright 2017 SINTEF Digital, Mathematics and Cybernetics.
3 Copyright 2017 Statoil ASA.
4
5 This file is part of the Open Porous Media project (OPM).
6
7 OPM is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
11
12 OPM is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with OPM. If not, see <http://www.gnu.org/licenses/>.
19*/
20
21
22#ifndef OPM_MULTISEGMENTWELL_PRIMARY_VARIABLES_HEADER_INCLUDED
23#define OPM_MULTISEGMENTWELL_PRIMARY_VARIABLES_HEADER_INCLUDED
24
25#include <opm/material/densead/Evaluation.hpp>
26
27#include <opm/simulators/wells/MultisegmentWellEquations.hpp>
28#include <opm/input/eclipse/Schedule/SummaryState.hpp>
29#include <opm/input/eclipse/Units/Units.hpp>
30
31#include <array>
32#include <cstddef>
33#include <vector>
34
35namespace Opm
36{
37
38class DeferredLogger;
39template<class Scalar> class MultisegmentWellGeneric;
40template<class FluidSystem, class Indices> class WellInterfaceIndices;
41template<class Scalar> class WellState;
42
43template<class FluidSystem, class Indices>
45{
46public:
47 // TODO: for now, not considering the polymer, solvent and so on to simplify the development process.
48
49 // TODO: we need to have order for the primary variables and also the order for the well equations.
50 // sometimes, they are similar, while sometimes, they can have very different forms.
51
52 // Table showing the primary variable indices, depending on what phases are present:
53 //
54 // WOG OG WG WO W/O/G (single phase)
55 // WQTotal 0 0 0 0 0
56 // WFrac 1 -1000 -1000 1 -1000
57 // GFrac 2 1 1 -1000 -1000
58 // Spres 3 2 2 2 1
59
60 static constexpr bool has_wfrac_variable = Indices::waterEnabled && Indices::oilEnabled;
61 static constexpr bool has_gfrac_variable = Indices::gasEnabled && Indices::numPhases > 1;
62
63 static constexpr int WQTotal = 0;
64 static constexpr int WFrac = has_wfrac_variable ? 1 : -1000;
65 static constexpr int GFrac = has_gfrac_variable ? has_wfrac_variable + 1 : -1000;
66 static constexpr int SPres = has_wfrac_variable + has_gfrac_variable + 1;
67
68 // the number of well equations TODO: it should have a more general strategy for it
69 static constexpr int numWellEq = Indices::numPhases + 1;
70
71 using Scalar = typename FluidSystem::Scalar;
72 using EvalWell = DenseAd::Evaluation<Scalar, /*size=*/Indices::numEq + numWellEq>;
73
75 using BVectorWell = typename Equations::BVectorWell;
76
78 : well_(well)
79 {}
80
82 void resize(const int numSegments);
83
85 void update(const WellState<Scalar>& well_state,
86 const bool stop_or_zero_rate_target);
87
89 void updateNewton(const BVectorWell& dwells,
90 const Scalar relaxation_factor,
91 const Scalar DFLimit,
92 const bool stop_or_zero_rate_target,
93 const Scalar max_pressure_change);
94
97 const Scalar rho,
98 WellState<Scalar>& well_state,
101
104 EvalWell volumeFractionScaled(const int seg,
105 const int compIdx) const;
106
109 EvalWell surfaceVolumeFraction(const int seg,
110 const int compIdx) const;
111
113 EvalWell getSegmentRateUpwinding(const int seg,
114 const int seg_upwind,
115 const int comp_idx) const;
116
118 EvalWell getBhp() const;
119
121 EvalWell getSegmentPressure(const int seg) const;
122
124 EvalWell getSegmentRate(const int seg,
125 const int comp_idx) const;
126
128 EvalWell getQs(const int comp_idx) const;
129
131 EvalWell getWQTotal() const;
132
134 const std::array<EvalWell, numWellEq>& eval(const int idx) const
135 { return evaluation_[idx]; }
136
138 const std::array<Scalar, numWellEq>& value(const int idx) const
139 { return value_[idx]; }
140
142 void setValue(const int idx, const std::array<Scalar, numWellEq>& val)
143 { value_[idx] = val; }
144
147
148private:
150 void setEvaluationsFromValues();
151
153 void processFractions(const int seg);
154
156 EvalWell volumeFraction(const int seg,
157 const int compIdx) const;
158
161 std::vector<std::array<Scalar, numWellEq>> value_;
162
165 std::vector<std::array<EvalWell, numWellEq>> evaluation_;
166
168
169 static constexpr double bhp_lower_limit = 1. * unit::barsa - 1. * unit::Pascal;
170 static constexpr double seg_pres_lower_limit = 0.;
171};
172
173}
174
175#endif // OPM_MULTISEGMENTWELL_PRIMARY_VARIABLES_HEADER_INCLUDED
Definition DeferredLogger.hpp:57
Definition MultisegmentWellGeneric.hpp:39
Definition MultisegmentWellPrimaryVariables.hpp:45
void resize(const int numSegments)
Resize values and evaluations.
Definition MultisegmentWellPrimaryVariables.cpp:49
EvalWell volumeFractionScaled(const int seg, const int compIdx) const
Returns scaled volume fraction for a component in a segment.
Definition MultisegmentWellPrimaryVariables.cpp:554
void outputLowLimitPressureSegments(DeferredLogger &deferred_logger) const
output the segments with pressure close to lower pressure limit for debugging purpose
Definition MultisegmentWellPrimaryVariables.cpp:668
EvalWell getSegmentRate(const int seg, const int comp_idx) const
Get rate for a component in a segment.
Definition MultisegmentWellPrimaryVariables.cpp:643
EvalWell getSegmentRateUpwinding(const int seg, const int seg_upwind, const int comp_idx) const
Returns upwinding rate for a component in a segment.
Definition MultisegmentWellPrimaryVariables.cpp:587
EvalWell getWQTotal() const
Get WQTotal.
Definition MultisegmentWellPrimaryVariables.cpp:660
void copyToWellState(const MultisegmentWellGeneric< Scalar > &mswell, const Scalar rho, WellState< Scalar > &well_state, const SummaryState &summary_state, DeferredLogger &deferred_logger) const
Copy values to well state.
Definition MultisegmentWellPrimaryVariables.cpp:217
const std::array< EvalWell, numWellEq > & eval(const int idx) const
Returns a const ref to an array of evaluations.
Definition MultisegmentWellPrimaryVariables.hpp:134
EvalWell getBhp() const
Get bottomhole pressure.
Definition MultisegmentWellPrimaryVariables.cpp:635
EvalWell surfaceVolumeFraction(const int seg, const int compIdx) const
Returns surface volume fraction for a component in a segment.
Definition MultisegmentWellPrimaryVariables.cpp:571
void setValue(const int idx, const std::array< Scalar, numWellEq > &val)
Set a value array. Note that this does not also set the corresponding evaluation.
Definition MultisegmentWellPrimaryVariables.hpp:142
EvalWell getQs(const int comp_idx) const
Returns scaled rate for a component.
Definition MultisegmentWellPrimaryVariables.cpp:652
void update(const WellState< Scalar > &well_state, const bool stop_or_zero_rate_target)
Copy values from well state.
Definition MultisegmentWellPrimaryVariables.cpp:70
EvalWell getSegmentPressure(const int seg) const
Get pressure for a segment.
Definition MultisegmentWellPrimaryVariables.cpp:627
void updateNewton(const BVectorWell &dwells, const Scalar relaxation_factor, const Scalar DFLimit, const bool stop_or_zero_rate_target, const Scalar max_pressure_change)
Update values from newton update vector.
Definition MultisegmentWellPrimaryVariables.cpp:160
const std::array< Scalar, numWellEq > & value(const int idx) const
Returns a value array.
Definition MultisegmentWellPrimaryVariables.hpp:138
Definition WellInterfaceIndices.hpp:34
The state of a set of wells, tailored for use by the fully implicit blackoil simulator.
Definition WellState.hpp:66
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilboundaryratevector.hh:37
constexpr auto getPropValue()
get the value data member of a property
Definition propertysystem.hh:242