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

Timestamp:

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

Author:

ajj

Branches:

gh-pages

Children:

4a9a316

Parents:

d1fe925

Message:

Adding docs

File:

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

_sources/model/capped_cylinder.txt

@@ -1 @@
-r"""
+.. _capped-cylinder:
+
+Capped cylinder
+=======================================================
+
+Right circular cylinder with spherical end caps and uniform SLD
+
+=========== ================================== ============ =============
+Parameter   Description                        Units        Default value
+=========== ================================== ============ =============
+scale       Source intensity                   None                     1
+background  Source background                  |cm^-1|                  0
+sld         Cylinder scattering length density |1e-6Ang^-2|             4
+solvent_sld Solvent scattering length density  |1e-6Ang^-2|             1
+radius      Cylinder radius                    |Ang|                   20
+cap_radius  Cap radius                         |Ang|                   20
+length      Cylinder length                    |Ang|                  400
+theta       In plane angle                     degree                  60
+phi         Out of plane angle                 degree                  60
+=========== ================================== ============ =============
+
+The returned value is scaled to units of |cm^-1|.
+
+
 Calculates the scattering from a cylinder with spherical section end-caps.
 This model simply becomes the a convex lens when the length of the cylinder
@@ -109 +132 @@
 
 H Kaya and N-R deSouza, *J. Appl. Cryst.*, 37 (2004) 508-509 (addenda and errata)
-"""
-from numpy import inf
 
-name = "capped_cylinder"
-title = "Right circular cylinder with spherical end caps and uniform SLD"
-description = """That is, a sphereocylinder
-    with end caps that have a radius larger than
-    that of the cylinder and the center of the
-    end cap radius lies within the cylinder.
-    Note: As the length of cylinder -->0,
-    it becomes a ConvexLens.
-    It must be that radius <(=) cap_radius.
-    [Parameters];
-    scale: volume fraction of spheres,
-    background:incoherent background,
-    radius: radius of the cylinder,
-    length: length of the cylinder,
-    cap_radius: radius of the semi-spherical cap,
-    sld: SLD of the capped cylinder,
-    solvent_sld: SLD of the solvent.
-"""
-category = "shape:cylinder"
-
-#             ["name", "units", default, [lower, upper], "type", "description"],
-parameters = [["sld", "1e-6/Ang^2", 4, [-inf, inf], "",
-               "Cylinder scattering length density"],
-              ["solvent_sld", "1e-6/Ang^2", 1, [-inf, inf], "",
-               "Solvent scattering length density"],
-              ["radius", "Ang", 20, [0, inf], "volume", "Cylinder radius"],
-              # TODO: use an expression for cap radius with fixed bounds.
-              # The current form requires cap radius R bigger than cylinder radius r.
-              # Could instead use R/r in [1,inf], r/R in [0,1], or the angle between
-              # cylinder and cap in [0,90].  The problem is similar for the barbell
-              # model.  Propose r/R in [0,1] in both cases, with the model specifying
-              # cylinder radius in the capped cylinder model and sphere radius in the
-              # barbell model.  This leads to the natural value of zero for no cap
-              # in the capped cylinder, and zero for no bar in the barbell model.  In
-              # both models, one would be a pill.
-              ["cap_radius", "Ang", 20, [0, inf], "volume", "Cap radius"],
-              ["length", "Ang", 400, [0, inf], "volume", "Cylinder length"],
-              ["theta", "degrees", 60, [-inf, inf], "orientation", "In plane angle"],
-              ["phi", "degrees", 60, [-inf, inf], "orientation", "Out of plane angle"],
-             ]
-
-source = ["lib/J1.c", "lib/gauss76.c", "capped_cylinder.c"]
-
-demo = dict(scale=1, background=0,
-            sld=6, solvent_sld=1,
-            radius=260, cap_radius=290, length=290,
-            theta=30, phi=15,
-            radius_pd=.2, radius_pd_n=1,
-            cap_radius_pd=.2, cap_radius_pd_n=1,
-            length_pd=.2, length_pd_n=10,
-            theta_pd=15, theta_pd_n=45,
-            phi_pd=15, phi_pd_n=1)
-oldname = 'CappedCylinderModel'
-oldpars = dict(sld='sld_capcyl', solvent_sld='sld_solv',
-               length='len_cyl', radius='rad_cyl', cap_radius='rad_cap')