Add 'force_disable_result_extrapolation' property (#846)

Add the 'force_disable_result_extrapolation' property to the
Model class. The property was added for the ACP server version 25.2.

Other changes:
- Clean up the 'test_unittest' test case.
- Move 'check_property' into 'test_model.py' since it is only used
  there. Rename it to '_check_property' to indicate that it is a
  private function.

Author: greschd

src/ansys/acp/core/_tree_objects/model.py

@@ -246,6 +246,10 @@ class Model(TreeObject):
     minimum_analysis_ply_thickness :
         Section computation minimum analysis ply thickness (in length
         unit of model).
+    force_disable_result_extrapolation :
+        Force the result extrapolation to be disabled ('ERESX,NO' command)
+        when exporting to APDL or CDB format. Available since ACP server
+        version 25.2.
     """
 
     __slots__: Iterable[str] = tuple()
@@ -263,6 +267,7 @@ def __init__(
         angle_tolerance: float = 1.0,
         relative_thickness_tolerance: float = 0.01,
         minimum_analysis_ply_thickness: float = 1e-6,
+        force_disable_result_extrapolation: bool = False,
     ) -> None:
         super().__init__(name=name)
 
@@ -271,6 +276,7 @@ def __init__(
         self.angle_tolerance = angle_tolerance
         self.relative_thickness_tolerance = relative_thickness_tolerance
         self.minimum_analysis_ply_thickness = minimum_analysis_ply_thickness
+        self.force_disable_result_extrapolation = force_disable_result_extrapolation
 
     def _get_stub(self) -> model_pb2_grpc.ObjectServiceStub:
         return cast(model_pb2_grpc.ObjectServiceStub, super()._get_stub())
@@ -295,6 +301,11 @@ def _create_stub(self) -> model_pb2_grpc.ObjectServiceStub:
     minimum_analysis_ply_thickness: ReadWriteProperty[float, float] = grpc_data_property(
         "properties.minimum_analysis_ply_thickness"
     )
+    force_disable_result_extrapolation: ReadWriteProperty[bool, bool] = grpc_data_property(
+        "properties.force_disable_result_extrapolation",
+        readable_since="25.2",
+        writable_since="25.2",
+    )
 
     @staticmethod
     def _set_unit_system_data_attribute(pb_obj: ObjectInfo, name: str, value: _PROTOBUF_T) -> None:

tests/unittests/helpers.py

@@ -25,6 +25,7 @@
 import os
 import pathlib
 import tempfile
+from typing import Any, TypeVar
 
 import numpy as np
 import numpy.testing
@@ -33,83 +34,56 @@
 from ansys.acp.core import ElementalDataType, UnitSystemType
 from ansys.acp.core.mesh_data import VectorData
 
-from .helpers import check_property
+T = TypeVar("T")
 
 
-def test_unittest(acp_instance, model_data_dir):
+def _check_property(obj: Any, *, name: str, value: T, set_value: T | None = None):
+    assert hasattr(obj, name), f"Object '{obj}' has no property named '{name}'"
+    assert (
+        getattr(obj, name) == value
+    ), f"Test of property '{name}' failed! value '{getattr( obj, name )}' instead of '{value}'."
+    if set_value is not None:
+        setattr(obj, name, set_value)
+        assert (
+            getattr(obj, name) == set_value
+        ), f"Setter of property '{name}' failed! value '{getattr(obj, name)}' instead of '{value}'."
+
+
+def test_unittest(acp_instance, model_data_dir, raises_before_version):
     """
     Test basic properties of the model object
     """
+
     input_file_path = model_data_dir / "ACP-Pre.h5"
     model = acp_instance.import_model(name="kiteboard", path=input_file_path, format="ansys:h5")
 
-    # TODO: re-activate these tests when the respective features are implemented
-    # assert model.unit_system.type == "mks"
-
-    check_property(model, name="name", value="kiteboard", set_value="kiteboard_renamed")
-    # TODO: re-activate these tests when the respective features are implemented
-    # check_property(model, name="save_path", value="")
-    # check_property(model, name="format", value="ansys:h5")
-    # check_property(model, name="cache_update_results", value=True, set_value=False),
-    # check_property(model, name="path", value=input_file_path),
-    check_property(model, name="use_nodal_thicknesses", value=False, set_value=True),
-    check_property(model, name="draping_offset_correction", value=False, set_value=True),
-    check_property(model, name="angle_tolerance", value=1.0, set_value=2.0),
-    check_property(model, name="relative_thickness_tolerance", value=0.01, set_value=0.03)
-
-    # TODO: re-activate these tests when the respective features are implemented
-    # The minimum analysis ply thickness is an absolute value, and depends on the
-    # unit system being set. This is currently not implemented in PyACP, hence the
-    # values are wrong (it's not using the expected unit system).
-    # check_property(model, name="minimum_analysis_ply_thickness", value=1e-09, set_value=2e-09)
-    # check_property(
-    #     model,
-    #     name="reference_surface_bounding_box",
-    #     value=(
-    #         (-0.6750000000000003, -0.2, 0.0005419999999999998),
-    #         (0.6750000000000003, 0.20000000000000007, 0.0005420000000000003),
-    #     ),
-    # )
+    _check_property(model, name="name", value="kiteboard", set_value="kiteboard_renamed")
+    _check_property(model, name="use_nodal_thicknesses", value=False, set_value=True),
+    _check_property(model, name="draping_offset_correction", value=False, set_value=True),
+    _check_property(model, name="angle_tolerance", value=1.0, set_value=2.0),
+    _check_property(model, name="relative_thickness_tolerance", value=0.01, set_value=0.03)
+    with raises_before_version("25.2"):
+        _check_property(
+            model, name="force_disable_result_extrapolation", value=False, set_value=True
+        )
 
     with tempfile.TemporaryDirectory() as tmp_dir:
         working_dir = pathlib.Path(tmp_dir) / "workdir"
         os.makedirs(working_dir)
-        # model.solver.working_dir = str(working_dir)
 
         with tempfile.TemporaryDirectory() as local_working_dir:
             save_path = pathlib.Path(local_working_dir) / "test_model_serialization.acph5"
             model.save(save_path, save_cache=True)
             acp_instance.clear()
             model = acp_instance.import_model(path=save_path)
 
-        # TODO: re-activate these tests when the respective features are implemented
-        # assert model.unit_system.type == "mks"
-
-        check_property(model, name="name", value="kiteboard_renamed")
-        # TODO: re-activate these tests when the respective features are implemented
-        # check_property(model, name="save_path", value=save_path)
-        # check_property(model, name="format", value="ansys:h5")
-        # check_property(model, name="cache_update_results", value=False)
-        # check_property(model, name="path", value=input_file_path)
-        check_property(model, name="use_nodal_thicknesses", value=True)
-        check_property(model, name="draping_offset_correction", value=True)
-        check_property(model, name="angle_tolerance", value=2.0)
-        check_property(model, name="relative_thickness_tolerance", value=0.03)
-
-        # TODO: re-activate these tests when the respective features are implemented
-        # check_property(model, name="minimum_analysis_ply_thickness", value=2e-09)
-        # check_property(
-        #     model,
-        #     name="reference_surface_bounding_box",
-        #     value=(
-        #         (-0.6750000000000003, -0.2, 0.0005419999999999998),
-        #         (0.6750000000000003, 0.20000000000000007, 0.0005420000000000003),
-        #     ),
-        # )
-
-        # rel_path_posix = pathlib.Path(relpath_if_possible(model.solver.working_dir)).as_posix()
-        # # To ensure platform independency we store file paths using POSIX format
-        # assert model.solver.working_dir == rel_path_posix
+        _check_property(model, name="name", value="kiteboard_renamed")
+        _check_property(model, name="use_nodal_thicknesses", value=True)
+        _check_property(model, name="draping_offset_correction", value=True)
+        _check_property(model, name="angle_tolerance", value=2.0)
+        _check_property(model, name="relative_thickness_tolerance", value=0.03)
+        with raises_before_version("25.2"):
+            _check_property(model, name="force_disable_result_extrapolation", value=True)
 
 
 def test_export_analysis_model(acp_instance, model_data_dir):