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


Ignore:
Timestamp:
Nov 1, 2015 2: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/lamellarPC.txt

    rd1fe925 r68532f3  
    1 # Note: model title and parameter table are inserted automatically 
    2 r""" 
     1.. _lamellarPC: 
     2 
     3Lamellarpc 
     4======================================================= 
     5 
     6Random lamellar sheet with paracrystal structure factor 
     7 
     8================ ================================= ============ ============= 
     9Parameter        Description                       Units        Default value 
     10================ ================================= ============ ============= 
     11scale            Source intensity                  None                     1 
     12background       Source background                 |cm^-1|                  0 
     13thickness        sheet thickness                   |Ang|                   33 
     14Nlayers          Number of layers                  None                    20 
     15spacing          d-spacing of paracrystal stack    |Ang|                  250 
     16spacing_polydisp d-spacing of paracrystal stack    |Ang|                    0 
     17sld              layer scattering length density   |1e-6Ang^-2|             1 
     18solvent_sld      Solvent scattering length density |1e-6Ang^-2|          6.34 
     19================ ================================= ============ ============= 
     20 
     21The returned value is scaled to units of |cm^-1|. 
     22 
     23 
    324This model calculates the scattering from a stack of repeating lamellar 
    425structures. The stacks of lamellae (infinite in lateral dimension) are 
     
    6586*J. Phys. Chem. B*, 103 (1999) 9888-9897 
    6687 
    67 """ 
    6888 
    69 from numpy import inf 
    70  
    71 name = "lamellarPC" 
    72 title = "Random lamellar sheet with paracrystal structure factor" 
    73 description = """\ 
    74     [Random lamellar phase with paracrystal structure factor] 
    75         randomly oriented stacks of infinite sheets 
    76         with paracrytal S(Q), having polydisperse spacing. 
    77         sld = sheet scattering length density 
    78         sld_solvent = solvent scattering length density 
    79         background = incoherent background 
    80         scale = scale factor 
    81 """ 
    82 category = "shape:lamellae" 
    83  
    84 #             ["name", "units", default, [lower, upper], "type","description"], 
    85 parameters = [["thickness", "Ang", 33.0, [0, inf], "volume", 
    86                "sheet thickness"], 
    87               ["Nlayers", "", 20, [0, inf], "", 
    88                "Number of layers"], 
    89               ["spacing", "Ang", 250., [0.0, inf], "", 
    90                "d-spacing of paracrystal stack"], 
    91               ["spacing_polydisp", "Ang", 0.0, [0.0, inf], "", 
    92                "d-spacing of paracrystal stack"], 
    93               ["sld", "1e-6/Ang^2", 1.0, [-inf, inf], "", 
    94                "layer scattering length density"], 
    95               ["solvent_sld", "1e-6/Ang^2", 6.34, [-inf, inf], "", 
    96                "Solvent scattering length density"], 
    97              ] 
    98  
    99  
    100 source = ["lamellarPC_kernel.c"] 
    101  
    102 form_volume = """ 
    103     return 1.0; 
    104     """ 
    105  
    106 Iqxy = """ 
    107     return Iq(sqrt(qx*qx+qy*qy), IQ_PARAMETERS); 
    108     """ 
    109  
    110 # ER defaults to 0.0 
    111 # VR defaults to 1.0 
    112  
    113 demo = dict(scale=1, background=0, 
    114             thickness=33, Nlayers=20, spacing=250, spacing_polydisp=0.2, 
    115             sld=1.0, solvent_sld=6.34, 
    116             thickness_pd=0.2, thickness_pd_n=40) 
    117  
    118 oldname = 'LamellarPCrystalModel' 
    119 oldpars = dict(spacing_polydisp='pd_spacing', sld='sld_layer', 
    120                solvent_sld='sld_solvent') 
Note: See TracChangeset for help on using the changeset viewer.