cs_cdo_connect.h

Go to the documentation of this file.

#ifndef __CS_CDO_CONNECT_H__
#define __CS_CDO_CONNECT_H__
 
/*============================================================================
 * Manage connectivity (Topological features of the mesh)
 *============================================================================*/
 
/*
  This file is part of code_saturne, a general-purpose CFD tool.
 
  Copyright (C) 1998-2025 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 "fvm/fvm_defs.h"
 
#include "base/cs_base.h"
#include "cdo/cs_flag.h"
#include "base/cs_param_types.h"
#include "mesh/cs_mesh.h"
#include "mesh/cs_mesh_adjacencies.h"
#include "base/cs_range_set.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
/* Additional macros */
 
#define CS_TRIANGLE_CASE          3 /* Number of vertices in a triangle */
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/* Connectivity structure */
 
typedef struct {
 
  /* Periodicity (copy from cs_mesh_t. Stored here to avoid to point to the
     mesh structure in many functions) */
 
  int                    n_init_perio;
 
  /* Vertex-related members */
  /* ---------------------- */
 
  cs_lnum_t              n_vertices;
 
  /* range set and interface set structures for scalar-valued vertex DoFs
     (these structures may be not allocated according to the settings) */
 
  cs_range_set_t        *vtx_rset;
  cs_interface_set_t    *vtx_ifs;
 
 
  /* Edge-related members */
  /* -------------------- */
 
  cs_lnum_t              n_edges;
  cs_gnum_t              n_g_edges;
 
  cs_adjacency_t        *e2v; /* edge --> vertices connectivity */
  cs_adjacency_t        *e2f; /* edge --> faces connectivity */
 
  /* range set and interface set structures for scalar-valued edge DoFs
     (these structures may be not allocated according to the settings) */
 
  cs_range_set_t        *edge_rset;
  cs_interface_set_t    *edge_ifs;
 
  /* Face-related members */
  /* -------------------- */
 
  cs_lnum_t              n_faces[3];  /* 0: all, 1: border, 2: interior */
 
  cs_adjacency_t        *f2c;         /* face --> cells connectivity */
  cs_adjacency_t        *f2e;         /* face --> edges connectivity */
  cs_adjacency_t        *bf2v;        /* border face --> vertices connectivity
                                         (map from cs_mesh_t) */
  cs_adjacency_t        *if2v;        /* interior face --> vertices connectivity
                                         (map from cs_mesh_t) */
 
  /* range set and interface set structures for scalar-valued edge DoFs
     (these structures may be not allocated according to the settings) */
 
  cs_range_set_t        *face_rset;
  cs_interface_set_t    *face_ifs;
 
  /* Cell-related members */
  /* -------------------- */
 
  cs_lnum_t              n_cells;
  cs_lnum_t              n_cells_with_ghosts;
 
  fvm_element_t         *cell_type;   /* type of cell */
  cs_flag_t             *cell_flag;   /* flag (border/solid) */
  cs_adjacency_t        *c2f;         /* cell --> faces connectivity */
  cs_adjacency_t        *c2e;         /* cell --> edges connectivity */
  cs_adjacency_t        *c2v;         /* cell --> vertices connectivity */
 
  /* Delta of ids between the min./max. values of entities related to a cell
     Useful to store compactly the link between mesh ids and cell mesh ids
     needed during the cell mesh definition */
 
  cs_lnum_t              e_max_cell_range;
  cs_lnum_t              v_max_cell_range;
 
  /* Max. connectitivy size for cells */
 
  int  n_max_vbyc;   /* max. number of vertices in a cell */
  int  n_max_ebyc;   /* max. number of edges in a cell */
  int  n_max_fbyc;   /* max. number of faces in a cell */
  int  n_max_vbyf;   /* max. number of vertices in a face */
  int  n_max_v2fc;   /* max. number of faces connected to a vertex in a cell */
  int  n_max_v2ec;   /* max. number of edges connected to a vertex in a cell */
 
  /* Adjacency related to linear systems (allocated only if needed) */
 
  cs_adjacency_t *v2v;    /* vertex to vertices through cells */
  cs_adjacency_t *f2f;    /* face to faces through cells */
  cs_adjacency_t *f2xf;   /* face to extended faces through cells + edges
                           * for MAC scheme */
  cs_adjacency_t *f2f_ed; /* face to faces through edges + same directions
                           * for MAC scheme */
  cs_adjacency_t *e2e;    /* edge to edges through cells */
 
} cs_cdo_connect_t;
 
/*============================================================================
 * Global variables
 *============================================================================*/
 
/*============================================================================
 * Static Inline Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static inline void
cs_connect_get_next_3_vertices(const cs_lnum_t   *f2e_ids,
                               const cs_lnum_t   *e2v_ids,
                               const cs_lnum_t    start_idx,
                               cs_lnum_t         *v0,
                               cs_lnum_t         *v1,
                               cs_lnum_t         *v2)
{
  const cs_lnum_t _2e0  = 2*f2e_ids[start_idx],
                  _2e1  = 2*f2e_ids[start_idx+1];
  const cs_lnum_t tmp = e2v_ids[_2e1];
 
  *v0 = e2v_ids[_2e0];
  *v1 = e2v_ids[_2e0+1];
  *v2 = ((tmp != *v0) && (tmp != *v1)) ? tmp : e2v_ids[_2e1+1];
}
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_cdo_connect_t *cs_cdo_connect_build(cs_mesh_t *mesh,
                                       cs_flag_t  eb_scheme_flag,
                                       cs_flag_t  fb_scheme_flag,
                                       cs_flag_t  cb_scheme_flag,
                                       cs_flag_t  vb_scheme_flag,
                                       cs_flag_t  vcb_scheme_flag,
                                       cs_flag_t  hho_scheme_flag,
                                       cs_flag_t  mac_scheme_flag);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_cdo_connect_t *
cs_cdo_connect_free(const cs_mesh_t    *mesh,
                    cs_cdo_connect_t   *connect);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_cdo_connect_log_summary(const cs_cdo_connect_t  *connect,
                           cs_flag_t                eb_scheme_flag,
                           cs_flag_t                vb_scheme_flag,
                           cs_flag_t                vcb_scheme_flag);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_cdo_connect_allocate_cw_buffer(const cs_cdo_connect_t      *connect);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_cdo_connect_free_cw_buffer(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
double *
cs_cdo_connect_get_cw_buffer(int   thr_id);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
long long
cs_cdo_connect_get_time_perfo(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_cdo_connect_assign_vtx_ifs_rs(const cs_mesh_t       *mesh,
                                 int                    n_vtx_dofs,
                                 bool                   interlaced,
                                 cs_interface_set_t   **p_ifs,
                                 cs_range_set_t       **p_rs);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_cdo_connect_assign_face_ifs_rs(const cs_mesh_t       *mesh,
                                  cs_lnum_t              n_faces,
                                  int                    n_face_dofs,
                                  cs_interface_set_t   **p_ifs,
                                  cs_range_set_t       **p_rs);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_interface_set_t *
cs_cdo_connect_define_face_interface(const cs_mesh_t       *mesh);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_cdo_connect_discrete_curl(const cs_cdo_connect_t    *connect,
                             const cs_real_t           *edge_values,
                             cs_real_t                **p_curl_values);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_cdo_connect_dump(const cs_cdo_connect_t  *connect);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_CDO_CONNECT_H__ */