Changeset 9272cbd in sasmodels for sasmodels/models/core_shell_ellipsoid.py

Timestamp:

Oct 6, 2016 7:27:44 PM (8 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:

6ae7957

Parents:

b3f2a24

Message:

new figure and documentation edit for core_shell_ellipsoid

File:

• sasmodels/models/core_shell_ellipsoid.py (modified) (3 diffs)

sasmodels/models/core_shell_ellipsoid.py

@@ -11 +11 @@
 .. figure:: img/core_shell_ellipsoid_geometry.png
 
-The geometric parameters of this model are
+The geometric parameters of this model are shown in the diagram above, which
+shows (a) a cross section of the circular equator and (b) a cross section through
+the poles, of a prolate ellipsoid.
 
-*radius_equat_core =* equatorial core radius *= Rminor_core*
-
-*X_core = polar_core / radius_equat_core = Rmajor_core / Rminor_core*
-
-*Thick_shell = equat_outer - radius_equat_core = Rminor_outer - Rminor_core*
-
-*XpolarShell = Tpolar_shell / Thick_shell = (Rmajor_outer - Rmajor_core)/
-(Rminor_outer - Rminor_core)*
-
-In terms of the original radii
-
-*polar_core = radius_equat_core * X_core*
-
-*equat_shell = radius_equat_core + Thick_shell*
-
-*polar_shell = radius_equat_core * X_core + Thick_shell * XpolarShell*
-
-(where we note that "shell" perhaps confusingly, relates to the outer radius)
 When *X_core < 1* the core is oblate; when *X_core > 1* it is prolate.
 *X_core = 1* is a spherical core.
@@ -41 +25 @@
 ellipsoid. This may have some undesirable effects if the aspect ratio of the
 ellipsoid is large (ie, if $X << 1$ or $X >> 1$ ), when the $S(q)$
-- which assumes spheres - will not in any case be valid.
+- which assumes spheres - will not in any case be valid.  Generating a 
+custom product model will enable separate effective volume fraction and effective 
+radius in the $S(q)$.
 
 If SAS data are in absolute units, and the SLDs are correct, then scale should
@@ -50 +36 @@
 References
 ----------
+see for example:
+Kotlarchyk, M.; Chen, S.-H. J. Chem. Phys., 1983, 79, 2461.
+Berr, S.  J. Phys. Chem., 1987, 91, 4760.
 
-R K Heenan, 2015, reparametrised the core_shell_ellipsoid model
+Authorship and Verification
+----------------------------
+
+* **Author:** NIST IGOR/DANSE **Date:** pre 2010
+* **Last Modified by:** Richard Heenan (reparametrised model) **Date:** 2015
+* **Last Reviewed by:** Richard Heenan **Date:** October 6, 2016
 
 """