Opm::SummaryConfigNode Class Reference

Definition of a single summary vector. More...

#include <SummaryConfig.hpp>

Public Types
using	Category = Opm::EclIO::SummaryNode::Category
	Summary vector level (field, well, region, &c).
using	Type = Opm::EclIO::SummaryNode::Type
	Summary vector type (rates, cumulative, pressure, &c)

Public Member Functions
	SummaryConfigNode ()=default
	Default constructor. More...
	SummaryConfigNode (std::string keyword, const Category cat, KeywordLocation loc_arg)
	Constructor. More...
SummaryConfigNode &	parameterType (const Type type)
	Assign vector type. More...
SummaryConfigNode &	namedEntity (std::string name)
	Assign vector's named entity. More...
SummaryConfigNode &	number (const int num)
	Assign vector's numeric ID. More...
SummaryConfigNode &	isUserDefined (const bool userDefined)
	Assign vector's UDQ flag. More...
SummaryConfigNode &	fip_region (const std::string &fip_region)
	Assign vector's associated region name. More...
const std::string &	keyword () const
	Retrieve summary vector name.
Category	category () const
	Retrieve summary vector's level.
Type	type () const
	Retrieve summary vector's type.
const std::string &	namedEntity () const
	Retrieve summary vector's named entity.
int	number () const
	Retrieve summary vector's associated numeric ID.
bool	isUserDefined () const
	Retrieve summary vector's UDQ flag.
const std::string &	fip_region () const
	Retrieve summary vector's associated region.
std::string	uniqueNodeKey () const
	Retrieve a unique distinguishing identifier for this summary vector.
const KeywordLocation &	location () const
	Retrieve summary keyword location in input. More...
	operator EclIO::SummaryNode () const
	Convert summary vector definition to low-level SummaryNode object.
template<class Serializer >
void	serializeOp (Serializer &serializer)
	Convert between byte array and object representation. More...

Static Public Member Functions
static SummaryConfigNode	serializationTestObject ()
	Create a serialisation test object.

Detailed Description

Definition of a single summary vector.

Collects the vector name (summary keyword), the vector entity (e.g., a well or group name), the vector "number" (e.g., a cell or segment index), and any applicable region names (for region level vectors).

Constructor & Destructor Documentation

SummaryConfigNode() [1/2]

Opm::SummaryConfigNode::SummaryConfigNode ( )

default

Default constructor.

Resulting object is mostly usable as the target of a deserialisation operation.

SummaryConfigNode() [2/2]

Opm::SummaryConfigNode::SummaryConfigNode ( std::string  keyword, const Category  cat, KeywordLocation  loc_arg  )

explicit

Constructor.

Parameters

[in]	keyword	Summary vector name.
[in]	cat	Summary vector level.
[in]	loc_arg	Keyword location. Mostly for diagnostic purposes.

Member Function Documentation

fip_region()

SummaryConfigNode& Opm::SummaryConfigNode::fip_region

(

const std::string &

fip_region

)

Assign vector's associated region name.

Parameters

[in]

fip_region

Summary vector's associated region.

Returns

*this 

isUserDefined()

SummaryConfigNode& Opm::SummaryConfigNode::isUserDefined

(

const bool

userDefined

)

Assign vector's UDQ flag.

Parameters

[in]

userDefined

Whether or not vector is a user defined quantity.

Returns

*this 

location()

const KeywordLocation& Opm::SummaryConfigNode::location ( ) const

inline

Retrieve summary keyword location in input.

Mostly provided for diagnostic purposes.

namedEntity()

SummaryConfigNode& Opm::SummaryConfigNode::namedEntity

(

std::string

name

)

Assign vector's named entity.

Parameters

[in]

name

Summary vector's named entity such as a well or group name.

Returns

*this 

number()

SummaryConfigNode& Opm::SummaryConfigNode::number

(

const int

num

)

Assign vector's numeric ID.

Parameters

[in]

num

Summary vector's "number" such as a cell/connection index, a completion number or a segment number.

Returns

*this 

parameterType()

SummaryConfigNode& Opm::SummaryConfigNode::parameterType

(

const Type

type

)

Assign vector type.

Parameters

[in]

type

Summary vector type (e.g., rate, cumulative, ratio, pressure).

Returns

*this 

serializeOp()

template<class Serializer >

void Opm::SummaryConfigNode::serializeOp ( Serializer &  serializer )

inline

Convert between byte array and object representation.

Template Parameters

Serializer

Byte array conversion protocol.

Parameters

[in,out]

serializer

Byte array conversion object.

---

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

• opm/input/eclipse/EclipseState/SummaryConfig/SummaryConfig.hpp