update_harmonic_vibe_props#

Analysis.update_harmonic_vibe_props(project, harmonic_vibe_properties)#

Update properties for a harmonic vibe analysis.

Parameters:

project (str) – Name of the Sherlock project.
harmonic_vibe_properties (list) –
Harmonic vibe properties for a CCA consisting of these properties:
- cca_namestr
  Name of the CCA.
- harmonic_vibe_countint
  Number of harmonic vibe result layers to generate.
- harmonic_vibe_damping: str
  One or more modal damping ratios. The default is None. Separate multiple float values with commas.
- part_validation_enabled: bool
  Whether to enable part validation. The default is None.
- require_material_assignment_enabled: bool
  Whether to require material assignment. The default is None.
- analysis_temp: float
  Temperature. The default is None.
- analysis_temp_units: str
  Temperature units. The default is None. Options are "C", "F", and "K".
- force_model_rebuild: str
  How to handle rebuilding of the model. The default is None. Options are "FORCE" and "AUTO".
- filter_by_event_frequency: bool
  Indicates if harmonic results outside analysis event range are included. This parameter is not used for NX Nastran analysis.
- natural_freq_min: int
  Minimum frequency. The default is None. This parameter is for NX Nastran analysis only.
- natural_freq_min_units: str
  Minimum frequency units. The default is None. Options are "HZ", "KHZ", "MHZ", and "GHZ". This parameter is for NX Nastran analysis only.
- natural_freq_max: int
  Maximum frequency. The default is None. This parameter is for NX Nastran analysis only.
- natural_freq_max_units: str
  Maximum frequency units. The default is None. Options are "HZ", "KHZ", "MHZ", and "GHZ". This parameter is for NX Nastran analysis only.
- reuse_modal_analysis: bool
  Whether to reuse the natural frequency for modal analysis. The default is None. This parameter is for NX Nastran analysis only.

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",
    cca_name="Card",
)
>>> sherlock.analysis.update_harmonic_vibe_props(
    "Test",
    [{
        "cca_name": "Card",
        "harmonic_vibe_count": 2,
        "harmonic_vibe_damping": "0.01, 0.05",
        "part_validation_enabled": False,
        "require_material_assignment_enabled": False,
        "analysis_temp": 20,
        "analysis_temp_units": "C",
        "filter_by_event_frequency": False,
    },
    ]
)