Change VOM missing_points_behaviour API (#4524)

Author: leo-collins

firedrake/mesh.py

@@ -3317,7 +3317,7 @@ def ExtrudedMesh(mesh, layers, layer_height=None, extrusion_type='uniform', peri
 
 
 class MissingPointsBehaviour(enum.Enum):
-    IGNORE = None
+    IGNORE = "ignore"
     ERROR = "error"
     WARN = "warn"
 
@@ -3358,7 +3358,8 @@ def VertexOnlyMesh(mesh, vertexcoords, reorder=None, missing_points_behaviour='e
     :kwarg missing_points_behaviour: optional string argument for what to do
         when vertices which are outside of the mesh are discarded. If
         ``'warn'``, will print a warning. If ``'error'`` will raise a
-        :class:`~.VertexOnlyMeshMissingPointsError`.
+        :class:`~.VertexOnlyMeshMissingPointsError`. If ``'ignore'``, will do
+        nothing. Default is ``'error'``.
     :kwarg tolerance: The relative tolerance (i.e. as defined on the reference
         cell) for the distance a point can be from a mesh cell and still be
         considered to be in the cell. Note that this tolerance uses an L1

tests/firedrake/vertexonly/test_interpolation_from_parent.py

@@ -158,7 +158,7 @@ def immersed_sphere_vertexcoords(mesh, vertexcoords_old):
 def test_scalar_spatialcoordinate_interpolation(parentmesh, vertexcoords):
     if parentmesh.name == "immersedsphere":
         vertexcoords = immersed_sphere_vertexcoords(parentmesh, vertexcoords)
-    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour="ignore")
     # Reshaping because for all meshes, we want (-1, gdim) but
     # when gdim == 1 PyOP2 doesn't distinguish between dats with shape
     # () and shape (1,).
@@ -172,7 +172,7 @@ def test_scalar_spatialcoordinate_interpolation(parentmesh, vertexcoords):
 def test_scalar_function_interpolation(parentmesh, vertexcoords, fs):
     if parentmesh.name == "immersedsphere":
         vertexcoords = immersed_sphere_vertexcoords(parentmesh, vertexcoords)
-    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour="ignore")
     vertexcoords = vm.coordinates.dat.data_ro.reshape(-1, parentmesh.geometric_dimension())
     fs_fam, fs_deg, fs_typ = fs
     if (
@@ -202,7 +202,7 @@ def test_scalar_function_interpolation(parentmesh, vertexcoords, fs):
 def test_vector_spatialcoordinate_interpolation(parentmesh, vertexcoords):
     if parentmesh.name == "immersedsphere":
         vertexcoords = immersed_sphere_vertexcoords(parentmesh, vertexcoords)
-    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour="ignore")
     vertexcoords = vm.coordinates.dat.data_ro
     W = VectorFunctionSpace(vm, "DG", 0)
     expr = 2 * SpatialCoordinate(parentmesh)
@@ -214,7 +214,7 @@ def test_vector_function_interpolation(parentmesh, vertexcoords, vfs):
     if parentmesh.name == "immersedsphere":
         vertexcoords = immersed_sphere_vertexcoords(parentmesh, vertexcoords)
     vfs_fam, vfs_deg, vfs_typ = vfs
-    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour="ignore")
     vertexcoords = vm.coordinates.dat.data_ro
     if (
         parentmesh.coordinates.function_space().ufl_element().family()
@@ -242,7 +242,7 @@ def test_vector_function_interpolation(parentmesh, vertexcoords, vfs):
 def test_tensor_spatialcoordinate_interpolation(parentmesh, vertexcoords):
     if parentmesh.name == "immersedsphere":
         vertexcoords = immersed_sphere_vertexcoords(parentmesh, vertexcoords)
-    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour="ignore")
     vertexcoords = vm.coordinates.dat.data_ro
     W = TensorFunctionSpace(vm, "DG", 0)
     x = SpatialCoordinate(parentmesh)
@@ -260,7 +260,7 @@ def test_tensor_function_interpolation(parentmesh, vertexcoords, tfs):
     if parentmesh.name == "immersedsphere":
         vertexcoords = immersed_sphere_vertexcoords(parentmesh, vertexcoords)
     tfs_fam, tfs_deg, tfs_typ = tfs
-    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour="ignore")
     vertexcoords = vm.coordinates.dat.data_ro
     if (
         parentmesh.coordinates.function_space().ufl_element().family()
@@ -296,7 +296,7 @@ def test_mixed_function_interpolation(parentmesh, vertexcoords, tfs):
         vertexcoords = immersed_sphere_vertexcoords(parentmesh, vertexcoords)
     tfs_fam, tfs_deg, tfs_typ = tfs
 
-    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour="ignore")
     vertexcoords = vm.coordinates.dat.data_ro.reshape(-1, parentmesh.geometric_dimension())
     if (
         parentmesh.coordinates.function_space().ufl_element().family()
@@ -336,7 +336,7 @@ def test_mixed_function_interpolation(parentmesh, vertexcoords, tfs):
 
 
 def test_scalar_real_interpolation(parentmesh, vertexcoords):
-    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour="ignore")
     W = FunctionSpace(vm, "DG", 0)
     V = FunctionSpace(parentmesh, "Real", 0)
     # Remove below when interpolating constant onto Real works for extruded
@@ -351,7 +351,7 @@ def test_scalar_real_interpolation(parentmesh, vertexcoords):
 
 def test_scalar_real_interpolator(parentmesh, vertexcoords):
     # try and make reusable Interpolator from V to W
-    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour="ignore")
     W = FunctionSpace(vm, "DG", 0)
     V = FunctionSpace(parentmesh, "Real", 0)
     # Remove below when interpolating constant onto Real works for extruded
@@ -378,8 +378,8 @@ def test_extruded_cell_parent_cell_list():
     # we are not at the cell midpoints
     coords = np.array([[0.2, 0.1], [0.5, 0.2], [0.7, 0.1], [0.2, 0.4], [0.4, 0.4], [0.8, 0.5], [0.1, 0.7], [0.5, 0.9], [0.9, 0.8]])
 
-    vms = VertexOnlyMesh(ms, coords, missing_points_behaviour=None)
-    vmx = VertexOnlyMesh(mx, coords, missing_points_behaviour=None)
+    vms = VertexOnlyMesh(ms, coords, missing_points_behaviour="ignore")
+    vmx = VertexOnlyMesh(mx, coords, missing_points_behaviour="ignore")
     assert vms.num_cells() == len(coords)
     assert vmx.num_cells() == len(coords)
     assert np.equal(vms.coordinates.dat.data_ro, coords[vms.topology._dm_renumbering]).all()

tests/firedrake/vertexonly/test_vertex_only_fs.py

@@ -281,7 +281,7 @@ def vectorfunctionspace_tests(vm, petsc_raises):
 
 @pytest.mark.parallel([1, 3])
 def test_functionspaces(parentmesh, vertexcoords, petsc_raises):
-    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour="ignore")
     functionspace_tests(vm, petsc_raises)
     vectorfunctionspace_tests(vm, petsc_raises)
     functionspace_tests(vm.input_ordering, petsc_raises)
@@ -313,7 +313,7 @@ def test_input_ordering_missing_point():
     m = UnitIntervalMesh(4)
     points = np.asarray([[0.125], [0.375], [0.625], [5.0]])
     data = np.asarray([1.0, 2.0, 3.0, 4.0])
-    vm = VertexOnlyMesh(m, points, missing_points_behaviour=None, redundant=True)
+    vm = VertexOnlyMesh(m, points, missing_points_behaviour="ignore", redundant=True)
 
     # put data on the input ordering
     P0DG_input_ordering = FunctionSpace(vm.input_ordering, "DG", 0)

tests/firedrake/vertexonly/test_vertex_only_manual.py

@@ -69,7 +69,7 @@ def display_correct_indent():
         vom = VertexOnlyMesh(parent_mesh, points, missing_points_behaviour='warn')
 
         # This will cause the point to be silently lost
-        vom = VertexOnlyMesh(parent_mesh, points, missing_points_behaviour=None)
+        vom = VertexOnlyMesh(parent_mesh, points, missing_points_behaviour="ignore")
         # [test_vom_manual_points_outside_domain 6]
 
         assert vom  # Just here to shut up flake8 unused variable warning.

tests/firedrake/vertexonly/test_vertex_only_mesh_generation.py

@@ -316,7 +316,7 @@ def test_generate_random(parentmesh, vertexcoords):
         # TODO: This failure should be investigated
         pytest.skip(reason="This test hangs in parallel when using the simple partitioner")
     vm = VertexOnlyMesh(
-        parentmesh, vertexcoords, missing_points_behaviour=None, name="testvom"
+        parentmesh, vertexcoords, missing_points_behaviour="ignore", name="testvom"
     )
     verify_vertexonly_mesh(parentmesh, vm, vertexcoords, name="testvom")
 
@@ -360,7 +360,7 @@ def test_point_tolerance():
     assert vm.cell_set.size == 1
     # check that the tolerance is passed through to the parent mesh
     assert m.tolerance == 0.1
-    vm = VertexOnlyMesh(m, coords, tolerance=0.0, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(m, coords, tolerance=0.0, missing_points_behaviour="ignore")
     assert vm.cell_set.size == 0
     assert m.tolerance == 0.0
     # See if changing the tolerance on the parent mesh changes the tolerance
@@ -369,7 +369,7 @@ def test_point_tolerance():
     vm = VertexOnlyMesh(m, coords)
     assert vm.cell_set.size == 1
     m.tolerance = 0.0
-    vm = VertexOnlyMesh(m, coords, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(m, coords, missing_points_behaviour="ignore")
     assert vm.cell_set.size == 0
 
 
@@ -381,7 +381,7 @@ def test_missing_points_behaviour(parentmesh):
     inputcoord = np.full((1, parentmesh.geometric_dimension()), np.inf)
     assert len(inputcoord) == 1
     # Can surpress error
-    vm = VertexOnlyMesh(parentmesh, inputcoord, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, inputcoord, missing_points_behaviour="ignore")
     assert vm.cell_set.size == 0
     # Error by default
     with pytest.raises(VertexOnlyMeshMissingPointsError):
@@ -419,11 +419,11 @@ def test_outside_boundary_behaviour(parentmesh):
     inputcoord = np.full((1, parentmesh.geometric_dimension()), edge_point-1e-15)
     assert len(inputcoord) == 1
     # Tolerance is too small to pick up point
-    vm = VertexOnlyMesh(parentmesh, inputcoord, tolerance=1e-16, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, inputcoord, tolerance=1e-16, missing_points_behaviour="ignore")
     assert vm.cell_set.size == 0
     # Tolerance is large enough to pick up point - note that we need to go up
     # by 2 orders of magnitude for this to work consistently
-    vm = VertexOnlyMesh(parentmesh, inputcoord, tolerance=1e-13, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, inputcoord, tolerance=1e-13, missing_points_behaviour="ignore")
     assert vm.cell_set.size == 1
 
 
@@ -471,10 +471,10 @@ def test_inside_boundary_behaviour(parentmesh):
     inputcoord = np.full((1, parentmesh.geometric_dimension()), edge_point+1e-15)
     assert len(inputcoord) == 1
     # Tolerance is large enough to pick up point
-    vm = VertexOnlyMesh(parentmesh, inputcoord, tolerance=1e-14, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, inputcoord, tolerance=1e-14, missing_points_behaviour="ignore")
     assert vm.cell_set.size == 1
     # Tolerance might be too small to pick up point, but it's not deterministic
-    vm = VertexOnlyMesh(parentmesh, inputcoord, tolerance=1e-16, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(parentmesh, inputcoord, tolerance=1e-16, missing_points_behaviour="ignore")
     assert vm.cell_set.size == 0 or vm.cell_set.size == 1
 
 
@@ -491,5 +491,5 @@ def test_pyop2_labelling():
     vm = VertexOnlyMesh(m, points, redundant=True)
     assert vm.cell_set.total_size == 2*m.cell_set.total_size
     points = np.asarray([[-5.0]])
-    vm = VertexOnlyMesh(m, points, redundant=False, missing_points_behaviour=None)
+    vm = VertexOnlyMesh(m, points, redundant=False, missing_points_behaviour="ignore")
     assert vm.cell_set.total_size == 0