Address review feedback

sethrj · Mar 15, 2024 · 3a8b084 · 3a8b084
1 parent 72f2a3a
commit 3a8b084
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 17 deletions.
diff --git a/src/orange/orangeinp/ProtoInterface.hh b/src/orange/orangeinp/ProtoInterface.hh
@@ -21,7 +21,7 @@ class GlobalBuilder;
 
 //---------------------------------------------------------------------------//
 /*!
- * Construct a universe for building ORANGE geometry.
+ * Construct a universe as part of an ORANGE geometry.
  *
  * Each Proto (for proto-universe) will result in a unique UniverseId and can
  * be placed into multiple other universes. Each universe has:
@@ -59,7 +59,7 @@ class ProtoInterface
 
   protected:
     //!@{
-    //! Allow construction and assignment only through daughter classes
+    //! Allow construction and assignment only through subclasses
     ProtoInterface() = default;
     virtual ~ProtoInterface() = default;
     CELER_DEFAULT_COPY_MOVE(ProtoInterface);

diff --git a/src/orange/orangeinp/UnitProto.cc b/src/orange/orangeinp/UnitProto.cc
@@ -107,7 +107,9 @@ void UnitProto::build(GlobalBuilder&) const
  * daughters list, which is the same ordering as the array of \c
  * this->daughters().
  *
- * The exterior zorder
+ * The "exterior boundary" argument determines whether the outer boundary needs
+ * to be deleted (assumed inside, implicit from the parent universe's boundary)
+ * or preserved.
  */
 auto UnitProto::build(Tol const& tol, ExteriorBoundary ext) const -> Unit
 {

diff --git a/src/orange/orangeinp/UnitProto.hh b/src/orange/orangeinp/UnitProto.hh
@@ -29,7 +29,7 @@ struct CsgUnit;
 
 //---------------------------------------------------------------------------//
 /*!
- * Construct a "unit" universe.
+ * Construct a general CSG universe, aka a "unit".
  *
  * A "unit" is a region of space (specified by the "boundary" object) that is
  * divided up into multiple smaller regions:
@@ -48,26 +48,26 @@ struct CsgUnit;
  *   Explicit   Interior CSG definition includes boundary (RTK)
  *  ========== ==========================================================
  *
- * Additionally, whether the universe is the top-level *global* universe
- * affects the construction.
+ * Additionally, whether the universe is the top-level \em global universe (see
+ * the \c ExteriorBoundary type) affects the construction.
  *
  *  ========== ==========================================================
- *   Global?    Description
+ *   ExtBound   Description
  *  ========== ==========================================================
- *   No         Boundary is already truncated by higher-level unit
- *   Yes        Boundary must explicitly be represented as a volume
+ *   Daughter   Boundary is already truncated by higher-level unit
+ *   Global     Boundary must explicitly be represented as a volume
  *  ========== ==========================================================
  *
  * These result in different z ordering for the exterior:
  *
- *  === === ================== ========================================
- *   G   P   Result             Description
- *  === === ================== ========================================
- *   N   I  IMPLICIT_EXTERIOR  Higher-level universe truncates
- *   N   X  IMPLICIT_EXTERIOR  Higher-level universe truncates
- *   Y   I  EXTERIOR           Global unit that truncates other regions
- *   Y   X  MEDIA              Global unit with well-connected exterior
- *  === === ================== ========================================
+ *  ===== ===== ================== ========================================
+ *   Inp   ExB   Resulting zorder   Description
+ *  ===== ===== ================== ========================================
+ *   I     N     implicit_exterior  Higher-level universe truncates
+ *   X     N     implicit_exterior  Higher-level universe truncates
+ *   I     Y     exterior           Global unit that truncates other regions
+ *   X     Y     media              Global unit with well-connected exterior
+ *  ===== ===== ================== ========================================
  */
 class UnitProto : public ProtoInterface
 {