Opm::EclIO::SummaryNode Struct Reference

#include <SummaryNode.hpp>

Public Types
enum class	Category {   Well , Group , Field , Region ,   Block , Connection , Segment , Aquifer ,   Node , Miscellaneous , Network , Well_Lgr ,   Block_Lgr , Connection_Lgr }
enum class	Type {   Rate , Total , Ratio , Pressure ,   Count , Mode , ProdIndex , Undefined }
using	number_renderer = std::function< std::string(const SummaryNode &)>

Public Member Functions
std::string	unique_key () const
std::string	unique_key (number_renderer) const
bool	is_user_defined () const
std::optional< std::string >	display_name () const
std::optional< std::string >	display_number () const
std::optional< std::string >	display_number (number_renderer) const
bool	isRegionToRegion () const
std::pair< int, int >	regionToRegionNumbers () const

Static Public Member Functions
static Category	category_from_keyword (const std::string &, const std::unordered_set< std::string > &miscellaneous_keywords={})
static std::string	create_key_lgr_well (const std::string &keyword, const std::string &wgname, const std::string &lgrname)
static std::string	create_key_lgr_completion (const std::string &keyword, const std::string &wgname, const std::string &lgrname, int i, int j, int k)
static std::string	create_key_lgr_block (const std::string &keyword, const std::string &lgrname, int i, int j, int k)

Public Attributes
std::string	keyword
Category	category
Type	type
std::string	wgname
int	number
std::string	lgrname
int	lgri
int	lgrj
int	lgrk
size_t	smspecKeywordIndex
std::optional< std::string >	fip_region

Static Public Attributes
static constexpr int	default_number { std::numeric_limits<int>::min() }

Member Typedef Documentation

number_renderer

using Opm::EclIO::SummaryNode::number_renderer = std::function<std::string(const SummaryNode&)>

Member Enumeration Documentation

Category

enum class Opm::EclIO::SummaryNode::Category

strong

Enumerator
Well
Group
Field
Region
Block
Connection
Segment
Aquifer
Node
Miscellaneous
Network
Well_Lgr
Block_Lgr
Connection_Lgr

Type

enum class Opm::EclIO::SummaryNode::Type

strong

Enumerator
Rate
Total
Ratio
Pressure
Count
Mode
ProdIndex
Undefined

Member Function Documentation

category_from_keyword()

static Category Opm::EclIO::SummaryNode::category_from_keyword ( const std::string &  , const std::unordered_set< std::string > &  miscellaneous_keywords = {}  )

static

create_key_lgr_block()

static std::string Opm::EclIO::SummaryNode::create_key_lgr_block ( const std::string &  keyword, const std::string &  lgrname, int  i, int  j, int  k  )

static

create_key_lgr_completion()

static std::string Opm::EclIO::SummaryNode::create_key_lgr_completion ( const std::string &  keyword, const std::string &  wgname, const std::string &  lgrname, int  i, int  j, int  k  )

static

create_key_lgr_well()

static std::string Opm::EclIO::SummaryNode::create_key_lgr_well ( const std::string &  keyword, const std::string &  wgname, const std::string &  lgrname  )

static

display_name()

std::optional< std::string > Opm::EclIO::SummaryNode::display_name

(

)

const

display_number() [1/2]

std::optional< std::string > Opm::EclIO::SummaryNode::display_number

(

)

const

display_number() [2/2]

std::optional< std::string > Opm::EclIO::SummaryNode::display_number

(

number_renderer

)

const

is_user_defined()

bool Opm::EclIO::SummaryNode::is_user_defined

(

)

const

isRegionToRegion()

bool Opm::EclIO::SummaryNode::isRegionToRegion

(

)

const

regionToRegionNumbers()

std::pair< int, int > Opm::EclIO::SummaryNode::regionToRegionNumbers

(

)

const

unique_key() [1/2]

std::string Opm::EclIO::SummaryNode::unique_key

(

)

const

unique_key() [2/2]

std::string Opm::EclIO::SummaryNode::unique_key

(

number_renderer

)

const

Member Data Documentation

category

Category Opm::EclIO::SummaryNode::category

default_number

constexpr int Opm::EclIO::SummaryNode::default_number { std::numeric_limits<int>::min() }

staticconstexpr

fip_region

std::optional<std::string> Opm::EclIO::SummaryNode::fip_region

keyword

std::string Opm::EclIO::SummaryNode::keyword

lgri

int Opm::EclIO::SummaryNode::lgri

lgrj

int Opm::EclIO::SummaryNode::lgrj

lgrk

int Opm::EclIO::SummaryNode::lgrk

lgrname

std::string Opm::EclIO::SummaryNode::lgrname

number

int Opm::EclIO::SummaryNode::number

smspecKeywordIndex

size_t Opm::EclIO::SummaryNode::smspecKeywordIndex

type

Type Opm::EclIO::SummaryNode::type

wgname

std::string Opm::EclIO::SummaryNode::wgname

---

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

• SummaryNode.hpp