Results files explanation
=========================

.. container:: matlab

   .. highlight:: matlab

Introduction
------------

This page explains the results files that are output by Robotran when
simulating the different modules.

For the basics use of the modules, see the `tutorial <./intro.html>`__.

.. container:: matlab

   This tutorial is for **matlab** language.

      REMARK:

      In MBsysLab, after the process, the results are available in the
      Matlab memory. More informations is also given in the `MBsysLab
      documentation <https://robotran.git-page.immc.ucl.ac.be/MBsysLab/>`__,
      for instance for `direct
      dynamics <https://robotran.git-page.immc.ucl.ac.be/MBsysLab/struct_m_b_s__dirdyn.html>`__.

Raw results files
-----------------

.. container:: matlab

   All simulation results are stored in the project *resultsR* folder.
   All result files use the result name as prefix (default behavior is
   the name of the module such as ``simdir`` or ``siminv``).

The values are given in the International System of Units.

The files are ``.res`` files that are basically text files. These can be
opened with any text editor such as
`NotePad++ <https://notepad-plus-plus.org/>`__.

By default, the first column is the time in seconds. If not specified,
the next columns are the indexes of joints in the multibody model as
defined in MBsysPad. The suffix of the file determines the content of
the file.

Equilibrium
-----------

For this module, the first column is always the iteration number.

-  Variables of the equilibrium process are given in \*_x.res\* file,
   each line being one iteration.
-  Joint positions at each iteration are given in \*_q.res\* file.
-  Forces of the equil process are given in \*_F.res\* file.
-  Residues of the equil process are given in \*_R.res\* file.

See also `Equilibrium Tutorial <./equil.html>`__.

Modal
-----

.. container:: matlab

   -  Main results for the multibody system studied are given in
      *modal.res* file.

-  Other files provide the matrices corresponding to the studied system
   as defined in `Modal Tutorial <./modal.html>`__. See also the
   corresponding documentation for more information.

Direct dynamics
---------------

Joints kinematics
~~~~~~~~~~~~~~~~~

.. container:: matlab

   -  Multibody system joints position, velocity and acceleration
      respectively with suffix \**, *d* and *dd*, each column is a
      joint.

Those can be in *m* or *rad* (resp *m/s*, *rad/s* or
*m/s\ 2\ ,\ rad/s\ 2*) depending on the type of the joint (linear or
revolute).

Joints dynamics
~~~~~~~~~~~~~~~

-  Multibody system joints internal forces/torque with suffix *Qq*.

-  Multibody system joints internal forces/torque for fixed (driven)
   variables with suffix *Qc*.

-  Multibody system joints internal forces/torque for actuated variables
   with suffix *Qa*.

-  Multibody system Lagrange multipliers (forces/torque) corresponding
   to constraints with suffix *Lambda*.

Links
~~~~~

.. container:: matlab

   -  Multibody system links elongation (distance) with suffix *linkl*.

Each column is a link.

-  Multibody system links 3D with suffix *link3D_XX*. The columns are:
   first is the time. The 6 other are the forces and torques in the 3
   dimensions.

User derivatives
~~~~~~~~~~~~~~~~

-  Multibody system user variables with suffix *ux*.
-  Multibody system user derivative variables with suffix *uxd*.

Solve kinematics and inverse dynamics
-------------------------------------

-  the outputs are the same as those defined in *Direct dynamics* here
   above.

Specific outputs
----------------

User can define specific outputs (see
`set_output <../ModellingFeatures/tipsAndTrick.html#saving-a-custom-quantity>`__).
The first column is always the time. The other columns depend on what
the user defined in its outputs.