:py:mod:`FELiCS.Misc.plottingUtils`
===================================

.. py:module:: FELiCS.Misc.plottingUtils


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


Functions
~~~~~~~~~

.. autoapisummary::

   FELiCS.Misc.plottingUtils.plot_modal_spectrum
   FELiCS.Misc.plottingUtils.plot_resolvent_spectrum
   FELiCS.Misc.plottingUtils.plot_scalar_function



Attributes
~~~~~~~~~~

.. autoapisummary::

   FELiCS.Misc.plottingUtils.logger


.. py:data:: logger

   

.. py:function:: plot_modal_spectrum(eigval, eigval_adjoint=None, ax=None, xlim=None, ylim=None)

   Plot direct and optional adjoint eigenvalues.

   :param eigval: Complex direct eigenvalues.
   :type eigval: :py:class:`numpy.ndarray`
   :param eigval_adjoint: Complex adjoint eigenvalues.
   :type eigval_adjoint: :py:class:`numpy.ndarray`, *optional*
   :param ax: Axes to draw on. A new figure is created when *None*.
   :type ax: :py:class:`matplotlib.axes.Axes`, *optional*
   :param xlim: Limits for the x-axis.
   :type xlim: :py:class:`tuple`, *optional*
   :param ylim: Limits for the y-axis.
   :type ylim: :py:class:`tuple`, *optional*

   :rtype: :py:class:`matplotlib.axes.Axes`


.. py:function:: plot_resolvent_spectrum(omega, gains, ax=None, xlim=None, ylim=None)

   Plot resolvent gain curves.

   :param omega: Frequencies at which gains are computed.
   :type omega: :py:class:`numpy.ndarray`
   :param gains: Gains corresponding to each frequency. Should be a 2D array where each column represents a different mode.
   :type gains: :py:class:`numpy.ndarray`
   :param ax: Axes to draw on. A new figure is created when *None*.
   :type ax: :py:class:`matplotlib.axes.Axes`, *optional*
   :param xlim: Limits for the x-axis.
   :type xlim: :py:class:`tuple`, *optional*
   :param ylim: Limits for the y-axis.
   :type ylim: :py:class:`tuple`, *optional*

   :rtype: :py:class:`matplotlib.axes.Axes`


.. py:function:: plot_scalar_function(dolfinx_mesh, function, title='scalar_field', xlim=None, ylim=None, plotType='real', clim=None, axes=None, showBoundaries=True, free_aspect_ratio=False)

   Plot a scalar finite-element function on a two-dimensional mesh.

   This is a debug-level visualisation utility, not intended for
   publication-quality figures.

   :param dolfinx_mesh:
   :type dolfinx_mesh: :py:class:`dolfinx.mesh.Mesh`
   :param function: Scalar function to plot.
   :type function: :py:class:`dolfinx.fem.Function`
   :param title: Base title used for the colorbar label.
   :type title: :py:class:`str`
   :param xlim:
   :type xlim: :py:class:`tuple`, *optional*
   :param ylim:
   :type ylim: :py:class:`tuple`, *optional*
   :param plotType:
   :type plotType: ``{'real', 'imag', 'magnitude', 'angle'}``
   :param clim:
   :type clim: :py:class:`tuple`, *optional*
   :param axes:
   :type axes: :py:class:`matplotlib.axes.Axes`, *optional*
   :param showBoundaries:
   :type showBoundaries: :py:class:`bool`
   :param free_aspect_ratio:
   :type free_aspect_ratio: :py:class:`bool`

   :rtype: :py:class:`matplotlib.axes.Axes`