planets.h

// Copyright 2020, the Aether Development Team (see doc/dev_team.md for members)
// Full license can be found in License.md
 
#ifndef AETHER_INCLUDE_PLANETS_H_
#define AETHER_INCLUDE_PLANETS_H_
 
/**************************************************************
 * A class for keeping track of all of the planetary characteristics
 *
 *
 **************************************************************/
 
#include <string>
#include <vector>
 
class Planets {
 
// -----------------------------------------------------------------------
// Public functions and variables
// -----------------------------------------------------------------------
 
public:
 
  // --------------------------------------------------------------------
  // Functions:
 
  /**********************************************************************
     \brief Initialize the Planet class
     \param args info about how user has configured things
     \param report allow reporting to occur
   **/
  Planets(Inputs args, Report report);
 
  /**********************************************************************
     \brief Returns the distance from the star to the planet being modeled
     \param time needed for getting the current time in different formats
   **/
  precision_t get_star_to_planet_dist(Times time);
 
  /**********************************************************************
     \brief Returns the orbit angle of the planet around the star
     \param time needed for getting the current time in different formats
   **/
  precision_t get_orbit_angle(Times time);
 
  /**********************************************************************
     \brief Returns the declination angle of the planet (zero = equinox)
     \param time needed for getting the current time in different formats
     \param
   **/
  precision_t get_declination(Times time);
 
  /**********************************************************************
     \brief Gets mu, which is planet mass times gravitational constant
   **/
  precision_t get_mu();
 
  /**********************************************************************
     \brief Returns radius of the planet, which can be a function of latitude
 
     currently, this ignores the latitude, but should be implemented.
 
     \param latitude the latitude to get the radius at.
   **/
  precision_t get_radius(precision_t latitude);
 
  /**********************************************************************
     \brief Returns the longitude offset to convert from longitude to local time
 
     this function returns a value that when added to the longitude (in
     radians) will provide the local time (in radians)
 
     \param time needed for getting the current time in different formats
   **/
  precision_t get_longitude_offset(Times time);
 
  /**********************************************************************
     \brief Returns the sin of the planet's declination angle
     \param time needed for getting the current time in different formats
   **/
  precision_t get_sin_dec(Times time);
 
  /**********************************************************************
     \brief Returns the cos of the planet's declination angle
     \param time needed for getting the current time in different formats
   **/
  precision_t get_cos_dec(Times time);
 
  /**********************************************************************
     \brief Returns the location of the center of the dipole (in meters)
   **/
  std::vector<float> get_dipole_center();
 
  /**********************************************************************
     \brief Returns the rotation angle of the dipole in longitude (radians)
   **/
  precision_t get_dipole_rotation();
 
  /**********************************************************************
     \brief Returns the tilt angle of the dipole (co-latitude) (radians)
   **/
  precision_t get_dipole_tilt();
 
  /**********************************************************************
     \brief Returns the strength of the dipole at the surface (in nT)
   **/
  precision_t get_dipole_strength();
  
// -----------------------------------------------------------------------
// Private functions and variables
// -----------------------------------------------------------------------
  
 private:
 
  struct planet_chars {
 
    // ---------------------------------------
    // These are set by an input file:
 
    std::string name;
 
    precision_t semimajoraxis;
    precision_t eccentricity;
    precision_t inclination;
    precision_t meanlongitude;
    precision_t perihelionlongitude;
    precision_t nodelongitude;
 
    precision_t rates_semimajoraxis;
    precision_t rates_eccentricity;
    precision_t rates_inclination;
    precision_t rates_meanlongitude;
    precision_t rates_perihelionlongitude;
    precision_t rates_nodelongitude;
 
    precision_t planet_tilt;
 
    precision_t rotation_period;
    precision_t omega;
    precision_t length_of_day;
 
    double length_of_year;
    precision_t longitude_jb2000;
 
    precision_t mass;
    precision_t mu;
    precision_t equator_radius;
    precision_t polar_radius;
    precision_t radius;
 
    precision_t dipole_strength;
    precision_t dipole_rotation;
    precision_t dipole_tilt;
    std::vector<float> dipole_center{ 0.0, 0.0, 0.0 };
 
    // ---------------------------------------
    // These are updated during the run:
 
    precision_t declination, sin_dec, cos_dec;
    precision_t longitude_offset;
 
    precision_t star_planet_distance;
    precision_t orbit_angle;
    precision_t ls;
 
    double update_time;
 
  };
 
  std::vector<planet_chars> planets;
 
  planet_chars planet;
 
  // --------------------------------------------------------------------
  // Functions:
 
  /**********************************************************************
     \brief Sets the planetary characterists for the chosen planet
 
     This function just copies over the chosen planet's characteristics
     from the vector into the stand-alone structure.
 
     \param input info about how user has configured things
     \param report allow reporting to occur
   **/
  int set_planet(Inputs args, Report report);
 
  /**********************************************************************
     \brief Updates the planetary characteristics that depend on time
 
     time is needed in a variety of formats, since many of the
     calculations require different time formats.
 
     \param time needed for getting the current time in different formats
   **/
  int update(Times time);
 
  /**********************************************************************
     \brief Reads in the planetary characteristics and stores them
     \param args info about how user has configured things
     \param report allow reporting to occur
   **/
  int read_file(Inputs args, Report report);
};
 
#endif  // INCLUDE_PLANETS_H_