#include <WellInterfaceGeneric.hpp>
|
| WellInterfaceGeneric (const Well &well, const ParallelWellInfo ¶llel_well_info, const int time_step, const int pvtRegionIdx, const int num_components, const int num_phases, const int index_of_well, const std::vector< PerforationData > &perf_data) |
|
const std::vector< PerforationData > & | perforationData () const |
| Get the perforations of the well. More...
|
|
const std::string & | name () const |
| Well name. More...
|
|
bool | isInjector () const |
| True if the well is an injector. More...
|
|
bool | isProducer () const |
| True if the well is a producer. More...
|
|
const std::vector< int > & | cells () const |
| Well cells. More...
|
|
int | indexOfWell () const |
| Index of well in the wells struct and wellState. More...
|
|
void | adaptRatesForVFP (std::vector< double > &rates) const |
|
const Well & | wellEcl () const |
|
Well & | wellEcl () |
|
const PhaseUsage & | phaseUsage () const |
|
bool | underPredictionMode () const |
| Returns true if the well is currently in prediction mode (i.e. not history mode). More...
|
|
bool | isOperableAndSolvable () const |
|
bool | useVfpExplicit () const |
|
bool | thpLimitViolatedButNotSwitched () const |
|
void | initCompletions () |
|
void | closeCompletions (const WellTestState &wellTestState) |
|
void | setVFPProperties (const VFPProperties *vfp_properties_arg) |
|
void | setPrevSurfaceRates (WellState< double > &well_state, const WellState< double > &prev_well_state) const |
|
void | setGuideRate (const GuideRate *guide_rate_arg) |
|
void | setWellEfficiencyFactor (const double efficiency_factor) |
|
void | setRepRadiusPerfLength () |
|
void | setWsolvent (const double wsolvent) |
|
void | setDynamicThpLimit (const double thp_limit) |
|
std::optional< double > | getDynamicThpLimit () const |
|
void | updatePerforatedCell (std::vector< bool > &is_cell_perforated) |
|
bool | wellHasTHPConstraints (const SummaryState &summaryState) const |
| Returns true if the well has one or more THP limits/constraints. More...
|
|
void | stopWell () |
|
void | openWell () |
|
bool | wellIsStopped () const |
|
int | currentStep () const |
|
int | pvtRegionIdx () const |
|
const GuideRate * | guideRate () const |
|
int | numComponents () const |
|
int | numPhases () const |
|
int | numPerfs () const |
|
double | refDepth () const |
|
double | gravity () const |
|
const VFPProperties * | vfpProperties () const |
|
const ParallelWellInfo & | parallelWellInfo () const |
|
const std::vector< double > & | perfDepth () const |
|
std::vector< double > & | perfDepth () |
|
const std::vector< double > & | wellIndex () const |
|
const std::map< int, std::vector< int > > & | getCompletions () const |
|
double | getTHPConstraint (const SummaryState &summaryState) const |
|
double | getALQ (const WellState< double > &well_state) const |
|
double | wsolvent () const |
|
double | rsRvInj () const |
|
void | initInjMult (const std::vector< double > &max_inj_mult) |
|
void | updateInjMult (std::vector< double > &inj_multipliers, DeferredLogger &deferred_logger) const |
|
double | getInjMult (const int perf, const double bhp, const double perf_pres) const |
|
bool | isVFPActive (DeferredLogger &deferred_logger) const |
|
void | reportWellSwitching (const SingleWellState< double > &ws, DeferredLogger &deferred_logger) const |
|
bool | changedToOpenThisStep () const |
|
void | updateWellTestState (const SingleWellState< double > &ws, const double &simulationTime, const bool &writeMessageToOPMLog, WellTestState &wellTestState, DeferredLogger &deferred_logger) const |
|
bool | isPressureControlled (const WellState< double > &well_state) const |
|
bool | stopppedOrZeroRateTarget (const SummaryState &summary_state, const WellState< double > &well_state) const |
|
double | wellEfficiencyFactor () const |
|
void | updateFilterCakeMultipliers (const std::vector< double > &inj_fc_multiplier) |
| Update filter cake multipliers. More...
|
|
void | resetWellOperability () |
|
◆ WellInterfaceGeneric()
Opm::WellInterfaceGeneric::WellInterfaceGeneric |
( |
const Well & |
well, |
|
|
const ParallelWellInfo & |
parallel_well_info, |
|
|
const int |
time_step, |
|
|
const int |
pvtRegionIdx, |
|
|
const int |
num_components, |
|
|
const int |
num_phases, |
|
|
const int |
index_of_well, |
|
|
const std::vector< PerforationData > & |
perf_data |
|
) |
| |
◆ adaptRatesForVFP()
void Opm::WellInterfaceGeneric::adaptRatesForVFP |
( |
std::vector< double > & |
rates | ) |
const |
◆ cells()
const std::vector< int > & Opm::WellInterfaceGeneric::cells |
( |
| ) |
const |
|
inline |
◆ changedToOpenThisStep()
bool Opm::WellInterfaceGeneric::changedToOpenThisStep |
( |
| ) |
const |
|
inline |
◆ checkNegativeWellPotentials()
void Opm::WellInterfaceGeneric::checkNegativeWellPotentials |
( |
std::vector< double > & |
well_potentials, |
|
|
const bool |
checkOperability, |
|
|
DeferredLogger & |
deferred_logger |
|
) |
| |
|
protected |
◆ closeCompletions()
void Opm::WellInterfaceGeneric::closeCompletions |
( |
const WellTestState & |
wellTestState | ) |
|
◆ computeWellPotentials()
std::pair< bool, bool > Opm::WellInterfaceGeneric::computeWellPotentials |
( |
std::vector< double > & |
well_potentials, |
|
|
const WellState< double > & |
well_state |
|
) |
| |
|
protected |
◆ currentStep()
int Opm::WellInterfaceGeneric::currentStep |
( |
| ) |
const |
|
inline |
◆ getAllowCrossFlow()
bool Opm::WellInterfaceGeneric::getAllowCrossFlow |
( |
| ) |
const |
|
protected |
◆ getALQ()
double Opm::WellInterfaceGeneric::getALQ |
( |
const WellState< double > & |
well_state | ) |
const |
◆ getCompletions()
const std::map< int, std::vector< int > > & Opm::WellInterfaceGeneric::getCompletions |
( |
| ) |
const |
|
inline |
◆ getDynamicThpLimit()
std::optional< double > Opm::WellInterfaceGeneric::getDynamicThpLimit |
( |
| ) |
const |
◆ getInjMult()
double Opm::WellInterfaceGeneric::getInjMult |
( |
const int |
perf, |
|
|
const double |
bhp, |
|
|
const double |
perf_pres |
|
) |
| const |
◆ getTHPConstraint()
double Opm::WellInterfaceGeneric::getTHPConstraint |
( |
const SummaryState & |
summaryState | ) |
const |
◆ gravity()
double Opm::WellInterfaceGeneric::gravity |
( |
| ) |
const |
|
inline |
◆ guideRate()
const GuideRate * Opm::WellInterfaceGeneric::guideRate |
( |
| ) |
const |
|
inline |
◆ indexOfWell()
int Opm::WellInterfaceGeneric::indexOfWell |
( |
| ) |
const |
◆ initCompletions()
void Opm::WellInterfaceGeneric::initCompletions |
( |
| ) |
|
◆ initInjMult()
void Opm::WellInterfaceGeneric::initInjMult |
( |
const std::vector< double > & |
max_inj_mult | ) |
|
◆ isInjector()
bool Opm::WellInterfaceGeneric::isInjector |
( |
| ) |
const |
True if the well is an injector.
◆ isOperableAndSolvable()
bool Opm::WellInterfaceGeneric::isOperableAndSolvable |
( |
| ) |
const |
◆ isPressureControlled()
bool Opm::WellInterfaceGeneric::isPressureControlled |
( |
const WellState< double > & |
well_state | ) |
const |
◆ isProducer()
bool Opm::WellInterfaceGeneric::isProducer |
( |
| ) |
const |
True if the well is a producer.
◆ isVFPActive()
bool Opm::WellInterfaceGeneric::isVFPActive |
( |
DeferredLogger & |
deferred_logger | ) |
const |
◆ name()
const std::string & Opm::WellInterfaceGeneric::name |
( |
| ) |
const |
◆ numComponents()
int Opm::WellInterfaceGeneric::numComponents |
( |
| ) |
const |
|
inline |
◆ numPerfs()
int Opm::WellInterfaceGeneric::numPerfs |
( |
| ) |
const |
|
inline |
◆ numPhases()
int Opm::WellInterfaceGeneric::numPhases |
( |
| ) |
const |
|
inline |
◆ openWell()
void Opm::WellInterfaceGeneric::openWell |
( |
| ) |
|
|
inline |
◆ parallelWellInfo()
◆ perfDepth() [1/2]
std::vector< double > & Opm::WellInterfaceGeneric::perfDepth |
( |
| ) |
|
|
inline |
◆ perfDepth() [2/2]
const std::vector< double > & Opm::WellInterfaceGeneric::perfDepth |
( |
| ) |
const |
|
inline |
◆ perforationData()
const std::vector< PerforationData > & Opm::WellInterfaceGeneric::perforationData |
( |
| ) |
const |
Get the perforations of the well.
◆ phaseUsage()
const PhaseUsage & Opm::WellInterfaceGeneric::phaseUsage |
( |
| ) |
const |
◆ polymerInjTable_()
int Opm::WellInterfaceGeneric::polymerInjTable_ |
( |
| ) |
const |
|
protected |
◆ polymerTable_()
int Opm::WellInterfaceGeneric::polymerTable_ |
( |
| ) |
const |
|
protected |
◆ polymerWaterTable_()
int Opm::WellInterfaceGeneric::polymerWaterTable_ |
( |
| ) |
const |
|
protected |
◆ prepareForPotentialCalculations()
void Opm::WellInterfaceGeneric::prepareForPotentialCalculations |
( |
const SummaryState & |
summary_state, |
|
|
WellState< double > & |
well_state, |
|
|
Well::InjectionControls & |
inj_controls, |
|
|
Well::ProductionControls & |
prod_controls |
|
) |
| const |
|
protected |
◆ pvtRegionIdx()
int Opm::WellInterfaceGeneric::pvtRegionIdx |
( |
| ) |
const |
|
inline |
◆ refDepth()
double Opm::WellInterfaceGeneric::refDepth |
( |
| ) |
const |
|
inline |
◆ reportWellSwitching()
◆ resetWellOperability()
void Opm::WellInterfaceGeneric::resetWellOperability |
( |
| ) |
|
◆ rsRvInj()
double Opm::WellInterfaceGeneric::rsRvInj |
( |
| ) |
const |
◆ setDynamicThpLimit()
void Opm::WellInterfaceGeneric::setDynamicThpLimit |
( |
const double |
thp_limit | ) |
|
◆ setGuideRate()
void Opm::WellInterfaceGeneric::setGuideRate |
( |
const GuideRate * |
guide_rate_arg | ) |
|
◆ setPrevSurfaceRates()
void Opm::WellInterfaceGeneric::setPrevSurfaceRates |
( |
WellState< double > & |
well_state, |
|
|
const WellState< double > & |
prev_well_state |
|
) |
| const |
◆ setRepRadiusPerfLength()
void Opm::WellInterfaceGeneric::setRepRadiusPerfLength |
( |
| ) |
|
◆ setVFPProperties()
void Opm::WellInterfaceGeneric::setVFPProperties |
( |
const VFPProperties * |
vfp_properties_arg | ) |
|
◆ setWellEfficiencyFactor()
void Opm::WellInterfaceGeneric::setWellEfficiencyFactor |
( |
const double |
efficiency_factor | ) |
|
◆ setWsolvent()
void Opm::WellInterfaceGeneric::setWsolvent |
( |
const double |
wsolvent | ) |
|
◆ stopppedOrZeroRateTarget()
bool Opm::WellInterfaceGeneric::stopppedOrZeroRateTarget |
( |
const SummaryState & |
summary_state, |
|
|
const WellState< double > & |
well_state |
|
) |
| const |
◆ stopWell()
void Opm::WellInterfaceGeneric::stopWell |
( |
| ) |
|
|
inline |
◆ thpLimitViolatedButNotSwitched()
bool Opm::WellInterfaceGeneric::thpLimitViolatedButNotSwitched |
( |
| ) |
const |
◆ underPredictionMode()
bool Opm::WellInterfaceGeneric::underPredictionMode |
( |
| ) |
const |
Returns true if the well is currently in prediction mode (i.e. not history mode).
◆ updateFilterCakeMultipliers()
void Opm::WellInterfaceGeneric::updateFilterCakeMultipliers |
( |
const std::vector< double > & |
inj_fc_multiplier | ) |
|
|
inline |
◆ updateInjMult()
void Opm::WellInterfaceGeneric::updateInjMult |
( |
std::vector< double > & |
inj_multipliers, |
|
|
DeferredLogger & |
deferred_logger |
|
) |
| const |
◆ updatePerforatedCell()
void Opm::WellInterfaceGeneric::updatePerforatedCell |
( |
std::vector< bool > & |
is_cell_perforated | ) |
|
◆ updateWellTestState()
void Opm::WellInterfaceGeneric::updateWellTestState |
( |
const SingleWellState< double > & |
ws, |
|
|
const double & |
simulationTime, |
|
|
const bool & |
writeMessageToOPMLog, |
|
|
WellTestState & |
wellTestState, |
|
|
DeferredLogger & |
deferred_logger |
|
) |
| const |
◆ useVfpExplicit()
bool Opm::WellInterfaceGeneric::useVfpExplicit |
( |
| ) |
const |
◆ vfpProperties()
const VFPProperties * Opm::WellInterfaceGeneric::vfpProperties |
( |
| ) |
const |
|
inline |
◆ wellEcl() [1/2]
Well & Opm::WellInterfaceGeneric::wellEcl |
( |
| ) |
|
◆ wellEcl() [2/2]
const Well & Opm::WellInterfaceGeneric::wellEcl |
( |
| ) |
const |
◆ wellEfficiencyFactor()
double Opm::WellInterfaceGeneric::wellEfficiencyFactor |
( |
| ) |
const |
|
inline |
◆ wellHasTHPConstraints()
bool Opm::WellInterfaceGeneric::wellHasTHPConstraints |
( |
const SummaryState & |
summaryState | ) |
const |
Returns true if the well has one or more THP limits/constraints.
◆ wellIndex()
const std::vector< double > & Opm::WellInterfaceGeneric::wellIndex |
( |
| ) |
const |
|
inline |
◆ wellIsStopped()
bool Opm::WellInterfaceGeneric::wellIsStopped |
( |
| ) |
const |
|
inline |
◆ wellUnderZeroRateTarget()
bool Opm::WellInterfaceGeneric::wellUnderZeroRateTarget |
( |
const SummaryState & |
summary_state, |
|
|
const WellState< double > & |
well_state |
|
) |
| const |
|
protected |
◆ wfoam_()
double Opm::WellInterfaceGeneric::wfoam_ |
( |
| ) |
const |
|
protected |
◆ wmicrobes_()
double Opm::WellInterfaceGeneric::wmicrobes_ |
( |
| ) |
const |
|
protected |
◆ woxygen_()
double Opm::WellInterfaceGeneric::woxygen_ |
( |
| ) |
const |
|
protected |
◆ wpolymer_()
double Opm::WellInterfaceGeneric::wpolymer_ |
( |
| ) |
const |
|
protected |
◆ wsalt_()
double Opm::WellInterfaceGeneric::wsalt_ |
( |
| ) |
const |
|
protected |
◆ wsolvent()
double Opm::WellInterfaceGeneric::wsolvent |
( |
| ) |
const |
◆ wurea_()
double Opm::WellInterfaceGeneric::wurea_ |
( |
| ) |
const |
|
protected |
◆ bore_diameters_
std::vector<double> Opm::WellInterfaceGeneric::bore_diameters_ |
|
protected |
◆ changed_to_open_this_step_
bool Opm::WellInterfaceGeneric::changed_to_open_this_step_ = true |
|
protected |
◆ completions_
std::map<int, std::vector<int> > Opm::WellInterfaceGeneric::completions_ |
|
protected |
◆ current_step_
const int Opm::WellInterfaceGeneric::current_step_ |
|
protected |
◆ dynamic_thp_limit_
std::optional<double> Opm::WellInterfaceGeneric::dynamic_thp_limit_ |
|
protected |
◆ gravity_
double Opm::WellInterfaceGeneric::gravity_ |
|
protected |
◆ guide_rate_
const GuideRate* Opm::WellInterfaceGeneric::guide_rate_ |
|
protected |
◆ index_of_well_
int Opm::WellInterfaceGeneric::index_of_well_ |
|
protected |
◆ inj_fc_multiplier_
std::vector<double> Opm::WellInterfaceGeneric::inj_fc_multiplier_ |
|
protected |
◆ inj_multiplier_
std::vector<double> Opm::WellInterfaceGeneric::inj_multiplier_ |
|
mutableprotected |
◆ ipr_a_
std::vector<double> Opm::WellInterfaceGeneric::ipr_a_ |
|
mutableprotected |
◆ ipr_b_
std::vector<double> Opm::WellInterfaceGeneric::ipr_b_ |
|
mutableprotected |
◆ num_components_
const int Opm::WellInterfaceGeneric::num_components_ |
|
protected |
◆ number_of_perforations_
int Opm::WellInterfaceGeneric::number_of_perforations_ |
|
protected |
◆ number_of_phases_
int Opm::WellInterfaceGeneric::number_of_phases_ |
|
protected |
◆ operability_status_
◆ parallel_well_info_
◆ perf_data_
◆ perf_depth_
std::vector<double> Opm::WellInterfaceGeneric::perf_depth_ |
|
protected |
◆ perf_length_
std::vector<double> Opm::WellInterfaceGeneric::perf_length_ |
|
protected |
◆ perf_rep_radius_
std::vector<double> Opm::WellInterfaceGeneric::perf_rep_radius_ |
|
protected |
◆ phase_usage_
const PhaseUsage* Opm::WellInterfaceGeneric::phase_usage_ |
|
protected |
◆ prev_inj_multiplier_
std::vector<double> Opm::WellInterfaceGeneric::prev_inj_multiplier_ |
|
protected |
◆ pvtRegionIdx_
const int Opm::WellInterfaceGeneric::pvtRegionIdx_ |
|
protected |
◆ ref_depth_
double Opm::WellInterfaceGeneric::ref_depth_ |
|
protected |
◆ saturation_table_number_
std::vector<int> Opm::WellInterfaceGeneric::saturation_table_number_ |
|
protected |
◆ vfp_properties_
◆ well_cells_
std::vector<int> Opm::WellInterfaceGeneric::well_cells_ |
|
protected |
◆ well_control_log_
std::vector< std::string> Opm::WellInterfaceGeneric::well_control_log_ |
|
protected |
◆ well_ecl_
Well Opm::WellInterfaceGeneric::well_ecl_ |
|
protected |
◆ well_efficiency_factor_
double Opm::WellInterfaceGeneric::well_efficiency_factor_ |
|
protected |
◆ well_index_
std::vector<double> Opm::WellInterfaceGeneric::well_index_ |
|
protected |
◆ wellStatus_
Well::Status Opm::WellInterfaceGeneric::wellStatus_ |
|
protected |
◆ wsolvent_
double Opm::WellInterfaceGeneric::wsolvent_ |
|
protected |
The documentation for this class was generated from the following file:
|