initial commit of the fluid simulator.
[blender.git] / intern / elbeem / extern / LBM_fluidsim.h
1 /**
2  * BKE_fluidsim.h 
3  *      
4  * $Id$
5  *
6  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) Blender Foundation.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
33  */
34 #ifndef LBM_FLUIDSIM_H
35 #define LBM_FLUIDSIM_H
36
37 struct Mesh;
38 struct DerivedMesh;
39 struct Object;
40 struct fluidsimDerivedMesh;
41
42 extern double fluidsimViscosityPreset[6];
43 extern char* fluidsimViscosityPresetString[6];
44
45 /* allocates and initializes fluidsim data */
46 struct FluidsimSettings* fluidsimSettingsNew(struct Object *srcob);
47
48 /* frees internal data itself */
49 void fluidsimSettingsFree(struct FluidsimSettings* sb);
50
51 /* export blender geometry to fluid solver */
52 void fluidsimBake(struct Object* ob);
53
54 /* read & write bobj / bobj.gz files (e.g. for fluid sim surface meshes) */
55 void writeBobjgz(char *filename, struct Object *ob);
56 struct Mesh* readBobjgz(char *filename, struct Mesh *orgmesh);
57
58 /* create derived mesh for fluid sim objects */
59 // WARNING - currently implemented in DerivedMesh.c!
60 struct DerivedMesh *getFluidsimDerivedMesh(struct Object *srcob, int useRenderParams, float *extverts, float *nors);
61
62 /* run simulation with given config file */
63 // WARNING - implemented in intern/elbeem/blendercall.cpp
64 int performElbeemSimulation(char *cfgfilename);
65
66 #endif
67
68