tud_lbm.io.plotting.animator
============================

.. py:module:: tud_lbm.io.plotting.animator

.. autoapi-nested-parse::

   Animation builder for field and analysis plotting.



Classes
-------

.. autoapisummary::

   tud_lbm.io.plotting.animator.Animator


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

.. py:class:: Animator(config: tud_lbm.config.SimulationConfig, run_dir: str | pathlib.Path, fps: int = 10, dpi: int = 150, fields: list[str] | None = None)

   Create frame-by-frame animations from saved snapshots.


   .. py:attribute:: fps
      :value: 10



   .. py:attribute:: dpi
      :value: 150



   .. py:attribute:: builder


   .. py:method:: build_frames() -> list[pathlib.Path]

      Build one composite frame per timestep file.



   .. py:method:: create(output_path: str | pathlib.Path | None = None) -> pathlib.Path

      Create an mp4/gif animation from generated frames.