/
SHReadJPL.f95
426 lines (351 loc) · 12.9 KB
/
SHReadJPL.f95
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
subroutine SHReadJPL(filename, cilm, lmax, error, gm, formatstring, exitstatus)
!------------------------------------------------------------------------------
!
! This program will read the file format of spherical harmonic
! coefficients sometimes used by the JPL group into standard arrays for
! of Cilm and the error. In order to for this to work, you need to know
! a priori the maximum spherical harmonic degree of the file.
!
! The input file contains
! 1. comment lines starting with "#"
! 2. GM (optional)
! 3. A list of J_l, which is -C(1,l+1,1)
! 4. A list of the cosine and sine terms
! 5. Starting from 2, the same thing over for the errors.
!
! Calling Parameters
!
! IN
! filename The name of the file.
! lmax Maximum spherical harmonic degree.
!
! OUT
! cilm An array of the spherical harmonic coefficients.
!
! OPTIONAL
! error An array containing the error coefficients.
! formatstring This is a string containing an I/O specification
! for the numbers of the spherical harmonic
! coefficients.
! exitstatus If present, instead of executing a STOP when an error
! is encountered, the variable exitstatus will be
! returned describing the error.
! 0 = No errors;
! 1 = Improper dimensions of input array;
! 2 = Improper bounds for input variable;
! 3 = Error allocating memory;
! 4 = File IO error.
!
! Copyright (c) 2005-2019, SHTOOLS
! All rights reserved.
!
!------------------------------------------------------------------------------
use ftypes
implicit none
character(*), intent(in) :: filename
integer(int32), intent(in) :: lmax
real(dp), intent(out) :: cilm(:,:,:)
real(dp), intent(out), optional :: error(:,:,:), gm(2)
integer(int32), intent(out), optional :: exitstatus
character(6), intent(in), optional :: formatstring
real(dp) :: gm1, gm2
logical :: gmpresent
integer(int32) :: l, m, stat, i, ll1, mm1, ll2, mm2, skip
character(4) :: c, s, j, js, cs, ss
character(14) :: dumb, dumb2
character(2) :: inum
if (present(exitstatus)) exitstatus = 0
if (size(cilm(:,1,1)) < 2 .or. size(cilm(1,:,1)) < lmax+1 .or. &
size(cilm(1,1,:)) < lmax+1) then
print*, "Error --- SHReadJPL"
print*, "CILM must be dimensioned (2, LMAX+1, LMAX+1) " // &
"where LMAX is ", lmax
print*, "Input array is dimensioned ", size(cilm(:,1,1)), &
size(cilm(1,:,1)), size(cilm(1,1,:))
if (present(exitstatus)) then
exitstatus = 1
return
else
stop
end if
end if
if (present(error)) then
if (size(error(:,1,1)) < 2 .or. size(error(1,:,1)) < lmax+1 .or. &
size(error(1,1,:)) < lmax+1) then
print*, "Error --- SHReadJPL"
print*, "error must be dimensioned (2, LMAX+1, LMAX+1) " // &
"where LMAX is ", lmax
print*, "Input array is dimensioned ", size(error(:,1,1)), &
size(error(1,:,1)), size(error(1,1,:))
if (present(exitstatus)) then
exitstatus = 1
return
else
stop
end if
end if
end if
gmpresent = .false.
c = "OBAC"
cs = "SIGC"
s = "OBAS"
ss = "SIGS"
j = "OBAJ"
js = "SIGJ"
if (lmax <= 99) then
inum = "i2"
else if (lmax >= 100 .and. lmax <=999) then
inum = "i3"
else
inum = "i4"
end if
open(13,file=filename)
! Skip past header lines
skip = 0
do
read(13,"(a)", iostat=stat) dumb
if (stat /= 0) then
print*, "Error --- SHReadJPL"
print*, "Problem reading header lines of ", filename
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
end if
if (dumb(1:1) == "#") then
skip = skip + 1
else
exit
end if
end do
! Try to read GM, if present
rewind(13)
do i = 1, skip, 1
read(13, *, iostat=stat)
end do
read(13, "(a12, f14.6)", iostat=stat) dumb, gm1
if (stat /= 0) then
print*, "Error --- SHReadJPL"
print*, "Problem reading GM(1)"
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
end if
if (dumb(2:3) == "GM") then
if ( present(gm) ) then
gm(1) = gm1
gmpresent = .true.
end if
else
rewind(13)
do i = 1, skip, 1
read(13,*)
end do
end if
! Start reading J_l coefficients
do i = 1, lmax
if (present(formatstring)) then
read(13,"(1x, a5, "//inum//", 5x,"//formatstring//")", &
iostat=stat) dumb, l, cilm(1,i+1,1)
else
read(13,"(1x, a5, "//inum//", 5x, e19.12)", iostat=stat) dumb, &
l, cilm(1,i+1,1)
end if
if (stat /= 0) then
print*, "Error --- SHReadJPL"
print*, "Problem reading file", i
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
else if (dumb(1:4) /= j) then
print*, "Error --- SHReadJPL"
print*, "Problem with line specifiers in file ", filename
print*, "Read sring = ", dumb(1:4)
print*, "Expected string = ", j
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
else if (i /= l) then
print*, "Error --- SHReadJPL"
print*, "Problem with indices in file ", filename
print*, "Read indice = ", l
print*, "Expected indice = ", i
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
end if
cilm(1,i+1,1) = -cilm(1,i+1,1)
end do
! Read the Clm and Slm coefficients
do l = 1, lmax
do m = 1, l
if (present(formatstring)) then
read(13, "(1x, a5, "//inum//", 1x, "//inum//", 5x," &
//formatstring//", 5x, a5, "//inum//", 1x, " &
//inum//", 5x,"//formatstring//")", &
iostat=stat) dumb, ll1, mm1, cilm(1,l+1,m+1), &
dumb2, ll2, mm2, cilm(2,l+1,m+1)
else
read(13,"(1x, a5, "//inum//", 1x, " &
//inum//", 5x, e19.12, 5x, a5, "//inum//", 1x, " &
//inum//", 5x, e19.12)", iostat=stat) dumb, ll1, mm1, &
cilm(1,l+1,m+1), &
dumb2, ll2, mm2,&
cilm(2,l+1,m+1)
end if
if (stat /= 0) then
print*, "Error --- SHReadJPL"
print*, "Problem reading file", l, m
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
else if (dumb(1:4) /= c .or. dumb2(1:4) /= s) then
print*, "Error --- SHReadJPL"
print*, "Problem with line specifiers in file ", filename
print*, "Read srings = ", dumb(1:4), dumb2(1:4)
print*, "Expected strings = ", c, s
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
else if (ll1 /= l .or. ll2 /= l .or. mm1 /= m .or. mm2 /= m ) then
print*, "Error --- SHReadJPL"
print*, "Problem with indices in file ", filename
print*, "Read indices (l1, m1), (l2, m2) = ", ll1, mm1, ll2, mm2
print*, "Expected indices (l, m) = ", l, m
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
end if
end do
end do
! Next read uncertainties
if (present(error)) then
if (gmpresent) then
read(13, "(a12, f17.6)", iostat=stat) dumb, gm2
gm(2) = gm2
if (stat /= 0) then
print*, "Error --- SHReadJPL"
print*, "Problem reading GM(2)"
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
end if
end if
do i = 1, lmax
if (present(formatstring)) then
read(13,"(1x, a5, "//inum//", 5x,"//formatstring//")", &
iostat=stat) dumb, l, error(1,i+1,1)
else
read(13,"(1x, a5, "//inum//", 5x, e19.12)", iostat=stat) &
dumb, l, error(1,i+1,1)
end if
if (stat /= 0) then
print*, "Error --- SHReadJPL"
print*, "Problem reading file during J2 error coefficients", i
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
else if (dumb(1:4) /= js) then
print*, "Error --- SHReadJPL"
print*, "Problem with line specifiers in file ", filename
print*, "Read sring = ", dumb(1:4)
print*, "Expected string = ", js
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
else if (i /= l) then
print*, "Error --- SHReadJPL"
print*, "Problem with indices in file ", filename
print*, "Read indice = ", l
print*, "Expected indice = ", i
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
end if
end do
do l = 1, lmax
do m = 1, l
if (present(formatstring)) then
read(13, "(1x, a5, "//inum//", 1x, "//inum//", 5x," &
//formatstring//", 5x, a5, "//inum//", 1x, " &
//inum//", 5x,"//formatstring//")", iostat=stat) &
dumb, ll1, mm1, error(1,l+1,m+1), dumb2, ll2, &
mm2, error(2,l+1,m+1)
else
read(13,"(1x, a5, "//inum//", 1x, " &
//inum//", 5x, e19.12, 5x, a5, "//inum//", 1x, " &
//inum//", 5x, e19.12)", iostat=stat) dumb, ll1, mm1,&
error(1,l+1,m+1), dumb2, ll2, mm2, error(2,l+1,m+1)
end if
if (stat /= 0) then
print*, "Error --- SHReadJPL"
print*, "Problem reading file during error coefficients", l, m
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
else if (dumb(1:4) /= cs .or. dumb2(1:4) /= ss) then
print*, "Error --- SHReadJPL"
print*, "Problem with line specifiers in file ", filename
print*, "Read srings = ", dumb(1:4), dumb2(1:4)
print*, "Expected strings = ", cs, ss
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
else if (ll1 /= l .or. ll2 /= l .or. mm1 /= m .or. mm2 /= m ) then
print*, "Error --- SHReadJPL"
print*, "Problem with indices in file ", filename
print*, "Read indices (l1, m1), (l2, m2) = ", ll1, mm1, ll2, mm2
print*, "Expected indices (l, m) = ", l, m
if (present(exitstatus)) then
exitstatus = 4
return
else
stop
end if
end if
end do
end do
end if
close(13)
end subroutine SHReadJPL