Modal analysis
==============

Linearization of the model around the equilibrium configuration and computation 
of the system eigenmodes. For more information, see `Robotran theoretical framework <http://robotran-doc.git-page.immc.ucl.ac.be/RobotranBasic/Robotran_basics.pdf>`_.

Code sample
-----------

For running the modal analysis, insert the following code in your main script 
and adapt it to your need:

.. code-block:: python

    mbs_data.process = 4
    mbs_modal = MBsysPy.MbsModal(mbs_data)
    mbs_modal.set_options(save_result = 1, save_anim = 1, mode_ampl = 0.2)
    mbs_modal.run()
    del mbs_modal

Use
---

.. py:currentmodule:: MBsysPy.mbsyspy.mbs_modal

The modal analysis is performed by instancing an instance of :py:class:`MbsModal`. 
Then modal analysis is performed by calling the function :py:func:`MbsModal.run`.

The options ot the modal analysis module are set with the function :py:func:`MbsModal.set_options`.