framework
=========

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

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



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





.. rubric:: Submodules

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

   
   * - :py:mod:`exceptions <fridom.framework.exceptions>`
     - exceptions.py - Custom exceptions for the framework.
   * - :py:mod:`grid <fridom.framework.grid>`
     - All grid related classes and functions.
   * - :py:mod:`domain_decomposition <fridom.framework.domain_decomposition>`
     - Domain Decomposition.
   * - :py:mod:`utils <fridom.framework.utils>`
     - Utility functions and classes for the FRIDOM framework.
   * - :py:mod:`time_steppers <fridom.framework.time_steppers>`
     - Time Steppers.
   * - :py:mod:`modules <fridom.framework.modules>`
     - Base classes and functions for creating modules in the model.
   * - :py:mod:`projection <fridom.framework.projection>`
     - Projection.
   * - :py:mod:`timing_module <fridom.framework.timing_module>`
     - timing_module.py - Keep track of the time spent in different model components.

..
   .. autosummary::
      :toctree:
      :recursive:
      
      fridom.framework.exceptions
      fridom.framework.grid
      fridom.framework.domain_decomposition
      fridom.framework.utils
      fridom.framework.time_steppers
      fridom.framework.modules
      fridom.framework.projection
      fridom.framework.timing_module

.. toctree::
   :includehidden:
   :hidden:

   
   fridom.framework.exceptions
   fridom.framework.grid
   fridom.framework.domain_decomposition
   fridom.framework.utils
   fridom.framework.time_steppers
   fridom.framework.modules
   fridom.framework.projection
   fridom.framework.timing_module




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





.. rubric:: Classes, Functions, and Variables





.. currentmodule:: fridom.framework.configuration

.. autosummary::
   :toctree:
   :recursive:
   
   config


.. currentmodule:: fridom.framework.logger

.. autosummary::
   :toctree:
   :recursive:
   
   log


.. currentmodule:: fridom.framework.model_settings_base

.. autosummary::
   :toctree:
   :recursive:
   
   ModelSettingsBase


.. currentmodule:: fridom.framework.field_base

.. autosummary::
   :toctree:
   :recursive:
   
   FieldBase


.. currentmodule:: fridom.framework.field_metadata

.. autosummary::
   :toctree:
   :recursive:
   
   FieldMetadata


.. currentmodule:: fridom.framework.scalar_field

.. autosummary::
   :toctree:
   :recursive:
   
   ScalarField


.. currentmodule:: fridom.framework.vector_field

.. autosummary::
   :toctree:
   :recursive:
   
   VectorField


.. currentmodule:: fridom.framework.tensor_field

.. autosummary::
   :toctree:
   :recursive:
   
   TensorField


.. currentmodule:: fridom.framework.model_state

.. autosummary::
   :toctree:
   :recursive:
   
   ModelState


.. currentmodule:: fridom.framework.model

.. autosummary::
   :toctree:
   :recursive:
   
   Model


.. currentmodule:: fridom.framework.clock

.. autosummary::
   :toctree:
   :recursive:
   
   Clock
   TimingFormat


.. currentmodule:: fridom.framework.clock_trigger

.. autosummary::
   :toctree:
   :recursive:
   
   ClockTrigger





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

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