Changeset 4b0a294 in sasmodels

Timestamp:

Apr 5, 2017 9:36:50 AM (7 years ago)

Author:

richardh

Branches:

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

Children:

b6e0636

Parents:

933af72

Message:

docu improvements re #890

Location:

sasmodels/models

Files:

• ellipsoid.py (modified) (1 diff)
• triaxial_ellipsoid.py (modified) (4 diffs)

sasmodels/models/ellipsoid.py

@@ -161 +161 @@
 def ER(radius_polar, radius_equatorial):
     import numpy as np
-
+# see equation (26) in A.Isihara, J.Chem.Phys. 18(1950)1446-1449
     ee = np.empty_like(radius_polar)
     idx = radius_polar > radius_equatorial

sasmodels/models/triaxial_ellipsoid.py

@@ -16 +16 @@
     \frac{X^2}{R_a^2} + \frac{Y^2}{R_b^2} + \frac{Z^2}{R_c^2} = 1
 
-the scattering is defined by the average over all orientations $\Omega$,
+the scattering for randomly oriented particles is defined by the average over all orientations $\Omega$ of:
 
 .. math::
 
-    P(q) = \text{scale}\frac{V}{4 \pi}\int_\Omega \Phi^2(qr) d\Omega + \text{background}
+    P(q) = \text{scale}(\Delta\rho)^2\frac{V}{4 \pi}\int_\Omega \Phi^2(qr) d\Omega + \text{background}
 
 where
@@ -79 +79 @@
 The radius-of-gyration for this system is  $R_g^2 = (R_a R_b R_c)^2/5$.
 
-The contrast is defined as SLD(ellipsoid) - SLD(solvent).  In the
+The contrast $\Delta\rho$ is defined as SLD(ellipsoid) - SLD(solvent).  In the
 parameters, $R_a$ is the minor equatorial radius, $R_b$ is the major
 equatorial radius, and $R_c$ is the polar radius of the ellipsoid.
@@ -102 +102 @@
 *Light scattering by ellipsoidal particles in solution*,
 J. Phys. D: Appl. Phys. 4, 72-77. doi:10.1088/0022-3727/4/1/310
+
+Authorship and Verification
+----------------------------
+
+* **Author:** NIST IGOR/DANSE **Date:** pre 2010
+* **Last Modified by:** Paul Kienzle (improved calculation) **Date:** April 4, 2017
+* **Last Reviewed by:** Paul Kienzle &Richard Heenan **Date:**  April 4, 2017
 
 """
@@ -144 +151 @@
     import numpy as np
     from .ellipsoid import ER as ellipsoid_ER
+     # now that radii can be in any size order, radii need sorting a,b,c where a~b and c is either much smaller or much larger
+     # also need some unit tests!
+    
     return ellipsoid_ER(radius_polar, np.sqrt(radius_equat_minor * radius_equat_major))