tud_lbm.io.save
===============

.. py:module:: tud_lbm.io.save

.. autoapi-nested-parse::

   Input/Output handler for simulation management and logging.



Classes
-------

.. autoapisummary::

   tud_lbm.io.save.SimulationIO


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

.. py:class:: SimulationIO(base_dir: str = 'results', config: tud_lbm.config.simulation_config.SimulationConfig | None = None, simulation_name: str | None = None, output_format: str = 'numpy', config_file_type: str = '.toml')

   Handles all I/O operations for the simulation, including logging and saving results.


   .. py:attribute:: base_dir
      :value: ''



   .. py:attribute:: simulation_name
      :value: None



   .. py:attribute:: config_file_type
      :value: '.toml'



   .. py:attribute:: run_dir
      :value: ''



   .. py:attribute:: data_dir
      :value: ''



   .. py:attribute:: save_data_step


   .. py:method:: save_config(config: tud_lbm.config.simulation_config.SimulationConfig) -> None

      Save the simulation configuration to the run directory.

      Accepts  a :class:`SimulationConfig`.
      Uses :func:`~config.adapter_base.get_adapter` to dispatch to the
      correct adapter based on :attr:`config_file_type`.

      :param config: A configuration dict or SimulationConfig object.