Add FluidMaterialConvectionCorrelation

Add a new transfer mechanism for fluid materials composed
by a parcel of radiation and convection.

ASIM-5943

CHANGELOG.rst

@@ -7,6 +7,7 @@ CHANGELOG
 
 * We have decided internally to revert the versioning schema back to SemVer, starting at ``1.0.0``, in order to improve better backward and forward compatibility support for plugins.
 * Fix bug related to Probabilistic History Matching result reader. The shape of result was wrong.
+* Add the heat transfer mechanism for fluid materials composed by a parcel of radiation and convection.
 
 
 2024.2 (2024-09-10)

docs/source/alfacase_definitions/PhysicsDescription.txt

@@ -25,6 +25,7 @@
             emulsion_inversion_water_cut: \ :class:`Scalar <barril.units.Scalar>`\  = Scalar(0.4, 'm3/m3', 'volume per volume')
             flash_model: \ :class:`FlashModel <alfasim_sdk._internal.constants.FlashModel>`\  = FlashModel.HydrocarbonAndWater
             correlations_package: \ :class:`CorrelationPackageType <alfasim_sdk._internal.constants.CorrelationPackageType>`\  = CorrelationPackageType.Classical
+            fluid_material_convection_correlation: \ :class:`FluidMaterialConvectionCorrelation <alfasim_sdk._internal.constants.FluidMaterialConvectionCorrelation>`\  = FluidMaterialConvectionCorrelation.HasanKabir1994
 
 .. tab:: Schema
 
@@ -70,3 +71,4 @@
                 unit: string
             flash_model: \ :class:`FlashModel <alfasim_sdk._internal.constants.FlashModel>`\  # optional
             correlations_package: \ :class:`CorrelationPackageType <alfasim_sdk._internal.constants.CorrelationPackageType>`\  # optional
+            fluid_material_convection_correlation: \ :class:`FluidMaterialConvectionCorrelation <alfasim_sdk._internal.constants.FluidMaterialConvectionCorrelation>`\  # optional

src/alfasim_sdk/__init__.py

@@ -295,6 +295,7 @@ def get_alfasim_sdk_api_path():
 from alfasim_sdk._internal.constants import WellConnectionPort
 from alfasim_sdk._internal.constants import WellIndexPhaseType
 from alfasim_sdk._internal.constants import ForchheimerCoefficientsOption
+from alfasim_sdk._internal.constants import FluidMaterialConvectionCorrelation
 
 
 # Plugins: Layouts imports
@@ -404,6 +405,7 @@ def get_alfasim_sdk_api_path():
     "FlashModel",
     "FlowDirection",
     "FlowPatternModel",
+    "FluidMaterialConvectionCorrelation",
     "ForchheimerIPRDescription",
     "ForchheimerCoefficientsOption",
     "CompositionalFluidDescription",

src/alfasim_sdk/_internal/alfacase/case_description.py

@@ -38,6 +38,7 @@
 from .case_description_attributes import PhaseName
 from alfasim_sdk._internal import constants
 
+
 # [[[cog
 # # This cog has no output, it just declares and imports symbols used by cogs in this module.
 #
@@ -3358,7 +3359,7 @@ class PhysicsDescription:
     correlations_package = attrib_enum(
         default=constants.CorrelationPackageType.Classical
     )
-
+    fluid_material_convection_correlation = attrib_enum(default=constants.FluidMaterialConvectionCorrelation.HasanKabir1994)
 
 @attr.s()
 class TimeOptionsDescription:

src/alfasim_sdk/_internal/alfacase/schema.py

@@ -443,6 +443,7 @@
         Optional("emulsion_inversion_water_cut"): Map({"value": Float(), "unit": Str()}),
         Optional("flash_model"): Enum(['hydrocarbon_only', 'hydrocarbon_and_water']),
         Optional("correlations_package"): Enum(['correlation_package_classical', 'correlation_package_alfasim', 'correlation_package_isdb_tests']),
+        Optional("fluid_material_convection_correlation"): Enum(['Hasan and Kabir 1994', 'Hasan and Kabir 2002', 'Fuzong Zhou 2013', 'Holman 1981']),
     }
 )
 pig_equipment_description_schema = Map(
@@ -1198,4 +1199,4 @@
         Optional("walls"): Seq(wall_description_schema),
     }
 )
-# [[[end]]] (checksum: c3e9dda5b6b211c66aef5f5b6f7ab550)
+# [[[end]]] (checksum: 491e5442b3beadcbf3ad91c5ca5d52e1)

src/alfasim_sdk/_internal/constants.py

@@ -539,3 +539,14 @@ class ForchheimerCoefficientsOption(Enum):
 
     ReservoirParameters = "reservoir_parameters"
     FlowCoefficients = "flow_coefficients"
+
+class FluidMaterialConvectionCorrelation(Enum):
+    """
+    The heat transfer mechanism for fluid materials composed by a parcel of radiation and
+    convection.
+    """
+
+    HasanKabir1994 = "Hasan and Kabir 1994"
+    HasanKabir2002 = "Hasan and Kabir 2002"
+    FuzongZhou2013 = "Fuzong Zhou 2013"
+    Holman1981 = "Holman 1981"

tests/alfacase/test_generate_case_description_docstring/test_generate_case_description_docstring_PhysicsDescription_.txt

@@ -25,6 +25,7 @@
             emulsion_inversion_water_cut: \ :class:`Scalar <barril.units.Scalar>`\  = Scalar(0.4, 'm3/m3', 'volume per volume')
             flash_model: \ :class:`FlashModel <alfasim_sdk._internal.constants.FlashModel>`\  = FlashModel.HydrocarbonAndWater
             correlations_package: \ :class:`CorrelationPackageType <alfasim_sdk._internal.constants.CorrelationPackageType>`\  = CorrelationPackageType.Classical
+            fluid_material_convection_correlation: \ :class:`FluidMaterialConvectionCorrelation <alfasim_sdk._internal.constants.FluidMaterialConvectionCorrelation>`\  = FluidMaterialConvectionCorrelation.HasanKabir1994
 
 .. tab:: Schema
 
@@ -70,3 +71,4 @@
                 unit: string
             flash_model: \ :class:`FlashModel <alfasim_sdk._internal.constants.FlashModel>`\  # optional
             correlations_package: \ :class:`CorrelationPackageType <alfasim_sdk._internal.constants.CorrelationPackageType>`\  # optional
+            fluid_material_convection_correlation: \ :class:`FluidMaterialConvectionCorrelation <alfasim_sdk._internal.constants.FluidMaterialConvectionCorrelation>`\  # optional

tests/alfacase/test_generate_case_schema/test_generate_schema_for_all_cases.txt

@@ -458,6 +458,7 @@ physics_description_schema = Map(
         Optional("emulsion_inversion_water_cut"): Map({"value": Float(), "unit": Str()}),
         Optional("flash_model"): Enum(['hydrocarbon_only', 'hydrocarbon_and_water']),
         Optional("correlations_package"): Enum(['correlation_package_classical', 'correlation_package_alfasim', 'correlation_package_isdb_tests']),
+        Optional("fluid_material_convection_correlation"): Enum(['Hasan and Kabir 1994', 'Hasan and Kabir 2002', 'Fuzong Zhou 2013', 'Holman 1981']),
     }
 )