Another addition of time values, yet some things to follow
[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->attractforceStrength = 0;
168         mesh->attractforceRadius = 0;
169         mesh->velocityforceStrength = 0;
170         mesh->velocityforceRadius = 0;
171 }
172
173 int globalMeshCounter = 1;
174 // add mesh as fluidsim object
175 extern "C" 
176 int elbeemAddMesh(elbeemMesh *mesh) {
177         int initType;
178         if(getElbeemState() != SIMWORLD_INITIALIZING) { errFatal("elbeemAddMesh","World and domain not initialized, call elbeemInit and elbeemAddDomain before...", SIMWORLD_INITERROR); }
179
180         switch(mesh->type) {
181                 case OB_FLUIDSIM_OBSTACLE: 
182                         if     (mesh->obstacleType==FLUIDSIM_OBSTACLE_PARTSLIP) initType = FGI_BNDPART; 
183                         else if(mesh->obstacleType==FLUIDSIM_OBSTACLE_FREESLIP) initType = FGI_BNDFREE; 
184                         else /*if(mesh->obstacleType==FLUIDSIM_OBSTACLE_NOSLIP)*/ initType = FGI_BNDNO; 
185                         break;
186                 case OB_FLUIDSIM_FLUID: initType = FGI_FLUID; break;
187                 case OB_FLUIDSIM_INFLOW: initType = FGI_MBNDINFLOW; break;
188                 case OB_FLUIDSIM_OUTFLOW: initType = FGI_MBNDOUTFLOW; break;
189                 case OB_FLUIDSIM_CONTROL: initType = FGI_CONTROL; break;
190                 default: return 1; // invalid type
191         }
192         
193         ntlGeometryObjModel *obj = new ntlGeometryObjModel( );
194         gpWorld->getRenderGlobals()->getSimScene()->addGeoClass( obj );
195         obj->initModel(
196                         mesh->numVertices, mesh->vertices, mesh->numTriangles, mesh->triangles,
197                         mesh->channelSizeVertices, mesh->channelVertices );
198         if(mesh->name) obj->setName(string(mesh->name));
199         else {
200                 char meshname[100];
201                 snprintf(meshname,100,"mesh%04d",globalMeshCounter);
202                 obj->setName(string(meshname));
203         }
204         globalMeshCounter++;
205         obj->setGeoInitId( mesh->parentDomainId+1 );
206         obj->setGeoInitIntersect(true);
207         obj->setGeoInitType(initType);
208         obj->setGeoPartSlipValue(mesh->obstaclePartslip);
209         obj->setGeoImpactFactor(mesh->obstacleImpactFactor);
210         
211         /* fluid control features */
212         obj->setCpsTimeStart(mesh->cpsTimeStart);
213         obj->setCpsTimeEnd(mesh->cpsTimeEnd);
214         obj->setAttractForceStrength(mesh->attractforceStrength);
215         obj->setAttractForceRadius(mesh->attractforceRadius);
216         obj->setVelocityForceStrength(mesh->velocityforceStrength);
217         obj->setVelocityForceRadius(mesh->velocityforceRadius);
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         obj->initChannels(
223                         mesh->channelSizeTranslation, mesh->channelTranslation, 
224                         mesh->channelSizeRotation,    mesh->channelRotation, 
225                         mesh->channelSizeScale,       mesh->channelScale,
226                         mesh->channelSizeActive,      mesh->channelActive,
227                         mesh->channelSizeInitialVel,  mesh->channelInitialVel
228                 );
229         obj->setLocalCoordInivel( mesh->localInivelCoords );
230
231         debMsgStd("elbeemAddMesh",DM_MSG,"Added elbeem mesh: "<<obj->getName()<<" type="<<initType<<" "<<obj->getIsAnimated(), 9 );
232         return 0;
233 }
234
235 // do the actual simulation
236 extern "C" 
237 int elbeemSimulate(void) {
238         if(!gpWorld) return 1;
239
240         gpWorld->finishWorldInit();
241         if( isSimworldOk() ) {
242                 myTime_t timestart = getTime();
243                 gpWorld->renderAnimation();
244                 myTime_t timeend = getTime();
245
246                 if(getElbeemState() != SIMWORLD_STOP) {
247                         // ok, we're done...
248                         delete gpWorld;
249                         gpWorld = NULL;
250                         debMsgStd("elbeemSimulate",DM_NOTIFY, "El'Beem simulation done, time: "<<getTimeString(timeend-timestart)<<".\n", 2 ); 
251                 } else {
252                         debMsgStd("elbeemSimulate",DM_NOTIFY, "El'Beem simulation stopped, time so far: "<<getTimeString(timeend-timestart)<<".", 2 ); 
253                 }
254                 return 0;
255         } 
256
257         // failure...
258         return 1;
259 }
260
261
262 // continue a previously stopped simulation
263 extern "C" 
264 int elbeemContinueSimulation(void) {
265
266         if(getElbeemState() != SIMWORLD_STOP) {
267                 errMsg("elbeemContinueSimulation","No running simulation found! Aborting...");
268                 if(gpWorld) delete gpWorld;
269                 return 1;
270         }
271
272         myTime_t timestart = getTime();
273         gpWorld->renderAnimation();
274         myTime_t timeend = getTime();
275
276         if(getElbeemState() != SIMWORLD_STOP) {
277                 // ok, we're done...
278                 delete gpWorld;
279                 gpWorld = NULL;
280                 debMsgStd("elbeemContinueSimulation",DM_NOTIFY, "El'Beem simulation done, time: "<<getTimeString(timeend-timestart)<<".\n", 2 ); 
281         } else {
282                 debMsgStd("elbeemContinueSimulation",DM_NOTIFY, "El'Beem simulation stopped, time so far: "<<getTimeString(timeend-timestart)<<".", 2 ); 
283         }
284         return 0;
285
286
287
288 // global vector to flag values to remove
289 vector<int> gKeepVal;
290
291 #define SIMPLIFY_FLOAT_EPSILON (1e-6f)
292 #define SIMPLIFY_DOUBLE_EPSILON (1e-12f)
293 #define SFLOATEQ(x,y)  (ABS((x)-(y)) < SIMPLIFY_FLOAT_EPSILON)
294 #define SDOUBLEEQ(x,y) (ABS((x)-(y)) < SIMPLIFY_DOUBLE_EPSILON)
295 #define SVECFLOATEQ(x,y)  ( \
296         (ABS((x)[0]-(y)[0]) < SIMPLIFY_FLOAT_EPSILON) && \
297         (ABS((x)[1]-(y)[1]) < SIMPLIFY_FLOAT_EPSILON) && \
298         (ABS((x)[2]-(y)[2]) < SIMPLIFY_FLOAT_EPSILON) )
299
300 // helper function - simplify animation channels
301 extern "C" 
302 int elbeemSimplifyChannelFloat(float *channel, int* size) {
303         bool changed = false;
304         int nsize = *size;
305         int orgsize = *size;
306         if(orgsize<1) return false;
307         gKeepVal.resize( orgsize );
308         for(int i=0; i<orgsize; i++) { gKeepVal[i] = true; }
309         const bool debugSF = false;
310
311         float last = channel[0 + 0];
312         for(int i=1; i<orgsize; i++) {
313                 float curr = channel[2*i + 0];
314                 bool remove = false;
315                 if(SFLOATEQ(curr,last)) remove = true;
316                 // dont remove if next value is different
317                 if((remove)&&(i<orgsize-1)) {
318                         float next = channel[2*(i+1)+0];
319                         if(!SFLOATEQ(next,curr)) remove = false;
320                 }
321                 if(remove) {
322                         changed = true;
323                         gKeepVal[i] = false;
324                         nsize--;
325                 }
326                 if(debugSF) errMsg("elbeemSimplifyChannelFloat","i"<<i<<"/"<<orgsize<<" v"<<channel[ (i*2) + 0 ]<<" t"<<channel[ (i*2) + 1 ]<<"   nsize="<<nsize<<" r"<<remove );
327                 last = curr;
328         }
329
330         if(changed) {
331                 nsize = 1;
332                 for(int i=1; i<orgsize; i++) {
333                         if(gKeepVal[i]) {
334                                 channel[ (nsize*2) + 0 ] = channel[ (i*2) + 0 ];
335                                 channel[ (nsize*2) + 1 ] = channel[ (i*2) + 1 ];
336                                 nsize++;
337                         }
338                 }
339                 *size = nsize;
340         }
341
342         if(debugSF) for(int i=1; i<nsize; i++) {
343                 errMsg("elbeemSimplifyChannelFloat","n i"<<i<<"/"<<nsize<<" v"<<channel[ (i*2) + 0 ]<<" t"<<channel[ (i*2) + 1 ] );
344         }
345
346         return changed;
347 }
348
349 extern "C" 
350 int elbeemSimplifyChannelVec3(float *channel, int* size) {
351         bool changed = false;
352         int nsize = *size;
353         int orgsize = *size;
354         if(orgsize<1) return false;
355         gKeepVal.resize( orgsize );
356         for(int i=0; i<orgsize; i++) { gKeepVal[i] = true; }
357         const bool debugVF = false;
358
359         ntlVec3f last( channel[0 + 0], channel[0 + 1], channel[0 + 2] );
360         for(int i=1; i<orgsize; i++) {
361                 ntlVec3f curr( channel[4*i + 0], channel[4*i + 1], channel[4*i + 2]);
362                 bool remove = false;
363                 if(SVECFLOATEQ(curr,last)) remove = true;
364                 // dont remove if next value is different
365                 if((remove)&&(i<orgsize-1)) {
366                         ntlVec3f next( channel[4*(i+1)+0], channel[4*(i+1)+1], channel[4*(i+1)+2]);
367                         if(!SVECFLOATEQ(next,curr)) remove = false;
368                 }
369                 if(remove) {
370                         changed = true;
371                         gKeepVal[i] = false;
372                         nsize--;
373                 }
374                 if(debugVF) errMsg("elbeemSimplifyChannelVec3","i"<<i<<"/"<<orgsize<<" v"<<
375                                 channel[ (i*4) + 0 ]<<","<< channel[ (i*4) + 1 ]<<","<< channel[ (i*4) + 2 ]<<
376                                 " t"<<channel[ (i*4) + 3 ]<<"   nsize="<<nsize<<" r"<<remove );
377                 last = curr;
378         }
379
380         if(changed) {
381                 nsize = 1;
382                 for(int i=1; i<orgsize; i++) {
383                         if(gKeepVal[i]) {
384                                 for(int j=0; j<4; j++){ channel[ (nsize*4) + j ] = channel[ (i*4) + j ]; }
385                                 nsize++;
386                         }
387                 }
388                 *size = nsize;
389         }
390
391         if(debugVF) for(int i=1; i<nsize; i++) {
392                 errMsg("elbeemSimplifyChannelVec3","n i"<<i<<"/"<<nsize<<" v"<<
393                                 channel[ (i*4) + 0 ]<<","<< channel[ (i*4) + 1 ]<<","<< channel[ (i*4) + 2 ]<<
394                                 " t"<<channel[ (i*4) + 3 ] );
395         }
396
397         return changed;
398 }
399
400
401 #undef SIMPLIFY_FLOAT_EPSILON
402 #undef SIMPLIFY_DOUBLE_EPSILON
403 #undef SFLOATEQ
404 #undef SDOUBLEEQ
405