misc: More clean up

Author: ZoeLeibowitz

devito/data/decomposition.py

@@ -465,9 +465,10 @@ def index_glb_to_loc_unsafe(self, glb_idx, rel=True):
             loc_abs_max = self.loc_abs_max
             glb_max = self.glb_max
 
-        base = loc_abs_min if rel else 0
         glb_min = 0
 
+        base = loc_abs_min if rel else 0
+
         # index_glb_to_loc(index)
         # -> Base case, empty local subdomain
         if self.loc_empty:
@@ -476,9 +477,7 @@ def index_glb_to_loc_unsafe(self, glb_idx, rel=True):
         if glb_idx < 0:
             glb_idx = glb_max + glb_idx + 1
         # -> Do the actual conversion
-        if loc_abs_min <= glb_idx <= loc_abs_max:
-            return glb_idx - base
-        elif glb_min <= glb_idx <= glb_max:
+        if loc_abs_min <= glb_idx <= loc_abs_max or glb_min <= glb_idx <= glb_max:
             return glb_idx - base
         else:
             # This should raise an exception when used to access a numpy.array

devito/ir/equations/equation.py

@@ -107,10 +107,6 @@ def detect(cls, expr):
             ReduceMin: OpMin,
             PetscEq: OpPetsc
         }
-        # try:
-        #     return reduction_mapper[type(expr)]
-        # except KeyError:
-        #     pass
 
         for expr_type, op in reduction_mapper.items():
             if isinstance(expr, expr_type):

devito/operator/operator.py

@@ -369,9 +369,7 @@ def _lower_exprs(cls, expressions, **kwargs):
         # in particular uniqueness across expressions is ensured
         expressions = concretize_subdims(expressions, **kwargs)
 
-        # rename etc
         expressions = lower_exprs_petsc(expressions, **kwargs)
-        # from IPython import embed; embed()
 
         processed = [LoweredEq(i) for i in expressions]
 

devito/passes/iet/linearization.py

@@ -25,7 +25,7 @@ def linearize(graph, **kwargs):
 
     mode = options.get('linearize')
     maybe_callback = kwargs.pop('callback', mode)
-    # from IPython import embed; embed()
+
     if not maybe_callback:
         return
     elif callable(maybe_callback):
@@ -230,7 +230,6 @@ def linearize_accesses(iet, key0, tracker=None):
             continue
 
         v = generate_linearization(f, i, tracker)
-
         if v is not None:
             subs[i] = v
 
@@ -240,7 +239,7 @@ 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))
-    # from IPython import embed; embed()
+
     instances = {}
     for i in offers:
         f = i.function
@@ -295,7 +294,7 @@ def linearize_accesses(iet, key0, tracker=None):
     if stmts:
         body = iet.body._rebuild(strides=stmts)
         iet = iet._rebuild(body=body)
-    # from IPython import embed; embed()
+
     return iet
 
 

devito/petsc/equations.py

@@ -18,7 +18,6 @@ def lower_exprs_petsc(expressions, **kwargs):
 
 def constrain_essential_bcs(expressions, **kwargs):
     """
-    NOTE:
     """
     sregistry = kwargs['sregistry']
     new_exprs = []
@@ -37,7 +36,7 @@ def constrain_essential_bcs(expressions, **kwargs):
     space_dims = [d for d in all_dims if isinstance(d, SpaceDimension)]
 
     mapper = {}
-    # from IPython import embed; embed()
+
     for d in subdims:
         halo = halo_size[d]
 
@@ -69,8 +68,7 @@ def constrain_essential_bcs(expressions, **kwargs):
             symbolic_max=Min(space_dim_max, d.symbolic_max + halo.right),
         )
 
-    # Apply mapper to all expressions
-    # from IPython import embed; embed()
+    # Apply mapper to expressions
     for e in expressions:
         if not isinstance(e, ConstrainBC):
             new_exprs.append(e)

devito/petsc/iet/builder.py

@@ -23,7 +23,6 @@ def __init__(self, **kwargs):
         self.callback_builder = kwargs.get('callback_builder')
         self.field_data = self.inject_solve.expr.rhs.field_data
         self.formatted_prefix = self.inject_solve.expr.rhs.formatted_prefix
-        # self.calls = self._setup()
 
     @cached_property
     def calls(self):
@@ -40,7 +39,6 @@ def snes_ctx(self):
     def _setup(self):
         sobjs = self.solver_objs
         dmda = sobjs['dmda']
-        # mainctx = sobjs['userctx']
 
         snes_create = petsc_call('SNESCreate', [sobjs['comm'], Byref(sobjs['snes'])])
 
@@ -110,8 +108,6 @@ def _setup(self):
         mat_set_dm = petsc_call('MatSetDM', [sobjs['Jac'], dmda])
 
         base_setup = dmda_calls + (
-            # call_struct_callback,
-            # calls_set_app_ctx,
             snes_create,
             snes_options_prefix,
             set_options,
@@ -337,7 +333,6 @@ def _setup(self):
             snes_set_options,
             call_struct_callback,
             mat_set_dm,
-            # calls_set_app_ctx,
             create_field_decomp,
             matop_create_submats_op,
             call_coupled_struct_callback,
@@ -378,9 +373,6 @@ def _create_dmda_calls(self, dmda):
             'DMGetLocalSection', [dmda, Byref(sobjs['lsection'])]
         )
 
-        import cgen as c
-        tmp = c.Line("PetscCall(PetscSectionView(lsection0, NULL));")
-
         get_point_sf = petsc_call('DMGetPointSF', [dmda, Byref(sobjs['sf'])])
 
         create_global_section = petsc_call(
@@ -414,7 +406,6 @@ def _create_dmda_calls(self, dmda):
             count_bcs,
             set_point_bcs,
             get_local_section,
-            tmp,
             get_point_sf,
             create_global_section,
             dm_set_global_section,
@@ -426,7 +417,7 @@ class ConstrainedBCBuilder(ConstrainedBCMixin, BuilderBase):
     pass
 
 
-# TODO: Implement this properly
+# TODO: Implement this class properly
 class CoupledConstrainedBCBuilder(ConstrainedBCMixin, CoupledBuilder):
     pass
 

devito/petsc/iet/callbacks.py

@@ -645,6 +645,11 @@ def _create_initial_guess_body(self, body):
         return Uxreplace(subs).visit(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`.
+        """
         increment_exprs = self.field_data.constrain_bc.increment_exprs
         point_bc_exprs = self.field_data.constrain_bc.point_bc_exprs
         sobjs = self.solver_objs
@@ -694,7 +699,7 @@ def _create_count_bc_body(self, body):
             'DMGetApplicationContext', [dmda, Byref(ctx._C_symbol)]
         )
 
-        # OBVS change names
+        # TODO: change names
         deref_ptr = DummyExpr(Counter, Deref(sobjs['numBCPtr']))
         move_ptr = DummyExpr(Deref(sobjs['numBCPtr']), Counter)
 

devito/petsc/iet/passes.py

@@ -137,7 +137,8 @@ def lower_petsc_symbols(iet, **kwargs):
 
 @iet_pass
 def linear_indices(iet, **kwargs):
-
+    """
+    """
     if not iet.name.startswith("SetPointBCs"):
         return iet, {}
 

devito/petsc/types/metadata.py

@@ -786,14 +786,8 @@ def _make_point_bc_expr(self, expr):
         Make the Eq that is used to increment the number of essential
         boundary nodes in the generated ccode.
         """
-        # numBC = PetscInt(name='numBC2')
         if isinstance(expr, EssentialBC):
             assert expr.lhs == self.target
-            # return PointEssentialBC(
-            #     Counter, self.target,
-            #     subdomain=expr.subdomain,
-            #     target=self.target
-            # )
             return PointEssentialBC(
                 Counter, self.target,
                 subdomain=expr.subdomain,

devito/types/misc.py

@@ -152,6 +152,8 @@ def bind(self, pname):
 
     @property
     def linear_index(self):
+        """
+        """
         f = self.function
         strides_map = self.strides_map
         indices = self.indices
@@ -170,8 +172,9 @@ def linear_index(self):
     __reduce_ex__ = Pickable.__reduce_ex__
 
 
-# the special postindex type sould live in this file i think
 class PostIncrementIndex(LocalObject):
+    """
+    """
     dtype = np.int32