tud_lbm.config

Configuration package for TUD-LBM.

Public API:

from config import SimulationConfig, from_toml, from_dict
from config import TomlAdapter, DictAdapter

Submodules

• tud_lbm.config.adapter_base
• tud_lbm.config.adapter_dict
• tud_lbm.config.adapter_toml
• tud_lbm.config.array_expansion
• tud_lbm.config.config_overview
• tud_lbm.config.jax_config
• tud_lbm.config.simulation_config

Functions

from_toml(→ simulation_config.SimulationConfig)	Load a TOML file and return a validated SimulationConfig.
from_dict(→ simulation_config.SimulationConfig)	Build a SimulationConfig from a plain dict.

Package Contents

tud_lbm.config.from_toml(path: str) → simulation_config.SimulationConfig

Load a TOML file and return a validated SimulationConfig.

This is a convenience wrapper that uses TomlAdapter internally. The returned object is a config — pass it to setup.simulation_setup.build_setup() to obtain the JAX-friendly SimulationSetup.

Parameters:

path – Filesystem path to a .toml file.

Returns:

A SimulationConfig.

tud_lbm.config.from_dict(d: dict[str, Any]) → simulation_config.SimulationConfig

Build a SimulationConfig from a plain dict.

Parameters:

d – Configuration mapping.

Returns:

A validated SimulationConfig.