DomainFluidSettings(FluidSettings)¶

base classes — bpy_struct, FluidSettings

class bpy.types.DomainFluidSettings(FluidSettings)¶

Fluid simulation settings for the domain of a fluid simulation

compressibility¶

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

Type :	float in [0.001, 0.1], default 0.0

end_time¶

Simulation time of the last blender frame (in seconds)

Type :	float in [0, 100], default 0.0

filepath¶

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

Type :	string, default “”, (never None)

fluid_mesh_vertices¶

Vertices of the fluid mesh generated by simulation

Type :	`bpy_prop_collection` of `FluidMeshVertex`, (readonly)

frame_offset¶

Offset when reading baked cache

Type :	int in [-inf, inf], default 0

generate_particles¶

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

Type :	float in [0, 10], default 0.0

gravity¶

Gravity in X, Y and Z direction

Type :	float array of 3 items in [-1000.1, 1000.1], default (0.0, 0.0, 0.0)

grid_levels¶

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

Type :	int in [-1, 4], default 0

memory_estimate¶

Estimated amount of memory needed for baking the domain

Type :	string, default “”, (readonly, never None)

partial_slip_factor¶

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

Type :	float in [0, 1], default 0.0

preview_resolution¶

Preview resolution in X,Y and Z direction

Type :	int in [1, 100], default 0

render_display_mode¶

How to display the mesh for rendering

GEOMETRY Geometry, Display geometry.
PREVIEW Preview, Display preview quality results.
FINAL Final, Display final quality results.

Type :	enum in [‘GEOMETRY’, ‘PREVIEW’, ‘FINAL’], default ‘GEOMETRY’

resolution¶

Domain resolution in X,Y and Z direction

Type :	int in [1, 1024], default 0

simulation_rate¶

Fluid motion rate (0 = stationary, 1 = normal speed)

Type :	float in [0, 100], default 0.0

simulation_scale¶

Size of the simulation domain in meters

Type :	float in [0.001, 10], default 0.0

slip_type¶

NOSLIP No Slip, Obstacle causes zero normal and tangential velocity (=sticky), default for all (only option for moving objects).
PARTIALSLIP Partial Slip, Mix between no-slip and free-slip (non moving objects only!).
FREESLIP Free Slip, Obstacle only causes zero normal velocity (=not sticky, non moving objects only!).

Type :	enum in [‘NOSLIP’, ‘PARTIALSLIP’, ‘FREESLIP’], default ‘NOSLIP’

start_time¶

Simulation time of the first blender frame (in seconds)

Type :	float in [0, 100], default 0.0

surface_noobs¶

Removes the air gap between fluid surface and obstacles - WARNING: Can result in a dissolving surface in other areas

Type :	boolean, default False

surface_smooth¶

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], default 0.0

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], default 0

tracer_particles¶

Number of tracer particles to generate

Type :	int in [0, 10000], default 0

use_reverse_frames¶

Reverse fluid frames

Type :	boolean, default False

use_speed_vectors¶

Generate speed vectors for vector blur

Type :	boolean, default False

use_time_override¶

Use a custom start and end time (in seconds) instead of the scene’s timeline

Type :	boolean, default False

viewport_display_mode¶

How to display the mesh in the viewport

GEOMETRY Geometry, Display geometry.
PREVIEW Preview, Display preview quality results.
FINAL Final, Display final quality results.

Type :	enum in [‘GEOMETRY’, ‘PREVIEW’, ‘FINAL’], default ‘GEOMETRY’

viscosity_base¶

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

Type :	float in [0, 10], default 0.0

viscosity_exponent¶

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

Type :	int in [0, 10], default 0

Inherited Properties

bpy_struct.id_data

FluidSettings.type

Inherited Functions

DomainFluidSettings(FluidSettings)¶

Previous topic

Next topic

Navigation

DomainFluidSettings(FluidSettings)¶

Previous topic

Next topic

Quick search

Navigation