Changeset 39a06c9 in sasmodels for sasmodels/generate.py

Timestamp:

Oct 25, 2018 3:58:26 PM (5 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

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

Children:

81751c2

Parents:

304c775

Message:

Remove references to ER and VR from sasmodels. Refs #1202.

File:

• sasmodels/generate.py (modified) (3 diffs)

sasmodels/generate.py

@@ -24 +24 @@
     dimension, or 1.0 if no volume normalization is required.
 
-    *ER(p1, p2, ...)* returns the effective radius of the form with
-    particular dimensions.
-
-    *VR(p1, p2, ...)* returns the volume ratio for core-shell style forms.
+    *shell_volume(p1, p2, ...)* returns the volume of the shell for forms
+    which are hollow.
+
+    *effective_radius(mode, p1, p2, ...)* returns the effective radius of
+    the form with particular dimensions.  Mode determines the type of
+    effective radius returned, with mode=1 for equivalent volume.
 
     #define INVALID(v) (expr)  returns False if v.parameter is invalid
@@ -72 +74 @@
 background.  This will work correctly even when polydispersity is off.
 
-*ER* and *VR* are python functions which operate on parameter vectors.
-The constructor code will generate the necessary vectors for computing
-them with the desired polydispersity.
 The kernel module must set variables defining the kernel meta data:
 
@@ -106 +105 @@
     create the OpenCL kernel functions.  The files defining the functions
     need to be listed before the files which use the functions.
-
-    *ER* is a python function defining the effective radius.  If it is
-    not present, the effective radius is 0.
-
-    *VR* is a python function defining the volume ratio.  If it is not
-    present, the volume ratio is 1.
 
     *form_volume*, *Iq*, *Iqac*, *Iqabc* are strings containing