tud_lbm.io.plotting.scalar_history_plot

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

Classes

MaxVelocityPlot	Plot maximum velocity magnitude over time.
DensityRatioPlot	Plot max/min density ratio over time.
AvgDensityPlot	Plot average density over time.
TotalMassPlot	Plot total domain mass (sum of rho) over time.

Module Contents

class tud_lbm.io.plotting.scalar_history_plot.MaxVelocityPlot(config: tud_lbm.config.SimulationConfig | None = None)

Bases: tud_lbm.io.plotting._analysis_common._BaseAnalysisPlot

Plot maximum velocity magnitude over time.

name = 'max_velocity'

title = 'Maximum velocity vs timestep'

ylabel = 'max(|u|)'

color = 'tab:blue'

required_keys = ('u',)

compute(files: list[pathlib.Path]) → dict[str, numpy.ndarray]

Compute maximum velocity values for each timestep file.

class tud_lbm.io.plotting.scalar_history_plot.DensityRatioPlot(config: tud_lbm.config.SimulationConfig | None = None)

Bases: tud_lbm.io.plotting._analysis_common._BaseAnalysisPlot

Plot max/min density ratio over time.

name = 'density_ratio'

title = 'Density ratio vs timestep'

ylabel = 'max(rho) / min(rho)'

color = 'tab:orange'

ylog = True

required_keys = ('rho',)

compute(files: list[pathlib.Path]) → dict[str, numpy.ndarray]

Compute density ratio values for each timestep file.

class tud_lbm.io.plotting.scalar_history_plot.AvgDensityPlot(config: tud_lbm.config.SimulationConfig | None = None)

Bases: tud_lbm.io.plotting._analysis_common._BaseAnalysisPlot

Plot average density over time.

name = 'avg_density'

title = 'Average density vs timestep'

ylabel = 'mean(rho)'

color = 'tab:green'

required_keys = ('rho',)

compute(files: list[pathlib.Path]) → dict[str, numpy.ndarray]

Compute average density values for each timestep file.

class tud_lbm.io.plotting.scalar_history_plot.TotalMassPlot(config: tud_lbm.config.SimulationConfig | None = None)

Bases: tud_lbm.io.plotting._analysis_common._BaseAnalysisPlot

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

name = 'total_mass'

title = 'Total mass vs timestep'

ylabel = 'sum(rho)'

color = 'tab:olive'

required_keys = ('rho',)

compute(files: list[pathlib.Path]) → dict[str, numpy.ndarray]

Compute total mass values for each timestep file.