add comments clarifying semantics of Kerr_KerrSchild__boost_v parameter

git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinInitialData/Exact/trunk@112 e296648e-0e4f-0410-bd07-d597d9acff87

1 files changed, 3 insertions, 1 deletions

diff --git a/param.ccl b/param.ccl
index dbc906e..cdde987 100644
--- a/param.ccl
+++ b/param.ccl
@@ -365,7 +365,9 @@ REAL Kerr_BoyerLindquist__mass "Kerr/Boyer-Lindquist: BH mass"
 # parameters for Kerr metric in Kerr-Schild coordinates
 #
 
-REAL Kerr_KerrSchild__boost_v "Kerr/Kerr-Schild: boost velocity of black hole"
+# the black hole is boosted in the z direction with this velocity,
+# i.e. the black hole is located at x=0, y=0, and z=vt
+REAL Kerr_KerrSchild__boost_v "Kerr/Kerr-Schild: boost velocity of black hole in z direction"
 {
 (-1:1)  ::  "any real number with absolute value < 1"
 } 0.0