Changeset ac7be54 in sasview for src/sas/models/BEPolyelectrolyte.py

Timestamp:

May 8, 2015 2:27:08 PM (9 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

5e880fe1

Parents:

c22c5e3

Message:

fix sphinx errors in api manual

File:

• src/sas/models/BEPolyelectrolyte.py (modified) (3 diffs)

src/sas/models/BEPolyelectrolyte.py

@@ -1 @@
-"""    
- Provide F(x) = K*1/(4*pi*Lb*(alpha)^(2))*(q^(2)+k2)/(1+(r02)^(2))*(q^(2)+k2)\
-                       *(q^(2)-(12*h*C/b^(2)))
+"""
  BEPolyelectrolyte as a BaseComponent model
 """
@@ -12 +10 @@
         Class that evaluates a BEPolyelectrolyte.
         
-        F(x) = K*1/(4*pi*Lb*(alpha)^(2))*(q^(2)+k2)/(1+(r02)^(2))*(q^(2)+k2)\
-                       *(q^(2)-(12*h*C/b^(2))) 
+        F(x) = K/(4 pi Lb (alpha)^(2)) (q^(2)+k2)/(1+(r02)^(2)) (q^(2)+k2)\
+                        (q^(2)-(12 h C/b^(2)))
         
-        The model has Eight parameters: 
-            K        =  Constrast factor of the polymer
-            Lb       =  Bjerrum length
-            H        =  virial parameter
-            B        =  monomer length
-            Cs       =  Concentration of monovalent salt 
-            alpha    =  ionazation degree 
+        The model has Eight parameters::
+
+            K        = Constrast factor of the polymer
+            Lb       = Bjerrum length
+            H        = virial parameter
+            B        = monomer length
+            Cs       = Concentration of monovalent salt
+            alpha    = ionazation degree
             C        = polymer molar concentration
             bkd      = background
@@ -75 +74 @@
         """
             Evaluate  
-            F(x) = K*1/(4*pi*Lb*(alpha)^(2))*(q^(2)+k2)/(1+(r02)^(2))
-                *(q^(2)+k2)*(q^(2)-(12*h*C/b^(2)))
+            F(x) = K 1/(4 pi Lb (alpha)^(2)) (q^(2)+k2)/(1+(r02)^(2))
+                 (q^(2)+k2) (q^(2)-(12 h C/b^(2)))
         
             has 3 internal parameters :
-                   The inverse Debye Length: K2 = 4*pi*Lb*(2*Cs+alpha*C)
-                   r02 =1/alpha/Ca^(0.5)*(B/(48*pi*Lb)^(0.5))
-                   Ca = C*6.022136e-4
+                   The inverse Debye Length: K2 = 4 pi Lb (2 Cs+alpha C)
+                   r02 =1/alpha/Ca^(0.5) (B/(48 pi Lb)^(0.5))
+                   Ca = 6.022136e-4 C
         """
         Ca = self.params['c'] * 6.022136e-4