tud_lbm.io.plotting.density
===========================

.. py:module:: tud_lbm.io.plotting.density

.. autoapi-nested-parse::

   Density field plot operator.



Attributes
----------

.. autoapisummary::

   tud_lbm.io.plotting.density.DENSITY_RATIO_THRESHOLD


Classes
-------

.. autoapisummary::

   tud_lbm.io.plotting.density.DensityPlotOperator


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

.. py:data:: DENSITY_RATIO_THRESHOLD
   :value: 100


.. py:class:: DensityPlotOperator(config: tud_lbm.config.SimulationConfig, data_dir: str | pathlib.Path | None = None)

   Bases: :py:obj:`tud_lbm.io.plotting.base.PlotOperator`


   Render the density field as a 2-D colour map.


   .. py:attribute:: name
      :value: 'density'



   .. py:method:: is_available(data: dict[str, numpy.ndarray]) -> bool

      Check if density data is available for rendering.



   .. py:method:: __call__(ax: matplotlib.axes.Axes, data: dict[str, numpy.ndarray], timestep: int) -> None

      Render the density field as a 2D color map.