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