source: trunk/GSASIIElem.py @ 2478

Last change on this file since 2478 was 2478, checked in by vondreele, 5 years ago

work up to magnetic structure factor calcs.

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