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

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

#include <WellState.hpp>

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

Detailed Description

The state of a set of wells.

Member Typedef Documentation

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

Member Function Documentation

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

One bhp pressure per well.

Referenced by numWells().

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

Referenced by getRestartPerfRatesOffset().

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

References getRestartPerfPressOffset().

Referenced by getRestartTemperatureOffset().

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

References getRestartPerfRatesOffset().

Referenced by getRestartWellRatesOffset().

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

References getRestartTemperatureOffset().

template<class State >
void Opm::WellState::init ( const Wells *  wells,
const State &  state 
)
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, 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(), and well_controls_well_is_stopped().

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

The number of phases present.

References numWells(), and wellRates().

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

The number of wells present.

References bhp().

Referenced by numPhases().

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

One pressure per well connection.

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

One rate per well connection.

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

One temperature per well.

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

One thp pressure per well.

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

One rate per well and phase.

Referenced by numPhases().

const std::vector<double>& Opm::WellState::wellRates ( ) const
inline
The documentation for this class was generated from the following file: