fd91df9c7693b888eddde7c85ec36ef5a0500106
[blender.git] / source / blender / physics / intern / implicit_eigen.cpp
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) Blender Foundation
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Lukas Toenne
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/physics/intern/implicit_eigen.cpp
29  *  \ingroup bph
30  */
31
32 #include "implicit.h"
33
34 #ifdef IMPLICIT_SOLVER_EIGEN
35
36 //#define USE_EIGEN_CORE
37 #define USE_EIGEN_CONSTRAINED_CG
38
39 #ifdef __GNUC__
40 #  pragma GCC diagnostic push
41 /* XXX suppress verbose warnings in eigen */
42 //#  pragma GCC diagnostic ignored "-Wlogical-op"
43 #endif
44
45 #ifndef IMPLICIT_ENABLE_EIGEN_DEBUG
46 #ifdef NDEBUG
47 #define IMPLICIT_NDEBUG
48 #endif
49 #define NDEBUG
50 #endif
51
52 #include <Eigen/Sparse>
53 #include <Eigen/src/Core/util/DisableStupidWarnings.h>
54
55 #ifdef USE_EIGEN_CONSTRAINED_CG
56 #include <intern/ConstrainedConjugateGradient.h>
57 #endif
58
59 #ifndef IMPLICIT_ENABLE_EIGEN_DEBUG
60 #ifndef IMPLICIT_NDEBUG
61 #undef NDEBUG
62 #else
63 #undef IMPLICIT_NDEBUG
64 #endif
65 #endif
66
67 #ifdef __GNUC__
68 #  pragma GCC diagnostic pop
69 #endif
70
71 #include "MEM_guardedalloc.h"
72
73 extern "C" {
74 #include "DNA_scene_types.h"
75 #include "DNA_object_types.h"
76 #include "DNA_object_force_types.h"
77 #include "DNA_meshdata_types.h"
78 #include "DNA_texture_types.h"
79
80 #include "BLI_math.h"
81 #include "BLI_linklist.h"
82 #include "BLI_utildefines.h"
83
84 #include "BKE_cloth.h"
85 #include "BKE_collision.h"
86 #include "BKE_effect.h"
87 #include "BKE_global.h"
88
89 #include "BPH_mass_spring.h"
90 }
91
92 typedef float Scalar;
93
94 static float I[3][3] = {{1, 0, 0}, {0, 1, 0}, {0, 0, 1}};
95
96 /* slightly extended Eigen vector class
97  * with conversion to/from plain C float array
98  */
99 class fVector : public Eigen::Vector3f {
100 public:
101         typedef float *ctype;
102
103         fVector()
104         {
105         }
106
107         fVector(const ctype &v)
108         {
109                 for (int k = 0; k < 3; ++k)
110                         coeffRef(k) = v[k];
111         }
112
113         fVector& operator = (const ctype &v)
114         {
115                 for (int k = 0; k < 3; ++k)
116                         coeffRef(k) = v[k];
117                 return *this;
118         }
119
120         operator ctype()
121         {
122                 return data();
123         }
124 };
125
126 /* slightly extended Eigen matrix class
127  * with conversion to/from plain C float array
128  */
129 class fMatrix : public Eigen::Matrix3f {
130 public:
131         typedef float (*ctype)[3];
132
133         fMatrix()
134         {
135         }
136
137         fMatrix(const ctype &v)
138         {
139                 for (int k = 0; k < 3; ++k)
140                         for (int l = 0; l < 3; ++l)
141                                 coeffRef(l, k) = v[k][l];
142         }
143
144         fMatrix& operator = (const ctype &v)
145         {
146                 for (int k = 0; k < 3; ++k)
147                         for (int l = 0; l < 3; ++l)
148                                 coeffRef(l, k) = v[k][l];
149                 return *this;
150         }
151
152         operator ctype()
153         {
154                 return (ctype)data();
155         }
156 };
157
158 /* Extension of dense Eigen vectors,
159  * providing 3-float block access for blenlib math functions
160  */
161 class lVector : public Eigen::VectorXf {
162 public:
163         typedef Eigen::VectorXf base_t;
164
165         lVector()
166         {
167         }
168
169         template <typename T>
170         lVector& operator = (T rhs)
171         {
172                 base_t::operator=(rhs);
173                 return *this;
174         }
175
176         float* v3(int vertex)
177         {
178                 return &coeffRef(3 * vertex);
179         }
180
181         const float* v3(int vertex) const
182         {
183                 return &coeffRef(3 * vertex);
184         }
185 };
186
187 typedef Eigen::Triplet<Scalar> Triplet;
188 typedef std::vector<Triplet> TripletList;
189
190 typedef Eigen::SparseMatrix<Scalar> lMatrix;
191
192 /* Constructor type that provides more convenient handling of Eigen triplets
193  * for efficient construction of sparse 3x3 block matrices.
194  * This should be used for building lMatrix instead of writing to such lMatrix directly (which is very inefficient).
195  * After all elements have been defined using the set() method, the actual matrix can be filled using construct().
196  */
197 struct lMatrixCtor {
198         lMatrixCtor()
199         {
200         }
201
202         void reset()
203         {
204                 m_trips.clear();
205         }
206
207         void reserve(int numverts)
208         {
209                 /* reserve for diagonal entries */
210                 m_trips.reserve(numverts * 9);
211         }
212
213         void add(int i, int j, const fMatrix &m)
214         {
215                 i *= 3;
216                 j *= 3;
217                 for (int k = 0; k < 3; ++k)
218                         for (int l = 0; l < 3; ++l)
219                                 m_trips.push_back(Triplet(i + k, j + l, m.coeff(l, k)));
220         }
221
222         void sub(int i, int j, const fMatrix &m)
223         {
224                 i *= 3;
225                 j *= 3;
226                 for (int k = 0; k < 3; ++k)
227                         for (int l = 0; l < 3; ++l)
228                                 m_trips.push_back(Triplet(i + k, j + l, -m.coeff(l, k)));
229         }
230
231         inline void construct(lMatrix &m)
232         {
233                 m.setFromTriplets(m_trips.begin(), m_trips.end());
234                 m_trips.clear();
235         }
236
237 private:
238         TripletList m_trips;
239 };
240
241 #ifdef USE_EIGEN_CORE
242 typedef Eigen::ConjugateGradient<lMatrix, Eigen::Lower, Eigen::DiagonalPreconditioner<Scalar> > ConjugateGradient;
243 #endif
244 #ifdef USE_EIGEN_CONSTRAINED_CG
245 typedef Eigen::ConstrainedConjugateGradient<lMatrix, Eigen::Lower, lMatrix,
246                                             Eigen::DiagonalPreconditioner<Scalar> >
247         ConstraintConjGrad;
248 #endif
249 using Eigen::ComputationInfo;
250
251 static void print_lvector(const lVector &v)
252 {
253         for (int i = 0; i < v.rows(); ++i) {
254                 if (i > 0 && i % 3 == 0)
255                         printf("\n");
256
257                 printf("%f,\n", v[i]);
258         }
259 }
260
261 static void print_lmatrix(const lMatrix &m)
262 {
263         for (int j = 0; j < m.rows(); ++j) {
264                 if (j > 0 && j % 3 == 0)
265                         printf("\n");
266
267                 for (int i = 0; i < m.cols(); ++i) {
268                         if (i > 0 && i % 3 == 0)
269                                 printf("  ");
270
271                         implicit_print_matrix_elem(m.coeff(j, i));
272                 }
273                 printf("\n");
274         }
275 }
276
277 BLI_INLINE void lMatrix_reserve_elems(lMatrix &m, int num)
278 {
279         m.reserve(Eigen::VectorXi::Constant(m.cols(), num));
280 }
281
282 BLI_INLINE float *lVector_v3(lVector &v, int vertex)
283 {
284         return v.data() + 3 * vertex;
285 }
286
287 BLI_INLINE const float *lVector_v3(const lVector &v, int vertex)
288 {
289         return v.data() + 3 * vertex;
290 }
291
292 #if 0
293 BLI_INLINE void triplets_m3(TripletList &tlist, float m[3][3], int i, int j)
294 {
295         i *= 3;
296         j *= 3;
297         for (int l = 0; l < 3; ++l) {
298                 for (int k = 0; k < 3; ++k) {
299                         tlist.push_back(Triplet(i + k, j + l, m[k][l]));
300                 }
301         }
302 }
303
304 BLI_INLINE void triplets_m3fl(TripletList &tlist, float m[3][3], int i, int j, float factor)
305 {
306         i *= 3;
307         j *= 3;
308         for (int l = 0; l < 3; ++l) {
309                 for (int k = 0; k < 3; ++k) {
310                         tlist.push_back(Triplet(i + k, j + l, m[k][l] * factor));
311                 }
312         }
313 }
314
315 BLI_INLINE void lMatrix_add_triplets(lMatrix &r, const TripletList &tlist)
316 {
317         lMatrix t(r.rows(), r.cols());
318         t.setFromTriplets(tlist.begin(), tlist.end());
319         r += t;
320 }
321
322 BLI_INLINE void lMatrix_madd_triplets(lMatrix &r, const TripletList &tlist, float f)
323 {
324         lMatrix t(r.rows(), r.cols());
325         t.setFromTriplets(tlist.begin(), tlist.end());
326         r += f * t;
327 }
328
329 BLI_INLINE void lMatrix_sub_triplets(lMatrix &r, const TripletList &tlist)
330 {
331         lMatrix t(r.rows(), r.cols());
332         t.setFromTriplets(tlist.begin(), tlist.end());
333         r -= t;
334 }
335 #endif
336
337 BLI_INLINE void outerproduct(float r[3][3], const float a[3], const float b[3])
338 {
339         mul_v3_v3fl(r[0], a, b[0]);
340         mul_v3_v3fl(r[1], a, b[1]);
341         mul_v3_v3fl(r[2], a, b[2]);
342 }
343
344 BLI_INLINE void cross_m3_v3m3(float r[3][3], const float v[3], float m[3][3])
345 {
346         cross_v3_v3v3(r[0], v, m[0]);
347         cross_v3_v3v3(r[1], v, m[1]);
348         cross_v3_v3v3(r[2], v, m[2]);
349 }
350
351 BLI_INLINE void cross_v3_identity(float r[3][3], const float v[3])
352 {
353         r[0][0] = 0.0f;         r[1][0] = v[2];         r[2][0] = -v[1];
354         r[0][1] = -v[2];        r[1][1] = 0.0f;         r[2][1] = v[0];
355         r[0][2] = v[1];         r[1][2] = -v[0];        r[2][2] = 0.0f;
356 }
357
358 BLI_INLINE void madd_m3_m3fl(float r[3][3], float m[3][3], float f)
359 {
360         r[0][0] += m[0][0] * f;
361         r[0][1] += m[0][1] * f;
362         r[0][2] += m[0][2] * f;
363         r[1][0] += m[1][0] * f;
364         r[1][1] += m[1][1] * f;
365         r[1][2] += m[1][2] * f;
366         r[2][0] += m[2][0] * f;
367         r[2][1] += m[2][1] * f;
368         r[2][2] += m[2][2] * f;
369 }
370
371 BLI_INLINE void madd_m3_m3m3fl(float r[3][3], float a[3][3], float b[3][3], float f)
372 {
373         r[0][0] = a[0][0] + b[0][0] * f;
374         r[0][1] = a[0][1] + b[0][1] * f;
375         r[0][2] = a[0][2] + b[0][2] * f;
376         r[1][0] = a[1][0] + b[1][0] * f;
377         r[1][1] = a[1][1] + b[1][1] * f;
378         r[1][2] = a[1][2] + b[1][2] * f;
379         r[2][0] = a[2][0] + b[2][0] * f;
380         r[2][1] = a[2][1] + b[2][1] * f;
381         r[2][2] = a[2][2] + b[2][2] * f;
382 }
383
384 struct Implicit_Data {
385         typedef std::vector<fMatrix> fMatrixVector;
386
387         Implicit_Data(int numverts)
388         {
389                 resize(numverts);
390         }
391
392         void resize(int numverts)
393         {
394                 this->numverts = numverts;
395                 int tot = 3 * numverts;
396
397                 M.resize(tot, tot);
398                 F.resize(tot);
399                 dFdX.resize(tot, tot);
400                 dFdV.resize(tot, tot);
401
402                 tfm.resize(numverts, I);
403
404                 X.resize(tot);
405                 Xnew.resize(tot);
406                 V.resize(tot);
407                 Vnew.resize(tot);
408
409                 A.resize(tot, tot);
410                 B.resize(tot);
411
412                 dV.resize(tot);
413                 z.resize(tot);
414                 S.resize(tot, tot);
415
416                 iM.reserve(numverts);
417                 idFdX.reserve(numverts);
418                 idFdV.reserve(numverts);
419                 iS.reserve(numverts);
420         }
421
422         int numverts;
423
424         /* inputs */
425         lMatrix M;                                      /* masses */
426         lVector F;                                      /* forces */
427         lMatrix dFdX, dFdV;                     /* force jacobians */
428
429         fMatrixVector tfm;                      /* local coordinate transform */
430
431         /* motion state data */
432         lVector X, Xnew;                        /* positions */
433         lVector V, Vnew;                        /* velocities */
434
435         /* internal solver data */
436         lVector B;                                      /* B for A*dV = B */
437         lMatrix A;                                      /* A for A*dV = B */
438
439         lVector dV;                                     /* velocity change (solution of A*dV = B) */
440         lVector z;                                      /* target velocity in constrained directions */
441         lMatrix S;                                      /* filtering matrix for constraints */
442
443         /* temporary constructors */
444         lMatrixCtor iM;                         /* masses */
445         lMatrixCtor idFdX, idFdV;       /* force jacobians */
446         lMatrixCtor iS;                         /* filtering matrix for constraints */
447 };
448
449 Implicit_Data *BPH_mass_spring_solver_create(int numverts, int numsprings)
450 {
451         Implicit_Data *id = new Implicit_Data(numverts);
452         return id;
453 }
454
455 void BPH_mass_spring_solver_free(Implicit_Data *id)
456 {
457         if (id)
458                 delete id;
459 }
460
461 int BPH_mass_spring_solver_numvert(Implicit_Data *id)
462 {
463         if (id)
464                 return id->numverts;
465         else
466                 return 0;
467 }
468
469 /* ==== Transformation from/to root reference frames ==== */
470
471 BLI_INLINE void world_to_root_v3(Implicit_Data *data, int index, float r[3], const float v[3])
472 {
473         copy_v3_v3(r, v);
474         mul_transposed_m3_v3(data->tfm[index], r);
475 }
476
477 BLI_INLINE void root_to_world_v3(Implicit_Data *data, int index, float r[3], const float v[3])
478 {
479         mul_v3_m3v3(r, data->tfm[index], v);
480 }
481
482 BLI_INLINE void world_to_root_m3(Implicit_Data *data, int index, float r[3][3], float m[3][3])
483 {
484         float trot[3][3];
485         copy_m3_m3(trot, data->tfm[index]);
486         transpose_m3(trot);
487         mul_m3_m3m3(r, trot, m);
488 }
489
490 BLI_INLINE void root_to_world_m3(Implicit_Data *data, int index, float r[3][3], float m[3][3])
491 {
492         mul_m3_m3m3(r, data->tfm[index], m);
493 }
494
495 /* ================================ */
496
497 bool BPH_mass_spring_solve_velocities(Implicit_Data *data, float dt, ImplicitSolverResult *result)
498 {
499 #ifdef USE_EIGEN_CORE
500         typedef ConjugateGradient solver_t;
501 #endif
502 #ifdef USE_EIGEN_CONSTRAINED_CG
503         typedef ConstraintConjGrad solver_t;
504 #endif
505
506         data->iM.construct(data->M);
507         data->idFdX.construct(data->dFdX);
508         data->idFdV.construct(data->dFdV);
509         data->iS.construct(data->S);
510
511         solver_t cg;
512         cg.setMaxIterations(100);
513         cg.setTolerance(0.01f);
514
515 #ifdef USE_EIGEN_CONSTRAINED_CG
516         cg.filter() = data->S;
517 #endif
518
519         data->A = data->M - dt * data->dFdV - dt*dt * data->dFdX;
520         cg.compute(data->A);
521
522         data->B = dt * data->F + dt*dt * data->dFdX * data->V;
523
524 #ifdef IMPLICIT_PRINT_SOLVER_INPUT_OUTPUT
525         printf("==== A ====\n");
526         print_lmatrix(id->A);
527         printf("==== z ====\n");
528         print_lvector(id->z);
529         printf("==== B ====\n");
530         print_lvector(id->B);
531         printf("==== S ====\n");
532         print_lmatrix(id->S);
533 #endif
534
535 #ifdef USE_EIGEN_CORE
536         data->dV = cg.solve(data->B);
537 #endif
538 #ifdef USE_EIGEN_CONSTRAINED_CG
539         data->dV = cg.solveWithGuess(data->B, data->z);
540 #endif
541
542 #ifdef IMPLICIT_PRINT_SOLVER_INPUT_OUTPUT
543         printf("==== dV ====\n");
544         print_lvector(id->dV);
545         printf("========\n");
546 #endif
547
548         data->Vnew = data->V + data->dV;
549
550         switch (cg.info()) {
551                 case Eigen::Success:        result->status = BPH_SOLVER_SUCCESS;         break;
552                 case Eigen::NoConvergence:  result->status = BPH_SOLVER_NO_CONVERGENCE;  break;
553                 case Eigen::InvalidInput:   result->status = BPH_SOLVER_INVALID_INPUT;   break;
554                 case Eigen::NumericalIssue: result->status = BPH_SOLVER_NUMERICAL_ISSUE; break;
555         }
556
557         result->iterations = cg.iterations();
558         result->error = cg.error();
559
560         return cg.info() == Eigen::Success;
561 }
562
563 bool BPH_mass_spring_solve_positions(Implicit_Data *data, float dt)
564 {
565         data->Xnew = data->X + data->Vnew * dt;
566         return true;
567 }
568
569 /* ================================ */
570
571 void BPH_mass_spring_apply_result(Implicit_Data *data)
572 {
573         data->X = data->Xnew;
574         data->V = data->Vnew;
575 }
576
577 void BPH_mass_spring_set_vertex_mass(Implicit_Data *data, int index, float mass)
578 {
579         float m[3][3];
580         copy_m3_m3(m, I);
581         mul_m3_fl(m, mass);
582         data->iM.add(index, index, m);
583 }
584
585 void BPH_mass_spring_set_rest_transform(Implicit_Data *data, int index, float tfm[3][3])
586 {
587 #ifdef CLOTH_ROOT_FRAME
588         copy_m3_m3(data->tfm[index], tfm);
589 #else
590         unit_m3(data->tfm[index]);
591         (void)tfm;
592 #endif
593 }
594
595 void BPH_mass_spring_set_motion_state(Implicit_Data *data, int index, const float x[3], const float v[3])
596 {
597         world_to_root_v3(data, index, data->X.v3(index), x);
598         world_to_root_v3(data, index, data->V.v3(index), v);
599 }
600
601 void BPH_mass_spring_set_position(Implicit_Data *data, int index, const float x[3])
602 {
603         world_to_root_v3(data, index, data->X.v3(index), x);
604 }
605
606 void BPH_mass_spring_set_velocity(Implicit_Data *data, int index, const float v[3])
607 {
608         world_to_root_v3(data, index, data->V.v3(index), v);
609 }
610
611 void BPH_mass_spring_get_motion_state(struct Implicit_Data *data, int index, float x[3], float v[3])
612 {
613         if (x) root_to_world_v3(data, index, x, data->X.v3(index));
614         if (v) root_to_world_v3(data, index, v, data->V.v3(index));
615 }
616
617 void BPH_mass_spring_get_position(struct Implicit_Data *data, int index, float x[3])
618 {
619         root_to_world_v3(data, index, x, data->X.v3(index));
620 }
621
622 void BPH_mass_spring_get_new_velocity(Implicit_Data *data, int index, float v[3])
623 {
624         root_to_world_v3(data, index, v, data->V.v3(index));
625 }
626
627 void BPH_mass_spring_set_new_velocity(Implicit_Data *data, int index, const float v[3])
628 {
629         world_to_root_v3(data, index, data->V.v3(index), v);
630 }
631
632 void BPH_mass_spring_clear_constraints(Implicit_Data *data)
633 {
634         int numverts = data->numverts;
635         for (int i = 0; i < numverts; ++i) {
636                 data->iS.add(i, i, I);
637                 zero_v3(data->z.v3(i));
638         }
639 }
640
641 void BPH_mass_spring_add_constraint_ndof0(Implicit_Data *data, int index, const float dV[3])
642 {
643         data->iS.sub(index, index, I);
644
645         world_to_root_v3(data, index, data->z.v3(index), dV);
646 }
647
648 void BPH_mass_spring_add_constraint_ndof1(Implicit_Data *data, int index, const float c1[3], const float c2[3], const float dV[3])
649 {
650         float m[3][3], p[3], q[3], u[3], cmat[3][3];
651
652         world_to_root_v3(data, index, p, c1);
653         outerproduct(cmat, p, p);
654         copy_m3_m3(m, cmat);
655
656         world_to_root_v3(data, index, q, c2);
657         outerproduct(cmat, q, q);
658         add_m3_m3m3(m, m, cmat);
659
660         /* XXX not sure but multiplication should work here */
661         data->iS.sub(index, index, m);
662 //      mul_m3_m3m3(data->S[index].m, data->S[index].m, m);
663
664         world_to_root_v3(data, index, u, dV);
665         add_v3_v3(data->z.v3(index), u);
666 }
667
668 void BPH_mass_spring_add_constraint_ndof2(Implicit_Data *data, int index, const float c1[3], const float dV[3])
669 {
670         float m[3][3], p[3], u[3], cmat[3][3];
671
672         world_to_root_v3(data, index, p, c1);
673         outerproduct(cmat, p, p);
674         copy_m3_m3(m, cmat);
675
676         data->iS.sub(index, index, m);
677 //      mul_m3_m3m3(data->S[index].m, data->S[index].m, m);
678
679         world_to_root_v3(data, index, u, dV);
680         add_v3_v3(data->z.v3(index), u);
681 }
682
683 void BPH_mass_spring_clear_forces(Implicit_Data *data)
684 {
685         data->F.setZero();
686         data->dFdX.setZero();
687         data->dFdV.setZero();
688 }
689
690 void BPH_mass_spring_force_reference_frame(Implicit_Data *data, int index, const float acceleration[3], const float omega[3], const float domega_dt[3], float mass)
691 {
692 #ifdef CLOTH_ROOT_FRAME
693         float acc[3], w[3], dwdt[3];
694         float f[3], dfdx[3][3], dfdv[3][3];
695         float euler[3], coriolis[3], centrifugal[3], rotvel[3];
696         float deuler[3][3], dcoriolis[3][3], dcentrifugal[3][3], drotvel[3][3];
697
698         world_to_root_v3(data, index, acc, acceleration);
699         world_to_root_v3(data, index, w, omega);
700         world_to_root_v3(data, index, dwdt, domega_dt);
701
702         cross_v3_v3v3(euler, dwdt, data->X.v3(index));
703         cross_v3_v3v3(coriolis, w, data->V.v3(index));
704         mul_v3_fl(coriolis, 2.0f);
705         cross_v3_v3v3(rotvel, w, data->X.v3(index));
706         cross_v3_v3v3(centrifugal, w, rotvel);
707
708         sub_v3_v3v3(f, acc, euler);
709         sub_v3_v3(f, coriolis);
710         sub_v3_v3(f, centrifugal);
711
712         mul_v3_fl(f, mass); /* F = m * a */
713
714         cross_v3_identity(deuler, dwdt);
715         cross_v3_identity(dcoriolis, w);
716         mul_m3_fl(dcoriolis, 2.0f);
717         cross_v3_identity(drotvel, w);
718         cross_m3_v3m3(dcentrifugal, w, drotvel);
719
720         add_m3_m3m3(dfdx, deuler, dcentrifugal);
721         negate_m3(dfdx);
722         mul_m3_fl(dfdx, mass);
723
724         copy_m3_m3(dfdv, dcoriolis);
725         negate_m3(dfdv);
726         mul_m3_fl(dfdv, mass);
727
728         add_v3_v3(data->F.v3(index), f);
729         data->idFdX.add(index, index, dfdx);
730         data->idFdV.add(index, index, dfdv);
731 #else
732         (void)data;
733         (void)index;
734         (void)acceleration;
735         (void)omega;
736         (void)domega_dt;
737 #endif
738 }
739
740 void BPH_mass_spring_force_gravity(Implicit_Data *data, int index, float mass, const float g[3])
741 {
742         /* force = mass * acceleration (in this case: gravity) */
743         float f[3];
744         world_to_root_v3(data, index, f, g);
745         mul_v3_fl(f, mass);
746
747         add_v3_v3(data->F.v3(index), f);
748 }
749
750 void BPH_mass_spring_force_drag(Implicit_Data *data, float drag)
751 {
752         int numverts = data->numverts;
753         for (int i = 0; i < numverts; i++) {
754                 float tmp[3][3];
755
756                 /* NB: uses root space velocity, no need to transform */
757                 madd_v3_v3fl(data->F.v3(i), data->V.v3(i), -drag);
758
759                 copy_m3_m3(tmp, I);
760                 mul_m3_fl(tmp, -drag);
761                 data->idFdV.add(i, i, tmp);
762         }
763 }
764
765 void BPH_mass_spring_force_extern(struct Implicit_Data *data, int i, const float f[3], float dfdx[3][3], float dfdv[3][3])
766 {
767         float tf[3], tdfdx[3][3], tdfdv[3][3];
768         world_to_root_v3(data, i, tf, f);
769         world_to_root_m3(data, i, tdfdx, dfdx);
770         world_to_root_m3(data, i, tdfdv, dfdv);
771
772         add_v3_v3(data->F.v3(i), tf);
773         data->idFdX.add(i, i, tdfdx);
774         data->idFdV.add(i, i, tdfdv);
775 }
776
777 static float calc_nor_area_tri(float nor[3], const float v1[3], const float v2[3], const float v3[3])
778 {
779         float n1[3], n2[3];
780
781         sub_v3_v3v3(n1, v1, v2);
782         sub_v3_v3v3(n2, v2, v3);
783
784         cross_v3_v3v3(nor, n1, n2);
785         return normalize_v3(nor);
786 }
787
788 /* XXX does not support force jacobians yet, since the effector system does not provide them either */
789 void BPH_mass_spring_force_face_wind(Implicit_Data *data, int v1, int v2, int v3, const float (*winvec)[3])
790 {
791         const float effector_scale = 0.02f;
792         float win[3], nor[3], area;
793         float factor;
794
795         // calculate face normal and area
796         area = calc_nor_area_tri(nor, data->X.v3(v1), data->X.v3(v2), data->X.v3(v3));
797         factor = effector_scale * area / 3.0f;
798
799         world_to_root_v3(data, v1, win, winvec[v1]);
800         madd_v3_v3fl(data->F.v3(v1), nor, factor * dot_v3v3(win, nor));
801
802         world_to_root_v3(data, v2, win, winvec[v2]);
803         madd_v3_v3fl(data->F.v3(v2), nor, factor * dot_v3v3(win, nor));
804
805         world_to_root_v3(data, v3, win, winvec[v3]);
806         madd_v3_v3fl(data->F.v3(v3), nor, factor * dot_v3v3(win, nor));
807 }
808
809 void BPH_mass_spring_force_edge_wind(Implicit_Data *data, int v1, int v2, const float (*winvec)[3])
810 {
811         const float effector_scale = 0.01;
812         float win[3], dir[3], nor[3], length;
813
814         sub_v3_v3v3(dir, data->X.v3(v1), data->X.v3(v2));
815         length = normalize_v3(dir);
816
817         world_to_root_v3(data, v1, win, winvec[v1]);
818         madd_v3_v3v3fl(nor, win, dir, -dot_v3v3(win, dir));
819         madd_v3_v3fl(data->F.v3(v1), nor, effector_scale * length);
820
821         world_to_root_v3(data, v2, win, winvec[v2]);
822         madd_v3_v3v3fl(nor, win, dir, -dot_v3v3(win, dir));
823         madd_v3_v3fl(data->F.v3(v2), nor, effector_scale * length);
824 }
825
826 BLI_INLINE void dfdx_spring(float to[3][3], const float dir[3], float length, float L, float k)
827 {
828         // dir is unit length direction, rest is spring's restlength, k is spring constant.
829         //return  ( (I-outerprod(dir, dir))*Min(1.0f, rest/length) - I) * -k;
830         outerproduct(to, dir, dir);
831         sub_m3_m3m3(to, I, to);
832
833         mul_m3_fl(to, (L/length));
834         sub_m3_m3m3(to, to, I);
835         mul_m3_fl(to, k);
836 }
837
838 /* unused */
839 #if 0
840 BLI_INLINE void dfdx_damp(float to[3][3], const float dir[3], float length, const float vel[3], float rest, float damping)
841 {
842         // inner spring damping   vel is the relative velocity  of the endpoints.
843         //      return (I-outerprod(dir, dir)) * (-damping * -(dot(dir, vel)/Max(length, rest)));
844         mul_fvectorT_fvector(to, dir, dir);
845         sub_fmatrix_fmatrix(to, I, to);
846         mul_fmatrix_S(to,  (-damping * -(dot_v3v3(dir, vel)/MAX2(length, rest))));
847 }
848 #endif
849
850 BLI_INLINE void dfdv_damp(float to[3][3], const float dir[3], float damping)
851 {
852         // derivative of force wrt velocity
853         outerproduct(to, dir, dir);
854         mul_m3_fl(to, -damping);
855 }
856
857 BLI_INLINE float fb(float length, float L)
858 {
859         float x = length / L;
860         return (-11.541f * powf(x, 4) + 34.193f * powf(x, 3) - 39.083f * powf(x, 2) + 23.116f * x - 9.713f);
861 }
862
863 BLI_INLINE float fbderiv(float length, float L)
864 {
865         float x = length/L;
866
867         return (-46.164f * powf(x, 3) + 102.579f * powf(x, 2) - 78.166f * x + 23.116f);
868 }
869
870 BLI_INLINE float fbstar(float length, float L, float kb, float cb)
871 {
872         float tempfb_fl = kb * fb(length, L);
873         float fbstar_fl = cb * (length - L);
874
875         if (tempfb_fl < fbstar_fl)
876                 return fbstar_fl;
877         else
878                 return tempfb_fl;
879 }
880
881 // function to calculae bending spring force (taken from Choi & Co)
882 BLI_INLINE float fbstar_jacobi(float length, float L, float kb, float cb)
883 {
884         float tempfb_fl = kb * fb(length, L);
885         float fbstar_fl = cb * (length - L);
886
887         if (tempfb_fl < fbstar_fl) {
888                 return -cb;
889         }
890         else {
891                 return -kb * fbderiv(length, L);
892         }
893 }
894
895 /* calculate elonglation */
896 BLI_INLINE bool spring_length(Implicit_Data *data, int i, int j, float r_extent[3], float r_dir[3], float *r_length, float r_vel[3])
897 {
898         sub_v3_v3v3(r_extent, data->X.v3(j), data->X.v3(i));
899         sub_v3_v3v3(r_vel, data->V.v3(j), data->V.v3(i));
900         *r_length = len_v3(r_extent);
901
902         if (*r_length > ALMOST_ZERO) {
903 #if 0
904                 if (length > L) {
905                         if ((clmd->sim_parms->flags & CSIMSETT_FLAG_TEARING_ENABLED) &&
906                             ( ((length-L)*100.0f/L) > clmd->sim_parms->maxspringlen ))
907                         {
908                                 // cut spring!
909                                 s->flags |= CSPRING_FLAG_DEACTIVATE;
910                                 return false;
911                         }
912                 }
913 #endif
914                 mul_v3_v3fl(r_dir, r_extent, 1.0f/(*r_length));
915         }
916         else {
917                 zero_v3(r_dir);
918         }
919
920         return true;
921 }
922
923 BLI_INLINE void apply_spring(Implicit_Data *data, int i, int j, const float f[3], float dfdx[3][3], float dfdv[3][3])
924 {
925         add_v3_v3(data->F.v3(i), f);
926         sub_v3_v3(data->F.v3(j), f);
927
928         data->idFdX.add(i, i, dfdx);
929         data->idFdX.add(j, j, dfdx);
930         data->idFdX.sub(i, j, dfdx);
931         data->idFdX.sub(j, i, dfdx);
932
933         data->idFdV.add(i, i, dfdv);
934         data->idFdV.add(j, j, dfdv);
935         data->idFdV.sub(i, j, dfdv);
936         data->idFdV.sub(j, i, dfdv);
937 }
938
939 bool BPH_mass_spring_force_spring_linear(Implicit_Data *data, int i, int j, float restlen,
940                                          float stiffness, float damping, bool no_compress, float clamp_force,
941                                          float r_f[3], float r_dfdx[3][3], float r_dfdv[3][3])
942 {
943         float extent[3], length, dir[3], vel[3];
944
945         // calculate elonglation
946         spring_length(data, i, j, extent, dir, &length, vel);
947
948         if (length > restlen || no_compress) {
949                 float stretch_force, f[3], dfdx[3][3], dfdv[3][3];
950
951                 stretch_force = stiffness * (length - restlen);
952                 if (clamp_force > 0.0f && stretch_force > clamp_force) {
953                         stretch_force = clamp_force;
954                 }
955                 mul_v3_v3fl(f, dir, stretch_force);
956
957                 // Ascher & Boxman, p.21: Damping only during elonglation
958                 // something wrong with it...
959                 madd_v3_v3fl(f, dir, damping * dot_v3v3(vel, dir));
960
961                 dfdx_spring(dfdx, dir, length, restlen, stiffness);
962                 dfdv_damp(dfdv, dir, damping);
963
964                 apply_spring(data, i, j, f, dfdx, dfdv);
965
966                 if (r_f) copy_v3_v3(r_f, f);
967                 if (r_dfdx) copy_m3_m3(r_dfdx, dfdx);
968                 if (r_dfdv) copy_m3_m3(r_dfdv, dfdv);
969
970                 return true;
971         }
972         else {
973                 if (r_f) zero_v3(r_f);
974                 if (r_dfdx) zero_m3(r_dfdx);
975                 if (r_dfdv) zero_m3(r_dfdv);
976
977                 return false;
978         }
979 }
980
981 /* See "Stable but Responsive Cloth" (Choi, Ko 2005) */
982 bool BPH_mass_spring_force_spring_bending(Implicit_Data *data, int i, int j, float restlen,
983                                           float kb, float cb,
984                                           float r_f[3], float r_dfdx[3][3], float r_dfdv[3][3])
985 {
986         float extent[3], length, dir[3], vel[3];
987
988         // calculate elonglation
989         spring_length(data, i, j, extent, dir, &length, vel);
990
991         if (length < restlen) {
992                 float f[3], dfdx[3][3], dfdv[3][3];
993
994                 mul_v3_v3fl(f, dir, fbstar(length, restlen, kb, cb));
995
996                 outerproduct(dfdx, dir, dir);
997                 mul_m3_fl(dfdx, fbstar_jacobi(length, restlen, kb, cb));
998
999                 /* XXX damping not supported */
1000                 zero_m3(dfdv);
1001
1002                 apply_spring(data, i, j, f, dfdx, dfdv);
1003
1004                 if (r_f) copy_v3_v3(r_f, f);
1005                 if (r_dfdx) copy_m3_m3(r_dfdx, dfdx);
1006                 if (r_dfdv) copy_m3_m3(r_dfdv, dfdv);
1007
1008                 return true;
1009         }
1010         else {
1011                 if (r_f) zero_v3(r_f);
1012                 if (r_dfdx) zero_m3(r_dfdx);
1013                 if (r_dfdv) zero_m3(r_dfdv);
1014
1015                 return false;
1016         }
1017 }
1018
1019 /* Jacobian of a direction vector.
1020  * Basically the part of the differential orthogonal to the direction,
1021  * inversely proportional to the length of the edge.
1022  *
1023  * dD_ij/dx_i = -dD_ij/dx_j = (D_ij * D_ij^T - I) / len_ij
1024  */
1025 BLI_INLINE void spring_grad_dir(Implicit_Data *data, int i, int j, float edge[3], float dir[3], float grad_dir[3][3])
1026 {
1027         float length;
1028
1029         sub_v3_v3v3(edge, data->X.v3(j), data->X.v3(i));
1030         length = normalize_v3_v3(dir, edge);
1031
1032         if (length > ALMOST_ZERO) {
1033                 outerproduct(grad_dir, dir, dir);
1034                 sub_m3_m3m3(grad_dir, I, grad_dir);
1035                 mul_m3_fl(grad_dir, 1.0f / length);
1036         }
1037         else {
1038                 zero_m3(grad_dir);
1039         }
1040 }
1041
1042 BLI_INLINE void spring_angbend_forces(Implicit_Data *data, int i, int j, int k,
1043                                       const float goal[3],
1044                                       float stiffness, float damping,
1045                                       int q, const float dx[3], const float dv[3],
1046                                       float r_f[3])
1047 {
1048         float edge_ij[3], dir_ij[3];
1049         float edge_jk[3], dir_jk[3];
1050         float vel_ij[3], vel_jk[3], vel_ortho[3];
1051         float f_bend[3], f_damp[3];
1052         float fk[3];
1053         float dist[3];
1054
1055         zero_v3(fk);
1056
1057         sub_v3_v3v3(edge_ij, data->X.v3(j), data->X.v3(i));
1058         if (q == i) sub_v3_v3(edge_ij, dx);
1059         if (q == j) add_v3_v3(edge_ij, dx);
1060         normalize_v3_v3(dir_ij, edge_ij);
1061
1062         sub_v3_v3v3(edge_jk, data->X.v3(k), data->X.v3(j));
1063         if (q == j) sub_v3_v3(edge_jk, dx);
1064         if (q == k) add_v3_v3(edge_jk, dx);
1065         normalize_v3_v3(dir_jk, edge_jk);
1066
1067         sub_v3_v3v3(vel_ij, data->V.v3(j), data->V.v3(i));
1068         if (q == i) sub_v3_v3(vel_ij, dv);
1069         if (q == j) add_v3_v3(vel_ij, dv);
1070
1071         sub_v3_v3v3(vel_jk, data->V.v3(k), data->V.v3(j));
1072         if (q == j) sub_v3_v3(vel_jk, dv);
1073         if (q == k) add_v3_v3(vel_jk, dv);
1074
1075         /* bending force */
1076         sub_v3_v3v3(dist, goal, edge_jk);
1077         mul_v3_v3fl(f_bend, dist, stiffness);
1078
1079         add_v3_v3(fk, f_bend);
1080
1081         /* damping force */
1082         madd_v3_v3v3fl(vel_ortho, vel_jk, dir_jk, -dot_v3v3(vel_jk, dir_jk));
1083         mul_v3_v3fl(f_damp, vel_ortho, damping);
1084
1085         sub_v3_v3(fk, f_damp);
1086
1087         copy_v3_v3(r_f, fk);
1088 }
1089
1090 /* Finite Differences method for estimating the jacobian of the force */
1091 BLI_INLINE void spring_angbend_estimate_dfdx(Implicit_Data *data, int i, int j, int k,
1092                                              const float goal[3],
1093                                              float stiffness, float damping,
1094                                              int q, float dfdx[3][3])
1095 {
1096         const float delta = 0.00001f; // TODO find a good heuristic for this
1097         float dvec_null[3][3], dvec_pos[3][3], dvec_neg[3][3];
1098         float f[3];
1099         int a, b;
1100
1101         zero_m3(dvec_null);
1102         unit_m3(dvec_pos);
1103         mul_m3_fl(dvec_pos, delta * 0.5f);
1104         copy_m3_m3(dvec_neg, dvec_pos);
1105         negate_m3(dvec_neg);
1106
1107         /* XXX TODO offset targets to account for position dependency */
1108
1109         for (a = 0; a < 3; ++a) {
1110                 spring_angbend_forces(data, i, j, k, goal, stiffness, damping,
1111                                       q, dvec_pos[a], dvec_null[a], f);
1112                 copy_v3_v3(dfdx[a], f);
1113
1114                 spring_angbend_forces(data, i, j, k, goal, stiffness, damping,
1115                                       q, dvec_neg[a], dvec_null[a], f);
1116                 sub_v3_v3(dfdx[a], f);
1117
1118                 for (b = 0; b < 3; ++b) {
1119                         dfdx[a][b] /= delta;
1120                 }
1121         }
1122 }
1123
1124 /* Finite Differences method for estimating the jacobian of the force */
1125 BLI_INLINE void spring_angbend_estimate_dfdv(Implicit_Data *data, int i, int j, int k,
1126                                              const float goal[3],
1127                                              float stiffness, float damping,
1128                                              int q, float dfdv[3][3])
1129 {
1130         const float delta = 0.00001f; // TODO find a good heuristic for this
1131         float dvec_null[3][3], dvec_pos[3][3], dvec_neg[3][3];
1132         float f[3];
1133         int a, b;
1134
1135         zero_m3(dvec_null);
1136         unit_m3(dvec_pos);
1137         mul_m3_fl(dvec_pos, delta * 0.5f);
1138         copy_m3_m3(dvec_neg, dvec_pos);
1139         negate_m3(dvec_neg);
1140
1141         /* XXX TODO offset targets to account for position dependency */
1142
1143         for (a = 0; a < 3; ++a) {
1144                 spring_angbend_forces(data, i, j, k, goal, stiffness, damping,
1145                                       q, dvec_null[a], dvec_pos[a], f);
1146                 copy_v3_v3(dfdv[a], f);
1147
1148                 spring_angbend_forces(data, i, j, k, goal, stiffness, damping,
1149                                       q, dvec_null[a], dvec_neg[a], f);
1150                 sub_v3_v3(dfdv[a], f);
1151
1152                 for (b = 0; b < 3; ++b) {
1153                         dfdv[a][b] /= delta;
1154                 }
1155         }
1156 }
1157
1158 /* Angular spring that pulls the vertex toward the local target
1159  * See "Artistic Simulation of Curly Hair" (Pixar technical memo #12-03a)
1160  */
1161 bool BPH_mass_spring_force_spring_bending_angular(Implicit_Data *data, int i, int j, int k,
1162                                                   const float target[3], float stiffness, float damping)
1163 {
1164         float goal[3];
1165         float fj[3], fk[3];
1166         float dfj_dxi[3][3], dfj_dxj[3][3], dfk_dxi[3][3], dfk_dxj[3][3], dfk_dxk[3][3];
1167         float dfj_dvi[3][3], dfj_dvj[3][3], dfk_dvi[3][3], dfk_dvj[3][3], dfk_dvk[3][3];
1168
1169         const float vecnull[3] = {0.0f, 0.0f, 0.0f};
1170
1171         world_to_root_v3(data, j, goal, target);
1172
1173         spring_angbend_forces(data, i, j, k, goal, stiffness, damping, k, vecnull, vecnull, fk);
1174         negate_v3_v3(fj, fk); /* counterforce */
1175
1176         spring_angbend_estimate_dfdx(data, i, j, k, goal, stiffness, damping, i, dfk_dxi);
1177         spring_angbend_estimate_dfdx(data, i, j, k, goal, stiffness, damping, j, dfk_dxj);
1178         spring_angbend_estimate_dfdx(data, i, j, k, goal, stiffness, damping, k, dfk_dxk);
1179         copy_m3_m3(dfj_dxi, dfk_dxi); negate_m3(dfj_dxi);
1180         copy_m3_m3(dfj_dxj, dfk_dxj); negate_m3(dfj_dxj);
1181
1182         spring_angbend_estimate_dfdv(data, i, j, k, goal, stiffness, damping, i, dfk_dvi);
1183         spring_angbend_estimate_dfdv(data, i, j, k, goal, stiffness, damping, j, dfk_dvj);
1184         spring_angbend_estimate_dfdv(data, i, j, k, goal, stiffness, damping, k, dfk_dvk);
1185         copy_m3_m3(dfj_dvi, dfk_dvi); negate_m3(dfj_dvi);
1186         copy_m3_m3(dfj_dvj, dfk_dvj); negate_m3(dfj_dvj);
1187
1188         /* add forces and jacobians to the solver data */
1189
1190         add_v3_v3(data->F.v3(j), fj);
1191         add_v3_v3(data->F.v3(k), fk);
1192
1193         data->idFdX.add(j, j, dfj_dxj);
1194         data->idFdX.add(k, k, dfk_dxk);
1195
1196         data->idFdX.add(i, j, dfj_dxi);
1197         data->idFdX.add(j, i, dfj_dxi);
1198         data->idFdX.add(j, k, dfk_dxj);
1199         data->idFdX.add(k, j, dfk_dxj);
1200         data->idFdX.add(i, k, dfk_dxi);
1201         data->idFdX.add(k, i, dfk_dxi);
1202
1203         data->idFdV.add(j, j, dfj_dvj);
1204         data->idFdV.add(k, k, dfk_dvk);
1205
1206         data->idFdV.add(i, j, dfj_dvi);
1207         data->idFdV.add(j, i, dfj_dvi);
1208         data->idFdV.add(j, k, dfk_dvj);
1209         data->idFdV.add(k, j, dfk_dvj);
1210         data->idFdV.add(i, k, dfk_dvi);
1211         data->idFdV.add(k, i, dfk_dvi);
1212
1213         /* XXX analytical calculation of derivatives below is incorrect.
1214          * This proved to be difficult, but for now just using the finite difference method for
1215          * estimating the jacobians should be sufficient.
1216          */
1217 #if 0
1218         float edge_ij[3], dir_ij[3], grad_dir_ij[3][3];
1219         float edge_jk[3], dir_jk[3], grad_dir_jk[3][3];
1220         float dist[3], vel_jk[3], vel_jk_ortho[3], projvel[3];
1221         float target[3];
1222         float tmp[3][3];
1223         float fi[3], fj[3], fk[3];
1224         float dfi_dxi[3][3], dfj_dxi[3][3], dfj_dxj[3][3], dfk_dxi[3][3], dfk_dxj[3][3], dfk_dxk[3][3];
1225         float dfdvi[3][3];
1226
1227         // TESTING
1228         damping = 0.0f;
1229
1230         zero_v3(fi);
1231         zero_v3(fj);
1232         zero_v3(fk);
1233         zero_m3(dfi_dxi);
1234         zero_m3(dfj_dxi);
1235         zero_m3(dfk_dxi);
1236         zero_m3(dfk_dxj);
1237         zero_m3(dfk_dxk);
1238
1239         /* jacobian of direction vectors */
1240         spring_grad_dir(data, i, j, edge_ij, dir_ij, grad_dir_ij);
1241         spring_grad_dir(data, j, k, edge_jk, dir_jk, grad_dir_jk);
1242
1243         sub_v3_v3v3(vel_jk, data->V[k], data->V[j]);
1244
1245         /* bending force */
1246         mul_v3_v3fl(target, dir_ij, restlen);
1247         sub_v3_v3v3(dist, target, edge_jk);
1248         mul_v3_v3fl(fk, dist, stiffness);
1249
1250         /* damping force */
1251         madd_v3_v3v3fl(vel_jk_ortho, vel_jk, dir_jk, -dot_v3v3(vel_jk, dir_jk));
1252         madd_v3_v3fl(fk, vel_jk_ortho, damping);
1253
1254         /* XXX this only holds true as long as we assume straight rest shape!
1255          * eventually will become a bit more involved since the opposite segment
1256          * gets its own target, under condition of having equal torque on both sides.
1257          */
1258         copy_v3_v3(fi, fk);
1259
1260         /* counterforce on the middle point */
1261         sub_v3_v3(fj, fi);
1262         sub_v3_v3(fj, fk);
1263
1264         /* === derivatives === */
1265
1266         madd_m3_m3fl(dfk_dxi, grad_dir_ij, stiffness * restlen);
1267
1268         madd_m3_m3fl(dfk_dxj, grad_dir_ij, -stiffness * restlen);
1269         madd_m3_m3fl(dfk_dxj, I, stiffness);
1270
1271         madd_m3_m3fl(dfk_dxk, I, -stiffness);
1272
1273         copy_m3_m3(dfi_dxi, dfk_dxk);
1274         negate_m3(dfi_dxi);
1275
1276         /* dfj_dfi == dfi_dfj due to symmetry,
1277          * dfi_dfj == dfk_dfj due to fi == fk
1278          * XXX see comment above on future bent rest shapes
1279          */
1280         copy_m3_m3(dfj_dxi, dfk_dxj);
1281
1282         /* dfj_dxj == -(dfi_dxj + dfk_dxj) due to fj == -(fi + fk) */
1283         sub_m3_m3m3(dfj_dxj, dfj_dxj, dfj_dxi);
1284         sub_m3_m3m3(dfj_dxj, dfj_dxj, dfk_dxj);
1285
1286         /* add forces and jacobians to the solver data */
1287         add_v3_v3(data->F[i], fi);
1288         add_v3_v3(data->F[j], fj);
1289         add_v3_v3(data->F[k], fk);
1290
1291         add_m3_m3m3(data->dFdX[i].m, data->dFdX[i].m, dfi_dxi);
1292         add_m3_m3m3(data->dFdX[j].m, data->dFdX[j].m, dfj_dxj);
1293         add_m3_m3m3(data->dFdX[k].m, data->dFdX[k].m, dfk_dxk);
1294
1295         add_m3_m3m3(data->dFdX[block_ij].m, data->dFdX[block_ij].m, dfj_dxi);
1296         add_m3_m3m3(data->dFdX[block_jk].m, data->dFdX[block_jk].m, dfk_dxj);
1297         add_m3_m3m3(data->dFdX[block_ik].m, data->dFdX[block_ik].m, dfk_dxi);
1298 #endif
1299
1300         return true;
1301 }
1302
1303 bool BPH_mass_spring_force_spring_goal(Implicit_Data *data, int i, const float goal_x[3], const float goal_v[3],
1304                                        float stiffness, float damping,
1305                                        float r_f[3], float r_dfdx[3][3], float r_dfdv[3][3])
1306 {
1307         float root_goal_x[3], root_goal_v[3], extent[3], length, dir[3], vel[3];
1308         float f[3], dfdx[3][3], dfdv[3][3];
1309
1310         /* goal is in world space */
1311         world_to_root_v3(data, i, root_goal_x, goal_x);
1312         world_to_root_v3(data, i, root_goal_v, goal_v);
1313
1314         sub_v3_v3v3(extent, root_goal_x, data->X.v3(i));
1315         sub_v3_v3v3(vel, root_goal_v, data->V.v3(i));
1316         length = normalize_v3_v3(dir, extent);
1317
1318         if (length > ALMOST_ZERO) {
1319                 mul_v3_v3fl(f, dir, stiffness * length);
1320
1321                 // Ascher & Boxman, p.21: Damping only during elonglation
1322                 // something wrong with it...
1323                 madd_v3_v3fl(f, dir, damping * dot_v3v3(vel, dir));
1324
1325                 dfdx_spring(dfdx, dir, length, 0.0f, stiffness);
1326                 dfdv_damp(dfdv, dir, damping);
1327
1328                 add_v3_v3(data->F.v3(i), f);
1329                 data->idFdX.add(i, i, dfdx);
1330                 data->idFdV.add(i, i, dfdv);
1331
1332                 if (r_f) copy_v3_v3(r_f, f);
1333                 if (r_dfdx) copy_m3_m3(r_dfdx, dfdx);
1334                 if (r_dfdv) copy_m3_m3(r_dfdv, dfdv);
1335
1336                 return true;
1337         }
1338         else {
1339                 if (r_f) zero_v3(r_f);
1340                 if (r_dfdx) zero_m3(r_dfdx);
1341                 if (r_dfdv) zero_m3(r_dfdv);
1342
1343                 return false;
1344         }
1345 }
1346
1347 #endif /* IMPLICIT_SOLVER_EIGEN */