.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples\gallery_examples\04-analyses\run_mechanical_shock_strain_map_analysis.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_run_mechanical_shock_strain_map_analysis.py>`
        to download the full example code.

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

.. _sphx_glr_examples_gallery_examples_04-analyses_run_mechanical_shock_strain_map_analysis.py:


.. _ref_sherlock_run_mechanical_shock_analysis:

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

This example demonstrates how to connect to the Sherlock gRPC service, import a project,
add strain maps, and run a mechanical shock analysis based on strain maps.

Description
-----------
Sherlock provides tools to perform mechanical shock analysis using strain maps.
This script includes the following steps:
- Connect to the Sherlock service.
- Import a project.
- Add a strain map file to the project.
- Configure the analysis properties for mechanical shock.
- Execute the mechanical shock analysis.

For further details, refer to the official documentation on mechanical shock analysis in Sherlock.

.. GENERATED FROM PYTHON SOURCE LINES 41-57

.. code-block:: Python



    import os

    from ansys.api.sherlock.v0.SherlockAnalysisService_pb2 import RunStrainMapAnalysisRequest
    from examples.examples_globals import get_sherlock_tutorial_path

    from ansys.sherlock.core import launcher
    from ansys.sherlock.core.errors import (
        SherlockAddStrainMapsError,
        SherlockImportProjectZipArchiveError,
        SherlockRunStrainMapAnalysisError,
    )
    from ansys.sherlock.core.types.analysis_types import ModelSource
    from ansys.sherlock.core.types.project_types import StrainMapsFileType


.. GENERATED FROM PYTHON SOURCE LINES 59-62

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

.. GENERATED FROM PYTHON SOURCE LINES 62-65

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 66-69

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

.. GENERATED FROM PYTHON SOURCE LINES 69-76

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 77-80

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

.. GENERATED FROM PYTHON SOURCE LINES 80-91

.. code-block:: Python


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


.. GENERATED FROM PYTHON SOURCE LINES 92-95

Add Strain Map
==============
Add a strain map to the project.

.. GENERATED FROM PYTHON SOURCE LINES 95-117

.. code-block:: Python


    try:
        strain_map_path = os.path.join(get_sherlock_tutorial_path(), "StrainMaps", "StrainMap.csv")
        sherlock.project.add_strain_maps(
            project="Test",
            strain_maps=[
                (
                    strain_map_path,
                    "This is the strain map file for the project",
                    StrainMapsFileType.CSV,
                    0,
                    "SolidID",
                    "PCB Strain",
                    "µε",
                    ["Main Board"],
                )
            ],
        )
        print("Strain maps added successfully.")
    except SherlockAddStrainMapsError as e:
        print(f"Error adding strain maps: {e}")


.. GENERATED FROM PYTHON SOURCE LINES 118-121

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

.. GENERATED FROM PYTHON SOURCE LINES 121-147

.. code-block:: Python


    try:
        # Update properties for mechanical shock analysis
        sherlock.analysis.update_mechanical_shock_props(
            project="Test",
            mechanical_shock_properties=[
                {
                    "cca_name": "Main Board",
                    "model_source": ModelSource.STRAIN_MAP,
                    "shock_result_count": 1,
                    "part_validation_enabled": False,
                    "require_material_assignment_enabled": True,
                    "force_model_rebuild": "AUTO",
                    "natural_freq_min": 1,
                    "natural_freq_min_units": "Hz",
                    "natural_freq_max": 100,
                    "natural_freq_max_units": "KHz",
                    "analysis_temp": 20,
                    "analysis_temp_units": "C",
                }
            ],
        )
        print("Mechanical shock properties updated successfully.")
    except SherlockRunStrainMapAnalysisError as e:
        print(f"Error updating mechanical shock properties: {e}")


.. GENERATED FROM PYTHON SOURCE LINES 148-151

Run Mechanical Shock Analysis
=============================
Execute the mechanical shock analysis based on strain maps.

.. GENERATED FROM PYTHON SOURCE LINES 151-169

.. code-block:: Python


    try:
        sherlock.analysis.run_strain_map_analysis(
            project="Test",
            cca_name="Main Board",
            strain_map_analyses=[
                [
                    RunStrainMapAnalysisRequest.StrainMapAnalysis.AnalysisType.MechanicalShock,
                    [
                        ["On The Road", "2 - Pothole", "TOP", "StrainMap - Top"],
                        ["On The Road", "3 - Collision", "BOTTOM", "StrainMap - Bottom"],
                    ],
                ]
            ],
        )
        print("Mechanical shock analysis executed successfully.")
    except SherlockRunStrainMapAnalysisError as e:
        print(f"Error running mechanical shock analysis: {e}")


.. _sphx_glr_download_examples_gallery_examples_04-analyses_run_mechanical_shock_strain_map_analysis.py:

.. only:: html

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

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

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

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

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

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

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