tud_lbm.io.plotting.velocity
============================

.. py:module:: tud_lbm.io.plotting.velocity

.. autoapi-nested-parse::

   Velocity magnitude and quiver plot operator.



Classes
-------

.. autoapisummary::

   tud_lbm.io.plotting.velocity.VelocityPlotOperator


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

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

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


   Render velocity magnitude with a downsampled vector overlay.


   .. py:attribute:: name
      :value: 'velocity'



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

      Check if velocity data is available in the dataset.

      :param data: Dictionary containing simulation output data.

      :returns: True if velocity field 'u' is present in data, False otherwise.



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

      Render velocity magnitude with a downsampled vector overlay.

      :param ax: Matplotlib axes object to plot on.
      :param data: Dictionary containing simulation output data with velocity field.
      :param timestep: Current simulation timestep for display in title.