rsspice 0.1.0

Pure Rust port of the SPICE Toolkit for space geometry
Documentation
//
// GENERATED FILE
//

use super::*;
use crate::SpiceContext;
use f2rust_std::*;

/// Cylindrical to rectangular
///
/// Convert from cylindrical to rectangular coordinates.
///
/// # Brief I/O
///
/// ```text
///  VARIABLE  I/O  DESCRIPTION
///  --------  ---  -------------------------------------------------
///  R          I   Distance of a point from Z axis.
///  CLON       I   Angle (radians) of a point from XZ plane
///  Z          I   Height of a point above XY plane.
///  RECTAN     O   Rectangular coordinates of the point.
/// ```
///
/// # Detailed Input
///
/// ```text
///  R        is the distance of the point of interest from Z-axis.
///
///  CLON     is the cylindrical angle (in radians) of the point of
///           interest from XZ plane.
///
///  Z        is the height of the point above XY plane.
/// ```
///
/// # Detailed Output
///
/// ```text
///  RECTAN   are the rectangular coordinates of the point of
///           interest.
/// ```
///
/// # Exceptions
///
/// ```text
///  Error free.
/// ```
///
/// # Particulars
///
/// ```text
///  This routine transforms the coordinates of a point from
///  cylindrical to rectangular coordinates.
/// ```
///
/// # Examples
///
/// ```text
///  The numerical results shown for these examples may differ across
///  platforms. The results depend on the SPICE kernels used as
///  input, the compiler and supporting libraries, and the machine
///  specific arithmetic implementation.
///
///  1) Compute the cylindrical coordinates of the position of the Moon
///     as seen from the Earth, and convert them to rectangular
///     coordinates.
///
///     Use the meta-kernel shown below to load the required SPICE
///     kernels.
///
///
///        KPL/MK
///
///        File name: cylrec_ex1.tm
///
///        This meta-kernel is intended to support operation of SPICE
///        example programs. The kernels shown here should not be
///        assumed to contain adequate or correct versions of data
///        required by SPICE-based user applications.
///
///        In order for an application to use this meta-kernel, the
///        kernels referenced here must be present in the user's
///        current working directory.
///
///        The names and contents of the kernels referenced
///        by this meta-kernel are as follows:
///
///           File name                     Contents
///           ---------                     --------
///           de421.bsp                     Planetary ephemeris
///           naif0012.tls                  Leapseconds
///
///
///        \begindata
///
///           KERNELS_TO_LOAD = ( 'de421.bsp',
///                               'naif0012.tls'  )
///
///        \begintext
///
///        End of meta-kernel
///
///
///     Example code begins here.
///
///
///           PROGRAM CYLREC_EX1
///           IMPLICIT NONE
///
///     C
///     C     SPICELIB functions
///     C
///           DOUBLE PRECISION      DPR
///
///     C
///     C     Local parameters
///     C
///           CHARACTER*(*)         FMT1
///           PARAMETER           ( FMT1 = '(A,F20.8)' )
///     C
///     C     Local variables
///     C
///           DOUBLE PRECISION      CLON
///           DOUBLE PRECISION      ET
///           DOUBLE PRECISION      LT
///           DOUBLE PRECISION      POS    ( 3 )
///           DOUBLE PRECISION      RECTAN ( 3 )
///           DOUBLE PRECISION      R
///           DOUBLE PRECISION      Z
///
///     C
///     C     Load SPK and LSK kernels, use a meta kernel for
///     C     convenience.
///     C
///           CALL FURNSH ( 'cylrec_ex1.tm' )
///
///     C
///     C     Look up the geometric state of the Moon as seen from
///     C     the Earth at 2017 Mar 20, relative to the J2000
///     C     reference frame.
///     C
///           CALL STR2ET ( '2017 Mar 20', ET )
///
///           CALL SPKPOS ( 'Moon',  ET,  'J2000', 'NONE',
///          .              'Earth', POS, LT               )
///
///     C
///     C     Convert the position vector POS to cylindrical
///     C     coordinates.
///     C
///           CALL RECCYL ( POS, R, CLON, Z )
///
///     C
///     C     Convert the cylindrical to rectangular coordinates.
///     C
///
///           CALL CYLREC ( R, CLON, Z, RECTAN )
///
///           WRITE(*,*) ' '
///           WRITE(*,*) 'Original rectangular coordinates:'
///           WRITE(*,*) ' '
///           WRITE(*,FMT1) '  X          (km): ', POS(1)
///           WRITE(*,FMT1) '  Y          (km): ', POS(2)
///           WRITE(*,FMT1) '  Z          (km): ', POS(3)
///           WRITE(*,*) ' '
///           WRITE(*,*) 'Cylindrical coordinates:'
///           WRITE(*,*) ' '
///           WRITE(*,FMT1) '  Radius     (km): ', R
///           WRITE(*,FMT1) '  Longitude (deg): ', CLON*DPR()
///           WRITE(*,FMT1) '  Z          (km): ', Z
///           WRITE(*,*) ' '
///           WRITE(*,*) 'Rectangular coordinates from CYLREC:'
///           WRITE(*,*) ' '
///           WRITE(*,FMT1) '  X          (km): ', RECTAN(1)
///           WRITE(*,FMT1) '  Y          (km): ', RECTAN(2)
///           WRITE(*,FMT1) '  Z          (km): ', RECTAN(3)
///           WRITE(*,*) ' '
///
///           END
///
///
///     When this program was executed on a Mac/Intel/gfortran/64-bit
///     platform, the output was:
///
///
///      Original rectangular coordinates:
///
///       X          (km):      -55658.44323296
///       Y          (km):     -379226.32931475
///       Z          (km):     -126505.93063865
///
///      Cylindrical coordinates:
///
///       Radius     (km):      383289.01777726
///       Longitude (deg):         261.65040211
///       Z          (km):     -126505.93063865
///
///      Rectangular coordinates from CYLREC:
///
///       X          (km):      -55658.44323296
///       Y          (km):     -379226.32931475
///       Z          (km):     -126505.93063865
///
///
///  2) Create a table showing a variety of cylindrical coordinates
///     and the corresponding rectangular coordinates.
///
///     Corresponding rectangular and cylindrical coordinates are
///     listed to three decimal places. Input angles are in degrees.
///
///
///     Example code begins here.
///
///
///           PROGRAM CYLREC_EX2
///           IMPLICIT NONE
///
///     C
///     C     SPICELIB functions
///     C
///           DOUBLE PRECISION      RPD
///
///     C
///     C     Local parameters.
///     C
///           INTEGER               NREC
///           PARAMETER           ( NREC = 11 )
///
///     C
///     C     Local variables.
///     C
///           DOUBLE PRECISION      R      ( NREC )
///           DOUBLE PRECISION      CLON   ( NREC )
///           DOUBLE PRECISION      Z      ( NREC )
///           DOUBLE PRECISION      RCLON
///           DOUBLE PRECISION      RECTAN ( 3    )
///
///           INTEGER               I
///
///     C
///     C     Define the input cylindrical coordinates. Angles
///     C     in degrees.
///     C
///           DATA                 R    /  0.D0, 1.D0,     1.D0,
///          .                             0.D0, 1.D0,     1.D0,
///          .                             0.D0, 1.4142D0, 1.D0,
///          .                             1.D0, 1.4142D0       /
///
///           DATA                 CLON /  0.D0,   0.D0,  90.D0,
///          .                             0.D0, 180.D0, 270.D0,
///          .                             0.D0,  45.D0,   0.D0,
///          .                            90.D0,  45.D0         /
///
///           DATA                 Z    /  0.D0,   0.D0,   0.D0,
///          .                             1.D0,   0.D0,   0.D0,
///          .                            -1.D0,   0.D0,   1.D0,
///          .                             1.D0,   1.D0         /
///
///     C
///     C     Print the banner.
///     C
///           WRITE(*,*) '    R       CLON      Z    '
///          . //        ' RECT(1)  RECT(2)  RECT(3) '
///           WRITE(*,*) ' -------  -------  ------- '
///          . //        ' -------  -------  ------- '
///
///     C
///     C     Do the conversion.
///     C
///           DO I = 1, NREC
///
///              RCLON = CLON(I) * RPD()
///
///              CALL CYLREC( R(I), RCLON, Z(I), RECTAN )
///
///              WRITE (*,'(6F9.3)') R(I), CLON(I), Z(I),
///          .                       RECTAN
///
///           END DO
///
///           END
///
///
///     When this program was executed on a Mac/Intel/gfortran/64-bit
///     platform, the output was:
///
///
///          R       CLON      Z     RECT(1)  RECT(2)  RECT(3)
///       -------  -------  -------  -------  -------  -------
///         0.000    0.000    0.000    0.000    0.000    0.000
///         1.000    0.000    0.000    1.000    0.000    0.000
///         1.000   90.000    0.000    0.000    1.000    0.000
///         0.000    0.000    1.000    0.000    0.000    1.000
///         1.000  180.000    0.000   -1.000    0.000    0.000
///         1.000  270.000    0.000   -0.000   -1.000    0.000
///         0.000    0.000   -1.000    0.000    0.000   -1.000
///         1.414   45.000    0.000    1.000    1.000    0.000
///         1.000    0.000    1.000    1.000    0.000    1.000
///         1.000   90.000    1.000    0.000    1.000    1.000
///         1.414   45.000    1.000    1.000    1.000    1.000
/// ```
///
/// # Author and Institution
///
/// ```text
///  J. Diaz del Rio    (ODC Space)
///  W.L. Taber         (JPL)
/// ```
///
/// # Version
///
/// ```text
/// -    SPICELIB Version 1.1.0, 06-JUL-2021 (JDR)
///
///         Changed the input argument name LONG to CLON for consistency
///         with other routines.
///
///         Added IMPLICIT NONE statement.
///
///         Edited the header to comply with NAIF standard. Removed
///         unnecessary $Revisions section. Added complete code examples.
///
/// -    SPICELIB Version 1.0.1, 10-MAR-1992 (WLT)
///
///         Comment section for permuted index source lines was added
///         following the header.
///
/// -    SPICELIB Version 1.0.0, 31-JAN-1990 (WLT)
/// ```
pub fn cylrec(r: f64, clon: f64, z: f64, rectan: &mut [f64; 3]) {
    CYLREC(r, clon, z, rectan);
}

//$Procedure CYLREC ( Cylindrical to rectangular )
pub fn CYLREC(R: f64, CLON: f64, Z: f64, RECTAN: &mut [f64]) {
    let mut RECTAN = DummyArrayMut::new(RECTAN, 1..=3);
    let mut X: f64 = 0.0;
    let mut Y: f64 = 0.0;

    //
    // Local variables
    //

    //
    // Convert to rectangular coordinates, storing the results in
    // temporary variables.
    //
    X = (R * f64::cos(CLON));
    Y = (R * f64::sin(CLON));

    //
    // Move the results to the output variables.
    //
    RECTAN[1] = X;
    RECTAN[2] = Y;
    RECTAN[3] = Z;
}