modules
=======

Module: :py:mod:`fridom.framework.modules`

.. ==================================================
..  Template for modules that are __init__.py files
.. ==================================================



.. --------------------------------------------------
..  Submodules Section
.. --------------------------------------------------





.. rubric:: Submodules

.. list-table::
   :widths: 10 90

   
   * - :py:mod:`animation <fridom.framework.modules.animation>`
     - Modules for creating animated output of the model
   * - :py:mod:`advection <fridom.framework.modules.advection>`
     - Advection modules for 1D, 2D, and 3D fluid simulations.
   * - :py:mod:`closures <fridom.framework.modules.closures>`
     - Closure modules. E.g. diffusion, hyperdiffusion, etc.
   * - :py:mod:`forcings <fridom.framework.modules.forcings>`
     - Forcing modules. E.g. relaxation

..
   .. autosummary::
      :toctree:
      :recursive:
      
      fridom.framework.modules.animation
      fridom.framework.modules.advection
      fridom.framework.modules.closures
      fridom.framework.modules.forcings

.. toctree::
   :includehidden:
   :hidden:

   
   fridom.framework.modules.animation
   fridom.framework.modules.advection
   fridom.framework.modules.closures
   fridom.framework.modules.forcings




.. --------------------------------------------------
..  Classes, Functions, and Variables Section
.. --------------------------------------------------





.. rubric:: Classes, Functions, and Variables





.. currentmodule:: fridom.framework.modules.module

.. autosummary::
   :toctree:
   :recursive:
   
   Module
   module_method


.. currentmodule:: fridom.framework.modules.module_container

.. autosummary::
   :toctree:
   :recursive:
   
   ModuleContainer


.. currentmodule:: fridom.framework.modules.progress_bar

.. autosummary::
   :toctree:
   :recursive:
   
   ProgressBar


.. currentmodule:: fridom.framework.modules.restart_module

.. autosummary::
   :toctree:
   :recursive:
   
   RestartModule


.. currentmodule:: fridom.framework.modules.netcdf_writer

.. autosummary::
   :toctree:
   :recursive:
   
   NetCDFWriter


.. currentmodule:: fridom.framework.modules

.. autosummary::
   :toctree:
   :recursive:
   
   ResetTendency


.. currentmodule:: fridom.framework.modules.figure_saver

.. autosummary::
   :toctree:
   :recursive:
   
   FigureSaver





.. automodule:: fridom.framework.modules
   :no-members:
   :no-inherited-members:
   :no-special-members:
   :no-private-members:
   :undoc-members:

.. ==================================================
..  Template for modules that are no __init__.py files
.. ==================================================