ansys-fluent-core 0.31.dev1__py3-none-any.whl → 0.32.dev0__py3-none-any.whl

ansys/fluent/core/services/deprecated_field_data.py

@@ -42,7 +42,7 @@ from ansys.fluent.core.services.field_data import (
     get_fields_request,
     override_help_text,
 )
-from ansys.fluent.core.utils.deprecate import deprecate_argument
+from ansys.fluent.core.utils.deprecate import all_deprecators
 
 DEPRECATION_MSG = "'field_data_old' is deprecated. Use 'field_data' instead."
 
@@ -297,15 +297,23 @@ class DeprecatedFieldData:
             self._allowed_vector_field_names,
         )
 
-    @deprecate_argument(
-        old_arg="surface_name",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: [old_arg_val] if old_arg_val else [],
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: [old_arg_val] if old_arg_val else [],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.27.0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message=DEPRECATION_MSG,
     )
     def get_scalar_field_data(
         self,
@@ -336,7 +344,6 @@ class DeprecatedFieldData:
             IDs are provided as input, a dictionary containing a map of surface IDs to scalar
             field data.
         """
-        warnings.warn(DEPRECATION_MSG, PyFluentDeprecationWarning)
         surface_ids = _get_surface_ids(
             field_info=self._field_info,
             allowed_surface_names=self._allowed_surface_names,
@@ -376,20 +383,28 @@ class DeprecatedFieldData:
                 for surface_id in surface_ids
             }
 
-    @deprecate_argument(
-        old_arg="surface_name",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: [old_arg_val] if old_arg_val else [],
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
-    )
-    @deprecate_argument(
-        old_arg="data_type",
-        new_arg="data_types",
-        converter=lambda old_arg_val: [old_arg_val] if old_arg_val else [],
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: [old_arg_val] if old_arg_val else [],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+            {
+                "old_arg": "data_type",
+                "new_arg": "data_types",
+                "converter": lambda old_arg_val: [old_arg_val] if old_arg_val else [],
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.27.0",
+        deprecated_reason="Old arguments 'surface_names', 'surface_ids' and 'data_type' are deprecated. Use 'surfaces' and 'data_types' instead.",
+        warn_message=DEPRECATION_MSG,
     )
     def get_surface_data(
         self,
@@ -421,7 +436,6 @@ class DeprecatedFieldData:
              If surface IDs are provided as input, a dictionary containing a map of surface IDs to face
              vertices, connectivity data, and normal or centroid data is returned.
         """
-        warnings.warn(DEPRECATION_MSG, PyFluentDeprecationWarning)
         surface_ids = _get_surface_ids(
             field_info=self._field_info,
             allowed_surface_names=self._allowed_surface_names,
@@ -509,15 +523,23 @@ class DeprecatedFieldData:
                     for surface_id in surface_ids
                 }
 
-    @deprecate_argument(
-        old_arg="surface_name",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: [old_arg_val] if old_arg_val else [],
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: [old_arg_val] if old_arg_val else [],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.27.0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message=DEPRECATION_MSG,
     )
     def get_vector_field_data(
         self,
@@ -540,7 +562,6 @@ class DeprecatedFieldData:
             If surface IDs are provided as input, a dictionary containing a map of
             surface IDs to vector field data is returned.
         """
-        warnings.warn(DEPRECATION_MSG, PyFluentDeprecationWarning)
         surface_ids = _get_surface_ids(
             field_info=self._field_info,
             allowed_surface_names=self._allowed_surface_names,
@@ -579,15 +600,23 @@ class DeprecatedFieldData:
                 for surface_id in surface_ids
             }
 
-    @deprecate_argument(
-        old_arg="surface_name",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: [old_arg_val] if old_arg_val else [],
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: [old_arg_val] if old_arg_val else [],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.27.0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message=DEPRECATION_MSG,
     )
     def get_pathlines_field_data(
         self,
@@ -648,7 +677,6 @@ class DeprecatedFieldData:
         """
         if zones is None:
             zones = []
-        warnings.warn(DEPRECATION_MSG, PyFluentDeprecationWarning)
         surface_ids = _get_surface_ids(
             field_info=self._field_info,
             allowed_surface_names=self._allowed_surface_names,

ansys/fluent/core/services/field_data.py

@@ -51,6 +51,7 @@ from ansys.fluent.core.field_data_interfaces import (
     _AllowedSurfaceNames,
     _AllowedVectorFieldNames,
     _ReturnFieldData,
+    _to_field_name_str,
 )
 from ansys.fluent.core.pyfluent_warnings import PyFluentDeprecationWarning
 from ansys.fluent.core.services.interceptors import (
@@ -60,7 +61,7 @@ from ansys.fluent.core.services.interceptors import (
     TracingInterceptor,
 )
 from ansys.fluent.core.services.streaming import StreamingService
-from ansys.fluent.core.utils.deprecate import deprecate_argument, deprecate_arguments
+from ansys.fluent.core.utils.deprecate import all_deprecators
 
 logger = logging.getLogger("pyfluent.field_data")
 
@@ -428,7 +429,7 @@ class BaseFieldData:
             )
         ]
         return self._returned_data._scalar_data(
-            kwargs.get("field_name"),
+            _to_field_name_str(kwargs.get("field_name")),
             kwargs.get("surfaces"),
             self.get_surface_ids(kwargs.get("surfaces")),
             scalar_field_data,
@@ -452,7 +453,7 @@ class BaseFieldData:
     ) -> Dict[int | str, np.array]:
         vector_field_data = self.data[(("type", "vector-field"),)]
         return self._returned_data._vector_data(
-            kwargs.get("field_name"),
+            _to_field_name_str(kwargs.get("field_name")),
             kwargs.get("surfaces"),
             self.get_surface_ids(kwargs.get("surfaces")),
             vector_field_data,
@@ -465,11 +466,10 @@ class BaseFieldData:
         if kwargs.get("zones") is None:
             zones = []
         del zones
-        pathlines_data = self.data[
-            (("type", "pathlines-field"), ("field", kwargs.get("field_name")))
-        ]
+        field_name = _to_field_name_str(kwargs.get("field_name"))
+        pathlines_data = self.data[(("type", "pathlines-field"), ("field", field_name))]
         return self._returned_data._pathlines_data(
-            kwargs.get("field_name"),
+            field_name,
             kwargs.get("surfaces"),
             self.get_surface_ids(kwargs.get("surfaces")),
             pathlines_data,
@@ -637,11 +637,16 @@ class Transaction(FieldTransaction):
             raise ValueError("For 'path-lines' `field_name` should be unique.")
         else:
             self._pathline_field_data.append(field_name)
+        additional_field_name = kwargs.get("additional_field_name")
+        if additional_field_name:
+            additional_field_name = self._allowed_scalar_field_names.valid_name(
+                additional_field_name
+            )
         self._fields_request.pathlinesFieldRequest.extend(
             self._fetched_data._pathlines_data(
                 field_name,
                 kwargs.get("surfaces"),
-                additionalField=kwargs.get("additional_field_name"),
+                additionalField=additional_field_name,
                 provideParticleTimeField=kwargs.get("provide_particle_time_field"),
                 dataLocation=(
                     FieldDataProtoModule.DataLocation.Nodes
@@ -660,17 +665,24 @@ class Transaction(FieldTransaction):
             )
         )
 
-    @deprecate_argument(
-        old_arg="surface_names",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+        ],
+        data_type_converter=_data_type_convertor,
+        deprecated_version="v0.23.dev0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message="'add_surfaces_request' is deprecated, use 'add_requests' instead",
     )
-    @deprecate_arguments(converter=_data_type_convertor)
     def add_surfaces_request(
         self,
         data_types: List[SurfaceDataType] | List[str],
@@ -679,25 +691,29 @@ class Transaction(FieldTransaction):
     ) -> None:
         """Add request to get surface data (vertices, face connectivity, centroids, and
         normals)."""
-        warnings.warn(
-            "'add_surfaces_request' is deprecated, use 'add_requests' instead",
-            PyFluentDeprecationWarning,
-        )
         self._add_surfaces_request(
             data_types=data_types,
             surfaces=self.get_surface_ids(surfaces),
             overset_mesh=overset_mesh,
         )
 
-    @deprecate_argument(
-        old_arg="surface_names",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.23.dev0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message="'add_scalar_fields_request' is deprecated, use 'add_requests' instead",
     )
     def add_scalar_fields_request(
         self,
@@ -707,10 +723,6 @@ class Transaction(FieldTransaction):
         boundary_value: bool | None = True,
     ) -> None:
         """Add request to get scalar field data on surfaces."""
-        warnings.warn(
-            "'add_scalar_fields_request' is deprecated, use 'add_requests' instead",
-            PyFluentDeprecationWarning,
-        )
         self._add_scalar_fields_request(
             field_name=field_name,
             surfaces=self.get_surface_ids(surfaces),
@@ -718,15 +730,23 @@ class Transaction(FieldTransaction):
             boundary_value=boundary_value,
         )
 
-    @deprecate_argument(
-        old_arg="surface_names",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.23.dev0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message="'add_vector_fields_request' is deprecated, use 'add_requests' instead",
     )
     def add_vector_fields_request(
         self,
@@ -734,23 +754,27 @@ class Transaction(FieldTransaction):
         surfaces: List[int | str],
     ) -> None:
         """Add request to get vector field data on surfaces."""
-        warnings.warn(
-            "'add_vector_fields_request' is deprecated, use 'add_requests' instead",
-            PyFluentDeprecationWarning,
-        )
         self._add_vector_fields_request(
             field_name=field_name, surfaces=self.get_surface_ids(surfaces)
         )
 
-    @deprecate_argument(
-        old_arg="surface_names",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
-    )
-    @deprecate_argument(
-        old_arg="surface_ids",
-        new_arg="surfaces",
-        converter=lambda old_arg_val: old_arg_val or [],
+    @all_deprecators(
+        deprecate_arg_mappings=[
+            {
+                "old_arg": "surface_names",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+            {
+                "old_arg": "surface_ids",
+                "new_arg": "surfaces",
+                "converter": lambda old_arg_val: old_arg_val or [],
+            },
+        ],
+        data_type_converter=None,
+        deprecated_version="v0.23.dev0",
+        deprecated_reason="Old arguments 'surface_ids' and 'surface_names' are deprecated. Use 'surfaces' instead.",
+        warn_message="'add_pathlines_fields_request' is deprecated, use 'add_requests' instead",
     )
     def add_pathlines_fields_request(
         self,
@@ -770,10 +794,6 @@ class Transaction(FieldTransaction):
         zones: list | None = None,
     ) -> None:
         """Add request to get path-lines field on surfaces."""
-        warnings.warn(
-            "'add_pathlines_fields_request' is deprecated, use 'add_requests' instead",
-            PyFluentDeprecationWarning,
-        )
         self._add_pathlines_fields_request(
             field_name=field_name,
             surfaces=self.get_surface_ids(surfaces),
@@ -1247,6 +1267,7 @@ class LiveFieldData(BaseFieldData, FieldDataSource):
         self._field_info = field_info
         self.is_data_valid = is_data_valid
         self.scheme_eval = scheme_eval
+
         self.get_zones_info = lambda: get_zones_info()()
 
         self._allowed_surface_names = _AllowedSurfaceNames(field_info)
@@ -1324,9 +1345,12 @@ class LiveFieldData(BaseFieldData, FieldDataSource):
         surfaces = kwargs.get("surfaces")
         surface_ids = self.get_surface_ids(surfaces)
         fields_request = get_fields_request()
+        field_name = self._allowed_scalar_field_names.valid_name(
+            kwargs.get("field_name")
+        )
         fields_request.scalarFieldRequest.extend(
             self._fetched_data._scalar_data(
-                self._allowed_scalar_field_names.valid_name(kwargs.get("field_name")),
+                field_name,
                 self.get_surface_ids(surfaces),
                 kwargs.get("node_value"),
                 kwargs.get("boundary_value"),
@@ -1335,7 +1359,7 @@ class LiveFieldData(BaseFieldData, FieldDataSource):
         fields = ChunkParser().extract_fields(self._service.get_fields(fields_request))
         scalar_field_data = next(iter(fields.values()))
         return self._returned_data._scalar_data(
-            kwargs.get("field_name"), surfaces, surface_ids, scalar_field_data
+            field_name, surfaces, surface_ids, scalar_field_data
         )
 
     def _get_surface_data(
@@ -1372,12 +1396,15 @@ class LiveFieldData(BaseFieldData, FieldDataSource):
         **kwargs,
     ) -> Dict[int | str, np.array]:
         surface_ids = self.get_surface_ids(kwargs.get("surfaces"))
+        field_name = self._allowed_vector_field_names.valid_name(
+            kwargs.get("field_name")
+        )
         for surface_id in surface_ids:
             self.scheme_eval.string_eval(f"(surface? {surface_id})")
         fields_request = get_fields_request()
         fields_request.vectorFieldRequest.extend(
             self._fetched_data._vector_data(
-                self._allowed_vector_field_names.valid_name(kwargs.get("field_name")),
+                field_name,
                 surface_ids,
             )
         )
@@ -1385,7 +1412,7 @@ class LiveFieldData(BaseFieldData, FieldDataSource):
         vector_field_data = next(iter(fields.values()))
 
         return self._returned_data._vector_data(
-            kwargs.get("field_name"),
+            field_name,
             kwargs.get("surfaces"),
             surface_ids,
             vector_field_data,
@@ -1398,12 +1425,20 @@ class LiveFieldData(BaseFieldData, FieldDataSource):
         if kwargs.get("zones") is None:
             zones = []
         surface_ids = self.get_surface_ids(kwargs.get("surfaces"))
+        field_name = self._allowed_scalar_field_names.valid_name(
+            kwargs.get("field_name")
+        )
         fields_request = get_fields_request()
+        additional_field_name = kwargs.get("additional_field_name")
+        if additional_field_name:
+            additional_field_name = self._allowed_scalar_field_names.valid_name(
+                additional_field_name
+            )
         fields_request.pathlinesFieldRequest.extend(
             self._fetched_data._pathlines_data(
-                self._allowed_scalar_field_names.valid_name(kwargs.get("field_name")),
+                field_name,
                 surface_ids,
-                additionalField=kwargs.get("additional_field_name"),
+                additionalField=kwargs.get(additional_field_name),
                 provideParticleTimeField=kwargs.get("provide_particle_time_field"),
                 dataLocation=(
                     FieldDataProtoModule.DataLocation.Nodes
@@ -1427,7 +1462,7 @@ class LiveFieldData(BaseFieldData, FieldDataSource):
         if self._deprecated_flag:
             self._deprecated_flag = False
             return self._returned_data._pathlines_data(
-                kwargs.get("field_name"),
+                field_name,
                 kwargs.get("surfaces"),
                 surface_ids,
                 pathlines_data,
@@ -1435,7 +1470,7 @@ class LiveFieldData(BaseFieldData, FieldDataSource):
             )
 
         return self._returned_data._pathlines_data(
-            kwargs.get("field_name"),
+            field_name,
             kwargs.get("surfaces"),
             surface_ids,
             pathlines_data,