tud_lbm.io.plotting.scalar_history_plot
=======================================

.. py:module:: tud_lbm.io.plotting.scalar_history_plot

.. autoapi-nested-parse::

   Scalar-history analysis plots: a single value vs. timestep.



Classes
-------

.. autoapisummary::

   tud_lbm.io.plotting.scalar_history_plot.MaxVelocityPlot
   tud_lbm.io.plotting.scalar_history_plot.DensityRatioPlot
   tud_lbm.io.plotting.scalar_history_plot.AvgDensityPlot
   tud_lbm.io.plotting.scalar_history_plot.TotalMassPlot


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

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

   Bases: :py:obj:`tud_lbm.io.plotting._analysis_common._BaseAnalysisPlot`


   Plot maximum velocity magnitude over time.


   .. py:attribute:: name
      :value: 'max_velocity'



   .. py:attribute:: title
      :value: 'Maximum velocity vs timestep'



   .. py:attribute:: ylabel
      :value: 'max(|u|)'



   .. py:attribute:: color
      :value: 'tab:blue'



   .. py:attribute:: required_keys
      :value: ('u',)



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

      Compute maximum velocity values for each timestep file.



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

   Bases: :py:obj:`tud_lbm.io.plotting._analysis_common._BaseAnalysisPlot`


   Plot max/min density ratio over time.


   .. py:attribute:: name
      :value: 'density_ratio'



   .. py:attribute:: title
      :value: 'Density ratio vs timestep'



   .. py:attribute:: ylabel
      :value: 'max(rho) / min(rho)'



   .. py:attribute:: color
      :value: 'tab:orange'



   .. py:attribute:: ylog
      :value: True



   .. py:attribute:: required_keys
      :value: ('rho',)



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

      Compute density ratio values for each timestep file.



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

   Bases: :py:obj:`tud_lbm.io.plotting._analysis_common._BaseAnalysisPlot`


   Plot average density over time.


   .. py:attribute:: name
      :value: 'avg_density'



   .. py:attribute:: title
      :value: 'Average density vs timestep'



   .. py:attribute:: ylabel
      :value: 'mean(rho)'



   .. py:attribute:: color
      :value: 'tab:green'



   .. py:attribute:: required_keys
      :value: ('rho',)



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

      Compute average density values for each timestep file.



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

   Bases: :py:obj:`tud_lbm.io.plotting._analysis_common._BaseAnalysisPlot`


   Plot total domain mass (sum of rho) over time.


   .. py:attribute:: name
      :value: 'total_mass'



   .. py:attribute:: title
      :value: 'Total mass vs timestep'



   .. py:attribute:: ylabel
      :value: 'sum(rho)'



   .. py:attribute:: color
      :value: 'tab:olive'



   .. py:attribute:: required_keys
      :value: ('rho',)



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

      Compute total mass values for each timestep file.