Python help for Parameter class added

_setup/parameters.py

@@ -8,13 +8,36 @@ class Parameters:
   '''
   Objects of this class are meant to specify
     - material parameters [in SI units]
-    - physical constants [those are predefined]
+      .A ... exchange stiffness
+      .Ms ... saturation magnetization
+      .K ... anisotropy constant
+      .D ... DMI constant
+      .alpha ... Gilber damping parameters
+      .P ... polarization rate (if current applied)
+      .xi ... zhang li non-adiabaticity
+      .Je ... applied current (1-dim for Slonczewski, 3-dim for Zhang-Li),
+        each component may be (t, x, y, z)-dependent (e.g., lambda fct)
+      .d ... thickness of geometry (necessary if DMI or Slonczewski used)
+      .p ... current polarization (Slonczewski)
+    - simulation options:
+      .m0 ... Initial magnetization: ["file.vtk", (0, 0, 1), 
+        or (ngsolveCF, ngolvesCF, ngsolveCF)] are possible
+      .theta ... degree of implicitness, available for, e.g., TPS1
+      .T_start, .T_end ..., e.g., 0 and 3e-9 to simulate for 3ns
+    - physical constants [those are predefined, i.e., they have default values]
+      .gamma0 [2.212761569e+05]
+      .mu0 [1.2566370614359173e-06]
+      .g [2.0023193043617]
+      .muB [9.27400968e-24]
+      .e [1.6021766208e-19]
+      .hbar [1.054571800e-34]
     - which lower-order contributions to consider:
       .H_ext = [ (f,g,h) where f, g, h are either constants 
                  or functions in (t, x, y, z) ]
+      .easy_axis [(1,0,0)] and .K for uniaxial anisotropy
       .maxwellCoupling = ['none', 'magnetostaticField', 'strayField','oerstedField']
       (magnetostaticField = strayfield & oersted field)
-      .dmCoupling = ['none', 'bulk', 'interfacial']
+      .dmCoupling = ['none', 'bulk', 'interfacial'] (if interfacial, .dmi_axis (default = 'z'))
       .spintronicsCoupling = ['none', 'zhangLi', 'slonczewski']
   '''