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

[willic3 at geodynamics.org]

Author: willic3
Date: 2008-03-06 14:38:11 -0800 (Thu, 06 Mar 2008)
New Revision: 11348

Modified:
   short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx
Log:
Added some new material on sub-components and example problems.
Nothing has been done for sections 2.3 (databases) or 2.4 (labels and
identifiers) yet.



Modified: short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx	2008-03-06 21:47:30 UTC (rev 11347)
+++ short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx	2008-03-06 22:38:11 UTC (rev 11348)
@@ -1,4 +1,4 @@
-#LyX 1.5.2 created this file. For more info see http://www.lyx.org/
+#LyX 1.5.3 created this file. For more info see http://www.lyx.org/
 \lyxformat 276
 \begin_document
 \begin_header
@@ -234,10 +234,40 @@
 $ pylith --problem.help-properties
 \end_layout
 
+\begin_layout Standard
+Each component may also have sub-components associated with it:
+\end_layout
+
 \begin_layout LyX-Code
-DISCUSS SUBCOMPONENTS AND EXAMPLES
+$ pylith -- problem.help-components
 \end_layout
 
+\begin_layout Standard
+By starting at the top-level components, you can determine the components
+ and properties at each level by working down to lower-level components:
+\end_layout
+
+\begin_layout LyX-Code
+$ pylith --problem.bc.help-components
+\end_layout
+
+\begin_layout LyX-Code
+$ pylith --problem.bc.help-properties
+\end_layout
+
+\begin_layout Standard
+Using the 
+\family typewriter
+--help-components
+\family default
+ and 
+\family typewriter
+--help-properties
+\family default
+ flags for the various components and sub-components is a good way to discover
+ potential problems in a simulation.
+\end_layout
+
 \begin_layout Subsection
 Using a 
 \family typewriter
@@ -419,6 +449,77 @@
  (1) overrides only the built-in defaults.
 \end_layout
 
+\begin_layout Standard
+All of the example problems are set up using configuration files in the
+ example directory, and specific problems are defined by including the appropria
+te configuration file on the command-line.
+ Referring to the directory 
+\family typewriter
+examples/twocells/twohex8
+\family default
+, the following configuration files are present:
+\end_layout
+
+\begin_layout LyX-Code
+axialdisp.cfg
+\end_layout
+
+\begin_layout LyX-Code
+dislocation.cfg
+\end_layout
+
+\begin_layout LyX-Code
+pylithapp.cfg
+\end_layout
+
+\begin_layout LyX-Code
+sheardisp.cfg
+\end_layout
+
+\begin_layout Standard
+The settings in pylithapp.cfg will be read automatically, and additional
+ settings are included by specifying one of the other files on the command-line:
+\end_layout
+
+\begin_layout LyX-Code
+$ pylith axialdisp.cfg
+\end_layout
+
+\begin_layout Standard
+If you want to see what settings are being used, you can either examine
+ the 
+\family typewriter
+.cfg
+\family default
+ files, or use the help flags as described above:
+\end_layout
+
+\begin_layout LyX-Code
+$ pylith axialdisp.cfg --problem.help-components
+\end_layout
+
+\begin_layout LyX-Code
+$ pylith axialdisp.cfg --problem.help-properties
+\end_layout
+
+\begin_layout LyX-Code
+$ pylith axialdisp.cfg --problem.bc.help-components
+\end_layout
+
+\begin_layout LyX-Code
+$ pylith axialdisp.cfg --problem.bc.help-properties
+\end_layout
+
+\begin_layout Standard
+This is generally a more useful way of determining problem settings, since
+ it includes default values as well as those that have been specified in
+ the 
+\family typewriter
+.cfg
+\family default
+ file.
+\end_layout
+
 \begin_layout Subsection
 PETSc Settings
 \end_layout