API Reference

Meshes

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

• Discretize Meshes (discretize)
  • Mesh Classes
    • discretize.TensorMesh
    • discretize.CylindricalMesh
    • discretize.CurvilinearMesh
    • discretize.TreeMesh
    • discretize.SimplexMesh
  • Mesh Cells
    • discretize.tensor_cell.TensorCell
    • discretize.tree_mesh.TreeCell

Mesh Building Blocks

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

• Base Mesh (discretize.base)
  • Base Mesh Class
• Discrete Operators (discretize.operators)
  • Operator Classes
• Mixins (discretize.mixins)
  • Mixin Classes
  • Other Optional Classes

Utilities

Classes and functions for performing useful operations.

• Utility Classes and Functions (discretize.utils)
  • Utility Classes
    • discretize.utils.TensorType
    • discretize.utils.Zero
    • discretize.utils.Identity
  • Utility Functions
    • Code Utilities
    • Coordinate Transform Utilities
    • Interpolation Utilities
    • IO utilities
    • Matrix Utilities
    • Mesh Utilities
    • Utilities for Curvilinear Meshes

Testing

Classes and functions for testing the discretize package.

• Testing Utilities (discretize.tests)
  • Classes
  • Functions