first commit

Author: OrtnerMichael

.gitignore

@@ -0,0 +1,141 @@
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+*.pptx
+*.ppt
+
+# docs
+docs/auto_examples
+
+# sphinx-gallery
+auto_examples
+
+# coderunner
+tempCodeRunnerFile.py
+
+#temp files
+__temp*.py
+
+# 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/
+test-results/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/_autogen/
+docs/_auto_examples/
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+*.ipynb
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.vscode/
+.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/
+
+### Python Patch ###
+.venv/
+
+.DS_Store

LICENSE

@@ -0,0 +1,29 @@
+SAL Software License Agreement
+
+1. Grant of License:
+SAL ("Licensor") hereby grants to the authorized user ("Licensee") a non-exclusive, non-transferable license to use the software provided under this Agreement (the "Software") solely for Licensee’s internal business operations.
+
+2. Restrictions:
+a. The Licensee shall not, and shall not permit any third parties to, modify, adapt, translate, decompile, reverse engineer, disassemble, attempt to derive the source code of, or create derivative works from the Software.
+b. The Licensee shall not sell, redistribute, sublicense, rent, lease, or lend the Software to any third party.
+c. The Software may contain confidential information and trade secrets of SAL, and the Licensee agrees to maintain the confidentiality of the Software using at least as great a degree of care as it uses to maintain the confidentiality of its own most confidential information.
+
+3. Intellectual Property Rights:
+All title, ownership rights, and intellectual property rights in and to the Software shall remain with SAL and/or its suppliers. This Agreement does not transfer any ownership rights in the Software to the Licensee.
+
+4. Termination:
+This License is effective until terminated. The License will terminate immediately without notice from SAL if the Licensee fails to comply with any provision of this Agreement. Upon termination, the Licensee must destroy all copies of the Software.
+
+5. Disclaimer of Warranty:
+The Software is provided "AS IS," without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement.
+
+6. Limitation of Liability:
+In no event shall SAL be liable for any special, incidental, indirect, or consequential damages whatsoever arising out of or related to the use of or inability to use the Software, even if SAL has been advised of the possibility of such damages.
+
+7. General:
+This Agreement constitutes the entire agreement between the parties relating to the Software and supersedes all prior or contemporaneous oral or written communications, proposals, and representations with respect to its subject matter.
+
+8. Governing Law:
+This Agreement shall be governed by and construed in accordance with the laws of the jurisdiction in which SAL is registered, without regard to its conflict of law provisions.
+
+By using the Software, the Licensee agrees to be bound by the terms of this Agreement.

README.md

@@ -0,0 +1,3 @@
+# Magpy-Force
+
+This package provides force and torque computation for Magpylib objects.

TODO.md

@@ -0,0 +1,58 @@
+# DONE SINCE LAST LAST TIME
+
+- magnet-wire force/torque codes completed
+    - confirmed by FEM
+    - confirmed by self-consistency
+    - confirmed by analytical fundamental solutions
+- COMSOL confirm ANSYS and bad FE convergence
+- We understand the possibilities and limitation (no wire ends) of our force codes
+
+
+# DONE SINCE LAST TIME
+
+- restructured repository so it can be made installable and used by end-users
+- removed unit-dependencies - everything is SI and magpylib 5 compatible
+- setting up a testing framework
+    - physics tests
+    - interface tests
+    - FE tests
+    - self-consistency tests
+- vectorization for multiple inputs
+- input checks and auto-formatting
+- dynamic wire meshing
+- some doc-strings
+- add License
+- making installable, current version is 0.1.2dev
+
+
+# TODO CRITICAL
+
+- testing
+    - FE tests wire-wire
+    - FE tests magnet-wire
+    - FE tests finite-sized wires magnet
+    - more interface and meshing tests
+- reduce computation effort when no anchor is given or proof that this will not help much
+- review and clean up the meshers
+- implement dynamic magnet meshing ?
+- speed-boost: replace integration using newton_cotes
+- profiling
+    - memory
+    - performance
+- upscaling computation to SAL servers
+
+
+# TODO UNCRITICAL
+
+- shape handling
+    - include paths
+    - avoid sum over all sources if sumup=False
+- more doc strings
+- make units optional
+- include orientations
+- allow Collection inputs
+- Arc solution
+- linting
+
+
+

UNITS_feeback.md

@@ -0,0 +1,34 @@
+# Question1
+cannot mix sources with units and sources without units in one script. I would have expecetd that unit-less sources are automatically given SI units.
+
+# Problem
+markers doesnt work with units :()
+
+
+import numpy as np
+import magpylib as magpy
+import matplotlib.pyplot as plt
+
+src = magpy.current.Polyline(
+    current=(1, "A"),
+    vertices=([(-1,0,0),(1,0,0)], "mm"),
+)
+tgt = magpy.current.Polyline(
+    current=(1, "A"),
+    vertices=([(-1,0,0),(1,0,0)], "mm"),
+    position=((0,0,5), "mm"),
+)
+lvec = tgt.vertices[1]-tgt.vertices[0]
+
+poss = tgt.position + (tgt.vertices[1]+tgt.vertices[0])/2
+#B = src.getB(poss)
+#F = tgt.current * np.cross(lvec, B)
+
+magpy.show(src, tgt, markers=poss)
+
+# Problem Custom sources
+
+kann custom source nicht vor source mit unit definieren weil die sonst keine quantity bekommt
+
+# Problem Matplotlib backend cannot show dimensionful cubes
+

example.py

@@ -0,0 +1,15 @@
+from mforce import getFTcube
+import magpylib as magpy
+
+# all inputs and output in SI units
+
+cube1 = magpy.magnet.Cuboid(
+    dimension=(1,1,1),
+    polarization=(1,1,1),
+)
+cube2 = cube1.copy(position=(1,0,2))
+cube2.mesh = (10,10,10)
+
+F,T = getFTcube(cube1, [cube2, cube2.copy()], anchor=(0,0,0))
+print(F)
+print(T)

mforce/__init__.py

@@ -0,0 +1,14 @@
+from mforce.force import getFTcube
+from mforce.force import getFTwire
+
+"""
+The mforce package sits on top of magpylib for force computation
+"""
+
+# module level dunders
+__version__ = "0.1.2dev"
+__author__ = "SAL"
+__all__ = [
+    "getFTcube",
+    "getFTwire",
+]