cape.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;
 
  clim_t *clim;
 
  met_t *met;
 
  dd_t *dd;
 
  char tstr[LEN];
 
  float help[EX * EY];
 
  int dims[10], ncid, varid;
 
  size_t start[10], count[10];
 
  /* Allocate... */
  ALLOC(clim, clim_t, 1);
  ALLOC(met, met_t, 1);
  ALLOC(dd, dd_t, 1);
 
  /* Print usage information... */
  USAGE;
 
  /* Check arguments... */
  if (argc < 2)
    ERRMSG("Missing or invalid command-line arguments.\n\n"
           "Usage: cape <ctl> <met.nc>\n\n" "Use -h for full help.");
 
  /* Read control parameters... */
  mptrac_read_ctl(argv[1], argc, argv, &ctl);
 
  /* Read climatological data... */
  mptrac_read_clim(&ctl, clim);
 
  /* Read meteorological data... */
  if (!mptrac_read_met(argv[2], &ctl, clim, met, dd))
    ERRMSG("Cannot open file!");
 
  /* Open netCDF file... */
  if (nc_open(argv[2], NC_WRITE, &ncid) != NC_NOERR)
    ERRMSG("Cannot open file!");
 
  /* Get dimensions... */
  NC_INQ_DIM("time", &dims[0], 1, 1, 1);
  NC_INQ_DIM("lat", &dims[1], met->ny, met->ny, 1);
  NC_INQ_DIM("lon", &dims[2], met->nx - 1, met->nx - 1, 1);
  NC(nc_inq_dimid(ncid, "time", &dims[0]));
  NC(nc_inq_dimid(ncid, "lat", &dims[1]));
  NC(nc_inq_dimid(ncid, "lon", &dims[2]));
 
  /* Set define mode... */
  NC(nc_redef(ncid));
 
  /* Create variables... */
  NC_DEF_VAR("CAPE_MPT", NC_FLOAT, 3, dims,
             "convective available potential energy", "J kg**-1", 0, 0);
  NC_DEF_VAR("CIN_MPT", NC_FLOAT, 3, dims,
             "convective inhibition", "J kg**-1", 0, 0);
  NC_DEF_VAR("PEL_MPT", NC_FLOAT, 3, dims,
             "pressure at equilibrium level", "hPa", 0, 0);
 
  /* Get current time... */
  time_t t = time(NULL);
  struct tm tm = *localtime(&t);
  sprintf(tstr, "%d-%02d-%02d %02d:%02d:%02d",
          tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday,
          tm.tm_hour, tm.tm_min, tm.tm_sec);
 
  /* Set additional attributes... */
  NC_PUT_ATT("CAPE_MPT", "creator_of_parameter", "MPTRAC");
  NC_PUT_ATT("CIN_MPT", "creator_of_parameter", "MPTRAC");
  NC_PUT_ATT("PEL_MPT", "creator_of_parameter", "MPTRAC");
 
  NC_PUT_ATT("CAPE_MPT", "param_creation_time", tstr);
  NC_PUT_ATT("CIN_MPT", "param_creation_time", tstr);
  NC_PUT_ATT("PEL_MPT", "param_creation_time", tstr);
 
  NC_PUT_ATT("CAPE_MPT", "param_modification_time", tstr);
  NC_PUT_ATT("CIN_MPT", "param_modification_time", tstr);
  NC_PUT_ATT("PEL_MPT", "param_modification_time", tstr);
 
  NC_PUT_ATT("CAPE_MPT", "flag", "NONE");
  NC_PUT_ATT("CIN_MPT", "flag", "NONE");
  NC_PUT_ATT("PEL_MPT", "flag", "NONE");
 
  float miss[1] = { NAN };
  NC(nc_inq_varid(ncid, "CAPE_MPT", &varid));
  NC(nc_put_att_float(ncid, varid, "missing_value", NC_FLOAT, 1, miss));
  NC(nc_inq_varid(ncid, "CIN_MPT", &varid));
  NC(nc_put_att_float(ncid, varid, "missing_value", NC_FLOAT, 1, miss));
  NC(nc_inq_varid(ncid, "PEL_MPT", &varid));
  NC(nc_put_att_float(ncid, varid, "missing_value", NC_FLOAT, 1, miss));
 
  /* End define mode... */
  NC(nc_enddef(ncid));
 
  /* Write data... */
  for (int ix = 0; ix < met->nx - 1; ix++)
    for (int iy = 0; iy < met->ny; iy++)
      help[ARRAY_2D(iy, ix, met->nx - 1)] = met->cape[ix][iy];
  NC_PUT_FLOAT("CAPE_MPT", help, 0);
 
  for (int ix = 0; ix < met->nx - 1; ix++)
    for (int iy = 0; iy < met->ny; iy++)
      help[ARRAY_2D(iy, ix, met->nx - 1)] = met->cin[ix][iy];
  NC_PUT_FLOAT("CIN_MPT", help, 0);
 
  for (int ix = 0; ix < met->nx - 1; ix++)
    for (int iy = 0; iy < met->ny; iy++)
      help[ARRAY_2D(iy, ix, met->nx - 1)] = met->pel[ix][iy];
  NC_PUT_FLOAT("PEL_MPT", help, 0);
 
  /* Close file... */
  NC(nc_close(ncid));
 
  /* Free... */
  free(clim);
  free(met);
  free(dd);
 
  return EXIT_SUCCESS;
}
 
/*****************************************************************************/
 
void usage(
  void) {
 
  printf("\nMPTRAC cape tool.\n\n");
  printf("Add CAPE data to a meteorological netCDF file.\n");
  printf("\n");
  printf("Usage:\n");
  printf("  cape <ctl> <met.nc>\n");
  printf("\n");
  printf("Arguments:\n");
  printf("  <ctl>     Control file.\n");
  printf("  <met.nc>  Meteorological netCDF file to update.\n");
  printf("\nFurther information:\n");
  printf("  Manual: https://slcs-jsc.github.io/mptrac/\n");
}