Changeset 39a06c9 in sasmodels for sasmodels/modelinfo.py


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed
  • sasmodels/modelinfo.py

    rbe43e39 r39a06c9  
    264264    will have a magnitude and a direction, which may be different from 
    265265    other sld parameters. The volume parameters are used for calls 
    266     to form_volume within the kernel (required for volume normalization) 
    267     and for calls to ER and VR for effective radius and volume ratio 
    268     respectively. 
     266    to form_volume within the kernel (required for volume normalization), 
     267    to shell_volume (for hollow shapes), and to effective_radius (for 
     268    structure factor interactions) respectively. 
    269269 
    270270    *description* is a short description of the parameter.  This will 
     
    799799    info.c_code = getattr(kernel_module, 'c_code', None) 
    800800    info.effective_radius = getattr(kernel_module, 'effective_radius', None) 
    801     info.ER = None  # CRUFT 
    802     info.VR = None  # CRUFT 
    803801    # TODO: check the structure of the tests 
    804802    info.tests = getattr(kernel_module, 'tests', []) 
     
    932930    #: use those functions. 
    933931    source = None           # type: List[str] 
    934     #: The set of tests that must pass.  The format of the tests is described 
    935     #: in :mod:`model_test`. 
    936     tests = None            # type: List[TestCondition] 
    937     #: Returns the effective radius of the model given its volume parameters. 
    938     #: The presence of *ER* indicates that the model is a form factor model 
    939     #: that may be used together with a structure factor to form an implicit 
    940     #: multiplication model. 
    941     #: 
    942     #: The parameters to the *ER* function must be marked with type *volume*. 
    943     #: in the parameter table.  They will appear in the same order as they 
    944     #: do in the table.  The values passed to *ER* will be vectors, with one 
    945     #: value for each polydispersity condition.  For example, if the model 
    946     #: is polydisperse over both length and radius, then both length and 
    947     #: radius will have the same number of values in the vector, with one 
    948     #: value for each *length X radius*.  If only *radius* is polydisperse, 
    949     #: then the value for *length* will be repeated once for each value of 
    950     #: *radius*.  The *ER* function should return one effective radius for 
    951     #: each parameter set.  Multiplicity parameters will be received as 
    952     #: arrays, with one row per polydispersity condition. 
    953     c_code = None 
     932    #: inline source code, added after all elements of source 
     933    c_code = None           # type: Optional[str] 
    954934    #: Returns the form volume for python-based models.  Form volume is needed 
    955935    #: for volume normalization in the polydispersity integral.  If no 
     
    1001981    #: Line numbers for symbols defining C code 
    1002982    lineno = None           # type: Dict[str, int] 
     983    #: The set of tests that must pass.  The format of the tests is described 
     984    #: in :mod:`model_test`. 
     985    tests = None            # type: List[TestCondition] 
    1003986 
    1004987    def __init__(self): 
Note: See TracChangeset for help on using the changeset viewer.