diff options
author | jthorn <jthorn@f88db872-0e4f-0410-b76b-b9085cfa78c5> | 2001-07-17 13:06:00 +0000 |
---|---|---|
committer | jthorn <jthorn@f88db872-0e4f-0410-b76b-b9085cfa78c5> | 2001-07-17 13:06:00 +0000 |
commit | 7ad5116005eea1389e998302cdbbd1b8772db98d (patch) | |
tree | 0edfa3f34301d0cf6c89c029d9beab0dd57367ee /src/patch | |
parent | e9f98f912f0d686ec87ed5873899b0888ce0c6af (diff) |
expand comments on setup_*_ghost_zone(), setup_patch_frontier()
git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinAnalysis/AHFinderDirect/trunk@208 f88db872-0e4f-0410-b76b-b9085cfa78c5
Diffstat (limited to 'src/patch')
-rw-r--r-- | src/patch/patch.cc | 17 | ||||
-rw-r--r-- | src/patch/patch.hh | 11 |
2 files changed, 18 insertions, 10 deletions
diff --git a/src/patch/patch.cc b/src/patch/patch.cc index cc8239c..67705ee 100644 --- a/src/patch/patch.cc +++ b/src/patch/patch.cc @@ -272,8 +272,9 @@ return static_cast<interpatch_ghost_zone &>(g); //****************************************************************************** // -// This function sets up a mirror-symmetry ghost zone of this patch. -// (It assert()s that this ghost zone hasn't already been set up.) +// This function assert()s that a specified ghost zone of this patch +// hasn't already been set up, then sets it up as a mirror-symmetry +// ghost zone. // symmetry_ghost_zone& patch::setup_mirror_symmetry_ghost_zone (const patch_edge& my_edge) @@ -289,8 +290,9 @@ return *temp; //****************************************************************************** // -// This function sets up a periodic-symmetry ghost zone of this patch. -// (It assert()s that this ghost zone hasn't already been set up.) +// This function assert()s that a specified ghost zone of this patch +// hasn't already been set up, then sets it up as a periodic-symmetry +// ghost zone. // symmetry_ghost_zone& patch::setup_periodic_symmetry_ghost_zone (const patch_edge& my_edge, const patch_edge& symmetry_edge, @@ -317,7 +319,9 @@ return *temp; //****************************************************************************** // -// This function sets up an interpatch ghost zone of this patch. +// This function assert()s that a specified ghost zone of this patch +// hasn't already been set up, then sets it up as an interpatch ghost +// zone. // interpatch_ghost_zone& patch::setup_interpatch_ghost_zone (const patch_edge& my_edge, const patch_edge& other_edge) @@ -352,7 +356,8 @@ my_gzp = gzp; //****************************************************************************** // -// This function sets up a patch frontier of this patch. +// This function assert()s that a specified frontier of this patch +// hasn't already been set up, then sets it up. // patch_frontier& patch::setup_patch_frontier(const patch_edge& my_edge, int min_iperp_in, int max_iperp_in, diff --git a/src/patch/patch.hh b/src/patch/patch.hh index 229c365..6bfc326 100644 --- a/src/patch/patch.hh +++ b/src/patch/patch.hh @@ -289,25 +289,28 @@ public: // ***** set up ghost zone and frontier subobjects // - // set up one of our ghost zones as mirror-symmetry + // assert() that this ghost zone hasn't been set up yet, + // then set it up as mirror-symmetry // ... return reference to new ghost zone symmetry_ghost_zone& setup_mirror_symmetry_ghost_zone (const patch_edge& edge); - // set up one of our ghost zones as periodic-symmetry + // assert() that this ghost zone hasn't been set up yet, + // then set it up as periodic-symmetry // ... return reference to new ghost zone symmetry_ghost_zone& setup_periodic_symmetry_ghost_zone (const patch_edge& my_edge, const patch_edge& symmetry_edge, bool ipar_map_sign); // one of cpm_map::{plus,minus}_map - // set up one of our ghost zones as interpatch + // assert() that this ghost zone hasn't been set up yet, + // then set it up as interpatch // ... but don't link it to the other patch's frontier // (which doesn't exist yet) // ... return reference to new ghost zone interpatch_ghost_zone& setup_interpatch_ghost_zone (const patch_edge& my_edge, const patch_edge& other_edge); - // set up one of our patch frontiers + // assert() that this frontier hasn't been set up yet, then set it up // ... return reference to new frontier patch_frontier& setup_patch_frontier(const patch_edge& my_edge_in, int min_iperp_in, int max_iperp_in, |