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

.. only:: html

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

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

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

.. _sphx_glr_examples_basics_ex2_1_basicvectors_disp2d.py:


Basics: Vector field (displacement) sensors
================================================================================

In this example we use the sensor array factory to build a set of displacement
sensors that can sample the displacement vector field from a solid mechanics
simulation. In the next example we will examine how we can build custom vector
field sensors as we did for scalar field in the first set of examples.

Note that this tutorial assumes you are familiar with the use of `pyvale` for
scalar fields as described in the first set of examples.

Test case: point displacement sensors on a 2D plate with hole loaded in tension

.. GENERATED FROM PYTHON SOURCE LINES 21-26

.. code-block:: Python


    import matplotlib.pyplot as plt
    import mooseherder as mh
    import pyvale as pyv


.. GENERATED FROM PYTHON SOURCE LINES 27-32

Here we load a pre-packaged dataset from pyvale that is the output of a
MOOSE simulation in exodus format. The simulation is a linear elastic
rectangular plate with a central hole that is loaded in tension (we will
see a visualisation of the mesh and results later). We use `mooseherder` to
load the exodus file into a `SimData` object.

.. GENERATED FROM PYTHON SOURCE LINES 32-35

.. code-block:: Python

    data_path = pyv.DataSet.mechanical_2d_path()
    sim_data = mh.ExodusReader(data_path).read_all_sim_data()


.. GENERATED FROM PYTHON SOURCE LINES 36-39

We scale our SI simulation to mm including the displacement fields which
are also in length units. The string keys we have provided here must match
the variable names you have in your SimData object.

.. GENERATED FROM PYTHON SOURCE LINES 39-45

.. code-block:: Python

    field_name = "disp"
    field_comps = ("disp_x","disp_y")
    sim_data = pyv.scale_length_units(scale=1000.0,
                                        sim_data=sim_data,
                                        disp_comps=field_comps)


.. GENERATED FROM PYTHON SOURCE LINES 46-52

Creating a displacement field point sensor array is similar to what we
have already done for scalar fields we just need to specify the string
keys for the displacement fields in the sim data object we have loaded.
For 2D vector fields we expect to have 2 components which are typically:
("disp_x","disp_y"). For 3D vector fields we have 3 field components which
are typically: ("disp_x","disp_y","disp_z").

.. GENERATED FROM PYTHON SOURCE LINES 52-68

.. code-block:: Python

    n_sens = (2,3,1)
    x_lims = (0.0,100.0)
    y_lims = (0.0,150.0)
    z_lims = (0.0,0.0)
    sens_pos = pyv.create_sensor_pos_array(n_sens,x_lims,y_lims,z_lims)

    sens_data = pyv.SensorData(positions=sens_pos)

    disp_sens_array = pyv.SensorArrayFactory \
                        .disp_sensors_basic_errs(sim_data,
                                                    sens_data,
                                                    elem_dims=2,
                                                    field_name=field_name,
                                                    field_comps=field_comps,
                                                    errs_pc=2.0)


.. GENERATED FROM PYTHON SOURCE LINES 69-72

We run our sensor simulation as normal but we note that the second
dimension of our measurement array will have the two vector components in
the order we specified them in the field keys.

.. GENERATED FROM PYTHON SOURCE LINES 72-74

.. code-block:: Python

    measurements = disp_sens_array.calc_measurements()


.. GENERATED FROM PYTHON SOURCE LINES 75-78

Here we print the shape of the measurement array so we can see that the
second dimension contains both our vector components. We also print some
of the sensor measurements for the first vector component.

.. GENERATED FROM PYTHON SOURCE LINES 78-99

.. code-block:: Python

    print("\n"+80*"-")
    print("For a virtual sensor: measurement = truth + sysematic error + random error")
    print(f"measurements.shape = {measurements.shape} = "+
            "(n_sensors,n_field_components,n_timesteps)\n")
    print("The truth, systematic error and random error arrays have the same "+
            "shape.")

    print(80*"-")

    sens_print = 0
    comp_print = 0
    time_last = 5
    time_print = slice(measurements.shape[2]-time_last,measurements.shape[2])

    print(f"These are the last {time_last} virtual measurements of sensor "
            + f"{sens_print}:")

    pyv.print_measurements(disp_sens_array,sens_print,comp_print,time_print)

    print(80*"-")


.. GENERATED FROM PYTHON SOURCE LINES 100-103

Now that we have multiple field components we can plot each of them on the
simulation mesh and visulise the sensor locations with respect to these
fields.

.. GENERATED FROM PYTHON SOURCE LINES 103-107

.. code-block:: Python

    for ff in field_comps:
        pv_plot = pyv.plot_point_sensors_on_sim(disp_sens_array,ff)
        pv_plot.show(cpos="xy")


.. GENERATED FROM PYTHON SOURCE LINES 108-109

We can also plot the traces for each component of the displacement field.

.. GENERATED FROM PYTHON SOURCE LINES 109-114

.. code-block:: Python

    for ff in field_comps:
        pyv.plot_time_traces(disp_sens_array,ff)

    plt.show()



.. _sphx_glr_download_examples_basics_ex2_1_basicvectors_disp2d.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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