Changeset 1373 for trunk/GSASIIsasd.py


Ignore:
Timestamp:
Jun 3, 2014 1:29:57 PM (7 years ago)
Author:
toby
Message:

minor source documention fixes

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/GSASIIsasd.py

    r1341 r1373  
    33'''
    44*GSASII small angle calculation module*
    5 ==================================
     5=======================================
    66
    77'''
     
    474474       
    475475def SquareWellSF(Q,args):
    476     ''' Computes structure factor for not dilute monodisperse hard sphere with a
     476    '''Computes structure factor for not dilute monodisperse hard sphere with a
    477477    square well potential interaction.
    478478    Refs.: SHARMA,SHARMA, PHYSICA 89A,(1977),212
    479479   
    480     param float Q: Q value array (A-1)
    481     param array args: [float R, float VolFrac, float depth, float width]:
     480    :param float Q: Q value array (A-1)
     481    :param array args: [float R, float VolFrac, float depth, float width]:
    482482        interparticle distance, volume fraction (<0.08), well depth (e/kT<1.5kT),
    483483        well width
    484     returns numpy array S(Q)
    485     well depth > 0 attractive & values outside above limits nonphysical cf.
    486     Monte Carlo simulations
     484    :returns: numpy array S(Q)
     485      well depth > 0 attractive & values outside above limits nonphysical cf.
     486      Monte Carlo simulations
    487487    '''
    488488    R,VolFr,Depth,Width = args
Note: See TracChangeset for help on using the changeset viewer.