dsl: Fix hashing for solveexpr

Author: ZoeLeibowitz

devito/petsc/iet/passes.py

@@ -75,7 +75,7 @@ def lower_petsc(iet, **kwargs):
     # individual PetscOptions
     # set_solver_option(efuncs)
     # List of all callbacks that clear PetscOptions
-    # from IPython import embed; embed()
+
     # TODO: throw a warning/error if the user passes a solver in with the same options_prefix
     # it's going to lead to weird solver option behaviour. Note, if you use the options_prefix across
     # different Operator runs, it will not be an issue
@@ -92,8 +92,6 @@ def lower_petsc(iet, **kwargs):
 
         efuncs.update(builder.cbbuilder.efuncs)
 
-        # clear_options.append(builder.cbbuilder._clear_options_efunc)
-        # from IPython import embed; embed()  # noqa: E402
         clear_options.extend((petsc_call(
             builder.cbbuilder._clear_options_efunc.name, []
         ),))

devito/petsc/solve.py

@@ -83,7 +83,7 @@ def build_expr(self):
             user_prefix=self.user_prefix,
             formatted_prefix=self.formatted_prefix
         )
-
+        # from IPython import embed; embed()
         return PetscEq(target, linear_solve)
 
     def linear_solve_args(self):

devito/petsc/solver_parameters.py

@@ -45,16 +45,14 @@ def linear_solver_parameters(solver_parameters):
     return processed
 
 
-# _options_prefix_counter = itertools.count()
+_options_prefix_counter = itertools.count()
 
 # TODO: add a default options prefix if not provided
 def format_options_prefix(options_prefix):
     # NOTE: Modified from the `OptionsManager` inside petsctools
     if options_prefix is None:
-        # options_prefix = f"devito_{next(_options_prefix_counter)}_"
-        options_prefix = ""
+        options_prefix = f"devito_{next(_options_prefix_counter)}_"
     else:
         if len(options_prefix) and not options_prefix.endswith("_"):
             options_prefix += "_"
-        # options_prefix = options_prefix
     return options_prefix

devito/petsc/types/types.py

@@ -17,14 +17,10 @@
 class MetaData(sympy.Function, Reconstructable):
     def __new__(cls, expr, **kwargs):
         with sympy_mutex:
-            obj = sympy.Basic.__new__(cls, expr)
-        obj._expr = expr
+            obj = sympy.Function.__new__(cls, expr)
+        obj.expr = expr
         return obj
 
-    @property
-    def expr(self):
-        return self._expr
-
 
 class Initialize(MetaData):
     pass
@@ -48,59 +44,36 @@ def __new__(cls, expr, solver_parameters=None,
                 user_prefix=None, formatted_prefix=None, **kwargs):
 
         with sympy_mutex:
-            obj = sympy.Function.__new__(cls, expr)
+            if isinstance(expr, tuple):
+                expr = sympy.Tuple(*expr)
+            obj = sympy.Basic.__new__(cls, expr)
 
-        obj._expr = expr
-        obj._solver_parameters = solver_parameters
-        obj._field_data = field_data if field_data else FieldData()
-        obj._time_mapper = time_mapper
-        obj._localinfo = localinfo
-        obj._user_prefix = user_prefix
-        obj._formatted_prefix = formatted_prefix
+        obj.expr = expr
+        obj.solver_parameters = solver_parameters
+        obj.field_data = field_data if field_data else FieldData()
+        obj.time_mapper = time_mapper
+        obj.localinfo = localinfo
+        obj.user_prefix = user_prefix
+        obj.formatted_prefix = formatted_prefix
         return obj
 
     def __repr__(self):
-        return "%s(%s)" % (self.__class__.__name__, self.expr)
+        return f"{self.__class__.__name__}{self.expr}"
 
     __str__ = __repr__
 
     def _sympystr(self, printer):
         return str(self)
 
-    def __hash__(self):
-        return hash(self.expr)
+    __hash__ = sympy.Basic.__hash__
+
+    def _hashable_content(self):
+            return (self.expr, self.formatted_prefix)
 
     def __eq__(self, other):
         return (isinstance(other, SolveExpr) and
-                self.expr == other.expr)
-
-    @property
-    def expr(self):
-        return self._expr
-
-    @property
-    def field_data(self):
-        return self._field_data
-
-    @property
-    def solver_parameters(self):
-        return self._solver_parameters
-
-    @property
-    def time_mapper(self):
-        return self._time_mapper
-
-    @property
-    def localinfo(self):
-        return self._localinfo
-
-    @property
-    def user_prefix(self):
-        return self._user_prefix
-    
-    @property
-    def formatted_prefix(self):
-        return self._formatted_prefix
+                self.expr == other.expr and
+                self.formatted_prefix == other.formatted_prefix)
 
     @property
     def grid(self):
@@ -114,48 +87,6 @@ def eval(cls, *args):
 
 
 
-
-
-# class SolveExpr(MetaData):
-
-#     # __rargs__ = ('expr',)
-#     # # __rkwargs__ = ('solver_parameters', 'field_data', 'time_mapper',
-#     # #                'localinfo', 'user_prefix', 'formatted_prefix')
-
-#     # __rkwargs__ = ('user_prefix',)
-
-#     def __new__(cls, expr, solver_parameters=None,
-#                 field_data=None, time_mapper=None, localinfo=None,
-#                 user_prefix=None, formatted_prefix=None, **kwargs):
-
-#     # def __new__(cls, expr,
-#     #             user_prefix=None, **kwargs):
-        
-#         obj = sympy.Basic.__new__(cls, expr)
-#         obj.solver_parameters = solver_parameters or {}
-#         obj.field_data = field_data if field_data else FieldData()
-#         obj.time_mapper = time_mapper
-#         obj.localinfo = localinfo
-#         obj.user_prefix = user_prefix
-#         obj.formatted_prefix = formatted_prefix
-#         return obj
-
-#     # def __hash__(self):
-#     #     return hash((self.expr, self.user_prefix, self.solver_parameters))
-#     def __hash__(self):
-#         return hash(self.expr)
-
-#     def __eq__(self, other):
-#         return (isinstance(other, LinearSolveExpr) and
-#                 self.expr == other.expr)
-
-#     @property
-#     def expr(self):
-#         return self.args[0]
-
-
-    
-
 class LinearSolveExpr(SolveExpr):
     """
     Linear problems are handled by setting the SNESType to 'ksponly',

examples/petsc/solver_options.py

@@ -55,15 +55,17 @@
 petsc1 = PETScSolve(eq, target=e, solver_parameters=params1, options_prefix='pde1')
 petsc2 = PETScSolve(eq, target=e, solver_parameters=params2, options_prefix='pde1')
 
-with switchconfig(language='petsc'):
+# from IPython import embed; embed()
+
+# with switchconfig(language='petsc'):
 
-    op1 = Operator([petsc1])
-    op2 = Operator(petsc2)
-    summary1 = op1.apply()
-    summary2 = op2.apply()
+#     op1 = Operator([petsc1, petsc2])
+#     # op2 = Operator(petsc2)
+#     # summary1 = op1.apply()
+#     # summary2 = op2.apply()
 
-    # print(op1.ccode)
-    # print(op2.ccode)
+#     print(op1.ccode)
+#     # print(op2.ccode)
 
 
 

tests/test_petsc.py

@@ -208,26 +208,6 @@ def test_petsc_cast():
         '(PetscScalar (*)[info.gym][info.gxm]) x_f3_vec;' in str(op3.ccode)
 
 
-# # TODO: add more thorough tests for solver_parameters
-# # @skipif('petsc')
-# # def test_LinearSolveExpr():
-
-# #     grid = Grid((2, 2), dtype=np.float64)
-
-# #     f = Function(name='f', grid=grid, space_order=2)
-# #     g = Function(name='g', grid=grid, space_order=2)
-
-# #     eqn = Eq(f, g.laplace)
-
-# #     linsolveexpr = LinearSolveExpr(eqn.rhs, field_data=FieldData(target=f))
-
-# #     # Check the solver parameters
-# #     assert linsolveexpr.solver_parameters == \
-# #         {'snes_type': 'ksponly', 'ksp_type': 'gmres', 'pc_type': 'none',
-# #          'ksp_rtol': 1e-05, 'ksp_atol': 1e-50, 'ksp_divtol': 100000.0,
-# #          'ksp_max_it': 10000}
-
-
 @skipif('petsc')
 def test_dmda_create():
 
@@ -794,7 +774,7 @@ def test_coupled_vs_non_coupled(self, eq1, eq2, so):
         # less callback functions than solving them separately.
         # TODO: As noted in the other test, some efuncs are not reused
         # where reuse is possible, investigate.
-        assert len(callbacks1) == 10
+        assert len(callbacks1) == 12
         assert len(callbacks2) == 8
 
         # Check field_data type
@@ -1494,8 +1474,11 @@ def test_logging_multiple_solves(self):
 class TestSolverParameters:
 
     @skipif('petsc')
-    def setup_method(self):
-        """Setup grid and functions shared across tests in this class"""
+    def setup_class(self):
+        """
+        Setup grid, functions and equations shared across
+        tests in this class
+        """
         grid = Grid(shape=(11, 11), dtype=np.float64)
         self.e, self.f, self.g, self.h = [
             Function(name=n, grid=grid, space_order=2)
@@ -1506,44 +1489,27 @@ def setup_method(self):
 
     @skipif('petsc')
     def test_differing_solver_params(self):
-        """
-        """
+        # Explicitly set the solver parameters
         solver1 = PETScSolve(
             self.eq1, target=self.e, solver_parameters={'ksp_rtol': '1e-10'}
         )
+        # This solver uses the defaults
         solver2 = PETScSolve(self.eq2, target=self.g)
 
         with switchconfig(language='petsc'):
             op = Operator([solver1, solver2])
 
         # Check that there are two `SetPetscOptions` callbacks since the solver
-        # parameters are different for each solver.
+        # parameters are different for each solver
         assert 'SetPetscOptions0' in op._func_table
         assert 'SetPetscOptions1' in op._func_table
 
-        assert 'PetscCall(PetscOptionsSetValue(NULL,"-ksp_rtol","1e-10"));' \
+        assert '_ksp_rtol","1e-10"' \
             in str(op._func_table['SetPetscOptions0'].root)
 
-        assert 'PetscCall(PetscOptionsSetValue(NULL,"-ksp_rtol","1e-05"));' \
+        assert '_ksp_rtol","1e-05"' \
             in str(op._func_table['SetPetscOptions1'].root)
 
-    @skipif('petsc')
-    def test_options_with_no_value(self):
-        """
-        Test solver parameters that do not require a value, such as
-        `snes_view`.
-        """
-        solver1 = PETScSolve(
-            self.eq1, target=self.e, solver_parameters={'snes_view': None}
-        )
-
-        with switchconfig(language='petsc'):
-            op = Operator(solver1)
-            op.apply()
-
-        assert 'PetscCall(PetscOptionsSetValue(NULL,"-snes_view",NULL));' \
-            in str(op._func_table['SetPetscOptions0'].root)
-
     @skipif('petsc')
     def test_options_prefix(self):
         solver1 = PETScSolve(self.eq1, self.e,
@@ -1556,7 +1522,7 @@ def test_options_prefix(self):
         with switchconfig(language='petsc'):
             op = Operator([solver1, solver2])
 
-        # Check the options prefix has been correctly set on each snes solver
+        # Check the options prefix has been correctly set for each snes solver
         assert 'PetscCall(SNESSetOptionsPrefix(snes0,"poisson1_"));' in str(op)
         assert 'PetscCall(SNESSetOptionsPrefix(snes1,"poisson2_"));' in str(op)
 
@@ -1567,6 +1533,24 @@ def test_options_prefix(self):
         assert 'PetscCall(PetscOptionsSetValue(NULL,"-poisson2_ksp_rtol","1e-12"));' \
             in str(op._func_table['SetPetscOptions1'].root)
 
+
+    @skipif('petsc')
+    def test_options_with_no_value(self):
+        """
+        Test solver parameters that do not require a value, such as
+        `snes_view` and `ksp_view`
+        """
+        solver = PETScSolve(
+            self.eq1, target=self.e, solver_parameters={'snes_view': None},
+            options_prefix='solver1'
+        )
+        with switchconfig(language='petsc'):
+            op = Operator(solver)
+            op.apply()
+
+        assert 'PetscCall(PetscOptionsSetValue(NULL,"-solver1_snes_view",NULL));' \
+            in str(op._func_table['SetPetscOptions0'].root)
+        
     @skipif('petsc')
     @pytest.mark.parametrize('log_level', ['PERF', 'DEBUG'])
     def test_tolerances(self, log_level):
@@ -1594,11 +1578,11 @@ def test_tolerances(self, log_level):
         assert tolerances['maxits'] == params['ksp_max_it']
 
 
-
     # TODO: ADD TEST TO CHECK FOR DEFAULT LINEAR SOLVER PARAMETERS
     # TODO: add test to check that the correct options are unset properly
     # TODO: Add a test to check that the command line args override anything set
     # in the solver_parameters dictionary
+    # TODO: add hashing tests to petscsolve
 
     # @skipif('petsc')
     # def test_command_line_priority(self):