[cig-commits] [commit] rajesh-petsc, rajesh-petsc-schur: Added PETSc configuration and usage sections to the CitcomS manual (27720cb)

[cig_noreply at geodynamics.org]

Repository : https://github.com/geodynamics/citcoms

On branches: rajesh-petsc,rajesh-petsc-schur
Link       : https://github.com/geodynamics/citcoms/compare/464e1b32299b15819f93efd98d969cddb84dfe51...f97ae655a50bdbd6dac1923a3471ee4dae178fbd

>---------------------------------------------------------------

commit 27720cba9c3c83fabda26157b144551590713fdd
Author: Rajesh Kommu <rajesh.kommu at gmail.com>
Date:   Mon Sep 8 11:06:14 2014 -0700

    Added PETSc configuration and usage sections to the CitcomS manual


>---------------------------------------------------------------

27720cba9c3c83fabda26157b144551590713fdd
 doc/citcoms-manual.pdf | Bin 12616604 -> 12617838 bytes
 doc/citcoms-manual.tex |  23 +++++++++++++++++++++++
 2 files changed, 23 insertions(+)

diff --git a/doc/citcoms-manual.pdf b/doc/citcoms-manual.pdf
index c4baae9..4f2f0ec 100644
Binary files a/doc/citcoms-manual.pdf and b/doc/citcoms-manual.pdf differ
diff --git a/doc/citcoms-manual.tex b/doc/citcoms-manual.tex
index 8c44935..69f71fa 100644
--- a/doc/citcoms-manual.tex
+++ b/doc/citcoms-manual.tex
@@ -1440,6 +1440,17 @@ commands:
 You may need to set \texttt{GMTHOME} and \texttt{NETCDFHOME} environment
 variables if these packages is not installed in the system directory.
 
+\section{PETSc Configuration (Optional)}
+
+To use the PETSc functionality in CitcomS, CitcomS first needs to be built with the PETSc library. This
+is done by passing \texttt{--with-petsc=yes} option to the \texttt{configure} script. If this option is 
+passed to \texttt{configure}, \texttt{configure} expects PETSc to be installed correctly on the system,
+with the environment variables \texttt{PETSC\_DIR} and \texttt{PETSC\_ARCH} being set appropriately.
+\texttt{configure} will check for the \texttt{PETSC\_DIR} and \texttt{PETSC\_ARCH} only if the 
+\texttt{--with-petsc=yes} option has been passed to the script.
+
+The PETSc homepage is \url{http://www.mcs.anl.gov/petsc/} and information about installing PETSc can be found at
+\url{http://www.mcs.anl.gov/petsc/documentation/installation.html}
 
 \section{\label{sec:Batch-System-Configuration}Batch System Configuration}
 
@@ -5752,6 +5763,18 @@ indicated.\tabularnewline
 \hline 
 \end{tabular}
 
+\subsection{PETSc Related Flags}
+
+
+\begin{tabular}{|>{\raggedright}p{1.85in}|>{\raggedright}p{4.25in}|}
+\hline 
+\texttt{\small{use\_petsc=off}} & Set to \texttt{on} to use PETSc functionality. Turning on this flag only will\\
+                                  cause the PETSc version of the Uzawa algorithm to be used in the Stokes solver
+                                  \tabularnewline\hline
+\texttt{\small{petsc\_schur=off}} & Set to \texttt{on} to use the ``Schur complement reduction'' approach in\\
+                                  the Stokes solver\tabularnewline\hline 
+\end{tabular}
+
 
 \section{CitcomS Facilities and Properties}