feat: remove set_named_dimensionless_unit. Replace it by an extension of unit setter to allow tuple as parameter

Author: anshlachamb

src/ansys/dpf/core/field.py

@@ -620,9 +620,15 @@ def unit(self):
     def unit(self, value):
         """Change the unit for the field.
 
+        If the value is a single string, then it will be interpreted to a physical meaning (homogeneity).
+
+        If the value is a tuple, then it must contain an homogeneity and a string.
+            If homogeneity is "dimensionless", then the unit string is kept as is.
+            Otherwise, homogeneity is ignored, and unit string is interpreted to a physical meaning.
+
         Parameters
         ----------
-        value : str
+        value : str | tuple(str, str)
             Units for the field.
 
         Examples
@@ -635,32 +641,18 @@ def unit(self, value):
         >>> my_field.unit
         'm'
 
-        """
-        fielddef = self.field_definition
-        fielddef.unit = value
-        self.field_definition = fielddef
 
-    def set_named_dimensionless_unit(self, value):
-        """Set a named dimensionless unit for the field.
-
-        Parameters
-        ----------
-        value : str
-            Units for the field. This unit must be homogeneous to no physical quantity
-
-        Examples
-        --------
-        Units for a psychoacoustics field.
+        Named dimensionless unit.
 
         >>> from ansys.dpf import core as dpf
         >>> my_field = dpf.Field(10)
-        >>> my_field.set_named_dimensionless_unit("sones")
+        >>> my_field.unit = ("dimensionless", "dollars")
         >>> print(my_field.unit)
-        sones
+        'dollars'
 
         """
         fielddef = self.field_definition
-        fielddef.set_named_dimensionless_unit(value)
+        fielddef.unit = value
         self.field_definition = fielddef
 
     @property

src/ansys/dpf/core/field_definition.py

@@ -205,18 +205,16 @@ def is_of_quantity_type(self, quantity_type):
 
     @unit.setter
     def unit(self, value):
-        self._api.csfield_definition_set_unit(self, value, None, 0, 0, 0)
-
-    def set_named_dimensionless_unit(self, value):
-        """Set a named dimensionless unit for the field.
-
-        Parameters
-        ----------
-        value : str
-            Units for the field. This unit must be homogeneous to no physical quantity
-        """
-        # 117 corresponds to dimensionless
-        self._api.csfield_definition_set_unit(self, value, None, 117, 0, 0)
+        # setter with explicit homogeneity: homogeneity is taken into account if it is dimensionless
+        if isinstance(value, tuple):
+            if value[0] == "dimensionless":
+                # 117 corresponds to dimensionless
+                self._api.csfield_definition_set_unit(self, value[1], None, 117, 0, 0)
+            else:
+                self._api.csfield_definition_set_unit(self, value[1], None, 0, 0, 0)
+        # standard unit setter, using string interpreter
+        else:
+            self._api.csfield_definition_set_unit(self, value, None, 0, 0, 0)
 
     @location.setter
     def location(self, value):

tests/entry/conftest.py

@@ -71,6 +71,9 @@ def _get_test_files_directory():
         "/tmp/test_files"
     )
 
+SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_10_0 = meets_version(
+    get_server_version(core._global_server()), "10.0"
+)
 SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_8_1 = meets_version(
     get_server_version(core._global_server()), "8.1"
 )

tests/test_field.py

@@ -1426,11 +1426,14 @@ def test_deep_copy_big_field_remote(server_type, server_type_remote_process):
 @pytest.mark.skipif(
     not SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_10_0, reason="Available for servers >=10.0"
 )
-def test_set_named_dimensionless_units():
+def test_set_units():
     data = np.random.random(100)
     field = dpf.core.field_from_array(data)
     field.unit = "m"
     assert field.unit == "m"
 
-    field.set_named_dimensionless_unit("sones")
+    field.unit = ("dimensionless", "sones")
     assert field.unit == "sones"
+
+    with pytest.raises(Exception):
+        field.unit = "sones"