Improved documentation and performance tests for multistep solver (#554)

zwicker-group · Apr 3, 2024 · 1eba064 · 1eba064
1 parent 7548016
commit 1eba064
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 5 deletions.
diff --git a/pde/solvers/adams_bashforth.py b/pde/solvers/adams_bashforth.py
@@ -1,6 +1,6 @@
 """
-Defines an explicit solver supporting various methods
-   
+Defines an explicit Adams-Bashforth solver
+
 .. codeauthor:: David Zwicker <[email protected]> 
 """
 
@@ -17,7 +17,7 @@
 
 
 class AdamsBashforthSolver(SolverBase):
-    """solving partial differential equations using an Adams-Bashforth scheme"""
+    """explicit Adams-Bashforth multi-step solver"""
 
     name = "adams–bashforth"
 

diff --git a/pde/solvers/crank_nicolson.py b/pde/solvers/crank_nicolson.py
@@ -18,7 +18,7 @@
 
 
 class CrankNicolsonSolver(SolverBase):
-    """solving partial differential equations using the Crank-Nicolson scheme"""
+    """Crank-Nicolson solver"""
 
     name = "crank-nicolson"
 

diff --git a/scripts/performance_solvers.py b/scripts/performance_solvers.py
@@ -13,7 +13,13 @@
 import numpy as np
 
 from pde import CahnHilliardPDE, Controller, DiffusionPDE, ScalarField, UnitGrid
-from pde.solvers import CrankNicolsonSolver, ExplicitSolver, ImplicitSolver, ScipySolver
+from pde.solvers import (
+    AdamsBashforthSolver,
+    CrankNicolsonSolver,
+    ExplicitSolver,
+    ImplicitSolver,
+    ScipySolver,
+)
 
 
 def main(
@@ -57,6 +63,7 @@ def main(
         "Runge-Kutta, fixed": (1e-2, ExplicitSolver(eq, scheme="rk", adaptive=False)),
         "Runge-Kutta, adaptive": (1e-2, ExplicitSolver(eq, scheme="rk", adaptive=True)),
         "Implicit": (1e-2, ImplicitSolver(eq)),
+        "Adams-Bashforth": (1e-2, AdamsBashforthSolver(eq)),
         "Crank-Nicolson": (1e-2, CrankNicolsonSolver(eq)),
         "Scipy": (None, ScipySolver(eq)),
     }