Alfasim-sdk

Latest version: v2024.2

Safety actively analyzes 701427 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 3 of 5

0.14.0

===================

* Add Electric Submersible Pump (ESP) input for ``PumpEquipmentDescription``. The new inputs are:

- ``esp_table``: table created through ``TablePumpDescription``
- ``esp_speed_input_type``: type of speed input ``Constant`` or ``Transient``
- ``esp_speed``: constant speed value
- ``esp_speed_curve``: curve defining time vs speed values
- ``esp_number_of_stages``: number of stages for ESP
- ``esp_reference_density``: rated density used to defined the ``esp_table``

* **Breaking Change**: Change in ``PhysicsDescription``: split emulsion model into relative viscosity, droplet size, and inversion point models and a flag to activate the emulsion models.

* Examples on how to update previous .alfacase files with emulsion model:

- Relative viscosity model:

* Before::

emulsion_model: taylor1932

* After::

emulsion_model_enabled: True
emulsion_relative_viscosity_model: taylor1932

- Droplet size model:

- Before::

emulsion_model: hinze1955

- After::

emulsion_model_enabled: True
emulsion_droplet_size_model: hinze1955

- Inversion point model:

- Before::

emulsion_model: brinkman1952_and_yeh1964

- After::

emulsion_model_enabled: True
emulsion_inversion_point_model: brinkman1952_and_yeh1964

* **Breaking Change**: change signature of hook ``calculate_relative_emulsion_viscosity``. This hook is also receiving the fluid temperature and a flag indicating whether the dispersion is water in oil or oil in water;

* Add new emulsion relative viscosity models:

- ``pal_rhodes1989``;
- ``ronningsen1995``;
- ``volumetric_weight``;
- ``woelflin_1942``;
- ``barnea_mizrahi1976``;
- ``table_based``;

* Add emulsion constant inversion point model;

* Add emulsion relative viscosity tuning factor;

* Fix ``automatic_profile_frequency`` and ``automatic_trend_frequency`` parameters being ignored in ``convert_alfacase_to_description``;

0.13.0

===================

* Add black-oil properties to PVT Correlations case description ``PvtModelCorrelationDescription``

* **Breaking Change**: Change in ``PvtModelsDescription`` renamed experimental compositional models holder property from ``compositions`` to ``compositional``;

* Example on how to update previous .alfacase files with compositional PVT models:

- Before::

pvt_models:
compositions:
Compositional model 1:
equation_of_state_type: pvt_compositional_peng_robinson
... Other properties

- After::

pvt_models:
compositional:
Compositional model 1:
equation_of_state_type: pvt_compositional_peng_robinson
... Other properties

* **Breaking Change**: Change signature of hook ``update_internal_deposition_layer``. Now, instead of the deposition thickness, it is returned the phase index of phase being deposited and the thickness variation rate.
* **Breaking Change**: Change signature of hook ``calculate_relative_emulsion_viscosity`` and function ``get_relative_emulsion_viscosity``. Indices of continuous and dispersed fields were removed.
* Add ``ControllerTrendDescription``, a new type of trend available in ``TrendsOutputDescription``.
* Add method ``get_deposition_thickness`` to retrieve the current thickness of a phase deposited on pipe wall.
* Add ``flow_pattern_model`` and ``regime_capturing_mesh_treshold`` attributes to ``PipeDescription``.
* Add Combined PVT model description classes (``PvtModelCombinedDescription`` and ``CombinedFluidDescription``).

0.12.0

===================

* **Breaking Change**: Change in ``AnnulusDescription`` to support different types of annulus equipment. Now ``AnnulusDescription`` has an attribute ``AnnulusEquipmentDescription``, which holds a dict that can contain multiple different equipment types, for which the current available options are:

- ``LeakEquipmentDescription``;
- ``GasLiftValveEquipmentDescription``;

* Example on how to update previous .alfacase files with annulus equipment:

- Before::

annulus:
gas_lift_valve_equipment:
Gas Lift Valve (Well 1 > Annulus) 1:
position:
value: 100.0
unit: m
... Other properties

- After::

annulus:
equipment:
gas_lift_valves:
Gas Lift Valve (Well 1 > Annulus) 1:
position:
value: 100.0
unit: m
... Other properties

* Removed *force per square velocity* unit definition, it is present in the new barril version.

0.11.0

===================

* **Breaking Change**: Change ``TrendOutputDescription`` to support different trends types. Now trends in ``CaseOutputDescription`` are an object of ``TrendsOutputDescription`` that contains a list for each trend type. The available trend types are:

- ``PositionalPipeTrendDescription``;
- ``GlobalTrendDescription``;
- ``OverallPipeTrendDescription``;
- ``EquipmentTrendDescription``;
- ``SeparatorTrendDescription``;

* Add new API functions related to Multi-Field Description info: ``get_number_of_fields``, ``get_number_of_phases``, ``get_number_of_layers`` and ``get_number_of_phase_pairs``.
* Add new API functions related to Multi-Field Description phase and field ids: ``get_phase_id_of_fields``, ``get_field_ids_in_layer`` and ``get_phase_pair_id``.
* Add LeakEquipment equipment.
* Add SurgeVolumeOptionsDescription (optional, used by PositionalPipeTrendDescription to hold some input for surge volume curves calculation).

0.10.1

===================

* Temporarily pin ``strictyaml`` dependency due to conflicts.

0.10.0

===================

* Add a new category ``gas standard volume`` from quantity ``standard volume``.
* Add transient input for:
- ``MassSourceNode`` and ``MassSourceEquipment``: ``temperature``, ``volumetric_flow_rates_std``, ``mass_flow_rates``, ``total_mass_flow_rate``, ``water_cut``, ``gas_oil_ratio``;
- ``PressureNode`` and ``ReservoirInflowEquipment``: ``pressure``, ``temperature``, ``mass_fractions``, ``volume_fractions``, ``gas_liquid_ratio``, ``gas_oil_ratio``, ``water_cut``;
- ``LinearIPR``: ``well_index``;
- ``HeatSourceEquipment``: ``power``;
* Add two new hooks to calculate solids model (for slurry viscosity and slip velocity).
* **Breaking Change**: Change ``OpeningCurveDescription`` (``opening_curve`` attribute) for ``Curve`` from barril.
* **Breaking Change**: Change signature of ``HOOK_INITIALIZE_STATE_VARIABLES_CALCULATOR``.
* **Breaking Change**: Change signature of ``HOOK_CALCULATE_RELATIVE_EMULSION_VISCOSITY``.
* Add new API function ``get_relative_emulsion_viscosity`` which is a helper function that can be used in the Hooks of Liquid-Liquid Mechanistic Model.

Page 3 of 5

© 2025 Safety CLI Cybersecurity Inc. All Rights Reserved.