.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples\gallery_examples\04-analyses\update_mechanical_shock_properties.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_gallery_examples_04-analyses_update_mechanical_shock_properties.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_gallery_examples_04-analyses_update_mechanical_shock_properties.py:


.. _ref_sherlock_update_mechanical_shock_props:

=============================
Run Mechanical Shock Analysis
=============================

This example demonstrates how to connect to the Sherlock gRPC service, import a project,
and configure mechanical shock analysis properties.

Description
-----------
Sherlock allows you to perform mechanical shock analysis.
This script performs the following steps:
- Connect to the Sherlock service.
- Import a project.
- Configure the properties for mechanical shock analysis.

.. GENERATED FROM PYTHON SOURCE LINES 37-54

.. code-block:: Python


    """
    sphinx_gallery_thumbnail_path =
    './images/sherlock_update_mechanical_shock_analysis_props_example.png'
    """

    import os

    from examples.examples_globals import get_sherlock_tutorial_path

    from ansys.sherlock.core import launcher
    from ansys.sherlock.core.errors import (
        SherlockImportProjectZipArchiveError,
        SherlockUpdateMechanicalShockPropsError,
    )
    from ansys.sherlock.core.types.analysis_types import ModelSource


.. GENERATED FROM PYTHON SOURCE LINES 55-58

Connect to Sherlock
===================
Connect to the Sherlock service and ensure proper initialization.

.. GENERATED FROM PYTHON SOURCE LINES 58-61

.. code-block:: Python


    sherlock = launcher.connect(port=9092, timeout=10)


.. GENERATED FROM PYTHON SOURCE LINES 62-65

Delete Project
==============
Delete the project if it already exists.

.. GENERATED FROM PYTHON SOURCE LINES 65-72

.. code-block:: Python


    try:
        sherlock.project.delete_project("Test")
        print("Project deleted successfully.")
    except Exception:
        pass


.. GENERATED FROM PYTHON SOURCE LINES 73-76

Import Tutorial Project
========================
Import the tutorial project zip archive from the Sherlock tutorial directory.

.. GENERATED FROM PYTHON SOURCE LINES 76-87

.. code-block:: Python


    try:
        sherlock.project.import_project_zip_archive(
            project="Test",
            category="Demos",
            archive_file=os.path.join(get_sherlock_tutorial_path(), "Auto Relay Project.zip"),
        )
        print("Tutorial project imported successfully.")
    except SherlockImportProjectZipArchiveError as e:
        print(f"Error importing project zip archive: {e}")


.. GENERATED FROM PYTHON SOURCE LINES 88-91

Update Mechanical Shock Properties
==================================
Configure properties for mechanical shock analysis.

.. GENERATED FROM PYTHON SOURCE LINES 91-118

.. code-block:: Python


    try:
        # Update properties for mechanical shock analysis
        sherlock.analysis.update_mechanical_shock_props(
            project="Test",
            mechanical_shock_properties=[
                {
                    "cca_name": "Auto Relay",
                    "model_source": ModelSource.GENERATED,
                    "shock_result_count": 3,
                    "critical_shock_strain": 5,
                    "critical_shock_strain_units": "strain",
                    "part_validation_enabled": True,
                    "require_material_assignment_enabled": False,
                    "force_model_rebuild": "AUTO",
                    "natural_freq_min": 5,
                    "natural_freq_min_units": "Hz",
                    "natural_freq_max": 50,
                    "natural_freq_max_units": "KHz",
                    "analysis_temp": 100,
                    "analysis_temp_units": "F",
                }
            ],
        )
        print("Mechanical shock properties updated successfully.")
    except SherlockUpdateMechanicalShockPropsError as e:
        print(f"Error updating mechanical shock properties: {e}")


.. _sphx_glr_download_examples_gallery_examples_04-analyses_update_mechanical_shock_properties.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: update_mechanical_shock_properties.ipynb <update_mechanical_shock_properties.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: update_mechanical_shock_properties.py <update_mechanical_shock_properties.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: update_mechanical_shock_properties.zip <update_mechanical_shock_properties.zip>`