bluemira.structural.result
==========================

.. py:module:: bluemira.structural.result

.. autoapi-nested-parse::

   FE result object



Classes
-------

.. autoapisummary::

   bluemira.structural.result.Result


Module Contents
---------------

.. py:class:: Result(geometry: bluemira.structural.geometry.Geometry, load_case: bluemira.structural.loads.LoadCase, deflections: numpy.ndarray, reactions: numpy.ndarray, cyclic_symmetry: bluemira.structural.symmetry.CyclicSymmetry | None)

   Container class for storing results


   .. py:attribute:: __slots__
      :value: ('_cycle_sym', '_max_deflections', '_max_stresses', '_safety_factors', '_stresses',...



   .. py:attribute:: geometry


   .. py:attribute:: load_case


   .. py:attribute:: deflections


   .. py:attribute:: deflections_xyz


   .. py:attribute:: reactions


   .. py:attribute:: _cycle_sym


   .. py:attribute:: _stresses
      :value: None



   .. py:attribute:: _max_stresses
      :value: None



   .. py:attribute:: _safety_factors
      :value: None



   .. py:attribute:: _max_deflections
      :value: None



   .. py:method:: _get_values()

      Get the maximum values of stress, deflection, and safety factors over
      all the Elements in the Geometry.



   .. py:method:: make_deformed_geometry(scale: float = 30.0) -> bluemira.structural.geometry.DeformedGeometry

      Make deformed geometry of the result

      :param scale: The scale for the deformations

      :rtype: The deformed geometry of the Result at the specified scale



   .. py:method:: _make_cyclic_geometry(geometry: bluemira.structural.geometry.Geometry | None = None) -> list[bluemira.structural.geometry.Geometry | bluemira.structural.geometry.DeformedGeometry]


   .. py:method:: plot(deformation_scale: float = 10.0, ax: matplotlib.pyplot.Axes | None = None, *, stress: bool = False, deflection: bool = False, pattern: bool = False, **kwargs)

      Plot the Result of the finite element analysis

      :param deformation_scale: The scale of the deformation to be shown in the plot
      :param ax: The Axes onto which to plot (should be 3-D).
      :param stress: Whether or not to plot stresses [color map]
      :param deflection: Whether or not to plot deflection [color map]
      :param pattern: Whether or not to pattern the model (if symmetry was used)