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