add some comments for broadcast_horizon_data()

git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinAnalysis/AHFinderDirect/trunk@1257 f88db872-0e4f-0410-b76b-b9085cfa78c5

1 files changed, 8 insertions, 4 deletions

diff --git a/src/driver/Newton.cc b/src/driver/Newton.cc
index d400b6d..b1f3ece 100644
--- a/src/driver/Newton.cc
+++ b/src/driver/Newton.cc
@@ -700,8 +700,8 @@ return any_proc_needs_more_iterations;
 
 //
 // This function (which must be called on *every* processor) broadcasts
-// the BH diagnostics and (ghosted) horizon shape from a specified processor
-// to all processors.
+// the BH diagnostics and optionally also the (ghosted) horizon shape,
+// from a specified processor to all processors.
 //
 // The present implementation of this function uses the Cactus reduction
 // API.  If AHFinderDirect is ported to some other software environment,
@@ -712,11 +712,15 @@ return any_proc_needs_more_iterations;
 // GH --> The Cactus grid hierarchy.
 // broadcast_flag = true on the broadcasting processor,
 //		    false on all other processors
+// broadcast_horizon_shape = true to broadcast the (ghosted) horizon shape
+//				  as well as the BH diagnostics
+//			     false to only broadcast the BH diagnostics
 // BH_diagnostics = On the broadcasting processor, this is the BH diagnostics
 //		    to broadcast; on all other processors, it's set to the
 //		    broadcast BH diagnostics.
-// ps = On the broadcasting processor,  gfn__h  is broadcast;
-//      on all other processors,  gfn__h  is set to the broadcast values.
+// ps = Used only if broadcast_horizon_shape; in this case...
+//	On the broadcasting processor,  gfn__h  is broadcast;
+//	on all other processors,  gfn__h  is set to the broadcast values.
 // horizon_buffers = Internal buffers for use in the broadcast;
 //		     if  N_buffer == 0  then we set N_buffer and allocate
 //		     the buffers.