Domain Simulation Settings - bakcxoj/OpenFLIP GitHub Wiki

This page documents the domain settings for the 'OpenFLIP Simulation' panel.

All parameters in this panel must be set before baking for changes in the simulation to take effect.

Bake	Start running a simulation. Notes: Blender will not be able to autosave your scene while the bake process is running. If you make any changes to your scene while the simulator is running, it is advised to save manually and not to rely on the Blender autosave feature. You are not required to save your scene in order to save the simulation progress. If you close your scene without saving, the simulator can be resumed from the last computed frame.
Stop / Pause	Stop running the current simulation. The simulation can be resumed at a later time with the Resume Baking operator. This operator is only available if a simulation is currently running. Notes: The simulator must wait until the current frame is finished computing to completely terminate the simulation process. The simulation process can be terminated immediately by exiting Blender. To ensure that the cache does not become corrupted, only terminate the simulation if the operator displays Safe to quit Blender. Avoid exiting Blender if the operator displays Do NOT quit Blender as there is a small chance that this could corrupt the simulation cache.
Resume Baking	Resume running a simulation from the last completed frame. This operator is only available if the last simulation was stopped or terminated after completing at least one frame. Notes: If Blender has crashed or was shut down during a simulation, baking can still be resumed from the last computed frame!
Reset	Reset the simulation and clear the simulation mesh and data cache. This operator is only available if the last simulation was stopped or terminated after completing at least one frame.

It is possible to bake a simulation from the command line. See the Baking from the Command Line documentation for details.

Settings Export Mode

How the simulator will export simulation settings and object mesh data before running the simulation. Default     Only export simulation settings and object mesh data at the start of a bake. Skip     re-exportation when resuming a paused simulation. Skip     Skip re-exportation if simulation settings and object mesh data from a previous     simulation are found. Force     Always re-export simulation settings and object mesh data when starting/resuming     a simulation. Use this option for changed settings/meshes to take effect when     resuming a simulation.

Setting the Settings Export Mode to Force allows you to change simulation settings before resuming a bake. This will force the addon to export new settings so that your changes will take effect after resuming the simulation. The following are some tips and tricks to keep in mind when using this feature:

• It is not advised to change the domain resolution. This can lead to unpredictable results.
• If you want to bake more frames after a simulation ends, you may extend the timeline range. When resuming the baking process, the simulator will finish processing the remaining frames.
• If you are updating the frame range, make sure to also update the simulation start and end times so that the simulation continues baking at the correct speed. These times are automatically updated if the Use Frame Rate option is enabled.

Resolution	The simulation domain resolution. This value is the number of grid cells along the longest side of the domain bounding box.
Preview Resolution	The resolution to use for generating lower quality meshes for the preview fluid surface. Notes: If set too low, the preview mesh may not be detailed enough to capture any details of full resolution simulation and may not be a usable representation of the final mesh. It is recommended to use a preview resolution that is half that of the full resolution.
Lock Cell Size	Lock the current grid cell size. If the domain bounding box is scaled to a different size, the domain Resolution will be automatically updated to maintain the current grid cell size when this option is enabled. TIP: enable this setting to maintain the same level of simulation detail when scaling the domain smaller/larger.

Use Frame Rate	Calculate the frame timestep using the Frame Rate value. If this setting is disabled, the Start and End time values will be used to calculate the frame timestep.
Frame Rate	Frame rate in frames per second. This setting is only available if Use Frame Rate is enabled.
Start	The start time of the first simulation frame in seconds. This setting is only available if Use Frame Rate is disabled.
End	The end time of the last simulation frame in seconds. This setting is only available if Use Frame Rate is disabled.
Speed	Scale the frame timestep by this value. If set to less than 1.0, the simulation will appear in slow motion. If set to greater than 1.0, the simulation will appear sped up.