add a new section "Driver Issues" to record gotchas and tips-n-tricks

about driver parameters to play nicely with CoordBase


git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/CoordBase/trunk@23 0337457d-221f-4ee6-a5f0-14255d5370d8

1 files changed, 21 insertions, 0 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index ce6749a..49ef96f 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -603,6 +603,27 @@ periodicity, staggered boundary & no & yes & 0
 For other boundary conditions such as Dirichlet or Robin, one can
 choose these parameters freely.
 
+\section{Driver Issues}
+
+When using the CoordBase domain and boundary parameters, the driver
+(PUGH, Carpet, etc) also needs to be kept informed.
+
+\subsection{PUGH}
+
+If you're using PUGH, you \textbf{must} still set the parameters
+\verb|driver::global_nx|, \verb|driver::global_ny|, and
+\verb|driver::global_nz| by hand.  (Of course, you must set them
+to values consistent with the CoordBase parameters.)  (If you don't
+set these parameters, PUGH will assume a default $10 \times 10 \times 10$
+grid, which is almost certainly not what you want!)
+
+\subsection{Carpet}
+
+If you're using Carpet, things are nice:  just set
+\begin{verbatim}
+Carpet::domain_from_coordbase = true
+\end{verbatim}
+and Carpet will get all this information from CoordBase.
 
 % Do not delete next line
 % END CACTUS THORNGUIDE