createExportTraceCopperLayerParams

Model.createExportTraceCopperLayerParams(project_name, cca_name, output_file_path, copper_layer, overwrite: bool = False, display_after: bool = False, clear_FEA_database: bool = False, use_FEA_model_ID: bool = False, coord_units: str = 'mm', mesh_type: int = SherlockModelService_pb2.MeshType.NONE, is_modeling_region_enabled: bool = False, trace_output_type: int = SherlockModelService_pb2.TraceOutputType.ALL_REGIONS, element_order: ElementOrder = SherlockAnalysisService_pb2.ElementOrder.Linear, max_mesh_size: float = 1.0, max_mesh_size_units: str = 'mm', max_holes_per_trace: int = 2, is_drill_hole_modeling_enabled: bool = False, drill_hole_min_diameter: float = 1.0, drill_hole_min_diameter_units: str = 'mm', drill_hole_max_edge_length: float = 1.0, drill_hole_max_edge_length_units: str = 'mm') → SherlockModelService_pb2.TraceModelExportParams

Create a set of parameters to be used to export a single copper layer.

Creates TraceModelExportParams object that can be added to an export trace model request. Should be used in conjunction with exportTraceModel method to export multiple trace layers all at once. See example below.

Parameters:

• project_name (str) – Name of the Sherlock project containing trace layer to export.

• cca_name (str) – Name of the CCA containing the trace layer to export.

• output_file_path (str) – File path including the file name and extension where the trace layer will be exported. Valid file extensions: .py, .bdf, .apdl, .cdb, .wbjn, .stp, .step, .tcl, .stl Note: relative paths will be relative to sherlock install directory, not the python script.

• copper_layer (str) – Name of the copper layer in the given CCA to export.

• overwrite (bool = False) – Determines if sherlock should overwrite the output file if it exists.

• display_after (bool = False) – Determines if the output file should automatically display after export.

• clear_FEA_database (bool = False) – Determines if sherlock should clear the database after export. Applicable file extensions: .apdl, and .cdb.

• use_FEA_model_ID (bool = False) – Determines if the FEA model id is used or not.

• coord_units (str = "mm") – Units of the coordinate system. Applicable to .py .wbjn, .stp, .step.

• mesh_type (MeshType = MeshType.NONE) – Options of difference trace meshing strategies

• is_modeling_region_enabled (bool = False) – Determines if pre-defined modeling regions will be applied to the exported trace model.

• trace_output_type (TraceOutputType = TraceOutputType.ALL_REGIONS) – Options to select which trace regions to include in the 3D model.

• element_order (ElementOrder = ElementOrder.LINEAR) – Type of FEA element to be used when modeling each component.

• max_mesh_size (float = 1.0) – Indicates the desired element sizes.

• max_mesh_size_units (str = "mm") – Indicates the units to be used with max_mesh_size.

• max_holes_per_trace (int = 2) – Maximum number of holes allowed in a trace before partitioning it into multiple traces.

• is_drill_hole_modeling_enabled (bool = False) – Determines if drill holes will be modeled or not.

• drill_hole_min_diameter (float = 1.0) – All drill holes with a diameter < this value will not be modeled.

• drill_hole_min_diameter_units (str = "mm") – Units associated with drill_hole_min_diameter.

• drill_hole_max_edge_length (float = 1.0) – Specifies the length of the line segments used to represent round drill holes.

• drill_hole_max_edge_length_units (str = "mm") – Units associated with drill_hole_max_edge_length.

Returns:

Object that holds the data for a single export trace request.

Return type:

TraceModelExportParams

Examples

>>> from ansys.sherlock.core import launcher
>>> from ansys.sherlock.core.types.analysis_types import ElementOrder
>>> from ansys.api.sherlock.v0 import SherlockModelService_pb2
>>> sherlock = launcher.launch_sherlock()
>>> copper_1_layer = sherlock.model.createExportTraceCopperLayerParams(
        "Tutorial Project",
        "Main Board",
        ".\\outputfile_path.stp",
        "copper-01.odb",
        False,
        False,
        False,
        False,
        "mm",
        SherlockModelService_pb2.MeshType.NONE,
        False,
        SherlockModelService_pb2.TraceOutputType.ALL_REGIONS,
        ElementOrder.LINEAR,
        1.0,
        "mm",
        2,
        False,
        1.0,
        "mm",
        1.0
    )
>>> copper_2_layer = sherlock.model.createExportTraceCopperLayerParams(
        "Tutorial Project",
        "Main Board",
        ".\\outputfile_path2.stp",
        "copper-02.odb",
        False,
        False,
        False,
        False,
        "mm",
        SherlockModelService_pb2.MeshType.NONE,
        False,
        SherlockModelService_pb2.TraceOutputType.ALL_REGIONS,
        ElementOrder.LINEAR,
        1.0,
        "mm",
        2,
        False,
        1.0,
        "mm",
        1.0
    )
>>> sherlock.model.exportTraceModel([copper_1_layer, copper_2_layer])