Merge branch 'add_volumetric_e' into 'main'

impl volumetric extrusion

See merge request kit/fast/lb/collaboration/additive-manufacturing/pygcodedecode!41

Author: jeknirsch

pyGCodeDecode/data/default_printer_presets.yaml

@@ -48,7 +48,8 @@ prusa_mini_klipper:
 debugging:
   # general properties
   nozzle_diam: 0.4
-  filament_diam: 1.75
+  filament_diam: 2.85
+  volumetric_extrusion: True # true: mm3 with UltiGCode, else mm length
   # default settings
   p_vel: 85
   p_acc: 100

pyGCodeDecode/gcode_interpreter.py

@@ -577,7 +577,7 @@ def get_values(self, t: float, output_unit_system: str = None) -> Tuple[List[flo
 
         return tmp_vel, tmp_pos
 
-    def get_width(self, t: float, extrusion_h: float, filament_dia: float):
+    def get_width(self, t: float, extrusion_h: float, filament_dia: Optional[float] = None) -> float:
         """Return the extrusion width for a certain extrusion height at time.
 
         Args:
@@ -588,13 +588,14 @@ def get_width(self, t: float, extrusion_h: float, filament_dia: float):
         Returns:
             float: width
         """
+        filament_dia = self.initial_machine_setup["filament_diam"] if filament_dia is None else filament_dia
+
         curr_val = self.get_values(t=t)
 
         feed_rate = np.linalg.norm(curr_val[0][:3])  # calculate feed rate at current time
         flow_rate = curr_val[0][3]  # get extrusion rate at current time
 
-        filament_cross_sec = (np.pi * filament_dia**2) / 4  # calculate cross area of filament
-
+        filament_cross_sec = np.pi * (filament_dia / 2) ** 2  # calculate cross area of filament
         width = (
             (flow_rate * filament_cross_sec) / (extrusion_h * feed_rate) if feed_rate > 0 else 0
         )  # calculate width, zero if no movement.
@@ -622,11 +623,7 @@ def check_initial_setup(self, initial_machine_setup):
             "printer_name",
             "firmware",
         ]
-        optional_keys = [
-            "layer_cue",
-            "nozzle_diam",
-            "filament_diam",
-        ]
+        optional_keys = ["layer_cue", "nozzle_diam", "filament_diam", "volumetric_extrusion"]
 
         valid_keys = req_keys + optional_keys
 

pyGCodeDecode/helpers.py

@@ -45,7 +45,7 @@ def custom_print(*args, lvl=2, **kwargs) -> None:
 
     # print with verbosity level
     if lvl <= VERBOSITY_LEVEL:
-        levels = {3: "[DEBUG]", 2: "[INFO]: ", 1: "[WARNING]: "}
+        levels = {3: "[DEBUG]:", 2: "[INFO]:", 1: "[WARNING]:"}
         prefix = levels.get(lvl, "")
         print(prefix, *sanitized_args, **kwargs)
 

pyGCodeDecode/state_generator.py

@@ -1,5 +1,6 @@
 """State generator module."""
 
+import math
 import pathlib
 import re
 from typing import List, Match
@@ -81,6 +82,7 @@
 default_virtual_machine = {
     "absolute_position": True,
     "absolute_extrusion": True,
+    "volumetric_extrusion": False,
     "units": "SI (mm)",
     "initial_position": None,
     # general properties
@@ -207,6 +209,24 @@ def dict_list_traveler(line_dict_list: List[dict], initial_machine_setup: dict)
         state_list: (list[state]) all states in a list
 
     """
+
+    def apply_extrusion(line_dict: dict, virtual_machine: dict, command: str) -> dict:
+        e_value = line_dict[command]["E"]
+
+        # volumetric to length conversion
+        # (1) V = (d/2)^2 * pi * E
+        # (2) E = V / ((d/2)^2 * pi)
+        if virtual_machine.get("volumetric_extrusion", False):
+            # volumetric extrusion
+            e_value = e_value / (math.pi * (virtual_machine["filament_diam"] / 2) ** 2)
+
+        if virtual_machine["absolute_extrusion"]:
+            virtual_machine["E"] = e_value
+        else:
+            virtual_machine["E"] = virtual_machine["E"] + e_value
+
+        return virtual_machine
+
     state_list: List[state] = list()
 
     virtual_machine = {
@@ -225,17 +245,15 @@ def dict_list_traveler(line_dict_list: List[dict], initial_machine_setup: dict)
         layer_counter = 0
 
     # overwrite default values from initial machine setup
-    """TODO: depending on the setting the user should be informed that a default value is used.
-    I prepared a warning below.
-    Are all these settings necessary?"""
     for key in default_virtual_machine:
         if initial_machine_setup is not None and key in initial_machine_setup:
             virtual_machine[key] = initial_machine_setup[key]
         else:
-            """print(
+            custom_print(
                 f"The parameter '{key}' was not specified in your machine presets. "
-                f"Using the the default value of '{default_virtual_machine[key]}' to continue."
-            )"""
+                f"Using the the default value of '{default_virtual_machine[key]}' to continue.",
+                lvl=3,
+            )
             virtual_machine[key] = default_virtual_machine[key]
 
     # initial state creation
@@ -298,10 +316,9 @@ def dict_list_traveler(line_dict_list: List[dict], initial_machine_setup: dict)
 
                 # look for extrusion commands and apply abs/rel
                 if "E" in line_dict[command]:
-                    if virtual_machine["absolute_extrusion"] is True:
-                        virtual_machine["E"] = line_dict[command]["E"]
-                    if virtual_machine["absolute_extrusion"] is False:  # redundant
-                        virtual_machine["E"] = virtual_machine["E"] + line_dict[command]["E"]
+                    virtual_machine = apply_extrusion(line_dict, virtual_machine, command)
+
+                # feed rates in unit/min to unit/sec
                 if "F" in line_dict[command]:
                     virtual_machine["p_vel"] = line_dict[command]["F"] / 60
 

tests/test_end_to_end.py

@@ -2,6 +2,8 @@
 
 import pathlib
 
+import numpy as np
+
 
 def test_end_to_end_compact():
     """Testing the simulation functionality with automatic setup, similarly to the brace example."""
@@ -13,6 +15,38 @@ def test_end_to_end_compact():
     )
 
 
+def test_end_to_end_volumetr():
+    """Testing the simulation functionality with automatic setup, using volumetric or distance based extrusion."""
+    from pyGCodeDecode.gcode_interpreter import setup, simulation
+
+    preset = setup(pathlib.Path("./tests/data/test_printer_setups.yaml"), "test")
+    preset.set_property({"volumetric_extrusion": False})
+
+    sim = simulation(
+        gcode_path=pathlib.Path("./tests/data/test_state_generator.gcode"),
+        initial_machine_setup=preset,
+    )
+
+    end_extrusion = sim.blocklist[-1].segments[-1].pos_end.e
+    expected_extrusion = 14.0
+    assert end_extrusion == expected_extrusion, f"Expected {expected_extrusion}, but got {end_extrusion}"
+
+    preset = setup(pathlib.Path("./tests/data/test_printer_setups.yaml"), "test")
+    preset.set_property({"volumetric_extrusion": True})
+
+    sim = simulation(
+        gcode_path=pathlib.Path("./tests/data/test_state_generator.gcode"),
+        initial_machine_setup=preset,
+    )
+
+    end_extrusion = sim.blocklist[-1].segments[-1].pos_end.e
+    expected_extrusion = 14.0 / ((1.75 / 2) ** 2 * np.pi)
+
+    assert np.isclose(
+        end_extrusion, expected_extrusion, rtol=1e-9
+    ), f"Expected {expected_extrusion}, but got {end_extrusion}"
+
+
 def test_end_to_end_extensive():
     """Testing the simulation functionality as well as the various outputs, similarly to the benchy example."""
     from pyGCodeDecode.abaqus_file_generator import generate_abaqus_event_series