anastruct.fem.plotter.values
============================

.. py:module:: anastruct.fem.plotter.values


Classes
-------

.. autoapisummary::

   anastruct.fem.plotter.values.PlottingValues


Functions
---------

.. autoapisummary::

   anastruct.fem.plotter.values.det_scaling_factor


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

.. py:function:: det_scaling_factor(max_unit: float, max_val_structure: float) -> float

   Determines the scaling factor for the plotting values.

   Args:
       max_unit (float): Maximum value of the unit to be plotted
       max_val_structure (float): Maximum value of the structure coordinates

   Returns:
       float: Scaling factor


.. py:class:: PlottingValues(system: anastruct.fem.system.SystemElements, mesh: int)

   .. py:attribute:: system
      :type:  anastruct.fem.system.SystemElements


   .. py:attribute:: mesh
      :type:  int


   .. py:attribute:: _max_val_structure
      :type:  Optional[float]
      :value: None



   .. py:property:: max_val_structure
      :type: float


      Maximum value of the structures dimensions.

      Returns:
          float: Maximum value of the structures dimensions.



   .. py:method:: displacements(factor: Optional[float], linear: bool) -> Tuple[numpy.ndarray, numpy.ndarray]

      Determines the plotting values for displacements

      Args:
          factor (Optional[float]): Factor by which to multiply the plotting values perpendicular to the elements axis
          linear (bool): If True, the bending in between the elements is determined.

      Returns:
          Tuple[np.ndarray, np.ndarray]: x and y values



   .. py:method:: bending_moment(factor: Optional[float]) -> Tuple[numpy.ndarray, numpy.ndarray]

      Determines the plotting values for bending moment

      Args:
          factor (Optional[float]): Factor by which to multiply the plotting values perpendicular to the elements axis

      Returns:
          Tuple[np.ndarray, np.ndarray]: x and y values



   .. py:method:: axial_force(factor: Optional[float]) -> Tuple[numpy.ndarray, numpy.ndarray]

      Determines the plotting values for axial force

      Returns:
          Tuple[np.ndarray, np.ndarray]: x and y values



   .. py:method:: shear_force(factor: Optional[float]) -> Tuple[numpy.ndarray, numpy.ndarray]

      Determines the plotting values for shear force

      Args:
          factor (Optional[float]): Factor by which to multiply the plotting values perpendicular to the elements axis

      Returns:
          Tuple[np.ndarray, np.ndarray]: x and y values



   .. py:method:: structure() -> Tuple[numpy.ndarray, numpy.ndarray]

      Determines the plotting values for the structure itself

      Returns:
          Tuple[np.ndarray, np.ndarray]: x and y values