tud_lbm.io.plotting.overview_simulation_inc_snapshots
=====================================================

.. py:module:: tud_lbm.io.plotting.overview_simulation_inc_snapshots

.. autoapi-nested-parse::

   Composite figure: ca_theta_vs_x with density/velocity snapshots at chosen timesteps.



Classes
-------

.. autoapisummary::

   tud_lbm.io.plotting.overview_simulation_inc_snapshots.SnapshotOverviewPlot


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

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

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


   ca_theta_vs_x plot with lettered density/velocity snapshots alongside it.


   .. py:attribute:: name
      :value: 'snapshot_fig'



   .. py:attribute:: required_keys
      :value: ('ca_left', 'ca_right', 'cll_left', 'cll_right')



   .. py:attribute:: is_multi_panel
      :value: True



   .. py:attribute:: timesteps
      :type:  list[int]
      :value: []



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

      Unused: this operator builds its figure via ``render_figure`` instead.



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

      Render a placeholder; this operator is only meaningful via render_figure().



   .. py:method:: render_figure(files: list[pathlib.Path]) -> matplotlib.figure.Figure

      Build the ca_theta_vs_x plot with lettered density/velocity snapshots.