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