update_pcb_modeling_props

Analysis.update_pcb_modeling_props(project, cca_names, analyses)

Update FEA PCB Modeling properties for one or more CCAs.

Available Since: 2023R2

Parameters:

• project (str) – str: Name of the Sherlock project.

• cca_names (list[str]) – list: Names of the CCAs to be used for the analysis.

• analyses (list[tuple[bool | float | str | int, ...]]) –

  list[tuple]: Elements consisting of the following properties in order:

  • analysis_type: SherlockAnalysisService_pb2.UpdatePcbModelingPropsRequest. Analysis.AnalysisType.ValueType. Type of analysis applied.

  • pcb_model_type: SherlockAnalysisService_pb2.UpdatePcbModelingPropsRequest. Analysis.PcbModelType.ValueType. The PCB modeling mesh type.

  • modeling_region_enabled (bool): Indicates if modeling regions are enabled.

  • pcb_material_model: SherlockAnalysisService_pb2.UpdatePcbModelingPropsRequest. Analysis.PcbMaterialModel.ValueType. The PCB material model type.

  • pcb_max_materials (int, optional): The number of PCB materials for Uniform Elements and Layered Elements PCB model types. Not applicable if PCB model is Uniform or Layered.

  • pcb_elem_order: SherlockAnalysisService_pb2.ElementOrder.ValueType. The element order for PCB elements.

  • pcb_max_edge_length (float): The maximum mesh size for PCB elements.

  • pcb_max_edge_length_units (str): The length units for the maximum mesh size.

  • pcb_max_vertical (float): The maximum vertical mesh size for PCB elements.

  • pcb_max_vertical_units (str): The length units for the maximum vertical mesh size.

  • quads_preferred (bool): Indicates that the meshing engine should attempt to generate quad-shaped elements when creating the mesh.

Return type:

int

Returns:

:

int

Status code of the response. 0 for success.

Examples

>>> from ansys.sherlock.core import launcher
>>> sherlock, install_dir = launcher.launch_and_connect(transport_mode="wnua")
>>> update_request = SherlockAnalysisService_pb2.UpdatePcbModelingPropsRequest
>>> sherlock.analysis.update_pcb_modeling_props(
>>>     "Tutorial Project",
>>>     ["Main Board"],
>>>     [
>>>         (
>>>             SherlockAnalysisService_pb2.UpdatePcbModelingPropsRequest.
>>>             Analysis.AnalysisType.HarmonicVibe,
>>>             SherlockAnalysisService_pb2.UpdatePcbModelingPropsRequest.
>>>             Analysis.PcbModelType.Bonded,
>>>             True,
>>>             SherlockAnalysisService_pb2.UpdatePcbModelingPropsRequest.
>>>             Analysis.PcbMaterialModel.Uniform,
>>>             SherlockAnalysisService_pb2.ElementOrder.SolidShell,
>>>             6,
>>>             "mm",
>>>             3,
>>>             "mm",
>>>             True,
>>>         )
>>>     ]
>>> )