diff options
| author | jthorn <jthorn@df1f8a13-aa1d-4dd4-9681-27ded5b42416> | 2002-05-12 16:51:53 +0000 |
|---|---|---|
| committer | jthorn <jthorn@df1f8a13-aa1d-4dd4-9681-27ded5b42416> | 2002-05-12 16:51:53 +0000 |
| commit | 841b863a445ba74f856eccfe386692c4c4c91f28 (patch) | |
| tree | 44caf51c216d8ed2d29619c97cc281f02027ea20 /doc/documentation.tex | |
| parent | 161bcb1bb6e259c162f8cbd87307e896f89cf332 (diff) | |
* document that m=0 is always valid
* document FIXME that molecule family querying isn't implemented yet
* add a footnote clarifying that Jacobian_pointer[out] = NULL
supresses the Jacobian query, and explaining why this is often
a good idea
git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/LocalInterp/trunk@26 df1f8a13-aa1d-4dd4-9681-27ded5b42416
Diffstat (limited to 'doc/documentation.tex')
| -rw-r--r-- | doc/documentation.tex | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index 95e3cfc..8e5a333 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -179,6 +179,8 @@ Note that there is no requirement that the output be semantically located at the position \verb|posn|! (This may become clearer once you look at the example in section~\ref{sect-generic-options/Jacobian/fixed-sized-hypercube}.) +However, by convention we do assume that $\verb|m|=0$ is always a valid +\verb|m| coordinate; this simplifies pointer arithmetic. When describing various entries in the parameter table in section~\ref{sect-generic-options}, we use \verb|const| qualifiers @@ -330,6 +332,8 @@ molecule family (\verb|"cube"| for hypercube-shaped molecules%%% we just call them hypercube-shaped instead. }%%% ). +FIXME: this querying isn't implemented yet + If this key is present with a value which is a non-empty string, this sets the molecule family/shape based on that string. @@ -624,7 +628,15 @@ const CCTK_INT Jacobian_m_strides[N_dims]; const CCTK_INT Jacobian_part_stride; /* optional */ \end{verbatim} All the optional entries default to 0 if omitted. -Then for each \verb|out| where \verb|Jacobian_pointer[out] != NULL|, +Then for each \verb|out| where \verb|Jacobian_pointer[out] != NULL|,%%% +\footnote{%%% + That is, setting {\tt Jacobian\_pointer[out] = NULL} + supresses the Jacobian query. If (as is often the + case) the Jacobian is independent of {\tt out}, then + it's a good idea to avoid unnecessary computations by + supressing the queries in this manner for any remaining + output arrays. + }%%% the interpolator would store the Jacobian~\eqref{eqn-Jacobian} in \begin{verbatim} Jacobian_pointer[out][offset |