Sparse collection of cells, and their properties, intersected by one or more well connections.
More...
#include <CompletedCells.hpp>
|
struct | Cell |
| Identification and associate properties of cell intersected by one or more well connections. More...
|
|
|
static CompletedCells | serializationTestObject () |
| Create a serialisation test object.
|
|
Sparse collection of cells, and their properties, intersected by one or more well connections.
◆ CompletedCells() [1/3]
Opm::CompletedCells::CompletedCells |
( |
| ) |
|
|
default |
Default constructor.
Creates a collection that is only usable as the target of a deserialisation operation.
◆ CompletedCells() [2/3]
Opm::CompletedCells::CompletedCells |
( |
const GridDims & |
dims | ) |
|
|
explicit |
Constructor.
- Parameters
-
[in] | dims | Host grid's Cartesian dimensions. Needed to translate between linearised Cartesian indices and (I,J,K) tuples. |
◆ CompletedCells() [3/3]
Opm::CompletedCells::CompletedCells |
( |
std::size_t |
nx, |
|
|
std::size_t |
ny, |
|
|
std::size_t |
nz |
|
) |
| |
Constructor.
- Parameters
-
[in] | nx | Host grid's Cartesian dimension in the X direction. |
[in] | ny | Host grid's Cartesian dimension in the Y direction. |
[in] | nz | Host grid's Cartesian dimension in the Z direction. |
◆ get()
Retrieve intersected cell.
Will throw an exception if the cell does not exist in the current collection.
- Parameters
-
[in] | i | Cell's Cartesian I index relative to grid's origin. |
[in] | j | Cell's Cartesian J index relative to grid's origin. |
[in] | k | Cell's Cartesian K index relative to grid's origin. |
- Returns
- Intersected cell at specified coordinates.
◆ operator==()
bool Opm::CompletedCells::operator== |
( |
const CompletedCells & |
other | ) |
const |
Equality predicate.
- Parameters
-
[in] | other | Object against which will be tested for equality. |
- Returns
- Whether or not is the same as
other
.
◆ serializeOp()
void Opm::CompletedCells::serializeOp |
( |
Serializer & |
serializer | ) |
|
|
inline |
Convert between byte array and object representation.
- Template Parameters
-
- Parameters
-
[in,out] | serializer | Byte array conversion object. |
◆ try_get()
Retrieve, and possibly create, an intersected cell.
Will insert a cell object into the collection if none exist at specified coordinate.
- Parameters
-
[in] | i | Cell's Cartesian I index relative to grid's origin. |
[in] | j | Cell's Cartesian J index relative to grid's origin. |
[in] | k | Cell's Cartesian K index relative to grid's origin. |
- Returns
- Cell object and existence status. The existence status is 'false' if a new cell object was inserted into the collection as a result of this request and 'true' otherwise.
The documentation for this class was generated from the following files:
- opm/input/eclipse/Schedule/CompletedCells.hpp
- opm/input/eclipse/Schedule/CompletedCells.cpp