climatology.c

Go to the documentation of this file.

/*
  This file is part of JURASSIC.
  
  JURASSIC is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
  
  JURASSIC is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with JURASSIC. If not, see <http://www.gnu.org/licenses/>.
  
  Copyright (C) 2003-2026 Forschungszentrum Juelich GmbH
*/
 
#include "jurassic.h"
 
/* ------------------------------------------------------------
   Functions...
   ------------------------------------------------------------ */
 
static void usage(
  void);
 
/* ------------------------------------------------------------
   Main...
   ------------------------------------------------------------ */
 
int main(
  int argc,
  char *argv[]) {
 
  static atm_t atm;
  static ctl_t ctl;
 
  double clk[NCL], sfeps[NSF];
 
  /* Print usage information... */
  USAGE;
 
  /* Check arguments... */
  if (argc < 3)
    ERRMSG("Missing or invalid command-line arguments.\n\n"
           "Usage: climatology <ctl> <atm> [KEY VALUE ...]\n\n"
           "Use -h for full help.");
 
  /* Read control parameters... */
  read_ctl(argc, argv, &ctl);
  const double t0 = scan_ctl(argc, argv, "T0", -1, "0", NULL);
  const double t1 = scan_ctl(argc, argv, "T1", -1, "0", NULL);
  const double dt = scan_ctl(argc, argv, "DT", -1, "1", NULL);
  const double z0 = scan_ctl(argc, argv, "Z0", -1, "0", NULL);
  const double z1 = scan_ctl(argc, argv, "Z1", -1, "90", NULL);
  const double dz = scan_ctl(argc, argv, "DZ", -1, "1", NULL);
  const double lat = scan_ctl(argc, argv, "LAT", -1, "0", NULL);
  const int zsurf = (int) scan_ctl(argc, argv, "ZSURF", -1, "0", NULL);
  const double clz = scan_ctl(argc, argv, "CLZ", -1, "0", NULL);
  const double cldz = scan_ctl(argc, argv, "CLDZ", -1, "0", NULL);
  for (int icl = 0; icl < ctl.ncl; icl++)
    clk[icl] = scan_ctl(argc, argv, "CLK", icl, "0", NULL);
  const double sft = scan_ctl(argc, argv, "SFT", -1, "0", NULL);
  for (int isf = 0; isf < ctl.nsf; isf++)
    sfeps[isf] = scan_ctl(argc, argv, "SFEPS", isf, "1", NULL);
 
  /* Loop over time steps... */
  for (double t = t0; t <= t1 + 0.5 * dt; t += dt) {
 
    /* Init... */
    atm.np = 0;
 
    /* Refine near-surface layer... */
    if (zsurf) {
      atm.np = 4;
      atm.z[0] = z0;
      atm.z[1] = z0 + 0.01;
      atm.z[2] = z0 + 0.02;
      atm.z[3] = z0 + 0.05;
      if (dz > 0.1)
        for (double z = 0.1; z <= 1.0 + 1e-9; z += 0.1)
          atm.z[atm.np++] = z0 + z;
      if (dz > 0.2)
        for (double z = 1.2; z <= 2.0 + 1e-9; z += 0.2)
          atm.z[atm.np++] = z0 + z;
      if (atm.np >= NP)
        ERRMSG("Too many atmospheric grid points!");
    }
 
    /* Add heights... */
    for (double z = z0; z <= z1; z += dz)
      if (atm.np == 0 || z > atm.z[atm.np - 1] + 1e-9) {
        atm.z[atm.np] = z;
        if ((++atm.np) >= NP)
          ERRMSG("Too many atmospheric grid points!");
      }
 
    /* Set time and latitude... */
    for (int ip = 0; ip < atm.np; ip++) {
      atm.time[ip] = t;
      atm.lat[ip] = lat;
    }
  }
 
  /* Read JuMACS climatology, if requested... */
  clim_t *clim = read_clim(&ctl);
 
  /* Interpolate climatological data... */
  climatology(&ctl, clim, &atm);
 
  /* Set cloud layer... */
  atm.clz = clz;
  atm.cldz = cldz;
  for (int icl = 0; icl < ctl.ncl; icl++)
    atm.clk[icl] = clk[icl];
 
  /* Set surface layer... */
  atm.sft = sft;
  for (int isf = 0; isf < ctl.nsf; isf++)
    atm.sfeps[isf] = sfeps[isf];
 
  /* Write data to disk... */
  write_atm(NULL, argv[2], &ctl, &atm, 0);
 
  /* Free climatology... */
  free(clim);
 
  return EXIT_SUCCESS;
}
 
/*****************************************************************************/
 
static void usage(
  void) {
  printf("\nJURASSIC climatology tool.\n\n");
  printf("Prepare an atmospheric profile from climatological data and\n");
  printf("write it to an atmospheric output file.\n\n");
  printf("Usage:\n");
  printf("  climatology <ctl> <atm> [KEY VALUE ...]\n\n");
  printf("Arguments:\n");
  printf("  <ctl>  Control file.\n");
  printf("  <atm>  Output atmospheric data file.\n");
  printf("  [KEY VALUE]  Optional control parameters.\n\n");
  printf("Tool-specific control parameters:\n");
  printf("  T0, T1, DT      Time range and spacing.\n");
  printf("  Z0, Z1, DZ      Altitude range and spacing.\n");
  printf("  LAT             Latitude of the profile.\n");
  printf("  ZSURF           Refine the near-surface grid if set.\n");
  printf("  CLZ, CLDZ, CLK  Cloud-layer settings.\n");
  printf("  SFT, SFEPS      Surface temperature and emissivity.\n\n");
  printf("Common control parameters:\n");
  printf("  ATMFMT                 Output atmospheric file format.\n");
  printf("  NG, EMITTER[i]         Active emitters.\n");
  printf("  NW, WINDOW[i]          Extinction-window layout.\n");
  printf("  NCL, CLNU[i]           Cloud spectral grid.\n");
  printf("  NSF, SFNU[i]           Surface spectral grid.\n\n");
  printf("Further information:\n");
  printf("  Manual: https://slcs-jsc.github.io/jurassic/\n");
}