summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/UsersGuide/Appendices.tex (renamed from doc/UsersGuide/UsersGuide_Part3.tex)4
-rw-r--r--doc/UsersGuide/Infrastructure.tex65
-rw-r--r--doc/UsersGuide/RunningCactus.tex (renamed from doc/UsersGuide/UsersGuide_Part1.tex)0
-rw-r--r--doc/UsersGuide/ThornWriters.tex (renamed from doc/UsersGuide/UsersGuide_Part2.tex)0
-rw-r--r--doc/UsersGuide/UsersGuide.tex9
5 files changed, 73 insertions, 5 deletions
diff --git a/doc/UsersGuide/UsersGuide_Part3.tex b/doc/UsersGuide/Appendices.tex
index 8993af88..095aceee 100644
--- a/doc/UsersGuide/UsersGuide_Part3.tex
+++ b/doc/UsersGuide/Appendices.tex
@@ -132,10 +132,10 @@ protection or scoping class. {\t access} can take the values:
\item{} Allowed {\t parameter types} are
\begin{itemize}
\item{} {\t INTEGER} The specification of parameter values takes
- the form or any number of comma-separated blocks of the form:
+ the form of any number of comma-separated blocks of the form:
{\t
\begin{verbatim}
-[<low-range>][::][<high-range>][::<step>]
+[<low-range>][:[<high-range>][:[<step>]]][::``<range description>'']
\end{verbatim}
}
Where an empty field, or a {\t *} in the place of {\t low-range} or
diff --git a/doc/UsersGuide/Infrastructure.tex b/doc/UsersGuide/Infrastructure.tex
index cc49d543..30b640a7 100644
--- a/doc/UsersGuide/Infrastructure.tex
+++ b/doc/UsersGuide/Infrastructure.tex
@@ -15,15 +15,51 @@
\begin{itemize}
\item{} Main
\begin{itemize}
+\item{} {\t int CCTK\_Initialise(tFleshConfig *)}
+\item{} {\t int CCTK\_Evolve(tFleshConfig *)}
+\item{} {\t int CCTK\_Shutdown(tFleshconfig *)}
+\end{itemize}
+\begin{itemize}
\item{} Defaults
\end{itemize}
\item{} IO
\begin{itemize}
+\item{} {\t int CCTK\_OutputGH(cGH *GH)}
+\item{} {\t int CCTK\_OutputVarAsByMethod(cGH *GH, const char *var,
+ const char *method, const char *alias)}
+\end{itemize}
+\begin{itemize}
\item{} Defaults
+\begin{itemize}
+\item{} {\t CCTK\_OutputGH}
+\item{} {\t CCTK\_OutputVarAsByMethod}
+\end{itemize}
\end{itemize}
\item{} Comm
\begin{itemize}
+\item{} {\t int CCTK\_SyncGroup(cGH *GH, const char *group)}
+\item{} {\t int CCTK\_EnableGroupStorage(cGH *GH, const char *group)}
+\item{} {\t int CCTK\_DisableGroupStorage(cGH *GH, const char *group)}
+\item{} {\t int CCTK\_EnableGroupComm(cGH *GH, const char *group)}
+\item{} {\t int CCTK\_DisableGroupComm(cGH *GH, const char *group)}
+\item{} {\t int CCTK\_Barrier(cGH *GH)}
+\item{} {\t int CCTK\_Reduce(cGH *GH, const char *operation,
+ int n\_infields, int n\_outfields,
+ int out\_type, void **outarray, ...)}
+\item{} {\t int CCTK\_Interp(cGH *GH, const char *operation,
+ int n\_coords, int n\_infields, int n\_outfields,
+ int n\_points, int type, ...)}
+\item{} {\t int CCTK\_ParallelInit(cGH *GH)}
+\item{} {\t int CCTK\_Init(cGH *GH)}
+\item{} {\t int CCTK\_Exit(cGH *GH)}
+\item{} {\t int CCTK\_Abort(cGH *GH)}
+\item{} {\t cGH *CCTK\_SetupGH(tFleshConfig *config, int convergence\_level)}
+\end{itemize}
+\begin{itemize}
\item{} Defaults
+\begin{itemize}
+\item{} {\t CCTK\_SetupGH}
+\end{itemize}
\end{itemize}
\end{itemize}
\item{} Registerable Functions in the F***h
@@ -42,5 +78,34 @@
\end{itemize}
\end{itemize}
\item{} Utility Routines
+\begin{itemize}
+\item{} CCTK\_GetNGroups
+\item{} CCTK\_GetNVariables
+\item{} CCTK\_GetMaxDim
+\item{} CCTK\_GetVariableNumber
+\item{} CCTK\_GetGroupNumber
+\item{} CCTK\_GetGHExtensionHandle
+\item{} CCTK\_GetHandleName
+\item{} CCTK\_GetHandle
+\item{} CCTK\_GetHandledData
+\item{} CCTK\_GetVarName
+\item{} CCTK\_GetGroupData
+\item{} CCTK\_GetNumGroups
+\item{} CCTK\_GetNumVars
+\item{} CCTK\_GetGroupNum
+\item{} CCTK\_GetVarNum
+\item{} int CCTK\_SplitString(char **before, char **after, const char *string, const char *sep);
+\item{} int CCTK\_Equals(const char *string1, const char *string2);
+\item{} int CCTK\_InList(const char *string1, int n\_elements, ...);
+\item{} int CCTK\_IntInRange(int inval, const char *range);
+\item{} int CCTK\_DoubleInRange(double inval, const char *range);
+\item{} int CCTK\_IntInRangeList(int inval, int n\_elements, ...);
+\item{} int CCTK\_DoubleInRangeList(double inval, int n\_elements, ...);
+\item{} int CCTK\_SetDoubleInRangeList(double *data, const char *value,
+\item{} int CCTK\_SetIntInRangeList(int *data, const char *value,
+\item{} int CCTK\_SetKeywordInRangeList(char **data, const char *value,
+\item{} int CCTK\_SetString(char **data, const char *value);
+\item{} int CCTK\_SetLogical(int *data, const char *value);
+\end{itemize}
\end{itemize}
\end{enumerate}
diff --git a/doc/UsersGuide/UsersGuide_Part1.tex b/doc/UsersGuide/RunningCactus.tex
index 9434963b..9434963b 100644
--- a/doc/UsersGuide/UsersGuide_Part1.tex
+++ b/doc/UsersGuide/RunningCactus.tex
diff --git a/doc/UsersGuide/UsersGuide_Part2.tex b/doc/UsersGuide/ThornWriters.tex
index fe4dfb99..fe4dfb99 100644
--- a/doc/UsersGuide/UsersGuide_Part2.tex
+++ b/doc/UsersGuide/ThornWriters.tex
diff --git a/doc/UsersGuide/UsersGuide.tex b/doc/UsersGuide/UsersGuide.tex
index 09431d03..648274f7 100644
--- a/doc/UsersGuide/UsersGuide.tex
+++ b/doc/UsersGuide/UsersGuide.tex
@@ -27,11 +27,14 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\include{UsersGuide_Part1}
+\include{RunningCactus}
-\include{UsersGuide_Part2}
+\include{ThornWriters}
+
+\include{Infrastructure}
+
+\include{Appendices}
-\include{UsersGuide_Part3}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%