cs_internal_coupling.h

Go to the documentation of this file.

#ifndef __CS_INTERNAL_COUPLING_H__
#define __CS_INTERNAL_COUPLING_H__
 
/*============================================================================
 * Internal coupling: coupling for one instance of code_saturne
 *============================================================================*/
 
/*
  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.
*/
 
/*----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 * PLE library headers
 *----------------------------------------------------------------------------*/
 
#include <ple_locator.h>
 
/*----------------------------------------------------------------------------
 *  Local headers
 *----------------------------------------------------------------------------*/
 
#include "base/cs_defs.h"
 
#include "base/cs_base.h"
#include "base/cs_field.h"
#include "alge/cs_matrix_assembler.h"
#include "mesh/cs_mesh.h"
#include "mesh/cs_mesh_quantities.h"
#include "base/cs_parameters.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*=============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/* Internal coupling structure definition */
 
typedef struct {
 
  /* Id */
  int id;
 
  /* Locator + tag for exchanging variables */
  ple_locator_t   *locator;
  int             *c_tag;
 
  /* Selection criteria for coupled domains */
  char  *cells_criteria;
  char  *faces_criteria;
 
  char *interior_faces_group_name;
  char *exterior_faces_group_name;
 
  /* Associated zone ids */
 
  int   n_volume_zones;
  int  *volume_zone_ids;
 
  cs_lnum_t  n_local; /* Number of faces */
  cs_lnum_t *faces_local; /* Coupling boundary faces, numbered 0..n-1 */
 
  cs_lnum_t  n_distant; /* Number of faces in faces_distant */
  cs_lnum_t *faces_distant; /* Distant boundary faces associated with locator */
 
  /* Face i is coupled in this entity if coupled_faces[i] = true */
  bool *coupled_faces;
 
  /* Geometrical weights around coupling interface */
  cs_real_t *g_weight;
 
  /* IJ vectors */
  cs_real_3_t *ci_cj_vect;
 
  /* OF vectors  */
  cs_real_3_t *offset_vect;
 
} cs_internal_coupling_t;
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
int
cs_internal_coupling_n_couplings(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_add(const char  criteria_cells[],
                         const char  criteria_faces[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_add_volume(const char criteria_cells[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_add_volume_zone(const cs_zone_t *z);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_add_volume_zones(int        n_zones,
                                      const int  zone_ids[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_add_boundary_groups(cs_internal_coupling_t  *cpl,
                                         const char              *interior_name,
                                         const char              *exterior_name);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_bcs(int         bc_type[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_finalize(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_internal_coupling_t *
cs_internal_coupling_by_id(int coupling_id);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_exchange_var(const cs_internal_coupling_t  *cpl,
                                  int                            stride,
                                  cs_real_t                      distant[],
                                  cs_real_t                      local[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_exchange_by_cell_id(const cs_internal_coupling_t  *cpl,
                                         int                            stride,
                                         const cs_real_t                tab[],
                                         cs_real_t                      local[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_exchange_by_face_id(const cs_internal_coupling_t  *cpl,
                                         int                            stride,
                                         const cs_real_t                tab[],
                                         cs_real_t                      local[]);
 
/*----------------------------------------------------------------------------
 * Modify iterative COCG matrix to include internal coupling
 *
 * parameters:
 *   cpl  <-- pointer to coupling entity
 *   cocg <-> cocg matrix modified
 *----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_it_cocg_contribution(const cs_internal_coupling_t  *cpl,
                                          cs_real_33_t                   cocg[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_setup(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_initialize(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_iterative_scalar_gradient
(
 const cs_internal_coupling_t  *cpl,
 const cs_real_t                c_weight[],
 cs_real_3_t                   *grad,
 const cs_real_t                pvar[],
 cs_real_3_t                    rhs[]
 );
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_iterative_vector_gradient
(
 const cs_internal_coupling_t  *cpl,
 const cs_real_t                c_weight[],
 cs_real_33_t                  *grad,
 const cs_real_3_t              pvar[],
 cs_real_33_t                   rhs[]
);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_iterative_tensor_gradient
(
 const cs_internal_coupling_t  *cpl,
 const cs_real_t                c_weight[],
 cs_real_63_t                  *grad,
 const cs_real_6_t              pvar[],
 cs_real_63_t                   rhs[]
);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_reconstruct_scalar_gradient(
    const cs_internal_coupling_t  *cpl,
    cs_real_3_t                   *r_grad,
    cs_real_3_t                    grad[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_reconstruct_vector_gradient(
    const cs_internal_coupling_t  *cpl,
    cs_real_33_t                  *r_grad,
    cs_real_33_t                   grad[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_reconstruct_tensor_gradient(
    const cs_internal_coupling_t  *cpl,
    cs_real_63_t                  *r_grad,
    cs_real_63_t                   grad[]);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_update_bc_coeff_s(const cs_field_bc_coeffs_t    *bc_coeffs,
                                       const cs_internal_coupling_t  *cpl,
                                       cs_halo_type_t                 halo_type,
                                       int                            w_stride,
                                       double                         clip_coeff,
                                       const cs_real_t               *var,
                                       const cs_real_t               *c_weight);
 
/*----------------------------------------------------------------------------
 * Addition to matrix-vector product in case of internal coupling.
 *
 * parameters:
 *   exclude_diag <-- extra diagonal flag
 *   f            <-- associated field pointer
 *   x            <-- vector x in m * x = y
 *   y            <-> vector y in m * x = y
 *----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_spmv_contribution(bool               exclude_diag,
                                       const cs_field_t  *f,
                                       const cs_real_t            *x,
                                       cs_real_t                  *y);
 
/*----------------------------------------------------------------------------
 * Add coupling term coordinates to matrix assembler.
 *
 * parameters:
 *   coupling_id
 *   r_g_id   <-- global row ids (per cell)
 *   ma       <-> matrix assembler
 *----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_matrix_add_ids(int                     coupling_id,
                                    const cs_gnum_t        *r_g_id,
                                    cs_matrix_assembler_t  *ma);
 
/*----------------------------------------------------------------------------
 * Add coupling terms to matrix values assembly.
 *
 * parameters:
 *   f        <-- associated field
 *   db_size  <-- diagonal block size
 *   eb_size  <-- extra-diagonal block size
 *   r_g_id   <-- global row ids (per cell)
 *   mav      <-> matrix values assembler
 *----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_matrix_add_values(const cs_field_t              *f,
                                       cs_lnum_t                      db_size,
                                       cs_lnum_t                      eb_size,
                                       const cs_gnum_t                r_g_id[],
                                       cs_matrix_assembler_values_t  *mav);
 
/*----------------------------------------------------------------------------
 * Return pointers to coupling components
 *
 * parameters:
 *   cpl             <-- pointer to coupling entity
 *   n_local         --> null or pointer to component n_local
 *   faces_local     --> null or pointer to component faces_local
 *   n_distant       --> null or pointer to component n_distant
 *   faces_distant   --> null or pointer to component faces_distant
 *----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_coupled_faces(const cs_internal_coupling_t  *cpl,
                                   cs_lnum_t                     *n_local,
                                   const cs_lnum_t               *faces_local[],
                                   cs_lnum_t                     *n_distant,
                                   const cs_lnum_t               *faces_distant[]);
 
/*----------------------------------------------------------------------------
 * Log information about a given internal coupling entity
 *
 * parameters:
 *   cpl <-- pointer to coupling entity
 *----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_log(const cs_internal_coupling_t  *cpl);
 
/*----------------------------------------------------------------------------
 * Print informations about all coupling entities
 *
 * parameters:
 *   cpl <-- pointer to coupling entity
 *----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_dump(void);
 
/*----------------------------------------------------------------------------
 * Add preprocessing operations required by coupling volume using given
 * criteria.
 *
 * The volume is separated from the rest of the domain with inserted
 * boundaries.
 *
 * parameters:
 *   mesh           <-> pointer to mesh structure to modify
 *----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_preprocess(cs_mesh_t   *mesh);
 
/*----------------------------------------------------------------------------
 * Define face to face mappings for internal couplings.
 *
 * parameters:
 *   mesh           <-> pointer to mesh structure to modify
 *----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_map(cs_mesh_t   *mesh);
 
/*----------------------------------------------------------------------------
 * Define coupling entity using given criteria.
 *
 * parameters:
 *   f_id       <-- id of the field
 *----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_add_entity(int        f_id);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_initialize_scalar_gradient
(
 const cs_internal_coupling_t  *cpl,
 const cs_real_t                c_weight[],
 const cs_real_t                pvar[],
 cs_real_3_t                   *grad
);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_initialize_vector_gradient
(
 const cs_internal_coupling_t  *cpl,
 const cs_real_t                c_weight[],
 const cs_real_3_t              pvar[],
 cs_real_33_t                  *grad
);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_internal_coupling_initialize_tensor_gradient
(
 const cs_internal_coupling_t  *cpl,
 const cs_real_t                c_weight[],
 const cs_real_6_t              pvar[],
 cs_real_63_t                  *grad
);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_ic_field_set_exchcoeff(const cs_field_t  *f,
                          const cs_real_t   *hbnd);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_ic_field_dist_data_by_face_id(const int         field_id,
                                 int               stride,
                                 const cs_real_t   tab_distant[],
                                 cs_real_t         tab_local[]);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#if defined(__cplusplus)
 
/*=============================================================================
 * Public C++ functions
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
template <cs_lnum_t stride>
void
cs_internal_coupling_update_bc_coeff_strided(const cs_field_bc_coeffs_t    *bc_coeffs_v,
                                             const cs_internal_coupling_t  *cpl,
                                             cs_halo_type_t                 halo_type,
                                             double                         clip_coeff,
                                             cs_real_t                     *df_limiter,
                                             const cs_real_t                var[][stride],
                                             const cs_real_t               *c_weight);
 
#endif // __cplusplus
 
#endif /* __CS_INTERNAL_COUPLING_H__ */