pyroll-forward-slip 3.0.0__tar.gz

pyroll_forward_slip-3.0.0/.gitignore

@@ -0,0 +1,435 @@
+## Python
+
+.working
+working
+*.lock
+.pytask.sqlite3
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+## TeX
+
+## Core latex/pdflatex auxiliary files:
+*.aux
+*.lof
+*.lot
+*.fls
+*.out
+*.toc
+*.fmt
+*.fot
+*.cb
+*.cb2
+.*.lb
+
+## Intermediate documents:
+*.dvi
+*.xdv
+*-converted-to.*
+# these rules might exclude image files for figures etc.
+# *.ps
+# *.eps
+# *.pdf
+
+## Generated if empty string is given at "Please type another file name for output:"
+.pdf
+
+## Bibliography auxiliary files (bibtex/biblatex/biber):
+*.bbl
+*.bcf
+*.blg
+*-blx.aux
+*-blx.bib
+*.run.xml
+
+## Build tool auxiliary files:
+*.fdb_latexmk
+*.synctex
+*.synctex(busy)
+*.synctex.gz
+*.synctex.gz(busy)
+*.pdfsync
+
+## Build tool directories for auxiliary files
+# latexrun
+latex.out/
+
+## Auxiliary and intermediate files from other packages:
+# algorithms
+*.alg
+*.loa
+
+# achemso
+acs-*.bib
+
+# amsthm
+*.thm
+
+# beamer
+*.nav
+*.pre
+*.snm
+*.vrb
+
+# changes
+*.soc
+
+# comment
+*.cut
+
+# cprotect
+*.cpt
+
+# elsarticle (documentclass of Elsevier journals)
+*.spl
+
+# endnotes
+*.ent
+
+*.lox
+
+# feynmf/feynmp
+*.mf
+*.mp
+*.t[1-9]
+*.t[1-9][0-9]
+*.tfm
+
+#(r)(e)ledmac/(r)(e)ledpar
+*.end
+*.?end
+*.[1-9]
+*.[1-9][0-9]
+*.[1-9][0-9][0-9]
+*.[1-9]R
+*.[1-9][0-9]R
+*.[1-9][0-9][0-9]R
+*.eledsec[1-9]
+*.eledsec[1-9]R
+*.eledsec[1-9][0-9]
+*.eledsec[1-9][0-9]R
+*.eledsec[1-9][0-9][0-9]
+*.eledsec[1-9][0-9][0-9]R
+
+# glossaries
+*.acn
+*.acr
+*.glg
+*.glo
+*.gls
+*.glsdefs
+*.lzo
+*.lzs
+
+# uncomment this for glossaries-extra (will ignore makeindex's style files!)
+# *.ist
+
+# gnuplottex
+*-gnuplottex-*
+
+# gregoriotex
+*.gaux
+*.glog
+*.gtex
+
+# htlatex
+*.4ct
+*.4tc
+*.idv
+*.lg
+*.trc
+*.xref
+
+# hyperref
+*.brf
+
+# knitr
+*-concordance.tex
+# *.tikz
+*-tikzDictionary
+
+# listings
+*.lol
+
+# luatexja-ruby
+*.ltjruby
+
+# makeidx
+*.idx
+*.ilg
+*.ind
+
+# minitoc
+*.maf
+*.mlf
+*.mlt
+*.mtc[0-9]*
+*.slf[0-9]*
+*.slt[0-9]*
+*.stc[0-9]*
+
+# minted
+_minted*
+*.pyg
+
+# morewrites
+*.mw
+
+# newpax
+*.newpax
+
+# nomencl
+*.nlg
+*.nlo
+*.nls
+
+# pax
+*.pax
+
+# pdfpcnotes
+*.pdfpc
+
+# sagetex
+*.sagetex.sage
+*.sagetex.py
+*.sagetex.scmd
+
+# scrwfile
+*.wrt
+
+# sympy
+*.sout
+*.sympy
+sympy-plots-for-*.tex/
+
+# pdfcomment
+*.upa
+*.upb
+
+# pythontex
+*.pytxcode
+pythontex-files-*/
+
+# tcolorbox
+*.listing
+
+# thmtools
+*.loe
+
+# TikZ & PGF
+*.dpth
+*.md5
+*.auxlock
+
+# todonotes
+*.tdo
+
+# vhistory
+*.hst
+*.ver
+
+# easy
+*.lod
+
+# xcolor
+*.xcp
+
+# xmpincl
+*.xmpi
+
+# xindy
+*.xdy
+
+# xypic precompiled matrices and outlines
+*.xyc
+*.xyd
+
+# endfloat
+*.ttt
+*.fff
+
+# Latexian
+TSWLatexianTemp*
+
+## Editors:
+# WinEdt
+*.bak
+*.sav
+
+# Texpad
+.texpadtmp
+
+# LyX
+*.lyx~
+
+# Kile
+*.backup
+
+# gummi
+.*.swp
+
+# KBibTeX
+*~[0-9]*
+
+# TeXnicCenter
+*.tps
+
+# auto folder when using emacs and auctex
+./auto/*
+*.el
+
+# expex forward references with \gathertags
+*-tags.tex
+
+# standalone packages
+*.sta
+
+# Makeindex log files
+*.lpz
+
+# xwatermark package
+*.xwm
+
+## JetBrains
+
+.idea
+
+## HTML report
+/out/report.html

pyroll_forward_slip-3.0.0/LICENSE

@@ -0,0 +1,11 @@
+Copyright 2022 ...
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pyroll_forward_slip-3.0.0/PKG-INFO

@@ -0,0 +1,14 @@
+Metadata-Version: 2.5
+Name: pyroll-forward-slip
+Version: 3.0.0
+Summary: Plugin for PyRolL providing a forward slip model based on the neutral angle after Mauk.
+Project-URL: Homepage, https://pyroll.readthedocs.io
+Project-URL: Repository, https://codeberg.org/pyroll-project/pyroll-forward-slip
+Project-URL: Documentation, https://codeberg.org/pyroll-project/pyroll-forward-slip/src/branch/main/docs/docs.pdf
+Author-email: Christoph Renzing <christoph.renzing@imf.tu-freiberg.de>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: numpy
+Requires-Dist: pyroll-core<3.2,>=3.1.16
+Requires-Dist: pyroll-interface-friction~=3.0

pyroll_forward_slip-3.0.0/hatch.toml

@@ -0,0 +1,37 @@
+[build]
+packages = [
+    "pyroll"
+]
+
+[version]
+path = "pyroll/forward_slip.py"
+
+[envs.default]
+path = ".venv"
+dependencies = [
+    "pytest ~= 7.0",
+    "pyroll-report ~= 3.0",
+    "pyroll-wusatowski-spreading ~= 3.0",
+]
+
+[envs.docs]
+path = ""
+dependencies = [
+    "pygments ~= 2.0"
+]
+
+[envs.docs.scripts]
+build = "latexmk --cd --pdf --shell-escape docs/docs"
+
+[envs.test]
+path = ""
+dependencies = [
+    "pytest ~= 7.0",
+    "pyroll-wusatowski-spreading ~= 3.0",
+]
+
+[envs.test.scripts]
+all = "pytest"
+
+[[envs.test.matrix]]
+python = ["3.11", "3.12", "3.13"]

pyroll_forward_slip-3.0.0/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "pyroll-forward-slip"
+description = "Plugin for PyRolL providing a forward slip model based on the neutral angle after Mauk."
+authors = [
+    { name = "Christoph Renzing", email = "christoph.renzing@imf.tu-freiberg.de" }
+]
+license = "BSD-3-Clause"
+requires-python = ">=3.11"
+dependencies = [
+    "pyroll-core >= 3.1.16, < 3.2",
+    "pyroll-interface-friction ~= 3.0",
+    "numpy",
+]
+
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://pyroll.readthedocs.io"
+Repository = "https://codeberg.org/pyroll-project/pyroll-forward-slip"
+Documentation = "https://codeberg.org/pyroll-project/pyroll-forward-slip/src/branch/main/docs/docs.pdf"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

pyroll_forward_slip-3.0.0/pyroll/forward_slip.py

@@ -0,0 +1,68 @@
+import numpy as np
+
+from pyroll.core import RollPass, Hook, root_hooks
+import pyroll.interface_friction
+
+VERSION = "3.0.0"
+
+SLIP_FACTOR = 3 / 4
+
+RollPass.Roll.effective_diameter = Hook[float]()
+"""Working diameter of the roll including the forward slip."""
+
+
+@RollPass.Roll.groove_factor
+def groove_factor(self: RollPass.Roll):
+    roll_pass = self.roll_pass
+    return (roll_pass.out_profile.equivalent_height - roll_pass.gap) / 2
+
+
+@RollPass.Roll.effective_diameter
+def effective_diameter(self: RollPass.Roll):
+    return 2 * self.working_radius * (1 + self.roll_pass.forward_slip_ratio)
+
+
+@RollPass.coulomb_friction_coefficient
+def coulomb_friction_coefficient(self: RollPass):
+    roll_diameter_mm = self.roll.nominal_diameter * 1e3
+    temperature_celsius = self.in_profile.temperature - 273.15
+    velocity = self.velocity
+
+    roll_factor = 0.8 if roll_diameter_mm < 250 else 0.9
+
+    if roll_diameter_mm < 250 or velocity <= 2:
+        velocity_factor = 1.0
+    else:
+        velocity_factor = 0.4 + 0.6 * np.exp(-0.2 * (velocity - 2))
+
+    return roll_factor * velocity_factor * (1.05 - 0.0005 * temperature_celsius)
+
+
+def neutral_angle_from_friction(roll: RollPass.Roll) -> float:
+    roll_pass = roll.roll_pass
+    height_change = roll_pass.in_profile.equivalent_height - roll_pass.out_profile.equivalent_height
+    working_diameter = 2 * roll.working_radius
+    friction = roll_pass.coulomb_friction_coefficient
+
+    neutral_angle_magnitude = (
+            np.sqrt(height_change / (2 * working_diameter))
+            - height_change / (2 * friction * working_diameter)
+    )
+    return -max(neutral_angle_magnitude, 0.0)
+
+
+@RollPass.Roll.neutral_angle
+def neutral_angle(self: RollPass.Roll):
+    return neutral_angle_from_friction(self)
+
+
+@RollPass.forward_slip_ratio
+def forward_slip_ratio(self: RollPass):
+    working_diameter = 2 * self.roll.working_radius
+    out_height = self.out_profile.equivalent_height
+    return SLIP_FACTOR * self.roll.neutral_angle ** 2 / 2 * (working_diameter / out_height - 1)
+
+
+root_hooks.append(RollPass.Roll.neutral_angle)
+root_hooks.append(RollPass.Roll.effective_diameter)
+root_hooks.add(RollPass.forward_slip_ratio)