SmokeDomainSettings(bpy_struct)

base class — bpy_struct

class bpy.types.SmokeDomainSettings(bpy_struct)

Smoke domain settings

adapt_margin

Margin added around fluid to minimize boundary interference

Type:int in [2, 24], default 0
adapt_threshold

Maximum amount of fluid cell can contain before it is considered empty

Type:float in [0.01, 0.5], default 0.0
additional_res

Maximum number of additional cells

Type:int in [0, 512], default 0
alpha

How much density affects smoke motion (higher value results in faster rising smoke)

Type:float in [-5, 5], default 0.0
amplify

Enhance the resolution of smoke by this factor using noise

Type:int in [1, 10], default 0
axis_slice_method
  • FULL Full, Slice the whole domain object.
  • SINGLE Single, Perform a single slice of the domain object.
Type:enum in [‘FULL’, ‘SINGLE’], default ‘FULL’
beta

How much heat affects smoke motion (higher value results in faster rising smoke)

Type:float in [-5, 5], default 0.0
burning_rate

Speed of the burning reaction (use larger values for smaller flame)

Type:float in [0.01, 4], default 0.0
cache_file_format

Select the file format to be used for caching

  • POINTCACHE Point Cache, Blender specific point cache file format.
  • OPENVDB OpenVDB, OpenVDB file format.
Type:enum in [‘POINTCACHE’, ‘OPENVDB’], default ‘POINTCACHE’
cell_size

Cell Size

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

Value under which voxels are considered empty space to optimize caching and rendering

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

Simulation field to color map

  • COLOR_R Red, Red component of the color field.
  • COLOR_G Green, Green component of the color field.
  • COLOR_B Blue, Blue component of the color field.
  • DENSITY Density, Quantity of soot in the fluid.
  • FLAME Flame, Flame field.
  • FUEL Fuel, Fuel field.
  • HEAT Heat, Temperature of the fluid.
  • VELOCITY_X X Velocity, X component of the velocity field.
  • VELOCITY_Y Y Velocity, Y component of the velocity field.
  • VELOCITY_Z Z Velocity, Z component of the velocity field.
Type:enum in [‘COLOR_R’, ‘COLOR_G’, ‘COLOR_B’, ‘DENSITY’, ‘FLAME’, ‘FUEL’, ‘HEAT’, ‘VELOCITY_X’, ‘VELOCITY_Y’, ‘VELOCITY_Z’], default ‘DENSITY’
collision_collection

Limit collisions to this collection

Type:Collection
collision_extents

Select which domain border will be treated as collision object

  • BORDEROPEN Open, Smoke doesn’t collide with any border.
  • BORDERVERTICAL Vertically Open, Smoke doesn’t collide with top and bottom sides.
  • BORDERCLOSED Collide All, Smoke collides with every side.
Type:enum in [‘BORDEROPEN’, ‘BORDERVERTICAL’, ‘BORDERCLOSED’], default ‘BORDEROPEN’
color_grid

Smoke color grid

Type:float array of 32 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0), (readonly)
color_ramp
Type:ColorRamp, (readonly)
data_depth

Bit depth for writing all scalar (including vector) lower values reduce file size

  • 16 Float (Half), Half float (16 bit data).
  • 32 Float (Full), Full float (32 bit data).
Type:enum in [‘16’, ‘32’], default ‘32’
density_grid

Smoke density grid

Type:float array of 32 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0), (readonly)
display_interpolation

Interpolation method to use for smoke/fire volumes in solid mode

  • LINEAR Linear, Good smoothness and speed.
  • CUBIC Cubic, Smoothed high quality interpolation, but slower.
Type:enum in [‘LINEAR’, ‘CUBIC’], default ‘LINEAR’
display_thickness

Thickness of smoke drawing in the viewport

Type:float in [0.001, 1000], default 0.0
dissolve_speed

Dissolve Speed

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

Smoke Grid Resolution

Type:int array of 3 items in [-inf, inf], default (0, 0, 0), (readonly)
effector_collection

Limit effectors to this collection

Type:Collection
effector_weights
Type:EffectorWeights, (readonly)
flame_grid

Smoke flame grid

Type:float array of 32 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0), (readonly)
flame_ignition

Minimum temperature of flames

Type:float in [0.5, 5], default 0.0
flame_max_temp

Maximum temperature of flames

Type:float in [1, 10], default 0.0
flame_smoke

Amount of smoke created by burning fuel

Type:float in [0, 8], default 0.0
flame_smoke_color

Color of smoke emitted from burning fuel

Type:float array of 3 items in [0, inf], default (0.0, 0.0, 0.0)
flame_vorticity

Additional vorticity for the flames

Type:float in [0, 2], default 0.0
fluid_collection

Limit fluid objects to this collection

Type:Collection
heat_grid

Smoke heat grid

Type:float array of 32 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0), (readonly)
highres_sampling

Method for sampling the high resolution flow

Type:enum in [‘FULLSAMPLE’, ‘LINEAR’, ‘NEAREST’], default ‘NEAREST’
noise_type

Noise method which is used for creating the high resolution

Type:enum in [‘NOISEWAVE’, ‘NOISEFFT’], default ‘NOISEWAVE’
openvdb_cache_compress_type

Compression method to be used

  • ZIP Zip, Effective but slow compression.
  • BLOSC Blosc, Multithreaded compression, similar in size and quality as ‘Zip’.
  • NONE None, Do not use any compression.
Type:enum in [‘ZIP’, ‘BLOSC’, ‘NONE’], default ‘BLOSC’
point_cache
Type:PointCache, (readonly, never None)
point_cache_compress_type

Compression method to be used

  • CACHELIGHT Light, Fast but not so effective compression.
  • CACHEHEAVY Heavy, Effective but slow compression.
Type:enum in [‘CACHELIGHT’, ‘CACHEHEAVY’], default ‘CACHELIGHT’
resolution_max

Maximal resolution used in the fluid domain

Type:int in [6, 512], default 0
show_high_resolution

Show high resolution (using amplification)

Type:boolean, default False
show_velocity

Toggle visualization of the velocity field as needles

Type:boolean, default False
slice_axis
  • AUTO Auto, Adjust slice direction according to the view direction.
  • X X, Slice along the X axis.
  • Y Y, Slice along the Y axis.
  • Z Z, Slice along the Z axis.
Type:enum in [‘AUTO’, ‘X’, ‘Y’, ‘Z’], default ‘AUTO’
slice_depth

Position of the slice

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

How to slice the volume for viewport rendering

  • VIEW_ALIGNED View, Slice volume parallel to the view plane.
  • AXIS_ALIGNED Axis, Slice volume parallel to the major axis.
Type:enum in [‘VIEW_ALIGNED’, ‘AXIS_ALIGNED’], default ‘VIEW_ALIGNED’
slice_per_voxel

How many slices per voxel should be generated

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

Start point

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

Strength of noise

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

Smoke temperature grid, range 0..1 represents 0..1000K

Type:float array of 32 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0), (readonly)
time_scale

Adjust simulation speed

Type:float in [0.2, 1.5], default 0.0
use_adaptive_domain

Adapt simulation resolution and size to fluid

Type:boolean, default False
use_color_ramp

Render a simulation field while mapping its voxels values to the colors of a ramp

Type:boolean, default False
use_dissolve_smoke

Enable smoke to disappear over time

Type:boolean, default False
use_dissolve_smoke_log

Using 1/x

Type:boolean, default False
use_high_resolution

Enable high resolution (using amplification)

Type:boolean, default False
vector_display_type
  • NEEDLE Needle, Display vectors as needles.
  • STREAMLINE Streamlines, Display vectors as streamlines.
Type:enum in [‘NEEDLE’, ‘STREAMLINE’], default ‘NEEDLE’
vector_scale

Multiplier for scaling the vectors

Type:float in [0, 1000], default 0.0
velocity_grid

Smoke velocity grid

Type:float array of 32 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0), (readonly)
vorticity

Amount of turbulence/rotation in fluid

Type:float in [0.01, 4], default 0.0
classmethod bl_rna_get_subclass(id, default=None)
Parameters:id (string) – The RNA type identifier.
Returns:The RNA type or default when not found.
Return type:bpy.types.Struct subclass
classmethod bl_rna_get_subclass_py(id, default=None)
Parameters:id (string) – The RNA type identifier.
Returns:The class or default when not found.
Return type:type

Inherited Properties

Inherited Functions

References