Changeset c1e44e5 in sasmodels for sasmodels/models/stickyhardsphere.py

Timestamp:

Mar 30, 2019 1:59:45 AM (5 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master

Children:

a42b091

Parents:

663d2a8

Message:

Add local link to source files. Refs #1263.

File:

• sasmodels/models/stickyhardsphere.py (modified) (5 diffs)

sasmodels/models/stickyhardsphere.py

@@ -1 +1 @@
 # Note: model title and parameter table are inserted automatically
 r"""
-Calculates the interparticle structure factor for a hard sphere fluid 
-with a narrow, attractive, potential well. Unlike the :ref:`squarewell` 
-model, here a perturbative solution of the Percus-Yevick closure 
-relationship is used. The strength of the attractive well is described 
+Calculates the interparticle structure factor for a hard sphere fluid
+with a narrow, attractive, potential well. Unlike the :ref:`squarewell`
+model, here a perturbative solution of the Percus-Yevick closure
+relationship is used. The strength of the attractive well is described
 in terms of "stickiness" as defined below.
 
 The perturbation parameter (perturb), $\tau$, should be fixed between 0.01
-and 0.1 and the "stickiness", $\epsilon$, allowed to vary to adjust the 
-interaction strength. The "stickiness" is defined in the equation below and is 
-a function of both the perturbation parameter and the interaction strength. 
-$\epsilon$ and $\tau$ are defined in terms of the hard sphere diameter $(\sigma = 2 R)$, 
-the width of the square well, $\Delta$ (having the same units as $R$\ ), 
-and the depth of the well, $U_o$, in units of $kT$. From the definition, it 
+and 0.1 and the "stickiness", $\epsilon$, allowed to vary to adjust the
+interaction strength. The "stickiness" is defined in the equation below and is
+a function of both the perturbation parameter and the interaction strength.
+$\epsilon$ and $\tau$ are defined in terms of the hard sphere diameter $(\sigma = 2 R)$,
+the width of the square well, $\Delta$ (having the same units as $R$\ ),
+and the depth of the well, $U_o$, in units of $kT$. From the definition, it
 is clear that smaller $\epsilon$ means a stronger attraction.
 
@@ -37 +37 @@
 
 The true particle volume fraction, $\phi$, is not equal to $h$ which appears
-in most of reference [1]. The two are related in equation (24). Reference 
-[1] also describes the relationship between this perturbative solution and 
+in most of reference [1]. The two are related in equation (24). Reference
+[1] also describes the relationship between this perturbative solution and
 the original sticky hard sphere (or "adhesive sphere") model of Baxter [2].
 
@@ -47 +47 @@
    reported to the command window and $S(q)$ is set to -1 (so it will
    disappear on a log-log plot!).
-   
-   Use tight bounds to keep the parameters to values that you know are 
-   physical (test them), and keep nudging them until the optimization 
+
+   Use tight bounds to keep the parameters to values that you know are
+   physical (test them), and keep nudging them until the optimization
    does not hit the constraints.
 
 .. note::
 
-   Earlier versions of SasView did not incorporate the so-called 
-   $\beta(q)$ ("beta") correction [3] for polydispersity and non-sphericity. 
+   Earlier versions of SasView did not incorporate the so-called
+   $\beta(q)$ ("beta") correction [3] for polydispersity and non-sphericity.
    This is only available in SasView versions 4.2.2 and higher.
-   
+
 In SasView the effective radius may be calculated from the parameters
 used in the form factor $P(q)$ that this $S(q)$ is combined with.
@@ -78 +78 @@
 .. [#] M Kotlarchyk and S-H Chen, *J. Chem. Phys.*, 79 (1983) 2461-2469
 
-Source
-------
-
-`stickyhardsphere.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/stickyhardsphere.py>`_
-
 Authorship and Verification
 ----------------------------
 
-* **Author:** 
-* **Last Modified by:** 
+* **Author:**
+* **Last Modified by:**
 * **Last Reviewed by:** Steve King **Date:** March 27, 2019
-* **Source added by :** Steve King **Date:** March 25, 2019
 """
 
@@ -101 +95 @@
 description = """\
     [Sticky hard sphere structure factor, with Percus-Yevick closure]
-        Interparticle structure factor S(Q) for a hard sphere fluid 
+        Interparticle structure factor S(Q) for a hard sphere fluid
     with a narrow attractive well. Fits are prone to deliver non-
-    physical parameters; use with care and read the references in 
-    the model documentation.The "beta(q)" correction is available 
+    physical parameters; use with care and read the references in
+    the model documentation.The "beta(q)" correction is available
     in versions 4.2.2 and higher.
 """