diff options
Diffstat (limited to 'doc/documentation.tex')
| -rw-r--r-- | doc/documentation.tex | 30 |
1 files changed, 22 insertions, 8 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index 338ca03..f5df214 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -99,9 +99,7 @@ This thorn does processor-local interpolation of N-dimensional data arrays. In general there may be many input arrays (all defined on the same uniform Cartesian grid) all being interpolated to the same set -of interpolation points. At present this thorn only supports the -\verb|CCTK_InterpLocal()| API, but in the near future it will probably be -enhanced to support the newer \verb|CCTK_InterpLocalUniform()| API. +of interpolation points. \end{abstract} % The following sections are suggestive only. @@ -118,11 +116,13 @@ operators "second-order uniform cartesian" "third-order uniform cartesian" \end{verbatim} +for the old Cactus interpolation API \verb|CCTK_InterpLocal()| and +\begin{verbatim} + "uniform cartesian" +\end{verbatim} +for the new Cactus interpolation API \verb|CCTK_InterpLocalUniform()|. It supports 1, 2, and 3-dimensional interpolation. -At present this thorn only supports the \verb|CCTK_InterpLocal()| API, -but in the near future it will probably be enhanced to support the -newer \verb|CCTK_InterpLocalUniform()| API. Although the \verb|CCTK_InterpLocal()| API supports both uniform and nonuniform grids for the input data, the present implementation @@ -130,8 +130,8 @@ assumes a uniform grid (and silently gives wrong results for a nonuniform grid). See the Cactus User's Guide ``Full Description of Functions'' -appendix for a full description of the \verb|CCTK_InterpLocal()| -API, and some examples of how to use it. +appendix for a full description of the \verb|CCTK_InterpLocalUniform()| and +\verb|CCTK_InterpLocal()| APIs, and some examples of how to use it. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -172,6 +172,20 @@ axis.%%% {} See the \verb|README| file in the \verb|src/| directory for further details. +\subsection{Additional information passed in as table options} + +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 +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 +global interpolator) are also recognized but silently ignored (a level-4 warning +message will be issued in this case). + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Do not delete next line |