misc: Change name from to

Author: ZoeLeibowitz

devito/petsc/iet/nodes.py

@@ -36,5 +36,5 @@ def petsc_call(specific_call, call_args):
 
 
 # Mapping special Eq operations to their corresponding IET Expression subclass types.
-# These operations correspond to subclasses of Eq utilised within PETScSolve.
+# These operations correspond to subclasses of `Eq`` utilised within `petscsolve``.
 petsc_iet_mapper = {OpPetsc: PetscMetaData}

devito/petsc/iet/passes.py

@@ -31,7 +31,7 @@
 
 @iet_pass
 def lower_petsc(iet, **kwargs):
-    # Check if PETScSolve was used
+    # Check if `petscsolve` was used
     inject_solve_mapper = MapNodes(Iteration, PetscMetaData,
                                    'groupby').visit(iet)
 
@@ -55,19 +55,19 @@ def lower_petsc(iet, **kwargs):
     unique_grids = {i.expr.rhs.grid for (i,) in inject_solve_mapper.values()}
     # Assumption is that all solves are on the same grid
     if len(unique_grids) > 1:
-        raise ValueError("All PETScSolves must use the same Grid, but multiple found.")
+        raise ValueError("All `petscsolve` calls must use the same grid, but multiple grids were found.")
     grid = unique_grids.pop()
     devito_mpi = kwargs['options'].get('mpi', False)
     comm = grid.distributor._obj_comm if devito_mpi else 'PETSC_COMM_WORLD'
 
-    # Create core PETSc calls (not specific to each PETScSolve)
+    # Create core PETSc calls (not specific to each `petscsolve`)
     core = make_core_petsc_calls(objs, comm)
 
     setup = []
     subs = {}
     efuncs = {}
 
-    # Map PETScSolve to its Section (for logging)
+    # Map each `PetscMetaData`` to its Section (for logging)
     section_mapper = MapNodes(Section, PetscMetaData, 'groupby').visit(iet)
 
     # Prefixes within the same `Operator` should not be duplicated
@@ -78,7 +78,7 @@ def lower_petsc(iet, **kwargs):
         dup_list = ", ".join(repr(p) for p in sorted(duplicates))
         raise ValueError(
             f"The following `options_prefix` values are duplicated "
-            f"among your PETScSolves. Ensure each one is unique: {dup_list}"
+            f"among your `petscsolve` calls. Ensure each one is unique: {dup_list}"
         )
 
     # List of `Call`s to clear options from the global PETSc options database,

devito/petsc/iet/time_dependence.py

@@ -42,7 +42,7 @@ class TimeDependent(TimeBase):
     This includes scenarios where the target is not directly a `TimeFunction`,
     but depends on other functions that are.
     Outline of time loop abstraction with PETSc:
-    - At PETScSolve, time indices are replaced with temporary `Symbol` objects
+    - At `petscsolve`, time indices are replaced with temporary `Symbol` objects
       via a mapper (e.g., {t: tau0, t + dt: tau1}) to prevent the time loop
       from being generated in the callback functions. These callbacks, needed
       for each `SNESSolve` at every time step, don't require the time loop, but
@@ -67,7 +67,7 @@ def time_spacing(self):
     @cached_property
     def symb_to_moddim(self):
         """
-        Maps temporary `Symbol` objects created during `PETScSolve` to their
+        Maps temporary `Symbol` objects created during `petscsolve` to their
         corresponding modulo dimensions (e.g. creates {tau0: t0, tau1: t1}).
         """
         mapper = {

devito/petsc/iet/type_builder.py

@@ -207,7 +207,7 @@ def _target_dependent(self, base_dict):
 
 
 # A static dict containing shared symbols and objects that are not
-# unique to each PETScSolve.
+# unique to each `petscsolve` call.
 # Many of these objects are used as arguments in callback functions to make
 # the C code cleaner and more modular.
 objs = frozendict({

devito/petsc/logging.py

@@ -50,8 +50,8 @@ def __init__(self, params, *args, **kwargs):
         # Dynamically create a property on this class for each PETSc function
         self._add_properties()
 
-        # Initialize the summary by adding PETSc information from each PetscInfo
-        # object (each corresponding to an individual PETScSolve)
+        # Initialize the summary with PETSc information from each `PetscInfo`
+        # object (each corresponding to a `petscsolve` call)
         for i in self.petscinfos:
             self.add_info(i)
 
@@ -69,8 +69,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).
+        # Collect the function names from this `PetscInfo`
+        # instance (specific to its `petscsolve` call).
         funcs = [
             petsc_return_variable_dict[f].name for f in petscinfo.query_functions
         ]

devito/petsc/solve.py

@@ -14,11 +14,10 @@
 )
 
 
-__all__ = ['PETScSolve']
+__all__ = ['petscsolve']
 
 
-# TODO: Rename this to petsc_solve, petscsolve?
-def PETScSolve(target_exprs, target=None, solver_parameters=None,
+def petscsolve(target_exprs, target=None, solver_parameters=None,
                options_prefix=None, get_info=[]):
     """
     Returns a symbolic expression representing a linear PETSc solver,
@@ -36,13 +35,13 @@ def PETScSolve(target_exprs, target=None, solver_parameters=None,
 
         - Single-field problem:
             Pass a single Eq or list of Eq, and specify `target` separately:
-                PETScSolve(Eq1, target)
-                PETScSolve([Eq1, Eq2], target)
+                petscsolve(Eq1, target)
+                petscsolve([Eq1, Eq2], target)
 
         - Multi-field (mixed) problem:
             Pass a dictionary mapping each target field to its Eq(s):
-                PETScSolve({u: Eq1, v: Eq2})
-                PETScSolve({u: [Eq1, Eq2], v: [Eq3, Eq4]})
+                petscsolve({u: Eq1, v: Eq2})
+                petscsolve({u: [Eq1, Eq2], v: [Eq3, Eq4]})
 
     target : Function-like
         The function (e.g., `Function`, `TimeFunction`) into which the linear

devito/petsc/types/array.py

@@ -20,7 +20,7 @@ class PETScArray(ArrayBasic, Differentiable):
 
     PETScArray objects represent vector objects within PETSc.
     They correspond to the spatial domain of a Function-like object
-    provided by the user, which is passed to PETScSolve as the target.
+    provided by the user, which is passed to `petscsolve` as the target.
 
     TODO: Potentially re-evaluate and separate into PETScFunction(Differentiable)
     and then PETScArray(ArrayBasic).

devito/petsc/types/equation.py

@@ -6,7 +6,7 @@
 
 class EssentialBC(Eq):
     """
-    Represents an essential boundary condition for use with PETScSolve.
+    Represents an essential boundary condition for use with `petscsolve`.
 
     Due to ongoing work on PetscSection and DMDA integration (WIP),
     these conditions are imposed as trivial equations. The compiler
@@ -16,8 +16,8 @@ class EssentialBC(Eq):
     Note:
         - To define an essential boundary condition, use:
             Eq(target, boundary_value, subdomain=...),
-          where `target` is the Function-like object passed to PETScSolve.
-        - SubDomains used for multiple EssentialBCs must not overlap.
+          where `target` is the Function-like object passed to `petscsolve`.
+        - SubDomains used for multiple `EssentialBC`s must not overlap.
     """
     pass
 

devito/petsc/types/metadata.py

@@ -212,7 +212,7 @@ def space_dimensions(self):
         if len(space_dims) > 1:
             # TODO: This may not actually have to be the case, but enforcing it for now
             raise ValueError(
-                "All targets within a PETScSolve have to have the same space dimensions."
+                "All targets within a `petscsolve` call have to have the same space dimensions."
             )
         return space_dims.pop()
 
@@ -222,7 +222,7 @@ def grid(self):
         grids = [t.grid for t in self.targets]
         if len(set(grids)) > 1:
             raise ValueError(
-                "All targets within a PETScSolve have to have the same grid."
+                "Multiple grids detected in `petscsolve`; all targets must share one grid."
             )
         return grids.pop()
 
@@ -236,7 +236,7 @@ def space_order(self):
         space_orders = [t.space_order for t in self.targets]
         if len(set(space_orders)) > 1:
             raise ValueError(
-                "All targets within a PETScSolve have to have the same space order."
+                "All targets within a `petscsolve` call must have the same space order."
             )
         return space_orders.pop()
 

examples/petsc/Poisson/01_poisson.py

@@ -4,7 +4,7 @@
 from devito import (Grid, Function, Eq, Operator, switchconfig,
                     configuration, SubDomain)
 
-from devito.petsc import PETScSolve, EssentialBC
+from devito.petsc import petscsolve, EssentialBC
 from devito.petsc.initialize import PetscInitialize
 configuration['compiler'] = 'custom'
 os.environ['CC'] = 'mpicc'
@@ -97,7 +97,7 @@ def analytical(x, y):
     bcs += [EssentialBC(phi, bc, subdomain=sub4)]
 
     exprs = [eqn] + bcs
-    petsc = PETScSolve(exprs, target=phi, solver_parameters={'ksp_rtol': 1e-8})
+    petsc = petscsolve(exprs, target=phi, solver_parameters={'ksp_rtol': 1e-8})
 
     with switchconfig(language='petsc'):
         op = Operator(petsc)