misc: More cleanup

Author: ZoeLeibowitz

devito/passes/iet/linearization.py

@@ -239,7 +239,6 @@ def linearize_accesses(iet, key0, tracker=None):
     # E.g. `{x_fsz0 -> u_vec->size[1]}`
     defines = FindSymbols('defines').visit(iet)
     offers = filter_ordered(i for i in defines if key0(i.function))
-
     instances = {}
     for i in offers:
         f = i.function

devito/petsc/equations.py

@@ -10,7 +10,8 @@
 
 
 def lower_exprs_petsc(expressions, **kwargs):
-    # Constrain EssentialBCs using PetscSection if specified to do so
+
+    # Process `ConstrainBC` equations 
     expressions = constrain_essential_bcs(expressions, **kwargs)
 
     return expressions

devito/petsc/iet/builder.py

@@ -344,16 +344,16 @@ def _setup(self):
 
 class ConstrainedBCMixin:
     """
-    not really a mixin?
     """
     def _create_dmda_calls(self, dmda):
         sobjs = self.solver_objs
-        # mainctx = sobjs['mainctx']
         mainctx = sobjs['userctx']
-        # TODO: CLEAN UP
+
         dmda_create = self._create_dmda(dmda)
-        # TODO: probs need to set the dm options prefix the same as snes?
-        # don't hardcode this probs? - the dm needs to be specific to the solver as well
+
+        # TODO: likely need to set the dm options prefix the same as snes?
+        # likely shouldn't hardcode this option like this.. (should be set in the options
+        # callback)
         da_create_section = petsc_call(
             'PetscOptionsSetValue', [Null, String("-da_use_section"), Null]
         )

devito/petsc/iet/callbacks.py

@@ -646,20 +646,19 @@ def _create_initial_guess_body(self, body):
 
     def _make_constrain_bc(self):
         """
-        To constrain essential boundary nodes, two additional callbacks are
-        required - this function generates the two new efuncs `CountBCs` and
-        `SetPointBCs`.
+        To constrain essential boundary nodes, two additional callbacks are required.
+        This method constructs the corresponding efuncs: `CountBCs` and `SetPointBCs`.
         """
         increment_exprs = self.field_data.constrain_bc.increment_exprs
         point_bc_exprs = self.field_data.constrain_bc.point_bc_exprs
         sobjs = self.solver_objs
 
-        # Compile constrain `eqns` into an IET via recursive compilation
+        # Compile `increment_exprs` into an IET via recursive compilation
         irs0, _ = self.rcompile(
             increment_exprs, options={'mpi': False}, sregistry=self.sregistry,
             concretize_mapper=self.concretize_mapper
         )
-        # Compile constrain `eqns` into an IET via recursive compilation
+        # Compile `point_bc_exprs` into an IET via recursive compilation
         irs1, _ = self.rcompile(
             point_bc_exprs, options={'mpi': False}, sregistry=self.sregistry,
             concretize_mapper=self.concretize_mapper

devito/petsc/types/dimension.py

@@ -20,9 +20,8 @@ def _arg_values(self, grid=None, **kwargs):
         grtkn = kwargs.get(self.subdim.rtkn.name, self.subdim.rtkn.value)
         # decomposition info
         decomp = dist.decomposition[self.subdim.parent]
-        g_x_M = decomp.glb_max
-        val = decomp.index_glb_to_loc_unsafe(g_x_M - grtkn)
-
+        glb_max = decomp.glb_max
+        val = decomp.index_glb_to_loc_unsafe(glb_max - grtkn)
         return {self.name: int(val)}
 
 
@@ -43,12 +42,10 @@ def _arg_values(self, grid=None, **kwargs):
         dist = grid.distributor
         # global ltkn
         gltkn = kwargs.get(self.subdim.ltkn.name, self.subdim.ltkn.value)
-
         # decomposition info
         decomp = dist.decomposition[self.subdim.parent]
-        g_x_m = decomp.glb_min
-        val = decomp.index_glb_to_loc_unsafe(g_x_m + gltkn)
-
+        glb_min = decomp.glb_min
+        val = decomp.index_glb_to_loc_unsafe(glb_min + gltkn)
         return {self.name: int(val)}
 
 
@@ -68,18 +65,14 @@ def space_dim(self):
     def _arg_values(self, grid=None, **kwargs):
         dist = grid.distributor
         decomp = dist.decomposition[self.space_dim]
-        # obvs not just x etc..
-        g_x_M = decomp.glb_max
-
-        val = decomp.index_glb_to_loc_unsafe(g_x_M)
-
+        glb_max = decomp.glb_max
+        val = decomp.index_glb_to_loc_unsafe(glb_max)
         return {self.name: int(val)}
 
 
 class SpaceDimMin(Thickness):
     """
     """
-
     def __init_finalize__(self, *args, **kwargs):
         self._space_dim = kwargs.pop('space_dim')
         self._dtype = self._space_dim.dtype
@@ -93,8 +86,6 @@ def space_dim(self):
     def _arg_values(self, grid=None, **kwargs):
         dist = grid.distributor
         decomp = dist.decomposition[self.space_dim]
-        # Obvs not just x etc..
-        g_x_m = decomp.glb_min
-        val = decomp.index_glb_to_loc_unsafe(g_x_m)
-
+        glb_min = decomp.glb_min
+        val = decomp.index_glb_to_loc_unsafe(glb_min)
         return {self.name: int(val)}

devito/types/misc.py

@@ -153,6 +153,7 @@ def bind(self, pname):
     @property
     def linear_index(self):
         """
+        TODO: Add tests
         """
         f = self.function
         strides_map = self.strides_map