Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
Opm::WellState Class Reference

The state of a set of wells. More...

#include <WellState.hpp>

Classes

struct  wdel
 

Public Types

typedef std::array< int, 3 > mapentry_t
 
typedef std::map< std::string, mapentry_t > WellMapType
 

Public Member Functions

template<class State >
void init (const Wells *wells, const State &state)
 
void init (const Wells *wells, const std::vector< double > &cellPressures)
 
std::vector< double > & bhp ()
 One bhp pressure per well. More...
 
const std::vector< double > & bhp () const
 
std::vector< double > & thp ()
 One thp pressure per well. More...
 
const std::vector< double > & thp () const
 
std::vector< double > & temperature ()
 One temperature per well. More...
 
const std::vector< double > & temperature () const
 
std::vector< double > & wellRates ()
 One rate per well and phase. More...
 
const std::vector< double > & wellRates () const
 
std::vector< double > & perfRates ()
 One rate per well connection. More...
 
const std::vector< double > & perfRates () const
 
std::vector< double > & perfPress ()
 One pressure per well connection. More...
 
const std::vector< double > & perfPress () const
 
size_t getRestartBhpOffset () const
 
size_t getRestartPerfPressOffset () const
 
size_t getRestartPerfRatesOffset () const
 
size_t getRestartTemperatureOffset () const
 
size_t getRestartWellRatesOffset () const
 
const WellMapType & wellMap () const
 
WellMapType & wellMap ()
 
int numWells () const
 The number of wells present. More...
 
int numPhases () const
 The number of phases present. More...
 
virtual data::Wells report (const PhaseUsage &pu) const
 
virtual ~WellState ()
 
 WellState ()=default
 
 WellState (const WellState &rhs)
 
WellState & operator= (const WellState &rhs)
 

Protected Attributes

std::unique_ptr< Wells, wdel > wells_
 

Detailed Description

The state of a set of wells.

Member Typedef Documentation

◆ mapentry_t

typedef std::array< int, 3 > Opm::WellState::mapentry_t

◆ WellMapType

typedef std::map< std::string, mapentry_t > Opm::WellState::WellMapType

Constructor & Destructor Documentation

◆ ~WellState()

virtual Opm::WellState::~WellState ( )
inlinevirtual

◆ WellState() [1/2]

Opm::WellState::WellState ( )
default

◆ WellState() [2/2]

Opm::WellState::WellState ( const WellState &  rhs)
inline

Member Function Documentation

◆ bhp() [1/2]

std::vector< double > & Opm::WellState::bhp ( )
inline

One bhp pressure per well.

Referenced by numWells(), and report().

◆ bhp() [2/2]

const std::vector< double > & Opm::WellState::bhp ( ) const
inline

◆ getRestartBhpOffset()

size_t Opm::WellState::getRestartBhpOffset ( ) const
inline

◆ getRestartPerfPressOffset()

size_t Opm::WellState::getRestartPerfPressOffset ( ) const
inline

Referenced by getRestartPerfRatesOffset().

◆ getRestartPerfRatesOffset()

size_t Opm::WellState::getRestartPerfRatesOffset ( ) const
inline

References getRestartPerfPressOffset().

Referenced by getRestartTemperatureOffset().

◆ getRestartTemperatureOffset()

size_t Opm::WellState::getRestartTemperatureOffset ( ) const
inline

References getRestartPerfRatesOffset().

Referenced by getRestartWellRatesOffset().

◆ getRestartWellRatesOffset()

size_t Opm::WellState::getRestartWellRatesOffset ( ) const
inline

References getRestartTemperatureOffset().

◆ init() [1/2]

template<class State >
void Opm::WellState::init ( const Wells *  wells,
const State &  state 
)
inline

References init().

Referenced by init().

◆ init() [2/2]

void Opm::WellState::init ( const Wells *  wells,
const std::vector< double > &  cellPressures 
)
inline

Allocate and initialize if wells is non-null. Also tries to give useful initial values to the bhp() and wellRates() fields, depending on controls. The perfRates() field is filled with zero, and perfPress() with -1e100.

References BHP, clone_wells(), Wells::ctrls, INJECTOR, Wells::name, Wells::number_of_phases, Wells::number_of_wells, PRODUCER, SURFACE_RATE, THP, Wells::type, Wells::well_cells, Wells::well_connpos, well_controls_get_current_distr(), well_controls_get_current_target(), well_controls_get_current_type(), well_controls_get_num(), well_controls_iget_target(), well_controls_iget_type(), well_controls_well_is_stopped(), and wells_.

◆ numPhases()

int Opm::WellState::numPhases ( ) const
inline

The number of phases present.

References numWells(), and wellRates().

◆ numWells()

int Opm::WellState::numWells ( ) const
inline

The number of wells present.

References bhp().

Referenced by numPhases().

◆ operator=()

WellState & Opm::WellState::operator= ( const WellState &  rhs)
inline

References clone_wells(), and wells_.

◆ perfPress() [1/2]

std::vector< double > & Opm::WellState::perfPress ( )
inline

One pressure per well connection.

Referenced by report().

◆ perfPress() [2/2]

const std::vector< double > & Opm::WellState::perfPress ( ) const
inline

◆ perfRates() [1/2]

std::vector< double > & Opm::WellState::perfRates ( )
inline

One rate per well connection.

Referenced by report().

◆ perfRates() [2/2]

const std::vector< double > & Opm::WellState::perfRates ( ) const
inline

◆ report()

virtual data::Wells Opm::WellState::report ( const PhaseUsage &  pu) const
inlinevirtual

References Opm::BlackoilPhases::Aqua, bhp(), Opm::Details::PhasePressure::gas(), Opm::BlackoilPhases::Liquid, Opm::PhaseUsage::num_phases, Opm::Details::PhasePressure::oil(), perfPress(), perfRates(), Opm::PhaseUsage::phase_pos, Opm::PhaseUsage::phase_used, temperature(), thp(), Opm::BlackoilPhases::Vapour, wellRates(), and wells_.

◆ temperature() [1/2]

std::vector< double > & Opm::WellState::temperature ( )
inline

One temperature per well.

Referenced by report().

◆ temperature() [2/2]

const std::vector< double > & Opm::WellState::temperature ( ) const
inline

◆ thp() [1/2]

std::vector< double > & Opm::WellState::thp ( )
inline

One thp pressure per well.

Referenced by report().

◆ thp() [2/2]

const std::vector< double > & Opm::WellState::thp ( ) const
inline

◆ wellMap() [1/2]

WellMapType & Opm::WellState::wellMap ( )
inline

◆ wellMap() [2/2]

const WellMapType & Opm::WellState::wellMap ( ) const
inline

◆ wellRates() [1/2]

std::vector< double > & Opm::WellState::wellRates ( )
inline

One rate per well and phase.

Referenced by numPhases(), and report().

◆ wellRates() [2/2]

const std::vector< double > & Opm::WellState::wellRates ( ) const
inline

Member Data Documentation

◆ wells_

std::unique_ptr< Wells, wdel > Opm::WellState::wells_
protected

Referenced by init(), operator=(), and report().

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