Changeset cb0dc22 in sasmodels

Timestamp:

Mar 24, 2017 12:20:51 AM (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:

9f91afe, 3a45c2c, d810d96, 6cff473

Parents:

1aa7990

Message:

document known issue in cs parallelepiped and the fact that it is not
completely understood and under review. ticken #786 can now be moved to
release 4.2

File:

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

sasmodels/models/core_shell_parallelepiped.py

@@ -4 +4 @@
 
 Calculates the form factor for a rectangular solid with a core-shell structure.
-**The thickness and the scattering length density of the shell or "rim"
-can be different on all three (pairs) of faces.**
+The thickness and the scattering length density of the shell or 
+"rim" can be different on each (pair) of faces. However at this time
+the model does **NOT** actually calculate a c face rim despite the presence of
+the parameter.
+
+.. note::
+   This model was originally ported from NIST IGOR macros. However,t is not
+   yet fully understood by the SasView developers and is currently review.
 
 The form factor is normalized by the particle volume $V$ such that
@@ -35 +41 @@
     V = ABC + 2t_ABC + 2t_BAC + 2t_CAB
 
-**meaning that there are "gaps" at the corners of the solid.**
+**meaning that there are "gaps" at the corners of the solid.**  Again note that
+$t_C = 0$ currently. 
 
 The intensity calculated follows the :ref:`parallelepiped` model, with the
@@ -41 +48 @@
 amplitudes of the core and shell, in the same manner as a core-shell model.
 
-.. math::
-
-    F_{a}(Q,\alpha,\beta)=
-    \Bigg(\frac{sin(Q(L_A+2t_A)/2sin\alpha sin\beta)}{Q(L_A+2t_A)/2sin\alpha
-    sin\beta)}
-    - \frac{sin(QL_A/2sin\alpha sin\beta)}{QL_A/2sin\alpha sin\beta)} \Bigg)
-    + \frac{sin(QL_B/2sin\alpha sin\beta)}{QL_B/2sin\alpha sin\beta)}
-    + \frac{sin(QL_C/2sin\alpha sin\beta)}{QL_C/2sin\alpha sin\beta)}
 
 .. note::
@@ -93 +92 @@
     detector plane.
 
-Validation
-----------
-
-The model uses the form factor calculations implemented in a c-library provided
-by the NIST Center for Neutron Research (Kline, 2006).
-
 References
 ----------
@@ -113 +106 @@
 
 * **Author:** NIST IGOR/DANSE **Date:** pre 2010
-* **Last Modified by:** Paul Butler **Date:** September 30, 2016
-* **Last Reviewed by:** Miguel Gonzales **Date:** March 21, 2016
+* **Converted to sasmodels by:** Miguel Gonzales **Date:** February 26, 2016
+* **Last Modified by:** Wojciech Potrzebowski **Date:** January 11, 2017
+* **Currently Under review by:** Paul Butler
 """