formod.c File Reference

JURASSIC forward model. More...

#include <limits.h>
#include "jurassic.h"

Go to the source code of this file.

Functions
void	call_formod (ctl_t *ctl, const tbl_t *tbl, const char *wrkdir, const char *obsfile, const char *atmfile, const char *radfile, char task_mode, const char *obsref, int formod_scalar, int batch_size)
	Perform forward model calculations in a single directory. More...
char	parse_task_mode (const char *task)
	Parse the formod task selector and map aliases to an internal task code. More...
int	parse_formod_scalar (int argc, char *argv[])
	Parse the formod execution selector. More...
int	parse_formod_batch_size (int argc, char *argv[])
	Parse the benchmark batch size. More...
void	exec_formod_single (const ctl_t *ctl, const tbl_t *tbl, atm_t *atm, obs_t *obs, los_t *los_scratch, obs_t *obs_scratch, int formod_scalar)
	Execute a single forward model call via the default batch path or the scalar debug path. More...
void	exec_formod_batch_setup (const ctl_t *ctl, const atm_t *atm, const obs_t *obs, int batch_size, atm_t *atm_batch, obs_t *obs_batch)
	Build a batch of randomly perturbed copies of the input atmosphere. More...
void	compute_rel_errors (const ctl_t *ctl, const obs_t *obs_test, const obs_t *obs_ref, double *mre, double *sdre, double *minre, double *maxre)
	Calculate relative errors. More...
void	compute_abs_errors (const ctl_t *ctl, const obs_t *obs_test, const obs_t *obs_ref, double *meanae, double *sdae, double *minae, double *maxae)
	Calculate signed absolute errors in the observation output units. More...
void	exec_formod_profiles (ctl_t *ctl, const tbl_t *tbl, const char *wrkdir, const char *radfile, const atm_t *atm, obs_t *obs, atm_t *atm_scratch, obs_t *obs_single, los_t *los_scratch, obs_t *obs_scratch, int formod_scalar)
	Process observation data profile by profile using time-based matching. More...
void	eval_formod_results (const ctl_t *ctl, const char *wrkdir, const char *obsref, const obs_t *obs, obs_t *obs_ref)
	Print relative-error diagnostics against reference observations. More...
void	exec_formod_contributions (ctl_t *ctl, const tbl_t *tbl, const char *wrkdir, const char *radfile, const atm_t *atm, obs_t *obs, atm_t *atm_scratch, los_t *los_scratch, obs_t *obs_scratch, int formod_scalar)
	Write emitter and extinction contribution outputs. More...
void	exec_formod_benchmark (const ctl_t *ctl, const tbl_t *tbl, const atm_t *atm, obs_t *obs, atm_t *atm_scratch, los_t *los_scratch, obs_t *obs_scratch, int formod_scalar, int batch_size)
	Run the built-in runtime benchmark. More...
void	exec_formod_stepsize (ctl_t *ctl, const tbl_t *tbl, atm_t *atm, obs_t *obs, obs_t *obs_ref, los_t *los_scratch, obs_t *obs_scratch, int formod_scalar)
	Analyze sensitivity to ray-tracing step sizes. More...
void	usage (void)
	Print command-line help. More...
int	main (int argc, char *argv[])

Detailed Description

JURASSIC forward model.

Definition in file formod.c.

Function Documentation

call_formod()

void call_formod	(	ctl_t *	ctl,
		const tbl_t *	tbl,
		const char *	wrkdir,
		const char *	obsfile,
		const char *	atmfile,
		const char *	radfile,
		char	task_mode,
		const char *	obsref,
		int	formod_scalar,
		int	batch_size
	)

Perform forward model calculations in a single directory.

Definition at line 777 of file formod.c.

                  {
 
  static atm_t atm, atm2;
  static obs_t obs, obs2, obs_ref, obs_scratch;
  static los_t los_scratch;
 
  /* Read atmospheric data... */
  SELECT_TIMER("READ_ATM", "INPUT");
  read_atm(wrkdir, atmfile, ctl, &atm, 0);
 
  /* Read observation geometry... */
  SELECT_TIMER("READ_OBS", "INPUT");
  read_obs(wrkdir, obsfile, ctl, &obs, 0);
 
  /* Compute multiple profiles... */
  if (task_mode == 'p') {
    exec_formod_profiles(ctl, tbl, wrkdir, radfile, &atm, &obs, &atm2, &obs2,
                         &los_scratch, &obs_scratch, formod_scalar);
  }
 
  /* Compute single profile... */
  else {
 
    if (task_mode != 't' && batch_size > 1)
      ERRMSG("BATCH_SIZE > 1 is only supported for TASK=time!");
 
    if (task_mode == 't') {
      SELECT_TIMER("FORMOD_REFERENCE", "FORWARD");
    }
    else {
      SELECT_TIMER("FORMOD", "FORWARD");
    }
    exec_formod_single(ctl, tbl, &atm, &obs, &los_scratch, &obs_scratch,
                       formod_scalar);
    SELECT_TIMER("WRITE_OBS", "OUTPUT");
    write_obs(wrkdir, radfile, ctl, &obs, 0);
 
    if (obsref[0] != '-') {
      eval_formod_results(ctl, wrkdir, obsref, &obs, &obs_ref);
    }
 
    if (task_mode == 'c') {
      exec_formod_contributions(ctl, tbl, wrkdir, radfile, &atm, &obs, &atm2,
                                   &los_scratch, &obs_scratch, formod_scalar);
    }
 
    if (task_mode == 't') {
      exec_formod_benchmark(ctl, tbl, &atm, &obs, &atm2, &los_scratch,
                            &obs_scratch, formod_scalar, batch_size);
    }
 
    if (task_mode == 's') {
      exec_formod_stepsize(ctl, tbl, &atm, &obs, &obs_ref, &los_scratch,
                           &obs_scratch, formod_scalar);
    }
  }
}

Here is the call graph for this function:

parse_task_mode()

char parse_task_mode

(

const char *

task

)

Parse the formod task selector and map aliases to an internal task code.

Definition at line 345 of file formod.c.

                    {
 
  if (task[0] == '-' || strcmp(task, "forward") == 0)
    return 'f';
  if (task[0] == 'c' || strcmp(task, "contrib") == 0
      || strcmp(task, "contributions") == 0)
    return 'c';
  if (task[0] == 'p' || strcmp(task, "profile") == 0
      || strcmp(task, "profiles") == 0)
    return 'p';
  if (task[0] == 's' || strcmp(task, "stepsize") == 0)
    return 's';
  if (task[0] == 't' || strcmp(task, "time") == 0
      || strcmp(task, "benchmark") == 0)
    return 't';
 
  ERRMSG("Unknown TASK '%s'!", task);
  return 'f';
}

parse_formod_scalar()

int parse_formod_scalar	(	int	argc,
		char *	argv[]
	)

Parse the formod execution selector.

Definition at line 368 of file formod.c.

                {
 
  char execution[LEN];
  scan_ctl(argc, argv, "EXECUTION", -1, "batch", execution);
 
  if (strcmp(execution, "batch") == 0)
    return 0;
  if (strcmp(execution, "scalar") == 0)
    return 1;
 
  ERRMSG("Unknown EXECUTION '%s'!", execution);
  return 0;
}

Here is the call graph for this function:

parse_formod_batch_size()

int parse_formod_batch_size	(	int	argc,
		char *	argv[]
	)

Parse the benchmark batch size.

Definition at line 386 of file formod.c.

                {
 
  const int batch_size =
    (int) scan_ctl(argc, argv, "BATCH_SIZE", -1, "1", NULL);
 
  if (batch_size < 1)
    ERRMSG("BATCH_SIZE must be positive!");
 
  return batch_size;
}

Here is the call graph for this function:

exec_formod_single()

void exec_formod_single	(	const ctl_t *	ctl,
		const tbl_t *	tbl,
		atm_t *	atm,
		obs_t *	obs,
		los_t *	los_scratch,
		obs_t *	obs_scratch,
		int	formod_scalar
	)

Execute a single forward model call via the default batch path or the scalar debug path.

Definition at line 401 of file formod.c.

                     {
 
  if (formod_scalar) {
    const int status = formod(ctl, tbl, atm, obs, los_scratch, obs_scratch);
    if (status != FORMOD_STATUS_OK)
      ERRMSG("Forward model failed with status code %d!", status);
    return;
  }
 
  int status[1];
  formod_batch(ctl, tbl, atm, obs, 1, status, los_scratch, obs_scratch);
  if (status[0] != FORMOD_STATUS_OK)
    ERRMSG("Forward model failed with status code %d!", status[0]);
}

Here is the call graph for this function:

exec_formod_batch_setup()

void exec_formod_batch_setup	(	const ctl_t *	ctl,
		const atm_t *	atm,
		const obs_t *	obs,
		int	batch_size,
		atm_t *	atm_batch,
		obs_t *	obs_batch
	)

Build a batch of randomly perturbed copies of the input atmosphere.

Definition at line 567 of file formod.c.

                    {
 
  double *dtemp, *dpress, *dq;
  ALLOC(dtemp, double,
        batch_size);
  ALLOC(dpress, double,
        batch_size);
  ALLOC(dq, double,
        batch_size * NG);
 
  /* Draw perturbations (the first case stays unperturbed)... */
  gsl_rng_env_setup();
  gsl_rng *rng = gsl_rng_alloc(gsl_rng_default);
  gsl_rng_set(rng, 0UL);
  for (int ib = 0; ib < batch_size; ib++) {
    dtemp[ib] = 0;
    dpress[ib] = 1;
    for (int ig = 0; ig < ctl->ng; ig++)
      dq[ib * NG + ig] = 1;
    if (ib == 0)
      continue;
    dtemp[ib] = 40.0 * (gsl_rng_uniform(rng) - 0.5);
    dpress[ib] = 1.0 - 0.1 * gsl_rng_uniform(rng);
    for (int ig = 0; ig < ctl->ng; ig++)
      dq[ib * NG + ig] = 0.8 + 0.4 * gsl_rng_uniform(rng);
  }
  gsl_rng_free(rng);
 
  /* Apply perturbations... */
#pragma omp parallel for schedule(static)
  for (int ib = 0; ib < batch_size; ib++) {
    atm_batch[ib] = *atm;
    obs_batch[ib] = *obs;
    for (int ip = 0; ip < atm_batch[ib].np; ip++) {
      atm_batch[ib].t[ip] += dtemp[ib];
      atm_batch[ib].p[ip] *= dpress[ib];
      for (int ig = 0; ig < ctl->ng; ig++)
        atm_batch[ib].q[ig][ip] *= dq[ib * NG + ig];
    }
  }
 
  /* Free... */
  free(dtemp);
  free(dpress);
  free(dq);
}

compute_rel_errors()

void compute_rel_errors	(	const ctl_t *	ctl,
		const obs_t *	obs_test,
		const obs_t *	obs_ref,
		double *	mre,
		double *	sdre,
		double *	minre,
		double *	maxre
	)

Calculate relative errors.

Definition at line 847 of file formod.c.

                 {
 
  /* Loop over channels... */
  for (int id = 0; id < ctl->nd; id++) {
 
    double sum = 0, sum2 = 0;
    minre[id] = +1e9;
    maxre[id] = -1e9;
    int n = 0;
 
    /* Loop over ray paths... */
    for (int ir = 0; ir < obs_test->nr; ir++) {
 
      /* Skip invalid pairs and zero references... */
      if (!isfinite(obs_test->rad[id][ir])
          || !isfinite(obs_ref->rad[id][ir])
          || obs_ref->rad[id][ir] == 0)
        continue;
 
      /* Calculate relative error... */
      double err = 100.0 * (obs_test->rad[id][ir] - obs_ref->rad[id][ir])
        / obs_ref->rad[id][ir];
 
      /* Get statistics... */
      sum += err;
      sum2 += err * err;
      if (err > maxre[id])
        maxre[id] = err;
      if (err < minre[id])
        minre[id] = err;
      n++;
    }
 
    /* Get mean and standard deviation... */
    if (n > 0) {
      mre[id] = sum / n;
      sdre[id] = sqrt(fmax(0, sum2 / n - mre[id] * mre[id]));
    } else
      mre[id] = sdre[id] = minre[id] = maxre[id] = NAN;
  }
}

compute_abs_errors()

void compute_abs_errors	(	const ctl_t *	ctl,
		const obs_t *	obs_test,
		const obs_t *	obs_ref,
		double *	meanae,
		double *	sdae,
		double *	minae,
		double *	maxae
	)

Calculate signed absolute errors in the observation output units.

Definition at line 898 of file formod.c.

                 {
 
  /* Loop over channels... */
  for (int id = 0; id < ctl->nd; id++) {
 
    double sum = 0, sum2 = 0;
    minae[id] = +1e100;
    maxae[id] = -1e100;
    int n = 0;
 
    /* Loop over ray paths... */
    for (int ir = 0; ir < obs_test->nr; ir++) {
 
      /* Skip invalid pairs... */
      if (!isfinite(obs_test->rad[id][ir])
          || !isfinite(obs_ref->rad[id][ir]))
        continue;
 
      /* Calculate signed absolute error in the observation output units... */
      double err = obs_test->rad[id][ir] - obs_ref->rad[id][ir];
 
      /* Get statistics... */
      sum += err;
      sum2 += err * err;
      if (err > maxae[id])
        maxae[id] = err;
      if (err < minae[id])
        minae[id] = err;
      n++;
    }
 
    /* Get mean and standard deviation... */
    if (n > 0) {
      meanae[id] = sum / n;
      sdae[id] = sqrt(fmax(0, sum2 / n - meanae[id] * meanae[id]));
    } else
      meanae[id] = sdae[id] = minae[id] = maxae[id] = NAN;
  }
}

exec_formod_profiles()

void exec_formod_profiles	(	ctl_t *	ctl,
		const tbl_t *	tbl,
		const char *	wrkdir,
		const char *	radfile,
		const atm_t *	atm,
		obs_t *	obs,
		atm_t *	atm_scratch,
		obs_t *	obs_single,
		los_t *	los_scratch,
		obs_t *	obs_scratch,
		int	formod_scalar
	)

Process observation data profile by profile using time-based matching.

Definition at line 425 of file formod.c.

                     {
 
  SELECT_TIMER("FORMOD_PROFILE_LOOP", "FORWARD");
 
  for (int ir = 0; ir < obs->nr; ir++) {
 
    atm_scratch->np = 0;
    for (int ip = 0; ip < atm->np; ip++)
      if (atm->time[ip] == obs->time[ir]) {
        atm_scratch->time[atm_scratch->np] = atm->time[ip];
        atm_scratch->z[atm_scratch->np] = atm->z[ip];
        atm_scratch->lon[atm_scratch->np] = atm->lon[ip];
        atm_scratch->lat[atm_scratch->np] = atm->lat[ip];
        atm_scratch->p[atm_scratch->np] = atm->p[ip];
        atm_scratch->t[atm_scratch->np] = atm->t[ip];
        for (int ig = 0; ig < ctl->ng; ig++)
          atm_scratch->q[ig][atm_scratch->np] = atm->q[ig][ip];
        for (int iw = 0; iw < ctl->nw; iw++)
          atm_scratch->k[iw][atm_scratch->np] = atm->k[iw][ip];
        atm_scratch->np++;
      }
 
    obs_single->nr = 1;
    obs_single->time[0] = obs->time[ir];
    obs_single->vpz[0] = obs->vpz[ir];
    obs_single->vplon[0] = obs->vplon[ir];
    obs_single->vplat[0] = obs->vplat[ir];
    obs_single->obsz[0] = obs->obsz[ir];
    obs_single->obslon[0] = obs->obslon[ir];
    obs_single->obslat[0] = obs->obslat[ir];
 
    if (atm_scratch->np > 0) {
      exec_formod_single(ctl, tbl, atm_scratch, obs_single, los_scratch,
                         obs_scratch, formod_scalar);
 
      for (int id = 0; id < ctl->nd; id++) {
        obs->rad[id][ir] = obs_single->rad[id][0];
        obs->tau[id][ir] = obs_single->tau[id][0];
      }
    }
  }
 
  SELECT_TIMER("WRITE_OBS", "OUTPUT");
  write_obs(wrkdir, radfile, ctl, obs, 0);
}

Here is the call graph for this function:

eval_formod_results()

void eval_formod_results	(	const ctl_t *	ctl,
		const char *	wrkdir,
		const char *	obsref,
		const obs_t *	obs,
		obs_t *	obs_ref
	)

Print relative-error diagnostics against reference observations.

Definition at line 484 of file formod.c.

                  {
 
  SELECT_TIMER("EVAL", "OUTPUT");
 
  read_obs(wrkdir, obsref, ctl, obs_ref, 0);
 
  double mre[ND], sdre[ND], minre[ND], maxre[ND];
  double meanae[ND], sdae[ND], minae[ND], maxae[ND];
  compute_rel_errors(ctl, obs, obs_ref, mre, sdre, minre, maxre);
  compute_abs_errors(ctl, obs, obs_ref, meanae, sdae, minae, maxae);
 
  for (int id = 0; id < ctl->nd; id++) {
    printf
      ("EVAL: nu= %.4f cm^-1 | MeanRE= %g %% | SDRE= %g %% | MinRE= %g %% | MaxRE= %g %%\n",
         ctl->nu[id], mre[id], sdre[id], minre[id], maxre[id]);
    printf
      ("EVAL: nu= %.4f cm^-1 | MeanAE= %g | SDAE= %g | MinAE= %g | MaxAE= %g\n",
         ctl->nu[id], meanae[id], sdae[id], minae[id], maxae[id]);
  }
}

Here is the call graph for this function:

exec_formod_contributions()

void exec_formod_contributions	(	ctl_t *	ctl,
		const tbl_t *	tbl,
		const char *	wrkdir,
		const char *	radfile,
		const atm_t *	atm,
		obs_t *	obs,
		atm_t *	atm_scratch,
		los_t *	los_scratch,
		obs_t *	obs_scratch,
		int	formod_scalar
	)

Write emitter and extinction contribution outputs.

Definition at line 512 of file formod.c.

                     {
 
  char filename[LEN];
 
  SELECT_TIMER("CONTRIBUTIONS", "FORWARD");
 
  ctl->ctm_co2 = 0;
  ctl->ctm_h2o = 0;
  ctl->ctm_n2 = 0;
  ctl->ctm_o2 = 0;
 
  for (int ig = 0; ig < ctl->ng; ig++) {
    copy_atm(ctl, atm_scratch, atm, 0);
 
    for (int iw = 0; iw < ctl->nw; iw++)
      for (int ip = 0; ip < atm_scratch->np; ip++)
        atm_scratch->k[iw][ip] = 0;
 
    for (int ig2 = 0; ig2 < ctl->ng; ig2++)
      if (ig2 != ig)
        for (int ip = 0; ip < atm_scratch->np; ip++)
          atm_scratch->q[ig2][ip] = 0;
 
    exec_formod_single(ctl, tbl, atm_scratch, obs, los_scratch,
                       obs_scratch, formod_scalar);
 
    sprintf(filename, "%s.%s", radfile, ctl->emitter[ig]);
    write_obs(wrkdir, filename, ctl, obs, 0);
  }
 
  copy_atm(ctl, atm_scratch, atm, 0);
 
  for (int ig = 0; ig < ctl->ng; ig++)
    for (int ip = 0; ip < atm_scratch->np; ip++)
      atm_scratch->q[ig][ip] = 0;
 
  exec_formod_single(ctl, tbl, atm_scratch, obs, los_scratch, obs_scratch,
                     formod_scalar);
 
  sprintf(filename, "%s.EXTINCT", radfile);
  write_obs(wrkdir, filename, ctl, obs, 0);
}

Here is the call graph for this function:

exec_formod_benchmark()

void exec_formod_benchmark	(	const ctl_t *	ctl,
		const tbl_t *	tbl,
		const atm_t *	atm,
		obs_t *	obs,
		atm_t *	atm_scratch,
		los_t *	los_scratch,
		obs_t *	obs_scratch,
		int	formod_scalar,
		int	batch_size
	)

Run the built-in runtime benchmark.

Definition at line 622 of file formod.c.

                  {
 
  double t_min = 0, t_max = 0, t_mean = 0, t_sd = 0;
  int n = 0;
 
  gsl_rng_env_setup();
  gsl_rng *rng = gsl_rng_alloc(gsl_rng_default);
 
  if (formod_scalar && batch_size > 1)
    ERRMSG("BATCH_SIZE > 1 cannot be combined with EXECUTION scalar!");
 
  /* Set up the batch and run it once untimed (warm-up)... */
  atm_t *atm_batch = NULL;
  obs_t *obs_batch = NULL;
  int *status = NULL;
  los_t *los_batch = NULL;
  obs_t *obs_scratch_batch = NULL;
  if (batch_size > 1) {
    ALLOC(atm_batch, atm_t, batch_size);
    ALLOC(obs_batch, obs_t, batch_size);
    ALLOC(los_batch, los_t, batch_size);
    ALLOC(obs_scratch_batch, obs_t, batch_size);
    ALLOC(status, int,
          batch_size);
 
    SELECT_TIMER("BENCHMARK_SETUP", "OVERHEAD");
    exec_formod_batch_setup(ctl, atm, obs, batch_size, atm_batch, obs_batch);
    formod_batch(ctl, tbl, atm_batch, obs_batch, batch_size, status,
                 los_batch, obs_scratch_batch);
  }
 
  /* Stop after JURASSIC_MAX_ITER samples or JURASSIC_TIME_BUDGET seconds... */
  const char *env_max_iter = getenv("JURASSIC_MAX_ITER");
  const int max_iter = env_max_iter ? atoi(env_max_iter) : INT_MAX;
  const char *env_budget = getenv("JURASSIC_TIME_BUDGET");
  const double t_budget = env_budget ? atof(env_budget) : 10.0;
 
  do {
    SELECT_TIMER("BENCHMARK_SAMPLE", "ANALYSIS");
    double dt;
 
    if (batch_size > 1) {
      const double t0 = omp_get_wtime();
      formod_batch(ctl, tbl, atm_batch, obs_batch, batch_size, status,
                   los_batch, obs_scratch_batch);
      dt = omp_get_wtime() - t0;
      for (int ib = 0; ib < batch_size; ib++)
        if (status[ib] != FORMOD_STATUS_OK)
          ERRMSG("Batch benchmark failed with status %d at element %d!",
                 status[ib], ib);
    } else {
      copy_atm(ctl, atm_scratch, atm, 0);
      const double dtemp = 40. * (gsl_rng_uniform(rng) - 0.5);
      const double dpress = 1. - 0.1 * gsl_rng_uniform(rng);
      double dq[NG];
      for (int ig = 0; ig < ctl->ng; ig++)
        dq[ig] = 0.8 + 0.4 * gsl_rng_uniform(rng);
      for (int ip = 0; ip < atm_scratch->np; ip++) {
        atm_scratch->t[ip] += dtemp;
        atm_scratch->p[ip] *= dpress;
        for (int ig = 0; ig < ctl->ng; ig++)
          atm_scratch->q[ig][ip] *= dq[ig];
      }
 
      const double t0 = omp_get_wtime();
      exec_formod_single(ctl, tbl, atm_scratch, obs, los_scratch,
                         obs_scratch, formod_scalar);
      dt = omp_get_wtime() - t0;
    }
 
    t_mean += dt;
    t_sd += POW2(dt);
    if (n == 0 || dt < t_min)
      t_min = dt;
    if (n == 0 || dt > t_max)
      t_max = dt;
    n++;
 
  } while (t_mean < t_budget && n < max_iter);
 
  /* Free... */
  if (batch_size > 1) {
    free(status);
    free(obs_scratch_batch);
    free(los_batch);
    free(obs_batch);
    free(atm_batch);
  }
 
  /* Write results... */
  t_mean /= (double) n;
  t_sd = sqrt(t_sd / (double) n - POW2(t_mean));
  printf("RUNTIME: execution= %s | threads= %d | batch_size= %d | mean= %g s"
         " | stddev= %g s | min= %g s | max= %g s | per_model= %g s"
         " | throughput= %g models/s | samples= %d\n",
         formod_scalar ? "scalar" : "batch", omp_get_max_threads(),
         batch_size, t_mean, t_sd, t_min, t_max,
         t_mean / batch_size, batch_size / t_mean, n);
 
  gsl_rng_free(rng);
}

Here is the call graph for this function:

exec_formod_stepsize()

void exec_formod_stepsize	(	ctl_t *	ctl,
		const tbl_t *	tbl,
		atm_t *	atm,
		obs_t *	obs,
		obs_t *	obs_ref,
		los_t *	los_scratch,
		obs_t *	obs_scratch,
		int	formod_scalar
	)

Analyze sensitivity to ray-tracing step sizes.

Definition at line 735 of file formod.c.

                     {
 
  SELECT_TIMER("STEP_ANALYSIS", "ANALYSIS");
 
  ctl->rayds = 0.1;
  ctl->raydz = 0.01;
  exec_formod_single(ctl, tbl, atm, obs, los_scratch, obs_scratch,
                     formod_scalar);
  copy_obs(ctl, obs_ref, obs, 0);
 
  for (double dz = 0.01; dz <= 2; dz *= 1.1)
    for (double ds = 0.1; ds <= 50; ds *= 1.1) {
      ctl->rayds = ds;
      ctl->raydz = dz;
 
      double t0 = omp_get_wtime();
      exec_formod_single(ctl, tbl, atm, obs, los_scratch,
                         obs_scratch, formod_scalar);
      double dt = omp_get_wtime() - t0;
 
      double mre[ND], sdre[ND], minre[ND], maxre[ND];
      compute_rel_errors(ctl, obs, obs_ref, mre, sdre, minre, maxre);
 
      for (int id = 0; id < ctl->nd; id++)
        printf
          ("STEPSIZE: ds= %.4f km | dz= %g km | t= %g s | nu= %.4f cm^-1"
           " | MeanRE= %g %% | SDRE= %g %% | MinRE= %g %% | MaxRE= %g %%\n",
           ds, dz, dt, ctl->nu[id], mre[id], sdre[id], minre[id],
           maxre[id]);
    }
}

Here is the call graph for this function:

usage()

static void usage

(

void

)

Print command-line help.

Definition at line 273 of file formod.c.

        {
 
  printf("\nJURASSIC forward model.\n\n");
  printf
    ("Compute simulated radiances or transmittances for the configured\n");
  printf
    ("channels from observation geometry, atmospheric state, and control\n");
  printf("settings.\n\n");
  printf("Usage:\n");
  printf("  formod <ctl> <obs> <atm> <rad> [KEY VALUE ...]\n\n");
  printf("Arguments:\n");
  printf("  <ctl>  Control file.\n");
  printf("  <obs>  Observation geometry input file.\n");
  printf("  <atm>  Atmospheric state input file.\n");
  printf("  <rad>  Output file for simulated radiances or transmittances.\n");
  printf("  [KEY VALUE]  Optional control parameters.\n\n");
  printf("Tool-specific control parameters:\n");
  printf("  TASK <name>      Select the operation mode.\n");
  printf
    ("                   forward or omitted: regular forward-model simulation.\n");
  printf
    ("                   contrib: write separate outputs for individual emitter\n");
  printf("                      extinction contributions.\n");
  printf
    ("                   profiles: process observation data profile by profile,\n");
  printf
    ("                      matching each profile to the corresponding\n");
  printf("                      atmospheric profile by time.\n");
  printf
    ("                   stepsize: analyze sensitivity to ray-tracing step\n");
  printf("                      sizes.\n");
  printf
    ("                   time: run the built-in runtime benchmark using\n");
  printf
    ("                      perturbed versions of the input atmosphere.\n");
  printf
    ("  DIRLIST <file>   Read working directories from <file> and run one case\n");
  printf
    ("                   per directory using the same <obs>, <atm>, and <rad>\n");
  printf("                   filenames relative to each listed directory.\n");
  printf
    ("  OBSREF <file>    Read reference observations from <file> and print\n");
  printf
    ("                   relative and signed absolute-error diagnostics against\n");
  printf
    ("                   the simulated output.\n");
  printf
    ("  EXECUTION <mode> Select execution backend: batch (default) or scalar.\n");
  printf
    ("  BATCH_SIZE <n>   Batch size for TASK=time with EXECUTION=batch.\n");
  printf("\n");
  printf("Common control parameters:\n");
  printf
    ("  TBLBASE, TBLFMT               Lookup-table base name and format.\n");
  printf
    ("  ATMFMT, OBSFMT                Atmospheric and observation file formats.\n");
  printf("  NG, EMITTER[i]                Active emitters.\n");
  printf("  ND, NU[i], NW, WINDOW[i]      Spectral channels and windows.\n");
  printf
    ("  NCL, CLNU[i], NSF, SFNU[i]    Cloud and surface spectral grids.\n");
  printf
    ("  WRITE_BBT, FORMOD             Output units and forward-model selection.\n");
  printf("  CTM_*, REFRAC                 Continua and refractivity.\n");
  printf
    ("  RAYDS, RAYDZ, FOV             Ray tracing and field of view.\n\n");
  printf("Further information:\n");
  printf("  Manual: https://slcs-jsc.github.io/jurassic/\n");
}

main()

int main	(	int	argc,
		char *	argv[]
	)

Definition at line 168 of file formod.c.

                {
 
  static ctl_t ctl;
 
  /* Print usage information... */
  USAGE;
 
  /* Check arguments... */
  if (argc < 5)
    ERRMSG("Missing or invalid command-line arguments.\n\n"
           "Usage: formod <ctl> <obs> <atm> <rad> [KEY VALUE ...]\n\n"
           "Use -h for full help.");
 
  /* Read control parameters... */
  SELECT_TIMER("READ_CTL", "INPUT");
  read_ctl(argc, argv, &ctl);
 
#ifdef UNIFIED
 
  static atm_t atm;
  static obs_t obs;
 
  /* Read observation geometry... */
  SELECT_TIMER("READ_OBS", "INPUT");
  read_obs(NULL, argv[2], &ctl, &obs, 0);
 
  /* Read atmospheric data... */
  SELECT_TIMER("READ_ATM", "INPUT");
  read_atm(NULL, argv[3], &ctl, &atm, 0);
 
  /* Call forward model... */
  SELECT_TIMER("FORMOD_UNIFIED", "FORWARD");
  jur_unified_init(argc, argv);
  jur_unified_formod_multiple_packages(&atm, &obs, 1, NULL);
 
  /* Save radiance data... */
  SELECT_TIMER("WRITE_OBS", "OUTPUT");
  write_obs(NULL, argv[4], &ctl, &obs, 0);
 
#else
 
  char dirlist[LEN], obsref[LEN], task[LEN];
  const int formod_scalar = parse_formod_scalar(argc, argv);
  const int batch_size = parse_formod_batch_size(argc, argv);
 
  /* Initialize look-up tables... */
  SELECT_TIMER("READ_TBL", "INPUT");
  tbl_t *tbl = read_tbl(&ctl);
 
  /* Get task... */
  SELECT_TIMER("READ_TASK", "INPUT");
  scan_ctl(argc, argv, "TASK", -1, "forward", task);
  const char task_mode = parse_task_mode(task);
 
  /* Get dirlist... */
  SELECT_TIMER("READ_DIRLIST", "INPUT");
  scan_ctl(argc, argv, "DIRLIST", -1, "-", dirlist);
 
  /* Get reference data... */
  SELECT_TIMER("READ_OBSREF", "INPUT");
  scan_ctl(argc, argv, "OBSREF", -1, "-", obsref);
 
  /* Single forward calculation... */
  if (dirlist[0] == '-')
    call_formod(&ctl, tbl, NULL, argv[2], argv[3], argv[4], task_mode, obsref,
                formod_scalar, batch_size);
 
  /* Work on directory list... */
  else {
 
    /* Open directory list... */
    FILE *in;
    if (!(in = fopen(dirlist, "r")))
      ERRMSG("Cannot open directory list!");
 
    /* Loop over directories... */
    char wrkdir[LEN];
    while (fscanf(in, "%4999s", wrkdir) != EOF) {
 
      /* Write info... */
      LOG(1, "\nWorking directory: %s", wrkdir);
 
      /* Call forward model... */
      call_formod(&ctl, tbl, wrkdir, argv[2], argv[3], argv[4], task_mode,
                  obsref, formod_scalar, batch_size);
    }
 
    /* Close dirlist... */
    fclose(in);
  }
 
#endif
 
  /* Free... */
  SELECT_TIMER("FINALIZE", "OVERHEAD");
  tbl_free(&ctl, tbl);
  PRINT_TIMERS;
 
  return EXIT_SUCCESS;
}

Here is the call graph for this function: