Alfasim-sdk

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

* **Breaking Change**: Available units for category ``angle per time`` have been restricted to ``Hz``, ``rpm`` and ``rad/s`` only;

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

* Hot fix release, loosing pin requirements for `barril`.

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

* Problem during deploy.

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

* Problem during deploy.

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

* 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``;

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

* 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``).