summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/UsersGuide/FunctionReference.tex17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/UsersGuide/FunctionReference.tex b/doc/UsersGuide/FunctionReference.tex
index 48d7a7bc..68d09a9f 100644
--- a/doc/UsersGuide/FunctionReference.tex
+++ b/doc/UsersGuide/FunctionReference.tex
@@ -2577,6 +2577,23 @@ A negative return code indicates an error condition:
\end{CCTKFunc}
+% ActiveThorns.c
+\begin{CCTKFunc}{CCTK\_IsThornActive}{Reports whether a thorn was activated in a parameter file}
+\label{CCTK-IsThornActive}
+\function{int}{integer}{istat}
+\argument{const char *}{character*(*)}{thornname}
+\showargs
+\begin{params}
+\parameter{istat}{the return status}
+\parameter{thorname}{the name of the thorn to check}
+\end{params}
+\begin{discussion}
+This function returns a non-zero value if the thorn given by {\it thornname}
+was activated in a parameter file, and zero otherwise.
+\end{discussion}
+\end{CCTKFunc}
+
+
%%%%%
% JJJ
%%%%%