source: sasview/sansmodels/src/sans/models/BEPolyelectrolyte.py @ 9316609

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 9316609 was 96672c0, checked in by Gervaise Alina <gervyh@…>, 16 years ago

code for description modified
  • Property mode set to 100644
File size: 4.6 KB
Line 
1#!/usr/bin/env python
2"""
3   
4    Provide F(x) = K*1/(4*pi*Lb*(alpha)^(2))*(q^(2)+k2)/(1+(r02)^(2))*(q^(2)+k2)\
5                       *(q^(2)-(12*h*C/b^(2)))
6    BEPolyelectrolyte as a BaseComponent model
7"""
8
9from sans.models.BaseComponent import BaseComponent
10import math
11
12class BEPolyelectrolyte(BaseComponent):
13   
14    """
15        Class that evaluates a BEPolyelectrolyte.
16       
17        F(x) = K*1/(4*pi*Lb*(alpha)^(2))*(q^(2)+k2)/(1+(r02)^(2))*(q^(2)+k2)\
18                       *(q^(2)-(12*h*C/b^(2)))
19       
20        The model has Eight parameters:
21            K        =  Constrast factor of the polymer
22            Lb       =  Bjerrum length
23            H        =  virial parameter
24            B        =  monomer length
25            Cs       =  Concentration of monovalent salt
26            alpha    =  ionazation degree
27            C        = polymer molar concentration
28            bkd      = background
29    """
30       
31    def __init__(self):
32        """ Initialization """
33       
34        # Initialize BaseComponent first, then sphere
35        BaseComponent.__init__(self)
36       
37        ## Name of the model
38        self.name = "BEPolyelectrolyte"
39        self.description="""
40        F(x) = K*1/(4*pi*Lb*(alpha)^(2))*(q^(2)+k2)/(1+(r02)^(2))*(q^(2)+k2)\
41                       *(q^(2)-(12*h*C/b^(2)))
42        The model has Eight parameters:
43        K        =  Constrast factor of the polymer
44        Lb       =  Bjerrum length
45        H        =  virial parameter
46        B        =  monomer length
47        Cs       =  Concentration of monovalent salt
48        alpha    =  ionazation degree
49        C        = polymer molar concentration
50        bkd      = background
51        """
52        ## Define parameters
53        self.params = {}
54        self.params['k']    = 10
55        self.params['lb']   = 7.1
56        self.params['h']    = 12
57        self.params['b']    = 10
58        self.params['cs']   = 0.0
59        self.params['alpha']= 0.05
60        self.params['c']    = 0.7
61        self.params['background']  = 0.0
62       
63
64        ## Parameter details [units, min, max]
65        self.details = {}
66        self.details['k']    = ['barns', None, None]
67        self.details['lb'] = ['A', None, None]
68        self.details['h']   = ['A-3', None, None]
69        self.details['b']    = ['A', None, None]
70        self.details['cs'] = ['mol/L', None, None]
71        self.details['alpha']   = ['', None, None]
72        self.details['c']    = ['mol/L', None, None]
73        self.details['background'] = ['cm-1', None, None]
74       
75               
76    def _BEPoly(self, x):
77        """
78            Evaluate 
79            F(x) = K*1/(4*pi*Lb*(alpha)^(2))*(q^(2)+k2)/(1+(r02)^(2))*(q^(2)+k2)\
80                       *(q^(2)-(12*h*C/b^(2)))
81       
82            has 3 internal parameters :
83                   The inverse Debye Length: K2 = 4*pi*Lb*(2*Cs+alpha*C)
84                   r02 =1/alpha/Ca^(0.5)*(B/(48*pi*Lb)^(0.5))
85                   Ca = C*6.022136e-4
86        """
87        Ca = self.params['c'] * 6.022136e-4
88       
89        K2 = 4.0 * math.pi * self.params['lb'] * (2*self.params['cs'] + \
90                 self.params['alpha'] * Ca)
91       
92        r02 = 1.0/self.params['alpha']/math.sqrt(Ca) * \
93                (self.params['b']/math.sqrt((48.0*math.pi *self.params['lb'])))
94       
95        return self.params['k']/( 4.0 * math.pi * self.params['lb'] * self.params['alpha']**2 ) \
96               * ( x**2 + K2 ) / ( 1.0 + r02**2 * ( x**2 + K2 ) \
97                    * (x**2 - ( 12.0 * self.params['h'] \
98                    * Ca/(self.params['b']**2) ))) \
99                    + self.params['background']
100       
101   
102    def run(self, x = 0.0):
103        """ Evaluate the model
104            @param x: input q-value (float or [float, float] as [r, theta])
105            @return: (debye value)
106        """
107        if x.__class__.__name__ == 'list':
108            return self._BEPoly(x[0])
109        elif x.__class__.__name__ == 'tuple':
110            raise ValueError, "Tuples are not allowed as input to BaseComponent models"
111        else:
112            return self._BEPoly(x)
113   
114    def runXY(self, x = 0.0):
115        """ Evaluate the model
116            @param x: input q-value (float or [float, float] as [qx, qy])
117            @return: debye value
118        """
119        if x.__class__.__name__ == 'list':
120            q = math.sqrt(x[0]**2 + x[1]**2)
121            return self._BEPoly(q)
122        elif x.__class__.__name__ == 'tuple':
123            raise ValueError, "Tuples are not allowed as input to BaseComponent models"
124        else:
125            return self._BEPoly(x)
Note: See TracBrowser for help on using the repository browser.