aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhinder <hinder@c78560ca-4b45-4335-b268-5f3340f3cb52>2012-04-10 08:48:39 +0000
committerhinder <hinder@c78560ca-4b45-4335-b268-5f3340f3cb52>2012-04-10 08:48:39 +0000
commit6d3b2d774e3a2dc1ce0e97e728906ee1e0798948 (patch)
tree55e9306b9911532732c9d2b9d48e808b4615ada3
parent9de4b8a4c43f915fdda1aac73c57399784ad47bd (diff)
Document deprecation of CartGrid3D symmetries
git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/CartGrid3D/trunk@260 c78560ca-4b45-4335-b268-5f3340f3cb52
-rw-r--r--doc/documentation.tex9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index a127ec2..b5419c9 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -30,7 +30,7 @@ coordinate axes.
\section{Specifying the Grid Symmetry}
-You specify the grid symmetry (or lack thereof) with the
+CartGrid3D allows you to specify the grid symmetry (or lack thereof) with the
\verb|grid::domain| parameter:
\begin{description}
\item[{\tt grid::domain = "full"}]\mbox{}\\
@@ -50,6 +50,13 @@ You specify the grid symmetry (or lack thereof) with the
plane.
\end{description}
+Note that the implementation of symmetries in CartGrid3D is
+deprecated, and the SymBase infrastructure should be used instead.
+The above symmetries can be implemented using SymBase and the
+ReflectionSymmetry thorn. Additionally, there are rotational
+symmetries provided by the RotatingSymmetry180 and RotatingSymmetry90
+thorns.
+
In each case except \verb|grid::domain = "full"|, symmetry zones are
introduced just on the ``other side'' of each symmetry grid boundary.
Each symmetry zone has a width (perpendicular to the boundary) of