[cig-commits] r15406 - short/3D/PyLith/trunk/doc/userguide/runpylith

[brad at geodynamics.org]

Author: brad
Date: 2009-06-30 16:51:05 -0700 (Tue, 30 Jun 2009)
New Revision: 15406

Modified:
   short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx
Log:
Added converged reason as recommended PETSc arguments.

Modified: short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx	2009-06-30 23:15:01 UTC (rev 15405)
+++ short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx	2009-06-30 23:51:05 UTC (rev 15406)
@@ -1723,7 +1723,7 @@
 
 
 \begin_inset Tabular
-<lyxtabular version="3" rows="7" columns="3">
+<lyxtabular version="3" rows="9" columns="3">
 <features>
 <column alignment="left" valignment="top" width="0.9in">
 <column alignment="center" valignment="middle" width="0.8in">
@@ -1925,7 +1925,7 @@
 </cell>
 </row>
 <row>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 \begin_inset Text
 
 \begin_layout Plain Layout
@@ -1936,7 +1936,7 @@
 
 \end_inset
 </cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 \begin_inset Text
 
 \begin_layout Plain Layout
@@ -1947,7 +1947,7 @@
 
 \end_inset
 </cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
 \begin_inset Text
 
 \begin_layout Plain Layout
@@ -1957,6 +1957,72 @@
 \end_inset
 </cell>
 </row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family typewriter
+ksp_converged_reason
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\shape italic
+true
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Indicate why iterating stopped in linear solve.
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\family typewriter
+snes_converged_reason
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
+\shape italic
+true
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Indicate why iterating stopped in nonlinear solve.
+\end_layout
+
+\end_inset
+</cell>
+</row>
 </lyxtabular>
 
 \end_inset
@@ -3341,8 +3407,12 @@
 \end_layout
 
 \begin_layout Itemize
-If you encounter errors or warnings, use the 
+If you encounter errors or warnings, run 
 \family typewriter
+pylithinfo
+\family default
+ or use the 
+\family typewriter
 --help
 \family default
 , 
@@ -3353,8 +3423,8 @@
 \family typewriter
 --help-properties
 \family default
- command line arguments to check the parameters to make sure PyLith is using
- the parameters you intended.
+ command line arguments when running PyLith to check the parameters to make
+ sure PyLith is using the parameters you intended.
 \end_layout
 
 \begin_layout Itemize
@@ -3366,10 +3436,18 @@
 \family typewriter
 --petsc.ksp_monitor
 \family default
-, and 
+, 
 \family typewriter
 --petsc.ksp_view
 \family default
+, 
+\family typewriter
+--petsc.ksp_converged_reason
+\family default
+, and 
+\family typewriter
+--petsc.snes_converged_reason
+\family default
  command line arguments (or set them in a parameter file) to view PyLith
  performance and monitor the convergence.
 \end_layout