Dune::cpgrid::WellConnections Class Reference

A class calculating and representing all connections of wells. More...

#include <WellConnections.hpp>

Public Types

typedef std::vector< std::set< int > >::const_iterator const_iterator
 The const iterator type.
 
typedef const_iterator iterator
 The iterator type (always const).
 

Public Member Functions

 WellConnections (const OpmEclipseStateType &eclipseState, const std::array< int, 3 > &cartesianSize, const std::vector< int > &cartesian_to_compressed)
 Constructor. More...
 
void init (const OpmEclipseStateType &eclipseState, const std::array< int, 3 > &cartesianSize, const std::vector< int > &cartesian_to_compressed)
 Initialze the data of the container. More...
 
const std::set< int > & operator[] (std::size_t i) const
 Access all connections of a well. More...
 
const_iterator begin () const
 Get a begin iterator.
 
const_iterator end () const
 Get the end iterator.
 
std::size_t size () const
 Get the number of wells
 

Detailed Description

A class calculating and representing all connections of wells.

Wells are identified by their position as exported by the wells method of the eclipse parser. For each well the container stores at the well index all indices of cells that the well perforates.

Constructor & Destructor Documentation

◆ WellConnections()

Dune::cpgrid::WellConnections::WellConnections ( const OpmEclipseStateType &  eclipseState,
const std::array< int, 3 > &  cartesianSize,
const std::vector< int > &  cartesian_to_compressed 
)

Constructor.

Parameters
eclipseStateThe eclipse information
cartesianSizeThe logical cartesian size of the grid.
cartesian_to_compressedMapping of cartesian index compressed cell index. The compressed index is used to represent the well conditions.

Member Function Documentation

◆ init()

void Dune::cpgrid::WellConnections::init ( const OpmEclipseStateType &  eclipseState,
const std::array< int, 3 > &  cartesianSize,
const std::vector< int > &  cartesian_to_compressed 
)

Initialze the data of the container.

Parameters
eclipseStateThe eclipse information
cartesianSizeThe logical cartesian size of the grid.
cartesian_to_compressedMapping of cartesian index compressed cell index. The compressed index is used to represent the well conditions.

◆ operator[]()

const std::set<int>& Dune::cpgrid::WellConnections::operator[] ( std::size_t  i) const
inline

Access all connections of a well.

Parameters
iThe index of the well (position of the well in the eclipse schedule.
Returns
The set of compressed indices of cells perforated by the well.

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