Cleanup: style
[blender.git] / source / blender / physics / intern / implicit_blender.c
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): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/physics/intern/implicit_blender.c
29  *  \ingroup bph
30  */
31
32 #include "implicit.h"
33
34 #ifdef IMPLICIT_SOLVER_BLENDER
35
36 #include "MEM_guardedalloc.h"
37
38 #include "DNA_scene_types.h"
39 #include "DNA_object_types.h"
40 #include "DNA_object_force_types.h"
41 #include "DNA_meshdata_types.h"
42 #include "DNA_texture_types.h"
43
44 #include "BLI_math.h"
45 #include "BLI_linklist.h"
46 #include "BLI_utildefines.h"
47
48 #include "BKE_cloth.h"
49 #include "BKE_collision.h"
50 #include "BKE_effect.h"
51
52 #include "BPH_mass_spring.h"
53
54 #ifdef __GNUC__
55 #  pragma GCC diagnostic ignored "-Wtype-limits"
56 #endif
57
58 #ifdef _OPENMP
59 #  define CLOTH_OPENMP_LIMIT 512
60 #endif
61
62 //#define DEBUG_TIME
63
64 #ifdef DEBUG_TIME
65 #  include "PIL_time.h"
66 #endif
67
68 static float I[3][3] = {{1, 0, 0}, {0, 1, 0}, {0, 0, 1}};
69 static float ZERO[3][3] = {{0, 0, 0}, {0, 0, 0}, {0, 0, 0}};
70
71 #if 0
72 #define C99
73 #ifdef C99
74 #defineDO_INLINE inline
75 #else
76 #defineDO_INLINE static
77 #endif
78 #endif  /* if 0 */
79
80 struct Cloth;
81
82 //////////////////////////////////////////
83 /* fast vector / matrix library, enhancements are welcome :) -dg */
84 /////////////////////////////////////////
85
86 /* DEFINITIONS */
87 typedef float lfVector[3];
88 typedef struct fmatrix3x3 {
89         float m[3][3]; /* 3x3 matrix */
90         unsigned int c, r; /* column and row number */
91         /* int pinned; // is this vertex allowed to move? */
92         float n1, n2, n3; /* three normal vectors for collision constrains */
93         unsigned int vcount; /* vertex count */
94         unsigned int scount; /* spring count */
95 } fmatrix3x3;
96
97 ///////////////////////////
98 // float[3] vector
99 ///////////////////////////
100 /* simple vector code */
101 /* STATUS: verified */
102 DO_INLINE void mul_fvector_S(float to[3], float from[3], float scalar)
103 {
104         to[0] = from[0] * scalar;
105         to[1] = from[1] * scalar;
106         to[2] = from[2] * scalar;
107 }
108 /* simple v^T * v product ("outer product") */
109 /* STATUS: HAS TO BE verified (*should* work) */
110 DO_INLINE void mul_fvectorT_fvector(float to[3][3], float vectorA[3], float vectorB[3])
111 {
112         mul_fvector_S(to[0], vectorB, vectorA[0]);
113         mul_fvector_S(to[1], vectorB, vectorA[1]);
114         mul_fvector_S(to[2], vectorB, vectorA[2]);
115 }
116 /* simple v^T * v product with scalar ("outer product") */
117 /* STATUS: HAS TO BE verified (*should* work) */
118 DO_INLINE void mul_fvectorT_fvectorS(float to[3][3], float vectorA[3], float vectorB[3], float aS)
119 {
120         mul_fvectorT_fvector(to, vectorA, vectorB);
121
122         mul_fvector_S(to[0], to[0], aS);
123         mul_fvector_S(to[1], to[1], aS);
124         mul_fvector_S(to[2], to[2], aS);
125 }
126
127 #if 0
128 /* printf vector[3] on console: for debug output */
129 static void print_fvector(float m3[3])
130 {
131         printf("%f\n%f\n%f\n\n", m3[0], m3[1], m3[2]);
132 }
133
134 ///////////////////////////
135 // long float vector float (*)[3]
136 ///////////////////////////
137 /* print long vector on console: for debug output */
138 DO_INLINE void print_lfvector(float(*fLongVector)[3], unsigned int verts)
139 {
140         unsigned int i = 0;
141         for (i = 0; i < verts; i++) {
142                 print_fvector(fLongVector[i]);
143         }
144 }
145 #endif
146
147 /* create long vector */
148 DO_INLINE lfVector *create_lfvector(unsigned int verts)
149 {
150         /* TODO: check if memory allocation was successful */
151         return (lfVector *)MEM_callocN(verts * sizeof(lfVector), "cloth_implicit_alloc_vector");
152         // return (lfVector *)cloth_aligned_malloc(&MEMORY_BASE, verts * sizeof(lfVector));
153 }
154 /* delete long vector */
155 DO_INLINE void del_lfvector(float(*fLongVector)[3])
156 {
157         if (fLongVector != NULL) {
158                 MEM_freeN(fLongVector);
159                 // cloth_aligned_free(&MEMORY_BASE, fLongVector);
160         }
161 }
162 /* copy long vector */
163 DO_INLINE void cp_lfvector(float(*to)[3], float(*from)[3], unsigned int verts)
164 {
165         memcpy(to, from, verts * sizeof(lfVector));
166 }
167 /* init long vector with float[3] */
168 DO_INLINE void init_lfvector(float(*fLongVector)[3], float vector[3], unsigned int verts)
169 {
170         unsigned int i = 0;
171         for (i = 0; i < verts; i++) {
172                 copy_v3_v3(fLongVector[i], vector);
173         }
174 }
175 /* zero long vector with float[3] */
176 DO_INLINE void zero_lfvector(float(*to)[3], unsigned int verts)
177 {
178         memset(to, 0.0f, verts * sizeof(lfVector));
179 }
180 /* multiply long vector with scalar*/
181 DO_INLINE void mul_lfvectorS(float(*to)[3], float(*fLongVector)[3], float scalar, unsigned int verts)
182 {
183         unsigned int i = 0;
184
185         for (i = 0; i < verts; i++) {
186                 mul_fvector_S(to[i], fLongVector[i], scalar);
187         }
188 }
189 /* multiply long vector with scalar*/
190 /* A -= B * float */
191 DO_INLINE void submul_lfvectorS(float(*to)[3], float(*fLongVector)[3], float scalar, unsigned int verts)
192 {
193         unsigned int i = 0;
194         for (i = 0; i < verts; i++) {
195                 VECSUBMUL(to[i], fLongVector[i], scalar);
196         }
197 }
198 /* dot product for big vector */
199 DO_INLINE float dot_lfvector(float(*fLongVectorA)[3], float(*fLongVectorB)[3], unsigned int verts)
200 {
201         long i = 0;
202         float temp = 0.0;
203 // XXX brecht, disabled this for now (first schedule line was already disabled),
204 // due to non-commutative nature of floating point ops this makes the sim give
205 // different results each time you run it!
206 // schedule(guided, 2)
207 //#pragma omp parallel for reduction(+: temp) if (verts > CLOTH_OPENMP_LIMIT)
208         for (i = 0; i < (long)verts; i++) {
209                 temp += dot_v3v3(fLongVectorA[i], fLongVectorB[i]);
210         }
211         return temp;
212 }
213 /* A = B + C  --> for big vector */
214 DO_INLINE void add_lfvector_lfvector(float(*to)[3], float(*fLongVectorA)[3], float(*fLongVectorB)[3], unsigned int verts)
215 {
216         unsigned int i = 0;
217
218         for (i = 0; i < verts; i++) {
219                 VECADD(to[i], fLongVectorA[i], fLongVectorB[i]);
220         }
221
222 }
223 /* A = B + C * float --> for big vector */
224 DO_INLINE void add_lfvector_lfvectorS(float(*to)[3], float(*fLongVectorA)[3], float(*fLongVectorB)[3], float bS, unsigned int verts)
225 {
226         unsigned int i = 0;
227
228         for (i = 0; i < verts; i++) {
229                 VECADDS(to[i], fLongVectorA[i], fLongVectorB[i], bS);
230
231         }
232 }
233 /* A = B * float + C * float --> for big vector */
234 DO_INLINE void add_lfvectorS_lfvectorS(float(*to)[3], float(*fLongVectorA)[3], float aS, float(*fLongVectorB)[3], float bS, unsigned int verts)
235 {
236         unsigned int i = 0;
237
238         for (i = 0; i < verts; i++) {
239                 VECADDSS(to[i], fLongVectorA[i], aS, fLongVectorB[i], bS);
240         }
241 }
242 /* A = B - C * float --> for big vector */
243 DO_INLINE void sub_lfvector_lfvectorS(float(*to)[3], float(*fLongVectorA)[3], float(*fLongVectorB)[3], float bS, unsigned int verts)
244 {
245         unsigned int i = 0;
246         for (i = 0; i < verts; i++) {
247                 VECSUBS(to[i], fLongVectorA[i], fLongVectorB[i], bS);
248         }
249
250 }
251 /* A = B - C --> for big vector */
252 DO_INLINE void sub_lfvector_lfvector(float(*to)[3], float(*fLongVectorA)[3], float(*fLongVectorB)[3], unsigned int verts)
253 {
254         unsigned int i = 0;
255
256         for (i = 0; i < verts; i++) {
257                 sub_v3_v3v3(to[i], fLongVectorA[i], fLongVectorB[i]);
258         }
259
260 }
261 ///////////////////////////
262 // 3x3 matrix
263 ///////////////////////////
264 #if 0
265 /* printf 3x3 matrix on console: for debug output */
266 static void print_fmatrix(float m3[3][3])
267 {
268         printf("%f\t%f\t%f\n", m3[0][0], m3[0][1], m3[0][2]);
269         printf("%f\t%f\t%f\n", m3[1][0], m3[1][1], m3[1][2]);
270         printf("%f\t%f\t%f\n\n", m3[2][0], m3[2][1], m3[2][2]);
271 }
272
273 static void print_sparse_matrix(fmatrix3x3 *m)
274 {
275         if (m) {
276                 unsigned int i;
277                 for (i = 0; i < m[0].vcount + m[0].scount; i++) {
278                         printf("%d:\n", i);
279                         print_fmatrix(m[i].m);
280                 }
281         }
282 }
283 #endif
284
285 #if 0
286 static void print_lvector(lfVector *v, int numverts)
287 {
288         int i;
289         for (i = 0; i < numverts; ++i) {
290                 if (i > 0)
291                         printf("\n");
292
293                 printf("%f,\n", v[i][0]);
294                 printf("%f,\n", v[i][1]);
295                 printf("%f,\n", v[i][2]);
296         }
297 }
298 #endif
299
300 #if 0
301 static void print_bfmatrix(fmatrix3x3 *m)
302 {
303         int tot = m[0].vcount + m[0].scount;
304         int size = m[0].vcount * 3;
305         float *t = MEM_callocN(sizeof(float) * size * size, "bfmatrix");
306         int q, i, j;
307
308         for (q = 0; q < tot; ++q) {
309                 int k = 3 * m[q].r;
310                 int l = 3 * m[q].c;
311
312                 for (j = 0; j < 3; ++j) {
313                         for (i = 0; i < 3; ++i) {
314 //                              if (t[k + i + (l + j) * size] != 0.0f) {
315 //                                      printf("warning: overwriting value at %d, %d\n", m[q].r, m[q].c);
316 //                              }
317                                 if (k == l) {
318                                         t[k + i + (k + j) * size] += m[q].m[i][j];
319                                 }
320                                 else {
321                                         t[k + i + (l + j) * size] += m[q].m[i][j];
322                                         t[l + j + (k + i) * size] += m[q].m[j][i];
323                                 }
324                         }
325                 }
326         }
327
328         for (j = 0; j < size; ++j) {
329                 if (j > 0 && j % 3 == 0)
330                         printf("\n");
331
332                 for (i = 0; i < size; ++i) {
333                         if (i > 0 && i % 3 == 0)
334                                 printf("  ");
335
336                         implicit_print_matrix_elem(t[i + j * size]);
337                 }
338                 printf("\n");
339         }
340
341         MEM_freeN(t);
342 }
343 #endif
344
345 /* copy 3x3 matrix */
346 DO_INLINE void cp_fmatrix(float to[3][3], float from[3][3])
347 {
348         // memcpy(to, from, sizeof (float) * 9);
349         copy_v3_v3(to[0], from[0]);
350         copy_v3_v3(to[1], from[1]);
351         copy_v3_v3(to[2], from[2]);
352 }
353
354 /* copy 3x3 matrix */
355 DO_INLINE void initdiag_fmatrixS(float to[3][3], float aS)
356 {
357         cp_fmatrix(to, ZERO);
358
359         to[0][0] = aS;
360         to[1][1] = aS;
361         to[2][2] = aS;
362 }
363
364 #if 0
365 /* calculate determinant of 3x3 matrix */
366 DO_INLINE float det_fmatrix(float m[3][3])
367 {
368         return m[0][0] * m[1][1] * m[2][2] + m[1][0] * m[2][1] * m[0][2] + m[0][1] * m[1][2] * m[2][0] -
369                m[0][0] * m[1][2] * m[2][1] - m[0][1] * m[1][0] * m[2][2] - m[2][0] * m[1][1] * m[0][2];
370 }
371
372 DO_INLINE void inverse_fmatrix(float to[3][3], float from[3][3])
373 {
374         unsigned int i, j;
375         float d;
376
377         if ((d = det_fmatrix(from)) == 0) {
378                 printf("can't build inverse");
379                 exit(0);
380         }
381         for (i = 0; i < 3; i++) {
382                 for (j = 0; j < 3; j++) {
383                         int i1 = (i + 1) % 3;
384                         int i2 = (i + 2) % 3;
385                         int j1 = (j + 1) % 3;
386                         int j2 = (j + 2) % 3;
387                         /** Reverse indexes i&j to take transpose. */
388                         to[j][i] = (from[i1][j1] * from[i2][j2] - from[i1][j2] * from[i2][j1]) / d;
389                         /**
390                          * <pre>
391                          * if (i == j) {
392                          *     to[i][j] = 1.0f / from[i][j];
393                          * }
394                          * else {
395                          *     to[i][j] = 0;
396                          * }
397                          * </pre>
398                          */
399                 }
400         }
401
402 }
403 #endif
404
405 /* 3x3 matrix multiplied by a scalar */
406 /* STATUS: verified */
407 DO_INLINE void mul_fmatrix_S(float matrix[3][3], float scalar)
408 {
409         mul_fvector_S(matrix[0], matrix[0], scalar);
410         mul_fvector_S(matrix[1], matrix[1], scalar);
411         mul_fvector_S(matrix[2], matrix[2], scalar);
412 }
413
414 /* a vector multiplied by a 3x3 matrix */
415 /* STATUS: verified */
416 DO_INLINE void mul_fvector_fmatrix(float *to, float *from, float matrix[3][3])
417 {
418         to[0] = matrix[0][0] * from[0] + matrix[1][0] * from[1] + matrix[2][0] * from[2];
419         to[1] = matrix[0][1] * from[0] + matrix[1][1] * from[1] + matrix[2][1] * from[2];
420         to[2] = matrix[0][2] * from[0] + matrix[1][2] * from[1] + matrix[2][2] * from[2];
421 }
422
423 /* 3x3 matrix multiplied by a vector */
424 /* STATUS: verified */
425 DO_INLINE void mul_fmatrix_fvector(float *to, float matrix[3][3], float from[3])
426 {
427         to[0] = dot_v3v3(matrix[0], from);
428         to[1] = dot_v3v3(matrix[1], from);
429         to[2] = dot_v3v3(matrix[2], from);
430 }
431 /* 3x3 matrix addition with 3x3 matrix */
432 DO_INLINE void add_fmatrix_fmatrix(float to[3][3], float matrixA[3][3], float matrixB[3][3])
433 {
434         VECADD(to[0], matrixA[0], matrixB[0]);
435         VECADD(to[1], matrixA[1], matrixB[1]);
436         VECADD(to[2], matrixA[2], matrixB[2]);
437 }
438 /* A -= B*x + C*y (3x3 matrix sub-addition with 3x3 matrix) */
439 DO_INLINE void subadd_fmatrixS_fmatrixS(float to[3][3], float matrixA[3][3], float aS, float matrixB[3][3], float bS)
440 {
441         VECSUBADDSS(to[0], matrixA[0], aS, matrixB[0], bS);
442         VECSUBADDSS(to[1], matrixA[1], aS, matrixB[1], bS);
443         VECSUBADDSS(to[2], matrixA[2], aS, matrixB[2], bS);
444 }
445 /* A = B - C (3x3 matrix subtraction with 3x3 matrix) */
446 DO_INLINE void sub_fmatrix_fmatrix(float to[3][3], float matrixA[3][3], float matrixB[3][3])
447 {
448         sub_v3_v3v3(to[0], matrixA[0], matrixB[0]);
449         sub_v3_v3v3(to[1], matrixA[1], matrixB[1]);
450         sub_v3_v3v3(to[2], matrixA[2], matrixB[2]);
451 }
452 /////////////////////////////////////////////////////////////////
453 // special functions
454 /////////////////////////////////////////////////////////////////
455 /* 3x3 matrix multiplied+added by a vector */
456 /* STATUS: verified */
457 DO_INLINE void muladd_fmatrix_fvector(float to[3], float matrix[3][3], float from[3])
458 {
459         to[0] += dot_v3v3(matrix[0], from);
460         to[1] += dot_v3v3(matrix[1], from);
461         to[2] += dot_v3v3(matrix[2], from);
462 }
463
464 BLI_INLINE void outerproduct(float r[3][3], const float a[3], const float b[3])
465 {
466         mul_v3_v3fl(r[0], a, b[0]);
467         mul_v3_v3fl(r[1], a, b[1]);
468         mul_v3_v3fl(r[2], a, b[2]);
469 }
470
471 BLI_INLINE void cross_m3_v3m3(float r[3][3], const float v[3], float m[3][3])
472 {
473         cross_v3_v3v3(r[0], v, m[0]);
474         cross_v3_v3v3(r[1], v, m[1]);
475         cross_v3_v3v3(r[2], v, m[2]);
476 }
477
478 BLI_INLINE void cross_v3_identity(float r[3][3], const float v[3])
479 {
480         r[0][0] = 0.0f;     r[1][0] = v[2];     r[2][0] = -v[1];
481         r[0][1] = -v[2];    r[1][1] = 0.0f;     r[2][1] = v[0];
482         r[0][2] = v[1];     r[1][2] = -v[0];    r[2][2] = 0.0f;
483 }
484
485 BLI_INLINE void madd_m3_m3fl(float r[3][3], float m[3][3], float f)
486 {
487         r[0][0] += m[0][0] * f;
488         r[0][1] += m[0][1] * f;
489         r[0][2] += m[0][2] * f;
490         r[1][0] += m[1][0] * f;
491         r[1][1] += m[1][1] * f;
492         r[1][2] += m[1][2] * f;
493         r[2][0] += m[2][0] * f;
494         r[2][1] += m[2][1] * f;
495         r[2][2] += m[2][2] * f;
496 }
497
498 BLI_INLINE void madd_m3_m3m3fl(float r[3][3], float a[3][3], float b[3][3], float f)
499 {
500         r[0][0] = a[0][0] + b[0][0] * f;
501         r[0][1] = a[0][1] + b[0][1] * f;
502         r[0][2] = a[0][2] + b[0][2] * f;
503         r[1][0] = a[1][0] + b[1][0] * f;
504         r[1][1] = a[1][1] + b[1][1] * f;
505         r[1][2] = a[1][2] + b[1][2] * f;
506         r[2][0] = a[2][0] + b[2][0] * f;
507         r[2][1] = a[2][1] + b[2][1] * f;
508         r[2][2] = a[2][2] + b[2][2] * f;
509 }
510 /////////////////////////////////////////////////////////////////
511
512 ///////////////////////////
513 // SPARSE SYMMETRIC big matrix with 3x3 matrix entries
514 ///////////////////////////
515 /* printf a big matrix on console: for debug output */
516 #if 0
517 static void print_bfmatrix(fmatrix3x3 *m3)
518 {
519         unsigned int i = 0;
520
521         for (i = 0; i < m3[0].vcount + m3[0].scount; i++)
522         {
523                 print_fmatrix(m3[i].m);
524         }
525 }
526 #endif
527
528 BLI_INLINE void init_fmatrix(fmatrix3x3 *matrix, int r, int c)
529 {
530         matrix->r = r;
531         matrix->c = c;
532 }
533
534 /* create big matrix */
535 DO_INLINE fmatrix3x3 *create_bfmatrix(unsigned int verts, unsigned int springs)
536 {
537         // TODO: check if memory allocation was successful */
538         fmatrix3x3 *temp = (fmatrix3x3 *)MEM_callocN(sizeof(fmatrix3x3) * (verts + springs), "cloth_implicit_alloc_matrix");
539         int i;
540
541         temp[0].vcount = verts;
542         temp[0].scount = springs;
543
544         /* vertex part of the matrix is diagonal blocks */
545         for (i = 0; i < verts; ++i) {
546                 init_fmatrix(temp + i, i, i);
547         }
548
549         return temp;
550 }
551 /* delete big matrix */
552 DO_INLINE void del_bfmatrix(fmatrix3x3 *matrix)
553 {
554         if (matrix != NULL) {
555                 MEM_freeN(matrix);
556         }
557 }
558
559 /* copy big matrix */
560 DO_INLINE void cp_bfmatrix(fmatrix3x3 *to, fmatrix3x3 *from)
561 {
562         // TODO bounds checking
563         memcpy(to, from, sizeof(fmatrix3x3) * (from[0].vcount + from[0].scount));
564 }
565
566 /* init big matrix */
567 // slow in parallel
568 DO_INLINE void init_bfmatrix(fmatrix3x3 *matrix, float m3[3][3])
569 {
570         unsigned int i;
571
572         for (i = 0; i < matrix[0].vcount + matrix[0].scount; i++) {
573                 cp_fmatrix(matrix[i].m, m3);
574         }
575 }
576
577 /* init the diagonal of big matrix */
578 // slow in parallel
579 DO_INLINE void initdiag_bfmatrix(fmatrix3x3 *matrix, float m3[3][3])
580 {
581         unsigned int i, j;
582         float tmatrix[3][3] = {{0, 0, 0}, {0, 0, 0}, {0, 0, 0}};
583
584         for (i = 0; i < matrix[0].vcount; i++) {
585                 cp_fmatrix(matrix[i].m, m3);
586         }
587         for (j = matrix[0].vcount; j < matrix[0].vcount + matrix[0].scount; j++) {
588                 cp_fmatrix(matrix[j].m, tmatrix);
589         }
590 }
591
592 /* SPARSE SYMMETRIC multiply big matrix with long vector*/
593 /* STATUS: verified */
594 DO_INLINE void mul_bfmatrix_lfvector(float(*to)[3], fmatrix3x3 *from, lfVector *fLongVector)
595 {
596         unsigned int i = 0;
597         unsigned int vcount = from[0].vcount;
598         lfVector *temp = create_lfvector(vcount);
599
600         zero_lfvector(to, vcount);
601
602 #pragma omp parallel sections private(i) if (vcount > CLOTH_OPENMP_LIMIT)
603         {
604 #pragma omp section
605                 {
606                         for (i = from[0].vcount; i < from[0].vcount + from[0].scount; i++) {
607                                 muladd_fmatrix_fvector(to[from[i].c], from[i].m, fLongVector[from[i].r]);
608                         }
609                 }
610 #pragma omp section
611                 {
612                         for (i = 0; i < from[0].vcount + from[0].scount; i++) {
613                                 muladd_fmatrix_fvector(temp[from[i].r], from[i].m, fLongVector[from[i].c]);
614                         }
615                 }
616         }
617         add_lfvector_lfvector(to, to, temp, from[0].vcount);
618
619         del_lfvector(temp);
620
621
622 }
623
624 /* SPARSE SYMMETRIC sub big matrix with big matrix*/
625 /* A -= B * float + C * float --> for big matrix */
626 /* VERIFIED */
627 DO_INLINE void subadd_bfmatrixS_bfmatrixS(fmatrix3x3 *to, fmatrix3x3 *from, float aS,  fmatrix3x3 *matrix, float bS)
628 {
629         unsigned int i = 0;
630
631         /* process diagonal elements */
632         for (i = 0; i < matrix[0].vcount + matrix[0].scount; i++) {
633                 subadd_fmatrixS_fmatrixS(to[i].m, from[i].m, aS, matrix[i].m, bS);
634         }
635
636 }
637
638 ///////////////////////////////////////////////////////////////////
639 // simulator start
640 ///////////////////////////////////////////////////////////////////
641
642 typedef struct Implicit_Data {
643         /* inputs */
644         fmatrix3x3 *bigI;           /* identity (constant) */
645         fmatrix3x3 *tfm;            /* local coordinate transform */
646         fmatrix3x3 *M;              /* masses */
647         lfVector *F;                /* forces */
648         fmatrix3x3 *dFdV, *dFdX;    /* force jacobians */
649         int num_blocks;             /* number of off-diagonal blocks (springs) */
650
651         /* motion state data */
652         lfVector *X, *Xnew;         /* positions */
653         lfVector *V, *Vnew;         /* velocities */
654
655         /* internal solver data */
656         lfVector *B;                /* B for A*dV = B */
657         fmatrix3x3 *A;              /* A for A*dV = B */
658
659         lfVector *dV;               /* velocity change (solution of A*dV = B) */
660         lfVector *z;                /* target velocity in constrained directions */
661         fmatrix3x3 *S;              /* filtering matrix for constraints */
662         fmatrix3x3 *P, *Pinv;       /* pre-conditioning matrix */
663 } Implicit_Data;
664
665 Implicit_Data *BPH_mass_spring_solver_create(int numverts, int numsprings)
666 {
667         Implicit_Data *id = (Implicit_Data *)MEM_callocN(sizeof(Implicit_Data), "implicit vecmat");
668
669         /* process diagonal elements */
670         id->tfm = create_bfmatrix(numverts, 0);
671         id->A = create_bfmatrix(numverts, numsprings);
672         id->dFdV = create_bfmatrix(numverts, numsprings);
673         id->dFdX = create_bfmatrix(numverts, numsprings);
674         id->S = create_bfmatrix(numverts, 0);
675         id->Pinv = create_bfmatrix(numverts, numsprings);
676         id->P = create_bfmatrix(numverts, numsprings);
677         id->bigI = create_bfmatrix(numverts, numsprings); // TODO 0 springs
678         id->M = create_bfmatrix(numverts, numsprings);
679         id->X = create_lfvector(numverts);
680         id->Xnew = create_lfvector(numverts);
681         id->V = create_lfvector(numverts);
682         id->Vnew = create_lfvector(numverts);
683         id->F = create_lfvector(numverts);
684         id->B = create_lfvector(numverts);
685         id->dV = create_lfvector(numverts);
686         id->z = create_lfvector(numverts);
687
688         initdiag_bfmatrix(id->bigI, I);
689
690         return id;
691 }
692
693 void BPH_mass_spring_solver_free(Implicit_Data *id)
694 {
695         del_bfmatrix(id->tfm);
696         del_bfmatrix(id->A);
697         del_bfmatrix(id->dFdV);
698         del_bfmatrix(id->dFdX);
699         del_bfmatrix(id->S);
700         del_bfmatrix(id->P);
701         del_bfmatrix(id->Pinv);
702         del_bfmatrix(id->bigI);
703         del_bfmatrix(id->M);
704
705         del_lfvector(id->X);
706         del_lfvector(id->Xnew);
707         del_lfvector(id->V);
708         del_lfvector(id->Vnew);
709         del_lfvector(id->F);
710         del_lfvector(id->B);
711         del_lfvector(id->dV);
712         del_lfvector(id->z);
713
714         MEM_freeN(id);
715 }
716
717 /* ==== Transformation from/to root reference frames ==== */
718
719 BLI_INLINE void world_to_root_v3(Implicit_Data *data, int index, float r[3], const float v[3])
720 {
721         copy_v3_v3(r, v);
722         mul_transposed_m3_v3(data->tfm[index].m, r);
723 }
724
725 BLI_INLINE void root_to_world_v3(Implicit_Data *data, int index, float r[3], const float v[3])
726 {
727         mul_v3_m3v3(r, data->tfm[index].m, v);
728 }
729
730 BLI_INLINE void world_to_root_m3(Implicit_Data *data, int index, float r[3][3], float m[3][3])
731 {
732         float trot[3][3];
733         copy_m3_m3(trot, data->tfm[index].m);
734         transpose_m3(trot);
735         mul_m3_m3m3(r, trot, m);
736 }
737
738 BLI_INLINE void root_to_world_m3(Implicit_Data *data, int index, float r[3][3], float m[3][3])
739 {
740         mul_m3_m3m3(r, data->tfm[index].m, m);
741 }
742
743 /* ================================ */
744
745 DO_INLINE void filter(lfVector *V, fmatrix3x3 *S)
746 {
747         unsigned int i = 0;
748
749         for (i = 0; i < S[0].vcount; i++) {
750                 mul_m3_v3(S[i].m, V[S[i].r]);
751         }
752 }
753
754 #if 0 /* this version of the CG algorithm does not work very well with partial constraints (where S has non-zero elements) */
755 static int  cg_filtered(lfVector *ldV, fmatrix3x3 *lA, lfVector *lB, lfVector *z, fmatrix3x3 *S)
756 {
757         // Solves for unknown X in equation AX=B
758         unsigned int conjgrad_loopcount = 0, conjgrad_looplimit = 100;
759         float conjgrad_epsilon = 0.0001f /* , conjgrad_lasterror=0 */ /* UNUSED */;
760         lfVector *q, *d, *tmp, *r;
761         float s, starget, a, s_prev;
762         unsigned int numverts = lA[0].vcount;
763         q = create_lfvector(numverts);
764         d = create_lfvector(numverts);
765         tmp = create_lfvector(numverts);
766         r = create_lfvector(numverts);
767
768         // zero_lfvector(ldV, CLOTHPARTICLES);
769         filter(ldV, S);
770
771         add_lfvector_lfvector(ldV, ldV, z, numverts);
772
773         // r = B - Mul(tmp, A, X);    // just use B if X known to be zero
774         cp_lfvector(r, lB, numverts);
775         mul_bfmatrix_lfvector(tmp, lA, ldV);
776         sub_lfvector_lfvector(r, r, tmp, numverts);
777
778         filter(r, S);
779
780         cp_lfvector(d, r, numverts);
781
782         s = dot_lfvector(r, r, numverts);
783         starget = s * sqrtf(conjgrad_epsilon);
784
785         while (s > starget && conjgrad_loopcount < conjgrad_looplimit) {
786                 // Mul(q, A, d); // q = A*d;
787                 mul_bfmatrix_lfvector(q, lA, d);
788
789                 filter(q, S);
790
791                 a = s / dot_lfvector(d, q, numverts);
792
793                 // X = X + d*a;
794                 add_lfvector_lfvectorS(ldV, ldV, d, a, numverts);
795
796                 // r = r - q*a;
797                 sub_lfvector_lfvectorS(r, r, q, a, numverts);
798
799                 s_prev = s;
800                 s = dot_lfvector(r, r, numverts);
801
802                 //d = r+d*(s/s_prev);
803                 add_lfvector_lfvectorS(d, r, d, (s / s_prev), numverts);
804
805                 filter(d, S);
806
807                 conjgrad_loopcount++;
808         }
809         /* conjgrad_lasterror = s; */ /* UNUSED */
810
811         del_lfvector(q);
812         del_lfvector(d);
813         del_lfvector(tmp);
814         del_lfvector(r);
815         // printf("W/O conjgrad_loopcount: %d\n", conjgrad_loopcount);
816
817         return conjgrad_loopcount < conjgrad_looplimit;  // true means we reached desired accuracy in given time - ie stable
818 }
819 #endif
820
821 static int cg_filtered(lfVector *ldV, fmatrix3x3 *lA, lfVector *lB, lfVector *z, fmatrix3x3 *S, ImplicitSolverResult *result)
822 {
823         // Solves for unknown X in equation AX=B
824         unsigned int conjgrad_loopcount = 0, conjgrad_looplimit = 100;
825         float conjgrad_epsilon = 0.01f;
826
827         unsigned int numverts = lA[0].vcount;
828         lfVector *fB = create_lfvector(numverts);
829         lfVector *AdV = create_lfvector(numverts);
830         lfVector *r = create_lfvector(numverts);
831         lfVector *c = create_lfvector(numverts);
832         lfVector *q = create_lfvector(numverts);
833         lfVector *s = create_lfvector(numverts);
834         float bnorm2, delta_new, delta_old, delta_target, alpha;
835
836         cp_lfvector(ldV, z, numverts);
837
838         /* d0 = filter(B)^T * P * filter(B) */
839         cp_lfvector(fB, lB, numverts);
840         filter(fB, S);
841         bnorm2 = dot_lfvector(fB, fB, numverts);
842         delta_target = conjgrad_epsilon * conjgrad_epsilon * bnorm2;
843
844         /* r = filter(B - A * dV) */
845         mul_bfmatrix_lfvector(AdV, lA, ldV);
846         sub_lfvector_lfvector(r, lB, AdV, numverts);
847         filter(r, S);
848
849         /* c = filter(P^-1 * r) */
850         cp_lfvector(c, r, numverts);
851         filter(c, S);
852
853         /* delta = r^T * c */
854         delta_new = dot_lfvector(r, c, numverts);
855
856 #ifdef IMPLICIT_PRINT_SOLVER_INPUT_OUTPUT
857         printf("==== A ====\n");
858         print_bfmatrix(lA);
859         printf("==== z ====\n");
860         print_lvector(z, numverts);
861         printf("==== B ====\n");
862         print_lvector(lB, numverts);
863         printf("==== S ====\n");
864         print_bfmatrix(S);
865 #endif
866
867         while (delta_new > delta_target && conjgrad_loopcount < conjgrad_looplimit) {
868                 mul_bfmatrix_lfvector(q, lA, c);
869                 filter(q, S);
870
871                 alpha = delta_new / dot_lfvector(c, q, numverts);
872
873                 add_lfvector_lfvectorS(ldV, ldV, c, alpha, numverts);
874
875                 add_lfvector_lfvectorS(r, r, q, -alpha, numverts);
876
877                 /* s = P^-1 * r */
878                 cp_lfvector(s, r, numverts);
879                 delta_old = delta_new;
880                 delta_new = dot_lfvector(r, s, numverts);
881
882                 add_lfvector_lfvectorS(c, s, c, delta_new / delta_old, numverts);
883                 filter(c, S);
884
885                 conjgrad_loopcount++;
886         }
887
888 #ifdef IMPLICIT_PRINT_SOLVER_INPUT_OUTPUT
889         printf("==== dV ====\n");
890         print_lvector(ldV, numverts);
891         printf("========\n");
892 #endif
893
894         del_lfvector(fB);
895         del_lfvector(AdV);
896         del_lfvector(r);
897         del_lfvector(c);
898         del_lfvector(q);
899         del_lfvector(s);
900         // printf("W/O conjgrad_loopcount: %d\n", conjgrad_loopcount);
901
902         result->status = conjgrad_loopcount < conjgrad_looplimit ? BPH_SOLVER_SUCCESS : BPH_SOLVER_NO_CONVERGENCE;
903         result->iterations = conjgrad_loopcount;
904         result->error = bnorm2 > 0.0f ? sqrtf(delta_new / bnorm2) : 0.0f;
905
906         return conjgrad_loopcount < conjgrad_looplimit;  // true means we reached desired accuracy in given time - ie stable
907 }
908
909 #if 0
910 // block diagonalizer
911 DO_INLINE void BuildPPinv(fmatrix3x3 *lA, fmatrix3x3 *P, fmatrix3x3 *Pinv)
912 {
913         unsigned int i = 0;
914
915         // Take only the diagonal blocks of A
916 // #pragma omp parallel for private(i) if (lA[0].vcount > CLOTH_OPENMP_LIMIT)
917         for (i = 0; i < lA[0].vcount; i++) {
918                 // block diagonalizer
919                 cp_fmatrix(P[i].m, lA[i].m);
920                 inverse_fmatrix(Pinv[i].m, P[i].m);
921
922         }
923 }
924
925 #if 0
926 // version 1.3
927 static int cg_filtered_pre(lfVector *dv, fmatrix3x3 *lA, lfVector *lB, lfVector *z, fmatrix3x3 *S, fmatrix3x3 *P, fmatrix3x3 *Pinv)
928 {
929         unsigned int numverts = lA[0].vcount, iterations = 0, conjgrad_looplimit = 100;
930         float delta0 = 0, deltaNew = 0, deltaOld = 0, alpha = 0;
931         float conjgrad_epsilon = 0.0001; // 0.2 is dt for steps=5
932         lfVector *r = create_lfvector(numverts);
933         lfVector *p = create_lfvector(numverts);
934         lfVector *s = create_lfvector(numverts);
935         lfVector *h = create_lfvector(numverts);
936
937         BuildPPinv(lA, P, Pinv);
938
939         filter(dv, S);
940         add_lfvector_lfvector(dv, dv, z, numverts);
941
942         mul_bfmatrix_lfvector(r, lA, dv);
943         sub_lfvector_lfvector(r, lB, r, numverts);
944         filter(r, S);
945
946         mul_prevfmatrix_lfvector(p, Pinv, r);
947         filter(p, S);
948
949         deltaNew = dot_lfvector(r, p, numverts);
950
951         delta0 = deltaNew * sqrt(conjgrad_epsilon);
952
953 #ifdef DEBUG_TIME
954         double start = PIL_check_seconds_timer();
955 #endif
956
957         while ((deltaNew > delta0) && (iterations < conjgrad_looplimit))
958         {
959                 iterations++;
960
961                 mul_bfmatrix_lfvector(s, lA, p);
962                 filter(s, S);
963
964                 alpha = deltaNew / dot_lfvector(p, s, numverts);
965
966                 add_lfvector_lfvectorS(dv, dv, p, alpha, numverts);
967
968                 add_lfvector_lfvectorS(r, r, s, -alpha, numverts);
969
970                 mul_prevfmatrix_lfvector(h, Pinv, r);
971                 filter(h, S);
972
973                 deltaOld = deltaNew;
974
975                 deltaNew = dot_lfvector(r, h, numverts);
976
977                 add_lfvector_lfvectorS(p, h, p, deltaNew / deltaOld, numverts);
978
979                 filter(p, S);
980
981         }
982
983 #ifdef DEBUG_TIME
984         double end = PIL_check_seconds_timer();
985         printf("cg_filtered_pre time: %f\n", (float)(end - start));
986 #endif
987
988         del_lfvector(h);
989         del_lfvector(s);
990         del_lfvector(p);
991         del_lfvector(r);
992
993         printf("iterations: %d\n", iterations);
994
995         return iterations < conjgrad_looplimit;
996 }
997 #endif
998
999 // version 1.4
1000 static int cg_filtered_pre(lfVector *dv, fmatrix3x3 *lA, lfVector *lB, lfVector *z, fmatrix3x3 *S, fmatrix3x3 *P, fmatrix3x3 *Pinv, fmatrix3x3 *bigI)
1001 {
1002         unsigned int numverts = lA[0].vcount, iterations = 0, conjgrad_looplimit = 100;
1003         float delta0 = 0, deltaNew = 0, deltaOld = 0, alpha = 0, tol = 0;
1004         lfVector *r = create_lfvector(numverts);
1005         lfVector *p = create_lfvector(numverts);
1006         lfVector *s = create_lfvector(numverts);
1007         lfVector *h = create_lfvector(numverts);
1008         lfVector *bhat = create_lfvector(numverts);
1009         lfVector *btemp = create_lfvector(numverts);
1010
1011         BuildPPinv(lA, P, Pinv);
1012
1013         initdiag_bfmatrix(bigI, I);
1014         sub_bfmatrix_Smatrix(bigI, bigI, S);
1015
1016         // x = Sx_0+(I-S)z
1017         filter(dv, S);
1018         add_lfvector_lfvector(dv, dv, z, numverts);
1019
1020         // b_hat = S(b-A(I-S)z)
1021         mul_bfmatrix_lfvector(r, lA, z);
1022         mul_bfmatrix_lfvector(bhat, bigI, r);
1023         sub_lfvector_lfvector(bhat, lB, bhat, numverts);
1024
1025         // r = S(b-Ax)
1026         mul_bfmatrix_lfvector(r, lA, dv);
1027         sub_lfvector_lfvector(r, lB, r, numverts);
1028         filter(r, S);
1029
1030         // p = SP^-1r
1031         mul_prevfmatrix_lfvector(p, Pinv, r);
1032         filter(p, S);
1033
1034         // delta0 = bhat^TP^-1bhat
1035         mul_prevfmatrix_lfvector(btemp, Pinv, bhat);
1036         delta0 = dot_lfvector(bhat, btemp, numverts);
1037
1038         // deltaNew = r^TP
1039         deltaNew = dot_lfvector(r, p, numverts);
1040
1041 #if 0
1042         filter(dv, S);
1043         add_lfvector_lfvector(dv, dv, z, numverts);
1044
1045         mul_bfmatrix_lfvector(r, lA, dv);
1046         sub_lfvector_lfvector(r, lB, r, numverts);
1047         filter(r, S);
1048
1049         mul_prevfmatrix_lfvector(p, Pinv, r);
1050         filter(p, S);
1051
1052         deltaNew = dot_lfvector(r, p, numverts);
1053
1054         delta0 = deltaNew * sqrt(conjgrad_epsilon);
1055 #endif
1056
1057 #ifdef DEBUG_TIME
1058         double start = PIL_check_seconds_timer();
1059 #endif
1060
1061         tol = (0.01 * 0.2);
1062
1063         while ((deltaNew > delta0 * tol * tol) && (iterations < conjgrad_looplimit))
1064         {
1065                 iterations++;
1066
1067                 mul_bfmatrix_lfvector(s, lA, p);
1068                 filter(s, S);
1069
1070                 alpha = deltaNew / dot_lfvector(p, s, numverts);
1071
1072                 add_lfvector_lfvectorS(dv, dv, p, alpha, numverts);
1073
1074                 add_lfvector_lfvectorS(r, r, s, -alpha, numverts);
1075
1076                 mul_prevfmatrix_lfvector(h, Pinv, r);
1077                 filter(h, S);
1078
1079                 deltaOld = deltaNew;
1080
1081                 deltaNew = dot_lfvector(r, h, numverts);
1082
1083                 add_lfvector_lfvectorS(p, h, p, deltaNew / deltaOld, numverts);
1084
1085                 filter(p, S);
1086
1087         }
1088
1089 #ifdef DEBUG_TIME
1090         double end = PIL_check_seconds_timer();
1091         printf("cg_filtered_pre time: %f\n", (float)(end - start));
1092 #endif
1093
1094         del_lfvector(btemp);
1095         del_lfvector(bhat);
1096         del_lfvector(h);
1097         del_lfvector(s);
1098         del_lfvector(p);
1099         del_lfvector(r);
1100
1101         // printf("iterations: %d\n", iterations);
1102
1103         return iterations < conjgrad_looplimit;
1104 }
1105 #endif
1106
1107 bool BPH_mass_spring_solve_velocities(Implicit_Data *data, float dt, ImplicitSolverResult *result)
1108 {
1109         unsigned int numverts = data->dFdV[0].vcount;
1110
1111         lfVector *dFdXmV = create_lfvector(numverts);
1112         zero_lfvector(data->dV, numverts);
1113
1114         cp_bfmatrix(data->A, data->M);
1115
1116         subadd_bfmatrixS_bfmatrixS(data->A, data->dFdV, dt, data->dFdX, (dt * dt));
1117
1118         mul_bfmatrix_lfvector(dFdXmV, data->dFdX, data->V);
1119
1120         add_lfvectorS_lfvectorS(data->B, data->F, dt, dFdXmV, (dt * dt), numverts);
1121
1122 #ifdef DEBUG_TIME
1123         double start = PIL_check_seconds_timer();
1124 #endif
1125
1126         cg_filtered(data->dV, data->A, data->B, data->z, data->S, result); /* conjugate gradient algorithm to solve Ax=b */
1127         // cg_filtered_pre(id->dV, id->A, id->B, id->z, id->S, id->P, id->Pinv, id->bigI);
1128
1129 #ifdef DEBUG_TIME
1130         double end = PIL_check_seconds_timer();
1131         printf("cg_filtered calc time: %f\n", (float)(end - start));
1132 #endif
1133
1134         // advance velocities
1135         add_lfvector_lfvector(data->Vnew, data->V, data->dV, numverts);
1136
1137         del_lfvector(dFdXmV);
1138
1139         return result->status == BPH_SOLVER_SUCCESS;
1140 }
1141
1142 bool BPH_mass_spring_solve_positions(Implicit_Data *data, float dt)
1143 {
1144         int numverts = data->M[0].vcount;
1145
1146         // advance positions
1147         add_lfvector_lfvectorS(data->Xnew, data->X, data->Vnew, dt, numverts);
1148
1149         return true;
1150 }
1151
1152 void BPH_mass_spring_apply_result(Implicit_Data *data)
1153 {
1154         int numverts = data->M[0].vcount;
1155         cp_lfvector(data->X, data->Xnew, numverts);
1156         cp_lfvector(data->V, data->Vnew, numverts);
1157 }
1158
1159 void BPH_mass_spring_set_vertex_mass(Implicit_Data *data, int index, float mass)
1160 {
1161         unit_m3(data->M[index].m);
1162         mul_m3_fl(data->M[index].m, mass);
1163 }
1164
1165 void BPH_mass_spring_set_rest_transform(Implicit_Data *data, int index, float tfm[3][3])
1166 {
1167 #ifdef CLOTH_ROOT_FRAME
1168         copy_m3_m3(data->tfm[index].m, tfm);
1169 #else
1170         unit_m3(data->tfm[index].m);
1171         (void)tfm;
1172 #endif
1173 }
1174
1175 void BPH_mass_spring_set_motion_state(Implicit_Data *data, int index, const float x[3], const float v[3])
1176 {
1177         world_to_root_v3(data, index, data->X[index], x);
1178         world_to_root_v3(data, index, data->V[index], v);
1179 }
1180
1181 void BPH_mass_spring_set_position(Implicit_Data *data, int index, const float x[3])
1182 {
1183         world_to_root_v3(data, index, data->X[index], x);
1184 }
1185
1186 void BPH_mass_spring_set_velocity(Implicit_Data *data, int index, const float v[3])
1187 {
1188         world_to_root_v3(data, index, data->V[index], v);
1189 }
1190
1191 void BPH_mass_spring_get_motion_state(struct Implicit_Data *data, int index, float x[3], float v[3])
1192 {
1193         if (x) root_to_world_v3(data, index, x, data->X[index]);
1194         if (v) root_to_world_v3(data, index, v, data->V[index]);
1195 }
1196
1197 void BPH_mass_spring_get_position(struct Implicit_Data *data, int index, float x[3])
1198 {
1199         root_to_world_v3(data, index, x, data->X[index]);
1200 }
1201
1202 void BPH_mass_spring_get_new_position(struct Implicit_Data *data, int index, float x[3])
1203 {
1204         root_to_world_v3(data, index, x, data->Xnew[index]);
1205 }
1206
1207 void BPH_mass_spring_set_new_position(struct Implicit_Data *data, int index, const float x[3])
1208 {
1209         world_to_root_v3(data, index, data->Xnew[index], x);
1210 }
1211
1212 void BPH_mass_spring_get_new_velocity(struct Implicit_Data *data, int index, float v[3])
1213 {
1214         root_to_world_v3(data, index, v, data->Vnew[index]);
1215 }
1216
1217 void BPH_mass_spring_set_new_velocity(struct Implicit_Data *data, int index, const float v[3])
1218 {
1219         world_to_root_v3(data, index, data->Vnew[index], v);
1220 }
1221
1222 /* -------------------------------- */
1223
1224 static int BPH_mass_spring_add_block(Implicit_Data *data, int v1, int v2)
1225 {
1226         int s = data->M[0].vcount + data->num_blocks; /* index from array start */
1227         BLI_assert(s < data->M[0].vcount + data->M[0].scount);
1228         ++data->num_blocks;
1229
1230         /* tfm and S don't have spring entries (diagonal blocks only) */
1231         init_fmatrix(data->bigI + s, v1, v2);
1232         init_fmatrix(data->M + s, v1, v2);
1233         init_fmatrix(data->dFdX + s, v1, v2);
1234         init_fmatrix(data->dFdV + s, v1, v2);
1235         init_fmatrix(data->A + s, v1, v2);
1236         init_fmatrix(data->P + s, v1, v2);
1237         init_fmatrix(data->Pinv + s, v1, v2);
1238
1239         return s;
1240 }
1241
1242 void BPH_mass_spring_clear_constraints(Implicit_Data *data)
1243 {
1244         int i, numverts = data->S[0].vcount;
1245         for (i = 0; i < numverts; ++i) {
1246                 unit_m3(data->S[i].m);
1247                 zero_v3(data->z[i]);
1248         }
1249 }
1250
1251 void BPH_mass_spring_add_constraint_ndof0(Implicit_Data *data, int index, const float dV[3])
1252 {
1253         zero_m3(data->S[index].m);
1254
1255         world_to_root_v3(data, index, data->z[index], dV);
1256 }
1257
1258 void BPH_mass_spring_add_constraint_ndof1(Implicit_Data *data, int index, const float c1[3], const float c2[3], const float dV[3])
1259 {
1260         float m[3][3], p[3], q[3], u[3], cmat[3][3];
1261
1262         world_to_root_v3(data, index, p, c1);
1263         mul_fvectorT_fvector(cmat, p, p);
1264         sub_m3_m3m3(m, I, cmat);
1265
1266         world_to_root_v3(data, index, q, c2);
1267         mul_fvectorT_fvector(cmat, q, q);
1268         sub_m3_m3m3(m, m, cmat);
1269
1270         /* XXX not sure but multiplication should work here */
1271         copy_m3_m3(data->S[index].m, m);
1272 //      mul_m3_m3m3(data->S[index].m, data->S[index].m, m);
1273
1274         world_to_root_v3(data, index, u, dV);
1275         add_v3_v3(data->z[index], u);
1276 }
1277
1278 void BPH_mass_spring_add_constraint_ndof2(Implicit_Data *data, int index, const float c1[3], const float dV[3])
1279 {
1280         float m[3][3], p[3], u[3], cmat[3][3];
1281
1282         world_to_root_v3(data, index, p, c1);
1283         mul_fvectorT_fvector(cmat, p, p);
1284         sub_m3_m3m3(m, I, cmat);
1285
1286         copy_m3_m3(data->S[index].m, m);
1287 //      mul_m3_m3m3(data->S[index].m, data->S[index].m, m);
1288
1289         world_to_root_v3(data, index, u, dV);
1290         add_v3_v3(data->z[index], u);
1291 }
1292
1293 void BPH_mass_spring_clear_forces(Implicit_Data *data)
1294 {
1295         int numverts = data->M[0].vcount;
1296         zero_lfvector(data->F, numverts);
1297         init_bfmatrix(data->dFdX, ZERO);
1298         init_bfmatrix(data->dFdV, ZERO);
1299
1300         data->num_blocks = 0;
1301 }
1302
1303 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)
1304 {
1305 #ifdef CLOTH_ROOT_FRAME
1306         float acc[3], w[3], dwdt[3];
1307         float f[3], dfdx[3][3], dfdv[3][3];
1308         float euler[3], coriolis[3], centrifugal[3], rotvel[3];
1309         float deuler[3][3], dcoriolis[3][3], dcentrifugal[3][3], drotvel[3][3];
1310
1311         world_to_root_v3(data, index, acc, acceleration);
1312         world_to_root_v3(data, index, w, omega);
1313         world_to_root_v3(data, index, dwdt, domega_dt);
1314
1315         cross_v3_v3v3(euler, dwdt, data->X[index]);
1316         cross_v3_v3v3(coriolis, w, data->V[index]);
1317         mul_v3_fl(coriolis, 2.0f);
1318         cross_v3_v3v3(rotvel, w, data->X[index]);
1319         cross_v3_v3v3(centrifugal, w, rotvel);
1320
1321         sub_v3_v3v3(f, acc, euler);
1322         sub_v3_v3(f, coriolis);
1323         sub_v3_v3(f, centrifugal);
1324
1325         mul_v3_fl(f, mass); /* F = m * a */
1326
1327         cross_v3_identity(deuler, dwdt);
1328         cross_v3_identity(dcoriolis, w);
1329         mul_m3_fl(dcoriolis, 2.0f);
1330         cross_v3_identity(drotvel, w);
1331         cross_m3_v3m3(dcentrifugal, w, drotvel);
1332
1333         add_m3_m3m3(dfdx, deuler, dcentrifugal);
1334         negate_m3(dfdx);
1335         mul_m3_fl(dfdx, mass);
1336
1337         copy_m3_m3(dfdv, dcoriolis);
1338         negate_m3(dfdv);
1339         mul_m3_fl(dfdv, mass);
1340
1341         add_v3_v3(data->F[index], f);
1342         add_m3_m3m3(data->dFdX[index].m, data->dFdX[index].m, dfdx);
1343         add_m3_m3m3(data->dFdV[index].m, data->dFdV[index].m, dfdv);
1344 #else
1345         (void)data;
1346         (void)index;
1347         (void)acceleration;
1348         (void)omega;
1349         (void)domega_dt;
1350 #endif
1351 }
1352
1353 void BPH_mass_spring_force_gravity(Implicit_Data *data, int index, float mass, const float g[3])
1354 {
1355         /* force = mass * acceleration (in this case: gravity) */
1356         float f[3];
1357         world_to_root_v3(data, index, f, g);
1358         mul_v3_fl(f, mass);
1359
1360         add_v3_v3(data->F[index], f);
1361 }
1362
1363 void BPH_mass_spring_force_drag(Implicit_Data *data, float drag)
1364 {
1365         int i, numverts = data->M[0].vcount;
1366         for (i = 0; i < numverts; i++) {
1367                 float tmp[3][3];
1368
1369                 /* NB: uses root space velocity, no need to transform */
1370                 madd_v3_v3fl(data->F[i], data->V[i], -drag);
1371
1372                 copy_m3_m3(tmp, I);
1373                 mul_m3_fl(tmp, -drag);
1374                 add_m3_m3m3(data->dFdV[i].m, data->dFdV[i].m, tmp);
1375         }
1376 }
1377
1378 void BPH_mass_spring_force_extern(struct Implicit_Data *data, int i, const float f[3], float dfdx[3][3], float dfdv[3][3])
1379 {
1380         float tf[3], tdfdx[3][3], tdfdv[3][3];
1381         world_to_root_v3(data, i, tf, f);
1382         world_to_root_m3(data, i, tdfdx, dfdx);
1383         world_to_root_m3(data, i, tdfdv, dfdv);
1384
1385         add_v3_v3(data->F[i], tf);
1386         add_m3_m3m3(data->dFdX[i].m, data->dFdX[i].m, tdfdx);
1387         add_m3_m3m3(data->dFdV[i].m, data->dFdV[i].m, tdfdv);
1388 }
1389
1390 static float calc_nor_area_tri(float nor[3], const float v1[3], const float v2[3], const float v3[3])
1391 {
1392         float n1[3], n2[3];
1393
1394         sub_v3_v3v3(n1, v1, v2);
1395         sub_v3_v3v3(n2, v2, v3);
1396
1397         cross_v3_v3v3(nor, n1, n2);
1398         return normalize_v3(nor);
1399 }
1400
1401 /* XXX does not support force jacobians yet, since the effector system does not provide them either */
1402 void BPH_mass_spring_force_face_wind(Implicit_Data *data, int v1, int v2, int v3, const float(*winvec)[3])
1403 {
1404         const float effector_scale = 0.02f;
1405         float win[3], nor[3], area;
1406         float factor;
1407
1408         /* calculate face normal and area */
1409         area = calc_nor_area_tri(nor, data->X[v1], data->X[v2], data->X[v3]);
1410         factor = effector_scale * area / 3.0f;
1411
1412         world_to_root_v3(data, v1, win, winvec[v1]);
1413         madd_v3_v3fl(data->F[v1], nor, factor * dot_v3v3(win, nor));
1414
1415         world_to_root_v3(data, v2, win, winvec[v2]);
1416         madd_v3_v3fl(data->F[v2], nor, factor * dot_v3v3(win, nor));
1417
1418         world_to_root_v3(data, v3, win, winvec[v3]);
1419         madd_v3_v3fl(data->F[v3], nor, factor * dot_v3v3(win, nor));
1420 }
1421
1422 static void edge_wind_vertex(const float dir[3], float length, float radius, const float wind[3], float f[3], float UNUSED(dfdx[3][3]), float UNUSED(dfdv[3][3]))
1423 {
1424         const float density = 0.01f; /* XXX arbitrary value, corresponds to effect of air density */
1425         float cos_alpha, sin_alpha, cross_section;
1426         float windlen = len_v3(wind);
1427
1428         if (windlen == 0.0f) {
1429                 zero_v3(f);
1430                 return;
1431         }
1432
1433         /* angle of wind direction to edge */
1434         cos_alpha = dot_v3v3(wind, dir) / windlen;
1435         sin_alpha = sqrtf(1.0f - cos_alpha * cos_alpha);
1436         cross_section = radius * ((float)M_PI * radius * sin_alpha + length * cos_alpha);
1437
1438         mul_v3_v3fl(f, wind, density * cross_section);
1439 }
1440
1441 void BPH_mass_spring_force_edge_wind(Implicit_Data *data, int v1, int v2, float radius1, float radius2, const float(*winvec)[3])
1442 {
1443         float win[3], dir[3], length;
1444         float f[3], dfdx[3][3], dfdv[3][3];
1445
1446         sub_v3_v3v3(dir, data->X[v1], data->X[v2]);
1447         length = normalize_v3(dir);
1448
1449         world_to_root_v3(data, v1, win, winvec[v1]);
1450         edge_wind_vertex(dir, length, radius1, win, f, dfdx, dfdv);
1451         add_v3_v3(data->F[v1], f);
1452
1453         world_to_root_v3(data, v2, win, winvec[v2]);
1454         edge_wind_vertex(dir, length, radius2, win, f, dfdx, dfdv);
1455         add_v3_v3(data->F[v2], f);
1456 }
1457
1458 void BPH_mass_spring_force_vertex_wind(Implicit_Data *data, int v, float UNUSED(radius), const float(*winvec)[3])
1459 {
1460         const float density = 0.01f; /* XXX arbitrary value, corresponds to effect of air density */
1461
1462         float wind[3];
1463         float f[3];
1464
1465         world_to_root_v3(data, v, wind, winvec[v]);
1466         mul_v3_v3fl(f, wind, density);
1467         add_v3_v3(data->F[v], f);
1468 }
1469
1470 BLI_INLINE void dfdx_spring(float to[3][3], const float dir[3], float length, float L, float k)
1471 {
1472         // dir is unit length direction, rest is spring's restlength, k is spring constant.
1473         //return  ( (I-outerprod(dir, dir))*Min(1.0f, rest/length) - I) * -k;
1474         outerproduct(to, dir, dir);
1475         sub_m3_m3m3(to, I, to);
1476
1477         mul_m3_fl(to, (L / length));
1478         sub_m3_m3m3(to, to, I);
1479         mul_m3_fl(to, k);
1480 }
1481
1482 /* unused */
1483 #if 0
1484 BLI_INLINE void dfdx_damp(float to[3][3], const float dir[3], float length, const float vel[3], float rest, float damping)
1485 {
1486         // inner spring damping   vel is the relative velocity  of the endpoints.
1487         //  return (I-outerprod(dir, dir)) * (-damping * -(dot(dir, vel)/Max(length, rest)));
1488         mul_fvectorT_fvector(to, dir, dir);
1489         sub_fmatrix_fmatrix(to, I, to);
1490         mul_fmatrix_S(to,  (-damping * -(dot_v3v3(dir, vel) / MAX2(length, rest))));
1491 }
1492 #endif
1493
1494 BLI_INLINE void dfdv_damp(float to[3][3], const float dir[3], float damping)
1495 {
1496         // derivative of force wrt velocity
1497         outerproduct(to, dir, dir);
1498         mul_m3_fl(to, -damping);
1499 }
1500
1501 BLI_INLINE float fb(float length, float L)
1502 {
1503         float x = length / L;
1504         float xx = x * x;
1505         float xxx = xx * x;
1506         float xxxx = xxx * x;
1507         return (-11.541f * xxxx + 34.193f * xxx - 39.083f * xx + 23.116f * x - 9.713f);
1508 }
1509
1510 BLI_INLINE float fbderiv(float length, float L)
1511 {
1512         float x = length / L;
1513         float xx = x * x;
1514         float xxx = xx * x;
1515         return (-46.164f * xxx + 102.579f * xx - 78.166f * x + 23.116f);
1516 }
1517
1518 BLI_INLINE float fbstar(float length, float L, float kb, float cb)
1519 {
1520         float tempfb_fl = kb * fb(length, L);
1521         float fbstar_fl = cb * (length - L);
1522
1523         if (tempfb_fl < fbstar_fl)
1524                 return fbstar_fl;
1525         else
1526                 return tempfb_fl;
1527 }
1528
1529 // function to calculae bending spring force (taken from Choi & Co)
1530 BLI_INLINE float fbstar_jacobi(float length, float L, float kb, float cb)
1531 {
1532         float tempfb_fl = kb * fb(length, L);
1533         float fbstar_fl = cb * (length - L);
1534
1535         if (tempfb_fl < fbstar_fl) {
1536                 return -cb;
1537         }
1538         else {
1539                 return -kb *fbderiv(length, L);
1540         }
1541 }
1542
1543 /* calculate elonglation */
1544 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])
1545 {
1546         sub_v3_v3v3(r_extent, data->X[j], data->X[i]);
1547         sub_v3_v3v3(r_vel, data->V[j], data->V[i]);
1548         *r_length = len_v3(r_extent);
1549
1550         if (*r_length > ALMOST_ZERO) {
1551 #if 0
1552                 if (length > L) {
1553                         if ((clmd->sim_parms->flags & CSIMSETT_FLAG_TEARING_ENABLED) &&
1554                             ( ((length - L) * 100.0f / L) > clmd->sim_parms->maxspringlen))
1555                         {
1556                                 // cut spring!
1557                                 s->flags |= CSPRING_FLAG_DEACTIVATE;
1558                                 return false;
1559                         }
1560                 }
1561 #endif
1562                 mul_v3_v3fl(r_dir, r_extent, 1.0f / (*r_length));
1563         }
1564         else {
1565                 zero_v3(r_dir);
1566         }
1567
1568         return true;
1569 }
1570
1571 BLI_INLINE void apply_spring(Implicit_Data *data, int i, int j, const float f[3], float dfdx[3][3], float dfdv[3][3])
1572 {
1573         int block_ij = BPH_mass_spring_add_block(data, i, j);
1574
1575         add_v3_v3(data->F[i], f);
1576         sub_v3_v3(data->F[j], f);
1577
1578         add_m3_m3m3(data->dFdX[i].m, data->dFdX[i].m, dfdx);
1579         add_m3_m3m3(data->dFdX[j].m, data->dFdX[j].m, dfdx);
1580         sub_m3_m3m3(data->dFdX[block_ij].m, data->dFdX[block_ij].m, dfdx);
1581
1582         add_m3_m3m3(data->dFdV[i].m, data->dFdV[i].m, dfdv);
1583         add_m3_m3m3(data->dFdV[j].m, data->dFdV[j].m, dfdv);
1584         sub_m3_m3m3(data->dFdV[block_ij].m, data->dFdV[block_ij].m, dfdv);
1585 }
1586
1587 bool BPH_mass_spring_force_spring_linear(Implicit_Data *data, int i, int j, float restlen,
1588                                          float stiffness, float damping, bool no_compress, float clamp_force)
1589 {
1590         float extent[3], length, dir[3], vel[3];
1591
1592         // calculate elonglation
1593         spring_length(data, i, j, extent, dir, &length, vel);
1594
1595         /* This code computes not only the force, but also its derivative.
1596            Zero derivative effectively disables the spring for the implicit solver.
1597            Thus length > restlen makes cloth unconstrained at the start of simulation. */
1598         if ((length >= restlen && length > 0) || no_compress) {
1599                 float stretch_force, f[3], dfdx[3][3], dfdv[3][3];
1600
1601                 stretch_force = stiffness * (length - restlen);
1602                 if (clamp_force > 0.0f && stretch_force > clamp_force) {
1603                         stretch_force = clamp_force;
1604                 }
1605                 mul_v3_v3fl(f, dir, stretch_force);
1606
1607                 // Ascher & Boxman, p.21: Damping only during elonglation
1608                 // something wrong with it...
1609                 madd_v3_v3fl(f, dir, damping * dot_v3v3(vel, dir));
1610
1611                 dfdx_spring(dfdx, dir, length, restlen, stiffness);
1612                 dfdv_damp(dfdv, dir, damping);
1613
1614                 apply_spring(data, i, j, f, dfdx, dfdv);
1615
1616                 return true;
1617         }
1618         else {
1619                 return false;
1620         }
1621 }
1622
1623 /* See "Stable but Responsive Cloth" (Choi, Ko 2005) */
1624 bool BPH_mass_spring_force_spring_bending(Implicit_Data *data, int i, int j, float restlen, float kb, float cb)
1625 {
1626         float extent[3], length, dir[3], vel[3];
1627
1628         // calculate elonglation
1629         spring_length(data, i, j, extent, dir, &length, vel);
1630
1631         if (length < restlen) {
1632                 float f[3], dfdx[3][3], dfdv[3][3];
1633
1634                 mul_v3_v3fl(f, dir, fbstar(length, restlen, kb, cb));
1635
1636                 outerproduct(dfdx, dir, dir);
1637                 mul_m3_fl(dfdx, fbstar_jacobi(length, restlen, kb, cb));
1638
1639                 /* XXX damping not supported */
1640                 zero_m3(dfdv);
1641
1642                 apply_spring(data, i, j, f, dfdx, dfdv);
1643
1644                 return true;
1645         }
1646         else {
1647                 return false;
1648         }
1649 }
1650
1651 /* Jacobian of a direction vector.
1652  * Basically the part of the differential orthogonal to the direction,
1653  * inversely proportional to the length of the edge.
1654  *
1655  * dD_ij/dx_i = -dD_ij/dx_j = (D_ij * D_ij^T - I) / len_ij
1656  */
1657 BLI_INLINE void spring_grad_dir(Implicit_Data *data, int i, int j, float edge[3], float dir[3], float grad_dir[3][3])
1658 {
1659         float length;
1660
1661         sub_v3_v3v3(edge, data->X[j], data->X[i]);
1662         length = normalize_v3_v3(dir, edge);
1663
1664         if (length > ALMOST_ZERO) {
1665                 outerproduct(grad_dir, dir, dir);
1666                 sub_m3_m3m3(grad_dir, I, grad_dir);
1667                 mul_m3_fl(grad_dir, 1.0f / length);
1668         }
1669         else {
1670                 zero_m3(grad_dir);
1671         }
1672 }
1673
1674 BLI_INLINE void spring_angbend_forces(Implicit_Data *data, int i, int j, int k,
1675                                       const float goal[3],
1676                                       float stiffness, float damping,
1677                                       int q, const float dx[3], const float dv[3],
1678                                       float r_f[3])
1679 {
1680         float edge_ij[3], dir_ij[3];
1681         float edge_jk[3], dir_jk[3];
1682         float vel_ij[3], vel_jk[3], vel_ortho[3];
1683         float f_bend[3], f_damp[3];
1684         float fk[3];
1685         float dist[3];
1686
1687         zero_v3(fk);
1688
1689         sub_v3_v3v3(edge_ij, data->X[j], data->X[i]);
1690         if (q == i) sub_v3_v3(edge_ij, dx);
1691         if (q == j) add_v3_v3(edge_ij, dx);
1692         normalize_v3_v3(dir_ij, edge_ij);
1693
1694         sub_v3_v3v3(edge_jk, data->X[k], data->X[j]);
1695         if (q == j) sub_v3_v3(edge_jk, dx);
1696         if (q == k) add_v3_v3(edge_jk, dx);
1697         normalize_v3_v3(dir_jk, edge_jk);
1698
1699         sub_v3_v3v3(vel_ij, data->V[j], data->V[i]);
1700         if (q == i) sub_v3_v3(vel_ij, dv);
1701         if (q == j) add_v3_v3(vel_ij, dv);
1702
1703         sub_v3_v3v3(vel_jk, data->V[k], data->V[j]);
1704         if (q == j) sub_v3_v3(vel_jk, dv);
1705         if (q == k) add_v3_v3(vel_jk, dv);
1706
1707         /* bending force */
1708         sub_v3_v3v3(dist, goal, edge_jk);
1709         mul_v3_v3fl(f_bend, dist, stiffness);
1710
1711         add_v3_v3(fk, f_bend);
1712
1713         /* damping force */
1714         madd_v3_v3v3fl(vel_ortho, vel_jk, dir_jk, -dot_v3v3(vel_jk, dir_jk));
1715         mul_v3_v3fl(f_damp, vel_ortho, damping);
1716
1717         sub_v3_v3(fk, f_damp);
1718
1719         copy_v3_v3(r_f, fk);
1720 }
1721
1722 /* Finite Differences method for estimating the jacobian of the force */
1723 BLI_INLINE void spring_angbend_estimate_dfdx(Implicit_Data *data, int i, int j, int k,
1724                                              const float goal[3],
1725                                              float stiffness, float damping,
1726                                              int q, float dfdx[3][3])
1727 {
1728         const float delta = 0.00001f; // TODO find a good heuristic for this
1729         float dvec_null[3][3], dvec_pos[3][3], dvec_neg[3][3];
1730         float f[3];
1731         int a, b;
1732
1733         zero_m3(dvec_null);
1734         unit_m3(dvec_pos);
1735         mul_m3_fl(dvec_pos, delta * 0.5f);
1736         copy_m3_m3(dvec_neg, dvec_pos);
1737         negate_m3(dvec_neg);
1738
1739         /* XXX TODO offset targets to account for position dependency */
1740
1741         for (a = 0; a < 3; ++a) {
1742                 spring_angbend_forces(data, i, j, k, goal, stiffness, damping,
1743                                       q, dvec_pos[a], dvec_null[a], f);
1744                 copy_v3_v3(dfdx[a], f);
1745
1746                 spring_angbend_forces(data, i, j, k, goal, stiffness, damping,
1747                                       q, dvec_neg[a], dvec_null[a], f);
1748                 sub_v3_v3(dfdx[a], f);
1749
1750                 for (b = 0; b < 3; ++b) {
1751                         dfdx[a][b] /= delta;
1752                 }
1753         }
1754 }
1755
1756 /* Finite Differences method for estimating the jacobian of the force */
1757 BLI_INLINE void spring_angbend_estimate_dfdv(Implicit_Data *data, int i, int j, int k,
1758                                              const float goal[3],
1759                                              float stiffness, float damping,
1760                                              int q, float dfdv[3][3])
1761 {
1762         const float delta = 0.00001f; // TODO find a good heuristic for this
1763         float dvec_null[3][3], dvec_pos[3][3], dvec_neg[3][3];
1764         float f[3];
1765         int a, b;
1766
1767         zero_m3(dvec_null);
1768         unit_m3(dvec_pos);
1769         mul_m3_fl(dvec_pos, delta * 0.5f);
1770         copy_m3_m3(dvec_neg, dvec_pos);
1771         negate_m3(dvec_neg);
1772
1773         /* XXX TODO offset targets to account for position dependency */
1774
1775         for (a = 0; a < 3; ++a) {
1776                 spring_angbend_forces(data, i, j, k, goal, stiffness, damping,
1777                                       q, dvec_null[a], dvec_pos[a], f);
1778                 copy_v3_v3(dfdv[a], f);
1779
1780                 spring_angbend_forces(data, i, j, k, goal, stiffness, damping,
1781                                       q, dvec_null[a], dvec_neg[a], f);
1782                 sub_v3_v3(dfdv[a], f);
1783
1784                 for (b = 0; b < 3; ++b) {
1785                         dfdv[a][b] /= delta;
1786                 }
1787         }
1788 }
1789
1790 /* Angular spring that pulls the vertex toward the local target
1791  * See "Artistic Simulation of Curly Hair" (Pixar technical memo #12-03a)
1792  */
1793 bool BPH_mass_spring_force_spring_bending_angular(Implicit_Data *data, int i, int j, int k,
1794                                                   const float target[3], float stiffness, float damping)
1795 {
1796         float goal[3];
1797         float fj[3], fk[3];
1798         float dfj_dxi[3][3], dfj_dxj[3][3], dfk_dxi[3][3], dfk_dxj[3][3], dfk_dxk[3][3];
1799         float dfj_dvi[3][3], dfj_dvj[3][3], dfk_dvi[3][3], dfk_dvj[3][3], dfk_dvk[3][3];
1800
1801         const float vecnull[3] = {0.0f, 0.0f, 0.0f};
1802
1803         int block_ij = BPH_mass_spring_add_block(data, i, j);
1804         int block_jk = BPH_mass_spring_add_block(data, j, k);
1805         int block_ik = BPH_mass_spring_add_block(data, i, k);
1806
1807         world_to_root_v3(data, j, goal, target);
1808
1809         spring_angbend_forces(data, i, j, k, goal, stiffness, damping, k, vecnull, vecnull, fk);
1810         negate_v3_v3(fj, fk); /* counterforce */
1811
1812         spring_angbend_estimate_dfdx(data, i, j, k, goal, stiffness, damping, i, dfk_dxi);
1813         spring_angbend_estimate_dfdx(data, i, j, k, goal, stiffness, damping, j, dfk_dxj);
1814         spring_angbend_estimate_dfdx(data, i, j, k, goal, stiffness, damping, k, dfk_dxk);
1815         copy_m3_m3(dfj_dxi, dfk_dxi); negate_m3(dfj_dxi);
1816         copy_m3_m3(dfj_dxj, dfk_dxj); negate_m3(dfj_dxj);
1817
1818         spring_angbend_estimate_dfdv(data, i, j, k, goal, stiffness, damping, i, dfk_dvi);
1819         spring_angbend_estimate_dfdv(data, i, j, k, goal, stiffness, damping, j, dfk_dvj);
1820         spring_angbend_estimate_dfdv(data, i, j, k, goal, stiffness, damping, k, dfk_dvk);
1821         copy_m3_m3(dfj_dvi, dfk_dvi); negate_m3(dfj_dvi);
1822         copy_m3_m3(dfj_dvj, dfk_dvj); negate_m3(dfj_dvj);
1823
1824         /* add forces and jacobians to the solver data */
1825
1826         add_v3_v3(data->F[j], fj);
1827         add_v3_v3(data->F[k], fk);
1828
1829         add_m3_m3m3(data->dFdX[j].m, data->dFdX[j].m, dfj_dxj);
1830         add_m3_m3m3(data->dFdX[k].m, data->dFdX[k].m, dfk_dxk);
1831
1832         add_m3_m3m3(data->dFdX[block_ij].m, data->dFdX[block_ij].m, dfj_dxi);
1833         add_m3_m3m3(data->dFdX[block_jk].m, data->dFdX[block_jk].m, dfk_dxj);
1834         add_m3_m3m3(data->dFdX[block_ik].m, data->dFdX[block_ik].m, dfk_dxi);
1835
1836         add_m3_m3m3(data->dFdV[j].m, data->dFdV[j].m, dfj_dvj);
1837         add_m3_m3m3(data->dFdV[k].m, data->dFdV[k].m, dfk_dvk);
1838
1839         add_m3_m3m3(data->dFdV[block_ij].m, data->dFdV[block_ij].m, dfj_dvi);
1840         add_m3_m3m3(data->dFdV[block_jk].m, data->dFdV[block_jk].m, dfk_dvj);
1841         add_m3_m3m3(data->dFdV[block_ik].m, data->dFdV[block_ik].m, dfk_dvi);
1842
1843
1844         /* XXX analytical calculation of derivatives below is incorrect.
1845          * This proved to be difficult, but for now just using the finite difference method for
1846          * estimating the jacobians should be sufficient.
1847          */
1848 #if 0
1849         float edge_ij[3], dir_ij[3], grad_dir_ij[3][3];
1850         float edge_jk[3], dir_jk[3], grad_dir_jk[3][3];
1851         float dist[3], vel_jk[3], vel_jk_ortho[3], projvel[3];
1852         float target[3];
1853         float tmp[3][3];
1854         float fi[3], fj[3], fk[3];
1855         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];
1856         float dfdvi[3][3];
1857
1858         // TESTING
1859         damping = 0.0f;
1860
1861         zero_v3(fi);
1862         zero_v3(fj);
1863         zero_v3(fk);
1864         zero_m3(dfi_dxi);
1865         zero_m3(dfj_dxi);
1866         zero_m3(dfk_dxi);
1867         zero_m3(dfk_dxj);
1868         zero_m3(dfk_dxk);
1869
1870         /* jacobian of direction vectors */
1871         spring_grad_dir(data, i, j, edge_ij, dir_ij, grad_dir_ij);
1872         spring_grad_dir(data, j, k, edge_jk, dir_jk, grad_dir_jk);
1873
1874         sub_v3_v3v3(vel_jk, data->V[k], data->V[j]);
1875
1876         /* bending force */
1877         mul_v3_v3fl(target, dir_ij, restlen);
1878         sub_v3_v3v3(dist, target, edge_jk);
1879         mul_v3_v3fl(fk, dist, stiffness);
1880
1881         /* damping force */
1882         madd_v3_v3v3fl(vel_jk_ortho, vel_jk, dir_jk, -dot_v3v3(vel_jk, dir_jk));
1883         madd_v3_v3fl(fk, vel_jk_ortho, damping);
1884
1885         /* XXX this only holds true as long as we assume straight rest shape!
1886          * eventually will become a bit more involved since the opposite segment
1887          * gets its own target, under condition of having equal torque on both sides.
1888          */
1889         copy_v3_v3(fi, fk);
1890
1891         /* counterforce on the middle point */
1892         sub_v3_v3(fj, fi);
1893         sub_v3_v3(fj, fk);
1894
1895         /* === derivatives === */
1896
1897         madd_m3_m3fl(dfk_dxi, grad_dir_ij, stiffness * restlen);
1898
1899         madd_m3_m3fl(dfk_dxj, grad_dir_ij, -stiffness * restlen);
1900         madd_m3_m3fl(dfk_dxj, I, stiffness);
1901
1902         madd_m3_m3fl(dfk_dxk, I, -stiffness);
1903
1904         copy_m3_m3(dfi_dxi, dfk_dxk);
1905         negate_m3(dfi_dxi);
1906
1907         /* dfj_dfi == dfi_dfj due to symmetry,
1908          * dfi_dfj == dfk_dfj due to fi == fk
1909          * XXX see comment above on future bent rest shapes
1910          */
1911         copy_m3_m3(dfj_dxi, dfk_dxj);
1912
1913         /* dfj_dxj == -(dfi_dxj + dfk_dxj) due to fj == -(fi + fk) */
1914         sub_m3_m3m3(dfj_dxj, dfj_dxj, dfj_dxi);
1915         sub_m3_m3m3(dfj_dxj, dfj_dxj, dfk_dxj);
1916
1917         /* add forces and jacobians to the solver data */
1918         add_v3_v3(data->F[i], fi);
1919         add_v3_v3(data->F[j], fj);
1920         add_v3_v3(data->F[k], fk);
1921
1922         add_m3_m3m3(data->dFdX[i].m, data->dFdX[i].m, dfi_dxi);
1923         add_m3_m3m3(data->dFdX[j].m, data->dFdX[j].m, dfj_dxj);
1924         add_m3_m3m3(data->dFdX[k].m, data->dFdX[k].m, dfk_dxk);
1925
1926         add_m3_m3m3(data->dFdX[block_ij].m, data->dFdX[block_ij].m, dfj_dxi);
1927         add_m3_m3m3(data->dFdX[block_jk].m, data->dFdX[block_jk].m, dfk_dxj);
1928         add_m3_m3m3(data->dFdX[block_ik].m, data->dFdX[block_ik].m, dfk_dxi);
1929 #endif
1930
1931         return true;
1932 }
1933
1934 bool BPH_mass_spring_force_spring_goal(Implicit_Data *data, int i, const float goal_x[3], const float goal_v[3],
1935                                        float stiffness, float damping)
1936 {
1937         float root_goal_x[3], root_goal_v[3], extent[3], length, dir[3], vel[3];
1938         float f[3], dfdx[3][3], dfdv[3][3];
1939
1940         /* goal is in world space */
1941         world_to_root_v3(data, i, root_goal_x, goal_x);
1942         world_to_root_v3(data, i, root_goal_v, goal_v);
1943
1944         sub_v3_v3v3(extent, root_goal_x, data->X[i]);
1945         sub_v3_v3v3(vel, root_goal_v, data->V[i]);
1946         length = normalize_v3_v3(dir, extent);
1947
1948         if (length > ALMOST_ZERO) {
1949                 mul_v3_v3fl(f, dir, stiffness * length);
1950
1951                 // Ascher & Boxman, p.21: Damping only during elonglation
1952                 // something wrong with it...
1953                 madd_v3_v3fl(f, dir, damping * dot_v3v3(vel, dir));
1954
1955                 dfdx_spring(dfdx, dir, length, 0.0f, stiffness);
1956                 dfdv_damp(dfdv, dir, damping);
1957
1958                 add_v3_v3(data->F[i], f);
1959                 add_m3_m3m3(data->dFdX[i].m, data->dFdX[i].m, dfdx);
1960                 add_m3_m3m3(data->dFdV[i].m, data->dFdV[i].m, dfdv);
1961
1962                 return true;
1963         }
1964         else {
1965                 return false;
1966         }
1967 }
1968
1969 #endif /* IMPLICIT_SOLVER_BLENDER */