add comment on generality of patch_system:: ctor

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

1 files changed, 23 insertions, 0 deletions

diff --git a/src/patch/patch_system.hh b/src/patch/patch_system.hh
index a1585fd..5531925 100644
--- a/src/patch/patch_system.hh
+++ b/src/patch/patch_system.hh
@@ -248,10 +248,33 @@ public:
 	int N_gridfns() const { return ith_patch(0).N_gridfns(); }
 
 
+	//
+	// ***** misc stuff *****
+	//
+
+	// set up gridfn data in all ghost zones of all patches
+	// via the appropriate sequence of symmetry operations and
+	// interpatch interpolation
+	void setup_scalar_gridfn_in_all_ghost_zones(int gfn);
+
+	// print a gridfn (via C stdio) in ASCII format
+	// output is assumed to already be open
+	// output format is suitable for gnuplot 'splot'
+	void print_gridfn(int gfn, bool want_ghost_zones,
+			  FILE *output_fp = stdout) const;
+
+
 public:
 	//
 	// ***** constructor, destructor *****
 	//
+	// This constructor doesn't support the full generality of the
+	// patch data structures (which would, eg, allow N_ghost_points
+	// and N_overlap_points and interpolator_order to vary from
+	// ghost zone to ghost zone, and the grid spacings to vary
+	// from patch to patch.  But in practice we'd probably never
+	// use that generality...
+	//
 	patch_system(fp origin_x_in, fp origin_y_in, fp origin_z_in,
 		     enum patch_system_type type_in,
 		     int N_ghost_points, int N_overlap_points,