Skip to content

BrandonDyer64/OpenFLIP

 
 

Repository files navigation

OpenFLIP

OpenFLIP is a powerful liquid simulation plugin that gives you the ability to create high quality fluid effects all within Blender, the free and open source 3D creation suite.

The OpenFLIP simulator was created as an alternative to the FLIP Fluids addon found on the Blender Market.

Installation

From Source

Clone Repository

git clone https://github.com/BrandonDyer64/OpenFLIP.git
cd OpenFLIP

Build

./build.sh

Install Addon

Move OpenFLIP/bl_open_flip/bl_open_flip into your Blender addons directory.

  • Linux
    • ~/.config/blender/2.79/scripts/addons

Key Features

High Performance

The core fluid engine, written in C++, is designed for running high performance computations and massive physics calculations efficiently. Multithreaded and extensively optimized, this simulator is built for speed.

Whitewater Effects

Create awesome large scale fluid effects with the whitewater simulator. Generate and simulate millions of foam, bubble, and spray particles to give a sense of realism to large bodies of water.

Viscosity Effects

Use the highly accurate viscosity solver to simulate thin silky-smooth liquids, thick fluids that buckle and coil, and anything in between.

Built-in Mesh Generation

The built-in mesher generates highly detailed meshes so that your fluid surface is render-ready immediately after simulation. This mesh generator is memory efficient and able to produce meshes containing millions of triangles without requiring massive amounts of RAM.

Fracture Modifier Support

Create interesting destruction simulations by using the OpenFLIP addon with the Blender Fracture Modifier branch. The fluid engine is optimized to support fractured objects that may contain hundreds to thousands of individual pieces.

Excellent User Experience

The addon interface was designed with a focus on functionality and usability to create a comfortable workflow. View simulation progress, meshes, and statistics in real-time. Pause and resume simulation baking- even after a Blender crash. Create and manage your own preset settings. Quickly apply materials from the fluid material library.

Stable, Reliable, and Built for You

We ran a closed beta testing phase involving over 250 testers to ensure that this complex simulation system is reliable, intuitive, and ready for you to use in your projects. We gathered your feedback and added your suggestions. This addon is built for you!

More Features

  • Simulation
    • Pause a simulation and resume baking at your convenience. Any simulation can be continued from the last baked frame even after a crash or computer shutdown.
    • Set length of animation manually or automatically by framerate.
    • Nearly all simulation settings can be keyframe animated.
    • Hover over any setting to view a tooltip description. Detailed settings documentation and tips are also available on the Wiki.
    • Want to keep the same level of simulation detail while resizing the domain? Lock the simulation voxel size and the addon will automatically adjust grid resolution as you resize the domain.
    • Manage your scene cache directory. Operators will help you rename, move, copy, or delete your cache files.
    • Advanced settings for power users who want to experiment with simulation accuracy and performance.
  • Whitewater Simulation
    • Control the amount of whitewater generated at wavecrests and in areas of high turbulence.
    • Control how foam is carried along the fluid surface: In tight streaks, or diffuse and spread-out?
    • Control how bubbles rise to the surface and how bubbles are advected with the fluid.
    • Control amount of drag on spray particles as they fall to the fluid surface.
    • Set percentages of foam/bubble/spray particles for display and rendering.
    • Render whitewater particles with a simple icosphere or use your own custom object.
  • Mesh Generator
    • Adjust particle size for the particle-to-mesh surface generator.
    • Create high detail meshes by increasing the subdivision level.
    • Generate meshes that wrap smoothly around curved surfaces.
  • Presets and Materials
    • Save your own custom default domain settings.
    • Create and manage domain presets.
    • Organize presets into packages and add custom thumbnail images.
    • Export and share preset packages.
    • Apply multiple presets at once using the preset stack.
    • Quickly apply materials from the fluid material library.
  • Simulation Stats
    • View simulation, timing, and mesh stats for the entire cache or an individual frame.
    • Export stats to CSV format and create your own detailed graphs.
  • Debugging Tools
    • Visualize the simulation and meshing grid.
    • Visualize fluid particles and velocities.
    • Visualize how the simulator 'sees' your obstacle objects to diagnose issues with meshes.
    • View detailed simulation progress in the Blender system console.
  • Obstacle Objects
    • Support for animated obstacle objects.
    • Turn obstacle meshes 'inside-out' to contain fluid inside of the mesh.
    • Accurate fluid-solid interaction against curved surfaces.
    • Control amount of fluid friction against the obstacle surface.
  • Fluid and Inflow Objects
    • Support for animated inflow objects.
    • Manually set inflow velocity, or set velocity towards a target object.
    • Add inflow object velocity to the emitted fluid for realistic animated inflows.
  • Outflow Objects
    • Support for animated outflow objects.
    • Control whether outflow objects remove fluid particles or whitewater particles.
    • Control whether outflows will remove fluid entering the object or leaving the object.

System Requirements

  • Blender 2.79 (64-bit)
  • CPU 64-bit Intel® or AMD® multi-core processor
  • 8 GB RAM minimum, 16 GB or more of RAM memory is highly recommended
  • OpenCL™ capable graphics card

Mac OS X and Linux support

At this moment, support for Mac OS X and Linux is experimental. This means that the addon has not yet undergone extensive testing on OS X and Linux operating systems.

License

This program uses multiple licenses. See the files LICENSE_GPLv3.md and LICENSE_MIT.md for license details. In General:

  • The Blender addon code is licensed under the GPL.
  • The fluid engine is licensed under the MIT license.

Source code files will state their license at the top of the file. Assets will include a license file and information in their containing directory.

Source code availability

In the spirit of open source software, the OpenFLIP Blender addon will continue development right here, in this repository. Anyone who would like to contribute is free to open a pull request.

About

OpenFLIP is a powerful liquid simulation plugin that gives you the ability to create high quality fluid effects all within Blender.

Topics

Resources

License

GPL-3.0, MIT licenses found

Licenses found

GPL-3.0
LICENSE_GPLv3.md
MIT
LICENSE_MIT.md

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 56.3%
  • Python 41.9%
  • C 1.4%
  • Other 0.4%