Add interface layer exposure (#609)

Add exposure for the `InterfaceLayer` object type.

Author: greschd

doc/source/api/tree_objects.rst

@@ -16,6 +16,7 @@ ACP objects
     ElementSet
     Fabric
     GeometricalSelectionRule
+    InterfaceLayer
     LookUpTable1D
     LookUpTable1DColumn
     LookUpTable3D

doc/source/index.rst

@@ -78,5 +78,4 @@ Limitations
 
 * Only shell workflows are supported, solid models can not yet be defined using PyACP
 * FieldDefinitions for variable material properties are not supported
-* Butt joint sequences and interface layers are not supported
 * Section cuts are not supported

src/ansys/acp/core/__init__.py

@@ -76,6 +76,7 @@
     GeometricalSelectionRuleElementalData,
     GeometricalSelectionRuleNodalData,
     IgnorableEntity,
+    InterfaceLayer,
     Lamina,
     LinkedSelectionRule,
     LookUpTable1D,
@@ -189,6 +190,7 @@
     "get_dpf_unit_system",
     "get_model_tree",
     "IgnorableEntity",
+    "InterfaceLayer",
     "Lamina",
     "launch_acp",
     "LaunchMode",

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

@@ -76,6 +76,7 @@
     GeometricalSelectionRuleElementalData,
     GeometricalSelectionRuleNodalData,
 )
+from .interface_layer import InterfaceLayer
 from .linked_selection_rule import LinkedSelectionRule
 from .lookup_table_1d import LookUpTable1D
 from .lookup_table_1d_column import LookUpTable1DColumn
@@ -155,6 +156,7 @@
     "GeometricalSelectionRuleElementalData",
     "GeometricalSelectionRuleNodalData",
     "IgnorableEntity",
+    "InterfaceLayer",
     "InterpolationOptions",
     "Lamina",
     "LinkedSelectionRule",

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

@@ -0,0 +1,129 @@
+# Copyright (C) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+import dataclasses
+
+from ansys.api.acp.v0 import interface_layer_pb2, interface_layer_pb2_grpc
+
+from .._utils.property_protocols import ReadWriteProperty
+from ._grpc_helpers.linked_object_list import (
+    define_linked_object_list,
+    define_polymorphic_linked_object_list,
+)
+from ._grpc_helpers.property_helper import (
+    grpc_data_property,
+    grpc_data_property_read_only,
+    mark_grpc_properties,
+)
+from ._mesh_data import (
+    ElementalData,
+    NodalData,
+    VectorData,
+    elemental_data_property,
+    nodal_data_property,
+)
+from .base import CreatableTreeObject, IdTreeObject
+from .element_set import ElementSet
+from .enums import status_type_from_pb
+from .object_registry import register
+from .oriented_selection_set import OrientedSelectionSet
+
+
+@dataclasses.dataclass
+class InterfaceLayerElementalData(ElementalData):
+    """Represents elemental data for a Modeling Ply."""
+
+    normal: VectorData | None = None
+
+
+@dataclasses.dataclass
+class InterfaceLayerNodalData(NodalData):
+    """Represents nodal data for a Modeling Ply."""
+
+    ply_offset: VectorData | None = None
+
+
+@mark_grpc_properties
+@register
+class InterfaceLayer(CreatableTreeObject, IdTreeObject):
+    """Instantiate an interface layer.
+
+    The interface layer is a separation layer in the stacking sequence. It can be
+    used to analyze the crack growth of existing cracks. They can also be used to
+    define contacts zones between two layers.
+    The topology is defined with an interface layer in ACP, while all other fracture
+    settings need to be specified in the downstream analysis (MAPDL or Mechanical).
+
+    Parameters
+    ----------
+    name :
+        Name of the interface layer.
+    global_ply_nr :
+        Global ply number for the stacking sequence.
+    active :
+        Inactive interface layers are ignored in ACP and the downstream analysis.
+    oriented_selection_sets :
+        Oriented Selection Set for the expansion of the interface layer.
+    open_area_sets :
+        Defines the initial crack of a Virtual Crack Closure Technique (VCCT) layer.
+        Can contain ``OrientedSelectionSet`` and ``ElementSet`` objects.
+    """
+
+    __slots__: Iterable[str] = tuple()
+    _COLLECTION_LABEL = "interface_layers"
+    _OBJECT_INFO_TYPE = interface_layer_pb2.ObjectInfo
+    _CREATE_REQUEST_TYPE = interface_layer_pb2.CreateRequest
+    _SUPPORTED_SINCE = "25.1"
+
+    def __init__(
+        self,
+        *,
+        name: str = "InterfaceLayer",
+        global_ply_nr: int = 0,
+        active: bool = True,
+        oriented_selection_sets: Iterable[OrientedSelectionSet] = (),
+        open_area_sets: Iterable[ElementSet | OrientedSelectionSet] = (),
+    ):
+        super().__init__(name=name)
+        self.global_ply_nr = global_ply_nr
+        self.active = active
+        self.oriented_selection_sets = oriented_selection_sets
+        self.open_area_sets = open_area_sets
+
+    def _create_stub(self) -> interface_layer_pb2_grpc.ObjectServiceStub:
+        return interface_layer_pb2_grpc.ObjectServiceStub(self._channel)
+
+    status = grpc_data_property_read_only("properties.status", from_protobuf=status_type_from_pb)
+    global_ply_nr: ReadWriteProperty[int, int] = grpc_data_property("properties.global_ply_nr")
+    active: ReadWriteProperty[bool, bool] = grpc_data_property("properties.active")
+    oriented_selection_sets = define_linked_object_list(
+        "properties.oriented_selection_sets", OrientedSelectionSet
+    )
+    open_area_sets = define_polymorphic_linked_object_list(
+        "properties.open_area_sets", allowed_types=(ElementSet, OrientedSelectionSet)
+    )
+
+    elemental_data = elemental_data_property(InterfaceLayerElementalData)
+    nodal_data = nodal_data_property(InterfaceLayerNodalData)

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

@@ -25,7 +25,12 @@
 from collections.abc import Iterable
 import dataclasses
 
-from ansys.api.acp.v0 import modeling_group_pb2, modeling_group_pb2_grpc, modeling_ply_pb2_grpc
+from ansys.api.acp.v0 import (
+    interface_layer_pb2_grpc,
+    modeling_group_pb2,
+    modeling_group_pb2_grpc,
+    modeling_ply_pb2_grpc,
+)
 
 from ._grpc_helpers.mapping import define_create_method, define_mutable_mapping
 from ._grpc_helpers.property_helper import mark_grpc_properties
@@ -37,6 +42,7 @@
     nodal_data_property,
 )
 from .base import CreatableTreeObject, IdTreeObject
+from .interface_layer import InterfaceLayer
 from .modeling_ply import ModelingPly
 from .object_registry import register
 
@@ -86,6 +92,15 @@ def _create_stub(self) -> modeling_group_pb2_grpc.ObjectServiceStub:
         module_name=__module__,
     )
     modeling_plies = define_mutable_mapping(ModelingPly, modeling_ply_pb2_grpc.ObjectServiceStub)
+    interface_layers = define_mutable_mapping(
+        InterfaceLayer, interface_layer_pb2_grpc.ObjectServiceStub
+    )
+    create_interface_layer = define_create_method(
+        InterfaceLayer,
+        func_name="create_interface_layer",
+        parent_class_name="ModelingGroup",
+        module_name=__module__,
+    )
 
     elemental_data = elemental_data_property(ModelingGroupElementalData)
     nodal_data = nodal_data_property(ModelingGroupNodalData)

tests/unittests/test_interface_layer.py

@@ -0,0 +1,84 @@
+# Copyright (C) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from packaging.version import parse as parse_version
+import pytest
+
+from ansys.acp.core import InterfaceLayer
+
+from .common.tree_object_tester import NoLockedMixin, ObjectPropertiesToTest, TreeObjectTester
+
+
+@pytest.fixture(autouse=True)
+def skip_if_unsupported_version(acp_instance):
+    if parse_version(acp_instance.server_version) < parse_version(InterfaceLayer._SUPPORTED_SINCE):
+        pytest.skip("InterfaceLayer is not supported on this version of the server.")
+
+
+@pytest.fixture
+def model(load_model_from_tempfile):
+    with load_model_from_tempfile() as model:
+        yield model
+
+
+@pytest.fixture
+def parent_object(model):
+    return list(model.modeling_groups.values())[0]
+
+
+@pytest.fixture
+def tree_object(parent_object):
+    return parent_object.create_interface_layer()
+
+
+class TestInterfaceLayer(NoLockedMixin, TreeObjectTester):
+    COLLECTION_NAME = "interface_layers"
+
+    @staticmethod
+    @pytest.fixture
+    def default_properties():
+        return {
+            "status": "NOTUPTODATE",
+            "active": True,
+            "oriented_selection_sets": [],
+            "open_area_sets": [],
+        }
+
+    CREATE_METHOD_NAME = "create_interface_layer"
+
+    @staticmethod
+    @pytest.fixture
+    def object_properties(model):
+        oriented_selection_sets = [model.create_oriented_selection_set() for _ in range(3)]
+        open_area_sets = [model.create_oriented_selection_set(), model.create_element_set()]
+        return ObjectPropertiesToTest(
+            read_write=[
+                ("name", "Interface layer name"),
+                ("oriented_selection_sets", oriented_selection_sets),
+                ("open_area_sets", open_area_sets),
+                ("active", False),
+            ],
+            read_only=[
+                ("id", "some_id"),
+                ("status", "UPTODATE"),
+            ],
+        )