Skip to content

Commit

Permalink
Add images in example_StiffnessTensor.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
DorianDepriester committed Nov 29, 2024
1 parent 5afc342 commit 596cc78
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 1 deletion.
Binary file added docs/_static/images/E_PF.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/E_plot3D.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/E_xyz_sections.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/G_plot3D.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/G_plot3D_min.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/G_xyz_sections.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 19 additions & 1 deletion docs/source/example_StiffnessTensor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,15 +90,24 @@ In order to fully evidence the directional dependence of the Young moduli, we ca

>>> E.plot3D() # doctest: +SKIP

.. image:: ../_static/images/E_plot3D.png
:width: 400

It is advised to use interactive plot to be able to zoom/rotate the surface. For flat images (i.e. to put in
document/articles), we can use plot the values as a Pole Figure (PF):

>>> E.plot_as_pole_figure() # doctest: +SKIP

.. image:: ../_static/images/E_PF.png
:width: 400

Alternatively, we can plot the Young moduli on X-Y, X-Z and Y-Z sections only:

>>> E.plot_xyz_sections() # doctest: +SKIP

.. image:: ../_static/images/E_xyz_sections.png
:width: 600

Hyperspherical functions
~~~~~~~~~~~~~~~~~~~~~~~~
Hyperspherical functions cannot plotted as 3D surfaces, as their values depend on two orthogonal directions.
Expand All @@ -107,12 +116,21 @@ plotting:

>>> G.plot3D() # doctest: +SKIP

.. image:: ../_static/images/G_plot3D.png
:width: 400

Instead of the mean value, we can consider other statistics, e.g.:

>>> G.plot3D(which='min') # doctest: +SKIP

.. image:: ../_static/images/G_plot3D_min.png
:width: 400

This also works for ``max`` and ``std``. These parameters also apply for pole figures (see above).

When plotting the X-Y, X-Z and Y-Z sections, the min, max and mean values are plotted at once:

>>> G.plot_xyz_sections() # doctest: +SKIP
>>> G.plot_xyz_sections() # doctest: +SKIP

.. image:: ../_static/images/G_xyz_sections.png
:width: 600

0 comments on commit 596cc78

Please sign in to comment.