diff options
author | jthorn <jthorn@df1f8a13-aa1d-4dd4-9681-27ded5b42416> | 2004-06-27 11:00:14 +0000 |
---|---|---|
committer | jthorn <jthorn@df1f8a13-aa1d-4dd4-9681-27ded5b42416> | 2004-06-27 11:00:14 +0000 |
commit | 4205b12215fb4b1a1d7ff93656b603e624f0b6ed (patch) | |
tree | 4b596e30e6892d15c221c64569f2eeb8de8b40f4 | |
parent | 2240036087871e5ce61ec90a9655e09c81daaf19 (diff) |
* refer to the Cactus Reference Manual for API documentation
* a few other small tweaks
git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/LocalInterp/trunk@186 df1f8a13-aa1d-4dd4-9681-27ded5b42416
-rw-r--r-- | doc/documentation.tex | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index 8d4da84..1d78fcb 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -116,11 +116,10 @@ operator \end{verbatim} for the Cactus local interpolation API \verb|CCTK_InterpLocalUniform()|. (Note that the word ``{\tt cartesian}'' is in lower case here!) - It supports 1, 2, and 3-dimensional interpolation. -See the Cactus User's Guide ``Full Description of Functions'' -appendix for a full description of the \verb|CCTK_InterpLocalUniform()| API, +See the Cactus Reference Manual +for a full description of the \verb|CCTK_InterpLocalUniform()| API, and some examples of how to use it. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -168,11 +167,11 @@ The \verb|CCTK_InterpLocalUniform()| API accepts a table handle as one of its arguments which can be used to pass additional information to the local interpolator via table options. -The only table option supported so far by {\bf LocalInterp}'s {\it "uniform +The only table option supported so far by {\bf LocalInterp}'s {\tt "uniform cartesian"} operator is the interpolation order which must be -passed as a CCTK\_INT value with key {\it "order"}. Options with keys -{\it "N\_boundary\_points\_to\_omit", "boundary\_off\_centering\_tolerance"}, or -{\it "boundary\_extrapolation\_tolerance"} (which are usually past by a +passed as a CCTK\_INT value with key {\tt "order"}. Options with keys +{\tt "N\_boundary\_points\_to\_omit", "boundary\_off\_centering\_tolerance"}, or +{\tt "boundary\_extrapolation\_tolerance"} (which are usually passed by a global interpolator) are also recognized but silently ignored (a level-4 warning message will be issued in this case). |