kappa_sdk.keg5.Keg5WellPropertyInputs#

class kappa_sdk.keg5.Keg5WellPropertyInputs(name, uwi, x, y, permeability, porosity, thickness, is_horizontal, radius, perforation_length, skin)[source]#

Class to store the properties to use to create a well in KEG5

Attributes

Keg5WellPropertyInputs.borehole_id

BoreholeId that will be used internally in KEG5 objects linked to this well

Keg5WellPropertyInputs.name

Name of the well

Keg5WellPropertyInputs.perforation_id

PerforationId that will be used internally in KEG5 objects linked to this well

Keg5WellPropertyInputs.permeability

Permeability to apply to the zone where the well is

Keg5WellPropertyInputs.porosity

Porosity to apply to the zone where the well is

Keg5WellPropertyInputs.radius

Well radius

Keg5WellPropertyInputs.skin

Skin

Keg5WellPropertyInputs.thickness

Permeability to apply to the zone where the well is

Keg5WellPropertyInputs.uwi

Unique well id of the well

Keg5WellPropertyInputs.well_id

WellId that will be used internally in KEG5 objects linked to this well

Keg5WellPropertyInputs.x

x well head coordinate

Keg5WellPropertyInputs.y

x well head coordinate

Methods

Keg5WellPropertyInputs.get_perforation_md_end(z_top)

Returns the md end to use for the well perforation, for both type of wells we take the last point of the well

Keg5WellPropertyInputs.get_perforation_md_start(z_top)

Returns the md start to use for the well perforation, for vertical wells: if the initial perforation length is undefined, we take md_start = well_md_start so the perforations will be present all along the well.

Keg5WellPropertyInputs.get_well_trajectory(z_top)

Calculates the trajectory of the well according to its type (horizontal of vertical)

Keg5WellPropertyInputs.get_well_type()

Parameters:

  • name (str)

  • uwi (str)

  • x (float)

  • y (float)

  • permeability (float)

  • porosity (float)

  • thickness (float)

  • is_horizontal (bool)

  • radius (float | None)

  • perforation_length (float | None)

  • skin (float | None)

On this page