sun.h

Go to the documentation of this file.

 
#ifndef star_h
#define star_h
 
/*===========================================================================
  === External declarations
  ===========================================================================*/
 
 
#include "arts.h"
#include "gridded_fields.h"
#include "matpack_concepts.h"
#include "transmissionmatrix.h"
#include "energylevelmap.h"
#include "optproperties.h"
 
 
class Agenda;
class Workspace;
 
/*===========================================================================
  === structs/classes  in sun.h
  ===========================================================================*/
 
struct Sun {
  String description;
  Matrix spectrum;
  Numeric radius;
  Numeric distance;
  Numeric latitude;
  Numeric longitude;
 
  friend std::ostream& operator<<(std::ostream& os, const Sun& sun);
};
 
 
 
using ArrayOfSun = Array<Sun>;
 
 
/*===========================================================================
  === Functions in sun.h
  ===========================================================================*/
 
void get_scattered_sunsource(Workspace& ws,
                              RadiationVector& scattered_sunlight,
                              const Vector& f_grid,
                              const Numeric& p,
                              const Numeric& T,
                              const Vector& vmr,
                              const Matrix& transmitted_sunlight,
                              const Vector& gas_scattering_los_in,
                              const Vector& gas_scattering_los_out,
                              const Agenda& gas_scattering_agenda);
 
void get_sun_background(Matrix& iy,
                         Index& suns_visible,
                         const ArrayOfSun& suns,
                         const Ppath& ppath,
                         const Vector& f_grid,
                         const Index& stokes_dim,
                         const Index& atmosphere_dim,
                         const Vector& refellipsoid);
 
void get_sun_radiation(Matrix& iy,
                        Index& suns_visible,
                         const Sun& sun,
                         const Vector& rtp_pos,
                         const Vector& rtp_los,
                         const Vector& refellipsoid);
 
void get_direct_radiation(Workspace& ws,
                     ArrayOfMatrix& direct_radiation,
                     ArrayOfArrayOfTensor3& ddirect_radiation_dx,
                     const Index& stokes_dim,
                     const Vector& f_grid,
                     const Index& atmosphere_dim,
                     const Vector& p_grid,
                     const Vector& lat_grid,
                     const Vector& lon_grid,
                     const Tensor3& t_field,
                     const EnergyLevelMap& nlte_field,
                     const Tensor4& vmr_field,
                     const ArrayOfArrayOfSpeciesTag& abs_species,
                     const Tensor3& wind_u_field,
                     const Tensor3& wind_v_field,
                     const Tensor3& wind_w_field,
                     const Tensor3& mag_u_field,
                     const Tensor3& mag_v_field,
                     const Tensor3& mag_w_field,
                     const Index& cloudbox_on,
                     const ArrayOfIndex& cloudbox_limits,
                     const Index& gas_scattering_do,
                     const Index& irradiance_flag,
                     const ArrayOfPpath& sun_ppaths,
                     const ArrayOfSun& suns,
                     const ArrayOfIndex& suns_visible,
                     const Vector& refellipsoid,
                     const Tensor4& pnd_field,
                     const ArrayOfTensor4& dpnd_field_dx,
                     const ArrayOfString& scat_species,
                     const ArrayOfArrayOfSingleScatteringData& scat_data,
                     const Index& jacobian_do,
                     const ArrayOfRetrievalQuantity& jacobian_quantities,
                     const Agenda& propmat_clearsky_agenda,
                     const Agenda& water_p_eq_agenda,
                     const Agenda& gas_scattering_agenda,
                     const Numeric& rte_alonglos_v,
                     const Verbosity& verbosity);
 
void get_sun_ppaths(Workspace& ws,
                     ArrayOfPpath& sun_ppaths,
                     ArrayOfIndex& suns_visible,
                     ArrayOfVector& sun_rte_los,
                     const Vector& rte_pos,
                     const ArrayOfSun& suns,
                     const Vector& f_grid,
                     const Index& atmosphere_dim,
                     const Vector& p_grid,
                     const Vector& lat_grid,
                     const Vector& lon_grid,
                     const Tensor3& z_field,
                     const Matrix& z_surface,
                     const Vector& refellipsoid,
                     const Numeric& ppath_lmax,
                     const Numeric& ppath_lraytrace,
                     const Agenda& ppath_step_agenda,
                     const Verbosity& verbosity);
 
Matrix regrid_sun_spectrum(const GriddedField2& sun_spectrum_raw,
                          const Vector &f_grid,
                          const Index &stokes_dim,
                          const Numeric &temperature,
                          const Verbosity &verbosity);
 
#endif /* star_h */