source: trunk/GSASIIElem.py @ 967

Last change on this file since 967 was 967, checked in by vondreele, 8 years ago

periodic table

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