% *======================================================================*
%  Cactus Thorn template for ThornGuide documentation
%  Author: Ian Kelley
%  Date: Sun Jun 02, 2002
%
%  Thorn documentation in the latex file doc/documentation.tex 
%  will be included in ThornGuides built with the Cactus make system.
%  The scripts employed by the make system automatically include 
%  pages about variables, parameters and scheduling parsed from the 
%  relevent thorn CCL files.
%  
%  This template contains guidelines which help to assure that your     
%  documentation will be correctly added to ThornGuides. More 
%  information is available in the Cactus UsersGuide.
%                                                    
%  Guidelines:
%   - Do not change anything before the line
%       % START CACTUS THORNGUIDE",
%     except for filling in the title, author, date etc. fields.
%        - Each of these fields should only be on ONE line.
%        - Author names should be sparated with a \\ or a comma
%   - You can define your own macros, but they must appear after
%     the START CACTUS THORNGUIDE line, and must not redefine standard 
%     latex commands.
%   - To avoid name clashes with other thorns, 'labels', 'citations', 
%     'references', and 'image' names should conform to the following 
%     convention:          
%       ARRANGEMENT_THORN_LABEL
%     For example, an image wave.eps in the arrangement CactusWave and 
%     thorn WaveToyC should be renamed to CactusWave_WaveToyC_wave.eps
%   - Graphics should only be included using the graphix package. 
%     More specifically, with the "includegraphics" command. Do
%     not specify any graphic file extensions in your .tex file. This 
%     will allow us (later) to create a PDF version of the ThornGuide
%     via pdflatex. |
%   - References should be included with the latex "bibitem" command. 
%   - Use \begin{abstract}...\end{abstract} instead of \abstract{...}
%   - Do not use \appendix, instead include any appendices you need as 
%     standard sections. 
%   - For the benefit of our Perl scripts, and for future extensions, 
%     please use simple latex.     
%
% *======================================================================* 
% 
% Example of including a graphic image:
%    \begin{figure}[ht]
% 	\begin{center}
%    	   \includegraphics[width=6cm]{MyArrangement_MyThorn_MyFigure}
% 	\end{center}
% 	\caption{Illustration of this and that}
% 	\label{MyArrangement_MyThorn_MyLabel}
%    \end{figure}
%
% Example of using a label:
%   \label{MyArrangement_MyThorn_MyLabel}
%
% Example of a citation:
%    \cite{MyArrangement_MyThorn_Author99}
%
% Example of including a reference
%   \bibitem{MyArrangement_MyThorn_Author99}
%   {J. Author, {\em The Title of the Book, Journal, or periodical}, 1 (1999), 
%   1--16. {\tt http://www.nowhere.com/}}
%
% *======================================================================* 

% If you are using CVS use this line to give version information

\documentclass{article}

% Use the Cactus ThornGuide style file
% (Automatically used from Cactus distribution, if you have a 
%  thorn without the Cactus Flesh download this from the Cactus
%  homepage at www.cactuscode.org)
\usepackage{../../../../doc/latex/cactus}

\begin{document}

% The author of the documentation
\author{Erik Schnetter \textless schnetter@uni-tuebingen.de\textgreater}

% The title of the document (not necessarily the name of the Thorn)
\title{Periodic}

% the date your document was last changed, if your document is in CVS, 
% please use:
\date{$ $Date$ $}

\maketitle

% Do not delete next line
% START CACTUS THORNGUIDE

% Add all definitions used in this documentation here 
%   \def\mydef etc

% Add an abstract for this thorn's documentation
\begin{abstract}
   Provide periodic boundary conditions.
\end{abstract}

% The following sections are suggestive only.
% Remove them or add your own.

\section{Introduction}

   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}

   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{Obtaining This Thorn}

   This thorn (and thorn \texttt{Slab}) are available in the
   \texttt{TAT} arrangement.

\subsection{Examples}

   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

\end{document}
