Blender V5.3
GEO_xpbd_constraint_friction_face.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2026 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
8
9namespace blender::xpbd {
10
12 : public TemplatedVelocityConstraintSet<FrictionFaceConstraintSet> {
13 private:
14 int geo_i_;
15 /* Constraint index for each point. */
16 Span<int> points_;
17 Span<float3> separating_axes_;
18 Span<float3> contact_velocities_;
19 /* Constraint multiplier lambda for the normal displacement divided by time step. */
20 Span<float> dynamic_friction_terms_;
21 Span<float> lambdas_normal_;
22 MutableSpan<float> lambdas_;
23
24 public:
25 static constexpr StringRefNull debug_name = "Friction";
26
28 const Span<int> points,
29 const Span<float3> separating_axes,
30 const Span<float3> contact_velocities,
31 const Span<float> dynamic_friction_terms,
32 const Span<float> lambdas_normal,
33 MutableSpan<float> lambdas)
35 geo_i_(geo_i),
36 points_(points),
37 separating_axes_(separating_axes),
38 contact_velocities_(contact_velocities),
39 dynamic_friction_terms_(dynamic_friction_terms),
40 lambdas_normal_(lambdas_normal),
41 lambdas_(lambdas)
42 {
43 }
44
45 void reset_force(const int constraint_i) const
46 {
47 lambdas_[constraint_i] = 0.0f;
48 }
49
50 template<typename UpdaterT>
52 UpdaterT &updater,
53 const int constraint_i) const
54 {
55 const int point_i = points_[constraint_i];
56 const float inv_m = params.inv_mass(geo_i_, point_i);
57 /* Should be inactive if weight is zero. */
58 BLI_assert(inv_m > 0.0f);
59
60 const float dynamic_friction = dynamic_friction_terms_[constraint_i] *
62 const float lambda_normal = lambdas_normal_[constraint_i];
63 const float3 &axis = separating_axes_[constraint_i];
64 const float3 &contact_velocity = contact_velocities_[constraint_i];
65 const float3 &velocity = params.velocity(geo_i_, point_i) - contact_velocity;
66 const float3 velocity_tangent = velocity - math::dot(velocity, axis) * axis;
67 float residual;
68 const float3 gradient = math::normalize_and_get_length(velocity_tangent, residual);
69 /* Note: lambda_normal already includes the 1/inv_m weighting factor. */
70 const float delta_lambda = std::min(dynamic_friction * lambda_normal, residual / inv_m);
71
72 lambdas_[constraint_i] += delta_lambda;
73 updater.update_velocity(geo_i_, point_i, -gradient * inv_m * delta_lambda);
74 }
75};
76
77} // namespace blender::xpbd
const float3 & velocity(int geo_i, int point_i) const
float inv_mass(int geo_i, int point_i) const
void solve_single(const ConstraintSetParams &params, UpdaterT &updater, const int constraint_i) const
FrictionFaceConstraintSet(const int geo_i, const Span< int > points, const Span< float3 > separating_axes, const Span< float3 > contact_velocities, const Span< float > dynamic_friction_terms, const Span< float > lambdas_normal, MutableSpan< float > lambdas)
TemplatedVelocityConstraintSet(int constraints_num, Vector< int > affected_geo_indices)
QuaternionBase< T > normalize_and_get_length(const QuaternionBase< T > &q, T &out_length)
T dot(const QuaternionBase< T > &a, const QuaternionBase< T > &b)
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
VecBase< float, 3 > float3