Fix comments

Author: zfergus

python/src/collisions/tangential/tangential_collision.cpp

@@ -21,7 +21,7 @@ void define_tangential_collision(py::module_& m)
             Compute the tangent basis of the collision.
 
             Parameters:
-                positions: NormalCollision stencil's vertex positions.
+                positions: Collision stencil's vertex positions.
 
             Returns:
                 Tangent basis of the collision.
@@ -34,7 +34,7 @@ void define_tangential_collision(py::module_& m)
             Compute the Jacobian of the tangent basis of the collision.
 
             Parameters:
-                positions: NormalCollision stencil's vertex positions.
+                positions: Collision stencil's vertex positions.
 
             Returns:
                 Jacobian of the tangent basis of the collision.
@@ -47,7 +47,7 @@ void define_tangential_collision(py::module_& m)
             Compute the barycentric coordinates of the closest point.
 
             Parameters:
-                positions: NormalCollision stencil's vertex positions.
+                positions: Collision stencil's vertex positions.
 
             Returns:
                 Barycentric coordinates of the closest point.
@@ -60,7 +60,7 @@ void define_tangential_collision(py::module_& m)
             Compute the Jacobian of the barycentric coordinates of the closest point.
 
             Parameters:
-                positions: NormalCollision stencil's vertex positions.
+                positions: Collision stencil's vertex positions.
 
             Returns:
                 Jacobian of the barycentric coordinates of the closest point.
@@ -72,7 +72,7 @@ void define_tangential_collision(py::module_& m)
             Compute the relative velocity of the collision.
 
             Parameters:
-                positions: NormalCollision stencil's vertex velocities.
+                positions: Collision stencil's vertex velocities.
 
             Returns:
                 Relative velocity of the collision.
@@ -121,9 +121,10 @@ void define_tangential_collision(py::module_& m)
         .def_readwrite(
             "normal_force_magnitude",
             &TangentialCollision::normal_force_magnitude,
-            "NormalCollision force magnitude")
+            "Normal force magnitude")
         .def_readwrite(
-            "mu", &TangentialCollision::mu, "Coefficient of friction")
+            "mu", &TangentialCollision::mu,
+            "Ratio between normal and tangential forces (e.g., friction coefficient)")
         .def_readwrite("weight", &TangentialCollision::weight, "Weight")
         .def_property(
             "weight_gradient",

python/src/potentials/friction_potential.cpp

@@ -19,5 +19,5 @@ void define_friction_potential(py::module_& m)
             py::arg("eps_v"))
         .def_property(
             "eps_v", &FrictionPotential::eps_v, &FrictionPotential::set_eps_v,
-            "Get the smooth friction mollifier parameter :math:`\epsilon_v`.");
+            "The smooth friction mollifier parameter :math:`\\epsilon_{v}`.");
 }

python/src/potentials/potential.hpp

@@ -5,6 +5,10 @@
 namespace py = pybind11;
 using namespace ipc;
 
+/// @brief Define the methods of the templated generic Potential class.
+/// @tparam TCollisions Type of the collisions.
+/// @tparam PyClass The pybind11 class to define the methods on.
+/// @param potential The pybind11 class to define the methods on.
 template <typename TCollisions, typename PyClass>
 void define_potential_methods(PyClass& potential)
 {

src/ipc/collisions/tangential/tangential_collision.hpp

@@ -14,7 +14,7 @@ class TangentialCollision : virtual public CollisionStencil {
 protected:
     /// @brief Initialize the collision.
     /// @param collision NormalCollision stencil.
-    /// @param positions NormalCollision stencil's vertex positions.
+    /// @param positions Collision stencil's vertex positions.
     /// @param normal_potential Barrier potential used for normal force.
     /// @param barrier_stiffness Barrier potential stiffness.
     void init(
@@ -35,31 +35,31 @@ class TangentialCollision : virtual public CollisionStencil {
     // -- Abstract methods -----------------------------------------------------
 
     /// @brief Compute the tangent basis of the collision.
-    /// @param positions NormalCollision stencil's vertex positions.
+    /// @param positions Collision stencil's vertex positions.
     /// @return Tangent basis of the collision.
     virtual MatrixMax<double, 3, 2>
     compute_tangent_basis(const VectorMax12d& positions) const = 0;
 
     /// @brief Compute the Jacobian of the tangent basis of the collision.
-    /// @param positions NormalCollision stencil's vertex positions.
+    /// @param positions Collision stencil's vertex positions.
     /// @return Jacobian of the tangent basis of the collision.
     virtual MatrixMax<double, 36, 2>
     compute_tangent_basis_jacobian(const VectorMax12d& positions) const = 0;
 
     /// @brief Compute the barycentric coordinates of the closest point.
-    /// @param positions NormalCollision stencil's vertex positions.
+    /// @param positions Collision stencil's vertex positions.
     /// @return Barycentric coordinates of the closest point.
     virtual VectorMax2d
     compute_closest_point(const VectorMax12d& positions) const = 0;
 
     /// @brief Compute the Jacobian of the barycentric coordinates of the closest point.
-    /// @param positions NormalCollision stencil's vertex positions.
+    /// @param positions Collision stencil's vertex positions.
     /// @return Jacobian of the barycentric coordinates of the closest point.
     virtual MatrixMax<double, 2, 12>
     compute_closest_point_jacobian(const VectorMax12d& positions) const = 0;
 
     /// @brief Compute the relative velocity of the collision.
-    /// @param positions NormalCollision stencil's vertex velocities.
+    /// @param positions Collision stencil's vertex velocities.
     /// @return Relative velocity of the collision.
     virtual VectorMax3d
     relative_velocity(const VectorMax12d& velocities) const = 0;
@@ -85,10 +85,10 @@ class TangentialCollision : virtual public CollisionStencil {
         const VectorMax2d& closest_point) const = 0;
 
 public:
-    /// @brief NormalCollision force magnitude
+    /// @brief Normal force magnitude
     double normal_force_magnitude;
 
-    /// @brief Coefficient of friction
+    /// @brief Ratio between normal and tangential forces (e.g., friction coefficient)
     double mu;
 
     /// @brief Weight