Changeset a807206 in sasmodels for sasmodels/models/pearl_necklace.py

Timestamp:

Sep 30, 2016 10:42:06 PM (8 years ago)

Author:

butler

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, release_v0.94, release_v0.95, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

caddb14, 5031ca3

Parents:

2222134

Message:

updating more parameter names addressing #649

File:

• sasmodels/models/pearl_necklace.py (modified) (4 diffs)

sasmodels/models/pearl_necklace.py

@@ -46 +46 @@
 pearl_necklace model are the following
 
-NB: *number_of_pearls* must be an integer.
+NB: *num_pearls* must be an integer.
 
 References
@@ -68 +68 @@
 sld_string: the SLD of the strings
 sld_solvent: the SLD of the solvent
-number_of_pearls: number of the pearls
+num_pearls: number of the pearls
 radius: the radius of a pearl
-edge_separation: the length of string segment; surface to surface
-string_thickness: thickness (ie, diameter) of the string
+edge_sep: the length of string segment; surface to surface
+thick_string: thickness (ie, diameter) of the string
 """
 category = "shape:cylinder"
@@ -78 +78 @@
 parameters = [["radius", "Ang", 80.0, [0, inf], "volume",
                "Mean radius of the chained spheres"],
-              ["edge_separation", "Ang", 350.0, [0, inf], "volume",
+              ["edge_sep", "Ang", 350.0, [0, inf], "volume",
                "Mean separation of chained particles"],
-              ["string_thickness", "Ang", 2.5, [0, inf], "volume",
+              ["thick_string", "Ang", 2.5, [0, inf], "volume",
                "Thickness of the chain linkage"],
-              ["number_of_pearls", "none", 3, [0, inf], "volume",
+              ["num_pearls", "none", 3, [0, inf], "volume",
                "Number of pearls in the necklace (must be integer)"],
               ["sld", "1e-6/Ang^2", 1.0, [-inf, inf], "sld",
@@ -95 +95 @@
 single = False  # use double precision unless told otherwise
 
-def volume(radius, edge_separation, string_thickness, number_of_pearls):
+def volume(radius, edge_sep, thick_string, num_pearls):
     """
     Calculates the total particle volume of the necklace.
     Redundant with form_volume.
     """
-    number_of_strings = number_of_pearls - 1.0
-    string_vol = edge_separation * pi * pow((string_thickness / 2.0), 2.0)
+    number_of_strings = num_pearls - 1.0
+    string_vol = edge_sep * pi * pow((thick_string / 2.0), 2.0)
     pearl_vol = 4.0 /3.0 * pi * pow(radius, 3.0)
     total_vol = number_of_strings * string_vol
-    total_vol += number_of_pearls * pearl_vol
+    total_vol += num_pearls * pearl_vol
     return total_vol
 
-def ER(radius, edge_separation, string_thickness, number_of_pearls):
+def ER(radius, edge_sep, thick_string, num_pearls):
     """
     Calculation for effective radius.
     """
-    tot_vol = volume(radius, edge_separation, string_thickness, number_of_pearls)
+    tot_vol = volume(radius, edge_sep, thick_string, num_pearls)
     rad_out = pow((3.0*tot_vol/4.0/pi), 0.33333)
     return rad_out
 
 # parameters for demo
-demo = dict(scale=1, background=0, radius=80.0, edge_separation=350.0,
-            number_of_pearls=3, sld=1, sld_solvent=6.3, sld_string=1,
-            string_thickness=2.5,
+demo = dict(scale=1, background=0, radius=80.0, edge_sep=350.0,
+            num_pearls=3, sld=1, sld_solvent=6.3, sld_string=1,
+            thick_string=2.5,
             radius_pd=.2, radius_pd_n=5,
-            edge_separation_pd=25.0, edge_separation_pd_n=5,
-            number_of_pearls_pd=0, number_of_pearls_pd_n=0,
-            string_thickness_pd=0.2, string_thickness_pd_n=5,
+            edge_sep_pd=25.0, edge_sep_pd_n=5,
+            num_pearls_pd=0, num_pearls_pd_n=0,
+            thick_string_pd=0.2, thick_string_pd_n=5,
            )