GRASP Framework Overview

Go to the documentation of this file.

 //
 // Created by Juan Carlos Antuña-Sánchez on 10/8/21.
 //
 #include <stdbool.h>
 #include "mod_par_OS.inc"
 #include "mod_par_DLS.inc"
 #include "mod_par_inv.inc"
  
 #ifndef EXTERNAL_INTERFACE_H
 #define EXTERNAL_INTERFACE_H
 #define MAX(x,y) ((x>y)?x:y)
  
 #define _NLEVEL_GAS _KVERT_WD
  
 typedef struct radiative_transfer_args_ {
     int IW;  
     int NG;  
     int NN;  
     int NF;  
     int iBRDF;  
     int iBPDF;  
     int iBRM_water;  
     float land_percent;  
     int NQDR;  
     int NT1[2];  
     float tetas;  
     int NBV;  
     float vis[2 * _NBVM];  
     float fiv[2 * _NBVM];  
     float WAVE;  
     int n_par_land;  
     int n_par_land_i;  
     float surf_land_par_vect[2 * _KBF];  
     int n_par_water;  
     float surf_water_par_vect[_KBF];  
     float EXT[_NMM + _NMG];  
     float SSA[_NMM + _NMG];  
     int NANG;  
     float ANGL[_KMpar];  
     float SD[_KSD][_KIDIM3];  
     float CEXT[_KSD];  
     float HOBS_km;  
     float HGR_km;  
     float HMAX_atm_km;  
     int NHVP_retr;  
     float HVP_retr_km[_KVERTM];  
     float H0[_KSD][_KVERTM];  
     float sigma_aerosol[_KSD];  
     int ifgas;  
     float gaspar;  
     float T_profile[_NLEVEL_GAS];  
     float STEMP;  
     bool laerosol;  
     bool lsurface;  
     bool ATMOS_EMIS;  
     bool SOLAR_EMIS;  
     float PF11_I[_KSD][_KMpar];  
     float PF12_I[_KSD][_KMpar];  
     float PF22_I[_KSD][_KMpar];  
     float PF33_I[_KSD][_KMpar];  
     int NLV;  
     float HLV[_KNT];  
     bool aerosol_analyt_prof;  
     bool gas_abs_line;  
     int N_level;  
     float Hight_level_km[MAX(_KVERTM, _KVERT_WD)];  
     int nh;  
     float h_km[_KVERT_WD];  
     int natm;  
     int naer;  
     int nmol;  
     int ngas;  
     float norm_DISCRVD[_NMM + _NMG];  
     bool ISGL;  
     bool IAER;  
     bool IVEC_CTL;  
     bool ISRF;  
     bool IDWN;  
     bool IFLX;  
     bool IGQ_F;  
     bool IGQ_D;  
     bool IGQ_BRM_FEXP;  
     bool IGQ_BRM_HSPH;  
     bool IP_VERBOSE;  
     bool IP_ADDITION;  
     bool ITRC;  
     bool ISCA;  
     bool IVEC_SET;  
     bool IWUT;  
     bool ILUT;  
     bool IATM;  
     bool ICRR;  
     bool boa_ref;  
     int AER_PRF;  
     int MOL_PRF;  
     int NA;  
     int NB[_KSD];  
     int NLYR[2];  
     float EPS;  
 } radiative_transfer_args;
  
 typedef struct radiative_transfer_result_ {
     float thd[2*_NBVM];  
     float SLout[2*_NBVM];  
     float SQout[2*_NBVM];  
     float SUout[2*_NBVM];  
     float SLPout[2*_NBVM];  
     float salb_out;  
     float UFX[_KNT];  
     float DFX[_KNT];  
 } radiative_transfer_result;
  
 /*
  * Actual function is implemented in fortran, which is why we have the full list of parameters here as well
  */
 extern void grasp_rt_sos_(int IW, int NG, int NN, int NF,
                           int iBRDF, int iBPDF, int iBRM_water, float land_percent,
                           int NQDR, int NT1[2], float tetas, int NBV, float vis[2*_NBVM], float fiv[2*_NBVM],
                           float WAVE,
                           int n_par_land, int n_par_land_i, float surf_land_par_vect[2*_KBF],
                           int n_par_water, float surf_water_par_vect[_KBF],
                           float EXT[_NMM+_NMG], float SSA[_NMM+_NMG],
                           int NANG, float ANGL[_KMpar],
                           float SD[_KSD][_KIDIM3], float CEXT[_KSD],
                           float HOBS_km, float HGR_km, float HMAX_atm_km,
                           int NHVP_retr, float HVP_retr_km[_KVERTM],
                           float H0[_KSD][_KVERTM], float sigma_aerosol[_KSD],
                           int ifgas, float gaspar,
                           float T_profile[_NLEVEL_GAS], float STEMP,
                           bool laerosol, bool lsurface,
                           bool ATMOS_EMIS, bool SOLAR_EMIS,
                           float PF11_I[_KSD][_KMpar], float PF12_I[_KSD][_KMpar],
                           float PF22_I[_KSD][_KMpar], float PF33_I[_KSD][_KMpar],
                           int NLV, float HLV[_KNT],
                           bool  aerosol_analyt_prof, bool gas_abs_line,
                           int N_level,
                           float Hight_level_km[MAX(_KVERTM,_KVERT_WD)],
                           int nh,
                           float h_km[_KVERT_WD],
                           int natm, int naer, int nmol, int ngas,
                           float norm_DISCRVD[_NMM+_NMG],
                           bool ISGL, bool IAER, bool IVEC_CTL, bool ISRF, bool IDWN, bool IFLX,
                           bool IGQ_F, bool IGQ_D, bool IGQ_BRM_FEXP, bool IGQ_BRM_HSPH,
                           bool IP_VERBOSE, bool IP_ADDITION, bool ITRC, bool ISCA, bool IVEC_SET,
                           bool IWUT, bool ILUT, bool IATM, bool ICRR, bool boa_ref,
                           int AER_PRF, int MOL_PRF,
                           int NA, int NB[_KSD],
                           int NLYR[2], float EPS,
                           float thd[2*_NBVM],
                           float SLout[2*_NBVM], float SQout[2*_NBVM], float SUout[2*_NBVM], float SLPout[2*_NBVM],
                           float *salb_out,
                           float UFX[_KNT], float DFX[_KNT]);
  
 void grasp_rt_sos(radiative_transfer_args *args, radiative_transfer_result *result);
  
 #endif //EXTERNAL_INTERFACE_H

radiative_transfer_args_::IP_VERBOSE

bool IP_VERBOSE

IP_VERBOSE - Related with output format.

Definition: external_interface.h:84

radiative_transfer_args_::boa_ref

bool boa_ref

boa_ref - Selectes between different surface models

Definition: external_interface.h:93

radiative_transfer_args_::WAVE

float WAVE

WAVE - Wavelength in micrometers.

Definition: external_interface.h:30

radiative_transfer_args_::natm

int natm

natm - Number of total atmospheric components

Definition: external_interface.h:69

radiative_transfer_args_::land_percent

float land_percent

land_percent - Percent of surface corresponding to land model

Definition: external_interface.h:23

radiative_transfer_args_::ifgas

int ifgas

ifgas - Selects if gas absorption is incuded or not (old gas model)

Definition: external_interface.h:49

radiative_transfer_args_::IFLX

bool IFLX

IFLX - Marks is flux calculations is going to be done (not possible with the actual approach of the s...

Definition: external_interface.h:79

radiative_transfer_args_::NA

int NA

NA - RT kernels approach: number of aerosol modes.

Definition: external_interface.h:96

radiative_transfer_args_::n_par_land

int n_par_land

n_par_land - total number of surface parameters (BRDF+BPDF) for land

Definition: external_interface.h:31

radiative_transfer_args_::CEXT

float CEXT[_KSD]

CEXT - RT kernels approach: extinction. Related to LUT generation.

Definition: external_interface.h:41

radiative_transfer_result_::thd

float thd[2 *_NBVM]

thd - Measurement azimuth angle (degrees)

Definition: external_interface.h:103

radiative_transfer_args_::HGR_km

float HGR_km

HGR_km - Station altitude in km.

Definition: external_interface.h:43

radiative_transfer_args_::IGQ_BRM_FEXP

bool IGQ_BRM_FEXP

IGQ_BRM_FEXP - Surface quadrature calculations for Fourier components.

Definition: external_interface.h:82

radiative_transfer_args_::SD

float SD[_KSD][_KIDIM3]

SD - RT kernels approach: Size distribution. Related to LUT generation.

Definition: external_interface.h:40

radiative_transfer_args_::EXT

float EXT[_NMM+_NMG]

EXT - Extinction for each.

Definition: external_interface.h:36

radiative_transfer_args_::NLV

int NLV

NLV - Number of levels.

Definition: external_interface.h:61

radiative_transfer_args_::gaspar

float gaspar

gaspar - Gas absorption value (old gas model)

Definition: external_interface.h:50

radiative_transfer_args_::ngas

int ngas

ngas - Number of total gaseous components

Definition: external_interface.h:72

radiative_transfer_result_::DFX

float DFX[_KNT]

DFX - Fluxes.

Definition: external_interface.h:110

radiative_transfer_args_::h_km

float h_km[_KVERT_WD]

h_km - Height of layers in the aerosol profile

Definition: external_interface.h:68

radiative_transfer_result_::SQout

float SQout[2 *_NBVM]

SQout - Calculated radiance in the selected viewing geometry.

Definition: external_interface.h:105

radiative_transfer_result_::SLPout

float SLPout[2 *_NBVM]

SLPout - Calculated radiance in the selected viewing geometry.

Definition: external_interface.h:107

radiative_transfer_args_::IGQ_D

bool IGQ_D

IGQ_D - Quadrature calculation for dericatives in inversion mode.

Definition: external_interface.h:81

radiative_transfer_args_::IGQ_F

bool IGQ_F

IGQ_F - Quadrature calculation in forward mode.

Definition: external_interface.h:80

radiative_transfer_args_::ISGL

bool ISGL

ISGL - To restrict the code to single scattering calculations.

Definition: external_interface.h:74

radiative_transfer_args_::IATM

bool IATM

IATM - Choose between bihemispherical or directional hemispherical reflectance of atmosphere.

Definition: external_interface.h:91

radiative_transfer_args_::naer

int naer

naer - Number of total aerosol modes

Definition: external_interface.h:70

radiative_transfer_args_::laerosol

bool laerosol

laerosol - Selects if aerosol is present in the atmosphere

Definition: external_interface.h:53

radiative_transfer_args_::tetas

float tetas

tetas - Solar Zenith Angle

Definition: external_interface.h:26

radiative_transfer_args_::AER_PRF

int AER_PRF

AER_PRF - Aerosol profile shape.

Definition: external_interface.h:94

radiative_transfer_args_::surf_land_par_vect

float surf_land_par_vect[2 *_KBF]

surf_land_par_vect - Parameters describing land surface

Definition: external_interface.h:33

radiative_transfer_result_::UFX

float UFX[_KNT]

UFX - Fluxes.

Definition: external_interface.h:109

radiative_transfer_args_::MOL_PRF

int MOL_PRF

MOL_PRF - Molecular profile shape.

Definition: external_interface.h:95

radiative_transfer_args_::ILUT

bool ILUT

ILUT - Use LUTs already generated.

Definition: external_interface.h:90

radiative_transfer_args_::iBRDF

int iBRDF

iBRDF - Establish if surface directional scattering is taken into account

Definition: external_interface.h:20

radiative_transfer_args_::N_level

int N_level

N_level - Number of levels.

Definition: external_interface.h:65

radiative_transfer_args_::IP_ADDITION

bool IP_ADDITION

IP_ADDITION - Related with output additional information.

Definition: external_interface.h:85

radiative_transfer_args_::IWUT

bool IWUT

IWUT - Lut generation.

Definition: external_interface.h:89

radiative_transfer_result

struct radiative_transfer_result_ radiative_transfer_result

radiative_transfer_args_

Definition: external_interface.h:15

sub_gas_kd::natm

integer, parameter natm

Definition: sub_gas_abs_kd.f90:18

radiative_transfer_args_::PF22_I

float PF22_I[_KSD][_KMpar]

PF22_I - Aerosol phase matrix.

Definition: external_interface.h:59

radiative_transfer_result_::SLout

float SLout[2 *_NBVM]

SLout - Calculated radiance in the selected viewing geometry.

Definition: external_interface.h:104

radiative_transfer_args_::ICRR

bool ICRR

ICRR - Atmospheric correction.

Definition: external_interface.h:92

grasp_rt_sos

void grasp_rt_sos(radiative_transfer_args *args, radiative_transfer_result *result)

Definition: external_interface.c:7

radiative_transfer_args_::SSA

float SSA[_NMM+_NMG]

SSA - Single scattering albedo for each atmospheric component.

Definition: external_interface.h:37

radiative_transfer_args_::norm_DISCRVD

float norm_DISCRVD[_NMM+_NMG]

norm_DISCRVD - Norm of atmospheric vertical profile

Definition: external_interface.h:73

radiative_transfer_args_::NG

int NG

NG - Number of gaussian quadrature points.

Definition: external_interface.h:17

MAX

#define MAX(x, y)

Definition: external_interface.h:11

radiative_transfer_args_::sigma_aerosol

float sigma_aerosol[_KSD]

sigma_aerosol - Parameters for aerosol vertical profile shape

Definition: external_interface.h:48

radiative_transfer_args_::lsurface

bool lsurface

lsurface - Selects if surface is present in the calculations

Definition: external_interface.h:54

radiative_transfer_args_::NT1

int NT1[2]

NT1 - Number of layers.

Definition: external_interface.h:25

radiative_transfer_args_::T_profile

float T_profile[_NLEVEL_GAS]

T_profile - Temperature profile for each level Only necessary if emission is accounted.

Definition: external_interface.h:51

radiative_transfer_args_::ITRC

bool ITRC

ITRC - Marks if Phase matrix truncation is going to be done.

Definition: external_interface.h:86

radiative_transfer_args_::NBV

int NBV

NBV - Number of observations.

Definition: external_interface.h:27

radiative_transfer_args_::STEMP

float STEMP

STEMP - Surface temperature. Only necesary if emission is accounted.

Definition: external_interface.h:52

radiative_transfer_result_::salb_out

float salb_out

salb_out - Surface albedo

Definition: external_interface.h:108

_NLEVEL_GAS

#define _NLEVEL_GAS

Definition: external_interface.h:13

radiative_transfer_args_::NQDR

int NQDR

NQDR - Number of angular quadrature points.

Definition: external_interface.h:24

radiative_transfer_args_::aerosol_analyt_prof

bool aerosol_analyt_prof

aerosol_analyt_prof - Marks if the the exact aerosol profiles is known or an analytic shape is going ...

Definition: external_interface.h:63

radiative_transfer_args_::IGQ_BRM_HSPH

bool IGQ_BRM_HSPH

IGQ_BRM_HSPH - High precision surface quadrature calculations.

Definition: external_interface.h:83

radiative_transfer_args_::H0

float H0[_KSD][_KVERTM]

H0 - Contains parameters of aerosol vertical distribution or distribution itself.

Definition: external_interface.h:47

radiative_transfer_args_::nh

int nh

nh - Number of layers in the aerosol profile

Definition: external_interface.h:67

radiative_transfer_args_::ATMOS_EMIS

bool ATMOS_EMIS

ATMOS_EMIS - To account for thermal emission.

Definition: external_interface.h:55

radiative_transfer_args_::NLYR

int NLYR[2]

NLYR - Number of layers.

Definition: external_interface.h:98

radiative_transfer_args_::NN

int NN

NN - Number of quadrature expansions.

Definition: external_interface.h:18

radiative_transfer_args_::ISCA

bool ISCA

ISCA - Output in scattering or meridian plane.

Definition: external_interface.h:87

radiative_transfer_args_::surf_water_par_vect

float surf_water_par_vect[_KBF]

surf_water_par_vect - Parameters describing water surface

Definition: external_interface.h:35

radiative_transfer_args_::NANG

int NANG

NANG - number of scattering angles of phase matrix NANG.

Definition: external_interface.h:38

radiative_transfer_args_::PF11_I

float PF11_I[_KSD][_KMpar]

PF11_I - Aerosol phase matrix.

Definition: external_interface.h:57

radiative_transfer_args_::NHVP_retr

int NHVP_retr

NHVP_retr - Number of altitudes for retrieved vertical profile.

Definition: external_interface.h:45

radiative_transfer_args_::IDWN

bool IDWN

IDWN - Marks if the calculations are upwards or downwards.

Definition: external_interface.h:78

radiative_transfer_args_::n_par_water

int n_par_water

n_par_water - number of BRDF surface parameters for water

Definition: external_interface.h:34

radiative_transfer_args_::IVEC_SET

bool IVEC_SET

IVEC_SET - Scalar or vector calculations.

Definition: external_interface.h:88

radiative_transfer_args_::fiv

float fiv[2 *_NBVM]

fiv - Observation Azimuth angle (degrees)

Definition: external_interface.h:29

radiative_transfer_args_::gas_abs_line

bool gas_abs_line

gas_abs_line - Marks if there is gas absorption included (new model)

Definition: external_interface.h:64

radiative_transfer_args_::n_par_land_i

int n_par_land_i

n_par_land_i - number of BRDF surface parameters for land

Definition: external_interface.h:32

radiative_transfer_result_

Definition: external_interface.h:102

radiative_transfer_args_::vis

float vis[2 *_NBVM]

vis - Observation Zenith angle (degrees)

Definition: external_interface.h:28

radiative_transfer_args_::EPS

float EPS

EPS - Related with precision of some numerical expansions.

Definition: external_interface.h:99

radiative_transfer_args_::HMAX_atm_km

float HMAX_atm_km

HMAX_atm_km - Atmosphere maximum altitude.

Definition: external_interface.h:44

radiative_transfer_args_::HLV

float HLV[_KNT]

HLV - Height of levels.

Definition: external_interface.h:62

radiative_transfer_args_::IAER

bool IAER

IAER - Selects if aerosol must be considered.

Definition: external_interface.h:75

radiative_transfer_args_::iBRM_water

int iBRM_water

iBRM_water - Type of water surface model

Definition: external_interface.h:22

radiative_transfer_args_::HOBS_km

float HOBS_km

HOBS_km - Height of observation in km.

Definition: external_interface.h:42

radiative_transfer_args_::SOLAR_EMIS

bool SOLAR_EMIS

SOLAR_EMIS - If emission is accounted it is used to account for solar contribution.

Definition: external_interface.h:56

radiative_transfer_args_::Hight_level_km

float Hight_level_km[MAX(_KVERTM, _KVERT_WD)]

Hight_level_km - Aerosol profile height.

Definition: external_interface.h:66

grasp_rt_sos_

void grasp_rt_sos_(int IW, int NG, int NN, int NF, int iBRDF, int iBPDF, int iBRM_water, float land_percent, int NQDR, int NT1[2], float tetas, int NBV, float vis[2 *_NBVM], float fiv[2 *_NBVM], float WAVE, int n_par_land, int n_par_land_i, float surf_land_par_vect[2 *_KBF], int n_par_water, float surf_water_par_vect[_KBF], float EXT[_NMM+_NMG], float SSA[_NMM+_NMG], int NANG, float ANGL[_KMpar], float SD[_KSD][_KIDIM3], float CEXT[_KSD], float HOBS_km, float HGR_km, float HMAX_atm_km, int NHVP_retr, float HVP_retr_km[_KVERTM], float H0[_KSD][_KVERTM], float sigma_aerosol[_KSD], int ifgas, float gaspar, float T_profile[_NLEVEL_GAS], float STEMP, bool laerosol, bool lsurface, bool ATMOS_EMIS, bool SOLAR_EMIS, float PF11_I[_KSD][_KMpar], float PF12_I[_KSD][_KMpar], float PF22_I[_KSD][_KMpar], float PF33_I[_KSD][_KMpar], int NLV, float HLV[_KNT], bool aerosol_analyt_prof, bool gas_abs_line, int N_level, float Hight_level_km[MAX(_KVERTM, _KVERT_WD)], int nh, float h_km[_KVERT_WD], int natm, int naer, int nmol, int ngas, float norm_DISCRVD[_NMM+_NMG], bool ISGL, bool IAER, bool IVEC_CTL, bool ISRF, bool IDWN, bool IFLX, bool IGQ_F, bool IGQ_D, bool IGQ_BRM_FEXP, bool IGQ_BRM_HSPH, bool IP_VERBOSE, bool IP_ADDITION, bool ITRC, bool ISCA, bool IVEC_SET, bool IWUT, bool ILUT, bool IATM, bool ICRR, bool boa_ref, int AER_PRF, int MOL_PRF, int NA, int NB[_KSD], int NLYR[2], float EPS, float thd[2 *_NBVM], float SLout[2 *_NBVM], float SQout[2 *_NBVM], float SUout[2 *_NBVM], float SLPout[2 *_NBVM], float *salb_out, float UFX[_KNT], float DFX[_KNT])

radiative_transfer_args_::nmol

int nmol

nmol - Number of total molecular components

Definition: external_interface.h:71

radiative_transfer_args_::HVP_retr_km

float HVP_retr_km[_KVERTM]

HVP_retr_km - Altitudes for retrieved vertical profile.

Definition: external_interface.h:46

radiative_transfer_args_::NF

int NF

NF - Maximum number of Fourier terms.

Definition: external_interface.h:19