FIX: Added missing sim setup APIs (#378)

Author: drewm102

doc/source/api/simulation_setup.rst

@@ -10,6 +10,7 @@ Classes
    :toctree: _autosummary
 
    HFSSSimulationSettings
+   HfssSimulationSetup
    HFSSGeneralSettings
    HFSSSettingsOptions
    HFSSSolverSettings
@@ -32,6 +33,9 @@ Classes
    SolverSettings
    SimulationSetup
    SweepData
+   FreqSweepType
+   HFSSRegionComputeResource
+   InterpolatingSweepData
    RaptorXSimulationSettings
    RaptorXGeneralSettings
    RaptorXAdvancedSettings

doc/source/conf.py

@@ -118,3 +118,6 @@
 
 # The master toctree document.
 master_doc = "index"
+
+# Ignore the following links during link checking
+linkcheck_ignore = ["https://www.ansys.com/products/electronics"]

pyproject.toml

@@ -26,7 +26,7 @@ classifiers = [
 
 # FIXME: add ansys-api-edb version
 dependencies = [
-    "ansys-api-edb",
+    "ansys-api-edb==1.0.1",
     "protobuf>=3.19.3,<4",
     "grpcio>=1.44.0"
 ]

src/ansys/edb/core/inner/messages.py

@@ -71,7 +71,6 @@
     AdaptiveMultiFrequencyDataMessage,
     BroadbandFrequencyAdaptiveSolutionMessage,
     MatrixConvergenceDataMessage,
-    MatrixConvergenceEntryMessage,
     MultiFrequencyAdaptiveSolutionMessage,
     SingleFrequencyAdaptiveSolutionMessage,
 )
@@ -120,6 +119,7 @@
 from ansys.api.edb.v1.port_post_processing_prop_pb2 import PortPostProcessingPropMessage
 from ansys.api.edb.v1.refs_pb2 import LayerRefMessage, LayerRefPropertyMessage, NetRefMessage
 from ansys.api.edb.v1.rlc_pb2 import RlcMessage
+from ansys.api.edb.v1.simulation_setup_pb2 import MatrixConvergenceEntryMessage
 from ansys.api.edb.v1.sparameter_model_pb2 import SParameterModelMessage
 from ansys.api.edb.v1.spice_model_pb2 import SpiceModelMessage, SpiceModelNewTerminalPinMessage
 from ansys.api.edb.v1.structure3d_pb2 import ClosureMessage, SetClosureMessage
@@ -1300,10 +1300,10 @@ def cpos_3d_double_message(pos, value):
     return CPos3DDoubleMessage(pos=cpos_3d_message(pos), value=value)
 
 
-def mx_convergence_data_msg(mx_data):
-    """Convert to a ``MatrixConvergenceDataMessage`` object."""
+def mx_convergence_entry_msg_list(mx_convergence_entry_list):
+    """Convert to a list ``of MatrixConvergenceEntryMessage`` objects."""
     mx_entry_msgs = []
-    for mx_entry in mx_data.entry_list:
+    for mx_entry in mx_convergence_entry_list:
         mx_entry_msgs.append(
             MatrixConvergenceEntryMessage(
                 port_1=mx_entry.port_1_name,
@@ -1312,13 +1312,17 @@ def mx_convergence_data_msg(mx_data):
                 phase_limit=mx_entry.phase_limit,
             )
         )
+    return mx_entry_msgs
+
 
+def mx_convergence_data_msg(mx_data):
+    """Convert to MatrixConvergenceDataMessage."""
     return MatrixConvergenceDataMessage(
         all_are_constant=mx_data.all_constant,
         all_diag_are_constant=mx_data.all_diag_constant,
         all_off_diag_are_constant=mx_data.all_off_diag_constant,
         mag_min_threashold=mx_data.mag_min_threshold,
-        entries=mx_entry_msgs,
+        entries=mx_convergence_entry_msg_list(mx_data.entry_list),
     )
 
 

src/ansys/edb/core/simulation_setup/__init__.py

@@ -41,6 +41,9 @@
     ViaStyle,
 )
 from ansys.edb.core.simulation_setup.simulation_setup import (
+    FreqSweepType,
+    HFSSRegionComputeResource,
+    InterpolatingSweepData,
     SimulationSetup,
     SimulationSetupType,
     SweepData,

src/ansys/edb/core/simulation_setup/hfss_simulation_settings.py

@@ -282,6 +282,15 @@ def relative_residual(self):
     def relative_residual(self, relative_residual):
         self.__stub.SetRelativeResidual(messages.double_property_message(self, relative_residual))
 
+    @property
+    def use_shell_elements(self):
+        """:class:`bool`: Flag indicating whether to use shell elements."""
+        return self.__stub.GetUseShellElements(self.msg).value
+
+    @use_shell_elements.setter
+    def use_shell_elements(self, use_shell_elements):
+        self.__stub.SetUseShellElements(messages.bool_property_message(self, use_shell_elements))
+
     @property
     def enhanced_low_frequency_accuracy(self):
         """:obj:`bool`: Flag indicating if enhanced low-frequency accuracy is enabled during simulation."""

src/ansys/edb/core/simulation_setup/simulation_settings.py

@@ -79,6 +79,15 @@ def lamda_target(self):
     def lamda_target(self, lamda_target):
         self.__stub.SetLamdaTarget(messages.double_property_message(self, lamda_target))
 
+    @property
+    def mesh_size_factor(self):
+        """:obj:`float`: Mesh size factor used for lambda refinement."""
+        return self.__stub.GetMeshSizefactor(self.msg).value
+
+    @mesh_size_factor.setter
+    def mesh_size_factor(self, mesh_size_factor):
+        self.__stub.SetMeshSizefactor(messages.double_property_message(self, mesh_size_factor))
+
     @property
     def use_default_lamda_value(self):
         """:obj:`bool`: Flag indicating if the default lambda target value is used."""
@@ -134,6 +143,15 @@ def remove_floating_geometry(self, remove_floating_geometry):
             messages.bool_property_message(self, remove_floating_geometry)
         )
 
+    @property
+    def healing_option(self):
+        """:obj:`int`: Enable/disable healing of mis-aligned points and edges."""
+        return self.__stub.GetHealingOption(self.msg).value
+
+    @healing_option.setter
+    def healing_option(self, healing_option):
+        self.__stub.SetHealingOption(messages.int_property_message(self, healing_option))
+
     @property
     def defeature_absolute_length(self):
         """:obj:`str`: Absolute length used as tolerance when defeaturing polygons."""