feat: Added pcb_material_elasticity option to export_FEA_model() (#656)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: ansys-pwalters

doc/changelog.d/656.documentation.md

@@ -0,0 +1 @@
+Feat: Added pcb_material_elasticity option to export_FEA_model()

examples/03-exporting/export_fea_model.py

@@ -39,6 +39,7 @@
 
 import os
 
+from ansys.api.sherlock.v0.SherlockModelService_pb2 import PcbMaterialElasticity
 from examples.examples_globals import get_sherlock_tutorial_path, get_temp_dir
 
 from ansys.sherlock.core import launcher
@@ -115,6 +116,7 @@
         clear_FEA_database=True,
         use_FEA_model_id=True,
         coordinate_units="mm",
+        pcb_material_elasticity=PcbMaterialElasticity.Orthotropic,
     )
     print(f"FEA model exported successfully to: {fea_export_path}")
 except SherlockExportFEAModelError as e:

pyproject.toml

@@ -24,7 +24,7 @@ classifiers = [
 ]
 
 dependencies = [
-    "ansys-api-sherlock==0.1.50",
+    "ansys-api-sherlock==0.1.51",
     "grpcio>=1.17, <1.68.0",
     "protobuf>=3.20",
     "pydantic>=2.9.2",

src/ansys/sherlock/core/model.py

@@ -9,11 +9,15 @@
 
 try:
     import SherlockModelService_pb2
-    from SherlockModelService_pb2 import MeshType, TraceOutputType
+    from SherlockModelService_pb2 import MeshType, PcbMaterialElasticity, TraceOutputType
     import SherlockModelService_pb2_grpc
 except ModuleNotFoundError:
     from ansys.api.sherlock.v0 import SherlockModelService_pb2
-    from ansys.api.sherlock.v0.SherlockModelService_pb2 import MeshType, TraceOutputType
+    from ansys.api.sherlock.v0.SherlockModelService_pb2 import (
+        MeshType,
+        PcbMaterialElasticity,
+        TraceOutputType,
+    )
     from ansys.api.sherlock.v0 import SherlockModelService_pb2_grpc
 
 from ansys.sherlock.core import LOG
@@ -652,6 +656,7 @@ def export_FEA_model(
         clear_FEA_database: bool,
         use_FEA_model_id: bool,
         coordinate_units: str,
+        pcb_material_elasticity: PcbMaterialElasticity = PcbMaterialElasticity.Isotropic,
     ) -> int:
         """
         Export a FEA model.
@@ -711,6 +716,9 @@ def export_FEA_model(
             Whether to use FEA model ID.
         coordinate_units: str
             Units of the model coordinates to use when exporting a model.
+        pcb_material_elasticity: PcbMaterialElasticity
+            The type of PCB material elasticity to use when exporting a model. The default value is
+            ``PcbMaterialElasticity.Isotropic``.
 
 
         Returns
@@ -720,6 +728,7 @@ def export_FEA_model(
 
         Examples
         --------
+        >>> from ansys.api.sherlock.v0.SherlockModelService_pb2 import PcbMaterialElasticity
         >>> from ansys.sherlock.core.launcher import launch_sherlock
         >>> from ansys.sherlock.core.types.common_types import (
             Measurement,
@@ -751,7 +760,8 @@ def export_FEA_model(
                 display_model=True,
                 clear_FEA_database=True,
                 use_FEA_model_id=True,
-                coordinate_units="mm"
+                coordinate_units="mm",
+                pcb_material_elasticity=PcbMaterialElasticity.Isotropic
             )
         """
         try:
@@ -834,6 +844,7 @@ def export_FEA_model(
             export_request.clearFEADatabase = clear_FEA_database
             export_request.useFEAModelID = use_FEA_model_id
             export_request.coordinateUnits = coordinate_units
+            export_request.pcbMaterialElasticity = pcb_material_elasticity
 
             return_code = self.stub.exportFEAModel(export_request)
             if return_code.value != 0:

tests/test_model.py

@@ -4,6 +4,7 @@
 import platform
 import unittest
 
+from ansys.api.sherlock.v0.SherlockModelService_pb2 import PcbMaterialElasticity
 import grpc
 import pytest
 
@@ -315,6 +316,7 @@ def test_export_FEA_model(self):
                 clear_FEA_database=True,
                 use_FEA_model_id=True,
                 coordinate_units="mm",
+                pcb_material_elasticity=PcbMaterialElasticity.Isotropic,
             )
             pytest.fail("No exception raised for invalid project name")
         except SherlockExportFEAModelError as e:
@@ -348,8 +350,9 @@ def test_export_FEA_model(self):
                 clear_FEA_database=True,
                 use_FEA_model_id=True,
                 coordinate_units="mm",
+                pcb_material_elasticity=PcbMaterialElasticity.Isotropic,
             )
-            pytest.fail("No exception raised for invalid project name")
+            pytest.fail("No exception raised for invalid CCA name")
         except SherlockExportFEAModelError as e:
             assert str(e) == "Export FEA model error: CCA name is invalid."
 
@@ -381,8 +384,9 @@ def test_export_FEA_model(self):
                 clear_FEA_database=True,
                 use_FEA_model_id=True,
                 coordinate_units="mm",
+                pcb_material_elasticity=PcbMaterialElasticity.Isotropic,
             )
-            pytest.fail("No exception raised for invalid project name")
+            pytest.fail("No exception raised for invalid file path")
         except SherlockExportFEAModelError as e:
             assert str(e) == "Export FEA model error: Export file path is invalid."
 
@@ -414,8 +418,9 @@ def test_export_FEA_model(self):
                 clear_FEA_database=True,
                 use_FEA_model_id=True,
                 coordinate_units="mm",
+                pcb_material_elasticity=PcbMaterialElasticity.Isotropic,
             )
-            pytest.fail("No exception raised for invalid project name")
+            pytest.fail("No exception raised for invalid file directory")
         except SherlockExportFEAModelError as e:
             assert str(e) == f'Export FEA model error: Export file directory "test" does not exist.'
 
@@ -447,8 +452,9 @@ def test_export_FEA_model(self):
                 clear_FEA_database=True,
                 use_FEA_model_id=True,
                 coordinate_units="mm",
+                pcb_material_elasticity=PcbMaterialElasticity.Isotropic,
             )
-            pytest.fail("No exception raised for invalid project name")
+            pytest.fail("No exception raised for invalid minimum hole diameter")
         except SherlockExportFEAModelError as e:
             assert str(e) == "Export FEA model error: Minimum hole diameter is invalid."
 
@@ -480,8 +486,9 @@ def test_export_FEA_model(self):
                 clear_FEA_database=True,
                 use_FEA_model_id=True,
                 coordinate_units="mm",
+                pcb_material_elasticity=PcbMaterialElasticity.Isotropic,
             )
-            pytest.fail("No exception raised for invalid project name")
+            pytest.fail("No exception raised for invalid maximum edge length")
         except SherlockExportFEAModelError as e:
             assert str(e) == "Export FEA model error: Maximum edge length is invalid."
 
@@ -513,8 +520,9 @@ def test_export_FEA_model(self):
                 clear_FEA_database=True,
                 use_FEA_model_id=True,
                 coordinate_units="mm",
+                pcb_material_elasticity=PcbMaterialElasticity.Isotropic,
             )
-            pytest.fail("No exception raised for invalid project name")
+            pytest.fail("No exception raised for invalid maximum mesh size")
         except SherlockExportFEAModelError as e:
             assert str(e) == "Export FEA model error: Maximum mesh size is invalid."
 
@@ -546,8 +554,9 @@ def test_export_FEA_model(self):
                 clear_FEA_database=True,
                 use_FEA_model_id=True,
                 coordinate_units="mm",
+                pcb_material_elasticity=PcbMaterialElasticity.Isotropic,
             )
-            pytest.fail("No exception raised for invalid project name")
+            pytest.fail("No exception raised for invalid vertical mesh size")
         except SherlockExportFEAModelError as e:
             assert str(e) == "Export FEA model error: Vertical mesh size is invalid."
 
@@ -580,8 +589,9 @@ def test_export_FEA_model(self):
                     clear_FEA_database=True,
                     use_FEA_model_id=True,
                     coordinate_units="mm",
+                    pcb_material_elasticity=PcbMaterialElasticity.Isotropic,
                 )
-                pytest.fail("No exception raised for invalid project name")
+                pytest.fail("No exception raised for invalid CCA name")
             except Exception as e:
                 assert type(e) == SherlockExportFEAModelError
 
@@ -613,6 +623,7 @@ def test_export_FEA_model(self):
                     clear_FEA_database=False,
                     use_FEA_model_id=False,
                     coordinate_units="mm",
+                    pcb_material_elasticity=PcbMaterialElasticity.Isotropic,
                 )
                 assert result == 0