diff options
| -rw-r--r-- | doc/documentation.tex | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index 0b7496d..ac49bb0 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -290,6 +290,31 @@ sym[2] = one; SetCartSymVN(cctkGH, sym,"ADMBase::gxy"); \end{verbatim} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\subsection{Calling Symmetry Boundary Conditions} + +\verb|CartGrid3D| provides the following two routines to apply symmetry +boundary conditions to a variable group: + +\begin{verbatim} +CartSymGI(cGH *GH, int *gi) +CartSymGN(cGH *GH, const char *gn) +\end{verbatim} + +and for a specific variable it provides: + +\begin{verbatim} +CartSymVI(cGH *GH, int *vi) +CartSymVN(cGH *GH, const char *gn) +\end{verbatim} + +A group or variable can +be specified by its index value or name (use the 'I' or 'N' version +respectively). The Fortran versions of these functions take an +additional first argument, which is an integer which will hold the +return value. + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Do not delete next line |