new demo version 0.2.0!

Author: rlguy

README.md

@@ -2,17 +2,15 @@ Want to try FLIP Fluids addon before buying the full [Blender Market Product](ht
 
 ### Limitations
 
-- _**New:**_ Unlimited simulation frames (previous limit of 250) 
-- _**New:**_ Unlimited number of simulation objects (previous limit of 1 per object type) 
 - Simulation meshes are watermarked with _FLIP Fluids Demo_ text
 
 ### Getting Started
 
-Download the latest FLIP Fluids Demo installation file here: [FLIP_Fluids_addon_0.1.0_demo_(20_aug_2021.zip)](https://github.com/rlguy/Blender-FLIP-Fluids/releases/download/0.1.0/FLIP_Fluids_addon_0.1.0_demo_.20_aug_2021.zip)
+Download the latest FLIP Fluids Demo installation file here: [FLIP_Fluids_addon_0.2.0_demo_(25_nov_2021.zip)](https://github.com/rlguy/Blender-FLIP-Fluids/releases/download/0.2.0/FLIP_Fluids_addon_0.2.0_demo_.25_nov_2021.zip)
 
 After downloading the demo addon, follow our [Installation Instructions](https://github.com/rlguy/Blender-FLIP-Fluids/wiki/Addon-Installation-and-Uninstallation). The instructions are similar to installing any other Blender addon.
 
-Get started creating your first simulation with our [beginners guide](https://github.com/rlguy/Blender-FLIP-Fluids/wiki/Creating-Your-First-FLIP-Fluids-Simulation)!
+Get started creating your first simulation with our [beginners guide](https://github.com/rlguy/Blender-FLIP-Fluids/wiki/Creating-Your-First-FLIP-Fluids-Simulation) or [video learning series](https://github.com/rlguy/Blender-FLIP-Fluids/wiki/Video-Learning-Series)!
 
 ### Have any questions?
 

cmake/CMakeLists.txt

@@ -20,7 +20,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 ]]
 
-cmake_minimum_required(VERSION 2.8.9)
+cmake_minimum_required(VERSION 3.0)
 
 function(set_output_directories DIR)
     set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${DIR} PARENT_SCOPE)
@@ -41,13 +41,17 @@ option(WITH_OPENCL "Compile project with OpenCL features" OFF)
 option(WITH_ENGINE_TEST "Compile engine test executable" OFF)
 option(WITH_PYFLUID_MODULE "Compile pyfluid Python module" OFF)
 
+if(APPLE)
+    set(MACOSX_DEPLOYMENT_TARGET 10.10)
+endif()
+
 project(bl_flip_fluids)
 set(CMAKE_BUILD_TYPE Release)
 
 set(FLUIDENGINE_VERSION_MAJOR 0)
-set(FLUIDENGINE_VERSION_MINOR 1)
+set(FLUIDENGINE_VERSION_MINOR 2)
 set(FLUIDENGINE_VERSION_REVISION 0)
-set(FLUIDENGINE_VERSION_LABEL "0.1.0 Demo 20-AUG-2021")
+set(FLUIDENGINE_VERSION_LABEL "0.2.0 Demo 25-NOV-2021")
 
 if(BUILD_DEBUG)
     set(FLUIDENGINE_VERSION_LABEL "${FLUIDENGINE_VERSION_LABEL} (DEBUG BUILD)") 
@@ -176,7 +180,6 @@ if(DISTRIBUTE_SOURCE)
     set(SOURCE_COPY_PATHS
         "${CMAKE_SOURCE_DIR}/src"
         "${CMAKE_SOURCE_DIR}/.gitignore"
-        "${CMAKE_SOURCE_DIR}/CMakeLists.txt"
         "${CMAKE_SOURCE_DIR}/LICENSE_GPLv3.md"
         "${CMAKE_SOURCE_DIR}/LICENSE_MIT.md"
         "${CMAKE_SOURCE_DIR}/LICENSE_Standard_Royalty_Free.md"

src/addon/__init__.py.in

@@ -23,7 +23,7 @@ bl_info = {
     "location" : "Properties > Physics > FLIP Fluid",
     "warning" : "",
     "wiki_url" : "https://github.com/rlguy/Blender-FLIP-Fluids/wiki",
-    "tracker_url" : "https://github.com/rlguy/Blender-FLIP-Fluids/wiki/Guidelines-for-Reporting-Bugs-and-Issues",
+    "doc_url" : "https://github.com/rlguy/Blender-FLIP-Fluids/wiki",
     "category" : "Animation"
 }
 

src/addon/bake.py

@@ -457,17 +457,24 @@ def __check_bake_cancelled(bakedata):
     return False
 
 
-def __get_parameter_data(parameter, frameno = 0):
+def __get_parameter_data(parameter, frameno=0, value_min=None, value_max=None):
     if parameter is None:
         raise IndexError()
 
-    if not hasattr(parameter, 'is_animated'):
-        return parameter
-
-    if parameter.is_animated:
-        return parameter.data[frameno]
+    if hasattr(parameter, 'data') and hasattr(parameter, 'is_animated'):
+        if parameter.is_animated:
+            value = parameter.data[frameno]
+        else:
+            value = parameter.data
     else:
-        return parameter.data
+        value = parameter
+
+    if value_min is not None:
+        value = max(value, value_min)
+    if value_max is not None:
+        value = min(value, value_max)
+
+    return value
 
 
 def __get_limit_behaviour_enum(b):
@@ -514,13 +521,15 @@ def __get_obstacle_meshing_offset(obstacle_meshing_mode):
 def __get_viscosity_value(world_data, frameno):
     base = __get_parameter_data(world_data.viscosity, frameno)
     exp = __get_parameter_data(world_data.viscosity_exponent, frameno)
-    return base * (10**(-exp))
+    viscosity = max(base * (10**(-exp)), 0.0)
+    return viscosity
 
 
 def __get_surface_tension_value(world_data, frameno):
     base = __get_parameter_data(world_data.surface_tension, frameno)
     exp = __get_parameter_data(world_data.surface_tension_exponent, frameno)
-    return world_data.native_surface_tension_scale * base * (10**(-exp))
+    value = world_data.native_surface_tension_scale * base * (10**(-exp))
+    return max(value, 0.0)
 
 
 def __read_save_state_file_data(file_data_path, start_byte, end_byte):
@@ -756,9 +765,9 @@ def __load_save_state_data(fluidsim, data, cache_directory, savestate_id):
 
     init_data = data.domain_data.initialize
     if init_data.delete_outdated_savestates:
-        __delete_outdated_savestates(cache_directory, savestate_id)
+        __delete_outdated_savestates(cache_directory, autosave_info["frame"])
     if init_data.delete_outdated_meshes:
-        __delete_outdated_meshes(cache_directory, savestate_id)
+        __delete_outdated_meshes(cache_directory, autosave_info["frame"])
 
 
 def __initialize_fluid_simulation_settings(fluidsim, data):
@@ -947,14 +956,17 @@ def __initialize_fluid_simulation_settings(fluidsim, data):
         surface_tension_number = mincfl + (1.0 - accuracy_pct) * (maxcfl - mincfl)
         fluidsim.surface_tension_condition_number = surface_tension_number
 
+        st_solver_mode = __get_parameter_data(world.surface_tension_solver_method, frameno)
+        fluidsim.enable_smooth_surface_tension_kernel = st_solver_mode == 'SURFACE_TENSION_SOLVER_METHOD_SMOOTH'
+
     is_sheet_seeding_enabled = __get_parameter_data(world.enable_sheet_seeding, frameno)
     if is_sheet_seeding_enabled:
         fluidsim.enable_sheet_seeding = is_sheet_seeding_enabled
-        fluidsim.sheet_fill_rate = __get_parameter_data(world.sheet_fill_rate, frameno)
-        threshold = __get_parameter_data(world.sheet_fill_threshold, frameno)
+        fluidsim.sheet_fill_rate = __get_parameter_data(world.sheet_fill_rate, frameno, value_min=0.0, value_max=1.0)
+        threshold = __get_parameter_data(world.sheet_fill_threshold, frameno, value_min=0.0, value_max=1.0)
         fluidsim.sheet_fill_threshold = threshold - 1
 
-    friction = __get_parameter_data(world.boundary_friction, frameno)
+    friction = __get_parameter_data(world.boundary_friction, frameno, value_min=0.0, value_max=1.0)
     fluidsim.boundary_friction = friction
 
     # Surface Settings
@@ -1471,11 +1483,11 @@ def __update_animatable_obstacle_properties(data, frameid):
             __update_dynamic_object_mesh(mesh_object, data)
 
         mesh_object.enable = __get_parameter_data(data.is_enabled, frameid)
-        mesh_object.friction = __get_parameter_data(data.friction, frameid)
-        mesh_object.whitewater_influence = __get_parameter_data(data.whitewater_influence, frameid)
-        mesh_object.dust_emission_strength = __get_parameter_data(data.dust_emission_strength, frameid)
-        mesh_object.sheeting_strength = __get_parameter_data(data.sheeting_strength, frameid)
-        mesh_object.mesh_expansion = __get_parameter_data(data.mesh_expansion, frameid)
+        mesh_object.friction = __get_parameter_data(data.friction, frameid, value_min=0.0)
+        mesh_object.whitewater_influence = __get_parameter_data(data.whitewater_influence, frameid, value_min=0.0)
+        mesh_object.dust_emission_strength = __get_parameter_data(data.dust_emission_strength, frameid, value_min=0.0)
+        mesh_object.sheeting_strength = __get_parameter_data(data.sheeting_strength, frameid, value_min=0.0)
+        mesh_object.mesh_expansion = __get_parameter_data(data.mesh_expansion, frameid, value_min=0.0)
 
 
 def __update_animatable_meshing_volume_properties(data, frameid):
@@ -1494,7 +1506,12 @@ def __update_animatable_meshing_volume_properties(data, frameid):
         volume_object.update_mesh_animated(mesh_previous, mesh_current, mesh_next)
 
 
-def __set_property(obj, pname, value):
+def __set_property(obj, pname, value, value_min=None, value_max=None):
+    if value_min is not None:
+        value = max(value, value_min)
+    if value_max is not None:
+        value = min(value, value_max)
+
     eps = 1e-6
     old_value = getattr(obj, pname)
     if isinstance(value, list):
@@ -1713,11 +1730,11 @@ def __update_animatable_domain_properties(fluidsim, data, frameno):
         sheet_fill_rate = __get_parameter_data(world.sheet_fill_rate, frameno)
         threshold = __get_parameter_data(world.sheet_fill_threshold, frameno)
         __set_property(fluidsim, 'enable_sheet_seeding', is_sheet_seeding_enabled)
-        __set_property(fluidsim, 'sheet_fill_rate', sheet_fill_rate)
-        __set_property(fluidsim, 'sheet_fill_threshold', threshold - 1)
+        __set_property(fluidsim, 'sheet_fill_rate', sheet_fill_rate, value_min=0, value_max=1.0)
+        __set_property(fluidsim, 'sheet_fill_threshold', threshold - 1, value_min=0, value_max=1.0)
 
     friction = __get_parameter_data(world.boundary_friction, frameno)
-    __set_property(fluidsim, 'boundary_friction', friction)
+    __set_property(fluidsim, 'boundary_friction', friction, value_min=0, value_max=1.0)
 
     # Surface Settings
 
@@ -2451,8 +2468,11 @@ def bake(datafile, cache_directory, bakedata, savestate_id=None, bake_retries=0)
 
             error_string = str(e)
             errmsg = error_string
+            do_not_attempt_relaunch = False
             if "std::bad_alloc" in errmsg:
                 errmsg = "Out of memory. "
+            elif "No space left on device" in errmsg:
+                do_not_attempt_relaunch = True
             elif not errmsg:
                 errmsg = "Unknown error. "
             if not errmsg.endswith(". "):
@@ -2469,10 +2489,13 @@ def bake(datafile, cache_directory, bakedata, savestate_id=None, bake_retries=0)
             print("\nThank you for using FLIP Fluids!")
             print("------------------------------------------------------------")
 
-            if retry_num == max_baking_retries:
+            if retry_num == max_baking_retries or do_not_attempt_relaunch:
                 bakedata.error_message = errmsg
                 break
             else:
+                # Setting to a negative value will default to the most recent savestate on the next attempt.
+                savestate_id = -1
+
                 retry_msg = "Attempting to re-launch bake... "
                 retry_msg += "(retry attempt " + str(retry_num + 1) + "/" + str(max_baking_retries) + ")"
                 print(retry_msg)

src/addon/objects/flip_fluid_cache.py

@@ -193,7 +193,11 @@ def initialize_cache_object(self):
         # Motion blur not supported. Leaving motion blur enabled can cause
         # slow render in versions of Blender 2.91+. Workaround is to
         # automatically disable motion blur on the object.
-        cache_object.cycles.use_motion_blur = False
+        try:
+            # Cycles may not be enabled in the user's preferences
+            cache_object.cycles.use_motion_blur = False
+        except:
+            pass
 
         self._initialize_cache_object_octane(cache_object)
 
@@ -337,6 +341,9 @@ def _update_velocity_attribute(self, frameno):
         frame_string = self._frame_number_to_string(frameno)
         velocity_data = self._import_velocity_attribute_data(frameno)
 
+        if not velocity_data:
+            return
+
         attribute_name = "flip_velocity"
         mesh = cache_object.data
         try:
@@ -357,6 +364,9 @@ def _update_speed_attribute(self, frameno):
         frame_string = self._frame_number_to_string(frameno)
         speed_data = self._import_speed_attribute_data(frameno)
 
+        if not speed_data:
+            return
+
         attribute_name = "flip_speed"
         mesh = cache_object.data
         try:
@@ -377,6 +387,9 @@ def _update_age_attribute(self, frameno):
         frame_string = self._frame_number_to_string(frameno)
         age_data = self._import_age_attribute_data(frameno)
 
+        if not age_data:
+            return
+
         attribute_name = "flip_age"
         mesh = cache_object.data
         try:
@@ -397,6 +410,9 @@ def _update_color_attribute(self, frameno):
         frame_string = self._frame_number_to_string(frameno)
         color_data = self._import_color_attribute_data(frameno)
 
+        if not color_data:
+            return
+
         attribute_name = "flip_color"
         mesh = cache_object.data
         try:
@@ -417,6 +433,9 @@ def _update_source_id_attribute(self, frameno):
         frame_string = self._frame_number_to_string(frameno)
         source_id_data = self._import_source_id_attribute_data(frameno)
 
+        if not source_id_data:
+            return
+
         attribute_name = "flip_source_id"
         mesh = cache_object.data
         try:
@@ -616,7 +635,11 @@ def initialize_duplivert_object(self, vertices=[], polygons=[], scale=1.0, insta
         # Motion blur not supported. Leaving motion blur enabled can cause
         # slow render in versions of Blender 2.91+. Workaround is to
         # automatically disable motion blur on the object.
-        duplivert_object.cycles.use_motion_blur = False
+        try:
+            # Cycles may not be enabled in the user's preferences
+            duplivert_object.cycles.use_motion_blur = False
+        except:
+            pass
 
         self.duplivert_object = duplivert_object
 

src/addon/operators/bake_operators.py

@@ -41,13 +41,20 @@ def is_bake_operator_running():
     return _IS_BAKE_OPERATOR_RUNNING
 
 
-def _update_stats(context):
+def update_stats(context=None):
+    if context is None:
+        context = bpy.context
+
     dprops = bpy.context.scene.flip_fluid.get_domain_properties()
     cache_dir = dprops.cache.get_cache_abspath()
     statsfilepath = os.path.join(cache_dir, dprops.stats.stats_filename)
     if not os.path.isfile(statsfilepath):
-        with open(statsfilepath, 'w', encoding='utf-8') as f:
-            f.write(json.dumps({}, sort_keys=True, indent=4))
+        try:
+            # Case that the cache directory path is not valid
+            with open(statsfilepath, 'w', encoding='utf-8') as f:
+                f.write(json.dumps({}, sort_keys=True, indent=4))
+        except:
+            return
 
     temp_dir = os.path.join(cache_dir, "temp")
     match_str = "framestats" + "[0-9]"*6 + ".data"
@@ -164,7 +171,7 @@ def _launch_thread(self):
 
 
     def _update_stats(self, context):
-        _update_stats(context)
+        update_stats(context)
 
 
     def _update_status(self, context):
@@ -443,7 +450,7 @@ def _export_simulation_data(self, context):
 
 
     def _update_simulation_stats(self, context):
-        _update_stats(context)
+        update_stats(context)
 
 
     def _run_fluid_simulation(self, context):

src/addon/operators/draw_grid_operators.py

@@ -242,6 +242,11 @@ def draw_callback_2d(self, context):
             xstart = 50
 
         font_id = 0
+        try:
+            # Not all Blender versions have functionality to set font color with this method
+            blf.color(font_id, 1.0, 1.0, 1.0, 1.0)
+        except:
+            pass
         if dprops.debug.grid_display_mode == 'GRID_DISPLAY_SIMULATION':
             blf.size(font_id, 20, 72)
             blf.position(font_id, xstart, height - 50, 0)
@@ -258,10 +263,10 @@ def draw_callback_2d(self, context):
             blf.draw(font_id, "Grid Dimensions: " + str(dimx) + "m x " + str(dimy) + "m x " + str(dimz) + "m")
 
             blf.position(font_id, xstart + 10, height - 130, 0)
-            blf.draw(font_id, "Grid Cell Count: " + format(isize*jsize*ksize, ",").replace(",", " "))
+            blf.draw(font_id, "Voxel Count: " + format(isize*jsize*ksize, ",").replace(",", " "))
 
             blf.position(font_id, xstart + 10, height - 155, 0)
-            blf.draw(font_id, "Grid Cell Width: " + str(round(simulation_dx, 4)) + "m")
+            blf.draw(font_id, "Voxel Width: " + str(round(simulation_dx, 4)) + "m")
         elif dprops.debug.grid_display_mode == 'GRID_DISPLAY_MESH':
             if dprops.surface.compute_chunk_mode == 'COMPUTE_CHUNK_MODE_AUTO':
                 compute_chunks = dprops.surface.compute_chunks_auto
@@ -286,10 +291,10 @@ def draw_callback_2d(self, context):
             num_cells_str = format(num_cells, ",").replace(",", " ")
             chunk_cells_str = format(math.ceil(num_cells / compute_chunks), ",").replace(",", " ")
             blf.position(font_id, xstart + 10, height - 155, 0)
-            blf.draw(font_id, "Grid Cell Count: " + num_cells_str + " (" + chunk_cells_str + " / chunk)")
+            blf.draw(font_id, "Voxel Count: " + num_cells_str + " (" + chunk_cells_str + " / chunk)")
 
             blf.position(font_id, xstart + 10, height - 180, 0)
-            blf.draw(font_id, "Grid Cell Width: " + str(round(simulation_dx, 4)))
+            blf.draw(font_id, "Voxel Width: " + str(round(simulation_dx, 4)))
         elif dprops.debug.grid_display_mode == 'GRID_DISPLAY_PREVIEW':
             blf.size(font_id, 20, 72)
             blf.position(font_id, xstart, height - 50, 0)
@@ -302,7 +307,7 @@ def draw_callback_2d(self, context):
             num_cells = isize*jsize*ksize
             num_cells_str = format(num_cells, ",").replace(",", " ")
             blf.position(font_id, xstart + 10, height - 105, 0)
-            blf.draw(font_id, "Grid Cell Width: " + str(round(simulation_dx, 4)))
+            blf.draw(font_id, "Voxel Width: " + str(round(simulation_dx, 4)))
         elif dprops.debug.grid_display_mode == 'GRID_DISPLAY_FORCE_FIELD':
             blf.size(font_id, 20, 72)
             blf.position(font_id, xstart, height - 50, 0)
@@ -318,7 +323,7 @@ def draw_callback_2d(self, context):
             num_cells = isize*jsize*ksize
             num_cells_str = format(num_cells, ",").replace(",", " ")
             blf.position(font_id, xstart + 10, height - 130, 0)
-            blf.draw(font_id, "Grid Cell Width: " + str(round(simulation_dx, 4)))
+            blf.draw(font_id, "Voxel Width: " + str(round(simulation_dx, 4)))
 
 
     def draw_callback_3d(self, context):