Package bpy :: Module types :: Class DomainFluidSettings

[frames] | no frames]

Class DomainFluidSettings

The Domain Fluid Simulation Settings Object

Fluid simulation settings for the domain of a fluid simulation.

(no references to this struct found)

Instance Variables

[hide private]

float in [0.001, 0.1]

compressibility
Allowed compressibility due to gravitational force for standing fluid.

float in [0, 100]

end_time
Simulation time of the last blender frame.

float in [0, 10]

generate_particles
Amount of particles to generate (0=off, 1=normal, >1=more).

boolean

generate_speed_vectors
Generate speed vectors for vector blur.

float array of 3 items in [-1000.1, 1000.1]

gravity
Gravity in X, Y and Z direction.

int in [-1, 4]

grid_levels
Number of coarsened grids to use (-1 for automatic).

string (readonly)

memory_estimate
Estimated amount of memory needed for baking the domain.

float in [0, 1]

partial_slip_factor
Amount of mixing between no- and free-slip, 0 is no slip and 1 is free slip.

string

path
Directory (and/or filename prefix) to store baked fluid simulation files in.

int in [1, 100]

preview_resolution
Preview resolution in X,Y and Z direction.

float in [0.001, 10]

real_world_size
Size of the simulation domain in metres.

enum

render_display_mode
How to display the mesh for rendering.

int in [1, 1024]

resolution
Domain resolution in X,Y and Z direction.

boolean

reverse_frames
Reverse fluid frames.

enum

slip_type
Slip Type in...

float in [0, 100]

start_time
Simulation time of the first blender frame.

float in [0, 5]

surface_smoothing
Amount of surface smoothing.

int in [0, 5]

surface_subdivisions
Number of isosurface subdivisions.

int in [0, 10000]

tracer_particles
Number of tracer particles to generate

enum

type
Type of participation in the fluid simulation. (Inherited from bpy.types.FluidSettings)

enum

viewport_display_mode
How to display the mesh in the viewport.

float in [0, 10]

viscosity_base
Viscosity setting: value that is multiplied by 10 to the power of (exponent*-1).

int in [0, 10]

viscosity_exponent
Negative exponent for the viscosity value (to simplify entering small values e.g.

enum

viscosity_preset
Set viscosity of the fluid to a preset value, or use manual input.

Instance Variable Details

[hide private]

compressibility

Allowed compressibility due to gravitational force for standing fluid. (directly affects simulation step size)

Type:: float in [0.001, 0.1]

memory_estimate

Estimated amount of memory needed for baking the domain. (maximum length of 0)

Type:: string (readonly)

path

Directory (and/or filename prefix) to store baked fluid simulation files in. (maximum length of 240)

Type:: string

render_display_mode

How to display the mesh for rendering. in...

GEOMETRY
PREVIEW
FINAL

Type:: enum

slip_type

Slip Type in...

NOSLIP
PARTIALSLIP
FREESLIP

Type:: enum

surface_smoothing

Amount of surface smoothing. A value of 0 is off, 1 is normal smoothing and more than 1 is extra smoothing.

Type:: float in [0, 5]

surface_subdivisions

Number of isosurface subdivisions. This is necessary for the inclusion of particles into the surface generation. Warning - can lead to longer computation times!

Type:: int in [0, 5]

viewport_display_mode

How to display the mesh in the viewport. in...

GEOMETRY
PREVIEW
FINAL

Type:: enum

viscosity_exponent

Negative exponent for the viscosity value (to simplify entering small values e.g. 5*10^-6.).

Type:: int in [0, 10]

viscosity_preset

Set viscosity of the fluid to a preset value, or use manual input. in...

MANUAL
WATER
OIL
HONEY

Type:: enum