updated solver docs

hippylib · Jul 11, 2023 · f8a53af · f8a53af
1 parent 17d7c55
commit f8a53af
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 4 deletions.
diff --git a/doc/soupy.solver.rst b/doc/soupy.solver.rst
@@ -1,6 +1,14 @@
 soupy.solver module
 =========================
 
+soupy.solver.nonlinearVariationalSolver 
+-----------------------------------------------
+
+.. automodule:: soupy.solver.nonlinearVariationalSolver
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 soupy.solver.newtonBacktrackSolver 
 -----------------------------------------------
 

diff --git a/soupy/solver/newtonBacktrackSolver.py b/soupy/solver/newtonBacktrackSolver.py
@@ -44,7 +44,7 @@ class NewtonBacktrackSolver:
     """
     Backtracking Newton solver for the nonlinear variational system 
 
-        .. math:: r(u,v) = 0 \\forall v
+        .. math:: \\text{Find } u \in U \qquad r(u,v) = 0 \quad \\forall v \in V
 
     The user must provide the variational forms for the residual form, \
         an initial guess, boundary conditions, and optionally, \
@@ -81,7 +81,7 @@ def solve(self, residual_form, u, bcs=None, J_form = None, energy_form=None, sol
         """
         Solve the nonlinear variational system 
 
-        .. math:: r(u,v) = 0 \\forall v
+        .. math:: \\text{Find } u \in U \qquad r(u,v) = 0 \quad \\forall v \in V
 
         given using a backtracking Newton method with supplied initial guess 
 

diff --git a/soupy/solver/nonlinearVariationalSolver.py b/soupy/solver/nonlinearVariationalSolver.py
@@ -4,7 +4,7 @@ class NonlinearVariationalSolver:
     """
     Solver for the nonlinear variational problem 
 
-        .. math:: r(u,v) = 0 \\forall v
+        .. math:: \\text{Find } u \in U \qquad r(u,v) = 0 \quad \\forall v \in V
 
     The user must provide the variational forms for the residual form, \
         an initial guess, boundary conditions, and optionally, \
@@ -30,7 +30,7 @@ def solve(self, residual_form, u, bcs, J_form, form_compiler_parameters=None):
         """
         Solve the nonlinear variational system 
 
-        .. math:: r(u,v) = 0 \\forall v
+        .. math:: \\text{Find } u \in U \qquad r(u,v) = 0 \quad \\forall v \in V
 
         given using the `dolfin.NonlinearVariationalSolver` with a supplied initial guess