add_shock_event#

Lifecycle.add_shock_event(project: str, phase_name: str, event_name: str, duration: float, duration_units: str, num_of_cycles: float, cycle_type: str, orientation: str, load_direction: str, description: str = '') → int#

Add a shock event to a life cycle phase.

Available Since: 2021R1

Parameters:

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

  • phase_name (str) – Name of the life cycle phase to add this shock event to.

  • event_name (str) – Name of the shock event.

  • duration (float) – Event duration length.

  • duration_units (str) – Event duration units. Options are "ms", "sec", "min", "hr", "day", and "year".

  • num_of_cycles (float) – Number of cycles for the shock event.

  • cycle_type (str) – Cycle type. Options are "COUNT", "DUTY CYCLE", "PER YEAR", and "PER HOUR".

  • orientation (str) – PCB orientation in the format of "azimuth, elevation". For example, "30,15".

  • load_direction (str) – Load direction in the format of "x,y,z". For example, "0,0,1".

  • description (str, optional) – Description of the shock event. The default is "".

Returns:

Status code of the response. 0 for success.

Return type:

int

Examples

>>> from ansys.sherlock.core.launcher import launch_sherlock
>>> sherlock = launch_sherlock()
>>> sherlock.project.import_odb_archive(
    "ODB++ Tutorial.tgz",
    True,
    True,
    True,
    True,
    project="Test",
)
>>> sherlock.lifecycle.create_life_phase(
    "Test",
    "Example",
    1.5,
    "sec",
    4.0,
    "COUNT",
)
>>> sherlock.lifecycle.add_shock_event(
    "Test",
    "Example",
    "Event1",
    1.5,
    "sec",
    4.0,
    "PER MIN",
    "45,45",
    "2,4,5"
)