.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "gallery/quickstart/example_quickstart_modal.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

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

        :ref:`Go to the end <sphx_glr_download_gallery_quickstart_example_quickstart_modal.py>`
        to download the full example code.

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

.. _sphx_glr_gallery_quickstart_example_quickstart_modal.py:


Modal cantilever — first modal example
======================================

A 60-second introduction to free-vibration analysis in femorph-solver: build
a steel plate, clamp one edge, extract the first 5 modes, render the
lowest mode shape.

.. GENERATED FROM PYTHON SOURCE LINES 9-18

.. code-block:: Python


    from __future__ import annotations

    import numpy as np
    import pyvista as pv

    import femorph_solver
    from femorph_solver import ELEMENTS








.. GENERATED FROM PYTHON SOURCE LINES 19-21

Build a 20 × 20 × 2 hex plate
-----------------------------

.. GENERATED FROM PYTHON SOURCE LINES 21-34

.. code-block:: Python

    E, NU, RHO = 2.0e11, 0.30, 7850.0
    LX, LY, LZ = 1.0, 1.0, 0.01
    NX, NY, NZ = 20, 20, 2

    grid = pv.StructuredGrid(
        *np.meshgrid(
            np.linspace(0.0, LX, NX + 1),
            np.linspace(0.0, LY, NY + 1),
            np.linspace(0.0, LZ, NZ + 1),
            indexing="ij",
        )
    ).cast_to_unstructured_grid()








.. GENERATED FROM PYTHON SOURCE LINES 35-37

Wrap and stamp material
-----------------------

.. GENERATED FROM PYTHON SOURCE LINES 37-45

.. code-block:: Python

    m = femorph_solver.Model.from_grid(grid)
    m.assign(ELEMENTS.HEX8, material={"EX": E, "PRXY": NU, "DENS": RHO})

    pts = np.asarray(grid.points)
    node_nums = np.asarray(grid.point_data["ansys_node_num"])
    fixed = node_nums[pts[:, 0] < 1e-9]
    m.fix(nodes=fixed.tolist(), dof="ALL")








.. GENERATED FROM PYTHON SOURCE LINES 46-48

Extract 5 modes
---------------

.. GENERATED FROM PYTHON SOURCE LINES 48-54

.. code-block:: Python

    res = m.modal_solve(n_modes=5)

    print("Mode     f [Hz]")
    for i, f in enumerate(res.frequency, start=1):
        print(f"{i:>3}   {f:>10.3f}")





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    Mode     f [Hz]
      1       26.507
      2       33.751
      3      166.483
      4      175.654
      5      175.890




.. GENERATED FROM PYTHON SOURCE LINES 55-57

Visualise mode 1
----------------

.. GENERATED FROM PYTHON SOURCE LINES 57-71

.. code-block:: Python

    grid_plot = femorph_solver.io.modal_result_to_grid(m, res)
    phi1 = grid_plot.point_data["mode_1_disp"]
    factor = 0.15 / (np.max(np.abs(phi1)) + 1e-30)

    plotter = pv.Plotter(off_screen=True)
    plotter.add_mesh(grid_plot, style="wireframe", color="gray", opacity=0.3)
    plotter.add_mesh(
        grid_plot.warp_by_vector("mode_1_disp", factor=factor),
        scalars="mode_1_magnitude",
        show_scalar_bar=True,
        scalar_bar_args={"title": f"mode 1 ({res.frequency[0]:.1f} Hz)"},
    )
    plotter.add_axes()
    plotter.show()



.. image-sg:: /gallery/quickstart/images/sphx_glr_example_quickstart_modal_001.png
   :alt: example quickstart modal
   :srcset: /gallery/quickstart/images/sphx_glr_example_quickstart_modal_001.png
   :class: sphx-glr-single-img






.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 1.378 seconds)


.. _sphx_glr_download_gallery_quickstart_example_quickstart_modal.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_