Skip to content

Commit b15eafe

Browse files
committed
Changed position of docstring for Documentation
1 parent 7bfdaa2 commit b15eafe

2 files changed

Lines changed: 29 additions & 29 deletions

File tree

docs/src/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,4 @@ makeisolevels(collect(0:0.1:10), 1, (1,-1),nothing)
123123

124124
```@docs
125125
GridVisualizeTools.calculate_plane_tetrahedron_intersection!
126-
GridVisualizeTools.assign_coordinates_at_point_in_plane!
127-
GridVisualizeTools.assign_coordinates_at_intersection!
128126
```

src/marching.jl

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,3 @@
1-
"""
2-
$(SIGNATURES)
3-
Calculate intersections between tetrahedron with given piecewise linear
4-
function data and plane
5-
6-
Adapted from [gltools](https://github.com/j-fu/gltools/blob/master/glm-3d.c#L341).
7-
8-
A non-empty intersection is either a triangle or a planar quadrilateral,
9-
defined by either 3 or 4 intersection points between tetrahedron edges
10-
and the plane.
11-
12-
Input:
13-
- coordinates: 3xN array of grid point coordinates
14-
- node_indices: 4 element array of node indices (pointing into coordinates and function_values)
15-
- planeq_values: 4 element array of plane equation evaluated at the node coordinates
16-
- function_values: N element array of function values
17-
18-
Mutates:
19-
- ixcoord: 3x4 array of plane - tetedge intersection coordinates
20-
- ixvalues: 4 element array of function values at plane - tetdedge intersections
21-
22-
Returns:
23-
- nxs,ixcoord,ixvalues
24-
25-
This method can be used both for the evaluation of plane sections and for
26-
the evaluation of function isosurfaces.
27-
"""
281
function assign_coordinates_at_point_in_plane!(
292
ixcoord,
303
ixvalues,
@@ -60,6 +33,35 @@ function assign_coordinates_at_intersection!(
6033
return nothing
6134
end
6235

36+
37+
"""
38+
$(SIGNATURES)
39+
Calculate intersections between tetrahedron with given piecewise linear
40+
function data and plane
41+
42+
Adapted from [gltools](https://github.com/j-fu/gltools/blob/master/glm-3d.c#L341).
43+
44+
A non-empty intersection is either a triangle or a planar quadrilateral,
45+
defined by either 3 or 4 intersection points between tetrahedron edges
46+
and the plane.
47+
48+
Input:
49+
- coordinates: 3xN array of grid point coordinates
50+
- node_indices: 4 element array of node indices (pointing into coordinates and function_values)
51+
- planeq_values: 4 element array of plane equation evaluated at the node coordinates
52+
- function_values: N element array of function values
53+
54+
Mutates:
55+
- ixcoord: 3x4 array of plane - tetedge intersection coordinates
56+
- ixvalues: 4 element array of function values at plane - tetdedge intersections
57+
58+
Returns:
59+
- amount_intersections,ixcoord,ixvalues
60+
61+
This method can be used both for the evaluation of plane sections and for
62+
the evaluation of function isosurfaces.
63+
"""
64+
6365
function calculate_plane_tetrahedron_intersection!(
6466
ixcoord,
6567
ixvalues,

0 commit comments

Comments
 (0)