00fc9ef68543a7bd2bc0eecd42f1f6280a00d99f
[blender.git] / intern / elbeem / intern / elbeem.cpp
1 /******************************************************************************
2  *
3  * El'Beem - Free Surface Fluid Simulation with the Lattice Boltzmann Method
4  * All code distributed as part of El'Beem is covered by the version 2 of the 
5  * GNU General Public License. See the file COPYING for details.
6  * Copyright 2003-2006 Nils Thuerey
7  *
8  * Main program functions
9  */
10
11 #include "elbeem.h"
12 #include "ntl_blenderdumper.h"
13 extern "C" void elbeemCheckDebugEnv(void);
14
15 #include "ntl_world.h"
16 #include "ntl_geometrymodel.h"
17
18 /*****************************************************************************/
19 // region of interest global vars
20 // currently used by e.g. fsgr solver
21 double guiRoiSX = 0.0;
22 double guiRoiSY = 0.0;
23 double guiRoiSZ = 0.0;
24 double guiRoiEX = 1.0;
25 double guiRoiEY = 1.0;
26 double guiRoiEZ = 1.0;
27 int guiRoiMaxLev=6, guiRoiMinLev=0;
28
29 //! global raytracer pointer (=world)
30 ntlWorld *gpWorld = NULL;
31
32
33
34 // API
35
36 // reset elbeemSimulationSettings struct with defaults
37 extern "C" 
38 void elbeemResetSettings(elbeemSimulationSettings *set) {
39         if(!set) return;
40   set->version = 3;
41   set->domainId = 0;
42         for(int i=0 ; i<3; i++) set->geoStart[i] = 0.0;
43         for(int i=0 ; i<3; i++) set->geoSize[i] = 1.0;
44   set->resolutionxyz = 64;
45   set->previewresxyz = 24;
46   set->realsize = 1.0;
47   set->viscosity = 0.000001;
48
49         for(int i=0 ; i<2; i++) set->gravity[i] = 0.0;
50         set->gravity[2] = -9.81;
51
52   set->animStart = 0; 
53         set->aniFrameTime = 0.01;
54         set->noOfFrames = 10;
55   set->gstar = 0.005;
56   set->maxRefine = -1;
57   set->generateParticles = 0.0;
58   set->numTracerParticles = 0;
59   strcpy(set->outputPath,"./elbeemdata_");
60
61         set->channelSizeFrameTime=0;
62         set->channelFrameTime=NULL;
63         set->channelSizeViscosity=0;
64         set->channelViscosity=NULL;
65         set->channelSizeGravity=0;
66         set->channelGravity=NULL; 
67
68         set->domainobsType= FLUIDSIM_OBSTACLE_NOSLIP;
69         set->domainobsPartslip= 0.;
70         set->generateVertexVectors = 0;
71         set->surfaceSmoothing = 1.;
72         set->surfaceSubdivs = 1;
73
74         set->farFieldSize = 0.;
75         set->runsimCallback = NULL;
76         set->runsimUserData = NULL;
77
78         // init identity
79         for(int i=0; i<16; i++) set->surfaceTrafo[i] = 0.0;
80         for(int i=0; i<4; i++) set->surfaceTrafo[i*4+i] = 1.0;
81 }
82
83 // start fluidsim init
84 extern "C" 
85 int elbeemInit() {
86         setElbeemState( SIMWORLD_INITIALIZING );
87         setElbeemErrorString("[none]");
88         resetGlobalColorSetting();
89
90         elbeemCheckDebugEnv();
91         debMsgStd("performElbeemSimulation",DM_NOTIFY,"El'Beem Simulation Init Start as Plugin, debugLevel:"<<gDebugLevel<<" ...\n", 2);
92         
93         // create world object with initial settings
94         ntlBlenderDumper *elbeem = new ntlBlenderDumper(); 
95         gpWorld = elbeem;
96         return 0;
97 }
98
99 // start fluidsim init
100 extern "C" 
101 int elbeemAddDomain(elbeemSimulationSettings *settings) {
102         // has to be inited...
103         if((getElbeemState() == SIMWORLD_INVALID) && (!gpWorld)) { elbeemInit(); }
104         if(getElbeemState() != SIMWORLD_INITIALIZING) { errFatal("elbeemAddDomain","Unable to init simulation world",SIMWORLD_INITERROR); }
105         // create domain with given settings
106         gpWorld->addDomain(settings);
107         return 0;
108 }
109
110 // error message access
111 extern "C" 
112 void elbeemGetErrorString(char *buffer) {
113         if(!buffer) return;
114         strncpy(buffer,getElbeemErrorString(),256);
115 }
116
117 // reset elbeemMesh struct with zeroes
118 extern "C" 
119 void elbeemResetMesh(elbeemMesh *mesh) {
120         if(!mesh) return;
121         // init typedef struct elbeemMesh
122   mesh->type = 0;
123
124         mesh->parentDomainId = 0;
125
126         /* vertices */
127   mesh->numVertices = 0;
128         mesh->vertices = NULL;
129
130         mesh->channelSizeVertices = 0;
131         mesh->channelVertices = NULL;
132
133         /* triangles */
134         mesh->numTriangles = 0;
135   mesh->triangles = NULL;
136
137         /* animation channels */
138         mesh->channelSizeTranslation = 0;
139         mesh->channelTranslation = NULL;
140         mesh->channelSizeRotation = 0;
141         mesh->channelRotation = NULL;
142         mesh->channelSizeScale = 0;
143         mesh->channelScale = NULL;
144
145         /* active channel */
146         mesh->channelSizeActive = 0;
147         mesh->channelActive = NULL;
148
149         mesh->channelSizeInitialVel = 0;
150         mesh->channelInitialVel = NULL;
151
152         mesh->localInivelCoords = 0;
153
154         mesh->obstacleType= FLUIDSIM_OBSTACLE_NOSLIP;
155         mesh->obstaclePartslip= 0.;
156         mesh->obstacleImpactFactor= 1.;
157
158         mesh->volumeInitType= OB_VOLUMEINIT_VOLUME;
159
160         /* name of the mesh, mostly for debugging */
161         mesh->name = "[unnamed]";
162         
163         /* fluid control settings */
164         mesh->cpsTimeStart = 0;
165         mesh->cpsTimeEnd = 0;
166         
167         mesh->channelSizeAttractforceStrength = 0;
168         mesh->channelAttractforceStrength = NULL;
169         mesh->channelSizeAttractforceRadius = 0;
170         mesh->channelAttractforceRadius = NULL;
171         mesh->channelSizeVelocityforceStrength = 0;
172         mesh->channelVelocityforceStrength = NULL;
173         mesh->channelSizeVelocityforceRadius = 0;
174         mesh->channelVelocityforceRadius = NULL;
175 }
176
177 int globalMeshCounter = 1;
178 // add mesh as fluidsim object
179 extern "C" 
180 int elbeemAddMesh(elbeemMesh *mesh) {
181         int initType;
182         if(getElbeemState() != SIMWORLD_INITIALIZING) { errFatal("elbeemAddMesh","World and domain not initialized, call elbeemInit and elbeemAddDomain before...", SIMWORLD_INITERROR); }
183
184         switch(mesh->type) {
185                 case OB_FLUIDSIM_OBSTACLE: 
186                         if     (mesh->obstacleType==FLUIDSIM_OBSTACLE_PARTSLIP) initType = FGI_BNDPART; 
187                         else if(mesh->obstacleType==FLUIDSIM_OBSTACLE_FREESLIP) initType = FGI_BNDFREE; 
188                         else /*if(mesh->obstacleType==FLUIDSIM_OBSTACLE_NOSLIP)*/ initType = FGI_BNDNO; 
189                         break;
190                 case OB_FLUIDSIM_FLUID: initType = FGI_FLUID; break;
191                 case OB_FLUIDSIM_INFLOW: initType = FGI_MBNDINFLOW; break;
192                 case OB_FLUIDSIM_OUTFLOW: initType = FGI_MBNDOUTFLOW; break;
193                 case OB_FLUIDSIM_CONTROL: initType = FGI_CONTROL; break;
194                 default: return 1; // invalid type
195         }
196         
197         ntlGeometryObjModel *obj = new ntlGeometryObjModel( );
198         gpWorld->getRenderGlobals()->getSimScene()->addGeoClass( obj );
199         obj->initModel(
200                         mesh->numVertices, mesh->vertices, mesh->numTriangles, mesh->triangles,
201                         mesh->channelSizeVertices, mesh->channelVertices );
202         if(mesh->name) obj->setName(string(mesh->name));
203         else {
204                 char meshname[100];
205                 snprintf(meshname,100,"mesh%04d",globalMeshCounter);
206                 obj->setName(string(meshname));
207         }
208         globalMeshCounter++;
209         obj->setGeoInitId( mesh->parentDomainId+1 );
210         obj->setGeoInitIntersect(true);
211         obj->setGeoInitType(initType);
212         obj->setGeoPartSlipValue(mesh->obstaclePartslip);
213         obj->setGeoImpactFactor(mesh->obstacleImpactFactor);
214         
215         /* fluid control features */
216         obj->setCpsTimeStart(mesh->cpsTimeStart);
217         obj->setCpsTimeEnd(mesh->cpsTimeEnd);
218         
219         if((mesh->volumeInitType<VOLUMEINIT_VOLUME)||(mesh->volumeInitType>VOLUMEINIT_BOTH)) mesh->volumeInitType = VOLUMEINIT_VOLUME;
220         obj->setVolumeInit(mesh->volumeInitType);
221         // use channel instead, obj->setInitialVelocity( ntlVec3Gfx(mesh->iniVelocity[0], mesh->iniVelocity[1], mesh->iniVelocity[2]) );
222         
223         obj->initChannels(
224                         mesh->channelSizeTranslation, mesh->channelTranslation, 
225                         mesh->channelSizeRotation,    mesh->channelRotation, 
226                         mesh->channelSizeScale,       mesh->channelScale,
227                         mesh->channelSizeActive,      mesh->channelActive,
228                         mesh->channelSizeInitialVel,  mesh->channelInitialVel,
229                         mesh->channelSizeAttractforceStrength,  mesh->channelAttractforceStrength,
230                         mesh->channelSizeAttractforceRadius,  mesh->channelAttractforceRadius,
231                         mesh->channelSizeVelocityforceStrength,  mesh->channelVelocityforceStrength,
232                         mesh->channelSizeVelocityforceRadius,  mesh->channelVelocityforceRadius
233                 );
234         obj->setLocalCoordInivel( mesh->localInivelCoords );
235
236         debMsgStd("elbeemAddMesh",DM_MSG,"Added elbeem mesh: "<<obj->getName()<<" type="<<initType<<" "<<obj->getIsAnimated(), 9 );
237         return 0;
238 }
239
240 // do the actual simulation
241 extern "C" 
242 int elbeemSimulate(void) {
243         if(!gpWorld) return 1;
244
245         gpWorld->finishWorldInit();
246         if( isSimworldOk() ) {
247                 myTime_t timestart = getTime();
248                 gpWorld->renderAnimation();
249                 myTime_t timeend = getTime();
250
251                 if(getElbeemState() != SIMWORLD_STOP) {
252                         // ok, we're done...
253                         delete gpWorld;
254                         gpWorld = NULL;
255                         debMsgStd("elbeemSimulate",DM_NOTIFY, "El'Beem simulation done, time: "<<getTimeString(timeend-timestart)<<".\n", 2 ); 
256                 } else {
257                         debMsgStd("elbeemSimulate",DM_NOTIFY, "El'Beem simulation stopped, time so far: "<<getTimeString(timeend-timestart)<<".", 2 ); 
258                 }
259                 return 0;
260         } 
261
262         // failure...
263         return 1;
264 }
265
266
267 // continue a previously stopped simulation
268 extern "C" 
269 int elbeemContinueSimulation(void) {
270
271         if(getElbeemState() != SIMWORLD_STOP) {
272                 errMsg("elbeemContinueSimulation","No running simulation found! Aborting...");
273                 if(gpWorld) delete gpWorld;
274                 return 1;
275         }
276
277         myTime_t timestart = getTime();
278         gpWorld->renderAnimation();
279         myTime_t timeend = getTime();
280
281         if(getElbeemState() != SIMWORLD_STOP) {
282                 // ok, we're done...
283                 delete gpWorld;
284                 gpWorld = NULL;
285                 debMsgStd("elbeemContinueSimulation",DM_NOTIFY, "El'Beem simulation done, time: "<<getTimeString(timeend-timestart)<<".\n", 2 ); 
286         } else {
287                 debMsgStd("elbeemContinueSimulation",DM_NOTIFY, "El'Beem simulation stopped, time so far: "<<getTimeString(timeend-timestart)<<".", 2 ); 
288         }
289         return 0;
290
291
292
293 // global vector to flag values to remove
294 vector<int> gKeepVal;
295
296 #define SIMPLIFY_FLOAT_EPSILON (1e-6f)
297 #define SIMPLIFY_DOUBLE_EPSILON (1e-12f)
298 #define SFLOATEQ(x,y)  (ABS((x)-(y)) < SIMPLIFY_FLOAT_EPSILON)
299 #define SDOUBLEEQ(x,y) (ABS((x)-(y)) < SIMPLIFY_DOUBLE_EPSILON)
300 #define SVECFLOATEQ(x,y)  ( \
301         (ABS((x)[0]-(y)[0]) < SIMPLIFY_FLOAT_EPSILON) && \
302         (ABS((x)[1]-(y)[1]) < SIMPLIFY_FLOAT_EPSILON) && \
303         (ABS((x)[2]-(y)[2]) < SIMPLIFY_FLOAT_EPSILON) )
304
305 // helper function - simplify animation channels
306 extern "C" 
307 int elbeemSimplifyChannelFloat(float *channel, int* size) {
308         bool changed = false;
309         int nsize = *size;
310         int orgsize = *size;
311         if(orgsize<1) return false;
312         gKeepVal.resize( orgsize );
313         for(int i=0; i<orgsize; i++) { gKeepVal[i] = true; }
314         const bool debugSF = false;
315
316         float last = channel[0 + 0];
317         for(int i=1; i<orgsize; i++) {
318                 float curr = channel[2*i + 0];
319                 bool remove = false;
320                 if(SFLOATEQ(curr,last)) remove = true;
321                 // dont remove if next value is different
322                 if((remove)&&(i<orgsize-1)) {
323                         float next = channel[2*(i+1)+0];
324                         if(!SFLOATEQ(next,curr)) remove = false;
325                 }
326                 if(remove) {
327                         changed = true;
328                         gKeepVal[i] = false;
329                         nsize--;
330                 }
331                 if(debugSF) errMsg("elbeemSimplifyChannelFloat","i"<<i<<"/"<<orgsize<<" v"<<channel[ (i*2) + 0 ]<<" t"<<channel[ (i*2) + 1 ]<<"   nsize="<<nsize<<" r"<<remove );
332                 last = curr;
333         }
334
335         if(changed) {
336                 nsize = 1;
337                 for(int i=1; i<orgsize; i++) {
338                         if(gKeepVal[i]) {
339                                 channel[ (nsize*2) + 0 ] = channel[ (i*2) + 0 ];
340                                 channel[ (nsize*2) + 1 ] = channel[ (i*2) + 1 ];
341                                 nsize++;
342                         }
343                 }
344                 *size = nsize;
345         }
346
347         if(debugSF) for(int i=1; i<nsize; i++) {
348                 errMsg("elbeemSimplifyChannelFloat","n i"<<i<<"/"<<nsize<<" v"<<channel[ (i*2) + 0 ]<<" t"<<channel[ (i*2) + 1 ] );
349         }
350
351         return changed;
352 }
353
354 extern "C" 
355 int elbeemSimplifyChannelVec3(float *channel, int* size) {
356         bool changed = false;
357         int nsize = *size;
358         int orgsize = *size;
359         if(orgsize<1) return false;
360         gKeepVal.resize( orgsize );
361         for(int i=0; i<orgsize; i++) { gKeepVal[i] = true; }
362         const bool debugVF = false;
363
364         ntlVec3f last( channel[0 + 0], channel[0 + 1], channel[0 + 2] );
365         for(int i=1; i<orgsize; i++) {
366                 ntlVec3f curr( channel[4*i + 0], channel[4*i + 1], channel[4*i + 2]);
367                 bool remove = false;
368                 if(SVECFLOATEQ(curr,last)) remove = true;
369                 // dont remove if next value is different
370                 if((remove)&&(i<orgsize-1)) {
371                         ntlVec3f next( channel[4*(i+1)+0], channel[4*(i+1)+1], channel[4*(i+1)+2]);
372                         if(!SVECFLOATEQ(next,curr)) remove = false;
373                 }
374                 if(remove) {
375                         changed = true;
376                         gKeepVal[i] = false;
377                         nsize--;
378                 }
379                 if(debugVF) errMsg("elbeemSimplifyChannelVec3","i"<<i<<"/"<<orgsize<<" v"<<
380                                 channel[ (i*4) + 0 ]<<","<< channel[ (i*4) + 1 ]<<","<< channel[ (i*4) + 2 ]<<
381                                 " t"<<channel[ (i*4) + 3 ]<<"   nsize="<<nsize<<" r"<<remove );
382                 last = curr;
383         }
384
385         if(changed) {
386                 nsize = 1;
387                 for(int i=1; i<orgsize; i++) {
388                         if(gKeepVal[i]) {
389                                 for(int j=0; j<4; j++){ channel[ (nsize*4) + j ] = channel[ (i*4) + j ]; }
390                                 nsize++;
391                         }
392                 }
393                 *size = nsize;
394         }
395
396         if(debugVF) for(int i=1; i<nsize; i++) {
397                 errMsg("elbeemSimplifyChannelVec3","n i"<<i<<"/"<<nsize<<" v"<<
398                                 channel[ (i*4) + 0 ]<<","<< channel[ (i*4) + 1 ]<<","<< channel[ (i*4) + 2 ]<<
399                                 " t"<<channel[ (i*4) + 3 ] );
400         }
401
402         return changed;
403 }
404
405
406 #undef SIMPLIFY_FLOAT_EPSILON
407 #undef SIMPLIFY_DOUBLE_EPSILON
408 #undef SFLOATEQ
409 #undef SDOUBLEEQ
410