Merge pull request #247 from ESSS/fb-ASIM-4672-missing-emulsion-models

Fb asim 4672 missing emulsion models

CHANGELOG.rst

@@ -51,6 +51,20 @@ History
         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;
 
 0.13.0 (2022-04-19)
 ===================

docs/source/alfacase_definitions/PhysicsDescription.txt

@@ -15,6 +15,10 @@
             keep_former_results: bool = False
             emulsion_model_enabled: bool = True
             emulsion_relative_viscosity_model: \ :class:`EmulsionRelativeViscosityModelType <alfasim_sdk._internal.constants.EmulsionRelativeViscosityModelType>`\  = EmulsionRelativeViscosityModelType.ModelDefault
+            emulsion_pal_rhodes_phi_rel_100: \ :class:`Scalar <barril.units.Scalar>`\  = Scalar(0.765, '-', 'dimensionless')
+            emulsion_woelflin_a: \ :class:`Scalar <barril.units.Scalar>`\  = Scalar(4.2, '-', 'dimensionless')
+            emulsion_woelflin_b: \ :class:`Scalar <barril.units.Scalar>`\  = Scalar(2.5, '-', 'dimensionless')
+            emulsion_table_based_rel_visc_curve: \ :class:`Curve <barril.curve.curve.Curve>`\  = Curve(-, m3/m3)[(1.0, 0.0)]
             emulsion_relative_viscosity_tuning_factor: \ :class:`Curve <barril.curve.curve.Curve>`\  = Curve(-, m3/m3)[(1.0, 0.0)]
             emulsion_droplet_size_model: \ :class:`EmulsionDropletSizeModelType <alfasim_sdk._internal.constants.EmulsionDropletSizeModelType>`\  = EmulsionDropletSizeModelType.ModelDefault
             emulsion_inversion_point_model: \ :class:`EmulsionInversionPointModelType <alfasim_sdk._internal.constants.EmulsionInversionPointModelType>`\  = EmulsionInversionPointModelType.ModelDefault
@@ -36,6 +40,22 @@
             keep_former_results: boolean  # optional
             emulsion_model_enabled: boolean  # optional
             emulsion_relative_viscosity_model: \ :class:`EmulsionRelativeViscosityModelType <alfasim_sdk._internal.constants.EmulsionRelativeViscosityModelType>`\  # optional
+            emulsion_pal_rhodes_phi_rel_100:  # optional
+                value: number
+                unit: string
+            emulsion_woelflin_a:  # optional
+                value: number
+                unit: string
+            emulsion_woelflin_b:  # optional
+                value: number
+                unit: string
+            emulsion_table_based_rel_visc_curve:  # optional
+                image:
+                    values: [number]
+                    unit: string
+                domain:
+                    values: [number]
+                    unit: string
             emulsion_relative_viscosity_tuning_factor:  # optional
                 image:
                     values: [number]

src/alfasim_sdk/_internal/alfacase/alfacase_to_case.py

@@ -361,9 +361,6 @@ def get_curve_loader(
                 domain_category, from_domain_unit
             ),
         )
-    assert category is not None or from_unit is not None, (
-        "At least the category or the unit must be provided in " "get_curve_loader"
-    )
     return partial(
         load_curve,
         category=_obtain_category_for_scalar(category, from_unit),
@@ -1898,6 +1895,10 @@ def load_physics_description(
         'emulsion_model': get_enum_loader(enum_class=constants.EmulsionModelType),
         'emulsion_model_enabled': load_value,
         'emulsion_relative_viscosity_model': get_enum_loader(enum_class=constants.EmulsionRelativeViscosityModelType),
+        'emulsion_pal_rhodes_phi_rel_100': get_scalar_loader(category='dimensionless'),
+        'emulsion_woelflin_a': get_scalar_loader(category='dimensionless'),
+        'emulsion_woelflin_b': get_scalar_loader(category='dimensionless'),
+        'emulsion_table_based_rel_visc_curve': get_curve_loader(category='dimensionless', domain_category='volume per volume'),
         'emulsion_relative_viscosity_tuning_factor': get_curve_loader(category='dimensionless', domain_category='volume per volume'),
         'emulsion_droplet_size_model': get_enum_loader(enum_class=constants.EmulsionDropletSizeModelType),
         'emulsion_inversion_point_model': get_enum_loader(enum_class=constants.EmulsionInversionPointModelType),

src/alfasim_sdk/_internal/alfacase/case_description.py

@@ -2669,6 +2669,17 @@ class PhysicsDescription:
     emulsion_relative_viscosity_model = attrib_enum(
         default=constants.EmulsionRelativeViscosityModelType.ModelDefault
     )
+    emulsion_pal_rhodes_phi_rel_100 = attrib_scalar(
+        default=Scalar("dimensionless", 0.765, "-")
+    )
+    emulsion_woelflin_a = attrib_scalar(default=Scalar("dimensionless", 4.2, "-"))
+    emulsion_woelflin_b = attrib_scalar(default=Scalar("dimensionless", 2.5, "-"))
+    emulsion_table_based_rel_visc_curve = attrib_curve(
+        default=Curve(
+            image=Array("dimensionless", [1.0], "-"),
+            domain=Array("volume per volume", [0.0], "m3/m3"),
+        )
+    )
 
     emulsion_relative_viscosity_tuning_factor = attrib_curve(
         default=Curve(
@@ -2703,13 +2714,12 @@ def _validate_inversion_point_water_cut(self, attribute, value):
 
     @emulsion_relative_viscosity_tuning_factor.validator
     def _validate_emulsion_relative_viscosity_tuning_factor(self, attribute, value):
-        assert isinstance(value, Curve), "Invalid tuning factor curve"
         domain = value.GetDomain()
         assert domain.GetCategory() == "volume per volume", "Invalid water-cut category"
         domain_values = np.asarray(domain.GetValues("m3/m3"))
         assert (
             np.min(domain_values) >= 0.0 and np.max(domain_values) <= 1.0
-        ), "Invlid water-cut values"
+        ), "Invalid water-cut values"
         image = value.GetImage()
         assert (
             image.GetCategory() == "dimensionless"

src/alfasim_sdk/_internal/alfacase/schema.py

@@ -382,7 +382,16 @@
         Optional("restart_filepath"): Str(),
         Optional("keep_former_results"): Bool(),
         Optional("emulsion_model_enabled"): Bool(),
-        Optional("emulsion_relative_viscosity_model"): Enum(['model_default', 'taylor1932', 'brinkman1952', 'mooney1951a', 'mooney1951b', 'from_plugin']),
+        Optional("emulsion_relative_viscosity_model"): Enum(['model_default', 'taylor1932', 'brinkman1952', 'mooney1951a', 'mooney1951b', 'pal_rhodes1989', 'ronningsen1995', 'volumetric_weight', 'woelflin_1942', 'barnea_mizrahi1976', 'table_based', 'from_plugin']),
+        Optional("emulsion_pal_rhodes_phi_rel_100"): Map({"value": Float(), "unit": Str()}),
+        Optional("emulsion_woelflin_a"): Map({"value": Float(), "unit": Str()}),
+        Optional("emulsion_woelflin_b"): Map({"value": Float(), "unit": Str()}),
+        Optional("emulsion_table_based_rel_visc_curve"): Map(
+            {
+                "image": Map({"values": Seq(Float()), "unit": Str()}),
+                "domain": Map({"values": Seq(Float()), "unit": Str()}),
+            }
+        ),
         Optional("emulsion_relative_viscosity_tuning_factor"): Map(
             {
                 "image": Map({"values": Seq(Float()), "unit": Str()}),
@@ -1114,5 +1123,5 @@
         Optional("walls"): Seq(wall_description_schema),
     }
 )
-# [[[end]]] (checksum: d29339ac713abc642330cf5e7fe100b7)
+# [[[end]]] (checksum: f1c874c32714ece81b49496d4dc106a0)
 # fmt: on

src/alfasim_sdk/_internal/constants.py

@@ -114,6 +114,12 @@ class EmulsionRelativeViscosityModelType(Enum):
     Brinkman1952 = "brinkman1952"
     Mooney1951a = "mooney1951a"
     Mooney1951b = "mooney1951b"
+    PalRhodes1989 = "pal_rhodes1989"
+    Ronningsen1995 = "ronningsen1995"
+    VolumetricWeight = "volumetric_weight"
+    Woelflin1942 = "woelflin_1942"
+    BarneaMizrahi1976 = "barnea_mizrahi1976"
+    TableBased = "table_based"
     FromPlugin = "from_plugin"
 
 

src/alfasim_sdk/_internal/hook_specs.py

@@ -1785,13 +1785,13 @@ def calculate_relative_emulsion_viscosity(
     mu_disp: "double",
     mu_cont: "double",
     alpha_disp_in_layer: "double",
+    T: "double",
+    water_in_oil: "bool",
 ) -> "int":
     """
-    **c++ signature** : ``HOOK_RELATIVE_EMULSION_VISCOSITY(void* ctx, double* mu_r, double mu_disp, double mu_cont, double alpha_disp_in_layer)``
+    **c++ signature** : ``HOOK_RELATIVE_EMULSION_VISCOSITY(void* ctx, double* mu_r, double mu_disp, double mu_cont, double alpha_disp_in_layer, double T, bool water_in_oil)``
 
-    Internal `hook` to calculate the relative emulsion viscosity in the Emulsion Model.
-    This `hook` will be used in the emulsion model to calculate the apparent viscosity of the emulsion
-    (Continuous field + dispersed field = layer).
+    Internal `hook` to calculate the relative emulsion viscosity of an oil-water dispersion (emulsion)
 
     The relative emulsion viscosity is defined by:
 
@@ -1810,7 +1810,8 @@ def calculate_relative_emulsion_viscosity(
 
     The output variable ``mu_r`` is the relative emulsion viscosity, ``mu_disp`` is the dispersed field
     viscosity, ``mu_cont`` is the continuous field viscosity and ``alpha_disp_in_layer`` is the volume
-    fraction of dispersed field in the layer.
+    fraction of dispersed field in the layer (dispersed field plus continuous field), T is the fluid temperature,
+    and water_in_oil is true when water is the dispersed phase and false otherwise.
 
     This `hook` allows the implementation of the relative emulsion viscosity correlation. Once the plugin
     installed it is important to be selected in the emulsion model configuration inside the Physics data
@@ -1821,6 +1822,8 @@ def calculate_relative_emulsion_viscosity(
     :param mu_disp: Dispersed field viscosity
     :param mu_cont: Continuous field viscosity
     :param alpha_disp_in_layer: Volume fraction of dispersed field in layer.
+    :param T: Fluid temperature
+    :param water_in_oil: True when water is the dispersed phase
 
     :returns: Return OK if successful or anything different if failed
 
@@ -1830,7 +1833,7 @@ def calculate_relative_emulsion_viscosity(
         :linenos:
         :emphasize-lines: 1
 
-        HOOK_RELATIVE_EMULSION_VISCOSITY(ctx, mu_r, mu_disp, mu_cont, alpha_disp_in_layer)
+        HOOK_RELATIVE_EMULSION_VISCOSITY(ctx, mu_r, mu_disp, mu_cont, alpha_disp_in_layer, T, water_in_oil)
         {
             // Einstein (1906) relative viscosity model
             mu_r = 1.0 + 2.5 * alpha_disp_in_layer;

src/alfasim_sdk/alfasim_sdk_api/api.h

@@ -908,14 +908,18 @@ DLL_EXPORT int get_liq_liq_shear_force_per_volume_input_variable(
     @param[in] mu_disp Dispersed Field Viscosity [Pa.s].
     @param[in] mu_cont Continuous Field Viscosity [Pa.s].
     @param[in] alpha_disp_in_layer Dispersed Field Volume Fraction in the layer (emulsion) [m3 of dispersed field /m3 of layer].
+    @param[in] T Fluid temperature [K].
+    @param[in] water_in_oil True when water is dispersed in oil, otherwise it is a dispersion of oil in water.
     @return An #error_code value.
 */
 DLL_EXPORT int get_relative_emulsion_viscosity(
     void* ctx,
     double* out,
     double mu_disp,
     double mu_cont,
-    double alpha_disp_in_layer
+    double alpha_disp_in_layer,
+    double T,
+    bool water_in_oil
 );
 
 #endif

src/alfasim_sdk/alfasim_sdk_api/detail/api_pointers.h

@@ -90,7 +90,7 @@ typedef int (*get_tracer_partition_coefficient_func)(void* ctx, double* out, voi
 typedef int (*get_plugin_input_data_multiplereference_selected_size_func)(void* ctx, int* indexes_size, const char* plugin_id, const char* var_name);
 typedef int (*get_input_variable_func)(void* ctx, double* out, const char* var_name, int phase_id);
 typedef int (*get_ucm_fluid_geometrical_properties_func)(void* ctx, double* S_w, double* S_i, double* H, double alpha_G, double D);
-typedef int (*get_relative_emulsion_viscosity_func)(void* ctx, double* out, double mu_disp, double mu_cont, double alpha_disp_in_layer, int disp_field_id, int cont_field_id);
+typedef int (*get_relative_emulsion_viscosity_func)(void* ctx, double* out, double mu_disp, double mu_cont, double alpha_disp_in_layer, double T, bool water_in_oil);
 
 struct ALFAsimSDK_API {
 #if defined(_WIN32)

tests/alfacase/test_generate_case_description_docstring/test_generate_case_description_docstring_PhysicsDescription_.txt

@@ -15,6 +15,10 @@
             keep_former_results: bool = False
             emulsion_model_enabled: bool = True
             emulsion_relative_viscosity_model: \ :class:`EmulsionRelativeViscosityModelType <alfasim_sdk._internal.constants.EmulsionRelativeViscosityModelType>`\  = EmulsionRelativeViscosityModelType.ModelDefault
+            emulsion_pal_rhodes_phi_rel_100: \ :class:`Scalar <barril.units.Scalar>`\  = Scalar(0.765, '-', 'dimensionless')
+            emulsion_woelflin_a: \ :class:`Scalar <barril.units.Scalar>`\  = Scalar(4.2, '-', 'dimensionless')
+            emulsion_woelflin_b: \ :class:`Scalar <barril.units.Scalar>`\  = Scalar(2.5, '-', 'dimensionless')
+            emulsion_table_based_rel_visc_curve: \ :class:`Curve <barril.curve.curve.Curve>`\  = Curve(-, m3/m3)[(1.0, 0.0)]
             emulsion_relative_viscosity_tuning_factor: \ :class:`Curve <barril.curve.curve.Curve>`\  = Curve(-, m3/m3)[(1.0, 0.0)]
             emulsion_droplet_size_model: \ :class:`EmulsionDropletSizeModelType <alfasim_sdk._internal.constants.EmulsionDropletSizeModelType>`\  = EmulsionDropletSizeModelType.ModelDefault
             emulsion_inversion_point_model: \ :class:`EmulsionInversionPointModelType <alfasim_sdk._internal.constants.EmulsionInversionPointModelType>`\  = EmulsionInversionPointModelType.ModelDefault
@@ -36,6 +40,22 @@
             keep_former_results: boolean  # optional
             emulsion_model_enabled: boolean  # optional
             emulsion_relative_viscosity_model: \ :class:`EmulsionRelativeViscosityModelType <alfasim_sdk._internal.constants.EmulsionRelativeViscosityModelType>`\  # optional
+            emulsion_pal_rhodes_phi_rel_100:  # optional
+                value: number
+                unit: string
+            emulsion_woelflin_a:  # optional
+                value: number
+                unit: string
+            emulsion_woelflin_b:  # optional
+                value: number
+                unit: string
+            emulsion_table_based_rel_visc_curve:  # optional
+                image:
+                    values: [number]
+                    unit: string
+                domain:
+                    values: [number]
+                    unit: string
             emulsion_relative_viscosity_tuning_factor:  # optional
                 image:
                     values: [number]

tests/alfacase/test_generate_case_schema/test_generate_schema_for_all_cases.txt

@@ -394,7 +394,16 @@ physics_description_schema = Map(
         Optional("restart_filepath"): Str(),
         Optional("keep_former_results"): Bool(),
         Optional("emulsion_model_enabled"): Bool(),
-        Optional("emulsion_relative_viscosity_model"): Enum(['model_default', 'taylor1932', 'brinkman1952', 'mooney1951a', 'mooney1951b', 'from_plugin']),
+        Optional("emulsion_relative_viscosity_model"): Enum(['model_default', 'taylor1932', 'brinkman1952', 'mooney1951a', 'mooney1951b', 'pal_rhodes1989', 'ronningsen1995', 'volumetric_weight', 'woelflin_1942', 'barnea_mizrahi1976', 'table_based', 'from_plugin']),
+        Optional("emulsion_pal_rhodes_phi_rel_100"): Map({"value": Float(), "unit": Str()}),
+        Optional("emulsion_woelflin_a"): Map({"value": Float(), "unit": Str()}),
+        Optional("emulsion_woelflin_b"): Map({"value": Float(), "unit": Str()}),
+        Optional("emulsion_table_based_rel_visc_curve"): Map(
+            {
+                "image": Map({"values": Seq(Float()), "unit": Str()}),
+                "domain": Map({"values": Seq(Float()), "unit": Str()}),
+            }
+        ),
         Optional("emulsion_relative_viscosity_tuning_factor"): Map(
             {
                 "image": Map({"values": Seq(Float()), "unit": Str()}),