#include <WellInterface.hpp>

Inheritance diagram for Opm::WellInterface< TypeTag >:

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	WellGroupHelperType = WellGroupHelper< Scalar, IndexTraits >

using	RateConverterType = typename WellInterfaceFluidSystem< FluidSystem >::RateConverterType

using	ModelParameters = typename Base::ModelParameters

using	FluidState = BlackOilFluidState< Eval, FluidSystem, has_temperature, has_energy, Indices::compositionSwitchIdx >=0, has_watVapor, has_brine, has_saltPrecip, has_disgas_in_water, Indices::numPhases >

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 Simulator &simulator, const WellStateType &well_state, const std::vector< Scalar > &B_avg, DeferredLogger &deferred_logger, const bool relax_tolerance) const =0

virtual void	solveEqAndUpdateWellState (const Simulator &simulator, WellStateType &well_state, DeferredLogger &deferred_logger)=0

void	assembleWellEq (const Simulator &simulator, const double dt, const WellGroupHelperType &wgHelper, WellStateType &well_state, DeferredLogger &deferred_logger)

void	assembleWellEqWithoutIteration (const Simulator &simulator, const double dt, WellStateType &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger)

void	prepareWellBeforeAssembling (const Simulator &simulator, const double dt, const WellGroupHelperType &wgHelper, WellStateType &well_state, DeferredLogger &deferred_logger)

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 WellGroupHelperType &wgHelper, const SummaryState &summary_state, const Scalar alq_value, DeferredLogger &deferred_logger, bool iterate_if_no_solution) const =0

virtual void	recoverWellSolutionAndUpdateWellState (const Simulator &simulator, const BVector &x, WellStateType &well_state, DeferredLogger &deferred_logger)=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 WellGroupHelperType &wgHelper, std::vector< Scalar > &well_potentials, DeferredLogger &deferred_logger)=0

virtual void	updateWellStateWithTarget (const Simulator &simulator, const WellGroupHelperType &wgHelper, WellStateType &well_state, DeferredLogger &deferred_logger) const

virtual void	scaleSegmentRatesAndPressure (WellStateType &well_state) const

virtual void	computeWellRatesWithBhpIterations (const Simulator &simulator, const Scalar &bhp, const WellGroupHelperType &wgHelper, std::vector< Scalar > &well_flux, DeferredLogger &deferred_logger) const =0

bool	wellUnderZeroRateTarget (const Simulator &simulator, const WellStateType &well_state, DeferredLogger &deferred_logger) const

bool	wellUnderZeroGroupRateTarget (const Simulator &simulator, const WellStateType &well_state, DeferredLogger &deferred_logger, std::optional< bool > group_control=std::nullopt) const

bool	stoppedOrZeroRateTarget (const Simulator &simulator, const WellStateType &well_state, DeferredLogger &deferred_logger) const

bool	updateWellStateWithTHPTargetProd (const Simulator &simulator, WellStateType &well_state, const WellGroupHelperType &wgHelper, DeferredLogger &deferred_logger) const

bool	updateWellControl (const Simulator &simulator, const IndividualOrGroup iog, const WellGroupHelperType &wgHelper, WellStateType &well_state, DeferredLogger &deferred_logger)

bool	updateWellControlAndStatusLocalIteration (const Simulator &simulator, const WellGroupHelperType &wgHelper, const Well::InjectionControls &inj_controls, const Well::ProductionControls &prod_controls, const Scalar WQTotal, WellStateType &well_state, DeferredLogger &deferred_logger, const bool fixed_control=false, const bool fixed_status=false)

virtual void	updatePrimaryVariables (const Simulator &simulator, const WellStateType &well_state, DeferredLogger &deferred_logger)=0

virtual void	calculateExplicitQuantities (const Simulator &simulator, const WellStateType &well_state, DeferredLogger &deferred_logger)=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 (RateVector &rates, int cellIdx) const

Scalar	volumetricSurfaceRateForConnection (int cellIdx, int phaseIdx) const

void	wellTesting (const Simulator &simulator, const double simulation_time, const WellGroupHelperType &wgHelper, WellStateType &well_state, WellTestState &welltest_state, GLiftEclWells &ecl_well_map, std::map< std::string, double > &open_times, DeferredLogger &deferred_logger)

void	checkWellOperability (const Simulator &simulator, const WellStateType &well_state, const WellGroupHelperType &wgHelper, DeferredLogger &deferred_logger)

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 WellGroupHelperType &wgHelper, DeferredLogger &deferred_logger)

bool	updateWellOperabilityFromWellEq (const Simulator &simulator, const WellGroupHelperType &wgHelper, DeferredLogger &deferred_logger)

virtual void	updateWaterThroughput (const double dt, WellStateType &well_state) const =0

virtual std::vector< Scalar >	computeCurrentWellRates (const Simulator &simulator, DeferredLogger &deferred_logger) const =0

void	initializeProducerWellState (const Simulator &simulator, WellStateType &well_state, DeferredLogger &deferred_logger) const

void	solveWellEquation (const Simulator &simulator, const WellGroupHelperType &wgHelper, WellStateType &well_state, DeferredLogger &deferred_logger)

const std::vector< RateVector > &	connectionRates () const

std::vector< Scalar >	wellIndex (const int perf, const IntensiveQuantities &intQuants, const Scalar trans_mult, const SingleWellStateType &ws) 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 WellGroupHelperType &wgHelper, WellStateType &well_state, DeferredLogger &deferred_logger, const bool fixed_control=false, const bool fixed_status=false)=0

Scalar	scalingFactor (const int phaseIdx) const

Eval	restrictEval (const EvalWell &in) const

const RateConverterType &	rateConverter () const

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

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 zero_group_target, WellTestState &wellTestState, DeferredLogger &deferred_logger) const

bool	isPressureControlled (const WellStateType &well_state) 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)

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 bool	has_energy = getPropValue<TypeTag, Properties::EnergyModuleType>() == EnergyModules::FullyImplicitThermal

static const bool	has_temperature = getPropValue<TypeTag, Properties::EnergyModuleType>() == EnergyModules::ConstantTemperature

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	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 WellGroupHelperType &wgHelper, DeferredLogger &deferred_logger)=0

virtual void	updateIPR (const Simulator &simulator, DeferredLogger &deferred_logger) const =0

virtual void	assembleWellEqWithoutIteration (const Simulator &simulator, const double dt, const WellInjectionControls &inj_controls, const WellProductionControls &prod_controls, WellStateType &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger)=0

virtual bool	iterateWellEqWithControl (const Simulator &simulator, const double dt, const WellInjectionControls &inj_controls, const WellProductionControls &prod_controls, const WellGroupHelperType &wgHelper, WellStateType &well_state, DeferredLogger &deferred_logger)=0

virtual void	updateIPRImplicit (const Simulator &simulator, WellStateType &well_state, DeferredLogger &deferred_logger)=0

bool	iterateWellEquations (const Simulator &simulator, const double dt, const WellGroupHelperType &wgHelper, WellStateType &well_state, DeferredLogger &deferred_logger)

bool	solveWellWithOperabilityCheck (const Simulator &simulator, const double dt, const Well::InjectionControls &inj_controls, const Well::ProductionControls &prod_controls, const WellGroupHelperType &wgHelper, WellStateType &well_state, DeferredLogger &deferred_logger)

std::optional< Scalar >	estimateOperableBhp (const Simulator &ebos_simulator, const double dt, const WellGroupHelperType &wgHelper, const SummaryState &summary_state, WellStateType &well_state, DeferredLogger &deferred_logger)

bool	solveWellWithBhp (const Simulator &simulator, const double dt, const Scalar bhp, const WellGroupHelperType &wgHelper, WellStateType &well_state, DeferredLogger &deferred_logger)

bool	solveWellWithZeroRate (const Simulator &simulator, const double dt, const WellGroupHelperType &wgHelper, WellStateType &well_state, DeferredLogger &deferred_logger)

bool	solveWellForTesting (const Simulator &simulator, const WellGroupHelperType &wgHelper, WellStateType &well_state, DeferredLogger &deferred_logger)

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

void	calculateReservoirRates (const bool co2store, 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 WellGroupHelperType &wgHelper, const Schedule &schedule, const SummaryState &summaryState, const bool check_guide_rate, WellStateType &well_state, DeferredLogger &deferred_logger) const

bool	checkConstraints (const WellGroupHelperType &wgHelper, const Schedule &schedule, const SummaryState &summaryState, WellStateType &well_state, DeferredLogger &deferred_logger) const

std::optional< Scalar >	getGroupInjectionTargetRate (const Group &group, const WellState< Scalar, IndexTraits > &well_state, const GroupState< Scalar > &group_state, const Schedule &schedule, const SummaryState &summaryState, const InjectorType &injectorType, Scalar efficiencyFactor, DeferredLogger &deferred_logger) const

Scalar	getGroupProductionTargetRate (const Group &group, const WellState< Scalar, IndexTraits > &well_state, const GroupState< Scalar > &group_state, const Schedule &schedule, const SummaryState &summaryState, Scalar efficiencyFactor, DeferredLogger &deferred_logger) const

bool	zeroGroupRateTarget (const SummaryState &summary_state, const Schedule &schedule, const WellState< Scalar, IndexTraits > &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferredLogger) 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 ()

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_

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_

Static Protected Attributes
static constexpr int	INVALIDCOMPLETION

Member Typedef Documentation

◆ BVector

template<typename TypeTag >

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

◆ Eval

template<typename TypeTag >

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

◆ FluidState

template<typename TypeTag >

using Opm::WellInterface< TypeTag >::FluidState = BlackOilFluidState<Eval, FluidSystem, has_temperature, has_energy, Indices::compositionSwitchIdx >= 0, has_watVapor, has_brine, has_saltPrecip, has_disgas_in_water, Indices::numPhases >

◆ FluidSystem

template<typename TypeTag >

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

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

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

◆ WellGroupHelperType

template<typename TypeTag >

using Opm::WellInterface< TypeTag >::WellGroupHelperType = WellGroupHelper<Scalar, IndexTraits>

◆ WellStateType

template<typename TypeTag >

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

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

◆ addCellRates()

template<typename TypeTag >

void Opm::WellInterface< TypeTag >::addCellRates	(	RateVector &	rates,
		int	cellIdx
	)		const

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

◆ assembleWellEq()

template<typename TypeTag >

void Opm::WellInterface< TypeTag >::assembleWellEq	(	const Simulator &	simulator,
		const double	dt,
		const WellGroupHelperType &	wgHelper,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

References Opm::WellGroupHelper< Scalar, IndexTraits >::groupState().

◆ assembleWellEqWithoutIteration() [1/2]

template<typename TypeTag >

virtual void Opm::WellInterface< TypeTag >::assembleWellEqWithoutIteration	(	const Simulator &	simulator,
		const double	dt,
		const WellInjectionControls &	inj_controls,
		const WellProductionControls &	prod_controls,
		WellStateType &	well_state,
		const GroupState< Scalar > &	group_state,
		DeferredLogger &	deferred_logger
	)

protectedpure virtual

◆ assembleWellEqWithoutIteration() [2/2]

template<typename TypeTag >

void Opm::WellInterface< TypeTag >::assembleWellEqWithoutIteration	(	const Simulator &	simulator,
		const double	dt,
		WellStateType &	well_state,
		const GroupState< Scalar > &	group_state,
		DeferredLogger &	deferred_logger
	)

◆ calculateExplicitQuantities()

template<typename TypeTag >

virtual void Opm::WellInterface< TypeTag >::calculateExplicitQuantities	(	const Simulator &	simulator,
		const WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

pure virtual

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

◆ calculateReservoirRates()

void Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::calculateReservoirRates	(	const bool	co2store,
		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 WellGroupHelperType &	wgHelper,
		const Schedule &	schedule,
		const SummaryState &	summaryState,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)		const

protectedinherited

◆ checkGroupConstraints()

bool Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::checkGroupConstraints	(	const WellGroupHelperType &	wgHelper,
		const Schedule &	schedule,
		const SummaryState &	summaryState,
		const bool	check_guide_rate,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)		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 WellGroupHelperType &	wgHelper,
		DeferredLogger &	deferred_logger
	)

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 WellGroupHelperType &	wgHelper,
		DeferredLogger &	deferred_logger
	)

References Opm::DeferredLogger::debug().

◆ 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 WellGroupHelperType &	wgHelper,
		const SummaryState &	summary_state,
		const Scalar	alq_value,
		DeferredLogger &	deferred_logger,
		bool	iterate_if_no_solution
	)		const

pure virtual

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

◆ 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 WellGroupHelperType &	wgHelper,
		std::vector< Scalar > &	well_potentials,
		DeferredLogger &	deferred_logger
	)

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 WellGroupHelperType &	wgHelper,
		std::vector< Scalar > &	well_flux,
		DeferredLogger &	deferred_logger
	)		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 WellGroupHelperType &	wgHelper,
		const SummaryState &	summary_state,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

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

◆ getGroupInjectionTargetRate()

std::optional< Scalar > Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::getGroupInjectionTargetRate	(	const Group &	group,
		const WellState< Scalar, IndexTraits > &	well_state,
		const GroupState< Scalar > &	group_state,
		const Schedule &	schedule,
		const SummaryState &	summaryState,
		const InjectorType &	injectorType,
		Scalar	efficiencyFactor,
		DeferredLogger &	deferred_logger
	)		const

protectedinherited

◆ getGroupProductionTargetRate()

Scalar Opm::WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::getGroupProductionTargetRate	(	const Group &	group,
		const WellState< Scalar, IndexTraits > &	well_state,
		const GroupState< Scalar > &	group_state,
		const Schedule &	schedule,
		const SummaryState &	summaryState,
		Scalar	efficiencyFactor,
		DeferredLogger &	deferred_logger
	)		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

References OPM_DEFLOG_THROW.

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

◆ getTHPConstraint()

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

inherited

◆ getWellConvergence()

template<typename TypeTag >

virtual ConvergenceReport Opm::WellInterface< TypeTag >::getWellConvergence	(	const Simulator &	simulator,
		const WellStateType &	well_state,
		const std::vector< Scalar > &	B_avg,
		DeferredLogger &	deferred_logger,
		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 WellGroupHelperType &	wgHelper,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

protected

References Opm::DeferredLogger::debug(), Opm::DeferredLogger::warning(), 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 WellGroupHelperType &	wgHelper,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

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 WellGroupHelperType &	wgHelper,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger,
		const bool	fixed_control = `false`,
		const bool	fixed_status = `false`
	)

pure virtual

◆ 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

◆ prepareWellBeforeAssembling()

template<typename TypeTag >

void Opm::WellInterface< TypeTag >::prepareWellBeforeAssembling	(	const Simulator &	simulator,
		const double	dt,
		const WellGroupHelperType &	wgHelper,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

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

◆ 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,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

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

◆ 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

◆ solveEqAndUpdateWellState()

template<typename TypeTag >

virtual void Opm::WellInterface< TypeTag >::solveEqAndUpdateWellState	(	const Simulator &	simulator,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

pure virtual

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

◆ solveWellEquation()

template<typename TypeTag >

void Opm::WellInterface< TypeTag >::solveWellEquation	(	const Simulator &	simulator,
		const WellGroupHelperType &	wgHelper,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

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

◆ solveWellForTesting()

template<typename TypeTag >

bool Opm::WellInterface< TypeTag >::solveWellForTesting	(	const Simulator &	simulator,
		const WellGroupHelperType &	wgHelper,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

protected

References Opm::DeferredLogger::debug(), Opm::to_string(), Opm::DeferredLogger::warning(), 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 WellGroupHelperType &	wgHelper,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

protected

References Opm::WellGroupHelper< 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 WellGroupHelperType &	wgHelper,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

protected

References Opm::DeferredLogger::debug(), 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 WellGroupHelperType &	wgHelper,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

protected

References Opm::WellGroupHelper< Scalar, IndexTraits >::pushGroupState().

◆ stoppedOrZeroRateTarget()

template<typename TypeTag >

bool Opm::WellInterface< TypeTag >::stoppedOrZeroRateTarget	(	const Simulator &	simulator,
		const WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)		const

◆ stopWell()

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

inlineinherited

◆ thpLimitViolatedButNotSwitched()

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

inherited

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

◆ 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,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

protectedpure 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 Simulator &	simulator,
		const WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

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

◆ updateWellControl()

template<typename TypeTag >

bool Opm::WellInterface< TypeTag >::updateWellControl	(	const Simulator &	simulator,
		const IndividualOrGroup	iog,
		const WellGroupHelperType &	wgHelper,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)

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

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

◆ updateWellControlAndStatusLocalIteration()

template<typename TypeTag >

bool Opm::WellInterface< TypeTag >::updateWellControlAndStatusLocalIteration	(	const Simulator &	simulator,
		const WellGroupHelperType &	wgHelper,
		const Well::InjectionControls &	inj_controls,
		const Well::ProductionControls &	prod_controls,
		const Scalar	WQTotal,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger,
		const bool	fixed_control = `false`,
		const bool	fixed_status = `false`
	)

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

◆ updateWellOperability()

template<typename TypeTag >

void Opm::WellInterface< TypeTag >::updateWellOperability	(	const Simulator &	simulator,
		const WellStateType &	well_state,
		const WellGroupHelperType &	wgHelper,
		DeferredLogger &	deferred_logger
	)

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

◆ updateWellOperabilityFromWellEq()

template<typename TypeTag >

bool Opm::WellInterface< TypeTag >::updateWellOperabilityFromWellEq	(	const Simulator &	simulator,
		const WellGroupHelperType &	wgHelper,
		DeferredLogger &	deferred_logger
	)

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

◆ updateWellStateWithTarget()

template<typename TypeTag >

void Opm::WellInterface< TypeTag >::updateWellStateWithTarget	(	const Simulator &	simulator,
		const WellGroupHelperType &	wgHelper,
		WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)		const

virtual

Reimplemented in Opm::MultisegmentWell< TypeTag >.

References Opm::WellBhpThpCalculator< Scalar, IndexTraits >::calculateBhpFromThp(), Opm::WellGroupHelper< Scalar, IndexTraits >::groupState(), 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 WellGroupHelperType &	wgHelper,
		DeferredLogger &	deferred_logger
	)		const

References 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	zero_group_target,
		WellTestState &	wellTestState,
		DeferredLogger &	deferred_logger
	)		const

inherited

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

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

inlineinherited

◆ wellIndex() [2/2]

template<typename TypeTag >

std::vector< typename WellInterface< TypeTag >::Scalar > Opm::WellInterface< TypeTag >::wellIndex	(	const int	perf,
		const IntensiveQuantities &	intQuants,
		const Scalar	trans_mult,
		const SingleWellStateType &	ws
	)		const

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

◆ 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 WellGroupHelperType &	wgHelper,
		WellStateType &	well_state,
		WellTestState &	welltest_state,
		GLiftEclWells &	ecl_well_map,
		std::map< std::string, double > &	open_times,
		DeferredLogger &	deferred_logger
	)

References Opm::DeferredLogger::debug(), Opm::WellGroupHelper< Scalar, IndexTraits >::groupState(), Opm::DeferredLogger::info(), Opm::WellState< Scalar, IndexTraits >::numPhases(), Opm::WellGroupHelper< 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 Simulator &	simulator,
		const WellStateType &	well_state,
		DeferredLogger &	deferred_logger,
		std::optional< bool >	group_control = `std::nullopt`
	)		const

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

◆ wellUnderZeroRateTarget()

template<typename TypeTag >

bool Opm::WellInterface< TypeTag >::wellUnderZeroRateTarget	(	const Simulator &	simulator,
		const WellStateType &	well_state,
		DeferredLogger &	deferred_logger
	)		const

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

◆ 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 SummaryState &	summary_state,
		const Schedule &	schedule,
		const WellState< Scalar, IndexTraits > &	well_state,
		const GroupState< Scalar > &	group_state,
		DeferredLogger &	deferredLogger
	)		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

◆ 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

◆ 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

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

◆ 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 = getPropValue<TypeTag, Properties::EnergyModuleType>() == EnergyModules::FullyImplicitThermal

staticconstexpr

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

◆ has_foam

template<typename TypeTag >

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

staticconstexpr

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

◆ has_micp

template<typename TypeTag >

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

staticconstexpr

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

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

template<typename TypeTag >

const bool Opm::WellInterface< TypeTag >::has_temperature = getPropValue<TypeTag, Properties::EnergyModuleType>() == EnergyModules::ConstantTemperature

static

◆ has_watVapor

template<typename TypeTag >

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

staticconstexpr

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

◆ has_zFraction

template<typename TypeTag >

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

staticconstexpr

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

◆ 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

◆ 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

◆ thp_update_iterations

template<typename TypeTag >

bool Opm::WellInterface< TypeTag >::thp_update_iterations = false

protected

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

◆ 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

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Typedef Documentation

◆ BVector

◆ Eval

◆ FluidState

◆ FluidSystem

◆ GasLiftSingleWell

◆ GLiftEclWells

◆ Grid

◆ IndexTraits

◆ Indices

◆ IntensiveQuantities

◆ MaterialLaw

◆ MatrixBlockType

◆ ModelParameters

◆ PressureMatrix

◆ RateConverterType

◆ RateVector

◆ Scalar

◆ Simulator

◆ SingleWellStateType

◆ SparseMatrixAdapter

◆ VectorBlockType

◆ WellGroupHelperType

◆ WellStateType

Member Enumeration Documentation

◆ IndividualOrGroup

Constructor & Destructor Documentation

◆ WellInterface()

◆ ~WellInterface()

Member Function Documentation

◆ adaptRatesForVFP()

◆ addCellRates()

◆ addPerforations()

◆ addWellContributions()

◆ addWellPressureEquations()

◆ apply() [1/2]

◆ apply() [2/2]

◆ assembleWellEq()

◆ assembleWellEqWithoutIteration() [1/2]

◆ assembleWellEqWithoutIteration() [2/2]

◆ calculateExplicitQuantities()

◆ calculateReservoirRates()

◆ cells()

◆ changedToOpenThisStep()

◆ checkConstraints()

◆ checkGroupConstraints()

◆ checkIndividualConstraints()

◆ checkNegativeWellPotentials()

◆ checkOperabilityUnderBHPLimit()

◆ checkOperabilityUnderTHPLimit()

◆ checkWellOperability()

◆ closeCompletions()

◆ computeBhpAtThpLimitProdWithAlq()

◆ computeConnectionDFactor()

◆ computeConnLevelInjInd()

◆ computeConnLevelProdInd()

◆ computeCurrentWellRates()

◆ computeWellPotentials() [1/2]

◆ computeWellPotentials() [2/2]

◆ computeWellRatesWithBhp()

◆ computeWellRatesWithBhpIterations()

◆ connectionDensity()

◆ connectionRates()

◆ currentStep()

◆ estimateOperableBhp()

◆ getAllowCrossFlow()

◆ getALQ()

◆ getCompletions()

◆ getDynamicThpLimit()

◆ getGroupInjectionTargetRate()

◆ getGroupProductionTargetRate()

◆ getInjMult()

◆ getMobility()

◆ getPerfCellPressure()