source: trunk/GSASIIElem.py @ 850

Last change on this file since 850 was 850, checked in by vondreele, 9 years ago

fix problem with atoms with An+ style of valence
more places for size results
more rigid body work
allow for skinnier images

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Author Revision URL Id
File size: 14.0 KB
Line 
1# -*- coding: utf-8 -*-
2"""Element: functions for element types
3   Copyright: 2008, Robert B. Von Dreele & Brian H. Toby (Argonne National Laboratory)
4"""
5########### SVN repository information ###################
6# $Date: 2013-02-12 19:21:23 +0000 (Tue, 12 Feb 2013) $
7# $Author: vondreele $
8# $Revision: 850 $
9# $URL: trunk/GSASIIElem.py $
10# $Id: GSASIIElem.py 850 2013-02-12 19:21:23Z vondreele $
11########### SVN repository information ###################
12
13import math
14import os.path
15import GSASIIpath
16GSASIIpath.SetVersionNumber("$Revision: 850 $")
17import numpy as np
18
19def GetFormFactorCoeff(El):
20    """Read X-ray form factor coefficients from `atomdata.asc` file
21
22    :param El: element 1-2 character symbol case irrevelant
23    :return: `FormFactors`: list of form factor dictionaries
24   
25    Each X-ray form factor dictionary is:
26   
27    * `Symbol`: 4 character element symbol with valence (e.g. 'NI+2')
28    * `Z`: atomic number
29    * `fa`: 4 A coefficients
30    * `fb`: 4 B coefficients
31    * `fc`: C coefficient
32   
33    """
34    ElS = El.upper()
35    ElS = ElS.rjust(2)
36    filename = os.path.join(os.path.split(__file__)[0],'atmdata.dat')
37    try:
38        FFdata = open(filename,'Ur')
39    except:
40        print "**** ERROR - File atmdata.dat not found in directory %s" % sys.path[0]
41        sys.exit()
42    S = '1'
43    FormFactors = []
44    while S:
45        S = FFdata.readline()
46        if S[3:5] == ElS:
47            if S[5:6] != '_' and S[8] not in ['N','M']:
48                Z=int(S[:2])
49                Symbol = S[3:7].strip()
50                S = S[12:]
51                fa = (float(S[:7]),float(S[14:21]),float(S[28:35]),float(S[42:49]))
52                fb = (float(S[7:14]),float(S[21:28]),float(S[35:42]),float(S[49:56]))
53                FormFac = {'Symbol':Symbol,'Z':Z,'fa':fa,'fb':fb,'fc':float(S[56:63])}
54                FormFactors.append(FormFac)               
55    FFdata.close()
56    return FormFactors
57   
58def GetFFC5(ElSym):
59    '''Get 5 term form factor and Compton scattering data
60    @param ElSym: str(1-2 character element symbol with proper case);
61    @return El: dictionary with 5 term form factor & compton coefficients
62    '''
63    import FormFactors as FF
64    El = {}
65    FF5 = FF.FFac5term[ElSym]
66    El['fa'] = FF5[:5]
67    El['fc'] = FF5[5]
68    El['fb'] = FF5[6:]
69    Cmp5 = FF.Compton[ElSym]
70    El['cmpz'] = Cmp5[0]
71    El['cmpa'] = Cmp5[1:6]
72    El['cmpb'] = Cmp5[6:]
73    return El
74   
75def CheckElement(El):
76    import ElementTable as ET
77    Elements = []
78    for elem in ET.ElTable:
79        Elements.append(elem[0][0])
80    if El.capitalize() in Elements:
81        return True
82    else:
83        return False 
84
85def FixValence(El): 
86    if '+' in El[-1]: #converts An+/- to A+/-n
87        num = El[-2]
88        El = El.split(num)[0]+'+'+num
89    if '-' in El[-1]:
90        num = El[-2]
91        El = El.split(num)[0]+'-'+num
92    return El
93       
94def GetAtomInfo(El):
95   
96    import ElementTable as ET
97    Elements = []
98    for elem in ET.ElTable:
99        Elements.append(elem[0][0])
100    if len(El) in [2,4]:
101        ElS = El.upper()[:2].rjust(2)
102    else:
103        ElS = El.upper()[:1].rjust(2)
104    filename = os.path.join(os.path.split(__file__)[0],'atmdata.dat')
105    try:
106        FFdata = open(filename,'Ur')
107    except:
108        print '**** ERROR - File atmdata.dat not found in directory %s' % sys.path[0]
109        sys.exit()
110    S = '1'
111    AtomInfo = {}
112    Isotopes = {}
113    Mass = []
114    while S:
115        S = FFdata.readline()
116        if S[3:5] == ElS:
117            if S[5:6] == '_':
118                if not Mass:                                 #picks 1st one; natural abundance or 1st isotope
119                    Mass = float(S[10:19])
120                if S[6] in [' ','1','2','3','4','5','6','7','8','9']:                       
121                    isoName = S[6:9]
122                    if isoName == '   ':
123                        isoName = 'Nat. Abund.'              #natural abundance
124                    if S[76:78] in ['LS','BW']:     #special anomalous scattering length info
125                        St = [S[10:19],S[19:25],S[25:31],S[31:38],S[38:44],S[44:50],
126                            S[50:56],S[56:62],S[62:68],S[68:74],]
127                        Vals = []
128                        for item in St:
129                            if item.strip():
130                                Vals.append(float(item.strip()))
131                        Isotopes[isoName.rstrip()] = Vals                       
132                    else:
133                        Isotopes[isoName.rstrip()] = [float(S[10:19]),float(S[19:25])]
134                elif S[5:9] == '_SIZ':
135                    Z=int(S[:2])
136                    Symbol = S[3:5].strip().lower().capitalize()
137                    Drad = float(S[12:22])
138                    Arad = float(S[22:32])
139                    Vdrad = float(S[32:38])
140                    Color = ET.ElTable[Elements.index(Symbol)][6]
141    FFdata.close()
142    AtomInfo={'Symbol':Symbol,'Isotopes':Isotopes,'Mass':Mass,'Z':Z,'Drad':Drad,'Arad':Arad,'Vdrad':Vdrad,'Color':Color}   
143    return AtomInfo
144     
145def GetXsectionCoeff(El):
146    """Read atom orbital scattering cross sections for fprime calculations via Cromer-Lieberman algorithm
147    @param El: 2 character element symbol
148    @return: Orbs: list of orbitals each a dictionary with detailed orbital information used by FPcalc
149    each dictionary is:
150    'OrbName': Orbital name read from file
151    'IfBe' 0/2 depending on orbital
152    'BindEn': binding energy
153    'BB': BindEn/0.02721
154    'XSectIP': 5 cross section inflection points
155    'ElEterm': energy correction term
156    'SEdge': absorption edge for orbital
157    'Nval': 10/11 depending on IfBe
158    'LEner': 10/11 values of log(energy)
159    'LXSect': 10/11 values of log(cross section)
160    """
161    AU = 2.80022e+7
162    C1 = 0.02721
163    ElS = El.upper()
164    ElS = ElS.ljust(2)
165    filename = os.path.join(os.path.split(__file__)[0],'Xsect.dat')
166    try:
167        xsec = open(filename,'Ur')
168    except:
169        print '**** ERROR - File Xsect.dat not found in directory %s' % sys.path[0]
170        sys.exit()
171    S = '1'
172    Orbs = []
173    while S:
174        S = xsec.readline()
175        if S[:2] == ElS:
176            S = S[:-1]+xsec.readline()[:-1]+xsec.readline()
177            OrbName = S[9:14]
178            S = S[14:]
179            IfBe = int(S[0])
180            S = S[1:]
181            val = S.split()
182            BindEn = float(val[0])
183            BB = BindEn/C1
184            Orb = {'OrbName':OrbName,'IfBe':IfBe,'BindEn':BindEn,'BB':BB}
185            Energy = []
186            XSect = []
187            for i in range(11):
188                Energy.append(float(val[2*i+1]))
189                XSect.append(float(val[2*i+2]))
190            XSecIP = []
191            for i in range(5): XSecIP.append(XSect[i+5]/AU)
192            Orb['XSecIP'] = XSecIP
193            if IfBe == 0:
194                Orb['SEdge'] = XSect[10]/AU
195                Nval = 11
196            else:
197                Orb['ElEterm'] = XSect[10]
198                del Energy[10]
199                del XSect[10]
200                Nval = 10
201                Orb['SEdge'] = 0.0
202            Orb['Nval'] = Nval
203            D = dict(zip(Energy,XSect))
204            Energy.sort()
205            X = []
206            for key in Energy:
207                X.append(D[key])
208            XSect = X
209            LEner = []
210            LXSect = []
211            for i in range(Nval):
212                LEner.append(math.log(Energy[i]))
213                if XSect[i] > 0.0:
214                    LXSect.append(math.log(XSect[i]))
215                else:
216                    LXSect.append(0.0)
217            Orb['LEner'] = LEner
218            Orb['LXSect'] = LXSect
219            Orbs.append(Orb)
220    xsec.close()
221    return Orbs
222   
223def GetMagFormFacCoeff(El):
224    """Read magnetic form factor data from atomdata.asc file
225    @param El: 2 character element symbol
226    @return: MagFormFactors: list of all magnetic form factors dictionaries for element El.
227    each dictionary contains:
228    'Symbol':Symbol
229    'Z':Z
230    'mfa': 4 MA coefficients
231    'nfa': 4 NA coefficients
232    'mfb': 4 MB coefficients
233    'nfb': 4 NB coefficients
234    'mfc': MC coefficient
235    'nfc': NC coefficient
236    """
237    ElS = El.upper()
238    ElS = ElS.rjust(2)
239    filename = os.path.join(os.path.split(__file__)[0],'atmdata.dat')
240    try:
241        FFdata = open(filename,'Ur')
242    except:
243        print '**** ERROR - File atmdata.dat not found in directory %s' % sys.path[0]
244        sys.exit()
245    S = '1'
246    MagFormFactors = []
247    while S:
248        S = FFdata.readline()
249        if S[3:5] == ElS:
250            if S[8:9] == 'M':
251                SN = FFdata.readline()               #'N' is assumed to follow 'M' in Atomdata.asc
252                Z=int(S[:2])
253                Symbol = S[3:7]
254                S = S[12:]
255                SN = SN[12:]
256                mfa = (float(S[:7]),float(S[14:21]),float(S[28:35]),float(S[42:49]))
257                mfb = (float(S[7:14]),float(S[21:28]),float(S[35:42]),float(S[49:56]))
258                nfa = (float(SN[:7]),float(SN[14:21]),float(SN[28:35]),float(SN[42:49]))
259                nfb = (float(SN[7:14]),float(SN[21:28]),float(SN[35:42]),float(SN[49:56]))
260                FormFac = {'Symbol':Symbol,'Z':Z,'mfa':mfa,'nfa':nfa,'mfb':mfb,'nfb':nfb,
261                    'mfc':float(S[56:63]),'nfc':float(SN[56:63])}
262                MagFormFactors.append(FormFac)
263    FFdata.close()
264    return MagFormFactors
265
266def ScatFac(El, SQ):
267    """compute value of form factor
268    @param El: element dictionary defined in GetFormFactorCoeff
269    @param SQ: (sin-theta/lambda)**2
270    @return: real part of form factor
271    """
272    fa = np.array(El['fa'])
273    fb = np.array(El['fb'])
274    t = -fb[:,np.newaxis]*SQ
275    return np.sum(fa[:,np.newaxis]*np.exp(t)[:],axis=0)+El['fc']
276       
277def BlenRes(Elist,BLtables,wave):
278    FP = np.zeros(len(Elist))
279    FPP = np.zeros(len(Elist))
280    Emev = 81.80703/wave**2
281    for i,El in enumerate(Elist):
282        BL = BLtables[El]
283        if len(BL) >= 6:
284            Emev = 81.80703/wave**2
285            G2 = BL[5]**2
286            T = [Emev-BL[4],0,0]
287            D = [T**2+G2,0,0]
288            fp = T/D
289            fpp = 1.0/D
290            if len(BL) == 8:
291                T = Emev-BL[7]
292                D = T**2+G2
293                fp += BL[6]*T/D
294                fpp += BL[6]/D
295            if len(BL) == 10:
296                T = Emev-BL[9]
297                D = T**2+G2
298                fp += BL[8]*T/D
299                fpp += BL[8]/D
300            FP[i] = (BL[2]*fp)
301            FPP[i] = (-BL[3]*fpp)
302        else:
303            FP[i] = 0.0
304            FPP[i] = 0.0
305    return FP,FPP
306   
307#def BlenRes(BLdata,wave):
308#    FP = []
309#    FPP = []
310#    Emev = 81.80703/wave**2
311#    for BL in BLdata:
312#        if len(BL) >= 6:
313#            Emev = 81.80703/wave**2
314#            G2 = BL[5]**2
315#            T = [Emev-BL[4],0,0]
316#            D = [T**2+G2,0,0]
317#            fp = T/D
318#            fpp = 1.0/D
319#            if len(BL) == 8:
320#                T = Emev-BL[7]
321#                D = T**2+G2
322#                fp += BL[6]*T/D
323#                fpp += BL[6]/D
324#            if len(BL) == 10:
325#                T = Emev-BL[9]
326#                D = T**2+G2
327#                fp += BL[8]*T/D
328#                fpp += BL[8]/D
329#            FP.append(BL[2]*fp)
330#            FPP.append(-BL[3]*fpp)
331#        else:
332#            FP.append(0.0)
333#            FPP.append(0.0)
334#    return np.array(FP),np.array(FPP)
335   
336def ComptonFac(El,SQ):
337    """compute Compton scattering factor
338    @param El: element dictionary
339    @param SQ: (sin-theta/lambda)**2
340    @return: compton scattering factor
341    """   
342    ca = np.array(El['cmpa'])
343    cb = np.array(El['cmpb'])
344    t = -cb[:,np.newaxis]*SQ       
345    return El['cmpz']-np.sum(ca[:,np.newaxis]*np.exp(t),axis=0) 
346           
347def FPcalc(Orbs, KEv):
348    """Compute real & imaginary resonant X-ray scattering factors
349    @param Orbs: list of orbital dictionaries as defined in GetXsectionCoeff
350    @param KEv: x-ray energy in keV
351    @return: C: (f',f",mu): real, imaginary parts of resonant scattering & atomic absorption coeff.
352    """
353    def Aitken(Orb, LKev):
354        Nval = Orb['Nval']
355        j = Nval-1
356        LEner = Orb['LEner']
357        for i in range(Nval):
358            if LEner[i] <= LKev: j = i
359        if j > Nval-3: j= Nval-3
360        T = [0,0,0,0,0,0]
361        LXSect = Orb['LXSect']
362        for i in range(3):
363           T[i] = LXSect[i+j]
364           T[i+3] = LEner[i+j]-LKev
365        T[1] = (T[0]*T[4]-T[1]*T[3])/(LEner[j+1]-LEner[j])
366        T[2] = (T[0]*T[5]-T[2]*T[3])/(LEner[j+2]-LEner[j])
367        T[2] = (T[1]*T[5]-T[2]*T[4])/(LEner[j+2]-LEner[j+1])
368        C = T[2]
369        return C
370   
371    def DGauss(Orb,CX,RX,ISig):
372        ALG = (0.11846344252810,0.23931433524968,0.284444444444,
373        0.23931433524968,0.11846344252810)
374        XLG = (0.04691007703067,0.23076534494716,0.5,
375        0.76923465505284,0.95308992296933)
376       
377        D = 0.0
378        B2 = Orb['BB']**2
379        R2 = RX**2
380        XSecIP = Orb['XSecIP']
381        for i in range(5):
382            X = XLG[i]
383            X2 = X**2
384            XS = XSecIP[i]
385            if ISig == 0:
386                S = BB*(XS*(B2/X2)-CX*R2)/(R2*X2-B2)
387            elif ISig == 1:
388                S = 0.5*BB*B2*XS/(math.sqrt(X)*(R2*X2-X*B2))
389            elif ISig == 2:
390                T = X*X2*R2-B2/X
391                S = 2.0*BB*(XS*B2/(T*X2**2)-(CX*R2/T))
392            else:
393                S = BB*B2*(XS-Orb['SEdge']*X2)/(R2*X2**2-X2*B2)
394            A = ALG[i]
395            D += A*S
396        return D
397   
398    AU = 2.80022e+7
399    C1 = 0.02721
400    C = 137.0367
401    FP = 0.0
402    FPP = 0.0
403    Mu = 0.0
404    LKev = math.log(KEv)
405    RX = KEv/C1
406    if Orbs:
407        for Orb in Orbs:
408            CX = 0.0
409            BB = Orb['BB']
410            BindEn = Orb['BindEn']
411            if Orb['IfBe'] != 0: ElEterm = Orb['ElEterm']
412            if BindEn <= KEv:
413                CX = math.exp(Aitken(Orb,LKev))
414                Mu += CX
415                CX /= AU
416            Corr = 0.0
417            if Orb['IfBe'] == 0 and BindEn >= KEv:
418                CX = 0.0
419                FPI = DGauss(Orb,CX,RX,3)
420                Corr = 0.5*Orb['SEdge']*BB**2*math.log((RX-BB)/(-RX-BB))/RX
421            else:
422                FPI = DGauss(Orb,CX,RX,Orb['IfBe'])
423                if CX != 0.0: Corr = -0.5*CX*RX*math.log((RX+BB)/(RX-BB))
424            FPI = (FPI+Corr)*C/(2.0*math.pi**2)
425            FPPI = C*CX*RX/(4.0*math.pi)
426            FP += FPI
427            FPP += FPPI
428        FP -= ElEterm
429   
430    return (FP, FPP, Mu)
431   
432
Note: See TracBrowser for help on using the repository browser.