Updated interactions/fields names

Author: davidcortesortuno

fidimag/atomistic/anisotropy.py

@@ -44,7 +44,7 @@ class Anisotropy(Energy):
 
     """
 
-    def __init__(self, Ku, axis=(1, 0, 0), name='anis'):
+    def __init__(self, Ku, axis=(1, 0, 0), name='Anisotropy'):
         self.Ku = Ku
         self.name = name
         self.axis = axis

fidimag/atomistic/demag.py

@@ -33,7 +33,7 @@ class Demag(object):
 
     """
 
-    def __init__(self, name='demag'):
+    def __init__(self, name='Demag'):
         self.name = name
         self.jac = True
 

fidimag/atomistic/demag_full.py

@@ -14,7 +14,7 @@ class DemagFull(Energy):
     the energy density.
     """
 
-    def __init__(self, name='demag_full'):
+    def __init__(self, name='DemagFull'):
         self.name = name
         self.jac = True
 

fidimag/atomistic/demag_hexagonal.py

@@ -47,7 +47,7 @@ class DemagHexagonal(object):
 
     """
 
-    def __init__(self, name='demag_hex'):
+    def __init__(self, name='DemagHexagonal'):
         self.name = name
         self.jac = True
 

fidimag/atomistic/exchange.py

@@ -41,7 +41,7 @@ class UniformExchange(Energy):
 
     """
 
-    def __init__(self, J=0, name='exch'):
+    def __init__(self, J=0, name='UniformExchange'):
         self.J = J
         self.name = name
 
@@ -142,7 +142,7 @@ def my_exchange(pos):
 
     """
 
-    def __init__(self, J_fun, name='exch'):
+    def __init__(self, J_fun, name='Exchange'):
         self.J_fun = J_fun
         self.name = name
         self.jac = False

fidimag/micro/anisotropy.py

@@ -11,7 +11,7 @@ class UniaxialAnisotropy(Energy):
         compute the anisotropy field with the energy density E = K[1- (m.u)^2]
     """
 
-    def __init__(self, Ku, axis=(1, 0, 0), name='anis'):
+    def __init__(self, Ku, axis=(1, 0, 0), name='Anisotropy'):
         self.Ku = Ku
         self.name = name
         self.jac = True

fidimag/micro/demag.py

@@ -6,15 +6,17 @@
 
 
 default_options={
-    'pbc_2d_error':1e-10, 
-    'sample_repeat_nx':-1,
-    'sample_repeat_ny':-1,
-    'tensor_file_name':'2dpbc_tensors',
+    'pbc_2d_error': 1e-10,
+    'sample_repeat_nx': -1,
+    'sample_repeat_ny': -1,
+    'tensor_file_name': '2dpbc_tensors',
 }
 
+
 class Demag(object):
 
-    def __init__(self, name='demag', pbc_2d=False, pbc_options=default_options):
+    def __init__(self, name='Demag', pbc_2d=False,
+                 pbc_options=default_options):
         self.name = name
         self.oommf = True
         self.pbc_2d = pbc_2d
@@ -36,7 +38,7 @@ def setup(self, mesh, spin, Ms):
 
         if self.pbc_2d is True:
 
-            self.demag = clib.FFTDemag(self.dx, self.dy, self.dz, 
+            self.demag = clib.FFTDemag(self.dx, self.dy, self.dz,
                                        self.nx, self.ny, self.nz, tensor_type='2d_pbc')
 
             nxyz = self.nx*self.ny*self.nz
@@ -65,7 +67,7 @@ def setup(self, mesh, spin, Ms):
 
             if len(tensor_file_name) > 0 :
                 if not (os.path.exists(tensor_file_name+'.npz')):
-                    
+
                     self.demag.compute_tensors_2dpbc(tensors, pbc_2d_error, sample_repeat_nx, sample_repeat_ny, dipolar_radius)
                 else:
                     npzfile = np.load(tensor_file_name+'.npz')
@@ -82,14 +84,15 @@ def setup(self, mesh, spin, Ms):
 
             else:
                 self.demag.compute_tensors_2dpbc(tensors, pbc_2d_error, sample_repeat_nx, sample_repeat_ny, dipolar_radius)
-            
+
             #print tensors
             self.demag.fill_demag_tensors(tensors)
 
-            
+
         else:
             self.demag = clib.FFTDemag(self.dx, self.dy, self.dz,
-                                       self.nx, self.ny, self.nz, tensor_type='demag')
+                                       self.nx, self.ny, self.nz, 
+                                       tensor_type='demag')
 
 
 

fidimag/micro/dmi.py

@@ -12,7 +12,7 @@ class DMI(Energy):
         compute the DMI field in micromagnetics
     """
 
-    def __init__(self, D, name='dmi', dmi_type='bulk'):
+    def __init__(self, D, name='DMI', dmi_type='bulk'):
         """
         type could be 'interfacial' or 'bulk'
         """

fidimag/micro/exchange.py

@@ -9,7 +9,7 @@ class UniformExchange(Energy):
     Compute the exchange field in micromagnetics.
     """
 
-    def __init__(self, A, name='exch'):
+    def __init__(self, A, name='UniformExchange'):
         self.A = A
         self.name = name
         self.jac = True

tests/test_demag_libraries.py

@@ -67,9 +67,9 @@ def test_hexagonal_demags_1Dchain():
     # Brute force demag calculation
     sim.add(DemagFull())
 
-    sim.get_interaction('demag_full').compute_field()
-    sim.get_interaction('demag_full').field
-    demag_full_energy = sim.compute_energy() / const.meV
+    sim.get_interaction('DemagFull').compute_field()
+    sim.get_interaction('DemagFull').field
+    DemagFull_energy = sim.compute_energy() / const.meV
 
     # Demag using the FFT approach and a larger mesh
     sim2 = Sim(mesh)
@@ -78,13 +78,13 @@ def test_hexagonal_demags_1Dchain():
     sim2.set_m(lambda pos: m_init_dw(pos, N, a))
 
     sim2.add(DemagHexagonal())
-    sim2.get_interaction('demag_hex').compute_field()
+    sim2.get_interaction('DemagHexagonal').compute_field()
     sim2.compute_energy()
 
     demag_2fft_energy = sim2.compute_energy() / const.meV
 
     # We compare both energies scaled in meV
-    assert (demag_full_energy - demag_2fft_energy) < 1e-10
+    assert (DemagFull_energy - demag_2fft_energy) < 1e-10
 
 
 def test_cuboid_demags_1Dchain():
@@ -108,9 +108,9 @@ def test_cuboid_demags_1Dchain():
     # Brute force demag calculation
     sim.add(DemagFull())
 
-    sim.get_interaction('demag_full').compute_field()
-    # print sim.get_interaction('demag_full').field
-    demag_full_energy = sim.compute_energy() / const.meV
+    sim.get_interaction('DemagFull').compute_field()
+    # print sim.get_interaction('DemagFull').field
+    DemagFull_energy = sim.compute_energy() / const.meV
 
     # Demag using the FFT approach
     sim2 = Sim(mesh)
@@ -119,13 +119,13 @@ def test_cuboid_demags_1Dchain():
     sim2.set_m(lambda pos: m_init_dw(pos, N, a))
 
     sim2.add(Demag())
-    sim2.get_interaction('demag').compute_field()
+    sim2.get_interaction('Demag').compute_field()
     sim2.compute_energy()
 
     demag_fft_energy = sim2.compute_energy() / const.meV
 
     # We compare both energies scaled in meV
-    assert (demag_full_energy - demag_fft_energy) < 1e-10
+    assert (DemagFull_energy - demag_fft_energy) < 1e-10
 
 
 def test_cuboid_demags_2D():
@@ -154,9 +154,9 @@ def test_cuboid_demags_2D():
     # Brute force demag calculation
     sim.add(DemagFull())
 
-    sim.get_interaction('demag_full').compute_field()
-    # print sim.get_interaction('demag_full').field
-    demag_full_energy = sim.compute_energy() / const.meV
+    sim.get_interaction('DemagFull').compute_field()
+    # print sim.get_interaction('DemagFull').field
+    DemagFull_energy = sim.compute_energy() / const.meV
 
     # Demag using the FFT approach
     sim2 = Sim(mesh)
@@ -165,13 +165,13 @@ def test_cuboid_demags_2D():
     sim2.set_m(lambda pos: m_init_2Dvortex(pos, (xc, yc)))
 
     sim2.add(Demag())
-    sim2.get_interaction('demag').compute_field()
+    sim2.get_interaction('Demag').compute_field()
     sim2.compute_energy()
 
     demag_fft_energy = sim2.compute_energy() / const.meV
 
     # We compare both energies scaled in meV
-    assert (demag_full_energy - demag_fft_energy) < 1e-10
+    assert (DemagFull_energy - demag_fft_energy) < 1e-10
 
 
 def test_hexagonal_demags_2D():
@@ -202,9 +202,9 @@ def test_hexagonal_demags_2D():
     # Brute force demag calculation
     sim.add(DemagFull())
 
-    sim.get_interaction('demag_full').compute_field()
-    sim.get_interaction('demag_full').field
-    demag_full_energy = sim.compute_energy() / const.meV
+    sim.get_interaction('DemagFull').compute_field()
+    sim.get_interaction('DemagFull').field
+    DemagFull_energy = sim.compute_energy() / const.meV
 
     # Demag using the FFT approach and a larger mesh
     sim2 = Sim(mesh)
@@ -213,13 +213,13 @@ def test_hexagonal_demags_2D():
     sim2.set_m(lambda pos: m_init_2Dvortex(pos, (xc, yc)))
 
     sim2.add(DemagHexagonal())
-    sim2.get_interaction('demag_hex').compute_field()
+    sim2.get_interaction('DemagHexagonal').compute_field()
     sim2.compute_energy()
 
     demag_2fft_energy = sim2.compute_energy() / const.meV
 
     # We compare both energies scaled in meV
-    assert (demag_full_energy - demag_2fft_energy) < 1e-10
+    assert (DemagFull_energy - demag_2fft_energy) < 1e-10
 
 
 if __name__ == '__main__':