Changeset b0c4271 in sasmodels for sasmodels/models/adsorbed_layer.py

Timestamp:

Oct 5, 2016 7:40:41 PM (8 years ago)

Author:

butler

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

63e9cd8

Parents:

bb2d187

Message:

model documentation final format through core_shell_bicelle re: #646

File:

• sasmodels/models/adsorbed_layer.py (modified) (4 diffs)

sasmodels/models/adsorbed_layer.py

@@ -1 @@
-#adsorbed_layer model
-#conversion of Core2ndMomentModel.py
-#converted by Steve King, Mar 2016
+r"""
+Definition
+----------
 
-r"""
 This model describes the scattering from a layer of surfactant or polymer
 adsorbed on large, smooth, notionally spherical particles under the conditions
@@ -19 +18 @@
 the mean of the density distribution (ie, the distance of the centre-of-mass
 of the distribution from the interface), $\sigma = \sqrt{t^2/12}$.
-
-Definition
-----------
 
 .. math::
@@ -44 +40 @@
 calculation is exact).
 
+The code for this model is based originally on a a fortran implementation by
+Steve King at ISIS in the SANDRA package c. 1990.
+
 References
 ----------
 
-S King, P Griffiths, J Hone, and T Cosgrove,
-*SANS from Adsorbed Polymer Layers*, *Macromol. Symp.*, 190 (2002) 33-42.
+.. [#] S King, P Griffiths, J Hone, and T Cosgrove, *SANS from Adsorbed Polymer
+   Layers*, *Macromol. Symp.*, 190 (2002) 33-42.
+
+Authorship and Verification
+----------------------------
+
+* **Author:** Jae-Hi Cho **Date:** pre 2010
+* **Last Modified by:** Paul Kienzle **Date:** April 14, 2016
+* **Last Reviewed by:** Steve King **Date:** March 18, 2016
 """
 
@@ -80 +86 @@
 def Iq(q, second_moment, adsorbed_amount, density_shell, radius,
        volfraction, sld_shell, sld_solvent):
-    # pylint: disable = missing-docstring
-    #deltarhosqrd =  (sld_shell - sld_solvent) * (sld_shell - sld_solvent)
-    #numerator =  6.0 * pi * volfraction * (adsorbed_amount * adsorbed_amount)
-    #denominator =  (q * q) * (density_shell * density_shell) * radius
-    #eterm =  exp(-1.0 * (q * q) * (second_moment * second_moment))
-    ##scale by 10^-2 for units conversion to cm^-1
-    #inten =  1.0e-02 * deltarhosqrd * ((numerator / denominator) * eterm)
     with errstate(divide='ignore'):
         aa = ((sld_shell - sld_solvent)/density_shell * adsorbed_amount) / q