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

Group documentation for bias acceleration #21761

Open
mitiguy opened this issue Jul 31, 2024 · 0 comments
Open

Group documentation for bias acceleration #21761

mitiguy opened this issue Jul 31, 2024 · 0 comments
Assignees
Labels
component: multibody plant MultibodyPlant and supporting code type: documentation

Comments

@mitiguy
Copy link
Contributor

mitiguy commented Jul 31, 2024

To address issue #21711 and during review of PR #21740, a doxygen group
@name Bias acceleration functions
was added to multibody_plant.h to group the following overloaded function :

  1. CalcBiasCenterOfMassTranslationalAcceleration() -- Overload 1 of 2.
  2. CalcBiasCenterOfMassTranslationalAcceleration() -- Overload 2 of 2.

In a subsequent PR (ASAP), also group the following.

  1. CalcBiasTranslationalAcceleration()
  2. CalcBiasSpatialAcceleration()
  3. CalcBiasTerm() -- albeit this is somewhat different in spirit.

**Alternatives that were tried **
Documentation for each overload was tried separately (without an @name group) and the amount of repeated documentation was significant. The reviewer (Sherm) preferred consolidating common documentation into an @name group with a subsequent PR to group other related documentation.

Additional context
Also discussed: consider a subsequent PR to consolidate Jacobian functions in multibody_plant.h into their own @name group, e.g.,

  1. CalcJacobianSpatialVelocity().
  2. CalcJacobianAngularVelocity().
  3. CalcJacobianTranslationalVelocity().
  4. CalcJacobianPositionVector().
  5. CalcJacobianCenterOfMassTranslationalVelocity() -- Overload 1 of 2.
  6. CalcJacobianCenterOfMassTranslationalVelocity() -- Overload 2 of 2.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: multibody plant MultibodyPlant and supporting code type: documentation
Projects
None yet
Development

No branches or pull requests

2 participants