Skip to content

Commit d2fb73a

Browse files
committed
adding extra docstrings
1 parent 823a4eb commit d2fb73a

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

src/Polyhedra.jl

+16
Original file line numberDiff line numberDiff line change
@@ -839,6 +839,15 @@ function split(p::Polyhedron,Π,side=:both;invert=false)
839839
p⁻,p⁺
840840
end
841841

842+
"""
843+
simplexify_boundary(p::Polyhedron,t::GridTopology)
844+
845+
It generates a simplex mesh of the surface of the polyhedron that touches the
846+
grid topology.
847+
848+
It returns the coordinates of the vertices, the connectivities and a mapping
849+
to the topology facets.
850+
"""
842851
function simplexify_boundary(poly::Polyhedron{3},stl::GridTopology)
843852
D = 3
844853
stack = Int32[]
@@ -1300,6 +1309,13 @@ function Base.copy(data::PolyhedronData)
13001309
PolyhedronData(args...)
13011310
end
13021311

1312+
"""
1313+
compute_distances!(p::Polyhedron,planes,plane_ids[;atol=0])
1314+
1315+
Compute the distances from the vertices of the polyhedron to each plane of
1316+
the list `planes`. If the distance is below `atol`, it sets the distance to
1317+
zero.
1318+
"""
13031319
function compute_distances!(p::Polyhedron,Π,faces;atol=0)
13041320
data = get_data(p)
13051321
v_to_f = get_data(p).vertex_to_original_faces

0 commit comments

Comments
 (0)