.. _api:

=============
API Reference
=============

Meshes
======

Meshes supported by the ``discretize`` package.
The :class:`~discretize.tree_mesh.TreeCell` class is an additional class used to define cells comprising
instances of the :class:`~discretize.TreeMesh` class.

.. toctree::
  :maxdepth: 3

  discretize

Mesh Building Blocks
====================

Base classes for ``discretize`` meshes, classes for constructing discrete operators,
and mixins for interfacing with external libraries.

.. toctree::
  :maxdepth: 2

  discretize.base
  discretize.operators
  discretize.mixins

Utilities
=========

Classes and functions for performing useful operations.

.. toctree::
  :maxdepth: 3

  discretize.utils

Testing
=======

Classes and functions for testing the ``discretize`` package.

.. toctree::
  :maxdepth: 2

  discretize.tests