feat: allow giving a name to a dimensionless unit (eg: sones)

Author: anshlachamb

src/ansys/dpf/core/field.py

@@ -640,6 +640,29 @@ def unit(self, value):
         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.
+
+        >>> from ansys.dpf import core as dpf
+        >>> my_field = dpf.Field(10)
+        >>> my_field.set_named_dimensionless_unit("sones")
+        >>> print(my_field.unit)
+        sones
+
+        """
+        fielddef = self.field_definition
+        fielddef.set_named_dimensionless_unit(value)
+        self.field_definition = fielddef
+
     @property
     def dimensionality(self):
         """Dimensionality represents the shape of the elementary data contained in the field.

src/ansys/dpf/core/field_definition.py

@@ -207,6 +207,17 @@ def is_of_quantity_type(self, quantity_type):
     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)
+
     @location.setter
     def location(self, value):
         self._api.csfield_definition_set_location(self, value)

tests/test_field.py

@@ -32,7 +32,11 @@
 from ansys.dpf.core.check_version import server_meet_version
 from ansys.dpf.core.common import locations, shell_layers
 import conftest
-from conftest import SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_8_0, running_docker
+from conftest import (
+    SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_8_0,
+    SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_10_0,
+    running_docker,
+)
 
 
 @pytest.fixture()
@@ -1417,3 +1421,16 @@ def test_deep_copy_big_field_remote(server_type, server_type_remote_process):
 
     out = dpf.core.core._deep_copy(field_a, server_type_remote_process)
     assert np.allclose(out.data, data)
+
+
+@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():
+    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")
+    assert field.unit == "sones"