Adding rotations (#2)

* add magnet rotation

* current rotation

* prepare for 0.1.8

* add pre-commit config

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: OrtnerMichael

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+        types: [file, python]
+      - id: trailing-whitespace
+        types: [file, python]
+      - id: check-added-large-files
+      - id: debug-statements
+        language_version: python3

CHANGELOG.md

@@ -1,3 +1,21 @@
+# v0.1.8
+- include Sphere magnets
+- rework of getFT workflow
+- include object rotations
+- update Readme
+
+# v0.1.7
+- generalize to getFT instead of separate functions
+- add excessive FEM testing
+- physics tests
+- self-consitency tests
+
+# v0.1.6
+- solve pypi problems
+
+# v0.1.5
+- solve pypi problems
+
 # v0.1.4
 - prepare for pypi
 - rename into "magpylib-force"

magpylib_force/__init__.py

@@ -5,7 +5,7 @@
 """
 
 # module level dunders
-__version__ = "0.1.7"
+__version__ = "0.1.8"
 __author__ = "SAL"
 __all__ = [
     "getFT",

magpylib_force/force.py

@@ -117,12 +117,12 @@ def getFTmagnet(sources, targets, eps=1e-5, anchor=None):
     targets: Cuboid object or 1D list of Cuboid objects
         Force and Torque acting on targets in the magnetic field generated by the sources
         will be computed. A target must have a valid `meshing` parameter.
-    
+
     eps: float, default=1e-5
         The magnetic field gradient is computed using finite differences (FD). eps is
         the FD step size. A good value is 1e-5 * characteristic system size (magnet size,
         distance between sources and targets, ...).
-    
+
     anchor: array_like, default=None
         The Force adds to the Torque via the anchor point. For a freely floating magnet
         this would be the barycenter. If `anchor=None`, this part of the Torque computation
@@ -151,10 +151,20 @@ def getFTmagnet(sources, targets, eps=1e-5, anchor=None):
 
     for i,tgt in enumerate(targets):
         tgt_vol = volume(tgt)
-        inst_mom = tgt.magnetization * tgt_vol / inst_numbers[i]
+        inst_mom = tgt.orientation.apply(tgt.magnetization) * tgt_vol / inst_numbers[i]
         MOM[insti[i]:insti[i+1]] = inst_mom
 
         mesh = mesh_target(tgt)
+        #import matplotlib.pyplot as plt
+        #ax = plt.figure().add_subplot(projection='3d')
+        #ax.plot(mesh[:,0], mesh[:,1], mesh[:,2], ls='', marker='.')
+
+        mesh = tgt.orientation.apply(mesh)
+        #ax.plot(mesh[:,0], mesh[:,1], mesh[:,2], ls='', marker='.', color='r')
+        #plt.show()
+        #import sys
+        #sys.exit()
+
         for j,ev in enumerate(eps_vec):
             POSS[insti[i]:insti[i+1],j] = mesh + ev + tgt.position
 
@@ -188,12 +198,12 @@ def getFTmagnet(sources, targets, eps=1e-5, anchor=None):
 #     targets: Cuboid object or 1D list of Cuboid objects
 #         Force and Torque acting on targets in the magnetic field generated by the sources
 #         will be computed. A target must have a valid `meshing` parameter.
-    
+
 #     eps: float, default=1e-5
 #         The magnetic field gradient is computed using finite differences (FD). eps is
 #         the FD step size. A good value is 1e-5 * characteristic system size (magnet size,
 #         distance between sources and targets, ...).
-    
+
 #     anchor: array_like, default=None
 #         The Force adds to the Torque via the anchor point. For a freely floating magnet
 #         this would be the barycenter. If `anchor=None`, this part of the Torque computation
@@ -292,14 +302,14 @@ def getFTcurrent(sources, targets, anchor=None, eps=None):
     CURR = np.zeros((no_inst,))
 
     for i,tgt in enumerate(targets):
-        verts = tgt.vertices
+        verts = tgt.orientation.apply(tgt.vertices)
         mesh = mesh_numbers[i]
 
         lvec = np.repeat(verts[1:] - verts[:-1], mesh, axis=0)/mesh
         LVEC[insti[i]:insti[i+1]] = lvec
 
         CURR[insti[i]:insti[i+1]] = [tgt.current]*mesh*seg_numbers[i]
-        
+
         for j in range(seg_numbers[i]):
             poss = np.linspace(verts[j]+lvec[j*mesh]/2, verts[j+1]-lvec[j*mesh]/2, mesh) + tgt.position
             POSS[insti[i]+mesh*j:insti[i]+mesh*(j+1)] = poss

magpylib_force/utility.py

@@ -51,4 +51,4 @@ def check_input_targets(targets):
 #         targets = [targets]
 #     if not isinstance(targets, list):
 #         raise ValueError("Bad targets input.")
-#     return targets
+#     return targets

tests/test_FEM.py

@@ -222,7 +222,7 @@ def test_ANSYS_magnet_current_close():
 
         t1 = np.array((t[4], t[5], t[6]))*1e-9
         t2 = np.array((t[7], t[8], t[9]))*1e-9
-        
+
         for wire in wires:
             wire.current = i0
         magnet.position = pos + np.array((0,0,.15))*1e-3

tests/test_basics.py

@@ -0,0 +1,56 @@
+import numpy as np
+import magpylib as magpy
+from magpylib_force import getFT
+
+
+def test_rotation1():
+    """
+    test if rotated magnets give the correct result
+    """
+    s1 = magpy.magnet.Sphere(diameter=1, polarization=(1,2,3))
+
+    c1 = magpy.magnet.Cuboid(
+        dimension=(1,1,1),
+        polarization=(0,0,1),
+        position=(1,2,3),
+    )
+    c1.meshing = (5,5,5) # regular rectangular mesh in Cuboid
+
+    c2 = magpy.magnet.Cuboid(
+        dimension=(1,1,1),
+        polarization=(1,0,0),
+        position=(1,2,3),
+    )
+    c2.meshing = (5,5,5) # regular rectangular mesh in Cuboid
+    c2.rotate_from_angax(-90, 'y')
+
+    FT = getFT(s1, [c1, c2], anchor=(0,0,0))
+
+    np.testing.assert_allclose(FT[0], FT[1])
+
+
+def test_rotation2():
+    """
+    test if rotated currents give the same result
+    """
+    s1 = magpy.magnet.Sphere(diameter=1, polarization=(1,2,3), position=(0,0,-1))
+
+    verts1 = [(0,0,0), (1,0,0), (1,1,0), (0,1,0), (0,0,0)]
+    verts2 = [(0,0,0), (1,0,0), (1,0,1), (0,0,1), (0,0,0)]
+
+    c1 = magpy.current.Polyline(
+        vertices=verts1,
+        current=1,
+    )
+    c1.meshing = 15
+
+    c2 = magpy.current.Polyline(
+        vertices=verts2,
+        current=1,
+    )
+    c2.meshing = 15
+    c2.rotate_from_angax(-90, "x")
+
+    FT = getFT(s1, [c1, c2], anchor=(0,0,0))
+
+    np.testing.assert_allclose(FT[0], FT[1])

tests/test_interface.py

@@ -22,14 +22,14 @@ def test_getFT_target_inputs_01():
     FT1 = getFT(src1, wire1, anchor=(0,0,0))
     FT2 = getFT(src1, [wire1], anchor=(0,0,0))
     FT3 = getFT(src1, [wire1,wire2,wire3], anchor=(0,0,0))
-    
+
     np.testing.assert_allclose(FT1,FT2)
     np.testing.assert_allclose(FT1,FT3[0])
     np.testing.assert_allclose(FT1,FT3[1])
     np.testing.assert_allclose(FT1,FT3[2])
 
     FT4 = getFT(src1, wire1, anchor=(0,0,0))
     FT5 = getFT([src1, src2], wire1, anchor=(0,0,0))
-    
+
+    np.testing.assert_allclose(FT4*2,FT5)
     np.testing.assert_allclose(FT4*2,FT5)
-    np.testing.assert_allclose(FT4*2,FT5)

tests/test_physics.py

@@ -261,4 +261,4 @@ def test_sphere_cube_at_distance():
     errT = (FT[0,1]-FT[1,1])/np.linalg.norm(FT[0,1])
 
     assert max(abs(errF)) < 1e-5
-    assert max(abs(errT)) < 1e-5
+    assert max(abs(errT)) < 1e-5