Skip to content

Commit

Permalink
[docs] add some documentation for UnstructuredTriangleGrid
Browse files Browse the repository at this point in the history
  • Loading branch information
sdrave committed Nov 6, 2015
1 parent 38fa988 commit e80122a
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/pymor/grids/unstructured.py
Expand Up @@ -12,6 +12,20 @@


class UnstructuredTriangleGrid(AffineGridInterface):
"""A generic unstructured, triangular grid.
Parameters
----------
vertices
A (num_vertices, 2)-shaped |array| containing the coordinates
of all vertices in the grid. The row numbers in the array will
be the global indices of the given vertices (codim 2 entities).
faces
A (num_faces, 3)-shaped |array| containing the global indices
of the vertices which define a given triangle in the grid.
The row numbers in the array will be the global indices of the
given triangles (codim 0 entities).
"""

dim = 2
dim_outer = 2
Expand Down

0 comments on commit e80122a

Please sign in to comment.