Changeset e53b881 in sasmodels


Ignore:
Timestamp:
Mar 26, 2019 12:47:02 PM (4 months 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:
2 edited

Legend:

Unmodified
Added
Removed
  • sasmodels/models/flexible_cylinder.py

    r598a354 re53b881  
    3333and solvent respectively. 
    3434 
    35 Our model uses the form factor calculations implemented in a c-library provided 
    36 by the NIST Center for Neutron Research (Kline, 2006). This states: 
     35Our model uses the form factor calculations in reference [1] as implemented in a  
     36c-library provided by the NIST Center for Neutron Research (Kline, 2006). This states: 
    3737 
    3838    'Method 3 With Excluded Volume' is used. 
     
    4141    pseudocontinuous limit. 
    4242    See equations (13,26-27) in the original reference for the details. 
     43 
     44**This is a model with complex behaviour depending on the ratio of** $L/b$ **and the  
     45reader is strongly encouraged to read reference [1] before use.** 
    4346 
    4447References 
  • sasmodels/models/flexible_cylinder_elliptical.py

    r598a354 re53b881  
    44The non-negligible diameter of the cylinder is included by accounting 
    55for excluded volume interactions within the walk of a single cylinder. 
     6**Inter-cylinder interactions are NOT provided for.** 
     7 
    68The form factor is normalized by the particle volume such that 
    79 
     
    2426----------- 
    2527 
    26 The function calculated in a similar way to that for the flexible_cylinder model 
    27 from the reference given below using the author's "Method 3 With Excluded Volume". 
     28The function is calculated in a similar way to that for the  
     29:ref:`flexible-cylinder` model in reference [1] below using the author's  
     30"Method 3 With Excluded Volume". 
     31 
    2832The model is a parameterization of simulations of a discrete representation of 
    2933the worm-like chain model of Kratky and Porod applied in the pseudo-continuous 
     
    5862 
    5963The cross section of the cylinder is elliptical, with minor radius $a$ . 
    60 The major radius is larger, so of course, **the axis ratio (parameter 5) must be 
     64The major radius is larger, so of course, **the axis_ratio must be 
    6165greater than one.** Simple constraints should be applied during curve fitting to 
    6266maintain this inequality. 
     
    6771these parameters must be held fixed during model fitting. 
    6872 
    69 **No inter-cylinder interference effects are included in this calculation.** 
     73**This is a model with complex behaviour depending on the ratio of** $L/b$ **and the  
     74reader is strongly encouraged to read reference [1] before use.** 
    7075 
    7176References 
Note: See TracChangeset for help on using the changeset viewer.