Changeset 68532f3 in sasmodels for _sources/model/barbell.txt


Ignore:
Timestamp:
Nov 1, 2015 4:10:22 PM (8 years ago)
Author:
ajj
Branches:
gh-pages
Children:
4a9a316
Parents:
d1fe925
Message:

Adding docs

File:
1 moved

Legend:

Unmodified
Added
Removed
  • _sources/model/barbell.txt

    rd1fe925 r68532f3  
    1 #barbell model 
    2 # cylinder model 
    3 # Note: model title and parameter table are inserted automatically 
    4 r""" 
     1.. _barbell: 
     2 
     3Barbell 
     4======================================================= 
     5 
     6Cylinder with spherical end caps 
     7 
     8=========== ================================= ============ ============= 
     9Parameter   Description                       Units        Default value 
     10=========== ================================= ============ ============= 
     11scale       Source intensity                  None                     1 
     12background  Source background                 |cm^-1|                  0 
     13sld         Barbell scattering length density |1e-6Ang^-2|             4 
     14solvent_sld Solvent scattering length density |1e-6Ang^-2|             1 
     15bell_radius Spherical bell radius             |Ang|                   40 
     16radius      Cylindrical bar radius            |Ang|                   20 
     17length      Cylinder bar length               |Ang|                  400 
     18theta       In plane angle                    degree                  60 
     19phi         Out of plane angle                degree                  60 
     20=========== ================================= ============ ============= 
     21 
     22The returned value is scaled to units of |cm^-1|. 
     23 
     24 
    525 
    626Calculates the scattering from a barbell-shaped cylinder (This model simply 
     
    110130H Kaya and N R deSouza, *J. Appl. Cryst.*, 37 (2004) 508-509 (addenda and errata) 
    111131 
    112 """ 
    113 from numpy import inf 
    114132 
    115 name = "barbell" 
    116 title = "Cylinder with spherical end caps" 
    117 description = """ 
    118         Calculates the scattering from a barbell-shaped cylinder. That is a sphereocylinder with spherical end caps that have a radius larger than that of the cylinder and the center of the end cap 
    119         radius lies outside of the cylinder. 
    120         Note: As the length of cylinder(bar) -->0,it becomes a dumbbell. And when rad_bar = rad_bell, it is a spherocylinder. 
    121         It must be that rad_bar <(=) rad_bell. 
    122 """ 
    123 category = "shape:cylinder" 
    124  
    125 #             ["name", "units", default, [lower, upper], "type","description"], 
    126 parameters = [["sld", "1e-6/Ang^2", 4, [-inf, inf], "", "Barbell scattering length density"], 
    127               ["solvent_sld", "1e-6/Ang^2", 1, [-inf, inf], "", "Solvent scattering length density"], 
    128               ["bell_radius", "Ang", 40, [0, inf], "volume", "Spherical bell radius"], 
    129               ["radius", "Ang", 20, [0, inf], "volume", "Cylindrical bar radius"], 
    130               ["length", "Ang", 400, [0, inf], "volume", "Cylinder bar length"], 
    131               ["theta", "degrees", 60, [-inf, inf], "orientation", "In plane angle"], 
    132               ["phi", "degrees", 60, [-inf, inf], "orientation", "Out of plane angle"], 
    133              ] 
    134  
    135 source = ["lib/J1.c", "lib/gauss76.c", "barbell.c"] 
    136  
    137 # parameters for demo 
    138 demo = dict(scale=1, background=0, 
    139             sld=6, solvent_sld=1, 
    140             bell_radius=40, radius=20, length=400, 
    141             theta=60, phi=60, 
    142             radius_pd=.2, radius_pd_n=5, 
    143             length_pd=.2, length_pd_n=5, 
    144             theta_pd=15, theta_pd_n=0, 
    145             phi_pd=15, phi_pd_n=0, 
    146            ) 
    147  
    148 # For testing against the old sasview models, include the converted parameter 
    149 # names and the target sasview model name. 
    150 oldname = 'BarBellModel' 
    151 oldpars = dict(sld='sld_barbell', 
    152                solvent_sld='sld_solv', bell_radius='rad_bell', 
    153                radius='rad_bar', length='len_bar') 
Note: See TracChangeset for help on using the changeset viewer.