Changes in sasmodels/models/core_shell_cylinder.py [f4878dc:01eece6] in sasmodels

File:

• sasmodels/models/core_shell_cylinder.py (modified) (8 diffs)

sasmodels/models/core_shell_cylinder.py

@@ -12 +12 @@
 .. math::
 
-    P(q,\alpha) = \frac{\text{scale}}{V_s} F^2(q) + \text{background}
+    I(q,\alpha) = \frac{\text{scale}}{V_s} F^2(q) + \text{background}
 
 where
@@ -52 +52 @@
 
 To provide easy access to the orientation of the core-shell cylinder, we
-define the axis of the cylinder using two angles $\theta$ and $\phi$. As
-for the case of the cylinder, those angles are defined in
-:num:`figure #cylinder-orientation`.
+define the axis of the cylinder using two angles $\theta$ and $\phi$. 
+(see :ref:`cylinder model <cylinder-angle-definition>`)
 
 NB: The 2nd virial coefficient of the cylinder is calculated based on
@@ -74 +73 @@
 distribution $p(\theta,\phi) = 1.0$.
 
-2013/11/26 - Description reviewed by Heenan, R.
+Reference
+---------
+see, for example, Ian Livsey  J. Chem. Soc., Faraday Trans. 2, 1987,83, 1445-1452
+
+2016/03/18 - Description reviewed by RKH
 """
 
@@ -83 +86 @@
 description = """
 P(q,alpha)= scale/Vs*f(q)^(2) + background,
-      where: f(q)= 2(core_sld - solvant_sld)
+      where: f(q)= 2(sld_core - solvant_sld)
         * Vc*sin[qLcos(alpha/2)]
         /[qLcos(alpha/2)]*J1(qRsin(alpha))
-        /[qRsin(alpha)]+2(shell_sld-solvent_sld)
+        /[qRsin(alpha)]+2(sld_shell-sld_solvent)
         *Vs*sin[q(L+T)cos(alpha/2)][[q(L+T)
         *cos(alpha/2)]*J1(q(R+T)sin(alpha))
@@ -96 +99 @@
     Vc: the volume of the core
     L: the length of the core
-        shell_sld: the scattering length density of the shell
-    solvent_sld: the scattering length density of the solvent
+        sld_shell: the scattering length density of the shell
+    sld_solvent: the scattering length density of the solvent
     background: the background
     T: the thickness
@@ -109 +112 @@
 
 #             ["name", "units", default, [lower, upper], "type", "description"],
-parameters = [["core_sld", "1e-6/Ang^2", 4, [-inf, inf], "",
+parameters = [["sld_core", "1e-6/Ang^2", 4, [-inf, inf], "",
                "Cylinder core scattering length density"],
-              ["shell_sld", "1e-6/Ang^2", 4, [-inf, inf], "",
+              ["sld_shell", "1e-6/Ang^2", 4, [-inf, inf], "",
                "Cylinder shell scattering length density"],
-              ["solvent_sld", "1e-6/Ang^2", 1, [-inf, inf], "",
+              ["sld_solvent", "1e-6/Ang^2", 1, [-inf, inf], "",
                "Solvent scattering length density"],
               ["radius", "Ang", 20, [0, inf], "volume",
@@ -147 +150 @@
 
 demo = dict(scale=1, background=0,
-            core_sld=6, shell_sld=8, solvent_sld=1,
+            sld_core=6, sld_shell=8, sld_solvent=1,
             radius=45, thickness=25, length=340,
             theta=30, phi=15,
@@ -156 +159 @@
             phi_pd=15, phi_pd_n=1)
 oldname = 'CoreShellCylinderModel'
-oldpars = dict(theta='axis_theta', phi='axis_phi')
+oldpars = dict( sld_core='core_sld',
+               sld_shell='shell_sld',
+               sld_solvent='solvent_sld',
+               theta='axis_theta', phi='axis_phi')
+# ADDED by:  RKH  ON: 18Mar2016 renamed sld's etc