opm-common
Opm::Network::Branch Class Reference

Public Types

enum  AlqEQ { OIL_DENSITY, GAS_DENSITY, ALQ_INPUT }
 

Public Member Functions

 Branch (const std::string &downtree_node, const std::string &uptree_node, int vfp_table, double alq)
 
 Branch (const std::string &downtree_node, const std::string &uptree_node, int vfp_table, AlqEQ alq_eq)
 
const std::string & downtree_node () const
 
const std::string & uptree_node () const
 
void set_uptree_node (const std::string &new_uptree_node)
 
std::optional< int > vfp_table () const
 
AlqEQ alq_eq () const
 
std::optional< double > alq_value (const Dimension &alq_dimension) const
 Artificial lift quantity for the branch. More...
 
bool operator== (const Branch &other) const
 
template<class Serializer >
void serializeOp (Serializer &serializer)
 

Static Public Member Functions

static AlqEQ AlqEqfromString (const std::string &input_string)
 
static Branch serializationTestObject ()
 

Member Function Documentation

◆ alq_value()

std::optional< double > Opm::Network::Branch::alq_value ( const Dimension alq_dimension) const

Artificial lift quantity for the branch.

Returns nullopt if the alq was defaulted. Otherwise the value will be converted to SI using the alq_dimension, which depends on the unit system and the ALQ type set in the branch's VFP table.


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