Changeset 68532f3 in sasmodels for _sources/model/sphere.txt

Timestamp:

Nov 1, 2015 2:10:22 PM (8 years ago)

Author:

ajj

Branches:

gh-pages

Children:

4a9a316

Parents:

d1fe925

Message:

Adding docs

File:

• _sources/model/sphere.txt (moved) (moved from sasmodels/models/sphere.py) (2 diffs)

_sources/model/sphere.txt

@@ -1 @@
-r"""
+.. _sphere:
+
+Sphere
+=======================================================
+
+Spheres with uniform scattering length density
+
+=========== ================================= ============ =============
+Parameter   Description                       Units        Default value
+=========== ================================= ============ =============
+scale       Source intensity                  None                     1
+background  Source background                 |cm^-1|                  0
+sld         Layer scattering length density   |1e-6Ang^-2|             1
+solvent_sld Solvent scattering length density |1e-6Ang^-2|             6
+radius      Sphere radius                     |Ang|                   50
+=========== ================================= ============ =============
+
+The returned value is scaled to units of |cm^-1|.
+
+
 For information about polarised and magnetic scattering, click here_.
 
@@ -56 +75 @@
 
 *2013/09/09 and 2014/01/06 - Description reviewed by S King and P Parker.*
-"""
 
-from numpy import inf
-
-name = "sphere"
-title = "Spheres with uniform scattering length density"
-description = """\
-P(q)=(scale/V)*[3V(sld-solvent_sld)*(sin(qR)-qRcos(qR))
-                /(qR)^3]^2 + background
-    R: radius of sphere
-    V: The volume of the scatter
-    sld: the SLD of the sphere
-    solvent_sld: the SLD of the solvent
-"""
-category = "shape:sphere"
-
-#             ["name", "units", default, [lower, upper], "type","description"],
-parameters = [["sld", "1e-6/Ang^2", 1, [-inf, inf], "",
-               "Layer scattering length density"],
-              ["solvent_sld", "1e-6/Ang^2", 6, [-inf, inf], "",
-               "Solvent scattering length density"],
-              ["radius", "Ang", 50, [0, inf], "volume",
-               "Sphere radius"],
-             ]
-
-
-# No volume normalization despite having a volume parameter
-# This should perhaps be volume normalized?
-form_volume = """
-    return 1.333333333333333*M_PI*radius*radius*radius;
-    """
-
-Iq = """
-    const double qr = q*radius;
-    double sn, cn;
-    SINCOS(qr, sn, cn);
-    const double bes = qr==0.0 ? 1.0 : 3.0*(sn-qr*cn)/(qr*qr*qr);
-    const double fq = bes * (sld - solvent_sld) * form_volume(radius);
-    return 1.0e-4*fq*fq;
-    """
-
-
-Iqxy = """
-    // never called since no orientation or magnetic parameters.
-    //return -1.0;
-    return Iq(sqrt(qx*qx + qy*qy), sld, solvent_sld, radius);
-    """
-
-def ER(radius):
-    return radius
-
-# VR defaults to 1.0
-
-demo = dict(scale=1, background=0,
-            sld=6, solvent_sld=1,
-            radius=120,
-            radius_pd=.2, radius_pd_n=45)
-oldname = "SphereModel"
-oldpars = dict(sld='sldSph', solvent_sld='sldSolv', radius='radius')