Class for handling the blackoil well model. More...

#include <BlackoilWellModel.hpp>

Inheritance diagram for Opm::BlackoilWellModel< TypeTag >:

Classes
struct	WBPCalcID

Public Types
using	ModelParameters = BlackoilModelParameters< TypeTag >

using	Grid = GetPropType< TypeTag, Properties::Grid >

using	EquilGrid = GetPropType< TypeTag, Properties::EquilGrid >

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

using	ElementContext = GetPropType< TypeTag, Properties::ElementContext >

using	Indices = GetPropType< TypeTag, Properties::Indices >

using	Simulator = GetPropType< TypeTag, Properties::Simulator >

using	Scalar = GetPropType< TypeTag, Properties::Scalar >

using	RateVector = GetPropType< TypeTag, Properties::RateVector >

using	GlobalEqVector = GetPropType< TypeTag, Properties::GlobalEqVector >

using	SparseMatrixAdapter = GetPropType< TypeTag, Properties::SparseMatrixAdapter >

using	GasLiftSingleWell = typename WellInterface< TypeTag >::GasLiftSingleWell

using	GLiftOptWells = typename BlackoilWellModelGeneric< Scalar >::GLiftOptWells

using	GLiftProdWells = typename BlackoilWellModelGeneric< Scalar >::GLiftProdWells

using	GLiftWellStateMap = typename BlackoilWellModelGeneric< Scalar >::GLiftWellStateMap

using	GLiftEclWells = typename GasLiftGroupInfo::GLiftEclWells

using	GLiftSyncGroups = typename GasLiftSingleWellGeneric::GLiftSyncGroups

typedef BaseAuxiliaryModule< TypeTag >::NeighborSet	NeighborSet

typedef Dune::FieldVector< Scalar, numEq >	VectorBlockType

typedef Dune::BlockVector< VectorBlockType >	BVector

typedef BlackOilPolymerModule< TypeTag >	PolymerModule

typedef BlackOilMICPModule< TypeTag >	MICPModule

using	RateConverterType = RateConverter::SurfaceToReservoirVoidage< FluidSystem, std::vector< int > >

using	AverageRegionalPressureType = RegionAverageCalculator::AverageRegionalPressure< FluidSystem, std::vector< int > >

using	Domain = SubDomain< Grid >

using	WellInterfacePtr = std::shared_ptr< WellInterface< TypeTag > >

using	PressureMatrix = Dune::BCRSMatrix< Opm::MatrixBlock< Scalar, 1, 1 > >

Public Member Functions
	BlackoilWellModel (Simulator &simulator)

void	init ()

void	initWellContainer (const int reportStepIdx) override

unsigned	numDofs () const override

void	addNeighbors (std::vector< NeighborSet > &neighbors) const override

void	applyInitial () override

void	linearize (SparseMatrixAdapter &jacobian, GlobalEqVector &res) override

void	linearizeDomain (const Domain &domain, SparseMatrixAdapter &jacobian, GlobalEqVector &res)

void	postSolve (GlobalEqVector &deltaX) override

void	postSolveDomain (GlobalEqVector &deltaX, const Domain &domain)

template<class Restarter >
void	deserialize (Restarter &)

template<class Restarter >
void	serialize (Restarter &)
	This method writes the complete state of the well to the harddisk. More...

void	beginEpisode ()

void	beginTimeStep ()

void	beginIteration ()

void	endIteration ()

void	endTimeStep ()

void	endEpisode ()

void	computeTotalRatesForDof (RateVector &rate, unsigned globalIdx) const

template<class Context >
void	computeTotalRatesForDof (RateVector &rate, const Context &context, unsigned spaceIdx, unsigned timeIdx) const

void	initFromRestartFile (const RestartValue &restartValues)

void	prepareDeserialize (const int report_step)

data::Wells	wellData () const

data::WellBlockAveragePressures	wellBlockAveragePressures () const

void	apply (BVector &r) const

void	apply (const BVector &x, BVector &Ax) const

void	getWellContributions (WellContributions &x) const

void	applyScaleAdd (const Scalar alpha, const BVector &x, BVector &Ax) const

ConvergenceReport	getWellConvergence (const std::vector< Scalar > &B_avg, const bool checkWellGroupControls=false) const

ConvergenceReport	getDomainWellConvergence (const Domain &domain, const std::vector< Scalar > &B_avg, DeferredLogger &local_deferredLogger) const

const SimulatorReportSingle &	lastReport () const

void	addWellContributions (SparseMatrixAdapter &jacobian) const

void	addReservoirSourceTerms (GlobalEqVector &residual, std::vector< typename SparseMatrixAdapter::MatrixBlock * > &diagMatAddress) const

void	beginReportStep (const int time_step)

void	calculateExplicitQuantities (DeferredLogger &deferred_logger) const

void	prepareTimeStep (DeferredLogger &deferred_logger)

void	initPrimaryVariablesEvaluation () const

void	initPrimaryVariablesEvaluationDomain (const Domain &domain) const

std::pair< bool, bool >	updateWellControls (const bool mandatory_network_balance, DeferredLogger &deferred_logger, const bool relax_network_tolerance=false)

void	updateAndCommunicate (const int reportStepIdx, const int iterationIdx, DeferredLogger &deferred_logger)

bool	updateGroupControls (const Group &group, DeferredLogger &deferred_logger, const int reportStepIdx, const int iterationIdx)

WellInterfacePtr	getWell (const std::string &well_name) const

bool	hasWell (const std::string &well_name) const

void	addWellPressureEquations (PressureMatrix &jacobian, const BVector &weights, const bool use_well_weights) const

void	addWellPressureEquationsStruct (PressureMatrix &jacobian) const

void	initGliftEclWellMap (GLiftEclWells &ecl_well_map)

const std::vector< WellInterfacePtr > &	localNonshutWells () const
	Get list of local nonshut wells. More...

void	assembleDomain (const int iterationIdx, const double dt, const Domain &domain)

void	updateWellControlsDomain (DeferredLogger &deferred_logger, const Domain &domain)

void	logPrimaryVars () const

std::vector< Scalar >	getPrimaryVarsDomain (const Domain &domain) const

void	setPrimaryVarsDomain (const Domain &domain, const std::vector< Scalar > &vars)

void	setupDomains (const std::vector< Domain > &domains)

int	numLocalWells () const

int	numLocalWellsEnd () const

int	numLocalNonshutWells () const

int	numPhases () const

bool	wellsActive () const
	return true if wells are available in the reservoir More...

bool	networkActive () const
	return true if network is active (at least one network well in prediction mode) More...

bool	anyMSWellOpenLocal () const

const Well &	getWellEcl (const std::string &well_name) const

std::vector< Well >	getLocalWells (const int timeStepIdx) const

const Schedule &	schedule () const

const PhaseUsage &	phaseUsage () const

const GroupState< GetPropType< TypeTag, Properties::Scalar > > &	groupState () const

GroupState< GetPropType< TypeTag, Properties::Scalar > > &	groupState ()

std::vector< const WellInterfaceGeneric * >	genericWells () const

const WellState< GetPropType< TypeTag, Properties::Scalar > > &	wellState () const

WellState< GetPropType< TypeTag, Properties::Scalar > > &	wellState ()

const WellState< GetPropType< TypeTag, Properties::Scalar > > &	nupcolWellState () const

WellTestState &	wellTestState ()

const WellTestState &	wellTestState () const

GetPropType< TypeTag, Properties::Scalar >	wellPI (const int well_index) const

GetPropType< TypeTag, Properties::Scalar >	wellPI (const std::string &well_name) const

void	updateEclWells (const int timeStepIdx, const SimulatorUpdate &sim_update, const SummaryState &st)

void	initFromRestartFile (const RestartValue &restartValues, WellTestState wtestState, const std::size_t numCells, bool handle_ms_well)

void	prepareDeserialize (int report_step, const std::size_t numCells, bool handle_ms_well)

void	commitWGState ()

data::GroupAndNetworkValues	groupAndNetworkData (const int reportStepIdx) const

bool	hasTHPConstraints () const
	Return true if any well has a THP constraint. More...

void	updateNetworkActiveState (const int report_step)
	Checks if network is active (at least one network well on prediction). More...

bool	needPreStepNetworkRebalance (const int report_step) const

bool	forceShutWellByName (const std::string &wellname, const double simulation_time)

const std::vector< PerforationData > &	perfData (const int well_idx) const

const Parallel::Communication &	comm () const

const EclipseState &	eclipseState () const

const SummaryState &	summaryState () const

const GuideRate &	guideRate () const

bool	reportStepStarts () const

bool	shouldBalanceNetwork (const int reportStepIndex, const int iterationIdx) const

void	updateClosedWellsThisStep (const std::string &well_name) const

bool	wasDynamicallyShutThisTimeStep (const std::string &well_name) const

void	serializeOp (Serializer &serializer)

bool	operator== (const BlackoilWellModelGeneric &rhs) const

Static Public Attributes
static constexpr std::size_t	pressureVarIndex = GetPropType<TypeTag, Properties::Indices>::pressureSwitchIdx

static const int	numEq = Indices::numEq

static const int	solventSaturationIdx = Indices::solventSaturationIdx

static constexpr bool	has_solvent_ = getPropValue<TypeTag, Properties::EnableSolvent>()

static constexpr bool	has_polymer_ = getPropValue<TypeTag, Properties::EnablePolymer>()

static constexpr bool	has_energy_ = getPropValue<TypeTag, Properties::EnableEnergy>()

static constexpr bool	has_micp_ = getPropValue<TypeTag, Properties::EnableMICP>()

Protected Types
using	WellTracerRates = std::map< std::pair< std::string, std::string >, GetPropType< TypeTag, Properties::Scalar > >

Protected Member Functions
void	initializeWellState (const int timeStepIdx)

void	createWellContainer (const int report_step) override

WellInterfacePtr	createWellPointer (const int wellID, const int report_step) const

template<typename WellType >
std::unique_ptr< WellType >	createTypedWellPointer (const int wellID, const int time_step) const

WellInterfacePtr	createWellForWellTest (const std::string &well_name, const int report_step, DeferredLogger &deferred_logger) const

void	doPreStepNetworkRebalance (DeferredLogger &deferred_logger)

const Grid &	grid () const

const EquilGrid &	equilGrid () const

const EclipseState &	eclState () const

void	assemble (const int iterationIdx, const double dt)

std::pair< bool, bool >	updateWellControlsAndNetworkIteration (const bool mandatory_network_balance, const bool relax_network_tolerance, const double dt, DeferredLogger &local_deferredLogger)

bool	updateWellControlsAndNetwork (const bool mandatory_network_balance, const double dt, DeferredLogger &local_deferredLogger)

void	initializeLocalWellStructure (const int reportStepIdx, const bool enableWellPIScaling)

void	initializeGroupStructure (const int reportStepIdx)

void	timeStepSucceeded (const double simulationTime, const double dt)

void	endReportStep ()

void	recoverWellSolutionAndUpdateWellState (const BVector &x)

void	recoverWellSolutionAndUpdateWellStateDomain (const BVector &x, const Domain &domain)

void	updatePrimaryVariables (DeferredLogger &deferred_logger)

void	initializeWBPCalculationService ()

data::WellBlockAveragePressures	computeWellBlockAveragePressures () const

ParallelWBPCalculation::EvaluatorFactory	makeWellSourceEvaluatorFactory (const std::vector< Well >::size_type wellIdx) const

void	registerOpenWellsForWBPCalculation ()

void	updateAverageFormationFactor ()

void	computePotentials (const std::size_t widx, const WellState< Scalar > &well_state_copy, std::string &exc_msg, ExceptionType::ExcEnum &exc_type, DeferredLogger &deferred_logger) override

const std::vector< Scalar > &	wellPerfEfficiencyFactors () const

void	calculateProductivityIndexValuesShutWells (const int reportStepIdx, DeferredLogger &deferred_logger) override

void	calculateProductivityIndexValues (DeferredLogger &deferred_logger) override

void	calculateProductivityIndexValues (const WellInterface< TypeTag > *wellPtr, DeferredLogger &deferred_logger)

int	numComponents () const

int	reportStepIndex () const

void	assembleWellEq (const double dt, DeferredLogger &deferred_logger)

void	assembleWellEqDomain (const double dt, const Domain &domain, DeferredLogger &deferred_logger)

void	prepareWellsBeforeAssembling (const double dt, DeferredLogger &deferred_logger)

void	assembleWellEqWithoutIteration (const double dt, DeferredLogger &deferred_logger)

bool	maybeDoGasLiftOptimize (DeferredLogger &deferred_logger)

void	gasLiftOptimizationStage1 (DeferredLogger &deferred_logger, GLiftProdWells &prod_wells, GLiftOptWells &glift_wells, GasLiftGroupInfo &group_info, GLiftWellStateMap &state_map)

void	gasLiftOptimizationStage1SingleWell (WellInterface< TypeTag > *well, DeferredLogger &deferred_logger, GLiftProdWells &prod_wells, GLiftOptWells &glift_wells, GasLiftGroupInfo &group_info, GLiftWellStateMap &state_map, GLiftSyncGroups &groups_to_sync)

void	extractLegacyCellPvtRegionIndex_ ()

void	extractLegacyDepth_ ()

void	updateWellTestState (const double &simulationTime, WellTestState &wellTestState) const
	upate the wellTestState related to economic limits More...

void	wellTesting (const int timeStepIdx, const double simulationTime, DeferredLogger &deferred_logger)

void	calcRates (const int fipnum, const int pvtreg, const std::vector< Scalar > &production_rates, std::vector< Scalar > &resv_coeff) override

void	calcInjRates (const int fipnum, const int pvtreg, std::vector< Scalar > &resv_coeff) override

void	computeWellTemperature ()

int	compressedIndexForInterior (int cartesian_cell_idx) const override
	get compressed index for interior cells (-1, otherwise More...

void	commitWGState (WGState< GetPropType< TypeTag, Properties::Scalar > > wgstate)

bool	wasDynamicallyShutThisTimeStep (const int well_index) const

const WellState< GetPropType< TypeTag, Properties::Scalar > > &	prevWellState () const

const WGState< GetPropType< TypeTag, Properties::Scalar > > &	prevWGState () const

void	resetWGState ()

void	updateNupcolWGState ()

std::vector< std::reference_wrapper< ParallelWellInfo > >	createLocalParallelWellInfo (const std::vector< Well > &wells)
	Create the parallel well information. More...

void	initializeWellProdIndCalculators ()

void	initializeWellPerfData ()

GetPropType< TypeTag, Properties::Scalar >	updateNetworkPressures (const int reportStepIdx)

void	updateWsolvent (const Group &group, const int reportStepIdx, const WellState< GetPropType< TypeTag, Properties::Scalar > > &wellState)

void	setWsolvent (const Group &group, const int reportStepIdx, GetPropType< TypeTag, Properties::Scalar > wsolvent)

void	assignShutConnections (data::Wells &wsrpt, const int reportStepIndex) const

void	assignGroupControl (const Group &group, data::GroupData &gdata) const

void	assignGroupValues (const int reportStepIdx, std::map< std::string, data::GroupData > &gvalues) const

void	assignNodeValues (std::map< std::string, data::NodeData > &nodevalues, const int reportStepIdx) const

void	calculateEfficiencyFactors (const int reportStepIdx)

void	checkGconsaleLimits (const Group &group, WellState< GetPropType< TypeTag, Properties::Scalar > > &well_state, const int reportStepIdx, DeferredLogger &deferred_logger)

void	checkGEconLimits (const Group &group, const double simulation_time, const int report_step_idx, DeferredLogger &deferred_logger)

bool	checkGroupHigherConstraints (const Group &group, DeferredLogger &deferred_logger, const int reportStepIdx)

void	updateAndCommunicateGroupData (const int reportStepIdx, const int iterationIdx)

void	inferLocalShutWells ()

void	setRepRadiusPerfLength ()

void	gliftDebug (const std::string &msg, DeferredLogger &deferred_logger) const

void	gliftDebugShowALQ (DeferredLogger &deferred_logger)

void	gasLiftOptimizationStage2 (DeferredLogger &deferred_logger, GLiftProdWells &prod_wells, GLiftOptWells &glift_wells, GasLiftGroupInfo &group_info, GLiftWellStateMap &map, const int episodeIndex)

void	updateWellPotentials (const int reportStepIdx, const bool onlyAfterEvent, const SummaryConfig &summaryConfig, DeferredLogger &deferred_logger)

void	initInjMult ()

void	updateInjMult (DeferredLogger &deferred_logger)

void	updateInjFCMult (DeferredLogger &deferred_logger)

void	updateFiltrationParticleVolume (const double dt, const std::size_t water_index)

void	runWellPIScaling (const int reportStepIdx, DeferredLogger &local_deferredLogger)

std::vector< int >	getCellsForConnections (const Well &well) const

std::vector< std::vector< int > >	getMaxWellConnections () const

std::vector< std::string >	getWellsForTesting (const int timeStepIdx, const double simulationTime)

void	assignWellTracerRates (data::Wells &wsrpt, const WellTracerRates &wellTracerRates) const

Protected Attributes
Simulator &	simulator_

std::vector< WellInterfacePtr >	well_container_ {}

std::vector< bool >	is_cell_perforated_ {}

const ModelParameters	param_

std::size_t	global_num_cells_ {}

std::size_t	local_num_cells_ {}

Scalar	gravity_ {}

std::vector< Scalar >	depth_ {}

bool	alternative_well_rate_init_ {}

std::unique_ptr< RateConverterType >	rateConverter_ {}

std::map< std::string, std::unique_ptr< AverageRegionalPressureType > >	regionalAveragePressureCalculator_ {}

std::vector< WBPCalcID >	wbpCalcMap_ {}

SimulatorReportSingle	last_report_ {}

BVector	scaleAddRes_ {}

std::vector< Scalar >	B_avg_ {}

std::map< std::string, int >	well_domain_

Schedule &	schedule_

const SummaryState &	summaryState_

const EclipseState &	eclState_

const Parallel::Communication &	comm_

PhaseUsage	phase_usage_

bool	terminal_output_

bool	wells_active_

bool	network_active_

bool	initial_step_

bool	report_step_starts_

std::optional< int >	last_run_wellpi_

std::vector< Well >	wells_ecl_

std::vector< std::vector< PerforationData > >	well_perf_data_

std::vector< ConnectionIndexMap >	conn_idx_map_

std::function< bool(const Well &)>	not_on_process_

std::vector< WellInterfaceGeneric * >	well_container_generic_

std::vector< int >	local_shut_wells_

std::vector< ParallelWellInfo >	parallel_well_info_

std::vector< std::reference_wrapper< ParallelWellInfo > >	local_parallel_well_info_

std::vector< WellProdIndexCalculator >	prod_index_calc_

ParallelWBPCalculation	wbpCalculationService_

std::vector< int >	pvt_region_idx_

std::unordered_set< std::string >	closed_this_step_

GuideRate	guideRate_

std::unique_ptr< VFPProperties >	vfp_properties_

std::map< std::string, GetPropType< TypeTag, Properties::Scalar > >	node_pressures_

std::unordered_map< std::string, std::vector< GetPropType< TypeTag, Properties::Scalar > > >	prev_inj_multipliers_

std::unordered_map< std::string, WellFilterCake< GetPropType< TypeTag, Properties::Scalar > > >	filter_cake_

WGState< GetPropType< TypeTag, Properties::Scalar > >	active_wgstate_

WGState< GetPropType< TypeTag, Properties::Scalar > >	last_valid_wgstate_

WGState< GetPropType< TypeTag, Properties::Scalar > >	nupcol_wgstate_

bool	glift_debug

double	last_glift_opt_time_

bool	wellStructureChangedDynamically_

std::map< std::string, std::string >	switched_prod_groups_

std::map< std::pair< std::string, Phase >, std::string >	switched_inj_groups_

std::map< std::string, std::pair< std::string, std::string > >	closed_offending_wells_

Detailed Description

template<typename TypeTag>
class Opm::BlackoilWellModel< TypeTag >

Class for handling the blackoil well model.

Member Typedef Documentation

◆ AverageRegionalPressureType

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::AverageRegionalPressureType = RegionAverageCalculator:: AverageRegionalPressure<FluidSystem, std::vector<int> >

◆ BVector

template<typename TypeTag >

typedef Dune::BlockVector<VectorBlockType> Opm::BlackoilWellModel< TypeTag >::BVector

◆ Domain

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::Domain = SubDomain<Grid>

◆ ElementContext

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::ElementContext = GetPropType<TypeTag, Properties::ElementContext>

◆ EquilGrid

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::EquilGrid = GetPropType<TypeTag, Properties::EquilGrid>

◆ FluidSystem

template<typename TypeTag >

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

◆ GasLiftSingleWell

template<typename TypeTag >

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

◆ GLiftEclWells

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::GLiftEclWells = typename GasLiftGroupInfo::GLiftEclWells

◆ GLiftOptWells

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::GLiftOptWells = typename BlackoilWellModelGeneric<Scalar>::GLiftOptWells

◆ GLiftProdWells

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::GLiftProdWells = typename BlackoilWellModelGeneric<Scalar>::GLiftProdWells

◆ GLiftSyncGroups

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::GLiftSyncGroups = typename GasLiftSingleWellGeneric::GLiftSyncGroups

◆ GLiftWellStateMap

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::GLiftWellStateMap = typename BlackoilWellModelGeneric<Scalar>::GLiftWellStateMap

◆ GlobalEqVector

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::GlobalEqVector = GetPropType<TypeTag, Properties::GlobalEqVector>

◆ Grid

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::Grid = GetPropType<TypeTag, Properties::Grid>

◆ Indices

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::Indices = GetPropType<TypeTag, Properties::Indices>

◆ MICPModule

template<typename TypeTag >

typedef BlackOilMICPModule<TypeTag> Opm::BlackoilWellModel< TypeTag >::MICPModule

◆ ModelParameters

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::ModelParameters = BlackoilModelParameters<TypeTag>

◆ NeighborSet

template<typename TypeTag >

typedef BaseAuxiliaryModule<TypeTag>::NeighborSet Opm::BlackoilWellModel< TypeTag >::NeighborSet

◆ PolymerModule

template<typename TypeTag >

typedef BlackOilPolymerModule<TypeTag> Opm::BlackoilWellModel< TypeTag >::PolymerModule

◆ PressureMatrix

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::PressureMatrix = Dune::BCRSMatrix<Opm::MatrixBlock<Scalar, 1, 1> >

◆ RateConverterType

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::RateConverterType = RateConverter:: SurfaceToReservoirVoidage<FluidSystem, std::vector<int> >

◆ RateVector

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::RateVector = GetPropType<TypeTag, Properties::RateVector>

◆ Scalar

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::Scalar = GetPropType<TypeTag, Properties::Scalar>

◆ Simulator

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::Simulator = GetPropType<TypeTag, Properties::Simulator>

◆ SparseMatrixAdapter

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::SparseMatrixAdapter = GetPropType<TypeTag, Properties::SparseMatrixAdapter>

◆ VectorBlockType

template<typename TypeTag >

typedef Dune::FieldVector<Scalar, numEq > Opm::BlackoilWellModel< TypeTag >::VectorBlockType

◆ WellInterfacePtr

template<typename TypeTag >

using Opm::BlackoilWellModel< TypeTag >::WellInterfacePtr = std::shared_ptr<WellInterface<TypeTag> >

◆ WellTracerRates

using Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::WellTracerRates = std::map<std::pair<std::string, std::string>, GetPropType< TypeTag, Properties::Scalar > >

protectedinherited

Constructor & Destructor Documentation

◆ BlackoilWellModel()

template<typename TypeTag >

Opm::BlackoilWellModel< TypeTag >::BlackoilWellModel ( Simulator & simulator )

Member Function Documentation

◆ addNeighbors()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::addNeighbors ( std::vector< NeighborSet > & neighbors ) const

override

◆ addReservoirSourceTerms()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::addReservoirSourceTerms	(	GlobalEqVector &	residual,
		std::vector< typename SparseMatrixAdapter::MatrixBlock * > &	diagMatAddress
	)		const

◆ addWellContributions()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::addWellContributions ( SparseMatrixAdapter & jacobian ) const

◆ addWellPressureEquations()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::addWellPressureEquations	(	PressureMatrix &	jacobian,
		const BVector &	weights,
		const bool	use_well_weights
	)		const

◆ addWellPressureEquationsStruct()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::addWellPressureEquationsStruct ( PressureMatrix & jacobian ) const

◆ anyMSWellOpenLocal()

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::anyMSWellOpenLocal ( ) const

inherited

◆ apply() [1/2]

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::apply ( BVector & r ) const

◆ apply() [2/2]

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::apply	(	const BVector &	x,
		BVector &	Ax
	)		const

◆ applyInitial()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::applyInitial ( )

inlineoverride

◆ applyScaleAdd()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::applyScaleAdd	(	const Scalar	alpha,
		const BVector &	x,
		BVector &	Ax
	)		const

◆ assemble()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::assemble	(	const int	iterationIdx,
		const double	dt
	)

protected

References OPM_BEGIN_PARALLEL_TRY_CATCH, and OPM_END_PARALLEL_TRY_CATCH_LOG.

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

◆ assembleDomain()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::assembleDomain	(	const int	iterationIdx,
		const double	dt,
		const Domain &	domain
	)

References Opm::DeferredLogger::logMessages().

◆ assembleWellEq()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::assembleWellEq	(	const double	dt,
		DeferredLogger &	deferred_logger
	)

protected

◆ assembleWellEqDomain()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::assembleWellEqDomain	(	const double	dt,
		const Domain &	domain,
		DeferredLogger &	deferred_logger
	)

protected

References Opm::SubDomain< Grid >::index.

◆ assembleWellEqWithoutIteration()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::assembleWellEqWithoutIteration	(	const double	dt,
		DeferredLogger &	deferred_logger
	)

protected

References OPM_BEGIN_PARALLEL_TRY_CATCH, and OPM_END_PARALLEL_TRY_CATCH_LOG.

◆ assignGroupControl()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::assignGroupControl	(	const Group &	group,
		data::GroupData &	gdata
	)		const

protectedinherited

◆ assignGroupValues()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::assignGroupValues	(	const int	reportStepIdx,
		std::map< std::string, data::GroupData > &	gvalues
	)		const

protectedinherited

◆ assignNodeValues()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::assignNodeValues	(	std::map< std::string, data::NodeData > &	nodevalues,
		const int	reportStepIdx
	)		const

protectedinherited

◆ assignShutConnections()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::assignShutConnections	(	data::Wells &	wsrpt,
		const int	reportStepIndex
	)		const

protectedinherited

◆ assignWellTracerRates()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::assignWellTracerRates	(	data::Wells &	wsrpt,
		const WellTracerRates &	wellTracerRates
	)		const

protectedinherited

◆ beginEpisode()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::beginEpisode ( )

inline

References Opm::BlackoilWellModel< TypeTag >::beginReportStep(), and Opm::BlackoilWellModel< TypeTag >::simulator_.

◆ beginIteration()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::beginIteration ( )

inline

References Opm::BlackoilWellModel< TypeTag >::assemble(), Opm::BlackoilWellModel< TypeTag >::beginIteration(), and Opm::BlackoilWellModel< TypeTag >::simulator_.

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

◆ beginReportStep()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::beginReportStep ( const int time_step )

References OPM_BEGIN_PARALLEL_TRY_CATCH, and OPM_END_PARALLEL_TRY_CATCH_LOG.

Referenced by Opm::BlackoilWellModel< TypeTag >::beginEpisode(), and Opm::SimulatorFullyImplicitBlackoil< TypeTag >::runStep().

◆ beginTimeStep()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::beginTimeStep

References logAndCheckForExceptionsAndThrow(), Opm::ExceptionType::NONE, OPM_BEGIN_PARALLEL_TRY_CATCH, OPM_END_PARALLEL_TRY_CATCH_LOG, OPM_PARALLEL_CATCH_CLAUSE, Opm::WellGroupHelpers< Scalar >::updateGpMaintTargetForGroups(), Opm::WellGroupHelpers< Scalar >::updateGuideRates(), and Opm::DeferredLogger::warning().

◆ calcInjRates()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::calcInjRates	(	const int	fipnum,
		const int	pvtreg,
		std::vector< Scalar > &	resv_coeff
	)

overrideprotectedvirtual

Implements Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >.

◆ calcRates()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::calcRates	(	const int	fipnum,
		const int	pvtreg,
		const std::vector< Scalar > &	production_rates,
		std::vector< Scalar > &	resv_coeff
	)

overrideprotectedvirtual

Implements Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >.

◆ calculateEfficiencyFactors()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::calculateEfficiencyFactors ( const int reportStepIdx )

protectedinherited

◆ calculateExplicitQuantities()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::calculateExplicitQuantities ( DeferredLogger & deferred_logger ) const

Calculating the explict quantities used in the well calculation. By explicit, we mean they are cacluated at the beginning of the time step and no derivatives are included in these quantities

◆ calculateProductivityIndexValues() [1/2]

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::calculateProductivityIndexValues	(	const WellInterface< TypeTag > *	wellPtr,
		DeferredLogger &	deferred_logger
	)

protected

References Opm::WellInterfaceGeneric::indexOfWell(), and Opm::WellInterface< TypeTag >::updateProductivityIndex().

◆ calculateProductivityIndexValues() [2/2]

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::calculateProductivityIndexValues ( DeferredLogger & deferred_logger )

overrideprotectedvirtual

Implements Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >.

◆ calculateProductivityIndexValuesShutWells()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::calculateProductivityIndexValuesShutWells	(	const int	reportStepIdx,
		DeferredLogger &	deferred_logger
	)

overrideprotectedvirtual

Implements Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >.

References Opm::StandardWell< TypeTag >::init().

◆ checkGconsaleLimits()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::checkGconsaleLimits	(	const Group &	group,
		WellState< GetPropType< TypeTag, Properties::Scalar > > &	well_state,
		const int	reportStepIdx,
		DeferredLogger &	deferred_logger
	)

protectedinherited

◆ checkGEconLimits()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::checkGEconLimits	(	const Group &	group,
		const double	simulation_time,
		const int	report_step_idx,
		DeferredLogger &	deferred_logger
	)

protectedinherited

◆ checkGroupHigherConstraints()

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::checkGroupHigherConstraints	(	const Group &	group,
		DeferredLogger &	deferred_logger,
		const int	reportStepIdx
	)

protectedinherited

◆ comm()

const Parallel::Communication & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::comm ( ) const

inlineinherited

◆ commitWGState() [1/2]

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::commitWGState ( )

inlineinherited

◆ commitWGState() [2/2]

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::commitWGState ( WGState< GetPropType< TypeTag, Properties::Scalar > > wgstate )

inlineprotectedinherited

◆ compressedIndexForInterior()

template<typename TypeTag >

int Opm::BlackoilWellModel< TypeTag >::compressedIndexForInterior ( int cartesian_cell_idx ) const

inlineoverrideprotectedvirtual

get compressed index for interior cells (-1, otherwise

Implements Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >.

References Opm::BlackoilWellModel< TypeTag >::simulator_.

◆ computePotentials()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::computePotentials	(	const std::size_t	widx,
		const WellState< Scalar > &	well_state_copy,
		std::string &	exc_msg,
		ExceptionType::ExcEnum &	exc_type,
		DeferredLogger &	deferred_logger
	)

overrideprotectedvirtual

Implements Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >.

References Opm::ExceptionType::NONE, and OPM_PARALLEL_CATCH_CLAUSE.

◆ computeTotalRatesForDof() [1/2]

template<typename TypeTag >

template<class Context >

void Opm::BlackoilWellModel< TypeTag >::computeTotalRatesForDof	(	RateVector &	rate,
		const Context &	context,
		unsigned	spaceIdx,
		unsigned	timeIdx
	)		const

◆ computeTotalRatesForDof() [2/2]

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::computeTotalRatesForDof	(	RateVector &	rate,
		unsigned	globalIdx
	)		const

◆ computeWellBlockAveragePressures()

template<typename TypeTag >

data::WellBlockAveragePressures Opm::BlackoilWellModel< TypeTag >::computeWellBlockAveragePressures

protected

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

◆ computeWellTemperature()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::computeWellTemperature

protected

◆ createLocalParallelWellInfo()

std::vector< std::reference_wrapper< ParallelWellInfo > > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::createLocalParallelWellInfo ( const std::vector< Well > & wells )

protectedinherited

Create the parallel well information.

Parameters

localWells The local wells from ECL schedule

◆ createTypedWellPointer()

template<typename TypeTag >

template<typename WellType >

std::unique_ptr< WellType > Opm::BlackoilWellModel< TypeTag >::createTypedWellPointer	(	const int	wellID,
		const int	time_step
	)		const

protected

◆ createWellContainer()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::createWellContainer ( const int report_step )

overrideprotectedvirtual

Implements Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >.

References Opm::DeferredLogger::debug(), Opm::gatherDeferredLogger(), and Opm::DeferredLogger::logMessages().

◆ createWellForWellTest()

template<typename TypeTag >

BlackoilWellModel< TypeTag >::WellInterfacePtr Opm::BlackoilWellModel< TypeTag >::createWellForWellTest	(	const std::string &	well_name,
		const int	report_step,
		DeferredLogger &	deferred_logger
	)		const

protected

References OPM_DEFLOG_THROW.

◆ createWellPointer()

template<typename TypeTag >

BlackoilWellModel< TypeTag >::WellInterfacePtr Opm::BlackoilWellModel< TypeTag >::createWellPointer	(	const int	wellID,
		const int	report_step
	)		const

protected

◆ deserialize()

template<typename TypeTag >

template<class Restarter >

void Opm::BlackoilWellModel< TypeTag >::deserialize ( Restarter & )

inline

◆ doPreStepNetworkRebalance()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::doPreStepNetworkRebalance ( DeferredLogger & deferred_logger )

protected

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

◆ eclipseState()

const EclipseState & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::eclipseState ( ) const

inlineinherited

◆ eclState()

template<typename TypeTag >

const EclipseState & Opm::BlackoilWellModel< TypeTag >::eclState ( ) const

inlineprotected

References Opm::BlackoilWellModel< TypeTag >::simulator_.

◆ endEpisode()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::endEpisode ( )

inline

References Opm::BlackoilWellModel< TypeTag >::endReportStep().

◆ endIteration()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::endIteration ( )

inline

◆ endReportStep()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::endReportStep

protected

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

◆ endTimeStep()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::endTimeStep ( )

inline

References Opm::BlackoilWellModel< TypeTag >::endTimeStep(), Opm::BlackoilWellModel< TypeTag >::simulator_, and Opm::BlackoilWellModel< TypeTag >::timeStepSucceeded().

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

◆ equilGrid()

template<typename TypeTag >

const EquilGrid & Opm::BlackoilWellModel< TypeTag >::equilGrid ( ) const

inlineprotected

References Opm::BlackoilWellModel< TypeTag >::simulator_.

◆ extractLegacyCellPvtRegionIndex_()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::extractLegacyCellPvtRegionIndex_

protected

◆ extractLegacyDepth_()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::extractLegacyDepth_

protected

◆ forceShutWellByName()

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::forceShutWellByName	(	const std::string &	wellname,
		const double	simulation_time
	)

inherited

Shut down any single well Returns true if the well was actually found and shut.

◆ gasLiftOptimizationStage1()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::gasLiftOptimizationStage1	(	DeferredLogger &	deferred_logger,
		GLiftProdWells &	prod_wells,
		GLiftOptWells &	glift_wells,
		GasLiftGroupInfo &	group_info,
		GLiftWellStateMap &	state_map
	)

protected

References Opm::Parallel::MpiSerializer::broadcast(), Opm::GasLiftGroupInfo::getRates(), Opm::GasLiftGroupInfo::hasWell(), and Opm::GasLiftGroupInfo::updateRate().

◆ gasLiftOptimizationStage1SingleWell()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::gasLiftOptimizationStage1SingleWell	(	WellInterface< TypeTag > *	well,
		DeferredLogger &	deferred_logger,
		GLiftProdWells &	prod_wells,
		GLiftOptWells &	glift_wells,
		GasLiftGroupInfo &	group_info,
		GLiftWellStateMap &	state_map,
		GLiftSyncGroups &	groups_to_sync
	)

protected

References Opm::WellInterfaceGeneric::name().

◆ gasLiftOptimizationStage2()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::gasLiftOptimizationStage2	(	DeferredLogger &	deferred_logger,
		GLiftProdWells &	prod_wells,
		GLiftOptWells &	glift_wells,
		GasLiftGroupInfo &	group_info,
		GLiftWellStateMap &	map,
		const int	episodeIndex
	)

protectedinherited

◆ genericWells()

std::vector< const WellInterfaceGeneric * > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::genericWells ( ) const

inlineinherited

◆ getCellsForConnections()

std::vector< int > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::getCellsForConnections ( const Well & well ) const

protectedinherited

◆ getDomainWellConvergence()

template<typename TypeTag >

ConvergenceReport Opm::BlackoilWellModel< TypeTag >::getDomainWellConvergence	(	const Domain &	domain,
		const std::vector< Scalar > &	B_avg,
		DeferredLogger &	local_deferredLogger
	)		const

References Opm::DeferredLogger::debug(), Opm::SubDomain< Grid >::index, Opm::ConvergenceReport::NotANumber, Opm::ConvergenceReport::setWellFailed(), Opm::to_string(), Opm::ConvergenceReport::TooLarge, and Opm::ConvergenceReport::wellFailures().

◆ getLocalWells()

std::vector< Well > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::getLocalWells ( const int timeStepIdx ) const

inherited

◆ getMaxWellConnections()

std::vector< std::vector< int > > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::getMaxWellConnections ( ) const

protectedinherited

◆ getPrimaryVarsDomain()

template<typename TypeTag >

std::vector< typename BlackoilWellModel< TypeTag >::Scalar > Opm::BlackoilWellModel< TypeTag >::getPrimaryVarsDomain ( const Domain & domain ) const

References Opm::SubDomain< Grid >::index.

◆ getWell()

template<typename TypeTag >

BlackoilWellModel< TypeTag >::WellInterfacePtr Opm::BlackoilWellModel< TypeTag >::getWell ( const std::string & well_name ) const

◆ getWellContributions()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::getWellContributions ( WellContributions & x ) const

References Opm::WellContributions::addNumBlocks(), Opm::WellContributions::alloc(), and Opm::WellContributions::setBlockSize().

◆ getWellConvergence()

template<typename TypeTag >

ConvergenceReport Opm::BlackoilWellModel< TypeTag >::getWellConvergence	(	const std::vector< Scalar > &	B_avg,
		const bool	checkWellGroupControls = `false`
	)		const

References Opm::gatherConvergenceReport(), Opm::gatherDeferredLogger(), Opm::DeferredLogger::logMessages(), Opm::ConvergenceReport::NotANumber, Opm::ConvergenceReport::setWellFailed(), Opm::ConvergenceReport::setWellGroupTargetsViolated(), Opm::to_string(), Opm::ConvergenceReport::TooLarge, and Opm::ConvergenceReport::wellFailures().

◆ getWellEcl()

const Well & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::getWellEcl ( const std::string & well_name ) const

inherited

◆ getWellsForTesting()

std::vector< std::string > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::getWellsForTesting	(	const int	timeStepIdx,
		const double	simulationTime
	)

protectedinherited

◆ gliftDebug()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::gliftDebug	(	const std::string &	msg,
		DeferredLogger &	deferred_logger
	)		const

protectedinherited

◆ gliftDebugShowALQ()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::gliftDebugShowALQ ( DeferredLogger & deferred_logger )

protectedinherited

◆ grid()

template<typename TypeTag >

const Grid & Opm::BlackoilWellModel< TypeTag >::grid ( ) const

inlineprotected

References Opm::BlackoilWellModel< TypeTag >::simulator_.

Referenced by Opm::BlackoilWellModel< TypeTag >::initFromRestartFile(), and Opm::BlackoilWellModel< TypeTag >::prepareDeserialize().

◆ groupAndNetworkData()

data::GroupAndNetworkValues Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::groupAndNetworkData ( const int reportStepIdx ) const

inherited

◆ groupState() [1/2]

GroupState< GetPropType< TypeTag, Properties::Scalar > > & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::groupState ( )

inlineinherited

◆ groupState() [2/2]

const GroupState< GetPropType< TypeTag, Properties::Scalar > > & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::groupState ( ) const

inlineinherited

◆ guideRate()

const GuideRate & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::guideRate ( ) const

inlineinherited

◆ hasTHPConstraints()

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::hasTHPConstraints ( ) const

inherited

Return true if any well has a THP constraint.

◆ hasWell()

template<typename TypeTag >

bool Opm::BlackoilWellModel< TypeTag >::hasWell ( const std::string & well_name ) const

◆ inferLocalShutWells()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::inferLocalShutWells ( )

protectedinherited

◆ init()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::init

◆ initFromRestartFile() [1/2]

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::initFromRestartFile ( const RestartValue & restartValues )

inline

References Opm::BlackoilWellModel< TypeTag >::grid(), Opm::BlackoilWellModel< TypeTag >::initFromRestartFile(), Opm::BlackoilWellModel< TypeTag >::param_, Opm::BlackoilWellModel< TypeTag >::simulator_, and Opm::BlackoilModelParameters< TypeTag >::use_multisegment_well_.

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

◆ initFromRestartFile() [2/2]

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::initFromRestartFile	(	const RestartValue &	restartValues,
		WellTestState	wtestState,
		const std::size_t	numCells,
		bool	handle_ms_well
	)

inherited

◆ initGliftEclWellMap()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::initGliftEclWellMap ( GLiftEclWells & ecl_well_map )

◆ initializeGroupStructure()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::initializeGroupStructure ( const int reportStepIdx )

protected

Initialize group control modes/constraints and group solution state.

Parameters

[in] reportStepIdx Report step.

References OPM_BEGIN_PARALLEL_TRY_CATCH, OPM_END_PARALLEL_TRY_CATCH_LOG, Opm::WellGroupHelpers< Scalar >::setCmodeGroup(), and Opm::WellGroupHelpers< Scalar >::setRegionAveragePressureCalculator().

◆ initializeLocalWellStructure()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::initializeLocalWellStructure	(	const int	reportStepIdx,
		const bool	enableWellPIScaling
	)

protected

Update rank's notion of intersecting wells and their associate solution variables.

Parameters

[in]	reportStepIdx	Report step.
[in]	enableWellPIScaling	Whether or not to enable WELPI scaling. Typically enabled (i.e., true) only at the start of a report step.

References OPM_BEGIN_PARALLEL_TRY_CATCH, and OPM_END_PARALLEL_TRY_CATCH_LOG.

◆ initializeWBPCalculationService()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::initializeWBPCalculationService

protected

◆ initializeWellPerfData()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::initializeWellPerfData ( )

protectedinherited

◆ initializeWellProdIndCalculators()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::initializeWellProdIndCalculators ( )

protectedinherited

◆ initializeWellState()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::initializeWellState ( const int timeStepIdx )

protected

References OPM_BEGIN_PARALLEL_TRY_CATCH, and OPM_END_PARALLEL_TRY_CATCH.

◆ initInjMult()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::initInjMult ( )

protectedinherited

◆ initPrimaryVariablesEvaluation()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::initPrimaryVariablesEvaluation

◆ initPrimaryVariablesEvaluationDomain()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::initPrimaryVariablesEvaluationDomain ( const Domain & domain ) const

References Opm::SubDomain< Grid >::index.

◆ initWellContainer()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::initWellContainer ( const int reportStepIdx )

overridevirtual

Implements Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >.

◆ lastReport()

template<typename TypeTag >

const SimulatorReportSingle & Opm::BlackoilWellModel< TypeTag >::lastReport

◆ linearize()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::linearize	(	SparseMatrixAdapter &	jacobian,
		GlobalEqVector &	res
	)

override

References OPM_BEGIN_PARALLEL_TRY_CATCH, and OPM_END_PARALLEL_TRY_CATCH.

◆ linearizeDomain()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::linearizeDomain	(	const Domain &	domain,
		SparseMatrixAdapter &	jacobian,
		GlobalEqVector &	res
	)

References Opm::SubDomain< Grid >::index.

◆ localNonshutWells()

template<typename TypeTag >

const std::vector< WellInterfacePtr > & Opm::BlackoilWellModel< TypeTag >::localNonshutWells ( ) const

inline

Get list of local nonshut wells.

References Opm::BlackoilWellModel< TypeTag >::well_container_.

◆ logPrimaryVars()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::logPrimaryVars

◆ makeWellSourceEvaluatorFactory()

template<typename TypeTag >

ParallelWBPCalculation::EvaluatorFactory Opm::BlackoilWellModel< TypeTag >::makeWellSourceEvaluatorFactory ( const std::vector< Well >::size_type wellIdx ) const

protected

◆ maybeDoGasLiftOptimize()

template<typename TypeTag >

bool Opm::BlackoilWellModel< TypeTag >::maybeDoGasLiftOptimize ( DeferredLogger & deferred_logger )

protected

◆ needPreStepNetworkRebalance()

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::needPreStepNetworkRebalance ( const int report_step ) const

inherited

Checks if there are reasons to perform a pre-step network re-balance. (Currently, the only reasons are network well status changes.) (TODO: Consider if adding network change events would be helpful.)

◆ networkActive()

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::networkActive ( ) const

inherited

return true if network is active (at least one network well in prediction mode)

◆ numComponents()

template<typename TypeTag >

int Opm::BlackoilWellModel< TypeTag >::numComponents

protected

◆ numDofs()

template<typename TypeTag >

unsigned Opm::BlackoilWellModel< TypeTag >::numDofs ( ) const

inlineoverride

◆ numLocalNonshutWells()

int Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::numLocalNonshutWells ( ) const

inherited

◆ numLocalWells()

int Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::numLocalWells ( ) const

inherited

◆ numLocalWellsEnd()

int Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::numLocalWellsEnd ( ) const

inherited

◆ numPhases()

int Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::numPhases ( ) const

inherited

◆ nupcolWellState()

const WellState< GetPropType< TypeTag, Properties::Scalar > > & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::nupcolWellState ( ) const

inlineinherited

◆ operator==()

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::operator== ( const BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > > & rhs ) const

inlineinherited

◆ perfData()

const std::vector< PerforationData > & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::perfData ( const int well_idx ) const

inlineinherited

◆ phaseUsage()

const PhaseUsage & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::phaseUsage ( ) const

inlineinherited

◆ postSolve()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::postSolve ( GlobalEqVector & deltaX )

inlineoverride

References Opm::BlackoilWellModel< TypeTag >::recoverWellSolutionAndUpdateWellState().

◆ postSolveDomain()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::postSolveDomain	(	GlobalEqVector &	deltaX,
		const Domain &	domain
	)

inline

References Opm::BlackoilWellModel< TypeTag >::recoverWellSolutionAndUpdateWellStateDomain().

◆ prepareDeserialize() [1/2]

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::prepareDeserialize ( const int report_step )

inline

References Opm::BlackoilWellModel< TypeTag >::grid(), Opm::BlackoilWellModel< TypeTag >::param_, Opm::BlackoilWellModel< TypeTag >::prepareDeserialize(), and Opm::BlackoilModelParameters< TypeTag >::use_multisegment_well_.

Referenced by Opm::BlackoilWellModel< TypeTag >::prepareDeserialize(), and Opm::SimulatorFullyImplicitBlackoil< TypeTag >::runStep().

◆ prepareDeserialize() [2/2]

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::prepareDeserialize	(	int	report_step,
		const std::size_t	numCells,
		bool	handle_ms_well
	)

inherited

◆ prepareTimeStep()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::prepareTimeStep ( DeferredLogger & deferred_logger )

References Opm::DeferredLogger::warning().

◆ prepareWellsBeforeAssembling()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::prepareWellsBeforeAssembling	(	const double	dt,
		DeferredLogger &	deferred_logger
	)

protected

◆ prevWellState()

const WellState< GetPropType< TypeTag, Properties::Scalar > > & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::prevWellState ( ) const

inlineprotectedinherited

◆ prevWGState()

const WGState< GetPropType< TypeTag, Properties::Scalar > > & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::prevWGState ( ) const

inlineprotectedinherited

◆ recoverWellSolutionAndUpdateWellState()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::recoverWellSolutionAndUpdateWellState ( const BVector & x )

protected

References OPM_BEGIN_PARALLEL_TRY_CATCH, and OPM_END_PARALLEL_TRY_CATCH_LOG.

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

◆ recoverWellSolutionAndUpdateWellStateDomain()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::recoverWellSolutionAndUpdateWellStateDomain	(	const BVector &	x,
		const Domain &	domain
	)

protected

References Opm::SubDomain< Grid >::index, and Opm::DeferredLogger::logMessages().

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

◆ registerOpenWellsForWBPCalculation()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::registerOpenWellsForWBPCalculation

protected

◆ reportStepIndex()

template<typename TypeTag >

int Opm::BlackoilWellModel< TypeTag >::reportStepIndex

protected

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

◆ reportStepStarts()

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::reportStepStarts ( ) const

inlineinherited

◆ resetWGState()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::resetWGState ( )

inlineprotectedinherited

◆ runWellPIScaling()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::runWellPIScaling	(	const int	reportStepIdx,
		DeferredLogger &	local_deferredLogger
	)

protectedinherited

◆ schedule()

const Schedule & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::schedule ( ) const

inlineinherited

◆ serialize()

template<typename TypeTag >

template<class Restarter >

void Opm::BlackoilWellModel< TypeTag >::serialize ( Restarter & )

inline

This method writes the complete state of the well to the harddisk.

◆ serializeOp()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::serializeOp ( Serializer & serializer )

inlineinherited

◆ setPrimaryVarsDomain()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::setPrimaryVarsDomain	(	const Domain &	domain,
		const std::vector< Scalar > &	vars
	)

References Opm::SubDomain< Grid >::index.

◆ setRepRadiusPerfLength()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::setRepRadiusPerfLength ( )

protectedinherited

◆ setupDomains()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::setupDomains ( const std::vector< Domain > & domains )

References Opm::DeferredLogger::debug(), Opm::gatherDeferredLogger(), OPM_BEGIN_PARALLEL_TRY_CATCH, and OPM_END_PARALLEL_TRY_CATCH.

◆ setWsolvent()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::setWsolvent	(	const Group &	group,
		const int	reportStepIdx,
		GetPropType< TypeTag, Properties::Scalar >	wsolvent
	)

protectedinherited

◆ shouldBalanceNetwork()

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::shouldBalanceNetwork	(	const int	reportStepIndex,
		const int	iterationIdx
	)		const

inherited

◆ summaryState()

const SummaryState & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::summaryState ( ) const

inlineinherited

◆ timeStepSucceeded()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::timeStepSucceeded	(	const double	simulationTime,
		const double	dt
	)

protected

References Opm::gatherDeferredLogger(), Opm::DeferredLogger::info(), Opm::DeferredLogger::logMessages(), and Opm::DeferredLogger::warning().

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

◆ updateAndCommunicate()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::updateAndCommunicate	(	const int	reportStepIdx,
		const int	iterationIdx,
		DeferredLogger &	deferred_logger
	)

References OPM_BEGIN_PARALLEL_TRY_CATCH, and OPM_END_PARALLEL_TRY_CATCH.

◆ updateAndCommunicateGroupData()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::updateAndCommunicateGroupData	(	const int	reportStepIdx,
		const int	iterationIdx
	)

protectedinherited

◆ updateAverageFormationFactor()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::updateAverageFormationFactor

protected

References OPM_BEGIN_PARALLEL_TRY_CATCH, and OPM_END_PARALLEL_TRY_CATCH.

◆ updateClosedWellsThisStep()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::updateClosedWellsThisStep ( const std::string & well_name ) const

inlineinherited

◆ updateEclWells()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::updateEclWells	(	const int	timeStepIdx,
		const SimulatorUpdate &	sim_update,
		const SummaryState &	st
	)

inherited

◆ updateFiltrationParticleVolume()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::updateFiltrationParticleVolume	(	const double	dt,
		const std::size_t	water_index
	)

protectedinherited

◆ updateGroupControls()

template<typename TypeTag >

bool Opm::BlackoilWellModel< TypeTag >::updateGroupControls	(	const Group &	group,
		DeferredLogger &	deferred_logger,
		const int	reportStepIdx,
		const int	iterationIdx
	)

◆ updateInjFCMult()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::updateInjFCMult ( DeferredLogger & deferred_logger )

protectedinherited

◆ updateInjMult()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::updateInjMult ( DeferredLogger & deferred_logger )

protectedinherited

◆ updateNetworkActiveState()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::updateNetworkActiveState ( const int report_step )

inherited

Checks if network is active (at least one network well on prediction).

◆ updateNetworkPressures()

GetPropType< TypeTag, Properties::Scalar > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::updateNetworkPressures ( const int reportStepIdx )

protectedinherited

◆ updateNupcolWGState()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::updateNupcolWGState ( )

inlineprotectedinherited

◆ updatePrimaryVariables()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::updatePrimaryVariables ( DeferredLogger & deferred_logger )

protected

◆ updateWellControls()

template<typename TypeTag >

std::pair< bool, bool > Opm::BlackoilWellModel< TypeTag >::updateWellControls	(	const bool	mandatory_network_balance,
		DeferredLogger &	deferred_logger,
		const bool	relax_network_tolerance = `false`
	)

References OPM_BEGIN_PARALLEL_TRY_CATCH, OPM_END_PARALLEL_TRY_CATCH, and Opm::WellInterface< TypeTag >::updateWellControl().

◆ updateWellControlsAndNetwork()

template<typename TypeTag >

bool Opm::BlackoilWellModel< TypeTag >::updateWellControlsAndNetwork	(	const bool	mandatory_network_balance,
		const double	dt,
		DeferredLogger &	local_deferredLogger
	)

protected

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

◆ updateWellControlsAndNetworkIteration()

template<typename TypeTag >

std::pair< bool, bool > Opm::BlackoilWellModel< TypeTag >::updateWellControlsAndNetworkIteration	(	const bool	mandatory_network_balance,
		const bool	relax_network_tolerance,
		const double	dt,
		DeferredLogger &	local_deferredLogger
	)

protected

References OPM_BEGIN_PARALLEL_TRY_CATCH, OPM_END_PARALLEL_TRY_CATCH_LOG, and Opm::WellGroupHelpers< Scalar >::updateGuideRates().

◆ updateWellControlsDomain()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::updateWellControlsDomain	(	DeferredLogger &	deferred_logger,
		const Domain &	domain
	)

References Opm::SubDomain< Grid >::index, and Opm::WellInterface< TypeTag >::updateWellControl().

◆ updateWellPotentials()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::updateWellPotentials	(	const int	reportStepIdx,
		const bool	onlyAfterEvent,
		const SummaryConfig &	summaryConfig,
		DeferredLogger &	deferred_logger
	)

protectedinherited

◆ updateWellTestState()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::updateWellTestState	(	const double &	simulationTime,
		WellTestState &	wellTestState
	)		const

protected

upate the wellTestState related to economic limits

References Opm::gatherDeferredLogger(), Opm::DeferredLogger::info(), and Opm::DeferredLogger::logMessages().

◆ updateWsolvent()

void Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::updateWsolvent	(	const Group &	group,
		const int	reportStepIdx,
		const WellState< GetPropType< TypeTag, Properties::Scalar > > &	wellState
	)

protectedinherited

◆ wasDynamicallyShutThisTimeStep() [1/2]

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::wasDynamicallyShutThisTimeStep ( const int well_index ) const

protectedinherited

◆ wasDynamicallyShutThisTimeStep() [2/2]

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::wasDynamicallyShutThisTimeStep ( const std::string & well_name ) const

inherited

◆ wellBlockAveragePressures()

template<typename TypeTag >

data::WellBlockAveragePressures Opm::BlackoilWellModel< TypeTag >::wellBlockAveragePressures ( ) const

inline

References Opm::BlackoilWellModel< TypeTag >::computeWellBlockAveragePressures().

◆ wellData()

template<typename TypeTag >

data::Wells Opm::BlackoilWellModel< TypeTag >::wellData ( ) const

inline

References Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::assignShutConnections(), Opm::BlackoilWellModelGuideRates< Scalar >::assignWellGuideRates(), Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::assignWellTracerRates(), Opm::WellState< Scalar >::report(), Opm::BlackoilWellModel< TypeTag >::reportStepIndex(), Opm::BlackoilWellModel< TypeTag >::simulator_, and Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::wellState().

◆ wellPerfEfficiencyFactors()

template<typename TypeTag >

const std::vector< Scalar > & Opm::BlackoilWellModel< TypeTag >::wellPerfEfficiencyFactors ( ) const

protected

◆ wellPI() [1/2]

GetPropType< TypeTag, Properties::Scalar > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::wellPI ( const int well_index ) const

inherited

◆ wellPI() [2/2]

GetPropType< TypeTag, Properties::Scalar > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::wellPI ( const std::string & well_name ) const

inherited

◆ wellsActive()

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::wellsActive ( ) const

inherited

return true if wells are available in the reservoir

◆ wellState() [1/2]

WellState< GetPropType< TypeTag, Properties::Scalar > > & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::wellState ( )

inlineinherited

◆ wellState() [2/2]

const WellState< GetPropType< TypeTag, Properties::Scalar > > & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::wellState ( ) const

inlineinherited

◆ wellTesting()

template<typename TypeTag >

void Opm::BlackoilWellModel< TypeTag >::wellTesting	(	const int	timeStepIdx,
		const double	simulationTime,
		DeferredLogger &	deferred_logger
	)

protected

References Opm::WellGroupHelpers< Scalar >::accumulateGroupEfficiencyFactor(), and Opm::DeferredLogger::warning().

◆ wellTestState() [1/2]

WellTestState & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::wellTestState ( )

inlineinherited

◆ wellTestState() [2/2]

const WellTestState & Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::wellTestState ( ) const

inlineinherited

Member Data Documentation

◆ active_wgstate_

WGState<GetPropType< TypeTag, Properties::Scalar > > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::active_wgstate_

protectedinherited

◆ alternative_well_rate_init_

template<typename TypeTag >

bool Opm::BlackoilWellModel< TypeTag >::alternative_well_rate_init_ {}

protected

◆ B_avg_

template<typename TypeTag >

std::vector<Scalar> Opm::BlackoilWellModel< TypeTag >::B_avg_ {}

protected

◆ closed_offending_wells_

std::map<std::string, std::pair<std::string, std::string> > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::closed_offending_wells_

protectedinherited

◆ closed_this_step_

std::unordered_set<std::string> Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::closed_this_step_

mutableprotectedinherited

◆ comm_

const Parallel::Communication& Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::comm_

protectedinherited

◆ conn_idx_map_

std::vector<ConnectionIndexMap> Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::conn_idx_map_

protectedinherited

◆ depth_

template<typename TypeTag >

std::vector<Scalar> Opm::BlackoilWellModel< TypeTag >::depth_ {}

protected

◆ eclState_

const EclipseState& Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::eclState_

protectedinherited

◆ filter_cake_

std::unordered_map<std::string, WellFilterCake<GetPropType< TypeTag, Properties::Scalar > > > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::filter_cake_

protectedinherited

◆ glift_debug

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::glift_debug

protectedinherited

◆ global_num_cells_

template<typename TypeTag >

std::size_t Opm::BlackoilWellModel< TypeTag >::global_num_cells_ {}

protected

◆ gravity_

template<typename TypeTag >

Scalar Opm::BlackoilWellModel< TypeTag >::gravity_ {}

protected

◆ guideRate_

GuideRate Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::guideRate_

protectedinherited

◆ has_energy_

template<typename TypeTag >

constexpr bool Opm::BlackoilWellModel< TypeTag >::has_energy_ = getPropValue<TypeTag, Properties::EnableEnergy>()

staticconstexpr

◆ has_micp_

template<typename TypeTag >

constexpr bool Opm::BlackoilWellModel< TypeTag >::has_micp_ = getPropValue<TypeTag, Properties::EnableMICP>()

staticconstexpr

◆ has_polymer_

template<typename TypeTag >

constexpr bool Opm::BlackoilWellModel< TypeTag >::has_polymer_ = getPropValue<TypeTag, Properties::EnablePolymer>()

staticconstexpr

◆ has_solvent_

template<typename TypeTag >

constexpr bool Opm::BlackoilWellModel< TypeTag >::has_solvent_ = getPropValue<TypeTag, Properties::EnableSolvent>()

staticconstexpr

◆ initial_step_

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::initial_step_

protectedinherited

◆ is_cell_perforated_

template<typename TypeTag >

std::vector<bool> Opm::BlackoilWellModel< TypeTag >::is_cell_perforated_ {}

protected

◆ last_glift_opt_time_

double Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::last_glift_opt_time_

protectedinherited

◆ last_report_

template<typename TypeTag >

SimulatorReportSingle Opm::BlackoilWellModel< TypeTag >::last_report_ {}

protected

◆ last_run_wellpi_

std::optional<int> Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::last_run_wellpi_

protectedinherited

◆ last_valid_wgstate_

WGState<GetPropType< TypeTag, Properties::Scalar > > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::last_valid_wgstate_

protectedinherited

◆ local_num_cells_

template<typename TypeTag >

std::size_t Opm::BlackoilWellModel< TypeTag >::local_num_cells_ {}

protected

◆ local_parallel_well_info_

std::vector<std::reference_wrapper<ParallelWellInfo> > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::local_parallel_well_info_

protectedinherited

◆ local_shut_wells_

std::vector<int> Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::local_shut_wells_

protectedinherited

◆ network_active_

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::network_active_

protectedinherited

◆ node_pressures_

std::map<std::string, GetPropType< TypeTag, Properties::Scalar > > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::node_pressures_

protectedinherited

◆ not_on_process_

std::function<bool(const Well&)> Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::not_on_process_

protectedinherited

◆ numEq

template<typename TypeTag >

const int Opm::BlackoilWellModel< TypeTag >::numEq = Indices::numEq

static

◆ nupcol_wgstate_

WGState<GetPropType< TypeTag, Properties::Scalar > > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::nupcol_wgstate_

protectedinherited

◆ parallel_well_info_

std::vector<ParallelWellInfo> Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::parallel_well_info_

protectedinherited

◆ param_

template<typename TypeTag >

const ModelParameters Opm::BlackoilWellModel< TypeTag >::param_

protected

Referenced by Opm::BlackoilWellModel< TypeTag >::initFromRestartFile(), and Opm::BlackoilWellModel< TypeTag >::prepareDeserialize().

◆ phase_usage_

PhaseUsage Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::phase_usage_

protectedinherited

◆ pressureVarIndex

template<typename TypeTag >

constexpr std::size_t Opm::BlackoilWellModel< TypeTag >::pressureVarIndex = GetPropType<TypeTag, Properties::Indices>::pressureSwitchIdx

staticconstexpr

◆ prev_inj_multipliers_

std::unordered_map<std::string, std::vector<GetPropType< TypeTag, Properties::Scalar > > > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::prev_inj_multipliers_

protectedinherited

◆ prod_index_calc_

std::vector<WellProdIndexCalculator> Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::prod_index_calc_

protectedinherited

◆ pvt_region_idx_

std::vector<int> Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::pvt_region_idx_

protectedinherited

◆ rateConverter_

template<typename TypeTag >

std::unique_ptr<RateConverterType> Opm::BlackoilWellModel< TypeTag >::rateConverter_ {}

protected

◆ regionalAveragePressureCalculator_

template<typename TypeTag >

std::map<std::string, std::unique_ptr<AverageRegionalPressureType> > Opm::BlackoilWellModel< TypeTag >::regionalAveragePressureCalculator_ {}

protected

◆ report_step_starts_

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::report_step_starts_

protectedinherited

◆ scaleAddRes_

template<typename TypeTag >

BVector Opm::BlackoilWellModel< TypeTag >::scaleAddRes_ {}

mutableprotected

◆ schedule_

Schedule& Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::schedule_

protectedinherited

◆ simulator_

template<typename TypeTag >

Simulator& Opm::BlackoilWellModel< TypeTag >::simulator_

protected

Referenced by Opm::BlackoilWellModel< TypeTag >::beginEpisode(), Opm::BlackoilWellModel< TypeTag >::beginIteration(), Opm::BlackoilWellModel< TypeTag >::compressedIndexForInterior(), Opm::BlackoilWellModel< TypeTag >::eclState(), Opm::BlackoilWellModel< TypeTag >::endTimeStep(), Opm::BlackoilWellModel< TypeTag >::equilGrid(), Opm::BlackoilWellModel< TypeTag >::grid(), Opm::BlackoilWellModel< TypeTag >::initFromRestartFile(), and Opm::BlackoilWellModel< TypeTag >::wellData().

◆ solventSaturationIdx

template<typename TypeTag >

const int Opm::BlackoilWellModel< TypeTag >::solventSaturationIdx = Indices::solventSaturationIdx

static

◆ summaryState_

const SummaryState& Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::summaryState_

protectedinherited

◆ switched_inj_groups_

std::map<std::pair<std::string, Phase>, std::string> Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::switched_inj_groups_

protectedinherited

◆ switched_prod_groups_

std::map<std::string, std::string> Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::switched_prod_groups_

protectedinherited

◆ terminal_output_

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::terminal_output_

protectedinherited

◆ vfp_properties_

std::unique_ptr<VFPProperties> Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::vfp_properties_

protectedinherited

◆ wbpCalcMap_

template<typename TypeTag >

std::vector<WBPCalcID> Opm::BlackoilWellModel< TypeTag >::wbpCalcMap_ {}

protected

◆ wbpCalculationService_

ParallelWBPCalculation Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::wbpCalculationService_

mutableprotectedinherited

◆ well_container_

template<typename TypeTag >

std::vector<WellInterfacePtr> Opm::BlackoilWellModel< TypeTag >::well_container_ {}

protected

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

◆ well_container_generic_

std::vector<WellInterfaceGeneric*> Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::well_container_generic_

protectedinherited

◆ well_domain_

template<typename TypeTag >

std::map<std::string, int> Opm::BlackoilWellModel< TypeTag >::well_domain_

protected

◆ well_perf_data_

std::vector<std::vector<PerforationData> > Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::well_perf_data_

protectedinherited

◆ wells_active_

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::wells_active_

protectedinherited

◆ wells_ecl_

std::vector<Well> Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::wells_ecl_

protectedinherited

◆ wellStructureChangedDynamically_

bool Opm::BlackoilWellModelGeneric< GetPropType< TypeTag, Properties::Scalar > >::wellStructureChangedDynamically_

protectedinherited

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ AverageRegionalPressureType

◆ BVector

◆ Domain

◆ ElementContext

◆ EquilGrid

◆ FluidSystem

◆ GasLiftSingleWell

◆ GLiftEclWells

◆ GLiftOptWells

◆ GLiftProdWells

◆ GLiftSyncGroups

◆ GLiftWellStateMap

◆ GlobalEqVector

◆ Grid

◆ Indices

◆ MICPModule

◆ ModelParameters

◆ NeighborSet

◆ PolymerModule

◆ PressureMatrix

◆ RateConverterType

◆ RateVector

◆ Scalar

◆ Simulator

◆ SparseMatrixAdapter

◆ VectorBlockType

◆ WellInterfacePtr

◆ WellTracerRates

Constructor & Destructor Documentation

◆ BlackoilWellModel()

Member Function Documentation

◆ addNeighbors()

◆ addReservoirSourceTerms()

◆ addWellContributions()

◆ addWellPressureEquations()

◆ addWellPressureEquationsStruct()

◆ anyMSWellOpenLocal()

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyInitial()

◆ applyScaleAdd()

◆ assemble()

◆ assembleDomain()

◆ assembleWellEq()

◆ assembleWellEqDomain()

◆ assembleWellEqWithoutIteration()

◆ assignGroupControl()

◆ assignGroupValues()

◆ assignNodeValues()

◆ assignShutConnections()

◆ assignWellTracerRates()

◆ beginEpisode()

◆ beginIteration()

◆ beginReportStep()

◆ beginTimeStep()

◆ calcInjRates()

◆ calcRates()

◆ calculateEfficiencyFactors()

◆ calculateExplicitQuantities()

◆ calculateProductivityIndexValues() [1/2]

◆ calculateProductivityIndexValues() [2/2]

◆ calculateProductivityIndexValuesShutWells()

◆ checkGconsaleLimits()

◆ checkGEconLimits()

◆ checkGroupHigherConstraints()

◆ comm()

◆ commitWGState() [1/2]

◆ commitWGState() [2/2]

◆ compressedIndexForInterior()

◆ computePotentials()

◆ computeTotalRatesForDof() [1/2]