init.c File Reference

Define default orbit structures and do other initialisation. More...

#include <stdlib.h>
#include <string.h>
#include "aephem.h"

Functions
const char *	ae_retcode_string (int retcode)
	For returning human readable return codes. More...

Variables
struct ae_orbit_t	ae_orb_mercury
	Default orbital parameters for Mercury. More...
struct ae_orbit_t	ae_orb_venus
	Default orbital parameters for Venus. More...
struct ae_orbit_t	ae_orb_earth
	Default orbital parameters for Earth. More...
struct ae_orbit_t	ae_orb_mars
	Default orbital parameters for Mars. More...
struct ae_orbit_t	ae_orb_jupiter
	Default orbital parameters for Jupiter. More...
struct ae_orbit_t	ae_orb_saturn
	Default orbital parameters for Saturn. More...
struct ae_orbit_t	ae_orb_uranus
	Default orbital parameters for Uranus. More...
struct ae_orbit_t	ae_orb_neptune
	Default orbital parameters for Neptune. More...
struct ae_orbit_t	ae_orb_pluto
	Default orbital parameters for Pluto. More...
struct ae_orbit_t *	ae_orb_planet []
	Pointers to the planetary orbit objects. More...
struct ae_physical_t *	ae_phys_planet []
	Pointers to the planetary physical information objects. More...
const char *	ae_ss_name []
	The names of the solar system bodies. More...
const char *	ae_retcode_name []
	Human readable strings describing return codes. More...

Detailed Description

Define default orbit structures and do other initialisation.

Function Documentation

const char* ae_retcode_string

(

int

retcode

)

For returning human readable return codes.

Parameters

retcode

A return code. The absolute value will be used, so either a negative or positive number may be passed.

Returns

A string describing the return code.

References ae_retcode_name.

Variable Documentation

struct ae_orbit_t ae_orb_earth

Initial value:

= {
  "Earth",
  2446800.5,
  0.0,
  0.0,
  102.884,
  0.999999,
  0.985611,
  0.016713,
  1.1791,
  2446800.5,
  &ae_ear404,
  0.0,
  0.0,
  0.0
}

Default orbital parameters for Earth.

struct ae_orbit_t ae_orb_jupiter

Initial value:

= {
  "Jupiter",
  2446800.5,
  1.3051,
  100.358,
  275.129,
  5.20265,
  0.0830948,
  0.048100,
  344.5086,
  2446800.5,
  &ae_jup404,
  0.0,
  0.0,
  0.0
}

Default orbital parameters for Jupiter.

struct ae_orbit_t ae_orb_mars

Initial value:

= {
  "Mars",
  2446800.5,
  1.8498,
  49.457,
  286.343,
  1.523710,
  0.524023,
  0.093472,
  53.1893,
  2446800.5,
  &ae_mar404,
  0.0,
  0.0,
  0.0
}

Default orbital parameters for Mars.

struct ae_orbit_t ae_orb_mercury

Initial value:

= {
  "Mercury",
  2446800.5,    
  7.0048,
  48.177,
  29.074,
  0.387098,
  4.09236,
  0.205628,
  198.7199,
  2446800.5,
  &ae_mer404,
  0.0,
  0.0,
  0.0
}

Default orbital parameters for Mercury.

struct ae_orbit_t ae_orb_neptune

Initial value:

= {
  "Neptune",
  2446800.5,
  1.7697,
  131.677,
  250.623,
  30.1631,
  0.00594978,
  0.009019,
  254.2568,
  2446800.5,
  &ae_nep404,
  0.0,
  0.0,
  0.0
}

Default orbital parameters for Neptune.

struct ae_orbit_t* ae_orb_planet[]

Initial value:

= {
  &ae_orb_mercury,
  &ae_orb_venus,
  NULL,
  &ae_orb_mars,
  &ae_orb_jupiter,
  &ae_orb_saturn,
  &ae_orb_uranus,
  &ae_orb_neptune,
  &ae_orb_pluto,
  NULL,
  NULL,
  NULL,
  NULL,
  &ae_orb_earth,
  NULL,
  NULL
}

Pointers to the planetary orbit objects.

The indices correspond to ae_ss_bodies_t.

struct ae_orbit_t ae_orb_pluto

Initial value:

= {
  "Pluto",
  2446640.5,
  17.1346,
  110.204,
  114.21,
  39.4633,
  0.00397570,
  0.248662,
  355.0554,
  2446640.5,
  &ae_plu404,
  0.0,
  0.0,
  0.0
}

Default orbital parameters for Pluto.

struct ae_orbit_t ae_orb_saturn

Initial value:

= {
  "Saturn",
  2446800.5,
  2.4858,
  113.555,
  337.969,
  9.54050,
  0.0334510,
  0.052786,
  159.6327,
  2446800.5,
  &ae_sat404,
  0.0,
  0.0,
  0.0
}

Default orbital parameters for Saturn.

struct ae_orbit_t ae_orb_uranus

Initial value:

= {
  "Uranus",
  2446800.5,
  0.7738,
  73.994,
  98.746,
  19.2233,
  0.0116943,
  0.045682,
  84.8516,
  2446800.5,
  &ae_ura404,
  0.0,
  0.0,
  0.0
}

Default orbital parameters for Uranus.

struct ae_orbit_t ae_orb_venus

Initial value:

= {
  "Venus",
  2446800.5,
  3.3946,
  76.561,
  54.889,
  0.723329,
  1.60214,
  0.006757,
  9.0369,
  2446800.5,
  &ae_ven404,
  0.0,
  0.0,
  0.0
}

Default orbital parameters for Venus.

struct ae_physical_t* ae_phys_planet[]

Initial value:

= {
  &ae_phys_mercury,
  &ae_phys_venus,
  NULL,
  &ae_phys_mars,
  &ae_phys_jupiter,
  &ae_phys_saturn,
  &ae_phys_uranus,
  &ae_phys_neptune,
  &ae_phys_pluto,
  NULL,
  &ae_phys_sun,
  NULL,
  NULL,
  &ae_phys_earth,
  NULL,
  NULL
}

Pointers to the planetary physical information objects.

The indices correspond to ae_ss_bodies_t.

const char* ae_retcode_name[]

Initial value:

= {
  "function excecuted normally",
  "could not open file",
  "unexpected end-of-file encountered",
  "unknown read error occured",
  "bad JPL file header",
  "bad JPL file header (KSIZE != 2 * N_COEFF)",
  "bad JPL file header (could not find a required group)",
  "bad JPL file header (differing numbers of constants and values)",
  "bad JPL file header (bad date range)",
  "unrecognised JPL file format (expecting ASCII)",
  "unrecognised JPL file format (expecting binary)",
  "bad JPL data block",
  "JPL data file seems to be corrupt",
  "Julian date outside of JPL file date range",
  "unable to parse expected float in JPL ASCII file",
  "bad Chebyshev parameter when interpolating data",
  "unknown object number",
  "object not found in catalogue file",
  "function requires aephem to be built with cfitsio support",
  "a required FITS keyword does not exist",
  "a required FITS keyword is corrupt",
  "unknown WCS projection type",
  "an error occurred in a call to a libcfitsio function",
  "could not compute the native pole of the projection",
  "a matrix is not invertible",
  "functionality under construction",
  NULL
}

Human readable strings describing return codes.

Referenced by ae_retcode_string().

const char* ae_ss_name[]

Initial value:

= {
  "Mercury",
  "Venus",
  "Earth-moon barycentre",
  "Mars",
  "Jupiter",
  "Saturn",
  "Uranus",
  "Neptune",
  "Pluto",
  "moon, relative to earth-moon barycentre",
  "sun",
  "nutation",
  "libration",
  "Earth",
  "moon",
  "Solar System barycentre",
}

The names of the solar system bodies.

The indices correspond to ae_ss_bodies_t.