cs_paramedmem_coupling_utils.h

Go to the documentation of this file.

#ifndef CS_PARAMEDMEM_UTILS_HXX
#define CS_PARAMEDMEM_UTILS_HXX
 
/*============================================================================
 * MEDCoupling ParaMESH/ParaFIELD wrapper functions.
 *============================================================================*/
 
/*
  This file is part of code_saturne, a general-purpose CFD tool.
 
  Copyright (C) 1998-2026 EDF S.A.
 
  This program 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 2 of the License, or (at your option) any later
  version.
 
  This program 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
  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
  Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
 
/*----------------------------------------------------------------------------
 *  Local headers
 *----------------------------------------------------------------------------*/
 
#include "base/cs_medcoupling_mesh.hxx"
#include "base/cs_paramedmem_coupling.h"
 
#if defined(HAVE_PARAMEDMEM)
 
DISABLE_WARNING_PUSH
// Disable this warning on LLVM based compilers
DISABLE_WARNING_LLVM(-Winconsistent-missing-override)
#include <MEDCouplingField.hxx>
#include <MEDCouplingFieldDouble.hxx>
DISABLE_WARNING_POP
 
#if defined(HAVE_PARAMEDMEM_CFEMDEC)
#include <CFEMDEC.hxx>
#endif
#if defined(HAVE_PARAMEDMEM_IKDECWO)
#include <InterpKernelDECWithOverlap.hxx>
#else
#include <InterpKernelDEC.hxx>
#endif
#include <ParaFIELD.hxx>
#include <ParaMESH.hxx>
 
using namespace MEDCoupling;
#endif
 
/*----------------------------------------------------------------------------*/
 
/*============================================================================
 * Structure definitions
 *============================================================================*/
 
/*----------------------------------------------------------------------------
 * MEDCoupling writer/reader structure
 *----------------------------------------------------------------------------*/
 
struct _cs_paramedmem_coupling_t {
  /* Coupling Name */
  std::string _name; /* Coupling name */
 
#if defined(HAVE_MPI)
  /* Current app name */
  ple_coupling_mpi_set_info_t apps[2];
#endif
 
#if defined(HAVE_PARAMEDMEM)
 
  cs_medcoupling_mesh_t *mesh;
 
  ParaMESH *para_mesh; /* Associated ParaMESH structure. */
 
#if defined(HAVE_PARAMEDMEM_IKDECWO)
  InterpKernelDECWithOverlap *dec; /* Data Exchange Channel with Overlap */
#else
  InterpKernelDEC *dec; /* Data Exchange Channel */
#endif
#if defined(HAVE_PARAMEDMEM_CFEMDEC)
  CFEMDEC *cdec; /* Data Exchange Channel with FE interpolation*/
#endif
 
  std::vector<ParaFIELD *> fields;
 
  /* Current attached local field id */
  const ParaFIELD *_curr_field;
 
#else
 
  void *para_mesh;
  void *dec;
  void *fields;
 
#endif
 
  /* Current attached local field id */
 
#if defined(HAVE_MPI)
  MPI_Comm comm;
#else
  int comm;
#endif
 
  bool dec_synced;
 
private:
  void
  _error_without_paramedmem() const
  {
#if !defined(HAVE_PARAMEDMEM)
 
    bft_error(__FILE__,
              __LINE__,
              0,
              _("Error: %s cannot be called without "
                "MEDCoupling MPI support."),
              __func__);
#endif
  };
 
#if defined(HAVE_PARAMEDMEM)
 
  /*--------------------------------------------------------------------------*/
  /*----------------------------------------------------------------------------*/
 
  DataArrayIdType *
  _computeGlobalNodeIds(const cs_mesh_t *parent_mesh) const;
 
  /*----------------------------------------------------------------------------*/
  /*----------------------------------------------------------------------------*/
 
  void
  _creare_paraMesh(const cs_mesh_t *parent_mesh);
 
  /*----------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  _attachLocalField(const ParaFIELD *field);
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  MEDCouplingFieldDouble *
  _get_field(const char *name) const;
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  _generate_coupling_mesh(const char *select_criteria, int elt_dim);
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  _generate_coupling_mesh_from_ids(cs_lnum_t       n_elts,
                                   const cs_lnum_t elt_ids[],
                                   int             elt_dim);
 
#endif /* HAVE_PARAMEDMEM */
 
public:
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  add_mesh_from_criteria(const char *sel_crit, int elt_dim);
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  add_mesh_from_zone(const cs_zone_t *zone);
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  add_mesh_from_ids(cs_lnum_t n_elts, const cs_lnum_t elt_ids[], int elt_dim);
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  std::string
  getName() const
  {
    return _name;
  }
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  cs_lnum_t
  get_n_elts() const
  {
    cs_lnum_t retval = 0;
 
#if !defined(HAVE_PARAMEDMEM)
 
    this->_error_without_paramedmem();
 
#else
 
    retval = this->mesh->n_elts;
 
#endif
 
    return retval;
  }
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  const cs_lnum_t *
  get_elt_list() const
  {
    const cs_lnum_t *retval = nullptr;
 
#if !defined(HAVE_PARAMEDMEM)
 
    this->_error_without_paramedmem();
 
#else
 
    retval = this->mesh->elt_list;
 
#endif
 
    return retval;
  }
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  cs_lnum_t
  get_n_vertices() const
  {
    cs_lnum_t retval = 0;
 
#if !defined(HAVE_PARAMEDMEM)
 
    this->_error_without_paramedmem();
 
#else
 
    retval = cs_medcoupling_mesh_get_n_vertices(this->mesh);
 
#endif
 
    return retval;
  }
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  const cs_lnum_t *
  get_vertex_list() const
  {
    const cs_lnum_t *retval = nullptr;
 
#if !defined(HAVE_PARAMEDMEM)
 
    this->_error_without_paramedmem();
 
#else
 
    retval = this->mesh->vtx_list;
 
#endif
 
    return retval;
  }
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  int
  add_field(const char              *name,
            int                      dim,
            cs_medcpl_field_nature_t field_nature,
            cs_medcpl_space_discr_t  space_discr,
            cs_medcpl_time_discr_t   time_discr);
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  int
  add_field(const cs_field_t        *f,
            cs_medcpl_field_nature_t fn,
            cs_medcpl_time_discr_t   td);
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  set_values(const char  *name,
             const double values[],
             const bool   use_list_elt = true);
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  get_values(const char *name,
             double      values[],
             const bool  use_list_elt = true) const;
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  send_data() const;
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  send_data(const char   *name,
            const double *vals,
            const bool    use_list_elt = true);
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  recv_data();
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  recv_data(const char *name, double *vals, const bool use_list_elt = true);
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  sync_dec();
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  attach_field_by_id(int field_id);
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  attach_field_by_name(const char *name);
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  void
  log() const;
};
 
/*----------------------------------------------------------------------------*/
 
#endif /* CS_PARAMEDMEM_UTILS_HXX */