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

#include <Connection.hpp>

Public Types

enum class  State { OPEN = 1 , SHUT = 2 , AUTO = 3 }
 
enum class  Direction { X = 1 , Y = 2 , Z = 3 }
 
enum class  Order { DEPTH , INPUT , TRACK }
 
enum class  CTFKind { DeckValue , Defaulted }
 

Public Member Functions

 Connection ()
 
 Connection (int i, int j, int k, std::size_t global_index, int complnum, double depth, State state, double CF, double Kh, double rw, double r0, double skin_factor, const int satTableId, const Direction direction, const CTFKind ctf_kind, const std::size_t sort_value, const double segDistStart, const double segDistEnd, const bool defaultSatTabId)
 
 Connection (const RestartIO::RstConnection &rst_connection, const EclipseGrid &grid, const FieldPropsManager &fp)
 
bool attachedToSegment () const
 
bool sameCoordinate (const int i, const int j, const int k) const
 
int getI () const
 
int getJ () const
 
int getK () const
 
std::size_t global_index () const
 
State state () const
 
Direction dir () const
 
double depth () const
 
int satTableId () const
 
int complnum () const
 
int segment () const
 
double CF () const
 
double Kh () const
 
double rw () const
 
double r0 () const
 
double skinFactor () const
 
CTFKind kind () const
 
void setState (State state)
 
void setComplnum (int compnum)
 
void scaleWellPi (double wellPi)
 
void updateSegmentRST (int segment_number_arg, double center_depth_arg)
 
void updateSegment (int segment_number_arg, double center_depth_arg, std::size_t compseg_insert_index, double start, double end)
 
std::size_t sort_value () const
 
const bool & getDefaultSatTabId () const
 
void setDefaultSatTabId (bool id)
 
const double & getSegDistStart () const
 
const double & getSegDistEnd () const
 
std::string str () const
 
bool ctfAssignedFromInput () const
 
bool operator== (const Connection &) const
 
bool operator!= (const Connection &) const
 
template<class Serializer >
void serializeOp (Serializer &serializer)
 

Static Public Member Functions

static const std::string State2String (State enumValue)
 
static State StateFromString (const std::string &stringValue)
 
static std::string Direction2String (const Direction enumValue)
 
static Direction DirectionFromString (const std::string &stringValue)
 
static const std::string Order2String (Order enumValue)
 
static Order OrderFromString (const std::string &comporderStringValue)
 
static Connection serializeObject ()
 

Member Enumeration Documentation

◆ CTFKind

enum class Opm::Connection::CTFKind
strong
Enumerator
DeckValue 
Defaulted 

◆ Direction

enum class Opm::Connection::Direction
strong
Enumerator
X 
Y 
Z 

◆ Order

enum class Opm::Connection::Order
strong
Enumerator
DEPTH 
INPUT 
TRACK 

◆ State

enum class Opm::Connection::State
strong
Enumerator
OPEN 
SHUT 
AUTO 

Constructor & Destructor Documentation

◆ Connection() [1/3]

Opm::Connection::Connection ( )

◆ Connection() [2/3]

Opm::Connection::Connection ( int  i,
int  j,
int  k,
std::size_t  global_index,
int  complnum,
double  depth,
State  state,
double  CF,
double  Kh,
double  rw,
double  r0,
double  skin_factor,
const int  satTableId,
const Direction  direction,
const CTFKind  ctf_kind,
const std::size_t  sort_value,
const double  segDistStart,
const double  segDistEnd,
const bool  defaultSatTabId 
)

◆ Connection() [3/3]

Opm::Connection::Connection ( const RestartIO::RstConnection &  rst_connection,
const EclipseGrid &  grid,
const FieldPropsManager &  fp 
)

Member Function Documentation

◆ attachedToSegment()

bool Opm::Connection::attachedToSegment ( ) const

◆ CF()

double Opm::Connection::CF ( ) const

◆ complnum()

int Opm::Connection::complnum ( ) const

◆ ctfAssignedFromInput()

bool Opm::Connection::ctfAssignedFromInput ( ) const
inline

References DeckValue.

◆ depth()

double Opm::Connection::depth ( ) const

◆ dir()

Direction Opm::Connection::dir ( ) const

◆ Direction2String()

static std::string Opm::Connection::Direction2String ( const Direction  enumValue)
static

◆ DirectionFromString()

static Direction Opm::Connection::DirectionFromString ( const std::string &  stringValue)
static

◆ getDefaultSatTabId()

const bool & Opm::Connection::getDefaultSatTabId ( ) const

◆ getI()

int Opm::Connection::getI ( ) const

◆ getJ()

int Opm::Connection::getJ ( ) const

◆ getK()

int Opm::Connection::getK ( ) const

◆ getSegDistEnd()

const double & Opm::Connection::getSegDistEnd ( ) const

◆ getSegDistStart()

const double & Opm::Connection::getSegDistStart ( ) const

◆ global_index()

std::size_t Opm::Connection::global_index ( ) const

◆ Kh()

double Opm::Connection::Kh ( ) const

◆ kind()

CTFKind Opm::Connection::kind ( ) const

◆ operator!=()

bool Opm::Connection::operator!= ( const Connection &  ) const

◆ operator==()

bool Opm::Connection::operator== ( const Connection &  ) const

◆ Order2String()

static const std::string Opm::Connection::Order2String ( Order  enumValue)
static

◆ OrderFromString()

static Order Opm::Connection::OrderFromString ( const std::string &  comporderStringValue)
static

◆ r0()

double Opm::Connection::r0 ( ) const

◆ rw()

double Opm::Connection::rw ( ) const

◆ sameCoordinate()

bool Opm::Connection::sameCoordinate ( const int  i,
const int  j,
const int  k 
) const

◆ satTableId()

int Opm::Connection::satTableId ( ) const

◆ scaleWellPi()

void Opm::Connection::scaleWellPi ( double  wellPi)

◆ segment()

int Opm::Connection::segment ( ) const

◆ serializeObject()

static Connection Opm::Connection::serializeObject ( )
static

◆ serializeOp()

template<class Serializer >
void Opm::Connection::serializeOp ( Serializer &  serializer)
inline

◆ setComplnum()

void Opm::Connection::setComplnum ( int  compnum)

◆ setDefaultSatTabId()

void Opm::Connection::setDefaultSatTabId ( bool  id)

◆ setState()

void Opm::Connection::setState ( State  state)

◆ skinFactor()

double Opm::Connection::skinFactor ( ) const

◆ sort_value()

std::size_t Opm::Connection::sort_value ( ) const

◆ state()

State Opm::Connection::state ( ) const

◆ State2String()

static const std::string Opm::Connection::State2String ( State  enumValue)
static

◆ StateFromString()

static State Opm::Connection::StateFromString ( const std::string &  stringValue)
static

◆ str()

std::string Opm::Connection::str ( ) const

◆ updateSegment()

void Opm::Connection::updateSegment ( int  segment_number_arg,
double  center_depth_arg,
std::size_t  compseg_insert_index,
double  start,
double  end 
)

◆ updateSegmentRST()

void Opm::Connection::updateSegmentRST ( int  segment_number_arg,
double  center_depth_arg 
)
The documentation for this class was generated from the following file: