configure_fluid_simulation
Create, configure, inspect, or remove Mantaflow gas, smoke, and liquid simulations in Blender with domains, flows, effectors, validated parameters, and rollback safeguards.
Instructions
Create, configure, inspect, or remove Mantaflow fluid simulations (Domain, Flow, Effector) for gas/smoke volumetrics and liquid simulations with parameter validation, safe interactive limits, optimistic concurrency, and transactional rollback.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "configure_fluid_simulation"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| beta | No | Gas buoyancy heat factor (-5.0 to 5.0). Defaults to 1.0. | |
| name | No | Alias for object_name. | |
| alpha | No | Gas buoyancy density factor (-5.0 to 5.0). Defaults to 1.0. | |
| action | No | Action to perform: 'create'/'add', 'configure', 'inspect', or 'remove'/'delete'. Defaults to 'create'. | create |
| density | No | Flow emission density (0.0 to 10.0). Defaults to 1.0. | |
| task_id | No | Optional task identifier. | |
| approved | No | DEPRECATED / UNTRUSTED: Client-supplied approval flags in tool arguments are not trusted as proof of human consent. | |
| use_mesh | No | Whether surface mesh generation is enabled for liquid domain. Defaults to True. | |
| flow_type | No | Flow emission type: 'SMOKE', 'BOTH' (fire+smoke), 'FIRE', or 'LIQUID'. Defaults to 'SMOKE'. | SMOKE |
| subframes | No | Emission subframes for fast-moving flow/effector objects (0 to 200). Defaults to 0. | |
| vorticity | No | Gas turbulence vorticity / swirl factor (0.0 to 4.0). Defaults to 0.0. | |
| cache_type | No | Cache type for domain ('REPLAY', 'MODULAR', 'ALL'). Defaults to 'REPLAY'. | REPLAY |
| flip_ratio | No | Ratio of FLIP to PIC velocity update (0.0 to 1.0). Defaults to 0.97. | |
| fluid_type | No | Fluid role on object: 'DOMAIN' (gas/liquid boundary), 'FLOW' (emitter/inflow/outflow), or 'EFFECTOR' (collision/guide). Defaults to 'DOMAIN'. | DOMAIN |
| mesh_scale | No | Resolution scale factor for generated liquid mesh (1 to 100). Defaults to 2. | |
| time_scale | No | Simulation time playback scale (0.0001 to 10.0). Defaults to 1.0. | |
| use_inflow | No | Whether inflow is actively emitting. Defaults to True. | |
| domain_type | No | Domain simulation type: 'GAS' (smoke/fire volumetrics) or 'LIQUID' (water/fluid surface). Defaults to 'GAS'. | GAS |
| flame_smoke | No | Amount of smoke generated by fire (0.0 to 8.0). Defaults to 1.0. | |
| fuel_amount | No | Flow emission fuel amount for fire (0.0 to 10.0). Defaults to 1.0. | |
| object_name | No | Name of the target mesh object (alias: name). | |
| snapshot_id | No | Alias for expected_snapshot_id. | |
| temperature | No | Flow emission temperature difference (-10.0 to 10.0). Defaults to 1.0. | |
| burning_rate | No | Fire burning speed rate (0.01 to 4.0). Defaults to 0.75. | |
| use_effector | No | Whether effector influence is enabled. Defaults to True. | |
| cfl_condition | No | CFL condition threshold (0.0 to 10.0). Defaults to 2.0. | |
| effector_type | No | Effector role: 'COLLISION' (solid obstacle/deflector) or 'GUIDE' (flow director). Defaults to 'COLLISION'. | COLLISION |
| flow_behavior | No | Flow behavior: 'INFLOW' (continuous stream), 'OUTFLOW' (drain/sink), or 'GEOMETRY' (one-time volume). Defaults to 'GEOMETRY'. | GEOMETRY |
| timesteps_max | No | Maximum simulation timesteps per frame (1 to 100). Defaults to 4. | |
| timesteps_min | No | Minimum simulation timesteps per frame (1 to 100). Defaults to 1. | |
| use_diffusion | No | Whether liquid viscosity diffusion is enabled. Defaults to False. | |
| dissolve_speed | No | Number of frames for smoke to dissolve (1 to 10000). Defaults to 5. | |
| resolution_max | No | Max resolution divisions for fluid domain grid (16 to 256). Defaults to 32. | |
| use_plane_init | No | Treat effector as planar surface rather than closed volume. Defaults to False. | |
| velocity_coord | No | Cartesian initial velocity vector [X, Y, Z]. Defaults to [0.0, 0.0, 0.0]. | |
| viscosity_base | No | Viscosity base factor for liquid (0.0 to 10.0). Defaults to 1.0. | |
| cache_frame_end | No | End frame of simulation cache (1 to 100000, max span <= 250). Defaults to 50. | |
| flame_vorticity | No | Additional vorticity created by flames (0.0 to 2.0). Defaults to 0.5. | |
| particle_radius | No | Particle radius factor relative to cell size (0.0 to 10.0). Defaults to 1.0. | |
| surface_tension | No | Surface tension of liquid (0.0 to 100.0). Defaults to 0.0. | |
| velocity_factor | No | Velocity multiplier (-100.0 to 100.0). Defaults to 1.0. | |
| velocity_normal | No | Normal velocity component (-100.0 to 100.0). Defaults to 0.0. | |
| surface_distance | No | Distance from mesh surface for flow/effector emission (0.0 to 10.0). Defaults to 1.0 for flow, 0.0 for effector. | |
| cache_frame_start | No | Start frame of simulation cache (1 to 100000). Defaults to 1. | |
| simulation_method | No | Liquid simulation method ('FLIP' or 'APIC'). Defaults to 'FLIP'. | FLIP |
| use_dissolve_smoke | No | Whether smoke dissolves over time. Defaults to False. | |
| viscosity_exponent | No | Viscosity exponent value (10^-n) (0 to 10). Defaults to 6. | |
| expected_snapshot_id | No | Expected state snapshot ID for optimistic concurrency control. | |
| use_initial_velocity | No | Whether to impart initial velocity to emitted fluid. Defaults to False. | |
| use_adaptive_timesteps | No | Whether to use adaptive timestepping based on CFL condition. Defaults to True. |