grid
====

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

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



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





.. rubric:: Submodules

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

   
   * - :py:mod:`cartesian <fridom.framework.grid.cartesian>`
     - Base module for Cartesian grids.
   * - :py:mod:`spectral <fridom.framework.grid.spectral>`
     - Base module for spectral grid classes.

..
   .. autosummary::
      :toctree:
      :recursive:
      
      fridom.framework.grid.cartesian
      fridom.framework.grid.spectral

.. toctree::
   :includehidden:
   :hidden:

   
   fridom.framework.grid.cartesian
   fridom.framework.grid.spectral




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





.. rubric:: Classes, Functions, and Variables





.. currentmodule:: fridom.framework.grid

.. autosummary::
   :toctree:
   :recursive:
   
   GridBase
   DiffModule
   InterpolationModule
   DummyInterpolation


.. currentmodule:: fridom.framework.grid.position

.. autosummary::
   :toctree:
   :recursive:
   
   AxisPosition
   Position


.. currentmodule:: fridom.framework.grid.water_mask

.. autosummary::
   :toctree:
   :recursive:
   
   WaterMask


.. currentmodule:: fridom.framework.grid.boundary_type

.. autosummary::
   :toctree:
   :recursive:
   
   BCType


.. currentmodule:: fridom.framework.grid.fft_padding

.. autosummary::
   :toctree:
   :recursive:
   
   FFTPadding





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

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