diff --git a/Sofa/Component/AnimationLoop/src/sofa/component/animationloop/ConstraintAnimationLoop.cpp b/Sofa/Component/AnimationLoop/src/sofa/component/animationloop/ConstraintAnimationLoop.cpp index e21cf208560..3557cbf51cd 100644 --- a/Sofa/Component/AnimationLoop/src/sofa/component/animationloop/ConstraintAnimationLoop.cpp +++ b/Sofa/Component/AnimationLoop/src/sofa/component/animationloop/ConstraintAnimationLoop.cpp @@ -218,7 +218,7 @@ ConstraintAnimationLoop::ConstraintAnimationLoop() : , d_tol( initData(&d_tol, 0.00001_sreal, "tolerance", "Tolerance of the Gauss-Seidel")) , d_maxIt( initData(&d_maxIt, 1000, "maxIterations", "Maximum number of iterations of the Gauss-Seidel")) , d_doCollisionsFirst(initData(&d_doCollisionsFirst, false, "doCollisionsFirst","Compute the collisions first (to support penality-based contacts)")) - , d_doubleBuffer( initData(&d_doubleBuffer, false, "doubleBuffer","Buffer the constraint problem in a doublebuffer to be accessible with an other thread")) + , d_doubleBuffer( initData(&d_doubleBuffer, false, "doubleBuffer","Double the buffer dedicated to the constraint problem to make it accessible to another thread")) , d_scaleTolerance( initData(&d_scaleTolerance, true, "scaleTolerance","Scale the error tolerance with the number of constraints")) , d_allVerified( initData(&d_allVerified, false, "allVerified","All contraints must be verified (each constraint's error < tolerance)")) , d_sor( initData(&d_sor, 1.0_sreal, "sor","Successive Over Relaxation parameter (0-2)")) diff --git a/Sofa/Component/AnimationLoop/src/sofa/component/animationloop/ConstraintAnimationLoop.h b/Sofa/Component/AnimationLoop/src/sofa/component/animationloop/ConstraintAnimationLoop.h index 47c7fa3b9b0..cd07f88876b 100644 --- a/Sofa/Component/AnimationLoop/src/sofa/component/animationloop/ConstraintAnimationLoop.h +++ b/Sofa/Component/AnimationLoop/src/sofa/component/animationloop/ConstraintAnimationLoop.h @@ -112,7 +112,7 @@ class SOFA_COMPONENT_ANIMATIONLOOP_API ConstraintAnimationLoop : public sofa::si Data d_tol; ///< Tolerance of the Gauss-Seidel Data d_maxIt; ///< Maximum number of iterations of the Gauss-Seidel Data d_doCollisionsFirst; ///< Compute the collisions first (to support penality-based contacts) - Data d_doubleBuffer; ///< Buffer the constraint problem in a SReal buffer to be accessible with an other thread + Data d_doubleBuffer; ///< Double the buffer dedicated to the constraint problem to make it accessible to another thread Data d_scaleTolerance; ///< Scale the error tolerance with the number of constraints Data d_allVerified; ///< All contraints must be verified (each constraint's error < tolerance) Data d_sor; ///< Successive Over Relaxation parameter (0-2) diff --git a/Sofa/Component/AnimationLoop/src/sofa/component/animationloop/FreeMotionAnimationLoop.h b/Sofa/Component/AnimationLoop/src/sofa/component/animationloop/FreeMotionAnimationLoop.h index ae3b5470449..abb53dcd9cb 100644 --- a/Sofa/Component/AnimationLoop/src/sofa/component/animationloop/FreeMotionAnimationLoop.h +++ b/Sofa/Component/AnimationLoop/src/sofa/component/animationloop/FreeMotionAnimationLoop.h @@ -48,8 +48,8 @@ class SOFA_COMPONENT_ANIMATIONLOOP_API FreeMotionAnimationLoop : public sofa::si Data d_solveVelocityConstraintFirst; ///< solve separately velocity constraint violations before position constraint violations Data d_threadSafeVisitor; ///< If true, do not use realloc and free visitors in fwdInteractionForceField. - Data d_parallelCollisionDetectionAndFreeMotion; /// d_parallelODESolving; /// d_parallelCollisionDetectionAndFreeMotion; ///< If true, executes free motion step and collision detection step in parallel. + Data d_parallelODESolving; ///< If true, solves all the ODEs in parallel during the free motion step. protected: FreeMotionAnimationLoop(); diff --git a/Sofa/Component/Collision/Detection/Algorithm/src/sofa/component/collision/detection/algorithm/BruteForceBroadPhase.h b/Sofa/Component/Collision/Detection/Algorithm/src/sofa/component/collision/detection/algorithm/BruteForceBroadPhase.h index b03f4b2d2d6..85493681477 100644 --- a/Sofa/Component/Collision/Detection/Algorithm/src/sofa/component/collision/detection/algorithm/BruteForceBroadPhase.h +++ b/Sofa/Component/Collision/Detection/Algorithm/src/sofa/component/collision/detection/algorithm/BruteForceBroadPhase.h @@ -52,7 +52,7 @@ class SOFA_COMPONENT_COLLISION_DETECTION_ALGORITHM_API BruteForceBroadPhase : pu SOFA_ATTRIBUTE_DEPRECATED__RENAME_DATA_IN_COLLISION_DETECTION_ALGORITHM() Data > box; - Data > d_box; + Data > d_box; ///< if not empty, objects that do not intersect this bounding-box will be ignored public: diff --git a/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/BaseProximityIntersection.cpp b/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/BaseProximityIntersection.cpp index faad75690a6..056a0882979 100644 --- a/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/BaseProximityIntersection.cpp +++ b/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/BaseProximityIntersection.cpp @@ -27,7 +27,7 @@ namespace sofa::component::collision::detection::intersection using namespace sofa::component::collision::geometry; BaseProximityIntersection::BaseProximityIntersection() - : d_alarmDistance(initData(&d_alarmDistance, 1.0_sreal, "alarmDistance", "Proximity detection distance")) + : d_alarmDistance(initData(&d_alarmDistance, 1.0_sreal, "alarmDistance", "Distance above which the intersection computations ignores the promixity pair. This distance can also be used in some broad phase algorithms to reduce the search area")) , d_contactDistance(initData(&d_contactDistance, 0.5_sreal, "contactDistance", "Distance below which a contact is created")) { d_alarmDistance.setRequired(true); diff --git a/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/BaseProximityIntersection.h b/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/BaseProximityIntersection.h index 228afd00ab5..f23d1f94c9c 100644 --- a/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/BaseProximityIntersection.h +++ b/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/BaseProximityIntersection.h @@ -44,7 +44,7 @@ class SOFA_COMPONENT_COLLISION_DETECTION_INTERSECTION_API BaseProximityIntersect Data contactDistance; - Data d_alarmDistance; ///< Proximity detection distance + Data d_alarmDistance; ///< Distance above which the intersection computations ignores the promixity pair. This distance can also be used in some broad phase algorithms to reduce the search area Data d_contactDistance; ///< Distance below which a contact is created protected: BaseProximityIntersection(); diff --git a/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/LocalMinDistance.cpp b/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/LocalMinDistance.cpp index b27302c66b4..eea2525f72a 100644 --- a/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/LocalMinDistance.cpp +++ b/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/LocalMinDistance.cpp @@ -55,14 +55,12 @@ LocalMinDistance::LocalMinDistance() , d_filterIntersection(initData(&d_filterIntersection, true, "filterIntersection", "Activate LMD filter")) , d_angleCone(initData(&d_angleCone, 0.0, "angleCone", "Filtering cone extension angle")) , d_coneFactor(initData(&d_coneFactor, 0.5, "coneFactor", "Factor for filtering cone angle computation")) - , d_useLMDFilters(initData(&d_useLMDFilters, false, "useLMDFilters", "Use external cone computation (Work in Progress)")) + , d_useLMDFilters(initData(&d_useLMDFilters, false, "useLMDFilters", "Use external cone computation")) { filterIntersection.setParent(&d_filterIntersection); angleCone.setParent(&d_angleCone); coneFactor.setParent(&d_coneFactor); useLMDFilters.setParent(&d_useLMDFilters); - - } void LocalMinDistance::init() diff --git a/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/LocalMinDistance.h b/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/LocalMinDistance.h index ff0aeaf8475..15b4588da10 100644 --- a/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/LocalMinDistance.h +++ b/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/LocalMinDistance.h @@ -77,7 +77,7 @@ class SOFA_COMPONENT_COLLISION_DETECTION_INTERSECTION_API LocalMinDistance : pub Data d_filterIntersection; ///< Activate LMD filter Data d_angleCone; ///< Filtering cone extension angle Data d_coneFactor; ///< Factor for filtering cone angle computation - Data d_useLMDFilters; ///< Use external cone computation (Work in Progress) + Data d_useLMDFilters; ///< Use external cone computation protected: LocalMinDistance(); diff --git a/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/MinProximityIntersection.cpp b/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/MinProximityIntersection.cpp index 60d80ab3fb0..2986ebdd5c7 100644 --- a/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/MinProximityIntersection.cpp +++ b/Sofa/Component/Collision/Detection/Intersection/src/sofa/component/collision/detection/intersection/MinProximityIntersection.cpp @@ -56,7 +56,6 @@ MinProximityIntersection::MinProximityIntersection() useLinePoint.setParent(&d_useLinePoint); useLineLine.setParent(&d_useLineLine); useSurfaceNormals.setParent(&d_useSurfaceNormals); - } void MinProximityIntersection::init() diff --git a/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/LineModel.h b/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/LineModel.h index bd126e61663..28ce9f9e09e 100644 --- a/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/LineModel.h +++ b/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/LineModel.h @@ -145,7 +145,7 @@ public : Data bothSide; - Data d_bothSide; ///< to activate collision on both-side of the both side of the line model (when surface normals are defined on these lines) + Data d_bothSide; ///< activate collision on both side of the line model (when surface normals are defined on these lines) /// Pre-construction check method called by ObjectFactory. /// Check that DataTypes matches the MechanicalState. diff --git a/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/PointModel.h b/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/PointModel.h index 965f53bce80..81914e538c8 100644 --- a/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/PointModel.h +++ b/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/PointModel.h @@ -105,7 +105,7 @@ class PointCollisionModel : public core::CollisionModel Data bothSide; - Data d_bothSide; ///< to activate collision on both side of the point model (when surface normals are defined on these points) + Data d_bothSide; ///< activate collision on both side of the point model (when surface normals are defined on these points) /// Pre-construction check method called by ObjectFactory. /// Check that DataTypes matches the MechanicalState. diff --git a/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/RayModel.h b/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/RayModel.h index f71c33c6fbf..65709ca93fe 100644 --- a/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/RayModel.h +++ b/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/RayModel.h @@ -99,7 +99,7 @@ class SOFA_COMPONENT_COLLISION_GEOMETRY_API RayCollisionModel : public core::Col - Data d_defaultLength; + Data d_defaultLength; ///< The default length for all rays in this collision model std::set contacts; core::behavior::MechanicalState* mstate; diff --git a/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/SphereModel.h b/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/SphereModel.h index 0ca4b518bf0..2fb8d733930 100644 --- a/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/SphereModel.h +++ b/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/SphereModel.h @@ -165,7 +165,7 @@ class SphereCollisionModel : public core::CollisionModel Data defaultRadius; Data< VecReal > d_radius; ///< Radius of each sphere - Data< SReal > d_defaultRadius; ///< Default Radius + Data< SReal > d_defaultRadius; ///< Default radius Data< bool > d_showImpostors; ///< Draw spheres as impostors instead of "real" spheres diff --git a/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/SphereModel.inl b/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/SphereModel.inl index 975f2897c88..dedd65f2e31 100644 --- a/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/SphereModel.inl +++ b/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/SphereModel.inl @@ -34,7 +34,7 @@ namespace sofa::component::collision::geometry template SphereCollisionModel::SphereCollisionModel() : d_radius(initData(&d_radius, "listRadius", "Radius of each sphere")) - , d_defaultRadius(initData(&d_defaultRadius, (SReal)(1.0), "radius", "Default Radius")) + , d_defaultRadius(initData(&d_defaultRadius, (SReal)(1.0), "radius", "Default radius")) , d_showImpostors(initData(&d_showImpostors, true, "showImpostors", "Draw spheres as impostors instead of \"real\" spheres")) , mstate(nullptr) { @@ -47,7 +47,7 @@ SphereCollisionModel::SphereCollisionModel() template SphereCollisionModel::SphereCollisionModel(core::behavior::MechanicalState* _mstate ) : d_radius(initData(&d_radius, "listRadius", "Radius of each sphere")) - , d_defaultRadius(initData(&d_defaultRadius, (SReal)(1.0), "radius", "Default Radius. (default=1.0)")) + , d_defaultRadius(initData(&d_defaultRadius, (SReal)(1.0), "radius", "Default radius")) , d_showImpostors(initData(&d_showImpostors, true, "showImpostors", "Draw spheres as impostors instead of \"real\" spheres")) , mstate(_mstate) { diff --git a/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/TriangleModel.h b/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/TriangleModel.h index fa696451de2..a7fdbc1ce51 100644 --- a/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/TriangleModel.h +++ b/Sofa/Component/Collision/Geometry/src/sofa/component/collision/geometry/TriangleModel.h @@ -135,7 +135,7 @@ class TriangleCollisionModel : public core::CollisionModel enum { NBARY = 2 }; - Data d_bothSide; ///< to activate collision on both side of the triangle model + Data d_bothSide; ///< activate collision on both side of the triangle model Data d_computeNormals; ///< set to false to disable computation of triangles normal Data d_useCurvature; ///< use the curvature of the mesh to avoid some self-intersection test diff --git a/Sofa/Component/Collision/Response/Contact/src/sofa/component/collision/response/contact/CollisionResponse.h b/Sofa/Component/Collision/Response/Contact/src/sofa/component/collision/response/contact/CollisionResponse.h index 4dcd7e77670..16cde7b9d8c 100644 --- a/Sofa/Component/Collision/Response/Contact/src/sofa/component/collision/response/contact/CollisionResponse.h +++ b/Sofa/Component/Collision/Response/Contact/src/sofa/component/collision/response/contact/CollisionResponse.h @@ -44,7 +44,7 @@ public : Data d_response; ///< contact response class - Data d_responseParams; ///< contact response parameters (syntax: name1=value1 Data responseParams;name2=value2 Data responseParams;...) + Data d_responseParams; ///< contact response parameters (syntax: name1=value1&name2=value2&...) /// outputsVec fixes the reproducibility problems by storing contacts in the collision detection saved order /// if not given, it is still working but with eventual reproducibility problems diff --git a/Sofa/Component/Constraint/Lagrangian/Correction/src/sofa/component/constraint/lagrangian/correction/GenericConstraintCorrection.h b/Sofa/Component/Constraint/Lagrangian/Correction/src/sofa/component/constraint/lagrangian/correction/GenericConstraintCorrection.h index 56ce5b8127f..0cb4295d470 100644 --- a/Sofa/Component/Constraint/Lagrangian/Correction/src/sofa/component/constraint/lagrangian/correction/GenericConstraintCorrection.h +++ b/Sofa/Component/Constraint/Lagrangian/Correction/src/sofa/component/constraint/lagrangian/correction/GenericConstraintCorrection.h @@ -61,7 +61,7 @@ class SOFA_COMPONENT_CONSTRAINT_LAGRANGIAN_CORRECTION_API GenericConstraintCorre SingleLink l_linearSolver; ///< Link towards the linear solver used to compute the compliance matrix, requiring the inverse of the linear system matrix SingleLink l_ODESolver; ///< Link towards the ODE solver used to recover the integration factors - Data< SReal > d_complianceFactor; ///< Factor applied to the position factor and velocity factor used to calculate compliance matrix. + Data< SReal > d_complianceFactor; ///< Factor applied to the position factor and velocity factor used to calculate compliance matrix protected: GenericConstraintCorrection(); diff --git a/Sofa/Component/Constraint/Lagrangian/Correction/src/sofa/component/constraint/lagrangian/correction/UncoupledConstraintCorrection.h b/Sofa/Component/Constraint/Lagrangian/Correction/src/sofa/component/constraint/lagrangian/correction/UncoupledConstraintCorrection.h index dc371afdd6b..41f1a897188 100644 --- a/Sofa/Component/Constraint/Lagrangian/Correction/src/sofa/component/constraint/lagrangian/correction/UncoupledConstraintCorrection.h +++ b/Sofa/Component/Constraint/Lagrangian/Correction/src/sofa/component/constraint/lagrangian/correction/UncoupledConstraintCorrection.h @@ -119,7 +119,7 @@ class UncoupledConstraintCorrection : public sofa::core::behavior::ConstraintCor SOFA_ATTRIBUTE_DEPRECATED__RENAME_DATA_IN_CONSTRAINT_LAGRANGIAN_CORRECTION() Data f_verbose; - core::topology::PointData< VecReal > d_compliance; ///< Rigid compliance value: 1st value for translations, 6 others for upper-triangular part of symmetric 3x3 rotation compliance matrix + core::topology::PointData< VecReal > d_compliance; ///< Compliance value on each dof. If Rigid compliance (7 values): 1st value for translations, 6 others for upper-triangular part of symmetric 3x3 rotation compliance matrix Data< Real > d_defaultCompliance; ///< Default compliance value for new dof or if all should have the same (in which case compliance vector should be empty) diff --git a/Sofa/Component/Constraint/Lagrangian/Correction/src/sofa/component/constraint/lagrangian/correction/UncoupledConstraintCorrection.inl b/Sofa/Component/Constraint/Lagrangian/Correction/src/sofa/component/constraint/lagrangian/correction/UncoupledConstraintCorrection.inl index fb2a56bbb7c..5a41ba57013 100644 --- a/Sofa/Component/Constraint/Lagrangian/Correction/src/sofa/component/constraint/lagrangian/correction/UncoupledConstraintCorrection.inl +++ b/Sofa/Component/Constraint/Lagrangian/Correction/src/sofa/component/constraint/lagrangian/correction/UncoupledConstraintCorrection.inl @@ -102,7 +102,7 @@ inline sofa::defaulttype::RigidDeriv<3, Real> UncoupledConstraintCorrection_comp template UncoupledConstraintCorrection::UncoupledConstraintCorrection(sofa::core::behavior::MechanicalState *mm) : Inherit(mm) - , d_compliance(initData(&d_compliance, "compliance", "compliance value on each dof. If Rigid compliance (7 values): 1st value for translations, 6 others for upper-triangular part of symmetric 3x3 rotation compliance matrix")) + , d_compliance(initData(&d_compliance, "compliance", "Compliance value on each dof. If Rigid compliance (7 values): 1st value for translations, 6 others for upper-triangular part of symmetric 3x3 rotation compliance matrix")) , d_defaultCompliance(initData(&d_defaultCompliance, (Real)0.00001, "defaultCompliance", "Default compliance value for new dof or if all should have the same (in which case compliance vector should be empty)")) , d_verbose(initData(&d_verbose, false, "verbose", "Dump the constraint matrix at each iteration") ) , d_correctionVelocityFactor(initData(&d_correctionVelocityFactor, (Real)1.0, "correctionVelocityFactor", "Factor applied to the constraint forces when correcting the velocities")) diff --git a/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/BilateralLagrangianConstraint.h b/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/BilateralLagrangianConstraint.h index d7deeb408cd..ab0b876c81f 100644 --- a/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/BilateralLagrangianConstraint.h +++ b/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/BilateralLagrangianConstraint.h @@ -113,7 +113,7 @@ class BilateralLagrangianConstraint : public PairInteractionConstraint d_numericalTolerance; ///< a real value specifying the tolerance during the constraint solving. (default=0.0001 - Data d_activate; ///< bool to control constraint activation + Data d_activate; ///< control constraint activation (true by default) Data d_keepOrientDiff; ///< keep the initial difference in orientation (only for rigids) diff --git a/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/BilateralLagrangianConstraint.inl b/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/BilateralLagrangianConstraint.inl index ddda4017e0d..e4d5f7815b8 100644 --- a/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/BilateralLagrangianConstraint.inl +++ b/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/BilateralLagrangianConstraint.inl @@ -41,9 +41,9 @@ using sofa::type::Vec; template BilateralLagrangianConstraint::BilateralLagrangianConstraint(MechanicalState* object1, MechanicalState* object2) : Inherit(object1, object2) - , d_m1(initData(&d_m1, "first_point", "index of the constraint on the first model")) - , d_m2(initData(&d_m2, "second_point", "index of the constraint on the second model")) - , d_restVector(initData(&d_restVector, "rest_vector", "Relative position to maintain between attached points (optional)")) + , d_m1(initData(&d_m1, "first_point","index of the constraint on the first model (object1)")) + , d_m2(initData(&d_m2, "second_point","index of the constraint on the second model (object2)")) + , d_restVector(initData(&d_restVector, "rest_vector","Relative position to maintain between attached points (optional)")) , d_numericalTolerance(initData(&d_numericalTolerance, 0.0001, "numericalTolerance", "a real value specifying the tolerance during the constraint solving. (optional, default=0.0001)") ) , d_activate( initData(&d_activate, true, "activate", "control constraint activation (true by default)")) diff --git a/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/FixedLagrangianConstraint.h b/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/FixedLagrangianConstraint.h index 37c78811980..03944cdd4ba 100644 --- a/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/FixedLagrangianConstraint.h +++ b/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/FixedLagrangianConstraint.h @@ -58,7 +58,7 @@ class FixedLagrangianConstraint : public core::behavior::Constraint sofa::type::vector m_prevForces; SetIndex d_indices; - Data d_fixAll; + Data d_fixAll; ///< If true, fix all points FixedLagrangianConstraint(MechanicalState* object = nullptr); virtual ~FixedLagrangianConstraint() {} diff --git a/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/SlidingLagrangianConstraint.h b/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/SlidingLagrangianConstraint.h index 81015097548..a0763fed866 100644 --- a/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/SlidingLagrangianConstraint.h +++ b/Sofa/Component/Constraint/Lagrangian/Model/src/sofa/component/constraint/lagrangian/model/SlidingLagrangianConstraint.h @@ -56,7 +56,7 @@ class SlidingLagrangianConstraint : public core::behavior::PairInteractionConstr Data d_m1; ///< index of the spliding point on the first model Data d_m2a; ///< index of one end of the sliding axis Data d_m2b; ///< index of the other end of the sliding axis - Data d_force; ///< interaction force + Data d_force; ///< force (impulse) used to solve the constraint Real m_dist; // constraint violation Real m_thirdConstraint; // 0 if A d_resolutionMethod; ///< Method used to solve the constraint problem, among: \"ProjectedGaussSeidel\", \"UnbuiltGaussSeidel\" or \"for NonsmoothNonlinearConjugateGradient\" + Data< sofa::helper::OptionsGroup > d_resolutionMethod; ///< Method used to solve the constraint problem, among: "ProjectedGaussSeidel", "UnbuiltGaussSeidel" or "for NonsmoothNonlinearConjugateGradient" SOFA_ATTRIBUTE_DEPRECATED__RENAME_DATA_IN_CONSTRAINT_LAGRANGIAN_SOLVER() Data maxIt; @@ -110,8 +110,8 @@ class SOFA_COMPONENT_CONSTRAINT_LAGRANGIAN_SOLVER_API GenericConstraintSolver : Data d_sor; ///< Successive Over Relaxation parameter (0-2) Data d_scaleTolerance; ///< Scale the error tolerance with the number of constraints Data d_allVerified; ///< All contraints must be verified (each constraint's error < tolerance) - Data d_newtonIterations; ///< Maximum iteration number of Newton (for the NNCG solver only) - Data d_multithreading; ///< Compliances built concurrently + Data d_newtonIterations; ///< Maximum iteration number of Newton (for the NonsmoothNonlinearConjugateGradient solver only) + Data d_multithreading; ///< Build compliances concurrently Data d_computeGraphs; ///< Compute graphs of errors and forces during resolution Data > > d_graphErrors; ///< Sum of the constraints' errors at each iteration Data > > d_graphConstraints; ///< Graph of each constraint's error at the end of the resolution @@ -123,7 +123,7 @@ class SOFA_COMPONENT_CONSTRAINT_LAGRANGIAN_SOLVER_API GenericConstraintSolver : Data d_currentIterations; ///< OUTPUT: current number of constraint groups Data d_currentError; ///< OUTPUT: current error Data d_reverseAccumulateOrder; ///< True to accumulate constraints from nodes in reversed order (can be necessary when using multi-mappings or interaction constraints not following the node hierarchy) - Data> d_constraintForces; ///< OUTPUT: The Data constraintForces is used to provide the intensities of constraint forces in the simulation. The user can easily check the constraint forces from the GenericConstraint component interface. + Data> d_constraintForces; ///< OUTPUT: constraint forces (stored only if computeConstraintForces=True) Data d_computeConstraintForces; ///< The indices of the constraintForces to store in the constraintForce data field. sofa::core::MultiVecDerivId getLambda() const override; diff --git a/Sofa/Component/Constraint/Lagrangian/Solver/src/sofa/component/constraint/lagrangian/solver/LCPConstraintSolver.h b/Sofa/Component/Constraint/Lagrangian/Solver/src/sofa/component/constraint/lagrangian/solver/LCPConstraintSolver.h index 78c1567e143..5e079e5d408 100644 --- a/Sofa/Component/Constraint/Lagrangian/Solver/src/sofa/component/constraint/lagrangian/solver/LCPConstraintSolver.h +++ b/Sofa/Component/Constraint/Lagrangian/Solver/src/sofa/component/constraint/lagrangian/solver/LCPConstraintSolver.h @@ -130,6 +130,7 @@ class SOFA_COMPONENT_CONSTRAINT_LAGRANGIAN_SOLVER_API LCPConstraintSolver : publ SOFA_ATTRIBUTE_DEPRECATED__RENAME_DATA_IN_CONSTRAINT_LAGRANGIAN_SOLVER() Data showLevelTranslation; + Data d_displayDebug; ///< Display debug information. Data d_initial_guess; ///< activate LCP results history to improve its resolution performances. Data d_build_lcp; ///< LCP is not fully built to increase performance in some case. @@ -141,9 +142,9 @@ class SOFA_COMPONENT_CONSTRAINT_LAGRANGIAN_SOLVER_API LCPConstraintSolver : publ Data d_multi_grid; ///< activate multi_grid resolution (NOT STABLE YET) Data d_multi_grid_levels; ///< if multi_grid is active: how many levels to create (>=2) Data d_merge_method; ///< if multi_grid is active: which method to use to merge constraints (0 = compliance-based, 1 = spatial coordinates) - Data d_merge_spatial_step; ///< if d_merge_method is 1: grid size reduction between multigrid levels - Data d_merge_local_levels; ///< if d_merge_method is 1: up to the specified level of the multigrid, constraints are grouped locally, i.e. separately within each contact pairs, while on upper levels they are grouped globally independently of contact pairs. - Data> d_constraintForces; ///< OUTPUT: The Data constraintForces is used to provide the intensities of constraint forces in the simulation. The user can easily check the constraint forces from the GenericConstraint component interface + Data d_merge_spatial_step; ///< if merge_method is 1: grid size reduction between multigrid levels + Data d_merge_local_levels; ///< if merge_method is 1: up to the specified level of the multigrid, constraints are grouped locally, i.e. separately within each contact pairs, while on upper levels they are grouped globally independently of contact pairs. + Data> d_constraintForces; ///< OUTPUT: constraint forces (stored only if computeConstraintForces=True) Data d_computeConstraintForces; ///< The indices of the constraintForces to store in the constraintForce data field Data < std::set > d_constraintGroups; ///< list of ID of groups of constraints to be handled by this solver. diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/AttachProjectiveConstraint.h b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/AttachProjectiveConstraint.h index a9a6d6f9dd2..427a9d276ba 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/AttachProjectiveConstraint.h +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/AttachProjectiveConstraint.h @@ -51,7 +51,7 @@ class AttachProjectiveConstraint : public core::behavior::PairInteractionProject public: SetIndex f_indices1; ///< Indices of the source points on the first model SetIndex f_indices2; ///< Indices of the fixed points on the second model - Data f_twoWay; ///< true if forces should be projected back from model2 to model1 + Data f_twoWay; ///< if true, projects the constraint vertices of both object1 and object2 towards their average degrees of freedom and derivatives. If false, the position of the object1 are projected onto the object2. Therefore, object2 only follows object1 without affecting the motion of object1 Data f_freeRotations; ///< true to keep rotations free (only used for Rigid DOFs) Data f_lastFreeRotation; ///< true to keep rotation of the last attached point free (only used for Rigid DOFs) Data f_restRotations; ///< true to use rest rotations local offsets (only used for Rigid DOFs) @@ -59,10 +59,10 @@ class AttachProjectiveConstraint : public core::behavior::PairInteractionProject Data f_lastDir; ///< direction from lastPos at which the attach coustraint should become inactive Data f_clamp; ///< true to clamp particles at lastPos instead of freeing them. Data f_minDistance; ///< the constraint become inactive if the distance between the points attached is bigger than minDistance. - Data< Real > d_positionFactor; ///< IN: Factor applied to projection of position - Data< Real > d_velocityFactor; ///< IN: Factor applied to projection of velocity - Data< Real > d_responseFactor; ///< IN: Factor applied to projection of force/acceleration - Data< type::vector > d_constraintFactor; ///< Constraint factor per pair of points constrained. 0 -> the constraint is released. 1 -> the constraint is fully constrained + Data< Real > d_positionFactor; ///< IN: Factor applied to projection of position + Data< Real > d_velocityFactor; ///< IN: Factor applied to projection of velocity + Data< Real > d_responseFactor; ///< IN: Factor applied to projection of force/acceleration + Data< type::vector > d_constraintFactor; ///< Vector of factors adapting the application of the constraint per pair of points (0 -> the constraint is released. 1 -> the constraint is fully constrained) type::vector activeFlags; type::vector constraintReleased; diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/AttachProjectiveConstraint.inl b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/AttachProjectiveConstraint.inl index e84f25e1dca..ac1b0f5f5f5 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/AttachProjectiveConstraint.inl +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/AttachProjectiveConstraint.inl @@ -198,7 +198,7 @@ AttachProjectiveConstraint::AttachProjectiveConstraint(core::behavior : core::behavior::PairInteractionProjectiveConstraintSet(mm1,mm2) , f_indices1( initData(&f_indices1,"indices1","Indices of the source points on the first model") ) , f_indices2( initData(&f_indices2,"indices2","Indices of the fixed points on the second model") ) - , f_twoWay( initData(&f_twoWay,false,"twoWay", "true if forces should be projected back from model2 to model1") ) + , f_twoWay( initData(&f_twoWay,false,"twoWay", "if true, projects the constraint vertices of both object1 and object2 towards their average degrees of freedom and derivatives. If false, the position of the object1 are projected onto the object2. Therefore, object2 only follows object1 without affecting the motion of object1") ) , f_freeRotations( initData(&f_freeRotations,false,"freeRotations", "true to keep rotations free (only used for Rigid DOFs)") ) , f_lastFreeRotation( initData(&f_lastFreeRotation,false,"lastFreeRotation", "true to keep rotation of the last attached point free (only used for Rigid DOFs)") ) , f_restRotations( initData(&f_restRotations,false,"restRotations", "true to use rest rotations local offsets (only used for Rigid DOFs)") ) @@ -209,7 +209,7 @@ AttachProjectiveConstraint::AttachProjectiveConstraint(core::behavior , d_positionFactor(initData(&d_positionFactor, static_cast(1.0), "positionFactor", "IN: Factor applied to projection of position")) , d_velocityFactor(initData(&d_velocityFactor, static_cast(1.0), "velocityFactor", "IN: Factor applied to projection of velocity")) , d_responseFactor(initData(&d_responseFactor, static_cast(1.0), "responseFactor", "IN: Factor applied to projection of force/acceleration")) - , d_constraintFactor( initData(&d_constraintFactor,"constraintFactor","Constraint factor per pair of points constrained. 0 -> the constraint is released. 1 -> the constraint is fully constrained") ) + , d_constraintFactor( initData(&d_constraintFactor,"constraintFactor","Vector of factors adapting the application of the constraint per pair of points (0 -> the constraint is released. 1 -> the constraint is fully constrained)") ) { } diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/DirectionProjectiveConstraint.h b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/DirectionProjectiveConstraint.h index 88928f1fced..475a6d08780 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/DirectionProjectiveConstraint.h +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/DirectionProjectiveConstraint.h @@ -91,9 +91,9 @@ class DirectionProjectiveConstraint : public core::behavior::ProjectiveConstrain SOFA_ATTRIBUTE_DEPRECATED__RENAME_DATA_IN_CONSTRAINT_PROJECTIVE() Dataf_direction; - IndexSubsetData d_indices; ///< the particles to project - Data d_drawSize; ///< The size of the square used to display the constrained particles - Data d_direction; ///< The direction of the line. Will be normalized by init() + IndexSubsetData d_indices; ///< Indices the particles to project + Data d_drawSize; ///< Size of the rendered particles (0 -> point based rendering, >0 -> radius of spheres) + Data d_direction; ///< Direction of the line /// Link to be set to the topology container in the component graph. SingleLink, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> l_topology; diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/DirectionProjectiveConstraint.inl b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/DirectionProjectiveConstraint.inl index f95d9bbff2e..2dd86a495d8 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/DirectionProjectiveConstraint.inl +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/DirectionProjectiveConstraint.inl @@ -36,9 +36,9 @@ namespace sofa::component::constraint::projective template DirectionProjectiveConstraint::DirectionProjectiveConstraint() : core::behavior::ProjectiveConstraintSet(nullptr) - , d_indices(initData(&d_indices, "indices", "Indices of the fixed points") ) - , d_drawSize(initData(&d_drawSize, (SReal)0.0, "drawSize", "0 -> point based rendering, >0 -> radius of spheres") ) - , d_direction(initData(&d_direction, CPos(), "direction", "Direction of the line")) + , d_indices( initData(&d_indices,"indices","Indices the particles to project") ) + , d_drawSize( initData(&d_drawSize,(SReal)0.0,"drawSize","Size of the rendered particles (0 -> point based rendering, >0 -> radius of spheres)") ) + , d_direction( initData(&d_direction,CPos(),"direction","Direction of the line")) , l_topology(initLink("topology", "link to the topology container")) , data(new DirectionProjectiveConstraintInternalData()) { diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedPlaneProjectiveConstraint.h b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedPlaneProjectiveConstraint.h index 6885db83f9e..795e9957474 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedPlaneProjectiveConstraint.h +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedPlaneProjectiveConstraint.h @@ -67,9 +67,9 @@ class FixedPlaneProjectiveConstraint : public ProjectiveConstraintSet typedef type::vector SetIndexArray; typedef core::topology::TopologySubsetIndices SetIndex; public: - Data d_direction; ///< direction on which the constraint applied - Data d_dmin; ///< coordinates min of the plane for the vertex selection - Data d_dmax; ///< coordinates max of the plane for the vertex selection + Data d_direction; ///< normal direction of the plane + Data d_dmin; ///< Minimum plane distance from the origin + Data d_dmax; ///< Maximum plane distance from the origin SetIndex d_indices; ///< the set of vertex indices /// Link to be set to the topology container in the component graph. diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedProjectiveConstraint.h b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedProjectiveConstraint.h index d2fad673643..e766fd9d3fb 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedProjectiveConstraint.h +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedProjectiveConstraint.h @@ -80,8 +80,8 @@ class FixedProjectiveConstraint : public core::behavior::ProjectiveConstraintSet SetIndex d_indices; Data d_fixAll; ///< filter all the DOF to implement a fixed object Data d_showObject; ///< draw or not the fixed constraints - Data d_drawSize; ///< 0 -> point based rendering, >0 -> radius of spheres - Data d_projectVelocity; ///< activate project velocity to set velocity to zero + Data d_drawSize; ///< Size of the rendered particles (0 -> point based rendering, >0 -> radius of spheres) + Data d_projectVelocity; ///< if true, projects not only a constant but a zero velocity /// Link to be set to the topology container in the component graph. SingleLink, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> l_topology; diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedProjectiveConstraint.inl b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedProjectiveConstraint.inl index 78bd3636d2e..4d50a0e6758 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedProjectiveConstraint.inl +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedProjectiveConstraint.inl @@ -39,8 +39,8 @@ FixedProjectiveConstraint::FixedProjectiveConstraint() , d_indices( initData(&d_indices,"indices","Indices of the fixed points") ) , d_fixAll( initData(&d_fixAll,false,"fixAll","filter all the DOF to implement a fixed object") ) , d_showObject(initData(&d_showObject,true,"showObject","draw or not the fixed constraints")) - , d_drawSize( initData(&d_drawSize,(SReal)0.0,"drawSize","0 -> point based rendering, >0 -> radius of spheres") ) - , d_projectVelocity( initData(&d_projectVelocity,false,"activate_projectVelocity","activate project velocity to set velocity") ) + , d_drawSize( initData(&d_drawSize,(SReal)0.0,"drawSize","Size of the rendered particles (0 -> point based rendering, >0 -> radius of spheres)") ) + , d_projectVelocity( initData(&d_projectVelocity,false,"activate_projectVelocity","if true, projects not only a constant but a zero velocity") ) , l_topology(initLink("topology", "link to the topology container")) , data(new FixedProjectiveConstraintInternalData()) { diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedTranslationProjectiveConstraint.h b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedTranslationProjectiveConstraint.h index b78e7beda08..1a832328566 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedTranslationProjectiveConstraint.h +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedTranslationProjectiveConstraint.h @@ -76,7 +76,7 @@ class FixedTranslationProjectiveConstraint : public core::behavior::ProjectiveCo SetIndex d_indices; ///< Indices of the fixed points Data d_fixAll; ///< filter all the DOF to implement a fixed object - Data d_drawSize; ///< 0 -> point based rendering, >0 -> radius of spheres + Data d_drawSize; ///< Size of the rendered particles (0 -> point based rendering, >0 -> radius of spheres) SetIndex d_coordinates; ///< Coordinates of the fixed points /// Link to be set to the topology container in the component graph. diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedTranslationProjectiveConstraint.inl b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedTranslationProjectiveConstraint.inl index 7dfbf484ebd..fdafc4e803a 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedTranslationProjectiveConstraint.inl +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/FixedTranslationProjectiveConstraint.inl @@ -33,10 +33,10 @@ namespace sofa::component::constraint::projective template< class DataTypes> FixedTranslationProjectiveConstraint::FixedTranslationProjectiveConstraint() : core::behavior::ProjectiveConstraintSet(nullptr) - , d_indices(initData(&d_indices, "indices", "Indices of the fixed points") ) - , d_fixAll(initData(&d_fixAll, false, "fixAll", "filter all the DOF to implement a fixed object") ) - , d_drawSize(initData(&d_drawSize, (SReal)0.0, "drawSize", "0 -> point based rendering, >0 -> radius of spheres") ) - , d_coordinates(initData(&d_coordinates, "coordinates", "Coordinates of the fixed points") ) + , d_indices( initData(&d_indices,"indices","Indices of the fixed points") ) + , d_fixAll( initData(&d_fixAll,false,"fixAll","filter all the DOF to implement a fixed object") ) + , d_drawSize( initData(&d_drawSize,(SReal)0.0,"drawSize","Size of the rendered particles (0 -> point based rendering, >0 -> radius of spheres)") ) + , d_coordinates( initData(&d_coordinates,"coordinates","Coordinates of the fixed points") ) , l_topology(initLink("topology", "link to the topology container")) { // default to indice 0 diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/LineProjectiveConstraint.h b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/LineProjectiveConstraint.h index caa295bf382..dcd04e5a37c 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/LineProjectiveConstraint.h +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/LineProjectiveConstraint.h @@ -96,9 +96,9 @@ class LineProjectiveConstraint : public core::behavior::ProjectiveConstraintSet< Data f_direction; IndexSubsetData d_indices; ///< the particles to project - Data d_drawSize; ///< The size of the square used to display the constrained particles - Data d_origin; ///< A point on the line - Data d_direction; ///< The direction of the line. Will be normalized by init() + Data d_drawSize; ///< Size of the rendered particles (0 -> point based rendering, >0 -> radius of spheres) + Data d_origin; ///< A point in the line + Data d_direction; ///< Direction of the line /// Link to be set to the topology container in the component graph. SingleLink, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> l_topology; diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/LineProjectiveConstraint.inl b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/LineProjectiveConstraint.inl index bfafaa90a2a..03ed1685a7f 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/LineProjectiveConstraint.inl +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/LineProjectiveConstraint.inl @@ -35,10 +35,10 @@ namespace sofa::component::constraint::projective template LineProjectiveConstraint::LineProjectiveConstraint() : core::behavior::ProjectiveConstraintSet(nullptr) - , d_indices(initData(&d_indices, "indices", "Indices of the fixed points") ) - , d_drawSize(initData(&d_drawSize, (SReal)0.0, "drawSize", "0 -> point based rendering, >0 -> radius of spheres") ) - , d_origin(initData(&d_origin, CPos(), "origin", "A point in the line")) - , d_direction(initData(&d_direction, CPos(), "direction", "Direction of the line")) + , d_indices( initData(&d_indices,"indices","Indices of the fixed points") ) + , d_drawSize( initData(&d_drawSize,(SReal)0.0,"drawSize","Size of the rendered particles (0 -> point based rendering, >0 -> radius of spheres)") ) + , d_origin( initData(&d_origin,CPos(),"origin","A point in the line")) + , d_direction( initData(&d_direction,CPos(),"direction","Direction of the line")) , l_topology(initLink("topology", "link to the topology container")) , data(new LineProjectiveConstraintInternalData()) { diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/OscillatorProjectiveConstraint.h b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/OscillatorProjectiveConstraint.h index f23540956cc..8d5f1113c73 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/OscillatorProjectiveConstraint.h +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/OscillatorProjectiveConstraint.h @@ -84,7 +84,7 @@ class OscillatorProjectiveConstraint : public core::behavior::ProjectiveConstrai SOFA_ATTRIBUTE_DEPRECATED__RENAME_DATA_IN_CONSTRAINT_PROJECTIVE() Data< type::vector< Oscillator > > constraints; - Data< type::vector< Oscillator > > d_constraints; ///< constrained particles + Data< type::vector< Oscillator > > d_constraints; ///< Define a sequence of oscillating particules: [index, Mean(x,y,z), amplitude(x,y,z), pulsation, phase] public: diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PartialFixedProjectiveConstraint.h b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PartialFixedProjectiveConstraint.h index 28e99260259..89bc6dab2f3 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PartialFixedProjectiveConstraint.h +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PartialFixedProjectiveConstraint.h @@ -64,8 +64,8 @@ class PartialFixedProjectiveConstraint : public FixedProjectiveConstraint VecBool; - Data d_fixedDirections; ///< Defines the directions in which the particles are fixed: true (or 1) for fixed, false (or 0) for free. - Data d_projectVelocity; ///< activate project velocity to set velocity to zero + Data d_fixedDirections; ///< Defines the directions in which the particles are fixed: true (or 1) for fixed, false (or 0) for free + Data d_projectVelocity; ///< activate project velocity to maintain a constant velocity protected: PartialFixedProjectiveConstraint(); diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PartialFixedProjectiveConstraint.inl b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PartialFixedProjectiveConstraint.inl index 3c9b090d771..ed05ccf9933 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PartialFixedProjectiveConstraint.inl +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PartialFixedProjectiveConstraint.inl @@ -34,8 +34,8 @@ namespace sofa::component::constraint::projective template PartialFixedProjectiveConstraint::PartialFixedProjectiveConstraint() - : d_fixedDirections( initData(&d_fixedDirections,"fixedDirections","for each direction, 1 if fixed, 0 if free") ) - , d_projectVelocity(initData(&d_projectVelocity, false, "projectVelocity", "project velocity to ensure no drift of the fixed point")) + : d_fixedDirections( initData(&d_fixedDirections,"fixedDirections","Defines the directions in which the particles are fixed: true (or 1) for fixed, false (or 0) for free") ) + , d_projectVelocity(initData(&d_projectVelocity, false, "projectVelocity", "activate project velocity to maintain a constant velocity")) { VecBool blockedDirection; for( unsigned i=0; i d_mainIndice; ///< The main indice node in the list of constrained nodes, it defines how to apply the linear movement between this constrained nodes core::objectmodel::Data d_minDepIndice; ///< The indice node in the list of constrained nodes, which is imposed the minimum displacment core::objectmodel::Data d_maxDepIndice; ///< The indice node in the list of constrained nodes, which is imposed the maximum displacment - core::objectmodel::Data > d_imposedDisplacmentOnMacroNodes; ///< imposed displacement at u1 u2 u3 u4 for 2d case + core::objectmodel::Data > d_imposedDisplacmentOnMacroNodes; ///< The imposed displacment on macro nodes ///< and u1 u2 u3 u4 u5 u6 u7 u8 for 3d case Data d_X0; ///< Size of specimen in X-direction Data d_Y0; ///< Size of specimen in Y-direction @@ -146,7 +146,7 @@ public : SOFA_ATTRIBUTE_DEPRECATED__RENAME_DATA_IN_CONSTRAINT_PROJECTIVE() core::objectmodel::Data movedDirections; - core::objectmodel::Data d_movedDirections; ///< Defines the directions in which the particles are moved: true (or 1) for fixed, false (or 0) for free. + core::objectmodel::Data d_movedDirections; ///< Defines the directions in which the particles are moved: true (or 1) for fixed, false (or 0) for free /// Link to be set to the topology container in the component graph. SingleLink, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> l_topology; diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PartialLinearMovementProjectiveConstraint.inl b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PartialLinearMovementProjectiveConstraint.inl index da209f1804f..6cf6e4a260a 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PartialLinearMovementProjectiveConstraint.inl +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PartialLinearMovementProjectiveConstraint.inl @@ -39,19 +39,19 @@ template PartialLinearMovementProjectiveConstraint::PartialLinearMovementProjectiveConstraint() : core::behavior::ProjectiveConstraintSet(nullptr) , data(new PartialLinearMovementProjectiveConstraintInternalData) - , d_indices(initData(&d_indices, "indices", "Indices of the constrained points") ) - , d_keyTimes(initData(&d_keyTimes, "keyTimes", "key times for the movements") ) - , d_keyMovements(initData(&d_keyMovements, "movements", "movements corresponding to the key times") ) - , d_showMovement(initData(&d_showMovement, (bool)false, "d_showMovement", "Visualization of the movement to be applied to constrained dofs.")) - , d_linearMovementBetweenNodesInIndices(initData(&d_linearMovementBetweenNodesInIndices, (bool)false, "d_linearMovementBetweenNodesInIndices", "Take into account the linear movement between the constrained points")) - , d_mainIndice(initData(&d_mainIndice, "d_mainIndice", "The main indice node in the list of constrained nodes, it defines how to apply the linear movement between this constrained nodes ")) - , d_minDepIndice(initData(&d_minDepIndice, "d_minDepIndice", "The indice node in the list of constrained nodes, which is imposed the minimum displacment ")) - , d_maxDepIndice(initData(&d_maxDepIndice, "d_maxDepIndice", "The indice node in the list of constrained nodes, which is imposed the maximum displacment ")) - , d_imposedDisplacmentOnMacroNodes(initData(&d_imposedDisplacmentOnMacroNodes, "imposedDisplacmentOnMacroNodes", "The imposed displacment on macro nodes") ) - , d_X0 (initData (&d_X0, Real(0.0), "X0", "Size of specimen in X-direction" ) ) - , d_Y0 (initData (&d_Y0, Real(0.0), "Y0", "Size of specimen in Y-direction" ) ) - , d_Z0 (initData (&d_Z0, Real(0.0), "Z0", "Size of specimen in Z-direction" ) ) - , d_movedDirections(initData(&d_movedDirections, "d_movedDirections", "for each direction, 1 if moved, 0 if free") ) + , d_indices( initData(&d_indices,"indices","Indices of the constrained points") ) + , d_keyTimes( initData(&d_keyTimes,"keyTimes","key times for the movements") ) + , d_keyMovements( initData(&d_keyMovements,"movements","movements corresponding to the key times") ) + , d_showMovement( initData(&d_showMovement, (bool)false, "showMovement", "Visualization of the movement to be applied to constrained dofs.")) + , d_linearMovementBetweenNodesInIndices( initData(&d_linearMovementBetweenNodesInIndices, (bool)false, "linearMovementBetweenNodesInIndices", "Take into account the linear movement between the constrained points")) + , d_mainIndice( initData(&d_mainIndice, "mainIndice", "The main indice node in the list of constrained nodes, it defines how to apply the linear movement between this constrained nodes ")) + , d_minDepIndice( initData(&d_minDepIndice, "minDepIndice", "The indice node in the list of constrained nodes, which is imposed the minimum displacment ")) + , d_maxDepIndice( initData(&d_maxDepIndice, "maxDepIndice", "The indice node in the list of constrained nodes, which is imposed the maximum displacment ")) + , d_imposedDisplacmentOnMacroNodes( initData(&d_imposedDisplacmentOnMacroNodes,"imposedDisplacmentOnMacroNodes","The imposed displacment on macro nodes") ) + , d_X0 ( initData ( &d_X0, Real(0.0),"X0","Size of specimen in X-direction" ) ) + , d_Y0 ( initData ( &d_Y0, Real(0.0),"Y0","Size of specimen in Y-direction" ) ) + , d_Z0 ( initData ( &d_Z0, Real(0.0),"Z0","Size of specimen in Z-direction" ) ) + , d_movedDirections( initData(&d_movedDirections,"movedDirections","Defines the directions in which the particles are moved: true (or 1) for fixed, false (or 0) for free") ) , l_topology(initLink("topology", "link to the topology container")) , finished(false) { diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PlaneProjectiveConstraint.h b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PlaneProjectiveConstraint.h index e20fba61212..5f4b606761f 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PlaneProjectiveConstraint.h +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PlaneProjectiveConstraint.h @@ -95,9 +95,9 @@ class PlaneProjectiveConstraint : public core::behavior::ProjectiveConstraintSet Data f_drawSize; IndexSubsetData d_indices; ///< the particles to project - Data d_origin; ///< A point in the plane - Data d_normal; ///< The normal to the plane. Will be normalized by init(). - Data d_drawSize; ///< The size of the display of the constrained particles + Data d_origin; ///< A point in the plane + Data d_normal; ///< Normal vector to the plane + Data d_drawSize; ///< Size of the rendered particles (0 -> point based rendering, >0 -> radius of spheres) /// Link to be set to the topology container in the component graph. SingleLink, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> l_topology; diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PlaneProjectiveConstraint.inl b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PlaneProjectiveConstraint.inl index 5be2adc92eb..85cfdc372c6 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PlaneProjectiveConstraint.inl +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PlaneProjectiveConstraint.inl @@ -35,10 +35,10 @@ namespace sofa::component::constraint::projective template PlaneProjectiveConstraint::PlaneProjectiveConstraint() : core::behavior::ProjectiveConstraintSet(nullptr) - , d_indices(initData(&d_indices, "indices", "Indices of the fixed points") ) - , d_origin(initData(&d_origin, CPos(), "origin", "A point in the plane")) - , d_normal(initData(&d_normal, CPos(), "normal", "Normal vector to the plane")) - , d_drawSize(initData(&d_drawSize, (SReal)0.0, "drawSize", "0 -> point based rendering, >0 -> radius of spheres") ) + , d_indices( initData(&d_indices,"indices","Indices of the fixed points") ) + , d_origin( initData(&d_origin,CPos(),"origin","A point in the plane")) + , d_normal( initData(&d_normal,CPos(),"normal","Normal vector to the plane")) + , d_drawSize( initData(&d_drawSize,(SReal)0.0,"drawSize","Size of the rendered particles (0 -> point based rendering, >0 -> radius of spheres)") ) , l_topology(initLink("topology", "link to the topology container")) , data(new PlaneProjectiveConstraintInternalData()) { diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PointProjectiveConstraint.h b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PointProjectiveConstraint.h index b901c41bcfb..f0163fd4966 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PointProjectiveConstraint.h +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PointProjectiveConstraint.h @@ -90,9 +90,9 @@ class PointProjectiveConstraint : public core::behavior::ProjectiveConstraintSet SetIndex d_indices; ///< the indices of the points to project to the target - Data d_point; ///< the target of the projection - Data d_fixAll; ///< to project all the points, rather than those listed in d_indices - Data d_drawSize; ///< 0 -> point based rendering, >0 -> radius of spheres + Data d_point; ///< Target of the projection + Data d_fixAll; ///< filter all the DOF to implement a fixed object + Data d_drawSize; ///< Size of the rendered particles (0 -> point based rendering, >0 -> radius of spheres) /// Link to be set to the topology container in the component graph. SingleLink, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> l_topology; diff --git a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PointProjectiveConstraint.inl b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PointProjectiveConstraint.inl index 9165c3fbf8c..41f12185d7a 100644 --- a/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PointProjectiveConstraint.inl +++ b/Sofa/Component/Constraint/Projective/src/sofa/component/constraint/projective/PointProjectiveConstraint.inl @@ -37,10 +37,10 @@ namespace sofa::component::constraint::projective template PointProjectiveConstraint::PointProjectiveConstraint() : core::behavior::ProjectiveConstraintSet(nullptr) - , d_indices(initData(&d_indices, "indices", "Indices of the points to project") ) - , d_point(initData(&d_point, "point", "Target of the projection") ) - , d_fixAll(initData(&d_fixAll, false, "fixAll", "filter all the DOF to implement a fixed object") ) - , d_drawSize(initData(&d_drawSize, (SReal)0.0, "drawSize", "0 -> point based rendering, >0 -> radius of spheres") ) + , d_indices( initData(&d_indices,"indices","Indices of the points to project") ) + , d_point( initData(&d_point,"point","Target of the projection") ) + , d_fixAll( initData(&d_fixAll,false,"fixAll","filter all the DOF to implement a fixed object") ) + , d_drawSize( initData(&d_drawSize,(SReal)0.0,"drawSize","Size of the rendered particles (0 -> point based rendering, >0 -> radius of spheres)") ) , l_topology(initLink("topology", "link to the topology container")) , data(new PointProjectiveConstraintInternalData()) { diff --git a/Sofa/Component/Controller/src/sofa/component/controller/Controller.h b/Sofa/Component/Controller/src/sofa/component/controller/Controller.h index 882ebb02035..7ce041b2c84 100644 --- a/Sofa/Component/Controller/src/sofa/component/controller/Controller.h +++ b/Sofa/Component/Controller/src/sofa/component/controller/Controller.h @@ -112,7 +112,7 @@ class SOFA_COMPONENT_CONTROLLER_API Controller : public core::behavior::BaseCont Data < bool > handleEventTriggersUpdate; - Data< bool > d_handleEventTriggersUpdate; ///< Event reception triggers object update + Data< bool > d_handleEventTriggersUpdate; ///< Event handling frequency controls the controller update frequency public: diff --git a/Sofa/Component/Controller/src/sofa/component/controller/MechanicalStateController.h b/Sofa/Component/Controller/src/sofa/component/controller/MechanicalStateController.h index 34a15256e65..e670b5bd75d 100644 --- a/Sofa/Component/Controller/src/sofa/component/controller/MechanicalStateController.h +++ b/Sofa/Component/Controller/src/sofa/component/controller/MechanicalStateController.h @@ -129,13 +129,13 @@ class MechanicalStateController : public Controller void applyController(void); protected: - Data< unsigned int > index; ///< Controlled DOF index. + Data< unsigned int > index; ///< Index of the controlled DOF Data< bool > onlyTranslation; ///< Controlling the DOF only in translation Data< bool > buttonDeviceState; ///< state of ths device button core::behavior::MechanicalState *mState; ///< Controlled MechanicalState. - Data< sofa::type::Vec<3,Real> > mainDirection; ///< Direction corresponding to the Mouse vertical axis. Default value is (0.0,0.0,-1.0), Z axis. + Data< sofa::type::Vec<3,Real> > mainDirection; ///< Main direction and orientation of the controlled DOF enum MouseMode { None=0, BtLeft, BtRight, BtMiddle, Wheel }; ///< Mouse current mode. bool device; diff --git a/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/AverageCoord.h b/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/AverageCoord.h index 1adfd33caa5..930f5f7852c 100644 --- a/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/AverageCoord.h +++ b/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/AverageCoord.h @@ -59,8 +59,8 @@ class AverageCoord : public core::DataEngine, public core::behavior::SingleState void doUpdate() override; - Data d_indices; ///< indices of the coordinates to average - Data d_vecId; ///< index of the vector (default value corresponds to core::VecCoordId::position() ) + Data d_indices; ///< indices of the coordinates to average + Data d_vecId; ///< index of the vector (default value corresponds to core::VecCoordId::position() ) Data d_average; ///< result void handleEvent(core::objectmodel::Event *event) override; diff --git a/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/ClusteringEngine.h b/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/ClusteringEngine.h index 887691e8672..9efe8a5029d 100644 --- a/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/ClusteringEngine.h +++ b/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/ClusteringEngine.h @@ -81,9 +81,9 @@ class ClusteringEngine : public core::DataEngine Data d_radius; ///< Neighborhood range. Data d_fixedRadius; ///< Neighborhood range (for non mechanical particles). Data d_nbClusters; ///< Number of clusters (-1 means that all input points are selected). - Data< VecCoord > d_fixedPosition; ///< input (non mechanical particle reference position) - Data< VecCoord > d_position; ///< input (reference mstate position) - Data< VVI > d_cluster; ///< result + Data< VecCoord > d_fixedPosition; ///< Input positions of fixed (non mechanical) particles. + Data< VecCoord > d_position; ///< Input rest positions. + Data< VVI > d_cluster; ///< Computed clusters. sofa::core::objectmodel::DataFileName input_filename; ///< import precomputed clusters sofa::core::objectmodel::DataFileName output_filename; ///< export clusters diff --git a/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/Distances.h b/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/Distances.h index b832087431c..a4b7a5104b3 100644 --- a/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/Distances.h +++ b/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/Distances.h @@ -77,8 +77,8 @@ class Distances : public core::DataEngine public: Data showMapIndex; ///< Frame DOF index on which display values. - Data showDistanceMap; ///< show the dsitance for each point of the target point set. - Data showGoalDistanceMap; ///< show the dsitance for each point of the target point set. + Data showDistanceMap; ///< show the distance for each point of the target point set. + Data showGoalDistanceMap; ///< show the distance for each point of the target point set. Data showTextScaleFactor; ///< Scale to apply on the text. Data showGradientMap; ///< show gradients for each point of the target point set. Data showGradientsScaleFactor; ///< scale for the gradients displayed. @@ -86,7 +86,7 @@ class Distances : public core::DataEngine Data distanceType; ///< type of distance to compute for inserted frames. Data initTarget; ///< initialize the target MechanicalObject from the grid. Data initTargetStep; ///< initialize the target MechanicalObject from the grid using this step. - Data > zonesFramePair; ///< Correspondance between the segmented value and the frames. + Data > zonesFramePair; ///< Correspondence between the segmented value and the frames. Data harmonicMaxValue; ///< Max value used to initialize the harmonic distance grid. void init() override; diff --git a/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/ShapeMatching.h b/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/ShapeMatching.h index f049c899c3a..9a1100773bd 100644 --- a/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/ShapeMatching.h +++ b/Sofa/Component/Engine/Analyze/src/sofa/component/engine/analyze/ShapeMatching.h @@ -75,9 +75,9 @@ class ShapeMatching : public core::DataEngine, public core::behavior::SingleStat Data< Real > fixedweight; ///< weight of fixed particles. Data< VecCoord > fixedPosition0; ///< rest positions of non mechanical particles. Data< VecCoord > fixedPosition; ///< current (fixed) positions of non mechanical particles. - Data< VecCoord > position; ///< input (current mstate position) - Data< VVI > cluster; ///< input2 (clusters) - Data< VecCoord > targetPosition; ///< result + Data< VecCoord > position; ///< Input positions. + Data< VVI > cluster; ///< Input clusters. + Data< VecCoord > targetPosition; ///< Computed target positions. private: sofa::core::topology::BaseMeshTopology* topo; diff --git a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/ExtrudeSurface.h b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/ExtrudeSurface.h index 787442e989c..156d1c7e59b 100644 --- a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/ExtrudeSurface.h +++ b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/ExtrudeSurface.h @@ -63,11 +63,11 @@ class ExtrudeSurface : public core::DataEngine bool initialized; Data isVisible; ///< is Visible ? - Data heightFactor; ///< Factor for the height of the extrusion (based on normal) ? - Data< type::vector > f_triangles; ///< List of triangle indices + Data heightFactor; ///< Factor for the height of the extrusion (based on normal) + Data< type::vector > f_triangles; ///< Triangle topology (list of BaseMeshTopology::Triangle) Data f_extrusionVertices; ///< Position coordinates of the extrusion Data f_surfaceVertices; ///< Position coordinates of the surface - Data< type::vector > f_extrusionTriangles; ///< Triangles indices of the extrusion + Data< type::vector > f_extrusionTriangles; ///< Subset triangle topology used for the extrusion Data< type::vector > f_surfaceTriangles; ///< Indices of the triangles of the surface to extrude diff --git a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/ExtrudeSurface.inl b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/ExtrudeSurface.inl index bf0aeee0bc0..aea6e31e052 100644 --- a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/ExtrudeSurface.inl +++ b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/ExtrudeSurface.inl @@ -31,11 +31,11 @@ template ExtrudeSurface::ExtrudeSurface() : initialized(false) , isVisible( initData (&isVisible, bool (true), "isVisible", "is Visible ?") ) - , heightFactor( initData (&heightFactor, Real (1.0), "heightFactor", "Factor for the height of the extrusion (based on normal) ?") ) - , f_triangles(initData(&f_triangles, "triangles", "List of triangle indices")) + , heightFactor( initData (&heightFactor, Real (1.0), "heightFactor", "Factor for the height of the extrusion (based on normal)") ) + , f_triangles(initData(&f_triangles, "triangles", "Triangle topology (list of BaseMeshTopology::Triangle)")) , f_extrusionVertices( initData (&f_extrusionVertices, "extrusionVertices", "Position coordinates of the extrusion") ) , f_surfaceVertices( initData (&f_surfaceVertices, "surfaceVertices", "Position coordinates of the surface") ) - , f_extrusionTriangles( initData (&f_extrusionTriangles, "extrusionTriangles", "Triangles indices of the extrusion") ) + , f_extrusionTriangles( initData (&f_extrusionTriangles, "extrusionTriangles", "Subset triangle topology used for the extrusion") ) , f_surfaceTriangles( initData (&f_surfaceTriangles, "surfaceTriangles", "Indices of the triangles of the surface to extrude") ) { addInput(&f_surfaceTriangles); diff --git a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateCylinder.h b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateCylinder.h index 02582c9d413..9dd08d84a2e 100644 --- a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateCylinder.h +++ b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateCylinder.h @@ -64,23 +64,23 @@ class GenerateCylinder : public core::DataEngine void doUpdate() override; public: - Data f_outputTetrahedraPositions; ///< ouput tetrahedra position - Data f_outputTrianglesPositions; ///< ouput triangle positions - Data f_tetrahedra; ///< output tetrahedra - Data f_triangles; ///< output triangles - Data > f_bezierTriangleWeight; ///< output weight for rational Bezier triangles - Data > f_isBezierTriangleRational; ///< for each Bezier triangle indicates if it is rational or integral - Data f_bezierTriangleDegree; ///< degree of Bezier triangles - Data > f_bezierTetrahedronWeight; ///< output weight for rational Bezier triangles - Data > f_isBezierTetrahedronRational; ///< for each Bezier tetrahedron indicates if it is rational - Data f_bezierTetrahedronDegree; ///< degree of Bezier tetrahedron - Data f_radius; ///< radius of cylinder - Data f_height; ///< height of cylinder - Data f_origin; ///< origin - Data f_openSurface; ///< if the triangulated surface is open or not - Data f_resolutionCircumferential; ///< number of points in the circumferential direction - Data f_resolutionRadial; ///< number of points in the radial direction - Data f_resolutionHeight; ///< number of points in the height direction + Data f_outputTetrahedraPositions; ///< output array of 3d points of tetrahedra mesh + Data f_outputTrianglesPositions; ///< output array of 3d points of triangle mesh + Data f_tetrahedra; ///< output mesh tetrahedra + Data f_triangles; ///< output triangular mesh + Data > f_bezierTriangleWeight; ///< weights of rational Bezier triangles + Data > f_isBezierTriangleRational; ///< booleans indicating if each Bezier triangle is rational or integral + Data f_bezierTriangleDegree; ///< order of Bezier triangles + Data > f_bezierTetrahedronWeight; ///< weights of rational Bezier tetrahedra + Data > f_isBezierTetrahedronRational; ///< booleans indicating if each Bezier tetrahedron is rational or integral + Data f_bezierTetrahedronDegree; ///< order of Bezier tetrahedra + Data f_radius; ///< input cylinder radius + Data f_height; ///< input cylinder height + Data f_origin; ///< cylinder origin point + Data f_openSurface; ///< if the cylinder is open at its 2 ends + Data f_resolutionCircumferential; ///< Resolution in the circumferential direction + Data f_resolutionRadial; ///< Resolution in the radial direction + Data f_resolutionHeight; ///< Resolution in the height direction }; diff --git a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateGrid.h b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateGrid.h index 7c2e2cce47c..d20b864f8f0 100644 --- a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateGrid.h +++ b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateGrid.h @@ -70,14 +70,14 @@ class GenerateGrid : public core::DataEngine public: - Data d_outputX; ///< ouput position - Data d_tetrahedron; ///< output tetrahedra - Data d_quad; ///< output quads - Data d_triangle; ///< output triangles - Data d_hexahedron; ///< output hexahedra - Data d_minCorner; ///< the position of the minimum corner - Data d_maxCorner; ///< the position of the maximum corner - Data d_resolution; ///< the resolution in the 3 directions + Data d_outputX; ///< output array of 3d points + Data d_tetrahedron; ///< output mesh tetrahedra + Data d_quad; ///< output mesh quads + Data d_triangle; ///< output mesh triangles + Data d_hexahedron; ///< output mesh hexahedra + Data d_minCorner; ///< the 3 coordinates of the minimum corner + Data d_maxCorner; ///< the 3 coordinates of the maximum corner + Data d_resolution; ///< the number of cubes in the x,y,z directions. If resolution in the z direction is 0 then a 2D grid is generated }; diff --git a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateRigidMass.h b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateRigidMass.h index d0c8f7427f7..d9c97c62ce5 100644 --- a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateRigidMass.h +++ b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateRigidMass.h @@ -65,7 +65,7 @@ class GenerateRigidMass : public core::DataEngine Data< type::vector< type::Vec3 > > m_positions; ///< input: positions of the vertices Data< type::vector< MTriangle > > m_triangles; ///< input: triangles of the mesh Data< type::vector< MQuad > > m_quads; ///< input: quads of the mesh - Data< type::vector< MPolygon > > m_polygons; ///< must be convex + Data< type::vector< MPolygon > > m_polygons; ///< input: polygons of the mesh /// output Data< MassType > rigidMass; diff --git a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateSphere.h b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateSphere.h index aab693c3fb5..17ab27791c2 100644 --- a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateSphere.h +++ b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GenerateSphere.h @@ -72,22 +72,22 @@ class GenerateSphere : public core::DataEngine void doUpdate() override; public: - Data f_outputTetrahedraPositions; ///< Output tetrahedra positions - Data f_tetrahedra; ///< Output tetrahedra - Data f_outputTrianglesPositions; ///< Output triangle positions - Data f_triangles; ///< Output triangles - - Data f_bezierTetrahedronDegree; ///< Degree of Bezier tetrahedra - Data > f_bezierTetrahedronWeight; ///< Output weight for rational Bezier triangles - Data > f_isBezierTetrahedronRational; ///< For each Bezier tetrahedron, indicates if it is rational - Data f_bezierTriangleDegree; ///< Degree of Bezier triangles - Data > f_bezierTriangleWeight; ///< Output weight for rational Bezier triangles - Data > f_isBezierTriangleRational; ///< For each Bezier triangle indicates, if it is rational or integral - - Data f_radius; ///< Radius of the sphere - Data f_origin; ///< Origin - Data f_tessellationDegree; ///< Degree of tessellation of each platonic triangle - Data f_platonicSolidName; ///< Name of the platonics solid + Data f_outputTetrahedraPositions; ///< output array of 3d points of tetrahedra mesh + Data f_tetrahedra; ///< output mesh tetrahedra + Data f_outputTrianglesPositions; ///< output array of 3d points of triangle mesh + Data f_triangles; ///< output triangular mesh + + Data f_bezierTetrahedronDegree; ///< order of Bezier tetrahedra + Data > f_bezierTetrahedronWeight; ///< weights of rational Bezier tetrahedra + Data > f_isBezierTetrahedronRational; ///< booleans indicating if each Bezier tetrahedron is rational or integral + Data f_bezierTriangleDegree; ///< order of Bezier triangles + Data > f_bezierTriangleWeight; ///< weights of rational Bezier triangles + Data > f_isBezierTriangleRational; ///< booleans indicating if each Bezier triangle is rational or integral + + Data f_radius; ///< input sphere radius + Data f_origin; ///< sphere center point + Data f_tessellationDegree; ///< Degree of tessellation of each Platonic triangulation + Data f_platonicSolidName; ///< name of the Platonic triangulation used to create the spherical dome : either "tetrahedron", "octahedron" or "icosahedron" PlatonicTriangulation platonicSolid; ///< the type of platonic solid used for the tessellation }; diff --git a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GroupFilterYoungModulus.h b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GroupFilterYoungModulus.h index 0ba654b89d9..06a5b7e205f 100644 --- a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GroupFilterYoungModulus.h +++ b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/GroupFilterYoungModulus.h @@ -55,7 +55,7 @@ class GroupFilterYoungModulus : public core::DataEngine //Input Data > f_groups; ///< Groups - Data > f_primitives; ///< not mandatory + Data > f_primitives; ///< Vector of primitives (indices) Data > f_elementsGroup; ///< Vector of groups (each element gives its group //Output Data > f_youngModulus; ///< Vector of young modulus for each primitive diff --git a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/MergePoints.h b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/MergePoints.h index ed690e72b86..673637ba887 100644 --- a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/MergePoints.h +++ b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/MergePoints.h @@ -62,8 +62,8 @@ class MergePoints : public core::DataEngine Data f_X2_mapping; ///< Mapping of indices to inject position2 inside position1 vertex buffer Data f_indices1; ///< Indices of the points of the first object Data f_indices2; ///< Indices of the points of the second object - Data f_points; ///< position coordinates of the merge - Data f_noUpdate; ///< do not update the output at eacth time step (false) + Data f_points; ///< position coordinates resulting from the merge + Data f_noUpdate; ///< do not update the output at each time step (false) }; #if !defined(SOFA_COMPONENT_ENGINE_MERGEPOINTS_CPP) diff --git a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/MergePoints.inl b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/MergePoints.inl index 205880b1b4e..9a116bd503c 100644 --- a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/MergePoints.inl +++ b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/MergePoints.inl @@ -33,8 +33,8 @@ MergePoints::MergePoints() , f_X2_mapping( initData (&f_X2_mapping, "mappingX2", "Mapping of indices to inject position2 inside position1 vertex buffer") ) , f_indices1( initData(&f_indices1,"indices1","Indices of the points of the first object") ) , f_indices2( initData(&f_indices2,"indices2","Indices of the points of the second object") ) - , f_points( initData (&f_points, "points", "position coordinates of the merge") ) - , f_noUpdate( initData (&f_noUpdate, false, "noUpdate", "do not update the output at eacth time step (false)") ) + , f_points( initData (&f_points, "points", "position coordinates resulting from the merge") ) + , f_noUpdate( initData (&f_noUpdate, false, "noUpdate", "do not update the output at each time step (false)") ) { addInput(&f_X1); addInput(&f_X2); diff --git a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/MeshBarycentricMapperEngine.h b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/MeshBarycentricMapperEngine.h index 508294e1f71..7f881033421 100644 --- a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/MeshBarycentricMapperEngine.h +++ b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/MeshBarycentricMapperEngine.h @@ -67,9 +67,9 @@ class MeshBarycentricMapperEngine : public core::DataEngine Data d_inputPositions; ///< Initial positions of the master points - Data d_mappedPointPositions; ///< Initial positions of the mapped points + Data d_mappedPointPositions; ///< Initial positions of the points to be mapped Data d_barycentricPositions; ///< Output : Barycentric positions of the mapped points - Data< VecIndices> d_tableElements; ///< Output : Table that provides the element index to which each input point belongs + Data< VecIndices> d_tableElements; ///< Output : Table that provides the index of the element to which each input point belongs Data d_bComputeLinearInterpolation; ///< if true, computes a linear interpolation (debug) Data< sofa::type::vector > > d_interpolationIndices; ///< Indices of a linear interpolation diff --git a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/NormalsFromPoints.h b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/NormalsFromPoints.h index e8218266fac..50dd8f2642a 100644 --- a/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/NormalsFromPoints.h +++ b/Sofa/Component/Engine/Generate/src/sofa/component/engine/generate/NormalsFromPoints.h @@ -59,7 +59,7 @@ class NormalsFromPoints : public core::DataEngine Data< VecCoord > position; ///< Vertices of the mesh Data< type::vector< type::fixed_array > > triangles; ///< Triangles of the mesh Data< type::vector< type::fixed_array > > quads; ///< Quads of the mesh - Data< VecCoord > normals; ///< result + Data< VecCoord > normals; ///< Computed vertex normals of the mesh Data invertNormals; ///< Swap normals Data useAngles; ///< Use incident angles to weight faces normal contributions at each vertex }; diff --git a/Sofa/Component/Engine/Select/src/sofa/component/engine/select/BoxROI.h b/Sofa/Component/Engine/Select/src/sofa/component/engine/select/BoxROI.h index 14417281c45..6ee291697f9 100644 --- a/Sofa/Component/Engine/Select/src/sofa/component/engine/select/BoxROI.h +++ b/Sofa/Component/Engine/Select/src/sofa/component/engine/select/BoxROI.h @@ -107,7 +107,7 @@ class BoxROI : public DataEngine public: //Input - Data > d_alignedBoxes; ///< each box is defined using xmin, ymin, zmin, xmax, ymax, zmax + Data > d_alignedBoxes; ///< List of boxes, each defined by two 3D points : xmin,ymin,zmin, xmax,ymax,zmax Data > d_orientedBoxes; ///< each box is defined using three point coordinates and a depth value /// Rest position coordinates of the degrees of freedom. /// If empty the positions from a MechanicalObject then a MeshLoader are searched in the current context. @@ -141,7 +141,7 @@ class BoxROI : public DataEngine Data< sofa::Size > d_nbIndices; ///< Number of selected indices //Parameter - Data d_drawBoxes; ///< Draw Boxes. (default = false) + Data d_drawBoxes; ///< Draw bounding box (default = false) Data d_drawPoints; ///< Draw Points. (default = false) Data d_drawEdges; ///< Draw Edges. (default = false) Data d_drawTriangles; ///< Draw Triangles. (default = false) diff --git a/Sofa/Component/Engine/Select/src/sofa/component/engine/select/BoxROI.inl b/Sofa/Component/Engine/Select/src/sofa/component/engine/select/BoxROI.inl index 22f0088c4ad..3fc654444ac 100644 --- a/Sofa/Component/Engine/Select/src/sofa/component/engine/select/BoxROI.inl +++ b/Sofa/Component/Engine/Select/src/sofa/component/engine/select/BoxROI.inl @@ -48,7 +48,7 @@ using type::vector ; template BoxROI::BoxROI() - : d_alignedBoxes( initData(&d_alignedBoxes, "box", "List of boxes defined by xmin,ymin,zmin, xmax,ymax,zmax") ) + : d_alignedBoxes( initData(&d_alignedBoxes, "box", "List of boxes, each defined by two 3D points : xmin,ymin,zmin, xmax,ymax,zmax") ) , d_orientedBoxes( initData(&d_orientedBoxes, "orientedBox", "List of boxes defined by 3 points (p0, p1, p2) and a depth distance \n" "A parallelogram will be defined by (p0, p1, p2, p3 = p0 + (p2-p1)). \n" "The box will finaly correspond to the parallelogram extrusion of depth/2 \n" @@ -66,7 +66,7 @@ BoxROI::BoxROI() , d_computeTetrahedra( initData(&d_computeTetrahedra, true,"computeTetrahedra","If true, will compute tetrahedra list and index list inside the ROI. (default = true)") ) , d_computeHexahedra( initData(&d_computeHexahedra, true,"computeHexahedra","If true, will compute hexahedra list and index list inside the ROI. (default = true)") ) , d_computeQuad( initData(&d_computeQuad, true,"computeQuad","If true, will compute quad list and index list inside the ROI. (default = true)") ) - , d_strict( initData(&d_strict, true,"strict","If true, an element is inside the box iif all of its nodes are inside. If False, only the center point of the element is checked. (default = true)") ) + , d_strict( initData(&d_strict, true,"strict","If true, an element is inside the box if all of its nodes are inside. If False, only the center point of the element is checked. (default = true)") ) , d_indices( initData(&d_indices,"indices","Indices of the points contained in the ROI") ) , d_edgeIndices( initData(&d_edgeIndices,"edgeIndices","Indices of the edges contained in the ROI") ) , d_triangleIndices( initData(&d_triangleIndices,"triangleIndices","Indices of the triangles contained in the ROI") ) @@ -80,7 +80,7 @@ BoxROI::BoxROI() , d_hexahedraInROI( initData(&d_hexahedraInROI,"hexahedraInROI","Hexahedra contained in the ROI") ) , d_quadInROI( initData(&d_quadInROI,"quadInROI","Quad contained in the ROI") ) , d_nbIndices( initData(&d_nbIndices,"nbIndices", "Number of selected indices") ) - , d_drawBoxes( initData(&d_drawBoxes,false,"drawBoxes","Draw Boxes. (default = false)") ) + , d_drawBoxes( initData(&d_drawBoxes,false,"drawBoxes","Draw bounding box (default = false)") ) , d_drawPoints( initData(&d_drawPoints,false,"drawPoints","Draw Points. (default = false)") ) , d_drawEdges( initData(&d_drawEdges,false,"drawEdges","Draw Edges. (default = false)") ) , d_drawTriangles( initData(&d_drawTriangles,false,"drawTriangles","Draw Triangles. (default = false)") ) diff --git a/Sofa/Component/Engine/Select/src/sofa/component/engine/select/ComplementaryROI.h b/Sofa/Component/Engine/Select/src/sofa/component/engine/select/ComplementaryROI.h index a5abd2c4214..6388c4652b4 100644 --- a/Sofa/Component/Engine/Select/src/sofa/component/engine/select/ComplementaryROI.h +++ b/Sofa/Component/Engine/Select/src/sofa/component/engine/select/ComplementaryROI.h @@ -70,14 +70,14 @@ class ComplementaryROI : public core::DataEngine /// inputs /// @{ Data d_position; ///< input positions - Data d_nbSet; ///< number of sets + Data d_nbSet; ///< number of sets to complement core::objectmodel::vectorData< SetIndex > vd_setIndices; ///< for each set, indices of the included points /// @} /// outputs /// @{ Data d_indices; ///< ROI indices - Data d_pointsInROI; ///< ROI positions + Data d_pointsInROI; ///< points in the ROI /// @} }; diff --git a/Sofa/Component/Engine/Select/src/sofa/component/engine/select/MeshSampler.h b/Sofa/Component/Engine/Select/src/sofa/component/engine/select/MeshSampler.h index a72b8537786..0c1886c607b 100644 --- a/Sofa/Component/Engine/Select/src/sofa/component/engine/select/MeshSampler.h +++ b/Sofa/Component/Engine/Select/src/sofa/component/engine/select/MeshSampler.h @@ -70,12 +70,12 @@ class MeshSampler : public core::DataEngine Data number; ///< Sample number - Data< VecCoord > position; ///< input positions - Data< SeqEdges > f_edges; ///< input edges for geodesic sampling + Data< VecCoord > position; ///< Input positions. + Data< SeqEdges > f_edges; ///< Input edges for geodesic sampling (Euclidean distances are used if not specified). Data< VecCoord > fixedPosition; ///< User defined sample positions. - Data maxIter; ///< Max number of LLoyd iterations - Data< VI > outputIndices; ///< selected point indices - Data< VecCoord > outputPosition; ///< selected point coordinates + Data maxIter; ///< Max number of Lloyd iterations. + Data< VI > outputIndices; ///< Computed sample indices. + Data< VecCoord > outputPosition; ///< Computed sample coordinates. private: diff --git a/Sofa/Component/Engine/Select/src/sofa/component/engine/select/NearestPointROI.h b/Sofa/Component/Engine/Select/src/sofa/component/engine/select/NearestPointROI.h index c3bfc53f8fb..98570fa7578 100644 --- a/Sofa/Component/Engine/Select/src/sofa/component/engine/select/NearestPointROI.h +++ b/Sofa/Component/Engine/Select/src/sofa/component/engine/select/NearestPointROI.h @@ -64,15 +64,15 @@ class NearestPointROI : public sofa::core::DataEngine, public core::behavior::Pa SetIndex d_inputIndices1; ///< Only these indices are considered in the first model SetIndex d_inputIndices2; ///< Only these indices are considered in the second model - Data f_radius; ///< Radius to search corresponding fixed point if no indices are given - Data d_useRestPosition; ///< If true will use rest position only at init. Otherwise will recompute the maps at each update. Default is true. + Data f_radius; ///< Radius to search corresponding fixed point + Data d_useRestPosition; ///< If true will use restPosition only at init /// Output Data ///@{ SetIndex f_indices1; ///< Indices of the source points on the first model SetIndex f_indices2; ///< Indices of the fixed points on the second model - Data< sofa::type::vector > d_edges; ///< List of edges. The indices point to a list composed as an interleaved fusion of output degrees of freedom. It could be used to fuse two mechanical objects and create a topology from the fusion. - Data< type::vector > d_indexPairs; ///< Two indices per child: the parent, and the index within the parent. Could be used with a SubsetMultiMapping + Data< sofa::type::vector > d_edges; ///< List of edge indices + Data< type::vector > d_indexPairs; ///< list of couples (parent index + index in the parent) Data< type::vector > d_distances; ///< List of distances between pairs of points ///@} diff --git a/Sofa/Component/Engine/Select/src/sofa/component/engine/select/PlaneROI.h b/Sofa/Component/Engine/Select/src/sofa/component/engine/select/PlaneROI.h index e379506ebf2..631a295fc77 100644 --- a/Sofa/Component/Engine/Select/src/sofa/component/engine/select/PlaneROI.h +++ b/Sofa/Component/Engine/Select/src/sofa/component/engine/select/PlaneROI.h @@ -102,11 +102,11 @@ class PlaneROI : public core::DataEngine public: //Input - Data< type::vector > planes; ///< Plane defined by 3 points and a depth distance + Data< type::vector > planes; ///< List of planes defined by 3 points and a depth distance Data f_X0; ///< Rest position coordinates of the degrees of freedom Data > f_edges; ///< Edge Topology Data > f_triangles; ///< Triangle Topology - Data > f_tetrahedra; ///< NOT YET + Data > f_tetrahedra; ///< Tetrahedron Topology Data f_computeEdges; ///< If true, will compute edge list and index list inside the ROI. Data f_computeTriangles; ///< If true, will compute triangle list and index list inside the ROI. Data f_computeTetrahedra; ///< If true, will compute tetrahedra list and index list inside the ROI. diff --git a/Sofa/Component/Engine/Select/src/sofa/component/engine/select/PlaneROI.inl b/Sofa/Component/Engine/Select/src/sofa/component/engine/select/PlaneROI.inl index 9205c41fb0d..272cde951b5 100644 --- a/Sofa/Component/Engine/Select/src/sofa/component/engine/select/PlaneROI.inl +++ b/Sofa/Component/Engine/Select/src/sofa/component/engine/select/PlaneROI.inl @@ -29,7 +29,7 @@ namespace sofa::component::engine::select template PlaneROI::PlaneROI() - : planes( initData(&planes, "plane", "Plane defined by 3 points and a depth distance") ) + : planes( initData(&planes, "plane", "List of planes defined by 3 points and a depth distance") ) , f_X0( initData (&f_X0, "position", "Rest position coordinates of the degrees of freedom") ) , f_edges(initData (&f_edges, "edges", "Edge Topology") ) , f_triangles(initData (&f_triangles, "triangles", "Triangle Topology") ) diff --git a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/DilateEngine.h b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/DilateEngine.h index 7b21a0a1429..10e9db4b5fe 100644 --- a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/DilateEngine.h +++ b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/DilateEngine.h @@ -62,11 +62,11 @@ class DilateEngine : public core::DataEngine void doUpdate() override; protected: - Data d_inputX; ///< input position - Data d_outputX; ///< ouput position - Data d_triangles; ///< input triangles - Data d_quads; ///< input quads - Data d_normals; ///< ouput normals + Data d_inputX; ///< input array of 3d points + Data d_outputX; ///< output array of 3d points + Data d_triangles; ///< input mesh triangles + Data d_quads; ///< input mesh quads + Data d_normals; ///< point normals Data > d_thickness; ///< point thickness Data d_distance; ///< distance to move the points (positive for dilatation, negative for erosion) Data d_minThickness; ///< minimal thickness to enforce diff --git a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/DisplacementMatrixEngine.h b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/DisplacementMatrixEngine.h index 10e52e24517..0a5f79a5f41 100644 --- a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/DisplacementMatrixEngine.h +++ b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/DisplacementMatrixEngine.h @@ -57,11 +57,11 @@ class DisplacementTransformEngine : public sofa::core::DataEngine typedef typename DataTypes::VecCoord VecCoord; // inputs - Data< VecCoord > d_x0; ///< initial bone positions - Data< VecCoord > d_x; ///< current bone positions + Data< VecCoord > d_x0; ///< Rest position + Data< VecCoord > d_x; ///< Current position // outputs - Data< type::vector< OutputType > > d_displacements; ///< displacement + Data< type::vector< OutputType > > d_displacements; ///< Displacement transforms with respect to original rigid positions // methods DisplacementTransformEngine(); @@ -115,7 +115,7 @@ class DisplacementMatrixEngine : public DisplacementTransformEngine > > d_scales; ///< scale matrices + Data< type::vector< sofa::type::Vec<3,Real> > > d_scales; ///< Scale transformation added to the rigid transformation type::vector SxInverses; ///< inverse initial positions }; diff --git a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/IndexValueMapper.inl b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/IndexValueMapper.inl index 87ebb5e67a6..a58303685e7 100644 --- a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/IndexValueMapper.inl +++ b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/IndexValueMapper.inl @@ -28,9 +28,9 @@ namespace sofa::component::engine::transform template IndexValueMapper::IndexValueMapper() - : f_inputValues(initData(&f_inputValues, "inputValues", "Already existing values (can be empty) ")) - , f_indices(initData(&f_indices, "indices", "Indices to map value on ")) - , f_value(initData(&f_value, "value", "Value to map indices on ")) + : f_inputValues(initData(&f_inputValues, "inputValues", "Already existing values (can be empty)")) + , f_indices(initData(&f_indices, "indices", "Indices to map value on")) + , f_value(initData(&f_value, "value", "Value to map indices on")) , f_outputValues(initData(&f_outputValues, "outputValues", "New map between indices and values")) , p_defaultValue(initData(&p_defaultValue, (Real) 1.0, "defaultValue", "Default value for indices without any value")) { diff --git a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/ProjectiveTransformEngine.h b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/ProjectiveTransformEngine.h index 57f1b887428..7fcca0768af 100644 --- a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/ProjectiveTransformEngine.h +++ b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/ProjectiveTransformEngine.h @@ -63,10 +63,10 @@ class ProjectiveTransformEngine : public core::DataEngine void doUpdate() override; protected: - Data f_inputX; ///< input position - Data f_outputX; ///< output position: Z=focal_distance - Data proj_mat; ///< 3x4 projection matrix - Data focal_distance; ///< focal distance i.e. distance between the optical center and the image plane + Data f_inputX; ///< input array of 3d points + Data f_outputX; ///< output array of projected 3d points + Data proj_mat; ///< projection matrix + Data focal_distance; ///< focal distance }; #if !defined(SOFA_COMPONENT_ENGINE_PROJECTIVETRANSFORMENGINE_CPP) diff --git a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/ProjectiveTransformEngine.inl b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/ProjectiveTransformEngine.inl index 14fc29b1c62..a5357fbec01 100644 --- a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/ProjectiveTransformEngine.inl +++ b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/ProjectiveTransformEngine.inl @@ -32,7 +32,7 @@ template ProjectiveTransformEngine::ProjectiveTransformEngine() : f_inputX ( initData (&f_inputX, "input_position", "input array of 3d points") ) , f_outputX( initData (&f_outputX, "output_position", "output array of projected 3d points") ) - , proj_mat(initData(&proj_mat, "proj_mat", "projection matrix ") ) + , proj_mat(initData(&proj_mat, "proj_mat", "projection matrix") ) , focal_distance(initData(&focal_distance, (Real)1,"focal_distance", "focal distance ") ) { addInput(&f_inputX); diff --git a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/RigidToQuatEngine.h b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/RigidToQuatEngine.h index 3e77775c006..6bdb743d003 100644 --- a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/RigidToQuatEngine.h +++ b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/RigidToQuatEngine.h @@ -57,7 +57,7 @@ class RigidToQuatEngine : public sofa::core::DataEngine Data > f_positions; ///< Positions (Vector of 3) Data > f_orientations; ///< Orientations (Quaternion) - Data > f_orientationsEuler; ///< Orientation (Euler angle) + Data > f_orientationsEuler; ///< Orientations (Euler angle) Data > f_rigids; ///< Rigid (Position + Orientation) }; diff --git a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformEngine.h b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformEngine.h index c8d8c264c51..32a85d223fb 100644 --- a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformEngine.h +++ b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformEngine.h @@ -59,12 +59,12 @@ class TransformEngine : public core::DataEngine protected: void doUpdate() override; - Data f_inputX; ///< input position - Data f_outputX; ///< ouput position - Data translation; ///< translation - Data rotation; ///< rotation - Data> quaternion; ///< quaternion rotation - Data scale; ///< scale + Data f_inputX; ///< input array of 3d points + Data f_outputX; ///< output array of 3d points + Data translation; ///< translation vector (x,y,z) + Data rotation; ///< rotation vector (x,y,z) + Data> quaternion; ///< rotation quaternion (qx,qy,qz,qw) + Data scale; ///< scale factor Data inverse; ///< true to apply inverse transformation }; diff --git a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformEngine.inl b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformEngine.inl index 5c86ba05f94..7f48ad22fb8 100644 --- a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformEngine.inl +++ b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformEngine.inl @@ -34,9 +34,9 @@ template TransformEngine::TransformEngine() : f_inputX ( initData (&f_inputX, "input_position", "input array of 3d points") ) , f_outputX( initData (&f_outputX, "output_position", "output array of 3d points") ) - , translation(initData(&translation, type::Vec3(0_sreal,0_sreal,0_sreal),"translation", "translation vector ") ) - , rotation(initData(&rotation, type::Vec3(0_sreal,0_sreal,0_sreal), "rotation", "rotation vector ") ) - , quaternion(initData(&quaternion, type::Quat(0_sreal,0_sreal,0_sreal,1_sreal), "quaternion", "rotation quaternion ") ) + , translation(initData(&translation, type::Vec3(0_sreal,0_sreal,0_sreal),"translation", "translation vector (x,y,z)") ) + , rotation(initData(&rotation, type::Vec3(0_sreal,0_sreal,0_sreal), "rotation", "rotation vector (x,y,z)") ) + , quaternion(initData(&quaternion, type::Quat(0_sreal,0_sreal,0_sreal,1_sreal), "quaternion", "rotation quaternion (qx,qy,qz,qw)") ) , scale(initData(&scale, type::Vec3(1_sreal,1_sreal,1_sreal),"scale", "scale factor") ) , inverse(initData(&inverse, false, "inverse", "true to apply inverse transformation")) { diff --git a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformMatrixEngine.h b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformMatrixEngine.h index cd68befbc9c..db223e5a782 100644 --- a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformMatrixEngine.h +++ b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformMatrixEngine.h @@ -52,8 +52,8 @@ class SOFA_COMPONENT_ENGINE_TRANSFORM_API AbstractTransformMatrixEngine : public void reinit() override; protected: - Data d_inT; ///< input transformation - Data d_outT; ///< input transformation + Data d_inT; ///< input transformation if any + Data d_outT; ///< output transformation }; /** @@ -135,7 +135,7 @@ class SOFA_COMPONENT_ENGINE_TRANSFORM_API ScaleTransformMatrixEngine : public Ab void init() override; protected: - Data d_scale; ///< scale + Data d_scale; ///< scaling values }; } //namespace sofa::component::engine::transform diff --git a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformPosition.h b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformPosition.h index ee6e6fe75c5..85b8a9ed5b2 100644 --- a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformPosition.h +++ b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/TransformPosition.h @@ -92,18 +92,18 @@ class TransformPosition : public core::DataEngine protected: TransformationMethod transformationMethod; - Data f_origin; ///< origin used by projectOnPlane - Data f_inputX; ///< input position - Data f_outputX; ///< ouput position - Data f_normal; ///< normal used by projectOnPlane - Data f_translation; ///< translation - Data f_rotation; ///< rotation - Data f_scale; ///< scale - Data f_affineMatrix; ///< affine transformation - Data f_method; ///< the method of the transformation - Data f_seed; ///< the seed for the random generator - Data f_maxRandomDisplacement; ///< the maximum displacement for the random generator - Data f_fixedIndices; ///< the indices of the elements that are not transformed + Data f_origin; ///< A 3d point on the plane/Center of the scale + Data f_inputX; ///< input array of 3d points + Data f_outputX; ///< output array of 3d points projected on a plane + Data f_normal; ///< plane normal + Data f_translation; ///< translation vector + Data f_rotation; ///< rotation vector + Data f_scale; ///< scale factor + Data f_affineMatrix; ///< 4x4 affine matrix + Data f_method; ///< transformation method either translation or scale or rotation or random or projectOnPlane + Data f_seed; ///< the seed value for the random generator + Data f_maxRandomDisplacement; ///< the maximum displacement around initial position for the random transformation + Data f_fixedIndices; ///< Indices of the entries that are not transformed core::objectmodel::DataFileName f_filename; ///< filename of an affine matrix. Supported extensions are: .trm, .tfm, .xfm and .txt(read as .xfm) Data f_drawInput; ///< Draw input points Data f_drawOutput; ///< Draw output points diff --git a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/Vertex2Frame.h b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/Vertex2Frame.h index 8493e6d1e15..5a1ae34f7a8 100644 --- a/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/Vertex2Frame.h +++ b/Sofa/Component/Engine/Transform/src/sofa/component/engine/transform/Vertex2Frame.h @@ -60,7 +60,7 @@ class Vertex2Frame : public core::DataEngine protected: typename sofa::core::behavior::MechanicalState::SPtr m_mstate; Data< type::vector > d_vertices; ///< Vertices of the mesh loaded - Data< type::vector > d_texCoords; ///< for the moment, we suppose that texCoords is order 2 (2 texCoords for a vertex) + Data< type::vector > d_texCoords; ///< TexCoords of the mesh loaded Data< type::vector > d_normals; ///< Normals of the mesh loaded Data d_frames; ///< Frames at output diff --git a/Sofa/Component/Haptics/src/sofa/component/haptics/LCPForceFeedback.h b/Sofa/Component/Haptics/src/sofa/component/haptics/LCPForceFeedback.h index 2f0c4f73dc3..7cce0bc5b15 100644 --- a/Sofa/Component/Haptics/src/sofa/component/haptics/LCPForceFeedback.h +++ b/Sofa/Component/Haptics/src/sofa/component/haptics/LCPForceFeedback.h @@ -64,7 +64,7 @@ class LCPForceFeedback : public MechanicalStateForceFeedback Data< double > solverTimeout; ///< max time to spend solving constraints. - Data< int > d_solverMaxIt; ///< max iteration to spend solving constraints. + Data< int > d_solverMaxIt; ///< max iteration to spend solving constraints // deriv (or not) the rotations when updating the violations Data d_derivRotations; ///< if true, deriv the rotations when updating the violations diff --git a/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/GridMeshCreator.h b/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/GridMeshCreator.h index 0c76b2224e5..e28918028e5 100644 --- a/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/GridMeshCreator.h +++ b/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/GridMeshCreator.h @@ -48,8 +48,8 @@ class SOFA_COMPONENT_IO_MESH_API GridMeshCreator : public sofa::core::loader::Me - Data< type::Vec2i > d_resolution; ///< Number of vertices in each direction - Data< int > d_trianglePattern; ///< 0: no triangles, 1: alternate triangles, 2: upward triangles, 3: downward triangles. + Data< type::Vec2i > d_resolution; ///< Number of vertices in each direction + Data< int > d_trianglePattern; ///< 0: no triangles, 1: alternate triangles, 2: upward triangles, 3: downward triangles protected: GridMeshCreator(); diff --git a/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/STLExporter.h b/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/STLExporter.h index b3577264c68..8b4b45ce2a3 100644 --- a/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/STLExporter.h +++ b/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/STLExporter.h @@ -57,7 +57,7 @@ class SOFA_COMPONENT_IO_MESH_API STLExporter : public BaseSimulationExporter public: SOFA_CLASS(STLExporter, BaseSimulationExporter); - Data d_binaryFormat; //0 for Ascii Formats, 1 for Binary File Format + Data d_binaryFormat; ///< if true, save in binary format, otherwise in ascii Data d_position; ///< points coordinates Data< type::vector< BaseMeshTopology::Triangle > > d_triangle; ///< triangles indices Data< type::vector< BaseMeshTopology::Quad > > d_quad; ///< quads indices diff --git a/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/SphereLoader.h b/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/SphereLoader.h index e48ad6d353b..ce6e202379b 100644 --- a/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/SphereLoader.h +++ b/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/SphereLoader.h @@ -38,7 +38,7 @@ class SphereLoader : public sofa::core::loader::BaseLoader // Point coordinates in 3D. Data< type::vector > d_positions; ///< Sphere centers Data< type::vector > d_radius; ///< Radius of each sphere - Data< type::Vec3 > d_scale; ///< Scale applied to sphere positions + Data< type::Vec3 > d_scale; ///< Scale applied to sphere positions & radius Data< type::Vec3 > d_rotation; ///< Rotation of the DOFs Data< type::Vec3 > d_translation; ///< Translation applied to sphere positions bool load() override; diff --git a/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/StringMeshCreator.h b/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/StringMeshCreator.h index 5cc0fc6be91..821d85b4612 100644 --- a/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/StringMeshCreator.h +++ b/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/StringMeshCreator.h @@ -44,7 +44,7 @@ class SOFA_COMPONENT_IO_MESH_API StringMeshCreator : public sofa::core::loader:: bool canLoad() override { return true; } bool doLoad() override; ///< create the string - Data< unsigned > d_resolution; ///< Number of vertices (more than 1) + Data< unsigned > d_resolution; ///< Number of vertices protected: StringMeshCreator(); diff --git a/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/VTKExporter.h b/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/VTKExporter.h index 53418617e5d..0f76b2e311a 100644 --- a/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/VTKExporter.h +++ b/Sofa/Component/IO/Mesh/src/sofa/component/io/mesh/VTKExporter.h @@ -100,7 +100,7 @@ class SOFA_COMPONENT_IO_MESH_API VTKExporter : public core::objectmodel::BaseObj sofa::core::objectmodel::DataFileName d_vtkFilename; - Data d_fileFormat; ///< 0 for Simple Legacy Formats, 1 for XML File Format + Data d_fileFormat; ///< Set to true to use XML format Data d_position; ///< points position (will use points from topology or mechanical state if this is empty) Data d_writeEdges; ///< write edge topology Data d_writeTriangles; ///< write triangle topology diff --git a/Sofa/Component/LinearSolver/Direct/src/sofa/component/linearsolver/direct/SparseLDLSolverImpl.h b/Sofa/Component/LinearSolver/Direct/src/sofa/component/linearsolver/direct/SparseLDLSolverImpl.h index 0fb14dc69e9..d808bad9bfb 100644 --- a/Sofa/Component/LinearSolver/Direct/src/sofa/component/linearsolver/direct/SparseLDLSolverImpl.h +++ b/Sofa/Component/LinearSolver/Direct/src/sofa/component/linearsolver/direct/SparseLDLSolverImpl.h @@ -171,7 +171,8 @@ protected : SparseLDLSolverImpl() - : d_precomputeSymbolicDecomposition(initData(&d_precomputeSymbolicDecomposition, true ,"precomputeSymbolicDecomposition", "If true the solver will reuse the precomputed symbolic decomposition. Otherwise it will recompute it at each step.")) + : d_precomputeSymbolicDecomposition(initData(&d_precomputeSymbolicDecomposition, true ,"precomputeSymbolicDecomposition", "If true, the solver will reuse the precomputed symbolic decomposition, meaning that it will store the shape of [factor matrix] on the first step, or when its shape changes, and then it will only update its coefficients. When the shape of the matrix changes, a new factorization is computed." + "If false, the solver will compute the entire decomposition at each step")) , d_L_nnz(initData(&d_L_nnz, 0, "L_nnz", "Number of non-zero values in the lower triangular matrix of the factorization. The lower, the faster the system is solved.", true, true)) {} diff --git a/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/CGLinearSolver.h b/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/CGLinearSolver.h index e45c103b9a3..46783dd8559 100644 --- a/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/CGLinearSolver.h +++ b/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/CGLinearSolver.h @@ -40,10 +40,10 @@ class CGLinearSolver : public sofa::component::linearsolver::MatrixLinearSolver< typedef sofa::component::linearsolver::MatrixLinearSolver Inherit; using Real = typename Matrix::Real; - Data d_maxIter; ///< maximum number of iterations of the Conjugate Gradient solution - Data d_tolerance; ///< desired precision of the Conjugate Gradient Solution (ratio of current residual norm over initial residual norm) - Data d_smallDenominatorThreshold; ///< minimum value of the denominator in the conjugate Gradient solution - Data d_warmStart; ///< Use previous solution as initial solution + Data d_maxIter; ///< Maximum number of iterations after which the iterative descent of the Conjugate Gradient must stop + Data d_tolerance; ///< Desired accuracy of the Conjugate Gradient solution evaluating: |r|²/|b|² (ratio of current residual norm over initial residual norm) + Data d_smallDenominatorThreshold; ///< Minimum value of the denominator (pT A p)^ in the conjugate Gradient solution + Data d_warmStart; ///< Use previous solution as initial solution, which may improve the initial guess if your system is evolving smoothly Data > > d_graph; ///< Graph of residuals at each iteration protected: diff --git a/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/CGLinearSolver.inl b/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/CGLinearSolver.inl index 7903e581465..51a042632df 100644 --- a/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/CGLinearSolver.inl +++ b/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/CGLinearSolver.inl @@ -33,10 +33,10 @@ namespace sofa::component::linearsolver::iterative /// Linear system solver using the conjugate gradient iterative algorithm template CGLinearSolver::CGLinearSolver() - : d_maxIter( initData(&d_maxIter, 25u,"iterations","Maximum number of iterations of the Conjugate Gradient solution") ) + : d_maxIter( initData(&d_maxIter, 25u,"iterations","Maximum number of iterations after which the iterative descent of the Conjugate Gradient must stop") ) , d_tolerance( initData(&d_tolerance,(Real)1e-5,"tolerance","Desired accuracy of the Conjugate Gradient solution evaluating: |r|²/|b|² (ratio of current residual norm over initial residual norm)") ) , d_smallDenominatorThreshold( initData(&d_smallDenominatorThreshold,(Real)1e-5,"threshold","Minimum value of the denominator (pT A p)^ in the conjugate Gradient solution") ) - , d_warmStart( initData(&d_warmStart,false,"warmStart","Use previous solution as initial solution") ) + , d_warmStart( initData(&d_warmStart,false,"warmStart","Use previous solution as initial solution, which may improve the initial guess if your system is evolving smoothly") ) , d_graph( initData(&d_graph,"graph","Graph of residuals at each iteration") ) { d_graph.setWidget("graph"); diff --git a/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/ShewchukPCGLinearSolver.h b/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/ShewchukPCGLinearSolver.h index 87c1f94d659..8e0b1e2301b 100644 --- a/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/ShewchukPCGLinearSolver.h +++ b/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/ShewchukPCGLinearSolver.h @@ -42,9 +42,9 @@ class ShewchukPCGLinearSolver : public sofa::component::linearsolver::MatrixLine typedef TVector Vector; typedef sofa::component::linearsolver::MatrixLinearSolver Inherit; - Data f_maxIter; ///< maximum number of iterations of the Conjugate Gradient solution - Data f_tolerance; ///< desired precision of the Conjugate Gradient Solution (ratio of current residual norm over initial residual norm) - Data f_use_precond; ///< Use preconditioner + Data f_maxIter; ///< Maximum number of iterations after which the iterative descent of the Conjugate Gradient must stop + Data f_tolerance; ///< Desired accuracy of the Conjugate Gradient solution evaluating: |r|²/|b|² (ratio of current residual norm over initial residual norm) + Data f_use_precond; ///< Use a preconditioner SingleLink l_preconditioner; ///< Link towards the linear solver used to precondition the conjugate gradient Data f_update_step; ///< Number of steps before the next refresh of precondtioners Data f_build_precond; ///< Build the preconditioners, if false build the preconditioner only at the initial step diff --git a/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/ShewchukPCGLinearSolver.inl b/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/ShewchukPCGLinearSolver.inl index 083163bd18f..08473945b15 100644 --- a/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/ShewchukPCGLinearSolver.inl +++ b/Sofa/Component/LinearSolver/Iterative/src/sofa/component/linearsolver/iterative/ShewchukPCGLinearSolver.inl @@ -36,9 +36,9 @@ namespace sofa::component::linearsolver::iterative template ShewchukPCGLinearSolver::ShewchukPCGLinearSolver() - : f_maxIter( initData(&f_maxIter,(unsigned)25,"iterations","maximum number of iterations of the Conjugate Gradient solution") ) - , f_tolerance( initData(&f_tolerance,1e-5,"tolerance","desired precision of the Conjugate Gradient Solution (ratio of current residual norm over initial residual norm)") ) - , f_use_precond( initData(&f_use_precond,true,"use_precond","Use preconditioner") ) + : f_maxIter( initData(&f_maxIter,(unsigned)25,"iterations","Maximum number of iterations after which the iterative descent of the Conjugate Gradient must stop") ) + , f_tolerance( initData(&f_tolerance,1e-5,"tolerance","Desired accuracy of the Conjugate Gradient solution evaluating: |r|²/|b|² (ratio of current residual norm over initial residual norm)") ) + , f_use_precond( initData(&f_use_precond,true,"use_precond","Use a preconditioner") ) , l_preconditioner(initLink("preconditioner", "Link towards the linear solver used to precondition the conjugate gradient")) , f_update_step( initData(&f_update_step,(unsigned)1,"update_step","Number of steps before the next refresh of precondtioners") ) , f_build_precond( initData(&f_build_precond,true,"build_precond","Build the preconditioners, if false build the preconditioner only at the initial step") ) diff --git a/Sofa/Component/LinearSystem/src/sofa/component/linearsystem/ConstantSparsityProjectionMethod.h b/Sofa/Component/LinearSystem/src/sofa/component/linearsystem/ConstantSparsityProjectionMethod.h index 48b0bf638f7..468ac200aa6 100644 --- a/Sofa/Component/LinearSystem/src/sofa/component/linearsystem/ConstantSparsityProjectionMethod.h +++ b/Sofa/Component/LinearSystem/src/sofa/component/linearsystem/ConstantSparsityProjectionMethod.h @@ -40,7 +40,7 @@ class ConstantSparsityProjectionMethod : public MatrixProjectionMethod ConstantSparsityProjectionMethod(); ~ConstantSparsityProjectionMethod() override; - Data d_parallelProduct; + Data d_parallelProduct; ///< Compute the matrix product in parallel void init() override; void reinit() override; diff --git a/Sofa/Component/LinearSystem/src/sofa/component/linearsystem/matrixaccumulators/BaseAssemblingMatrixAccumulator.h b/Sofa/Component/LinearSystem/src/sofa/component/linearsystem/matrixaccumulators/BaseAssemblingMatrixAccumulator.h index 9c1c326db32..be731087f49 100644 --- a/Sofa/Component/LinearSystem/src/sofa/component/linearsystem/matrixaccumulators/BaseAssemblingMatrixAccumulator.h +++ b/Sofa/Component/LinearSystem/src/sofa/component/linearsystem/matrixaccumulators/BaseAssemblingMatrixAccumulator.h @@ -52,9 +52,9 @@ class BaseAssemblingMatrixAccumulator : public sofa::core::get_base_object_stron BaseAssemblingMatrixAccumulator(); - Data< sofa::type::Vec2u > d_matrixSize; /// Size of the local matrix - Data< sofa::type::Vec2u > d_positionInGlobalMatrix; /// Position of this local matrix in the global matrix - Data< SReal > d_factor; /// factor applied on matrix entries + Data< sofa::type::Vec2u > d_matrixSize; ///< Size of the local matrix + Data< sofa::type::Vec2u > d_positionInGlobalMatrix; ///< Position of this local matrix in the global matrix + Data< SReal > d_factor; ///< Factor applied to matrix entries. This factor depends on the ODE solver and the associated component. sofa::linearalgebra::BaseMatrix* m_globalMatrix { nullptr }; diff --git a/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/BarycentricMapping.h b/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/BarycentricMapping.h index 4f68d4b4fcf..236ab760b61 100644 --- a/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/BarycentricMapping.h +++ b/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/BarycentricMapping.h @@ -62,7 +62,7 @@ class BarycentricMapping : public LinearMapping typedef TopologyBarycentricMapper Mapper; public: - Data< bool > d_useRestPosition; ///< Use the rest position of the input and output models to initialize the mapping + Data< bool > d_useRestPosition; ///< Use the rest position of the input and output models to initialize the mapping SingleLink,Mapper,BaseLink::FLAG_STRONGLINK> d_mapper; SingleLink,BaseMeshTopology,BaseLink::FLAG_STRONGLINK> d_input_topology; diff --git a/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/Mesh2PointTopologicalMapping.h b/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/Mesh2PointTopologicalMapping.h index f8d03c1f35f..40221619407 100644 --- a/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/Mesh2PointTopologicalMapping.h +++ b/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/Mesh2PointTopologicalMapping.h @@ -127,7 +127,7 @@ class SOFA_COMPONENT_MAPPING_LINEAR_API Mesh2PointTopologicalMapping : public so Data< bool > copyEdges; ///< Activate mapping of input edges into the output topology (requires at least one item in pointBaryCoords) Data< bool > copyTriangles; ///< Activate mapping of input triangles into the output topology (requires at least one item in pointBaryCoords) - Data< bool > copyTetrahedra; ///< Activate mapping of input tetrahedras into the output topology (requires at least one item in pointBaryCoords) + Data< bool > copyTetrahedra; ///< Activate mapping of input tetrahedra into the output topology (requires at least one item in pointBaryCoords) type::fixed_array< type::vector< type::vector >, NB_ELEMENTS > pointsMappedFrom; ///< Points mapped from the differents elements (see the enum Element declared before) diff --git a/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/SimpleTesselatedTetraTopologicalMapping.h b/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/SimpleTesselatedTetraTopologicalMapping.h index 6688dfa8f2b..9d944969cfe 100644 --- a/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/SimpleTesselatedTetraTopologicalMapping.h +++ b/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/SimpleTesselatedTetraTopologicalMapping.h @@ -90,11 +90,11 @@ class SOFA_COMPONENT_MAPPING_LINEAR_API SimpleTesselatedTetraTopologicalMapping const type::vector& getPointSource() const { return d_pointSource.getValue(); } protected: - core::topology::TetrahedronData< sofa::type::vector > > tetrahedraMappedFromTetra; ///< Each Tetrahedron of the input topology is mapped to the 8 tetrahedrons in which it can be divided. - core::topology::TetrahedronData< sofa::type::vector > tetraSource; /// > > tetrahedraMappedFromTetra; ///< Each Tetrahedron of the input topology is mapped to the 8 tetrahedrons in which it can be divided + core::topology::TetrahedronData< sofa::type::vector > tetraSource; ///< Which tetra from the input topology map to a given tetra in the output topology (sofa::InvalidID if none) - Data< type::vector > d_pointMappedFromPoint; ///< Each point of the input topology is mapped to the same point. - Data< type::vector > d_pointMappedFromEdge; ///< Each edge of the input topology is mapped to his midpoint. + Data< type::vector > d_pointMappedFromPoint; ///< Each point of the input topology is mapped to the same point + Data< type::vector > d_pointMappedFromEdge; ///< Each edge of the input topology is mapped to his midpoint Data< type::vector > d_pointSource; ///< Which input topology element map to a given point in the output topology : 0 -> none, > 0 -> point index + 1, < 0 , - edge index -1 void swapOutputPoints(Index i1, Index i2); diff --git a/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/SkinningMapping.h b/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/SkinningMapping.h index a9ab713d4aa..2736d7c5d8d 100644 --- a/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/SkinningMapping.h +++ b/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/SkinningMapping.h @@ -75,7 +75,7 @@ class SkinningMapping : public LinearMapping typedef linearalgebra::EigenSparseMatrix SparseJMatrixEigen; protected: - Data f_initPos; ///< initial child coordinates in the world reference frame + Data f_initPos; ///< initial child coordinates in the world reference frame. // data for linear blending type::vector > f_localPos; /// initial child coordinates in local frame x weight : dp = dMa_i (w_i \bar M_i f_localPos) @@ -84,7 +84,7 @@ class SkinningMapping : public LinearMapping // data for dual quat blending Data< type::vector > nbRef; ///< Number of primitives influencing each point. - Data< type::vector > > f_index; ///< indices of primitives influencing each point. + Data< type::vector > > f_index; ///< parent indices for each child. Data< type::vector > > weight; ///< influence weights of the Dofs. void updateWeights(); diff --git a/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/SubsetMultiMapping.h b/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/SubsetMultiMapping.h index 35af51543da..cdfb060688c 100644 --- a/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/SubsetMultiMapping.h +++ b/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/SubsetMultiMapping.h @@ -90,7 +90,7 @@ class SubsetMultiMapping : public LinearMultiMapping virtual const type::vector* getJs() override; - Data< type::vector > indexPairs; ///< Two indices per child: the parent, and the index within the parent + Data< type::vector > indexPairs; ///< list of couples (parent index + index in the parent) protected : diff --git a/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/TubularMapping.h b/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/TubularMapping.h index 1c30a35d47e..ce94af27332 100644 --- a/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/TubularMapping.h +++ b/Sofa/Component/Mapping/Linear/src/sofa/component/mapping/linear/TubularMapping.h @@ -87,9 +87,9 @@ class TubularMapping : public LinearMapping void applyJT ( const core::ConstraintParams* /*cparams*/, InDataMatrixDeriv& dOut, const OutDataMatrixDeriv& dIn ) override; - Data m_nbPointsOnEachCircle; ///< number of points along the circles around each point of the input object (10 by default) - Data m_radius; ///< radius of the circles around each point of the input object (1 by default) - Data m_peak; ///< if 1 or 2 creates a peak at the end + Data m_nbPointsOnEachCircle; ///< Discretization of created circles + Data m_radius; ///< Radius of created circles + Data m_peak; ///< =0 no peak, =1 peak on the first segment =2 peak on the two first segment, =-1 peak on the last segment protected: diff --git a/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceFromTargetMapping.h b/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceFromTargetMapping.h index 8f9413e4114..3feb77115ec 100644 --- a/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceFromTargetMapping.h +++ b/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceFromTargetMapping.h @@ -83,9 +83,9 @@ class DistanceFromTargetMapping : public core::Mapping, public BaseDi enum {Nin = In::deriv_total_size, Nout = Out::deriv_total_size }; typedef type::Vec Direction; - Data> f_indices; ///< Indices of the parent points - Data f_targetPositions; ///< Positions to compute the distances from - Data> f_restDistances; ///< Rest lengths of the connections + Data> f_indices; ///< Indices of the parent points + Data f_targetPositions; ///< Positions to compute the distances from + Data> f_restDistances; ///< Rest lengths of the connections /// Add a target with a desired distance void createTarget( unsigned index, const InCoord& position, Real distance); diff --git a/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceFromTargetMapping.inl b/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceFromTargetMapping.inl index ab28f996330..389c57b0127 100644 --- a/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceFromTargetMapping.inl +++ b/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceFromTargetMapping.inl @@ -38,7 +38,7 @@ DistanceFromTargetMapping::DistanceFromTargetMapping() : Inherit() , f_indices(initData(&f_indices, "indices", "Indices of the parent points")) , f_targetPositions(initData(&f_targetPositions, "targetPositions", "Positions to compute the distances from")) - , f_restDistances(initData(&f_restDistances, "restLengths", "Rest lengths of the connections.")) + , f_restDistances(initData(&f_restDistances, "restLengths", "Rest lengths of the connections")) , d_showObjectScale(initData(&d_showObjectScale, 0.f, "showObjectScale", "Scale for object display")) , d_color(initData(&d_color, sofa::type::RGBAColor(1,1,0,1), "showColor", "Color for object display. (default=[1.0,1.0,0.0,1.0])")) { diff --git a/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceMapping.h b/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceMapping.h index ce20e9c62fe..8716da1ee94 100644 --- a/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceMapping.h +++ b/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceMapping.h @@ -82,10 +82,10 @@ class DistanceMapping : public core::Mapping, public NonLinearMapping typedef type::Vec Direction; - Data f_computeDistance; ///< if 'computeDistance = true', then rest length of each element equal 0, otherwise rest length is the initial lenght of each of them - Data> f_restLengths; ///< Rest lengths of the connections - Data d_showObjectScale; ///< Scale for object display - Data d_color; ///< Color for object display. (default=[1.0,1.0,0.0,1.0]) + Data f_computeDistance; ///< if 'computeDistance = true', then rest length of each element equal 0, otherwise rest length is the initial lenght of each of them + Data> f_restLengths; ///< Rest lengths of the connections + Data d_showObjectScale; ///< Scale for object display + Data d_color; ///< Color for object display. (default=[1.0,1.0,0.0,1.0]) /// Link to be set to the topology container in the component graph. SingleLink, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> l_topology; diff --git a/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceMultiMapping.h b/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceMultiMapping.h index f2836695ac8..4a1afc30a2f 100644 --- a/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceMultiMapping.h +++ b/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/DistanceMultiMapping.h @@ -75,11 +75,11 @@ class DistanceMultiMapping : public core::MultiMapping, public NonLin typedef type::Vec Direction; - Data f_computeDistance; ///< if 'computeDistance = true', then rest length of each element equal 0, otherwise rest length is the initial lenght of each of them - Data> f_restLengths; ///< Rest lengths of the connections - Data d_showObjectScale; ///< Scale for object display - Data d_color; ///< Color for object display. (default=[1.0,1.0,0.0,1.0]) - Data> d_indexPairs; ///< list of couples (parent index + index in the parent) + Data f_computeDistance; ///< if 'computeDistance = true', then rest length of each element equal 0, otherwise rest length is the initial lenght of each of them + Data> f_restLengths; ///< Rest lengths of the connections + Data d_showObjectScale; ///< Scale for object display + Data d_color; ///< Color for object display. (default=[1.0,1.0,0.0,1.0]) + Data> d_indexPairs; ///< list of couples (parent index + index in the parent) /// Link to be set to the topology container in the component graph. SingleLink, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> l_topology; diff --git a/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/RigidMapping.h b/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/RigidMapping.h index 8bd3d0fa7fc..1bb3d6cb0eb 100644 --- a/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/RigidMapping.h +++ b/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/RigidMapping.h @@ -85,7 +85,7 @@ class RigidMapping : public core::Mapping, public NonLinearMappingDat typedef type::Mat MBloc; typedef sofa::linearalgebra::CompressedRowSparseMatrix MatrixType; - Data d_points; ///< mapped points in local coordinates + Data d_points; ///< Local Coordinates of the points SOFA_ATTRIBUTE_DISABLED("v23.06", "v23.12", "Use d_points instead") DeprecatedAndRemoved points; OutVecCoord m_rotatedPoints; ///< vectors from frame origin to mapped points, projected to world coordinates diff --git a/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/SquareDistanceMapping.h b/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/SquareDistanceMapping.h index 017f9123a8c..afca0b322b5 100644 --- a/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/SquareDistanceMapping.h +++ b/Sofa/Component/Mapping/NonLinear/src/sofa/component/mapping/nonlinear/SquareDistanceMapping.h @@ -85,8 +85,8 @@ class SquareDistanceMapping : public core::Mapping, public NonLinearM typedef type::Vec Direction; - Data d_showObjectScale; ///< drawing size - Data d_color; ///< drawing color + Data d_showObjectScale; ///< Scale for object display + Data d_color; ///< Color for object display. (default=[1.0,1.0,0.0,1.0]) /// Link to be set to the topology container in the component graph. SingleLink, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> l_topology; diff --git a/Sofa/Component/Mass/src/sofa/component/mass/DiagonalMass.h b/Sofa/Component/Mass/src/sofa/component/mass/DiagonalMass.h index 6f382372404..87f15b99a2e 100644 --- a/Sofa/Component/Mass/src/sofa/component/mass/DiagonalMass.h +++ b/Sofa/Component/Mass/src/sofa/component/mass/DiagonalMass.h @@ -107,7 +107,7 @@ class DiagonalMass : public core::behavior::Mass /// to display the center of gravity of the system Data< bool > d_showCenterOfGravity; - Data< float > d_showAxisSize; ///< factor length of the axis displayed (only used for rigids) + Data< float > d_showAxisSize; ///< Factor length of the axis displayed (only used for rigids) core::objectmodel::DataFileName d_fileMass; ///< an Xsp3.0 file to specify the mass parameters /// value defining the initialization process of the mass (0 : totalMass, 1 : massDensity, 2 : vertexMass) diff --git a/Sofa/Component/Mass/src/sofa/component/mass/MeshMatrixMass.inl b/Sofa/Component/Mass/src/sofa/component/mass/MeshMatrixMass.inl index 1bbf5b7ec93..3162394f316 100644 --- a/Sofa/Component/Mass/src/sofa/component/mass/MeshMatrixMass.inl +++ b/Sofa/Component/Mass/src/sofa/component/mass/MeshMatrixMass.inl @@ -51,7 +51,7 @@ MeshMatrixMass::MeshMatrixMass() , d_computeMassOnRest(initData(&d_computeMassOnRest, false, "computeMassOnRest", "If true, the mass of every element is computed based on the rest position rather than the position")) , d_showCenterOfGravity( initData(&d_showCenterOfGravity, false, "showGravityCenter", "display the center of gravity of the system" ) ) , d_showAxisSize( initData(&d_showAxisSize, Real(1.0), "showAxisSizeFactor", "factor length of the axis displayed (only used for rigids)" ) ) - , d_lumping( initData(&d_lumping, false, "lumping","boolean if you need to use a lumped mass matrix") ) + , d_lumping( initData(&d_lumping, false, "lumping","If true, the mass matrix is lumped, meaning the mass matrix becomes diagonal (summing all mass values of a line on the diagonal)") ) , d_printMass( initData(&d_printMass, false, "printMass","boolean if you want to check the mass conservation") ) , f_graph( initData(&f_graph,"graph","Graph of the controlled potential") ) , l_topology(initLink("topology", "link to the topology container")) diff --git a/Sofa/Component/Mass/src/sofa/component/mass/UniformMass.h b/Sofa/Component/Mass/src/sofa/component/mass/UniformMass.h index 0c1298a0d4d..6b0e22a0e8d 100644 --- a/Sofa/Component/Mass/src/sofa/component/mass/UniformMass.h +++ b/Sofa/Component/Mass/src/sofa/component/mass/UniformMass.h @@ -63,13 +63,13 @@ class UniformMass : public core::behavior::Mass Data d_totalMass; ///< if >0 : total mass of this body sofa::core::objectmodel::DataFileName d_filenameMass; ///< a .rigid file to automatically load the inertia matrix and other parameters - Data d_showCenterOfGravity; ///< to display the center of gravity of the system - Data d_showAxisSize; ///< to display the center of gravity of the system + Data d_showCenterOfGravity; ///< display the center of gravity of the system + Data d_showAxisSize; ///< factor length of the axis displayed (only used for rigids) Data d_computeMappingInertia; ///< to be used if the mass is placed under a mapping Data d_showInitialCenterOfGravity; ///< display the initial center of gravity of the system - Data d_showX0; ///< to display the rest positions + Data d_showX0; ///< display the rest positions /// optional range of local DOF indices. Any computation involving only /// indices outside of this range are discarded (useful for parallelization diff --git a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/ConstantForceField.inl b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/ConstantForceField.inl index 0313a4297af..4e0b34c6ea1 100644 --- a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/ConstantForceField.inl +++ b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/ConstantForceField.inl @@ -37,7 +37,7 @@ template ConstantForceField::ConstantForceField() : d_indices(initData(&d_indices, "indices", "indices where the forces are applied")) , d_indexFromEnd(initData(&d_indexFromEnd,false,"indexFromEnd", "Concerned DOFs indices are numbered from the end of the MState DOFs vector. (default=false)")) - , d_forces(initData(&d_forces, "forces", "applied forces at each point")) + , d_forces(initData(&d_forces, "forces", "vector containing the force amplitude applied at each node")) , d_totalForce(initData(&d_totalForce, "totalForce", "total force for all points, will be distributed uniformly over points")) , d_showArrowSize(initData(&d_showArrowSize, 0_sreal, "showArrowSize", "Size of the drawn arrows (0->no arrows, sign->direction of drawing. (default=0)")) , d_color(initData(&d_color, sofa::type::RGBAColor(0.2f,0.9f,0.3f,1.0f), "showColor", "Color for object display (default: [0.2,0.9,0.3,1.0])")) diff --git a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/EdgePressureForceField.h b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/EdgePressureForceField.h index 782bca98e1c..1f0fd59063d 100644 --- a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/EdgePressureForceField.h +++ b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/EdgePressureForceField.h @@ -83,12 +83,12 @@ class EdgePressureForceField : public core::behavior::ForceField Data pressure; ///< Pressure force per unit area Data > edgeIndices; ///< Indices of edges separated with commas where a pressure is applied Data > edges; ///< List of edges where a pressure is applied - Data normal; ///< the normal used to define the edge subjected to the pressure force - Data dmin; ///< coordinates min of the plane for the vertex selection - Data dmax;///< coordinates max of the plane for the vertex selection - Data< SReal > arrowSizeCoef; ///< for drawing. The sign changes the direction, 0 doesn't draw arrow + Data normal; ///< Normal direction for the plane selection of edges + Data dmin; ///< Minimum distance from the origin along the normal direction + Data dmax; ///< Maximum distance from the origin along the normal direction + Data< SReal > arrowSizeCoef; ///< Size of the drawn arrows (0->no arrows, sign->direction of drawing Data< type::vector > p_intensity; ///< pressure intensity on edge normal - Data p_binormal; ///< binormal of the 2D plane + Data p_binormal; ///< Binormal of the 2D plane Data p_showForces; ///< draw arrows of edge pressures /// Link to be set to the topology container in the component graph. diff --git a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/OscillatingTorsionPressureForceField.h b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/OscillatingTorsionPressureForceField.h index cf76aa43a35..2cf8b55c302 100644 --- a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/OscillatingTorsionPressureForceField.h +++ b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/OscillatingTorsionPressureForceField.h @@ -81,16 +81,16 @@ class OscillatingTorsionPressureForceField : public core::behavior::ForceField > trianglePressureMap; ///< map between triangle indices and their pressure + sofa::core::topology::TriangleSubsetData > trianglePressureMap; ///< Map between triangle indices and their pressure - Data moment; ///< total moment/torque applied + Data moment; ///< Moment force applied on the entire surface Data > triangleList; ///< Indices of triangles separated with commas where a pressure is applied - Data axis; ///< axis of rotation and normal used to define the edge subjected to the pressure force - Data center; ///< center of rotation - Data penalty; ///< strength of penalty force - Data frequency; ///< frequency of change - Data dmin; ///< coordinates min of the plane for the vertex selection - Data dmax; ///< coordinates max of the plane for the vertex selection + Data axis; ///< Axis of rotation and normal direction for the plane selection of triangles + Data center; ///< Center of rotation + Data penalty; ///< Strength of the penalty force + Data frequency; ///< frequency of oscillation + Data dmin; ///< Minimum distance from the origin along the normal direction + Data dmax; ///< Maximum distance from the origin along the normal direction Data p_showForces; ///< draw triangles which have a given pressure /// Link to be set to the topology container in the component graph. diff --git a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/OscillatingTorsionPressureForceField.inl b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/OscillatingTorsionPressureForceField.inl index 2dbc4ab0777..45992292038 100644 --- a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/OscillatingTorsionPressureForceField.inl +++ b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/OscillatingTorsionPressureForceField.inl @@ -34,7 +34,7 @@ namespace sofa::component::mechanicalload template OscillatingTorsionPressureForceField::OscillatingTorsionPressureForceField() - : trianglePressureMap(initData(&trianglePressureMap, "trianglePressureMap", "map between edge indices and their pressure")) + : trianglePressureMap(initData(&trianglePressureMap, "trianglePressureMap", "Map between triangle indices and their pressure")) , moment(initData(&moment, "moment", "Moment force applied on the entire surface")) , triangleList(initData(&triangleList, "triangleList", "Indices of triangles separated with commas where a pressure is applied")) , axis(initData(&axis, Coord(0,0,1), "axis", "Axis of rotation and normal direction for the plane selection of triangles")) diff --git a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/QuadPressureForceField.h b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/QuadPressureForceField.h index 30b0065f604..628110fbb1c 100644 --- a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/QuadPressureForceField.h +++ b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/QuadPressureForceField.h @@ -59,8 +59,8 @@ class QuadPressureForceField : public core::behavior::ForceField /// the normal used to define the edge subjected to the pressure force. Data normal; - Data dmin; ///< coordinates min of the plane for the vertex selection - Data dmax;///< coordinates max of the plane for the vertex selection + Data dmin; ///< Minimum distance from the origin along the normal direction + Data dmax; ///< Maximum distance from the origin along the normal direction Data p_showForces; ///< draw quads which have a given pressure /// Link to be set to the topology container in the component graph. @@ -98,7 +98,7 @@ class QuadPressureForceField : public core::behavior::ForceField } }; - sofa::core::topology::QuadSubsetData > quadPressureMap; ///< map between quad indices and their pressure + sofa::core::topology::QuadSubsetData > quadPressureMap; ///< Map between quad indices and their pressure /// Pointer to the current topology /// Pointer to the current topology sofa::core::topology::BaseMeshTopology* m_topology; diff --git a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/QuadPressureForceField.inl b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/QuadPressureForceField.inl index 51ccff6dd9a..24c185805bd 100644 --- a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/QuadPressureForceField.inl +++ b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/QuadPressureForceField.inl @@ -44,7 +44,7 @@ QuadPressureForceField::QuadPressureForceField() , dmax(initData(&dmax,(Real)0.0, "dmax", "Maximum distance from the origin along the normal direction")) , p_showForces(initData(&p_showForces, (bool)false, "showForces", "draw quads which have a given pressure")) , l_topology(initLink("topology", "link to the topology container")) - , quadPressureMap(initData(&quadPressureMap, "quadPressureMap", "map between edge indices and their pressure")) + , quadPressureMap(initData(&quadPressureMap, "quadPressureMap", "Map between quad indices and their pressure")) , m_topology(nullptr) { } diff --git a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/SurfacePressureForceField.h b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/SurfacePressureForceField.h index 90382808928..e2813413043 100644 --- a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/SurfacePressureForceField.h +++ b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/SurfacePressureForceField.h @@ -69,20 +69,20 @@ class SurfacePressureForceField : public core::behavior::ForceField enum State { INCREASE, DECREASE }; - Data m_pressure; ///< Scalar pressure value applied on the surfaces. - Data m_min; ///< Lower bound of the pressured box. - Data m_max; ///< Upper bound of the pressured box. - Data m_triangleIndices; ///< Specify triangles by indices. - Data m_quadIndices; ///< Specify quads by indices. - Data m_pulseMode; ///< In this mode, the pressure increases (or decreases) from 0 to m_pressure cyclicly. - Data m_pressureLowerBound; ///< In pulseMode, the pressure increases(or decreases) from m_pressureLowerBound to m_pressure cyclicly. - Data m_pressureSpeed; ///< Pressure variation in Pascal by second. - Data m_volumeConservationMode; ///< In this mode, pressure variation is related to the object volume variation. - Data m_useTangentStiffness; ///< The tangent stiffness matrix is not symmetric and could create issues with some linear solvers. Set to false to not use it. - Data m_defaultVolume; ///< Default Volume. - Data m_mainDirection; ///< Main axis for pressure application. - - Data m_drawForceScale; ///< scale used to render force vectors + Data m_pressure; ///< Pressure force per unit area + Data m_min; ///< Lower bound of the selection box + Data m_max; ///< Upper bound of the selection box + Data m_triangleIndices; ///< Indices of affected triangles + Data m_quadIndices; ///< Indices of affected quads + Data m_pulseMode; ///< Cyclic pressure application + Data m_pressureLowerBound; ///< Pressure lower bound force per unit area (active in pulse mode) + Data m_pressureSpeed; ///< Continuous pressure application in Pascal per second. Only active in pulse mode + Data m_volumeConservationMode; ///< Pressure variation follow the inverse of the volume variation + Data m_useTangentStiffness; ///< Whether (non-symmetric) stiffness matrix should be used + Data m_defaultVolume; ///< Default Volume + Data m_mainDirection; ///< Main direction for pressure application + + Data m_drawForceScale; ///< DEBUG: scale used to render force vectors protected: type::vector m_f; ///< store forces for visualization diff --git a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/SurfacePressureForceField.inl b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/SurfacePressureForceField.inl index 60803c5021e..c9d84072271 100644 --- a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/SurfacePressureForceField.inl +++ b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/SurfacePressureForceField.inl @@ -40,8 +40,8 @@ namespace sofa::component::mechanicalload template SurfacePressureForceField::SurfacePressureForceField() : m_pressure(initData(&m_pressure, (Real)0.0, "pressure", "Pressure force per unit area")) - , m_min(initData(&m_min, Coord(), "min", "Lower bond of the selection box")) - , m_max(initData(&m_max, Coord(), "max", "Upper bond of the selection box")) + , m_min(initData(&m_min, Coord(), "min", "Lower bound of the selection box")) + , m_max(initData(&m_max, Coord(), "max", "Upper bound of the selection box")) , m_triangleIndices(initData(&m_triangleIndices, "triangleIndices", "Indices of affected triangles")) , m_quadIndices(initData(&m_quadIndices, "quadIndices", "Indices of affected quads")) , m_pulseMode(initData(&m_pulseMode, false, "pulseMode", "Cyclic pressure application")) diff --git a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TaitSurfacePressureForceField.h b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TaitSurfacePressureForceField.h index 179d8db7269..757be63c5d9 100644 --- a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TaitSurfacePressureForceField.h +++ b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TaitSurfacePressureForceField.h @@ -71,29 +71,29 @@ class TaitSurfacePressureForceField : public core::behavior::ForceField m_p0; ///< IN: Rest pressure when V = V0 - Data< Real > m_B; ///< IN: Bulk modulus (resistance to uniform compression) - Data< Real > m_gamma; ///< IN: Bulk modulus (resistance to uniform compression) - Data< Real > m_injectedVolume; ///< IN: Injected (or extracted) volume since the start of the simulation - Data< Real > m_maxInjectionRate; ///< IN: Maximum injection rate (volume per second) + Data< Real > m_p0; ///< IN: Rest pressure when V = V0 + Data< Real > m_B; ///< IN: Bulk modulus (resistance to uniform compression) + Data< Real > m_gamma; ///< IN: Bulk modulus (resistance to uniform compression) + Data< Real > m_injectedVolume; ///< IN: Injected (or extracted) volume since the start of the simulation + Data< Real > m_maxInjectionRate; ///< IN: Maximum injection rate (volume per second) - Data< Real > m_initialVolume; ///< OUT: Initial volume, as computed from the surface rest position + Data< Real > m_initialVolume; ///< OUT: Initial volume, as computed from the surface rest position Data< Real > m_currentInjectedVolume; ///< OUT: Current injected (or extracted) volume (taking into account maxInjectionRate) - Data< Real > m_v0; ///< OUT: Rest volume (as computed from initialVolume + currentInjectedVolume) - Data< Real > m_currentVolume; ///< OUT: Current volume, as computed from the last surface position - Data< Real > m_currentPressure; ///< OUT: Current pressure, as computed from the last surface position - Data< Real > m_currentStiffness; ///< OUT: dP/dV at current volume and pressure + Data< Real > m_v0; ///< OUT: Rest volume (as computed from initialVolume + injectedVolume) + Data< Real > m_currentVolume; ///< OUT: Current volume, as computed from the last surface position + Data< Real > m_currentPressure; ///< OUT: Current pressure, as computed from the last surface position + Data< Real > m_currentStiffness; ///< OUT: dP/dV at current volume and pressure Data< SeqTriangles > m_pressureTriangles; ///< OUT: list of triangles where a pressure is applied (mesh triangles + tesselated quads) - Data< Real > m_initialSurfaceArea; ///< OUT: Initial surface area, as computed from the surface rest position - Data< Real > m_currentSurfaceArea; ///< OUT: Current surface area, as computed from the last surface position + Data< Real > m_initialSurfaceArea; ///< OUT: Initial surface area, as computed from the surface rest position + Data< Real > m_currentSurfaceArea; ///< OUT: Current surface area, as computed from the last surface position - Data< Real > m_drawForceScale; ///< DEBUG: scale used to render force vectors - Data< sofa::type::RGBAColor > m_drawForceColor; ///< DEBUG: color used to render force vectors + Data< Real > m_drawForceScale; ///< DEBUG: scale used to render force vectors + Data< sofa::type::RGBAColor > m_drawForceColor; ///< DEBUG: color used to render force vectors - Data< Real > m_volumeAfterTC; ///< OUT: Volume after a topology change - Data< Real > m_surfaceAreaAfterTC; ///< OUT: Surface area after a topology change + Data< Real > m_volumeAfterTC; ///< OUT: Volume after a topology change + Data< Real > m_surfaceAreaAfterTC; ///< OUT: Surface area after a topology change /// Link to be set to the topology container in the component graph. SingleLink, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> l_topology; diff --git a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TorsionForceField.h b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TorsionForceField.h index 580a2e4d401..df44ff4535c 100644 --- a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TorsionForceField.h +++ b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TorsionForceField.h @@ -82,10 +82,10 @@ class TorsionForceField : public ForceField SReal getPotentialEnergy(const core::MechanicalParams* /*mparams*/, const DataVecCoord& /* x */) const override; public : - Data m_indices; ///< indices of the selected nodes. - Data m_torque; ///< torque to be applied. - Data m_axis; ///< direction of the axis. - Data m_origin; ///< origin of the axis. + Data m_indices; ///< indices of the selected points + Data m_torque; ///< torque to apply + Data m_axis; ///< direction of the axis (will be normalized) + Data m_origin; ///< origin of the axis protected : Pos m_u; ///< normalized axis diff --git a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TrianglePressureForceField.h b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TrianglePressureForceField.h index 70cccaf8556..748f9666470 100644 --- a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TrianglePressureForceField.h +++ b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TrianglePressureForceField.h @@ -49,16 +49,16 @@ class TrianglePressureForceField : public core::behavior::ForceField using Index = sofa::Index; - Data pressure; ///< pressure is a vector with specified direction - Data cauchyStress; ///< the Cauchy stress applied on triangles + Data pressure; ///< Pressure force per unit area + Data cauchyStress; ///< Cauchy Stress applied on the normal of each triangle Data > triangleList; ///< Indices of triangles separated with commas where a pressure is applied /// the normal used to define the edge subjected to the pressure force. Data normal; - Data dmin; ///< coordinates min of the plane for the vertex selection - Data dmax;///< coordinates max of the plane for the vertex selection + Data dmin; ///< Minimum distance from the origin along the normal direction + Data dmax; ///< Maximum distance from the origin along the normal direction Data p_showForces; ///< draw triangles which have a given pressure Data p_useConstantForce; ///< applied force is computed as the pressure vector times the area at rest @@ -101,7 +101,7 @@ class TrianglePressureForceField : public core::behavior::ForceField } }; - core::topology::TriangleSubsetData > trianglePressureMap; ///< map between triangle indices and their pressure + core::topology::TriangleSubsetData > trianglePressureMap; ///< Map between triangle indices and their pressure sofa::core::topology::BaseMeshTopology* m_topology; diff --git a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TrianglePressureForceField.inl b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TrianglePressureForceField.inl index 2485a678dfa..88e9e03af1d 100644 --- a/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TrianglePressureForceField.inl +++ b/Sofa/Component/MechanicalLoad/src/sofa/component/mechanicalload/TrianglePressureForceField.inl @@ -46,7 +46,7 @@ template TrianglePressureForceField::TrianglePress , p_showForces(initData(&p_showForces, (bool)false, "showForces", "draw triangles which have a given pressure")) , p_useConstantForce(initData(&p_useConstantForce, (bool)true, "useConstantForce", "applied force is computed as the pressure vector times the area at rest")) , l_topology(initLink("topology", "link to the topology container")) - , trianglePressureMap(initData(&trianglePressureMap, "trianglePressureMap", "map between edge indices and their pressure")) + , trianglePressureMap(initData(&trianglePressureMap, "trianglePressureMap", "Map between triangle indices and their pressure")) , m_topology(nullptr) {} diff --git a/Sofa/Component/ODESolver/Backward/src/sofa/component/odesolver/backward/EulerImplicitSolver.cpp b/Sofa/Component/ODESolver/Backward/src/sofa/component/odesolver/backward/EulerImplicitSolver.cpp index 95ea850b29c..a4076b20ce0 100644 --- a/Sofa/Component/ODESolver/Backward/src/sofa/component/odesolver/backward/EulerImplicitSolver.cpp +++ b/Sofa/Component/ODESolver/Backward/src/sofa/component/odesolver/backward/EulerImplicitSolver.cpp @@ -40,8 +40,8 @@ EulerImplicitSolver::EulerImplicitSolver() : d_rayleighStiffness(initData(&d_rayleighStiffness, (SReal)0.0, "rayleighStiffness", "Rayleigh damping coefficient related to stiffness, > 0") ) , d_rayleighMass(initData(&d_rayleighMass, (SReal)0.0, "rayleighMass", "Rayleigh damping coefficient related to mass, > 0")) , d_velocityDamping(initData(&d_velocityDamping, (SReal)0.0, "vdamping", "Velocity decay coefficient (no decay if null)") ) - , d_firstOrder (initData(&d_firstOrder, false, "firstOrder", "Use backward Euler scheme for first order ode system.")) - , d_trapezoidalScheme( initData(&d_trapezoidalScheme,false,"trapezoidalScheme","Optional: use the trapezoidal scheme instead of the implicit Euler scheme and get second order accuracy in time") ) + , d_firstOrder (initData(&d_firstOrder, false, "firstOrder", "Use backward Euler scheme for first order ODE system, which means that only the first derivative of the DOFs (state) appears in the equation. Higher derivatives are absent")) + , d_trapezoidalScheme( initData(&d_trapezoidalScheme,false,"trapezoidalScheme","Boolean to use the trapezoidal scheme instead of the implicit Euler scheme and get second order accuracy in time (false by default)") ) , d_solveConstraint(initData(&d_solveConstraint, false, "solveConstraint", "Apply ConstraintSolver (requires a ConstraintSolver in the same node as this solver, disabled by by default for now)") ) , d_threadSafeVisitor(initData(&d_threadSafeVisitor, false, "threadSafeVisitor", "If true, do not use realloc and free visitors in fwdInteractionForceField.")) { diff --git a/Sofa/Component/ODESolver/Backward/src/sofa/component/odesolver/backward/EulerImplicitSolver.h b/Sofa/Component/ODESolver/Backward/src/sofa/component/odesolver/backward/EulerImplicitSolver.h index eba82b83cfc..4979e8c34d1 100644 --- a/Sofa/Component/ODESolver/Backward/src/sofa/component/odesolver/backward/EulerImplicitSolver.h +++ b/Sofa/Component/ODESolver/Backward/src/sofa/component/odesolver/backward/EulerImplicitSolver.h @@ -122,8 +122,8 @@ class SOFA_COMPONENT_ODESOLVER_BACKWARD_API EulerImplicitSolver : Data d_rayleighStiffness; ///< Rayleigh damping coefficient related to stiffness, > 0 Data d_rayleighMass; ///< Rayleigh damping coefficient related to mass, > 0 Data d_velocityDamping; ///< Velocity decay coefficient (no decay if null) - Data d_firstOrder; ///< Use backward Euler scheme for first order ode system. - Data d_trapezoidalScheme; ///< Optional: use the trapezoidal scheme instead of the implicit Euler scheme and get second order accuracy in time + Data d_firstOrder; ///< Use backward Euler scheme for first order ODE system, which means that only the first derivative of the DOFs (state) appears in the equation. Higher derivatives are absent + Data d_trapezoidalScheme; ///< Boolean to use the trapezoidal scheme instead of the implicit Euler scheme and get second order accuracy in time (false by default) Data d_solveConstraint; ///< Apply ConstraintSolver (requires a ConstraintSolver in the same node as this solver, disabled by by default for now) Data d_threadSafeVisitor; ///< If true, do not use realloc and free visitors in fwdInteractionForceField. diff --git a/Sofa/Component/ODESolver/Backward/src/sofa/component/odesolver/backward/StaticSolver.cpp b/Sofa/Component/ODESolver/Backward/src/sofa/component/odesolver/backward/StaticSolver.cpp index 067679cd473..2e2bb48c024 100644 --- a/Sofa/Component/ODESolver/Backward/src/sofa/component/odesolver/backward/StaticSolver.cpp +++ b/Sofa/Component/ODESolver/Backward/src/sofa/component/odesolver/backward/StaticSolver.cpp @@ -45,29 +45,29 @@ StaticSolver::StaticSolver() : d_newton_iterations(initData(&d_newton_iterations, (unsigned) 1, "newton_iterations", - "Number of newton iterations between each load increments (normally, one load increment per simulation time-step.")) + "Number of Netwon iterations between each load increments (normally, one load increment per simulation time-step.")) , d_absolute_correction_tolerance_threshold(initData(&d_absolute_correction_tolerance_threshold, 1e-5_sreal, "absolute_correction_tolerance_threshold", - "Convergence criterion: The newton iterations will stop when the norm |du| is smaller than this threshold.")) + "Convergence criterion of the norm |du| under which the Netwon iterations stop")) , d_relative_correction_tolerance_threshold(initData(&d_relative_correction_tolerance_threshold, 1e-5_sreal, "relative_correction_tolerance_threshold", - "Convergence criterion: The newton iterations will stop when the ratio |du| / |U| is smaller than this threshold.")) + "Convergence criterion regarding the ratio |du| / |U| under which the Netwon iterations stop")) , d_absolute_residual_tolerance_threshold( initData(&d_absolute_residual_tolerance_threshold, 1e-5_sreal, "absolute_residual_tolerance_threshold", - "Convergence criterion: The newton iterations will stop when the norm |R| is smaller than this threshold. " - "Use a negative value to disable this criterion.")) + "Convergence criterion of the norm |R| under which the Netwon iterations stop." + "Use a negative value to disable this criterion")) , d_relative_residual_tolerance_threshold( initData(&d_relative_residual_tolerance_threshold, 1e-5_sreal, "relative_residual_tolerance_threshold", - "Convergence criterion: The newton iterations will stop when the ratio |R|/|R0| is smaller than this threshold. " - "Use a negative value to disable this criterion.")) + "Convergence criterion regarding the ratio |R|/|R0| under which the Netwon iterations stop." + "Use a negative value to disable this criterion")) , d_should_diverge_when_residual_is_growing( initData(&d_should_diverge_when_residual_is_growing, false, "should_diverge_when_residual_is_growing", - "Divergence criterion: The newton iterations will stop when the residual is greater than the one from the previous iteration.")) + "Boolean stopping Netwon iterations when the residual is greater than the one from the previous iteration")) {} void StaticSolver::solve(const sofa::core::ExecParams* params, SReal dt, sofa::core::MultiVecCoordId xResult, sofa::core::MultiVecDerivId vResult) diff --git a/Sofa/Component/ODESolver/Forward/src/sofa/component/odesolver/forward/EulerSolver.cpp b/Sofa/Component/ODESolver/Forward/src/sofa/component/odesolver/forward/EulerSolver.cpp index aa86c6ecb5f..99183d804e1 100644 --- a/Sofa/Component/ODESolver/Forward/src/sofa/component/odesolver/forward/EulerSolver.cpp +++ b/Sofa/Component/ODESolver/Forward/src/sofa/component/odesolver/forward/EulerSolver.cpp @@ -45,7 +45,7 @@ int EulerExplicitSolverClass = core::RegisterObject("A simple explicit time inte ; EulerExplicitSolver::EulerExplicitSolver() - : d_symplectic( initData( &d_symplectic, true, "symplectic", "If true, the velocities are updated before the positions and the method is symplectic (more robust). If false, the positions are updated before the velocities (standard Euler, less robust).") ) + : d_symplectic( initData( &d_symplectic, true, "symplectic", "If true (default), the velocities are updated before the positions and the method is symplectic, more robust. If false, the positions are updated before the velocities (standard Euler, less robust).") ) , d_threadSafeVisitor(initData(&d_threadSafeVisitor, false, "threadSafeVisitor", "If true, do not use realloc and free visitors in fwdInteractionForceField.")) , l_linearSolver(initLink("linearSolver", "Linear solver used by this component")) { diff --git a/Sofa/Component/ODESolver/Forward/src/sofa/component/odesolver/forward/EulerSolver.h b/Sofa/Component/ODESolver/Forward/src/sofa/component/odesolver/forward/EulerSolver.h index 2a94d986e20..d5c9d1b83f2 100644 --- a/Sofa/Component/ODESolver/Forward/src/sofa/component/odesolver/forward/EulerSolver.h +++ b/Sofa/Component/ODESolver/Forward/src/sofa/component/odesolver/forward/EulerSolver.h @@ -75,7 +75,7 @@ class SOFA_COMPONENT_ODESOLVER_FORWARD_API EulerExplicitSolver : public sofa::co public: void solve(const core::ExecParams* params, SReal dt, sofa::core::MultiVecCoordId xResult, sofa::core::MultiVecDerivId vResult) override; - Data d_symplectic; ///< If true, the velocities are updated before the positions and the method is symplectic (more robust). If false, the positions are updated before the velocities (standard Euler, less robust). + Data d_symplectic; ///< If true (default), the velocities are updated before the positions and the method is symplectic, more robust. If false, the positions are updated before the velocities (standard Euler, less robust). Data d_threadSafeVisitor; ///< If true, do not use realloc and free visitors in fwdInteractionForceField. SingleLink l_linearSolver; diff --git a/Sofa/Component/Playback/src/sofa/component/playback/WriteState.h b/Sofa/Component/Playback/src/sofa/component/playback/WriteState.h index 42044e27f0d..c3db8c36fb4 100644 --- a/Sofa/Component/Playback/src/sofa/component/playback/WriteState.h +++ b/Sofa/Component/Playback/src/sofa/component/playback/WriteState.h @@ -57,7 +57,7 @@ class SOFA_COMPONENT_PLAYBACK_API WriteState: public core::objectmodel::BaseObje Data < bool > d_writeX0; ///< flag enabling output of X0 vector Data < bool > d_writeV; ///< flag enabling output of V vector Data < bool > d_writeF; ///< flag enabling output of F vector - Data < type::vector > d_time; ///< set time to write outputs + Data < type::vector > d_time; ///< set time to write outputs (by default export at t=0) Data < double > d_period; ///< period between outputs Data < type::vector > d_DOFsX; ///< set the position DOFs to write Data < type::vector > d_DOFsV; ///< set the velocity DOFs to write diff --git a/Sofa/Component/Setting/src/sofa/component/setting/BackgroundSetting.h b/Sofa/Component/Setting/src/sofa/component/setting/BackgroundSetting.h index e1f440d6287..7ef27090994 100644 --- a/Sofa/Component/Setting/src/sofa/component/setting/BackgroundSetting.h +++ b/Sofa/Component/Setting/src/sofa/component/setting/BackgroundSetting.h @@ -46,7 +46,7 @@ class SOFA_COMPONENT_SETTING_API BackgroundSetting: public core::objectmodel::Co sofa::core::objectmodel::DataFileName image; ///< Image to be used as background of the viewer. - Data d_color; ///< Color of the Background of the Viewer. + Data d_color; ///< Color of the background sofa::core::objectmodel::DataFileName d_image; ///< Image to be used as background of the viewer. }; diff --git a/Sofa/Component/Setting/src/sofa/component/setting/SofaDefaultPathSetting.h b/Sofa/Component/Setting/src/sofa/component/setting/SofaDefaultPathSetting.h index d741007a006..2d18f1ea3de 100644 --- a/Sofa/Component/Setting/src/sofa/component/setting/SofaDefaultPathSetting.h +++ b/Sofa/Component/Setting/src/sofa/component/setting/SofaDefaultPathSetting.h @@ -40,7 +40,7 @@ class SOFA_COMPONENT_SETTING_API SofaDefaultPathSetting: public core::objectmode SOFA_ATTRIBUTE_DEPRECATED__RENAME_DATA_IN_SETTING() sofa::core::objectmodel::Data gnuplotPath; - sofa::core::objectmodel::Data d_gnuplotPath; /// d_gnuplotPath; ///< Path where will be saved the gnuplot files }; } // namespace sofa::component::setting diff --git a/Sofa/Component/Setting/src/sofa/component/setting/StatsSetting.h b/Sofa/Component/Setting/src/sofa/component/setting/StatsSetting.h index 2116a9a30fa..c24b5b3da9e 100644 --- a/Sofa/Component/Setting/src/sofa/component/setting/StatsSetting.h +++ b/Sofa/Component/Setting/src/sofa/component/setting/StatsSetting.h @@ -56,11 +56,11 @@ class SOFA_COMPONENT_SETTING_API StatsSetting: public core::objectmodel::Configu Data exportState; - Data d_dumpState; ///< If true, dump state vectors at each time step of the simulation. - Data d_logTime; ///< If true, output in the console an average of the time spent during different stages of the simulation. - Data d_exportState; ///< If true, create GNUPLOT files with the positions, velocities and forces of all the simulated objects of the scene. + Data d_dumpState; ///< Dump state vectors at each time step of the simulation + Data d_logTime; ///< Output in the console an average of the time spent during different stages of the simulation + Data d_exportState; ///< Create GNUPLOT files with the positions, velocities and forces of all the simulated objects of the scene #ifdef SOFA_DUMP_VISITOR_INFO - Data traceVisitors; ///< If true, trace the time spent by each visitor, and allows to profile precisely one step of a simulation. + Data traceVisitors; ///< Trace the time spent by each visitor, and allows to profile precisely one step of a simulation #endif }; diff --git a/Sofa/Component/Setting/src/sofa/component/setting/ViewerSetting.h b/Sofa/Component/Setting/src/sofa/component/setting/ViewerSetting.h index ca011cb13e3..6d65dc38991 100644 --- a/Sofa/Component/Setting/src/sofa/component/setting/ViewerSetting.h +++ b/Sofa/Component/Setting/src/sofa/component/setting/ViewerSetting.h @@ -61,13 +61,13 @@ class SOFA_COMPONENT_SETTING_API ViewerSetting: public sofa::core::objectmodel:: SOFA_ATTRIBUTE_DEPRECATED__RENAME_DATA_IN_SETTING() Data objectPickingMethod; - Data > d_resolution; ///< Screen resolution (width, height). - Data d_fullscreen; ///< True if viewer should be fullscreen. - Data d_cameraMode; ///< Camera mode. + Data > d_resolution; ///< resolution of the Viewer + Data d_fullscreen; ///< Fullscreen mode + Data d_cameraMode; ///< Camera mode /**< \arg Perspective. * \arg Orthographic. */ - Data d_objectPickingMethod; ///< Picking Method. + Data d_objectPickingMethod; ///< The method used to pick objects /**< \arg Ray casting. * \arg Selection Buffer. */ diff --git a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/FastTetrahedralCorotationalForceField.h b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/FastTetrahedralCorotationalForceField.h index 9490d42fc9e..f3d16b86c59 100644 --- a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/FastTetrahedralCorotationalForceField.h +++ b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/FastTetrahedralCorotationalForceField.h @@ -119,7 +119,7 @@ class FastTetrahedralCorotationalForceField : public core::behavior::ForceField< core::topology::TetrahedronData tetrahedronInfo; ///< Internal tetrahedron data VecCoord _initialPoints;///< the intial positions of the points - Data f_method; ///< the computation method of the displacements + Data f_method; ///< method for rotation computation :"qr" (by QR) or "polar" or "polar2" or "none" (Linear elastic) RotationDecompositionMethod m_decompositionMethod; Data f_poissonRatio; ///< Poisson ratio in Hooke's law diff --git a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedralFEMForceField.h b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedralFEMForceField.h index 9f65def4a08..520e7552b85 100644 --- a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedralFEMForceField.h +++ b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedralFEMForceField.h @@ -185,7 +185,7 @@ class HexahedralFEMForceField : virtual public core::behavior::ForceField f_method; ///< the computation method of the displacements + Data f_method; ///< "large" or "polar" displacements Data f_poissonRatio; Data f_youngModulus; /// container that stotes all requires information for each hexahedron diff --git a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedralFEMForceFieldAndMass.h b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedralFEMForceFieldAndMass.h index a8b34db740b..ff9ff15240e 100644 --- a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedralFEMForceFieldAndMass.h +++ b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedralFEMForceFieldAndMass.h @@ -125,11 +125,11 @@ class HexahedralFEMForceFieldAndMass : virtual public sofa::core::behavior::Mass Data _density; ///< density == volumetric mass in english (kg.m-3) Data _useLumpedMass; ///< Does it use lumped masses? - core::topology::HexahedronData > _elementMasses; ///< mass matrices per element - core::topology::HexahedronData > _elementTotalMass; ///< total mass per element + core::topology::HexahedronData > _elementMasses; ///< Mass matrices per element (M_i) + core::topology::HexahedronData > _elementTotalMass; ///< Total mass per element - core::topology::PointData > _particleMasses; ///< masses per particle in order to compute gravity - core::topology::PointData > _lumpedMasses; ///< masses per particle computed by lumping mass matrices + core::topology::PointData > _particleMasses; ///< Mass per particle + core::topology::PointData > _lumpedMasses; ///< Lumped masses }; #if !defined(SOFA_COMPONENT_FORCEFIELD_HEXAHEDRALFEMFORCEFIELDANDMASS_CPP) diff --git a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedronFEMForceField.h b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedronFEMForceField.h index 14801c77b62..d717d90c56a 100644 --- a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedronFEMForceField.h +++ b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedronFEMForceField.h @@ -113,13 +113,13 @@ class HexahedronFEMForceField : virtual public core::behavior::ForceField f_method; ///< the computation method of the displacements - Data f_poissonRatio; - Data f_youngModulus; + Data f_method; ///< "large" or "polar" or "small" displacements + Data f_poissonRatio; ///< FEM Poisson Ratio in Hooke's law [0,0.5[ + Data f_youngModulus; ///< FEM Young's modulus in Hooke's law Data f_updateStiffnessMatrix; - Data< sofa::helper::OptionsGroup > _gatherPt; ///< use in GPU version - Data< sofa::helper::OptionsGroup > _gatherBsize; ///< use in GPU version - Data f_drawing; ///< draw the forcefield if true + Data< sofa::helper::OptionsGroup > _gatherPt; ///< number of dof accumulated per threads during the gather operation (Only use in GPU version) + Data< sofa::helper::OptionsGroup > _gatherBsize; ///< number of dof accumulated per threads during the gather operation (Only use in GPU version) + Data f_drawing; ///< draw the forcefield if true Data f_drawPercentageOffset; ///< size of the hexa bool needUpdateTopology; @@ -182,7 +182,7 @@ class HexahedronFEMForceField : virtual public core::behavior::ForceField _initialPoints; ///< the intial positions of the points + Data< VecCoord > _initialPoints; ///< Initial Position type::Mat<8,3,int> _coef; ///< coef of each vertices to compute the strain stress matrix diff --git a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedronFEMForceFieldAndMass.h b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedronFEMForceFieldAndMass.h index 424c67cfd54..b02346a4526 100644 --- a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedronFEMForceFieldAndMass.h +++ b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/HexahedronFEMForceFieldAndMass.h @@ -131,7 +131,7 @@ class HexahedronFEMForceFieldAndMass : virtual public core::behavior::Mass d_elementMasses; ///< mass matrices per element + Data d_elementMasses; ///< Mass matrices per element (M_i) Data d_density; ///< density == volumetric mass in english (kg.m-3) Data d_lumpedMass; ///< Does it use lumped masses? diff --git a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/QuadBendingFEMForceField.inl b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/QuadBendingFEMForceField.inl index 7924a00d49f..0631e26b8f1 100644 --- a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/QuadBendingFEMForceField.inl +++ b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/QuadBendingFEMForceField.inl @@ -66,7 +66,7 @@ using namespace sofa::core::topology; template QuadBendingFEMForceField::QuadBendingFEMForceField() : quadInfo(initData(&quadInfo,"quadInfo", "Internal quad data")) - , vertexInfo(initData(&vertexInfo,"vertexInfo", "Internal node data")) + , vertexInfo(initData(&vertexInfo,"vertexInfo", "Internal point data")) , edgeInfo(initData(&edgeInfo,"edgeInfo", "Internal edge data")) , m_topology(nullptr) , method(SMALL) diff --git a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TetrahedralCorotationalFEMForceField.h b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TetrahedralCorotationalFEMForceField.h index dae0e45aa19..5bf87ff7d08 100644 --- a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TetrahedralCorotationalFEMForceField.h +++ b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TetrahedralCorotationalFEMForceField.h @@ -140,7 +140,7 @@ class TetrahedralCorotationalFEMForceField : public core::behavior::ForceField f_method; ///< the computation method of the displacements + Data f_method; ///< "small", "large" (by QR) or "polar" displacements Data _poissonRatio; ///< FEM Poisson Ratio Data _youngModulus; ///< FEM Young Modulus Data _localStiffnessFactor; ///< Allow specification of different stiffness per element. If there are N element and M values are specified, the youngModulus factor for element i would be localStiffnessFactor[i*M/N] diff --git a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TetrahedronFEMForceField.h b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TetrahedronFEMForceField.h index e357c896a40..fe9f71876bc 100644 --- a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TetrahedronFEMForceField.h +++ b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TetrahedronFEMForceField.h @@ -187,12 +187,12 @@ class TetrahedronFEMForceField : public core::behavior::ForceField, p type::vector< Mat33 > m_rotations; const type::vector& getRotations() override; - Data< VecCoord > _initialPoints; ///< the initial positions of the points + Data< VecCoord > _initialPoints; ///< Initial Position int method; - Data f_method; ///< the computation method of the displacements + Data f_method; ///< "small", "large" (by QR), "polar" or "svd" displacements - Data _poissonRatio; ///< FEM Poisson Ratio [0,0.5[ - Data _youngModulus; ///< FEM Young Modulus + Data _poissonRatio; ///< FEM Poisson Ratio in Hooke's law [0,0.5[ + Data _youngModulus; ///< FEM Young's Modulus in Hooke's law Data _localStiffnessFactor; ///< Allow specification of different stiffness per element. If there are N element and M values are specified, the youngModulus factor for element i would be localStiffnessFactor[i*M/N] Data _updateStiffnessMatrix; Data _assembling; @@ -202,12 +202,12 @@ class TetrahedronFEMForceField : public core::behavior::ForceField, p /// @{ Data _plasticMaxThreshold; Data _plasticYieldThreshold; ///< Plastic Yield Threshold (2-norm of the strain) - Data _plasticCreep; ///< this parameters is different from the article, here it includes the multiplication by dt + Data _plasticCreep; ///< Plastic Creep Factor * dt [0,1]. Warning this factor depends on dt. /// @} - Data< sofa::helper::OptionsGroup > _gatherPt; ///< use in GPU version - Data< sofa::helper::OptionsGroup > _gatherBsize; ///< use in GPU version + Data< sofa::helper::OptionsGroup > _gatherPt; ///< number of dof accumulated per threads during the gather operation (Only use in GPU version) + Data< sofa::helper::OptionsGroup > _gatherBsize; ///< number of dof accumulated per threads during the gather operation (Only use in GPU version) Data< bool > drawHeterogeneousTetra; ///< Draw Heterogeneous Tetra in different color Real minYoung, maxYoung; @@ -221,7 +221,7 @@ class TetrahedronFEMForceField : public core::behavior::ForceField, p Real prevMaxStress; - Data _computeVonMisesStress; ///< compute and display von Mises stress: 0: no computations, 1: using corotational strain, 2: using full Green strain + Data _computeVonMisesStress; ///< compute and display von Mises stress: 0: no computations, 1: using corotational strain, 2: using full Green strain. Set listening=1 Data > _vonMisesPerElement; ///< von Mises Stress per element Data > _vonMisesPerNode; ///< von Mises Stress per node Data > _vonMisesStressColors; ///< Vector of colors describing the VonMises stress @@ -232,10 +232,10 @@ class TetrahedronFEMForceField : public core::behavior::ForceField, p Data _showStressColorMap; ///< Color map used to show stress values Data _showStressAlpha; ///< Alpha for vonMises visualisation Data _showVonMisesStressPerNode; ///< draw points showing vonMises stress interpolated in nodes - Data d_showVonMisesStressPerNodeColorMap; ///< draw triangles showing vonMises stress interpolated in nodes + Data d_showVonMisesStressPerNodeColorMap; ///< draw elements showing vonMises stress interpolated in nodes Data _showVonMisesStressPerElement; ///< draw triangles showing vonMises stress interpolated in elements - Data d_showElementGapScale; ///< draw gap between elements (when showWireFrame is disabled) + Data d_showElementGapScale; ///< draw gap between elements (when showWireFrame is disabled) [0,1]: 0: no gap, 1: no element Data _updateStiffness; ///< udpate structures (precomputed in init) using stiffness parameters in each iteration (set listening=1) diff --git a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TriangleFEMForceField.h b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TriangleFEMForceField.h index 8375798ff65..78ce1374e68 100644 --- a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TriangleFEMForceField.h +++ b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TriangleFEMForceField.h @@ -90,7 +90,7 @@ class TriangleFEMForceField : public core::behavior::ForceField VecStrainDisplacement _strainDisplacements; ///< the strain-displacement matrices vector const VecElement* _indexedElements; - Data< VecCoord > _initialPoints; ///< the intial positions of the points + Data< VecCoord > _initialPoints; ///< Initial Position TriangleFEMForceField(); virtual ~TriangleFEMForceField(); @@ -113,11 +113,11 @@ class TriangleFEMForceField : public core::behavior::ForceField void draw(const core::visual::VisualParams* vparams) override; int method; - Data f_method; ///< Choice of method: 0 for small, 1 for large displacements - Data f_poisson; ///< Poisson ratio of the material - Data f_young; ///< Young modulus of the material - Data f_thickness; ///< Thickness of the elements - Data f_planeStrain; ///< compute material stiffness corresponding to the plane strain assumption, or to the plane stress otherwise. + Data f_method; ///< large: large displacements, small: small displacements + Data f_poisson; ///< Poisson ratio in Hooke's law + Data f_young; ///< Young modulus in Hooke's law + Data f_thickness; ///< Thickness of the elements + Data f_planeStrain; ///< Plane strain or plane stress assumption Real getPoisson() { return f_poisson.getValue(); } void setPoisson(Real val); diff --git a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TriangularFEMForceField.h b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TriangularFEMForceField.h index c82da997531..bac9e476784 100644 --- a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TriangularFEMForceField.h +++ b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TriangularFEMForceField.h @@ -282,7 +282,7 @@ protected : sofa::type::vector > > allGraphOrientation; //the index of element we want to display the graphs - Data elementID; ///< element id to follow for fracture criteria + Data elementID; ///< element id to follow in the graphs //data storing the values along time for the element with index elementID Data > > f_graphStress; ///< Graph of max stress corresponding to the element id diff --git a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TriangularFEMForceFieldOptim.h b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TriangularFEMForceFieldOptim.h index 55d851e60b4..1c4df87598c 100644 --- a/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TriangularFEMForceFieldOptim.h +++ b/Sofa/Component/SolidMechanics/FEM/Elastic/src/sofa/component/solidmechanics/fem/elastic/TriangularFEMForceFieldOptim.h @@ -248,7 +248,7 @@ class TriangularFEMForceFieldOptim : public core::behavior::ForceField d_showStressVector; ///< Flag activating rendering of stress directions within each triangle - Data d_showStressThreshold; ///< Minimum Stress value for rendering of stress vectors + Data d_showStressThreshold; ///< Threshold value to render only stress vectors higher to this threshold /// Link to be set to the topology container in the component graph. SingleLink, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> l_topology; diff --git a/Sofa/Component/SolidMechanics/FEM/HyperElastic/src/sofa/component/solidmechanics/fem/hyperelastic/StandardTetrahedralFEMForceField.h b/Sofa/Component/SolidMechanics/FEM/HyperElastic/src/sofa/component/solidmechanics/fem/hyperelastic/StandardTetrahedralFEMForceField.h index 277c39ae370..e9d72e80123 100644 --- a/Sofa/Component/SolidMechanics/FEM/HyperElastic/src/sofa/component/solidmechanics/fem/hyperelastic/StandardTetrahedralFEMForceField.h +++ b/Sofa/Component/SolidMechanics/FEM/HyperElastic/src/sofa/component/solidmechanics/fem/hyperelastic/StandardTetrahedralFEMForceField.h @@ -143,7 +143,7 @@ public : VecCoord _initialPoints; /// the intial positions of the points bool updateMatrix; bool _meshSaved ; - Data f_materialName; ///< the name of the material + Data f_materialName; ///< the name of the material to be used Data f_parameterSet; ///< The global parameters specifying the material Data f_anisotropySet; ///< The global directions of anisotropy of the material Data f_parameterFileName; ///< the name of the file describing the material parameters for all tetrahedra diff --git a/Sofa/Component/SolidMechanics/FEM/HyperElastic/src/sofa/component/solidmechanics/fem/hyperelastic/TetrahedronHyperelasticityFEMForceField.h b/Sofa/Component/SolidMechanics/FEM/HyperElastic/src/sofa/component/solidmechanics/fem/hyperelastic/TetrahedronHyperelasticityFEMForceField.h index a5df0705761..e734d8f2cb1 100644 --- a/Sofa/Component/SolidMechanics/FEM/HyperElastic/src/sofa/component/solidmechanics/fem/hyperelastic/TetrahedronHyperelasticityFEMForceField.h +++ b/Sofa/Component/SolidMechanics/FEM/HyperElastic/src/sofa/component/solidmechanics/fem/hyperelastic/TetrahedronHyperelasticityFEMForceField.h @@ -135,9 +135,9 @@ class TetrahedronHyperelasticityFEMForceField : public core::behavior::ForceFiel public: Data d_stiffnessMatrixRegularizationWeight; ///< Regularization of the Stiffness Matrix (between true or false) - Data d_materialName; ///< the name of the material + Data d_materialName; ///< the name of the material to be used. Possible options are: 'ArrudaBoyce', 'Costa', 'MooneyRivlin', 'NeoHookean', 'Ogden', 'StVenantKirchhoff', 'VerondaWestman', 'StableNeoHookean' Data d_parameterSet; ///< The global parameters specifying the material - Data d_anisotropySet; ///< The global directions of anisotropy of the material + Data d_anisotropySet; ///< The global directions of anisotropy of the material: vector containing anisotropic directions. The vector size is 0 if the material is isotropic, 1 if it is transversely isotropic and 2 for orthotropic materials TetrahedronData > m_tetrahedronInfo; ///< Internal tetrahedron data EdgeData > m_edgeInfo; ///< Internal edge data diff --git a/Sofa/Component/SolidMechanics/FEM/HyperElastic/src/sofa/component/solidmechanics/fem/hyperelastic/TetrahedronHyperelasticityFEMForceField.inl b/Sofa/Component/SolidMechanics/FEM/HyperElastic/src/sofa/component/solidmechanics/fem/hyperelastic/TetrahedronHyperelasticityFEMForceField.inl index 3854c3c7790..43dd45698bf 100644 --- a/Sofa/Component/SolidMechanics/FEM/HyperElastic/src/sofa/component/solidmechanics/fem/hyperelastic/TetrahedronHyperelasticityFEMForceField.inl +++ b/Sofa/Component/SolidMechanics/FEM/HyperElastic/src/sofa/component/solidmechanics/fem/hyperelastic/TetrahedronHyperelasticityFEMForceField.inl @@ -62,9 +62,9 @@ template TetrahedronHyperelasticityFEMForceField::T , m_initialPoints(0) , m_updateMatrix(true) , d_stiffnessMatrixRegularizationWeight(initData(&d_stiffnessMatrixRegularizationWeight, (bool)false,"matrixRegularization","Regularization of the Stiffness Matrix (between true or false)")) - , d_materialName(initData(&d_materialName, materialOptions, "materialName","the name of the material to be used")) + , d_materialName(initData(&d_materialName, materialOptions, "materialName","the name of the material to be used. Possible options are: 'ArrudaBoyce', 'Costa', 'MooneyRivlin', 'NeoHookean', 'Ogden', 'StVenantKirchhoff', 'VerondaWestman', 'StableNeoHookean'")) , d_parameterSet(initData(&d_parameterSet,"ParameterSet","The global parameters specifying the material")) - , d_anisotropySet(initData(&d_anisotropySet,"AnisotropyDirections","The global directions of anisotropy of the material")) + , d_anisotropySet(initData(&d_anisotropySet,"AnisotropyDirections","The global directions of anisotropy of the material: vector containing anisotropic directions. The vector size is 0 if the material is isotropic, 1 if it is transversely isotropic and 2 for orthotropic materials")) , m_tetrahedronInfo(initData(&m_tetrahedronInfo, "tetrahedronInfo", "Internal tetrahedron data")) , m_edgeInfo(initData(&m_edgeInfo, "edgeInfo", "Internal edge data")) , l_topology(initLink("topology", "link to the topology container")) diff --git a/Sofa/Component/SolidMechanics/FEM/NonUniform/src/sofa/component/solidmechanics/fem/nonuniform/NonUniformHexahedralFEMForceFieldAndMass.h b/Sofa/Component/SolidMechanics/FEM/NonUniform/src/sofa/component/solidmechanics/fem/nonuniform/NonUniformHexahedralFEMForceFieldAndMass.h index e42b5b48d33..cf6ffcc6688 100644 --- a/Sofa/Component/SolidMechanics/FEM/NonUniform/src/sofa/component/solidmechanics/fem/nonuniform/NonUniformHexahedralFEMForceFieldAndMass.h +++ b/Sofa/Component/SolidMechanics/FEM/NonUniform/src/sofa/component/solidmechanics/fem/nonuniform/NonUniformHexahedralFEMForceFieldAndMass.h @@ -181,7 +181,7 @@ class NonUniformHexahedralFEMForceFieldAndMass : virtual public component::solid typedef core::objectmodel::Data DataVecCoord; typedef core::objectmodel::Data DataVecDeriv; - Data useMBK; ///< if true, compute and use MBK matrix + Data useMBK; ///< compute MBK and use it in addMBKdx, instead of using addDForce and addMDx. /** Matrix-vector product for implicit methods with iterative solvers. If the MBK matrix is ill-conditionned, recompute it, and correct it to avoid too small singular values. diff --git a/Sofa/Component/SolidMechanics/FEM/NonUniform/src/sofa/component/solidmechanics/fem/nonuniform/NonUniformHexahedronFEMForceFieldAndMass.h b/Sofa/Component/SolidMechanics/FEM/NonUniform/src/sofa/component/solidmechanics/fem/nonuniform/NonUniformHexahedronFEMForceFieldAndMass.h index c086b8330e9..64f65ec8ee1 100644 --- a/Sofa/Component/SolidMechanics/FEM/NonUniform/src/sofa/component/solidmechanics/fem/nonuniform/NonUniformHexahedronFEMForceFieldAndMass.h +++ b/Sofa/Component/SolidMechanics/FEM/NonUniform/src/sofa/component/solidmechanics/fem/nonuniform/NonUniformHexahedronFEMForceFieldAndMass.h @@ -75,8 +75,8 @@ class NonUniformHexahedronFEMForceFieldAndMass : virtual public component::solid public: - Data d_nbVirtualFinerLevels; ///< use virtual finer levels, in order to compte non-uniform stiffness, only valid if the topology is a SparseGridTopology with enough VirtualFinerLevels. - Data d_useMass; ///< Do we want to use this ForceField like a Mass? (or do we prefer using a separate Mass) + Data d_nbVirtualFinerLevels; ///< use virtual finer levels, in order to compte non-uniform stiffness + Data d_useMass; ///< Using this ForceField like a Mass? (rather than using a separated Mass) Data d_totalMass; /// Link to be set to the topology container in the component graph. diff --git a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/FastTriangularBendingSprings.h b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/FastTriangularBendingSprings.h index fd0f98839ec..f89a0514d21 100644 --- a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/FastTriangularBendingSprings.h +++ b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/FastTriangularBendingSprings.h @@ -68,8 +68,8 @@ class FastTriangularBendingSprings : public core::behavior::ForceField< _DataTyp using Index = sofa::Index; - Data d_bendingStiffness; ///< Material parameter - Data d_minDistValidity; ///< Minimal distance to consider a spring valid + Data d_bendingStiffness; ///< Bending stiffness of the material + Data d_minDistValidity; ///< Distance under which a spring is not valid /// Link to be set to the topology container in the component graph. SingleLink, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> l_topology; diff --git a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/FastTriangularBendingSprings.inl b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/FastTriangularBendingSprings.inl index e1a9e25ed45..5532d529d59 100644 --- a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/FastTriangularBendingSprings.inl +++ b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/FastTriangularBendingSprings.inl @@ -281,7 +281,7 @@ void FastTriangularBendingSprings::applyPointRenumbering(const sofa:: template FastTriangularBendingSprings::FastTriangularBendingSprings(/*double _ks, double _kd*/) - : d_bendingStiffness(initData(&d_bendingStiffness,(SReal) 1.0,"bendingStiffness","bending stiffness of the material")) + : d_bendingStiffness(initData(&d_bendingStiffness,(SReal) 1.0,"bendingStiffness","Bending stiffness of the material")) , d_minDistValidity(initData(&d_minDistValidity,(SReal) 0.000001,"minDistValidity","Distance under which a spring is not valid")) , l_topology(initLink("topology", "link to the topology container")) , d_edgeSprings(initData(&d_edgeSprings, "edgeInfo", "Internal edge data")) diff --git a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/PolynomialRestShapeSpringsForceField.h b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/PolynomialRestShapeSpringsForceField.h index a0652421952..2ae928e3f70 100644 --- a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/PolynomialRestShapeSpringsForceField.h +++ b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/PolynomialRestShapeSpringsForceField.h @@ -78,11 +78,11 @@ class PolynomialRestShapeSpringsForceField : public core::behavior::ForceField d_recomputeIndices; ///< Recompute indices (should be false for BBOX) - Data d_drawSpring; ///< draw Spring + Data d_drawSpring; ///< draw Spring Data d_springColor; ///< spring color Data d_showIndicesScale; ///< Scale for indices display. (default=0.02) - Data d_zeroLength; ///< Springs initial lengths + Data d_zeroLength; ///< initial virtual length of the spring Data d_smoothShift; ///< denominator correction adding shift value Data d_smoothScale; ///< denominator correction adding scale diff --git a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/PolynomialSpringsForceField.h b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/PolynomialSpringsForceField.h index 057c75e5a98..6d8e692a021 100644 --- a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/PolynomialSpringsForceField.h +++ b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/PolynomialSpringsForceField.h @@ -69,16 +69,16 @@ class PolynomialSpringsForceField : public core::behavior::PairInteractionForceF /// Describe set of polynomial degrees fro every spring Data< type::vector > d_polynomialDegree; - Data d_computeZeroLength; ///< Flag to verify if initial length has to be computed during the first iteration - Data d_zeroLength; ///< Springs initial lengths + Data d_computeZeroLength; ///< flag to compute initial length for springs + Data d_zeroLength; ///< initial length for springs Data d_recomputeIndices; ///< Recompute indices (should be false for BBOX) - Data d_compressible; ///< flag to put compressible springs + Data d_compressible; ///< Indicates if object compresses without any reaction force - Data d_drawMode; ///< Draw Mode: 0=Line - 1=Cylinder - 2=Arrow - Data d_showArrowSize; ///< size of the axis + Data d_drawMode; ///< The way springs will be drawn: - 0: Line - 1:Cylinder - 2: Arrow + Data d_showArrowSize; ///< size of the axis Data d_springColor; ///< spring color - Data d_showIndicesScale; ///< Scale for indices display. (default=0.02) + Data d_showIndicesScale; ///< Scale for indices display (default=0.02) // data to compute spring derivatives diff --git a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/PolynomialSpringsForceField.inl b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/PolynomialSpringsForceField.inl index 3f5b9d9fab2..547a69fa4c5 100644 --- a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/PolynomialSpringsForceField.inl +++ b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/PolynomialSpringsForceField.inl @@ -51,11 +51,11 @@ PolynomialSpringsForceField::PolynomialSpringsForceField(MechanicalSt , d_computeZeroLength(initData(&d_computeZeroLength, 1, "computeZeroLength", "flag to compute initial length for springs")) , d_zeroLength(initData(&d_zeroLength, "zeroLength", "initial length for springs")) , d_recomputeIndices(initData(&d_recomputeIndices, false, "recompute_indices", "Recompute indices (should be false for BBOX)")) - , d_compressible(initData(&d_compressible, false, "compressible", "Indicates if object compresses without reactio force")) + , d_compressible(initData(&d_compressible, false, "compressible", "Indicates if object compresses without any reaction force")) , d_drawMode(initData(&d_drawMode, 0, "drawMode", "The way springs will be drawn:\n- 0: Line\n- 1:Cylinder\n- 2: Arrow")) , d_showArrowSize(initData(&d_showArrowSize, 0.01f, "showArrowSize","size of the axis")) , d_springColor(initData(&d_springColor, sofa::type::RGBAColor(0.0f, 1.0f, 0.0f, 1.0f), "springColor", "spring color")) - , d_showIndicesScale(initData(&d_showIndicesScale, (float)0.02, "showIndicesScale", "Scale for indices display. (default=0.02)")) + , d_showIndicesScale(initData(&d_showIndicesScale, (float)0.02, "showIndicesScale", "Scale for indices display (default=0.02)")) , m_dimension(Coord::total_size) { } diff --git a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/SpringForceField.h b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/SpringForceField.h index 83e8f9a24a8..d07b5322707 100644 --- a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/SpringForceField.h +++ b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/SpringForceField.h @@ -71,7 +71,7 @@ class SpringForceField : public core::behavior::PairInteractionForceField ks; ///< uniform stiffness for the all springs Data kd; ///< uniform damping for the all springs Data showArrowSize; ///< size of the axis - Data drawMode; ///Draw Mode: 0=Line - 1=Cylinder - 2=Arrow + Data drawMode; ///< The way springs will be drawn: - 0: Line - 1:Cylinder - 2: Arrow Data > springs; ///< pairs of indices, stiffness, damping, rest length protected: diff --git a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/TriangularBendingSprings.h b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/TriangularBendingSprings.h index 6b37f9cbfc9..38b1e3dc006 100644 --- a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/TriangularBendingSprings.h +++ b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/TriangularBendingSprings.h @@ -62,7 +62,7 @@ class TriangularBendingSprings : public core::behavior::ForceField Data d_ks; ///< uniform stiffness for the all springs Data d_kd; ///< uniform damping for the all springs - Data d_showSprings; ///< Option to enable/disable the spring display when showForceField is on. True by default + Data d_showSprings; ///< option to draw springs /// Link to be set to the topology container in the component graph. SingleLink, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> l_topology; @@ -96,7 +96,7 @@ class TriangularBendingSprings : public core::behavior::ForceField } }; - sofa::core::topology::EdgeData > edgeInfo; ///< Internal Edge data storing @sa EdgeInformation per edge + sofa::core::topology::EdgeData > edgeInfo; ///< Internal edge data protected: TriangularBendingSprings(); diff --git a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/TriangularBiquadraticSpringsForceField.h b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/TriangularBiquadraticSpringsForceField.h index 309e81b7b88..a83203427e6 100644 --- a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/TriangularBiquadraticSpringsForceField.h +++ b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/TriangularBiquadraticSpringsForceField.h @@ -125,16 +125,16 @@ class TriangularBiquadraticSpringsForceField : public core::behavior::ForceField sofa::core::topology::TriangleData > triangleInfo; ///< Internal triangle data sofa::core::topology::EdgeData > edgeInfo; ///< Internal edge data - Data < VecCoord > _initialPoints; ///< the intial positions of the points + Data < VecCoord > _initialPoints; ///< Initial Position bool updateMatrix; Data f_poissonRatio; ///< Poisson ratio in Hooke's law Data f_youngModulus; ///< Young modulus in Hooke's law Data f_dampingRatio; ///< Ratio damping/stiffness - Data f_useAngularSprings; ///< whether angular springs should be included + Data f_useAngularSprings; ///< If Angular Springs should be used or not - Data f_compressible; ///< whether the material is compressible or not + Data f_compressible; ///< If additional energy penalizing compressibility should be used /**** coefficient that controls how the material can cope with very compressible cases must be between 0 and 1 : if 0 then the deformation may diverge for large compression if 1 then the material can undergo large compression even inverse elements ***/ diff --git a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/TriangularQuadraticSpringsForceField.h b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/TriangularQuadraticSpringsForceField.h index 28ce37bea6b..639e07c1a7e 100644 --- a/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/TriangularQuadraticSpringsForceField.h +++ b/Sofa/Component/SolidMechanics/Spring/src/sofa/component/solidmechanics/spring/TriangularQuadraticSpringsForceField.h @@ -116,14 +116,14 @@ class TriangularQuadraticSpringsForceField : public core::behavior::ForceField _initialPoints; ///< the intial positions of the points + Data< VecCoord > _initialPoints; ///< Initial Position bool updateMatrix; Data f_poissonRatio; ///< Poisson ratio in Hooke's law Data f_youngModulus; ///< Young modulus in Hooke's law Data f_dampingRatio; ///< Ratio damping/stiffness - Data f_useAngularSprings; ///< whether angular springs should be included + Data f_useAngularSprings; ///< If Angular Springs should be used or not Real lambda; /// first Lame coefficient Real mu; /// second Lame coefficient diff --git a/Sofa/Component/SolidMechanics/TensorMass/src/sofa/component/solidmechanics/tensormass/TetrahedralTensorMassForceField.h b/Sofa/Component/SolidMechanics/TensorMass/src/sofa/component/solidmechanics/tensormass/TetrahedralTensorMassForceField.h index 3d4590c9dd0..a71f5f47f8b 100644 --- a/Sofa/Component/SolidMechanics/TensorMass/src/sofa/component/solidmechanics/tensormass/TetrahedralTensorMassForceField.h +++ b/Sofa/Component/SolidMechanics/TensorMass/src/sofa/component/solidmechanics/tensormass/TetrahedralTensorMassForceField.h @@ -88,7 +88,7 @@ class TetrahedralTensorMassForceField : public core::behavior::ForceField f_poissonRatio; ///< Poisson ratio in Hooke's law - Data f_youngModulus; ///< Young modulus in Hooke's law + Data f_youngModulus; ///< Young's modulus in Hooke's law Real lambda; /// first Lame coefficient Real mu; /// second Lame coefficient diff --git a/Sofa/Component/SolidMechanics/TensorMass/src/sofa/component/solidmechanics/tensormass/TriangularTensorMassForceField.h b/Sofa/Component/SolidMechanics/TensorMass/src/sofa/component/solidmechanics/tensormass/TriangularTensorMassForceField.h index 4f6ef558110..204ad80b496 100644 --- a/Sofa/Component/SolidMechanics/TensorMass/src/sofa/component/solidmechanics/tensormass/TriangularTensorMassForceField.h +++ b/Sofa/Component/SolidMechanics/TensorMass/src/sofa/component/solidmechanics/tensormass/TriangularTensorMassForceField.h @@ -120,7 +120,7 @@ class TriangularTensorMassForceField : public core::behavior::ForceField f_poissonRatio; ///< Poisson ratio in Hooke's law - Data f_youngModulus; ///< Young modulus in Hooke's law + Data f_youngModulus; ///< Young's modulus in Hooke's law /// Link to be set to the topology container in the component graph. SingleLink, sofa::core::topology::BaseMeshTopology, BaseLink::FLAG_STOREPATH | BaseLink::FLAG_STRONGLINK> l_topology; diff --git a/Sofa/Component/StateContainer/src/sofa/component/statecontainer/MechanicalObject.h b/Sofa/Component/StateContainer/src/sofa/component/statecontainer/MechanicalObject.h index 3d1b0484d95..58aabafb9f2 100644 --- a/Sofa/Component/StateContainer/src/sofa/component/statecontainer/MechanicalObject.h +++ b/Sofa/Component/StateContainer/src/sofa/component/statecontainer/MechanicalObject.h @@ -113,7 +113,7 @@ class MechanicalObject : public sofa::core::behavior::MechanicalState Data< bool > showVectors; ///< Show velocity. (default=false) Data< float > showVectorsScale; ///< Scale for vectors display. (default=0.0001) Data< int > drawMode; ///< The way vectors will be drawn: - 0: Line - 1:Cylinder - 2: Arrow. The DOFS will be drawn: - 0: point - >1: sphere. (default=0) - Data< type::RGBAColor > d_color; ///< drawing color + Data< type::RGBAColor > d_color; ///< Color for object display. (default=[1 1 1 1]) void init() override; void reinit() override; diff --git a/Sofa/Component/Topology/Container/Constant/src/sofa/component/topology/container/constant/CubeTopology.h b/Sofa/Component/Topology/Container/Constant/src/sofa/component/topology/container/constant/CubeTopology.h index e926f0d1fa7..9b1c51f13eb 100644 --- a/Sofa/Component/Topology/Container/Constant/src/sofa/component/topology/container/constant/CubeTopology.h +++ b/Sofa/Component/Topology/Container/Constant/src/sofa/component/topology/container/constant/CubeTopology.h @@ -116,9 +116,9 @@ class SOFA_COMPONENT_TOPOLOGY_CONTAINER_CONSTANT_API CubeTopology : public MeshT Data max; - Data d_nx; ///< z grid resolution - Data d_ny; - Data d_nz; + Data d_nx; ///< x grid resolution + Data d_ny; ///< y grid resolution + Data d_nz; ///< z grid resolution Data d_internalPoints; ///< include internal points (allow a one-to-one mapping between points from RegularGridTopology and CubeTopology) Data d_splitNormals; ///< split corner points to have planar normals diff --git a/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/DynamicSparseGridTopologyContainer.h b/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/DynamicSparseGridTopologyContainer.h index 4b379c3ae67..348997b8548 100644 --- a/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/DynamicSparseGridTopologyContainer.h +++ b/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/DynamicSparseGridTopologyContainer.h @@ -50,7 +50,7 @@ class SOFA_COMPONENT_TOPOLOGY_CONTAINER_DYNAMIC_API DynamicSparseGridTopologyCon Data< sofa::type::vector > valuesIndexedInRegularGrid; SOFA_ATTRIBUTE_DEPRECATED__RENAME_DATA_IN_TOPOLOGY_CONTAINER_DYNAMIC() - core::topology::HexahedronData< sofa::type::vector > valuesIndexedInTopology; + core::topology::HexahedronData< sofa::type::vector > valuesIndexedInTopology; ///< values indexed in the topology SOFA_ATTRIBUTE_DEPRECATED__RENAME_DATA_IN_TOPOLOGY_CONTAINER_DYNAMIC() Data< sofa::type::vector > idxInRegularGrid; diff --git a/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/HexahedronSetTopologyModifier.h b/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/HexahedronSetTopologyModifier.h index ad96f658b98..e65e9f46666 100644 --- a/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/HexahedronSetTopologyModifier.h +++ b/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/HexahedronSetTopologyModifier.h @@ -57,14 +57,14 @@ class SOFA_COMPONENT_TOPOLOGY_CONTAINER_DYNAMIC_API HexahedronSetTopologyModifie protected: HexahedronSetTopologyModifier() : QuadSetTopologyModifier() - , removeIsolated( initData(&removeIsolated,true, "removeIsolated", "remove Isolated dof") ) + , removeIsolated( initData(&removeIsolated,true, "removeIsolated", "Remove isolated DOFs") ) { } ~HexahedronSetTopologyModifier() override {} public: void init() override; - Data< bool > removeIsolated; ///< Controlled DOF index. + Data< bool > removeIsolated; ///< Remove isolated DOFs /** \brief add a set of hexahedra @param hexahedra an array of vertex indices describing the hexahedra to be created diff --git a/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/MultilevelHexahedronSetTopologyContainer.h b/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/MultilevelHexahedronSetTopologyContainer.h index de9a797752a..1f08199b358 100644 --- a/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/MultilevelHexahedronSetTopologyContainer.h +++ b/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/MultilevelHexahedronSetTopologyContainer.h @@ -127,7 +127,7 @@ class SOFA_COMPONENT_TOPOLOGY_CONTAINER_DYNAMIC_API MultilevelHexahedronSetTopol const std::set& getHexaVoxels(const Index hexaId) const; Data _level; ///< Number of resolution levels between the fine and coarse mesh - Data fineResolution; ///< width, height, depth (number of hexa in each direction) + Data fineResolution; ///< fine resolution Data > hexaIndexInRegularGrid; ///< indices of the hexa in the grid. private: @@ -188,8 +188,8 @@ class SOFA_COMPONENT_TOPOLOGY_CONTAINER_DYNAMIC_API MultilevelHexahedronSetTopol std::list m_changeListFine; - core::topology::HexahedronData > _coarseComponents; ///< map between hexahedra and components - coarse - core::topology::HexahedronData > _fineComponents; ///< map between hexahedra and components - fine + core::topology::HexahedronData > _coarseComponents; ///< map between hexahedra and components - coarse + core::topology::HexahedronData > _fineComponents; ///< map between hexahedra and components - fine // the fine mesh must be a regular grid - store its parameters here diff --git a/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/PointSetTopologyContainer.h b/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/PointSetTopologyContainer.h index e0f0b51918d..698f3df0a48 100644 --- a/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/PointSetTopologyContainer.h +++ b/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/PointSetTopologyContainer.h @@ -148,9 +148,9 @@ class SOFA_COMPONENT_TOPOLOGY_CONTAINER_DYNAMIC_API PointSetTopologyContainer : const bool& isPointTopologyDirty() const {return m_pointTopologyDirty;} public: - Data d_initPoints; ///< Initial position of points + Data d_initPoints; ///< Initial position of points - Data d_checkTopology; ///< Bool parameter to activate internal topology checks in several methods + Data d_checkTopology; ///< Parameter to activate internal topology checks (might slow down the simulation) protected: /// Boolean used to know if the topology Data of this container is dirty diff --git a/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/PointSetTopologyModifier.h b/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/PointSetTopologyModifier.h index f56bd6ccafa..f201be03e1c 100644 --- a/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/PointSetTopologyModifier.h +++ b/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/PointSetTopologyModifier.h @@ -44,12 +44,12 @@ class SOFA_COMPONENT_TOPOLOGY_CONTAINER_DYNAMIC_API PointSetTopologyModifier : p friend class PointSetGeometryAlgorithms; typedef core::topology::BaseMeshTopology::PointID PointID; - Data d_propagateToDOF; ///< propagate changes to Mechanical object DOFs + Data d_propagateToDOF; ///< Propagate changes to Mechanical object DOFs protected: PointSetTopologyModifier() : TopologyModifier() - , d_propagateToDOF(initData(&d_propagateToDOF, true, "propagateToDOF", " propagate changes to MEchanical object DOFs if true")) + , d_propagateToDOF(initData(&d_propagateToDOF, true, "propagateToDOF", "Propagate changes to Mechanical object DOFs")) {} ~PointSetTopologyModifier() override {} diff --git a/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/TetrahedronSetTopologyModifier.h b/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/TetrahedronSetTopologyModifier.h index 70ed4d18876..fcda7675aec 100644 --- a/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/TetrahedronSetTopologyModifier.h +++ b/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/TetrahedronSetTopologyModifier.h @@ -54,11 +54,11 @@ class SOFA_COMPONENT_TOPOLOGY_CONTAINER_DYNAMIC_API TetrahedronSetTopologyModifi typedef Tetra Tetrahedron; - Data< bool > removeIsolated; ///< Controlled DOF index. + Data< bool > removeIsolated; ///< Remove isolated DOFs protected: TetrahedronSetTopologyModifier() : TriangleSetTopologyModifier() - , removeIsolated( initData(&removeIsolated,true, "removeIsolated", "remove Isolated dof") ) + , removeIsolated( initData(&removeIsolated,true, "removeIsolated", "Remove isolated DOFs") ) {} ~TetrahedronSetTopologyModifier() override {} diff --git a/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/TriangleSetGeometryAlgorithms.h b/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/TriangleSetGeometryAlgorithms.h index 7dc41b3fdd8..581d90cde83 100644 --- a/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/TriangleSetGeometryAlgorithms.h +++ b/Sofa/Component/Topology/Container/Dynamic/src/sofa/component/topology/container/dynamic/TriangleSetGeometryAlgorithms.h @@ -71,10 +71,10 @@ class TriangleSetGeometryAlgorithms : public EdgeSetGeometryAlgorithms showTriangleIndices; ///< Debug : view Triangle indices Data _draw; ///< if true, draw the triangles in the topology - Data _drawColor; ///< RGBA code color used to draw triangles. + Data _drawColor; ///< RGBA code color used to draw triangles Data _drawNormals; ///< if true, draw the triangles in the topology Data _drawNormalLength; ///< Fiber length visualisation. - Data p_recomputeTrianglesOrientation; ///< if true, will recompute triangles orientation according to normals. + Data p_recomputeTrianglesOrientation; ///< if true, will recompute triangles orientation according to normals Data p_flipNormals; ///< if true, will flip normal of the first triangle used to recompute triangle orientation. /// include cubature points NumericalIntegrationDescriptor triangleNumericalIntegration; diff --git a/Sofa/Component/Topology/Container/Grid/src/sofa/component/topology/container/grid/GridTopology.cpp b/Sofa/Component/Topology/Container/Grid/src/sofa/component/topology/container/grid/GridTopology.cpp index 756e51433d9..166d08df145 100644 --- a/Sofa/Component/Topology/Container/Grid/src/sofa/component/topology/container/grid/GridTopology.cpp +++ b/Sofa/Component/Topology/Container/Grid/src/sofa/component/topology/container/grid/GridTopology.cpp @@ -218,7 +218,7 @@ GridTopology::GridTopology() : d_n(initData(&d_n,type::Vec3i(2,2,2),"n","grid resolution. (default = 2 2 2)")) , d_computeHexaList(initData(&d_computeHexaList, true, "computeHexaList", "put true if the list of Hexahedra is needed during init (default=true)")) , d_computeQuadList(initData(&d_computeQuadList, true, "computeQuadList", "put true if the list of Quad is needed during init (default=true)")) - , d_computeTriangleList(initData(&d_computeTriangleList, true, "computeTriangleList", "put true if the list of triangle is needed during init (default=true)")) + , d_computeTriangleList(initData(&d_computeTriangleList, true, "computeTriangleList", "put true if the list of Triangles is needed during init (default=true)")) , d_computeEdgeList(initData(&d_computeEdgeList, true, "computeEdgeList", "put true if the list of Lines is needed during init (default=true)")) , d_computePointList(initData(&d_computePointList, true, "computePointList", "put true if the list of Points is needed during init (default=true)")) , d_createTexCoords(initData(&d_createTexCoords, (bool)false, "createTexCoords", "If set to true, virtual texture coordinates will be generated using 3D interpolation (default=false).")) diff --git a/Sofa/Component/Topology/Container/Grid/src/sofa/component/topology/container/grid/SparseGridTopology.h b/Sofa/Component/Topology/Container/Grid/src/sofa/component/topology/container/grid/SparseGridTopology.h index b78c3cc1538..0d4fbdc261c 100644 --- a/Sofa/Component/Topology/Container/Grid/src/sofa/component/topology/container/grid/SparseGridTopology.h +++ b/Sofa/Component/Topology/Container/Grid/src/sofa/component/topology/container/grid/SparseGridTopology.h @@ -201,7 +201,7 @@ class SOFA_COMPONENT_TOPOLOGY_CONTAINER_GRID_API SparseGridTopology : public con Data< type::vector< unsigned char > > d_dataVoxels; - Data d_fillWeighted; ///< is quantity of matter inside a cell taken into account? + Data d_fillWeighted; ///< Is quantity of matter inside a cell taken into account? (.5 for boundary, 1 for inside) Data d_bOnlyInsideCells; ///< Select only inside cells (exclude boundary cells) diff --git a/Sofa/Component/Topology/Mapping/src/sofa/component/topology/mapping/Edge2QuadTopologicalMapping.h b/Sofa/Component/Topology/Mapping/src/sofa/component/topology/mapping/Edge2QuadTopologicalMapping.h index cf838710074..3f66b8606f0 100644 --- a/Sofa/Component/Topology/Mapping/src/sofa/component/topology/mapping/Edge2QuadTopologicalMapping.h +++ b/Sofa/Component/Topology/Mapping/src/sofa/component/topology/mapping/Edge2QuadTopologicalMapping.h @@ -88,10 +88,10 @@ class SOFA_COMPONENT_TOPOLOGY_MAPPING_API Edge2QuadTopologicalMapping : public s Index getFromIndex(Index ind) override; - Data d_nbPointsOnEachCircle; ///< number of points to create along the circles around each point of the input topology (10 by default) - Data d_radius; ///< radius of the circles around each point of the input topology (1 by default) - Data d_radiusFocal; ///< in case of ellipse, (extra) radius on the focal axis (0 by default) - Data d_focalAxis; ///< in case of ellipse, focal axis (default [0,0,1]) + Data d_nbPointsOnEachCircle; ///< Discretization of created circles + Data d_radius; ///< Radius of created circles in yz plan + Data d_radiusFocal; ///< If greater than 0., radius in focal axis of created ellipses + Data d_focalAxis; ///< In case of ellipses Data d_edgeList; ///< list of input edges for the topological mapping: by default, all considered Data d_flipNormals; ///< Flip Normal ? (Inverse point order when creating quad) diff --git a/Sofa/Component/Topology/Utility/src/sofa/component/topology/utility/TopologyBoundingTrasher.h b/Sofa/Component/Topology/Utility/src/sofa/component/topology/utility/TopologyBoundingTrasher.h index e7c9d321080..c8743c96ebe 100644 --- a/Sofa/Component/Topology/Utility/src/sofa/component/topology/utility/TopologyBoundingTrasher.h +++ b/Sofa/Component/Topology/Utility/src/sofa/component/topology/utility/TopologyBoundingTrasher.h @@ -85,7 +85,7 @@ class SOFA_COMPONENT_TOPOLOGY_UTILITY_API TopologyBoundingTrasher: public core:: public: Data d_positions; ///< position coordinates of the topology object to interact with. Data d_borders; ///< List of boxes defined by xmin,ymin,zmin, xmax,ymax,zmax - Data d_drawBox; ///< draw bounding box + Data d_drawBox; ///< Draw bounding box (default = false) /// Link to be set to the topology container in the component graph. SingleLink l_topology; diff --git a/Sofa/Component/Topology/Utility/src/sofa/component/topology/utility/TopologyBoundingTrasher.inl b/Sofa/Component/Topology/Utility/src/sofa/component/topology/utility/TopologyBoundingTrasher.inl index 0336a039156..5fa1756f869 100644 --- a/Sofa/Component/Topology/Utility/src/sofa/component/topology/utility/TopologyBoundingTrasher.inl +++ b/Sofa/Component/Topology/Utility/src/sofa/component/topology/utility/TopologyBoundingTrasher.inl @@ -42,7 +42,7 @@ template TopologyBoundingTrasher::TopologyBoundingTrasher() : d_positions(initData(&d_positions, "position", "position coordinates of the topology object to interact with.")) , d_borders(initData(&d_borders, Vec6(-1000, -1000, -1000, 1000, 1000, 1000), "box", "List of boxes defined by xmin,ymin,zmin, xmax,ymax,zmax")) - , d_drawBox(initData(&d_drawBox, false, "drawBox", "Draw Boxes. (default = false)")) + , d_drawBox(initData(&d_drawBox, false, "drawBox", "Draw bounding box (default = false)")) , l_topology(initLink("topology", "link to the topology container")) , m_topology(nullptr) , edgeModifier(nullptr) diff --git a/Sofa/Component/Visual/src/sofa/component/visual/VisualModelImpl.h b/Sofa/Component/Visual/src/sofa/component/visual/VisualModelImpl.h index 7d426b1491a..aff16ba357b 100644 --- a/Sofa/Component/Visual/src/sofa/component/visual/VisualModelImpl.h +++ b/Sofa/Component/Visual/src/sofa/component/visual/VisualModelImpl.h @@ -134,7 +134,7 @@ class SOFA_COMPONENT_VISUAL_API VisualModelImpl : public core::visual::VisualMod Data< type::vector > m_vertNormIdx; - Data d_initRestPositions; ///< True if rest positions should be initialized with initial positions, False if nothing should be done + Data d_initRestPositions; ///< True if rest positions must be initialized with initial positions Data d_useNormals; ///< True if normals should be read from file Data d_updateNormals; ///< True if normals should be updated at each iteration Data d_computeTangents; ///< True if tangents should be computed at startup diff --git a/Sofa/GL/Component/Rendering2D/src/sofa/gl/component/rendering2d/OglColorMap.h b/Sofa/GL/Component/Rendering2D/src/sofa/gl/component/rendering2d/OglColorMap.h index ab9efb646d1..703e0a66d2c 100644 --- a/Sofa/GL/Component/Rendering2D/src/sofa/gl/component/rendering2d/OglColorMap.h +++ b/Sofa/GL/Component/Rendering2D/src/sofa/gl/component/rendering2d/OglColorMap.h @@ -55,11 +55,11 @@ class SOFA_GL_COMPONENT_RENDERING2D_API OglColorMap : public sofa::core::visual: Data d_showLegend; ///< Activate rendering of color scale legend on the side Data d_legendOffset; ///< Draw the legend on screen with an x,y offset - Data d_legendTitle; ///< Add a title to the legend - Data d_legendSize; ///< Font size of the legend (if any) + Data d_legendTitle; ///< Font size of the legend (if any) + Data d_legendSize; ///< Add a title to the legend Data d_min; ///< min value for drawing the legend without the need to actually use the range with getEvaluator method wich sets the min Data d_max; ///< max value for drawing the legend without the need to actually use the range with getEvaluator method wich sets the max - Data d_legendRangeScale; ///< to convert unit + Data d_legendRangeScale; ///< to change the unit of the min/max value of the legend sofa::helper::ColorMap m_colorMap; GLuint texture; diff --git a/Sofa/GL/Component/Rendering3D/src/sofa/gl/component/rendering3d/DataDisplay.cpp b/Sofa/GL/Component/Rendering3D/src/sofa/gl/component/rendering3d/DataDisplay.cpp index 698d214bc9c..03be99c5517 100644 --- a/Sofa/GL/Component/Rendering3D/src/sofa/gl/component/rendering3d/DataDisplay.cpp +++ b/Sofa/GL/Component/Rendering3D/src/sofa/gl/component/rendering3d/DataDisplay.cpp @@ -46,7 +46,7 @@ DataDisplay::DataDisplay() , f_quadData(initData(&f_quadData, "quadData", "Data associated with quads")) , f_pointTriangleData(initData(&f_pointTriangleData, "pointTriangleData", "Data associated with nodes per triangle")) , f_pointQuadData(initData(&f_pointQuadData, "pointQuadData", "Data associated with nodes per quad")) - , f_colorNaN(initData(&f_colorNaN, sofa::type::RGBAColor(0.0f,0.0f,0.0f,1.0f), "colorNaN", "Color used for NaN values.(default=[0.0,0.0,0.0,1.0])")) + , f_colorNaN(initData(&f_colorNaN, sofa::type::RGBAColor(0.0f,0.0f,0.0f,1.0f), "colorNaN", "Color used for NaN values (default=[0.0,0.0,0.0,1.0])")) , d_userRange(initData(&d_userRange, type::Vec2f(1,-1), "userRange", "Clamp to this values (if max>min)")) , d_currentMin(initData(&d_currentMin, Real(0.0), "currentMin", "Current min range")) , d_currentMax(initData(&d_currentMax, Real(0.0), "currentMax", "Current max range")) diff --git a/Sofa/GL/Component/Rendering3D/src/sofa/gl/component/rendering3d/DataDisplay.h b/Sofa/GL/Component/Rendering3D/src/sofa/gl/component/rendering3d/DataDisplay.h index 621505ea878..f2924cd6810 100644 --- a/Sofa/GL/Component/Rendering3D/src/sofa/gl/component/rendering3d/DataDisplay.h +++ b/Sofa/GL/Component/Rendering3D/src/sofa/gl/component/rendering3d/DataDisplay.h @@ -52,7 +52,7 @@ class SOFA_GL_COMPONENT_RENDERING3D_API DataDisplay : public core::visual::Visua Data f_quadData; ///< Data associated with quads Data f_pointTriangleData; ///< Data associated with nodes per triangle Data f_pointQuadData; ///< Data associated with nodes per quad - Data f_colorNaN; ///< Color for NaNs + Data f_colorNaN; ///< Color used for NaN values (default=[0.0,0.0,0.0,1.0]) Data d_userRange; ///< Clamp to this values (if max>min) Data d_currentMin; ///< Current min range Data d_currentMax; ///< Current max range diff --git a/Sofa/framework/Core/src/sofa/core/Multi2Mapping.h b/Sofa/framework/Core/src/sofa/core/Multi2Mapping.h index e970c163ee3..3fa44c7b8be 100644 --- a/Sofa/framework/Core/src/sofa/core/Multi2Mapping.h +++ b/Sofa/framework/Core/src/sofa/core/Multi2Mapping.h @@ -80,7 +80,7 @@ class Multi2Mapping : public BaseMapping public: - Data f_applyRestPosition; ///< @todo document this + Data f_applyRestPosition; ///< set to true to apply this mapping to restPosition at init protected: /// Constructor diff --git a/Sofa/framework/Core/src/sofa/core/MultiMapping.h b/Sofa/framework/Core/src/sofa/core/MultiMapping.h index ca53a030f02..c6ecfe48c78 100644 --- a/Sofa/framework/Core/src/sofa/core/MultiMapping.h +++ b/Sofa/framework/Core/src/sofa/core/MultiMapping.h @@ -72,7 +72,7 @@ class MultiMapping : public BaseMapping public: - Data f_applyRestPosition; ///< @todo document this + Data f_applyRestPosition; ///< set to true to apply this mapping to restPosition at init protected: /// Constructor diff --git a/Sofa/framework/Core/src/sofa/core/behavior/Constraint.h b/Sofa/framework/Core/src/sofa/core/behavior/Constraint.h index 283a5ec2da7..62ed6dc2294 100644 --- a/Sofa/framework/Core/src/sofa/core/behavior/Constraint.h +++ b/Sofa/framework/Core/src/sofa/core/behavior/Constraint.h @@ -62,7 +62,7 @@ class Constraint : public BaseConstraint, public SingleStateAccessor virtual void init() override; public: - Data endTime; ///< Time when the constraint becomes inactive (-1 for infinitely active) + Data endTime; ///< The constraint stops acting after the given value. Use a negative value for infinite constraints virtual bool isActive() const; ///< if false, the constraint does nothing using BaseConstraintSet::getConstraintViolation; diff --git a/Sofa/framework/Core/src/sofa/core/behavior/MixedInteractionConstraint.h b/Sofa/framework/Core/src/sofa/core/behavior/MixedInteractionConstraint.h index 4857eff493c..b36a5d6ef91 100644 --- a/Sofa/framework/Core/src/sofa/core/behavior/MixedInteractionConstraint.h +++ b/Sofa/framework/Core/src/sofa/core/behavior/MixedInteractionConstraint.h @@ -75,7 +75,7 @@ class MixedInteractionConstraint : public BaseInteractionConstraint, public Pair public: - Data endTime; ///< Time when the constraint becomes inactive (-1 for infinitely active) + Data endTime; ///< The constraint stops acting after the given value. Use a negative value for infinite constraints virtual bool isActive() const; ///< if false, the constraint does nothing using BaseConstraintSet::getConstraintViolation; diff --git a/Sofa/framework/Core/src/sofa/core/behavior/PairInteractionConstraint.h b/Sofa/framework/Core/src/sofa/core/behavior/PairInteractionConstraint.h index 2e524f43f4e..269b400d6c6 100644 --- a/Sofa/framework/Core/src/sofa/core/behavior/PairInteractionConstraint.h +++ b/Sofa/framework/Core/src/sofa/core/behavior/PairInteractionConstraint.h @@ -58,7 +58,7 @@ class PairInteractionConstraint : public BaseInteractionConstraint, public PairS ~PairInteractionConstraint() override; public: - Data endTime; ///< Time when the constraint becomes inactive (-1 for infinitely active) + Data endTime; ///< The constraint stops acting after the given value. Use a negative value for infinite constraints virtual bool isActive() const; ///< if false, the constraint does nothing using BaseConstraintSet::getConstraintViolation; diff --git a/Sofa/framework/Core/src/sofa/core/behavior/PairInteractionProjectiveConstraintSet.h b/Sofa/framework/Core/src/sofa/core/behavior/PairInteractionProjectiveConstraintSet.h index fa61da72190..3547b05f9da 100644 --- a/Sofa/framework/Core/src/sofa/core/behavior/PairInteractionProjectiveConstraintSet.h +++ b/Sofa/framework/Core/src/sofa/core/behavior/PairInteractionProjectiveConstraintSet.h @@ -56,7 +56,7 @@ class PairInteractionProjectiveConstraintSet : public BaseInteractionProjectiveC ~PairInteractionProjectiveConstraintSet() override; public: - Data endTime; ///< Time when the constraint becomes inactive (-1 for infinitely active) + Data endTime; ///< The constraint stops acting after the given value. Use a negative value for infinite constraints virtual bool isActive() const; ///< if false, the constraint does nothing // to get rid of warnings diff --git a/Sofa/framework/Core/src/sofa/core/behavior/ProjectiveConstraintSet.h b/Sofa/framework/Core/src/sofa/core/behavior/ProjectiveConstraintSet.h index f6f4a853f1f..6374406aa49 100644 --- a/Sofa/framework/Core/src/sofa/core/behavior/ProjectiveConstraintSet.h +++ b/Sofa/framework/Core/src/sofa/core/behavior/ProjectiveConstraintSet.h @@ -64,7 +64,7 @@ class ProjectiveConstraintSet : public BaseProjectiveConstraintSet, public Singl - Data endTime; ///< Time when the constraint becomes inactive (-1 for infinitely active) + Data endTime; ///< The constraint stops acting after the given value. Use a negative value for infinite constraints virtual bool isActive() const; ///< if false, the constraint does nothing virtual type::vector< core::BaseState* > getModels() override diff --git a/Sofa/framework/Core/src/sofa/core/loader/MeshLoader.h b/Sofa/framework/Core/src/sofa/core/loader/MeshLoader.h index 4ba1ea82a53..f15f4af3974 100644 --- a/Sofa/framework/Core/src/sofa/core/loader/MeshLoader.h +++ b/Sofa/framework/Core/src/sofa/core/loader/MeshLoader.h @@ -161,7 +161,7 @@ class SOFA_CORE_API MeshLoader : public BaseLoader // polygons in 3D ? //Misc - Data< type::vector > d_normals; ///< Normals per vertex + Data< type::vector > d_normals; ///< Normals of the mesh loaded // Groups Data< type::vector< PrimitiveGroup > > d_edgesGroups; ///< Groups of Edges diff --git a/Sofa/framework/Core/src/sofa/core/loader/VoxelLoader.h b/Sofa/framework/Core/src/sofa/core/loader/VoxelLoader.h index aa5f389e84d..b65693a799c 100644 --- a/Sofa/framework/Core/src/sofa/core/loader/VoxelLoader.h +++ b/Sofa/framework/Core/src/sofa/core/loader/VoxelLoader.h @@ -48,7 +48,7 @@ class SOFA_CORE_API VoxelLoader : public sofa::core::loader::BaseLoader public: Data< type::vector > positions; ///< Coordinates of the nodes loaded - Data< type::vector > hexahedra; ///< Hexahedra loaded + Data< type::vector > hexahedra; ///< Hexahedra loaded void addHexahedron(type::vector< Hexahedron >* pHexahedra, const type::fixed_array &p); diff --git a/Sofa/framework/Core/src/sofa/core/objectmodel/Base.h b/Sofa/framework/Core/src/sofa/core/objectmodel/Base.h index 2d146d283dc..f586b1e9858 100644 --- a/Sofa/framework/Core/src/sofa/core/objectmodel/Base.h +++ b/Sofa/framework/Core/src/sofa/core/objectmodel/Base.h @@ -394,7 +394,7 @@ class SOFA_CORE_API Base Data< sofa::type::BoundingBox > f_bbox; ///< this object bounding box - Data< sofa::core::objectmodel::ComponentState > d_componentState; ///< the object state + Data< sofa::core::objectmodel::ComponentState > d_componentState; ///< The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). std::string m_definitionSourceFileName {""}; int m_definitionSourceFilePos {-1}; diff --git a/Sofa/framework/Core/src/sofa/core/objectmodel/Context.h b/Sofa/framework/Core/src/sofa/core/objectmodel/Context.h index 1b98960ccd5..758af6fbd40 100644 --- a/Sofa/framework/Core/src/sofa/core/objectmodel/Context.h +++ b/Sofa/framework/Core/src/sofa/core/objectmodel/Context.h @@ -36,12 +36,12 @@ class SOFA_CORE_API Context : public BaseContext SOFA_CLASS(Context, BaseContext); Data is_activated; ///< To Activate a node - Data worldGravity_; ///< Gravity IN THE WORLD COORDINATE SYSTEM. + Data worldGravity_; ///< Gravity in the world coordinate system Data dt_; ///< Time step Data time_; ///< Current time Data animate_; ///< Animate the Simulation(applied at initialization only) - Data d_isSleeping; ///< Tells if the context is sleeping, and thus ignored by visitors - Data d_canChangeSleepingState; ///< Tells if the context can change its sleeping state + Data d_isSleeping; ///< The node is sleeping, and thus ignored by visitors. + Data d_canChangeSleepingState; ///< The node can change its sleeping state. protected: Context(); diff --git a/Sofa/framework/Core/src/sofa/core/visual/VisualModel.h b/Sofa/framework/Core/src/sofa/core/visual/VisualModel.h index 77bc842dc2d..5002bb6521a 100644 --- a/Sofa/framework/Core/src/sofa/core/visual/VisualModel.h +++ b/Sofa/framework/Core/src/sofa/core/visual/VisualModel.h @@ -48,7 +48,7 @@ class SOFA_CORE_API VisualModel : public virtual objectmodel::BaseObject SOFA_ABSTRACT_CLASS(VisualModel, objectmodel::BaseObject); SOFA_BASE_CAST_IMPLEMENTATION(VisualModel) - Data d_enable; ///< Display the visual model or not + Data d_enable; ///< Display the object or not /** * \brief Display the VisualModel object. diff --git a/Sofa/framework/Core/test/TestEngine.h b/Sofa/framework/Core/test/TestEngine.h index 22a9e931ff8..ad4fd735f61 100644 --- a/Sofa/framework/Core/test/TestEngine.h +++ b/Sofa/framework/Core/test/TestEngine.h @@ -62,9 +62,9 @@ class TestEngine : public core::DataEngine void printUpdateCallList(); - Data f_numberToMultiply; ///< number to multiply - Data f_factor; ///< multiplication factor - Data f_result; ///< result + Data f_numberToMultiply; ///< number that will be multiplied by the factor + Data f_factor; ///< multiplication factor + Data f_result; ///< result of the multiplication of numberToMultiply by factor int counter; diff --git a/Sofa/framework/Simulation/Core/src/sofa/simulation/DefaultAnimationLoop.cpp b/Sofa/framework/Simulation/Core/src/sofa/simulation/DefaultAnimationLoop.cpp index 904387497d4..c20b0c0d80b 100644 --- a/Sofa/framework/Simulation/Core/src/sofa/simulation/DefaultAnimationLoop.cpp +++ b/Sofa/framework/Simulation/Core/src/sofa/simulation/DefaultAnimationLoop.cpp @@ -33,7 +33,6 @@ #include #include #include -#include #include #include @@ -49,7 +48,6 @@ #include #include #include -#include #include #include #include diff --git a/Sofa/framework/Simulation/Core/src/sofa/simulation/DefaultAnimationLoop.h b/Sofa/framework/Simulation/Core/src/sofa/simulation/DefaultAnimationLoop.h index c11161170f0..dd07da022bb 100644 --- a/Sofa/framework/Simulation/Core/src/sofa/simulation/DefaultAnimationLoop.h +++ b/Sofa/framework/Simulation/Core/src/sofa/simulation/DefaultAnimationLoop.h @@ -54,7 +54,7 @@ class SOFA_SIMULATION_CORE_API DefaultAnimationLoop : public sofa::core::behavio ~DefaultAnimationLoop() override; public: - Data d_parallelODESolving; /// d_parallelODESolving; ///< If true, solves all the ODEs in parallel void init() override; diff --git a/Sofa/framework/Simulation/Core/src/sofa/simulation/RequiredPlugin.h b/Sofa/framework/Simulation/Core/src/sofa/simulation/RequiredPlugin.h index 873558cb480..a20e2446d16 100644 --- a/Sofa/framework/Simulation/Core/src/sofa/simulation/RequiredPlugin.h +++ b/Sofa/framework/Simulation/Core/src/sofa/simulation/RequiredPlugin.h @@ -41,7 +41,7 @@ class SOFA_SIMULATION_CORE_API RequiredPlugin : public core::objectmodel::BaseOb sofa::core::objectmodel::Data d_requireOne; ///< Display an error message if no plugin names were successfully loaded sofa::core::objectmodel::Data d_requireAll; ///< Display an error message if any plugin names failed to be loaded - sofa::core::objectmodel::Data > d_loadedPlugins; ///< name of the loaded plugins + sofa::core::objectmodel::Data > d_loadedPlugins; ///< List of the plugins that are have been loaded. protected: RequiredPlugin(); diff --git a/applications/collections/deprecated/modules/SofaValidation/src/SofaValidation/DevAngleCollisionMonitor.h b/applications/collections/deprecated/modules/SofaValidation/src/SofaValidation/DevAngleCollisionMonitor.h index 3f55ca6ffe1..b806e98219d 100644 --- a/applications/collections/deprecated/modules/SofaValidation/src/SofaValidation/DevAngleCollisionMonitor.h +++ b/applications/collections/deprecated/modules/SofaValidation/src/SofaValidation/DevAngleCollisionMonitor.h @@ -49,9 +49,11 @@ class DevAngleCollisionMonitor: public virtual DevMonitor maxDist; ///< alarm distance for proximity detection + protected: DevAngleCollisionMonitor(); virtual ~DevAngleCollisionMonitor() { }; + public: void init() override; void eval() override; diff --git a/applications/plugins/ArticulatedSystemPlugin/src/ArticulatedSystemPlugin/ArticulatedHierarchyController.h b/applications/plugins/ArticulatedSystemPlugin/src/ArticulatedSystemPlugin/ArticulatedHierarchyController.h index 93e10fbb804..80b9098a122 100644 --- a/applications/plugins/ArticulatedSystemPlugin/src/ArticulatedSystemPlugin/ArticulatedHierarchyController.h +++ b/applications/plugins/ArticulatedSystemPlugin/src/ArticulatedSystemPlugin/ArticulatedHierarchyController.h @@ -108,10 +108,10 @@ class SOFA_ARTICULATEDSYSTEMPLUGIN_API ArticulatedHierarchyController : public C virtual void applyController(void); protected: - Data > articulationsIndices; ///< Stores controlled articulations indices. - Data > bindingKeys; ///< Stores controlled articulations keyboard keys. - Data< double > angleDelta; ///< Angle step added at each event reception. - Data< bool > propagateUserInteraction; ///< Says wether or not to apportion the articulation modification to its children in the hierarchy. + Data > articulationsIndices; ///< Indices of articulations controlled by the keyboard + Data > bindingKeys; ///< Keys to press to control the articulations + Data< double > angleDelta; ///< Angle incrementation due to each user interaction + Data< bool > propagateUserInteraction; ///< Says wether or not the user interaction is local on the articulations, or must be propagated to children recursively type::vector< bool > activeArticulations; ///< Stores activated articulations information. std::map > articulationsPropagationChains; diff --git a/applications/plugins/Geomagic/src/Geomagic/GeomagicDriver.cpp b/applications/plugins/Geomagic/src/Geomagic/GeomagicDriver.cpp index 359a3bfd6b5..dd54d354a3d 100644 --- a/applications/plugins/Geomagic/src/Geomagic/GeomagicDriver.cpp +++ b/applications/plugins/Geomagic/src/Geomagic/GeomagicDriver.cpp @@ -158,7 +158,7 @@ GeomagicDriver::GeomagicDriver() , d_orientationBase(initData(&d_orientationBase, Quat(0,0,0,1), "orientationBase","Orientation of the device base in the SOFA scene world coordinates")) , d_orientationTool(initData(&d_orientationTool, Quat(0,0,0,1), "orientationTool","Orientation of the tool in the SOFA scene world coordinates")) , d_scale(initData(&d_scale, 1.0, "scale", "Default scale applied to the Device coordinates")) - , d_forceScale(initData(&d_forceScale, 1.0, "forceScale", "Default forceScale applied to the force feedback. ")) + , d_forceScale(initData(&d_forceScale, 1.0, "forceScale", "Default scaling factor applied to the force feedback")) , d_maxInputForceFeedback(initData(&d_maxInputForceFeedback, double(1.0), "maxInputForceFeedback", "Maximum value of the normed input force feedback for device security")) , d_inputForceFeedback(initData(&d_inputForceFeedback, Vec3(0, 0, 0), "inputForceFeedback", "Input force feedback in case of no LCPForceFeedback is found (manual setting)")) , d_manualStart(initData(&d_manualStart, false, "manualStart", "If true, will not automatically initDevice at component init phase.")) diff --git a/applications/plugins/Geomagic/src/Geomagic/GeomagicDriver.h b/applications/plugins/Geomagic/src/Geomagic/GeomagicDriver.h index 5930a27e535..e61a9f66804 100644 --- a/applications/plugins/Geomagic/src/Geomagic/GeomagicDriver.h +++ b/applications/plugins/Geomagic/src/Geomagic/GeomagicDriver.h @@ -101,19 +101,19 @@ class SOFA_GEOMAGIC_API GeomagicDriver : public Controller public: //Input Data Data< std::string > d_deviceName; ///< Name of device Configuration - Data d_positionBase; ///< Input Position of the device base in the scene world coordinates - Data d_orientationBase; ///< Input Orientation of the device base in the scene world coordinates - Data d_orientationTool; ///< Input Orientation of the tool - Data d_scale; ///< Default scale applied to the device Coordinates - Data d_forceScale; ///< Default forceScale applied to the force feedback. + Data d_positionBase; ///< Position of the device base in the SOFA scene world coordinates + Data d_orientationBase; ///< Orientation of the device base in the SOFA scene world coordinates + Data d_orientationTool; ///< Orientation of the tool in the SOFA scene world coordinates + Data d_scale; ///< Default scale applied to the Device coordinates + Data d_forceScale; ///< Default scaling factor applied to the force feedback Data d_maxInputForceFeedback; ///< Maximum value of the normed input force feedback for device security Data d_inputForceFeedback; ///< Input force feedback in case of no LCPForceFeedback is found (manual setting) // Input parameters - Data d_manualStart; ///< Bool to unactive the automatic start of the device at init. initDevice need to be called manually. False by default. - Data d_emitButtonEvent; ///< Bool to send event through the graph when button are pushed/released + Data d_manualStart; ///< If true, will not automatically initDevice at component init phase. + Data d_emitButtonEvent; ///< If true, will send event through the graph when button are pushed/released Data d_frameVisu; ///< Visualize the frame corresponding to the device tooltip - Data d_omniVisu; ///< Visualize the frame of the interface in the virtual scene + Data d_omniVisu; ///< Visualize the Geomagic device in the virtual scene //Output Data Data d_posDevice; ///< position of the base of the part of the device diff --git a/applications/plugins/Geomagic/src/Geomagic/GeomagicEmulator.h b/applications/plugins/Geomagic/src/Geomagic/GeomagicEmulator.h index 8ad8a4bae0c..20bdb925e37 100644 --- a/applications/plugins/Geomagic/src/Geomagic/GeomagicEmulator.h +++ b/applications/plugins/Geomagic/src/Geomagic/GeomagicEmulator.h @@ -73,7 +73,7 @@ class SOFA_GEOMAGIC_API GeomagicEmulator : public GeomagicDriver - Data d_speedFactor; ///< factor to increase/decrease the movements speed + Data d_speedFactor; ///< factor to increase/decrease the movements speed void applyTranslation(sofa::type::Vec3 translation); void worldToLocal(sofa::type::Vec3& vector); diff --git a/applications/plugins/MultiThreading/src/MultiThreading/DataExchange.h b/applications/plugins/MultiThreading/src/MultiThreading/DataExchange.h index b1bab2b232c..7d04d03360e 100644 --- a/applications/plugins/MultiThreading/src/MultiThreading/DataExchange.h +++ b/applications/plugins/MultiThreading/src/MultiThreading/DataExchange.h @@ -111,7 +111,7 @@ class DataExchange : public virtual objectmodel::BaseObject } - Data mSource; ///< source object to copy + Data mSource; ///< source object to copy Data mDestination; ///< destination object to copy private: diff --git a/applications/plugins/MultiThreading/src/MultiThreading/TaskSchedulerUser.h b/applications/plugins/MultiThreading/src/MultiThreading/TaskSchedulerUser.h index 865c7b534c5..5b4cb0b0d70 100644 --- a/applications/plugins/MultiThreading/src/MultiThreading/TaskSchedulerUser.h +++ b/applications/plugins/MultiThreading/src/MultiThreading/TaskSchedulerUser.h @@ -33,7 +33,7 @@ class SOFA_MULTITHREADING_PLUGIN_API TaskSchedulerUser : virtual public sofa::co { public: sofa::Data d_nbThreads; - sofa::Data d_taskSchedulerType; + sofa::Data d_taskSchedulerType; ///< Type of task scheduler to use. protected: sofa::simulation::TaskScheduler* m_taskScheduler { nullptr }; diff --git a/applications/plugins/Sensable/NewOmniDriver.cpp b/applications/plugins/Sensable/NewOmniDriver.cpp index 6ebbfaed95c..7bd587ea2a6 100644 --- a/applications/plugins/Sensable/NewOmniDriver.cpp +++ b/applications/plugins/Sensable/NewOmniDriver.cpp @@ -394,7 +394,7 @@ int NewOmniDriver::initDevice() //constructeur NewOmniDriver::NewOmniDriver() - : forceScale(initData(&forceScale, 1.0, "forceScale","Default forceScale applied to the force feedback. ")) + : forceScale(initData(&forceScale, 1.0, "forceScale","Default scaling factor applied to the force feedback")) , scale(initData(&scale, 100.0, "scale","Default scale applied to the Phantom Coordinates. ")) , positionBase(initData(&positionBase, Vec3d(0,0,0), "positionBase","Position of the interface base in the scene world coordinates")) , orientationBase(initData(&orientationBase, Quat(0,0,0,1), "orientationBase","Orientation of the interface base in the scene world coordinates")) diff --git a/applications/plugins/Sensable/NewOmniDriver.h b/applications/plugins/Sensable/NewOmniDriver.h index 389867fcd5d..d8230dc21d1 100644 --- a/applications/plugins/Sensable/NewOmniDriver.h +++ b/applications/plugins/Sensable/NewOmniDriver.h @@ -135,7 +135,7 @@ class NewOmniDriver : public Controller - Data forceScale; ///< Default forceScale applied to the force feedback. + Data forceScale; ///< Default scaling factor applied to the force feedback Data scale; ///< Default scale applied to the Phantom Coordinates. Data positionBase; ///< Position of the interface base in the scene world coordinates Data orientationBase; ///< Orientation of the interface base in the scene world coordinates diff --git a/applications/plugins/Sensable/OmniDriver.cpp b/applications/plugins/Sensable/OmniDriver.cpp index 211d8a5a4a0..38fa65f080e 100644 --- a/applications/plugins/Sensable/OmniDriver.cpp +++ b/applications/plugins/Sensable/OmniDriver.cpp @@ -338,7 +338,7 @@ int OmniDriver::initDevice(OmniData& data) OmniDriver::OmniDriver() : scale(initData(&scale, 1.0, "scale","Default scale applied to the Phantom Coordinates. ")) - , forceScale(initData(&forceScale, 1.0, "forceScale","Default forceScale applied to the force feedback. ")) + , forceScale(initData(&forceScale, 1.0, "forceScale","Default scaling factor applied to the force feedback")) , positionBase(initData(&positionBase, Vec3d(0,0,0), "positionBase","Position of the interface base in the scene world coordinates")) , orientationBase(initData(&orientationBase, Quat(0,0,0,1), "orientationBase","Orientation of the interface base in the scene world coordinates")) , positionTool(initData(&positionTool, Vec3d(0,0,0), "positionTool","Position of the tool in the omni end effector frame")) diff --git a/applications/plugins/Sensable/OmniDriver.h b/applications/plugins/Sensable/OmniDriver.h index 9037f1451c4..d737eeb07a3 100644 --- a/applications/plugins/Sensable/OmniDriver.h +++ b/applications/plugins/Sensable/OmniDriver.h @@ -96,7 +96,7 @@ class OmniDriver : public Controller public: SOFA_CLASS(OmniDriver, Controller); Data scale; ///< Default scale applied to the Phantom Coordinates. - Data forceScale; ///< Default forceScale applied to the force feedback. + Data forceScale; ///< Default scaling factor applied to the force feedback Data positionBase; ///< Position of the interface base in the scene world coordinates Data orientationBase; ///< Orientation of the interface base in the scene world coordinates Data positionTool; ///< Position of the tool in the omni end effector frame diff --git a/applications/plugins/SensableEmulation/NewOmniDriverEmu.cpp b/applications/plugins/SensableEmulation/NewOmniDriverEmu.cpp index 8bac9d6999a..95c5d1065b5 100644 --- a/applications/plugins/SensableEmulation/NewOmniDriverEmu.cpp +++ b/applications/plugins/SensableEmulation/NewOmniDriverEmu.cpp @@ -64,7 +64,7 @@ using namespace core::behavior; using namespace sofa::defaulttype; NewOmniDriverEmu::NewOmniDriverEmu() - : forceScale(initData(&forceScale, 1.0, "forceScale","Default forceScale applied to the force feedback. ")) + : forceScale(initData(&forceScale, 1.0, "forceScale","Default scaling factor applied to the force feedback")) , scale(initData(&scale, 1.0, "scale","Default scale applied to the Phantom Coordinates. ")) , positionBase(initData(&positionBase, Vec3d(0,0,0), "positionBase","Position of the interface base in the scene world coordinates")) , orientationBase(initData(&orientationBase, Quat(0,0,0,1), "orientationBase","Orientation of the interface base in the scene world coordinates")) diff --git a/applications/plugins/SensableEmulation/NewOmniDriverEmu.h b/applications/plugins/SensableEmulation/NewOmniDriverEmu.h index 882933a3f49..c12a68bec9d 100644 --- a/applications/plugins/SensableEmulation/NewOmniDriverEmu.h +++ b/applications/plugins/SensableEmulation/NewOmniDriverEmu.h @@ -94,7 +94,7 @@ class NewOmniDriverEmu : public Controller SOFA_CLASS(NewOmniDriverEmu, Controller); Data scale; ///< Default scale applied to the Phantom Coordinates. - Data forceScale; ///< Default forceScale applied to the force feedback. + Data forceScale; ///< Default scaling factor applied to the force feedback Data simuFreq; ///< frequency of the "simulated Omni" Data positionBase; ///< Position of the interface base in the scene world coordinates Data orientationBase; ///< Orientation of the interface base in the scene world coordinates diff --git a/applications/plugins/SensableEmulation/OmniDriverEmu.cpp b/applications/plugins/SensableEmulation/OmniDriverEmu.cpp index 8f2df25b5ad..1077d87c055 100644 --- a/applications/plugins/SensableEmulation/OmniDriverEmu.cpp +++ b/applications/plugins/SensableEmulation/OmniDriverEmu.cpp @@ -69,7 +69,7 @@ using namespace core::behavior; using type::vector; OmniDriverEmu::OmniDriverEmu() - : forceScale(initData(&forceScale, 1.0, "forceScale","Default forceScale applied to the force feedback. ")) + : forceScale(initData(&forceScale, 1.0, "forceScale","Default scaling factor applied to the force feedback")) , scale(initData(&scale, 1.0, "scale","Default scale applied to the Phantom Coordinates. ")) , positionBase(initData(&positionBase, Vec3d(0,0,0), "positionBase","Position of the interface base in the scene world coordinates")) , orientationBase(initData(&orientationBase, Quat(0,0,0,1), "orientationBase","Orientation of the interface base in the scene world coordinates")) diff --git a/applications/plugins/SensableEmulation/OmniDriverEmu.h b/applications/plugins/SensableEmulation/OmniDriverEmu.h index b45731bed0e..0590808fa47 100644 --- a/applications/plugins/SensableEmulation/OmniDriverEmu.h +++ b/applications/plugins/SensableEmulation/OmniDriverEmu.h @@ -99,8 +99,8 @@ class SOFA_SENSABLEEMUPLUGIN_API OmniDriverEmu : public Controller using Quat = sofa::type::Quat; SOFA_CLASS(OmniDriverEmu, Controller); - Data forceScale; ///< Default forceScale applied to the force feedback. - Data scale; ///< Default scale applied to the Phantom Coordinates. + Data forceScale; ///< Default scaling factor applied to the force feedback + Data scale; ///< Default scale applied to the Phantom Coordinates. Data positionBase; ///< Position of the interface base in the scene world coordinates Data orientationBase; ///< Orientation of the interface base in the scene world coordinates Data positionTool; ///< Position of the tool in the omni end effector frame diff --git a/applications/plugins/SofaCUDA/sofa/gpu/cuda/CudaHexahedronTLEDForceField.h b/applications/plugins/SofaCUDA/sofa/gpu/cuda/CudaHexahedronTLEDForceField.h index f68456cebc9..b912b1c3e17 100644 --- a/applications/plugins/SofaCUDA/sofa/gpu/cuda/CudaHexahedronTLEDForceField.h +++ b/applications/plugins/SofaCUDA/sofa/gpu/cuda/CudaHexahedronTLEDForceField.h @@ -92,10 +92,10 @@ class CudaHexahedronTLEDForceField : public core::behavior::ForceField timestep; ///< time step of the simulation - Data isViscoelastic; ///< flag = 1 to enable viscoelasticity - Data isAnisotropic; ///< flag = 1 to enable transverse isotropy - Data preferredDirection; ///< uniform preferred direction for transverse isotropy + Data timestep; ///< Simulation timestep + Data isViscoelastic; ///< Viscoelasticity flag + Data isAnisotropic; ///< Anisotropy flag + Data preferredDirection; ///< Transverse isotropy direction CudaHexahedronTLEDForceField(); virtual ~CudaHexahedronTLEDForceField(); diff --git a/applications/plugins/SofaCUDA/sofa/gpu/cuda/CudaTetrahedronTLEDForceField.h b/applications/plugins/SofaCUDA/sofa/gpu/cuda/CudaTetrahedronTLEDForceField.h index 4dc344a2e74..49046d535d2 100644 --- a/applications/plugins/SofaCUDA/sofa/gpu/cuda/CudaTetrahedronTLEDForceField.h +++ b/applications/plugins/SofaCUDA/sofa/gpu/cuda/CudaTetrahedronTLEDForceField.h @@ -96,10 +96,10 @@ class CudaTetrahedronTLEDForceField : public core::behavior::ForceField timestep; ///< time step of the simulation - Data isViscoelastic; ///< flag = 1 to enable viscoelasticity - Data isAnisotropic; ///< flag = 1 to enable transverse isotropy - Data preferredDirection; ///< uniform preferred direction for transverse isotropy + Data timestep; ///< Simulation timestep + Data isViscoelastic; ///< Viscoelasticity flag + Data isAnisotropic; ///< Anisotropy flag + Data preferredDirection; ///< Transverse isotropy direction CudaTetrahedronTLEDForceField(); virtual ~CudaTetrahedronTLEDForceField(); diff --git a/applications/plugins/SofaHAPI/SofaHAPIHapticsDevice.cpp b/applications/plugins/SofaHAPI/SofaHAPIHapticsDevice.cpp index b008ba9f7fb..edf7973e1d3 100644 --- a/applications/plugins/SofaHAPI/SofaHAPIHapticsDevice.cpp +++ b/applications/plugins/SofaHAPI/SofaHAPIHapticsDevice.cpp @@ -92,7 +92,7 @@ namespace sofa SofaHAPIHapticsDevice::SofaHAPIHapticsDevice() : scale(initData(&scale, 1.0, "scale","Default scale applied to the Phantom Coordinates. ")) - , forceScale(initData(&forceScale, 1.0, "forceScale","Default forceScale applied to the force feedback. ")) + , forceScale(initData(&forceScale, 1.0, "forceScale","Default scaling factor applied to the force feedback")) , positionBase(initData(&positionBase, Vec3d(0,0,0), "positionBase","Position of the interface base in the scene world coordinates")) , orientationBase(initData(&orientationBase, Quat(0,0,0,1), "orientationBase","Orientation of the interface base in the scene world coordinates")) , positionTool(initData(&positionTool, Vec3d(0,0,0), "positionTool","Position of the tool in the device end effector frame")) diff --git a/applications/plugins/SofaHAPI/SofaHAPIHapticsDevice.h b/applications/plugins/SofaHAPI/SofaHAPIHapticsDevice.h index b10bffb1e04..07911163b3e 100644 --- a/applications/plugins/SofaHAPI/SofaHAPIHapticsDevice.h +++ b/applications/plugins/SofaHAPI/SofaHAPIHapticsDevice.h @@ -67,7 +67,7 @@ namespace sofa public: SOFA_CLASS(SofaHAPIHapticsDevice, Controller); Data scale; ///< Default scale applied to the Phantom Coordinates. - Data forceScale; ///< Default forceScale applied to the force feedback. + Data forceScale; ///< Default scaling factor applied to the force feedback Data positionBase; ///< Position of the interface base in the scene world coordinates Data orientationBase; ///< Orientation of the interface base in the scene world coordinates Data positionTool; ///< Position of the tool in the device end effector frame diff --git a/applications/plugins/SofaImplicitField/components/geometry/BottleField.h b/applications/plugins/SofaImplicitField/components/geometry/BottleField.h index 0587fc22cfc..1f62df0c172 100644 --- a/applications/plugins/SofaImplicitField/components/geometry/BottleField.h +++ b/applications/plugins/SofaImplicitField/components/geometry/BottleField.h @@ -61,7 +61,7 @@ class SOFA_SOFAIMPLICITFIELD_API BottleField : public ScalarField using ScalarField::getGradient ; using ScalarField::getValueAndGradient ; - Data d_inside; ///< If true the field is oriented inside (resp. outside) the sphere. (default = false) + Data d_inside; ///< If true the field is oriented inside (resp. outside) the bottle-shaped object. (default = false) Data d_radiusSphere; ///< Radius of Sphere emitting the field. (default = 1) Data d_centerSphere; ///< Position of the Sphere Surface. (default=0 0 0) Data d_shift; ///< How much the top ellipsoid is shifted from the bottom sphere. (default=1) diff --git a/applications/plugins/SofaImplicitField/components/geometry/DiscreteGridField.h b/applications/plugins/SofaImplicitField/components/geometry/DiscreteGridField.h index 76a4e5ed4df..a98e897d4c3 100644 --- a/applications/plugins/SofaImplicitField/components/geometry/DiscreteGridField.h +++ b/applications/plugins/SofaImplicitField/components/geometry/DiscreteGridField.h @@ -72,9 +72,9 @@ class SOFA_SOFAIMPLICITFIELD_API DiscreteGridField : public virtual ScalarField sofa::core::objectmodel::DataFileName d_distanceMapHeader; Data< int > d_maxDomains; ///< Number of domains available for caching - Data< double > dx; ///< translation of original image - Data< double > dy; ///< translation of original image - Data< double > dz; ///< translation of original image + Data< double > dx; ///< x translation + Data< double > dy; ///< y translation + Data< double > dz; ///< z translation int m_usedDomains; // number of domains already given out unsigned int m_imgSize[3]; // number of voxels diff --git a/applications/plugins/SofaMatrix/src/SofaMatrix/ComplianceMatrixImage.h b/applications/plugins/SofaMatrix/src/SofaMatrix/ComplianceMatrixImage.h index c2c6e5d032e..16461c8a023 100644 --- a/applications/plugins/SofaMatrix/src/SofaMatrix/ComplianceMatrixImage.h +++ b/applications/plugins/SofaMatrix/src/SofaMatrix/ComplianceMatrixImage.h @@ -48,7 +48,7 @@ class SOFA_SOFAMATRIX_API ComplianceMatrixImage : public core::objectmodel::Base void init() override; void handleEvent(core::objectmodel::Event *event) override; - Data< type::BaseMatrixImageProxy > d_bitmap; ///< A proxy to visualize the produced image in the GUI through a DataWidget + Data< type::BaseMatrixImageProxy > d_bitmap; ///< Visualization of the representation of the matrix as a binary image. White pixels are zeros, black pixels are non-zeros. SingleLink l_constraintSolver; }; diff --git a/applications/plugins/SofaMatrix/src/SofaMatrix/GlobalSystemMatrixImage.h b/applications/plugins/SofaMatrix/src/SofaMatrix/GlobalSystemMatrixImage.h index 2e23028c90e..016d1fc9872 100644 --- a/applications/plugins/SofaMatrix/src/SofaMatrix/GlobalSystemMatrixImage.h +++ b/applications/plugins/SofaMatrix/src/SofaMatrix/GlobalSystemMatrixImage.h @@ -47,7 +47,7 @@ class SOFA_SOFAMATRIX_API GlobalSystemMatrixImage : public core::objectmodel::Ba void init() override; void handleEvent(core::objectmodel::Event *event) override; - Data< type::BaseMatrixImageProxy > d_bitmap; ///< A proxy to visualize the produced image in the GUI through a DataWidget + Data< type::BaseMatrixImageProxy > d_bitmap; ///< Visualization of the representation of the matrix as a binary image. White pixels are zeros, black pixels are non-zeros. SingleLink l_linearSystem; }; diff --git a/applications/plugins/image/ImageCoordValuesFromPositions.h b/applications/plugins/image/ImageCoordValuesFromPositions.h index d9510f6aa84..73042fc6c40 100644 --- a/applications/plugins/image/ImageCoordValuesFromPositions.h +++ b/applications/plugins/image/ImageCoordValuesFromPositions.h @@ -168,10 +168,10 @@ class ImageCoordValuesFromPositions : public core::DataEngine typedef helper::ReadAccessor > raPositions; Data< SeqPositions > position; ///< input positions - Data< helper::OptionsGroup > Interpolation; ///< nearest, linear, cubic + Data< helper::OptionsGroup > Interpolation; ///< Interpolation method. typedef helper::WriteOnlyAccessor > waValues; - Data< SeqPositions > values; ///< output interpolated values + Data< SeqPositions > values; ///< Interpolated values. Data< Real > outValue; ///< default value outside image Data< bool > addPosition; ///< add positions to interpolated values (to get translated positions) diff --git a/applications/plugins/image/ImageTransformEngine.h b/applications/plugins/image/ImageTransformEngine.h index 39bbcdcef22..01075d4f4af 100644 --- a/applications/plugins/image/ImageTransformEngine.h +++ b/applications/plugins/image/ImageTransformEngine.h @@ -60,9 +60,9 @@ class SOFA_IMAGE_API ImageTransformEngine : public core::DataEngine Data< TransformType > inputTransform; Data< TransformType > outputTransform; - Data translation; ///< translation - Data rotation; ///< rotation - Data scale; ///< scale + Data translation; ///< translation vector + Data rotation; ///< rotation vector + Data scale; ///< scale factor Data inverse; ///< true to apply inverse transformation ImageTransformEngine() : Inherited() diff --git a/applications/plugins/image/ImageValuesFromPositions.h b/applications/plugins/image/ImageValuesFromPositions.h index 5cd70cab3d4..3f20f81d1bb 100644 --- a/applications/plugins/image/ImageValuesFromPositions.h +++ b/applications/plugins/image/ImageValuesFromPositions.h @@ -146,11 +146,11 @@ class ImageValuesFromPositions : public core::DataEngine typedef helper::ReadAccessor > raPositions; Data< SeqPositions > position; ///< input positions - Data< helper::OptionsGroup > Interpolation; ///< nearest, linear, cubic + Data< helper::OptionsGroup > Interpolation; ///< Interpolation method. typedef type::vector valuesType; typedef helper::WriteOnlyAccessor > waValues; - Data< valuesType > values; ///< output interpolated values + Data< valuesType > values; ///< Interpolated values. Data< Real > outValue; ///< default value outside image ImageValuesFromPositions() : Inherited() diff --git a/applications/plugins/image/ImageViewer.h b/applications/plugins/image/ImageViewer.h index 4e373a20a82..36149a2f05c 100644 --- a/applications/plugins/image/ImageViewer.h +++ b/applications/plugins/image/ImageViewer.h @@ -139,7 +139,7 @@ class SOFA_IMAGE_API ImageViewer : public sofa::core::objectmodel::BaseObject /**@}*/ Data scroll; ///< 0 if no scrolling, 1 for up, 2 for down, 3 left, and 4 for right - Data display; ///< Boolean to activate/desactivate the display of the image + Data display; ///< true if image is displayed, false otherwise typedef sofa::component::visual::VisualModelImpl VisuModelType; diff --git a/applications/plugins/image/MeshToImageEngine.h b/applications/plugins/image/MeshToImageEngine.h index acac30fd363..e5ff3738f50 100644 --- a/applications/plugins/image/MeshToImageEngine.h +++ b/applications/plugins/image/MeshToImageEngine.h @@ -66,7 +66,7 @@ class MeshToImageEngine : public core::DataEngine typedef SReal Real; - Data< type::vector > voxelSize; ///< should be a Vec<3,Real>, but it is easier to be backward-compatible that way + Data< type::vector > voxelSize; ///< voxel Size (redondant with and not priority over nbVoxels) typedef helper::WriteOnlyAccessor > > waVecReal; Data< type::Vec<3,unsigned> > nbVoxels; ///< number of voxel (redondant with and priority over voxelSize) Data< bool > rotateImage; ///< orient the image bounding box according to the mesh (OBB) diff --git a/applications/plugins/image/image_test/TestImageEngine.h b/applications/plugins/image/image_test/TestImageEngine.h index 656f4f34890..49dff4822b9 100644 --- a/applications/plugins/image/image_test/TestImageEngine.h +++ b/applications/plugins/image/image_test/TestImageEngine.h @@ -61,7 +61,7 @@ class TestImageEngine : public core::DataEngine typedef helper::WriteOnlyAccessor > waImage; typedef helper::ReadAccessor > raImage; - Data< ImageTypes > inputImage; ///< input image + Data< ImageTypes > inputImage; ///< input image Data< ImageTypes > outputImage; ///< ouput image TestImageEngine() : Inherited() diff --git a/scripts/doxygenDataComments.sh b/scripts/doxygenDataComments.sh old mode 100644 new mode 100755