misc: Rename internals to config

Author: ZoeLeibowitz

devito/petsc/internals.py devito/petsc/config.pydevito/petsc/internals.py renamed to devito/petsc/config.py

@@ -14,12 +14,12 @@ def make_core_petsc_calls(objs, comm):
     return call_mpi, BlankLine
 
 
-class BaseSetup:
+class BuilderBase:
     def __init__(self, **kwargs):
         self.inject_solve = kwargs.get('inject_solve')
         self.objs = kwargs.get('objs')
         self.solver_objs = kwargs.get('solver_objs')
-        self.cbbuilder = kwargs.get('cbbuilder')
+        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()
@@ -31,7 +31,63 @@ def snes_ctx(self):
         https://petsc.org/main/manualpages/SNES/SNESSetFunction/
         """
         return VOID(self.solver_objs['dmda'], stars='*')
+    
+    def _setup(self):
+        return ()
+
+    def _extend_setup(self):
+        """
+        Hook for subclasses to add additional setup calls.
+        """
+        return ()
+
+    def _create_dmda_calls(self, dmda):
+        dmda_create = self._create_dmda(dmda)
+        dm_setup = petsc_call('DMSetUp', [dmda])
+        dm_mat_type = petsc_call('DMSetMatType', [dmda, 'MATSHELL'])
+        return dmda_create, dm_setup, dm_mat_type
+
+    def _create_dmda(self, dmda):
+        sobjs = self.solver_objs
+        grid = self.field_data.grid
+        nspace_dims = len(grid.dimensions)
+
+        # MPI communicator
+        args = [sobjs['comm']]
+
+        # Type of ghost nodes
+        args.extend(['DM_BOUNDARY_GHOSTED' for _ in range(nspace_dims)])
+
+        # Stencil type
+        if nspace_dims > 1:
+            args.append('DMDA_STENCIL_BOX')
+
+        # Global dimensions
+        args.extend(list(grid.shape)[::-1])
+        # No.of processors in each dimension
+        if nspace_dims > 1:
+            args.extend(list(grid.distributor.topology)[::-1])
+
+        # Number of degrees of freedom per node
+        args.append(dmda.dofs)
+        # "Stencil width" -> size of overlap
+        # TODO: Instead, this probably should be
+        # extracted from field_data.target._size_outhalo?
+        stencil_width = self.field_data.space_order
+
+        args.append(stencil_width)
+        args.extend([Null]*nspace_dims)
+
+        # The distributed array object
+        args.append(Byref(dmda))
+
+        # The PETSc call used to create the DMDA
+        dmda = petsc_call(f'DMDACreate{nspace_dims}d', args)
+
+        return dmda
+    
 
+class Builder(BuilderBase):
     def _setup(self):
         sobjs = self.solver_objs
         dmda = sobjs['dmda']
@@ -43,7 +99,7 @@ def _setup(self):
         ) if self.formatted_prefix else None
 
         set_options = petsc_call(
-            self.cbbuilder._set_options_efunc.name, []
+            self.callback_builder._set_options_efunc.name, []
         )
 
         snes_set_dm = petsc_call('SNESSetDM', [sobjs['snes'], dmda])
@@ -82,12 +138,12 @@ def _setup(self):
         snes_get_ksp = petsc_call('SNESGetKSP',
                                   [sobjs['snes'], Byref(sobjs['ksp'])])
 
-        matvec = self.cbbuilder.main_matvec_callback
+        matvec = self.callback_builder.main_matvec_callback
         matvec_operation = petsc_call(
             'MatShellSetOperation',
             [sobjs['Jac'], 'MATOP_MULT', MatShellSetOp(matvec.name, void, void)]
         )
-        formfunc = self.cbbuilder._F_efunc
+        formfunc = self.callback_builder._F_efunc
         formfunc_operation = petsc_call(
             'SNESSetFunction',
             [sobjs['snes'], Null, FormFunctionCallback(formfunc.name, void, void),
@@ -103,7 +159,7 @@ def _setup(self):
         mainctx = sobjs['userctx']
 
         call_struct_callback = petsc_call(
-            self.cbbuilder.user_struct_callback.name, [Byref(mainctx)]
+            self.callback_builder.user_struct_callback.name, [Byref(mainctx)]
         )
 
         # TODO: maybe don't need to explictly set this
@@ -134,59 +190,8 @@ def _setup(self):
         extended_setup = self._extend_setup()
         return base_setup + extended_setup
 
-    def _extend_setup(self):
-        """
-        Hook for subclasses to add additional setup calls.
-        """
-        return ()
-
-    def _create_dmda_calls(self, dmda):
-        dmda_create = self._create_dmda(dmda)
-        dm_setup = petsc_call('DMSetUp', [dmda])
-        dm_mat_type = petsc_call('DMSetMatType', [dmda, 'MATSHELL'])
-        return dmda_create, dm_setup, dm_mat_type
-
-    def _create_dmda(self, dmda):
-        sobjs = self.solver_objs
-        grid = self.field_data.grid
-        nspace_dims = len(grid.dimensions)
-
-        # MPI communicator
-        args = [sobjs['comm']]
-
-        # Type of ghost nodes
-        args.extend(['DM_BOUNDARY_GHOSTED' for _ in range(nspace_dims)])
-
-        # Stencil type
-        if nspace_dims > 1:
-            args.append('DMDA_STENCIL_BOX')
-
-        # Global dimensions
-        args.extend(list(grid.shape)[::-1])
-        # No.of processors in each dimension
-        if nspace_dims > 1:
-            args.extend(list(grid.distributor.topology)[::-1])
-
-        # Number of degrees of freedom per node
-        args.append(dmda.dofs)
-        # "Stencil width" -> size of overlap
-        # TODO: Instead, this probably should be
-        # extracted from field_data.target._size_outhalo?
-        stencil_width = self.field_data.space_order
-
-        args.append(stencil_width)
-        args.extend([Null]*nspace_dims)
-
-        # The distributed array object
-        args.append(Byref(dmda))
-
-        # The PETSc call used to create the DMDA
-        dmda = petsc_call(f'DMDACreate{nspace_dims}d', args)
-
-        return dmda
-
 
-class CoupledSetup(BaseSetup):
+class CoupledBuilder(BuilderBase):
     def _setup(self):
         # TODO: minimise code duplication with superclass
         objs = self.objs
@@ -200,7 +205,7 @@ def _setup(self):
         ) if self.formatted_prefix else None
 
         set_options = petsc_call(
-            self.cbbuilder._set_options_efunc.name, []
+            self.callback_builder._set_options_efunc.name, []
         )
 
         snes_set_dm = petsc_call('SNESSetDM', [sobjs['snes'], dmda])
@@ -223,12 +228,12 @@ def _setup(self):
         snes_get_ksp = petsc_call('SNESGetKSP',
                                   [sobjs['snes'], Byref(sobjs['ksp'])])
 
-        matvec = self.cbbuilder.main_matvec_callback
+        matvec = self.callback_builder.main_matvec_callback
         matvec_operation = petsc_call(
             'MatShellSetOperation',
             [sobjs['Jac'], 'MATOP_MULT', MatShellSetOp(matvec.name, void, void)]
         )
-        formfunc = self.cbbuilder._F_efunc
+        formfunc = self.callback_builder._F_efunc
         formfunc_operation = petsc_call(
             'SNESSetFunction',
             [sobjs['snes'], Null, FormFunctionCallback(formfunc.name, void, void),
@@ -244,7 +249,7 @@ def _setup(self):
         mainctx = sobjs['userctx']
 
         call_struct_callback = petsc_call(
-            self.cbbuilder.user_struct_callback.name, [Byref(mainctx)]
+            self.callback_builder.user_struct_callback.name, [Byref(mainctx)]
         )
 
         # TODO: maybe don't need to explictly set this
@@ -257,7 +262,7 @@ def _setup(self):
             [dmda, Byref(sobjs['nfields']), Null, Byref(sobjs['fields']),
              Byref(sobjs['subdms'])]
         )
-        submat_cb = self.cbbuilder.submatrices_callback
+        submat_cb = self.callback_builder.submatrices_callback
         matop_create_submats_op = petsc_call(
             'MatShellSetOperation',
             [sobjs['Jac'], 'MATOP_CREATE_SUBMATRICES',

devito/petsc/iet/builder.py

@@ -14,7 +14,7 @@
 
 from devito.petsc.iet.nodes import PETScCallable, MatShellSetOp, petsc_call
 from devito.petsc.types import DMCast, MainUserStruct, CallbackUserStruct
-from devito.petsc.iet.objects import objs
+from devito.petsc.iet.type_builder import objs
 from devito.petsc.types.macros import petsc_func_begin_user
 from devito.petsc.types.modes import InsertMode
 

devito/petsc/iet/callbacks.py

@@ -21,9 +21,9 @@
 from devito.petsc.iet.callbacks import (
     BaseCallback, CoupledCallback, populate_matrix_context, get_user_struct_fields
 )
-from devito.petsc.iet.objects import BaseObjectBuilder, CoupledObjectBuilder, objs
-from devito.petsc.iet.builder import BaseSetup, CoupledSetup, make_core_petsc_calls
-from devito.petsc.iet.solver import Solver, CoupledSolver
+from devito.petsc.iet.type_builder import BaseTypeBuilder, CoupledTypeBuilder, objs
+from devito.petsc.iet.builder import Builder, CoupledBuilder, make_core_petsc_calls
+from devito.petsc.iet.solve import Solve, CoupledSolve
 from devito.petsc.iet.time_dependence import TimeDependent, TimeIndependent
 from devito.petsc.iet.logging import PetscLogger
 
@@ -86,17 +86,17 @@ def lower_petsc(iet, **kwargs):
 
     for iters, (inject_solve,) in inject_solve_mapper.items():
 
-        builder = Builder(inject_solve, iters, comm, section_mapper, **kwargs)
+        solver = BuildSolver(inject_solve, iters, comm, section_mapper, **kwargs)
 
-        setup.extend(builder.solver_setup.calls)
+        setup.extend(solver.builder.calls)
 
         # Transform the spatial iteration loop with the calls to execute the solver
-        subs.update({builder.solve.spatial_body: builder.calls})
+        subs.update({solver.solve.spatial_body: solver.calls})
 
-        efuncs.update(builder.cbbuilder.efuncs)
+        efuncs.update(solver.callback_builder.efuncs)
 
         clear_options.extend((petsc_call(
-            builder.cbbuilder._clear_options_efunc.name, []
+            solver.callback_builder._clear_options_efunc.name, []
         ),))
 
     populate_matrix_context(efuncs)
@@ -226,7 +226,7 @@ def finalize(iet):
     return iet._rebuild(body=finalize_body)
 
 
-class Builder:
+class BuildSolver:
     """
     This class is designed to support future extensions, enabling
     different combinations of solver types, preconditioning methods,
@@ -252,17 +252,17 @@ def __init__(self, inject_solve, iters, comm, section_mapper, **kwargs):
             'section_mapper': self.section_mapper,
             **self.kwargs
         }
-        self.common_kwargs['solver_objs'] = self.object_builder.solver_objs
+        self.common_kwargs['solver_objs'] = self.type_builder.solver_objs
         self.common_kwargs['time_dependence'] = self.time_dependence
-        self.common_kwargs['cbbuilder'] = self.cbbuilder
+        self.common_kwargs['callback_builder'] = self.callback_builder
         self.common_kwargs['logger'] = self.logger
 
     @cached_property
-    def object_builder(self):
+    def type_builder(self):
         return (
-            CoupledObjectBuilder(**self.common_kwargs)
+            CoupledTypeBuilder(**self.common_kwargs)
             if self.coupled else
-            BaseObjectBuilder(**self.common_kwargs)
+            BaseTypeBuilder(**self.common_kwargs)
         )
 
     @cached_property
@@ -272,19 +272,19 @@ def time_dependence(self):
         return time_class(**self.common_kwargs)
 
     @cached_property
-    def cbbuilder(self):
+    def callback_builder(self):
         return CoupledCallback(**self.common_kwargs) \
             if self.coupled else BaseCallback(**self.common_kwargs)
 
     @cached_property
-    def solver_setup(self):
-        return CoupledSetup(**self.common_kwargs) \
-            if self.coupled else BaseSetup(**self.common_kwargs)
+    def builder(self):
+        return CoupledBuilder(**self.common_kwargs) \
+            if self.coupled else Builder(**self.common_kwargs)
 
     @cached_property
     def solve(self):
-        return CoupledSolver(**self.common_kwargs) \
-            if self.coupled else Solver(**self.common_kwargs)
+        return CoupledSolve(**self.common_kwargs) \
+            if self.coupled else Solve(**self.common_kwargs)
 
     @cached_property
     def logger(self):

devito/petsc/iet/passes.py

@@ -9,13 +9,13 @@
 from devito.petsc.types.modes import InsertMode, ScatterMode
 
 
-class Solver:
+class Solve:
     def __init__(self, **kwargs):
         self.inject_solve = kwargs.get('inject_solve')
         self.objs = kwargs.get('objs')
         self.solver_objs = kwargs.get('solver_objs')
         self.iters = kwargs.get('iters')
-        self.cbbuilder = kwargs.get('cbbuilder')
+        self.callback_builder = kwargs.get('callback_builder')
         self.time_dependence = kwargs.get('time_dependence')
         self.calls = self._execute_solve()
 
@@ -29,16 +29,16 @@ def _execute_solve(self):
 
         struct_assignment = self.time_dependence.assign_time_iters(sobjs['userctx'])
 
-        b_efunc = self.cbbuilder._b_efunc
+        b_efunc = self.callback_builder._b_efunc
 
         dmda = sobjs['dmda']
 
         rhs_call = petsc_call(b_efunc.name, [sobjs['dmda'], sobjs['bglobal']])
 
         vec_place_array = self.time_dependence.place_array(target)
 
-        if self.cbbuilder.initial_guesses:
-            initguess = self.cbbuilder.initial_guesses[0]
+        if self.callback_builder.initial_guesses:
+            initguess = self.callback_builder.initial_guesses[0]
             initguess_call = petsc_call(initguess.name, [dmda, sobjs['xlocal']])
         else:
             initguess_call = None
@@ -84,7 +84,7 @@ def spatial_body(self):
         return spatial_body
 
 
-class CoupledSolver(Solver):
+class CoupledSolve(Solve):
     def _execute_solve(self):
         """
         Assigns the required time iterators to the struct and executes

devito/petsc/iet/solver.py devito/petsc/iet/solve.pydevito/petsc/iet/solver.py renamed to devito/petsc/iet/solve.py

@@ -12,7 +12,7 @@
 )
 
 
-class BaseObjectBuilder:
+class BaseTypeBuilder:
     """
     A base class for constructing objects needed for a PETSc solver.
     Designed to be extended by subclasses, which can override the `_extend_build`
@@ -89,9 +89,9 @@ def _extend_build(self, base_dict):
         base dictionary of solver objects.
         """
         return base_dict
+    
 
-
-class CoupledObjectBuilder(BaseObjectBuilder):
+class CoupledTypeBuilder(BaseTypeBuilder):
     def _extend_build(self, base_dict):
         sreg = self.sregistry
         objs = self.objs