source: trunk/GSASIIElem.py @ 2492

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

fix handling of Lande g factor
fix Mag structure factor calcs - now OK for all tests

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Author Revision URL Id
File size: 15.6 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-10-15 16:20:33 +0000 (Sat, 15 Oct 2016) $
10# $Author: vondreele $
11# $Revision: 2492 $
12# $URL: trunk/GSASIIElem.py $
13# $Id: GSASIIElem.py 2492 2016-10-15 16:20:33Z vondreele $
14########### SVN repository information ###################
15
16import math
17import os.path
18import GSASIIpath
19GSASIIpath.SetVersionNumber("$Revision: 2492 $")
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,ifMag=False):
187    'reads element information from atmdata.py'
188    import ElementTable as ET
189    Elem = ET.ElTable
190    if ifMag:
191        Elem = ET.MagElTable
192    Elements = [elem[0][0] for elem in Elem]
193    AtomInfo = {}
194    ElS = getElSym(El)
195    if El not in atmdata.XrayFF and El not in atmdata.MagFF:
196        if ElS not in atmdata.XrayFF:
197            print('Atom type '+El+' not found, using UNK')
198            return # not sure what this element should be!
199        print('Atom type '+El+' not found, using '+ElS)
200        El = ElS
201    AtomInfo.update(dict(zip(['Drad','Arad','Vdrad','Hbrad'],atmdata.AtmSize[ElS])))
202    AtomInfo['Symbol'] = El
203    AtomInfo['Color'] = ET.ElTable[Elements.index(ElS)][6]
204    AtomInfo['Z'] = atmdata.XrayFF[ElS]['Z']
205    isotopes = [ky for ky in atmdata.AtmBlens.keys() if ElS == ky.split('_')[0]]
206    isotopes.sort()
207    AtomInfo['Mass'] = atmdata.AtmBlens[isotopes[0]]['Mass']    #default to nat. abund.
208    AtomInfo['Isotopes'] = {}
209    for isotope in isotopes:
210        data = atmdata.AtmBlens[isotope]
211        if isotope == ElS+'_':
212            AtomInfo['Isotopes']['Nat. Abund.'] = data
213        else:
214            AtomInfo['Isotopes'][isotope.split('_')[1]] = data
215    AtomInfo['Lande g'] = 2.0
216    return AtomInfo
217       
218def GetXsectionCoeff(El):
219    """Read atom orbital scattering cross sections for fprime calculations via Cromer-Lieberman algorithm
220
221    :param El: 2 character element symbol
222    :return: Orbs: list of orbitals each a dictionary with detailed orbital information used by FPcalc
223
224    each dictionary is:
225
226    * 'OrbName': Orbital name read from file
227    * 'IfBe' 0/2 depending on orbital
228    * 'BindEn': binding energy
229    * 'BB': BindEn/0.02721
230    * 'XSectIP': 5 cross section inflection points
231    * 'ElEterm': energy correction term
232    * 'SEdge': absorption edge for orbital
233    * 'Nval': 10/11 depending on IfBe
234    * 'LEner': 10/11 values of log(energy)
235    * 'LXSect': 10/11 values of log(cross section)
236
237    """
238    AU = 2.80022e+7
239    C1 = 0.02721
240    ElS = El.upper()
241    ElS = ElS.ljust(2)
242    filename = os.path.join(os.path.split(__file__)[0],'Xsect.dat')
243    try:
244        xsec = open(filename,'Ur')
245    except:
246        print '**** ERROR - File Xsect.dat not found in directory %s' % os.path.split(filename)[0]
247        sys.exit()
248    S = '1'
249    Orbs = []
250    while S:
251        S = xsec.readline()
252        if S[:2] == ElS:
253            S = S[:-1]+xsec.readline()[:-1]+xsec.readline()
254            OrbName = S[9:14]
255            S = S[14:]
256            IfBe = int(S[0])
257            S = S[1:]
258            val = S.split()
259            BindEn = float(val[0])
260            BB = BindEn/C1
261            Orb = {'OrbName':OrbName,'IfBe':IfBe,'BindEn':BindEn,'BB':BB}
262            Energy = []
263            XSect = []
264            for i in range(11):
265                Energy.append(float(val[2*i+1]))
266                XSect.append(float(val[2*i+2]))
267            XSecIP = []
268            for i in range(5): XSecIP.append(XSect[i+5]/AU)
269            Orb['XSecIP'] = XSecIP
270            if IfBe == 0:
271                Orb['SEdge'] = XSect[10]/AU
272                Nval = 11
273            else:
274                Orb['ElEterm'] = XSect[10]
275                del Energy[10]
276                del XSect[10]
277                Nval = 10
278                Orb['SEdge'] = 0.0
279            Orb['Nval'] = Nval
280            D = dict(zip(Energy,XSect))
281            Energy.sort()
282            X = []
283            for key in Energy:
284                X.append(D[key])
285            XSect = X
286            LEner = []
287            LXSect = []
288            for i in range(Nval):
289                LEner.append(math.log(Energy[i]))
290                if XSect[i] > 0.0:
291                    LXSect.append(math.log(XSect[i]))
292                else:
293                    LXSect.append(0.0)
294            Orb['LEner'] = LEner
295            Orb['LXSect'] = LXSect
296            Orbs.append(Orb)
297    xsec.close()
298    return Orbs
299   
300def GetMagFormFacCoeff(El):
301    """Read magnetic form factor data from atmdata.py
302
303    :param El: 2 character element symbol
304    :return: MagFormFactors: list of all magnetic form factors dictionaries for element El.
305
306    each dictionary contains:
307
308    * 'Symbol':Symbol
309    * 'Z':Z
310    * 'mfa': 4 MA coefficients
311    * 'nfa': 4 NA coefficients
312    * 'mfb': 4 MB coefficients
313    * 'nfb': 4 NB coefficients
314    * 'mfc': MC coefficient
315    * 'nfc': NC coefficient
316   
317    """
318    Els = El.capitalize().strip()
319    MagFormFactors = []
320    mags = [ky for ky in atmdata.MagFF.keys() if Els == getElSym(ky)]
321    for mag in mags:
322        magData = {}
323        data = atmdata.MagFF[mag]
324        magData['Symbol'] = mag.upper()
325        magData['Z'] = atmdata.XrayFF[getElSym(mag)]['Z']
326        magData['mfa'] = [data['M'][i] for i in [0,2,4,6]]
327        magData['mfb'] = [data['M'][i] for i in [1,3,5,7]]
328        magData['mfc'] = data['M'][8]
329        magData['nfa'] = [data['N'][i] for i in [0,2,4,6]]
330        magData['nfb'] = [data['N'][i] for i in [1,3,5,7]]
331        magData['nfc'] = data['N'][8]
332        MagFormFactors.append(magData)
333    return MagFormFactors
334
335def ScatFac(El, SQ):
336    """compute value of form factor
337
338    :param El: element dictionary defined in GetFormFactorCoeff
339    :param SQ: (sin-theta/lambda)**2
340    :return: real part of form factor
341    """
342    fa = np.array(El['fa'])
343    fb = np.array(El['fb'])
344    t = -fb[:,np.newaxis]*SQ
345    return np.sum(fa[:,np.newaxis]*np.exp(t)[:],axis=0)+El['fc']
346       
347def MagScatFac(El, SQ):
348    """compute value of form factor
349
350    :param El: element dictionary defined in GetFormFactorCoeff
351    :param SQ: (sin-theta/lambda)**2
352    :param gfac: Lande g factor (normally = 2.0)
353    :return: real part of form factor
354    """
355    mfa = np.array(El['mfa'])
356    mfb = np.array(El['mfb'])
357    nfa = np.array(El['nfa'])
358    nfb = np.array(El['nfb'])
359    mt = -mfb[:,np.newaxis]*SQ
360    nt = -nfb[:,np.newaxis]*SQ
361    MMF = np.sum(mfa[:,np.newaxis]*np.exp(mt)[:],axis=0)+El['mfc']
362    NMF = np.sum(nfa[:,np.newaxis]*np.exp(nt)[:],axis=0)+El['nfc']
363    return MMF+(2.0/El['gfac']-1.0)*NMF
364       
365def BlenResCW(Els,BLtables,wave):
366    FP = np.zeros(len(Els))
367    FPP = np.zeros(len(Els))
368    for i,El in enumerate(Els):
369        BL = BLtables[El][1]
370        if 'BW-LS' in BL:
371            Re,Im,E0,gam,A,E1,B,E2 = BL['BW-LS'][1:]
372            Emev = 81.80703/wave**2
373            T0 = Emev-E0
374            T1 = Emev-E1
375            T2 = Emev-E2
376            D0 = T0**2+gam**2
377            D1 = T1**2+gam**2
378            D2 = T2**2+gam**2
379            FP[i] = Re*(T0/D0+A*T1/D1+B*T2/D2)
380            FPP[i] = Im*(1/D0+A/D1+B/D2)
381        else:
382            FPP[i] = BL['SL'][1]    #for Li, B, etc.
383    return FP,FPP
384   
385def BlenResTOF(Els,BLtables,wave):
386    FP = np.zeros((len(Els),len(wave)))
387    FPP = np.zeros((len(Els),len(wave)))
388    BL = [BLtables[el][1] for el in Els]
389    for i,El in enumerate(Els):
390        if 'BW-LS' in BL[i]:
391            Re,Im,E0,gam,A,E1,B,E2 = BL[i]['BW-LS'][1:]
392            Emev = 81.80703/wave**2
393            T0 = Emev-E0
394            T1 = Emev-E1
395            T2 = Emev-E2
396            D0 = T0**2+gam**2
397            D1 = T1**2+gam**2
398            D2 = T2**2+gam**2
399            FP[i] = Re*(T0/D0+A*T1/D1+B*T2/D2)
400            FPP[i] = Im*(1/D0+A/D1+B/D2)
401        else:
402            FPP[i] = np.ones(len(wave))*BL[i]['SL'][1]    #for Li, B, etc.
403    return FP,FPP
404   
405def ComptonFac(El,SQ):
406    """compute Compton scattering factor
407
408    :param El: element dictionary
409    :param SQ: (sin-theta/lambda)**2
410    :return: compton scattering factor
411    """   
412    ca = np.array(El['cmpa'])
413    cb = np.array(El['cmpb'])
414    t = -cb[:,np.newaxis]*SQ       
415    return El['cmpz']-np.sum(ca[:,np.newaxis]*np.exp(t),axis=0) 
416           
417def FPcalc(Orbs, KEv):
418    """Compute real & imaginary resonant X-ray scattering factors
419
420    :param Orbs: list of orbital dictionaries as defined in GetXsectionCoeff
421    :param KEv: x-ray energy in keV
422    :return: C: (f',f",mu): real, imaginary parts of resonant scattering & atomic absorption coeff.
423    """
424    def Aitken(Orb, LKev):
425        Nval = Orb['Nval']
426        j = Nval-1
427        LEner = Orb['LEner']
428        for i in range(Nval):
429            if LEner[i] <= LKev: j = i
430        if j > Nval-3: j= Nval-3
431        T = [0,0,0,0,0,0]
432        LXSect = Orb['LXSect']
433        for i in range(3):
434           T[i] = LXSect[i+j]
435           T[i+3] = LEner[i+j]-LKev
436        T[1] = (T[0]*T[4]-T[1]*T[3])/(LEner[j+1]-LEner[j])
437        T[2] = (T[0]*T[5]-T[2]*T[3])/(LEner[j+2]-LEner[j])
438        T[2] = (T[1]*T[5]-T[2]*T[4])/(LEner[j+2]-LEner[j+1])
439        C = T[2]
440        return C
441   
442    def DGauss(Orb,CX,RX,ISig):
443        ALG = (0.11846344252810,0.23931433524968,0.284444444444,
444        0.23931433524968,0.11846344252810)
445        XLG = (0.04691007703067,0.23076534494716,0.5,
446        0.76923465505284,0.95308992296933)
447       
448        D = 0.0
449        B2 = Orb['BB']**2
450        R2 = RX**2
451        XSecIP = Orb['XSecIP']
452        for i in range(5):
453            X = XLG[i]
454            X2 = X**2
455            XS = XSecIP[i]
456            if ISig == 0:
457                S = BB*(XS*(B2/X2)-CX*R2)/(R2*X2-B2)
458            elif ISig == 1:
459                S = 0.5*BB*B2*XS/(math.sqrt(X)*(R2*X2-X*B2))
460            elif ISig == 2:
461                T = X*X2*R2-B2/X
462                S = 2.0*BB*(XS*B2/(T*X2**2)-(CX*R2/T))
463            else:
464                S = BB*B2*(XS-Orb['SEdge']*X2)/(R2*X2**2-X2*B2)
465            A = ALG[i]
466            D += A*S
467        return D
468   
469    AU = 2.80022e+7
470    C1 = 0.02721
471    C = 137.0367
472    FP = 0.0
473    FPP = 0.0
474    Mu = 0.0
475    LKev = math.log(KEv)
476    RX = KEv/C1
477    if Orbs:
478        for Orb in Orbs:
479            CX = 0.0
480            BB = Orb['BB']
481            BindEn = Orb['BindEn']
482            if Orb['IfBe'] != 0: ElEterm = Orb['ElEterm']
483            if BindEn <= KEv:
484                CX = math.exp(Aitken(Orb,LKev))
485                Mu += CX
486                CX /= AU
487            Corr = 0.0
488            if Orb['IfBe'] == 0 and BindEn >= KEv:
489                CX = 0.0
490                FPI = DGauss(Orb,CX,RX,3)
491                Corr = 0.5*Orb['SEdge']*BB**2*math.log((RX-BB)/(-RX-BB))/RX
492            else:
493                FPI = DGauss(Orb,CX,RX,Orb['IfBe'])
494                if CX != 0.0: Corr = -0.5*CX*RX*math.log((RX+BB)/(RX-BB))
495            FPI = (FPI+Corr)*C/(2.0*math.pi**2)
496            FPPI = C*CX*RX/(4.0*math.pi)
497            FP += FPI
498            FPP += FPPI
499        FP -= ElEterm
500   
501    return (FP, FPP, Mu)
502   
503
Note: See TracBrowser for help on using the repository browser.