aboutsummaryrefslogtreecommitdiff
path: root/doc/documentation.tex
diff options
context:
space:
mode:
authorrideout <rideout@6a38eb6e-646e-4a02-a296-d141613ad6c4>2002-08-29 13:55:02 +0000
committerrideout <rideout@6a38eb6e-646e-4a02-a296-d141613ad6c4>2002-08-29 13:55:02 +0000
commit4de07c7f136d0eae4d3e3f530af17b0647b7c838 (patch)
tree3fe52fc904cd52ca09ffa42f51b1a5c88d6a327a /doc/documentation.tex
parent83fa18f1a0f12565d2ac322d8b324d5a5589f086 (diff)
Cleaned up one "Arguments" section, so that the argument names will
not fall off the left side of the page. We need to agree on how to format these in general. git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/Boundary/trunk@182 6a38eb6e-646e-4a02-a296-d141613ad6c4
Diffstat (limited to 'doc/documentation.tex')
-rw-r--r--doc/documentation.tex31
1 files changed, 14 insertions, 17 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index 9969a73..dfdd351 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -379,43 +379,40 @@ CCTK\_REAL\>limit\\
\end{tabbing}
}
-
-
-
-where
+\subsubsection*{Arguments}
\begin{itemize}
-\item[{\tt integer ierr}] return value, operation failed when return
+\item[{\tt ierr}] return value, operation failed when return
value {\em negative}
-\item[{\tt CCTK\_POINTER cctkGH}] grid hierarchy pointer
-\item[{\tt integer stencil\_size(dim)}] array of size {\tt dim}
+\item[{\tt cctkGH}] grid hierarchy pointer
+\item[{\tt stencil\_size(dim)}] array of size {\tt dim}
(dimension of the gridfunction). To how many points from the outer
boundary to apply the boundary condition.
-\item[{\tt CCTK\_REAL speed}] wave speed used for boundary condition ($v$).
+\item[{\tt speed}] wave speed used for boundary condition ($v$).
-\item[{\tt CCTK\_REAL limit}] asymptotic value of function at infinity
+\item[{\tt limit}] asymptotic value of function at infinity
-\item[{\tt character*(*) variable\_name}] the name of the grid function
+\item[{\tt variable\_name}] the name of the grid function
to which the boundary condition will be applied
-\item[{\tt character*(*) variable\_name\_past}]
+\item[{\tt variable\_name\_past}]
The name of the grid function
containing the values on the past time level, needed to calculate
the boundary condition.
-\item[{\tt character*(*) group\_name}] the name of the group
+\item[{\tt group\_name}] the name of the group
to which the boundary condition will be applied
-\item[{\tt character*(*) group\_name\_past}] is the name of the group
+\item[{\tt group\_name\_past}] is the name of the group
containing the grid functions on the past time level, needed to calculate
the boundary condition.
-\item[{\tt integer variable\_index}] the index of the grid function
+\item[{\tt variable\_index}] the index of the grid function
to which the boundary condition will be applied
-\item[{\tt integer variable\_index\_past}] the index of the grid function
+\item[{\tt variable\_index\_past}] the index of the grid function
containing the values on the past time level, needed to calculate
the boundary condition.
-\item[{\tt integer group\_index}] the index of the group
+\item[{\tt group\_index}] the index of the group
to which the boundary condition will be applied
-\item[{\tt integer group\_index\_past}] the index of the group
+\item[{\tt group\_index\_past}] the index of the group
containing the values on the past time level, needed to calculate
the boundary condition.
\end{itemize}