diff options
Diffstat (limited to 'doc/documentation.tex')
| -rw-r--r-- | doc/documentation.tex | 31 |
1 files changed, 16 insertions, 15 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index 72ed964..6cd40aa 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -295,7 +295,7 @@ of the domain. If you need face specific calls immediately, please use the old interface for now. The mapping of bits to faces will likely be the same as that used for -the (optional) \texttt{BOUNDARY WIDTH} array. Precisely, the rule is as +the (optional) \texttt{BOUNDARY\_WIDTH} array. Precisely, the rule is as follows. For a $d$ dimensional grid variable, label the elements or bits by integers $i$ from $0$ to $2d-1$. Element or bit $i$ gets mapped to face $(-)^{i+1}e_{\lfloor i\rfloor}$, where ${}_{\lfloor @@ -347,7 +347,7 @@ boundary conditions, which you would like to use instead. %will be increased to $2n$ integers, so that one can have a different %stencil size on the `plus' and `minus' faces. Note that the number of boundary zones, as expressed in the -\texttt{boundary\_width} argument or the \texttt{BOUNDARY WIDTH} +\texttt{boundary\_width} argument or the \texttt{BOUNDARY\_WIDTH} array, is taken from the total number of grid points presented by Cactus through \texttt{cctk\_lssh}, etc. %In this sense they do not @@ -428,7 +428,7 @@ following additional arguments:\\[1mm] \textbf{key} & \textbf{variable type} & \textbf{description} & \textbf{default value}\\ \hline SCALAR & CCTK\_REAL & the scalar value & 0.0\\ -BOUNDARY WIDTH & CCTK\_INT array & stencil width for each face & n/a\\ +BOUNDARY\_WIDTH & CCTK\_INT array & stencil width for each face & n/a\\ \hline \end{tabular} @@ -528,7 +528,7 @@ following additional arguments:\\[1mm] \hline \textbf{key} & \textbf{variable type} & \textbf{description} & \textbf{default value}\\ \hline -BOUNDARY WIDTH & CCTK\_INT array & stencil width for each face & n/a\\ +BOUNDARY\_WIDTH & CCTK\_INT array & stencil width for each face & n/a\\ \hline \end{tabular} @@ -674,16 +674,17 @@ following additional arguments:\\[1mm] \textbf{key} & \textbf{variable type} & \textbf{description} & \textbf{default value}\\ \hline LIMIT & CCTK\_REAL & $f_0$ & 0.0\\ -PREVIOUS TIME LEVEL & CCTK\_INT or CCTK\_STRING & GV which holds the & Cactus previous time level\\ +PREVIOUS\_TIME\_LEVEL & CCTK\_INT or CCTK\_STRING & GV which holds the & Cactus previous time level\\ && previous time level&\\ SPEED & CCTK\_REAL & wave speed $v$& 1.0\\ -BOUNDARY WIDTH & CCTK\_INT array & stencil width for each face & n/a\\ +BOUNDARY\_WIDTH & CCTK\_INT array & stencil width for each face & n/a\\ \hline \end{tabular} \\[1mm] The default behavior is to use the Cactus previous time level, as defined in the \texttt{interface.ccl} file, for the grid variable -requested for the radiative boundary condition. The ``PREVIOUS TIME -LEVEL'' key is provided for backward compatibility only, and will be +requested for the radiative boundary condition. The +``PREVIOUS\_TIME\_LEVEL'' +key is provided for backward compatibility only, and will be deprecated in the future. The corresponding value may be either a \texttt{CCTK\_INT}, which will be interpreted as the index of a grid variable holding the previous time level, or a \texttt{CCTK\_STRING}, @@ -811,19 +812,19 @@ The copy boundary condition is registered under the name ``Copy''. \subsection{Additional arguments} -The ``COPY FROM'' argument for the copy boundary condition is +The ``COPY\_FROM'' argument for the copy boundary condition is required, so a valid table handle is required as well. The keys read are \\[1mm] \begin{tabular}{|l|l|l|l|} \hline \textbf{key} & \textbf{variable type} & \textbf{description} & \textbf{default value}\\ \hline -COPY FROM & CCTK\_INT or CCTK\_STRING & GV to copy from & \emph{no default}\\ -BOUNDARY WIDTH & CCTK\_INT array & stencil width for each face & n/a\\ +COPY\_FROM & CCTK\_INT or CCTK\_STRING & GV to copy from & \emph{no default}\\ +BOUNDARY\_WIDTH & CCTK\_INT array & stencil width for each face & n/a\\ \hline \end{tabular} \\[1mm] -(The \texttt{BOUNDARY WIDTH} table entry is only necessary if +(The \texttt{BOUNDARY\_WIDTH} table entry is only necessary if the \texttt{boundary\_width} parameter is negative.) @@ -936,8 +937,8 @@ following additional arguments:\\[1mm] \textbf{key} & \textbf{variable type} & \textbf{description} & \textbf{default value}\\ \hline FINF & CCTK\_REAL & $f_0$ & 0\\ -DECAY POWER & CCTK\_INT & $n$ & 1\\ -BOUNDARY WIDTH & CCTK\_INT array & stencil width for each face & n/a\\ +DECAY\_POWER & CCTK\_INT & $n$ & 1\\ +BOUNDARY\_WIDTH & CCTK\_INT array & stencil width for each face & n/a\\ \hline \end{tabular} @@ -1013,7 +1014,7 @@ following additional arguments:\\[1mm] \hline \textbf{key} & \textbf{variable type} & \textbf{description} & \textbf{default value}\\ \hline -BOUNDARY WIDTH & CCTK\_INT array & stencil width for each face & n/a\\ +BOUNDARY\_WIDTH & CCTK\_INT array & stencil width for each face & n/a\\ \hline \end{tabular} |