Bifröst Caching attributes

The Caching attributes can be found in the Caching group of bifrostLiquidProperties, bifrostFoamProperties, bifrostGuideProperties, and bifrostAeroProperties nodes.

Initial State Cache

These options are available for liquid and foam only. Normally they are set automatically when you set an initial state, but you can also edit them manually.

Enable
Activates the use of an initial state.
Initial State Filepath
The path and file name of a Bifröst cache file to use as a starting point for the simulation. The path can be relative to the current project, or absolute.
  • For a liquid simulation, you can specify either a voxel file or a particle file (e.g., voxel_liquid_particle.0200.bif), but there must be a matching pair of cache files for the corresponding frame in the folder.
  • For a foam simulation, specify a particle file (e.g., Foam_particle.0200.bif).

Aero/Liquid/Mesh/Solid/Foam Cache

These options control how each Bifrost object is cached. Normally they are set when you generate a user cache but you can also edit them manually, for example, if you want to load a cache into an empty simulation.

Note that, to read or write cache files for the mesh, meshing must be enabled in the Bifröst shape's attributes.

Enable
Allows Bifröst to use the user cache files.
Note: When reading a Liquid Cache or Aero Cache, you can turn off Enable in the Solid Cache group if the colliders are not animated in any way. This can save disk space and time reading and writing the associated files. However, if you do so then you will not be able to extend the liquid or aero cache past its current end frame without playing the entire simulation through from the first frame.
Cache Control
Sets the caching action that will be performed on the Bifröst object when Enable is on.

0—Recomputes the simulation.

1—Reads cached frames. This is the default setting when cache files exist.

2—Creates user files for each frame. Existing cache files get overwritten.

3—Reads existing cached frames, while creating files for uncached frames based on the previously cached frames.

Compression Quality
Set to 0 for the least amount of compression, 1 for more compression, or 2 for lossy compression.
Cache Directory
The location of the user cache files. The default is the cache/bifrost/<scene name> subfolder of the current project folder.
(Object) Cache Name
The directory containing the object's cache files. The default cache name is the name of the main bifrostLiquidContainer or bifrostAeroContainer node. Cache file names consist of the <Bifröst object> appended by -volume for voxelized objects and -particle or -flipParticles for particles.