atm_select.c

Go to the documentation of this file.

/*
  This file is part of MPTRAC.
  
  MPTRAC 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.
  
  MPTRAC 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 MPTRAC. If not, see <http://www.gnu.org/licenses/>.
  
  Copyright (C) 2013-2026 Forschungszentrum Juelich GmbH
*/
 
#include "mptrac.h"
 
/* ------------------------------------------------------------
   Functions...
   ------------------------------------------------------------ */
 
void usage(
  void);
 
/* ------------------------------------------------------------
   Main...
   ------------------------------------------------------------ */
 
int main(
  int argc,
  char *argv[]) {
 
  ctl_t ctl;
 
  atm_t *atm, *atm2;
 
  /* Allocate... */
  ALLOC(atm, atm_t, 1);
  ALLOC(atm2, atm_t, 1);
 
  /* Print usage information... */
  USAGE;
 
  /* Check arguments... */
  if (argc < 4)
    ERRMSG("Missing or invalid command-line arguments.\n\n"
           "Usage: atm_select <ctl> <atm_select> <atm1> [<atm2> ...]\n\n"
           "Use -h for full help.");
 
  /* Read control parameters... */
  mptrac_read_ctl(argv[1], argc, argv, &ctl);
  const int stride =
    (int) scan_ctl(argv[1], argc, argv, "SELECT_STRIDE", -1, "1", NULL);
  const int idx0 =
    (int) scan_ctl(argv[1], argc, argv, "SELECT_IDX0", -1, "-999", NULL);
  const int idx1 =
    (int) scan_ctl(argv[1], argc, argv, "SELECT_IDX1", -1, "-999", NULL);
  int ip0 =
    (int) scan_ctl(argv[1], argc, argv, "SELECT_IP0", -1, "-999", NULL);
  int ip1 =
    (int) scan_ctl(argv[1], argc, argv, "SELECT_IP1", -1, "-999", NULL);
  const double t0 = scan_ctl(argv[1], argc, argv, "SELECT_T0", -1, "0", NULL);
  const double t1 = scan_ctl(argv[1], argc, argv, "SELECT_T1", -1, "0", NULL);
  const double p0 =
    P(scan_ctl(argv[1], argc, argv, "SELECT_Z0", -1, "0", NULL));
  const double p1 =
    P(scan_ctl(argv[1], argc, argv, "SELECT_Z1", -1, "0", NULL));
  const double theta0 =
    scan_ctl(argv[1], argc, argv, "SELECT_THETA0", -1, "0", NULL);
  const double theta1 =
    scan_ctl(argv[1], argc, argv, "SELECT_THETA1", -1, "0", NULL);
  const double lon0 =
    scan_ctl(argv[1], argc, argv, "SELECT_LON0", -1, "0", NULL);
  const double lon1 =
    scan_ctl(argv[1], argc, argv, "SELECT_LON1", -1, "0", NULL);
  const double lat0 =
    scan_ctl(argv[1], argc, argv, "SELECT_LAT0", -1, "0", NULL);
  const double lat1 =
    scan_ctl(argv[1], argc, argv, "SELECT_LAT1", -1, "0", NULL);
  const double r0 = scan_ctl(argv[1], argc, argv, "SELECT_R0", -1, "0", NULL);
  const double r1 = scan_ctl(argv[1], argc, argv, "SELECT_R1", -1, "0", NULL);
  const double rlon =
    scan_ctl(argv[1], argc, argv, "SELECT_RLON", -1, "0", NULL);
  const double rlat =
    scan_ctl(argv[1], argc, argv, "SELECT_RLAT", -1, "0", NULL);
 
  /* Get Cartesian coordinates... */
  double x0[3], x1[3];
  geo2cart(0, rlon, rlat, x0);
 
  /* Loop over files... */
  for (int f = 3; f < argc; f++) {
 
    /* Read atmopheric data... */
    if (!mptrac_read_atm(argv[f], &ctl, atm))
      continue;
 
    /* Adjust range of air parcels... */
    if (ip0 < 0)
      ip0 = 0;
    ip0 = MIN(ip0, atm->np - 1);
    if (ip1 < 0)
      ip1 = atm->np - 1;
    ip1 = MIN(ip1, atm->np - 1);
    if (ip1 < ip0)
      ip1 = ip0;
 
    /* Loop over air parcels... */
    for (int ip = ip0; ip <= ip1; ip += stride) {
 
      /* Check air parcel index... */
      if (ctl.qnt_idx >= 0 && idx0 >= 0 && idx1 >= 0)
        if (atm->q[ctl.qnt_idx][ip] < idx0 || atm->q[ctl.qnt_idx][ip] > idx1)
          continue;
 
      /* Check time... */
      if (t0 != t1)
        if ((t1 > t0 && (atm->time[ip] < t0 || atm->time[ip] > t1))
            || (t1 < t0 && (atm->time[ip] < t0 && atm->time[ip] > t1)))
          continue;
 
      /* Check vertical distance... */
      if (p0 != p1)
        if ((p0 > p1 && (atm->p[ip] > p0 || atm->p[ip] < p1))
            || (p0 < p1 && (atm->p[ip] > p0 && atm->p[ip] < p1)))
          continue;
 
      /* Check potential temperature... */
      if (theta0 != theta1) {
        double theta;
        if (ctl.qnt_theta >= 0)
          theta = atm->q[ctl.qnt_theta][ip];
        else if (ctl.qnt_t >= 0)
          theta = THETA(atm->p[ip], atm->q[ctl.qnt_t][ip]);
        else
          ERRMSG
            ("Filtering requires temperature or potential temperature data!");
        if ((theta1 > theta0 && (theta < theta0 || theta > theta1))
            || (theta1 < theta0 && (theta < theta0 && theta > theta1)))
          continue;
      }
 
      /* Check longitude... */
      if (lon0 != lon1)
        if ((lon1 > lon0 && (atm->lon[ip] < lon0 || atm->lon[ip] > lon1))
            || (lon1 < lon0 && (atm->lon[ip] < lon0 && atm->lon[ip] > lon1)))
          continue;
 
      /* Check latitude... */
      if (lat0 != lat1)
        if ((lat1 > lat0 && (atm->lat[ip] < lat0 || atm->lat[ip] > lat1))
            || (lat1 < lat0 && (atm->lat[ip] < lat0 && atm->lat[ip] > lat1)))
          continue;
 
      /* Check horizontal distace... */
      if (r0 != r1) {
        geo2cart(0, atm->lon[ip], atm->lat[ip], x1);
        double r = DIST(x0, x1);
        if ((r1 > r0 && (r < r0 || r > r1))
            || (r1 < r0 && (r < r0 && r > r1)))
          continue;
      }
 
      /* Copy data... */
      atm2->time[atm2->np] = atm->time[ip];
      atm2->p[atm2->np] = atm->p[ip];
      atm2->lon[atm2->np] = atm->lon[ip];
      atm2->lat[atm2->np] = atm->lat[ip];
      for (int iq = 0; iq < ctl.nq; iq++)
        atm2->q[iq][atm2->np] = atm->q[iq][ip];
      if ((++atm2->np) > NP)
        ERRMSG("Too many air parcels!");
    }
  }
 
  /* Close file... */
  mptrac_write_atm(argv[2], &ctl, atm2, 0);
 
  /* Free... */
  free(atm);
  free(atm2);
 
  return EXIT_SUCCESS;
}
 
/*****************************************************************************/
 
void usage(
  void) {
 
  printf("\nMPTRAC atm_select tool.\n\n");
  printf("Extract subsets of air parcels from atmospheric data files.\n");
  printf("\n");
  printf("Usage:\n");
  printf("  atm_select <ctl> <atm_select> <atm1> [<atm2> ...]\n");
  printf("\n");
  printf("Arguments:\n");
  printf("  <ctl>         Control file.\n");
  printf("  <atm_select>  Atmospheric output file for selected parcels.\n");
  printf("  <atm*>        Atmospheric input files.\n");
  printf("\nFurther information:\n");
  printf("  Manual: https://slcs-jsc.github.io/mptrac/\n");
}