-
Notifications
You must be signed in to change notification settings - Fork 104
/
shread2.3
105 lines (105 loc) · 3.78 KB
/
shread2.3
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
.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "shread2" "1" "2021-02-15" "Fortran 95" "SHTOOLS 4.11"
.hy
.SH SHRead2
.PP
Read spherical harmonic coefficients from a CHAMP or GRACE-like
ascii-formatted file.
.SH Usage
.PP
call SHRead2 (\f[V]filename\f[R], \f[V]cilm\f[R], \f[V]lmax\f[R],
\f[V]gm\f[R], \f[V]r0_pot\f[R], \f[V]error\f[R], \f[V]dot\f[R],
\f[V]doystart\f[R], \f[V]doyend\f[R], \f[V]epoch\f[R],
\f[V]exitstatus\f[R])
.SH Parameters
.TP
\f[V]filename\f[R] : input, character(*)
The ascii-formatted filename containing the spherical harmonic
coefficients.
.TP
\f[V]cilm\f[R] : output, real(dp), dimension (2, \f[V]lmax\f[R]+1, \f[V]lmax\f[R]+1)
The spherical harmonic coefficients contained in \f[V]filename\f[R].
.TP
\f[V]lmax\f[R] : output, integer(int32)
The maximum spherical harmonic degree of \f[V]cilm\f[R].
.TP
\f[V]gm\f[R] : output, real(dp)
The mass-gravitational constant.
.TP
\f[V]r0_pot\f[R] : output, real(dp)
The reference radius of the potential coefficients.
.TP
\f[V]error\f[R] : output, optional, real(dp), dimension (2, \f[V]lmax\f[R]+1, \f[V]lmax\f[R]+1)
The errors corresponding to the spherical harmonic coefficients
\f[V]cilm\f[R].
.TP
\f[V]dot\f[R] : output, optional, real(dp), dimension (2, \f[V]lmaxout\f[R]+1, \f[V]lmaxout\f[R]+1)
The time derivatives of the spherical harmonic coefficients.
The dimension of this array can be smaller than \f[V]lmax+1\f[R].
.TP
\f[V]doystart\f[R] : output, optional, real(dp)
The starting time of the solution.
.TP
\f[V]doyend\f[R] : output, optional, real(dp)
The ending time of the solution
.TP
\f[V]epoch\f[R] : output, optional, real(dp)
The epoch time for the time derivates.
.TP
\f[V]exitstatus\f[R] : output, optional, integer(int32)
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.
.SH Description
.PP
\f[V]SHRead2\f[R] will read spherical harmonic coefficients from a CHAMP
or GRACE-like ascii-formatted file into an array \f[V]cilm\f[R].
The errors and time derivatives associated with the coefficients will be
read if the optional arrays \f[V]error\f[R] and \f[V]dot\f[R] are
specified, respectively.
The staring and ending date of the solution are specified by the
optional parameters \f[V]doystart\f[R] and \f[V]doyend\f[R], and the
epoch of the time derivates is specified by the optional parameter
\f[V]epoch\f[R].
The maximum spherical harmonic degree is read from the file, and the
file does not need to be ordered by angular degree or order.
.PP
This routine does not read and output all parameters in the file.
Records that are read (and at least partially output) include:
\f[V]EARTH\f[R], \f[V]GGM\f[R], \f[V]SHM\f[R], \f[V]GRCOF2\f[R],
\f[V]GRDOTA\f[R], \f[V]CALSDV\f[R], \f[V]gfc\f[R], \f[V]gfct\f[R], and
\f[V]dot\f[R].
Comments specified by the record \f[V]CMMNT\f[R] will be print out to
the screen, as will the record names that are not currently implemented.
.PP
Each line of the file starts with a character string describing what
follows.
.IP \[bu] 2
\f[V]EARTH\f[R] or \f[V]GGM\f[R]: \f[V]GM\f[R], \f[V]R0_POT\f[R]
.IP \[bu] 2
\f[V]SHM\f[R]: Maximum spherical harmonic degree of file.
.IP \[bu] 2
\f[V]GRCOF2\f[R], \f[V]CALSDV\f[R], or \f[V]gfc\f[R]: spherical harmonic
coefficients, formatted as (\f[V]l\f[R], \f[V]m\f[R], \f[V]clm\f[R],
\f[V]slm\f[R]) or (\f[V]l\f[R], \f[V]m\f[R], \f[V]clm\f[R],
\f[V]slm\f[R], \f[V]clm_error\f[R], \f[V]slm_error\f[R]).
.SH See also
.PP
shread, shreadjpl