:py:mod:`BladeAD.utils.plot`
============================

.. py:module:: BladeAD.utils.plot


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


Functions
~~~~~~~~~

.. autoapisummary::

   BladeAD.utils.plot.make_polarplot



.. py:function:: make_polarplot(data: csdl_alpha.Variable, radius: Union[csdl_alpha.Variable, float, int, None] = None, norm_hub_radius: Union[float] = 0.2, quantity_name: list[str] = ['quantity'], plot_contours: bool = True, num_contours: int = 15, plot_min_max: bool = True, azimuthal_offset: Union[float, int, None] = None, fig_size: tuple = (10, 8), cmap: str = 'viridis', vmin=None, vmax=None)

   
   Generate polar plots for quantities that vary azimuthally and radially. 

   If radius is not provided, plot between normalized hub radius and 1. 

   Works for multiple evaluations (i.e., num_nodes>1)

   :Parameters:

       **data** : csdl.Variable
           Data to be plotted; must be of shape (num_nodes, num_radial, num_azimuthal)

       **radius** : Union[csdl.Variable, float, int, None], optional
           rotor radius; if None, plot between hub radius and 1, by default None

       **norm_hub_radius** : float, optional
           fraction of radius, by default 0.2

       **quantity_name** : str, optional
           name of the quantity to be plotted, by default 'quantity'

       **plot_contours** : bool, optional
           flag for plotting contours, by default True

       **num_contours** : int, optional
           number of contours, by default 10

       **plot_min_max** : bool, optional
           flag for plotting min/max values

       **azimuthal_offset** : Union[float, int, None], optional
           rotate the polar plot counter clockwise (in degrees), by default None

       **fig_size** : tuple, optional
           by default (10, 8)

       **cmap** : str, optional
           string for matplotlib colormaps, by default 'viridis'














   ..
       !! processed by numpydoc !!