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

#include <WellInterface.hpp>

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

Public Types

enum class  IndividualOrGroup { Individual , Group , Both }
 
using Grid = GetPropType< TypeTag, Properties::Grid >
 
using Simulator = GetPropType< TypeTag, Properties::Simulator >
 
using Scalar = GetPropType< TypeTag, Properties::Scalar >
 
using FluidSystem = GetPropType< TypeTag, Properties::FluidSystem >
 
using IndexTraits = typename FluidSystem::IndexTraitsType
 
using Indices = GetPropType< TypeTag, Properties::Indices >
 
using IntensiveQuantities = GetPropType< TypeTag, Properties::IntensiveQuantities >
 
using MaterialLaw = GetPropType< TypeTag, Properties::MaterialLaw >
 
using SparseMatrixAdapter = GetPropType< TypeTag, Properties::SparseMatrixAdapter >
 
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 Eval = typename Base::Eval
 
using BVector = Dune::BlockVector< VectorBlockType >
 
using PressureMatrix = Dune::BCRSMatrix< Opm::MatrixBlock< Scalar, 1, 1 > >
 
using WellStateType = WellState< Scalar, IndexTraits >
 
using SingleWellStateType = SingleWellState< Scalar, IndexTraits >
 
using GroupStateHelperType = GroupStateHelper< Scalar, IndexTraits >
 
using FSInfo = FirstPerfCellConditions< Scalar >
 Temperature and salt concentration of the first perforated cell. More...
 
using RateConverterType = typename WellInterfaceFluidSystem< FluidSystem >::RateConverterType
 
using ModelParameters = typename Base::ModelParameters
 
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 FluidState = BlackOilFluidStateType< Eval >
 
using BMatrix = Dune::BCRSMatrix< Dune::FieldMatrix< Scalar, numWellDofs, numResDofs > >
 
using CMatrix = Dune::BCRSMatrix< Dune::FieldMatrix< Scalar, numResDofs, numWellDofs > >
 
using DMatrix = Dune::BCRSMatrix< Dune::FieldMatrix< Scalar, numWellDofs, numWellDofs > >
 
using WVector = Dune::BlockVector< Dune::FieldVector< Scalar, numWellDofs > >
 

Public Member Functions

 WellInterface (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)
 Constructor. More...
 
virtual ~WellInterface ()=default
 Virtual destructor. More...
 
virtual 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)
 
virtual ConvergenceReport getWellConvergence (const GroupStateHelperType &groupStateHelper, const std::vector< Scalar > &B_avg, const bool relax_tolerance) const =0
 
virtual void solveEqAndUpdateWellState (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, WellStateType &well_state)=0
 
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)
 
virtual void computeWellRatesWithBhp (const Simulator &ebosSimulator, const Scalar &bhp, std::vector< Scalar > &well_flux, DeferredLogger &deferred_logger) const =0
 
virtual std::optional< Scalar > computeBhpAtThpLimitProdWithAlq (const Simulator &ebos_simulator, const GroupStateHelperType &groupStateHelper, const SummaryState &summary_state, const Scalar alq_value, bool iterate_if_no_solution) const =0
 
std::optional< Scalar > computeBhpAtThpLimitProdWithAlqUsingIPR (const Simulator &simulator, const WellStateType &well_state, Scalar bhp, const SummaryState &summary_state, const Scalar alq_value)
 
virtual void recoverWellSolutionAndUpdateWellState (const Simulator &simulator, const BVector &x, const GroupStateHelperType &groupStateHelper, WellStateType &well_state)=0
 
virtual void apply (const BVector &x, BVector &Ax) const =0
 Ax = Ax - C D^-1 B x. More...
 
virtual void apply (BVector &r) const =0
 r = r - C D^-1 Rw More...
 
virtual void computeWellPotentials (const Simulator &simulator, const WellStateType &well_state, const GroupStateHelperType &groupStateHelper, std::vector< Scalar > &well_potentials)=0
 
virtual void updateWellStateWithTarget (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, WellStateType &well_state) const
 
virtual void scaleSegmentRatesAndPressure (WellStateType &well_state) const
 
virtual void computeWellRatesWithBhpIterations (const Simulator &simulator, const Scalar &bhp, const GroupStateHelperType &groupStateHelper, std::vector< Scalar > &well_flux) const =0
 
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)
 
virtual void updatePrimaryVariables (const GroupStateHelperType &groupStateHelper)=0
 
virtual void calculateExplicitQuantities (const Simulator &simulator, const GroupStateHelperType &groupStateHelper)=0
 
virtual void updateProductivityIndex (const Simulator &simulator, const WellProdIndexCalculator< Scalar > &wellPICalc, WellStateType &well_state, DeferredLogger &deferred_logger) const =0
 
virtual void addWellContributions (SparseMatrixAdapter &) const =0
 
virtual void addWellPressureEquations (PressureMatrix &mat, const BVector &x, const int pressureVarIndex, const bool use_well_weights, const WellStateType &well_state) const =0
 
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)
 
virtual void updateWaterThroughput (const double dt, WellStateType &well_state) const =0
 
virtual std::vector< Scalar > computeCurrentWellRates (const Simulator &simulator, DeferredLogger &deferred_logger) const =0
 
virtual void getScaledWellFractions (std::vector< Scalar > &scaled_fractions, DeferredLogger &deferred_logger) const =0
 
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
 
virtual Scalar maxPerfPress (const Simulator &simulator) const =0
 
virtual void updateIPRImplicit (const Simulator &simulator, const GroupStateHelperType &groupStateHelper, WellStateType &well_state)=0
 
virtual void addBCDMatrix (std::vector< BMatrix > &b_matrices, std::vector< CMatrix > &c_matrices, std::vector< DMatrix > &d_matrices, Opm::SparseTable< int > &wcells) const =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 std::vector< FluidSystem::Scalar > getPrimaryVars () const
 
virtual int setPrimaryVars (typename std::vector< FluidSystem::Scalar >::const_iterator)
 
virtual FluidSystem::Scalar connectionDensity (const int globalConnIdx, const int openConnIdx) const=0
 
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
 

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 has_solvent = getPropValue<TypeTag, Properties::EnableSolvent>()
 
static constexpr bool has_zFraction = getPropValue<TypeTag, Properties::EnableExtbo>()
 
static constexpr bool has_polymer = getPropValue<TypeTag, Properties::EnablePolymer>()
 
static constexpr EnergyModules energyModuleType = getPropValue<TypeTag, Properties::EnergyModuleType>()
 
static constexpr bool has_energy = energyModuleType == EnergyModules::FullyImplicitThermal
 
static constexpr bool has_polymermw = getPropValue<TypeTag, Properties::EnablePolymerMW>()
 
static constexpr bool has_foam = getPropValue<TypeTag, Properties::EnableFoam>()
 
static constexpr bool has_brine = getPropValue<TypeTag, Properties::EnableBrine>()
 
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
 

Protected Member Functions

Scalar wpolymer () const
 
Scalar wfoam () const
 
Scalar wsalt () const
 
Scalar wmicrobes () const
 
Scalar woxygen () const
 
Scalar wurea () const
 
virtual Scalar getRefDensity () const =0
 
std::vector< Scalar > initialWellRateFractions (const Simulator &ebosSimulator, const WellStateType &well_state) const
 
virtual void checkOperabilityUnderBHPLimit (const WellStateType &well_state, const Simulator &simulator, DeferredLogger &deferred_logger)=0
 
virtual void checkOperabilityUnderTHPLimit (const Simulator &simulator, const WellStateType &well_state, const GroupStateHelperType &groupStateHelper)=0
 
virtual void updateIPR (const Simulator &simulator, DeferredLogger &deferred_logger) const =0
 
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
 
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
 
std::pair< bool, bool > computeWellPotentials (std::vector< FluidSystem::Scalar > &well_potentials, const WellStateType &well_state)
 
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 updateGroupTargetFallbackFlag (WellState< FluidSystem::Scalar, FluidSystem::IndexTraitsType > &well_state, const std::vector< FluidSystem::Scalar > &scaled_well_fractions, DeferredLogger &deferred_logger) const
 

Protected Attributes

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_
 

Static Protected Attributes

static constexpr int INVALIDCOMPLETION
 

Member Typedef Documentation

◆ 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>

◆ BMatrix

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::BMatrix = Dune::BCRSMatrix<Dune::FieldMatrix<Scalar, numWellDofs, numResDofs> >

◆ BVector

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

◆ CMatrix

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::CMatrix = Dune::BCRSMatrix<Dune::FieldMatrix<Scalar, numResDofs, numWellDofs> >

◆ DMatrix

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::DMatrix = Dune::BCRSMatrix<Dune::FieldMatrix<Scalar, numWellDofs, numWellDofs> >

◆ Eval

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

◆ 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::WellInterface< TypeTag >::FSInfo = FirstPerfCellConditions<Scalar>

Temperature and salt concentration of the first perforated cell.

◆ GasLiftSingleWell

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

◆ GLiftEclWells

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

◆ Grid

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

◆ 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>

◆ ModelParameters

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

◆ PressureMatrix

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

◆ 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>

◆ Scalar

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

◆ 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>

◆ 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>

◆ WellStateType

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

◆ WVector

template<typename TypeTag >
using Opm::WellInterface< TypeTag >::WVector = Dune::BlockVector<Dune::FieldVector<Scalar, numWellDofs> >

Member Enumeration Documentation

◆ IndividualOrGroup

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

Constructor & Destructor Documentation

◆ WellInterface()

template<typename TypeTag >
Opm::WellInterface< TypeTag >::WellInterface ( 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 
)

Constructor.

References Opm::WellInterface< TypeTag >::connectionRates_, Opm::WellInterface< TypeTag >::has_solvent, Opm::WellInterface< TypeTag >::has_zFraction, Opm::WellInterfaceGeneric< FluidSystem::Scalar, FluidSystem::IndexTraitsType >::number_of_local_perforations_, Opm::WellInterfaceGeneric< FluidSystem::Scalar, FluidSystem::IndexTraitsType >::well_ecl_, and Opm::WellInterfaceGeneric< FluidSystem::Scalar, FluidSystem::IndexTraitsType >::wsolvent_.

◆ ~WellInterface()

template<typename TypeTag >
virtual Opm::WellInterface< TypeTag >::~WellInterface ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ adaptRatesForVFP()

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

◆ addBCDMatrix()

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

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ addCellRates()

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

◆ 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 >
virtual void Opm::WellInterface< TypeTag >::addWellContributions ( SparseMatrixAdapter &  ) const
pure virtual

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ addWellPressureEquations()

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

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ apply() [1/2]

template<typename TypeTag >
virtual void Opm::WellInterface< TypeTag >::apply ( BVector &  r) const
pure virtual

r = r - C D^-1 Rw

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ apply() [2/2]

template<typename TypeTag >
virtual void Opm::WellInterface< TypeTag >::apply ( const BVector &  x,
BVector &  Ax 
) const
pure virtual

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

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< 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.

◆ assembleWellEq()

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

◆ assembleWellEqWithoutIteration() [1/2]

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 virtual

◆ assembleWellEqWithoutIteration() [2/2]

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 
)

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

◆ calculateExplicitQuantities()

template<typename TypeTag >
virtual void Opm::WellInterface< TypeTag >::calculateExplicitQuantities ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper 
)
pure virtual

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ 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 >
virtual void Opm::WellInterface< TypeTag >::checkOperabilityUnderBHPLimit ( const WellStateType &  well_state,
const Simulator &  simulator,
DeferredLogger &  deferred_logger 
)
protectedpure virtual

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ checkOperabilityUnderTHPLimit()

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

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ checkWellOperability()

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

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

◆ closeCompletions()

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

◆ computeBhpAtThpLimitProdWithAlq()

template<typename TypeTag >
virtual std::optional< Scalar > Opm::WellInterface< TypeTag >::computeBhpAtThpLimitProdWithAlq ( const Simulator &  ebos_simulator,
const GroupStateHelperType &  groupStateHelper,
const SummaryState &  summary_state,
const Scalar  alq_value,
bool  iterate_if_no_solution 
) const
pure virtual

Implemented in Opm::StandardWell< TypeTag >, and Opm::MultisegmentWell< TypeTag >.

◆ 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 
)

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
protected

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
protected

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
protected

◆ computeCurrentWellRates()

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

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

Implemented in Opm::StandardWell< TypeTag >, and Opm::MultisegmentWell< TypeTag >.

◆ computeWellPotentials() [1/2]

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

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ 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

◆ computeWellRatesWithBhp()

template<typename TypeTag >
virtual void Opm::WellInterface< TypeTag >::computeWellRatesWithBhp ( const Simulator &  ebosSimulator,
const Scalar &  bhp,
std::vector< Scalar > &  well_flux,
DeferredLogger &  deferred_logger 
) const
pure virtual

Implemented in Opm::StandardWell< TypeTag >, and Opm::MultisegmentWell< TypeTag >.

◆ computeWellRatesWithBhpIterations()

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

Implemented in Opm::StandardWell< TypeTag >, and Opm::MultisegmentWell< TypeTag >.

◆ connectionDensity()

virtual FluidSystem::Scalar Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::connectionDensity ( const int  globalConnIdx,
const int  openConnIdx 
) const
pure virtualinherited

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ connectionRates()

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

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

◆ 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 
)
protected

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

◆ 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

◆ getDynamicThpLimit()

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

◆ getFirstPerfCellConditions()

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

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()

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
protected

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

◆ getPerfCellPressure()

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

◆ getPrimaryVars()

virtual std::vector< FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::getPrimaryVars ( ) const
inlinevirtualinherited

Reimplemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ getRefDensity()

template<typename TypeTag >
virtual Scalar Opm::WellInterface< TypeTag >::getRefDensity ( ) const
protectedpure virtual

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ getScaledWellFractions()

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

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

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ getTHPConstraint()

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

◆ getTransMult()

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
protected

Referenced by Opm::MultisegmentWell< TypeTag >::getTransMult(), and Opm::StandardWell< 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
protected

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

◆ getWellConvergence()

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

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ 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 
)

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::WellInterface< 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 
)
virtual

Reimplemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< 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 
)
protected

◆ initializeProducerWellState()

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

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
protected

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

◆ initInjMult()

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

◆ 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 
)
protected

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

◆ iterateWellEqWithControl()

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 virtual

◆ iterateWellEqWithSwitching()

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 virtual

◆ maxPerfPress()

template<typename TypeTag >
virtual Scalar Opm::WellInterface< TypeTag >::maxPerfPress ( const Simulator &  simulator) const
pure virtual

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ name()

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

Well name.

◆ 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

◆ 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 
)

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

◆ 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 >
virtual void Opm::WellInterface< TypeTag >::recoverWellSolutionAndUpdateWellState ( const Simulator &  simulator,
const BVector &  x,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
pure virtual

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

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ refDepth()

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

◆ 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

◆ scaleSegmentRatesAndPressure()

template<typename TypeTag >
void Opm::WellInterface< TypeTag >::scaleSegmentRatesAndPressure ( WellStateType &  well_state) const
virtual

Reimplemented in Opm::MultisegmentWell< TypeTag >.

◆ scalingFactor()

Scalar Opm::WellInterfaceIndices< GetPropType< TypeTag, Properties::FluidSystem > , GetPropType< TypeTag, Properties::Indices > >::scalingFactor ( const int  phaseIdx) 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()

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

◆ 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 >
virtual void Opm::WellInterface< TypeTag >::solveEqAndUpdateWellState ( const Simulator &  simulator,
const GroupStateHelperType &  groupStateHelper,
WellStateType &  well_state 
)
pure virtual

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ 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 
)

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 
)
protected

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 
)
protected

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 
)
protected

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 
)
protected

◆ stoppedOrZeroRateTarget()

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

◆ stopWell()

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

◆ 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).

◆ updateConnectionDFactor()

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

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

◆ updateConnectionTransmissibilityFactor()

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

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

◆ updateInjMult()

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

◆ updateIPR()

template<typename TypeTag >
virtual void Opm::WellInterface< TypeTag >::updateIPR ( const Simulator &  simulator,
DeferredLogger &  deferred_logger 
) const
protectedpure virtual

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ updateIPRImplicit()

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

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ updatePerforatedCell()

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

◆ updatePrimaryVariables()

template<typename TypeTag >
virtual void Opm::WellInterface< TypeTag >::updatePrimaryVariables ( const GroupStateHelperType &  groupStateHelper)
pure virtual

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ updateProductivityIndex()

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

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

Referenced by Opm::BlackoilWellModel< TypeTag >::calculateProductivityIndexValues().

◆ updateWaterThroughput()

template<typename TypeTag >
virtual void Opm::WellInterface< TypeTag >::updateWaterThroughput ( const double  dt,
WellStateType &  well_state 
) const
pure virtual

Implemented in Opm::MultisegmentWell< TypeTag >, and Opm::StandardWell< TypeTag >.

◆ updateWeldrawMaxRate()

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

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 
)

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 
)

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

◆ updateWellOperability()

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

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 
)

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

◆ updateWellStateWithTarget()

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

Reimplemented in Opm::MultisegmentWell< TypeTag >.

References Opm::WellBhpThpCalculator< Scalar, IndexTraits >::calculateBhpFromThp(), Opm::GroupStateHelper< Scalar, IndexTraits >::deferredLogger(), Opm::ExceptionType::NONE, Opm::WellState< Scalar, IndexTraits >::numPhases(), OPM_DEFLOG_THROW, and Opm::WellState< Scalar, IndexTraits >::well().

◆ updateWellStateWithTHPTargetProd()

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

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

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 
)

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

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

◆ wellUnderZeroRateTarget()

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

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
protected

◆ wfoam_()

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

◆ wmicrobes()

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

◆ wmicrobes_()

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

◆ woxygen()

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

◆ woxygen_()

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

◆ wpolymer()

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

◆ wpolymer_()

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

◆ wsalt()

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

◆ 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
protected

◆ 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_
protected

◆ bore_diameters_

std::vector<FluidSystem::Scalar > Opm::WellInterfaceGeneric< FluidSystem::Scalar , FluidSystem::IndexTraitsType >::bore_diameters_
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
protected

◆ completions_

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

◆ 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_
protected

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

◆ current_step_

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

◆ dynamic_thp_limit_

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

◆ energyModuleType

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

◆ 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>()
staticconstexpr

◆ has_brine

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_brine = getPropValue<TypeTag, Properties::EnableBrine>()
staticconstexpr

◆ has_disgas_in_water

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

◆ has_energy

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_energy = energyModuleType == EnergyModules::FullyImplicitThermal
staticconstexpr

◆ has_foam

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

◆ has_micp

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

◆ has_polymer

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_polymer = getPropValue<TypeTag, Properties::EnablePolymer>()
staticconstexpr

◆ has_polymermw

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

◆ has_saltPrecip

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

◆ has_solvent

template<typename TypeTag >
constexpr bool Opm::WellInterface< TypeTag >::has_solvent = getPropValue<TypeTag, Properties::EnableSolvent>()
staticconstexpr

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

◆ has_watVapor

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

◆ has_zFraction

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

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

◆ 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}
protected

◆ numResDofs

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

◆ numWellDofs

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

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

◆ 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

◆ 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

◆ saturation_table_number_

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

◆ solve_stats_

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

◆ thp_update_iterations

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

◆ 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

◆ wellStatus_

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

◆ wsolvent_

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