Moved DAMPING functions and variable to the DriverBase class. Moved common variables to DriverBase. Now we pass one less variable from sim to the driver. To initialise alpha in the BaseDriver it is necessary to define the number of spins from sim.mesh.n first

Author: davidcortesortuno

fidimag/atomistic/atomistic_driver.py

@@ -19,6 +19,7 @@ class AtomisticDriver(DriverBase):
 
     Variables that are proper of the driver class:
 
+        * alpha (damping)
         * mu_s_const
         * t
         * spin_last
@@ -33,9 +34,11 @@ class AtomisticDriver(DriverBase):
                      during the LLG equation integration. See the
                      fidimag/atomistic/lib/llg.c file for more details)
 
+        From DriverBase: t, spin_last, dm_dt, integrator_tolerances_set, step
+
     """
 
-    def __init__(self, mesh, spin, mu_s, mu_s_inv, field, alpha, pins,
+    def __init__(self, mesh, spin, mu_s, mu_s_inv, field, pins,
                  interactions,
                  name,
                  data_saver,
@@ -56,33 +59,29 @@ def __init__(self, mesh, spin, mu_s, mu_s_inv, field, alpha, pins,
         self.mu_s_const = 0
 
         self.field = field
-        self._alpha = alpha
         self._pins = pins
         self.interactions = interactions
         # Strings are not referenced, this is a copy:
         self.name = name
 
-        # The following are proper of the driver class: -----------------------
+        # The following are proper of the driver class: (see DriverBase) ------
         # See also the set_default_options() function
 
-        self.t = 0
-        self.step = 0
-        self.spin_last = np.ones(3 * self.mesh.n, dtype=np.float)
-        self.dm_dt = np.zeros(3 * self.mesh.n, dtype=np.float)
-        self.integrator_tolerances_set = False
-
         self.n = self.mesh.n
         self.n_nonzero = self.mesh.n  # number of spins that are not zero
                                       # We check this in the set_Ms function
 
+        self.initiate_variables(self.n)
+        self.set_default_options()
+
+        # Integrator options --------------------------------------------------
+
         if use_jac is not True:
             self.integrator = cvode.CvodeSolver(self.spin, self.sundials_rhs)
         else:
             self.integrator = cvode.CvodeSolver(
                 self.spin, self.sundials_rhs, self.sundials_jtn)
 
-        self.set_default_options()
-
         self.set_tols()
 
         # When initialising the integrator in the self.integrator call, the

fidimag/atomistic/llg.py

@@ -27,7 +27,7 @@ class LLG(AtomisticDriver):
 
     """
 
-    def __init__(self, mesh, spin, mu_s, mu_s_inv, field, alpha, pins,
+    def __init__(self, mesh, spin, mu_s, mu_s_inv, field, pins,
                  interactions,
                  name,
                  data_saver,
@@ -36,7 +36,7 @@ def __init__(self, mesh, spin, mu_s, mu_s_inv, field, alpha, pins,
 
         # Inherit from the driver class
         super(LLG, self).__init__(mesh, spin, mu_s, mu_s_inv, field,
-                                  alpha, pins, interactions, name,
+                                  pins, interactions, name,
                                   data_saver,
                                   use_jac
                                   )

fidimag/atomistic/llg_stt.py

@@ -30,7 +30,7 @@ class LLG_STT(AtomisticDriver):
 
     """
 
-    def __init__(self, mesh, spin, mu_s, mu_s_inv, field, alpha, pins,
+    def __init__(self, mesh, spin, mu_s, mu_s_inv, field, pins,
                  interactions,
                  name,
                  data_saver,
@@ -39,7 +39,7 @@ def __init__(self, mesh, spin, mu_s, mu_s_inv, field, alpha, pins,
 
         # Inherit from the driver class
         super(LLG_STT, self).__init__(mesh, spin, mu_s, mu_s_inv, field,
-                                      alpha, pins, interactions, name,
+                                      pins, interactions, name,
                                       data_saver,
                                       use_jac
                                       )

fidimag/atomistic/llg_stt_cpp.py

@@ -30,7 +30,7 @@ class LLG_STT_CPP(AtomisticDriver):
 
     """
 
-    def __init__(self, mesh, spin, mu_s, mu_s_inv, field, alpha, pins,
+    def __init__(self, mesh, spin, mu_s, mu_s_inv, field, pins,
                  interactions,
                  name,
                  data_saver,
@@ -39,7 +39,7 @@ def __init__(self, mesh, spin, mu_s, mu_s_inv, field, alpha, pins,
 
         # Inherit from the driver class
         super(LLG_STT_CPP, self).__init__(mesh, spin, mu_s, mu_s_inv, field,
-                                          alpha, pins, interactions, name,
+                                          pins, interactions, name,
                                           data_saver,
                                           use_jac
                                           )

fidimag/atomistic/sim.py

@@ -79,7 +79,6 @@ def __init__(self, mesh, name='unnamed', driver='llg',
                                             self._mu_s,
                                             self._mu_s_inv,
                                             self.field,
-                                            self._alpha,
                                             self._pins,
                                             self.interactions,
                                             self.name,

fidimag/atomistic/sllg.py

@@ -26,7 +26,7 @@ class SLLG(AtomisticDriver):
 
     """
 
-    def __init__(self, mesh, spin, mu_s, mu_s_inv, field, alpha, pins,
+    def __init__(self, mesh, spin, mu_s, mu_s_inv, field, pins,
                  interactions,
                  name,
                  data_saver,
@@ -35,7 +35,7 @@ def __init__(self, mesh, spin, mu_s, mu_s_inv, field, alpha, pins,
 
         # Inherit from the driver class
         super(SLLG, self).__init__(mesh, spin, mu_s, mu_s_inv, field,
-                                   alpha, pins, interactions, name,
+                                   pins, interactions, name,
                                    data_saver,
                                    use_jac=False
                                    )

fidimag/common/driver_base.py

@@ -3,6 +3,7 @@
 
 import os
 import numpy as np
+import fidimag.common.helper as helper
 
 
 class DriverBase(object):
@@ -15,6 +16,61 @@ def __init__(self):
 
     # -------------------------------------------------------------------------
 
+    def initiate_variables(self, n_spins):
+        """
+        Common variables for both micro and atomistic drivers
+        """
+        self._alpha = np.zeros(n_spins, dtype=np.float)
+
+        self.t = 0
+        self.spin_last = np.ones(3 * n_spins, dtype=np.float)
+        self.dm_dt = np.zeros(3 * n_spins, dtype=np.float)
+        self.integrator_tolerances_set = False
+        self.step = 0
+
+    def get_alpha(self):
+        """
+        Returns the array with the spatially dependent Gilbert damping
+        per mesh/lattice site
+        """
+        return self._alpha
+
+    def set_alpha(self, value):
+        """
+
+        Set the Gilbert damping of the system as a uniform or spatially
+        dependent scalar field
+
+        ARGUMENTS:
+
+        value     :: * For a uniform damping across the whole sample, just
+                       specify a float ranging from 0 to 1
+
+                     * In addition, you can specify a function that returns
+                       values ranging from 0 to 1, which depends on the spatial
+                       coordinates. For example, a damping that increases
+                       linearly in the x direction:
+
+                        def alpha_profile(r):
+                            for r[0] <= 10:
+                                return r[0] / 10.
+                            else:
+                                return 0
+
+                     * You can also manually specify an array with n values
+                     ranging from 0 to 1 with the damping values, in the same
+                     order than the mesh coordinates array.
+
+                     * Alternatively, if you previously saved the damping
+                     field array to a numpy file, you can load it using
+                     numpy.load(my_array)
+        """
+        self._alpha[:] = helper.init_scalar(value, self.mesh)
+
+    alpha = property(get_alpha, set_alpha)
+
+    # ------------------------------------------------------------------------
+
     def stat(self):
         return self.integrator.stat()
 

fidimag/common/sim_base.py

@@ -20,7 +20,6 @@ def __init__(self, mesh, name):
         self.unit_length = mesh.unit_length
 
         self._magnetisation = np.zeros(self.n, dtype=np.float)
-        self._alpha = np.zeros(self.n, dtype=np.float)
         self.spin = np.ones(3 * self.n, dtype=np.float)
         self._pins = np.zeros(self.n, dtype=np.int32)
         self.field = np.zeros(3 * self.n, dtype=np.float)
@@ -149,47 +148,6 @@ def pin_profile(r):
 
     pins = property(get_pins, set_pins)
 
-    def get_alpha(self):
-        """
-        Returns the array with the spatially dependent Gilbert damping
-        per mesh/lattice site
-        """
-        return self._alpha
-
-    def set_alpha(self, value):
-        """
-
-        Set the Gilbert damping of the system as a uniform or spatially
-        dependent scalar field
-
-        ARGUMENTS:
-
-        value     :: * For a uniform damping across the whole sample, just
-                       specify a float ranging from 0 to 1
-
-                     * In addition, you can specify a function that returns
-                       values ranging from 0 to 1, which depends on the spatial
-                       coordinates. For example, a damping that increases
-                       linearly in the x direction:
-
-                        def alpha_profile(r):
-                            for r[0] <= 10:
-                                return r[0] / 10.
-                            else:
-                                return 0
-
-                     * You can also manually specify an array with n values
-                     ranging from 0 to 1 with the damping values, in the same
-                     order than the mesh coordinates array.
-
-                     * Alternatively, if you previously saved the damping
-                     field array to a numpy file, you can load it using
-                     numpy.load(my_array)
-        """
-        self._alpha[:] = helper.init_scalar(value, self.mesh)
-
-    alpha = property(get_alpha, set_alpha)
-
     def add(self, interaction, save_field=False):
         """
 

fidimag/micro/llg.py

@@ -28,7 +28,7 @@ class LLG(MicroDriver):
 
     """
 
-    def __init__(self, mesh, spin, Ms, field, alpha, pins,
+    def __init__(self, mesh, spin, Ms, field, pins,
                  interactions,
                  name,
                  data_saver,
@@ -38,7 +38,7 @@ def __init__(self, mesh, spin, Ms, field, alpha, pins,
 
         # Inherit from the driver class
         super(LLG, self).__init__(mesh, spin, Ms, field,
-                                  alpha, pins, interactions, name,
+                                  pins, interactions, name,
                                   data_saver,
                                   integrator='sundials',
                                   use_jac=False

fidimag/micro/llg_stt.py

@@ -29,7 +29,7 @@ class LLG_STT(MicroDriver):
 
         """
 
-    def __init__(self, mesh, spin, Ms, field, alpha, pins,
+    def __init__(self, mesh, spin, Ms, field, pins,
                  interactions,
                  name,
                  data_saver,
@@ -39,7 +39,7 @@ def __init__(self, mesh, spin, Ms, field, alpha, pins,
 
         # Inherit from the driver class
         super(LLG_STT, self).__init__(mesh, spin, Ms, field,
-                                      alpha, pins, interactions, name,
+                                      pins, interactions, name,
                                       data_saver,
                                       integrator='sundials',
                                       use_jac=False