euv.h

// Copyright 2020, the Aether Development Team (see doc/dev_team.md for members)
// Full license can be found in License.md
 
#ifndef INCLUDE_EUV_H_
#define INCLUDE_EUV_H_
 
/**************************************************************
 * \class Euv
 *
 * \brief Defines the Extreme Ultraviolet radiation above the atmosphere
 * 
 * The Euv class defines the EUV environment above the atmosphere. It
 * does this through the use of a CSV file that contains a bunch of
 * information. Namely:
 *  - Upper and lower wavelengths of bins in the EUV spectrum
 *  - How to relate the wavelengths to brightness (using a model like EUVAC)
 *  - Absorption, ionization, and dissociation cross sections for species
 *
 * \author Aaron Ridley
 *
 * \date 2021/03/28 
 *
 **************************************************************/
 
#include <vector>
#include <string>
 
class Euv {
 
public:
 
  int nWavelengths;
 
  // number of lines in the EUV CSV file:
  int nLines;
 
  struct waveinfotype {
    std::string name;
    std::string to;
    std::string type;
    std::string units;
    std::string note;
    std::vector<float> values;
  };
 
  std::vector<waveinfotype> waveinfo;
 
  std::vector<float> wavelengths_short;
  
  std::vector<float> wavelengths_long;
  
  std::vector<float> wavelengths_energy;
 
  std::vector<float> wavelengths_intensity_1au;
 
  std::vector<float> wavelengths_intensity_top;
 
  std::vector<float> euvac_f74113;
  std::vector<float> euvac_afac;
 
  // --------------------------------------------------------------------
  // Functions:
 
  /**********************************************************************
     \brief Initialize the Euv class
     \param input info about how user has configured things
     \param report allow reporting to occur
   **/
  Euv(Inputs args, Report report);
 
  /**********************************************************************
     \brief Compute the EUV spectrum given F107 and F107a
     \param time The times within the model (dt is needed)
     \param indices Need the F107 and F107a
     \param report allow reporting to occur
   **/
  int euvac(Times time, Indices indices, Report &report);
 
  /**********************************************************************
     \brief Scale the EUV spectrum given the star - planet distance
     \param planet needed to compute the star - planet distance
     \param time Needed to compute orbital position around star
     \param report allow reporting to occur
   **/
  int scale_from_1au(Planets planet, Times time, Report report);
 
  /**********************************************************************
     \brief Pairs rows in the EUV CSV file with neutral and ions
 
     Reads through each row in the EUV CSV file and figures out whether
     the row is abs, ion, diss, and then figures out which neutral it is
     acting on and which neutral or ion results from the action 
     (e.g. O + photon -> O+, identifies O as ionization "loss" and
     O+ as an ionization "source")
 
     \param neutrals Needs names of the neutrals, stores lines in Neutrals
     \param ions Needs names of the ions
     \param report allow reporting to occur
   **/
  int pair_euv(Neutrals &neutrals, Ions ions, Report report);
  
private:
 
  /**********************************************************************
     \brief Read in the EUV CSV file
 
     Read in the EUV CSV file that describes all of the wavelengths and
     cross sections (and any other EUV - related things that are a 
     function of wavelength)
 
     \param input info about how user has configured things
     \param report allow reporting to occur
   **/
  int read_file(Inputs args, Report report);
 
  /**********************************************************************
     \brief Interprets the EUV CSV rows and returns the relevant row
 
     Find the correct row in the EUV CSV file information, and return
     the values in that row.
 
     \param item The string value to search for in the first column
     \param item2 If not blank, the string value to search for in the 2nd col.
     \return values The values in the CSV row that matches the item (and item2) 
     \param report Allow reporting to occur
   **/
  int slot_euv(std::string item,
               std::string item2,
               std::vector<float> &values,
               Report report);
};
 
#endif  // INCLUDE_EUV_H_