Animation: Remove depsgraph argument from a lot of API
[blender.git] / source / blender / blenkernel / intern / particle_system.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2007 by Janne Karhu.
17  * All rights reserved.
18  * Adaptive time step
19  * Classical SPH
20  * Copyright 2011-2012 AutoCRC
21  */
22
23 /** \file
24  * \ingroup bke
25  */
26
27 #include <stddef.h>
28
29 #include <stdlib.h>
30 #include <math.h>
31 #include <string.h>
32
33 #include "MEM_guardedalloc.h"
34
35 #include "DNA_anim_types.h"
36 #include "DNA_boid_types.h"
37 #include "DNA_particle_types.h"
38 #include "DNA_mesh_types.h"
39 #include "DNA_meshdata_types.h"
40 #include "DNA_modifier_types.h"
41 #include "DNA_object_force_types.h"
42 #include "DNA_object_types.h"
43 #include "DNA_curve_types.h"
44 #include "DNA_scene_types.h"
45 #include "DNA_texture_types.h"
46 #include "DNA_listBase.h"
47
48 #include "BLI_utildefines.h"
49 #include "BLI_edgehash.h"
50 #include "BLI_rand.h"
51 #include "BLI_math.h"
52 #include "BLI_blenlib.h"
53 #include "BLI_kdtree.h"
54 #include "BLI_kdopbvh.h"
55 #include "BLI_task.h"
56 #include "BLI_threads.h"
57 #include "BLI_linklist.h"
58 #include "BLI_string_utils.h"
59
60 #include "BKE_animsys.h"
61 #include "BKE_boids.h"
62 #include "BKE_collision.h"
63 #include "BKE_colortools.h"
64 #include "BKE_effect.h"
65 #include "BKE_library.h"
66 #include "BKE_library_query.h"
67 #include "BKE_particle.h"
68
69 #include "BKE_collection.h"
70 #include "BKE_object.h"
71 #include "BKE_material.h"
72 #include "BKE_cloth.h"
73 #include "BKE_lattice.h"
74 #include "BKE_pointcache.h"
75 #include "BKE_mesh.h"
76 #include "BKE_modifier.h"
77 #include "BKE_scene.h"
78 #include "BKE_bvhutils.h"
79
80 #include "DEG_depsgraph.h"
81 #include "DEG_depsgraph_physics.h"
82 #include "DEG_depsgraph_query.h"
83
84 #include "PIL_time.h"
85
86 #include "RE_shader_ext.h"
87
88 /* fluid sim particle import */
89 #ifdef WITH_MOD_FLUID
90 #  include "DNA_object_fluidsim_types.h"
91 #  include "LBM_fluidsim.h"
92 #  include <zlib.h>
93 #  include <string.h>
94
95 #endif  // WITH_MOD_FLUID
96
97 static ThreadRWMutex psys_bvhtree_rwlock = BLI_RWLOCK_INITIALIZER;
98
99 /************************************************/
100 /*          Reacting to system events           */
101 /************************************************/
102
103 static int particles_are_dynamic(ParticleSystem *psys)
104 {
105   if (psys->pointcache->flag & PTCACHE_BAKED) {
106     return 0;
107   }
108
109   if (psys->part->type == PART_HAIR) {
110     return psys->flag & PSYS_HAIR_DYNAMICS;
111   }
112   else {
113     return ELEM(psys->part->phystype, PART_PHYS_NEWTON, PART_PHYS_BOIDS, PART_PHYS_FLUID);
114   }
115 }
116
117 float psys_get_current_display_percentage(ParticleSystem *psys, const bool use_render_params)
118 {
119   ParticleSettings *part = psys->part;
120
121   if ((use_render_params &&
122        !particles_are_dynamic(psys)) ||          /* non-dynamic particles can be rendered fully */
123       (part->child_nbr && part->childtype) ||    /* display percentage applies to children */
124       (psys->pointcache->flag & PTCACHE_BAKING)) /* baking is always done with full amount */
125   {
126     return 1.0f;
127   }
128
129   return psys->part->disp / 100.0f;
130 }
131
132 static int tot_particles(ParticleSystem *psys, PTCacheID *pid)
133 {
134   if (pid && psys->pointcache->flag & PTCACHE_EXTERNAL) {
135     return pid->cache->totpoint;
136   }
137   else if (psys->part->distr == PART_DISTR_GRID && psys->part->from != PART_FROM_VERT) {
138     return psys->part->grid_res * psys->part->grid_res * psys->part->grid_res - psys->totunexist;
139   }
140   else {
141     return psys->part->totpart - psys->totunexist;
142   }
143 }
144
145 void psys_reset(ParticleSystem *psys, int mode)
146 {
147   PARTICLE_P;
148
149   if (ELEM(mode, PSYS_RESET_ALL, PSYS_RESET_DEPSGRAPH)) {
150     if (mode == PSYS_RESET_ALL || !(psys->flag & PSYS_EDITED)) {
151       /* don't free if not absolutely necessary */
152       if (psys->totpart != tot_particles(psys, NULL)) {
153         psys_free_particles(psys);
154         psys->totpart = 0;
155       }
156
157       psys->totkeyed = 0;
158       psys->flag &= ~(PSYS_HAIR_DONE | PSYS_KEYED);
159
160       if (psys->edit && psys->free_edit) {
161         psys->free_edit(psys->edit);
162         psys->edit = NULL;
163         psys->free_edit = NULL;
164       }
165     }
166   }
167   else if (mode == PSYS_RESET_CACHE_MISS) {
168     /* set all particles to be skipped */
169     LOOP_PARTICLES
170     {
171       pa->flag |= PARS_NO_DISP;
172     }
173   }
174
175   /* reset children */
176   if (psys->child) {
177     MEM_freeN(psys->child);
178     psys->child = NULL;
179   }
180
181   psys->totchild = 0;
182
183   /* reset path cache */
184   psys_free_path_cache(psys, psys->edit);
185
186   /* reset point cache */
187   BKE_ptcache_invalidate(psys->pointcache);
188
189   if (psys->fluid_springs) {
190     MEM_freeN(psys->fluid_springs);
191     psys->fluid_springs = NULL;
192   }
193
194   psys->tot_fluidsprings = psys->alloc_fluidsprings = 0;
195 }
196
197 void psys_unique_name(Object *object, ParticleSystem *psys, const char *defname)
198 {
199   BLI_uniquename(&object->particlesystem,
200                  psys,
201                  defname,
202                  '.',
203                  offsetof(ParticleSystem, name),
204                  sizeof(psys->name));
205 }
206
207 static void realloc_particles(ParticleSimulationData *sim, int new_totpart)
208 {
209   ParticleSystem *psys = sim->psys;
210   ParticleSettings *part = psys->part;
211   ParticleData *newpars = NULL;
212   BoidParticle *newboids = NULL;
213   PARTICLE_P;
214   int totpart, totsaved = 0;
215
216   if (new_totpart < 0) {
217     if ((part->distr == PART_DISTR_GRID) && (part->from != PART_FROM_VERT)) {
218       totpart = part->grid_res;
219       totpart *= totpart * totpart;
220     }
221     else {
222       totpart = part->totpart;
223     }
224   }
225   else {
226     totpart = new_totpart;
227   }
228
229   if (totpart != psys->totpart) {
230     if (psys->edit && psys->free_edit) {
231       psys->free_edit(psys->edit);
232       psys->edit = NULL;
233       psys->free_edit = NULL;
234     }
235
236     if (totpart) {
237       newpars = MEM_callocN(totpart * sizeof(ParticleData), "particles");
238       if (newpars == NULL) {
239         return;
240       }
241
242       if (psys->part->phystype == PART_PHYS_BOIDS) {
243         newboids = MEM_callocN(totpart * sizeof(BoidParticle), "boid particles");
244
245         if (newboids == NULL) {
246           /* allocation error! */
247           if (newpars) {
248             MEM_freeN(newpars);
249           }
250           return;
251         }
252       }
253     }
254
255     if (psys->particles) {
256       totsaved = MIN2(psys->totpart, totpart);
257       /*save old pars*/
258       if (totsaved) {
259         memcpy(newpars, psys->particles, totsaved * sizeof(ParticleData));
260
261         if (psys->particles->boid) {
262           memcpy(newboids, psys->particles->boid, totsaved * sizeof(BoidParticle));
263         }
264       }
265
266       if (psys->particles->keys) {
267         MEM_freeN(psys->particles->keys);
268       }
269
270       if (psys->particles->boid) {
271         MEM_freeN(psys->particles->boid);
272       }
273
274       for (p = 0, pa = newpars; p < totsaved; p++, pa++) {
275         if (pa->keys) {
276           pa->keys = NULL;
277           pa->totkey = 0;
278         }
279       }
280
281       for (p = totsaved, pa = psys->particles + totsaved; p < psys->totpart; p++, pa++) {
282         if (pa->hair) {
283           MEM_freeN(pa->hair);
284         }
285       }
286
287       MEM_freeN(psys->particles);
288       psys_free_pdd(psys);
289     }
290
291     psys->particles = newpars;
292     psys->totpart = totpart;
293
294     if (newboids) {
295       LOOP_PARTICLES
296       {
297         pa->boid = newboids++;
298       }
299     }
300   }
301
302   if (psys->child) {
303     MEM_freeN(psys->child);
304     psys->child = NULL;
305     psys->totchild = 0;
306   }
307 }
308
309 int psys_get_child_number(Scene *scene, ParticleSystem *psys, const bool use_render_params)
310 {
311   int nbr;
312
313   if (!psys->part->childtype) {
314     return 0;
315   }
316
317   if (use_render_params) {
318     nbr = psys->part->ren_child_nbr;
319   }
320   else {
321     nbr = psys->part->child_nbr;
322   }
323
324   return get_render_child_particle_number(&scene->r, nbr, use_render_params);
325 }
326
327 int psys_get_tot_child(Scene *scene, ParticleSystem *psys, const bool use_render_params)
328 {
329   return psys->totpart * psys_get_child_number(scene, psys, use_render_params);
330 }
331
332 /************************************************/
333 /*          Distribution                        */
334 /************************************************/
335
336 void psys_calc_dmcache(Object *ob, Mesh *mesh_final, Mesh *mesh_original, ParticleSystem *psys)
337 {
338   /* use for building derived mesh mapping info:
339    *
340    * node: the allocated links - total derived mesh element count
341    * nodearray: the array of nodes aligned with the base mesh's elements, so
342    *            each original elements can reference its derived elements
343    */
344   Mesh *me = (Mesh *)ob->data;
345   bool use_modifier_stack = psys->part->use_modifier_stack;
346   PARTICLE_P;
347
348   /* CACHE LOCATIONS */
349   if (!mesh_final->runtime.deformed_only) {
350     /* Will use later to speed up subsurf/evaluated mesh. */
351     LinkNode *node, *nodedmelem, **nodearray;
352     int totdmelem, totelem, i, *origindex, *origindex_poly = NULL;
353
354     if (psys->part->from == PART_FROM_VERT) {
355       totdmelem = mesh_final->totvert;
356
357       if (use_modifier_stack) {
358         totelem = totdmelem;
359         origindex = NULL;
360       }
361       else {
362         totelem = me->totvert;
363         origindex = CustomData_get_layer(&mesh_final->vdata, CD_ORIGINDEX);
364       }
365     }
366     else { /* FROM_FACE/FROM_VOLUME */
367       totdmelem = mesh_final->totface;
368
369       if (use_modifier_stack) {
370         totelem = totdmelem;
371         origindex = NULL;
372         origindex_poly = NULL;
373       }
374       else {
375         totelem = mesh_original->totface;
376         origindex = CustomData_get_layer(&mesh_final->fdata, CD_ORIGINDEX);
377
378         /* for face lookups we need the poly origindex too */
379         origindex_poly = CustomData_get_layer(&mesh_final->pdata, CD_ORIGINDEX);
380         if (origindex_poly == NULL) {
381           origindex = NULL;
382         }
383       }
384     }
385
386     nodedmelem = MEM_callocN(sizeof(LinkNode) * totdmelem, "psys node elems");
387     nodearray = MEM_callocN(sizeof(LinkNode *) * totelem, "psys node array");
388
389     for (i = 0, node = nodedmelem; i < totdmelem; i++, node++) {
390       int origindex_final;
391       node->link = POINTER_FROM_INT(i);
392
393       /* may be vertex or face origindex */
394       if (use_modifier_stack) {
395         origindex_final = i;
396       }
397       else {
398         origindex_final = origindex ? origindex[i] : ORIGINDEX_NONE;
399
400         /* if we have a poly source, do an index lookup */
401         if (origindex_poly && origindex_final != ORIGINDEX_NONE) {
402           origindex_final = origindex_poly[origindex_final];
403         }
404       }
405
406       if (origindex_final != ORIGINDEX_NONE && origindex_final < totelem) {
407         if (nodearray[origindex_final]) {
408           /* prepend */
409           node->next = nodearray[origindex_final];
410           nodearray[origindex_final] = node;
411         }
412         else {
413           nodearray[origindex_final] = node;
414         }
415       }
416     }
417
418     /* cache the verts/faces! */
419     LOOP_PARTICLES
420     {
421       if (pa->num < 0) {
422         pa->num_dmcache = DMCACHE_NOTFOUND;
423         continue;
424       }
425
426       if (use_modifier_stack) {
427         if (pa->num < totelem) {
428           pa->num_dmcache = DMCACHE_ISCHILD;
429         }
430         else {
431           pa->num_dmcache = DMCACHE_NOTFOUND;
432         }
433       }
434       else {
435         if (psys->part->from == PART_FROM_VERT) {
436           if (pa->num < totelem && nodearray[pa->num]) {
437             pa->num_dmcache = POINTER_AS_INT(nodearray[pa->num]->link);
438           }
439           else {
440             pa->num_dmcache = DMCACHE_NOTFOUND;
441           }
442         }
443         else { /* FROM_FACE/FROM_VOLUME */
444           pa->num_dmcache = psys_particle_dm_face_lookup(
445               mesh_final, mesh_original, pa->num, pa->fuv, nodearray);
446         }
447       }
448     }
449
450     MEM_freeN(nodearray);
451     MEM_freeN(nodedmelem);
452   }
453   else {
454     /* TODO PARTICLE, make the following line unnecessary, each function
455      * should know to use the num or num_dmcache, set the num_dmcache to
456      * an invalid value, just in case */
457
458     LOOP_PARTICLES
459     {
460       pa->num_dmcache = DMCACHE_NOTFOUND;
461     }
462   }
463 }
464
465 /* threaded child particle distribution and path caching */
466 void psys_thread_context_init(ParticleThreadContext *ctx, ParticleSimulationData *sim)
467 {
468   memset(ctx, 0, sizeof(ParticleThreadContext));
469   ctx->sim = *sim;
470   ctx->mesh = ctx->sim.psmd->mesh_final;
471   ctx->ma = give_current_material(sim->ob, sim->psys->part->omat);
472 }
473
474 void psys_tasks_create(ParticleThreadContext *ctx,
475                        int startpart,
476                        int endpart,
477                        ParticleTask **r_tasks,
478                        int *r_numtasks)
479 {
480   ParticleTask *tasks;
481   int numtasks = min_ii(BLI_system_thread_count() * 4, endpart - startpart);
482   float particles_per_task = (float)(endpart - startpart) / (float)numtasks, p, pnext;
483   int i;
484
485   tasks = MEM_callocN(sizeof(ParticleTask) * numtasks, "ParticleThread");
486   *r_numtasks = numtasks;
487   *r_tasks = tasks;
488
489   p = (float)startpart;
490   for (i = 0; i < numtasks; i++, p = pnext) {
491     pnext = p + particles_per_task;
492
493     tasks[i].ctx = ctx;
494     tasks[i].begin = (int)p;
495     tasks[i].end = min_ii((int)pnext, endpart);
496   }
497 }
498
499 void psys_tasks_free(ParticleTask *tasks, int numtasks)
500 {
501   int i;
502
503   /* threads */
504   for (i = 0; i < numtasks; ++i) {
505     if (tasks[i].rng) {
506       BLI_rng_free(tasks[i].rng);
507     }
508     if (tasks[i].rng_path) {
509       BLI_rng_free(tasks[i].rng_path);
510     }
511   }
512
513   MEM_freeN(tasks);
514 }
515
516 void psys_thread_context_free(ParticleThreadContext *ctx)
517 {
518   /* path caching */
519   if (ctx->vg_length) {
520     MEM_freeN(ctx->vg_length);
521   }
522   if (ctx->vg_clump) {
523     MEM_freeN(ctx->vg_clump);
524   }
525   if (ctx->vg_kink) {
526     MEM_freeN(ctx->vg_kink);
527   }
528   if (ctx->vg_rough1) {
529     MEM_freeN(ctx->vg_rough1);
530   }
531   if (ctx->vg_rough2) {
532     MEM_freeN(ctx->vg_rough2);
533   }
534   if (ctx->vg_roughe) {
535     MEM_freeN(ctx->vg_roughe);
536   }
537   if (ctx->vg_twist) {
538     MEM_freeN(ctx->vg_twist);
539   }
540
541   if (ctx->sim.psys->lattice_deform_data) {
542     end_latt_deform(ctx->sim.psys->lattice_deform_data);
543     ctx->sim.psys->lattice_deform_data = NULL;
544   }
545
546   /* distribution */
547   if (ctx->jit) {
548     MEM_freeN(ctx->jit);
549   }
550   if (ctx->jitoff) {
551     MEM_freeN(ctx->jitoff);
552   }
553   if (ctx->weight) {
554     MEM_freeN(ctx->weight);
555   }
556   if (ctx->index) {
557     MEM_freeN(ctx->index);
558   }
559   if (ctx->seams) {
560     MEM_freeN(ctx->seams);
561   }
562   // if (ctx->vertpart) MEM_freeN(ctx->vertpart);
563   BLI_kdtree_3d_free(ctx->tree);
564
565   if (ctx->clumpcurve != NULL) {
566     curvemapping_free(ctx->clumpcurve);
567   }
568   if (ctx->roughcurve != NULL) {
569     curvemapping_free(ctx->roughcurve);
570   }
571   if (ctx->twistcurve != NULL) {
572     curvemapping_free(ctx->twistcurve);
573   }
574 }
575
576 static void initialize_particle_texture(ParticleSimulationData *sim, ParticleData *pa, int p)
577 {
578   ParticleSystem *psys = sim->psys;
579   ParticleSettings *part = psys->part;
580   ParticleTexture ptex;
581
582   psys_get_texture(sim, pa, &ptex, PAMAP_INIT, 0.f);
583
584   switch (part->type) {
585     case PART_EMITTER:
586       if (ptex.exist < psys_frand(psys, p + 125)) {
587         pa->flag |= PARS_UNEXIST;
588       }
589       pa->time = part->sta + (part->end - part->sta) * ptex.time;
590       break;
591     case PART_HAIR:
592       if (ptex.exist < psys_frand(psys, p + 125)) {
593         pa->flag |= PARS_UNEXIST;
594       }
595       pa->time = 0.f;
596       break;
597     case PART_FLUID:
598       break;
599   }
600 }
601
602 /* set particle parameters that don't change during particle's life */
603 void initialize_particle(ParticleSimulationData *sim, ParticleData *pa)
604 {
605   ParticleSettings *part = sim->psys->part;
606   float birth_time = (float)(pa - sim->psys->particles) / (float)sim->psys->totpart;
607
608   pa->flag &= ~PARS_UNEXIST;
609   pa->time = part->sta + (part->end - part->sta) * birth_time;
610
611   pa->hair_index = 0;
612   /* we can't reset to -1 anymore since we've figured out correct index in distribute_particles */
613   /* usage other than straight after distribute has to handle this index by itself - jahka*/
614   // pa->num_dmcache = DMCACHE_NOTFOUND; /* assume we don't have a derived mesh face */
615 }
616
617 static void initialize_all_particles(ParticleSimulationData *sim)
618 {
619   ParticleSystem *psys = sim->psys;
620   ParticleSettings *part = psys->part;
621   /* Grid distributionsets UNEXIST flag, need to take care of
622    * it here because later this flag is being reset.
623    *
624    * We can't do it for any distribution, because it'll then
625    * conflict with texture influence, which does not free
626    * unexisting particles and only sets flag.
627    *
628    * It's not so bad, because only grid distribution sets
629    * UNEXIST flag.
630    */
631   const bool emit_from_volume_grid = (part->distr == PART_DISTR_GRID) &&
632                                      (!ELEM(part->from, PART_FROM_VERT, PART_FROM_CHILD));
633   PARTICLE_P;
634   LOOP_PARTICLES
635   {
636     if (!(emit_from_volume_grid && (pa->flag & PARS_UNEXIST) != 0)) {
637       initialize_particle(sim, pa);
638     }
639   }
640 }
641
642 static void free_unexisting_particles(ParticleSimulationData *sim)
643 {
644   ParticleSystem *psys = sim->psys;
645   PARTICLE_P;
646
647   psys->totunexist = 0;
648
649   LOOP_PARTICLES
650   {
651     if (pa->flag & PARS_UNEXIST) {
652       psys->totunexist++;
653     }
654   }
655
656   if (psys->totpart && psys->totunexist == psys->totpart) {
657     if (psys->particles->boid) {
658       MEM_freeN(psys->particles->boid);
659     }
660
661     MEM_freeN(psys->particles);
662     psys->particles = NULL;
663     psys->totpart = psys->totunexist = 0;
664   }
665
666   if (psys->totunexist) {
667     int newtotpart = psys->totpart - psys->totunexist;
668     ParticleData *npa, *newpars;
669
670     npa = newpars = MEM_callocN(newtotpart * sizeof(ParticleData), "particles");
671
672     for (p = 0, pa = psys->particles; p < newtotpart; p++, pa++, npa++) {
673       while (pa->flag & PARS_UNEXIST) {
674         pa++;
675       }
676
677       memcpy(npa, pa, sizeof(ParticleData));
678     }
679
680     if (psys->particles->boid) {
681       MEM_freeN(psys->particles->boid);
682     }
683     MEM_freeN(psys->particles);
684     psys->particles = newpars;
685     psys->totpart -= psys->totunexist;
686
687     if (psys->particles->boid) {
688       BoidParticle *newboids = MEM_callocN(psys->totpart * sizeof(BoidParticle), "boid particles");
689
690       LOOP_PARTICLES
691       {
692         pa->boid = newboids++;
693       }
694     }
695   }
696 }
697
698 static void get_angular_velocity_vector(short avemode, ParticleKey *state, float vec[3])
699 {
700   switch (avemode) {
701     case PART_AVE_VELOCITY:
702       copy_v3_v3(vec, state->vel);
703       break;
704     case PART_AVE_HORIZONTAL: {
705       float zvec[3];
706       zvec[0] = zvec[1] = 0;
707       zvec[2] = 1.f;
708       cross_v3_v3v3(vec, state->vel, zvec);
709       break;
710     }
711     case PART_AVE_VERTICAL: {
712       float zvec[3], temp[3];
713       zvec[0] = zvec[1] = 0;
714       zvec[2] = 1.f;
715       cross_v3_v3v3(temp, state->vel, zvec);
716       cross_v3_v3v3(vec, temp, state->vel);
717       break;
718     }
719     case PART_AVE_GLOBAL_X:
720       vec[0] = 1.f;
721       vec[1] = vec[2] = 0;
722       break;
723     case PART_AVE_GLOBAL_Y:
724       vec[1] = 1.f;
725       vec[0] = vec[2] = 0;
726       break;
727     case PART_AVE_GLOBAL_Z:
728       vec[2] = 1.f;
729       vec[0] = vec[1] = 0;
730       break;
731   }
732 }
733
734 void psys_get_birth_coords(
735     ParticleSimulationData *sim, ParticleData *pa, ParticleKey *state, float dtime, float cfra)
736 {
737   Object *ob = sim->ob;
738   ParticleSystem *psys = sim->psys;
739   ParticleSettings *part = psys->part;
740   ParticleTexture ptex;
741   float fac, phasefac, nor[3] = {0, 0, 0}, loc[3], vel[3] = {0.0, 0.0, 0.0}, rot[4], q2[4];
742   float r_vel[3], r_ave[3], r_rot[4], vec[3], p_vel[3] = {0.0, 0.0, 0.0};
743   float x_vec[3] = {1.0, 0.0, 0.0}, utan[3] = {0.0, 1.0, 0.0}, vtan[3] = {0.0, 0.0, 1.0},
744         rot_vec[3] = {0.0, 0.0, 0.0};
745   float q_phase[4];
746
747   const bool use_boids = ((part->phystype == PART_PHYS_BOIDS) && (pa->boid != NULL));
748   const bool use_tangents = ((use_boids == false) &&
749                              ((part->tanfac != 0.0f) || (part->rotmode == PART_ROT_NOR_TAN)));
750
751   int p = pa - psys->particles;
752
753   /* get birth location from object       */
754   if (use_tangents) {
755     psys_particle_on_emitter(sim->psmd,
756                              part->from,
757                              pa->num,
758                              pa->num_dmcache,
759                              pa->fuv,
760                              pa->foffset,
761                              loc,
762                              nor,
763                              utan,
764                              vtan,
765                              0);
766   }
767   else {
768     psys_particle_on_emitter(
769         sim->psmd, part->from, pa->num, pa->num_dmcache, pa->fuv, pa->foffset, loc, nor, 0, 0, 0);
770   }
771
772   /* get possible textural influence */
773   psys_get_texture(sim, pa, &ptex, PAMAP_IVEL, cfra);
774
775   /* particles live in global space so    */
776   /* let's convert:                       */
777   /* -location                            */
778   mul_m4_v3(ob->obmat, loc);
779
780   /* -normal                              */
781   mul_mat3_m4_v3(ob->obmat, nor);
782   normalize_v3(nor);
783
784   /* -tangent                             */
785   if (use_tangents) {
786 #if 0
787     float phase = vg_rot ?
788                       2.0f *
789                           (psys_particle_value_from_verts(sim->psmd->dm, part->from, pa, vg_rot) -
790                            0.5f) :
791                       0.0f;
792 #else
793     float phase = 0.0f;
794 #endif
795     mul_v3_fl(vtan, -cosf((float)M_PI * (part->tanphase + phase)));
796     fac = -sinf((float)M_PI * (part->tanphase + phase));
797     madd_v3_v3fl(vtan, utan, fac);
798
799     mul_mat3_m4_v3(ob->obmat, vtan);
800
801     copy_v3_v3(utan, nor);
802     mul_v3_fl(utan, dot_v3v3(vtan, nor));
803     sub_v3_v3(vtan, utan);
804
805     normalize_v3(vtan);
806   }
807
808   /* -velocity (boids need this even if there's no random velocity) */
809   if (part->randfac != 0.0f || (part->phystype == PART_PHYS_BOIDS && pa->boid)) {
810     r_vel[0] = 2.0f * (psys_frand(psys, p + 10) - 0.5f);
811     r_vel[1] = 2.0f * (psys_frand(psys, p + 11) - 0.5f);
812     r_vel[2] = 2.0f * (psys_frand(psys, p + 12) - 0.5f);
813
814     mul_mat3_m4_v3(ob->obmat, r_vel);
815     normalize_v3(r_vel);
816   }
817
818   /* -angular velocity                    */
819   if (part->avemode == PART_AVE_RAND) {
820     r_ave[0] = 2.0f * (psys_frand(psys, p + 13) - 0.5f);
821     r_ave[1] = 2.0f * (psys_frand(psys, p + 14) - 0.5f);
822     r_ave[2] = 2.0f * (psys_frand(psys, p + 15) - 0.5f);
823
824     mul_mat3_m4_v3(ob->obmat, r_ave);
825     normalize_v3(r_ave);
826   }
827
828   /* -rotation                            */
829   if (part->randrotfac != 0.0f) {
830     r_rot[0] = 2.0f * (psys_frand(psys, p + 16) - 0.5f);
831     r_rot[1] = 2.0f * (psys_frand(psys, p + 17) - 0.5f);
832     r_rot[2] = 2.0f * (psys_frand(psys, p + 18) - 0.5f);
833     r_rot[3] = 2.0f * (psys_frand(psys, p + 19) - 0.5f);
834     normalize_qt(r_rot);
835
836     mat4_to_quat(rot, ob->obmat);
837     mul_qt_qtqt(r_rot, r_rot, rot);
838   }
839
840   if (use_boids) {
841     float dvec[3], q[4], mat[3][3];
842
843     copy_v3_v3(state->co, loc);
844
845     /* boids don't get any initial velocity  */
846     zero_v3(state->vel);
847
848     /* boids store direction in ave */
849     if (fabsf(nor[2]) == 1.0f) {
850       sub_v3_v3v3(state->ave, loc, ob->obmat[3]);
851       normalize_v3(state->ave);
852     }
853     else {
854       copy_v3_v3(state->ave, nor);
855     }
856
857     /* calculate rotation matrix */
858     project_v3_v3v3(dvec, r_vel, state->ave);
859     sub_v3_v3v3(mat[0], state->ave, dvec);
860     normalize_v3(mat[0]);
861     negate_v3_v3(mat[2], r_vel);
862     normalize_v3(mat[2]);
863     cross_v3_v3v3(mat[1], mat[2], mat[0]);
864
865     /* apply rotation */
866     mat3_to_quat_is_ok(q, mat);
867     copy_qt_qt(state->rot, q);
868   }
869   else {
870     /* conversion done so now we apply new: */
871     /* -velocity from:                      */
872
873     /*      *reactions                      */
874     if (dtime > 0.f) {
875       sub_v3_v3v3(vel, pa->state.vel, pa->prev_state.vel);
876     }
877
878     /*      *emitter velocity               */
879     if (dtime != 0.f && part->obfac != 0.f) {
880       sub_v3_v3v3(vel, loc, state->co);
881       mul_v3_fl(vel, part->obfac / dtime);
882     }
883
884     /*      *emitter normal                 */
885     if (part->normfac != 0.f) {
886       madd_v3_v3fl(vel, nor, part->normfac);
887     }
888
889     /*      *emitter tangent                */
890     if (sim->psmd && part->tanfac != 0.f) {
891       madd_v3_v3fl(vel, vtan, part->tanfac);
892     }
893
894     /*      *emitter object orientation     */
895     if (part->ob_vel[0] != 0.f) {
896       normalize_v3_v3(vec, ob->obmat[0]);
897       madd_v3_v3fl(vel, vec, part->ob_vel[0]);
898     }
899     if (part->ob_vel[1] != 0.f) {
900       normalize_v3_v3(vec, ob->obmat[1]);
901       madd_v3_v3fl(vel, vec, part->ob_vel[1]);
902     }
903     if (part->ob_vel[2] != 0.f) {
904       normalize_v3_v3(vec, ob->obmat[2]);
905       madd_v3_v3fl(vel, vec, part->ob_vel[2]);
906     }
907
908     /*      *texture                        */
909     /* TODO */
910
911     /*      *random                         */
912     if (part->randfac != 0.f) {
913       madd_v3_v3fl(vel, r_vel, part->randfac);
914     }
915
916     /*      *particle                       */
917     if (part->partfac != 0.f) {
918       madd_v3_v3fl(vel, p_vel, part->partfac);
919     }
920
921     mul_v3_v3fl(state->vel, vel, ptex.ivel);
922
923     /* -location from emitter               */
924     copy_v3_v3(state->co, loc);
925
926     /* -rotation                            */
927     unit_qt(state->rot);
928
929     if (part->rotmode) {
930       bool use_global_space;
931
932       /* create vector into which rotation is aligned */
933       switch (part->rotmode) {
934         case PART_ROT_NOR:
935         case PART_ROT_NOR_TAN:
936           copy_v3_v3(rot_vec, nor);
937           use_global_space = false;
938           break;
939         case PART_ROT_VEL:
940           copy_v3_v3(rot_vec, vel);
941           use_global_space = true;
942           break;
943         case PART_ROT_GLOB_X:
944         case PART_ROT_GLOB_Y:
945         case PART_ROT_GLOB_Z:
946           rot_vec[part->rotmode - PART_ROT_GLOB_X] = 1.0f;
947           use_global_space = true;
948           break;
949         case PART_ROT_OB_X:
950         case PART_ROT_OB_Y:
951         case PART_ROT_OB_Z:
952           copy_v3_v3(rot_vec, ob->obmat[part->rotmode - PART_ROT_OB_X]);
953           use_global_space = false;
954           break;
955         default:
956           use_global_space = true;
957           break;
958       }
959
960       /* create rotation quat */
961
962       if (use_global_space) {
963         negate_v3(rot_vec);
964         vec_to_quat(q2, rot_vec, OB_POSX, OB_POSZ);
965
966         /* randomize rotation quat */
967         if (part->randrotfac != 0.0f) {
968           interp_qt_qtqt(rot, q2, r_rot, part->randrotfac);
969         }
970         else {
971           copy_qt_qt(rot, q2);
972         }
973       }
974       else {
975         /* calculate rotation in local-space */
976         float q_obmat[4];
977         float q_imat[4];
978
979         mat4_to_quat(q_obmat, ob->obmat);
980         invert_qt_qt_normalized(q_imat, q_obmat);
981
982         if (part->rotmode != PART_ROT_NOR_TAN) {
983           float rot_vec_local[3];
984
985           /* rot_vec */
986           negate_v3(rot_vec);
987           copy_v3_v3(rot_vec_local, rot_vec);
988           mul_qt_v3(q_imat, rot_vec_local);
989           normalize_v3(rot_vec_local);
990
991           vec_to_quat(q2, rot_vec_local, OB_POSX, OB_POSZ);
992         }
993         else {
994           /* (part->rotmode == PART_ROT_NOR_TAN) */
995           float tmat[3][3];
996
997           /* note: utan_local is not taken from 'utan', we calculate from rot_vec/vtan */
998           /* note: it looks like rotation phase may be applied twice (once with vtan, again below)
999            * however this isn't the case - campbell */
1000           float *rot_vec_local = tmat[0];
1001           float *vtan_local = tmat[1];
1002           float *utan_local = tmat[2];
1003
1004           /* use tangents */
1005           BLI_assert(use_tangents == true);
1006
1007           /* rot_vec */
1008           copy_v3_v3(rot_vec_local, rot_vec);
1009           mul_qt_v3(q_imat, rot_vec_local);
1010
1011           /* vtan_local */
1012           copy_v3_v3(vtan_local, vtan); /* flips, cant use */
1013           mul_qt_v3(q_imat, vtan_local);
1014
1015           /* ensure orthogonal matrix (rot_vec aligned) */
1016           cross_v3_v3v3(utan_local, vtan_local, rot_vec_local);
1017           cross_v3_v3v3(vtan_local, utan_local, rot_vec_local);
1018
1019           /* note: no need to normalize */
1020           mat3_to_quat(q2, tmat);
1021         }
1022
1023         /* randomize rotation quat */
1024         if (part->randrotfac != 0.0f) {
1025           mul_qt_qtqt(r_rot, r_rot, q_imat);
1026           interp_qt_qtqt(rot, q2, r_rot, part->randrotfac);
1027         }
1028         else {
1029           copy_qt_qt(rot, q2);
1030         }
1031
1032         mul_qt_qtqt(rot, q_obmat, rot);
1033       }
1034
1035       /* rotation phase */
1036       phasefac = part->phasefac;
1037       if (part->randphasefac != 0.0f) {
1038         phasefac += part->randphasefac * psys_frand(psys, p + 20);
1039       }
1040       axis_angle_to_quat(q_phase, x_vec, phasefac * (float)M_PI);
1041
1042       /* combine base rotation & phase */
1043       mul_qt_qtqt(state->rot, rot, q_phase);
1044     }
1045
1046     /* -angular velocity                    */
1047
1048     zero_v3(state->ave);
1049
1050     if (part->avemode) {
1051       if (part->avemode == PART_AVE_RAND) {
1052         copy_v3_v3(state->ave, r_ave);
1053       }
1054       else {
1055         get_angular_velocity_vector(part->avemode, state, state->ave);
1056       }
1057
1058       normalize_v3(state->ave);
1059       mul_v3_fl(state->ave, part->avefac);
1060     }
1061   }
1062 }
1063
1064 /* recursively evaluate emitter parent anim at cfra */
1065 static void evaluate_emitter_anim(struct Depsgraph *depsgraph,
1066                                   Scene *scene,
1067                                   Object *ob,
1068                                   float cfra)
1069 {
1070   if (ob->parent) {
1071     evaluate_emitter_anim(depsgraph, scene, ob->parent, cfra);
1072   }
1073
1074   BKE_object_where_is_calc_time(depsgraph, scene, ob, cfra);
1075 }
1076
1077 /* sets particle to the emitter surface with initial velocity & rotation */
1078 void reset_particle(ParticleSimulationData *sim, ParticleData *pa, float dtime, float cfra)
1079 {
1080   ParticleSystem *psys = sim->psys;
1081   ParticleSettings *part;
1082   ParticleTexture ptex;
1083   int p = pa - psys->particles;
1084   part = psys->part;
1085
1086   /* get precise emitter matrix if particle is born */
1087   if (part->type != PART_HAIR && dtime > 0.f && pa->time < cfra && pa->time >= sim->psys->cfra) {
1088     evaluate_emitter_anim(sim->depsgraph, sim->scene, sim->ob, pa->time);
1089
1090     psys->flag |= PSYS_OB_ANIM_RESTORE;
1091   }
1092
1093   psys_get_birth_coords(sim, pa, &pa->state, dtime, cfra);
1094
1095   /* Initialize particle settings which depends on texture.
1096    *
1097    * We could only do it now because we'll need to know coordinate
1098    * before sampling the texture.
1099    */
1100   initialize_particle_texture(sim, pa, p);
1101
1102   if (part->phystype == PART_PHYS_BOIDS && pa->boid) {
1103     BoidParticle *bpa = pa->boid;
1104
1105     /* and gravity in r_ve */
1106     bpa->gravity[0] = bpa->gravity[1] = 0.0f;
1107     bpa->gravity[2] = -1.0f;
1108     if ((sim->scene->physics_settings.flag & PHYS_GLOBAL_GRAVITY) &&
1109         (sim->scene->physics_settings.gravity[2] != 0.0f)) {
1110       bpa->gravity[2] = sim->scene->physics_settings.gravity[2];
1111     }
1112
1113     bpa->data.health = part->boids->health;
1114     bpa->data.mode = eBoidMode_InAir;
1115     bpa->data.state_id = ((BoidState *)part->boids->states.first)->id;
1116     bpa->data.acc[0] = bpa->data.acc[1] = bpa->data.acc[2] = 0.0f;
1117   }
1118
1119   if (part->type == PART_HAIR) {
1120     pa->lifetime = 100.0f;
1121   }
1122   else {
1123     /* initialize the lifetime, in case the texture coordinates
1124      * are from Particles/Strands, which would cause undefined values
1125      */
1126     pa->lifetime = part->lifetime * (1.0f - part->randlife * psys_frand(psys, p + 21));
1127     pa->dietime = pa->time + pa->lifetime;
1128
1129     /* get possible textural influence */
1130     psys_get_texture(sim, pa, &ptex, PAMAP_LIFE, cfra);
1131
1132     pa->lifetime = part->lifetime * ptex.life;
1133
1134     if (part->randlife != 0.0f) {
1135       pa->lifetime *= 1.0f - part->randlife * psys_frand(psys, p + 21);
1136     }
1137   }
1138
1139   pa->dietime = pa->time + pa->lifetime;
1140
1141   if ((sim->psys->pointcache) && (sim->psys->pointcache->flag & PTCACHE_BAKED) &&
1142       (sim->psys->pointcache->mem_cache.first)) {
1143     float dietime = psys_get_dietime_from_cache(sim->psys->pointcache, p);
1144     pa->dietime = MIN2(pa->dietime, dietime);
1145   }
1146
1147   if (pa->time > cfra) {
1148     pa->alive = PARS_UNBORN;
1149   }
1150   else if (pa->dietime <= cfra) {
1151     pa->alive = PARS_DEAD;
1152   }
1153   else {
1154     pa->alive = PARS_ALIVE;
1155   }
1156
1157   pa->state.time = cfra;
1158 }
1159 static void reset_all_particles(ParticleSimulationData *sim, float dtime, float cfra, int from)
1160 {
1161   ParticleData *pa;
1162   int p, totpart = sim->psys->totpart;
1163
1164   for (p = from, pa = sim->psys->particles + from; p < totpart; p++, pa++) {
1165     reset_particle(sim, pa, dtime, cfra);
1166   }
1167 }
1168 /************************************************/
1169 /*          Particle targets                    */
1170 /************************************************/
1171 ParticleSystem *psys_get_target_system(Object *ob, ParticleTarget *pt)
1172 {
1173   ParticleSystem *psys = NULL;
1174
1175   if (pt->ob == NULL || pt->ob == ob) {
1176     psys = BLI_findlink(&ob->particlesystem, pt->psys - 1);
1177   }
1178   else {
1179     psys = BLI_findlink(&pt->ob->particlesystem, pt->psys - 1);
1180   }
1181
1182   if (psys) {
1183     pt->flag |= PTARGET_VALID;
1184   }
1185   else {
1186     pt->flag &= ~PTARGET_VALID;
1187   }
1188
1189   return psys;
1190 }
1191 /************************************************/
1192 /*          Keyed particles                     */
1193 /************************************************/
1194 /* Counts valid keyed targets */
1195 void psys_count_keyed_targets(ParticleSimulationData *sim)
1196 {
1197   ParticleSystem *psys = sim->psys, *kpsys;
1198   ParticleTarget *pt = psys->targets.first;
1199   int keys_valid = 1;
1200   psys->totkeyed = 0;
1201
1202   for (; pt; pt = pt->next) {
1203     kpsys = psys_get_target_system(sim->ob, pt);
1204
1205     if (kpsys && kpsys->totpart) {
1206       psys->totkeyed += keys_valid;
1207       if (psys->flag & PSYS_KEYED_TIMING && pt->duration != 0.0f) {
1208         psys->totkeyed += 1;
1209       }
1210     }
1211     else {
1212       keys_valid = 0;
1213     }
1214   }
1215
1216   psys->totkeyed *= psys->flag & PSYS_KEYED_TIMING ? 1 : psys->part->keyed_loops;
1217 }
1218
1219 static void set_keyed_keys(ParticleSimulationData *sim)
1220 {
1221   ParticleSystem *psys = sim->psys;
1222   ParticleSimulationData ksim = {0};
1223   ParticleTarget *pt;
1224   PARTICLE_P;
1225   ParticleKey *key;
1226   int totpart = psys->totpart, k, totkeys = psys->totkeyed;
1227   int keyed_flag = 0;
1228
1229   ksim.depsgraph = sim->depsgraph;
1230   ksim.scene = sim->scene;
1231
1232   /* no proper targets so let's clear and bail out */
1233   if (psys->totkeyed == 0) {
1234     free_keyed_keys(psys);
1235     psys->flag &= ~PSYS_KEYED;
1236     return;
1237   }
1238
1239   if (totpart && psys->particles->totkey != totkeys) {
1240     free_keyed_keys(psys);
1241
1242     key = MEM_callocN(totpart * totkeys * sizeof(ParticleKey), "Keyed keys");
1243
1244     LOOP_PARTICLES
1245     {
1246       pa->keys = key;
1247       pa->totkey = totkeys;
1248       key += totkeys;
1249     }
1250   }
1251
1252   psys->flag &= ~PSYS_KEYED;
1253
1254   pt = psys->targets.first;
1255   for (k = 0; k < totkeys; k++) {
1256     ksim.ob = pt->ob ? pt->ob : sim->ob;
1257     ksim.psys = BLI_findlink(&ksim.ob->particlesystem, pt->psys - 1);
1258     keyed_flag = (ksim.psys->flag & PSYS_KEYED);
1259     ksim.psys->flag &= ~PSYS_KEYED;
1260
1261     LOOP_PARTICLES
1262     {
1263       key = pa->keys + k;
1264       key->time = -1.0; /* use current time */
1265
1266       psys_get_particle_state(&ksim, p % ksim.psys->totpart, key, 1);
1267
1268       if (psys->flag & PSYS_KEYED_TIMING) {
1269         key->time = pa->time + pt->time;
1270         if (pt->duration != 0.0f && k + 1 < totkeys) {
1271           copy_particle_key(key + 1, key, 1);
1272           (key + 1)->time = pa->time + pt->time + pt->duration;
1273         }
1274       }
1275       else if (totkeys > 1) {
1276         key->time = pa->time + (float)k / (float)(totkeys - 1) * pa->lifetime;
1277       }
1278       else {
1279         key->time = pa->time;
1280       }
1281     }
1282
1283     if (psys->flag & PSYS_KEYED_TIMING && pt->duration != 0.0f) {
1284       k++;
1285     }
1286
1287     ksim.psys->flag |= keyed_flag;
1288
1289     pt = (pt->next && pt->next->flag & PTARGET_VALID) ? pt->next : psys->targets.first;
1290   }
1291
1292   psys->flag |= PSYS_KEYED;
1293 }
1294
1295 /************************************************/
1296 /*          Point Cache                         */
1297 /************************************************/
1298 void psys_make_temp_pointcache(Object *ob, ParticleSystem *psys)
1299 {
1300   PointCache *cache = psys->pointcache;
1301
1302   if (cache->flag & PTCACHE_DISK_CACHE && BLI_listbase_is_empty(&cache->mem_cache)) {
1303     PTCacheID pid;
1304     BKE_ptcache_id_from_particles(&pid, ob, psys);
1305     cache->flag &= ~PTCACHE_DISK_CACHE;
1306     BKE_ptcache_disk_to_mem(&pid);
1307     cache->flag |= PTCACHE_DISK_CACHE;
1308   }
1309 }
1310 static void psys_clear_temp_pointcache(ParticleSystem *psys)
1311 {
1312   if (psys->pointcache->flag & PTCACHE_DISK_CACHE) {
1313     BKE_ptcache_free_mem(&psys->pointcache->mem_cache);
1314   }
1315 }
1316 void psys_get_pointcache_start_end(Scene *scene, ParticleSystem *psys, int *sfra, int *efra)
1317 {
1318   ParticleSettings *part = psys->part;
1319
1320   *sfra = max_ii(1, (int)part->sta);
1321   *efra = min_ii((int)(part->end + part->lifetime + 1.0f), max_ii(scene->r.pefra, scene->r.efra));
1322 }
1323
1324 /************************************************/
1325 /*          Effectors                           */
1326 /************************************************/
1327 static void psys_update_particle_bvhtree(ParticleSystem *psys, float cfra)
1328 {
1329   if (psys) {
1330     PARTICLE_P;
1331     int totpart = 0;
1332     bool need_rebuild;
1333
1334     BLI_rw_mutex_lock(&psys_bvhtree_rwlock, THREAD_LOCK_READ);
1335     need_rebuild = !psys->bvhtree || psys->bvhtree_frame != cfra;
1336     BLI_rw_mutex_unlock(&psys_bvhtree_rwlock);
1337
1338     if (need_rebuild) {
1339       LOOP_SHOWN_PARTICLES
1340       {
1341         totpart++;
1342       }
1343
1344       BLI_rw_mutex_lock(&psys_bvhtree_rwlock, THREAD_LOCK_WRITE);
1345
1346       BLI_bvhtree_free(psys->bvhtree);
1347       psys->bvhtree = BLI_bvhtree_new(totpart, 0.0, 4, 6);
1348
1349       LOOP_SHOWN_PARTICLES
1350       {
1351         if (pa->alive == PARS_ALIVE) {
1352           if (pa->state.time == cfra) {
1353             BLI_bvhtree_insert(psys->bvhtree, p, pa->prev_state.co, 1);
1354           }
1355           else {
1356             BLI_bvhtree_insert(psys->bvhtree, p, pa->state.co, 1);
1357           }
1358         }
1359       }
1360       BLI_bvhtree_balance(psys->bvhtree);
1361
1362       psys->bvhtree_frame = cfra;
1363
1364       BLI_rw_mutex_unlock(&psys_bvhtree_rwlock);
1365     }
1366   }
1367 }
1368 void psys_update_particle_tree(ParticleSystem *psys, float cfra)
1369 {
1370   if (psys) {
1371     PARTICLE_P;
1372     int totpart = 0;
1373
1374     if (!psys->tree || psys->tree_frame != cfra) {
1375       LOOP_SHOWN_PARTICLES
1376       {
1377         totpart++;
1378       }
1379
1380       BLI_kdtree_3d_free(psys->tree);
1381       psys->tree = BLI_kdtree_3d_new(psys->totpart);
1382
1383       LOOP_SHOWN_PARTICLES
1384       {
1385         if (pa->alive == PARS_ALIVE) {
1386           if (pa->state.time == cfra) {
1387             BLI_kdtree_3d_insert(psys->tree, p, pa->prev_state.co);
1388           }
1389           else {
1390             BLI_kdtree_3d_insert(psys->tree, p, pa->state.co);
1391           }
1392         }
1393       }
1394       BLI_kdtree_3d_balance(psys->tree);
1395
1396       psys->tree_frame = cfra;
1397     }
1398   }
1399 }
1400
1401 static void psys_update_effectors(ParticleSimulationData *sim)
1402 {
1403   BKE_effectors_free(sim->psys->effectors);
1404   sim->psys->effectors = BKE_effectors_create(
1405       sim->depsgraph, sim->ob, sim->psys, sim->psys->part->effector_weights);
1406   precalc_guides(sim, sim->psys->effectors);
1407 }
1408
1409 static void integrate_particle(
1410     ParticleSettings *part,
1411     ParticleData *pa,
1412     float dtime,
1413     float *external_acceleration,
1414     void (*force_func)(void *forcedata, ParticleKey *state, float *force, float *impulse),
1415     void *forcedata)
1416 {
1417 #define ZERO_F43 \
1418   { \
1419     {0.0f, 0.0f, 0.0f}, {0.0f, 0.0f, 0.0f}, {0.0f, 0.0f, 0.0f}, \
1420     { \
1421       0.0f, 0.0f, 0.0f \
1422     } \
1423   }
1424
1425   ParticleKey states[5];
1426   float force[3], acceleration[3], impulse[3], dx[4][3] = ZERO_F43, dv[4][3] = ZERO_F43, oldpos[3];
1427   float pa_mass = (part->flag & PART_SIZEMASS ? part->mass * pa->size : part->mass);
1428   int i, steps = 1;
1429   int integrator = part->integrator;
1430
1431 #undef ZERO_F43
1432
1433   copy_v3_v3(oldpos, pa->state.co);
1434
1435   /* Verlet integration behaves strangely with moving emitters, so do first step with euler. */
1436   if (pa->prev_state.time < 0.f && integrator == PART_INT_VERLET) {
1437     integrator = PART_INT_EULER;
1438   }
1439
1440   switch (integrator) {
1441     case PART_INT_EULER:
1442       steps = 1;
1443       break;
1444     case PART_INT_MIDPOINT:
1445       steps = 2;
1446       break;
1447     case PART_INT_RK4:
1448       steps = 4;
1449       break;
1450     case PART_INT_VERLET:
1451       steps = 1;
1452       break;
1453   }
1454
1455   for (i = 0; i < steps; i++) {
1456     copy_particle_key(states + i, &pa->state, 1);
1457   }
1458
1459   states->time = 0.f;
1460
1461   for (i = 0; i < steps; i++) {
1462     zero_v3(force);
1463     zero_v3(impulse);
1464
1465     force_func(forcedata, states + i, force, impulse);
1466
1467     /* force to acceleration*/
1468     mul_v3_v3fl(acceleration, force, 1.0f / pa_mass);
1469
1470     if (external_acceleration) {
1471       add_v3_v3(acceleration, external_acceleration);
1472     }
1473
1474     /* calculate next state */
1475     add_v3_v3(states[i].vel, impulse);
1476
1477     switch (integrator) {
1478       case PART_INT_EULER:
1479         madd_v3_v3v3fl(pa->state.co, states->co, states->vel, dtime);
1480         madd_v3_v3v3fl(pa->state.vel, states->vel, acceleration, dtime);
1481         break;
1482       case PART_INT_MIDPOINT:
1483         if (i == 0) {
1484           madd_v3_v3v3fl(states[1].co, states->co, states->vel, dtime * 0.5f);
1485           madd_v3_v3v3fl(states[1].vel, states->vel, acceleration, dtime * 0.5f);
1486           states[1].time = dtime * 0.5f;
1487           /*fra=sim->psys->cfra+0.5f*dfra;*/
1488         }
1489         else {
1490           madd_v3_v3v3fl(pa->state.co, states->co, states[1].vel, dtime);
1491           madd_v3_v3v3fl(pa->state.vel, states->vel, acceleration, dtime);
1492         }
1493         break;
1494       case PART_INT_RK4:
1495         switch (i) {
1496           case 0:
1497             copy_v3_v3(dx[0], states->vel);
1498             mul_v3_fl(dx[0], dtime);
1499             copy_v3_v3(dv[0], acceleration);
1500             mul_v3_fl(dv[0], dtime);
1501
1502             madd_v3_v3v3fl(states[1].co, states->co, dx[0], 0.5f);
1503             madd_v3_v3v3fl(states[1].vel, states->vel, dv[0], 0.5f);
1504             states[1].time = dtime * 0.5f;
1505             /*fra=sim->psys->cfra+0.5f*dfra;*/
1506             break;
1507           case 1:
1508             madd_v3_v3v3fl(dx[1], states->vel, dv[0], 0.5f);
1509             mul_v3_fl(dx[1], dtime);
1510             copy_v3_v3(dv[1], acceleration);
1511             mul_v3_fl(dv[1], dtime);
1512
1513             madd_v3_v3v3fl(states[2].co, states->co, dx[1], 0.5f);
1514             madd_v3_v3v3fl(states[2].vel, states->vel, dv[1], 0.5f);
1515             states[2].time = dtime * 0.5f;
1516             break;
1517           case 2:
1518             madd_v3_v3v3fl(dx[2], states->vel, dv[1], 0.5f);
1519             mul_v3_fl(dx[2], dtime);
1520             copy_v3_v3(dv[2], acceleration);
1521             mul_v3_fl(dv[2], dtime);
1522
1523             add_v3_v3v3(states[3].co, states->co, dx[2]);
1524             add_v3_v3v3(states[3].vel, states->vel, dv[2]);
1525             states[3].time = dtime;
1526             /*fra=cfra;*/
1527             break;
1528           case 3:
1529             add_v3_v3v3(dx[3], states->vel, dv[2]);
1530             mul_v3_fl(dx[3], dtime);
1531             copy_v3_v3(dv[3], acceleration);
1532             mul_v3_fl(dv[3], dtime);
1533
1534             madd_v3_v3v3fl(pa->state.co, states->co, dx[0], 1.0f / 6.0f);
1535             madd_v3_v3fl(pa->state.co, dx[1], 1.0f / 3.0f);
1536             madd_v3_v3fl(pa->state.co, dx[2], 1.0f / 3.0f);
1537             madd_v3_v3fl(pa->state.co, dx[3], 1.0f / 6.0f);
1538
1539             madd_v3_v3v3fl(pa->state.vel, states->vel, dv[0], 1.0f / 6.0f);
1540             madd_v3_v3fl(pa->state.vel, dv[1], 1.0f / 3.0f);
1541             madd_v3_v3fl(pa->state.vel, dv[2], 1.0f / 3.0f);
1542             madd_v3_v3fl(pa->state.vel, dv[3], 1.0f / 6.0f);
1543         }
1544         break;
1545       case PART_INT_VERLET: /* Verlet integration */
1546         madd_v3_v3v3fl(pa->state.vel, pa->prev_state.vel, acceleration, dtime);
1547         madd_v3_v3v3fl(pa->state.co, pa->prev_state.co, pa->state.vel, dtime);
1548
1549         sub_v3_v3v3(pa->state.vel, pa->state.co, oldpos);
1550         mul_v3_fl(pa->state.vel, 1.0f / dtime);
1551         break;
1552     }
1553   }
1554 }
1555
1556 /* -------------------------------------------------------------------- */
1557 /** \name SPH fluid physics
1558  *
1559  * In theory, there could be unlimited implementation of SPH simulators
1560  *
1561  * This code uses in some parts adapted algorithms
1562  * from the pseudo code as outlined in the Research paper:
1563  *
1564  * Titled: Particle-based Viscoelastic Fluid Simulation.
1565  * Authors: Simon Clavet, Philippe Beaudoin and Pierre Poulin
1566  * Website: http://www.iro.umontreal.ca/labs/infographie/papers/Clavet-2005-PVFS/
1567  *
1568  * Presented at Siggraph, (2005)
1569  *
1570  * \{ */
1571
1572 #define PSYS_FLUID_SPRINGS_INITIAL_SIZE 256
1573 static ParticleSpring *sph_spring_add(ParticleSystem *psys, ParticleSpring *spring)
1574 {
1575   /* Are more refs required? */
1576   if (psys->alloc_fluidsprings == 0 || psys->fluid_springs == NULL) {
1577     psys->alloc_fluidsprings = PSYS_FLUID_SPRINGS_INITIAL_SIZE;
1578     psys->fluid_springs = (ParticleSpring *)MEM_callocN(
1579         psys->alloc_fluidsprings * sizeof(ParticleSpring), "Particle Fluid Springs");
1580   }
1581   else if (psys->tot_fluidsprings == psys->alloc_fluidsprings) {
1582     /* Double the number of refs allocated */
1583     psys->alloc_fluidsprings *= 2;
1584     psys->fluid_springs = (ParticleSpring *)MEM_reallocN(
1585         psys->fluid_springs, psys->alloc_fluidsprings * sizeof(ParticleSpring));
1586   }
1587
1588   memcpy(psys->fluid_springs + psys->tot_fluidsprings, spring, sizeof(ParticleSpring));
1589   psys->tot_fluidsprings++;
1590
1591   return psys->fluid_springs + psys->tot_fluidsprings - 1;
1592 }
1593 static void sph_spring_delete(ParticleSystem *psys, int j)
1594 {
1595   if (j != psys->tot_fluidsprings - 1) {
1596     psys->fluid_springs[j] = psys->fluid_springs[psys->tot_fluidsprings - 1];
1597   }
1598
1599   psys->tot_fluidsprings--;
1600
1601   if (psys->tot_fluidsprings < psys->alloc_fluidsprings / 2 &&
1602       psys->alloc_fluidsprings > PSYS_FLUID_SPRINGS_INITIAL_SIZE) {
1603     psys->alloc_fluidsprings /= 2;
1604     psys->fluid_springs = (ParticleSpring *)MEM_reallocN(
1605         psys->fluid_springs, psys->alloc_fluidsprings * sizeof(ParticleSpring));
1606   }
1607 }
1608 static void sph_springs_modify(ParticleSystem *psys, float dtime)
1609 {
1610   SPHFluidSettings *fluid = psys->part->fluid;
1611   ParticleData *pa1, *pa2;
1612   ParticleSpring *spring = psys->fluid_springs;
1613
1614   float h, d, Rij[3], rij, Lij;
1615   int i;
1616
1617   float yield_ratio = fluid->yield_ratio;
1618   float plasticity = fluid->plasticity_constant;
1619   /* scale things according to dtime */
1620   float timefix = 25.f * dtime;
1621
1622   if ((fluid->flag & SPH_VISCOELASTIC_SPRINGS) == 0 || fluid->spring_k == 0.f) {
1623     return;
1624   }
1625
1626   /* Loop through the springs */
1627   for (i = 0; i < psys->tot_fluidsprings; i++, spring++) {
1628     pa1 = psys->particles + spring->particle_index[0];
1629     pa2 = psys->particles + spring->particle_index[1];
1630
1631     sub_v3_v3v3(Rij, pa2->prev_state.co, pa1->prev_state.co);
1632     rij = normalize_v3(Rij);
1633
1634     /* adjust rest length */
1635     Lij = spring->rest_length;
1636     d = yield_ratio * timefix * Lij;
1637
1638     if (rij > Lij + d) {  // Stretch
1639       spring->rest_length += plasticity * (rij - Lij - d) * timefix;
1640     }
1641     else if (rij < Lij - d) {  // Compress
1642       spring->rest_length -= plasticity * (Lij - d - rij) * timefix;
1643     }
1644
1645     h = 4.f * pa1->size;
1646
1647     if (spring->rest_length > h) {
1648       spring->delete_flag = 1;
1649     }
1650   }
1651
1652   /* Loop through springs backwaqrds - for efficient delete function */
1653   for (i = psys->tot_fluidsprings - 1; i >= 0; i--) {
1654     if (psys->fluid_springs[i].delete_flag) {
1655       sph_spring_delete(psys, i);
1656     }
1657   }
1658 }
1659 static EdgeHash *sph_springhash_build(ParticleSystem *psys)
1660 {
1661   EdgeHash *springhash = NULL;
1662   ParticleSpring *spring;
1663   int i = 0;
1664
1665   springhash = BLI_edgehash_new_ex(__func__, psys->tot_fluidsprings);
1666
1667   for (i = 0, spring = psys->fluid_springs; i < psys->tot_fluidsprings; i++, spring++) {
1668     BLI_edgehash_insert(
1669         springhash, spring->particle_index[0], spring->particle_index[1], POINTER_FROM_INT(i + 1));
1670   }
1671
1672   return springhash;
1673 }
1674
1675 #define SPH_NEIGHBORS 512
1676 typedef struct SPHNeighbor {
1677   ParticleSystem *psys;
1678   int index;
1679 } SPHNeighbor;
1680
1681 typedef struct SPHRangeData {
1682   SPHNeighbor neighbors[SPH_NEIGHBORS];
1683   int tot_neighbors;
1684
1685   float *data;
1686
1687   ParticleSystem *npsys;
1688   ParticleData *pa;
1689
1690   float h;
1691   float mass;
1692   float massfac;
1693   int use_size;
1694 } SPHRangeData;
1695
1696 static void sph_evaluate_func(BVHTree *tree,
1697                               ParticleSystem **psys,
1698                               float co[3],
1699                               SPHRangeData *pfr,
1700                               float interaction_radius,
1701                               BVHTree_RangeQuery callback)
1702 {
1703   int i;
1704
1705   pfr->tot_neighbors = 0;
1706
1707   for (i = 0; i < 10 && psys[i]; i++) {
1708     pfr->npsys = psys[i];
1709     pfr->massfac = psys[i]->part->mass / pfr->mass;
1710     pfr->use_size = psys[i]->part->flag & PART_SIZEMASS;
1711
1712     if (tree) {
1713       BLI_bvhtree_range_query(tree, co, interaction_radius, callback, pfr);
1714       break;
1715     }
1716     else {
1717       BLI_rw_mutex_lock(&psys_bvhtree_rwlock, THREAD_LOCK_READ);
1718
1719       BLI_bvhtree_range_query(psys[i]->bvhtree, co, interaction_radius, callback, pfr);
1720
1721       BLI_rw_mutex_unlock(&psys_bvhtree_rwlock);
1722     }
1723   }
1724 }
1725 static void sph_density_accum_cb(void *userdata, int index, const float co[3], float squared_dist)
1726 {
1727   SPHRangeData *pfr = (SPHRangeData *)userdata;
1728   ParticleData *npa = pfr->npsys->particles + index;
1729   float q;
1730   float dist;
1731
1732   UNUSED_VARS(co);
1733
1734   if (npa == pfr->pa || squared_dist < FLT_EPSILON) {
1735     return;
1736   }
1737
1738   /* Ugh! One particle has too many neighbors! If some aren't taken into
1739    * account, the forces will be biased by the tree search order. This
1740    * effectively adds energy to the system, and results in a churning motion.
1741    * But, we have to stop somewhere, and it's not the end of the world.
1742    * - jahka and z0r
1743    */
1744   if (pfr->tot_neighbors >= SPH_NEIGHBORS) {
1745     return;
1746   }
1747
1748   pfr->neighbors[pfr->tot_neighbors].index = index;
1749   pfr->neighbors[pfr->tot_neighbors].psys = pfr->npsys;
1750   pfr->tot_neighbors++;
1751
1752   dist = sqrtf(squared_dist);
1753   q = (1.f - dist / pfr->h) * pfr->massfac;
1754
1755   if (pfr->use_size) {
1756     q *= npa->size;
1757   }
1758
1759   pfr->data[0] += q * q;
1760   pfr->data[1] += q * q * q;
1761 }
1762
1763 /*
1764  * Find the Courant number for an SPH particle (used for adaptive time step).
1765  */
1766 static void sph_particle_courant(SPHData *sphdata, SPHRangeData *pfr)
1767 {
1768   ParticleData *pa, *npa;
1769   int i;
1770   float flow[3], offset[3], dist;
1771
1772   zero_v3(flow);
1773
1774   dist = 0.0f;
1775   if (pfr->tot_neighbors > 0) {
1776     pa = pfr->pa;
1777     for (i = 0; i < pfr->tot_neighbors; i++) {
1778       npa = pfr->neighbors[i].psys->particles + pfr->neighbors[i].index;
1779       sub_v3_v3v3(offset, pa->prev_state.co, npa->prev_state.co);
1780       dist += len_v3(offset);
1781       add_v3_v3(flow, npa->prev_state.vel);
1782     }
1783     dist += sphdata->psys[0]->part->fluid->radius;  // TODO: remove this? - z0r
1784     sphdata->element_size = dist / pfr->tot_neighbors;
1785     mul_v3_v3fl(sphdata->flow, flow, 1.0f / pfr->tot_neighbors);
1786   }
1787   else {
1788     sphdata->element_size = FLT_MAX;
1789     copy_v3_v3(sphdata->flow, flow);
1790   }
1791 }
1792 static void sph_force_cb(void *sphdata_v, ParticleKey *state, float *force, float *UNUSED(impulse))
1793 {
1794   SPHData *sphdata = (SPHData *)sphdata_v;
1795   ParticleSystem **psys = sphdata->psys;
1796   ParticleData *pa = sphdata->pa;
1797   SPHFluidSettings *fluid = psys[0]->part->fluid;
1798   ParticleSpring *spring = NULL;
1799   SPHRangeData pfr;
1800   SPHNeighbor *pfn;
1801   float *gravity = sphdata->gravity;
1802   EdgeHash *springhash = sphdata->eh;
1803
1804   float q, u, rij, dv[3];
1805   float pressure, near_pressure;
1806
1807   float visc = fluid->viscosity_omega;
1808   float stiff_visc = fluid->viscosity_beta *
1809                      (fluid->flag & SPH_FAC_VISCOSITY ? fluid->viscosity_omega : 1.f);
1810
1811   float inv_mass = 1.0f / sphdata->mass;
1812   float spring_constant = fluid->spring_k;
1813
1814   /* 4.0 seems to be a pretty good value */
1815   float interaction_radius = fluid->radius *
1816                              (fluid->flag & SPH_FAC_RADIUS ? 4.0f * pa->size : 1.0f);
1817   float h = interaction_radius * sphdata->hfac;
1818   /* 4.77 is an experimentally determined density factor */
1819   float rest_density = fluid->rest_density * (fluid->flag & SPH_FAC_DENSITY ? 4.77f : 1.f);
1820   float rest_length = fluid->rest_length *
1821                       (fluid->flag & SPH_FAC_REST_LENGTH ? 2.588f * pa->size : 1.f);
1822
1823   float stiffness = fluid->stiffness_k;
1824   float stiffness_near_fac = fluid->stiffness_knear *
1825                              (fluid->flag & SPH_FAC_REPULSION ? fluid->stiffness_k : 1.f);
1826
1827   ParticleData *npa;
1828   float vec[3];
1829   float vel[3];
1830   float co[3];
1831   float data[2];
1832   float density, near_density;
1833
1834   int i, spring_index, index = pa - psys[0]->particles;
1835
1836   data[0] = data[1] = 0;
1837   pfr.data = data;
1838   pfr.h = h;
1839   pfr.pa = pa;
1840   pfr.mass = sphdata->mass;
1841
1842   sph_evaluate_func(NULL, psys, state->co, &pfr, interaction_radius, sph_density_accum_cb);
1843
1844   density = data[0];
1845   near_density = data[1];
1846
1847   pressure = stiffness * (density - rest_density);
1848   near_pressure = stiffness_near_fac * near_density;
1849
1850   pfn = pfr.neighbors;
1851   for (i = 0; i < pfr.tot_neighbors; i++, pfn++) {
1852     npa = pfn->psys->particles + pfn->index;
1853
1854     madd_v3_v3v3fl(co, npa->prev_state.co, npa->prev_state.vel, state->time);
1855
1856     sub_v3_v3v3(vec, co, state->co);
1857     rij = normalize_v3(vec);
1858
1859     q = (1.f - rij / h) * pfn->psys->part->mass * inv_mass;
1860
1861     if (pfn->psys->part->flag & PART_SIZEMASS) {
1862       q *= npa->size;
1863     }
1864
1865     copy_v3_v3(vel, npa->prev_state.vel);
1866
1867     /* Double Density Relaxation */
1868     madd_v3_v3fl(force, vec, -(pressure + near_pressure * q) * q);
1869
1870     /* Viscosity */
1871     if (visc > 0.f || stiff_visc > 0.f) {
1872       sub_v3_v3v3(dv, vel, state->vel);
1873       u = dot_v3v3(vec, dv);
1874
1875       if (u < 0.f && visc > 0.f) {
1876         madd_v3_v3fl(force, vec, 0.5f * q * visc * u);
1877       }
1878
1879       if (u > 0.f && stiff_visc > 0.f) {
1880         madd_v3_v3fl(force, vec, 0.5f * q * stiff_visc * u);
1881       }
1882     }
1883
1884     if (spring_constant > 0.f) {
1885       /* Viscoelastic spring force */
1886       if (pfn->psys == psys[0] && fluid->flag & SPH_VISCOELASTIC_SPRINGS && springhash) {
1887         /* BLI_edgehash_lookup appears to be thread-safe. - z0r */
1888         spring_index = POINTER_AS_INT(BLI_edgehash_lookup(springhash, index, pfn->index));
1889
1890         if (spring_index) {
1891           spring = psys[0]->fluid_springs + spring_index - 1;
1892
1893           madd_v3_v3fl(
1894               force, vec, -10.f * spring_constant * (1.f - rij / h) * (spring->rest_length - rij));
1895         }
1896         else if (fluid->spring_frames == 0 ||
1897                  (pa->prev_state.time - pa->time) <= fluid->spring_frames) {
1898           ParticleSpring temp_spring;
1899           temp_spring.particle_index[0] = index;
1900           temp_spring.particle_index[1] = pfn->index;
1901           temp_spring.rest_length = (fluid->flag & SPH_CURRENT_REST_LENGTH) ? rij : rest_length;
1902           temp_spring.delete_flag = 0;
1903
1904           /* sph_spring_add is not thread-safe. - z0r */
1905           sph_spring_add(psys[0], &temp_spring);
1906         }
1907       }
1908       else { /* PART_SPRING_HOOKES - Hooke's spring force */
1909         madd_v3_v3fl(force, vec, -10.f * spring_constant * (1.f - rij / h) * (rest_length - rij));
1910       }
1911     }
1912   }
1913
1914   /* Artificial buoyancy force in negative gravity direction  */
1915   if (fluid->buoyancy > 0.f && gravity) {
1916     madd_v3_v3fl(force, gravity, fluid->buoyancy * (density - rest_density));
1917   }
1918
1919   if (sphdata->pass == 0 && psys[0]->part->time_flag & PART_TIME_AUTOSF) {
1920     sph_particle_courant(sphdata, &pfr);
1921   }
1922   sphdata->pass++;
1923 }
1924
1925 static void sphclassical_density_accum_cb(void *userdata,
1926                                           int index,
1927                                           const float co[3],
1928                                           float UNUSED(squared_dist))
1929 {
1930   SPHRangeData *pfr = (SPHRangeData *)userdata;
1931   ParticleData *npa = pfr->npsys->particles + index;
1932   float q;
1933   float qfac = 21.0f / (256.f * (float)M_PI);
1934   float rij, rij_h;
1935   float vec[3];
1936
1937   /* Exclude particles that are more than 2h away. Can't use squared_dist here
1938    * because it is not accurate enough. Use current state, i.e. the output of
1939    * basic_integrate() - z0r */
1940   sub_v3_v3v3(vec, npa->state.co, co);
1941   rij = len_v3(vec);
1942   rij_h = rij / pfr->h;
1943   if (rij_h > 2.0f) {
1944     return;
1945   }
1946
1947   /* Smoothing factor. Utilise the Wendland kernel. gnuplot:
1948    *     q1(x) = (2.0 - x)**4 * ( 1.0 + 2.0 * x)
1949    *     plot [0:2] q1(x) */
1950   q = qfac / pow3f(pfr->h) * pow4f(2.0f - rij_h) * (1.0f + 2.0f * rij_h);
1951   q *= pfr->npsys->part->mass;
1952
1953   if (pfr->use_size) {
1954     q *= pfr->pa->size;
1955   }
1956
1957   pfr->data[0] += q;
1958   pfr->data[1] += q / npa->sphdensity;
1959 }
1960
1961 static void sphclassical_neighbour_accum_cb(void *userdata,
1962                                             int index,
1963                                             const float co[3],
1964                                             float UNUSED(squared_dist))
1965 {
1966   SPHRangeData *pfr = (SPHRangeData *)userdata;
1967   ParticleData *npa = pfr->npsys->particles + index;
1968   float rij, rij_h;
1969   float vec[3];
1970
1971   if (pfr->tot_neighbors >= SPH_NEIGHBORS) {
1972     return;
1973   }
1974
1975   /* Exclude particles that are more than 2h away. Can't use squared_dist here
1976    * because it is not accurate enough. Use current state, i.e. the output of
1977    * basic_integrate() - z0r */
1978   sub_v3_v3v3(vec, npa->state.co, co);
1979   rij = len_v3(vec);
1980   rij_h = rij / pfr->h;
1981   if (rij_h > 2.0f) {
1982     return;
1983   }
1984
1985   pfr->neighbors[pfr->tot_neighbors].index = index;
1986   pfr->neighbors[pfr->tot_neighbors].psys = pfr->npsys;
1987   pfr->tot_neighbors++;
1988 }
1989 static void sphclassical_force_cb(void *sphdata_v,
1990                                   ParticleKey *state,
1991                                   float *force,
1992                                   float *UNUSED(impulse))
1993 {
1994   SPHData *sphdata = (SPHData *)sphdata_v;
1995   ParticleSystem **psys = sphdata->psys;
1996   ParticleData *pa = sphdata->pa;
1997   SPHFluidSettings *fluid = psys[0]->part->fluid;
1998   SPHRangeData pfr;
1999   SPHNeighbor *pfn;
2000   float *gravity = sphdata->gravity;
2001
2002   float dq, u, rij, dv[3];
2003   float pressure, npressure;
2004
2005   float visc = fluid->viscosity_omega;
2006
2007   float interaction_radius;
2008   float h, hinv;
2009   /* 4.77 is an experimentally determined density factor */
2010   float rest_density = fluid->rest_density * (fluid->flag & SPH_FAC_DENSITY ? 4.77f : 1.0f);
2011
2012   // Use speed of sound squared
2013   float stiffness = pow2f(fluid->stiffness_k);
2014
2015   ParticleData *npa;
2016   float vec[3];
2017   float co[3];
2018   float pressureTerm;
2019
2020   int i;
2021
2022   float qfac2 = 42.0f / (256.0f * (float)M_PI);
2023   float rij_h;
2024
2025   /* 4.0 here is to be consistent with previous formulation/interface */
2026   interaction_radius = fluid->radius * (fluid->flag & SPH_FAC_RADIUS ? 4.0f * pa->size : 1.0f);
2027   h = interaction_radius * sphdata->hfac;
2028   hinv = 1.0f / h;
2029
2030   pfr.h = h;
2031   pfr.pa = pa;
2032
2033   sph_evaluate_func(
2034       NULL, psys, state->co, &pfr, interaction_radius, sphclassical_neighbour_accum_cb);
2035   pressure = stiffness * (pow7f(pa->sphdensity / rest_density) - 1.0f);
2036
2037   /* multiply by mass so that we return a force, not accel */
2038   qfac2 *= sphdata->mass / pow3f(pfr.h);
2039
2040   pfn = pfr.neighbors;
2041   for (i = 0; i < pfr.tot_neighbors; i++, pfn++) {
2042     npa = pfn->psys->particles + pfn->index;
2043     if (npa == pa) {
2044       /* we do not contribute to ourselves */
2045       continue;
2046     }
2047
2048     /* Find vector to neighbor. Exclude particles that are more than 2h
2049      * away. Can't use current state here because it may have changed on
2050      * another thread - so do own mini integration. Unlike basic_integrate,
2051      * SPH integration depends on neighboring particles. - z0r */
2052     madd_v3_v3v3fl(co, npa->prev_state.co, npa->prev_state.vel, state->time);
2053     sub_v3_v3v3(vec, co, state->co);
2054     rij = normalize_v3(vec);
2055     rij_h = rij / pfr.h;
2056     if (rij_h > 2.0f) {
2057       continue;
2058     }
2059
2060     npressure = stiffness * (pow7f(npa->sphdensity / rest_density) - 1.0f);
2061
2062     /* First derivative of smoothing factor. Utilise the Wendland kernel.
2063      * gnuplot:
2064      *     q2(x) = 2.0 * (2.0 - x)**4 - 4.0 * (2.0 - x)**3 * (1.0 + 2.0 * x)
2065      *     plot [0:2] q2(x)
2066      * Particles > 2h away are excluded above. */
2067     dq = qfac2 * (2.0f * pow4f(2.0f - rij_h) - 4.0f * pow3f(2.0f - rij_h) * (1.0f + 2.0f * rij_h));
2068
2069     if (pfn->psys->part->flag & PART_SIZEMASS) {
2070       dq *= npa->size;
2071     }
2072
2073     pressureTerm = pressure / pow2f(pa->sphdensity) + npressure / pow2f(npa->sphdensity);
2074
2075     /* Note that 'minus' is removed, because vec = vecBA, not vecAB.
2076      * This applies to the viscosity calculation below, too. */
2077     madd_v3_v3fl(force, vec, pressureTerm * dq);
2078
2079     /* Viscosity */
2080     if (visc > 0.0f) {
2081       sub_v3_v3v3(dv, npa->prev_state.vel, pa->prev_state.vel);
2082       u = dot_v3v3(vec, dv);
2083       /* Apply parameters */
2084       u *= -dq * hinv * visc / (0.5f * npa->sphdensity + 0.5f * pa->sphdensity);
2085       madd_v3_v3fl(force, vec, u);
2086     }
2087   }
2088
2089   /* Artificial buoyancy force in negative gravity direction  */
2090   if (fluid->buoyancy > 0.f && gravity) {
2091     madd_v3_v3fl(force, gravity, fluid->buoyancy * (pa->sphdensity - rest_density));
2092   }
2093
2094   if (sphdata->pass == 0 && psys[0]->part->time_flag & PART_TIME_AUTOSF) {
2095     sph_particle_courant(sphdata, &pfr);
2096   }
2097   sphdata->pass++;
2098 }
2099
2100 static void sphclassical_calc_dens(ParticleData *pa, float UNUSED(dfra), SPHData *sphdata)
2101 {
2102   ParticleSystem **psys = sphdata->psys;
2103   SPHFluidSettings *fluid = psys[0]->part->fluid;
2104   /* 4.0 seems to be a pretty good value */
2105   float interaction_radius = fluid->radius *
2106                              (fluid->flag & SPH_FAC_RADIUS ? 4.0f * psys[0]->part->size : 1.0f);
2107   SPHRangeData pfr;
2108   float data[2];
2109
2110   data[0] = 0;
2111   data[1] = 0;
2112   pfr.data = data;
2113   pfr.h = interaction_radius * sphdata->hfac;
2114   pfr.pa = pa;
2115   pfr.mass = sphdata->mass;
2116
2117   sph_evaluate_func(
2118       NULL, psys, pa->state.co, &pfr, interaction_radius, sphclassical_density_accum_cb);
2119   pa->sphdensity = min_ff(max_ff(data[0], fluid->rest_density * 0.9f), fluid->rest_density * 1.1f);
2120 }
2121
2122 void psys_sph_init(ParticleSimulationData *sim, SPHData *sphdata)
2123 {
2124   ParticleTarget *pt;
2125   int i;
2126
2127   // Add other coupled particle systems.
2128   sphdata->psys[0] = sim->psys;
2129   for (i = 1, pt = sim->psys->targets.first; i < 10; i++, pt = (pt ? pt->next : NULL)) {
2130     sphdata->psys[i] = pt ? psys_get_target_system(sim->ob, pt) : NULL;
2131   }
2132
2133   if (psys_uses_gravity(sim)) {
2134     sphdata->gravity = sim->scene->physics_settings.gravity;
2135   }
2136   else {
2137     sphdata->gravity = NULL;
2138   }
2139   sphdata->eh = sph_springhash_build(sim->psys);
2140
2141   // These per-particle values should be overridden later, but just for
2142   // completeness we give them default values now.
2143   sphdata->pa = NULL;
2144   sphdata->mass = 1.0f;
2145
2146   if (sim->psys->part->fluid->solver == SPH_SOLVER_DDR) {
2147     sphdata->force_cb = sph_force_cb;
2148     sphdata->density_cb = sph_density_accum_cb;
2149     sphdata->hfac = 1.0f;
2150   }
2151   else {
2152     /* SPH_SOLVER_CLASSICAL */
2153     sphdata->force_cb = sphclassical_force_cb;
2154     sphdata->density_cb = sphclassical_density_accum_cb;
2155     sphdata->hfac = 0.5f;
2156   }
2157 }
2158
2159 void psys_sph_finalise(SPHData *sphdata)
2160 {
2161   if (sphdata->eh) {
2162     BLI_edgehash_free(sphdata->eh, NULL);
2163     sphdata->eh = NULL;
2164   }
2165 }
2166 /* Sample the density field at a point in space. */
2167 void psys_sph_density(BVHTree *tree, SPHData *sphdata, float co[3], float vars[2])
2168 {
2169   ParticleSystem **psys = sphdata->psys;
2170   SPHFluidSettings *fluid = psys[0]->part->fluid;
2171   /* 4.0 seems to be a pretty good value */
2172   float interaction_radius = fluid->radius *
2173                              (fluid->flag & SPH_FAC_RADIUS ? 4.0f * psys[0]->part->size : 1.0f);
2174   SPHRangeData pfr;
2175   float density[2];
2176
2177   density[0] = density[1] = 0.0f;
2178   pfr.data = density;
2179   pfr.h = interaction_radius * sphdata->hfac;
2180   pfr.mass = sphdata->mass;
2181
2182   sph_evaluate_func(tree, psys, co, &pfr, interaction_radius, sphdata->density_cb);
2183
2184   vars[0] = pfr.data[0];
2185   vars[1] = pfr.data[1];
2186 }
2187
2188 static void sph_integrate(ParticleSimulationData *sim,
2189                           ParticleData *pa,
2190                           float dfra,
2191                           SPHData *sphdata)
2192 {
2193   ParticleSettings *part = sim->psys->part;
2194   // float timestep = psys_get_timestep(sim); // UNUSED
2195   float pa_mass = part->mass * (part->flag & PART_SIZEMASS ? pa->size : 1.f);
2196   float dtime = dfra * psys_get_timestep(sim);
2197   // int steps = 1; // UNUSED
2198   float effector_acceleration[3];
2199
2200   sphdata->pa = pa;
2201   sphdata->mass = pa_mass;
2202   sphdata->pass = 0;
2203   // sphdata.element_size and sphdata.flow are set in the callback.
2204
2205   /* restore previous state and treat gravity & effectors as external acceleration*/
2206   sub_v3_v3v3(effector_acceleration, pa->state.vel, pa->prev_state.vel);
2207   mul_v3_fl(effector_acceleration, 1.f / dtime);
2208
2209   copy_particle_key(&pa->state, &pa->prev_state, 0);
2210
2211   integrate_particle(part, pa, dtime, effector_acceleration, sphdata->force_cb, sphdata);
2212 }
2213
2214 /** \} */
2215
2216 /************************************************/
2217 /*          Basic physics                       */
2218 /************************************************/
2219 typedef struct EfData {
2220   ParticleTexture ptex;
2221   ParticleSimulationData *sim;
2222   ParticleData *pa;
2223 } EfData;
2224 static void basic_force_cb(void *efdata_v, ParticleKey *state, float *force, float *impulse)
2225 {
2226   EfData *efdata = (EfData *)efdata_v;
2227   ParticleSimulationData *sim = efdata->sim;
2228   ParticleSettings *part = sim->psys->part;
2229   ParticleData *pa = efdata->pa;
2230   EffectedPoint epoint;
2231   RNG *rng = sim->rng;
2232
2233   /* add effectors */
2234   pd_point_from_particle(efdata->sim, efdata->pa, state, &epoint);
2235   if (part->type != PART_HAIR || part->effector_weights->flag & EFF_WEIGHT_DO_HAIR) {
2236     BKE_effectors_apply(
2237         sim->psys->effectors, sim->colliders, part->effector_weights, &epoint, force, impulse);
2238   }
2239
2240   mul_v3_fl(force, efdata->ptex.field);
2241   mul_v3_fl(impulse, efdata->ptex.field);
2242
2243   /* calculate air-particle interaction */
2244   if (part->dragfac != 0.0f) {
2245     madd_v3_v3fl(force, state->vel, -part->dragfac * pa->size * pa->size * len_v3(state->vel));
2246   }
2247
2248   /* brownian force */
2249   if (part->brownfac != 0.0f) {
2250     force[0] += (BLI_rng_get_float(rng) - 0.5f) * part->brownfac;
2251     force[1] += (BLI_rng_get_float(rng) - 0.5f) * part->brownfac;
2252     force[2] += (BLI_rng_get_float(rng) - 0.5f) * part->brownfac;
2253   }
2254
2255   if (part->flag & PART_ROT_DYN && epoint.ave) {
2256     copy_v3_v3(pa->state.ave, epoint.ave);
2257   }
2258 }
2259 /* gathers all forces that effect particles and calculates a new state for the particle */
2260 static void basic_integrate(ParticleSimulationData *sim, int p, float dfra, float cfra)
2261 {
2262   ParticleSettings *part = sim->psys->part;
2263   ParticleData *pa = sim->psys->particles + p;
2264   ParticleKey tkey;
2265   float dtime = dfra * psys_get_timestep(sim), time;
2266   float *gravity = NULL, gr[3];
2267   EfData efdata;
2268
2269   psys_get_texture(sim, pa, &efdata.ptex, PAMAP_PHYSICS, cfra);
2270
2271   efdata.pa = pa;
2272   efdata.sim = sim;
2273
2274   /* add global acceleration (gravitation) */
2275   if (psys_uses_gravity(sim) &&
2276       /* normal gravity is too strong for hair so it's disabled by default */
2277       (part->type != PART_HAIR || part->effector_weights->flag & EFF_WEIGHT_DO_HAIR)) {
2278     zero_v3(gr);
2279     madd_v3_v3fl(gr,
2280                  sim->scene->physics_settings.gravity,
2281                  part->effector_weights->global_gravity * efdata.ptex.gravity);
2282     gravity = gr;
2283   }
2284
2285   /* maintain angular velocity */
2286   copy_v3_v3(pa->state.ave, pa->prev_state.ave);
2287
2288   integrate_particle(part, pa, dtime, gravity, basic_force_cb, &efdata);
2289
2290   /* damp affects final velocity */
2291   if (part->dampfac != 0.f) {
2292     mul_v3_fl(pa->state.vel, 1.f - part->dampfac * efdata.ptex.damp * 25.f * dtime);
2293   }
2294
2295   // copy_v3_v3(pa->state.ave, states->ave);
2296
2297   /* finally we do guides */
2298   time = (cfra - pa->time) / pa->lifetime;
2299   CLAMP(time, 0.0f, 1.0f);
2300
2301   copy_v3_v3(tkey.co, pa->state.co);
2302   copy_v3_v3(tkey.vel, pa->state.vel);
2303   tkey.time = pa->state.time;
2304
2305   if (part->type != PART_HAIR) {
2306     if (do_guides(sim->depsgraph, sim->psys->part, sim->psys->effectors, &tkey, p, time)) {
2307       copy_v3_v3(pa->state.co, tkey.co);
2308       /* guides don't produce valid velocity */
2309       sub_v3_v3v3(pa->state.vel, tkey.co, pa->prev_state.co);
2310       mul_v3_fl(pa->state.vel, 1.0f / dtime);
2311       pa->state.time = tkey.time;
2312     }
2313   }
2314 }
2315 static void basic_rotate(ParticleSettings *part, ParticleData *pa, float dfra, float timestep)
2316 {
2317   float rotfac, rot1[4], rot2[4] = {1.0, 0.0, 0.0, 0.0}, dtime = dfra * timestep, extrotfac;
2318
2319   if ((part->flag & PART_ROTATIONS) == 0) {
2320     unit_qt(pa->state.rot);
2321     return;
2322   }
2323
2324   if (part->flag & PART_ROT_DYN) {
2325     extrotfac = len_v3(pa->state.ave);
2326   }
2327   else {
2328     extrotfac = 0.0f;
2329   }
2330
2331   if ((part->flag & PART_ROT_DYN) &&
2332       ELEM(part->avemode, PART_AVE_VELOCITY, PART_AVE_HORIZONTAL, PART_AVE_VERTICAL)) {
2333     float angle;
2334     float len1 = len_v3(pa->prev_state.vel);
2335     float len2 = len_v3(pa->state.vel);
2336     float vec[3];
2337
2338     if (len1 == 0.0f || len2 == 0.0f) {
2339       zero_v3(pa->state.ave);
2340     }
2341     else {
2342       cross_v3_v3v3(pa->state.ave, pa->prev_state.vel, pa->state.vel);
2343       normalize_v3(pa->state.ave);
2344       angle = dot_v3v3(pa->prev_state.vel, pa->state.vel) / (len1 * len2);
2345       mul_v3_fl(pa->state.ave, saacos(angle) / dtime);
2346     }
2347
2348     get_angular_velocity_vector(part->avemode, &pa->state, vec);
2349     axis_angle_to_quat(rot2, vec, dtime * part->avefac);
2350   }
2351
2352   rotfac = len_v3(pa->state.ave);
2353   if (rotfac == 0.0f || (part->flag & PART_ROT_DYN) == 0 || extrotfac == 0.0f) {
2354     unit_qt(rot1);
2355   }
2356   else {
2357     axis_angle_to_quat(rot1, pa->state.ave, rotfac * dtime);
2358   }
2359   mul_qt_qtqt(pa->state.rot, rot1, pa->prev_state.rot);
2360   mul_qt_qtqt(pa->state.rot, rot2, pa->state.rot);
2361
2362   /* keep rotation quat in good health */
2363   normalize_qt(pa->state.rot);
2364 }
2365
2366 /************************************************
2367  * Collisions
2368  *
2369  * The algorithm is roughly:
2370  *  1. Use a BVH tree to search for faces that a particle may collide with.
2371  *  2. Use Newton's method to find the exact time at which the collision occurs.
2372  *     https://en.wikipedia.org/wiki/Newton's_method
2373  *
2374  ************************************************/
2375 #define COLLISION_MIN_RADIUS 0.001f
2376 #define COLLISION_MIN_DISTANCE 0.0001f
2377 #define COLLISION_ZERO 0.00001f
2378 #define COLLISION_INIT_STEP 0.00008f
2379 typedef float (*NRDistanceFunc)(float *p, float radius, ParticleCollisionElement *pce, float *nor);
2380 static float nr_signed_distance_to_plane(float *p,
2381                                          float radius,
2382                                          ParticleCollisionElement *pce,
2383                                          float *nor)
2384 {
2385   float p0[3], e1[3], e2[3], d;
2386
2387   sub_v3_v3v3(e1, pce->x1, pce->x0);
2388   sub_v3_v3v3(e2, pce->x2, pce->x0);
2389   sub_v3_v3v3(p0, p, pce->x0);
2390
2391   cross_v3_v3v3(nor, e1, e2);
2392   normalize_v3(nor);
2393
2394   d = dot_v3v3(p0, nor);
2395
2396   if (pce->inv_nor == -1) {
2397     if (d < 0.f) {
2398       pce->inv_nor = 1;
2399     }
2400     else {
2401       pce->inv_nor = 0;
2402     }
2403   }
2404
2405   if (pce->inv_nor == 1) {
2406     negate_v3(nor);
2407     d = -d;
2408   }
2409
2410   return d - radius;
2411 }
2412 static float nr_distance_to_edge(float *p,
2413                                  float radius,
2414                                  ParticleCollisionElement *pce,
2415                                  float *UNUSED(nor))
2416 {
2417   float v0[3], v1[3], v2[3], c[3];
2418
2419   sub_v3_v3v3(v0, pce->x1, pce->x0);
2420   sub_v3_v3v3(v1, p, pce->x0);
2421   sub_v3_v3v3(v2, p, pce->x1);
2422
2423   cross_v3_v3v3(c, v1, v2);
2424
2425   return fabsf(len_v3(c) / len_v3(v0)) - radius;
2426 }
2427 static float nr_distance_to_vert(float *p,
2428                                  float radius,
2429                                  ParticleCollisionElement *pce,
2430                                  float *UNUSED(nor))
2431 {
2432   return len_v3v3(p, pce->x0) - radius;
2433 }
2434 static void collision_interpolate_element(ParticleCollisionElement *pce,
2435                                           float t,
2436                                           float fac,
2437                                           ParticleCollision *col)
2438 {
2439   /* t is the current time for newton rhapson */
2440   /* fac is the starting factor for current collision iteration */
2441   /* The col->fac's are factors for the particle subframe step start
2442    * and end during collision modifier step. */
2443   float f = fac + t * (1.f - fac);
2444   float mul = col->fac1 + f * (col->fac2 - col->fac1);
2445   if (pce->tot > 0) {
2446     madd_v3_v3v3fl(pce->x0, pce->x[0], pce->v[0], mul);
2447
2448     if (pce->tot > 1) {
2449       madd_v3_v3v3fl(pce->x1, pce->x[1], pce->v[1], mul);
2450
2451       if (pce->tot > 2) {
2452         madd_v3_v3v3fl(pce->x2, pce->x[2], pce->v[2], mul);
2453       }
2454     }
2455   }
2456 }
2457 static void collision_point_velocity(ParticleCollisionElement *pce)
2458 {
2459   float v[3];
2460
2461   copy_v3_v3(pce->vel, pce->v[0]);
2462
2463   if (pce->tot > 1) {
2464     sub_v3_v3v3(v, pce->v[1], pce->v[0]);
2465     madd_v3_v3fl(pce->vel, v, pce->uv[0]);
2466
2467     if (pce->tot > 2) {
2468       sub_v3_v3v3(v, pce->v[2], pce->v[0]);
2469       madd_v3_v3fl(pce->vel, v, pce->uv[1]);
2470     }
2471   }
2472 }
2473 static float collision_point_distance_with_normal(
2474     float p[3], ParticleCollisionElement *pce, float fac, ParticleCollision *col, float *nor)
2475 {
2476   if (fac >= 0.f) {
2477     collision_interpolate_element(pce, 0.f, fac, col);
2478   }
2479
2480   switch (pce->tot) {
2481     case 1: {
2482       sub_v3_v3v3(nor, p, pce->x0);
2483       return normalize_v3(nor);
2484     }
2485     case 2: {
2486       float u, e[3], vec[3];
2487       sub_v3_v3v3(e, pce->x1, pce->x0);
2488       sub_v3_v3v3(vec, p, pce->x0);
2489       u = dot_v3v3(vec, e) / dot_v3v3(e, e);
2490
2491       madd_v3_v3v3fl(nor, vec, e, -u);
2492       return normalize_v3(nor);
2493     }
2494     case 3:
2495       return nr_signed_distance_to_plane(p, 0.f, pce, nor);
2496   }
2497   return 0;
2498 }
2499 static void collision_point_on_surface(
2500     float p[3], ParticleCollisionElement *pce, float fac, ParticleCollision *col, float *co)
2501 {
2502   collision_interpolate_element(pce, 0.f, fac, col);
2503
2504   switch (pce->tot) {
2505     case 1: {
2506       sub_v3_v3v3(co, p, pce->x0);
2507       normalize_v3(co);
2508       madd_v3_v3v3fl(co, pce->x0, co, col->radius);
2509       break;
2510     }
2511     case 2: {
2512       float u, e[3], vec[3], nor[3];
2513       sub_v3_v3v3(e, pce->x1, pce->x0);
2514       sub_v3_v3v3(vec, p, pce->x0);
2515       u = dot_v3v3(vec, e) / dot_v3v3(e, e);
2516
2517       madd_v3_v3v3fl(nor, vec, e, -u);
2518       normalize_v3(nor);
2519
2520       madd_v3_v3v3fl(co, pce->x0, e, pce->uv[0]);
2521       madd_v3_v3fl(co, nor, col->radius);
2522       break;
2523     }
2524     case 3: {
2525       float p0[3], e1[3], e2[3], nor[3];
2526
2527       sub_v3_v3v3(e1, pce->x1, pce->x0);
2528       sub_v3_v3v3(e2, pce->x2, pce->x0);
2529       sub_v3_v3v3(p0, p, pce->x0);
2530
2531       cross_v3_v3v3(nor, e1, e2);
2532       normalize_v3(nor);
2533
2534       if (pce->inv_nor == 1) {
2535         negate_v3(nor);
2536       }
2537
2538       madd_v3_v3v3fl(co, pce->x0, nor, col->radius);
2539       madd_v3_v3fl(co, e1, pce->uv[0]);
2540       madd_v3_v3fl(co, e2, pce->uv[1]);
2541       break;
2542     }
2543   }
2544 }
2545 /* find first root in range [0-1] starting from 0 */
2546 static float collision_newton_rhapson(ParticleCollision *col,
2547                                       float radius,
2548                                       ParticleCollisionElement *pce,
2549                                       NRDistanceFunc distance_func)
2550 {
2551   float t0, t1, dt_init, d0, d1, dd, n[3];
2552   int iter;
2553
2554   pce->inv_nor = -1;
2555
2556   if (col->inv_total_time > 0.0f) {
2557     /* Initial step size should be small, but not too small or floating point
2558      * precision errors will appear. - z0r */
2559     dt_init = COLLISION_INIT_STEP * col->inv_total_time;
2560   }
2561   else {
2562     dt_init = 0.001f;
2563   }
2564
2565   /* start from the beginning */
2566   t0 = 0.f;
2567   collision_interpolate_element(pce, t0, col->f, col);
2568   d0 = distance_func(col->co1, radius, pce, n);
2569   t1 = dt_init;
2570   d1 = 0.f;
2571
2572   for (iter = 0; iter < 10; iter++) {  //, itersum++) {
2573     /* get current location */
2574     collision_interpolate_element(pce, t1, col->f, col);
2575     interp_v3_v3v3(pce->p, col->co1, col->co2, t1);
2576
2577     d1 = distance_func(pce->p, radius, pce, n);
2578
2579     /* particle already inside face, so report collision */
2580     if (iter == 0 && d0 < 0.f && d0 > -radius) {
2581       copy_v3_v3(pce->p, col->co1);
2582       copy_v3_v3(pce->nor, n);
2583       pce->inside = 1;
2584       return 0.f;
2585     }
2586
2587     /* Zero gradient (no movement relative to element). Can't step from
2588      * here. */
2589     if (d1 == d0) {
2590       /* If first iteration, try from other end where the gradient may be
2591        * greater. Note: code duplicated below. */
2592       if (iter == 0) {
2593         t0 = 1.f;
2594         collision_interpolate_element(pce, t0, col->f, col);
2595         d0 = distance_func(col->co2, radius, pce, n);
2596         t1 = 1.0f - dt_init;
2597         d1 = 0.f;
2598         continue;
2599       }
2600       else {
2601         return -1.f;
2602       }
2603     }
2604
2605     dd = (t1 - t0) / (d1 - d0);
2606
2607     t0 = t1;
2608     d0 = d1;
2609
2610     t1 -= d1 * dd;
2611
2612     /* Particle moving away from plane could also mean a strangely rotating
2613      * face, so check from end. Note: code duplicated above. */
2614     if (iter == 0 && t1 < 0.f) {
2615       t0 = 1.f;
2616       collision_interpolate_element(pce, t0, col->f, col);
2617       d0 = distance_func(col->co2, radius, pce, n);
2618       t1 = 1.0f - dt_init;
2619       d1 = 0.f;
2620       continue;
2621     }
2622     else if (iter == 1 && (t1 < -COLLISION_ZERO || t1 > 1.f)) {
2623       return -1.f;
2624     }
2625
2626     if (d1 <= COLLISION_ZERO && d1 >= -COLLISION_ZERO) {
2627       if (t1 >= -COLLISION_ZERO && t1 <= 1.f) {
2628         if (distance_func == nr_signed_distance_to_plane) {
2629           copy_v3_v3(pce->nor, n);
2630         }
2631
2632         CLAMP(t1, 0.f, 1.f);
2633
2634         return t1;
2635       }
2636       else {
2637         return -1.f;
2638       }
2639     }
2640   }
2641   return -1.0;
2642 }
2643 static int collision_sphere_to_tri(ParticleCollision *col,
2644                                    float radius,
2645                                    ParticleCollisionElement *pce,
2646                                    float *t)
2647 {
2648   ParticleCollisionElement *result = &col->pce;
2649   float ct, u, v;
2650
2651   pce->inv_nor = -1;
2652   pce->inside = 0;
2653
2654   ct = collision_newton_rhapson(col, radius, pce, nr_signed_distance_to_plane);
2655
2656   if (ct >= 0.f && ct < *t && (result->inside == 0 || pce->inside == 1)) {
2657     float e1[3], e2[3], p0[3];
2658     float e1e1, e1e2, e1p0, e2e2, e2p0, inv;
2659
2660     sub_v3_v3v3(e1, pce->x1, pce->x0);
2661     sub_v3_v3v3(e2, pce->x2, pce->x0);
2662     /* XXX: add radius correction here? */
2663     sub_v3_v3v3(p0, pce->p, pce->x0);
2664
2665     e1e1 = dot_v3v3(e1, e1);
2666     e1e2 = dot_v3v3(e1, e2);
2667     e1p0 = dot_v3v3(e1, p0);
2668     e2e2 = dot_v3v3(e2, e2);
2669     e2p0 = dot_v3v3(e2, p0);
2670
2671     inv = 1.f / (e1e1 * e2e2 - e1e2 * e1e2);
2672     u = (e2e2 * e1p0 - e1e2 * e2p0) * inv;
2673     v = (e1e1 * e2p0 - e1e2 * e1p0) * inv;
2674
2675     if (u >= 0.f && u <= 1.f && v >= 0.f && u + v <= 1.f) {
2676       *result = *pce;
2677
2678       /* normal already calculated in pce */
2679
2680       result->uv[0] = u;
2681       result->uv[1] = v;
2682
2683       *t = ct;
2684       return 1;
2685     }
2686   }
2687   return 0;
2688 }
2689 static int collision_sphere_to_edges(ParticleCollision *col,
2690                                      float radius,
2691                                      ParticleCollisionElement *pce,
2692                                      float *t)
2693 {
2694   ParticleCollisionElement edge[3], *cur = NULL, *hit = NULL;
2695   ParticleCollisionElement *result = &col->pce;
2696
2697   float ct;
2698   int i;
2699
2700   for (i = 0; i < 3; i++) {
2701     cur = edge + i;
2702     cur->x[0] = pce->x[i];
2703     cur->x[1] = pce->x[(i + 1) % 3];
2704     cur->v[0] = pce->v[i];
2705     cur->v[1] = pce->v[(i + 1) % 3];
2706     cur->tot = 2;
2707     cur->inside = 0;
2708
2709     ct = collision_newton_rhapson(col, radius, cur, nr_distance_to_edge);
2710
2711     if (ct >= 0.f && ct < *t) {
2712       float u, e[3], vec[3];
2713
2714       sub_v3_v3v3(e, cur->x1, cur->x0);
2715       sub_v3_v3v3(vec, cur->p, cur->x0);
2716       u = dot_v3v3(vec, e) / dot_v3v3(e, e);
2717
2718       if (u < 0.f || u > 1.f) {
2719         break;
2720       }
2721
2722       *result = *cur;
2723
2724       madd_v3_v3v3fl(result->nor, vec, e, -u);
2725       normalize_v3(result->nor);
2726
2727       result->uv[0] = u;
2728
2729       hit = cur;
2730       *t = ct;
2731     }
2732   }
2733
2734   return hit != NULL;
2735 }
2736 static int collision_sphere_to_verts(ParticleCollision *col,
2737                                      float radius,
2738                                      ParticleCollisionElement *pce,
2739                                      float *t)
2740 {
2741   ParticleCollisionElement vert[3], *cur = NULL, *hit = NULL;
2742   ParticleCollisionElement *result = &col->pce;
2743
2744   float ct;
2745   int i;
2746
2747   for (i = 0; i < 3; i++) {
2748     cur = vert + i;
2749     cur->x[0] = pce->x[i];
2750     cur->v[0] = pce->v[i];
2751     cur->tot = 1;
2752     cur->inside = 0;
2753
2754     ct = collision_newton_rhapson(col, radius, cur, nr_distance_to_vert);
2755
2756     if (ct >= 0.f && ct < *t) {
2757       *result = *cur;
2758
2759       sub_v3_v3v3(result->nor, cur->p, cur->x0);
2760       normalize_v3(result->nor);
2761
2762       hit = cur;
2763       *t = ct;
2764     }
2765   }
2766
2767   return hit != NULL;
2768 }
2769 /* Callback for BVHTree near test */
2770 void BKE_psys_collision_neartest_cb(void *userdata,
2771                                     int index,
2772                                     const BVHTreeRay *ray,
2773                                     BVHTreeRayHit *hit)
2774 {
2775   ParticleCollision *col = (ParticleCollision *)userdata;
2776   ParticleCollisionElement pce;
2777   const MVertTri *vt = &col->md->tri[index];
2778   MVert *x = col->md->x;
2779   MVert *v = col->md->current_v;
2780   float t = hit->dist / col->original_ray_length;
2781   int collision = 0;
2782
2783   pce.x[0] = x[vt->tri[0]].co;
2784   pce.x[1] = x[vt->tri[1]].co;
2785   pce.x[2] = x[vt->tri[2]].co;
2786
2787   pce.v[0] = v[vt->tri[0]].co;
2788   pce.v[1] = v[vt->tri[1]].co;
2789   pce.v[2] = v[vt->tri[2]].co;
2790
2791   pce.tot = 3;
2792   pce.inside = 0;
2793   pce.index = index;
2794
2795   collision = collision_sphere_to_tri(col, ray->radius, &pce, &t);
2796   if (col->pce.inside == 0) {
2797     collision += collision_sphere_to_edges(col, ray->radius, &pce, &t);
2798     collision += collision_sphere_to_verts(col, ray->radius, &pce, &t);
2799   }
2800
2801   if (collision) {
2802     hit->dist = col->original_ray_length * t;
2803     hit->index = index;
2804
2805     collision_point_velocity(&col->pce);
2806
2807     col->hit = col->current;
2808   }
2809 }
2810 static int collision_detect(ParticleData *pa,
2811                             ParticleCollision *col,
2812                             BVHTreeRayHit *hit,
2813                             ListBase *colliders)
2814 {
2815   const int raycast_flag = BVH_RAYCAST_DEFAULT & ~(BVH_RAYCAST_WATERTIGHT);
2816   ColliderCache *coll;
2817   float ray_dir[3];
2818
2819   if (BLI_listbase_is_empty(colliders)) {
2820     return 0;
2821   }
2822
2823   sub_v3_v3v3(ray_dir, col->co2, col->co1);
2824   hit->index = -1;
2825   hit->dist = col->original_ray_length = normalize_v3(ray_dir);
2826   col->pce.inside = 0;
2827
2828   /* even if particle is stationary we want to check for moving colliders */
2829   /* if hit.dist is zero the bvhtree_ray_cast will just ignore everything */
2830   if (hit->dist == 0.0f) {
2831     hit->dist = col->original_ray_length = 0.000001f;
2832   }
2833
2834   for (coll = colliders->first; coll; coll = coll->next) {
2835     /* for boids: don't check with current ground object; also skip if permeated */
2836     bool skip = false;
2837
2838     for (int i = 0; i < col->skip_count; i++) {
2839       if (coll->ob == col->skip[i]) {
2840         skip = true;
2841         break;
2842       }
2843     }
2844
2845     if (skip) {
2846       continue;
2847     }
2848
2849     /* particles should not collide with emitter at birth */
2850     if (coll->ob == col->emitter && pa->time < col->cfra && pa->time >= col->old_cfra) {
2851       continue;
2852     }
2853
2854     col->current = coll->ob;
2855     col->md = coll->collmd;
2856     col->fac1 = (col->old_cfra - coll->collmd->time_x) /
2857                 (coll->collmd->time_xnew - coll->collmd->time_x);
2858     col->fac2 = (col->cfra - coll->collmd->time_x) /
2859                 (coll->collmd->time_xnew - coll->collmd->time_x);
2860
2861     if (col->md && col->md->bvhtree) {
2862       BLI_bvhtree_ray_cast_ex(col->md->bvhtree,
2863                               col->co1,
2864                               ray_dir,
2865                               col->radius,
2866                               hit,
2867                               BKE_psys_collision_neartest_cb,
2868                               col,
2869                               raycast_flag);
2870     }
2871   }
2872
2873   return hit->index >= 0;
2874 }
2875 static int collision_response(ParticleSimulationData *sim,
2876                               ParticleData *pa,
2877                               ParticleCollision *col,
2878                               BVHTreeRayHit *hit,
2879                               int kill,
2880                               int dynamic_rotation)
2881 {
2882   ParticleCollisionElement *pce = &col->pce;
2883   PartDeflect *pd = col->hit->pd;
2884   RNG *rng = sim->rng;
2885   /* point of collision */
2886   float co[3];
2887   /* location factor of collision between this iteration */
2888   float x = hit->dist / col->original_ray_length;
2889   /* time factor of collision between timestep */
2890   float f = col->f + x * (1.0f - col->f);
2891   /* time since previous collision (in seconds) */
2892   float dt1 = (f - col->f) * col->total_time;
2893   /* time left after collision (in seconds) */
2894   float dt2 = (1.0f - f) * col->total_time;
2895   /* did particle pass through the collision surface? */
2896   int through = (BLI_rng_get_float(rng) < pd->pdef_perm) ? 1 : 0;
2897
2898   /* calculate exact collision location */
2899   interp_v3_v3v3(co, col->co1, col->co2, x);
2900
2901   /* particle dies in collision */
2902   if (through == 0 && (kill || pd->flag & PDEFLE_KILL_PART)) {
2903     pa->alive = PARS_DYING;
2904     pa->dietime = col->old_cfra + (col->cfra - col->old_cfra) * f;
2905
2906     copy_v3_v3(pa->state.co, co);
2907     interp_v3_v3v3(pa->state.vel, pa->prev_state.vel, pa->state.vel, f);
2908     interp_qt_qtqt(pa->state.rot, pa->prev_state.rot, pa->state.rot, f);
2909     interp_v3_v3v3(pa->state.ave, pa->prev_state.ave, pa->state.ave, f);
2910
2911     /* particle is dead so we don't need to calculate further */
2912     return 0;
2913   }
2914   /* figure out velocity and other data after collision */
2915   else {
2916     /* velocity directly before collision to be modified into velocity directly after collision */
2917     float v0[3];
2918     /* normal component of v0 */
2919     float v0_nor[3];
2920     /* tangential component of v0 */
2921     float v0_tan[3];
2922     /* tangential component of collision surface velocity */
2923     float vc_tan[3];
2924     float v0_dot, vc_dot;
2925     float damp = pd->pdef_damp + pd->pdef_rdamp * 2 * (BLI_rng_get_float(rng) - 0.5f);
2926     float frict = pd->pdef_frict + pd->pdef_rfrict * 2 * (BLI_rng_get_float(rng) - 0.5f);
2927     float distance, nor[3], dot;
2928
2929     CLAMP(damp, 0.0f, 1.0f);
2930     CLAMP(frict, 0.0f, 1.0f);
2931
2932     /* get exact velocity right before collision */
2933     madd_v3_v3v3fl(v0, col->ve1, col->acc, dt1);
2934
2935     /* Convert collider velocity from 1/framestep to 1/s TODO:
2936      * here we assume 1 frame step for collision modifier. */
2937     mul_v3_fl(pce->vel, col->inv_timestep);
2938
2939     /* calculate tangential particle velocity */
2940     v0_dot = dot_v3v3(pce->nor, v0);
2941     madd_v3_v3v3fl(v0_tan, v0, pce->nor, -v0_dot);
2942
2943     /* calculate tangential collider velocity */
2944     vc_dot = dot_v3v3(pce->nor, pce->vel);
2945     madd_v3_v3v3fl(vc_tan, pce->vel, pce->nor, -vc_dot);
2946
2947     /* handle friction effects (tangential and angular velocity) */
2948     if (frict > 0.0f) {
2949       /* angular <-> linear velocity */
2950       if (dynamic_rotation) {
2951         float vr_tan[3], v1_tan[3], ave[3];
2952
2953         /* linear velocity of particle surface */
2954         cross_v3_v3v3(vr_tan, pce->nor, pa->state.ave);
2955         mul_v3_fl(vr_tan, pa->size);
2956
2957         /* change to coordinates that move with the collision plane */
2958         sub_v3_v3v3(v1_tan, v0_tan, vc_tan);
2959
2960         /* The resulting velocity is a weighted average of particle cm & surface
2961          * velocity. This weight (related to particle's moment of inertia) could
2962          * be made a parameter for angular <-> linear conversion.
2963          */
2964         madd_v3_v3fl(v1_tan, vr_tan, -0.4);
2965         mul_v3_fl(v1_tan, 1.0f / 1.4f); /* 1/(1+0.4) */
2966
2967         /* rolling friction is around 0.01 of sliding friction
2968          * (could be made a parameter) */
2969         mul_v3_fl(v1_tan, 1.0f - 0.01f * frict);
2970
2971         /* surface_velocity is opposite to cm velocity */
2972         negate_v3_v3(vr_tan, v1_tan);
2973
2974         /* get back to global coordinates */
2975         add_v3_v3(v1_tan, vc_tan);
2976
2977         /* convert to angular velocity*/
2978         cross_v3_v3v3(ave, vr_tan, pce->nor);
2979         mul_v3_fl(ave, 1.0f / MAX2(pa->size, 0.001f));
2980
2981         /* only friction will cause change in linear & angular velocity */
2982         interp_v3_v3v3(pa->state.ave, pa->state.ave, ave, frict);
2983         interp_v3_v3v3(v0_tan, v0_tan, v1_tan, frict);
2984       }
2985       else {
2986         /* just basic friction (unphysical due to the friction model used in Blender) */
2987         interp_v3_v3v3(v0_tan, v0_tan, vc_tan, frict);
2988       }
2989     }
2990
2991     /* Stickiness was possibly added before,
2992      * so cancel that before calculating new normal velocity.
2993      * Otherwise particles go flying out of the surface
2994      * because of high reversed sticky velocity. */
2995     if (v0_dot < 0.0f) {
2996       v0_dot += pd->pdef_stickness;
2997       if (v0_dot > 0.0f) {
2998         v0_dot = 0.0f;
2999       }
3000     }
3001
3002     /* damping and flipping of velocity around normal */
3003     v0_dot *= 1.0f - damp;
3004     vc_dot *= through ? damp : 1.0f;
3005
3006     /* calculate normal particle velocity */
3007     /* special case for object hitting the particle from behind */
3008     if (through == 0 && ((vc_dot > 0.0f && v0_dot > 0.0f && vc_dot > v0_dot) ||
3009                          (vc_dot < 0.0f && v0_dot < 0.0f && vc_dot < v0_dot))) {
3010       mul_v3_v3fl(v0_nor, pce->nor, vc_dot);
3011     }
3012     else if (v0_dot > 0.f) {
3013       mul_v3_v3fl(v0_nor, pce->nor, vc_dot + v0_dot);
3014     }
3015     else {
3016       mul_v3_v3fl(v0_nor, pce->nor, vc_dot + (through ? 1.0f : -1.0f) * v0_dot);
3017     }
3018
3019     /* combine components together again */
3020     add_v3_v3v3(v0, v0_nor, v0_tan);
3021
3022     if (col->boid) {
3023       /* keep boids above ground */
3024       BoidParticle *bpa = pa->boid;
3025       if (bpa->data.mode == eBoidMode_OnLand || co[2] <= col->boid_z) {
3026         co[2] = col->boid_z;
3027         v0[2] = 0.0f;
3028       }
3029     }
3030
3031     /* re-apply acceleration to final location and velocity */
3032     madd_v3_v3v3fl(pa->state.co, co, v0, dt2);
3033     madd_v3_v3fl(pa->state.co, col->acc, 0.5f * dt2 * dt2);
3034     madd_v3_v3v3fl(pa->state.vel, v0, col->acc, dt2);
3035
3036     /* make sure particle stays on the right side of the surface */
3037     if (!through) {
3038       distance = collision_point_distance_with_normal(co, pce, -1.f, col, nor);
3039
3040       if (distance < col->radius + COLLISION_MIN_DISTANCE) {
3041         madd_v3_v3fl(co, nor, col->radius + COLLISION_MIN_DISTANCE - distance);
3042       }
3043
3044       dot = dot_v3v3(nor, v0);
3045       if (dot < 0.f) {
3046         madd_v3_v3fl(v0, nor, -dot);
3047       }
3048
3049       distance = collision_point_distance_with_normal(pa->state.co, pce, 1.f, col, nor);
3050
3051       if (distance < col->radius + COLLISION_MIN_DISTANCE) {
3052         madd_v3_v3fl(pa->state.co, nor, col->radius + COLLISION_MIN_DISTANCE - distance);
3053       }
3054
3055       dot = dot_v3v3(nor, pa->state.vel);
3056       if (dot < 0.f) {
3057         madd_v3_v3fl(pa->state.vel, nor, -dot);
3058       }
3059     }
3060
3061     /* add stickiness to surface */
3062     madd_v3_v3fl(pa->state.vel, pce->nor, -pd->pdef_stickness);
3063
3064     /* set coordinates for next iteration */
3065     copy_v3_v3(col->co1, co);
3066     copy_v3_v3(col->co2, pa->state.co);
3067
3068     copy_v3_v3(col->ve1, v0);
3069     copy_v3_v3(col->ve2, pa->state.vel);
3070
3071     col->f = f;
3072   }
3073
3074   /* if permeability random roll succeeded, disable collider for this sim step */
3075   if (through) {
3076     col->skip[col->skip_count++] = col->hit;
3077   }
3078
3079   return 1;
3080 }
3081 static void collision_fail(ParticleData *pa, ParticleCollision *col)
3082 {
3083   /* final chance to prevent total failure, so stick to the surface and hope for the best */
3084   collision_point_on_surface(col->co1, &col->pce, 1.f, col, pa->state.co);
3085
3086   copy_v3_v3(pa->state.vel, col->pce.vel);
3087   mul_v3_fl(pa->state.vel, col->inv_timestep);
3088
3089   /* printf("max iterations\n"); */
3090 }
3091
3092 /* Particle - Mesh collision detection and response
3093  * Features:
3094  * -friction and damping
3095  * -angular momentum <-> linear momentum
3096  * -high accuracy by re-applying particle acceleration after collision
3097  * -handles moving, rotating and deforming meshes
3098  * -uses Newton-Rhapson iteration to find the collisions
3099  * -handles spherical particles and (nearly) point like particles
3100  */
3101 static void collision_check(ParticleSimulationData *sim, int p, float dfra, float cfra)
3102 {
3103   ParticleSettings *part = sim->psys->part;
3104   ParticleData *pa = sim->psys->particles + p;
3105   ParticleCollision col;
3106   BVHTreeRayHit hit;
3107   int collision_count = 0;
3108
3109   float timestep = psys_get_timestep(sim);
3110
3111   memset(&col, 0, sizeof(ParticleCollision));
3112
3113   col.total_time = timestep * dfra;
3114   col.inv_total_time = 1.0f / col.total_time;
3115   col.inv_timestep = 1.0f / timestep;
3116
3117   col.cfra = cfra;
3118   col.old_cfra = sim->psys->cfra;
3119
3120   /* get acceleration (from gravity, forcefields etc. to be re-applied in collision response) */
3121   sub_v3_v3v3(col.acc, pa->state.vel, pa->prev_state.vel);
3122   mul_v3_fl(col.acc, 1.f / col.total_time);
3123
3124   /* set values for first iteration */
3125   copy_v3_v3(col.co1, pa->prev_state.co);
3126   copy_v3_v3(col.co2, pa->state.co);
3127   copy_v3_v3(col.ve1, pa->prev_state.vel);
3128   copy_v3_v3(col.ve2, pa->state.vel);
3129   col.f = 0.0f;
3130
3131   col.radius = ((part->flag & PART_SIZE_DEFL) || (part->phystype == PART_PHYS_BOIDS)) ?
3132                    pa->size :
3133                    COLLISION_MIN_RADIUS;
3134
3135   /* override for boids */
3136   if (part->phystype == PART_PHYS_BOIDS && part->boids->options & BOID_ALLOW_LAND) {
3137     col.boid = 1;
3138     col.boid_z = pa->state.co[2];
3139     col.skip[col.skip_count++] = pa->boid->ground;
3140   }
3141
3142   /* 10 iterations to catch multiple collisions */
3143   while (collision_count < PARTICLE_COLLISION_MAX_COLLISIONS) {
3144     if (collision_detect(pa, &col, &hit, sim->colliders)) {
3145
3146       collision_count++;
3147
3148       if (collision_count == PARTICLE_COLLISION_MAX_COLLISIONS) {
3149         collision_fail(pa, &col);
3150       }
3151       else if (collision_response(
3152                    sim, pa, &col, &hit, part->flag & PART_DIE_ON_COL, part->flag & PART_ROT_DYN) ==
3153                0) {
3154         return;
3155       }
3156     }
3157     else {
3158       return;
3159     }
3160   }
3161 }
3162 /************************************************/
3163 /*          Hair                                */
3164 /************************************************/
3165 /* check if path cache or children need updating and do it if needed */
3166 static void psys_update_path_cache(ParticleSimulationData *sim,
3167                                    float cfra,
3168                                    const bool use_render_params)
3169 {
3170   ParticleSystem *psys = sim->psys;
3171   ParticleSettings *part = psys->part;
3172   ParticleEditSettings *pset = &sim->scene->toolsettings->particle;
3173   int distr = 0, alloc = 0, skip = 0;
3174
3175   if ((psys->part->childtype &&
3176        psys->totchild != psys_get_tot_child(sim->scene, psys, use_render_params)) ||
3177       psys->recalc & ID_RECALC_PSYS_RESET) {
3178     alloc = 1;
3179   }
3180
3181   if (alloc || psys->recalc & ID_RECALC_PSYS_CHILD ||
3182       (psys->vgroup[PSYS_VG_DENSITY] && (sim->ob && sim->ob->mode & OB_MODE_WEIGHT_PAINT))) {
3183     distr = 1;
3184   }
3185
3186   if (distr) {
3187     if (alloc) {
3188       realloc_particles(sim, sim->psys->totpart);
3189     }
3190
3191     if (psys_get_tot_child(sim->scene, psys, use_render_params)) {
3192       /* don't generate children while computing the hair keys */
3193       if (!(psys->part->type == PART_HAIR) || (psys->flag & PSYS_HAIR_DONE)) {
3194         distribute_particles(sim, PART_FROM_CHILD);
3195
3196         if (part->childtype == PART_CHILD_FACES && part->parents != 0.0f) {
3197           psys_find_parents(sim, use_render_params);
3198         }
3199       }
3200     }
3201     else {
3202       psys_free_children(psys);
3203     }
3204   }
3205
3206   if ((part->type == PART_HAIR || psys->flag & PSYS_KEYED ||
3207        psys->pointcache->flag & PTCACHE_BAKED) == 0) {
3208     skip = 1; /* only hair, keyed and baked stuff can have paths */
3209   }
3210   else if (part->ren_as != PART_DRAW_PATH &&
3211            !(part->type == PART_HAIR && ELEM(part->ren_as, PART_DRAW_OB, PART_DRAW_GR))) {
3212     skip = 1; /* particle visualization must be set as path */
3213   }
3214   else if (DEG_get_mode(sim->depsgraph) != DAG_EVAL_RENDER) {
3215     if (part->draw_as != PART_DRAW_REND) {
3216       skip = 1; /* draw visualization */
3217     }
3218     else if (psys->pointcache->flag & PTCACHE_BAKING) {
3219       skip = 1; /* no need to cache paths while baking dynamics */
3220     }
3221     else if (psys_in_edit_mode(sim->depsgraph, psys)) {
3222       if ((pset->flag & PE_DRAW_PART) == 0) {
3223         skip = 1;
3224       }
3225       else if (part->childtype == 0 &&
3226                (psys->flag & PSYS_HAIR_DYNAMICS && psys->pointcache->flag & PTCACHE_BAKED) == 0) {
3227         skip = 1; /* in edit mode paths are needed for child particles and dynamic hair */
3228       }
3229     }
3230   }
3231
3232   if (!skip) {
3233     psys_cache_paths(sim, cfra, use_render_params);
3234
3235     /* for render, child particle paths are computed on the fly */
3236     if (part->childtype) {
3237       if (!psys->totchild) {
3238         skip = 1;
3239       }
3240       else if (psys->part->type == PART_HAIR && (psys->flag & PSYS_HAIR_DONE) == 0) {
3241         skip = 1;
3242       }
3243
3244       if (!skip) {
3245         psys_cache_child_paths(sim, cfra, 0, use_render_params);
3246       }
3247     }
3248   }
3249   else if (psys->pathcache) {
3250     psys_free_path_cache(psys, NULL);
3251   }
3252 }
3253
3254 static bool psys_hair_use_simulation(ParticleData *pa, float max_length)
3255 {
3256   /* Minimum segment length relative to average length.
3257    * Hairs with segments below this length will be excluded from the simulation,
3258    * because otherwise the solver will become unstable.
3259    * The hair system should always make sure the hair segments have reasonable length ratios,
3260    * but this can happen in old files when e.g. cutting hair.
3261    */
3262   const float min_length = 0.1f * max_length;
3263
3264   HairKey *key;
3265   int k;
3266
3267   if (pa->totkey < 2) {
3268     return false;
3269   }
3270
3271   for (k = 1, key = pa->hair + 1; k < pa->totkey; k++, key++) {
3272     float length = len_v3v3(key->co, (key - 1)->co);
3273     if (length < min_length) {
3274       return false;
3275     }
3276   }
3277
3278   return true;
3279 }
3280
3281 static MDeformVert *hair_set_pinning(MDeformVert *dvert, float weight)
3282 {
3283   if (dvert) {
3284     if (!dvert->totweight) {
3285       dvert->dw = MEM_callocN(sizeof(MDeformWeight), "deformWeight");
3286       dvert->totweight = 1;
3287     }
3288
3289     dvert->dw->weight = weight;
3290     dvert++;
3291   }
3292   return dvert;
3293 }
3294
3295 static void hair_create_input_mesh(ParticleSimulationData *sim,
3296                                    int totpoint,
3297                                    int totedge,
3298                                    Mesh **r_mesh,
3299                                    ClothHairData **r_hairdata)
3300 {
3301   ParticleSystem *psys = sim->psys;
3302   ParticleSettings *part = psys->part;
3303   Mesh *mesh;
3304   ClothHairData *hairdata;
3305   MVert *mvert;
3306   MEdge *medge;
3307   MDeformVert *dvert;
3308   HairKey *key;
3309   PARTICLE_P;
3310   int k, hair_index;
3311   float hairmat[4][4];
3312   float max_length;
3313   float hair_radius;
3314
3315   mesh = *r_mesh;
3316   if (!mesh) {
3317     *r_mesh = mesh = BKE_mesh_new_nomain(totpoint, totedge, 0, 0, 0);
3318     CustomData_add_layer(&mesh->vdata, CD_MDEFORMVERT, CD_CALLOC, NULL, mesh->totvert);
3319     BKE_mesh_update_customdata_pointers(mesh, false);
3320   }
3321   mvert = mesh->mvert;
3322   medge = mesh->medge;
3323   dvert = mesh->dvert;
3324
3325   hairdata = *r_hairdata;
3326   if (!hairdata) {
3327     *r_hairdata = hairdata = MEM_mallocN(sizeof(ClothHairData) * totpoint, "hair data");
3328   }
3329
3330   /* calculate maximum segment length */
3331   max_length = 0.0f;
3332   LOOP_PARTICLES
3333   {
3334     if (!(pa->flag & PARS_UNEXIST)) {
3335       for (k = 1, key = pa->hair + 1; k < pa->totkey; k++, key++) {
3336         float length = len_v3v3(key->co, (key - 1)->co);
3337         if (max_length < length) {
3338           max_length = length;
3339         }
3340       }
3341     }
3342   }
3343
3344   psys->clmd->sim_parms->vgroup_mass = 1;
3345
3346   /* XXX placeholder for more flexible future hair settings */
3347   hair_radius = part->size;
3348
3349   /* make vgroup for pin roots etc.. */
3350   hair_index = 1;
3351   LOOP_PARTICLES
3352   {
3353     if (!(pa->flag & PARS_UNEXIST)) {
3354       float root_mat[4][4];
3355       float bending_stiffness;
3356       bool use_hair;
3357
3358       pa->hair_index = hair_index;
3359       use_hair = psys_hair_use_simulation(pa, max_length);
3360
3361       psys_mat_hair_to_object(sim->ob, sim->psmd->mesh_final, psys->part->from, pa, hairmat);
3362       mul_m4_m4m4(root_mat, sim->ob->obmat, hairmat);
3363       normalize_m4(root_mat);
3364
3365       bending_stiffness = CLAMPIS(
3366           1.0f - part->bending_random * psys_frand(psys, p + 666), 0.0f, 1.0f);
3367
3368       for (k = 0, key = pa->hair; k < pa->totkey; k++, key++) {
3369         ClothHairData *hair;
3370         float *co, *co_next;
3371
3372         co = key->co;
3373         co_next = (key + 1)->co;
3374
3375         /* create fake root before actual root to resist bending */
3376         if (k == 0) {
3377           hair = &psys->clmd->hairdata[pa->hair_index - 1];
3378           copy_v3_v3(hair->loc, root_mat[3]);
3379           copy_m3_m4(hair->rot, root_mat);
3380
3381           hair->radius = hair_radius;
3382           hair->bending_stiffness = bending_stiffness;
3383
3384           add_v3_v3v3(mvert->co, co, co);
3385           sub_v3_v3(mvert->co, co_next);
3386           mul_m4_v3(hairmat, mvert->co);
3387
3388           medge->v1 = pa->hair_index - 1;
3389           medge->v2 = pa->hair_index;
3390
3391           dvert = hair_set_pinning(dvert, 1.0f);
3392
3393           mvert++;
3394           medge++;
3395         }
3396
3397         /* store root transform in cloth data */
3398         hair = &psys->clmd->hairdata[pa->hair_index + k];
3399         copy_v3_v3(hair->loc, root_mat[3]);
3400         copy_m3_m4(hair->rot, root_mat);
3401
3402         hair->radius = hair_radius;
3403         hair->bending_stiffness = bending_stiffness;
3404
3405         copy_v3_v3(mvert->co, co);
3406         mul_m4_v3(hairmat, mvert->co);
3407
3408         if (k) {
3409           medge->v1 = pa->hair_index + k - 1;
3410           medge->v2 = pa->hair_index + k;
3411         }
3412
3413         /* roots and disabled hairs should be 1.0, the rest can be anything from 0.0 to 1.0 */
3414         if (use_hair) {
3415           dvert = hair_set_pinning(dvert, key->weight);
3416         }
3417         else {
3418           dvert = hair_set_pinning(dvert, 1.0f);
3419         }
3420
3421         mvert++;
3422         if (k) {
3423           medge++;
3424         }
3425       }
3426
3427       hair_index += pa->totkey + 1;
3428     }
3429   }
3430 }
3431
3432 static void do_hair_dynamics(ParticleSimulationData *sim)
3433 {
3434   ParticleSystem *psys = sim->psys;
3435   PARTICLE_P;
3436   EffectorWeights *clmd_effweights;
3437   int totpoint;
3438   int totedge;
3439   float(*deformedVerts)[3];
3440   bool realloc_roots;
3441
3442   if (!psys->clmd) {
3443     psys->clmd = (ClothModifierData *)modifier_new(eModifierType_Cloth);
3444     psys->clmd->sim_parms->goalspring = 0.0f;
3445     psys->clmd->sim_parms->flags |= CLOTH_SIMSETTINGS_FLAG_RESIST_SPRING_COMPRESS;
3446     psys->clmd->coll_parms->flags &= ~CLOTH_COLLSETTINGS_FLAG_SELF;
3447   }
3448
3449   /* count simulated points */
3450   totpoint = 0;
3451   totedge = 0;
3452   LOOP_PARTICLES
3453   {
3454     if (!(pa->flag & PARS_UNEXIST)) {
3455       /* "out" dm contains all hairs */
3456       totedge += pa->totkey;
3457       totpoint += pa->totkey + 1; /* +1 for virtual root point */
3458     }
3459   }
3460
3461   /* whether hair root info array has to be reallocated */
3462   realloc_roots = false;
3463   if (psys->hair_in_mesh) {
3464     Mesh *mesh = psys->hair_in_mesh;
3465     if (totpoint != mesh->totvert || totedge != mesh->totedge) {
3466       BKE_id_free(NULL, mesh);
3467       psys->hair_in_mesh = NULL;
3468       realloc_roots = true;
3469     }
3470   }
3471
3472   if (!psys->hair_in_mesh || !psys->clmd->hairdata || realloc_roots) {
3473     if (psys->clmd->hairdata) {
3474       MEM_freeN(psys->clmd->hairdata);
3475       psys->clmd->hairdata = NULL;
3476     }
3477   }
3478
3479   hair_create_input_mesh(sim, totpoint, totedge, &psys->hair_in_mesh, &psys->clmd->hairdata);
3480
3481   if (psys->hair_out_mesh) {
3482     BKE_id_free(NULL, psys->hair_out_mesh);
3483   }
3484
3485   psys->clmd->point_cache = psys->pointcache;
3486   /* for hair sim we replace the internal cloth effector weights temporarily
3487    * to use the particle settings
3488    */
3489   clmd_effweights = psys->clmd->sim_parms->effector_weights;
3490   psys->clmd->sim_parms->effector_weights = psys->part->effector_weights;
3491
3492   BKE_id_copy_ex(NULL, &psys->hair_in_mesh->id, (ID **)&psys->hair_out_mesh, LIB_ID_COPY_LOCALIZE);
3493   deformedVerts = BKE_mesh_vertexCos_get(psys->hair_out_mesh, NULL);
3494   clothModifier_do(
3495       psys->clmd, sim->depsgraph, sim->scene, sim->ob, psys->hair_in_mesh, deformedVerts);
3496   BKE_mesh_apply_vert_coords(psys->hair_out_mesh, deformedVerts);
3497
3498   MEM_freeN(deformedVerts);
3499
3500   /* restore cloth effector weights */
3501   psys->clmd->sim_parms->effector_weights = clmd_effweights;
3502 }
3503 static void hair_step(ParticleSimulationData *sim, float cfra, const bool use_render_params)
3504 {
3505   ParticleSystem *psys = sim->psys;
3506   ParticleSettings *part = psys->part;
3507   PARTICLE_P;
3508   float disp = psys_get_current_display_percentage(psys, use_render_params);
3509
3510   LOOP_PARTICLES
3511   {
3512     pa->size = part->size;
3513     if (part->randsize > 0.0f) {
3514       pa->size *= 1.0f - part->randsize * psys_frand(psys, p + 1);
3515     }
3516
3517     if (psys_frand(psys, p) > disp) {
3518       pa->flag |= PARS_NO_DISP;
3519     }
3520     else {
3521       pa->flag &= ~PARS_NO_DISP;
3522     }
3523   }
3524
3525   if (psys->recalc & ID_RECALC_PSYS_RESET) {
3526     /* need this for changing subsurf levels */
3527     psys_calc_dmcache(sim->ob, sim->psmd->mesh_final, sim->psmd->mesh_original, psys);
3528
3529     if (psys->clmd) {
3530       cloth_free_modifier(psys->clmd);
3531     }
3532   }
3533
3534   /* dynamics with cloth simulation, psys->particles can be NULL with 0 particles [#25519] */
3535   if (psys->part->type == PART_HAIR && psys->flag & PSYS_HAIR_DYNAMICS && psys->particles) {
3536     do_hair_dynamics(sim);
3537   }
3538
3539   /* following lines were removed r29079 but cause bug [#22811], see report for details */
3540   psys_update_effectors(sim);
3541   psys_update_path_cache(sim, cfra, use_render_params);
3542
3543   psys->flag |= PSYS_HAIR_UPDATED;
3544 }
3545
3546 static void save_hair(ParticleSimulationData *sim, float UNUSED(cfra))
3547 {
3548   Object *ob = sim->ob;
3549   ParticleSystem *psys = sim->psys;
3550   HairKey *key, *root;
3551   PARTICLE_P;
3552
3553   invert_m4_m4(ob->imat, ob->obmat);
3554
3555   psys->lattice_deform_data = psys_create_lattice_deform_data(sim);
3556
3557   if (psys->totpart == 0) {
3558     return;
3559   }
3560
3561   /* save new keys for elements if needed */
3562   LOOP_PARTICLES
3563   {
3564     /* first time alloc */
3565     if (pa->totkey == 0 || pa->hair == NULL) {
3566       pa->hair = MEM_callocN((psys->part->hair_step + 1) * sizeof(HairKey), "HairKeys");
3567       pa->totkey = 0;
3568     }
3569
3570     key = root = pa->hair;
3571     key += pa->totkey;
3572
3573     /* convert from global to geometry space */
3574     copy_v3_v3(key->co, pa->state.co);
3575     mul_m4_v3(ob->imat, key->co);
3576
3577     if (pa->totkey) {
3578       sub_v3_v3(key->co, root->co);
3579       psys_vec_rot_to_face(sim->psmd->mesh_final, pa, key->co);
3580     }
3581
3582     key->time = pa->state.time;
3583
3584     key->weight = 1.0f - key->time / 100.0f;
3585
3586     pa->totkey++;
3587
3588     /* Root is always in the origin of hair space
3589      * so we set it to be so after the last key is saved. */
3590     if (pa->totkey == psys->part->hair_step + 1) {
3591       zero_v3(root->co);
3592     }
3593   }
3594 }
3595
3596 /* Code for an adaptive time step based on the Courant-Friedrichs-Lewy
3597  * condition. */
3598 static const float MIN_TIMESTEP = 1.0f / 101.0f;
3599 /* Tolerance of 1.5 means the last subframe neither favors growing nor
3600  * shrinking (e.g if it were 1.3, the last subframe would tend to be too
3601  * small). */
3602 static const float TIMESTEP_EXPANSION_FACTOR = 0.1f;
3603 static const float TIMESTEP_EXPANSION_TOLERANCE = 1.5f;
3604
3605 /* Calculate the speed of the particle relative to the local scale of the
3606  * simulation. This should be called once per particle during a simulation
3607  * step, after the velocity has been updated. element_size defines the scale of