﻿fdtdx.SimulationConfig
======================

.. currentmodule:: fdtdx

.. autoclass:: SimulationConfig
   :show-inheritance:

Quick Reference
---------------



.. rubric:: Attributes





* :attr:`~SimulationConfig.backend`



* :attr:`~SimulationConfig.courant_factor`



* :attr:`~SimulationConfig.courant_number`



* :attr:`~SimulationConfig.dtype`



* :attr:`~SimulationConfig.gradient_config`



* :attr:`~SimulationConfig.grid`



* :attr:`~SimulationConfig.has_nonuniform_grid`



* :attr:`~SimulationConfig.invertible_optimization`



* :attr:`~SimulationConfig.max_travel_distance`



* :attr:`~SimulationConfig.only_forward`



* :attr:`~SimulationConfig.resolved_grid`



* :attr:`~SimulationConfig.time`



* :attr:`~SimulationConfig.time_step_duration`



* :attr:`~SimulationConfig.time_steps_total`



* :attr:`~SimulationConfig.use_complex_fields`






.. rubric:: Methods





* :attr:`~SimulationConfig.aset`



* :attr:`~SimulationConfig.get_class_fields`



* :attr:`~SimulationConfig.get_public_fields`



* :attr:`~SimulationConfig.resolve_grid`



* :attr:`~SimulationConfig.uniform_spacing`







Attributes
==========





.. autoattribute:: SimulationConfig.backend



.. autoattribute:: SimulationConfig.courant_factor



.. autoattribute:: SimulationConfig.courant_number



.. autoattribute:: SimulationConfig.dtype



.. autoattribute:: SimulationConfig.gradient_config



.. autoattribute:: SimulationConfig.grid



.. autoattribute:: SimulationConfig.has_nonuniform_grid



.. autoattribute:: SimulationConfig.invertible_optimization



.. autoattribute:: SimulationConfig.max_travel_distance



.. autoattribute:: SimulationConfig.only_forward



.. autoattribute:: SimulationConfig.resolved_grid



.. autoattribute:: SimulationConfig.time



.. autoattribute:: SimulationConfig.time_step_duration



.. autoattribute:: SimulationConfig.time_steps_total



.. autoattribute:: SimulationConfig.use_complex_fields








Methods
==========








.. automethod:: SimulationConfig.aset





.. automethod:: SimulationConfig.get_class_fields





.. automethod:: SimulationConfig.get_public_fields





.. automethod:: SimulationConfig.resolve_grid





.. automethod:: SimulationConfig.uniform_spacing






If you find any errors in the documentation, please report them in the `Github Issues <https://github.com/ymahlau/fdtdx/issues>`_!