export_trace_reinforcement_model#

Model.export_trace_reinforcement_model(project_name: str, cca_name: str, export_file: str, overwrite: bool = True, display_model: bool = False, generate_models_for_all_layers: bool = False, coordinate_units: str = 'mm', trace_param_diameter_threshold_val: float = 2, trace_param_diameter_threshold_unit: str = 'mm', trace_param_min_hole_diameter_val: float = 0.25, trace_param_min_hole_diameter_unit: str = 'mm', trace_drill_hole_modeling: str = 'DISABLED', trace_drill_hole_min_diameter_val: float = 2, trace_drill_hole_min_diameter_unit: str = 'mm', trace_drill_hole_max_edge_val: float = 1, trace_drill_hole_max_edge_unit: str = 'mm') → int#

Export a trace reinforcement model.

Available Since: 2023R1

Parameters:

  • project_name (str) – Name of the Sherlock project to generate the trace reinforcement model for.

  • cca_name (str) – Name of the CCA to generate the trace reinforcement model from.

  • export_file (str) – Path for saving exported files to. The file extension must be .wbjn.

  • overwrite (bool, optional) – Whether to overwrite an existing file having the same file name. The default is True.

  • display_model (bool, optional) – Whether to launch and display the exported model in Ansys Workbench Mechanical once the export finishes. The default is False.

  • generate_models_for_all_layers (bool, optional) – Whether to generate and export trace models for not only the generated trace reinforcement layers but also all other layers. The default is False, in which case only trace reinforcement layers are generated and exported.

  • coordinate_units (str, optional) – Units of the model coordinates to use when exporting a model. The default is "mm".

  • trace_param_diameter_threshold_val (float, optional) – Threshold value that determines whether a hole is modeled with shell reinforcement elements or beam elements. The default is 2, with the default units being "mm" as specified by the next parameter. Holes with diameters equal to or greater than this threshold value are modeled with shell reinforcement elements. Holes with diameters less than this threshold value are modeled with beam elements. Holes buried inside the board are always modeled with beam elements.

  • trace_param_diameter_threshold_unit (str, optional) – Units associated with the threshold value for the trace parameter diameter. The default is "mm".

  • trace_param_min_hole_diameter_val (float, optional) – Minimum trace parameter diameter for determining whether a via is exported. The default is 0.25, with the default units being "mm" as specified by the next parameter. Vias with diameters smaller than this diameter are not exported. Setting the value to 0 exports all vias.

  • trace_param_min_hole_diameter_unit (str, optional) – Units associated with the value for the minimum trace parameter diameter. The default is "mm".

  • trace_drill_hole_modeling (str, optional) – Whether to enable or disable the modeling of trace drill holes. Options are "ENABLED" and "DISABLED". The default is "DISABLED", in which case the trace_drill_hole_min_diameter and trace_drill_hole_max_edge parameters are not used.

  • trace_drill_hole_min_diameter_val (float, optional) – Minimimun diameter value for determining whether a trace drill hole is exported. The default is 2, with the default units being "mm" as specified by the next parameter. Trace drill holes with diameters smaller than this diameter are not exported. Setting the value to 0 exports all trace drill holes.

  • trace_drill_hole_min_diameter_unit (str, optional) – Units associated with the value for the minimum trace drill hole diameter. The default is "mm".

  • trace_drill_hole_max_edge_val (float, optional) – Maximum segment size for representing round drill holes by a polygon. The default is 1, with the default units being "mm" as specified by the next parameter.

  • trace_drill_hole_max_edge_unit (str, optional) – Units associated with the maximum segment for representing round drill holes by a polygon. The default is "mm".

Returns:

Status code of the response. 0 for success.

Return type:

int

Examples

>>> from ansys.sherlock.core import launcher
>>> from ansys.sherlock.core import model
>>> sherlock = launcher.launch_sherlock()
>>> sherlock.model.export_trace_reinforcement_model(
    'Tutorial Project', 'Main Board', 'c:\Temp\export.wbjn',
    True, False, False)

>>> from ansys.sherlock.core import launcher
>>> from ansys.sherlock.core import model
>>> sherlock = launcher.launch_sherlock()
>>> sherlock.model.export_trace_reinforcement_model(
    'Tutorial Project', 'Main Board', 'c:\Temp\export.wbjn',
    True, False, False, "mm", 1.5, "mm", 0, "mm", "ENABLED", 1.5, "mm", 1, "mm")