Documenting static boundary condition.

git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/Boundary/trunk@183 6a38eb6e-646e-4a02-a296-d141613ad6c4

1 files changed, 73 insertions, 1 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index dfdd351..3d5f264 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -36,9 +36,10 @@ The boundary conditions available are
 \begin{itemize}
 \item Scalar
 \item Flat 
-\item Copy (static)
 \item Radiation 
+\item Copy
 \item Robin
+\item Static
 \end{itemize}
 
 \vskip .5cm
@@ -569,6 +570,77 @@ boundary condition was not successfully applied
 \item[{\tt group\_index}] Group index
 \end{Lentry}
 
+
+\subsection{Static Boundary Condition}
+
+The static boundary condition ensures that the boundary values do not
+evolve in time, by copying their values from previous timelevels.
+
+\subsubsection*{Calling from C:}
+
+{\bf All Coordinate Directions:}
+\begin{verbatim}
+int ierr = BndStaticVN(cGH *cctkGH, int *stencil_size, char *variable_name)
+int ierr = BndStaticGN(cGH *cctkGH, int *stencil_size, char *group_name)
+int ierr = BndStaticVI(cGH *cctkGH, int *stencil_size, int variable_index)
+int ierr = BndStaticGI(cGH *cctkGH, int *stencil_size, int group_index)
+\end{verbatim}
+
+{\bf Individual Coordinate Directions:}
+\begin{verbatim}
+int ierr = BndStaticDirVN(cGH *cctkGH, int stencil, int dir, char *variable_name)
+int ierr = BndStaticDirGN(cGH *cctkGH, int stencil, int dir, char *group_name)
+int ierr = BndStaticDirVI(cGH *cctkGH, int stencil, int dir, int variable_index)
+int ierr = BndStaticDirGI(cGH *cctkGH, int stencil, int dir, int group_index)
+\end{verbatim}
+
+\subsubsection*{Calling from Fortran:}
+
+{\bf All Coordinate Directions:}
+\begin{verbatim}
+call BndStaticVN(ierr, cctkGH, stencil_array, variable_name)
+call BndStaticGN(ierr, cctkGH, stencil_array, group_name)
+call BndStaticVI(ierr, cctkGH, stencil_array, variable_index)
+call BndStaticGI(ierr, cctkGH, stencil_array, group_index)
+\end{verbatim}
+
+{\bf Individual Coordinate Directions:}
+\begin{verbatim}
+call BndStaticDirVN(ierr, cctkGH, stencil, dir, variable_name)
+call BndStaticDirGN(ierr, cctkGH, stencil, dir, group_name)
+call BndStaticDirVI(ierr, cctkGH, stencil, dir, variable_index)
+call BndStaticDirGI(ierr, cctkGH, stencil, dir, group_index)
+\end{verbatim}
+where
+{\tt
+\begin{tabbing}
+character*(*) \= variable\_name\=\kill
+integer \> ierr \\
+CCTK\_POINTER \> cctkGH\\
+integer \> dir\\
+integer \> stencil\\
+integer \> stencil\_array(dim)\\
+character*(*) \> variable\_name\\
+character*(*) \> group\_name\\
+integer \> variable\_index\\
+integer \> group\_index\\
+\end{tabbing}
+}
+
+\subsubsection*{Arguments}
+\begin{itemize}
+\item[{\tt ierr}] Return value, negative value indicates the
+boundary condition was not successfully applied
+\item[{\tt cctkGH}] Grid hierarchy pointer
+\item[{\tt dir}] Coordinate direction in which to apply boundary condition
+\item[{\tt stencil\_size}] Array with dimension of the grid function, containing the stencil width to apply the boundary at
+\item[{\tt variable\_name}] Name of the variable
+\item[{\tt group\_name}] Name of the group
+\item[{\tt variable\_index}] Variable index
+\item[{\tt group\_index}] Group index
+\end{itemize}
+
+
 % Do not delete next line
 % END CACTUS THORNGUIDE