Changeset e53b881 in sasmodels

Timestamp:

Mar 26, 2019 12:47:02 PM (6 years ago)

Author:

smk78

Branches:

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

Children:

fca112d

Parents:

598a354

Message:

Clarifications to model help whilst considering #1240

Location:

sasmodels/models

Files:

• flexible_cylinder.py (modified) (2 diffs)
• flexible_cylinder_elliptical.py (modified) (4 diffs)

sasmodels/models/flexible_cylinder.py

@@ -33 +33 @@
 and solvent respectively.
 
-Our model uses the form factor calculations implemented in a c-library provided
-by the NIST Center for Neutron Research (Kline, 2006). This states:
+Our model uses the form factor calculations in reference [1] as implemented in a 
+c-library provided by the NIST Center for Neutron Research (Kline, 2006). This states:
 
     'Method 3 With Excluded Volume' is used.
@@ -41 +41 @@
     pseudocontinuous limit.
     See equations (13,26-27) in the original reference for the details.
+
+**This is a model with complex behaviour depending on the ratio of** $L/b$ **and the 
+reader is strongly encouraged to read reference [1] before use.**
 
 References

sasmodels/models/flexible_cylinder_elliptical.py

@@ -4 +4 @@
 The non-negligible diameter of the cylinder is included by accounting
 for excluded volume interactions within the walk of a single cylinder.
+**Inter-cylinder interactions are NOT provided for.**
+
 The form factor is normalized by the particle volume such that
 
@@ -24 +26 @@
 -----------
 
-The function calculated in a similar way to that for the flexible_cylinder model
-from the reference given below using the author's "Method 3 With Excluded Volume".
+The function is calculated in a similar way to that for the 
+:ref:`flexible-cylinder` model in reference [1] below using the author's 
+"Method 3 With Excluded Volume".
+
 The model is a parameterization of simulations of a discrete representation of
 the worm-like chain model of Kratky and Porod applied in the pseudo-continuous
@@ -58 +62 @@
 
 The cross section of the cylinder is elliptical, with minor radius $a$ .
-The major radius is larger, so of course, **the axis ratio (parameter 5) must be
+The major radius is larger, so of course, **the axis_ratio must be
 greater than one.** Simple constraints should be applied during curve fitting to
 maintain this inequality.
@@ -67 +71 @@
 these parameters must be held fixed during model fitting.
 
-**No inter-cylinder interference effects are included in this calculation.**
+**This is a model with complex behaviour depending on the ratio of** $L/b$ **and the 
+reader is strongly encouraged to read reference [1] before use.**
 
 References