Skip to content

Commit 38608bb

Browse files
committed
[algorithm] Rewrite some comments
1 parent 69ded04 commit 38608bb

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

src/CollisionAlgorithm/algorithm/InsertionAlgorithm.h

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
#include <CollisionAlgorithm/BaseAlgorithm.h>
44
#include <CollisionAlgorithm/BaseGeometry.h>
55
#include <CollisionAlgorithm/BaseOperation.h>
6+
#include <CollisionAlgorithm/operations/ContainsPoint.h>
67
#include <CollisionAlgorithm/operations/CreateCenterProximity.h>
78
#include <CollisionAlgorithm/operations/FindClosestProximity.h>
8-
#include <CollisionAlgorithm/operations/Project.h>
9-
#include <CollisionAlgorithm/operations/ContainsPoint.h>
109
#include <CollisionAlgorithm/operations/NeedleOperations.h>
10+
#include <CollisionAlgorithm/operations/Project.h>
1111
#include <CollisionAlgorithm/proximity/EdgeProximity.h>
1212
#include <sofa/component/constraint/lagrangian/solver/ConstraintSolverImpl.h>
1313
#include <sofa/component/statecontainer/MechanicalObject.h>
@@ -128,7 +128,7 @@ class InsertionAlgorithm : public BaseAlgorithm
128128

129129
if (m_couplingPts.empty())
130130
{
131-
// 1. Puncture algorithm
131+
// Puncture sequence
132132
auto createTipProximity =
133133
Operations::CreateCenterProximity::Operation::get(l_tipGeom->getTypeInfo());
134134
auto findClosestProxOnSurf =
@@ -147,7 +147,7 @@ class InsertionAlgorithm : public BaseAlgorithm
147147
{
148148
surfProx->normalize();
149149

150-
// 1.1 Check whether puncture is happening - if so, create coupling point
150+
// Check whether puncture is happening - if so, create coupling point ...
151151
if (m_constraintSolver)
152152
{
153153
const MechStateTipType::SPtr mstate =
@@ -171,7 +171,7 @@ class InsertionAlgorithm : public BaseAlgorithm
171171
}
172172
}
173173

174-
// 1.3 Collision with the shaft geometry
174+
// Shaft collision sequence - Disable if coupling points have been added
175175
if (m_couplingPts.empty())
176176
{
177177
auto createShaftProximity =
@@ -187,7 +187,6 @@ class InsertionAlgorithm : public BaseAlgorithm
187187
{
188188
surfProx->normalize();
189189

190-
// 1.2 If not, create a proximity pair for the tip-surface collision
191190
if (d_projective.getValue())
192191
{
193192
shaftProx =
@@ -202,7 +201,7 @@ class InsertionAlgorithm : public BaseAlgorithm
202201
}
203202
else
204203
{
205-
// 2. Needle insertion algorithm
204+
// Insertion sequence
206205
ElementIterator::SPtr itTip = l_tipGeom->begin();
207206
auto createTipProximity =
208207
Operations::CreateCenterProximity::Operation::get(itTip->getTypeInfo());
@@ -303,7 +302,7 @@ class InsertionAlgorithm : public BaseAlgorithm
303302

304303
if (!m_couplingPts.empty())
305304
{
306-
// 3. Re-project proximities on the shaft geometry
305+
// Reprojection on shaft geometry sequence
307306
auto findClosestProxOnShaft =
308307
Operations::FindClosestProximity::Operation::get(l_shaftGeom);
309308
auto projectOnShaft = Operations::Project::Operation::get(l_shaftGeom);

0 commit comments

Comments
 (0)