summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authortradke <tradke@17b73243-c579-4c4c-a9d2-2d5706c11dac>2006-07-06 17:40:22 +0000
committertradke <tradke@17b73243-c579-4c4c-a9d2-2d5706c11dac>2006-07-06 17:40:22 +0000
commit26d6e3b3c0c5176cd762312ea54addc3be498921 (patch)
treef27a1d1dbbd2fa114779481ddb06c469556583f4 /doc
parentf0cf03607c0a19f30a2acefe531942dc49dcbf1d (diff)
Document new overloadable function CCTK_SyncGroupsByDirI() which deprecates
CCTK_SyncGroup(). git-svn-id: http://svn.cactuscode.org/flesh/trunk@4349 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc')
-rw-r--r--doc/UsersGuide/Infrastructure.tex6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/UsersGuide/Infrastructure.tex b/doc/UsersGuide/Infrastructure.tex
index f1445808..ec39aedd 100644
--- a/doc/UsersGuide/Infrastructure.tex
+++ b/doc/UsersGuide/Infrastructure.tex
@@ -102,6 +102,7 @@ the schedule tree.
\begin{tabular}{|l|l|}
\hline {\bf Function} & {\bf Default} \\
\hline {\t CCTK\_SyncGroup} &\\
+ \hline {\t CCTK\_SyncGroupsByDirI} &\\
\hline {\t CCTK\_EnableGroupStorage} &\\
\hline {\t CCTK\_DisableGroupStorage} &\\
\hline {\t CCTK\_EnableGroupComm} &\\
@@ -150,6 +151,7 @@ functions.
\item{} {\tt CCTK\_ArrayGroupSizeB}
\item{} {\tt CCTK\_QueryGroupStorageB}
\item{} {\tt CCTK\_SyncGroup}
+\item{} {\tt CCTK\_SyncGroupsByDirI}
\item{} {\tt CCTK\_EnableGroupComm}
\item{} {\tt CCTK\_DisableGroupComm}
\item{} {\tt CCTK\_Barrier}
@@ -160,6 +162,10 @@ functions.
\item{} {\tt CCTK\_OverloadnProcs}
\end{enumerate}
+The overloadable function {\tt CCTK\_SyncGroup} is deprecated, a driver should
+instead provide a routine to overload the more general function
+{\tt CCTK\_SyncGroupsByDirI}.
+
\section{The GH Extension}
The GH extension is where the driver stores all its grid-dependent information.