tud_lbm.io.plotting.base
========================

.. py:module:: tud_lbm.io.plotting.base

.. autoapi-nested-parse::

   Abstract base class for plot operators.



Classes
-------

.. autoapisummary::

   tud_lbm.io.plotting.base.PlotOperator
   tud_lbm.io.plotting.base.AnalysisPlot


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

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

   Bases: :py:obj:`abc.ABC`


   Base class for a single-panel plotting operator.


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: config


   .. py:attribute:: data_dir


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


      Draw this operator on the provided axes.



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

      Whether this operator has enough data to render.



.. py:class:: AnalysisPlot(config: tud_lbm.config.SimulationConfig | None = None)

   Bases: :py:obj:`abc.ABC`


   Base class for analysis plots computed from saved snapshot history.


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: config
      :value: None



   .. py:method:: compute(files: list[pathlib.Path]) -> dict[str, numpy.ndarray]
      :abstractmethod:


      Compute time-series arrays from snapshot files.



   .. py:method:: render(ax: matplotlib.axes.Axes, precomputed: dict[str, numpy.ndarray]) -> None
      :abstractmethod:


      Render the full analysis plot from precomputed arrays.



   .. py:method:: update(ax: matplotlib.axes.Axes, files: list[pathlib.Path]) -> None

      Render analysis for a prefix of snapshot files (animation-friendly).