misc: Add another test

Author: ZoeLeibowitz

devito/ir/iet/visitors.py

@@ -292,7 +292,6 @@ def _gen_struct_decl(self, obj, masked=()):
         for i, (n, ct) in zip(fields, ctype._fields_):
             try:
                 entries.append(self._gen_value(i, 0, masked=('const',)))
-
             except AttributeError:
                 cstr = self.ccode(ct)
                 if ct is c_restrict_void_p:

devito/petsc/iet/logging.py

@@ -13,11 +13,10 @@ class PetscLogger:
     Class for PETSc loggers that collect solver related statistics.
     """
     def __init__(self, level, get_info=[], **kwargs):
-        self.function_list = get_info
 
+        self.function_list = get_info
         self.sobjs = kwargs.get('solver_objs')
         self.sreg = kwargs.get('sregistry')
-
         self.section_mapper = kwargs.get('section_mapper', {})
         self.inject_solve = kwargs.get('inject_solve', None)
 

devito/petsc/iet/passes.py

@@ -69,7 +69,7 @@ def lower_petsc(iet, **kwargs):
     # Map PETScSolve to its Section (for logging)
     section_mapper = MapNodes(Section, PetscMetaData, 'groupby').visit(iet)
 
-    # Prefixes within the same Operator should not be duplicated
+    # Prefixes within the same `Operator` should not be duplicated
     prefixes = [d.expr.rhs.user_prefix for d in data if d.expr.rhs.user_prefix]
     duplicates = {p for p in prefixes if prefixes.count(p) > 1}
 

devito/petsc/initialize.py

@@ -15,14 +15,13 @@
 global _petsc_clargs
 
 
-dummy = Symbol(name='d')
-
-
 def PetscInitialize(clargs=sys.argv):
     global _petsc_initialized
     global _petsc_clargs
 
     if not _petsc_initialized:
+        dummy = Symbol(name='d')
+
         if clargs is not sys.argv:
             clargs = [sys.argv[0], *clargs]
 

devito/petsc/logging.py

@@ -29,7 +29,6 @@ def __repr__(self):
 
 class PetscSummary(dict):
     """
-    # TODO: Actually print to screen when DEBUG of PERF is enabled
     A summary of PETSc statistics collected for all solver runs
     associated with a single operator during execution.
     """
@@ -69,6 +68,8 @@ def petsc_entry(self, petscinfo):
         Create a named tuple entry for the given PetscInfo object,
         containing the values for each PETSc function call.
         """
+        # Collect the function names associated with this PetscInfo
+        # instance (i.e., for a single PETScSolve).
         funcs = [
             petsc_return_variable_dict[f].name for f in petscinfo.function_list
         ]

devito/petsc/solve.py

@@ -67,10 +67,8 @@ def PETScSolve(target_exprs, target=None, solver_parameters=None,
         provided, a default prefix is generated by Devito.
 
     get_info : list[str], optional
-        A list of PETSc API functions to collect statistics from the solver.
-        For example, `['kspgetiterationnumber', 'kspgettolerances']`.
-        Capitalisation does not matter; e.g. `'KSPGetIterationNumber'` and
-        `'kspgetiterationnumber'` are treated the same.
+        A list of PETSc API functions (case insensitive) to collect statistics
+        from the solver.
 
         List of available functions:
         - ['kspgetiterationnumber', 'kspgettolerances', 'kspgetconvergedreason',
@@ -96,6 +94,7 @@ def __init__(self, solver_parameters=None, target_exprs=None, options_prefix=Non
         self.solver_parameters = linear_solver_parameters(solver_parameters)
         self.time_mapper = None
         self.target_exprs = target_exprs
+        # The original options prefix provided by the user
         self.user_prefix = options_prefix
         self.formatted_prefix = format_options_prefix(options_prefix)
         self.get_info = [f.lower() for f in get_info]

examples/petsc/init_test.py

@@ -1,10 +1,8 @@
 import os
-from devito.petsc.initialize import PetscInitialize, PetscGetArgs
+from devito.petsc.initialize import PetscInitialize
 from devito import configuration
 configuration['compiler'] = 'custom'
 os.environ['CC'] = 'mpicc'
 
 PetscInitialize()
 print("helloworld")
-
-PetscGetArgs()

tests/test_petsc.py

@@ -25,21 +25,25 @@
 
 @pytest.fixture(scope='session')
 def command_line():
-    # One random prefix to use per test that "tests" the command line args
-    prefix = ('d17weqroeg', 'riabfodkj5', 'fir8o3lsak', 'zwejklqn25')
+
+    # Random prefixes to validate command line argument parsing
+    prefix = (
+        'd17weqroeg', 'riabfodkj5', 'fir8o3lsak',
+        'zwejklqn25', 'qtr2vfvwiu')
 
     petsc_option = (
         ('ksp_rtol',),
         ('ksp_rtol', 'ksp_atol'),
         ('ksp_rtol', 'ksp_atol', 'ksp_divtol', 'ksp_max_it'),
-        ('ksp_type',)
-
+        ('ksp_type',),
+        ('ksp_divtol', 'ksp_type')
     )
     value = (
         (1e-8,),
         (1e-11, 1e-15),
         (1e-3, 1e-10, 50000, 2000),
-        ('cg',)
+        ('cg',),
+        (22000, 'richardson'),
     )
     argv = []
     expected = {}
@@ -1663,9 +1667,6 @@ def test_tolerances(self, log_level):
 
     @skipif('petsc')
     def test_clearing_options(self):
-        # TODO: Extend this test to check that options are only cleared
-        # if they have NOT ben set via the command line
-
         # Explicitly set the solver parameters
         solver1 = PETScSolve(
             self.eq1, target=self.e, solver_parameters={'ksp_rtol': '1e-10'}
@@ -1737,7 +1738,7 @@ def test_multiple_operators(self, log_level):
     def test_command_line_priority_tols_1(self, command_line, log_level):
         """
         Test solver tolerances specifed via the command line
-        take precedence over those set by the defaults.
+        take precedence over those specified in the defaults.
         """
         prefix = 'd17weqroeg'
         _, expected = command_line
@@ -1838,6 +1839,55 @@ def test_command_line_priority_ksp_type(self, command_line, log_level):
             assert entry.KSPGetType == val
             assert not entry.KSPGetType == params['ksp_type']
 
+    @skipif('petsc')
+    def test_not_set_or_clear_command_line_opts(self, command_line):
+        """
+        Verify that if an option is set via the command line,
+        the corresponding entry in `linear_solve_defaults` or in the user
+        specified `solver_parameters` is not set or cleared in the
+        generated code. (The command line option will have already been set in
+        the global PetscOptions database during PetscInitialize().)
+        """
+        prefix = 'qtr2vfvwiu'
+
+        solver = PETScSolve(
+            self.eq1, target=self.e,
+            # Specify a solver parameter that is not set via the
+            # command line (see the `command_line` fixture for this prefix).
+            solver_parameters={'ksp_rtol': '1e-10'},
+            options_prefix=prefix
+        )
+        with switchconfig(language='petsc'):
+            op = Operator(solver)
+
+        set_options_callback = str(op._func_table['SetPetscOptions0'].root)
+        clear_options_callback = str(op._func_table['ClearPetscOptions0'].root)
+
+        # Check that the `ksp_rtol` option IS set and cleared explicitly
+        # since it is NOT set via the command line.
+        assert f'PetscOptionsSetValue(NULL,"-{prefix}_ksp_rtol","1e-10")' \
+            in set_options_callback
+        assert f'PetscOptionsClearValue(NULL,"-{prefix}_ksp_rtol")' \
+            in clear_options_callback
+
+        # Check that the `ksp_divtol` and `ksp_type` options are NOT set
+        # or cleared explicitly since they ARE set via the command line.
+        assert f'PetscOptionsSetValue(NULL,"-{prefix}_div_tol",' \
+            not in set_options_callback
+        assert f'PetscOptionsSetValue(NULL,"-{prefix}_ksp_type",' \
+            not in set_options_callback
+        assert f'PetscOptionsClearValue(NULL,"-{prefix}_div_tol"));' \
+            not in clear_options_callback
+        assert f'PetscOptionsClearValue(NULL,"-{prefix}_ksp_type"));' \
+            not in clear_options_callback
+
+        # Check that options specifed by the `linear_solver_defaults`
+        # are still set and cleared
+        assert f'PetscOptionsSetValue(NULL,"-{prefix}_ksp_atol",' \
+            in set_options_callback
+        assert f'PetscOptionsClearValue(NULL,"-{prefix}_ksp_atol"));' \
+            in clear_options_callback
+
 
 class TestHashing: