#include <CompdatWrapper.hpp>
A wrapper class to provide convenient access to the data of the 'COMPDAT' keyword.
int Opm::CompdatWrapper::coordinateI |
( |
int |
wellIdx | ) |
const |
|
inline |
Return the I-coordinate of the well.
int Opm::CompdatWrapper::coordinateJ |
( |
int |
wellIdx | ) |
const |
|
inline |
Return the J-coordinate of the well.
int Opm::CompdatWrapper::coordinateKLower |
( |
int |
wellIdx | ) |
const |
|
inline |
Return the lower K-coordinate of the well.
int Opm::CompdatWrapper::coordinateKUpper |
( |
int |
wellIdx | ) |
const |
|
inline |
Return the upper K-coordinate of the well.
double Opm::CompdatWrapper::dFactor |
( |
int |
wellIdx | ) |
const |
|
inline |
Return the "D-factor" (for non-Darcy flow regimes) to be used for the well.
double Opm::CompdatWrapper::intrinsicPermeability |
( |
int |
wellIdx | ) |
const |
|
inline |
Return the effective intrinisic permeability to be used for the well.
int Opm::CompdatWrapper::numWells |
( |
| ) |
const |
|
inline |
Return the number of injection wells.
std::string Opm::CompdatWrapper::penetrationDirection |
( |
int |
wellIdx | ) |
const |
|
inline |
Return the direction into which the cells are penetrated by the well.
This is one of:
- X
- Y
- Z
- FX (fracture in X direction)
- FY (fracture in Y direction)
int Opm::CompdatWrapper::saturationTableIndex |
( |
int |
wellIdx | ) |
const |
|
inline |
Return the index of the saturation table to calculate the relative permebilities of the connection.
double Opm::CompdatWrapper::skinFactor |
( |
int |
wellIdx | ) |
const |
|
inline |
Return the skin factor to be used for the well.
double Opm::CompdatWrapper::transmissibilityFactor |
( |
int |
wellIdx | ) |
const |
|
inline |
Return the transmissibility factor to be used for the connection.
double Opm::CompdatWrapper::wellDiameter |
( |
int |
wellIdx | ) |
const |
|
inline |
Return the diameter of the well.
std::string Opm::CompdatWrapper::wellName |
( |
int |
wellIdx | ) |
const |
|
inline |
Return the human-readable name of the well with a given index.
std::string Opm::CompdatWrapper::wellStatus |
( |
int |
wellIdx | ) |
const |
|
inline |
Return whether a well is open or closed.
This is one of:
- OPEN: Well injects
- SHUT: Well does not influence the reservoir
- AUTO: Simulation selects one of the above depending in the well parameters and reservoir conditions at the well.
The documentation for this class was generated from the following file: