source: trunk/GSASIIElem.py @ 942

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

mods for MC/SA:
moved scat fac routines from GSASIIstrIO.py & GSASIIstrMath.py to GSASIIElem.py

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