- modified patch #4681, for scons compiling
[blender.git] / intern / elbeem / extern / elbeem.h
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-2005 Nils Thuerey
7  *
8  * API header
9  */
10 #ifndef ELBEEM_API_H
11 #define ELBEEM_API_H
12
13
14 // simulation run callback function type (elbeemSimulationSettings->runsimCallback)
15 // best use with FLUIDSIM_CBxxx defines below.
16 // >parameters
17 // return values: 0=continue, 1=stop, 2=abort
18 // data pointer: user data pointer from elbeemSimulationSettings->runsimUserData
19 // status integer: 1=running simulation, 2=new frame saved
20 // frame integer: if status is 1, contains current frame number
21 typedef int (*elbeemRunSimulationCallback)(void *data, int status, int frame);
22 #define FLUIDSIM_CBRET_CONTINUE    0
23 #define FLUIDSIM_CBRET_STOP        1
24 #define FLUIDSIM_CBRET_ABORT       2 
25 #define FLUIDSIM_CBSTATUS_STEP     1 
26 #define FLUIDSIM_CBSTATUS_NEWFRAME 2 
27
28
29 // global settings for the simulation
30 typedef struct elbeemSimulationSettings {
31   /* version number */
32   short version;
33         /* id number of simulation domain, needed if more than a
34          * single domain should be simulated */
35         short domainId;
36
37         /* geometrical extent */
38         float geoStart[3], geoSize[3];
39
40   /* resolutions */
41   short resolutionxyz;
42   short previewresxyz;
43   /* size of the domain in real units (meters along largest resolution x,y,z extent) */
44   float realsize;
45
46   /* fluid properties */
47   double viscosity;
48   /* gravity strength */
49   float gravity[3];
50   /* anim start end time */
51   float animStart, aniFrameTime;
52         /* no. of frames to simulate & output */
53         short noOfFrames;
54   /* g star param (LBM compressibility) */
55   float gstar;
56   /* activate refinement? */
57   short maxRefine;
58   /* probability for surface particle generation (0.0=off) */
59   float generateParticles;
60   /* amount of tracer particles to generate (0=off) */
61   int numTracerParticles;
62
63   /* store output path, and file prefix for baked fluid surface */
64   char outputPath[160+80];
65
66         /* channel for frame time, visc & gravity animations */
67         int channelSizeFrameTime;
68         float *channelFrameTime;
69         int channelSizeViscosity;
70         float *channelViscosity;
71         int channelSizeGravity;
72         float *channelGravity;  // vector
73
74         /* boundary types and settings for domain walls */
75         short obstacleType;
76         float obstaclePartslip;
77         /* generate speed vectors for vertices (e.g. for image based motion blur)*/
78         short generateVertexVectors;
79         /* strength of surface smoothing */
80         float surfaceSmoothing;
81         // TODO add surf gen flags
82
83         /* global transformation to apply to fluidsim mesh */
84         float surfaceTrafo[4*4];
85
86         /* development variables, testing for upcoming releases...*/
87         float farFieldSize;
88
89         /* callback function to notify calling program of performed simulation steps
90          * or newly available frame data, if NULL it is ignored */
91         elbeemRunSimulationCallback runsimCallback;
92         /* pointer passed to runsimCallback for user data storage */
93         void* runsimUserData;
94
95 } elbeemSimulationSettings;
96
97
98 // defines for elbeemMesh->type below
99 #define OB_FLUIDSIM_FLUID       4
100 #define OB_FLUIDSIM_OBSTACLE    8
101 #define OB_FLUIDSIM_INFLOW      16
102 #define OB_FLUIDSIM_OUTFLOW     32
103
104 // defines for elbeemMesh->obstacleType below
105 #define FLUIDSIM_OBSTACLE_NOSLIP     1
106 #define FLUIDSIM_OBSTACLE_PARTSLIP   2
107 #define FLUIDSIM_OBSTACLE_FREESLIP   3
108
109 #define OB_VOLUMEINIT_VOLUME 1
110 #define OB_VOLUMEINIT_SHELL  2
111 #define OB_VOLUMEINIT_BOTH   (OB_VOLUMEINIT_SHELL|OB_VOLUMEINIT_VOLUME)
112
113 // a single mesh object
114 typedef struct elbeemMesh {
115   /* obstacle,fluid or inflow... */
116   short type;
117         /* id of simulation domain it belongs to */
118         short parentDomainId;
119
120         /* vertices */
121   int numVertices;
122         float *vertices; // = float[n][3];
123         /* animated vertices */
124   int channelSizeVertices;
125         float *channelVertices; // = float[channelSizeVertices* (n*3+1) ];
126
127         /* triangles */
128         int   numTriangles;
129   int   *triangles; // = int[][3];
130
131         /* animation channels */
132         int channelSizeTranslation;
133         float *channelTranslation;
134         int channelSizeRotation;
135         float *channelRotation;
136         int channelSizeScale;
137         float *channelScale;
138         
139         /* active channel */
140         int channelSizeActive;
141         float *channelActive;
142         /* initial velocity channel (e.g. for inflow) */
143         int channelSizeInitialVel;
144         float *channelInitialVel; // vector
145         /* use initial velocity in object coordinates? (e.g. for rotation) */
146         short localInivelCoords;
147         /* boundary types and settings */
148         short obstacleType;
149         float obstaclePartslip;
150         /* init volume, shell or both? use OB_VOLUMEINIT_xxx defines above */
151         short volumeInitType;
152
153         /* name of the mesh, mostly for debugging */
154         char *name;
155 } elbeemMesh;
156
157 // API functions
158
159 #ifdef __cplusplus
160 extern "C"  {
161 #endif // __cplusplus
162  
163
164 // reset elbeemSimulationSettings struct with defaults
165 void elbeemResetSettings(struct elbeemSimulationSettings*);
166  
167 // start fluidsim init (returns !=0 upon failure)
168 int elbeemInit(void);
169
170 // start fluidsim init (returns !=0 upon failure)
171 int elbeemAddDomain(struct elbeemSimulationSettings*);
172
173 // get failure message during simulation or init
174 // if an error occured (the string is copied into buffer,
175 // max. length = 256 chars )
176 void elbeemGetErrorString(char *buffer);
177
178 // reset elbeemMesh struct with zeroes
179 void elbeemResetMesh(struct elbeemMesh*);
180
181 // add mesh as fluidsim object
182 int elbeemAddMesh(struct elbeemMesh*);
183
184 // do the actual simulation
185 int elbeemSimulate(void);
186
187 // continue a previously stopped simulation
188 int elbeemContinueSimulation(void);
189
190
191 // helper functions 
192
193 // simplify animation channels
194 // returns if the channel and its size changed
195 int elbeemSimplifyChannelFloat(float *channel, int *size);
196 int elbeemSimplifyChannelVec3(float *channel, int *size);
197
198 // helper functions implemented in utilities.cpp
199
200 /* set elbeem debug output level (0=off to 10=full on) */
201 void elbeemSetDebugLevel(int level);
202 /* elbeem debug output function, prints if debug level >0 */
203 void elbeemDebugOut(char *msg);
204
205 /* estimate how much memory a given setup will require */
206 double elbeemEstimateMemreq(int res,
207     float sx, float sy, float sz,
208     int refine, char *retstr);
209
210
211
212 #ifdef __cplusplus
213 }
214 #endif // __cplusplus
215
216
217
218 /******************************************************************************/
219 // internal defines, do not use for initializing elbeemMesh
220 // structs, for these use OB_xxx defines above
221
222 /*! fluid geometry init types */
223 #define FGI_FLAGSTART   16
224 #define FGI_FLUID                         (1<<(FGI_FLAGSTART+ 0))
225 #define FGI_NO_FLUID      (1<<(FGI_FLAGSTART+ 1))
226 #define FGI_BNDNO                         (1<<(FGI_FLAGSTART+ 2))
227 #define FGI_BNDFREE               (1<<(FGI_FLAGSTART+ 3))
228 #define FGI_BNDPART               (1<<(FGI_FLAGSTART+ 4))
229 #define FGI_NO_BND                (1<<(FGI_FLAGSTART+ 5))
230 #define FGI_MBNDINFLOW  (1<<(FGI_FLAGSTART+ 6))
231 #define FGI_MBNDOUTFLOW (1<<(FGI_FLAGSTART+ 7))
232
233
234 #endif // ELBEEM_API_H