Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename components about weak, projective and Lagrangian constraints #3952

Open
hugtalbot opened this issue Jun 14, 2023 · 0 comments
Open

Rename components about weak, projective and Lagrangian constraints #3952

hugtalbot opened this issue Jun 14, 2023 · 0 comments
Labels
issue: discussion Open topic of discussion STC#17 Tasks for STC#17 coding sprint

Comments

@hugtalbot
Copy link
Contributor

As discussed in #3903, the renaming of RestShapeSpringFF was raised. The discussion widened to all SOFA constraints and we agreed on this new naming convention:

Here would be my suggested nomenclature:

  • projective constraints ➡️ XXXProjectiveConstraint even if it repeats the package name
    (e.g. FixedProjectiveConstraint)
  • weak force constraints ➡️ XXXPenalityForceField
  • Lagrange-based constraints ➡️ XXXLagrangianConstraint (to keep the current C++ class names)

e.g. A code was the purpose of the RestShapeSpringsForceField would become ShapePenalityForceField.

Any feedback is more than welcome 👥

@hugtalbot hugtalbot added the issue: discussion Open topic of discussion label Jun 14, 2023
@hugtalbot hugtalbot added the STC#16 Tasks for STC#16 coding sprint label Jun 14, 2023
@hugtalbot hugtalbot added STC#17 Tasks for STC#17 coding sprint and removed STC#16 Tasks for STC#16 coding sprint labels Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
issue: discussion Open topic of discussion STC#17 Tasks for STC#17 coding sprint
Projects
None yet
Development

No branches or pull requests

1 participant