sofars 0.6.0

Pure Rust implementation of the IAU SOFA library
Documentation 
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

use super::{bpn2xy, pnm00a, s00};

/// The CIO locator s, positioning the Celestial Intermediate Origin on
/// the equator of the Celestial Intermediate Pole, using the IAU 2000A
/// precession-nutation model.
///
/// This function is part of the International Astronomical Union's
/// SOFA (Standards of Fundamental Astronomy) software collection.
///
/// Status:  support function.
///
/// Given:
///    date1,date2  f64    TT as a 2-part Julian Date (Note 1)
///
/// Returned (function value):
///                 f64    the CIO locator s in radians (Note 2)
///
/// Notes:
///
/// 1) The TT date date1+date2 is a Julian Date, apportioned in any
///    convenient way between the two arguments.  For example,
///    JD(TT)=2450123.7 could be expressed in any of these ways,
///    among others:
///
/// ```text
///           date1          date2
///
///        2450123.7           0.0       (JD method)
///        2451545.0       -1421.3       (J2000 method)
///        2400000.5       50123.2       (MJD method)
///        2450123.5           0.2       (date & time method)
/// ```
///
///    The JD method is the most natural and convenient to use in
///    cases where the loss of several decimal digits of resolution
///    is acceptable.  The J2000 method is best matched to the way
///    the argument is handled internally and will deliver the
///    optimum resolution.  The MJD method and the date & time methods
///    are both good compromises between resolution and convenience.
///
/// 2) The CIO locator s is the difference between the right ascensions
///    of the same point in two systems.  The two systems are the GCRS
///    and the CIP,CIO, and the point is the ascending node of the
///    CIP equator.  The CIO locator s remains a small fraction of
///    1 arcsecond throughout 1900-2100.
///
/// 3) The series used to compute s is in fact for s+XY/2, where X and Y
///    are the x and y components of the CIP unit vector;  this series
///    is more compact than a direct series for s would be.  The present
///    function uses the full IAU 2000A nutation model when predicting
///    the CIP position.  Faster results, with no significant loss of
///    accuracy, can be obtained via the function iauS00b, which uses
///    instead the IAU 2000B truncated model.
///
/// References:
///
///    Capitaine, N., Chapront, J., Lambert, S. and Wallace, P.,
///    "Expressions for the Celestial Intermediate Pole and Celestial
///    Ephemeris Origin consistent with the IAU 2000A precession-
///    nutation model", Astron.Astrophys. 400, 1145-1154 (2003)
///
///    n.b. The celestial ephemeris origin (CEO) was renamed "celestial
///         intermediate origin" (CIO) by IAU 2006 Resolution 2.
///
///    McCarthy, D. D., Petit, G. (eds.), IERS Conventions (2003),
///    IERS Technical Note No. 32, BKG (2004)
pub fn s00a(date1: f64, date2: f64) -> f64 {
    /* Bias-precession-nutation-matrix, IAU 2000A. */
    let rbpn = pnm00a(date1, date2);

    /* Extract the CIP coordinates. */
    let (x, y) = bpn2xy(&rbpn);

    /* Compute the CIO locator s, given the CIP coordinates. */
    s00(date1, date2, x, y)
}