more documentation

git-svn-id: http://svn.aei.mpg.de/numrel/AEIThorns/ADMMass/trunk@46 54511f98-0e4f-0410-826e-eb8b393f5a1e

2 files changed, 44 insertions, 21 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 33c6dd8..9ff69df 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -142,28 +142,51 @@ In practice, the following equation can also be used within the thorn:
 
 \section{Using This Thorn}
 
-\subsection{Basic Usage}
-
-
-
-\subsection{Special Behaviour}
-
-\subsection{Interaction With Other Thorns}
-
-\subsection{Examples}
-
-\subsection{Support and Feedback}
-
-\section{History}
-
-\subsection{Thorn Source Code}
-
-\subsection{Thorn Documentation}
-
-\subsection{Acknowledgements}
-
+Multiple measurements can be done for both volume and surface integral, but the
+limit for both is 100 (change param.ccl if you need more). You need to
+specify the number of integrations with \texttt{ADMMass\_number} (and ADMMass
+will perform both integrations that many times).
+
+Also note that this thorn uses the ADMMacros for derivatives. Thus, converegence
+of results is limited to the order of these derivatives (ADMMacros::spatial\_order).
+
+ADMMass provides several possibilities to specify the (finite) integration domain,
+both for surface and volume integral, which we list in the following:
+
+\begin{itemize}
+ \item Surface Integral (over rectangular domain)
+  \begin{itemize}
+   \item \texttt{ADMMass\_distance\_from\_grid\_boundary}: specifies the distance
+         between the physical domain boundary and the integration domain. If
+         this is set, this fully specifies the domain boundary.
+   \item \texttt{ADMMass\_surface\_distance}: specifies a distance of the integration
+         boundary from a given point, specified using \texttt{ADMMass\_x\_pos[3]}.
+   \item Otherwise, \texttt{ADMMass\_[xyz]\_[min|max]} specify a rectangular
+         integration domain.
+  \end{itemize}
+ \item Volume Integral (over sphere)
+  \begin{itemize}
+   \item If \texttt{ADMMass\_use\_all\_volume\_as\_volume\_radius} is set,
+         the whole volume is used for integration.
+   \item If \texttt{ADMMass\_use\_surface\_distance\_as\_volume\_radius} is set
+         and \texttt{ADMMass\_volume\_radius} is not (negative),
+         \texttt{ADMMass\_surface\_distance} is used to specify the integration
+         radius.
+   \item Otherwise, \texttt{ADMMass\_volume\_radius} specifies this radius.
+   \item \texttt{ADMMass\_[xyz]\_pos} specify the position of the integration
+         sphere.
+   \item Use \texttt{ADMMass\_Excise\_Horizons} to exclude domains where
+         thorn \texttt{OutsideMask} didn't specify domain as \texttt{outside}.
+         This can be used to, e.g. excise black hole apparent horizons.
+  \end{itemize}
+\end{itemize}
+
+You should output \texttt{ADMMass::ADMMass\_Masses} for the result of the
+integrations, which will include the results for the volume integral, the
+usual surface integral and the sorface integral including the lapse.
 
 % Do not delete next line
 % END CACTUS THORNGUIDE
 
 \end{document}
+
diff --git a/param.ccl b/param.ccl
index 9b39caa..f7021c3 100644
--- a/param.ccl
+++ b/param.ccl
@@ -65,7 +65,7 @@ BOOLEAN ADMMass_use_surface_distance_as_volume_radius "Use ADMMass_surface_dista
 {
 } "yes"
 
-BOOLEAN ADMMass_use_all_volume_as_volume_radius "Use ADMMass_distance_from_grid_boundary instead of ADMMass_volume_radius" STEERABLE=ALWAYS
+BOOLEAN ADMMass_use_all_volume_as_volume_radius "Use the whole grid for volume integration" STEERABLE=ALWAYS
 {
 } "no"