\documentclass{article}
\usepackage{../../../../../doc/latex/cactus}
\newlength{\tableWidth} \newlength{\maxVarWidth} \newlength{\paraWidth} \newlength{\descWidth} \begin{document}

% The title of the document (not necessarily the name of the Thorn)
\title{Hydro\_InitExcision - Initial Excision for Hydro Evolutions}

% The author of the documentation - on one line, otherwise it does not work
\author{Andrea Nerozzi, Frank L\"offler}

\maketitle

% 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)

% Do not delete next line
% START CACTUS THORNGUIDE

%\newcommand{\eqref}[1]{(\ref{#1})}

% Add an abstract for this thorn's documentation
\begin{abstract}
  This thorn initialises the excision-spacemask for GRHydro to
  specified forms. It is based on a similar version used to initialise
  the excision-mask for Whisky code.
\end{abstract}

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

\section{Using This Thorn}

Using this thorn is quite easy:
You have to activate it in your parameter file and specify at least the
following:

\begin{verbatim}
hydro_initexcision::hydro_initexcision = "yes"
\end{verbatim}

In addition to that you may want to specify the type of excision zone
you want to have. You can do this by

\begin{verbatim}
hydro_initexcision::hydro_initexcision_type = <TYPE>
\end{verbatim}

where \begin{verbatim}<TYPE>\end{verbatim} is one of the following list:
\begin{itemize}
 \item "x-axis"
 \item "y-axis"
 \item "z-axis"
 \item "box"
 \item "sphere"
\end{itemize}

\section{Thorn Source Code}

This was initially written by Andrea Nerozzi and later changed
by Frank L\"offler.

\section{Thorn Documentation}

This documentation was largely written by Frank L\"offler.

% Do not delete next line
% END CACTUS THORNGUIDE



\section{Parameters} 


\parskip = 0pt

\setlength{\tableWidth}{160mm}

\setlength{\paraWidth}{\tableWidth}
\setlength{\descWidth}{\tableWidth}
\settowidth{\maxVarWidth}{hydro\_initexcision\_coordinate\_length}

\addtolength{\paraWidth}{-\maxVarWidth}
\addtolength{\paraWidth}{-\columnsep}
\addtolength{\paraWidth}{-\columnsep}
\addtolength{\paraWidth}{-\columnsep}

\addtolength{\descWidth}{-\columnsep}
\addtolength{\descWidth}{-\columnsep}
\addtolength{\descWidth}{-\columnsep}
\noindent \begin{tabular*}{\tableWidth}{|c|l@{\extracolsep{\fill}}r|}
\hline
\multicolumn{1}{|p{\maxVarWidth}}{hydro\_initexcision} & {\bf Scope:} restricted & BOOLEAN \\\hline
\multicolumn{3}{|p{\descWidth}|}{{\bf Description:}   {\em Sets up an excision zone}} \\
\hline & & {\bf Default:} no \\\hline
\end{tabular*}

\vspace{0.5cm}\noindent \begin{tabular*}{\tableWidth}{|c|l@{\extracolsep{\fill}}r|}
\hline
\multicolumn{1}{|p{\maxVarWidth}}{hydro\_initexcision\_coordinate\_length} & {\bf Scope:} restricted & REAL \\\hline
\multicolumn{3}{|p{\descWidth}|}{{\bf Description:}   {\em Length of excised region}} \\
\hline{\bf Range} & &  {\bf Default:} (none) \\\multicolumn{1}{|p{\maxVarWidth}|}{\centering 0:} & \multicolumn{2}{p{\paraWidth}|}{Length of excised region, has different meanings for the types} \\\hline
\end{tabular*}

\vspace{0.5cm}\noindent \begin{tabular*}{\tableWidth}{|c|l@{\extracolsep{\fill}}r|}
\hline
\multicolumn{1}{|p{\maxVarWidth}}{hydro\_initexcision\_flip} & {\bf Scope:} restricted & INT \\\hline
\multicolumn{3}{|p{\descWidth}|}{{\bf Description:}   {\em Exchange excised and normal region}} \\
\hline{\bf Range} & &  {\bf Default:} (none) \\\multicolumn{1}{|p{\maxVarWidth}|}{\centering 0:1} & \multicolumn{2}{p{\paraWidth}|}{0 (default) for no, 1 for yes} \\\hline
\end{tabular*}

\vspace{0.5cm}\noindent \begin{tabular*}{\tableWidth}{|c|l@{\extracolsep{\fill}}r|}
\hline
\multicolumn{1}{|p{\maxVarWidth}}{hydro\_initexcision\_fraction} & {\bf Scope:} restricted & REAL \\\hline
\multicolumn{3}{|p{\descWidth}|}{{\bf Description:}   {\em Fraction of excised region}} \\
\hline{\bf Range} & &  {\bf Default:} 0.25 \\\multicolumn{1}{|p{\maxVarWidth}|}{\centering 0:1} & \multicolumn{2}{p{\paraWidth}|}{Represents the fraction of excised region (0..1)} \\\hline
\end{tabular*}

\vspace{0.5cm}\noindent \begin{tabular*}{\tableWidth}{|c|l@{\extracolsep{\fill}}r|}
\hline
\multicolumn{1}{|p{\maxVarWidth}}{hydro\_initexcision\_min\_points} & {\bf Scope:} restricted & INT \\\hline
\multicolumn{3}{|p{\descWidth}|}{{\bf Description:}   {\em minimal number of points of excision}} \\
\hline{\bf Range} & &  {\bf Default:} (none) \\\multicolumn{1}{|p{\maxVarWidth}|}{\centering 0:} & \multicolumn{2}{p{\paraWidth}|}{minimal number of points of excision, currently only partly implemented} \\\hline
\end{tabular*}

\vspace{0.5cm}\noindent \begin{tabular*}{\tableWidth}{|c|l@{\extracolsep{\fill}}r|}
\hline
\multicolumn{1}{|p{\maxVarWidth}}{hydro\_initexcision\_old\_mask} & {\bf Scope:} restricted & INT \\\hline
\multicolumn{3}{|p{\descWidth}|}{{\bf Description:}   {\em Also set the old 'emask'?}} \\
\hline{\bf Range} & &  {\bf Default:} (none) \\\multicolumn{1}{|p{\maxVarWidth}|}{\centering 0:1} & \multicolumn{2}{p{\paraWidth}|}{0 (default) for no, 1 for yes} \\\hline
\end{tabular*}

\vspace{0.5cm}\noindent \begin{tabular*}{\tableWidth}{|c|l@{\extracolsep{\fill}}r|}
\hline
\multicolumn{1}{|p{\maxVarWidth}}{hydro\_initexcision\_position\_x} & {\bf Scope:} restricted & REAL \\\hline
\multicolumn{3}{|p{\descWidth}|}{{\bf Description:}   {\em x-coordinate}} \\
\hline{\bf Range} & &  {\bf Default:} 0.0 \\\multicolumn{1}{|p{\maxVarWidth}|}{\centering :} & \multicolumn{2}{p{\paraWidth}|}{anything real is ok} \\\hline
\end{tabular*}

\vspace{0.5cm}\noindent \begin{tabular*}{\tableWidth}{|c|l@{\extracolsep{\fill}}r|}
\hline
\multicolumn{1}{|p{\maxVarWidth}}{hydro\_initexcision\_position\_y} & {\bf Scope:} restricted & REAL \\\hline
\multicolumn{3}{|p{\descWidth}|}{{\bf Description:}   {\em y-coordinate}} \\
\hline{\bf Range} & &  {\bf Default:} 0.0 \\\multicolumn{1}{|p{\maxVarWidth}|}{\centering :} & \multicolumn{2}{p{\paraWidth}|}{anything real is ok} \\\hline
\end{tabular*}

\vspace{0.5cm}\noindent \begin{tabular*}{\tableWidth}{|c|l@{\extracolsep{\fill}}r|}
\hline
\multicolumn{1}{|p{\maxVarWidth}}{hydro\_initexcision\_position\_z} & {\bf Scope:} restricted & REAL \\\hline
\multicolumn{3}{|p{\descWidth}|}{{\bf Description:}   {\em z-coordinate}} \\
\hline{\bf Range} & &  {\bf Default:} 0.0 \\\multicolumn{1}{|p{\maxVarWidth}|}{\centering :} & \multicolumn{2}{p{\paraWidth}|}{anything real is ok} \\\hline
\end{tabular*}

\vspace{0.5cm}\noindent \begin{tabular*}{\tableWidth}{|c|l@{\extracolsep{\fill}}r|}
\hline
\multicolumn{1}{|p{\maxVarWidth}}{hydro\_initexcision\_poststep} & {\bf Scope:} restricted & BOOLEAN \\\hline
\multicolumn{3}{|p{\descWidth}|}{{\bf Description:}   {\em Schedule also at poststep}} \\
\hline & & {\bf Default:} no \\\hline
\end{tabular*}

\vspace{0.5cm}\noindent \begin{tabular*}{\tableWidth}{|c|l@{\extracolsep{\fill}}r|}
\hline
\multicolumn{1}{|p{\maxVarWidth}}{hydro\_initexcision\_type} & {\bf Scope:} restricted & KEYWORD \\\hline
\multicolumn{3}{|p{\descWidth}|}{{\bf Description:}   {\em Type of excision to apply}} \\
\hline{\bf Range} & &  {\bf Default:} x-axis \\\multicolumn{1}{|p{\maxVarWidth}|}{\centering box} & \multicolumn{2}{p{\paraWidth}|}{Box excised region} \\\multicolumn{1}{|p{\maxVarWidth}|}{\centering x-axis} & \multicolumn{2}{p{\paraWidth}|}{X axis excision} \\\multicolumn{1}{|p{\maxVarWidth}|}{\centering y-axis} & \multicolumn{2}{p{\paraWidth}|}{Y axis excision} \\\multicolumn{1}{|p{\maxVarWidth}|}{\centering z-axis} & \multicolumn{2}{p{\paraWidth}|}{Z axis excision} \\\multicolumn{1}{|p{\maxVarWidth}|}{\centering diagonal} & \multicolumn{2}{p{\paraWidth}|}{diagonal excision} \\\multicolumn{1}{|p{\maxVarWidth}|}{\centering sphere} & \multicolumn{2}{p{\paraWidth}|}{sphere excision} \\\hline
\end{tabular*}

\vspace{0.5cm}\noindent \begin{tabular*}{\tableWidth}{|c|l@{\extracolsep{\fill}}r|}
\hline
\multicolumn{1}{|p{\maxVarWidth}}{domain} & {\bf Scope:} shared from GRID & KEYWORD \\\hline
\end{tabular*}

\vspace{0.5cm}\parskip = 10pt 

\section{Interfaces} 


\parskip = 0pt

\vspace{3mm} \subsection*{General}

\noindent {\bf Implements}: 

hydro\_initexcision
\vspace{2mm}

\noindent {\bf Inherits}: 

hydrobase

grid

spacemask
\vspace{2mm}

\vspace{5mm}\parskip = 10pt 

\section{Schedule} 


\parskip = 0pt


\noindent This section lists all the variables which are assigned storage by thorn EinsteinInitialData/Hydro\_InitExcision.  Storage can either last for the duration of the run ({\bf Always} means that if this thorn is activated storage will be assigned, {\bf Conditional} means that if this thorn is activated storage will be assigned for the duration of the run if some condition is met), or can be turned on for the duration of a schedule function.


\subsection*{Storage}NONE
\subsection*{Scheduled Functions}
\vspace{5mm}

\noindent {\bf CCTK\_INITIAL} 

\hspace{5mm} hydro\_initexcisionmask 

\hspace{5mm}{\it sets up the excision mask } 


\hspace{5mm}

 \begin{tabular*}{160mm}{cll} 
~ & After:  & maskone \\ 
~ & Language:  & c \\ 
~ & Type:  & function \\ 
\end{tabular*} 


\vspace{5mm}

\noindent {\bf CCTK\_POST\_RECOVER\_VARIABLES} 

\hspace{5mm} hydro\_initexcisionmask 

\hspace{5mm}{\it sets up the excision mask } 


\hspace{5mm}

 \begin{tabular*}{160mm}{cll} 
~ & After:  & maskone \\ 
~ & Language:  & c \\ 
~ & Type:  & function \\ 
\end{tabular*} 


\vspace{5mm}

\noindent {\bf CCTK\_POSTREGRID} 

\hspace{5mm} hydro\_initexcisionmask 

\hspace{5mm}{\it sets up the excision mask } 


\hspace{5mm}

 \begin{tabular*}{160mm}{cll} 
~ & After:  & maskone \\ 
~ & Language:  & c \\ 
~ & Type:  & function \\ 
\end{tabular*} 


\vspace{5mm}

\noindent {\bf CCTK\_POSTSTEP} 

\hspace{5mm} hydro\_initexcisionmask\_poststep 

\hspace{5mm}{\it sets up the excision mask } 


\hspace{5mm}

 \begin{tabular*}{160mm}{cll} 
~ & Before:  & setup\_epsdis \\ 
~ & Language:  & c \\ 
~ & Type:  & function \\ 
\end{tabular*} 



\vspace{5mm}\parskip = 10pt 
\end{document}
