Document _solve()

usnistgov · Jan 19, 2024 · eced40c · eced40c
1 parent 1e78000
commit eced40c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/fipy/solvers/solver.py b/fipy/solvers/solver.py
@@ -187,6 +187,10 @@ def _cleanup(self):
 
     def _solve(self):
         """Solve system of equations posed for FiPy
+
+        Common method invoked by :class:`~fipy.terms.term.Term`, which then
+        calls solver-suite-specific :math:`~fipy.solvers.solver._solve_`
+        methods.
         """
         L, x, b = self._Lxb