Changeset e31b19a in sasmodels

Timestamp:

Sep 8, 2018 3:09:13 AM (6 years ago)

Author:

butler

Branches:

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

Children:

8400bc5

Parents:

b477605

Message:

update core_shell_cylinder docs to address #1030

Updated docs to point out the core_shell_cylinder includes end caps.
Point users to core_shell_bicelle if they want a core_shell_cylinder
without end caps (by setting face thickness to zero) — setting face
thickness to zero was tested and verified that setting that parameter to
zero does not cause a problem

File:

• sasmodels/models/core_shell_cylinder.py (modified) (2 diffs)

sasmodels/models/core_shell_cylinder.py

@@ -5 +5 @@
 The output of the 2D scattering intensity function for oriented core-shell
 cylinders is given by (Kline, 2006 [#kline]_). The form factor is normalized
-by the particle volume.
+by the particle volume. Note that in this model the shell envelops the entire
+core so that besides a "sleeve" around the core, the shell also provides two
+flat end caps of thickness = shell thickness. In other words the length of the
+total cyclinder is the length of the core cylinder plus twice the thickness of
+the shell. If no end caps are desired one should use the
+:ref:`core-shell-bicelle` and set the thickness of the end caps (in this case
+the "thick_face") to zero.
 
 .. math::
@@ -33 +39 @@
 
 and $\alpha$ is the angle between the axis of the cylinder and $\vec q$,
-$V_s$ is the volume of the outer shell (i.e. the total volume, including
-the shell), $V_c$ is the volume of the core, $L$ is the length of the core,
+$V_s$ is the total volume (i.e. including both the core and the outer shell),
+$V_c$ is the volume of the core, $L$ is the length of the core,
 $R$ is the radius of the core, $T$ is the thickness of the shell, $\rho_c$
 is the scattering length density of the core, $\rho_s$ is the scattering