Merge pull request #123 from nschloe/remove-false-warning

Remove false warning

Author: nschloe

README.md

@@ -130,7 +130,7 @@ circ.append(circ[0])
 
 mesh = pygalmesh.generate_mesh(
     u,
-    feature_edges=[circ],
+    extra_feature_edges=[circ],
     max_cell_circumradius=0.15,
     max_edge_size_at_feature_edges=max_edge_size_at_feature_edges,
     min_facet_angle=25,

pygalmesh/main.py

@@ -1,7 +1,6 @@
 import math
 import os
 import tempfile
-import warnings
 
 import meshio
 import numpy
@@ -29,7 +28,7 @@ def eval(self, x):
 
 def generate_mesh(
     domain,
-    feature_edges=None,
+    extra_feature_edges=None,
     bounding_sphere_radius=0.0,
     lloyd=False,
     odt=False,
@@ -66,7 +65,7 @@ def generate_mesh(
         a scalar field (resp. a constant) describing a space varying (resp. a uniform)
         upper-bound for the circumradii of the mesh tetrahedra.
     """
-    feature_edges = [] if feature_edges is None else feature_edges
+    extra_feature_edges = [] if extra_feature_edges is None else extra_feature_edges
 
     fh, outfile = tempfile.mkstemp(suffix=".mesh")
     os.close(fh)
@@ -90,20 +89,20 @@ def _select(obj):
     ) = _select(max_radius_surface_delaunay_ball)
     max_facet_distance_value, max_facet_distance_field = _select(max_facet_distance)
 
-    if feature_edges:
-        if max_edge_size_at_feature_edges == 0.0:
-            raise ValueError(
-                "Need a positive max_edge_size_at_feature_edges bound if feature_edges are present."
-            )
-    elif max_edge_size_at_feature_edges != 0.0:
-        warnings.warn(
-            "No feature edges. The max_edge_size_at_feature_edges argument has no effect."
-        )
+    # if feature_edges:
+    #     if max_edge_size_at_feature_edges == 0.0:
+    #         raise ValueError(
+    #             "Need a positive max_edge_size_at_feature_edges bound if feature_edges are present."
+    #         )
+    # elif max_edge_size_at_feature_edges != 0.0:
+    #     warnings.warn(
+    #         "No feature edges. The max_edge_size_at_feature_edges argument has no effect."
+    #     )
 
     _generate_mesh(
         domain,
         outfile,
-        feature_edges=feature_edges,
+        extra_feature_edges=extra_feature_edges,
         bounding_sphere_radius=bounding_sphere_radius,
         lloyd=lloyd,
         odt=odt,

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pygalmesh
-version = 0.9.0
+version = 0.9.1
 url = https://github.com/nschloe/pygalmesh
 author = Nico Schlömer
 author_email = nico.schloemer@gmail.com

src/generate.cpp

@@ -49,7 +49,7 @@ void
 generate_mesh(
     const std::shared_ptr<pygalmesh::DomainBase> & domain,
     const std::string & outfile,
-    const std::vector<std::vector<std::array<double, 3>>> & feature_edges,
+    const std::vector<std::vector<std::array<double, 3>>> & extra_feature_edges,
     const double bounding_sphere_radius,
     const bool lloyd,
     const bool odt,
@@ -98,7 +98,7 @@ generate_mesh(
   const auto native_features = translate_feature_edges(domain->get_features());
   cgal_domain.add_features(native_features.begin(), native_features.end());
 
-  const auto polylines = translate_feature_edges(feature_edges);
+  const auto polylines = translate_feature_edges(extra_feature_edges);
   cgal_domain.add_features(polylines.begin(), polylines.end());
 
   // perhaps there's a more elegant solution here

src/generate.hpp

@@ -14,7 +14,7 @@ namespace pygalmesh {
 void generate_mesh(
     const std::shared_ptr<pygalmesh::DomainBase> & domain,
     const std::string & outfile,
-    const std::vector<std::vector<std::array<double, 3>>> & feature_edges = {},
+    const std::vector<std::vector<std::array<double, 3>>> & extra_feature_edges = {},
     const double bounding_sphere_radius = 0.0,
     const bool lloyd = false,
     const bool odt = false,

src/primitives.hpp

@@ -1,3 +1,14 @@
+// Note:
+// One could also implement the primitives as Python classes and have much more readable
+// code. Unfortunately, this approach would be a lot slower. The reason is that CGAL
+// calls the eval() method with individual points, and this many CPP-to-Python calls are
+// very expensive. It would be a lot better if CGAL called the method with batches of X
+// at once, which would also enable users to employ some optimization, but this isn't
+// the case yet. It's not clear if the mesh building algorithm allows for such
+// optimziation at all.
+// The corresponding issue hasn't gained much traction
+// <https://github.com/CGAL/cgal/issues/3874>.
+//
 #ifndef PRIMITIVES_HPP
 #define PRIMITIVES_HPP
 

src/pybind11.cpp

@@ -270,7 +270,7 @@ PYBIND11_MODULE(_pygalmesh, m) {
         "_generate_mesh", &generate_mesh,
         py::arg("domain"),
         py::arg("outfile"),
-        py::arg("feature_edges") = std::vector<std::vector<std::array<double, 3>>>(),
+        py::arg("extra_feature_edges") = std::vector<std::vector<std::array<double, 3>>>(),
         py::arg("bounding_sphere_radius") = 0.0,
         py::arg("lloyd") = false,
         py::arg("odt") = false,

test/test_volume_mesh.py

@@ -37,7 +37,7 @@ def test_balls_union():
 
     mesh = pygalmesh.generate_mesh(
         u,
-        feature_edges=[circ],
+        extra_feature_edges=[circ],
         max_cell_circumradius=0.15,
         max_edge_size_at_feature_edges=max_edge_size_at_feature_edges,
         verbose=False,
@@ -77,7 +77,7 @@ def test_balls_intersection():
 
     mesh = pygalmesh.generate_mesh(
         u,
-        feature_edges=[circ],
+        extra_feature_edges=[circ],
         max_cell_circumradius=0.15,
         max_edge_size_at_feature_edges=max_edge_size_at_feature_edges,
         verbose=False,
@@ -115,7 +115,7 @@ def test_balls_difference():
 
     mesh = pygalmesh.generate_mesh(
         u,
-        feature_edges=[circ],
+        extra_feature_edges=[circ],
         max_cell_circumradius=0.15,
         max_edge_size_at_feature_edges=max_edge_size_at_feature_edges,
         min_facet_angle=25,