Changeset 2c108a3 in sasmodels for doc

Timestamp:

Oct 19, 2017 2:58:57 PM (7 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

6773b02

Parents:

9ee2756

Message:

simplify magnetism code

Location:

doc

Files:

• developer/calculator.rst (modified) (2 diffs)
• guide/magnetism/magnetism.rst (modified) (4 diffs)

doc/developer/calculator.rst

@@ -107 +107 @@
 - MAGNETIC_PARS is a comma separated list of the magnetic SLDs, indicating
   their locations in the values vector.
-- MAGNETIC_PAR1, ... are the first three magnetic parameter ids so we can
-  hard code the setting of magnetic values if there are only a few of them.
 - KERNEL_NAME is the name of the function being declared
 - PARAMETER_TABLE is the declaration of the parameters to the kernel:
@@ -208 +206 @@
     NUM_MAGNETIC = 2      // two parameters might be magnetic
     MAGNETIC_PARS = 4, 5  // they are sld and sld_solvent
-    MAGNETIC_PAR0 = 4     // sld index
-    MAGNETIC_PAR1 = 5     // solvent index
 
     details {

doc/guide/magnetism/magnetism.rst

@@ -31 +31 @@
 to the $x'$ axis, the possible spin states after the sample are then
 
-No spin-flips (+ +) and (- -)
+Non spin-flip (+ +) and (- -)
 
-Spin-flips    (+ -) and (- +)
+Spin-flip    (+ -) and (- +)
 
 .. figure::
@@ -41 +41 @@
 $\phi$ and $\theta_{up}$, respectively, then, depending on the spin state of the
 neutrons, the scattering length densities, including the nuclear scattering
-length density ($\beta{_N}$) are
+length density $(\beta{_N})$ are
 
 .. math::
     \beta_{\pm\pm} =  \beta_N \mp D_M M_{\perp x'}
-    \text{ when there are no spin-flips}
+    \text{ for non spin-flip states}
 
 and
@@ -51 +51 @@
 .. math::
     \beta_{\pm\mp} =  -D_M (M_{\perp y'} \pm iM_{\perp z'})
-    \text{ when there are}
+    \text{ for spin-flip states}
 
 where
 
 .. math::
-    M_{\perp x'} = M_{0q_x}\cos(\theta_{up})+M_{0q_y}\sin(\theta_{up}) \\
-    M_{\perp y'} = M_{0q_y}\cos(\theta_{up})-M_{0q_x}\sin(\theta_{up}) \\
-    M_{\perp z'} = M_{0z} \\
-    M_{0q_x} = (M_{0x}\cos\phi - M_{0y}\sin\phi)\cos\phi \\
-    M_{0q_y} = (M_{0y}\sin\phi - M_{0x}\cos\phi)\sin\phi
+    M_{\perp x'} &= M_{0q_x}\cos(\theta_{up})+M_{0q_y}\sin(\theta_{up}) \\
+    M_{\perp y'} &= M_{0q_y}\cos(\theta_{up})-M_{0q_x}\sin(\theta_{up}) \\
+    M_{\perp z'} &= M_{0z} \\
+    M_{0q_x} &= (M_{0x}\cos\phi - M_{0y}\sin\phi)\cos\phi \\
+    M_{0q_y} &= (M_{0y}\sin\phi - M_{0x}\cos\phi)\sin\phi
 
 Here, $M_{0x}$, $M_{0x}$, $M_{0z}$ are the x, y and z components
@@ -66 +66 @@
 
 .. math::
-    M_{0x} = M_0\cos\theta_M\cos\phi_M \\
-    M_{0y} = M_0\sin\theta_M \\
-    M_{0z} = -M_0\cos\theta_M\sin\phi_M
+    M_{0x} &= M_0\cos\theta_M\cos\phi_M \\
+    M_{0y} &= M_0\sin\theta_M \\
+    M_{0z} &= -M_0\cos\theta_M\sin\phi_M
 
 and the magnetization angles $\theta_M$ and $\phi_M$ are defined in