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

[brad at geodynamics.org]

Author: brad
Date: 2013-08-20 17:49:49 -0700 (Tue, 20 Aug 2013)
New Revision: 22723

Modified:
   short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx
Log:
Added pylith workflow diagram to manual.

Modified: short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx	2013-08-21 00:34:20 UTC (rev 22722)
+++ short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx	2013-08-21 00:49:49 UTC (rev 22723)
@@ -72,22 +72,15 @@
 \end_layout
 
 \begin_layout Standard
-There are essentially three major inputs needed to run a problem with PyLith:
-\end_layout
+Figure 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "fig:pylith:workflow"
 
-\begin_layout Enumerate
-A set of parameters describing the problem.
- These parameters describe the type of problem to be run, solver information,
- time-stepping information, boundary conditions, materials, etc.
- This information can be provided from the command-line or by using a 
-\family typewriter
-.cfg
-\family default
- or 
-\family typewriter
-.pml
-\family default
- file.
+\end_inset
+
+ shows the workflow for running PyLith.
+ There are essentially three main inputs needed to run a problem with PyLith:
 \end_layout
 
 \begin_layout Enumerate
@@ -123,6 +116,15 @@
 \end_layout
 
 \begin_layout Enumerate
+A set of parameters describing the problem.
+ These parameters describe the type of problem to be run, solver information,
+ time-stepping information, boundary conditions, materials, etc.
+ This information can be provided from the command-line or by using a 
+\family typewriter
+.cfg.
+\end_layout
+
+\begin_layout Enumerate
 Databases specifying the material property values and boundary condition
  values to be used.
  Arbitrarily complex spatial variations in boundary and fault conditions
@@ -144,6 +146,68 @@
  for the format specification).
 \end_layout
 
+\begin_layout Standard
+PyLith writes solution information, such as solution fields and state variables,
+ to either VTK files or HDF5/Xdmf files.
+ ParaView and Visit can read both types of files.
+ Post-processing of output is generally performed using HDF5 files accessed
+ via a Python script and the h5py package or a Matlab script.
+\end_layout
+
+\begin_layout Standard
+\noindent
+\align center
+\begin_inset Float figure
+placement H
+wide false
+sideways false
+status open
+
+\begin_layout Plain Layout
+\noindent
+\align center
+\begin_inset Graphics
+	filename figs/runpylith.pdf
+	width 5in
+
+\end_inset
+
+ 
+\end_layout
+
+\begin_layout Plain Layout
+\begin_inset Caption
+
+\begin_layout Plain Layout
+PyLith requires a finite-element mesh (three different mechanisms for generating
+ a mesh are currently supported), simulation parameters, and spatial databases
+ (defining the spatial variation of various parameters).
+ PyLith writes the solution output to either VTK or HDF5/Xdmf files, which
+ can be visualized with ParaView or Visit.
+ Post-processing is generally done using the HDF5 files with Python or Matlab
+ scripts.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+\begin_inset CommandInset label
+LatexCommand label
+name "fig:pylith:workflow"
+
+\end_inset
+
+ 
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
 \begin_layout Section
 Defining the Simulation
 \end_layout