updated and removed bug

Author: ChRen95

docs/docs.pdf

@@ -61,6 +61,9 @@
     The correction coefficients $\kappa$ were measured by the autor from various rolling trials.
     For round - oval passes the value is $\kappa = 19.6e-12$ and for oval - round passes $\kappa =  35.9e-12$.
     Further, for round - oval roll passes the value $0.75$ is a empirical coefficient as stated by the original author.
+    Also, the original authors stated, that the weight function $J_w$ should be in a range between 0.8 and 1.
+    If the function leaves this range, the acting wear can be considered catastrophic and the model becomes invalid.
+    This has been treated in the implementation as well.
 
 
     \section{Usage instructions}\label{sec:usage-instructions}

docs/docs.tex

@@ -10,7 +10,8 @@ path = "pyroll/byon_lee_wear_model/__init__.py"
 path = ".venv"
 dependencies = [
     "pytest ~= 7.0",
-    "pyroll-report ~= 3.0.0"
+    "pyroll-report ~= 3.0.0",
+    "pyroll-wusatowski-spreading ~= 3.0.0"
 ]
 
 [envs.docs]

hatch.toml

@@ -22,11 +22,10 @@ def unit_plot(unit: Unit):
                                           unit.roll.groove_wear_cross_section.geoms):
             wear_contour = ax.plot(*wear_cl.xy, color='red', ls='--', label="wear contour")
             roll_surface = ax.plot(*cl.xy, color="k", label="roll surface")
-            wear_cross_section = ax.fill(*wear_poly.boundary.xy, color="red", alpha=0.5,
-                                         label="wear cross section")
+            wear_cross_section = ax.fill(*wear_poly.boundary.xy, color="red", alpha=0.5, label="wear cross section")
 
         axl.axis("off")
-        axl.legend(handles=roll_surface + wear_cross_section + wear_contour, ncols=3, loc="lower center")
+        axl.legend(handles=roll_surface + wear_contour + wear_cross_section, ncols=3, loc="lower center")
         fig.set_layout_engine('constrained')
 
         return fig

pyroll/byon_lee_wear_model/report.py

@@ -1,11 +1,14 @@
+import math
+
 import numpy as np
 
 from pyroll.core.hooks import Hook
 from pyroll.core import SymmetricRollPass, root_hooks
-from shapely.affinity import translate, rotate
+from shapely.affinity import rotate
 from shapely.geometry import LineString, MultiPoint, Point, Polygon
 from shapely.geometry.multilinestring import MultiLineString
 from shapely.geometry.multipolygon import MultiPolygon
+from shapely.lib import clip_by_rect
 
 SymmetricRollPass.Roll.shore_hardness = Hook[float]()
 """Shore hardness of the roll material."""
@@ -34,6 +37,7 @@
 SymmetricRollPass.Roll.wear_area = Hook[float]()
 """Worn area of the groove."""
 
+
 @SymmetricRollPass.Roll.oval_round_wear_coefficient
 def default_byon_lee_wear_coefficient(self: SymmetricRollPass.Roll):
     return 35.9e-12
@@ -51,17 +55,23 @@ def wear_radius(self: SymmetricRollPass.Roll):
 
     def weight(correction_factor: float) -> float:
         return 1 - correction_factor * (
-                    (roll_pass.roll_force ** 2 * self.contact_length * roll_pass.rolled_billets) / self.shore_hardness)
+                (roll_pass.roll_force ** 2 * self.contact_length * roll_pass.rolled_billets) / self.shore_hardness)
 
     if "round" in in_profile.classifiers and "oval" in roll_pass.classifiers:
         weight = weight(self.round_oval_wear_coefficient)
-        radius = self.groove.r2 * weight + in_profile.equivalent_radius * (1 - weight)
-        return radius
+        if weight <= 0.75:  # Condition from Byon-Lee weight should be between 0.8 and 1
+            return 0
+        self.logger.debug(f"Weight function on Byon-Lee model for round - oval pass: {weight}.")
+        return self.groove.r2 * weight + in_profile.equivalent_radius * (1 - weight)
+
 
     elif "oval" in in_profile.classifiers and "round" in roll_pass.classifiers:
         weight = weight(self.oval_round_wear_coefficient)
-        radius = self.groove.r2 * weight + 0.75 * roll_pass.out_profile.bulge_radius * (1 - weight)
-        return radius
+        self.logger.debug(f"Weight function on Byon-Lee model for oval - round pass: {weight}.")
+        if weight <= 0.75:  # Condition from Byon-Lee weight should be between 0.8 and 1
+            return 0
+
+        return self.groove.r2 * weight + 0.75 * roll_pass.out_profile.bulge_radius * (1 - weight)
     else:
         return 0
 
@@ -72,6 +82,11 @@ def groove_wear_contour_lines(self: SymmetricRollPass.Roll) -> MultiLineString:
                                                 Point(self.roll_pass.out_profile.contact_lines.geoms[0].coords[-1])])
     z_coordinates_wear_contour = np.arange(start=detachment_points.geoms[0].x, stop=detachment_points.geoms[1].x,
                                            step=1e-6)
+
+    if self.wear_radius == 0:
+        self.logger.warning("Wear radius is 0 either pass-sequence unsuitable or model detected catastrophic wear.")
+        return self.roll_pass.contour_lines
+
     y_coordinates_wear_contour = np.sqrt(self.wear_radius ** 2 - z_coordinates_wear_contour ** 2)
     minimum_wear_distance = min(y_coordinates_wear_contour)
     y_coordinates_wear_contour_shifted = y_coordinates_wear_contour - minimum_wear_distance + detachment_points.geoms[
@@ -88,12 +103,12 @@ def groove_wear_contour_lines(self: SymmetricRollPass.Roll) -> MultiLineString:
 
 @SymmetricRollPass.Roll.groove_wear_cross_section
 def groove_wear_cross_section(self: SymmetricRollPass.Roll):
-
     poly = []
     for cl, wcl in zip(self.roll_pass.contour_lines.geoms, self.groove_wear_contour_lines.geoms):
         boundary = list(cl.coords) + list(reversed(wcl.coords))
         _poly = Polygon(boundary)
-        poly.append(_poly)
+        _clipped_poly = clip_by_rect(_poly, -self.roll_pass.out_profile.width / 2, -math.inf, self.roll_pass.out_profile.width / 2, math.inf)
+        poly.append(_clipped_poly)
 
     return MultiPolygon(poly)
 
@@ -109,4 +124,4 @@ def wear_area(self: SymmetricRollPass.Roll):
 
 
 root_hooks.append(SymmetricRollPass.Roll.max_wear_depth)
-root_hooks.append(SymmetricRollPass.Roll.wear_area)
+root_hooks.append(SymmetricRollPass.Roll.wear_area)

pyroll/byon_lee_wear_model/roll_pass.py

@@ -8,6 +8,7 @@
 def test_solve(tmp_path: Path, caplog):
     caplog.set_level(logging.DEBUG, logger="pyroll")
 
+    import pyroll.wusatowski_spreading
     import pyroll.byon_lee_wear_model
     import pyroll.profile_bulging
 
@@ -46,7 +47,7 @@ def test_solve(tmp_path: Path, caplog):
                 velocity=11.7,
                 gap=3.5e-3,
                 coulomb_friction_coefficient=0.4,
-                rolled_billets=20000,
+                rolled_billets=3000,
 
             ),
         ]

tests/test_solve_falseround.py

@@ -33,7 +33,7 @@ def test_solve_round_oval_round(tmp_path: Path, caplog):
                     shore_hardness=65
                 ),
                 gap=2e-3,
-                rolled_billets=20000,
+                rolled_billets=500,
 
             ),