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. More...
typedef const_iterator	iterator
	The iterator type (always const). More...

Public Member Functions
	WellConnections ()=default
	WellConnections (const std::vector< OpmWellType > &wells, const std::array< int, 3 > &cartesianSize, const std::vector< int > &cartesian_to_compressed)
	Constructor. More...
	WellConnections (const std::vector< OpmWellType > &wells, const Dune::CpGrid &cpGrid)
	Constructor. More...
void	init (const std::vector< OpmWellType > &wells, 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. More...
const_iterator	end () const
	Get the end iterator. More...
std::size_t	size () const
	\breif Get the number of wells More...

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.

Member Typedef Documentation

const_iterator

typedef std::vector<std::set<int>>::const_iterator Dune::cpgrid::WellConnections::const_iterator

The const iterator type.

iterator

typedef const_iterator Dune::cpgrid::WellConnections::iterator

The iterator type (always const).

Constructor & Destructor Documentation

WellConnections() [1/3]

Dune::cpgrid::WellConnections::WellConnections ( )

default

WellConnections() [2/3]

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

Constructor.

Parameters

wells	The eclipse information about the wells
cartesianSize	The logical cartesian size of the grid.
cartesian_to_compressed	Mapping of cartesian index compressed cell index. The compressed index is used to represent the well conditions.

WellConnections() [3/3]

Dune::cpgrid::WellConnections::WellConnections	(	const std::vector< OpmWellType > &	wells,
		const Dune::CpGrid &	cpGrid
	)

Constructor.

Parameters

wells	The eclipse information about the wells
cpGrid	The corner point grid

Member Function Documentation

begin()

const_iterator Dune::cpgrid::WellConnections::begin ( ) const

inline

Get a begin iterator.

end()

const_iterator Dune::cpgrid::WellConnections::end ( ) const

inline

Get the end iterator.

init()

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

Initialze the data of the container.

Parameters

schedule	The eclipse information
cartesianSize	The logical cartesian size of the grid.
cartesian_to_compressed	Mapping 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

i	The index of the well (position of the well in the eclipse schedule.

Returns

The set of compressed indices of cells perforated by the well.

size()

std::size_t Dune::cpgrid::WellConnections::size ( ) const

inline

\breif Get the number of wells

---

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

• WellConnections.hpp