vtkexodusII/src/ex_inquire.c

/*
 * Copyright(C) 1999-2021 National Technology & Engineering Solutions
 * of Sandia, LLC (NTESS).  Under the terms of Contract DE-NA0003525 with
 * NTESS, the U.S. Government retains certain rights in this software.
 *
 * See packages/seacas/LICENSE for details
 */

#include "exodusII.h"
#include "exodusII_int.h"

/*! \cond INTERNAL */
static int ex__get_dimension_value(int exoid, int64_t *var, int default_value,
                                   const char *dimension_name, int missing_ok)
{
  int    status;
  char   errmsg[MAX_ERR_LENGTH];
  size_t idum;
  int    dimid;

  if ((status = nc_inq_dimid(exoid, dimension_name, &dimid)) != NC_NOERR) {
    *var = default_value;
    if (missing_ok) {
      return (EX_NOERR);
    }
    snprintf(errmsg, MAX_ERR_LENGTH, "ERROR: failed to retrieve dimension %s for file id %d",
             dimension_name, exoid);
    ex_err_fn(exoid, __func__, errmsg, status);
    return (EX_FATAL);
  }
  if ((status = nc_inq_dimlen(exoid, dimid, &idum)) != NC_NOERR) {
    *var = default_value;
    snprintf(errmsg, MAX_ERR_LENGTH,
             "ERROR: failed to retrieve value for dimension %s for file id %d", dimension_name,
             exoid);
    ex_err_fn(exoid, __func__, errmsg, status);
    return (EX_FATAL);
  }
  *var = idum;
  return (EX_NOERR);
}

static int ex_get_concat_set_len(int exoid, int64_t *set_length, const char *set_name,
                                 const char *set_num_dim, const char *set_stat_var,
                                 const char *set_size_root, int missing_ok)
{
  int    i;
  int    status;
  char   errmsg[MAX_ERR_LENGTH];
  size_t idum;
  int    dimid, varid;
  size_t num_sets;
  int *  stat_vals = NULL;

  *set_length = 0; /* default return value */

  if ((status = nc_inq_dimid(exoid, set_num_dim, &dimid)) == NC_NOERR) {
    if ((status = nc_inq_dimlen(exoid, dimid, &num_sets)) != NC_NOERR) {
      snprintf(errmsg, MAX_ERR_LENGTH, "ERROR: failed to get number of %s sets in file id %d",
               set_name, exoid);
      ex_err_fn(exoid, __func__, errmsg, status);
      return (EX_FATAL);
    }

    /* Allocate space for stat array */
    if (!(stat_vals = malloc((int)num_sets * sizeof(int)))) {
      snprintf(errmsg, MAX_ERR_LENGTH,
               "ERROR: failed to allocate memory for %s set status "
               "array for file id %d",
               set_name, exoid);
      ex_err_fn(exoid, __func__, errmsg, EX_MEMFAIL);
      return (EX_FATAL);
    }

    /* get variable id of status array */
    if ((status = nc_inq_varid(exoid, set_stat_var, &varid)) == NC_NOERR) {
      /* if status array exists, use it, otherwise assume, object exists
         to be backward compatible */
      if ((status = nc_get_var_int(exoid, varid, stat_vals)) != NC_NOERR) {
        free(stat_vals);
        snprintf(errmsg, MAX_ERR_LENGTH, "ERROR: failed to get %s set status array from file id %d",
                 set_name, exoid);
        ex_err_fn(exoid, __func__, errmsg, status);
        return (EX_FATAL);
      }
    }
    else { /* default: status is true */
      for (i = 0; i < num_sets; i++) {
        stat_vals[i] = 1;
      }
    }

    for (i = 0; i < num_sets; i++) {
      if (stat_vals[i] == 0) { /* is this object null? */
        continue;
      }

      if ((status = nc_inq_dimid(exoid, ex__catstr(set_size_root, i + 1), &dimid)) != NC_NOERR) {
        if (missing_ok) {
          idum = 0;
        }
        else {
          *set_length = 0;
          free(stat_vals);
          return (EX_FATAL);
        }
      }
      else {
        if ((status = nc_inq_dimlen(exoid, dimid, &idum)) != NC_NOERR) {
          *set_length = 0;
          free(stat_vals);
          return (EX_FATAL);
        }
      }

      *set_length += idum;
    }

    free(stat_vals);
  }
  return (EX_NOERR);
}

static void flt_cvt(float *xptr, double x) { *xptr = (float)x; }
/*! \endcond */

static int ex_inquire_internal(int exoid, int req_info, int64_t *ret_int, float *ret_float,
                               char *ret_char)
{
  int       dimid, varid, rootid;
  void_int *ids = NULL;
  size_t    i;
  size_t    ldum = 0;
  size_t    num_sets, idum;
  int *     stat_vals;
  char      errmsg[MAX_ERR_LENGTH];
  int       status;
  char      tmp_title[2048];
  int       num_var;

  if (ex__check_valid_file_id(exoid, __func__) == EX_FATAL) {
    return (EX_FATAL);
  }

  if (ret_char) {
    *ret_char = '\0'; /* Only needs to be non-null for TITLE and some GROUP NAME inquiries */
  }
  if (!ret_int) {
    snprintf(errmsg, MAX_ERR_LENGTH, "Warning: integer argument is NULL which is not allowed.");
    ex_err_fn(exoid, __func__, errmsg, EX_BADPARAM);
    return (EX_FATAL);
  }

  rootid = exoid & EX_FILE_ID_MASK;

  switch (req_info) {
  case EX_INQ_FILE_TYPE:

    /* obsolete call */
    /*returns "r" for regular EXODUS file or "h" for history EXODUS file*/
    snprintf(errmsg, MAX_ERR_LENGTH, "Warning: file type inquire is obsolete");
    ex_err_fn(exoid, __func__, errmsg, EX_BADPARAM);
    return (EX_WARN);

  case EX_INQ_API_VERS:
    /* returns the EXODUS API version number */
    if (!ret_float) {
      snprintf(errmsg, MAX_ERR_LENGTH,
               "Warning: float argument is NULL for EX_INQ_API_VERS "
               "which is not allowed.");
      ex_err_fn(exoid, __func__, errmsg, EX_BADPARAM);
      return (EX_FATAL);
    }

    if (nc_get_att_float(rootid, NC_GLOBAL, ATT_API_VERSION, ret_float) !=
        NC_NOERR) { /* try old (prior to db version 2.02) attribute name */
      if ((status = nc_get_att_float(rootid, NC_GLOBAL, ATT_API_VERSION_BLANK, ret_float)) !=
          NC_NOERR) {
        snprintf(errmsg, MAX_ERR_LENGTH, "ERROR: failed to get EXODUS API version for file id %d",
                 rootid);
        ex_err_fn(exoid, __func__, errmsg, status);
        return (EX_FATAL);
      }
    }

    break;

  case EX_INQ_DB_VERS:
    /* returns the EXODUS database version number */
    if (!ret_float) {
      snprintf(errmsg, MAX_ERR_LENGTH,
               "Warning: float argument is NULL for EX_INQ_DB_VERS "
               "which is not allowed.");
      ex_err_fn(exoid, __func__, errmsg, EX_BADPARAM);
      return (EX_FATAL);
    }

    if ((status = nc_get_att_float(rootid, NC_GLOBAL, ATT_VERSION, ret_float)) != NC_NOERR) {
      snprintf(errmsg, MAX_ERR_LENGTH,
               "ERROR: failed to get EXODUS database version for file id %d", rootid);
      ex_err_fn(exoid, __func__, errmsg, status);
      return (EX_FATAL);
    }
    break;

  case EX_INQ_LIB_VERS:
    /* returns the EXODUS Library version number */
    if (ret_float) {
      float version_major = EXODUS_VERSION_MAJOR;
      float version_minor = EXODUS_VERSION_MINOR;
      float version       = version_major + version_minor / 100.0;
      flt_cvt(ret_float, version);
    }

    if (ret_int) {
      *ret_int = EX_API_VERS_NODOT;
    }
    break;

  case EX_INQ_DB_MAX_ALLOWED_NAME_LENGTH:
    /* Return the MAX_NAME_LENGTH size for this database
       It will not include the space for the trailing null, so if it
       is defined as 33 on the database, 32 will be returned.
    */
    if ((status = nc_inq_dimid(rootid, DIM_STR_NAME, &dimid)) != NC_NOERR) {
      /* If not found, then an older database */
      *ret_int = 32;
    }
    else {
      /* Get the name string length */
      size_t name_length = 0;
      if ((status = nc_inq_dimlen(rootid, dimid, &name_length)) != NC_NOERR) {
        snprintf(errmsg, MAX_ERR_LENGTH, "ERROR: failed to get name string length in file id %d",
                 exoid);
        ex_err_fn(exoid, __func__, errmsg, status);
        return (EX_FATAL);
      }

      *ret_int = name_length - 1;
    }
    break;

  case EX_INQ_DB_FLOAT_SIZE: {
    nc_get_att_longlong(rootid, NC_GLOBAL, ATT_FLT_WORDSIZE, (long long *)ret_int);
  } break;

  case EX_INQ_DB_MAX_USED_NAME_LENGTH:
    /* Return the value of the ATT_MAX_NAME_LENGTH attribute (if it
       exists) which is the maximum length of any entity, variable,
       attribute, property name written to this database.  If the
       attribute does not exist, then '32' is returned.  The length
       does not include the trailing null.
    */
    {
      nc_type att_type = NC_NAT;
      size_t  att_len  = 0;

      *ret_int = 32; /* Default size consistent with older databases */

      status = nc_inq_att(rootid, NC_GLOBAL, ATT_MAX_NAME_LENGTH, &att_type, &att_len);
      if (status == NC_NOERR && att_type == NC_INT) {
        /* The attribute exists, return it... */
        nc_get_att_longlong(rootid, NC_GLOBAL, ATT_MAX_NAME_LENGTH, (long long *)ret_int);
      }
    }
    break;

  case EX_INQ_MAX_READ_NAME_LENGTH: {
    /* Returns the user-specified maximum size of names that will be
     * returned to the user by any of the ex_get_ routines.  If the
     * name is longer than this value, it will be truncated. The
     * default if not set by the client is 32 characters. The value
     * does not include the trailing null.
     */
    struct ex__file_item *file = ex__find_file_item(rootid);

    if (!file) {
      snprintf(errmsg, MAX_ERR_LENGTH, "ERROR: unknown file id %d for ex_inquire_int().", rootid);
      ex_err_fn(exoid, __func__, errmsg, EX_BADFILEID);
      *ret_int = 0;
    }
    else {
      *ret_int = file->maximum_name_length;
    }
  } break;

  case EX_INQ_TITLE:
    if (!ret_char) {
      snprintf(errmsg, MAX_ERR_LENGTH,
               "ERROR: Requested title, but character pointer was null "
               "for file id %d",
               rootid);
      ex_err_fn(exoid, __func__, errmsg, EX_BADPARAM);
      return (EX_FATAL);
    }
    else {
      /* returns the title of the database */
      /* Title is stored at root level... */
      if ((status = nc_get_att_text(rootid, NC_GLOBAL, ATT_TITLE, tmp_title)) != NC_NOERR) {
        *ret_char = '\0';
        snprintf(errmsg, MAX_ERR_LENGTH, "ERROR: failed to get database title for file id %d",
                 exoid);
        ex_err_fn(exoid, __func__, errmsg, status);
        return (EX_FATAL);
      }
      ex_copy_string(ret_char, tmp_title, MAX_LINE_LENGTH + 1);
    }
    break;

  case EX_INQ_DIM:
    /* returns the dimensionality (2 or 3, for 2-d or 3-d) of the database */
    if (ex__get_dimension(exoid, DIM_NUM_DIM, "database dimensionality", &ldum, &dimid, __func__) !=
        NC_NOERR) {
      return (EX_FATAL);
    }
    *ret_int = ldum;
    break;

  case EX_INQ_ASSEMBLY:
    /* returns the number of assemblies */
    {
      *ret_int                   = 0;
      struct ex__file_item *file = ex__find_file_item(exoid);
      if (file) {
        *ret_int = file->assembly_count;
      }
    }
    break;

  case EX_INQ_BLOB:
    /* returns the number of blobs */
    {
      *ret_int                   = 0;
      struct ex__file_item *file = ex__find_file_item(exoid);
      if (file) {
        *ret_int = file->blob_count;
      }
    }
    break;

  case EX_INQ_NODES:
    /* returns the number of nodes */
    if (ex__get_dimension(exoid, DIM_NUM_NODES, "nodes", &ldum, &dimid, NULL) != NC_NOERR) {
      *ret_int = 0;
    }
    else {
      *ret_int = ldum;
    }
    break;

  case EX_INQ_ELEM:
    /* returns the number of elements */
    if (ex__get_dimension(exoid, DIM_NUM_ELEM, "elements", &ldum, &dimid, NULL) != NC_NOERR) {
      *ret_int = 0;
    }
    else {
      *ret_int = ldum;
    }
    break;

  case EX_INQ_ELEM_BLK:
    /* returns the number of element blocks */
    if (ex__get_dimension(exoid, DIM_NUM_EL_BLK, "element blocks", &ldum, &dimid, NULL) !=
        NC_NOERR) {
      *ret_int = 0;
    }
    else {
      *ret_int = ldum;
    }
    break;

  case EX_INQ_NODE_SETS:
    /* returns the number of node sets */
    if (ex__get_dimension(exoid, DIM_NUM_NS, "node sets", &ldum, &dimid, NULL) != NC_NOERR) {
      *ret_int = 0;
    }
    else {
      *ret_int = ldum;
    }
    break;

  case EX_INQ_NS_NODE_LEN:
    /* returns the length of the concatenated node sets node list */
    ex_get_concat_set_len(exoid, ret_int, "node", DIM_NUM_NS, VAR_NS_STAT, "num_nod_ns", 0);
    break;

  case EX_INQ_NS_DF_LEN:
    /*     returns the length of the concatenated node sets dist factor list */

    /*
      Determine the concatenated node sets distribution factor length:

      2. Check see if the dist factor variable for a node set id exists.
      3. If it exists, goto step 4, else the length is zero.
      4. Get the dimension of the number of nodes in the node set -0
      use this value as the length as by definition they are the same.
      5. Sum the individual lengths for the total list length.
    */

    *ret_int = 0; /* default value if no node sets defined */

    if (nc_inq_dimid(exoid, DIM_NUM_NS, &dimid) == NC_NOERR) {
      if ((status = nc_inq_dimlen(exoid, dimid, &num_sets)) != NC_NOERR) {
        snprintf(errmsg, MAX_ERR_LENGTH, "ERROR: failed to get number of node sets in file id %d",
                 exoid);
        ex_err_fn(exoid, __func__, errmsg, status);
        return (EX_FATAL);
      }

      for (i = 0; i < num_sets; i++) {
        if ((status = nc_inq_varid(exoid, VAR_FACT_NS(i + 1), &varid)) != NC_NOERR) {
          if (status == NC_ENOTVAR) {
            idum = 0; /* this dist factor doesn't exist */
          }
          else {
            *ret_int = 0;
            snprintf(
                errmsg, MAX_ERR_LENGTH,
                "ERROR: failed to locate number of dist fact for %zu'th node set in file id %d", i,
                exoid);
            ex_err_fn(exoid, __func__, errmsg, status);
            return (EX_FATAL);
          }
        }
        else {
          if ((status = nc_inq_dimid(exoid, DIM_NUM_NOD_NS(i + 1), &dimid)) != NC_NOERR) {
            *ret_int = 0;
            snprintf(errmsg, MAX_ERR_LENGTH,
                     "ERROR: failed to locate number of nodes in %zu'th node set in file id %d", i,
                     exoid);
            ex_err_fn(exoid, __func__, errmsg, status);
            return (EX_FATAL);
          }
          if ((status = nc_inq_dimlen(exoid, dimid, &idum)) != NC_NOERR) {
            *ret_int = 0;
            snprintf(errmsg, MAX_ERR_LENGTH,
                     "ERROR: failed to get number of nodes in %zu'th node set in file id %d", i,
                     exoid);
            ex_err_fn(exoid, __func__, errmsg, status);
            return (EX_FATAL);
          }
        }
        *ret_int += idum;
      }
    }

    break;

  case EX_INQ_SIDE_SETS:
    /* returns the number of side sets */
    if (ex__get_dimension(exoid, DIM_NUM_SS, "side sets", &ldum, &dimid, NULL) != NC_NOERR) {
      *ret_int = 0;
    }
    else {
      *ret_int = ldum;
    }
    break;

  case EX_INQ_SS_NODE_LEN:

    /*     returns the length of the concatenated side sets node list */

    *ret_int = 0; /* default return value */

    if (nc_inq_dimid(exoid, DIM_NUM_SS, &dimid) == NC_NOERR) {
      if ((status = nc_inq_dimlen(exoid, dimid, &num_sets)) != NC_NOERR) {
        snprintf(errmsg, MAX_ERR_LENGTH, "ERROR: failed to get number of side sets in file id %d",
                 exoid);
        ex_err_fn(exoid, __func__, errmsg, status);
        return (EX_FATAL);
      }

      if (!(ids = malloc(num_sets * sizeof(int64_t)))) { /* May be getting 2x what is
                                                            needed, but should be OK */
        snprintf(errmsg, MAX_ERR_LENGTH,
                 "ERROR: failed to allocate memory for side set ids for file id %d", exoid);
        ex_err_fn(exoid, __func__, errmsg, EX_MEMFAIL);
        return (EX_FATAL);
      }

      if (ex_get_ids(exoid, EX_SIDE_SET, ids) == EX_FATAL) {
        snprintf(errmsg, MAX_ERR_LENGTH, "ERROR: failed to get side set ids in file id %d", exoid);
        ex_err_fn(exoid, __func__, errmsg, EX_LASTERR);
        free(ids);
        return (EX_FATAL);
      }

      /* allocate space for stat array */
      if (!(stat_vals = malloc((int)num_sets * sizeof(int)))) {
        free(ids);
        snprintf(errmsg, MAX_ERR_LENGTH,
                 "ERROR: failed to allocate memory for side set status "
                 "array for file id %d",
                 exoid);
        ex_err_fn(exoid, __func__, errmsg, EX_MEMFAIL);
        return (EX_FATAL);
      }
      /* get variable id of status array */
      if ((status = nc_inq_varid(exoid, VAR_SS_STAT, &varid)) == NC_NOERR) {
        /* if status array exists, use it, otherwise assume, object exists
           to be backward compatible */

        if ((status = nc_get_var_int(exoid, varid, stat_vals)) != NC_NOERR) {
          free(ids);
          free(stat_vals);
          snprintf(errmsg, MAX_ERR_LENGTH,
                   "ERROR: failed to get element block status array from file id %d", exoid);
          ex_err_fn(exoid, __func__, errmsg, status);
          return (EX_FATAL);
        }
      }
      else { /* default: status is true */
        for (i = 0; i < num_sets; i++) {
          stat_vals[i] = 1;
        }
      }

      /* walk id list, get each side set node length and sum for total */

      for (i = 0; i < num_sets; i++) {
        ex_entity_id id;
        if (stat_vals[i] == 0) { /* is this object null? */
          continue;
        }

        if (ex_int64_status(exoid) & EX_IDS_INT64_API) {
          int64_t tmp_len = 0;
          id              = ((int64_t *)ids)[i];
          status          = ex_get_side_set_node_list_len(exoid, id, &tmp_len);
          if (status != EX_FATAL) {
            *ret_int += tmp_len;
          }
        }
        else {
          int tmp_len = 0;
          id          = ((int *)ids)[i];
          status      = ex_get_side_set_node_list_len(exoid, id, &tmp_len);
          if (status != EX_FATAL) {
            *ret_int += tmp_len;
          }
        }

        if (status == EX_FATAL) {
          *ret_int = 0;
          snprintf(errmsg, MAX_ERR_LENGTH,
                   "ERROR: failed to side set %" PRId64 " node length in file id %d", id, exoid);
          ex_err_fn(exoid, __func__, errmsg, status);
          free(stat_vals);
          free(ids);
          return (EX_FATAL);
        }
      }

      free(stat_vals);
      free(ids);
    }

    break;

  case EX_INQ_SS_ELEM_LEN:
    /*     returns the length of the concatenated side sets element list */
    ex_get_concat_set_len(exoid, ret_int, "side", DIM_NUM_SS, VAR_SS_STAT, "num_side_ss", 0);
    break;

  case EX_INQ_SS_DF_LEN:

    /*     returns the length of the concatenated side sets dist factor list */

    /*
      Determine the concatenated side sets distribution factor length:

      1. Get the side set ids list.
      2. Check see if the dist factor dimension for a side set id exists.
      3. If it exists, goto step 4, else set the individual length to zero.
      4. Sum the dimension value into the running total length.
    */

    *ret_int = 0;

    /* first check see if any side sets exist */

    if (nc_inq_dimid(exoid, DIM_NUM_SS, &dimid) == NC_NOERR) {
      if ((status = nc_inq_dimlen(exoid, dimid, &num_sets)) != NC_NOERR) {
        snprintf(errmsg, MAX_ERR_LENGTH, "ERROR: failed to get number of side sets in file id %d",
                 exoid);
        ex_err_fn(exoid, __func__, errmsg, status);
        return (EX_FATAL);
      }

      for (i = 0; i < num_sets; i++) {
        if ((status = nc_inq_dimid(exoid, DIM_NUM_DF_SS(i + 1), &dimid)) != NC_NOERR) {
          if (status == NC_EBADDIM) {
            ldum = 0; /* this dist factor doesn't exist */
          }
          else {
            *ret_int = 0;
            snprintf(
                errmsg, MAX_ERR_LENGTH,
                "ERROR: failed to locate number of dist fact for %zu'th side set in file id %d", i,
                exoid);
            ex_err_fn(exoid, __func__, errmsg, status);
            return (EX_FATAL);
          }
        }
        else {
          if ((status = nc_inq_dimlen(exoid, dimid, &ldum)) != NC_NOERR) {
            *ret_int = 0;
            snprintf(errmsg, MAX_ERR_LENGTH,
                     "ERROR: failed to get number of dist factors in %zu'th side set in file id %d",
                     i, exoid);
            ex_err_fn(exoid, __func__, errmsg, status);
            return (EX_FATAL);
          }
        }
        *ret_int += ldum;
      }
    }

    break;

  case EX_INQ_QA:
    /* returns the number of QA records */
    if (ex__get_dimension(rootid, DIM_NUM_QA, "QA records", &ldum, &dimid, NULL) != NC_NOERR) {
      *ret_int = 0;
    }
    else {
      *ret_int = ldum;
    }
    break;

  case EX_INQ_INFO:
    /* returns the number of information records */
    if (ex__get_dimension(rootid, DIM_NUM_INFO, "info records", &ldum, &dimid, NULL) != NC_NOERR) {
      *ret_int = 0;
    }
    else {
      *ret_int = ldum;
    }
    break;

  case EX_INQ_TIME:
    /*     returns the number of time steps stored in the database */
    if (ex__get_dimension(exoid, DIM_TIME, "time dimension", &ldum, &dimid, __func__) != NC_NOERR) {
      return (EX_FATAL);
    }
    *ret_int = ldum;
    break;

  case EX_INQ_EB_PROP:
    /* returns the number of element block properties */
    *ret_int = ex_get_num_props(exoid, EX_ELEM_BLOCK);
    break;

  case EX_INQ_NS_PROP:
    /* returns the number of node set properties */
    *ret_int = ex_get_num_props(exoid, EX_NODE_SET);
    break;

  case EX_INQ_SS_PROP:
    /* returns the number of side set properties */
    *ret_int = ex_get_num_props(exoid, EX_SIDE_SET);
    break;

  case EX_INQ_ELEM_MAP:
    /* returns the number of element maps */
    if (ex__get_dimension(exoid, DIM_NUM_EM, "element maps", &ldum, &dimid, NULL) != NC_NOERR) {
      *ret_int = 0;
    }
    else {
      *ret_int = ldum;
    }
    break;

  case EX_INQ_EM_PROP:
    /* returns the number of element map properties */
    *ret_int = ex_get_num_props(exoid, EX_ELEM_MAP);
    break;

  case EX_INQ_NODE_MAP:
    /* returns the number of node maps */
    if (ex__get_dimension(exoid, DIM_NUM_NM, "node maps", &ldum, &dimid, NULL) != NC_NOERR) {
      *ret_int = 0;
    }
    else {
      *ret_int = ldum;
    }
    break;

  case EX_INQ_NM_PROP:
    /* returns the number of node map properties */
    *ret_int = ex_get_num_props(exoid, EX_NODE_MAP);
    break;

  case EX_INQ_EDGE:
    /* returns the number of edges (defined across all edge blocks). */
    if (ex__get_dimension_value(exoid, ret_int, 0, DIM_NUM_EDGE, 1) != EX_NOERR) {
      return (EX_FATAL);
    }
    break;

  case EX_INQ_EDGE_BLK:
    /* returns the number of edge blocks. */
    if (ex__get_dimension_value(exoid, ret_int, 0, DIM_NUM_ED_BLK, 1) != EX_NOERR) {
      return (EX_FATAL);
    }
    break;

  case EX_INQ_EDGE_SETS:
    /* returns the number of edge sets. */
    if (ex__get_dimension_value(exoid, ret_int, 0, DIM_NUM_ES, 1) != EX_NOERR) {
      return (EX_FATAL);
    }
    break;

  case EX_INQ_ES_LEN:
    /* returns the length of the concatenated edge set edge list. */
    ex_get_concat_set_len(exoid, ret_int, "edge", DIM_NUM_ES, VAR_ES_STAT, "num_edge_es", 0);
    break;

  case EX_INQ_ES_DF_LEN:
    /* returns the length of the concatenated edge set distribution factor list.
     */
    ex_get_concat_set_len(exoid, ret_int, "edge", DIM_NUM_ES, VAR_ES_STAT, "num_df_es", 1);
    break;

  case EX_INQ_EDGE_PROP:
    /* returns the number of integer properties stored for each edge block. This
     * includes the "ID" property. */
    *ret_int = ex_get_num_props(exoid, EX_EDGE_BLOCK);
    break;

  case EX_INQ_ES_PROP:
    /* returns the number of integer properties stored for each edge set.. This
     * includes the "ID" property */
    *ret_int = ex_get_num_props(exoid, EX_EDGE_SET);
    break;

  case EX_INQ_FACE:
    /* returns the number of faces (defined across all face blocks). */
    if (ex__get_dimension_value(exoid, ret_int, 0, DIM_NUM_FACE, 1) != EX_NOERR) {
      return (EX_FATAL);
    }
    break;

  case EX_INQ_FACE_BLK:
    /* returns the number of face blocks. */
    if (ex__get_dimension_value(exoid, ret_int, 0, DIM_NUM_FA_BLK, 1) != EX_NOERR) {
      return (EX_FATAL);
    }
    break;

  case EX_INQ_FACE_SETS:
    /* returns the number of face sets. */
    if (ex__get_dimension_value(exoid, ret_int, 0, DIM_NUM_FS, 1) != EX_NOERR) {
      return (EX_FATAL);
    }
    break;

  case EX_INQ_FS_LEN:
    /* returns the length of the concatenated edge set edge list. */
    ex_get_concat_set_len(exoid, ret_int, "face", DIM_NUM_FS, VAR_FS_STAT, "num_face_fs", 0);
    break;

  case EX_INQ_FS_DF_LEN:
    /* returns the length of the concatenated edge set distribution factor list.
     */
    ex_get_concat_set_len(exoid, ret_int, "face", DIM_NUM_FS, VAR_FS_STAT, "num_df_fs", 1);
    break;

  case EX_INQ_FACE_PROP:
    /* returns the number of integer properties stored for each edge block. This
     * includes the "ID" property. */
    *ret_int = ex_get_num_props(exoid, EX_FACE_BLOCK);
    break;

  case EX_INQ_FS_PROP:
    /* returns the number of integer properties stored for each edge set.. This
     * includes the "ID" property */
    *ret_int = ex_get_num_props(exoid, EX_FACE_SET);
    break;

  case EX_INQ_ELEM_SETS:
    /* returns the number of element sets. */
    if (ex__get_dimension_value(exoid, ret_int, 0, DIM_NUM_ELS, 1) != EX_NOERR) {
      return (EX_FATAL);
    }
    break;

  case EX_INQ_ELS_LEN:
    /* returns the length of the concatenated element set element list. */
    ex_get_concat_set_len(exoid, ret_int, "element", DIM_NUM_ELS, VAR_ELS_STAT, "num_ele_els", 0);
    break;

  case EX_INQ_ELS_DF_LEN:
    /* returns the length of the concatenated element set distribution factor
     * list. */
    ex_get_concat_set_len(exoid, ret_int, "element", DIM_NUM_ELS, VAR_ELS_STAT, "num_df_els", 1);
    break;

  case EX_INQ_ELS_PROP:
    /* returns the number of integer properties stored for each element set. */
    *ret_int = ex_get_num_props(exoid, EX_ELEM_SET);
    break;

  case EX_INQ_EDGE_MAP:
    /* returns the number of edge maps. */
    if (ex__get_dimension_value(exoid, ret_int, 0, DIM_NUM_EDM, 1) != EX_NOERR) {
      return (EX_FATAL);
    }
    break;

  case EX_INQ_FACE_MAP:
    /*     returns the number of face maps. */
    if (ex__get_dimension_value(exoid, ret_int, 0, DIM_NUM_FAM, 1) != EX_NOERR) {
      return (EX_FATAL);
    }
    break;

  case EX_INQ_NUM_NODE_VAR:
    if (ex_get_variable_param(exoid, EX_NODAL, &num_var) != EX_NOERR) {
      return (EX_FATAL);
    }
    *ret_int = num_var;
    break;

  case EX_INQ_NUM_EDGE_BLOCK_VAR:
    if (ex_get_variable_param(exoid, EX_EDGE_BLOCK, &num_var) != EX_NOERR) {
      return (EX_FATAL);
    }
    *ret_int = num_var;
    break;

  case EX_INQ_NUM_FACE_BLOCK_VAR:
    if (ex_get_variable_param(exoid, EX_FACE_BLOCK, &num_var) != EX_NOERR) {
      return (EX_FATAL);
    }
    *ret_int = num_var;
    break;

  case EX_INQ_NUM_ELEM_BLOCK_VAR:
    if (ex_get_variable_param(exoid, EX_ELEM_BLOCK, &num_var) != EX_NOERR) {
      return (EX_FATAL);
    }
    *ret_int = num_var;
    break;

  case EX_INQ_NUM_NODE_SET_VAR:
    if (ex_get_variable_param(exoid, EX_NODE_SET, &num_var) != EX_NOERR) {
      return (EX_FATAL);
    }
    *ret_int = num_var;
    break;

  case EX_INQ_NUM_EDGE_SET_VAR:
    if (ex_get_variable_param(exoid, EX_EDGE_SET, &num_var) != EX_NOERR) {
      return (EX_FATAL);
    }
    *ret_int = num_var;
    break;

  case EX_INQ_NUM_FACE_SET_VAR:
    if (ex_get_variable_param(exoid, EX_FACE_SET, &num_var) != EX_NOERR) {
      return (EX_FATAL);
    }
    *ret_int = num_var;
    break;

  case EX_INQ_NUM_ELEM_SET_VAR:
    if (ex_get_variable_param(exoid, EX_ELEM_SET, &num_var) != EX_NOERR) {
      return (EX_FATAL);
    }
    *ret_int = num_var;
    break;

  case EX_INQ_NUM_SIDE_SET_VAR:
    if (ex_get_variable_param(exoid, EX_SIDE_SET, &num_var) != EX_NOERR) {
      return (EX_FATAL);
    }
    *ret_int = num_var;
    break;

  case EX_INQ_NUM_GLOBAL_VAR:
    if (ex_get_variable_param(exoid, EX_GLOBAL, &num_var) != EX_NOERR) {
      return (EX_FATAL);
    }
    *ret_int = num_var;
    break;

  case EX_INQ_COORD_FRAMES:
    /* return the number of coordinate frames */
    if (ex__get_dimension_value(exoid, ret_int, 0, DIM_NUM_CFRAMES, 1) != EX_NOERR) {
      return (EX_FATAL);
    }
    break;

  case EX_INQ_NUM_CHILD_GROUPS: {
    /* return number of groups contained in this (exoid) group */
    int tmp_num = 0;
#if NC_HAS_HDF5
    nc_inq_grps(exoid, &tmp_num, NULL);
#endif
    *ret_int = tmp_num;
  } break;

  case EX_INQ_GROUP_PARENT: {
/* return id of parent of this (exoid) group; returns exoid if at root */
#if NC_HAS_HDF5
    int tmp_num = exoid;
    nc_inq_grp_parent(exoid, &tmp_num);
    *ret_int = tmp_num;
#else
    *ret_int = exoid;
#endif
  } break;

  case EX_INQ_GROUP_ROOT:
    /* return id of root group "/" of this (exoid) group; returns exoid if at
     * root */
    *ret_int = (unsigned)exoid & EX_FILE_ID_MASK;
    break;

  case EX_INQ_GROUP_NAME_LEN: {
    size_t len_name = 0;
#if NC_HAS_HDF5
    /* return name length of group exoid */
    nc_inq_grpname_len(exoid, &len_name);
#endif
    *ret_int = (int)len_name;
  } break;

  case EX_INQ_GROUP_NAME:
    /* return name of group exoid. "/" returned for root group */
    /* Assumes that ret_char is large enough to hold name. */
    if (!ret_char) {
      snprintf(errmsg, MAX_ERR_LENGTH,
               "ERROR: Requested group name, but character pointer was "
               "null for file id %d",
               exoid);
      ex_err_fn(exoid, __func__, errmsg, EX_BADPARAM);
      return (EX_FATAL);
    }
#if NC_HAS_HDF5
    nc_inq_grpname(exoid, ret_char);
#endif
    break;

  case EX_INQ_FULL_GROUP_NAME_LEN: {
    size_t len_name = 0;
#if NC_HAS_HDF5
    /* return length of full group name which is the "/" separated path from
     * root
     * For example "/group1/subgroup1/subsubgroup1"
     * length does not include the NULL terminator byte.
     */
    nc_inq_grpname_full(exoid, &len_name, NULL);
#endif
    *ret_int = (int)len_name;
  } break;

  case EX_INQ_FULL_GROUP_NAME:
    /* return full path name of group exoid which is the "/" separated path from
     * root
     * For example "/group1/subgroup1/subsubgroup1"
     * Assumes that ret_char is large enough to hold full path name.
     */
    if (!ret_char) {
      snprintf(errmsg, MAX_ERR_LENGTH,
               "ERROR: Requested group name, but character pointer was "
               "null for file id %d",
               exoid);
      ex_err_fn(exoid, __func__, errmsg, EX_BADPARAM);
      return (EX_FATAL);
    }
#if NC_HAS_HDF5
    nc_inq_grpname_full(exoid, NULL, ret_char);
#endif
    break;

  case EX_INQ_THREADSAFE:
/* Return 1 if the library was compiled in thread-safe mode.
 * Return 0 otherwise
 */
#if defined(EXODUS_THREADSAFE)
    *ret_int = 1;
#else
    *ret_int = 0;
#endif
    break;

  default:
    *ret_int = 0;
    snprintf(errmsg, MAX_ERR_LENGTH, "ERROR: invalid inquiry %d", req_info);
    ex_err_fn(exoid, __func__, errmsg, EX_BADPARAM);
    return (EX_FATAL);
  }
  return (EX_NOERR);
}

/*!
  \ingroup Utilities

  A variant of ex_inquire() which queries integer-valued information only. \see
ex_inquire().
  \param[in] exoid     exodus file ID returned from a previous call to
ex_create() or ex_open().
  \param[in] req_info  A flag of type #ex_inquiry which designates what information is requested.
                       (See ex_inquire() documentation)
  \return    result of inquiry.

 As an example, the following will return the number of nodes,
 elements, and element blocks stored in the exodus file :

~~~{.c}
#include "exodusII.h"
int exoid;
int num_nodes = ex_inquire_int(exoid, EX_INQ_NODES);
int num_elems = ex_inquire_int(exoid, EX_INQ_ELEM);
int num_block = ex_inquire_int(exoid, EX_INQ_ELEM_BLK);
~~~

*/
int64_t ex_inquire_int(int exoid, ex_inquiry req_info)
{
  char *  cdummy  = NULL; /* Needed just for function call, unused. */
  float   fdummy  = 0;    /* Needed just for function call, unused. */
  int64_t ret_val = 0;
  int     error;
  EX_FUNC_ENTER();
  error = ex_inquire_internal(exoid, req_info, &ret_val, &fdummy, cdummy);
  if (error < 0) {
    ret_val = error;
  }
  EX_FUNC_LEAVE(ret_val);
}

/*!
  \ingroup Utilities

The function ex_inquire() is used to inquire values of certain
data entities in an exodus file. Memory must be allocated for the
returned values before this function is invoked.query database.

\sa ex_inquire_int(), ex_inquiry.

\return In case of an error, ex_inquire() returns a negative
        number; a warning will return a positive number.
        Possible causes of errors include:
  -  data file not properly opened with call to ex_create() or ex_open().
  -  requested information not stored in the file.
  -  invalid request flag.

\param[in] exoid     exodus file ID returned from a previous call to ex_create()
or ex_open().
\param[in] req_info  A flag of type #ex_inquiry which designates what information is requested. It
                     must be one of the following constants in the table below.

\param[out]  ret_int   Returned integer, if an integer value is requested
                       (according to req_info); otherwise, supply a dummy argument.

\param[out]  ret_float Returned float, if a float value is requested
                       (according to req_info); otherwise, supply a dummy
                       argument. This argument is always a float even if the
                       database IO and/or CPU word size is a double.

\param[out]  ret_char  Returned character string, if a character value is
                       requested (according to req_info);
                       otherwise, supply a dummy argument.

As an example, the following will return the number of element
block properties stored in the exodus file :

~~~{.c}
#include "exodusII.h"
int error, exoid, num_props;
float fdum;
char *cdum;

\comment{determine the number of element block properties}
error = ex_inquire (exoid, EX_INQ_EB_PROP, &num_props,
                    &fdum, cdum);

\comment{...Another way to get the same information}
num_props = ex_inquire_int(exoid, EX_INQ_EB_PROP);
~~~

*/

int ex_inquire(int exoid, ex_inquiry req_info, void_int *ret_int, float *ret_float, char *ret_char)
{
  int ierr;
  if (ex_int64_status(exoid) & EX_INQ_INT64_API) {
    EX_FUNC_ENTER();
    ierr = ex_inquire_internal(exoid, req_info, ret_int, ret_float, ret_char);
    EX_FUNC_LEAVE(ierr);
  }
  /* ret_int is a 32-bit int */
  int64_t tmp_int;
  int *   return_int = ret_int;

  EX_FUNC_ENTER();
  ierr        = ex_inquire_internal(exoid, req_info, &tmp_int, ret_float, ret_char);
  *return_int = (int)tmp_int;
  EX_FUNC_LEAVE(ierr);
}