descrdata.cpp

Go to the documentation of this file.

/* @authors 11/2023 :: ICON Community Interface  <comin@icon-model.org>
 
   SPDX-License-Identifier: BSD-3-Clause
 
   Please see the file LICENSE in the root of the source tree for this code.
   Where software is supplied by third parties, it is indicated in the
   headers of the routines. */
 
#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include <cstring>
#include <iostream>
#include <stdexcept>
#include <string>
#include <tuple>
#include <vector>
 
#include "util.h"
 
#include "comin.h"
#include "descrdata_properties.h"
#include "exception.h"
 
namespace comin::python {
 
static PyObject* current_get_plugin_info(PyObject* /*self*/,
                                         PyObject* /*args*/) {
  int plugin_id = comin_current_get_plugin_id();
  check_error();
  const char* plugin_name = comin_current_get_plugin_name();
  check_error();
 
  const char* plugin_options = comin_current_get_plugin_options();
  check_error();
 
  const char* plugin_comm = comin_current_get_plugin_comm();
  check_error();
 
  return Py_BuildValue("{sissssss}", "id", plugin_id, "name", plugin_name,
                       "options", plugin_options, "comm", plugin_comm);
}
 
static PyObject* descrdata_get_domain(PyObject* /*self*/, PyObject* /*args*/) {
  return descrdata_properties_to_dict(comin_descrdata_domain_properties);
}
 
static PyObject* descrdata_get_global(PyObject* /*self*/, PyObject* /*args*/) {
  return descrdata_properties_to_dict(comin_descrdata_global_properties);
}
 
static PyObject* descrdata_get_simulation_interval(PyObject* /*self*/,
                                                   PyObject* /*args*/) {
  const char* exp_start = comin_descrdata_get_simulation_interval_exp_start();
  check_error();
  const char* exp_stop = comin_descrdata_get_simulation_interval_exp_stop();
  check_error();
  const char* run_start = comin_descrdata_get_simulation_interval_run_start();
  check_error();
  const char* run_stop = comin_descrdata_get_simulation_interval_run_stop();
  check_error();
 
  return Py_BuildValue("{ssssssss}", "exp_start", exp_start, "exp_stop",
                       exp_stop, "run_start", run_start, "run_stop", run_stop);
}

static PyObject* descrdata_get_timesteplength(PyObject* /*self*/,
                                              PyObject* args,
                                              PyObject* kwargs) {
  int j;
  static char const* kwlist[] = {"j", NULL};
  if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i", (char**)&kwlist, &j))
    return NULL;
  double t = comin_descrdata_get_timesteplength(j);
  check_error();
  return PyFloat_FromDouble(t);
}

static PyObject* descrdata_get_index(PyObject* /*self*/, PyObject* args,
                                     PyObject* kwargs) {
  int j;
  static char const* kwlist[] = {"j", NULL};
  if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i", (char**)&kwlist, &j))
    return NULL;
  int i = comin_descrdata_get_index(j);
  check_error();
  return PyLong_FromLong(i);
}

static PyObject* descrdata_get_block(PyObject* /*self*/, PyObject* args,
                                     PyObject* kwargs) {
  int j;
  static char const* kwlist[] = {"j", NULL};
  if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i", (char**)&kwlist, &j))
    return NULL;
  int b = comin_descrdata_get_block(j);
  check_error();
  return PyLong_FromLong(b);
}
 
using BlockLimitGetterFn = void (*)(int jg, int irl_start, int irl_end,
                                    int* i_startblk, int* i_endblk);

template <BlockLimitGetterFn get_block_limits>
static PyObject* descrdata_get_block_limits(PyObject* /*self*/, PyObject* args,
                                            PyObject* kwargs) {
  int jg, irl_start, irl_end;
  static char const* kwlist[] = {"jg", "irl_start", "irl_end", NULL};
  if (!PyArg_ParseTupleAndKeywords(args, kwargs, "iii", (char**)&kwlist, &jg,
                                   &irl_start, &irl_end))
    return NULL;
  int i_startblk, i_endblk;
  get_block_limits(jg, irl_start, irl_end, &i_startblk, &i_endblk);
  check_error();
  return Py_BuildValue("ii", i_startblk, i_endblk);
}
 
using IndexGetterFn = void (*)(int jg, int i_blk, int i_startblk, int i_endblk,
                               int* i_startidx, int* i_endidx, int irl_start,
                               int irl_end);

template <IndexGetterFn get_indices>
static PyObject* descrdata_get_indices(PyObject* /*self*/, PyObject* args,
                                       PyObject* kwargs) {
  int jg, i_blk, i_startblk, i_endblk, irl_start, irl_end;
  static char const* kwlist[] = {
      "jg", "i_blk", "i_startblk", "i_endblk", "irl_start", "irl_end", NULL};
  if (!PyArg_ParseTupleAndKeywords(args, kwargs, "iiiiii", (char**)&kwlist, &jg,
                                   &i_blk, &i_startblk, &i_endblk, &irl_start,
                                   &irl_end))
    return NULL;
  int i_startidx, i_endidx;
  get_indices(jg, i_blk, i_startblk, i_endblk, &i_startidx, &i_endidx,
              irl_start, irl_end);
  check_error();
  return Py_BuildValue("ii", i_startidx, i_endidx);
}

static PyObject* descrdata_get_cell_npromz(PyObject* /*self*/, PyObject* args,
                                           PyObject* kwargs) {
  int jg;
  static char const* kwlist[] = {"jg", NULL};
  if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i", (char**)&kwlist, &jg))
    return NULL;
  int npz = comin_descrdata_get_cell_npromz(jg);
  check_error();
  return PyLong_FromLong(npz);
}

static PyObject* descrdata_get_edge_npromz(PyObject* /*self*/, PyObject* args,
                                           PyObject* kwargs) {
  int jg;
  static char const* kwlist[] = {"jg", NULL};
  if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i", (char**)&kwlist, &jg))
    return NULL;
  int npz = comin_descrdata_get_edge_npromz(jg);
  check_error();
  return PyLong_FromLong(npz);
}

static PyObject* descrdata_get_vert_npromz(PyObject* /*self*/, PyObject* args,
                                           PyObject* kwargs) {
  int jg;
  static char const* kwlist[] = {"jg", NULL};
  if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i", (char**)&kwlist, &jg))
    return NULL;
  int npz = comin_descrdata_get_vert_npromz(jg);
  check_error();
  return PyLong_FromLong(npz);
}

static PyObject* current_get_datetime(PyObject* /*self*/, PyObject* /*args*/) {
  const char* datetime_str = comin_current_get_datetime();
  check_error();
  return PyUnicode_FromString(datetime_str);
}

static PyObject* current_get_domain_id(PyObject* /*self*/, PyObject* /*args*/) {
  int jg = comin_current_get_domain_id();
  check_error();
  if (jg < 0)
    return PyErr_Format(PyExc_RuntimeError,
                        "comin_current_get_domain_id failed. (jg=%d)", jg);
  return PyLong_FromLong(jg);
}

static PyObject* descrdata_index_lookup_glb2loc_cell(PyObject* /*self*/,
                                                     PyObject* args,
                                                     PyObject* kwargs) {
  int jg, global_idx;
  static char const* kwlist[] = {"jg", "global_idx", NULL};
  if (!PyArg_ParseTupleAndKeywords(args, kwargs, "ii", (char**)&kwlist, &jg,
                                   &global_idx))
    return NULL;
  int loc = comin_descrdata_index_lookup_glb2loc_cell(jg, global_idx);
  check_error();
  return PyLong_FromLong(loc);
}

static PyObject* descrdata_index_lookup_glb2loc_edge(PyObject* /*self*/,
                                                     PyObject* args,
                                                     PyObject* kwargs) {
  int jg, global_idx;
  static char const* kwlist[] = {"jg", "global_idx", NULL};
  if (!PyArg_ParseTupleAndKeywords(args, kwargs, "ii", (char**)&kwlist, &jg,
                                   &global_idx))
    return NULL;
  int loc = comin_descrdata_index_lookup_glb2loc_edge(jg, global_idx);
  check_error();
  return PyLong_FromLong(loc);
}

static PyObject* descrdata_index_lookup_glb2loc_vert(PyObject* /*self*/,
                                                     PyObject* args,
                                                     PyObject* kwargs) {
  int jg, global_idx;
  static char const* kwlist[] = {"jg", "global_idx", NULL};
  if (!PyArg_ParseTupleAndKeywords(args, kwargs, "ii", (char**)&kwlist, &jg,
                                   &global_idx))
    return NULL;
  int loc = comin_descrdata_index_lookup_glb2loc_vert(jg, global_idx);
  check_error();
  return PyLong_FromLong(loc);
}

static PyObject* setup_get_version(PyObject* /*self*/, PyObject* /*args*/) {
  unsigned int major, minor, patch;
  comin_setup_get_version(&major, &minor, &patch);
  check_error();
  return Py_BuildValue("iii", major, minor, patch);
}

static PyObject* parallel_get_host_mpi_comm(PyObject* /*self*/,
                                            PyObject* /*args*/) {
  int comm = comin_parallel_get_host_mpi_comm();
  check_error();
  return PyLong_FromLong((long)comm);
}

static PyObject* parallel_get_plugin_mpi_comm(PyObject* /*self*/,
                                              PyObject* /*args*/) {
  int comm = comin_parallel_get_plugin_mpi_comm();
  check_error();
  return PyLong_FromLong((long)comm);
}

static PyObject* parallel_get_host_mpi_rank(PyObject* /*self*/,
                                            PyObject* /*args*/) {
  int rank = comin_parallel_get_host_mpi_rank();
  check_error();
  return PyLong_FromLong((long)rank);
}

static PyObject* print_debug(PyObject* /*self*/, PyObject* args,
                             PyObject* kwargs) {
  PyObject* pymsg;
  static char const* kwlist[] = {"msg", NULL};
  if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O", (char**)&kwlist, &pymsg))
    return NULL;
  PyObject* msg_str = PyObject_Str(pymsg);
  if (!PyUnicode_Check(msg_str)) {
    return PyErr_Format(PyExc_ValueError, "Conversion to string failed");
  }
  const char* val_str = PyUnicode_AsUTF8(msg_str);
  if (!val_str)
    return NULL;
  comin_print_debug(val_str);
  check_error();
  Py_DECREF(msg_str);
  Py_RETURN_NONE;
}

static PyObject* print_info(PyObject* /*self*/, PyObject* args,
                            PyObject* kwargs) {
  PyObject* pymsg;
  static char const* kwlist[] = {"msg", NULL};
  if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O", (char**)&kwlist, &pymsg))
    return NULL;
  PyObject* msg_str = PyObject_Str(pymsg);
  if (!PyUnicode_Check(msg_str)) {
    return PyErr_Format(PyExc_ValueError, "Conversion to string failed");
  }
  const char* val_str = PyUnicode_AsUTF8(msg_str);
  if (!val_str)
    return NULL;
  comin_print_info(val_str);
  check_error();
  Py_DECREF(msg_str);
  Py_RETURN_NONE;
}

static PyObject* print_warning(PyObject* /*self*/, PyObject* args,
                               PyObject* kwargs) {
  PyObject* pymsg;
  static char const* kwlist[] = {"msg", NULL};
  if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O", (char**)&kwlist, &pymsg))
    return NULL;
  PyObject* msg_str = PyObject_Str(pymsg);
  if (!PyUnicode_Check(msg_str)) {
    return PyErr_Format(PyExc_ValueError, "Conversion to string failed");
  }
  const char* val_str = PyUnicode_AsUTF8(msg_str);
  if (!val_str)
    return NULL;
  comin_print_warning(val_str);
  check_error();
  Py_DECREF(msg_str);
  Py_RETURN_NONE;
}
 
const std::vector<PyMethodDef> descrdata_methods() {
  return {
      {"_current_get_plugin_info", func_wrapper<current_get_plugin_info>,
       METH_NOARGS, ""},
      {"_descrdata_eval_property",
       (PyCFunction)func_wrapper<descrdata_eval_property>,
       METH_VARARGS | METH_KEYWORDS, ""},
      {"_descrdata_get_domain", func_wrapper<descrdata_get_domain>, METH_NOARGS,
       ""},
      {"_descrdata_get_global", func_wrapper<descrdata_get_global>, METH_NOARGS,
       ""},
      {"_descrdata_get_simulation_interval",
       func_wrapper<descrdata_get_simulation_interval>, METH_NOARGS, ""},
      {"descrdata_get_timesteplength",
       (PyCFunction)func_wrapper<descrdata_get_timesteplength>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `void double "
       "comin_descrdata_get_timesteplength(int jg)`"},
      {"descrdata_get_index", (PyCFunction)func_wrapper<descrdata_get_index>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `int comin_descrdata_get_index(int j)`"},
      {"descrdata_get_block", (PyCFunction)func_wrapper<descrdata_get_block>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `int comin_descrdata_get_block(int j)`"},
      {"descrdata_get_cell_block_limits",
       (PyCFunction)func_wrapper<
           descrdata_get_block_limits<comin_descrdata_get_cell_block_limits>>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `void comin_descrdata_get_cell_block_limits(int "
       "jg, int irl_start, int irl_end, int* i_startblk, int* i_endblk)`"},
      {"descrdata_get_edge_block_limits",
       (PyCFunction)func_wrapper<
           descrdata_get_block_limits<comin_descrdata_get_edge_block_limits>>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `void comin_descrdata_get_edge_block_limits(int "
       "jg, int irl_start, int irl_end, int* i_startblk, int* i_endblk)`"},
      {"descrdata_get_vert_block_limits",
       (PyCFunction)func_wrapper<
           descrdata_get_block_limits<comin_descrdata_get_vert_block_limits>>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `void comin_descrdata_get_vert_block_limits(int "
       "jg, int irl_start, int irl_end, int* i_startblk, int* i_endblk)`"},
      {"descrdata_get_cell_indices",
       (PyCFunction)func_wrapper<
           descrdata_get_indices<comin_descrdata_get_cell_indices>>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `void comin_descrdata_get_cell_indices(int jg, "
       "int i_blk, int i_startblk, int i_endblk, int* i_startidx, int* "
       "i_endidx, int irl_start, int irl_end)`"},
      {"descrdata_get_edge_indices",
       (PyCFunction)func_wrapper<
           descrdata_get_indices<comin_descrdata_get_edge_indices>>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `void comin_descrdata_get_edge_indices(int jg, "
       "int i_blk, int i_startblk, int i_endblk, int* i_startidx, int* "
       "i_endidx, int irl_start, int irl_end)`"},
      {"descrdata_get_vert_indices",
       (PyCFunction)func_wrapper<
           descrdata_get_indices<comin_descrdata_get_vert_indices>>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `void comin_descrdata_get_vert_indices(int jg, "
       "int i_blk, int i_startblk, int i_endblk, int* i_startidx, int* "
       "i_endidx, int irl_start, int irl_end)`"},
      {"descrdata_get_cell_npromz",
       (PyCFunction)func_wrapper<descrdata_get_cell_npromz>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `int comin_descrdata_get_cell_npromz(int jg)`"},
      {"descrdata_get_edge_npromz",
       (PyCFunction)func_wrapper<descrdata_get_edge_npromz>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `int comin_descrdata_get_edge_npromz(int jg)`"},
      {"descrdata_get_vert_npromz",
       (PyCFunction)func_wrapper<descrdata_get_vert_npromz>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `int comin_descrdata_get_vert_npromz(int jg)`"},
      {"current_get_datetime", func_wrapper<current_get_datetime>, METH_NOARGS,
       "C function signature: `const char* comin_current_get_datetime();`"},
      {"current_get_domain_id", func_wrapper<current_get_domain_id>,
       METH_NOARGS,
       "C function signature: `int comin_current_get_domain_id()`"},
      {"descrdata_index_lookup_glb2loc_cell",
       (PyCFunction)func_wrapper<descrdata_index_lookup_glb2loc_cell>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `int "
       "comin_descrdata_index_lookup_glb2loc_cell(int jg, int global_idx)`"},
      {"descrdata_index_lookup_glb2loc_edge",
       (PyCFunction)func_wrapper<descrdata_index_lookup_glb2loc_edge>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `int "
       "comin_descrdata_index_lookup_glb2loc_edge(int jg, int global_idx)`"},
      {"descrdata_index_lookup_glb2loc_vert",
       (PyCFunction)func_wrapper<descrdata_index_lookup_glb2loc_vert>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `int "
       "comin_descrdata_index_lookup_glb2loc_vert(int jg, int global_idx)`"},
      {"setup_get_version", func_wrapper<setup_get_version>, METH_NOARGS,
       "returns (major, minor, patch) version info"},
      {"parallel_get_host_mpi_comm", func_wrapper<parallel_get_host_mpi_comm>,
       METH_NOARGS,
       "C function signature: `int comin_parallel_get_host_mpi_comm()`"},
      {"parallel_get_plugin_mpi_comm",
       func_wrapper<parallel_get_plugin_mpi_comm>, METH_NOARGS,
       "C function signature: `int comin_parallel_get_host_mpi_comm()`"},
      {"parallel_get_host_mpi_rank", func_wrapper<parallel_get_host_mpi_rank>,
       METH_NOARGS,
       "C function signature: `int comin_parallel_get_host_mpi_rank()`"},
      {"print_debug", (PyCFunction)func_wrapper<print_debug>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `void comin_print_debug(const char* msg)`"},
      {"print_info", (PyCFunction)func_wrapper<print_info>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `void comin_print_info(const char* msg)`"},
      {"print_warning", (PyCFunction)func_wrapper<print_warning>,
       METH_VARARGS | METH_KEYWORDS,
       "C function signature: `void comin_print_warning(const char* msg)`"},
  };
}
} // namespace comin::python