add_potting_region#

Add one or more potting regions to a given project.

Available Since: 2024R1

Parameters:

project (str) – Name of the Sherlock project.
potting_regions (list[dict[str, float | str | PolygonalShape | RectangularShape | SlotShape | CircularShape | PCBShape]]) –
Potting region properties consisting of these properties:
- cca_name: str
  Name of the CCA.
- potting_id: str
  Potting ID. The default is None.
- side: str
  The side to add the potting region to. The default is None. Options are "TOP", "BOTTOM", and "BOT".
- material: str
  The potting material. The default is None.
- potting_units: str
  The potting region units. The default is None.
- thickness: float
  The potting thickness. The default is None.
- standoff: float
  The potting standoff. The default is None.
- shape: PolygonalShape|RectangularShape|SlotShape|CircularShape|PCBShape
  The shape of the potting region.

Returns:

Status code of the response. 0 for success.

Return type:

int

Examples

>>> from ansys.sherlock.core.launcher import launch_sherlock
>>> from ansys.sherlock.core.types.layer_types import PolygonalShape
>>> sherlock = launch_sherlock()
>>> sherlock.project.import_odb_archive(
    "ODB++ Tutorial.tgz",
    True,
    True,
    True,
    True,
    project="Test",
    cca_name="Card",
)
>>> polygonal_shape = PolygonalShape(points=[
                (0, 0),
                (0, 6.35),
                (9.77, 0)
            ], rotation=87.8)
>>> sherlock.layer.add_potting_region(
    "Test",
    [{
        'cca_name': 'Card',
        'potting_id': 'Test Region',
        'side': 'TOP',
        'material': 'epoxyencapsulant',
        'potting_units': 'in',
        'thickness': 0.1,
        'standoff': 0.2,
        'shape': polygonal_shape
    },
    ]
)