add_random_vibe_event#

Lifecycle.add_random_vibe_event(project, phase_name, event_name, duration, duration_units, num_of_cycles, cycle_type, orientation, profile_type, load_direction, description='')#

Add a random vibe 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 the random vibe event to.

event_name: str

Name of the random vibe 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 random vibe event.

cycle_type: str

Cycle type. Options are "COUNT", "DUTY_CYCLE", "PER_YEAR", "PER_DAY", "PER_HOUR", "PER_MIN", and "PER_SEC".

orientation: str

PCB orientation in the format of "azimuth, elevation". For example, "30,15".

profile_type: str

Random load profile type. The only option is "Uniaxial".

load_direction: str

Load direction in the format of "x,y,z". For example, "0,0,1".

description: str, optional

Description of the random vibe event. The default is "".

Returns:
:
int

Status code of the response. 0 for success.

Return type:

int

Examples

>>> from ansys.sherlock.core import launcher
>>> sherlock, install_dir = launcher.launch_and_connect(transport_mode="wnua")
>>> 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_random_vibe_event(
>>>     "Test",
>>>     "Example",
>>>     "Event1",
>>>     1.5,
>>>     "sec",
>>>     4.0,
>>>     "PER MIN",
>>>     "45,45",
>>>     "Uniaxial",
>>>     "2,4,5"
>>> )