grid.h

// Copyright 2020, the Aether Development Team (see doc/dev_team.md for members)
// Full license can be found in License.md
 
#ifndef INCLUDE_GRID_H_
#define INCLUDE_GRID_H_
 
// ----------------------------------------------------------------------------
// Grid class
// ----------------------------------------------------------------------------
 
class Grid {
 
public:
 
  int get_IsGeoGrid();
  bool get_HasBField();
  void set_IsGeoGrid(int value);
 
  int64_t get_nPointsInGrid();
 
  int64_t get_nX();
  int64_t get_nY();
  int64_t get_nZ();
 
  int64_t get_nLons();
  int64_t get_nLats();
  int64_t get_nAlts();
 
  int64_t get_nGCs();
 
  // Armidillo Cube Versions:
  arma_cube geoLon_scgc, geoX_scgc;
  arma_cube geoLat_scgc, geoY_scgc;
  arma_cube geoAlt_scgc, geoZ_scgc;
  arma_cube geoLocalTime_scgc;
  
  // These define the magnetic grid:
  // Armidillo Cube Versions:
  arma_cube magLon_scgc, magX_scgc;
  arma_cube magLat_scgc, magY_scgc;
  arma_cube magAlt_scgc, magZ_scgc;
  arma_cube magLocalTime_scgc;
 
  // These are the locations of the magnetic poles:
  //  ll -> lat, lon, radius independent
  arma_vec mag_pole_north_ll;
  arma_vec mag_pole_south_ll;
 
  // pole gse -> needs to be for each altitude, so we can compute
  // magnetic local time. We want to use some GSE conversion function,
  // so this type has to a vector of arma_cubes:
  std::vector<arma_cube> mag_pole_north_gse;
  std::vector<arma_cube> mag_pole_south_gse;
  
  std::vector<arma_cube> GSE_XYZ_vcgc;
 
  std::string altitude_name = "Altitude";
  std::string altitude_unit = "meters";
 
  std::string longitude_name = "Longitude";
  std::string longitude_unit = "radians";
 
  std::string latitude_name = "Latitude";
  std::string latitude_unit = "radians";
 
  // These are derived variables from the grid:
 
  // Switch to armadillo variables (precision_t cubes):
  arma_cube radius_scgc;
  arma_cube radius2_scgc;
  arma_cube radius2i_scgc;
  arma_cube gravity_scgc;
 
  arma_cube sza_scgc;
  arma_cube cos_sza_scgc;
 
  arma_cube dalt_center_scgc;
  arma_cube dalt_lower_scgc;
  arma_cube dalt_ratio_scgc;
  arma_cube dalt_ratio_sq_scgc;
 
  arma_cube dlon_center_scgc;
  arma_cube dlon_center_dist_scgc;
 
  arma_cube dlat_center_scgc;
  arma_cube dlat_center_dist_scgc;
  
  std::vector<arma_cube> bfield_vcgc;
  arma_cube bfield_mag_scgc;
  std::vector<arma_cube> bfield_unit_vcgc;
 
  Grid(int nX_in, int nY_in, int nZ_in, int nGCs_in);
 
  void calc_sza(Planets planet, Times time, Report &report);
  void calc_gse(Planets planet, Times time, Report &report);
  void calc_mlt(Report &report);
  void fill_grid(Planets planet, Report &report);
  void fill_grid_radius(Planets planet, Report &report);
  void init_geo_grid(Planets planet, Inputs input, Report &report);
  void fill_grid_bfield(Planets planet, Inputs input, Report &report);
 
 private:
 
  int IsGeoGrid;
  bool HasBField;
 
  int64_t nX, nLons;
  int64_t nY, nLats;
  int64_t nZ, nAlts;
 
  int nGCs; // number of ghostcells
 
};
 
#endif  // INCLUDE_GRID_H_