JURASSIC
Data Fields
ret_t Struct Reference

Retrieval control parameters. More...

#include <jurassic.h>

Data Fields

char dir [LEN]
 Working directory. More...
 
int kernel_recomp
 Re-computation of kernel matrix (number of iterations). More...
 
int conv_itmax
 Maximum number of iterations. More...
 
double conv_dmin
 Minimum normalized step size in state space. More...
 
int err_ana
 Carry out error analysis (0=no, 1=yes). More...
 
double err_formod [ND]
 Forward model error [%]. More...
 
double err_noise [ND]
 Noise error [W/(m^2 sr cm^-1)]. More...
 
double err_press
 Pressure error [%]. More...
 
double err_press_cz
 Vertical correlation length for pressure error [km]. More...
 
double err_press_ch
 Horizontal correlation length for pressure error [km]. More...
 
double err_temp
 Temperature error [K]. More...
 
double err_temp_cz
 Vertical correlation length for temperature error [km]. More...
 
double err_temp_ch
 Horizontal correlation length for temperature error [km]. More...
 
double err_q [NG]
 Volume mixing ratio error [%]. More...
 
double err_q_cz [NG]
 Vertical correlation length for volume mixing ratio error [km]. More...
 
double err_q_ch [NG]
 Horizontal correlation length for volume mixing ratio error [km]. More...
 
double err_k [NW]
 Extinction error [km^-1]. More...
 
double err_k_cz [NW]
 Vertical correlation length for extinction error [km]. More...
 
double err_k_ch [NW]
 Horizontal correlation length for extinction error [km]. More...
 
double err_clz
 Cloud height error [km]. More...
 
double err_cldz
 Cloud depth error [km]. More...
 
double err_clk [NCL]
 Cloud extinction error [km^-1]. More...
 
double err_sft
 Surface temperature error [K]. More...
 
double err_sfeps [NSF]
 Surface emissivity error. More...
 
int shared_io_profile
 Profile index used for shared netCDF retrieval inputs and outputs. More...
 
char shared_io_proflist [LEN]
 Optional file containing retrieval profile indices. More...
 
char shared_io_atm_apr_file [LEN]
 Optional shared atmospheric a priori input file. More...
 
char shared_io_obs_meas_file [LEN]
 Optional shared measured-observation input file. More...
 
char shared_io_atm_final_file [LEN]
 Optional shared retrieved-atmosphere output file. More...
 
char shared_io_obs_final_file [LEN]
 Optional shared retrieved-observation output file. More...
 
char shared_io_matrix_cov_apr_file [LEN]
 Optional shared a priori covariance output file. More...
 
char shared_io_matrix_kernel_file [LEN]
 Optional shared kernel matrix output file. More...
 
char shared_io_matrix_cov_ret_file [LEN]
 Optional shared retrieval covariance output file. More...
 
char shared_io_matrix_corr_file [LEN]
 Optional shared correlation matrix output file. More...
 
char shared_io_matrix_gain_file [LEN]
 Optional shared gain matrix output file. More...
 
char shared_io_matrix_avk_file [LEN]
 Optional shared averaging-kernel matrix output file. More...
 
char shared_io_atm_err_total_file [LEN]
 Optional shared total retrieval-error output file. More...
 
char shared_io_atm_err_noise_file [LEN]
 Optional shared noise retrieval-error output file. More...
 
char shared_io_atm_err_formod_file [LEN]
 Optional shared forward-model retrieval-error output file. More...
 
char shared_io_atm_cont_file [LEN]
 Optional shared averaging-kernel contribution output file. More...
 
char shared_io_atm_res_file [LEN]
 Optional shared averaging-kernel resolution output file. More...
 

Detailed Description

Retrieval control parameters.

The ret_t structure holds all parameters controlling the iterative inversion process (retrieval), including convergence criteria, kernel matrix updates, and uncertainty specifications for each retrieved quantity (pressure, temperature, trace gas concentrations, extinction, cloud, and surface parameters).

Definition at line 1732 of file jurassic.h.

Field Documentation

◆ dir

char ret_t::dir[LEN]

Working directory.

Definition at line 1735 of file jurassic.h.

◆ kernel_recomp

int ret_t::kernel_recomp

Re-computation of kernel matrix (number of iterations).

Definition at line 1738 of file jurassic.h.

◆ conv_itmax

int ret_t::conv_itmax

Maximum number of iterations.

Definition at line 1741 of file jurassic.h.

◆ conv_dmin

double ret_t::conv_dmin

Minimum normalized step size in state space.

Definition at line 1744 of file jurassic.h.

◆ err_ana

int ret_t::err_ana

Carry out error analysis (0=no, 1=yes).

Definition at line 1747 of file jurassic.h.

◆ err_formod

double ret_t::err_formod[ND]

Forward model error [%].

Definition at line 1750 of file jurassic.h.

◆ err_noise

double ret_t::err_noise[ND]

Noise error [W/(m^2 sr cm^-1)].

Definition at line 1753 of file jurassic.h.

◆ err_press

double ret_t::err_press

Pressure error [%].

Definition at line 1756 of file jurassic.h.

◆ err_press_cz

double ret_t::err_press_cz

Vertical correlation length for pressure error [km].

Definition at line 1759 of file jurassic.h.

◆ err_press_ch

double ret_t::err_press_ch

Horizontal correlation length for pressure error [km].

Definition at line 1762 of file jurassic.h.

◆ err_temp

double ret_t::err_temp

Temperature error [K].

Definition at line 1765 of file jurassic.h.

◆ err_temp_cz

double ret_t::err_temp_cz

Vertical correlation length for temperature error [km].

Definition at line 1768 of file jurassic.h.

◆ err_temp_ch

double ret_t::err_temp_ch

Horizontal correlation length for temperature error [km].

Definition at line 1771 of file jurassic.h.

◆ err_q

double ret_t::err_q[NG]

Volume mixing ratio error [%].

Definition at line 1774 of file jurassic.h.

◆ err_q_cz

double ret_t::err_q_cz[NG]

Vertical correlation length for volume mixing ratio error [km].

Definition at line 1777 of file jurassic.h.

◆ err_q_ch

double ret_t::err_q_ch[NG]

Horizontal correlation length for volume mixing ratio error [km].

Definition at line 1780 of file jurassic.h.

◆ err_k

double ret_t::err_k[NW]

Extinction error [km^-1].

Definition at line 1783 of file jurassic.h.

◆ err_k_cz

double ret_t::err_k_cz[NW]

Vertical correlation length for extinction error [km].

Definition at line 1786 of file jurassic.h.

◆ err_k_ch

double ret_t::err_k_ch[NW]

Horizontal correlation length for extinction error [km].

Definition at line 1789 of file jurassic.h.

◆ err_clz

double ret_t::err_clz

Cloud height error [km].

Definition at line 1792 of file jurassic.h.

◆ err_cldz

double ret_t::err_cldz

Cloud depth error [km].

Definition at line 1795 of file jurassic.h.

◆ err_clk

double ret_t::err_clk[NCL]

Cloud extinction error [km^-1].

Definition at line 1798 of file jurassic.h.

◆ err_sft

double ret_t::err_sft

Surface temperature error [K].

Definition at line 1801 of file jurassic.h.

◆ err_sfeps

double ret_t::err_sfeps[NSF]

Surface emissivity error.

Definition at line 1804 of file jurassic.h.

◆ shared_io_profile

int ret_t::shared_io_profile

Profile index used for shared netCDF retrieval inputs and outputs.

Definition at line 1807 of file jurassic.h.

◆ shared_io_proflist

char ret_t::shared_io_proflist[LEN]

Optional file containing retrieval profile indices.

Definition at line 1810 of file jurassic.h.

◆ shared_io_atm_apr_file

char ret_t::shared_io_atm_apr_file[LEN]

Optional shared atmospheric a priori input file.

Definition at line 1813 of file jurassic.h.

◆ shared_io_obs_meas_file

char ret_t::shared_io_obs_meas_file[LEN]

Optional shared measured-observation input file.

Definition at line 1816 of file jurassic.h.

◆ shared_io_atm_final_file

char ret_t::shared_io_atm_final_file[LEN]

Optional shared retrieved-atmosphere output file.

Definition at line 1819 of file jurassic.h.

◆ shared_io_obs_final_file

char ret_t::shared_io_obs_final_file[LEN]

Optional shared retrieved-observation output file.

Definition at line 1822 of file jurassic.h.

◆ shared_io_matrix_cov_apr_file

char ret_t::shared_io_matrix_cov_apr_file[LEN]

Optional shared a priori covariance output file.

Definition at line 1825 of file jurassic.h.

◆ shared_io_matrix_kernel_file

char ret_t::shared_io_matrix_kernel_file[LEN]

Optional shared kernel matrix output file.

Definition at line 1828 of file jurassic.h.

◆ shared_io_matrix_cov_ret_file

char ret_t::shared_io_matrix_cov_ret_file[LEN]

Optional shared retrieval covariance output file.

Definition at line 1831 of file jurassic.h.

◆ shared_io_matrix_corr_file

char ret_t::shared_io_matrix_corr_file[LEN]

Optional shared correlation matrix output file.

Definition at line 1834 of file jurassic.h.

◆ shared_io_matrix_gain_file

char ret_t::shared_io_matrix_gain_file[LEN]

Optional shared gain matrix output file.

Definition at line 1837 of file jurassic.h.

◆ shared_io_matrix_avk_file

char ret_t::shared_io_matrix_avk_file[LEN]

Optional shared averaging-kernel matrix output file.

Definition at line 1840 of file jurassic.h.

◆ shared_io_atm_err_total_file

char ret_t::shared_io_atm_err_total_file[LEN]

Optional shared total retrieval-error output file.

Definition at line 1843 of file jurassic.h.

◆ shared_io_atm_err_noise_file

char ret_t::shared_io_atm_err_noise_file[LEN]

Optional shared noise retrieval-error output file.

Definition at line 1846 of file jurassic.h.

◆ shared_io_atm_err_formod_file

char ret_t::shared_io_atm_err_formod_file[LEN]

Optional shared forward-model retrieval-error output file.

Definition at line 1849 of file jurassic.h.

◆ shared_io_atm_cont_file

char ret_t::shared_io_atm_cont_file[LEN]

Optional shared averaging-kernel contribution output file.

Definition at line 1852 of file jurassic.h.

◆ shared_io_atm_res_file

char ret_t::shared_io_atm_res_file[LEN]

Optional shared averaging-kernel resolution output file.

Definition at line 1855 of file jurassic.h.


The documentation for this struct was generated from the following file: