Opm::BlackoilWellModelGeneric< Scalar > Class Template Reference

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

#include <BlackoilWellModelGeneric.hpp>

Inheritance diagram for Opm::BlackoilWellModelGeneric< Scalar >:

Public Member Functions
	BlackoilWellModelGeneric (Schedule &schedule, BlackoilWellModelGasLiftGeneric< Scalar > &gaslift, const SummaryState &summaryState, const EclipseState &eclState, const PhaseUsage &phase_usage, const Parallel::Communication &comm)
virtual	~BlackoilWellModelGeneric ()=default
virtual int	compressedIndexForInteriorLGR (const std::string &lgr_tag, const Connection &conn) const
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	hasLocalWell (const std::string &wname) const
	Returns true if well is defined and has connections on current rank. More...
bool	hasOpenLocalWell (const std::string &well_name) const
	Returns true if well is defined, open and has connections on current rank. More...
bool	networkActive () const
	return true if network is active (at least one network well in prediction mode) More...
bool	anyMSWellOpenLocal () const
const std::vector< Well > &	eclWells () const
bool	terminalOutput () 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< Scalar > &	groupState () const
std::vector< const WellInterfaceGeneric< Scalar > * >	genericWells () const
std::vector< WellInterfaceGeneric< Scalar > * >	genericWells ()
const WellState< Scalar > &	wellState () const
WellState< Scalar > &	wellState ()
const WellState< Scalar > &	nupcolWellState () const
GroupState< Scalar > &	groupState ()
WellTestState &	wellTestState ()
const WellTestState &	wellTestState () const
Scalar	wellPI (const int well_index) const
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, std::unique_ptr< WellTestState > wtestState, const std::size_t numCells, bool handle_ms_well, bool enable_distributed_wells)
void	prepareDeserialize (int report_step, const std::size_t numCells, bool handle_ms_well, bool enable_distributed_wells)
void	commitWGState ()
data::GroupAndNetworkValues	groupAndNetworkData (const int reportStepIdx) const
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 bool dont_shut_grup_wells)
const std::vector< PerforationData< Scalar > > &	perfData (const int well_idx) const
const Parallel::Communication &	comm () const
const EclipseState &	eclipseState () const
const SummaryState &	summaryState () const
const GuideRate &	guideRate () const
GuideRate &	guideRate ()
const std::map< std::string, double > &	wellOpenTimes () const
const std::map< std::string, double > &	wellCloseTimes () const
const WellGroupEvents &	reportStepStartEvents () const
std::vector< int >	getCellsForConnections (const Well &well) 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	logPrimaryVars () const
template<class Serializer >
void	serializeOp (Serializer &serializer)
bool	operator== (const BlackoilWellModelGeneric &rhs) const
const ParallelWellInfo< Scalar > &	parallelWellInfo (const std::size_t idx) const
bool	isOwner (const std::string &wname) const
const ConnectionIndexMap &	connectionIndexMap (const std::size_t idx)

Protected Types
using	WellTracerRates = std::unordered_map< int, std::vector< WellTracerRate< Scalar > > >
using	MswTracerRates = std::unordered_map< int, std::vector< MSWellTracerRate< Scalar > > >

Protected Member Functions
const WellState< Scalar > &	prevWellState () const
const WGState< Scalar > &	prevWGState () const
void	commitWGState (WGState< Scalar > wgstate)
void	resetWGState ()
void	updateNupcolWGState ()
void	reportGroupSwitching (DeferredLogger &local_deferredLogger) const
std::vector< std::reference_wrapper< ParallelWellInfo< Scalar > > >	createLocalParallelWellInfo (const std::vector< Well > &wells)
	Create the parallel well information. More...
void	initializeWellProdIndCalculators ()
void	initializeWellPerfData ()
bool	wasDynamicallyShutThisTimeStep (const int well_index) const
Scalar	updateNetworkPressures (const int reportStepIdx, const Scalar damping_factor, const Scalar update_upper_bound)
void	updateWsolvent (const Group &group, const int reportStepIdx, const WellState< Scalar > &wellState)
void	setWsolvent (const Group &group, const int reportStepIdx, Scalar wsolvent)
virtual void	calcResvCoeff (const int fipnum, const int pvtreg, const std::vector< Scalar > &production_rates, std::vector< Scalar > &resv_coeff)=0
virtual void	calcInjResvCoeff (const int fipnum, const int pvtreg, std::vector< Scalar > &resv_coeff)=0
void	assignDynamicWellStatus (data::Wells &wsrpt, const int reportStepIdx) const
void	assignShutConnections (data::Wells &wsrpt, const int reportStepIndex) const
void	assignWellTargets (data::Wells &wsrpt) const
void	assignProductionWellTargets (const Well &well, data::WellControlLimits &limits) const
void	assignInjectionWellTargets (const Well &well, data::WellControlLimits &limits) 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< 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, const int max_number_of_group_switch)
void	updateAndCommunicateGroupData (const int reportStepIdx, const int iterationIdx, const Scalar tol_nupcol, const bool update_wellgrouptarget, DeferredLogger &deferred_logger)
void	inferLocalShutWells ()
void	setRepRadiusPerfLength ()
virtual void	computePotentials (const std::size_t widx, const WellState< Scalar > &well_state_copy, std::string &exc_msg, ExceptionType::ExcEnum &exc_type, DeferredLogger &deferred_logger)=0
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	updateFiltrationModelsPostStep (const double dt, const std::size_t water_index, DeferredLogger &deferred_logger)
void	updateFiltrationModelsPreStep (DeferredLogger &deferred_logger)
virtual void	createWellContainer (const int time_step)=0
virtual void	initWellContainer (const int reportStepIdx)=0
virtual void	calculateProductivityIndexValuesShutWells (const int reportStepIdx, DeferredLogger &deferred_logger)=0
virtual void	calculateProductivityIndexValues (DeferredLogger &deferred_logger)=0
void	runWellPIScaling (const int reportStepIdx, DeferredLogger &local_deferredLogger)
virtual int	compressedIndexForInterior (int cartesian_cell_idx) const =0
	get compressed index for interior cells (-1, otherwise More...
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 unsigned reportStep) const
void	assignMswTracerRates (data::Wells &wsrpt, const MswTracerRates &mswTracerRates, const unsigned reportStep) const
void	assignMassGasRate (data::Wells &wsrpt, const Scalar gasDensity) const

Protected Attributes
Schedule &	schedule_
const SummaryState &	summaryState_
const EclipseState &	eclState_
const Parallel::Communication &	comm_
BlackoilWellModelGasLiftGeneric< Scalar > &	gen_gaslift_
BlackoilWellModelWBP< Scalar >	wbp_
PhaseUsage	phase_usage_
bool	terminal_output_ {false}
bool	wells_active_ {false}
bool	network_active_ {false}
bool	initial_step_ {}
bool	report_step_starts_ {}
std::optional< int >	last_run_wellpi_ {}
std::vector< Well >	wells_ecl_
std::vector< std::vector< PerforationData< Scalar > > >	well_perf_data_
std::map< std::string, double >	well_open_times_
std::map< std::string, double >	well_close_times_
std::vector< ConnectionIndexMap >	conn_idx_map_ {}
std::function< bool(const std::string &)>	not_on_process_ {}
std::vector< WellInterfaceGeneric< Scalar > * >	well_container_generic_ {}
std::vector< int >	local_shut_wells_ {}
std::vector< ParallelWellInfo< Scalar > >	parallel_well_info_
std::vector< std::reference_wrapper< ParallelWellInfo< Scalar > > >	local_parallel_well_info_
std::vector< WellProdIndexCalculator< Scalar > >	prod_index_calc_
std::vector< int >	pvt_region_idx_
std::unordered_set< std::string >	closed_this_step_
GuideRate	guideRate_
std::unique_ptr< VFPProperties< Scalar > >	vfp_properties_ {}
std::map< std::string, Scalar >	node_pressures_
std::map< std::string, Scalar >	last_valid_node_pressures_
std::unordered_map< std::string, std::vector< Scalar > >	prev_inj_multipliers_
std::unordered_map< std::string, WellFilterCake< Scalar > >	filter_cake_
WGState< Scalar >	active_wgstate_
WGState< Scalar >	last_valid_wgstate_
WGState< Scalar >	nupcol_wgstate_
WellGroupEvents	report_step_start_events_
	Well group events at start of report step. More...
bool	wellStructureChangedDynamically_ {false}
std::map< std::string, std::vector< Group::ProductionCMode > >	switched_prod_groups_
std::map< std::string, std::array< std::vector< Group::InjectionCMode >, 3 > >	switched_inj_groups_
std::map< std::string, std::pair< std::string, std::string > >	closed_offending_wells_

Detailed Description

template<class Scalar>
class Opm::BlackoilWellModelGeneric< Scalar >

Class for handling the blackoil well model.

Member Typedef Documentation

MswTracerRates

template<class Scalar >

using Opm::BlackoilWellModelGeneric< Scalar >::MswTracerRates = std::unordered_map<int, std::vector<MSWellTracerRate<Scalar> >>

protected

WellTracerRates

template<class Scalar >

using Opm::BlackoilWellModelGeneric< Scalar >::WellTracerRates = std::unordered_map<int, std::vector<WellTracerRate<Scalar> >>

protected

Constructor & Destructor Documentation

BlackoilWellModelGeneric()

template<class Scalar >

Opm::BlackoilWellModelGeneric< Scalar >::BlackoilWellModelGeneric	(	Schedule &	schedule,
		BlackoilWellModelGasLiftGeneric< Scalar > &	gaslift,
		const SummaryState &	summaryState,
		const EclipseState &	eclState,
		const PhaseUsage &	phase_usage,
		const Parallel::Communication &	comm
	)

~BlackoilWellModelGeneric()

template<class Scalar >

virtual Opm::BlackoilWellModelGeneric< Scalar >::~BlackoilWellModelGeneric ( )

virtualdefault

Member Function Documentation

anyMSWellOpenLocal()

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::anyMSWellOpenLocal

(

)

const

assignDynamicWellStatus()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::assignDynamicWellStatus ( data::Wells &  wsrpt, const int  reportStepIdx  ) const

protected

Assign dynamic well status for each well owned by current rank

Parameters

[in,out]	wsrpt	Well solution object. On exit, holds current values for data::Well::dynamicStatus .
[in]	reportStepIdx	Zero-based index of current report step.

assignGroupControl()

template<class Scalar >

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

protected

assignGroupValues()

template<class Scalar >

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

protected

assignInjectionWellTargets()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::assignInjectionWellTargets ( const Well &  well, data::WellControlLimits &  limits  ) const

protected

assignMassGasRate()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::assignMassGasRate ( data::Wells &  wsrpt, const Scalar  gasDensity  ) const

protected

assignMswTracerRates()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::assignMswTracerRates ( data::Wells &  wsrpt, const MswTracerRates &  mswTracerRates, const unsigned  reportStep  ) const

protected

assignNodeValues()

template<class Scalar >

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

protected

assignProductionWellTargets()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::assignProductionWellTargets ( const Well &  well, data::WellControlLimits &  limits  ) const

protected

assignShutConnections()

template<class Scalar >

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

protected

Assign basic result quantities for shut connections of wells owned by current rank.

Mostly provided for summary file output purposes. Applies to fully shut/stopped wells and shut connections of open/flowing wells.

Parameters

[in,out]	wsrpt	Well solution object. On exit, also contains a few quantities, like the D factor, the Kh product and the CTF, for shut connections.
[in]	reportStepIdx	Zero-based index of current report step.

assignWellTargets()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::assignWellTargets ( data::Wells &  wsrpt ) const

protected

assignWellTracerRates()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::assignWellTracerRates ( data::Wells &  wsrpt, const WellTracerRates &  wellTracerRates, const unsigned  reportStep  ) const

protected

calcInjResvCoeff()

template<class Scalar >

virtual void Opm::BlackoilWellModelGeneric< Scalar >::calcInjResvCoeff ( const int  fipnum, const int  pvtreg, std::vector< Scalar > &  resv_coeff  )

protectedpure virtual

calcResvCoeff()

template<class Scalar >

virtual void Opm::BlackoilWellModelGeneric< Scalar >::calcResvCoeff ( const int  fipnum, const int  pvtreg, const std::vector< Scalar > &  production_rates, std::vector< Scalar > &  resv_coeff  )

protectedpure virtual

calculateEfficiencyFactors()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::calculateEfficiencyFactors ( const int  reportStepIdx )

protected

calculateProductivityIndexValues()

template<class Scalar >

virtual void Opm::BlackoilWellModelGeneric< Scalar >::calculateProductivityIndexValues ( DeferredLogger &  deferred_logger )

protectedpure virtual

Implemented in Opm::BlackoilWellModel< TypeTag >.

calculateProductivityIndexValuesShutWells()

template<class Scalar >

virtual void Opm::BlackoilWellModelGeneric< Scalar >::calculateProductivityIndexValuesShutWells ( const int  reportStepIdx, DeferredLogger &  deferred_logger  )

protectedpure virtual

Implemented in Opm::BlackoilWellModel< TypeTag >.

checkGconsaleLimits()

template<class Scalar >

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

protected

checkGEconLimits()

template<class Scalar >

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

protected

checkGroupHigherConstraints()

template<class Scalar >

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

protected

comm()

template<class Scalar >

const Parallel::Communication & Opm::BlackoilWellModelGeneric< Scalar >::comm ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::comm_.

commitWGState() [1/2]

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::commitWGState ( )

inline

References Opm::BlackoilWellModelGeneric< Scalar >::active_wgstate_, Opm::BlackoilWellModelGeneric< Scalar >::last_valid_node_pressures_, Opm::BlackoilWellModelGeneric< Scalar >::last_valid_wgstate_, and Opm::BlackoilWellModelGeneric< Scalar >::node_pressures_.

commitWGState() [2/2]

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::commitWGState ( WGState< Scalar >  wgstate )

inlineprotected

References Opm::BlackoilWellModelGeneric< Scalar >::last_valid_wgstate_.

compressedIndexForInterior()

template<class Scalar >

virtual int Opm::BlackoilWellModelGeneric< Scalar >::compressedIndexForInterior ( int  cartesian_cell_idx ) const

protectedpure virtual

get compressed index for interior cells (-1, otherwise

Implemented in Opm::BlackoilWellModel< TypeTag >.

compressedIndexForInteriorLGR()

template<class Scalar >

virtual int Opm::BlackoilWellModelGeneric< Scalar >::compressedIndexForInteriorLGR ( const std::string &  lgr_tag, const Connection &  conn  ) const

inlinevirtual

Reimplemented in Opm::BlackoilWellModel< TypeTag >.

computePotentials()

template<class Scalar >

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

protectedpure virtual

connectionIndexMap()

template<class Scalar >

const ConnectionIndexMap & Opm::BlackoilWellModelGeneric< Scalar >::connectionIndexMap ( const std::size_t  idx )

inline

References Opm::BlackoilWellModelGeneric< Scalar >::conn_idx_map_.

createLocalParallelWellInfo()

template<class Scalar >

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

protected

Create the parallel well information.

Parameters

localWells

The local wells from ECL schedule

createWellContainer()

template<class Scalar >

virtual void Opm::BlackoilWellModelGeneric< Scalar >::createWellContainer ( const int  time_step )

protectedpure virtual

Implemented in Opm::BlackoilWellModel< TypeTag >.

eclipseState()

template<class Scalar >

const EclipseState & Opm::BlackoilWellModelGeneric< Scalar >::eclipseState ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::eclState_.

eclWells()

template<class Scalar >

const std::vector< Well > & Opm::BlackoilWellModelGeneric< Scalar >::eclWells ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::wells_ecl_.

forceShutWellByName()

template<class Scalar >

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

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

genericWells() [1/2]

template<class Scalar >

std::vector< WellInterfaceGeneric< Scalar > * > Opm::BlackoilWellModelGeneric< Scalar >::genericWells ( )

inline

References Opm::BlackoilWellModelGeneric< Scalar >::well_container_generic_.

genericWells() [2/2]

template<class Scalar >

std::vector< const WellInterfaceGeneric< Scalar > * > Opm::BlackoilWellModelGeneric< Scalar >::genericWells ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::well_container_generic_.

getCellsForConnections()

template<class Scalar >

std::vector< int > Opm::BlackoilWellModelGeneric< Scalar >::getCellsForConnections

(

const Well &

well

)

const

getLocalWells()

template<class Scalar >

std::vector< Well > Opm::BlackoilWellModelGeneric< Scalar >::getLocalWells

(

const int

timeStepIdx

)

const

getMaxWellConnections()

template<class Scalar >

std::vector< std::vector< int > > Opm::BlackoilWellModelGeneric< Scalar >::getMaxWellConnections ( ) const

protected

getWellEcl()

template<class Scalar >

const Well & Opm::BlackoilWellModelGeneric< Scalar >::getWellEcl

(

const std::string &

well_name

)

const

getWellsForTesting()

template<class Scalar >

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

protected

groupAndNetworkData()

template<class Scalar >

data::GroupAndNetworkValues Opm::BlackoilWellModelGeneric< Scalar >::groupAndNetworkData

(

const int

reportStepIdx

)

const

groupState() [1/2]

template<class Scalar >

GroupState< Scalar > & Opm::BlackoilWellModelGeneric< Scalar >::groupState ( )

inline

References Opm::BlackoilWellModelGeneric< Scalar >::active_wgstate_.

groupState() [2/2]

template<class Scalar >

const GroupState< Scalar > & Opm::BlackoilWellModelGeneric< Scalar >::groupState ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::active_wgstate_.

guideRate() [1/2]

template<class Scalar >

GuideRate & Opm::BlackoilWellModelGeneric< Scalar >::guideRate ( )

inline

References Opm::BlackoilWellModelGeneric< Scalar >::guideRate_.

guideRate() [2/2]

template<class Scalar >

const GuideRate & Opm::BlackoilWellModelGeneric< Scalar >::guideRate ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::guideRate_.

hasLocalWell()

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::hasLocalWell

(

const std::string &

wname

)

const

Returns true if well is defined and has connections on current rank.

hasOpenLocalWell()

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::hasOpenLocalWell

(

const std::string &

well_name

)

const

Returns true if well is defined, open and has connections on current rank.

inferLocalShutWells()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::inferLocalShutWells ( )

protected

initFromRestartFile()

template<class Scalar >

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

initializeWellPerfData()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::initializeWellPerfData ( )

protected

initializeWellProdIndCalculators()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::initializeWellProdIndCalculators ( )

protected

initInjMult()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::initInjMult ( )

protected

initWellContainer()

template<class Scalar >

virtual void Opm::BlackoilWellModelGeneric< Scalar >::initWellContainer ( const int  reportStepIdx )

protectedpure virtual

Implemented in Opm::BlackoilWellModel< TypeTag >.

isOwner()

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::isOwner ( const std::string &  wname ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::parallel_well_info_.

logPrimaryVars()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::logPrimaryVars

(

)

const

needPreStepNetworkRebalance()

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::needPreStepNetworkRebalance

(

const int

report_step

)

const

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

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::networkActive

(

)

const

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

numLocalNonshutWells()

template<class Scalar >

int Opm::BlackoilWellModelGeneric< Scalar >::numLocalNonshutWells

(

)

const

numLocalWells()

template<class Scalar >

int Opm::BlackoilWellModelGeneric< Scalar >::numLocalWells

(

)

const

numLocalWellsEnd()

template<class Scalar >

int Opm::BlackoilWellModelGeneric< Scalar >::numLocalWellsEnd

(

)

const

numPhases()

template<class Scalar >

int Opm::BlackoilWellModelGeneric< Scalar >::numPhases

(

)

const

nupcolWellState()

template<class Scalar >

const WellState< Scalar > & Opm::BlackoilWellModelGeneric< Scalar >::nupcolWellState ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::nupcol_wgstate_.

operator==()

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::operator==

(

const BlackoilWellModelGeneric< Scalar > &

rhs

)

const

parallelWellInfo()

template<class Scalar >

const ParallelWellInfo< Scalar > & Opm::BlackoilWellModelGeneric< Scalar >::parallelWellInfo ( const std::size_t  idx ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::local_parallel_well_info_.

perfData()

template<class Scalar >

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

inline

References Opm::BlackoilWellModelGeneric< Scalar >::well_perf_data_.

phaseUsage()

template<class Scalar >

const PhaseUsage & Opm::BlackoilWellModelGeneric< Scalar >::phaseUsage ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::phase_usage_.

prepareDeserialize()

template<class Scalar >

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

prevWellState()

template<class Scalar >

const WellState< Scalar > & Opm::BlackoilWellModelGeneric< Scalar >::prevWellState ( ) const

inlineprotected

References Opm::BlackoilWellModelGeneric< Scalar >::last_valid_wgstate_.

prevWGState()

template<class Scalar >

const WGState< Scalar > & Opm::BlackoilWellModelGeneric< Scalar >::prevWGState ( ) const

inlineprotected

References Opm::BlackoilWellModelGeneric< Scalar >::last_valid_wgstate_.

reportGroupSwitching()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::reportGroupSwitching ( DeferredLogger &  local_deferredLogger ) const

protected

reportStepStartEvents()

template<class Scalar >

const WellGroupEvents & Opm::BlackoilWellModelGeneric< Scalar >::reportStepStartEvents ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::report_step_start_events_.

reportStepStarts()

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::reportStepStarts ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::report_step_starts_.

resetWGState()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::resetWGState ( )

inlineprotected

References Opm::BlackoilWellModelGeneric< Scalar >::active_wgstate_, Opm::BlackoilWellModelGeneric< Scalar >::last_valid_node_pressures_, Opm::BlackoilWellModelGeneric< Scalar >::last_valid_wgstate_, and Opm::BlackoilWellModelGeneric< Scalar >::node_pressures_.

runWellPIScaling()

template<class Scalar >

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

protected

schedule()

template<class Scalar >

const Schedule & Opm::BlackoilWellModelGeneric< Scalar >::schedule ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::schedule_.

serializeOp()

template<class Scalar >

template<class Serializer >

void Opm::BlackoilWellModelGeneric< Scalar >::serializeOp ( Serializer &  serializer )

inline

References Opm::BlackoilWellModelGeneric< Scalar >::active_wgstate_, Opm::BlackoilWellModelGeneric< Scalar >::closed_offending_wells_, Opm::BlackoilWellModelGeneric< Scalar >::closed_this_step_, Opm::BlackoilWellModelGeneric< Scalar >::gen_gaslift_, Opm::BlackoilWellModelGeneric< Scalar >::guideRate_, Opm::BlackoilWellModelGeneric< Scalar >::initial_step_, Opm::BlackoilWellModelGeneric< Scalar >::last_run_wellpi_, Opm::BlackoilWellModelGeneric< Scalar >::last_valid_node_pressures_, Opm::BlackoilWellModelGeneric< Scalar >::last_valid_wgstate_, Opm::BlackoilWellModelGeneric< Scalar >::local_shut_wells_, Opm::BlackoilWellModelGeneric< Scalar >::node_pressures_, Opm::BlackoilWellModelGeneric< Scalar >::nupcol_wgstate_, Opm::BlackoilWellModelGeneric< Scalar >::prev_inj_multipliers_, Opm::BlackoilWellModelGeneric< Scalar >::report_step_starts_, Opm::BlackoilWellModelGeneric< Scalar >::switched_inj_groups_, and Opm::BlackoilWellModelGeneric< Scalar >::switched_prod_groups_.

setRepRadiusPerfLength()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::setRepRadiusPerfLength ( )

protected

setWsolvent()

template<class Scalar >

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

protected

shouldBalanceNetwork()

template<class Scalar >

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

summaryState()

template<class Scalar >

const SummaryState & Opm::BlackoilWellModelGeneric< Scalar >::summaryState ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::summaryState_.

terminalOutput()

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::terminalOutput ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::terminal_output_.

updateAndCommunicateGroupData()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::updateAndCommunicateGroupData ( const int  reportStepIdx, const int  iterationIdx, const Scalar  tol_nupcol, const bool  update_wellgrouptarget, DeferredLogger &  deferred_logger  )

protected

updateClosedWellsThisStep()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::updateClosedWellsThisStep ( const std::string &  well_name ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::closed_this_step_.

updateEclWells()

template<class Scalar >

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

updateFiltrationModelsPostStep()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::updateFiltrationModelsPostStep ( const double  dt, const std::size_t  water_index, DeferredLogger &  deferred_logger  )

protected

updateFiltrationModelsPreStep()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::updateFiltrationModelsPreStep ( DeferredLogger &  deferred_logger )

protected

updateInjFCMult()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::updateInjFCMult ( DeferredLogger &  deferred_logger )

protected

updateInjMult()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::updateInjMult ( DeferredLogger &  deferred_logger )

protected

updateNetworkActiveState()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::updateNetworkActiveState

(

const int

report_step

)

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

updateNetworkPressures()

template<class Scalar >

Scalar Opm::BlackoilWellModelGeneric< Scalar >::updateNetworkPressures ( const int  reportStepIdx, const Scalar  damping_factor, const Scalar  update_upper_bound  )

protected

updateNupcolWGState()

template<class Scalar >

void Opm::BlackoilWellModelGeneric< Scalar >::updateNupcolWGState ( )

inlineprotected

References Opm::BlackoilWellModelGeneric< Scalar >::active_wgstate_, and Opm::BlackoilWellModelGeneric< Scalar >::nupcol_wgstate_.

updateWellPotentials()

template<class Scalar >

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

protected

updateWsolvent()

template<class Scalar >

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

protected

wasDynamicallyShutThisTimeStep() [1/2]

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::wasDynamicallyShutThisTimeStep ( const int  well_index ) const

protected

wasDynamicallyShutThisTimeStep() [2/2]

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::wasDynamicallyShutThisTimeStep

(

const std::string &

well_name

)

const

wellCloseTimes()

template<class Scalar >

const std::map< std::string, double > & Opm::BlackoilWellModelGeneric< Scalar >::wellCloseTimes ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::well_close_times_.

wellOpenTimes()

template<class Scalar >

const std::map< std::string, double > & Opm::BlackoilWellModelGeneric< Scalar >::wellOpenTimes ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::well_open_times_.

wellPI() [1/2]

template<class Scalar >

Scalar Opm::BlackoilWellModelGeneric< Scalar >::wellPI

(

const int

well_index

)

const

wellPI() [2/2]

template<class Scalar >

Scalar Opm::BlackoilWellModelGeneric< Scalar >::wellPI

(

const std::string &

well_name

)

const

wellsActive()

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::wellsActive

(

)

const

return true if wells are available in the reservoir

wellState() [1/2]

template<class Scalar >

WellState< Scalar > & Opm::BlackoilWellModelGeneric< Scalar >::wellState ( )

inline

References Opm::BlackoilWellModelGeneric< Scalar >::active_wgstate_.

wellState() [2/2]

template<class Scalar >

const WellState< Scalar > & Opm::BlackoilWellModelGeneric< Scalar >::wellState ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::active_wgstate_.

wellTestState() [1/2]

template<class Scalar >

WellTestState & Opm::BlackoilWellModelGeneric< Scalar >::wellTestState ( )

inline

References Opm::BlackoilWellModelGeneric< Scalar >::active_wgstate_.

wellTestState() [2/2]

template<class Scalar >

const WellTestState & Opm::BlackoilWellModelGeneric< Scalar >::wellTestState ( ) const

inline

References Opm::BlackoilWellModelGeneric< Scalar >::active_wgstate_.

Member Data Documentation

active_wgstate_

template<class Scalar >

WGState<Scalar> Opm::BlackoilWellModelGeneric< Scalar >::active_wgstate_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::commitWGState(), Opm::BlackoilWellModelGeneric< Scalar >::groupState(), Opm::BlackoilWellModelGeneric< Scalar >::resetWGState(), Opm::BlackoilWellModelGeneric< Scalar >::serializeOp(), Opm::BlackoilWellModelGeneric< Scalar >::updateNupcolWGState(), Opm::BlackoilWellModelGeneric< Scalar >::wellState(), and Opm::BlackoilWellModelGeneric< Scalar >::wellTestState().

closed_offending_wells_

template<class Scalar >

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

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::serializeOp().

closed_this_step_

template<class Scalar >

std::unordered_set<std::string> Opm::BlackoilWellModelGeneric< Scalar >::closed_this_step_

mutableprotected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::serializeOp(), and Opm::BlackoilWellModelGeneric< Scalar >::updateClosedWellsThisStep().

comm_

template<class Scalar >

const Parallel::Communication& Opm::BlackoilWellModelGeneric< Scalar >::comm_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::comm().

conn_idx_map_

template<class Scalar >

std::vector<ConnectionIndexMap> Opm::BlackoilWellModelGeneric< Scalar >::conn_idx_map_ {}

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::connectionIndexMap().

eclState_

template<class Scalar >

const EclipseState& Opm::BlackoilWellModelGeneric< Scalar >::eclState_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::eclipseState().

filter_cake_

template<class Scalar >

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

protected

gen_gaslift_

template<class Scalar >

BlackoilWellModelGasLiftGeneric<Scalar>& Opm::BlackoilWellModelGeneric< Scalar >::gen_gaslift_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::serializeOp().

guideRate_

template<class Scalar >

GuideRate Opm::BlackoilWellModelGeneric< Scalar >::guideRate_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::guideRate(), and Opm::BlackoilWellModelGeneric< Scalar >::serializeOp().

initial_step_

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::initial_step_ {}

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::serializeOp().

last_run_wellpi_

template<class Scalar >

std::optional<int> Opm::BlackoilWellModelGeneric< Scalar >::last_run_wellpi_ {}

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::serializeOp().

last_valid_node_pressures_

template<class Scalar >

std::map<std::string, Scalar> Opm::BlackoilWellModelGeneric< Scalar >::last_valid_node_pressures_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::commitWGState(), Opm::BlackoilWellModelGeneric< Scalar >::resetWGState(), and Opm::BlackoilWellModelGeneric< Scalar >::serializeOp().

last_valid_wgstate_

template<class Scalar >

WGState<Scalar> Opm::BlackoilWellModelGeneric< Scalar >::last_valid_wgstate_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::commitWGState(), Opm::BlackoilWellModelGeneric< Scalar >::prevWellState(), Opm::BlackoilWellModelGeneric< Scalar >::prevWGState(), Opm::BlackoilWellModelGeneric< Scalar >::resetWGState(), and Opm::BlackoilWellModelGeneric< Scalar >::serializeOp().

local_parallel_well_info_

template<class Scalar >

std::vector<std::reference_wrapper<ParallelWellInfo<Scalar> > > Opm::BlackoilWellModelGeneric< Scalar >::local_parallel_well_info_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::parallelWellInfo().

local_shut_wells_

template<class Scalar >

std::vector<int> Opm::BlackoilWellModelGeneric< Scalar >::local_shut_wells_ {}

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::serializeOp().

network_active_

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::network_active_ {false}

protected

node_pressures_

template<class Scalar >

std::map<std::string, Scalar> Opm::BlackoilWellModelGeneric< Scalar >::node_pressures_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::commitWGState(), Opm::BlackoilWellModelGeneric< Scalar >::resetWGState(), and Opm::BlackoilWellModelGeneric< Scalar >::serializeOp().

not_on_process_

template<class Scalar >

std::function<bool(const std::string&)> Opm::BlackoilWellModelGeneric< Scalar >::not_on_process_ {}

protected

nupcol_wgstate_

template<class Scalar >

WGState<Scalar> Opm::BlackoilWellModelGeneric< Scalar >::nupcol_wgstate_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::nupcolWellState(), Opm::BlackoilWellModelGeneric< Scalar >::serializeOp(), and Opm::BlackoilWellModelGeneric< Scalar >::updateNupcolWGState().

parallel_well_info_

template<class Scalar >

std::vector<ParallelWellInfo<Scalar> > Opm::BlackoilWellModelGeneric< Scalar >::parallel_well_info_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::isOwner().

phase_usage_

template<class Scalar >

PhaseUsage Opm::BlackoilWellModelGeneric< Scalar >::phase_usage_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::phaseUsage().

prev_inj_multipliers_

template<class Scalar >

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

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::serializeOp().

prod_index_calc_

template<class Scalar >

std::vector<WellProdIndexCalculator<Scalar> > Opm::BlackoilWellModelGeneric< Scalar >::prod_index_calc_

protected

pvt_region_idx_

template<class Scalar >

std::vector<int> Opm::BlackoilWellModelGeneric< Scalar >::pvt_region_idx_

protected

report_step_start_events_

template<class Scalar >

WellGroupEvents Opm::BlackoilWellModelGeneric< Scalar >::report_step_start_events_

protected

Well group events at start of report step.

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::reportStepStartEvents().

report_step_starts_

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::report_step_starts_ {}

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::reportStepStarts(), and Opm::BlackoilWellModelGeneric< Scalar >::serializeOp().

schedule_

template<class Scalar >

Schedule& Opm::BlackoilWellModelGeneric< Scalar >::schedule_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::schedule().

summaryState_

template<class Scalar >

const SummaryState& Opm::BlackoilWellModelGeneric< Scalar >::summaryState_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::summaryState().

switched_inj_groups_

template<class Scalar >

std::map<std::string, std::array<std::vector<Group::InjectionCMode>, 3> > Opm::BlackoilWellModelGeneric< Scalar >::switched_inj_groups_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::serializeOp().

switched_prod_groups_

template<class Scalar >

std::map<std::string, std::vector<Group::ProductionCMode> > Opm::BlackoilWellModelGeneric< Scalar >::switched_prod_groups_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::serializeOp().

terminal_output_

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::terminal_output_ {false}

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::terminalOutput().

vfp_properties_

template<class Scalar >

std::unique_ptr<VFPProperties<Scalar> > Opm::BlackoilWellModelGeneric< Scalar >::vfp_properties_ {}

protected

wbp_

template<class Scalar >

BlackoilWellModelWBP<Scalar> Opm::BlackoilWellModelGeneric< Scalar >::wbp_

protected

well_close_times_

template<class Scalar >

std::map<std::string, double> Opm::BlackoilWellModelGeneric< Scalar >::well_close_times_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::wellCloseTimes().

well_container_generic_

template<class Scalar >

std::vector<WellInterfaceGeneric<Scalar>*> Opm::BlackoilWellModelGeneric< Scalar >::well_container_generic_ {}

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::genericWells().

well_open_times_

template<class Scalar >

std::map<std::string, double> Opm::BlackoilWellModelGeneric< Scalar >::well_open_times_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::wellOpenTimes().

well_perf_data_

template<class Scalar >

std::vector<std::vector<PerforationData<Scalar> > > Opm::BlackoilWellModelGeneric< Scalar >::well_perf_data_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::perfData().

wells_active_

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::wells_active_ {false}

protected

wells_ecl_

template<class Scalar >

std::vector<Well> Opm::BlackoilWellModelGeneric< Scalar >::wells_ecl_

protected

Referenced by Opm::BlackoilWellModelGeneric< Scalar >::eclWells().

wellStructureChangedDynamically_

template<class Scalar >

bool Opm::BlackoilWellModelGeneric< Scalar >::wellStructureChangedDynamically_ {false}

protected

---

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

• ActionHandler.hpp
• BlackoilWellModelGeneric.hpp