From 66866bca3070e6c54423bbfb952dea8602d6f7b9 Mon Sep 17 00:00:00 2001 From: jthorn Date: Fri, 12 Jan 2007 17:36:39 +0000 Subject: document the semantics of CCTK_MyProc(NULL) CCTK_nProcs(NULL) as per the thread starting with http://www.cactuscode.org/old/pipermail/developers/2007-January/005227.html git-svn-id: http://svn.cactuscode.org/flesh/trunk@4399 17b73243-c579-4c4c-a9d2-2d5706c11dac --- doc/ReferenceManual/CCTKReference.tex | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'doc/ReferenceManual') diff --git a/doc/ReferenceManual/CCTKReference.tex b/doc/ReferenceManual/CCTKReference.tex index ace54032..4a46cc88 100644 --- a/doc/ReferenceManual/CCTKReference.tex +++ b/doc/ReferenceManual/CCTKReference.tex @@ -7185,6 +7185,11 @@ The variable name should be in the form \code{::} \begin{discussion} For a single processor run this call will return zero. For multiprocessor runs, this call will return 0 $\leq$ myproc $<$ \code{CCTK\_nProcs(cctkGH)}. + +Calling \code{CCTK\_MyProc(NULL)} is safe (it will not crash). +Current drivers handle this case correctly (i.e.\ \code{CCTK\_MyProc(NULL)} +returns a correct result), but only a ``best effort'' is guaranteed for +future drivers (or future revisions of current drivers). \end{discussion} \begin{examples} \begin{tabular}{@{}p{3cm}cp{11cm}} @@ -7213,6 +7218,11 @@ runs, this call will return 0 $\leq$ myproc $<$ \code{CCTK\_nProcs(cctkGH)}. \end{params} \begin{discussion} For a single processor run this call will return one. + +Calling \code{CCTK\_nProcs(NULL)} is safe (it will not crash). +Current drivers handle this case correctly (i.e.\ \code{CCTK\_nProcs(NULL)} +returns a correct result), but only a ``best effort'' is guaranteed for +future drivers (or future revisions of current drivers). \end{discussion} \begin{examples} \begin{tabular}{@{}p{3cm}cp{11cm}} -- cgit v1.2.3