Skip to content

Commit 7ee25a5

Browse files
committed
fix documenter v1 stuff
1 parent e295336 commit 7ee25a5

File tree

3 files changed

+15
-7
lines changed

3 files changed

+15
-7
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "GridVisualizeTools"
22
uuid = "5573ae12-3b76-41d9-b48c-81d0b6e61cc5"
33
authors = ["Jürgen Fuhrmann <juergen-fuhrmann@web.de>"]
4-
version = "0.3.1"
4+
version = "0.3.2"
55

66
[deps]
77
ColorSchemes = "35d6a980-a343-548e-a6ea-1d62b119f2f4"

docs/src/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,3 +115,11 @@ makeisolevels(collect(0:0.1:10), 1, (1,-1),nothing)
115115
# output
116116
([0.0, 5.0, 10.0], (0.0, 10.0), [0.0, 5.0, 10.0])
117117
```
118+
119+
120+
## Private API
121+
122+
```@docs
123+
GridVisualizeTools.tet_x_plane!
124+
```
125+

src/marching.jl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@
33
Calculate intersections between tetrahedron with given piecewise linear
44
function data and plane
55
6-
Adapted from https://github.com/j-fu/gltools/blob/master/glm-3d.c#L341
6+
Adapted from [gltools](https://github.com/j-fu/gltools/blob/master/glm-3d.c#L341).
77
88
A non-empty intersection is either a triangle or a planar quadrilateral,
9-
define by either 3 or 4 intersection points between tetrahedron edges
9+
defined by either 3 or 4 intersection points between tetrahedron edges
1010
and the plane.
1111
1212
Input:
13-
- pointlist: 3xN array of grid point coordinates
14-
- node_indices: 4 element array of node indices (pointing into pointlist and function_values)
15-
- planeq_values: 4 element array of plane equation evaluated at the node coordinates
13+
- pointlist: 3xN array of grid point coordinates
14+
- node_indices: 4 element array of node indices (pointing into pointlist and function_values)
15+
- planeq_values: 4 element array of plane equation evaluated at the node coordinates
1616
- function_values: N element array of function values
1717
1818
Mutates:
19-
- ixcoord: 3x4 array of plane - tetedge intersection coordinates
19+
- ixcoord: 3x4 array of plane - tetedge intersection coordinates
2020
- ixvalues: 4 element array of fuction values at plane - tetdedge intersections
2121
2222
Returns:

0 commit comments

Comments
 (0)