kappa_sdk.pvt.PVT#

class kappa_sdk.pvt.PVT(context, id, name, technical_object_id, labels, cluster_apis, pvt_dto_converter)[source]#

Attributes

PVT.eos_parameters

Gets the EOS model parameters.

PVT.field_id

Gets the id of the field that contains this PVT.

PVT.flash_inputs

Gets the stored flash presets.

PVT.fluid_type

Gets the fluid type value.

PVT.id

Gets the unique id of this PVT.

PVT.labels

Gets the labels associated with this PVT.

PVT.name

Gets the name of this PVT.

PVT.parameters

Gets the time-dependent parameter sets.

PVT.properties

Retrieves the properties specific to the Black Oil PVT type.

PVT.reference_phase

Gets the reference phase.

PVT.technical_object_id

Gets the technical object id associated with this PVT.

PVT.type

Gets the type of this PVT.

PVT.well_id

Gets the id of the well associated with this PVT.

Methods

PVT.compute_pseudo_pressures(temperature, ...)

PVT.convert_rates(field_pressures, ...)

PVT.flash_black_oil_process(temperature, ...)

Compute a flash on black oil PVT

PVT.flash_eos_process(temperature, pressure, ...)

Compute a flash on EoS PVT

PVT.get_artm_parameters()

Parameters:

  • context (KAContext)

  • id (str)

  • name (str)

  • technical_object_id (str)

  • labels (List[str] | None)

  • cluster_apis (ClusterAPIS)

  • pvt_dto_converter (PVTDtoConverter)

__init__(context, id, name, technical_object_id, labels, cluster_apis, pvt_dto_converter)[source]#
Parameters:

  • context (KAContext)

  • id (str)

  • name (str)

  • technical_object_id (str)

  • labels (List[str] | None)

  • cluster_apis (ClusterAPIS)

  • pvt_dto_converter (PVTDtoConverter)

Return type:

None

property field_id: str#

Gets the id of the field that contains this PVT.

property well_id: str | None#

Gets the id of the well associated with this PVT.

property id: str#

Gets the unique id of this PVT.

property name: str#

Gets the name of this PVT.

property technical_object_id: str#

Gets the technical object id associated with this PVT.

property labels: List[str] | None#

Gets the labels associated with this PVT.

property type: PVTTypeEnum#

Gets the type of this PVT.

property properties: List[BlackOilPvtProperty]#

Retrieves the properties specific to the Black Oil PVT type.

This property checks if the current PVT type is black_oil. If so, it builds and returns the relevant PVT properties using the appropriate converter. Otherwise, an error is raised indicating that the properties are only available for the black_oil type.

Returns:

List[BlackOilPvtProperty] – A list of BlackOilPvtProperty objects representing the PVT properties for the black_oil PVT type.

Raises:

ValueError – If the current PVT type is not black_oil.

property fluid_type: PVTFluidTypeEnum#

Gets the fluid type value. Only available for black oil PVT.

Returns:

PVTFluidTypeEnum – The fluid type value.

property reference_phase: str | None#

Gets the reference phase. Only available for black oil PVT.

Returns:

Optional[str] – The reference phase, or None if not set.

property parameters: List[BlackOilPvtParameters]#

Gets the time-dependent parameter sets. Only available for black oil PVT.

Returns:

List[BlackOilPvtParameters] – One entry per configuration start date.

property eos_parameters: EosPvtParameters | None#

Gets the EOS model parameters. Only available for EOS PVT.

Returns:

Optional[EosPvtParameters] – The EOS parameters, or None if not set.

property flash_inputs: List[EosFlashInput]#

Gets the stored flash presets. Only available for EOS PVT.

Returns:

List[EosFlashInput] – The stored EOS flash presets.

flash_black_oil_process(temperature, pressure, pb_imposed, gor_or_pb=None)[source]#

Compute a flash on black oil PVT

Parameters:

  • temperature (float)

  • pressure (float)

  • pb_imposed (bool)

  • gor_or_pb (float | None)

Return type:

BlackOilFlashResults

flash_eos_process(temperature, pressure, extended, water_molar_fraction=None, salinity=None)[source]#

Compute a flash on EoS PVT

Parameters:

  • temperature (float)

  • pressure (float)

  • extended (bool)

  • water_molar_fraction (float | None)

  • salinity (float | None)

Return type:

EosFlashResults

compute_pseudo_pressures(temperature, rock_compressibility, pressure_range_min, pressure_range_max, pressure_range_steps, sw=None)[source]#
Parameters:

  • temperature (float)

  • rock_compressibility (float)

  • pressure_range_min (float)

  • pressure_range_max (float)

  • pressure_range_steps (int)

  • sw (float | None)

Return type:

PseudoPressuresResults

convert_rates(field_pressures, field_temperatures, surface_pressures, surface_temperatures, standard_oil_rates, standard_gas_rates)[source]#
Parameters:

  • field_pressures (List[List[float]])

  • field_temperatures (List[List[float]])

  • surface_pressures (List[List[float]])

  • surface_temperatures (List[List[float]])

  • standard_oil_rates (List[float])

  • standard_gas_rates (List[float])

Return type:

RateConversionResults

get_artm_parameters()[source]#
Return type:

AutomaticRtmParametersDto