Skip to content

Commit e054d96

Browse files
tdixon97Copilot
andcommitted
Update include/RMGVertexConfinement.hh
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 9c18fbf commit e054d96

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

include/RMGVertexConfinement.hh

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,12 @@ class RMGVertexConfinement : public RMGVVertexGenerator {
103103
* - **Uniform**: flat distribution over a user-defined range.
104104
*
105105
* @note The depth profile is applied in the local coordinate system of the solid before
106-
* the global rotation and translation are applied. No containment check is performed
107-
* after the displacement; the user is responsible for choosing parameters consistent
108-
* with the solid geometry.
106+
* the global rotation and translation are applied. By default, no containment
107+
* enforcement is performed after the displacement; the user is responsible for
108+
* choosing parameters consistent with the solid geometry. When
109+
* @c ForceContainmentCheck is enabled, an additional containment check may be
110+
* performed after applying the depth offset, but this is used only for logging or
111+
* diagnostic purposes and does not trigger resampling or correction of the vertex.
109112
*/
110113
struct DepthProfile {
111114

0 commit comments

Comments
 (0)