Changeset 68532f3 in sasmodels for _sources/model/lamellarCaille.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/lamellarCaille.txt (moved) (moved from sasmodels/models/lamellarCaille.py) (2 diffs)

_sources/model/lamellarCaille.txt

@@ -1 @@
-# Note: model title and parameter table are inserted automatically
-r"""
+.. _lamellarPS:
+
+Lamellarps
+=======================================================
+
+Random lamellar sheet with Caille structure factor
+
+================ ================================= ============ =============
+Parameter        Description                       Units        Default value
+================ ================================= ============ =============
+scale            Source intensity                  None                     1
+background       Source background                 |cm^-1|                  0
+thickness        sheet thickness                   |Ang|                   30
+Nlayers          Number of layers                  None                    20
+spacing          d-spacing of Caille S(Q)          |Ang|                  400
+Caille_parameter Caille parameter                  |Ang^-2|               0.1
+sld              layer scattering length density   |1e-6Ang^-2|           6.3
+solvent_sld      Solvent scattering length density |1e-6Ang^-2|             1
+================ ================================= ============ =============
+
+The returned value is scaled to units of |cm^-1|.
+
+
 This model provides the scattering intensity, $I(q) = P(q) S(q)$, for a
 lamellar phase where a random distribution in solution are assumed.
@@ -69 +90 @@
 
 also in J. Phys. Chem. B, 105, (2001) 11081-11088
-"""
-from numpy import inf
 
-name = "lamellarPS"
-title = "Random lamellar sheet with Caille structure factor"
-description = """\
-        [Random lamellar phase with Caille  structure factor]
-        randomly oriented stacks of infinite sheets
-                with Caille S(Q), having polydisperse spacing.
-        sld = sheet scattering length density
-                sld_solvent = solvent scattering length density
-                background = incoherent background
-                scale = scale factor
-"""
-category = "shape:lamellae"
-
-#             ["name", "units", default, [lower, upper], "type","description"],
-parameters = [["thickness", "Ang",  30.0, [0, inf], "volume", "sheet thickness"],
-              ["Nlayers", "",  20, [0, inf], "", "Number of layers"],
-              ["spacing", "Ang", 400., [0.0,inf], "volume", "d-spacing of Caille S(Q)"],
-              ["Caille_parameter", "1/Ang^2", 0.1, [0.0,0.8], "", "Caille parameter"],
-              ["sld", "1e-6/Ang^2", 6.3, [-inf,inf], "",
-               "layer scattering length density"],
-              ["solvent_sld", "1e-6/Ang^2", 1.0, [-inf,inf], "",
-               "Solvent scattering length density"],
-             ]
-
-source = ["lamellarCaille_kernel.c"]
-
-# No volume normalization despite having a volume parameter
-# This should perhaps be volume normalized?
-form_volume = """
-    return 1.0;
-    """
-
-Iqxy = """
-    return Iq(sqrt(qx*qx+qy*qy), IQ_PARAMETERS);
-    """
-
-# ER defaults to 0.0
-# VR defaults to 1.0
-
-demo = dict(scale=1, background=0,
-            thickness=67.,Nlayers=3.75,spacing=200.,
-            Caille_parameter=0.268,sld=1.0, solvent_sld=6.34,
-            thickness_pd= 0.1, thickness_pd_n=100,
-            spacing_pd= 0.05, spacing_pd_n=40)
-
-oldname = 'LamellarPSModel'
-oldpars = dict(thickness='delta', Nlayers='N_plates', Caille_parameter='caille',
-               sld='sld_bi',solvent_sld='sld_sol')