source: trunk/GSASIIElem.py @ 584

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

add coding line everywhere
more options in sample parm copy

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