tud_lbm.io.physical_parameters
==============================

.. py:module:: tud_lbm.io.physical_parameters

.. autoapi-nested-parse::

   Write a human-readable physical parameter overview to disk.

   Generates ``physical_parameters.txt`` in the run directory whenever a
   :class:`~tud_lbm.io.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
---------

.. autoapisummary::

   tud_lbm.io.physical_parameters.build_overview
   tud_lbm.io.physical_parameters.write_physical_parameters


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

.. py:function:: build_overview(config: tud_lbm.config.simulation_config.SimulationConfig) -> str

   Return the full physical parameter overview as a string.


.. py:function:: write_physical_parameters(config: tud_lbm.config.simulation_config.SimulationConfig, path: str | pathlib.Path) -> None

   Write ``physical_parameters.txt`` to *path*.

   :param config: Validated :class:`~tud_lbm.config.simulation_config.SimulationConfig`.
   :param path: Destination file path (typically ``<run_dir>/physical_parameters.txt``).