Fix for own mistake: arc diff swallowed a commit somehow, breaking
[blender.git] / source / blender / makesdna / DNA_object_fluidsim.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2004-2005 by Blender Foundation
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_object_fluidsim.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_OBJECT_FLUIDSIM_H__
33 #define __DNA_OBJECT_FLUIDSIM_H__
34
35 #include "DNA_ID.h"
36 #include "DNA_defs.h"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41         
42 struct Mesh;
43 struct Ipo;
44
45 typedef struct FluidVertexVelocity {
46         float vel[3];
47 } FluidVertexVelocity;
48         
49 typedef struct FluidsimSettings {
50         struct FluidsimModifierData *fmd; /* for fast RNA access */
51         /* threadcont the calculation is done with */
52         int threads;
53         int pad1;
54         /* domain, fluid or obstacle */
55         short type;
56         /* display advanced options in fluid sim tab (on=1, off=0)*/
57         short show_advancedoptions;
58
59         /* domain object settings */
60         /* resolutions */
61         short resolutionxyz;
62         short previewresxyz;
63         /* size of the domain in real units (meters along largest resolution x, y, z extent) */
64         float realsize;
65         /* show original meshes, preview or final sim */
66         short guiDisplayMode;
67         short renderDisplayMode;
68
69         /* fluid properties */
70         float viscosityValue;
71         short viscosityMode DNA_DEPRECATED;
72         short viscosityExponent;
73         /* gravity strength */
74         float grav[3];
75         /* anim start end time (in seconds) */
76         float animStart, animEnd;
77         /* bake start end time (in blender frames) */
78         int bakeStart, bakeEnd;
79         /* offset for baked frames */
80         int frameOffset;
81         int pad2;
82         /* g star param (LBM compressibility) */
83         float gstar;
84         /* activate refinement? */
85         int maxRefine;
86         
87         /* fluid object type settings */
88         /* gravity strength */
89         float iniVelx, iniVely, iniVelz;
90
91         /* store pointer to original mesh (for replacing the current one) */
92         struct Mesh *orgMesh;
93         /* a mesh to display the bounding box used for simulation */
94         struct Mesh *meshBB;
95
96         /* store output path, and file prefix for baked fluid surface */
97         /* strlens; 256= FILE_MAXFILE, 768= FILE_MAXDIR */
98         char surfdataPath[1024];
99
100         /* store start coords of axis aligned bounding box together with size */
101         /* values are inited during derived mesh display */
102         float bbStart[3], bbSize[3];
103
104         /* animated params */
105         struct Ipo *ipo;
106
107         /* additional flags depending on the type, lower short contains flags
108          * to check validity, higher short additional flags */
109         short typeFlags;
110         /* switch off velocity genration, volume init type for fluid/obstacles (volume=1, shell=2, both=3) */
111         char  domainNovecgen, volumeInitType;
112
113         /* boundary "stickiness" for part slip values */
114         float partSlipValue;
115
116         /* number of tracers to generate */
117         int generateTracers;
118         /* particle generation - on if >0, then determines amount (experimental...) */
119         float generateParticles;
120         /* smooth fluid surface? */
121         float surfaceSmoothing;
122         /* number of surface subdivisions*/
123         int surfaceSubdivs;
124         int flag; /* GUI flags */
125
126         /* particle display - size scaling, and alpha influence */
127         float particleInfSize, particleInfAlpha;
128         /* testing vars */
129         float farFieldSize;
130
131         /* vertex velocities of simulated fluid mesh */
132         struct FluidVertexVelocity *meshVelocities;
133         /* number of vertices in simulated fluid mesh */
134         int totvert;
135         
136         /* Fluid control settings */
137         float cpsTimeStart;
138         float cpsTimeEnd;
139         float cpsQuality;
140         
141         float attractforceStrength;
142         float attractforceRadius;
143         float velocityforceStrength;
144         float velocityforceRadius;
145
146         int lastgoodframe;
147         
148         /* Simulation/flow rate control (i.e. old "Fac-Time") */
149         float animRate;
150 } FluidsimSettings;
151
152 /* ob->fluidsimSettings defines */
153 #define OB_FLUIDSIM_ENABLE                      1
154 #define OB_FLUIDSIM_DOMAIN                      2
155 #define OB_FLUIDSIM_FLUID                       4
156 #define OB_FLUIDSIM_OBSTACLE            8
157 #define OB_FLUIDSIM_INFLOW                      16
158 #define OB_FLUIDSIM_OUTFLOW                     32
159 #define OB_FLUIDSIM_PARTICLE            64
160 #define OB_FLUIDSIM_CONTROL                     128
161
162 #define OB_TYPEFLAG_START       7
163 #define OB_FSGEO_THIN           (1<<(OB_TYPEFLAG_START+1))
164 #define OB_FSBND_NOSLIP         (1<<(OB_TYPEFLAG_START+2))
165 #define OB_FSBND_PARTSLIP       (1<<(OB_TYPEFLAG_START+3))
166 #define OB_FSBND_FREESLIP       (1<<(OB_TYPEFLAG_START+4))
167 #define OB_FSINFLOW_LOCALCOORD  (1<<(OB_TYPEFLAG_START+5))
168
169 /* surface generation flag (part of enabling chapter 6 of "Free Surface Flows with Moving and Deforming Objects for LBM") */
170 #define OB_FSSG_NOOBS                   (1<<(OB_TYPEFLAG_START+6))
171
172 // guiDisplayMode particle flags
173 #define OB_FSDOM_GEOM     1
174 #define OB_FSDOM_PREVIEW  2
175 #define OB_FSDOM_FINAL    3
176 #define OB_FSPART_BUBBLE  (1<<1)
177 #define OB_FSPART_DROP    (1<<2)
178 #define OB_FSPART_NEWPART (1<<3)
179 #define OB_FSPART_FLOAT   (1<<4)
180 #define OB_FSPART_TRACER  (1<<5)
181
182 // new fluid bit flags for fss->flags
183 #define OB_FLUIDSIM_REVERSE                     (1 << 0)
184 #define OB_FLUIDSIM_ACTIVE                      (1 << 1)
185 #define OB_FLUIDSIM_OVERRIDE_TIME       (1 << 2)
186
187 #define OB_FLUIDSIM_SURF_PREVIEW_OBJ_FNAME "fluidsurface_preview_####.bobj.gz"
188 #define OB_FLUIDSIM_SURF_FINAL_OBJ_FNAME   "fluidsurface_final_####.bobj.gz"
189 #define OB_FLUIDSIM_SURF_FINAL_VEL_FNAME   "fluidsurface_final_####.bvel.gz"
190 #define OB_FLUIDSIM_SURF_PARTICLES_FNAME   "fluidsurface_particles_####.gz"
191
192 #ifdef __cplusplus
193 }
194 #endif
195
196 #endif
197
198