Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Opm::MultisegmentWell< TypeTag > Class Template Referenceabstract

#include <MultisegmentWell.hpp>

Inheritance diagram for Opm::MultisegmentWell< TypeTag >:
Inheritance graph

Public Types

using Base = WellInterface< TypeTag >
 
using MSWEval = MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem >, GetPropType< TypeTag, Properties::Indices > >
 
using FSInfo = typename Base::FSInfo
 
using BMatrix = typename Base::BMatrix
 
using CMatrix = typename Base::CMatrix
 
using DMatrix = typename Base::DMatrix
 
using WVector = typename Base::WVector
 
template<typename ValueType >
using SegmentFluidState = Base::template BlackOilFluidStateType< ValueType >
 
using SegmentPvt = typename MultisegmentWellSegments< FluidSystem, Indices >::SegmentPvt
 
using Simulator = GetPropType< TypeTag, Properties::Simulator >
 
using IntensiveQuantities = GetPropType< TypeTag, Properties::IntensiveQuantities >
 
using FluidSystem = GetPropType< TypeTag, Properties::FluidSystem >
 
using IndexTraits = typename FluidSystem::IndexTraitsType
 
using ModelParameters = typename Base::ModelParameters
 
using MaterialLaw = GetPropType< TypeTag, Properties::MaterialLaw >
 
using Indices = GetPropType< TypeTag, Properties::Indices >
 
using RateConverterType = typename WellInterfaceFluidSystem< FluidSystem >::RateConverterType
 
using SparseMatrixAdapter = GetPropType< TypeTag, Properties::SparseMatrixAdapter >
 
using FluidState = BlackOilFluidStateType< Eval >
 
using WellStateType = WellState< Scalar, IndexTraits >
 
using GroupStateHelperType = GroupStateHelper< Scalar, IndexTraits >
 
using Scalar = GetPropType< TypeTag, Properties::Scalar >
 
using BVector = Dune::BlockVector< VectorBlockType >
 
using Eval = typename Base::Eval
 
using PressureMatrix = Dune::BCRSMatrix< Opm::MatrixBlock< Scalar, 1, 1 > >
 
enum class  IndividualOrGroup { Individual , Group , Both }
 
using Grid = GetPropType< TypeTag, Properties::Grid >
 
using RateVector = GetPropType< TypeTag, Properties::RateVector >
 
using GasLiftSingleWell = ::Opm::GasLiftSingleWell< TypeTag >
 
using GLiftEclWells = typename GasLiftGroupInfo< Scalar, IndexTraits >::GLiftEclWells
 
using VectorBlockType = Dune::FieldVector< Scalar, Indices::numEq >
 
using MatrixBlockType = Dune::FieldMatrix< Scalar, Indices::numEq, Indices::numEq >
 
using SingleWellStateType = SingleWellState< Scalar, IndexTraits >
 
template<class ValueType >
using BlackOilFluidStateType = BlackOilFluidState< ValueType, FluidSystem, energyModuleType !=EnergyModules::NoTemperature, energyModuleType==EnergyModules::FullyImplicitThermal, Indices::compositionSwitchIdx !=std::numeric_limits< unsigned >::max(), has_watVapor, has_brine, has_saltPrecip, has_disgas_in_water, has_solvent, Indices::numPhases >
 
using PrimaryVariables = MultisegmentWellPrimaryVariables< GetPropType< TypeTag, Properties::FluidSystem >, GetPropType< TypeTag, Properties::Indices > >
 

Public Member Functions

 MultisegmentWell (const Well &well, const ParallelWellInfo< Scalar > &pw_info, const int time_step, const ModelParameters &param, const RateConverterType &rate_converter, const int pvtRegionIdx, const int num_conservation_quantities, const int num_phases, const int index_of_well, const std::vector< PerforationData< Scalar > > &perf_data)
 
void init (const std::vector< Scalar > &depth_arg, const Scalar gravity_arg, const std::vector< Scalar > &B_avg, const bool changed_to_open_this_step) override
 
void updateWellStateWithTarget (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, WellStateType &well_state) const override
 updating the well state based the current control mode More...
 
void scaleSegmentRatesAndPressure (WellStateType &well_state) const override
 updating the segment pressure and rates based the current bhp and well rates More...
 
ConvergenceReport getWellConvergence (const GroupStateHelperType &groupStateHelper, const std::vector< Scalar > &B_avg, const bool relax_tolerance) const override
 check whether the well equations get converged for this well More...
 
void apply (const BVector &x, BVector &Ax) const override
 Ax = Ax - C D^-1 B x. More...
 
void apply (BVector &r) const override
 r = r - C D^-1 Rw More...
 
void recoverWellSolutionAndUpdateWellState (const Simulator &simulator, const BVector &x, const GroupStateHelperType &groupStateHelper, WellStateType &well_state) override
 
void computeWellPotentials (const Simulator &simulator, const WellStateType &well_state, const GroupStateHelperType &groupStateHelper, std::vector< Scalar > &well_potentials) override
 computing the well potentials for group control More...
 
void updatePrimaryVariables (const GroupStateHelperType &groupStateHelper) override
 
void solveEqAndUpdateWellState (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, WellStateType &well_state) override
 
void calculateExplicitQuantities (const Simulator &simulator, const GroupStateHelperType &groupStateHelper) override
 
void updateIPRImplicit (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, WellStateType &well_state) override
 
void updateProductivityIndex (const Simulator &simulator, const WellProdIndexCalculator< Scalar > &wellPICalc, WellStateType &well_state, DeferredLogger &deferred_logger) const override
 
Scalar connectionDensity (const int globalConnIdx, const int openConnIdx) const override
 
void addWellContributions (SparseMatrixAdapter &jacobian) const override
 
void addWellPressureEquations (PressureMatrix &mat, const BVector &x, const int pressureVarIndex, const bool use_well_weights, const WellStateType &well_state) const override
 
std::vector< Scalar > computeCurrentWellRates (const Simulator &simulator, DeferredLogger &deferred_logger) const override
 
std::optional< Scalar > computeBhpAtThpLimitProdWithAlq (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, const SummaryState &summary_state, const Scalar alq_value, bool iterate_if_no_solution) const override
 
std::vector< Scalar > getPrimaryVars () const override
 
int setPrimaryVars (typename std::vector< Scalar >::const_iterator it) override
 
void addBCDMatrix (std::vector< typename Base::BMatrix > &b_matrices, std::vector< typename Base::CMatrix > &c_matrices, std::vector< typename Base::DMatrix > &d_matrices, Opm::SparseTable< int > &wcells) const override
 
void getScaledWellFractions (std::vector< Scalar > &scaled_fractions, DeferredLogger &deferred_logger) const override
 
void assembleWellEq (const Simulator &simulator, const double dt, const GroupStateHelperType &groupStateHelper, WellStateType &well_state)
 
void assembleWellEqWithoutIteration (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, const double dt, WellStateType &well_state, const bool solving_with_zero_rate)
 
void updateGroupTargetFallbackFlag (WellStateType &well_state, DeferredLogger &deferred_logger) const
 
void prepareWellBeforeAssembling (const Simulator &simulator, const double dt, const GroupStateHelperType &groupStateHelper, WellStateType &well_state)
 
std::optional< Scalar > computeBhpAtThpLimitProdWithAlqUsingIPR (const Simulator &simulator, const WellStateType &well_state, Scalar bhp, const SummaryState &summary_state, const Scalar alq_value)
 
bool wellUnderZeroRateTarget (const GroupStateHelperType &groupStateHelper) const
 
bool stoppedOrZeroRateTarget (const GroupStateHelperType &groupStateHelper) const
 
bool updateWellStateWithTHPTargetProd (const Simulator &simulator, WellStateType &well_state, const GroupStateHelperType &groupStateHelper) const
 
bool wellUnderZeroGroupRateTarget (const GroupStateHelperType &groupStateHelper, const std::optional< bool > group_control=std::nullopt) const
 
bool updateWellControl (const Simulator &simulator, const IndividualOrGroup iog, const GroupStateHelperType &groupStateHelper, WellStateType &well_state)
 
void updateWeldrawMaxRate (const Simulator &simulator, WellStateType &well_state, DeferredLogger &deferred_logger) const
 
bool updateWellControlAndStatusLocalIteration (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, const Well::InjectionControls &inj_controls, const Well::ProductionControls &prod_controls, const Scalar WQTotal, WellStateType &well_state, const bool fixed_control, const bool fixed_status, const bool solving_with_zero_rate)
 
void addCellRates (std::map< int, RateVector > &cellRates_) const
 
Scalar volumetricSurfaceRateForConnection (int cellIdx, int phaseIdx) const
 
void wellTesting (const Simulator &simulator, const double simulation_time, const GroupStateHelperType &groupStateHelper, WellStateType &well_state, WellTestState &welltest_state, GLiftEclWells &ecl_well_map, std::map< std::string, double > &open_times)
 
void checkWellOperability (const Simulator &simulator, const WellStateType &well_state, const GroupStateHelperType &groupStateHelper)
 
void gliftBeginTimeStepWellTestUpdateALQ (const Simulator &simulator, WellStateType &well_state, const GroupState< Scalar > &group_state, GLiftEclWells &ecl_well_map, DeferredLogger &deferred_logger)
 
void updateWellOperability (const Simulator &simulator, const WellStateType &well_state, const GroupStateHelperType &groupStateHelper)
 
bool updateWellOperabilityFromWellEq (const Simulator &simulator, const GroupStateHelperType &groupStateHelper)
 
void initializeProducerWellState (const Simulator &simulator, WellStateType &well_state, DeferredLogger &deferred_logger) const
 
void solveWellEquation (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, WellStateType &well_state)
 
const std::vector< RateVector > & connectionRates () const
 
void updateConnectionDFactor (const Simulator &simulator, SingleWellStateType &ws) const
 
void updateConnectionTransmissibilityFactor (const Simulator &simulator, SingleWellStateType &ws) const
 
virtual bool iterateWellEqWithSwitching (const Simulator &simulator, const double dt, const WellInjectionControls &inj_controls, const WellProductionControls &prod_controls, const GroupStateHelperType &groupStateHelper, WellStateType &well_state, const bool fixed_control, const bool fixed_status, const bool solving_with_zero_rate)=0
 
Scalar scalingFactor (const int phaseIdx) const
 
Eval restrictEval (const EvalWell &in) const
 
const RateConverterType & rateConverter () const
 
Scalar totalReservoirVoidageRate (const std::vector< Scalar > &surface_rates) const override
 The total reservoir voidage rate for the given surface phase rates (or potentials), using the region average PVT properties that also produce the voidage rates in the well state. More...
 
const std::vector< PerforationData< FluidSystem::Scalar > > & perforationData () const
 Get the perforations of the well. More...
 
const std::string & name () const
 Well name. More...
 
bool isInjector () const
 True if the well is an injector. More...
 
bool isProducer () const
 True if the well is a producer. More...
 
const std::vector< int > & cells () const
 Well cells. More...
 
int indexOfWell () const
 Index of well in the wells struct and wellState. More...
 
void adaptRatesForVFP (std::vector< FluidSystem::Scalar > &rates) const
 
const Well & wellEcl () const
 
Well & wellEcl ()
 
const PhaseUsageInfo< FluidSystem::IndexTraitsType > & phaseUsage () const
 
bool underPredictionMode () const
 Returns true if the well is currently in prediction mode (i.e. not history mode). More...
 
bool isOperableAndSolvable () const
 
bool useVfpExplicit () const
 
bool thpLimitViolatedButNotSwitched () const
 
void initCompletions ()
 
void closeCompletions (const WellTestState &wellTestState)
 
void setVFPProperties (const VFPProperties< FluidSystem::Scalar, FluidSystem::IndexTraitsType > *vfp_properties_arg)
 
void setPrevSurfaceRates (WellStateType &well_state, const WellStateType &prev_well_state) const
 
void setGuideRate (const GuideRate *guide_rate_arg)
 
void setWellEfficiencyFactor (const FluidSystem::Scalar efficiency_factor)
 
void setRepRadiusPerfLength ()
 
void setWsolvent (const FluidSystem::Scalar wsolvent)
 
void setDynamicThpLimit (const FluidSystem::Scalar thp_limit)
 
void setDynamicThpLimit (const std::optional< FluidSystem::Scalar > thp_limit)
 
std::optional< FluidSystem::Scalar > getDynamicThpLimit () const
 
void updatePerforatedCell (std::vector< bool > &is_cell_perforated)
 
bool wellHasTHPConstraints (const SummaryState &summaryState) const
 Returns true if the well has one or more THP limits/constraints. More...
 
void stopWell ()
 
void openWell ()
 
Well::Status wellStatus ()
 
bool wellIsStopped () const
 
int currentStep () const
 
int pvtRegionIdx () const
 
const GuideRate * guideRate () const
 
int numConservationQuantities () const
 
int numPhases () const
 
int numLocalPerfs () const
 
FluidSystem::Scalar refDepth () const
 
FluidSystem::Scalar gravity () const
 
const VFPProperties< FluidSystem::Scalar, FluidSystem::IndexTraitsType > * vfpProperties () const
 
const ParallelWellInfo< FluidSystem::Scalar > & parallelWellInfo () const
 
const std::vector< FluidSystem::Scalar > & perfDepth () const
 
std::vector< FluidSystem::Scalar > & perfDepth ()
 
const std::vector< FluidSystem::Scalar > & wellIndex () const
 
std::vector< FluidSystem::Scalar > & wellIndex ()
 Mutable per-perforation well indices (connection transmissibility factors). Adjoint hook: the dJ/dperm well-coupling gradient perturbs the CTF here and re-linearizes. Not used in the forward path. More...
 
const std::map< int, std::vector< int > > & getCompletions () const
 
FluidSystem::Scalar getTHPConstraint (const SummaryState &summaryState) const
 
FluidSystem::Scalar getALQ (const WellStateType &well_state) const
 
FluidSystem::Scalar wsolvent () const
 
FluidSystem::Scalar rsRvInj () const
 
void initInjMult (const std::vector< FluidSystem::Scalar > &max_inj_mult)
 
void updateInjMult (std::vector< FluidSystem::Scalar > &inj_multipliers, DeferredLogger &deferred_logger) const
 
FluidSystem::Scalar getInjMult (const int local_perf_index, const FluidSystem::Scalar bhp, const FluidSystem::Scalar perf_pres, DeferredLogger &dlogger) const
 
bool isVFPActive (DeferredLogger &deferred_logger) const
 
void reportWellSwitching (const SingleWellState< FluidSystem::Scalar, FluidSystem::IndexTraitsType > &ws, DeferredLogger &deferred_logger) const
 
bool changedToOpenThisStep () const
 
void updateWellTestState (const SingleWellState< FluidSystem::Scalar, FluidSystem::IndexTraitsType > &ws, const double &simulationTime, const bool &writeMessageToOPMLog, const bool during_well_test, const bool zero_group_target, WellTestState &wellTestState, const UnitSystem &unit_system, const std::time_t start_time, DeferredLogger &deferred_logger, std::string *closure_reason=nullptr) const
 
bool isPressureControlled (const WellStateType &well_state) const
 
Well::ProductionControls productionControlsWithWeldraw (const SummaryState &summary_state, const SingleWellState< FluidSystem::Scalar, FluidSystem::IndexTraitsType > &ws) const
 
FluidSystem::Scalar wellEfficiencyFactor () const
 
void updateFilterCakeMultipliers (const std::vector< FluidSystem::Scalar > &inj_fc_multiplier)
 Update filter cake multipliers. More...
 
void resetWellOperability ()
 
virtual int setPrimaryVars (typename std::vector< FluidSystem::Scalar >::const_iterator)
 
void addPerforations (const std::vector< RuntimePerforation > &perfs)
 
void addFracturePerforations (const std::vector< RuntimePerforation > &perfs)
 
const std::vector< WellIndexFracture > & wellIndexFracture () const
 
const WellSolveStats & solveStats () const
 
void resetSolveStats () const
 
const Equations & linSys () const
 Returns a const reference to equation system. More...
 
const PrimaryVariables & primaryVariables () const
 Read access to the primary variables, needed by the adjoint module to build dJ/dx_w (segment-0 BHP / surface-rate derivatives), mirroring the StandardWellEval hook. More...
 
const WellSegments & segmentSet () const
 
int segmentNumberToIndex (const int segment_number) const
 
int numberOfSegments () const
 number of segments for this well More...
 

Static Public Member Functions

static void applyWeldrawRateLimit (const Well &well_ecl, const std::optional< FluidSystem::Scalar > &weldraw_max_rate, Well::ProductionControls &controls)
 

Static Public Attributes

static constexpr bool compositionSwitchEnabled
 
static constexpr bool enable_temperature
 
static constexpr Scalar energy_scaling_factor_
 
static constexpr bool has_solvent
 
static constexpr bool has_polymer
 
static constexpr bool has_energy
 
static constexpr bool has_brine
 
static constexpr bool has_zFraction = getPropValue<TypeTag, Properties::EnableExtbo>()
 
static constexpr EnergyModules energyModuleType = getPropValue<TypeTag, Properties::EnergyModuleType>()
 
static constexpr bool has_polymermw = getPropValue<TypeTag, Properties::EnablePolymerMW>()
 
static constexpr bool has_foam = getPropValue<TypeTag, Properties::EnableFoam>()
 
static constexpr bool has_watVapor = getPropValue<TypeTag, Properties::EnableVapwat>()
 
static constexpr bool has_disgas_in_water = getPropValue<TypeTag, Properties::EnableDisgasInWater>()
 
static constexpr bool has_saltPrecip = getPropValue<TypeTag, Properties::EnableSaltPrecipitation>()
 
static constexpr bool has_bioeffects = getPropValue<TypeTag, Properties::EnableBioeffects>()
 
static constexpr bool has_micp = Indices::enableMICP
 
static constexpr int numResDofs = Indices::numEq
 
static constexpr int numWellDofs = numResDofs + 1
 
static constexpr int Water
 
static constexpr int Oil
 
static constexpr int Gas
 
static constexpr int numResDofs
 
static constexpr int numWellDofs
 

Protected Types

using Equations = MultisegmentWellEquations< Scalar, IndexTraits, numWellEq, Indices::numEq >
 
using MSWSegments = MultisegmentWellSegments< GetPropType< TypeTag, Properties::FluidSystem >, GetPropType< TypeTag, Properties::Indices > >
 
using BVectorWell = typename Equations::BVectorWell
 
using EvalWell = typename PrimaryVariables::EvalWell
 

Protected Member Functions

void updateWellState (const Simulator &simulator, const BVectorWell &dwells, const GroupStateHelperType &groupStateHelper, WellStateType &well_state, const Scalar relaxation_factor=1.0)
 
void computeInitialSegmentInventory (DeferredLogger &deferred_logger)
 
void computePerfCellPressDiffs (const Simulator &simulator)
 
template<class Value >
void computePerfRate (const IntensiveQuantities &int_quants, const std::vector< Value > &mob_perfcells, const std::vector< Value > &Tw, const int seg, const int perf, const Value &segment_pressure, const bool &allow_cf, std::vector< Value > &cq_s, Value &perf_press, PerforationRates< Scalar > &perf_rates, DeferredLogger &deferred_logger) const
 
template<class Value >
void computePerfRate (const Value &pressure_cell, const Value &rs, const Value &rv, const std::vector< Value > &b_perfcells, const std::vector< Value > &mob_perfcells, const std::vector< Value > &Tw, const int perf, const Value &segment_pressure, const Value &segment_density, const bool &allow_cf, const std::vector< Value > &cmix_s, std::vector< Value > &cq_s, Value &perf_press, PerforationRates< Scalar > &perf_rates, DeferredLogger &deferred_logger) const
 
void computeSegmentFluidProperties (const Simulator &simulator, DeferredLogger &deferred_logger)
 
template<class Value >
void getTransMult (Value &trans_mult, const Simulator &simulator, const int cell_indx) const
 
template<class Value >
void getMobility (const Simulator &simulator, const int local_perf_index, std::vector< Value > &mob, DeferredLogger &deferred_logger) const
 
void computeWellRatesAtBhpLimit (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, std::vector< Scalar > &well_flux) const
 
void computeWellRatesWithBhp (const Simulator &simulator, const Scalar &bhp, std::vector< Scalar > &well_flux, DeferredLogger &deferred_logger) const override
 
void computeWellRatesWithBhpIterations (const Simulator &simulator, const Scalar &bhp, const GroupStateHelperType &groupStateHelper, std::vector< Scalar > &well_flux) const override
 
std::vector< Scalar > computeWellPotentialWithTHP (const WellStateType &well_state, const Simulator &simulator, const GroupStateHelperType &groupStateHelper) const
 
bool computeWellPotentialsImplicit (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, std::vector< Scalar > &well_potentials) const
 
Scalar getRefDensity () const override
 
bool iterateWellEqWithControl (const Simulator &simulator, const double dt, const Well::InjectionControls &inj_controls, const Well::ProductionControls &prod_controls, const GroupStateHelperType &groupStateHelper, WellStateType &well_state) override
 
bool iterateWellEqWithSwitching (const Simulator &simulator, const double dt, const Well::InjectionControls &inj_controls, const Well::ProductionControls &prod_controls, const GroupStateHelperType &groupStateHelper, WellStateType &well_state, const bool fixed_control, const bool fixed_status, const bool solving_with_zero_rate) override
 
void assembleWellEqWithoutIteration (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, const double dt, const Well::InjectionControls &inj_controls, const Well::ProductionControls &prod_controls, WellStateType &well_state, const bool solving_with_zero_rate) override
 
void updateWaterThroughput (const double dt, WellStateType &well_state) const override
 
EvalWell getSegmentSurfaceVolume (const int seg_idx, const EvalWell &volume_ratio) const
 
bool openCrossFlowAvoidSingularity (const Simulator &simulator) const
 
bool allDrawDownWrongDirection (const Simulator &simulator) const
 
std::optional< Scalar > computeBhpAtThpLimitProd (const WellStateType &well_state, const Simulator &ebos_simulator, const GroupStateHelperType &groupStateHelper, const SummaryState &summary_state) const
 
std::optional< Scalar > computeBhpAtThpLimitInj (const Simulator &ebos_simulator, const GroupStateHelperType &groupStateHelper, const SummaryState &summary_state) const
 
Scalar maxPerfPress (const Simulator &simulator) const override
 
void checkOperabilityUnderBHPLimit (const WellStateType &well_state, const Simulator &ebos_simulator, DeferredLogger &deferred_logger) override
 
void checkOperabilityUnderTHPLimit (const Simulator &ebos_simulator, const WellStateType &well_state, const GroupStateHelperType &groupStateHelper) override
 
void updateIPR (const Simulator &ebos_simulator, DeferredLogger &deferred_logger) const override
 
template<typename ValueType = EvalWell>
SegmentFluidState< ValueType > createFluidState (const std::vector< ValueType > &fluid_composition, const ValueType &pressure, const ValueType &temperature, const ValueType &saltConcentration, DeferredLogger &deferred_logger) const
 
SegmentFluidState< EvalWell > createSegmentFluidState (int seg, const FSInfo &info, DeferredLogger &deferred_logger) const
 
SegmentPvt segmentPvt (const SegmentFluidState< EvalWell > &fluid_state) const
 
void assemblePerforationEnergyEq (const IntensiveQuantities &int_quants, const std::vector< EvalWell > &cq_s, const int seg, const int local_perf_index, DeferredLogger &deferred_logger)
 
void updateWellHeadCondition (const Simulator &simulator, const Scalar first_perf_temperature, const Scalar first_perf_salt_concentration, DeferredLogger &deferred_logger)
 
void updateSegmentFluidState (const FSInfo &info, DeferredLogger &deferred_logger)
 
template<typename ValueType = EvalWell>
ValueType computeSegmentEnergy (int seg) const
 
template<typename FluidStateT >
EvalWell surfaceToReservoirRate (unsigned phaseIdx, const FluidStateT &fs, const std::vector< EvalWell > &surface_rates, int seg, std::string_view context, DeferredLogger &deferred_logger) const
 
EvalWell computeSegmentEnergyRate (int seg, int upwind_seg, const SegmentFluidState< EvalWell > &upwind_fs, std::string_view context, DeferredLogger &deferred_logger) const
 
virtual void assembleWellEqWithoutIteration (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, const double dt, const WellInjectionControls &inj_controls, const WellProductionControls &prod_controls, WellStateType &well_state, const bool solving_with_zero_rate)=0
 
void updateGroupTargetFallbackFlag (WellState< FluidSystem::Scalar, FluidSystem::IndexTraitsType > &well_state, const std::vector< FluidSystem::Scalar > &scaled_well_fractions, DeferredLogger &deferred_logger) const
 
std::pair< bool, bool > computeWellPotentials (std::vector< FluidSystem::Scalar > &well_potentials, const WellStateType &well_state)
 
Scalar wpolymer () const
 
Scalar wfoam () const
 
Scalar wsalt () const
 
Scalar wmicrobes () const
 
Scalar woxygen () const
 
Scalar wurea () const
 
std::vector< Scalar > initialWellRateFractions (const Simulator &ebosSimulator, const WellStateType &well_state) const
 
virtual bool iterateWellEqWithControl (const Simulator &simulator, const double dt, const WellInjectionControls &inj_controls, const WellProductionControls &prod_controls, const GroupStateHelperType &groupStateHelper, WellStateType &well_state)=0
 
bool iterateWellEquations (const Simulator &simulator, const double dt, const GroupStateHelperType &groupStateHelper, WellStateType &well_state)
 
bool solveWellWithOperabilityCheck (const Simulator &simulator, const double dt, const Well::InjectionControls &inj_controls, const Well::ProductionControls &prod_controls, const GroupStateHelperType &groupStateHelper, WellStateType &well_state)
 
std::optional< Scalar > estimateOperableBhp (const Simulator &ebos_simulator, const double dt, const GroupStateHelperType &groupStateHelper, const SummaryState &summary_state, WellStateType &well_state)
 
bool solveWellWithBhp (const Simulator &simulator, const double dt, const Scalar bhp, const GroupStateHelperType &groupStateHelper, WellStateType &well_state)
 
bool solveWellWithZeroRate (const Simulator &simulator, const double dt, const GroupStateHelperType &groupStateHelper, WellStateType &well_state)
 
bool solveWellForTesting (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, WellStateType &well_state)
 
template<class GasLiftSingleWell >
std::unique_ptr< GasLiftSingleWell > initializeGliftWellTest_ (const Simulator &simulator, WellStateType &well_state, const GroupState< Scalar > &group_state, GLiftEclWells &ecl_well_map, DeferredLogger &deferred_logger)
 
Eval getPerfCellPressure (const FluidState &fs) const
 
template<class Value , class Callback >
void getTransMult (Value &trans_mult, const Simulator &simulator, const int cell_idx, Callback &extendEval) const
 
template<class Value >
void getTw (std::vector< Value > &wi, const int perf, const IntensiveQuantities &intQuants, const Value &trans_mult, const SingleWellStateType &ws) const
 
template<class Value , class Callback >
void getMobility (const Simulator &simulator, const int local_perf_index, std::vector< Value > &mob, Callback &extendEval, DeferredLogger &deferred_logger) const
 
void computeConnLevelProdInd (const FluidState &fs, const std::function< Scalar(const Scalar)> &connPICalc, const std::vector< Scalar > &mobility, Scalar *connPI) const
 
void computeConnLevelInjInd (const FluidState &fs, const Phase preferred_phase, const std::function< Scalar(const Scalar)> &connIICalc, const std::vector< Scalar > &mobility, Scalar *connII, DeferredLogger &deferred_logger) const
 
Scalar computeConnectionDFactor (const int perf, const IntensiveQuantities &intQuants, const SingleWellStateType &ws) const
 
FSInfo getFirstPerfCellConditions (const Simulator &simulator) const
 Temperature and salt concentration of the first perforated cell, broadcast so that all processes of a distributed well get the values. More...
 
void calculateReservoirRates (const bool use_well_bhp_temperature, SingleWellState< Scalar, IndexTraits > &ws) const
 
bool checkIndividualConstraints (SingleWellState< Scalar, IndexTraits > &ws, const SummaryState &summaryState, DeferredLogger &deferred_logger, const std::optional< Well::InjectionControls > &inj_controls=std::nullopt, const std::optional< Well::ProductionControls > &prod_controls=std::nullopt) const
 
bool checkGroupConstraints (const GroupStateHelperType &groupStateHelper, const Schedule &schedule, const SummaryState &summaryState, const bool check_guide_rate, WellStateType &well_state) const
 
bool checkConstraints (const GroupStateHelperType &groupStateHelper, const Schedule &schedule, const SummaryState &summaryState, WellStateType &well_state) const
 
std::optional< Scalar > getGroupInjectionTargetRate (const Group &group, const GroupStateHelperType &groupStateHelper, const InjectorType &injectorType, Scalar efficiencyFactor) const
 
Scalar getGroupProductionTargetRate (const Group &group, const GroupStateHelperType &groupStateHelper, Scalar efficiencyFactor) const
 
bool zeroGroupRateTarget (const GroupStateHelperType &groupStateHelper) const
 
WellSolveScope solveScope (const int &iterations) const
 
SolvePartTimer solveAssembleTimer () const
 
SolvePartTimer solveLinearSolveTimer () const
 
PotentialCalculationScope potentialCalculationScope () const
 
bool getAllowCrossFlow () const
 
FluidSystem::Scalar wmicrobes_ () const
 
FluidSystem::Scalar wfoam_ () const
 
FluidSystem::Scalar woxygen_ () const
 
FluidSystem::Scalar wpolymer_ () const
 
FluidSystem::Scalar wsalt_ () const
 
FluidSystem::Scalar wurea_ () const
 
int polymerTable_ () const
 
int polymerInjTable_ () const
 
int polymerWaterTable_ () const
 
bool wellUnderZeroRateTargetIndividual (const SummaryState &summary_state, const WellState< FluidSystem::Scalar, FluidSystem::IndexTraitsType > &well_state) const
 
bool wellUnderGroupControl (const SingleWellState< FluidSystem::Scalar, FluidSystem::IndexTraitsType > &ws) const
 
void checkNegativeWellPotentials (std::vector< FluidSystem::Scalar > &well_potentials, const bool checkOperability, DeferredLogger &deferred_logger)
 
void onlyKeepBHPandTHPcontrols (const SummaryState &summary_state, WellStateType &well_state, Well::InjectionControls &inj_controls, Well::ProductionControls &prod_controls) const
 
void resetDampening ()
 
void initMatrixAndVectors (const ParallelWellInfo< Scalar > &parallel_well_info)
 
void assembleDefaultPressureEq (const int seg, WellState< Scalar, IndexTraits > &well_state, const bool use_average_density)
 
void assembleICDPressureEq (const int seg, const UnitSystem &unit_system, WellState< Scalar, IndexTraits > &well_state, const SummaryState &summary_state, const bool use_average_density, DeferredLogger &deferred_logger)
 
void assembleAccelerationAndHydroPressureLosses (const int seg, WellState< Scalar, IndexTraits > &well_state, const bool use_average_density)
 
void assemblePressureEq (const int seg, const UnitSystem &unit_system, WellState< Scalar, IndexTraits > &well_state, const SummaryState &summary_state, const bool use_average_density, DeferredLogger &deferred_logger)
 
ConvergenceReport getWellConvergence (const WellState< Scalar, IndexTraits > &well_state, const std::vector< Scalar > &B_avg, DeferredLogger &deferred_logger, const Scalar max_residual_allowed, const Scalar tolerance_wells, const Scalar relaxed_inner_tolerance_flow_ms_well, const Scalar tolerance_pressure_ms_wells, const Scalar relaxed_inner_tolerance_pressure_ms_well, const bool relax_tolerance, const bool well_is_stopped) const
 check whether the well equations get converged for this well More...
 
std::pair< bool, std::vector< Scalar > > getFiniteWellResiduals (const std::vector< Scalar > &B_avg, DeferredLogger &deferred_logger) const
 
Scalar getControlTolerance (const WellState< Scalar, IndexTraits > &well_state, const Scalar tolerance_wells, const Scalar tolerance_pressure_ms_wells, DeferredLogger &deferred_logger) const
 
Scalar getResidualMeasureValue (const WellState< Scalar, IndexTraits > &well_state, const std::vector< Scalar > &residuals, const Scalar tolerance_wells, const Scalar tolerance_pressure_ms_wells, DeferredLogger &deferred_logger) const
 
void assembleAccelerationPressureLoss (const int seg, WellState< Scalar, IndexTraits > &well_state)
 
EvalWell extendEval (const Eval &in) const
 
void scaleSegmentRatesWithWellRates (const std::vector< std::vector< int > > &segment_inlets, const std::vector< std::vector< int > > &segment_perforations, WellState< FluidSystem::Scalar, FluidSystem::IndexTraitsType > &well_state) const
 
void scaleSegmentPressuresWithBhp (WellState< FluidSystem::Scalar, FluidSystem::IndexTraitsType > &well_state) const
 
WellSegmentCompPressureDrop compPressureDrop () const
 
bool update_relaxation_factor (const std::vector< FluidSystem::Scalar > &measure_history, FluidSystem::Scalar &relaxation_factor, bool &regularize, DeferredLogger &deferred_logger) const
 Detect oscillation or stagnation based on the residual measure history. More...
 
bool repeatedStagnation (const std::vector< FluidSystem::Scalar > &measure_history, bool &regularize, DeferredLogger &deferred_logger) const
 
bool accelerationalPressureLossConsidered () const
 
bool frictionalPressureLossConsidered () const
 
FluidSystem::Scalar getSegmentDp (const int seg, const FluidSystem::Scalar density, const std::vector< FluidSystem::Scalar > &seg_dp) const
 

Protected Attributes

bool regularize_
 
std::vector< std::vector< Scalar > > segment_fluid_initial_
 
std::vector< Scalar > segment_initial_energy_
 
std::vector< SegmentFluidState< EvalWell > > segment_fluid_state_
 
std::vector< SegmentPvt > segment_pvt_
 
SegmentFluidState< EvalWell > wellhead_fluid_state_
 
int debug_cost_counter_ = 0
 
std::vector< RateVector > connectionRates_
 
std::vector< Scalar > B_avg_
 
bool changed_to_stopped_this_step_ = false
 
bool thp_update_iterations = false
 
int number_of_well_reopenings_ {0}
 
const RateConverterType & rateConverter_
 
OperabilityStatus operability_status_
 
Well well_ecl_
 
const ParallelWellInfo< FluidSystem::Scalar > & parallel_well_info_
 
const int current_step_
 
const ModelParameters & param_
 
const int pvtRegionIdx_
 
const int num_conservation_quantities_
 
int number_of_phases_
 
int index_of_well_
 
const PhaseUsageInfo< FluidSystem::IndexTraitsType > & phase_usage_
 
const std::vector< PerforationData< FluidSystem::Scalar > > * perf_data_
 
std::vector< FluidSystem::Scalar > ipr_a_
 
std::vector< FluidSystem::Scalar > ipr_b_
 
std::vector< int > well_cells_
 
std::vector< FluidSystem::Scalar > well_index_
 
std::vector< WellIndexFracture > well_index_fracture_
 
int number_of_local_perforations_
 
std::vector< FluidSystem::Scalar > perf_depth_
 
std::vector< FluidSystem::Scalar > perf_rep_radius_
 
std::vector< FluidSystem::Scalar > perf_length_
 
std::vector< FluidSystem::Scalar > bore_diameters_
 
std::map< int, std::vector< int > > completions_
 
FluidSystem::Scalar ref_depth_
 
std::vector< int > saturation_table_number_
 
Well::Status wellStatus_
 
FluidSystem::Scalar gravity_
 
FluidSystem::Scalar wsolvent_
 
std::optional< FluidSystem::Scalar > dynamic_thp_limit_
 
std::vector< FluidSystem::Scalar > inj_multiplier_
 
std::vector< FluidSystem::Scalar > prev_inj_multiplier_
 
std::vector< FluidSystem::Scalar > inj_multiplier_previter_
 
std::vector< FluidSystem::Scalar > inj_multiplier_damp_factor_
 
std::vector< FluidSystem::Scalar > inj_fc_multiplier_
 
FluidSystem::Scalar well_efficiency_factor_
 
const VFPProperties< FluidSystem::Scalar, FluidSystem::IndexTraitsType > * vfp_properties_
 
const GuideRate * guide_rate_
 
std::vector< std::string > well_control_log_
 
bool changed_to_open_this_step_
 
std::shared_ptr< WellSolveStats > solve_stats_
 
bool computing_well_potentials_
 
bool in_well_solve_
 
const WellInterfaceIndices< GetPropType< TypeTag, Properties::FluidSystem >, GetPropType< TypeTag, Properties::Indices > > & baseif_
 
Equations linSys_
 The equation system. More...
 
PrimaryVariables primary_variables_
 The primary variables. More...
 
MSWSegments segments_
 Segment properties. More...
 
std::vector< Scalar > cell_perforation_depth_diffs_
 
std::vector< Scalar > cell_perforation_pressure_diffs_
 

Static Protected Attributes

static constexpr int INVALIDCOMPLETION
 
static constexpr int numWellEq
 
static constexpr int SPres
 
static constexpr int WQTotal
 
static constexpr bool enable_energy
 
static constexpr int Temperature
 

Member Typedef Documentation

◆ Base

template<typename TypeTag >
using Opm::MultisegmentWell< TypeTag >::Base = WellInterface<TypeTag>

◆ BlackOilFluidStateType

template<typename TypeTag >
template<class ValueType >
using Opm::WellInterface< TypeTag >::BlackOilFluidStateType = BlackOilFluidState<ValueType, FluidSystem, energyModuleType != EnergyModules::NoTemperature, energyModuleType == EnergyModules::FullyImplicitThermal, Indices::compositionSwitchIdx != std::numeric_limits<unsigned>::max(), has_watVapor, has_brine, has_saltPrecip, has_disgas_in_water, has_solvent, Indices::numPhases>
inherited

◆ BMatrix

template<typename TypeTag >
using Opm::MultisegmentWell< TypeTag >::BMatrix = typename Base::BMatrix

◆ BVector

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::BVector = Dune::BlockVector<VectorBlockType>

◆ BVectorWell

using Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::BVectorWell = typename Equations::BVectorWell
protectedinherited

◆ CMatrix

template<typename TypeTag >
using Opm::MultisegmentWell< TypeTag >::CMatrix = typename Base::CMatrix

◆ DMatrix

template<typename TypeTag >
using Opm::MultisegmentWell< TypeTag >::DMatrix = typename Base::DMatrix

◆ Equations

using Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::Equations = MultisegmentWellEquations<Scalar, IndexTraits, numWellEq, Indices::numEq>
protectedinherited

◆ Eval

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::Eval = typename Base::Eval

◆ EvalWell

using Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::EvalWell = typename PrimaryVariables::EvalWell
protectedinherited

◆ FluidState

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::FluidState = BlackOilFluidStateType<Eval>

◆ FluidSystem

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>

◆ FSInfo

template<typename TypeTag >
using Opm::MultisegmentWell< TypeTag >::FSInfo = typename Base::FSInfo

◆ GasLiftSingleWell

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::GasLiftSingleWell = ::Opm::GasLiftSingleWell<TypeTag>
inherited

◆ GLiftEclWells

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::GLiftEclWells = typename GasLiftGroupInfo<Scalar, IndexTraits>::GLiftEclWells
inherited

◆ Grid

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::Grid = GetPropType<TypeTag, Properties::Grid>
inherited

◆ GroupStateHelperType

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::GroupStateHelperType = GroupStateHelper<Scalar, IndexTraits>

◆ IndexTraits

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::IndexTraits = typename FluidSystem::IndexTraitsType

◆ Indices

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::Indices = GetPropType<TypeTag, Properties::Indices>

◆ IntensiveQuantities

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::IntensiveQuantities = GetPropType<TypeTag, Properties::IntensiveQuantities>

◆ MaterialLaw

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::MaterialLaw = GetPropType<TypeTag, Properties::MaterialLaw>

◆ MatrixBlockType

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::MatrixBlockType = Dune::FieldMatrix<Scalar, Indices::numEq, Indices::numEq>
inherited

◆ ModelParameters

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::ModelParameters = typename Base::ModelParameters

◆ MSWEval

template<typename TypeTag >
using Opm::MultisegmentWell< TypeTag >::MSWEval = MultisegmentWellEval<GetPropType<TypeTag, Properties::FluidSystem>, GetPropType<TypeTag, Properties::Indices> >

◆ MSWSegments

using Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::MSWSegments = MultisegmentWellSegments<GetPropType< TypeTag, Properties::FluidSystem > ,GetPropType< TypeTag, Properties::Indices > >
protectedinherited

◆ PressureMatrix

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::PressureMatrix = Dune::BCRSMatrix<Opm::MatrixBlock<Scalar, 1, 1> >

◆ PrimaryVariables

using Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::PrimaryVariables = MultisegmentWellPrimaryVariables<GetPropType< TypeTag, Properties::FluidSystem > ,GetPropType< TypeTag, Properties::Indices > >
inherited

◆ RateConverterType

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::RateConverterType = typename WellInterfaceFluidSystem<FluidSystem>::RateConverterType

◆ RateVector

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::RateVector = GetPropType<TypeTag, Properties::RateVector>
inherited

◆ Scalar

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::Scalar = GetPropType<TypeTag, Properties::Scalar>

◆ SegmentFluidState

template<typename TypeTag >
template<typename ValueType >
using Opm::MultisegmentWell< TypeTag >::SegmentFluidState = Base::template BlackOilFluidStateType<ValueType>

◆ SegmentPvt

template<typename TypeTag >
using Opm::MultisegmentWell< TypeTag >::SegmentPvt = typename MultisegmentWellSegments<FluidSystem, Indices>::SegmentPvt

◆ Simulator

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::Simulator = GetPropType<TypeTag, Properties::Simulator>

◆ SingleWellStateType

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::SingleWellStateType = SingleWellState<Scalar, IndexTraits>
inherited

◆ SparseMatrixAdapter

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::SparseMatrixAdapter = GetPropType<TypeTag, Properties::SparseMatrixAdapter>

◆ VectorBlockType

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::VectorBlockType = Dune::FieldVector<Scalar, Indices::numEq>
inherited

◆ WellStateType

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::WellStateType = WellState<Scalar, IndexTraits>

◆ WVector

template<typename TypeTag >
using Opm::MultisegmentWell< TypeTag >::WVector = typename Base::WVector

Member Enumeration Documentation

◆ IndividualOrGroup

template<typename TypeTag >
enum class Opm::WellInterface::IndividualOrGroup
stronginherited
Enumerator
Individual 
Group 
Both 

Constructor & Destructor Documentation

◆ MultisegmentWell()

template<typename TypeTag >
Opm::MultisegmentWell< TypeTag >::MultisegmentWell ( const Well &  well,
const ParallelWellInfo< Scalar > &  pw_info,
const int  time_step,
const ModelParameters &  param,
const RateConverterType &  rate_converter,
const int  pvtRegionIdx,
const int  num_conservation_quantities,
const int  num_phases,
const int  index_of_well,
const std::vector< PerforationData< Scalar > > &  perf_data 
)

Member Function Documentation

◆ accelerationalPressureLossConsidered()

bool Opm::MultisegmentWellGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::accelerationalPressureLossConsidered ( ) const
protectedinherited

◆ adaptRatesForVFP()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::adaptRatesForVFP ( std::vector< FluidSystem::Scalar > &  rates) const
inherited

◆ addBCDMatrix()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::addBCDMatrix ( std::vector< typename Base::BMatrix > &  b_matrices,
std::vector< typename Base::CMatrix > &  c_matrices,
std::vector< typename Base::DMatrix > &  d_matrices,
Opm::SparseTable< int > &  wcells 
) const
inlineoverridevirtual

Implements Opm::WellInterface< TypeTag >.

References Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem >, GetPropType< TypeTag, Properties::Indices > >::addBCDMatrix(), Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem >, GetPropType< TypeTag, Properties::Indices > >::numWellDofs, and Opm::WellInterface< TypeTag >::numWellDofs.

◆ addCellRates()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::addCellRates ( std::map< int, RateVector > &  cellRates_) const
inherited

◆ addFracturePerforations()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::addFracturePerforations ( const std::vector< RuntimePerforation > &  perfs)
inherited

Record (or update in place) the fracture contribution to the connection transmissibility of existing perforations. Perforations referring to cells that are not part of this well's local structure are skipped with a (deduplicated) log message. Storage is allocated on first use; wells without fractures carry no extra state.

◆ addPerforations()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::addPerforations ( const std::vector< RuntimePerforation > &  perfs)
inherited

◆ addWellContributions()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::addWellContributions ( SparseMatrixAdapter &  jacobian) const
overridevirtual

Implements Opm::WellInterface< TypeTag >.

◆ addWellPressureEquations()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::addWellPressureEquations ( PressureMatrix &  mat,
const BVector &  x,
const int  pressureVarIndex,
const bool  use_well_weights,
const WellStateType &  well_state 
) const
overridevirtual

Implements Opm::WellInterface< TypeTag >.

◆ allDrawDownWrongDirection()

template<typename TypeTag >
bool Opm::MultisegmentWell< TypeTag >::allDrawDownWrongDirection ( const Simulator &  simulator) const
protected

◆ apply() [1/2]

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::apply ( BVector &  r) const
overridevirtual

r = r - C D^-1 Rw

Implements Opm::WellInterface< TypeTag >.

◆ apply() [2/2]

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::apply ( const BVector &  x,
BVector &  Ax 
) const
overridevirtual

Ax = Ax - C D^-1 B x.

Implements Opm::WellInterface< TypeTag >.

◆ applyWeldrawRateLimit()

static void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::applyWeldrawRateLimit ( const Well &  well_ecl,
const std::optional< FluidSystem::Scalar > &  weldraw_max_rate,
Well::ProductionControls &  controls 
)
staticinherited

Impose a WELDRAW-derived maximum production rate as an additional LRAT or GRAT constraint on controls. No-op when weldraw_max_rate is unset. Static so that components without a well interface (e.g. gas lift optimization) can apply the same limit.

◆ assembleAccelerationAndHydroPressureLosses()

void Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::assembleAccelerationAndHydroPressureLosses ( const int  seg,
WellState< Scalar, IndexTraits > &  well_state,
const bool  use_average_density 
)
protectedinherited

◆ assembleAccelerationPressureLoss()

void Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::assembleAccelerationPressureLoss ( const int  seg,
WellState< Scalar, IndexTraits > &  well_state 
)
protectedinherited

◆ assembleDefaultPressureEq()

void Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::assembleDefaultPressureEq ( const int  seg,
WellState< Scalar, IndexTraits > &  well_state,
const bool  use_average_density 
)
protectedinherited

◆ assembleICDPressureEq()

void Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::assembleICDPressureEq ( const int  seg,
const UnitSystem &  unit_system,
WellState< Scalar, IndexTraits > &  well_state,
const SummaryState &  summary_state,
const bool  use_average_density,
DeferredLogger &  deferred_logger 
)
protectedinherited

◆ assemblePerforationEnergyEq()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::assemblePerforationEnergyEq ( const IntensiveQuantities &  int_quants,
const std::vector< EvalWell > &  cq_s,
const int  seg,
const int  local_perf_index,
DeferredLogger &  deferred_logger 
)
protected

◆ assemblePressureEq()

void Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::assemblePressureEq ( const int  seg,
const UnitSystem &  unit_system,
WellState< Scalar, IndexTraits > &  well_state,
const SummaryState &  summary_state,
const bool  use_average_density,
DeferredLogger &  deferred_logger 
)
protectedinherited

◆ assembleWellEq()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::assembleWellEq ( const Simulator &  simulator,
const double  dt,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
inherited

◆ assembleWellEqWithoutIteration() [1/3]

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::assembleWellEqWithoutIteration ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper,
const double  dt,
const Well::InjectionControls &  inj_controls,
const Well::ProductionControls &  prod_controls,
WellStateType &  well_state,
const bool  solving_with_zero_rate 
)
overrideprotected

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), Opm::PerforationRates< Scalar >::dis_gas, Opm::GroupStateHelper< Scalar, IndexTraits >::groupState(), Opm::GroupStateHelper< Scalar, IndexTraits >::pushGroupState(), Opm::PerforationRates< Scalar >::vap_oil, and Opm::WellState< Scalar, IndexTraits >::well().

◆ assembleWellEqWithoutIteration() [2/3]

template<typename TypeTag >
virtual void Opm::WellInterface< TypeTag >::assembleWellEqWithoutIteration ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper,
const double  dt,
const WellInjectionControls &  inj_controls,
const WellProductionControls &  prod_controls,
WellStateType &  well_state,
const bool  solving_with_zero_rate 
)
protectedpure virtualinherited

◆ assembleWellEqWithoutIteration() [3/3]

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::assembleWellEqWithoutIteration ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper,
const double  dt,
WellStateType &  well_state,
const bool  solving_with_zero_rate 
)
inherited

References Opm::WellState< Scalar, IndexTraits >::well().

◆ calculateExplicitQuantities()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::calculateExplicitQuantities ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper 
)
overridevirtual

Implements Opm::WellInterface< TypeTag >.

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger().

Referenced by Opm::MultisegmentWell< TypeTag >::computeWellPotentialsImplicit(), and Opm::MultisegmentWell< TypeTag >::computeWellRatesWithBhpIterations().

◆ calculateReservoirRates()

void Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::calculateReservoirRates ( const bool  use_well_bhp_temperature,
SingleWellState< Scalar, IndexTraits > &  ws 
) const
protectedinherited

◆ cells()

const std::vector< int > & Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::cells ( ) const
inlineinherited

Well cells.

◆ changedToOpenThisStep()

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::changedToOpenThisStep ( ) const
inlineinherited

◆ checkConstraints()

bool Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::checkConstraints ( const GroupStateHelperType &  groupStateHelper,
const Schedule &  schedule,
const SummaryState &  summaryState,
WellStateType &  well_state 
) const
protectedinherited

◆ checkGroupConstraints()

bool Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::checkGroupConstraints ( const GroupStateHelperType &  groupStateHelper,
const Schedule &  schedule,
const SummaryState &  summaryState,
const bool  check_guide_rate,
WellStateType &  well_state 
) const
protectedinherited

◆ checkIndividualConstraints()

bool Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::checkIndividualConstraints ( SingleWellState< Scalar, IndexTraits > &  ws,
const SummaryState &  summaryState,
DeferredLogger &  deferred_logger,
const std::optional< Well::InjectionControls > &  inj_controls = std::nullopt,
const std::optional< Well::ProductionControls > &  prod_controls = std::nullopt 
) const
protectedinherited

◆ checkNegativeWellPotentials()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::checkNegativeWellPotentials ( std::vector< FluidSystem::Scalar > &  well_potentials,
const bool  checkOperability,
DeferredLogger &  deferred_logger 
)
protectedinherited

◆ checkOperabilityUnderBHPLimit()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::checkOperabilityUnderBHPLimit ( const WellStateType &  well_state,
const Simulator &  ebos_simulator,
DeferredLogger &  deferred_logger 
)
overrideprotectedvirtual

Implements Opm::WellInterface< TypeTag >.

References Opm::WellBhpThpCalculator< Scalar, IndexTraits >::calculateThpFromBhp(), and Opm::WellBhpThpCalculator< Scalar, IndexTraits >::mostStrictBhpFromBhpLimits().

◆ checkOperabilityUnderTHPLimit()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::checkOperabilityUnderTHPLimit ( const Simulator &  ebos_simulator,
const WellStateType &  well_state,
const GroupStateHelperType &  groupStateHelper 
)
overrideprotectedvirtual

Implements Opm::WellInterface< TypeTag >.

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), Opm::WellBhpThpCalculator< Scalar, IndexTraits >::mostStrictBhpFromBhpLimits(), and Opm::to_string().

◆ checkWellOperability()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::checkWellOperability ( const Simulator &  simulator,
const WellStateType &  well_state,
const GroupStateHelperType &  groupStateHelper 
)
inherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger().

◆ closeCompletions()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::closeCompletions ( const WellTestState &  wellTestState)
inherited

◆ compPressureDrop()

WellSegmentCompPressureDrop Opm::MultisegmentWellGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::compPressureDrop ( ) const
protectedinherited

◆ computeBhpAtThpLimitInj()

template<typename TypeTag >
std::optional< typename MultisegmentWell< TypeTag >::Scalar > Opm::MultisegmentWell< TypeTag >::computeBhpAtThpLimitInj ( const Simulator &  ebos_simulator,
const GroupStateHelperType &  groupStateHelper,
const SummaryState &  summary_state 
) const
protected

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger().

◆ computeBhpAtThpLimitProd()

template<typename TypeTag >
std::optional< typename MultisegmentWell< TypeTag >::Scalar > Opm::MultisegmentWell< TypeTag >::computeBhpAtThpLimitProd ( const WellStateType &  well_state,
const Simulator &  ebos_simulator,
const GroupStateHelperType &  groupStateHelper,
const SummaryState &  summary_state 
) const
protected

References Opm::MultisegmentWell< TypeTag >::computeBhpAtThpLimitProdWithAlq().

◆ computeBhpAtThpLimitProdWithAlq()

template<typename TypeTag >
std::optional< typename MultisegmentWell< TypeTag >::Scalar > Opm::MultisegmentWell< TypeTag >::computeBhpAtThpLimitProdWithAlq ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper,
const SummaryState &  summary_state,
const Scalar  alq_value,
bool  iterate_if_no_solution 
) const
overridevirtual

Implements Opm::WellInterface< TypeTag >.

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger().

Referenced by Opm::MultisegmentWell< TypeTag >::computeBhpAtThpLimitProd().

◆ computeBhpAtThpLimitProdWithAlqUsingIPR()

template<typename TypeTag >
std::optional< typename WellInterface< TypeTag >::Scalar > Opm::WellInterface< TypeTag >::computeBhpAtThpLimitProdWithAlqUsingIPR ( const Simulator &  simulator,
const WellStateType &  well_state,
Scalar  bhp,
const SummaryState &  summary_state,
const Scalar  alq_value 
)
inherited

References Opm::WellBhpThpCalculator< Scalar, IndexTraits >::estimateStableBhp(), Opm::GroupStateHelper< Scalar, IndexTraits >::pushWellState(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ computeConnectionDFactor()

template<typename TypeTag >
WellInterface< TypeTag >::Scalar Opm::WellInterface< TypeTag >::computeConnectionDFactor ( const int  perf,
const IntensiveQuantities &  intQuants,
const SingleWellStateType &  ws 
) const
protectedinherited

References Opm::SingleWellState< Scalar, IndexTraits >::perf_data, and Opm::SingleWellState< Scalar, IndexTraits >::temperature.

◆ computeConnLevelInjInd()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::computeConnLevelInjInd ( const FluidState &  fs,
const Phase  preferred_phase,
const std::function< Scalar(const Scalar)> &  connIICalc,
const std::vector< Scalar > &  mobility,
Scalar *  connII,
DeferredLogger &  deferred_logger 
) const
protectedinherited

References OPM_DEFLOG_THROW.

◆ computeConnLevelProdInd()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::computeConnLevelProdInd ( const FluidState &  fs,
const std::function< Scalar(const Scalar)> &  connPICalc,
const std::vector< Scalar > &  mobility,
Scalar *  connPI 
) const
protectedinherited

◆ computeCurrentWellRates()

template<typename TypeTag >
std::vector< typename MultisegmentWell< TypeTag >::Scalar > Opm::MultisegmentWell< TypeTag >::computeCurrentWellRates ( const Simulator &  simulator,
DeferredLogger &  deferred_logger 
) const
overridevirtual

Compute well rates based on current reservoir conditions and well variables. Used in updateWellStateRates().

Implements Opm::WellInterface< TypeTag >.

◆ computeInitialSegmentInventory()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::computeInitialSegmentInventory ( DeferredLogger &  deferred_logger)
protected

◆ computePerfCellPressDiffs()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::computePerfCellPressDiffs ( const Simulator &  simulator)
protected

◆ computePerfRate() [1/2]

template<typename TypeTag >
template<class Value >
void Opm::MultisegmentWell< TypeTag >::computePerfRate ( const IntensiveQuantities &  int_quants,
const std::vector< Value > &  mob_perfcells,
const std::vector< Value > &  Tw,
const int  seg,
const int  perf,
const Value &  segment_pressure,
const bool &  allow_cf,
std::vector< Value > &  cq_s,
Value &  perf_press,
PerforationRates< Scalar > &  perf_rates,
DeferredLogger &  deferred_logger 
) const
protected

◆ computePerfRate() [2/2]

template<typename TypeTag >
template<class Value >
void Opm::MultisegmentWell< TypeTag >::computePerfRate ( const Value &  pressure_cell,
const Value &  rs,
const Value &  rv,
const std::vector< Value > &  b_perfcells,
const std::vector< Value > &  mob_perfcells,
const std::vector< Value > &  Tw,
const int  perf,
const Value &  segment_pressure,
const Value &  segment_density,
const bool &  allow_cf,
const std::vector< Value > &  cmix_s,
std::vector< Value > &  cq_s,
Value &  perf_press,
PerforationRates< Scalar > &  perf_rates,
DeferredLogger &  deferred_logger 
) const
protected

References Opm::PerforationRates< Scalar >::dis_gas, OPM_DEFLOG_PROBLEM, and Opm::PerforationRates< Scalar >::vap_oil.

◆ computeSegmentEnergy()

template<typename TypeTag >
template<typename ValueType >
ValueType Opm::MultisegmentWell< TypeTag >::computeSegmentEnergy ( int  seg) const
protected

◆ computeSegmentEnergyRate()

template<typename TypeTag >
MultisegmentWell< TypeTag >::EvalWell Opm::MultisegmentWell< TypeTag >::computeSegmentEnergyRate ( int  seg,
int  upwind_seg,
const SegmentFluidState< EvalWell > &  upwind_fs,
std::string_view  context,
DeferredLogger &  deferred_logger 
) const
protected

◆ computeSegmentFluidProperties()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::computeSegmentFluidProperties ( const Simulator &  simulator,
DeferredLogger &  deferred_logger 
)
protected

◆ computeWellPotentials() [1/2]

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::computeWellPotentials ( const Simulator &  simulator,
const WellStateType &  well_state,
const GroupStateHelperType &  groupStateHelper,
std::vector< Scalar > &  well_potentials 
)
overridevirtual

computing the well potentials for group control

Implements Opm::WellInterface< TypeTag >.

References Opm::WellInterfaceGeneric< Scalar, IndexTraits >::computeWellPotentials(), Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), and Opm::to_string().

◆ computeWellPotentials() [2/2]

std::pair< bool, bool > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::computeWellPotentials ( std::vector< FluidSystem::Scalar > &  well_potentials,
const WellStateType &  well_state 
)
protectedinherited

◆ computeWellPotentialsImplicit()

template<typename TypeTag >
bool Opm::MultisegmentWell< TypeTag >::computeWellPotentialsImplicit ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper,
std::vector< Scalar > &  well_potentials 
) const
protected

References Opm::MultisegmentWell< TypeTag >::calculateExplicitQuantities(), Opm::MultisegmentWell< TypeTag >::debug_cost_counter_, Opm::MultisegmentWellPrimaryVariables< FluidSystem, Indices >::getQs(), Opm::MultisegmentWell< TypeTag >::iterateWellEqWithSwitching(), Opm::WellInterfaceGeneric< Scalar, IndexTraits >::onlyKeepBHPandTHPcontrols(), Opm::MultisegmentWellEval< FluidSystem, Indices >::primary_variables_, Opm::GroupStateHelper< Scalar, IndexTraits >::pushWellState(), Opm::MultisegmentWellGeneric< Scalar, IndexTraits >::scaleSegmentPressuresWithBhp(), Opm::MultisegmentWellGeneric< Scalar, IndexTraits >::scaleSegmentRatesWithWellRates(), Opm::WellInterface< TypeTag >::solveWellWithOperabilityCheck(), Opm::WellState< Scalar, IndexTraits >::well(), Opm::WellInterfaceGeneric< Scalar, IndexTraits >::well_ecl_, and Opm::GroupStateHelper< Scalar, IndexTraits >::wellState().

◆ computeWellPotentialWithTHP()

template<typename TypeTag >
std::vector< typename MultisegmentWell< TypeTag >::Scalar > Opm::MultisegmentWell< TypeTag >::computeWellPotentialWithTHP ( const WellStateType &  well_state,
const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper 
) const
protected

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), and Opm::to_string().

◆ computeWellRatesAtBhpLimit()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::computeWellRatesAtBhpLimit ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper,
std::vector< Scalar > &  well_flux 
) const
protected

◆ computeWellRatesWithBhp()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::computeWellRatesWithBhp ( const Simulator &  simulator,
const Scalar &  bhp,
std::vector< Scalar > &  well_flux,
DeferredLogger &  deferred_logger 
) const
overrideprotectedvirtual

Implements Opm::WellInterface< TypeTag >.

References Opm::WellState< Scalar, IndexTraits >::well().

◆ computeWellRatesWithBhpIterations()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::computeWellRatesWithBhpIterations ( const Simulator &  simulator,
const Scalar &  bhp,
const GroupStateHelperType &  groupStateHelper,
std::vector< Scalar > &  well_flux 
) const
overrideprotectedvirtual

Implements Opm::WellInterface< TypeTag >.

References Opm::MultisegmentWell< TypeTag >::calculateExplicitQuantities(), Opm::MultisegmentWell< TypeTag >::debug_cost_counter_, Opm::MultisegmentWellPrimaryVariables< FluidSystem, Indices >::getQs(), Opm::MultisegmentWell< TypeTag >::iterateWellEqWithControl(), Opm::MultisegmentWellEval< FluidSystem, Indices >::primary_variables_, Opm::GroupStateHelper< Scalar, IndexTraits >::pushWellState(), Opm::WellInterfaceGeneric< Scalar, IndexTraits >::resetDampening(), Opm::MultisegmentWellGeneric< Scalar, IndexTraits >::scaleSegmentPressuresWithBhp(), Opm::MultisegmentWellGeneric< Scalar, IndexTraits >::scaleSegmentRatesWithWellRates(), Opm::WellState< Scalar, IndexTraits >::well(), Opm::WellInterfaceGeneric< Scalar, IndexTraits >::well_ecl_, and Opm::GroupStateHelper< Scalar, IndexTraits >::wellState().

◆ connectionDensity()

template<typename TypeTag >
MultisegmentWell< TypeTag >::Scalar Opm::MultisegmentWell< TypeTag >::connectionDensity ( const int  globalConnIdx,
const int  openConnIdx 
) const
overridevirtual

Implements Opm::WellInterfaceGeneric< FluidSystem::Scalar, FluidSystem::IndexTraitsType >.

◆ connectionRates()

template<typename TypeTag >
const std::vector< RateVector > & Opm::WellInterface< TypeTag >::connectionRates ( ) const
inlineinherited

References Opm::WellInterface< TypeTag >::connectionRates_.

◆ createFluidState()

template<typename TypeTag >
template<typename ValueType >
MultisegmentWell< TypeTag >::SegmentFluidState< ValueType > Opm::MultisegmentWell< TypeTag >::createFluidState ( const std::vector< ValueType > &  fluid_composition,
const ValueType &  pressure,
const ValueType &  temperature,
const ValueType &  saltConcentration,
DeferredLogger &  deferred_logger 
) const
protected

References Opm::DeferredLogger::debug(), and Opm::to_string().

◆ createSegmentFluidState()

template<typename TypeTag >
MultisegmentWell< TypeTag >::template SegmentFluidState< typename MultisegmentWell< TypeTag >::EvalWell > Opm::MultisegmentWell< TypeTag >::createSegmentFluidState ( int  seg,
const FSInfo &  info,
DeferredLogger &  deferred_logger 
) const
protected

◆ currentStep()

int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::currentStep ( ) const
inlineinherited

◆ estimateOperableBhp()

template<typename TypeTag >
std::optional< typename WellInterface< TypeTag >::Scalar > Opm::WellInterface< TypeTag >::estimateOperableBhp ( const Simulator &  ebos_simulator,
const double  dt,
const GroupStateHelperType &  groupStateHelper,
const SummaryState &  summary_state,
WellStateType &  well_state 
)
protectedinherited

References Opm::WellBhpThpCalculator< Scalar, IndexTraits >::calculateMinimumBhpFromThp(), Opm::WellBhpThpCalculator< Scalar, IndexTraits >::estimateStableBhp(), Opm::WellBhpThpCalculator< Scalar, IndexTraits >::mostStrictBhpFromBhpLimits(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ extendEval()

EvalWell Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::extendEval ( const Eval &  in) const
protectedinherited

◆ frictionalPressureLossConsidered()

bool Opm::MultisegmentWellGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::frictionalPressureLossConsidered ( ) const
protectedinherited

◆ getAllowCrossFlow()

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::getAllowCrossFlow ( ) const
protectedinherited

◆ getALQ()

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::getALQ ( const WellStateType &  well_state) const
inherited

◆ getCompletions()

const std::map< int, std::vector< int > > & Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::getCompletions ( ) const
inlineinherited

◆ getControlTolerance()

Scalar Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::getControlTolerance ( const WellState< Scalar, IndexTraits > &  well_state,
const Scalar  tolerance_wells,
const Scalar  tolerance_pressure_ms_wells,
DeferredLogger &  deferred_logger 
) const
protectedinherited

◆ getDynamicThpLimit()

std::optional< FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::getDynamicThpLimit ( ) const
inherited

◆ getFiniteWellResiduals()

std::pair< bool, std::vector< Scalar > > Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::getFiniteWellResiduals ( const std::vector< Scalar > &  B_avg,
DeferredLogger &  deferred_logger 
) const
protectedinherited

◆ getFirstPerfCellConditions()

template<typename TypeTag >
WellInterface< TypeTag >::FSInfo Opm::WellInterface< TypeTag >::getFirstPerfCellConditions ( const Simulator &  simulator) const
protectedinherited

Temperature and salt concentration of the first perforated cell, broadcast so that all processes of a distributed well get the values.

References Opm::FirstPerfCellConditions< Scalar >::temperature.

◆ getGroupInjectionTargetRate()

std::optional< Scalar > Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::getGroupInjectionTargetRate ( const Group &  group,
const GroupStateHelperType &  groupStateHelper,
const InjectorType &  injectorType,
Scalar  efficiencyFactor 
) const
protectedinherited

◆ getGroupProductionTargetRate()

Scalar Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::getGroupProductionTargetRate ( const Group &  group,
const GroupStateHelperType &  groupStateHelper,
Scalar  efficiencyFactor 
) const
protectedinherited

◆ getInjMult()

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::getInjMult ( const int  local_perf_index,
const FluidSystem::Scalar  bhp,
const FluidSystem::Scalar  perf_pres,
DeferredLogger &  dlogger 
) const
inherited

◆ getMobility() [1/2]

template<typename TypeTag >
template<class Value , class Callback >
void Opm::WellInterface< TypeTag >::getMobility ( const Simulator &  simulator,
const int  local_perf_index,
std::vector< Value > &  mob,
Callback &  extendEval,
DeferredLogger &  deferred_logger 
) const
protectedinherited

Referenced by Opm::MultisegmentWell< TypeTag >::getMobility(), and Opm::StandardWell< TypeTag >::getMobility().

◆ getMobility() [2/2]

template<typename TypeTag >
template<class Value >
void Opm::MultisegmentWell< TypeTag >::getMobility ( const Simulator &  simulator,
const int  local_perf_index,
std::vector< Value > &  mob,
DeferredLogger &  deferred_logger 
) const
protected

References Opm::WellInterface< TypeTag >::getMobility(), and Opm::ExceptionType::NONE.

◆ getPerfCellPressure()

template<typename TypeTag >
WellInterface< TypeTag >::Eval Opm::WellInterface< TypeTag >::getPerfCellPressure ( const FluidState &  fs) const
protectedinherited

◆ getPrimaryVars()

template<typename TypeTag >
std::vector< typename MultisegmentWell< TypeTag >::Scalar > Opm::MultisegmentWell< TypeTag >::getPrimaryVars
overridevirtual

Reimplemented from Opm::WellInterfaceGeneric< FluidSystem::Scalar, FluidSystem::IndexTraitsType >.

◆ getRefDensity()

template<typename TypeTag >
MultisegmentWell< TypeTag >::Scalar Opm::MultisegmentWell< TypeTag >::getRefDensity
overrideprotectedvirtual

Implements Opm::WellInterface< TypeTag >.

◆ getResidualMeasureValue()

Scalar Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::getResidualMeasureValue ( const WellState< Scalar, IndexTraits > &  well_state,
const std::vector< Scalar > &  residuals,
const Scalar  tolerance_wells,
const Scalar  tolerance_pressure_ms_wells,
DeferredLogger &  deferred_logger 
) const
protectedinherited

◆ getScaledWellFractions()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::getScaledWellFractions ( std::vector< Scalar > &  scaled_fractions,
DeferredLogger &  deferred_logger 
) const
overridevirtual

Get scaled well fractions from primary variables Implemented by derived classes that have access to primary_variables_

Implements Opm::WellInterface< TypeTag >.

◆ getSegmentDp()

FluidSystem::Scalar Opm::MultisegmentWellGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::getSegmentDp ( const int  seg,
const FluidSystem::Scalar  density,
const std::vector< FluidSystem::Scalar > &  seg_dp 
) const
protectedinherited

◆ getSegmentSurfaceVolume()

template<typename TypeTag >
MultisegmentWell< TypeTag >::EvalWell Opm::MultisegmentWell< TypeTag >::getSegmentSurfaceVolume ( const int  seg_idx,
const EvalWell &  volume_ratio 
) const
protected

◆ getTHPConstraint()

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::getTHPConstraint ( const SummaryState &  summaryState) const
inherited

◆ getTransMult() [1/2]

template<typename TypeTag >
template<class Value , class Callback >
void Opm::WellInterface< TypeTag >::getTransMult ( Value &  trans_mult,
const Simulator &  simulator,
const int  cell_idx,
Callback &  extendEval 
) const
protectedinherited

Referenced by Opm::MultisegmentWell< TypeTag >::getTransMult(), and Opm::StandardWell< TypeTag >::getTransMult().

◆ getTransMult() [2/2]

template<typename TypeTag >
template<class Value >
void Opm::MultisegmentWell< TypeTag >::getTransMult ( Value &  trans_mult,
const Simulator &  simulator,
const int  cell_indx 
) const
protected

References Opm::WellInterface< TypeTag >::getTransMult().

◆ getTw()

template<typename TypeTag >
template<class Value >
void Opm::WellInterface< TypeTag >::getTw ( std::vector< Value > &  wi,
const int  perf,
const IntensiveQuantities &  intQuants,
const Value &  trans_mult,
const SingleWellStateType &  ws 
) const
protectedinherited

References Opm::SingleWellState< Scalar, IndexTraits >::perf_data.

◆ getWellConvergence() [1/2]

template<typename TypeTag >
ConvergenceReport Opm::MultisegmentWell< TypeTag >::getWellConvergence ( const GroupStateHelperType &  groupStateHelper,
const std::vector< Scalar > &  B_avg,
const bool  relax_tolerance 
) const
overridevirtual

check whether the well equations get converged for this well

Implements Opm::WellInterface< TypeTag >.

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), and Opm::GroupStateHelper< Scalar, IndexTraits >::wellState().

◆ getWellConvergence() [2/2]

ConvergenceReport Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::getWellConvergence ( const WellState< Scalar, IndexTraits > &  well_state,
const std::vector< Scalar > &  B_avg,
DeferredLogger &  deferred_logger,
const Scalar  max_residual_allowed,
const Scalar  tolerance_wells,
const Scalar  relaxed_inner_tolerance_flow_ms_well,
const Scalar  tolerance_pressure_ms_wells,
const Scalar  relaxed_inner_tolerance_pressure_ms_well,
const bool  relax_tolerance,
const bool  well_is_stopped 
) const
protectedinherited

check whether the well equations get converged for this well

◆ gliftBeginTimeStepWellTestUpdateALQ()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::gliftBeginTimeStepWellTestUpdateALQ ( const Simulator &  simulator,
WellStateType &  well_state,
const GroupState< Scalar > &  group_state,
GLiftEclWells &  ecl_well_map,
DeferredLogger &  deferred_logger 
)
inherited

References Opm::DeferredLogger::info(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ gravity()

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::gravity ( ) const
inlineinherited

◆ guideRate()

const GuideRate * Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::guideRate ( ) const
inlineinherited

◆ indexOfWell()

int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::indexOfWell ( ) const
inherited

Index of well in the wells struct and wellState.

◆ init()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::init ( const std::vector< Scalar > &  depth_arg,
const Scalar  gravity_arg,
const std::vector< Scalar > &  B_avg,
const bool  changed_to_open_this_step 
)
overridevirtual

Reimplemented from Opm::WellInterface< TypeTag >.

◆ initCompletions()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::initCompletions ( )
inherited

◆ initializeGliftWellTest_()

template<typename TypeTag >
template<class GasLiftSingleWell >
std::unique_ptr< GasLiftSingleWell > Opm::WellInterface< TypeTag >::initializeGliftWellTest_ ( const Simulator &  simulator,
WellStateType &  well_state,
const GroupState< Scalar > &  group_state,
GLiftEclWells &  ecl_well_map,
DeferredLogger &  deferred_logger 
)
protectedinherited

◆ initializeProducerWellState()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::initializeProducerWellState ( const Simulator &  simulator,
WellStateType &  well_state,
DeferredLogger &  deferred_logger 
) const
inherited

Modify the well_state's rates if there is only one nonzero rate. If so, that rate is kept as is, but the others are set proportionally to the rates at bhp limit or bhp 1 bar.

References Opm::WellState< Scalar, IndexTraits >::well().

◆ initialWellRateFractions()

template<typename TypeTag >
std::vector< typename WellInterface< TypeTag >::Scalar > Opm::WellInterface< TypeTag >::initialWellRateFractions ( const Simulator &  ebosSimulator,
const WellStateType &  well_state 
) const
protectedinherited

References Opm::WellState< Scalar, IndexTraits >::well().

◆ initInjMult()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::initInjMult ( const std::vector< FluidSystem::Scalar > &  max_inj_mult)
inherited

◆ initMatrixAndVectors()

void Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::initMatrixAndVectors ( const ParallelWellInfo< Scalar > &  parallel_well_info)
protectedinherited

◆ isInjector()

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::isInjector ( ) const
inherited

True if the well is an injector.

◆ isOperableAndSolvable()

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::isOperableAndSolvable ( ) const
inherited

◆ isPressureControlled()

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::isPressureControlled ( const WellStateType &  well_state) const
inherited

◆ isProducer()

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::isProducer ( ) const
inherited

True if the well is a producer.

◆ isVFPActive()

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::isVFPActive ( DeferredLogger &  deferred_logger) const
inherited

◆ iterateWellEquations()

template<typename TypeTag >
bool Opm::WellInterface< TypeTag >::iterateWellEquations ( const Simulator &  simulator,
const double  dt,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
protectedinherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ iterateWellEqWithControl() [1/2]

template<typename TypeTag >
bool Opm::MultisegmentWell< TypeTag >::iterateWellEqWithControl ( const Simulator &  simulator,
const double  dt,
const Well::InjectionControls &  inj_controls,
const Well::ProductionControls &  prod_controls,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
overrideprotected

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger().

Referenced by Opm::MultisegmentWell< TypeTag >::computeWellRatesWithBhpIterations().

◆ iterateWellEqWithControl() [2/2]

template<typename TypeTag >
virtual bool Opm::WellInterface< TypeTag >::iterateWellEqWithControl ( const Simulator &  simulator,
const double  dt,
const WellInjectionControls &  inj_controls,
const WellProductionControls &  prod_controls,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
protectedpure virtualinherited

◆ iterateWellEqWithSwitching() [1/2]

template<typename TypeTag >
bool Opm::MultisegmentWell< TypeTag >::iterateWellEqWithSwitching ( const Simulator &  simulator,
const double  dt,
const Well::InjectionControls &  inj_controls,
const Well::ProductionControls &  prod_controls,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state,
const bool  fixed_control,
const bool  fixed_status,
const bool  solving_with_zero_rate 
)
overrideprotected

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), Opm::GroupStateHelper< Scalar, IndexTraits >::summaryState(), and Opm::WellState< Scalar, IndexTraits >::well().

Referenced by Opm::MultisegmentWell< TypeTag >::computeWellPotentialsImplicit().

◆ iterateWellEqWithSwitching() [2/2]

template<typename TypeTag >
virtual bool Opm::WellInterface< TypeTag >::iterateWellEqWithSwitching ( const Simulator &  simulator,
const double  dt,
const WellInjectionControls &  inj_controls,
const WellProductionControls &  prod_controls,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state,
const bool  fixed_control,
const bool  fixed_status,
const bool  solving_with_zero_rate 
)
pure virtualinherited

◆ linSys()

const Equations & Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::linSys ( ) const
inlineinherited

Returns a const reference to equation system.

◆ maxPerfPress()

template<typename TypeTag >
MultisegmentWell< TypeTag >::Scalar Opm::MultisegmentWell< TypeTag >::maxPerfPress ( const Simulator &  simulator) const
overrideprotectedvirtual

Implements Opm::WellInterface< TypeTag >.

◆ name()

const std::string & Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::name ( ) const
inherited

Well name.

◆ numberOfSegments()

int Opm::MultisegmentWellGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::numberOfSegments ( ) const
inherited

number of segments for this well

◆ numConservationQuantities()

int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::numConservationQuantities ( ) const
inlineinherited

◆ numLocalPerfs()

int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::numLocalPerfs ( ) const
inlineinherited

◆ numPhases()

int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::numPhases ( ) const
inlineinherited

◆ onlyKeepBHPandTHPcontrols()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::onlyKeepBHPandTHPcontrols ( const SummaryState &  summary_state,
WellStateType &  well_state,
Well::InjectionControls &  inj_controls,
Well::ProductionControls &  prod_controls 
) const
protectedinherited

◆ openCrossFlowAvoidSingularity()

template<typename TypeTag >
bool Opm::MultisegmentWell< TypeTag >::openCrossFlowAvoidSingularity ( const Simulator &  simulator) const
protected

◆ openWell()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::openWell ( )
inlineinherited

◆ parallelWellInfo()

const ParallelWellInfo< FluidSystem::Scalar > & Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::parallelWellInfo ( ) const
inlineinherited

◆ perfDepth() [1/2]

std::vector< FluidSystem::Scalar > & Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::perfDepth ( )
inlineinherited

◆ perfDepth() [2/2]

const std::vector< FluidSystem::Scalar > & Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::perfDepth ( ) const
inlineinherited

◆ perforationData()

const std::vector< PerforationData< FluidSystem::Scalar > > & Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::perforationData ( ) const
inherited

Get the perforations of the well.

◆ phaseUsage()

const PhaseUsageInfo< FluidSystem::IndexTraitsType > & Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::phaseUsage ( ) const
inherited

◆ polymerInjTable_()

int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::polymerInjTable_ ( ) const
protectedinherited

◆ polymerTable_()

int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::polymerTable_ ( ) const
protectedinherited

◆ polymerWaterTable_()

int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::polymerWaterTable_ ( ) const
protectedinherited

◆ potentialCalculationScope()

PotentialCalculationScope Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::potentialCalculationScope ( ) const
inlineprotectedinherited

◆ prepareWellBeforeAssembling()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::prepareWellBeforeAssembling ( const Simulator &  simulator,
const double  dt,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
inherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), Opm::WellState< Scalar, IndexTraits >::isOpen(), Opm::WellState< Scalar, IndexTraits >::numPhases(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ primaryVariables()

const PrimaryVariables & Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::primaryVariables ( ) const
inlineinherited

Read access to the primary variables, needed by the adjoint module to build dJ/dx_w (segment-0 BHP / surface-rate derivatives), mirroring the StandardWellEval hook.

◆ productionControlsWithWeldraw()

Well::ProductionControls Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::productionControlsWithWeldraw ( const SummaryState &  summary_state,
const SingleWellState< FluidSystem::Scalar , FluidSystem::IndexTraitsType > &  ws 
) const
inherited

The well's production controls with the WELDRAW-derived rate limit (stored in ws.weldraw_max_rate) applied. Constraint checking and target computations should obtain controls through this method so the drawdown limit cannot be missed; potential calculations use the unadjusted Well::productionControls() (WELDRAW item 4 is NO).

◆ pvtRegionIdx()

int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::pvtRegionIdx ( ) const
inlineinherited

◆ rateConverter()

const RateConverterType & Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::rateConverter ( ) const
inlineinherited

◆ recoverWellSolutionAndUpdateWellState()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::recoverWellSolutionAndUpdateWellState ( const Simulator &  simulator,
const BVector &  x,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
overridevirtual

using the solution x to recover the solution xw for wells and applying xw to update Well State

Implements Opm::WellInterface< TypeTag >.

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger().

◆ refDepth()

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::refDepth ( ) const
inlineinherited

◆ repeatedStagnation()

bool Opm::MultisegmentWellGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::repeatedStagnation ( const std::vector< FluidSystem::Scalar > &  measure_history,
bool &  regularize,
DeferredLogger &  deferred_logger 
) const
protectedinherited

◆ reportWellSwitching()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::reportWellSwitching ( const SingleWellState< FluidSystem::Scalar , FluidSystem::IndexTraitsType > &  ws,
DeferredLogger &  deferred_logger 
) const
inherited

◆ resetDampening()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::resetDampening ( )
inlineprotectedinherited

◆ resetSolveStats()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::resetSolveStats ( ) const
inlineinherited

◆ resetWellOperability()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::resetWellOperability ( )
inherited

◆ restrictEval()

Eval Opm::WellInterfaceIndices< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::restrictEval ( const EvalWell &  in) const
inlineinherited

◆ rsRvInj()

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::rsRvInj ( ) const
inherited

◆ scaleSegmentPressuresWithBhp()

void Opm::MultisegmentWellGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::scaleSegmentPressuresWithBhp ( WellState< FluidSystem::Scalar , FluidSystem::IndexTraitsType > &  well_state) const
protectedinherited

◆ scaleSegmentRatesAndPressure()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::scaleSegmentRatesAndPressure ( WellStateType &  well_state) const
overridevirtual

updating the segment pressure and rates based the current bhp and well rates

Reimplemented from Opm::WellInterface< TypeTag >.

◆ scaleSegmentRatesWithWellRates()

void Opm::MultisegmentWellGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::scaleSegmentRatesWithWellRates ( const std::vector< std::vector< int > > &  segment_inlets,
const std::vector< std::vector< int > > &  segment_perforations,
WellState< FluidSystem::Scalar , FluidSystem::IndexTraitsType > &  well_state 
) const
protectedinherited

◆ scalingFactor()

Scalar Opm::WellInterfaceIndices< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::scalingFactor ( const int  phaseIdx) const
inherited

◆ segmentNumberToIndex()

int Opm::MultisegmentWellGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::segmentNumberToIndex ( const int  segment_number) const
inherited

◆ segmentPvt()

template<typename TypeTag >
MultisegmentWell< TypeTag >::SegmentPvt Opm::MultisegmentWell< TypeTag >::segmentPvt ( const SegmentFluidState< EvalWell > &  fluid_state) const
protected

◆ segmentSet()

const WellSegments & Opm::MultisegmentWellGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::segmentSet ( ) const
inherited

◆ setDynamicThpLimit() [1/2]

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::setDynamicThpLimit ( const FluidSystem::Scalar  thp_limit)
inherited

◆ setDynamicThpLimit() [2/2]

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::setDynamicThpLimit ( const std::optional< FluidSystem::Scalar >  thp_limit)
inherited

◆ setGuideRate()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::setGuideRate ( const GuideRate *  guide_rate_arg)
inherited

◆ setPrevSurfaceRates()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::setPrevSurfaceRates ( WellStateType &  well_state,
const WellStateType &  prev_well_state 
) const
inherited

◆ setPrimaryVars() [1/2]

virtual int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::setPrimaryVars ( typename std::vector< FluidSystem::Scalar >::const_iterator  )
inlinevirtualinherited

◆ setPrimaryVars() [2/2]

template<typename TypeTag >
int Opm::MultisegmentWell< TypeTag >::setPrimaryVars ( typename std::vector< Scalar >::const_iterator  it)
override

◆ setRepRadiusPerfLength()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::setRepRadiusPerfLength ( )
inherited

◆ setVFPProperties()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::setVFPProperties ( const VFPProperties< FluidSystem::Scalar , FluidSystem::IndexTraitsType > *  vfp_properties_arg)
inherited

◆ setWellEfficiencyFactor()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::setWellEfficiencyFactor ( const FluidSystem::Scalar  efficiency_factor)
inherited

◆ setWsolvent()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::setWsolvent ( const FluidSystem::Scalar  wsolvent)
inherited

◆ solveAssembleTimer()

SolvePartTimer Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::solveAssembleTimer ( ) const
inlineprotectedinherited

◆ solveEqAndUpdateWellState()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::solveEqAndUpdateWellState ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
overridevirtual

Implements Opm::WellInterface< TypeTag >.

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), and Opm::DeferredLogger::problem().

◆ solveLinearSolveTimer()

SolvePartTimer Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::solveLinearSolveTimer ( ) const
inlineprotectedinherited

◆ solveScope()

WellSolveScope Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::solveScope ( const int &  iterations) const
inlineprotectedinherited

◆ solveStats()

const WellSolveStats & Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::solveStats ( ) const
inlineinherited

◆ solveWellEquation()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::solveWellEquation ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
inherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), Opm::to_string(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ solveWellForTesting()

template<typename TypeTag >
bool Opm::WellInterface< TypeTag >::solveWellForTesting ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
protectedinherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), Opm::to_string(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ solveWellWithBhp()

template<typename TypeTag >
bool Opm::WellInterface< TypeTag >::solveWellWithBhp ( const Simulator &  simulator,
const double  dt,
const Scalar  bhp,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
protectedinherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::pushGroupState(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ solveWellWithOperabilityCheck()

template<typename TypeTag >
bool Opm::WellInterface< TypeTag >::solveWellWithOperabilityCheck ( const Simulator &  simulator,
const double  dt,
const Well::InjectionControls &  inj_controls,
const Well::ProductionControls &  prod_controls,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
protectedinherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), Opm::WellBhpThpCalculator< Scalar, IndexTraits >::estimateStableBhp(), Opm::WellBhpThpCalculator< Scalar, IndexTraits >::isStableSolution(), and Opm::WellState< Scalar, IndexTraits >::well().

Referenced by Opm::StandardWell< TypeTag >::computeWellPotentialsImplicit(), and Opm::MultisegmentWell< TypeTag >::computeWellPotentialsImplicit().

◆ solveWellWithZeroRate()

template<typename TypeTag >
bool Opm::WellInterface< TypeTag >::solveWellWithZeroRate ( const Simulator &  simulator,
const double  dt,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
protectedinherited

◆ stoppedOrZeroRateTarget()

template<typename TypeTag >
bool Opm::WellInterface< TypeTag >::stoppedOrZeroRateTarget ( const GroupStateHelperType &  groupStateHelper) const
inherited

◆ stopWell()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::stopWell ( )
inlineinherited

◆ surfaceToReservoirRate()

template<typename TypeTag >
template<typename FluidStateT >
MultisegmentWell< TypeTag >::EvalWell Opm::MultisegmentWell< TypeTag >::surfaceToReservoirRate ( unsigned  phaseIdx,
const FluidStateT &  fs,
const std::vector< EvalWell > &  surface_rates,
int  seg,
std::string_view  context,
DeferredLogger &  deferred_logger 
) const
protected

References Opm::DeferredLogger::debug().

◆ thpLimitViolatedButNotSwitched()

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::thpLimitViolatedButNotSwitched ( ) const
inherited

◆ totalReservoirVoidageRate()

Scalar Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::totalReservoirVoidageRate ( const std::vector< Scalar > &  surface_rates) const
overridevirtualinherited

The total reservoir voidage rate for the given surface phase rates (or potentials), using the region average PVT properties that also produce the voidage rates in the well state.

Implements Opm::WellInterfaceGeneric< FluidSystem::Scalar, FluidSystem::IndexTraitsType >.

◆ underPredictionMode()

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::underPredictionMode ( ) const
inherited

Returns true if the well is currently in prediction mode (i.e. not history mode).

◆ update_relaxation_factor()

bool Opm::MultisegmentWellGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::update_relaxation_factor ( const std::vector< FluidSystem::Scalar > &  measure_history,
FluidSystem::Scalar &  relaxation_factor,
bool &  regularize,
DeferredLogger &  deferred_logger 
) const
protectedinherited

Detect oscillation or stagnation based on the residual measure history.

◆ updateConnectionDFactor()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::updateConnectionDFactor ( const Simulator &  simulator,
SingleWellStateType &  ws 
) const
inherited

References Opm::SingleWellState< Scalar, IndexTraits >::perf_data.

◆ updateConnectionTransmissibilityFactor()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::updateConnectionTransmissibilityFactor ( const Simulator &  simulator,
SingleWellStateType &  ws 
) const
inherited

References Opm::SingleWellState< Scalar, IndexTraits >::perf_data.

◆ updateFilterCakeMultipliers()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::updateFilterCakeMultipliers ( const std::vector< FluidSystem::Scalar > &  inj_fc_multiplier)
inlineinherited

Update filter cake multipliers.

◆ updateGroupTargetFallbackFlag() [1/2]

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::updateGroupTargetFallbackFlag ( WellState< FluidSystem::Scalar , FluidSystem::IndexTraitsType > &  well_state,
const std::vector< FluidSystem::Scalar > &  scaled_well_fractions,
DeferredLogger &  deferred_logger 
) const
protectedinherited

◆ updateGroupTargetFallbackFlag() [2/2]

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::updateGroupTargetFallbackFlag ( WellStateType &  well_state,
DeferredLogger &  deferred_logger 
) const
inherited

◆ updateInjMult()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::updateInjMult ( std::vector< FluidSystem::Scalar > &  inj_multipliers,
DeferredLogger &  deferred_logger 
) const
inherited

◆ updateIPR()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::updateIPR ( const Simulator &  ebos_simulator,
DeferredLogger &  deferred_logger 
) const
overrideprotectedvirtual

Implements Opm::WellInterface< TypeTag >.

References Opm::DeferredLogger::debug().

◆ updateIPRImplicit()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::updateIPRImplicit ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
overridevirtual

Implements Opm::WellInterface< TypeTag >.

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ updatePerforatedCell()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::updatePerforatedCell ( std::vector< bool > &  is_cell_perforated)
inherited

◆ updatePrimaryVariables()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::updatePrimaryVariables ( const GroupStateHelperType &  groupStateHelper)
overridevirtual

Implements Opm::WellInterface< TypeTag >.

References Opm::GroupStateHelper< Scalar, IndexTraits >::wellState().

◆ updateProductivityIndex()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::updateProductivityIndex ( const Simulator &  simulator,
const WellProdIndexCalculator< Scalar > &  wellPICalc,
WellStateType &  well_state,
DeferredLogger &  deferred_logger 
) const
overridevirtual

Implements Opm::WellInterface< TypeTag >.

References Opm::WellProdIndexCalculator< Scalar >::connectionProdIndStandard(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ updateSegmentFluidState()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::updateSegmentFluidState ( const FSInfo &  info,
DeferredLogger &  deferred_logger 
)
protected

◆ updateWaterThroughput()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::updateWaterThroughput ( const double  dt,
WellStateType &  well_state 
) const
overrideprotectedvirtual

Implements Opm::WellInterface< TypeTag >.

◆ updateWeldrawMaxRate()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::updateWeldrawMaxRate ( const Simulator &  simulator,
WellStateType &  well_state,
DeferredLogger &  deferred_logger 
) const
inherited

Convert the well's WELDRAW maximum drawdown into a maximum production rate for the target phase, Qmax = Dmax * sum_j (Tw_j * M_j), and store it in the well state. Should only be called during the first NUPCOL iterations of a timestep; afterwards the stored value is kept frozen (like the rate targets of wells under group control).

References Opm::DeferredLogger::warning(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ updateWellControl()

template<typename TypeTag >
bool Opm::WellInterface< TypeTag >::updateWellControl ( const Simulator &  simulator,
const IndividualOrGroup  iog,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
inherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), and Opm::WellState< Scalar, IndexTraits >::well().

Referenced by Opm::BlackoilWellModelNldd< TypeTag >::updateWellControls(), and Opm::BlackoilWellModel< TypeTag >::updateWellControls().

◆ updateWellControlAndStatusLocalIteration()

template<typename TypeTag >
bool Opm::WellInterface< TypeTag >::updateWellControlAndStatusLocalIteration ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper,
const Well::InjectionControls &  inj_controls,
const Well::ProductionControls &  prod_controls,
const Scalar  WQTotal,
WellStateType &  well_state,
const bool  fixed_control,
const bool  fixed_status,
const bool  solving_with_zero_rate 
)
inherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), OPM_DEFLOG_THROW, and Opm::WellState< Scalar, IndexTraits >::well().

◆ updateWellHeadCondition()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::updateWellHeadCondition ( const Simulator &  simulator,
const Scalar  first_perf_temperature,
const Scalar  first_perf_salt_concentration,
DeferredLogger &  deferred_logger 
)
protected

References Opm::to_string().

◆ updateWellOperability()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::updateWellOperability ( const Simulator &  simulator,
const WellStateType &  well_state,
const GroupStateHelperType &  groupStateHelper 
)
inherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ updateWellOperabilityFromWellEq()

template<typename TypeTag >
bool Opm::WellInterface< TypeTag >::updateWellOperabilityFromWellEq ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper 
)
inherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::pushWellState(), and Opm::GroupStateHelper< Scalar, IndexTraits >::wellState().

◆ updateWellState()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::updateWellState ( const Simulator &  simulator,
const BVectorWell &  dwells,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state,
const Scalar  relaxation_factor = 1.0 
)
protected

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ updateWellStateWithTarget()

template<typename TypeTag >
void Opm::MultisegmentWell< TypeTag >::updateWellStateWithTarget ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
) const
overridevirtual

updating the well state based the current control mode

Reimplemented from Opm::WellInterface< TypeTag >.

◆ updateWellStateWithTHPTargetProd()

template<typename TypeTag >
bool Opm::WellInterface< TypeTag >::updateWellStateWithTHPTargetProd ( const Simulator &  simulator,
WellStateType &  well_state,
const GroupStateHelperType &  groupStateHelper 
) const
inherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ updateWellTestState()

void Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::updateWellTestState ( const SingleWellState< FluidSystem::Scalar , FluidSystem::IndexTraitsType > &  ws,
const double &  simulationTime,
const bool &  writeMessageToOPMLog,
const bool  during_well_test,
const bool  zero_group_target,
WellTestState &  wellTestState,
const UnitSystem &  unit_system,
const std::time_t  start_time,
DeferredLogger &  deferred_logger,
std::string *  closure_reason = nullptr 
) const
inherited
Parameters
wsWell state
simulationTimeSimulation time
writeMessageToOPMLogTrue to write message to the OPM log
during_well_testtrue when called from WTEST re-open testing, which re-solves the well after every completion closure; false for the regular timestep update. See WellTest::updateWellTestStateEconomic().
zero_group_targetTrue if the group has no target
wellTestStateWell test state
unit_systemUnit system to use
start_timeStarting time
deferred_loggerDeferred logging helper
closure_reasonwhen non-null, receives the reason a limit closed the well instead of it being logged here. Used by the WTEST re-open testing, where no shut-in actually happens.

◆ useVfpExplicit()

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::useVfpExplicit ( ) const
inherited

◆ vfpProperties()

const VFPProperties< FluidSystem::Scalar , FluidSystem::IndexTraitsType > * Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::vfpProperties ( ) const
inlineinherited

◆ volumetricSurfaceRateForConnection()

template<typename TypeTag >
WellInterface< TypeTag >::Scalar Opm::WellInterface< TypeTag >::volumetricSurfaceRateForConnection ( int  cellIdx,
int  phaseIdx 
) const
inherited

References Opm::to_string().

◆ wellEcl() [1/2]

Well & Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wellEcl ( )
inherited

◆ wellEcl() [2/2]

const Well & Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wellEcl ( ) const
inherited

◆ wellEfficiencyFactor()

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wellEfficiencyFactor ( ) const
inlineinherited

◆ wellHasTHPConstraints()

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wellHasTHPConstraints ( const SummaryState &  summaryState) const
inherited

Returns true if the well has one or more THP limits/constraints.

◆ wellIndex() [1/2]

std::vector< FluidSystem::Scalar > & Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wellIndex ( )
inlineinherited

Mutable per-perforation well indices (connection transmissibility factors). Adjoint hook: the dJ/dperm well-coupling gradient perturbs the CTF here and re-linearizes. Not used in the forward path.

◆ wellIndex() [2/2]

const std::vector< FluidSystem::Scalar > & Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wellIndex ( ) const
inlineinherited

◆ wellIndexFracture()

const std::vector< WellIndexFracture > & Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wellIndexFracture ( ) const
inlineinherited

Fracture contributions per local perforation; empty unless addFracturePerforations() has been called.

◆ wellIsStopped()

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wellIsStopped ( ) const
inlineinherited

◆ wellStatus()

Well::Status Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wellStatus ( )
inlineinherited

◆ wellTesting()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::wellTesting ( const Simulator &  simulator,
const double  simulation_time,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state,
WellTestState &  welltest_state,
GLiftEclWells &  ecl_well_map,
std::map< std::string, double > &  open_times 
)
inherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), Opm::economicLimitDateString(), Opm::economicLimitMessageSeparator(), Opm::GroupStateHelper< Scalar, IndexTraits >::groupState(), Opm::WellState< Scalar, IndexTraits >::numPhases(), Opm::GroupStateHelper< Scalar, IndexTraits >::pushWellState(), and Opm::WellState< Scalar, IndexTraits >::well().

◆ wellUnderGroupControl()

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wellUnderGroupControl ( const SingleWellState< FluidSystem::Scalar , FluidSystem::IndexTraitsType > &  ws) const
protectedinherited

◆ wellUnderZeroGroupRateTarget()

template<typename TypeTag >
bool Opm::WellInterface< TypeTag >::wellUnderZeroGroupRateTarget ( const GroupStateHelperType &  groupStateHelper,
const std::optional< bool >  group_control = std::nullopt 
) const
inherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::wellState().

◆ wellUnderZeroRateTarget()

template<typename TypeTag >
bool Opm::WellInterface< TypeTag >::wellUnderZeroRateTarget ( const GroupStateHelperType &  groupStateHelper) const
inherited

References Opm::GroupStateHelper< Scalar, IndexTraits >::summaryState(), and Opm::GroupStateHelper< Scalar, IndexTraits >::wellState().

◆ wellUnderZeroRateTargetIndividual()

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wellUnderZeroRateTargetIndividual ( const SummaryState &  summary_state,
const WellState< FluidSystem::Scalar , FluidSystem::IndexTraitsType > &  well_state 
) const
protectedinherited

◆ wfoam()

template<typename TypeTag >
WellInterface< TypeTag >::Scalar Opm::WellInterface< TypeTag >::wfoam
protectedinherited

◆ wfoam_()

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wfoam_ ( ) const
protectedinherited

◆ wmicrobes()

template<typename TypeTag >
WellInterface< TypeTag >::Scalar Opm::WellInterface< TypeTag >::wmicrobes
protectedinherited

◆ wmicrobes_()

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wmicrobes_ ( ) const
protectedinherited

◆ woxygen()

template<typename TypeTag >
WellInterface< TypeTag >::Scalar Opm::WellInterface< TypeTag >::woxygen
protectedinherited

◆ woxygen_()

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::woxygen_ ( ) const
protectedinherited

◆ wpolymer()

template<typename TypeTag >
WellInterface< TypeTag >::Scalar Opm::WellInterface< TypeTag >::wpolymer
protectedinherited

◆ wpolymer_()

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wpolymer_ ( ) const
protectedinherited

◆ wsalt()

template<typename TypeTag >
WellInterface< TypeTag >::Scalar Opm::WellInterface< TypeTag >::wsalt
protectedinherited

◆ wsalt_()

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wsalt_ ( ) const
protectedinherited

◆ wsolvent()

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wsolvent ( ) const
inherited

◆ wurea()

template<typename TypeTag >
WellInterface< TypeTag >::Scalar Opm::WellInterface< TypeTag >::wurea
protectedinherited

◆ wurea_()

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wurea_ ( ) const
protectedinherited

◆ zeroGroupRateTarget()

bool Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::zeroGroupRateTarget ( const GroupStateHelperType &  groupStateHelper) const
protectedinherited

Member Data Documentation

◆ B_avg_

template<typename TypeTag >
std::vector<Scalar> Opm::WellInterface< TypeTag >::B_avg_
protectedinherited

◆ baseif_

const WellInterfaceIndices<GetPropType< TypeTag, Properties::FluidSystem > ,GetPropType< TypeTag, Properties::Indices > >& Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::baseif_
protectedinherited

◆ bore_diameters_

std::vector<FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::bore_diameters_
protectedinherited

◆ cell_perforation_depth_diffs_

std::vector<Scalar> Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::cell_perforation_depth_diffs_
protectedinherited

◆ cell_perforation_pressure_diffs_

std::vector<Scalar> Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::cell_perforation_pressure_diffs_
protectedinherited

◆ changed_to_open_this_step_

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::changed_to_open_this_step_
protectedinherited

◆ changed_to_stopped_this_step_

template<typename TypeTag >
bool Opm::WellInterface< TypeTag >::changed_to_stopped_this_step_ = false
protectedinherited

◆ completions_

std::map<int, std::vector<int> > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::completions_
protectedinherited

◆ compositionSwitchEnabled

template<typename TypeTag >
constexpr bool Opm::MultisegmentWell< TypeTag >::compositionSwitchEnabled
staticconstexpr
Initial value:
=
Indices::compositionSwitchIdx != std::numeric_limits<unsigned>::max()

◆ computing_well_potentials_

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::computing_well_potentials_
mutableprotectedinherited

◆ connectionRates_

template<typename TypeTag >
std::vector<RateVector> Opm::WellInterface< TypeTag >::connectionRates_
protectedinherited

Referenced by Opm::WellInterface< TypeTag >::connectionRates(), and Opm::WellInterface< TypeTag >::WellInterface().

◆ current_step_

const int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::current_step_
protectedinherited

◆ debug_cost_counter_

template<typename TypeTag >
int Opm::MultisegmentWell< TypeTag >::debug_cost_counter_ = 0
mutableprotected

Referenced by Opm::MultisegmentWell< TypeTag >::computeWellPotentialsImplicit(), and Opm::MultisegmentWell< TypeTag >::computeWellRatesWithBhpIterations().

◆ dynamic_thp_limit_

std::optional<FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::dynamic_thp_limit_
protectedinherited

◆ enable_energy

constexpr bool Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::enable_energy
staticconstexprprotectedinherited

◆ enable_temperature

template<typename TypeTag >
constexpr bool Opm::MultisegmentWell< TypeTag >::enable_temperature
staticconstexpr
Initial value:
=
Base::energyModuleType != EnergyModules::NoTemperature
Opm::WellInterface::energyModuleType
static constexpr EnergyModules energyModuleType
Definition: WellInterface.hpp:121

◆ energy_scaling_factor_

template<typename TypeTag >
constexpr Scalar Opm::MultisegmentWell< TypeTag >::energy_scaling_factor_
staticconstexpr
Initial value:
=
getPropValue<TypeTag, Properties::BlackOilEnergyScalingFactor>()

◆ energyModuleType

template<typename TypeTag >
constexpr EnergyModules Opm::WellInterface< TypeTag >::energyModuleType = getPropValue<TypeTag, Properties::EnergyModuleType>()
staticconstexprinherited

◆ Gas

constexpr int Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::Gas
staticconstexprinherited

◆ gravity_

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::gravity_
protectedinherited

◆ guide_rate_

const GuideRate* Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::guide_rate_
protectedinherited

◆ has_bioeffects

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_bioeffects = getPropValue<TypeTag, Properties::EnableBioeffects>()
staticconstexprinherited

◆ has_brine

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_brine
staticconstexpr

◆ has_disgas_in_water

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_disgas_in_water = getPropValue<TypeTag, Properties::EnableDisgasInWater>()
staticconstexprinherited

◆ has_energy

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_energy
staticconstexpr

◆ has_foam

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_foam = getPropValue<TypeTag, Properties::EnableFoam>()
staticconstexprinherited

◆ has_micp

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_micp = Indices::enableMICP
staticconstexprinherited

◆ has_polymer

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_polymer
staticconstexpr

◆ has_polymermw

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_polymermw = getPropValue<TypeTag, Properties::EnablePolymerMW>()
staticconstexprinherited

◆ has_saltPrecip

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_saltPrecip = getPropValue<TypeTag, Properties::EnableSaltPrecipitation>()
staticconstexprinherited

◆ has_solvent

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_solvent
staticconstexpr

◆ has_watVapor

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_watVapor = getPropValue<TypeTag, Properties::EnableVapwat>()
staticconstexprinherited

◆ has_zFraction

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_zFraction = getPropValue<TypeTag, Properties::EnableExtbo>()
staticconstexprinherited

Referenced by Opm::WellInterface< TypeTag >::WellInterface().

◆ in_well_solve_

bool Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::in_well_solve_
mutableprotectedinherited

◆ index_of_well_

int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::index_of_well_
protectedinherited

◆ inj_fc_multiplier_

std::vector<FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::inj_fc_multiplier_
protectedinherited

◆ inj_multiplier_

std::vector<FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::inj_multiplier_
mutableprotectedinherited

◆ inj_multiplier_damp_factor_

std::vector<FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::inj_multiplier_damp_factor_
mutableprotectedinherited

◆ inj_multiplier_previter_

std::vector<FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::inj_multiplier_previter_
mutableprotectedinherited

◆ INVALIDCOMPLETION

constexpr int Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::INVALIDCOMPLETION
staticconstexprprotectedinherited

◆ ipr_a_

std::vector<FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::ipr_a_
mutableprotectedinherited

◆ ipr_b_

std::vector<FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::ipr_b_
mutableprotectedinherited

◆ linSys_

Equations Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::linSys_
protectedinherited

The equation system.

◆ num_conservation_quantities_

const int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::num_conservation_quantities_
protectedinherited

◆ number_of_local_perforations_

int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::number_of_local_perforations_
protectedinherited

◆ number_of_phases_

int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::number_of_phases_
protectedinherited

◆ number_of_well_reopenings_

template<typename TypeTag >
int Opm::WellInterface< TypeTag >::number_of_well_reopenings_ {0}
protectedinherited

◆ numResDofs [1/2]

constexpr int Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::numResDofs
staticconstexprinherited

◆ numResDofs [2/2]

template<typename TypeTag >
constexpr int Opm::WellInterface< TypeTag >::numResDofs = Indices::numEq
staticconstexprinherited

◆ numWellDofs [1/2]

constexpr int Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::numWellDofs
staticconstexprinherited

◆ numWellDofs [2/2]

template<typename TypeTag >
constexpr int Opm::WellInterface< TypeTag >::numWellDofs = numResDofs + 1
staticconstexprinherited

Referenced by Opm::MultisegmentWell< TypeTag >::addBCDMatrix(), and Opm::StandardWell< TypeTag >::addBCDMatrix().

◆ numWellEq

constexpr int Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::numWellEq
staticconstexprprotectedinherited

◆ Oil

constexpr int Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::Oil
staticconstexprinherited

◆ operability_status_

OperabilityStatus Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::operability_status_
protectedinherited

◆ parallel_well_info_

const ParallelWellInfo<FluidSystem::Scalar >& Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::parallel_well_info_
protectedinherited

◆ param_

const ModelParameters& Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::param_
protectedinherited

◆ perf_data_

const std::vector<PerforationData<FluidSystem::Scalar > >* Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::perf_data_
protectedinherited

◆ perf_depth_

std::vector<FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::perf_depth_
protectedinherited

◆ perf_length_

std::vector<FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::perf_length_
protectedinherited

◆ perf_rep_radius_

std::vector<FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::perf_rep_radius_
protectedinherited

◆ phase_usage_

const PhaseUsageInfo<FluidSystem::IndexTraitsType >& Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::phase_usage_
protectedinherited

◆ prev_inj_multiplier_

std::vector<FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::prev_inj_multiplier_
protectedinherited

◆ primary_variables_

PrimaryVariables Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::primary_variables_
protectedinherited

The primary variables.

◆ pvtRegionIdx_

const int Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::pvtRegionIdx_
protectedinherited

◆ rateConverter_

const RateConverterType& Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::rateConverter_
protectedinherited

◆ ref_depth_

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::ref_depth_
protectedinherited

◆ regularize_

template<typename TypeTag >
bool Opm::MultisegmentWell< TypeTag >::regularize_
protected

◆ saturation_table_number_

std::vector<int> Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::saturation_table_number_
protectedinherited

◆ segment_fluid_initial_

template<typename TypeTag >
std::vector<std::vector<Scalar> > Opm::MultisegmentWell< TypeTag >::segment_fluid_initial_
protected

◆ segment_fluid_state_

template<typename TypeTag >
std::vector<SegmentFluidState<EvalWell> > Opm::MultisegmentWell< TypeTag >::segment_fluid_state_
protected

◆ segment_initial_energy_

template<typename TypeTag >
std::vector<Scalar> Opm::MultisegmentWell< TypeTag >::segment_initial_energy_
protected

◆ segment_pvt_

template<typename TypeTag >
std::vector<SegmentPvt> Opm::MultisegmentWell< TypeTag >::segment_pvt_
protected

◆ segments_

MSWSegments Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::segments_
protectedinherited

Segment properties.

◆ solve_stats_

std::shared_ptr<WellSolveStats> Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::solve_stats_
protectedinherited

◆ SPres

constexpr int Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::SPres
staticconstexprprotectedinherited

◆ Temperature

constexpr int Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::Temperature
staticconstexprprotectedinherited

◆ thp_update_iterations

template<typename TypeTag >
bool Opm::WellInterface< TypeTag >::thp_update_iterations = false
protectedinherited

◆ vfp_properties_

const VFPProperties<FluidSystem::Scalar , FluidSystem::IndexTraitsType >* Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::vfp_properties_
protectedinherited

◆ Water

constexpr int Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::Water
staticconstexprinherited

◆ well_cells_

std::vector<int> Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::well_cells_
protectedinherited

◆ well_control_log_

std::vector<std::string> Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::well_control_log_
protectedinherited

◆ well_ecl_

Well Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::well_ecl_
protectedinherited

◆ well_efficiency_factor_

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::well_efficiency_factor_
protectedinherited

◆ well_index_

std::vector<FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::well_index_
protectedinherited

◆ well_index_fracture_

std::vector<WellIndexFracture> Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::well_index_fracture_
protectedinherited

◆ wellhead_fluid_state_

template<typename TypeTag >
SegmentFluidState<EvalWell> Opm::MultisegmentWell< TypeTag >::wellhead_fluid_state_
protected

◆ wellStatus_

Well::Status Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wellStatus_
protectedinherited

◆ WQTotal

constexpr int Opm::MultisegmentWellEval< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::WQTotal
staticconstexprprotectedinherited

◆ wsolvent_

FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::wsolvent_
protectedinherited
The documentation for this class was generated from the following files: