Rename 'unmarked' to 'UNMARKED' to make clear that it is a constant (#4837)

Author: connorjward

firedrake/__init__.py

@@ -92,7 +92,7 @@ def init_petsc():
 )
 from firedrake.mesh import (  # noqa: F401
     Mesh, ExtrudedMesh, VertexOnlyMesh, RelabeledMesh,
-    SubDomainData, unmarked, DistributedMeshOverlapType,
+    SubDomainData, UNMARKED, DistributedMeshOverlapType,
     DEFAULT_MESH_NAME, MeshGeometry, MeshTopology,
     AbstractMeshTopology, ExtrudedMeshTopology, Submesh,
     VertexOnlyMeshTopology, MeshSequenceGeometry, MeshSequenceTopology

firedrake/mesh.py

@@ -54,7 +54,7 @@
 
 __all__ = [
     'Mesh', 'ExtrudedMesh', 'VertexOnlyMesh', 'RelabeledMesh',
-    'SubDomainData', 'unmarked', 'DistributedMeshOverlapType',
+    'SubDomainData', 'UNMARKED', 'DistributedMeshOverlapType',
     'DEFAULT_MESH_NAME', 'MeshGeometry', 'MeshTopology',
     'AbstractMeshTopology', 'ExtrudedMeshTopology', 'VertexOnlyMeshTopology',
     'MeshSequenceGeometry', 'MeshSequenceTopology',
@@ -76,7 +76,7 @@
                                             ("interval * interval", 3)]
 
 
-unmarked = -1
+UNMARKED = -1
 """A mesh marker that selects all entities that are not explicitly marked."""
 
 DEFAULT_MESH_NAME = "_".join(["firedrake", "default"])
@@ -247,7 +247,7 @@ def subset(self, markers):
         :param markers: integer marker id or an iterable of marker ids
             (or ``None``, for an empty subset).
         """
-        valid_markers = set([unmarked]).union(self.unique_markers)
+        valid_markers = set([UNMARKED]).union(self.unique_markers)
         markers = as_tuple(markers, numbers.Integral)
         try:
             return self._subsets[markers]
@@ -261,7 +261,7 @@ def subset(self, markers):
             # markers
             marked_points_list = []
             for i in markers:
-                if i == unmarked:
+                if i == UNMARKED:
                     _markers = self.mesh.topology_dm.getLabelIdIS(dmcommon.FACE_SETS_LABEL).indices
                     # Can exclude points labeled with i\in markers here,
                     # as they will be included in the below anyway.

tests/firedrake/regression/test_interior_facets.py

@@ -156,4 +156,4 @@ def test_interior_facet_integration(circle_in_square_mesh):
     assert np.allclose(assemble(f*dS(2)), 2*pi, rtol=1e-2)
 
     assert np.allclose(assemble(f*dS),
-                       assemble(f*dS(2)) + assemble(f*dS(unmarked)))
+                       assemble(f*dS(2)) + assemble(f*dS(UNMARKED)))

tests/firedrake/regression/test_mark_entities.py

@@ -41,9 +41,9 @@ def test_mark_entities_mark_points_with_function_array():
     assert abs(v - (4 * .5 + 4 * .5 * sqrt(2))) < 1.e-10
     v = assemble(Constant(1) * dS(my_facet_label, domain=mesh))
     assert abs(v - (1 * .5 + 1 * .5 * sqrt(2))) < 1.e-10
-    v = assemble(Constant(1) * dS(unmarked, domain=mesh))
+    v = assemble(Constant(1) * dS(UNMARKED, domain=mesh))
     assert abs(v - (3 * .5 + 3 * .5 * sqrt(2))) < 1.e-10
-    v = assemble(Constant(1) * dS((my_facet_label, unmarked), domain=mesh))
+    v = assemble(Constant(1) * dS((my_facet_label, UNMARKED), domain=mesh))
     assert abs(v - (4 * .5 + 4 * .5 * sqrt(2))) < 1.e-10
 
 
@@ -66,7 +66,7 @@ def test_mark_entities_overlapping_facet_subdomains():
     assert abs(v - 1.5) < 1.e-10
     v = assemble(Constant(1) * ds(removed_label, domain=mesh))
     assert abs(v - 0.0) < 1.e-10
-    v = assemble(Constant(1) * ds(unmarked, domain=mesh))
+    v = assemble(Constant(1) * ds(UNMARKED, domain=mesh))
     assert abs(v - 1.0) < 1.e-10