flownet.realization._simulation_keywords module

class flownet.realization._simulation_keywords.COMPDAT(date: datetime.date, well_name: str, i: int, j: int, k1: int, k2: int, rw: float, status: str = '1*', satnum: str = '1*', confact: str = '1*', kh: str = '1*', skin: str = '1*', dfact: str = '1*', direct: str = '1*')

Bases: flownet.realization._simulation_keywords.Keyword

The COMPDAT keyword defines how a well is connected to the reservoir by defining or modifying existing well connections. Ideally the connections should be declared in the correct sequence, starting with the connection nearest the well head and then working along the wellbore towards the bottom or toe of the well.

See the OPM Flow manual for further details.

_abc_impl = <_abc_data object>
bhp: float
gas_rate: float
name: str
oil_rate: float
thp: float
well_name: str
class flownet.realization._simulation_keywords.DATES(date)

Bases: flownet.realization._simulation_keywords.Keyword

This keyword advances the simulation to a given report date after which additional keywords may be entered to instruct OPM Flow to perform additional functions via the SCHEDULE section keywords, or further DATES data sets or keywords may be entered to advance the simulator to the next report date.

See the OPM Flow manual for further details.

_abc_impl = <_abc_data object>
bhp: float
gas_rate: float
name: str
oil_rate: float
thp: float
well_name: str
class flownet.realization._simulation_keywords.Keyword(date)

Bases: abc.ABC

Each simulation Keyword is a subclass of the Keyword-class - which enforces that a keyword is always linked to a particular date.

_abc_impl = <_abc_data object>
bhp: float
property date: datetime.date
gas_rate: float
name: str
oil_rate: float
thp: float
well_name: str
class flownet.realization._simulation_keywords.WCONHIST(date: datetime.date, well_name: str, prod_control_mode: str, status: str = '1*', oil_rate: float = nan, water_rate: float = nan, gas_rate: float = nan, salt_rate: float = nan, salt_total: float = nan, oil_total: float = nan, water_total: float = nan, gas_total: float = nan, vfp_table: str = '1*', artificial_lift: str = '1*', thp: float = nan, bhp: float = nan, temperature: float = nan)

Bases: flownet.realization._simulation_keywords.Keyword

The WCONHIST keyword defines production rates and pressures for wells that have been declared history matching wells by the use of this keyword. History matching wells are handled differently than ordinary wells that use the WCONPROD keyword for controlling their production targets and constraints. However, the wells still need to be defined like ordinary production wells using the WELSPECS keyword in the SCHEDULE section.

See the OPM Flow manual for further details.

_abc_impl = <_abc_data object>
bhp: float
gas_rate: float
name: str
oil_rate: float
thp: float
well_name: str
class flownet.realization._simulation_keywords.WCONINJH(date: datetime.date, well_name: str, inj_type: str, status: str = '1*', rate: float = nan, total: float = nan, bhp: float = nan, thp: float = nan, vfp_table: str = '1*', inj_control_mode: str = '1*')

Bases: flownet.realization._simulation_keywords.Keyword

The WCONINJH keyword defines injection rates and pressures for wells that have been declared history matching wells by the use of this keyword. History matching wells are handled differently then ordinary wells that use the WCONINJE keyword for controlling their injection targets and constraints. However, the wells still need to be defined like ordinary injection wells using the WELSPECS keyword in the SCHEDULE section.

See the OPM Flow manual for further details.

_abc_impl = <_abc_data object>
bhp: float
gas_rate: float
name: str
oil_rate: float
thp: float
well_name: str
class flownet.realization._simulation_keywords.WELSPECS(date: datetime.date, well_name: str, group_name: str, i: int, j: int, phase: str, ref_depth_bhp: str = '1*', drainage_radius: str = '1*', inflow_equation: str = '1*', shutin_instruction: str = '1*', crossflow: str = '1*', pvt_table: str = '1*', density_calc: str = '1*', fip: str = '1*')

Bases: flownet.realization._simulation_keywords.Keyword

The WELSPECS keyword defines the general well specification data for all well types, and must be used for all wells before any other well specification keywords are used in the input file. The keyword declares the name of well, the wellhead location and other key parameters.

See the OPM Flow manual for further details.

_abc_impl = <_abc_data object>
bhp: float
gas_rate: float
name: str
oil_rate: float
thp: float
well_name: str
class flownet.realization._simulation_keywords.WSALT(date: datetime.date, well_name: str, salt_concentration: float = nan)

Bases: flownet.realization._simulation_keywords.Keyword

The WSALT keyword defines the salt concentration of the injected water.

See the OPM Flow manual for further details.

_abc_impl = <_abc_data object>
bhp: float
gas_rate: float
name: str
oil_rate: float
thp: float
well_name: str
class flownet.realization._simulation_keywords.WTEMP(date: datetime.date, well_name: str, temperature: float = nan)

Bases: flownet.realization._simulation_keywords.Keyword

The WTEMP keyword defines the temperature of the injected water.

See the OPM Flow manual for further details.

_abc_impl = <_abc_data object>
bhp: float
gas_rate: float
name: str
oil_rate: float
thp: float
well_name: str