Skip to content

Commit

Permalink
Merge pull request #325 from santisoler/cell-bounds
Browse files Browse the repository at this point in the history
Add new TensorCell class
  • Loading branch information
jcapriot authored Jun 27, 2023
2 parents 2480627 + 58b8e55 commit d6eb086
Show file tree
Hide file tree
Showing 5 changed files with 1,204 additions and 5 deletions.
1 change: 1 addition & 0 deletions .flake8
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ rst-roles =
func,
mod,
meth,
attr,
ref,
data,
# Python programming language:
Expand Down
17 changes: 12 additions & 5 deletions discretize/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,21 @@
TreeMesh
SimplexMesh
Tree Mesh Cells
===============
The :class:`~discretize.tree_mesh.TreeCell` class was designed specificialy to define the cells within tree meshes.
Instances of :class:`~discretize.tree_mesh.TreeCell` are not meant to be created on there own.
However, they can be returned directly by indexing a particular cell within a tree mesh.
Mesh Cells
==========
The :class:`~discretize.tensor_cell.TensorCell` and
:class:`~discretize.tree_mesh.TreeCell` classes were designed specifically to
define the cells within tensor and tree meshes, respectively.
Instances of :class:`~discretize.tree_mesh.TreeCell` and
:class:`~discretize.tensor_cell.TensorCell` are not meant to be created on
their own.
However, they can be returned directly by indexing a particular cell within
a tensor or tree mesh.
.. autosummary::
:toctree: generated/
tensor_cell.TensorCell
tree_mesh.TreeCell
"""

Expand All @@ -35,6 +41,7 @@
from discretize.curvilinear_mesh import CurvilinearMesh
from discretize.unstructured_mesh import SimplexMesh
from discretize.utils.io_utils import load_mesh
from .tensor_cell import TensorCell

try:
from discretize.tree_mesh import TreeMesh
Expand Down
Loading

0 comments on commit d6eb086

Please sign in to comment.