diff options
Diffstat (limited to 'doc/documentation.tex')
| -rw-r--r-- | doc/documentation.tex | 62 |
1 files changed, 36 insertions, 26 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index c848aa9..45cef5f 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -82,12 +82,11 @@ \author{Erik Schnetter \textless schnetter@uni-tuebingen.de\textgreater} % The title of the document (not necessarily the name of the Thorn) -\title{} +\title{Periodic} % the date your document was last changed, if your document is in CVS, % please use: -% \date{$ $Date$ $} -\date{May 05 2003} +\date{$ $Date$ $} \maketitle @@ -99,7 +98,7 @@ % Add an abstract for this thorn's documentation \begin{abstract} - + Provide periodic boundary conditions. \end{abstract} % The following sections are suggestive only. @@ -107,36 +106,47 @@ \section{Introduction} -\section{Physical System} - -\section{Numerical Implementation} + This thorn provides periodic boundary conditions that are + independent of PUGH, i.e.\ they work with both PUGH and Carpet. + They use the new boundary condition scheme, so that no changes to + existing code and only small changes to existing parameter files + are necessary. Currently, thorn \texttt{Periodic} works in single + patch mode only. \section{Using This Thorn} -\subsection{Obtaining This Thorn} - -\subsection{Basic Usage} + Make sure that the other symmetry thorns (e.g.\ + \texttt{CartGrid3D}) do not provide symmetry boundary conditions + for the same boundaries as \texttt{Periodic}. Then activate thorn + \texttt{Periodic} and thorn \texttt{Slab}. Set the parameters + \texttt{Periodic::periodic*} according to your wishes. -\subsection{Special Behaviour} +\subsection{Obtaining This Thorn} -\subsection{Interaction With Other Thorns} + This thorn (and thorn \texttt{Slab}) are available in the + \texttt{TAT} arrangement. \subsection{Examples} -\subsection{Support and Feedback} - -\section{History} - -\subsection{Thorn Source Code} - -\subsection{Thorn Documentation} - -\subsection{Acknowledgements} - - -\begin{thebibliography}{9} - -\end{thebibliography} + The following lines come from a WaveToy simulation with Carpet: +\begin{verbatim} + driver::global_nx = 19 + driver::global_ny = 26 + driver::global_nz = 34 + + driver::ghost_size = 2 + + grid::type = byrange + grid::xmin = -5.4 + grid::ymin = -7.2 + grid::zmin = -9.6 + grid::xmax = 5.4 + grid::ymax = 7.8 + grid::zmax = 10.2 + grid::domain = full + + periodic::periodic = yes +\end{verbatim} % Do not delete next line % END CACTUS THORNGUIDE |