tud_lbm.io.physical_parameters

Write a human-readable physical parameter overview to disk.

Generates physical_parameters.txt in the run directory whenever a SimulationIO is created with a config. Unlike the saved TOML (machine-readable, round-trippable), this file is intended to be read directly by a human and includes derived quantities such as kinematic viscosity.

Public API:

from tud_lbm.io.physical_parameters import write_physical_parameters
write_physical_parameters(config, "/path/to/run/physical_parameters.txt")

Functions

build_overview(→ str)	Return the full physical parameter overview as a string.
write_physical_parameters(→ None)	Write physical_parameters.txt to path.

Module Contents

tud_lbm.io.physical_parameters.build_overview(config: tud_lbm.config.simulation_config.SimulationConfig) → str

Return the full physical parameter overview as a string.

tud_lbm.io.physical_parameters.write_physical_parameters(config: tud_lbm.config.simulation_config.SimulationConfig, path: str | pathlib.Path) → None

Write physical_parameters.txt to path.

Parameters:

• config – Validated SimulationConfig.

• path – Destination file path (typically <run_dir>/physical_parameters.txt).