Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
Opm::SingleWellState< Scalar, IndexTraits > Class Template Reference

#include <SingleWellState.hpp>

Inheritance diagram for Opm::SingleWellState< Scalar, IndexTraits >:
Inheritance graph

Public Types

enum  RateIndices { dissolved_gas = 0 , dissolved_gas_in_water = 1 , vaporized_oil = 2 , vaporized_water = 3 }
 

Public Member Functions

 SingleWellState (const std::string &name, const ParallelWellInfo< Scalar > &pinfo, const PhaseUsageInfo< IndexTraits > &pu, bool is_producer, Scalar presssure_first_connection, const std::vector< PerforationData< Scalar > > &perf_input, Scalar temp)
 
template<class Serializer >
void serializeOp (Serializer &serializer)
 
bool operator== (const SingleWellState &) const
 
void reset_connection_factors (const std::vector< PerforationData< Scalar > > &new_perf_data)
 
void update_producer_targets (const Well &ecl_well, const SummaryState &st)
 
void update_injector_targets (const Well &ecl_well, const SummaryState &st)
 
void update_type_and_targets (const Well &ecl_well, const SummaryState &st)
 update the type of the well and the targets. More...
 
bool updateStatus (WellStatus status)
 
void init_timestep (const SingleWellState &other)
 
void shut ()
 
void stop ()
 
void open ()
 
Scalar sum_solvent_rates () const
 
Scalar sum_polymer_rates () const
 
Scalar sum_brine_rates () const
 
Scalar sum_microbial_rates () const
 
Scalar sum_oxygen_rates () const
 
Scalar sum_urea_rates () const
 
Scalar sum_wat_mass_rates () const
 
Scalar sum_filtrate_rate () const
 
Scalar sum_filtrate_total () const
 

Static Public Member Functions

static SingleWellState serializationTestObject (const ParallelWellInfo< Scalar > &pinfo)
 

Public Attributes

std::string name
 
std::reference_wrapper< const ParallelWellInfo< Scalar > > parallel_info
 
WellStatus status {WellStatus::OPEN}
 
bool producer
 
PhaseUsageInfo< IndexTraits > pu
 
Scalar bhp {0}
 
Scalar thp {0}
 
Scalar temperature {0}
 
Scalar efficiency_scaling_factor {1.0}
 
Scalar filtrate_conc {0}
 
std::array< Scalar, 4 > phase_mixing_rates {}
 
std::vector< Scalar > well_potentials
 
std::vector< Scalar > productivity_index
 
std::vector< Scalar > implicit_ipr_a
 
std::vector< Scalar > implicit_ipr_b
 
std::vector< Scalar > surface_rates
 
std::vector< Scalar > reservoir_rates
 
std::vector< Scalar > prev_surface_rates
 
PerfData< Scalar > perf_data
 
bool trivial_group_target
 
std::optional< Scalar > group_target
 
SegmentState< Scalar > segments
 
Events events
 
WellInjectorCMode injection_cmode {WellInjectorCMode::CMODE_UNDEFINED}
 
WellProducerCMode production_cmode {WellProducerCMode::CMODE_UNDEFINED}
 
std::vector< Scalar > primaryvar
 
ALQState< Scalar > alq_state
 

Static Public Attributes

static const int waterPhaseIdx = PhaseUsageInfo<IndexTraits>::waterPhaseIdx
 
static const int oilPhaseIdx = PhaseUsageInfo<IndexTraits>::oilPhaseIdx
 
static const int gasPhaseIdx = PhaseUsageInfo<IndexTraits>::gasPhaseIdx
 

Member Enumeration Documentation

◆ RateIndices

template<typename Scalar , typename IndexTraits >
enum Opm::SingleWellState::RateIndices
Enumerator
dissolved_gas 
dissolved_gas_in_water 
vaporized_oil 
vaporized_water 

Constructor & Destructor Documentation

◆ SingleWellState()

template<typename Scalar , typename IndexTraits >
Opm::SingleWellState< Scalar, IndexTraits >::SingleWellState ( const std::string &  name,
const ParallelWellInfo< Scalar > &  pinfo,
const PhaseUsageInfo< IndexTraits > &  pu,
bool  is_producer,
Scalar  presssure_first_connection,
const std::vector< PerforationData< Scalar > > &  perf_input,
Scalar  temp 
)

Member Function Documentation

◆ init_timestep()

template<typename Scalar , typename IndexTraits >
void Opm::SingleWellState< Scalar, IndexTraits >::init_timestep ( const SingleWellState< Scalar, IndexTraits > &  other)

◆ open()

template<typename Scalar , typename IndexTraits >
void Opm::SingleWellState< Scalar, IndexTraits >::open ( )

◆ operator==()

template<typename Scalar , typename IndexTraits >
bool Opm::SingleWellState< Scalar, IndexTraits >::operator== ( const SingleWellState< Scalar, IndexTraits > &  ) const

◆ reset_connection_factors()

template<typename Scalar , typename IndexTraits >
void Opm::SingleWellState< Scalar, IndexTraits >::reset_connection_factors ( const std::vector< PerforationData< Scalar > > &  new_perf_data)

Special purpose method to support dynamically rescaling a well's CTFs through WELPI.

Parameters
[in]new_perf_dataNew perforation data. Only PerforationData::connection_transmissibility_factor actually used (overwrites existing internal values).

◆ serializationTestObject()

template<typename Scalar , typename IndexTraits >
static SingleWellState Opm::SingleWellState< Scalar, IndexTraits >::serializationTestObject ( const ParallelWellInfo< Scalar > &  pinfo)
static

◆ serializeOp()

template<typename Scalar , typename IndexTraits >
template<class Serializer >
void Opm::SingleWellState< Scalar, IndexTraits >::serializeOp ( Serializer &  serializer)
inline

References Opm::SingleWellState< Scalar, IndexTraits >::alq_state, Opm::SingleWellState< Scalar, IndexTraits >::bhp, Opm::SingleWellState< Scalar, IndexTraits >::efficiency_scaling_factor, Opm::SingleWellState< Scalar, IndexTraits >::events, Opm::SingleWellState< Scalar, IndexTraits >::filtrate_conc, Opm::SingleWellState< Scalar, IndexTraits >::group_target, Opm::SingleWellState< Scalar, IndexTraits >::implicit_ipr_a, Opm::SingleWellState< Scalar, IndexTraits >::implicit_ipr_b, Opm::SingleWellState< Scalar, IndexTraits >::injection_cmode, Opm::SingleWellState< Scalar, IndexTraits >::name, Opm::SingleWellState< Scalar, IndexTraits >::perf_data, Opm::SingleWellState< Scalar, IndexTraits >::phase_mixing_rates, Opm::SingleWellState< Scalar, IndexTraits >::prev_surface_rates, Opm::SingleWellState< Scalar, IndexTraits >::primaryvar, Opm::SingleWellState< Scalar, IndexTraits >::producer, Opm::SingleWellState< Scalar, IndexTraits >::production_cmode, Opm::SingleWellState< Scalar, IndexTraits >::productivity_index, Opm::SingleWellState< Scalar, IndexTraits >::reservoir_rates, Opm::SingleWellState< Scalar, IndexTraits >::segments, Opm::SingleWellState< Scalar, IndexTraits >::status, Opm::SingleWellState< Scalar, IndexTraits >::surface_rates, Opm::SingleWellState< Scalar, IndexTraits >::temperature, Opm::SingleWellState< Scalar, IndexTraits >::thp, Opm::SingleWellState< Scalar, IndexTraits >::trivial_group_target, and Opm::SingleWellState< Scalar, IndexTraits >::well_potentials.

◆ shut()

template<typename Scalar , typename IndexTraits >
void Opm::SingleWellState< Scalar, IndexTraits >::shut ( )

◆ stop()

template<typename Scalar , typename IndexTraits >
void Opm::SingleWellState< Scalar, IndexTraits >::stop ( )

◆ sum_brine_rates()

template<typename Scalar , typename IndexTraits >
Scalar Opm::SingleWellState< Scalar, IndexTraits >::sum_brine_rates ( ) const

◆ sum_filtrate_rate()

template<typename Scalar , typename IndexTraits >
Scalar Opm::SingleWellState< Scalar, IndexTraits >::sum_filtrate_rate ( ) const

◆ sum_filtrate_total()

template<typename Scalar , typename IndexTraits >
Scalar Opm::SingleWellState< Scalar, IndexTraits >::sum_filtrate_total ( ) const

◆ sum_microbial_rates()

template<typename Scalar , typename IndexTraits >
Scalar Opm::SingleWellState< Scalar, IndexTraits >::sum_microbial_rates ( ) const

◆ sum_oxygen_rates()

template<typename Scalar , typename IndexTraits >
Scalar Opm::SingleWellState< Scalar, IndexTraits >::sum_oxygen_rates ( ) const

◆ sum_polymer_rates()

template<typename Scalar , typename IndexTraits >
Scalar Opm::SingleWellState< Scalar, IndexTraits >::sum_polymer_rates ( ) const

◆ sum_solvent_rates()

template<typename Scalar , typename IndexTraits >
Scalar Opm::SingleWellState< Scalar, IndexTraits >::sum_solvent_rates ( ) const

◆ sum_urea_rates()

template<typename Scalar , typename IndexTraits >
Scalar Opm::SingleWellState< Scalar, IndexTraits >::sum_urea_rates ( ) const

◆ sum_wat_mass_rates()

template<typename Scalar , typename IndexTraits >
Scalar Opm::SingleWellState< Scalar, IndexTraits >::sum_wat_mass_rates ( ) const

◆ update_injector_targets()

template<typename Scalar , typename IndexTraits >
void Opm::SingleWellState< Scalar, IndexTraits >::update_injector_targets ( const Well &  ecl_well,
const SummaryState &  st 
)

◆ update_producer_targets()

template<typename Scalar , typename IndexTraits >
void Opm::SingleWellState< Scalar, IndexTraits >::update_producer_targets ( const Well &  ecl_well,
const SummaryState &  st 
)

◆ update_type_and_targets()

template<typename Scalar , typename IndexTraits >
void Opm::SingleWellState< Scalar, IndexTraits >::update_type_and_targets ( const Well &  ecl_well,
const SummaryState &  st 
)

update the type of the well and the targets.

This called after ACTIONX is executed to update well rates. The new status is in ecl_well and st.

Returns
whether well was switched to a producer

◆ updateStatus()

template<typename Scalar , typename IndexTraits >
bool Opm::SingleWellState< Scalar, IndexTraits >::updateStatus ( WellStatus  status)

Member Data Documentation

◆ alq_state

template<typename Scalar , typename IndexTraits >
ALQState<Scalar> Opm::SingleWellState< Scalar, IndexTraits >::alq_state

Referenced by Opm::GasLiftSingleWell< TypeTag >::GasLiftSingleWell(), and Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ bhp

template<typename Scalar , typename IndexTraits >
Scalar Opm::SingleWellState< Scalar, IndexTraits >::bhp {0}

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ efficiency_scaling_factor

template<typename Scalar , typename IndexTraits >
Scalar Opm::SingleWellState< Scalar, IndexTraits >::efficiency_scaling_factor {1.0}

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ events

template<typename Scalar , typename IndexTraits >
Events Opm::SingleWellState< Scalar, IndexTraits >::events

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ filtrate_conc

template<typename Scalar , typename IndexTraits >
Scalar Opm::SingleWellState< Scalar, IndexTraits >::filtrate_conc {0}

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ gasPhaseIdx

template<typename Scalar , typename IndexTraits >
const int Opm::SingleWellState< Scalar, IndexTraits >::gasPhaseIdx = PhaseUsageInfo<IndexTraits>::gasPhaseIdx
static

◆ group_target

template<typename Scalar , typename IndexTraits >
std::optional<Scalar> Opm::SingleWellState< Scalar, IndexTraits >::group_target

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ implicit_ipr_a

template<typename Scalar , typename IndexTraits >
std::vector<Scalar> Opm::SingleWellState< Scalar, IndexTraits >::implicit_ipr_a

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ implicit_ipr_b

template<typename Scalar , typename IndexTraits >
std::vector<Scalar> Opm::SingleWellState< Scalar, IndexTraits >::implicit_ipr_b

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ injection_cmode

template<typename Scalar , typename IndexTraits >
WellInjectorCMode Opm::SingleWellState< Scalar, IndexTraits >::injection_cmode {WellInjectorCMode::CMODE_UNDEFINED}

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ name

template<typename Scalar , typename IndexTraits >
std::string Opm::SingleWellState< Scalar, IndexTraits >::name

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ oilPhaseIdx

template<typename Scalar , typename IndexTraits >
const int Opm::SingleWellState< Scalar, IndexTraits >::oilPhaseIdx = PhaseUsageInfo<IndexTraits>::oilPhaseIdx
static

◆ parallel_info

template<typename Scalar , typename IndexTraits >
std::reference_wrapper<const ParallelWellInfo<Scalar> > Opm::SingleWellState< Scalar, IndexTraits >::parallel_info

◆ perf_data

template<typename Scalar , typename IndexTraits >
PerfData<Scalar> Opm::SingleWellState< Scalar, IndexTraits >::perf_data

Referenced by Opm::WellInterface< TypeTag >::computeConnectionDFactor(), Opm::SingleWellState< Scalar, IndexTraits >::serializeOp(), Opm::WellInterface< TypeTag >::updateConnectionDFactor(), Opm::WellInterface< TypeTag >::updateConnectionTransmissibilityFactor(), and Opm::WellInterface< TypeTag >::wellIndex().

◆ phase_mixing_rates

template<typename Scalar , typename IndexTraits >
std::array<Scalar,4> Opm::SingleWellState< Scalar, IndexTraits >::phase_mixing_rates {}

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ prev_surface_rates

template<typename Scalar , typename IndexTraits >
std::vector<Scalar> Opm::SingleWellState< Scalar, IndexTraits >::prev_surface_rates

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ primaryvar

template<typename Scalar , typename IndexTraits >
std::vector<Scalar> Opm::SingleWellState< Scalar, IndexTraits >::primaryvar

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ producer

template<typename Scalar , typename IndexTraits >
bool Opm::SingleWellState< Scalar, IndexTraits >::producer

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ production_cmode

template<typename Scalar , typename IndexTraits >
WellProducerCMode Opm::SingleWellState< Scalar, IndexTraits >::production_cmode {WellProducerCMode::CMODE_UNDEFINED}

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ productivity_index

template<typename Scalar , typename IndexTraits >
std::vector<Scalar> Opm::SingleWellState< Scalar, IndexTraits >::productivity_index

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ pu

template<typename Scalar , typename IndexTraits >
PhaseUsageInfo<IndexTraits> Opm::SingleWellState< Scalar, IndexTraits >::pu

◆ reservoir_rates

template<typename Scalar , typename IndexTraits >
std::vector<Scalar> Opm::SingleWellState< Scalar, IndexTraits >::reservoir_rates

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ segments

template<typename Scalar , typename IndexTraits >
SegmentState<Scalar> Opm::SingleWellState< Scalar, IndexTraits >::segments

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ status

template<typename Scalar , typename IndexTraits >
WellStatus Opm::SingleWellState< Scalar, IndexTraits >::status {WellStatus::OPEN}

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ surface_rates

template<typename Scalar , typename IndexTraits >
std::vector<Scalar> Opm::SingleWellState< Scalar, IndexTraits >::surface_rates

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ temperature

template<typename Scalar , typename IndexTraits >
Scalar Opm::SingleWellState< Scalar, IndexTraits >::temperature {0}

Referenced by Opm::WellInterface< TypeTag >::computeConnectionDFactor(), and Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ thp

template<typename Scalar , typename IndexTraits >
Scalar Opm::SingleWellState< Scalar, IndexTraits >::thp {0}

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ trivial_group_target

template<typename Scalar , typename IndexTraits >
bool Opm::SingleWellState< Scalar, IndexTraits >::trivial_group_target

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

◆ waterPhaseIdx

template<typename Scalar , typename IndexTraits >
const int Opm::SingleWellState< Scalar, IndexTraits >::waterPhaseIdx = PhaseUsageInfo<IndexTraits>::waterPhaseIdx
static

◆ well_potentials

template<typename Scalar , typename IndexTraits >
std::vector<Scalar> Opm::SingleWellState< Scalar, IndexTraits >::well_potentials

Referenced by Opm::SingleWellState< Scalar, IndexTraits >::serializeOp().

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