torax package
=============

Subpackages
-----------

.. toctree::
   :maxdepth: 4

   torax.config
   torax.fvm
   torax.geometry
   torax.physics
   torax.plotting
   torax.sources
   torax.stepper
   torax.time_step_calculator
   torax.transport_model

Submodules
----------

torax.array\_typing module
--------------------------

.. automodule:: torax.array_typing
   :members:
   :show-inheritance:

torax.conftest module
---------------------

.. automodule:: torax.conftest
   :members:
   :show-inheritance:

torax.constants module
----------------------

.. automodule:: torax.constants
   :members:
   :show-inheritance:

torax.interpolated\_param module
--------------------------------

.. automodule:: torax.interpolated_param
   :members:
   :show-inheritance:

torax.jax\_utils module
-----------------------

.. automodule:: torax.jax_utils
   :members:
   :show-inheritance:

torax.math\_utils module
------------------------

.. automodule:: torax.math_utils
   :members:
   :show-inheritance:

torax.output module
-------------------

.. automodule:: torax.output
   :members:
   :show-inheritance:

torax.post\_processing module
-----------------------------

.. automodule:: torax.post_processing
   :members:
   :show-inheritance:

torax.run\_simulation\_main module
----------------------------------

.. automodule:: torax.run_simulation_main
   :members:
   :show-inheritance:

torax.sim module
----------------

.. automodule:: torax.sim
   :members:
   :show-inheritance:

torax.state module
------------------

.. automodule:: torax.state
   :members:
   :show-inheritance:

torax.version module
--------------------

.. automodule:: torax.version
   :members:
   :show-inheritance:

Module contents
---------------

.. automodule:: torax
   :members:
   :show-inheritance: