synched branch with trunk at revision 29109
[blender.git] / source / blender / editors / physics / physics_fluid.c
1 /**
2  * fluidsim.c
3  * 
4  * $Id$
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * The Original Code is Copyright (C) Blender Foundation
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31
32
33
34 #include <math.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <sys/stat.h>
38
39 #ifdef WIN32    /* Windos */
40 #ifndef snprintf
41 #define snprintf _snprintf
42 #endif
43 #endif
44
45 #include "MEM_guardedalloc.h"
46
47 /* types */
48 #include "DNA_anim_types.h"
49 #include "DNA_action_types.h"
50 #include "DNA_object_types.h"
51 #include "DNA_object_fluidsim.h"        
52
53 #include "BLI_blenlib.h"
54 #include "BLI_threads.h"
55 #include "BLI_math.h"
56
57 #include "BKE_animsys.h"
58 #include "BKE_armature.h"
59 #include "BKE_blender.h"
60 #include "BKE_context.h"
61 #include "BKE_customdata.h"
62 #include "BKE_DerivedMesh.h"
63 #include "BKE_displist.h"
64 #include "BKE_effect.h"
65 #include "BKE_fluidsim.h"
66 #include "BKE_global.h"
67 #include "BKE_ipo.h"
68 #include "BKE_key.h"
69 #include "BKE_main.h"
70 #include "BKE_modifier.h"
71 #include "BKE_object.h"
72 #include "BKE_report.h"
73 #include "BKE_scene.h"
74 #include "BKE_softbody.h"
75 #include "BKE_unit.h"
76
77
78 #include "LBM_fluidsim.h"
79
80 #include "BIF_gl.h"
81
82 #include "ED_screen.h"
83
84 #include "WM_types.h"
85
86 #include "physics_intern.h" // own include
87
88 /* enable/disable overall compilation */
89 #ifndef DISABLE_ELBEEM
90
91 #include "WM_api.h"
92
93 #include "DNA_scene_types.h"
94 #include "DNA_ipo_types.h"
95 #include "DNA_mesh_types.h"
96
97 #include "PIL_time.h"
98
99
100 static float get_fluid_viscosity(FluidsimSettings *settings)
101 {
102         switch (settings->viscosityMode) {
103                 case 0:         /* unused */
104                         return -1.0;
105                 case 2:         /* water */
106                         return 1.0e-6;
107                 case 3:         /* some (thick) oil */
108                         return 5.0e-5;
109                 case 4:         /* ca. honey */
110                         return 2.0e-3;
111                 case 1:         /* manual */
112                 default:
113                         return (1.0/pow(10.0, settings->viscosityExponent)) * settings->viscosityValue;
114         }
115 }
116
117 static void get_fluid_gravity(float *gravity, Scene *scene, FluidsimSettings *fss)
118 {
119         if (scene->physics_settings.flag & PHYS_GLOBAL_GRAVITY) {
120                 copy_v3_v3(gravity, scene->physics_settings.gravity);
121         } else {
122                 copy_v3_v3(gravity, &fss->gravx);
123         }
124 }
125
126 static float get_fluid_size_m(Scene *scene, Object *domainob, FluidsimSettings *fss)
127 {
128         if (!scene->unit.system) {
129                 return fss->realsize;
130         } else {
131                 float dim[3];
132                 float longest_axis;
133                 
134                 object_get_dimensions(domainob, dim);
135                 longest_axis = MAX3(dim[0], dim[1], dim[2]);
136                 
137                 return longest_axis * scene->unit.scale_length;
138         }
139 }
140
141 static int fluid_is_animated_mesh(FluidsimSettings *fss)
142 {
143         return ((fss->type == OB_FLUIDSIM_CONTROL) || fss->domainNovecgen);
144 }
145
146 /* ********************** fluid sim settings struct functions ********************** */
147
148 #if 0
149 /* helper function */
150 void fluidsimGetGeometryObjFilename(Object *ob, char *dst) { //, char *srcname) {
151         //snprintf(dst,FILE_MAXFILE, "%s_cfgdata_%s.bobj.gz", srcname, ob->id.name);
152         snprintf(dst,FILE_MAXFILE, "fluidcfgdata_%s.bobj.gz", ob->id.name);
153 }
154 #endif
155
156
157 /* ********************** fluid sim channel helper functions ********************** */
158
159 typedef struct FluidAnimChannels {
160         int length;
161         
162         double aniFrameTime;
163         
164         float *timeAtFrame;
165         float *DomainTime;
166         float *DomainGravity;
167         float *DomainViscosity;
168 } FluidAnimChannels;
169
170 typedef struct FluidObject {
171         struct FluidObject *next, *prev;
172         
173         struct Object *object;
174         
175         float *Translation;
176         float *Rotation;
177         float *Scale;
178         float *Active;
179         
180         float *InitialVelocity;
181         
182         float *AttractforceStrength;
183         float *AttractforceRadius;
184         float *VelocityforceStrength;
185         float *VelocityforceRadius;
186         
187         float *VertexCache;
188         int numVerts, numTris;
189 } FluidObject;
190
191 // no. of entries for the two channel sizes
192 #define CHANNEL_FLOAT 1
193 #define CHANNEL_VEC   3
194
195 // simplify channels before printing
196 // for API this is done anyway upon init
197 #if 0
198 static void fluidsimPrintChannel(FILE *file, float *channel, int paramsize, char *str, int entries) 
199
200         int i,j; 
201         int channelSize = paramsize; 
202
203         if(entries==3) {
204                 elbeemSimplifyChannelVec3( channel, &channelSize); 
205         } else if(entries==1) {
206                 elbeemSimplifyChannelFloat( channel, &channelSize); 
207         } else {
208                 // invalid, cant happen?
209         }
210
211         fprintf(file, "      CHANNEL %s = \n", str); 
212         for(i=0; i<channelSize;i++) { 
213                 fprintf(file,"        ");  
214                 for(j=0;j<=entries;j++) {  // also print time value
215                         fprintf(file," %f ", channel[i*(entries+1)+j] ); 
216                         if(j==entries-1){ fprintf(file,"  "); }
217                 } 
218                 fprintf(file," \n");  
219         } 
220
221         fprintf(file,  "      ; \n" ); 
222 }
223 #endif
224
225
226 /* Note: fluid anim channel data layout
227  * ------------------------------------
228  * CHANNEL_FLOAT:
229  * frame 1     |frame 2
230  * [dataF][time][dataF][time]
231  *
232  * CHANNEL_VEC:
233  * frame 1                   |frame 2
234  * [dataX][dataY][dataZ][time][dataX][dataY][dataZ][time]
235  *
236  */
237
238 static void init_time(FluidsimSettings *domainSettings, FluidAnimChannels *channels)
239 {
240         int i;
241         
242         channels->timeAtFrame = MEM_callocN( (channels->length+1)*sizeof(float), "timeAtFrame channel");
243         
244         channels->timeAtFrame[0] = channels->timeAtFrame[1] = domainSettings->animStart; // start at index 1
245         
246         for(i=2; i<=channels->length; i++) {
247                 channels->timeAtFrame[i] = channels->timeAtFrame[i-1] + channels->aniFrameTime;
248         }
249 }
250
251 /* if this is slow, can replace with faster, less readable code */
252 static void set_channel(float *channel, float time, float *value, int i, int size)
253 {
254         if (size == CHANNEL_FLOAT) {
255                 channel[(i * 2) + 0] = value[0];
256                 channel[(i * 2) + 1] = time;
257         }
258         else if (size == CHANNEL_VEC) {
259                 channel[(i * 4) + 0] = value[0];
260                 channel[(i * 4) + 1] = value[1];
261                 channel[(i * 4) + 2] = value[2];
262                 channel[(i * 4) + 3] = time;
263         }
264 }
265
266 static void set_vertex_channel(float *channel, float time, struct Scene *scene, struct FluidObject *fobj, int i)
267 {
268         Object *ob = fobj->object;
269         FluidsimModifierData *fluidmd = (FluidsimModifierData *)modifiers_findByType(ob, eModifierType_Fluidsim);
270         float *verts;
271         int *tris=NULL, numVerts=0, numTris=0;
272         int modifierIndex = modifiers_indexInObject(ob, (ModifierData *)fluidmd);
273         int framesize = (3*fobj->numVerts) + 1;
274         int j;
275         
276         if (channel == NULL)
277                 return;
278         
279         initElbeemMesh(scene, ob, &numVerts, &verts, &numTris, &tris, 1, modifierIndex);
280         
281         /* don't allow mesh to change number of verts in anim sequence */
282         if (numVerts != fobj->numVerts) {
283                 MEM_freeN(channel);
284                 channel = NULL;
285                 return;
286         }
287         
288         /* fill frame of channel with vertex locations */
289         for(j=0; j < (3*numVerts); j++) {
290                 channel[i*framesize + j] = verts[j];
291         }
292         channel[i*framesize + framesize-1] = time;
293         
294         MEM_freeN(verts);
295         MEM_freeN(tris);
296 }
297
298 static void free_domain_channels(FluidAnimChannels *channels)
299 {
300         MEM_freeN(channels->timeAtFrame);
301         channels->timeAtFrame = NULL;
302         MEM_freeN(channels->DomainGravity);
303         channels->DomainGravity = NULL;
304         MEM_freeN(channels->DomainViscosity);
305         channels->DomainViscosity = NULL;
306 }
307
308 static void free_all_fluidobject_channels(ListBase *fobjects)
309 {
310         FluidObject *fobj;
311         
312         for (fobj=fobjects->first; fobj; fobj=fobj->next) {
313                 if (fobj->Translation) {
314                         MEM_freeN(fobj->Translation);
315                         fobj->Translation = NULL;
316                         MEM_freeN(fobj->Rotation);
317                         fobj->Rotation = NULL;
318                         MEM_freeN(fobj->Scale);
319                         fobj->Scale = NULL;
320                         MEM_freeN(fobj->Active);
321                         fobj->Active = NULL;
322                         MEM_freeN(fobj->InitialVelocity);
323                         fobj->InitialVelocity = NULL;
324                 }
325                 
326                 if (fobj->AttractforceStrength) {
327                         MEM_freeN(fobj->AttractforceStrength);
328                         fobj->AttractforceStrength = NULL;
329                         MEM_freeN(fobj->AttractforceRadius);
330                         fobj->AttractforceRadius = NULL;
331                         MEM_freeN(fobj->VelocityforceStrength);
332                         fobj->VelocityforceStrength = NULL;
333                         MEM_freeN(fobj->VelocityforceRadius);
334                         fobj->VelocityforceRadius = NULL;
335                 }
336                 
337                 if (fobj->VertexCache) {
338                         MEM_freeN(fobj->VertexCache);
339                         fobj->VertexCache = NULL;
340                 }
341         }
342 }
343
344 static void fluid_init_all_channels(bContext *C, Object *fsDomain, FluidsimSettings *domainSettings, FluidAnimChannels *channels, ListBase *fobjects)
345 {
346         Scene *scene = CTX_data_scene(C);
347         Base *base;
348         int i;
349         int length = channels->length;
350         float eval_time;
351         
352         /* XXX: first init time channel - temporary for now */
353         /* init time values (should be done after evaluating animated time curve) */
354         init_time(domainSettings, channels);
355         
356         /* allocate domain animation channels */
357         channels->DomainGravity = MEM_callocN( length * (CHANNEL_VEC+1) * sizeof(float), "channel DomainGravity");
358         channels->DomainViscosity = MEM_callocN( length * (CHANNEL_FLOAT+1) * sizeof(float), "channel DomainViscosity");
359         //channels->DomainTime = MEM_callocN( length * (CHANNEL_FLOAT+1) * sizeof(float), "channel DomainTime");
360         
361         /* allocate fluid objects */
362         for (base=scene->base.first; base; base= base->next) {
363                 Object *ob = base->object;
364                 FluidsimModifierData *fluidmd = (FluidsimModifierData *)modifiers_findByType(ob, eModifierType_Fluidsim);
365                 
366                 if (fluidmd) {
367                         FluidObject *fobj = MEM_callocN(sizeof(FluidObject), "Fluid Object");
368                         fobj->object = ob;
369                         
370                         if (ELEM(fluidmd->fss->type, OB_FLUIDSIM_DOMAIN, OB_FLUIDSIM_PARTICLE)) {
371                                 BLI_addtail(fobjects, fobj);
372                                 continue;
373                         }
374                         
375                         fobj->Translation = MEM_callocN( length * (CHANNEL_VEC+1) * sizeof(float), "fluidobject Translation");
376                         fobj->Rotation = MEM_callocN( length * (CHANNEL_VEC+1) * sizeof(float), "fluidobject Rotation");
377                         fobj->Scale = MEM_callocN( length * (CHANNEL_VEC+1) * sizeof(float), "fluidobject Scale");
378                         fobj->Active = MEM_callocN( length * (CHANNEL_FLOAT+1) * sizeof(float), "fluidobject Active");
379                         fobj->InitialVelocity = MEM_callocN( length * (CHANNEL_VEC+1) * sizeof(float), "fluidobject InitialVelocity");
380                         
381                         if (fluidmd->fss->type == OB_FLUIDSIM_CONTROL) {
382                                 fobj->AttractforceStrength = MEM_callocN( length * (CHANNEL_FLOAT+1) * sizeof(float), "fluidobject AttractforceStrength");
383                                 fobj->AttractforceRadius = MEM_callocN( length * (CHANNEL_FLOAT+1) * sizeof(float), "fluidobject AttractforceRadius");
384                                 fobj->VelocityforceStrength = MEM_callocN( length * (CHANNEL_FLOAT+1) * sizeof(float), "fluidobject VelocityforceStrength");
385                                 fobj->VelocityforceRadius = MEM_callocN( length * (CHANNEL_FLOAT+1) * sizeof(float), "fluidobject VelocityforceRadius");
386                         }
387                         
388                         if (fluid_is_animated_mesh(fluidmd->fss)) {
389                                 float *verts=NULL;
390                                 int *tris=NULL, modifierIndex = modifiers_indexInObject(ob, (ModifierData *)fluidmd);
391
392                                 initElbeemMesh(scene, ob, &fobj->numVerts, &verts, &fobj->numTris, &tris, 0, modifierIndex);
393                                 fobj->VertexCache = MEM_callocN( length *((fobj->numVerts*CHANNEL_VEC)+1) * sizeof(float), "fluidobject VertexCache");
394                                 
395                                 MEM_freeN(verts);
396                                 MEM_freeN(tris);
397                         }
398                         
399                         BLI_addtail(fobjects, fobj);
400                 }
401         }
402         
403         /* now we loop over the frames and fill the allocated channels with data */
404         for (i=0; i<channels->length; i++) {
405                 FluidObject *fobj;
406                 float viscosity, gravity[3];
407                 float timeAtFrame;
408                 
409                 eval_time = domainSettings->bakeStart + i;
410                 timeAtFrame = channels->timeAtFrame[i+1];
411                 
412                 /* XXX: This can't be used due to an anim sys optimisation that ignores recalc object animation,
413                  * leaving it for the depgraph (this ignores object animation such as modifier properties though... :/ )
414                  * --> BKE_animsys_evaluate_all_animation(G.main, eval_time);
415                  * This doesn't work with drivers:
416                  * --> BKE_animsys_evaluate_animdata(&fsDomain->id, fsDomain->adt, eval_time, ADT_RECALC_ALL);
417                  */
418                 
419                 /* Modifying the global scene isn't nice, but we can do it in 
420                  * this part of the process before a threaded job is created */
421                 scene->r.cfra = (int)eval_time;
422                 ED_update_for_newframe(C, 1);
423                 
424                 /* now scene data should be current according to animation system, so we fill the channels */
425                 
426                 /* Domain properties - gravity/viscosity/time */
427                 get_fluid_gravity(gravity, scene, domainSettings);
428                 set_channel(channels->DomainGravity, timeAtFrame, gravity, i, CHANNEL_VEC);
429                 viscosity = get_fluid_viscosity(domainSettings);
430                 set_channel(channels->DomainViscosity, timeAtFrame, &viscosity, i, CHANNEL_FLOAT);
431                 // XXX : set_channel(channels->DomainTime, timeAtFrame, &time, i, CHANNEL_VEC);
432                 
433                 /* object movement */
434                 for (fobj=fobjects->first; fobj; fobj=fobj->next) {
435                         Object *ob = fobj->object;
436                         FluidsimModifierData *fluidmd = (FluidsimModifierData *)modifiers_findByType(ob, eModifierType_Fluidsim);
437                         float active= (float)(fluidmd->fss->flag & OB_FLUIDSIM_ACTIVE);
438                         float rot_d[3], rot_360[3] = {360.f, 360.f, 360.f};
439                         
440                         if (ELEM(fluidmd->fss->type, OB_FLUIDSIM_DOMAIN, OB_FLUIDSIM_PARTICLE))
441                                 continue;
442                         
443                         /* init euler rotation values and convert to elbeem format */
444                         BKE_rotMode_change_values(ob->quat, ob->rot, ob->rotAxis, &ob->rotAngle, ob->rotmode, ROT_MODE_EUL);
445                         mul_v3_v3fl(rot_d, ob->rot, 180.f/M_PI);
446                         sub_v3_v3v3(rot_d, rot_360, rot_d);
447                         
448                         set_channel(fobj->Translation, timeAtFrame, ob->loc, i, CHANNEL_VEC);
449                         set_channel(fobj->Rotation, timeAtFrame, rot_d, i, CHANNEL_VEC);
450                         set_channel(fobj->Scale, timeAtFrame, ob->size, i, CHANNEL_VEC);
451                         set_channel(fobj->Active, timeAtFrame, &active, i, CHANNEL_FLOAT);
452                         set_channel(fobj->InitialVelocity, timeAtFrame, &fluidmd->fss->iniVelx, i, CHANNEL_VEC);
453                         
454                         if (fluidmd->fss->type == OB_FLUIDSIM_CONTROL) {
455                                 set_channel(fobj->AttractforceStrength, timeAtFrame, &fluidmd->fss->attractforceStrength, i, CHANNEL_FLOAT);
456                                 set_channel(fobj->AttractforceRadius, timeAtFrame, &fluidmd->fss->attractforceRadius, i, CHANNEL_FLOAT);
457                                 set_channel(fobj->VelocityforceStrength, timeAtFrame, &fluidmd->fss->velocityforceStrength, i, CHANNEL_FLOAT);
458                                 set_channel(fobj->VelocityforceRadius, timeAtFrame, &fluidmd->fss->velocityforceRadius, i, CHANNEL_FLOAT);
459                         }
460                         
461                         if (fluid_is_animated_mesh(fluidmd->fss)) {
462                                 set_vertex_channel(fobj->VertexCache, timeAtFrame, scene, fobj, i);
463                         }
464                 }
465         }
466 }
467
468 static void export_fluid_objects(ListBase *fobjects, Scene *scene, int length)
469 {
470         FluidObject *fobj;
471         
472         for (fobj=fobjects->first; fobj; fobj=fobj->next) {
473                 Object *ob = fobj->object;
474                 FluidsimModifierData *fluidmd = (FluidsimModifierData *)modifiers_findByType(ob, eModifierType_Fluidsim);
475                 int modifierIndex = modifiers_indexInObject(ob, (ModifierData *)fluidmd);
476                 
477                 float *verts=NULL;
478                 int *tris=NULL;
479                 int numVerts=0, numTris=0;
480                 int deform = fluid_is_animated_mesh(fluidmd->fss);
481                 
482                 elbeemMesh fsmesh;
483                 
484                 if (ELEM(fluidmd->fss->type, OB_FLUIDSIM_DOMAIN, OB_FLUIDSIM_PARTICLE))
485                         continue;
486                 
487                 elbeemResetMesh( &fsmesh );
488                 
489                 fsmesh.type = fluidmd->fss->type;
490                 fsmesh.name = ob->id.name;
491                 
492                 initElbeemMesh(scene, ob, &numVerts, &verts, &numTris, &tris, 0, modifierIndex);
493                 
494                 fsmesh.numVertices   = numVerts;
495                 fsmesh.numTriangles  = numTris;
496                 fsmesh.vertices      = verts;
497                 fsmesh.triangles     = tris;
498                 
499                 fsmesh.channelSizeTranslation  = 
500                 fsmesh.channelSizeRotation     = 
501                 fsmesh.channelSizeScale        = 
502                 fsmesh.channelSizeInitialVel   = 
503                 fsmesh.channelSizeActive       = length;
504                 
505                 fsmesh.channelTranslation      = fobj->Translation;
506                 fsmesh.channelRotation         = fobj->Rotation;
507                 fsmesh.channelScale            = fobj->Scale;
508                 fsmesh.channelActive           = fobj->Active;
509                 
510                 if( ELEM(fsmesh.type, OB_FLUIDSIM_FLUID, OB_FLUIDSIM_INFLOW)) {
511                         fsmesh.channelInitialVel = fobj->InitialVelocity;
512                         fsmesh.localInivelCoords = ((fluidmd->fss->typeFlags & OB_FSINFLOW_LOCALCOORD)?1:0);
513                 } 
514                 
515                 if(fluidmd->fss->typeFlags & OB_FSBND_NOSLIP)
516                         fsmesh.obstacleType = FLUIDSIM_OBSTACLE_NOSLIP;
517                 else if(fluidmd->fss->typeFlags & OB_FSBND_PARTSLIP)
518                         fsmesh.obstacleType = FLUIDSIM_OBSTACLE_PARTSLIP;
519                 else if(fluidmd->fss->typeFlags & OB_FSBND_FREESLIP)
520                         fsmesh.obstacleType = FLUIDSIM_OBSTACLE_FREESLIP;
521                 
522                 fsmesh.obstaclePartslip = fluidmd->fss->partSlipValue;
523                 fsmesh.volumeInitType = fluidmd->fss->volumeInitType;
524                 fsmesh.obstacleImpactFactor = fluidmd->fss->surfaceSmoothing; // misused value
525                 
526                 if (fsmesh.type == OB_FLUIDSIM_CONTROL) {
527                         fsmesh.cpsTimeStart = fluidmd->fss->cpsTimeStart;
528                         fsmesh.cpsTimeEnd = fluidmd->fss->cpsTimeEnd;
529                         fsmesh.cpsQuality = fluidmd->fss->cpsQuality;
530                         fsmesh.obstacleType = (fluidmd->fss->flag & OB_FLUIDSIM_REVERSE);
531                         
532                         fsmesh.channelSizeAttractforceRadius = 
533                         fsmesh.channelSizeVelocityforceStrength = 
534                         fsmesh.channelSizeVelocityforceRadius = 
535                         fsmesh.channelSizeAttractforceStrength = length;
536                         
537                         fsmesh.channelAttractforceStrength = fobj->AttractforceStrength;
538                         fsmesh.channelAttractforceRadius = fobj->AttractforceRadius;
539                         fsmesh.channelVelocityforceStrength = fobj->VelocityforceStrength;
540                         fsmesh.channelVelocityforceRadius = fobj->VelocityforceRadius;
541                 }
542                 else {
543                         fsmesh.channelAttractforceStrength =
544                         fsmesh.channelAttractforceRadius = 
545                         fsmesh.channelVelocityforceStrength = 
546                         fsmesh.channelVelocityforceRadius = NULL; 
547                 }
548                 
549                 /* animated meshes */
550                 if(deform) {
551                         fsmesh.channelSizeVertices = length;
552                         fsmesh.channelVertices = fobj->VertexCache;
553                                 
554                         // remove channels
555                         fsmesh.channelTranslation      = 
556                         fsmesh.channelRotation         = 
557                         fsmesh.channelScale            = NULL; 
558                 }
559                 
560                 elbeemAddMesh(&fsmesh);
561                 
562                 if(verts) MEM_freeN(verts);
563                 if(tris) MEM_freeN(tris);
564                 if(fsmesh.channelVertices) MEM_freeN(fsmesh.channelVertices);
565         }
566 }
567
568 static int fluid_validate_scene(ReportList *reports, Scene *scene, Object *fsDomain)
569 {
570         Base *base;
571         Object *newdomain = NULL;
572         int channelObjCount = 0;
573         int fluidInputCount = 0;
574
575         for(base=scene->base.first; base; base= base->next)
576         {
577                 Object *ob = base->object;
578                 FluidsimModifierData *fluidmdtmp = (FluidsimModifierData *)modifiers_findByType(ob, eModifierType_Fluidsim);                    
579
580                 /* only find objects with fluid modifiers */
581                 if (!fluidmdtmp || ob->type != OB_MESH) continue;
582                         
583                 if(fluidmdtmp->fss->type == OB_FLUIDSIM_DOMAIN) {
584                         /* if no initial domain object given, find another potential domain */
585                         if (!fsDomain) {
586                                 newdomain = ob;
587                         }
588                         /* if there's more than one domain, cancel */
589                         else if (fsDomain && ob != fsDomain) {
590                                 BKE_report(reports, RPT_ERROR, "There should be only one domain object.");
591                                 return 0;
592                         }
593                 }
594                 
595                 /* count number of objects needed for animation channels */
596                 if ( !ELEM(fluidmdtmp->fss->type, OB_FLUIDSIM_DOMAIN, OB_FLUIDSIM_PARTICLE) )
597                         channelObjCount++;
598                 
599                 /* count number of fluid input objects */
600                 if (ELEM(fluidmdtmp->fss->type, OB_FLUIDSIM_FLUID, OB_FLUIDSIM_INFLOW))
601                         fluidInputCount++;
602         }
603
604         if (newdomain)
605                 fsDomain = newdomain;
606         
607         if (!fsDomain) {
608                 BKE_report(reports, RPT_ERROR, "No domain object found.");
609                 return 0;
610         }
611         
612         if (channelObjCount>=255) {
613                 BKE_report(reports, RPT_ERROR, "Cannot bake with more then 256 objects.");
614                 return 0;
615         }
616         
617         if (fluidInputCount == 0) {
618                 BKE_report(reports, RPT_ERROR, "No fluid input objects in the scene.");
619                 return 0;
620         }
621         
622         return 1;
623 }
624
625
626 #define FLUID_SUFFIX_CONFIG             "fluidsim.cfg"
627 #define FLUID_SUFFIX_SURFACE    "fluidsurface"
628
629 static int fluid_init_filepaths(Object *fsDomain, char *targetDir, char *targetFile, char *debugStrBuffer)
630 {
631         FluidsimModifierData *fluidmd = (FluidsimModifierData *)modifiers_findByType(fsDomain, eModifierType_Fluidsim);
632         FluidsimSettings *domainSettings= fluidmd->fss; 
633         FILE *fileCfg;
634         int dirExist = 0;
635         char newSurfdataPath[FILE_MAXDIR+FILE_MAXFILE]; // modified output settings
636         char *suffixConfig = FLUID_SUFFIX_CONFIG;
637         int outStringsChanged = 0;
638         
639         // prepare names...
640         strncpy(targetDir, domainSettings->surfdataPath, FILE_MAXDIR);
641         strncpy(newSurfdataPath, domainSettings->surfdataPath, FILE_MAXDIR);
642         BLI_path_abs(targetDir, G.sce); // fixed #frame-no 
643         
644         strcpy(targetFile, targetDir);
645         strcat(targetFile, suffixConfig);
646         strcat(targetFile,".tmp"); // dont overwrite/delete original file
647         // make sure all directories exist
648         // as the bobjs use the same dir, this only needs to be checked
649         // for the cfg output
650         BLI_make_existing_file(targetFile);
651         
652         // check selected directory
653         // simply try to open cfg file for writing to test validity of settings
654         fileCfg = fopen(targetFile, "w");
655         if(fileCfg) { 
656                 dirExist = 1; fclose(fileCfg); 
657                 // remove cfg dummy from  directory test
658                 BLI_delete(targetFile, 0,0);
659         }
660         
661         if((strlen(targetDir)<1) || (!dirExist)) {
662                 char blendDir[FILE_MAXDIR+FILE_MAXFILE];
663                 char blendFile[FILE_MAXDIR+FILE_MAXFILE];
664                 
665                 // invalid dir, reset to current/previous
666                 strcpy(blendDir, G.sce);
667                 BLI_splitdirstring(blendDir, blendFile);
668                 if(strlen(blendFile)>6){
669                         int len = strlen(blendFile);
670                         if( (blendFile[len-6]=='.')&& (blendFile[len-5]=='b')&& (blendFile[len-4]=='l')&&
671                            (blendFile[len-3]=='e')&& (blendFile[len-2]=='n')&& (blendFile[len-1]=='d') ){
672                                 blendFile[len-6] = '\0';
673                         }
674                 }
675                 // todo... strip .blend ?
676                 snprintf(newSurfdataPath,FILE_MAXFILE+FILE_MAXDIR,"//fluidsimdata/%s_%s_", blendFile, fsDomain->id.name);
677                 
678                 snprintf(debugStrBuffer,256,"fluidsimBake::error - warning resetting output dir to '%s'\n", newSurfdataPath);
679                 elbeemDebugOut(debugStrBuffer);
680                 outStringsChanged=1;
681         }
682         
683         // check if modified output dir is ok
684 #if 0
685         if(outStringsChanged) {
686                 char dispmsg[FILE_MAXDIR+FILE_MAXFILE+256];
687                 int  selection=0;
688                 strcpy(dispmsg,"Output settings set to: '");
689                 strcat(dispmsg, newSurfdataPath);
690                 strcat(dispmsg, "'%t|Continue with changed settings%x1|Discard and abort%x0");
691                 
692                 // ask user if thats what he/she wants...
693                 selection = pupmenu(dispmsg);
694                 if(selection<1) return 0; // 0 from menu, or -1 aborted
695                 strcpy(targetDir, newSurfdataPath);
696                 strncpy(domainSettings->surfdataPath, newSurfdataPath, FILE_MAXDIR);
697                 BLI_path_abs(targetDir, G.sce); // fixed #frame-no 
698         }
699 #endif  
700         return outStringsChanged;
701 }
702
703 /* ******************************************************************************** */
704 /* ********************** write fluidsim config to file ************************* */
705 /* ******************************************************************************** */
706
707 typedef struct FluidBakeJob {
708         /* from wmJob */
709         void *owner;
710         short *stop, *do_update;
711         float *progress;
712         int current_frame;
713         elbeemSimulationSettings *settings;
714 } FluidBakeJob;
715
716 static void fluidbake_free(void *customdata)
717 {
718         FluidBakeJob *fb= customdata;
719         MEM_freeN(fb);
720 }
721
722 /* called by fluidbake, only to check job 'stop' value */
723 static int fluidbake_breakjob(void *customdata)
724 {
725         //FluidBakeJob *fb= (FluidBakeJob *)customdata;
726         //return *(fb->stop);
727         
728         /* this is not nice yet, need to make the jobs list template better 
729          * for identifying/acting upon various different jobs */
730         /* but for now we'll reuse the render break... */
731         return (G.afbreek);
732 }
733
734 /* called by fluidbake, wmJob sends notifier */
735 static void fluidbake_updatejob(void *customdata, float progress)
736 {
737         FluidBakeJob *fb= customdata;
738         
739         *(fb->do_update)= 1;
740         *(fb->progress)= progress;
741 }
742
743 static void fluidbake_startjob(void *customdata, short *stop, short *do_update, float *progress)
744 {
745         FluidBakeJob *fb= customdata;
746         
747         fb->stop= stop;
748         fb->do_update = do_update;
749         fb->progress = progress;
750         
751         G.afbreek= 0;   /* XXX shared with render - replace with job 'stop' switch */
752         
753         elbeemSimulate();
754         *do_update= 1;
755         *stop = 0;
756 }
757
758 static void fluidbake_endjob(void *customdata)
759 {
760         FluidBakeJob *fb= customdata;
761         
762         if (fb->settings) {
763                 MEM_freeN(fb->settings);
764                 fb->settings = NULL;
765         }
766 }
767
768 int runSimulationCallback(void *data, int status, int frame) {
769         FluidBakeJob *fb = (FluidBakeJob *)data;
770         elbeemSimulationSettings *settings = fb->settings;
771         //printf("elbeem blender cb s%d, f%d, domainid:%d \n", status,frame, settings->domainId ); // DEBUG
772         
773         if (status == FLUIDSIM_CBSTATUS_NEWFRAME) {
774                 fluidbake_updatejob(fb, frame / (float)settings->noOfFrames);
775         }
776         
777         if (fluidbake_breakjob(fb))  {
778                 return FLUIDSIM_CBRET_ABORT;
779         }
780         
781         return FLUIDSIM_CBRET_CONTINUE;
782 }
783
784 int fluidsimBake(bContext *C, ReportList *reports, Object *fsDomain)
785 {
786         Scene *scene= CTX_data_scene(C);
787         int i;
788         FluidsimSettings *domainSettings;
789
790         char debugStrBuffer[256];
791         
792         int gridlevels = 0;
793         const char *strEnvName = "BLENDER_ELBEEMDEBUG"; // from blendercall.cpp
794         char *suffixConfig = FLUID_SUFFIX_CONFIG;
795         char *suffixSurface = FLUID_SUFFIX_SURFACE;
796
797         char targetDir[FILE_MAXDIR+FILE_MAXFILE];  // store & modify output settings
798         char targetFile[FILE_MAXDIR+FILE_MAXFILE]; // temp. store filename from targetDir for access
799         int  outStringsChanged = 0;             // modified? copy back before baking
800
801         float domainMat[4][4];
802         float invDomMat[4][4];
803
804         int noFrames;
805         int origFrame = scene->r.cfra;
806         
807         FluidAnimChannels *channels = MEM_callocN(sizeof(FluidAnimChannels), "fluid domain animation channels");
808         ListBase *fobjects = MEM_callocN(sizeof(ListBase), "fluid objects");
809         FluidsimModifierData *fluidmd = NULL;
810         Mesh *mesh = NULL;
811         
812         wmJob *steve;
813         FluidBakeJob *fb;
814         elbeemSimulationSettings *fsset= MEM_callocN(sizeof(elbeemSimulationSettings), "Fluid sim settings");
815         
816         steve= WM_jobs_get(CTX_wm_manager(C), CTX_wm_window(C), scene, "Fluid Sim", WM_JOB_PROGRESS);
817         fb= MEM_callocN(sizeof(FluidBakeJob), "fluid bake job");
818         
819         if(getenv(strEnvName)) {
820                 int dlevel = atoi(getenv(strEnvName));
821                 elbeemSetDebugLevel(dlevel);
822                 snprintf(debugStrBuffer,256,"fluidsimBake::msg: Debug messages activated due to envvar '%s'\n",strEnvName); 
823                 elbeemDebugOut(debugStrBuffer);
824         }
825         
826         /* make sure it corresponds to startFrame setting (old: noFrames = scene->r.efra - scene->r.sfra +1) */;
827         noFrames = scene->r.efra - 0;
828         if(noFrames<=0) {
829                 BKE_report(reports, RPT_ERROR, "No frames to export - check your animation range settings.");
830                 return 0;
831         }
832         
833         /* check scene for sane object/modifier settings */
834         if (!fluid_validate_scene(reports, scene, fsDomain)) {
835                 return 0;
836         }
837
838         
839         /* these both have to be valid, otherwise we wouldnt be here */
840         fluidmd = (FluidsimModifierData *)modifiers_findByType(fsDomain, eModifierType_Fluidsim);
841         domainSettings = fluidmd->fss;
842         mesh = fsDomain->data;
843         
844         domainSettings->bakeStart = 1;
845         domainSettings->bakeEnd = scene->r.efra;
846         
847         // calculate bounding box
848         fluid_get_bb(mesh->mvert, mesh->totvert, fsDomain->obmat, domainSettings->bbStart, domainSettings->bbSize);
849         
850         // reset last valid frame
851         domainSettings->lastgoodframe = -1;
852         
853         /* rough check of settings... */
854         if(domainSettings->previewresxyz > domainSettings->resolutionxyz) {
855                 snprintf(debugStrBuffer,256,"fluidsimBake::warning - Preview (%d) >= Resolution (%d)... setting equal.\n", domainSettings->previewresxyz ,  domainSettings->resolutionxyz); 
856                 elbeemDebugOut(debugStrBuffer);
857                 domainSettings->previewresxyz = domainSettings->resolutionxyz;
858         }
859         // set adaptive coarsening according to resolutionxyz
860         // this should do as an approximation, with in/outflow
861         // doing this more accurate would be overkill
862         // perhaps add manual setting?
863         if(domainSettings->maxRefine <0) {
864                 if(domainSettings->resolutionxyz>128) {
865                         gridlevels = 2;
866                 } else
867                 if(domainSettings->resolutionxyz>64) {
868                         gridlevels = 1;
869                 } else {
870                         gridlevels = 0;
871                 }
872         } else {
873                 gridlevels = domainSettings->maxRefine;
874         }
875         snprintf(debugStrBuffer,256,"fluidsimBake::msg: Baking %s, refine: %d\n", fsDomain->id.name , gridlevels ); 
876         elbeemDebugOut(debugStrBuffer);
877         
878         
879         
880         /* ******** prepare output file paths ******** */
881         outStringsChanged = fluid_init_filepaths(fsDomain, targetDir, targetFile, debugStrBuffer);
882         channels->length = scene->r.efra;
883         channels->aniFrameTime = (domainSettings->animEnd - domainSettings->animStart)/(double)noFrames;
884         
885         /* ******** initialise and allocate animation channels ******** */
886         fluid_init_all_channels(C, fsDomain, domainSettings, channels, fobjects);
887
888         /* reset to original current frame */
889         scene->r.cfra = origFrame;
890         ED_update_for_newframe(C, 1);
891         
892         
893         /* ---- XXX: No Time animation curve for now, leaving this code here for reference 
894          
895         { int timeIcu[1] = { FLUIDSIM_TIME };
896                 float timeDef[1] = { 1. };
897
898                 // time channel is a bit special, init by hand...
899                 timeAtIndex = MEM_callocN( (allchannelSize+1)*1*sizeof(float), "fluidsiminit_timeatindex");
900                 for(i=0; i<=scene->r.efra; i++) {
901                         timeAtIndex[i] = (float)(i-startFrame);
902                 }
903                 fluidsimInitChannel(scene, &channelDomainTime, allchannelSize, timeAtIndex, timeIcu,timeDef, domainSettings->ipo, CHANNEL_FLOAT ); // NDEB
904                 // time channel is a multiplicator for 
905                 if(channelDomainTime) {
906                         for(i=0; i<allchannelSize; i++) { 
907                                 channelDomainTime[i*2+0] = aniFrameTime * channelDomainTime[i*2+0]; 
908                                 if(channelDomainTime[i*2+0]<0.) channelDomainTime[i*2+0] = 0.;
909                         }
910                 }
911                 timeAtFrame = MEM_callocN( (allchannelSize+1)*1*sizeof(float), "fluidsiminit_timeatframe");
912                 timeAtFrame[0] = timeAtFrame[1] = domainSettings->animStart; // start at index 1
913                 if(channelDomainTime) {
914                         for(i=2; i<=allchannelSize; i++) {
915                                 timeAtFrame[i] = timeAtFrame[i-1]+channelDomainTime[(i-1)*2+0];
916                         }
917                 fsset->} else {
918                         for(i=2; i<=allchannelSize; i++) { timeAtFrame[i] = timeAtFrame[i-1]+aniFrameTime; }
919                 }
920
921         } // domain channel init
922         */
923                 
924         /* ******** init domain object's matrix ******** */
925         copy_m4_m4(domainMat, fsDomain->obmat);
926         if(!invert_m4_m4(invDomMat, domainMat)) {
927                 snprintf(debugStrBuffer,256,"fluidsimBake::error - Invalid obj matrix?\n"); 
928                 elbeemDebugOut(debugStrBuffer);
929                 BKE_report(reports, RPT_ERROR, "Invalid object matrix."); 
930
931                 free_domain_channels(channels);
932                 MEM_freeN(channels);
933                 
934                 free_all_fluidobject_channels(fobjects);
935                 BLI_freelistN(fobjects);
936                 MEM_freeN(fobjects);
937                 return 0;
938         }
939
940         /* ********  start writing / exporting ******** */
941         strcpy(targetFile, targetDir);
942         strcat(targetFile, suffixConfig);
943         strcat(targetFile,".tmp");  // dont overwrite/delete original file
944         
945         // make sure these directories exist as well
946         if(outStringsChanged) {
947                 BLI_make_existing_file(targetFile);
948         }
949
950         /* ******** export domain to elbeem ******** */
951         elbeemResetSettings(fsset);
952         fsset->version = 1;
953
954         // setup global settings
955         copy_v3_v3(fsset->geoStart, domainSettings->bbStart);
956         copy_v3_v3(fsset->geoSize, domainSettings->bbSize);
957         
958         // simulate with 50^3
959         fsset->resolutionxyz = (int)domainSettings->resolutionxyz;
960         fsset->previewresxyz = (int)domainSettings->previewresxyz;
961
962         fsset->realsize = get_fluid_size_m(scene, fsDomain, domainSettings);
963         fsset->viscosity = get_fluid_viscosity(domainSettings);
964         get_fluid_gravity(fsset->gravity, scene, domainSettings);
965
966         // simulate 5 frames, each 0.03 seconds, output to ./apitest_XXX.bobj.gz
967         fsset->animStart = domainSettings->animStart;
968         fsset->aniFrameTime = channels->aniFrameTime;
969         fsset->noOfFrames = noFrames; // is otherwise subtracted in parser
970
971         strcpy(targetFile, targetDir);
972         strcat(targetFile, suffixSurface);
973         // defaults for compressibility and adaptive grids
974         fsset->gstar = domainSettings->gstar;
975         fsset->maxRefine = domainSettings->maxRefine; // check <-> gridlevels
976         fsset->generateParticles = domainSettings->generateParticles; 
977         fsset->numTracerParticles = domainSettings->generateTracers; 
978         fsset->surfaceSmoothing = domainSettings->surfaceSmoothing; 
979         fsset->surfaceSubdivs = domainSettings->surfaceSubdivs; 
980         fsset->farFieldSize = domainSettings->farFieldSize; 
981         strcpy( fsset->outputPath, targetFile);
982
983         // domain channels
984         fsset->channelSizeFrameTime = 
985         fsset->channelSizeViscosity = 
986         fsset->channelSizeGravity = channels->length;
987         fsset->channelFrameTime = channels->DomainTime;
988         fsset->channelViscosity = channels->DomainViscosity;
989         fsset->channelGravity = channels->DomainGravity;
990         
991         fsset->runsimCallback = &runSimulationCallback;
992         fsset->runsimUserData = fb;
993
994         if (domainSettings->typeFlags & OB_FSBND_NOSLIP)                fsset->domainobsType = FLUIDSIM_OBSTACLE_NOSLIP;
995         else if (domainSettings->typeFlags&OB_FSBND_PARTSLIP)   fsset->domainobsType = FLUIDSIM_OBSTACLE_PARTSLIP;
996         else if (domainSettings->typeFlags&OB_FSBND_FREESLIP)   fsset->domainobsType = FLUIDSIM_OBSTACLE_FREESLIP;
997         fsset->domainobsPartslip = domainSettings->partSlipValue;
998         fsset->generateVertexVectors = (domainSettings->domainNovecgen==0);
999
1000         // init blender domain transform matrix
1001         { int j; 
1002         for(i=0; i<4; i++) {
1003                 for(j=0; j<4; j++) {
1004                         fsset->surfaceTrafo[i*4+j] = invDomMat[j][i];
1005                 }
1006         } }
1007
1008         /* ******** init solver with settings ******** */
1009         elbeemInit();
1010         elbeemAddDomain(fsset);
1011         
1012         /* ******** export all fluid objects to elbeem ******** */
1013         export_fluid_objects(fobjects, scene, channels->length);
1014         
1015         /* custom data for fluid bake job */
1016         fb->settings = fsset;
1017         
1018         /* setup job */
1019         WM_jobs_customdata(steve, fb, fluidbake_free);
1020         WM_jobs_timer(steve, 0.1, NC_SCENE|ND_FRAME, NC_SCENE|ND_FRAME);
1021         WM_jobs_callbacks(steve, fluidbake_startjob, NULL, NULL, fluidbake_endjob);
1022         
1023         WM_jobs_start(CTX_wm_manager(C), steve);
1024
1025         /* ******** free stored animation data ******** */
1026         free_domain_channels(channels);
1027         MEM_freeN(channels);
1028         
1029         free_all_fluidobject_channels(fobjects);
1030         BLI_freelistN(fobjects);
1031         MEM_freeN(fobjects);
1032
1033         // elbeemFree();
1034         return 1;
1035 }
1036
1037 void fluidsimFreeBake(Object *ob)
1038 {
1039         /* not implemented yet */
1040 }
1041
1042 #else /* DISABLE_ELBEEM */
1043
1044 /* compile dummy functions for disabled fluid sim */
1045
1046 FluidsimSettings *fluidsimSettingsNew(Object *srcob)
1047 {
1048         return NULL;
1049 }
1050
1051 void fluidsimSettingsFree(FluidsimSettings *fss)
1052 {
1053 }
1054
1055 FluidsimSettings* fluidsimSettingsCopy(FluidsimSettings *fss)
1056 {
1057         return NULL;
1058 }
1059
1060 /* only compile dummy functions */
1061 int fluidsimBake(bContext *C, ReportList *reports, Object *ob)
1062 {
1063         return 0;
1064 }
1065
1066 void fluidsimFreeBake(Object *ob)
1067 {
1068 }
1069
1070 #endif /* DISABLE_ELBEEM */
1071
1072 /***************************** Operators ******************************/
1073
1074 static int fluid_bake_exec(bContext *C, wmOperator *op)
1075 {
1076         Object *ob= CTX_data_active_object(C);
1077
1078         if(!fluidsimBake(C, op->reports, ob))
1079                 return OPERATOR_CANCELLED;
1080
1081         return OPERATOR_FINISHED;
1082 }
1083
1084 void FLUID_OT_bake(wmOperatorType *ot)
1085 {
1086         /* identifiers */
1087         ot->name= "Fluid Simulation Bake";
1088         ot->description= "Bake fluid simulation";
1089         ot->idname= "FLUID_OT_bake";
1090         
1091         /* api callbacks */
1092         ot->exec= fluid_bake_exec;
1093         ot->poll= ED_operator_object_active_editable;
1094 }
1095