9.2
general documentation
cs_mesh_halo.h
Go to the documentation of this file.
1#ifndef CS_MESH_HALO_H
2#define CS_MESH_HALO_H
3
4/*============================================================================
5 * Structure and function headers handling with ghost cells
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2026 EDF S.A.
12
13 This program is free software; you can redistribute it and/or modify it under
14 the terms of the GNU General Public License as published by the Free Software
15 Foundation; either version 2 of the License, or (at your option) any later
16 version.
17
18 This program is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21 details.
22
23 You should have received a copy of the GNU General Public License along with
24 this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25 Street, Fifth Floor, Boston, MA 02110-1301, USA.
26*/
27
28/*----------------------------------------------------------------------------*/
29
30/*----------------------------------------------------------------------------
31 * Local headers
32 *----------------------------------------------------------------------------*/
33
34#include "base/cs_base.h"
35#include "base/cs_interface.h"
36#include "mesh/cs_mesh.h"
37
38/*=============================================================================
39 * Public function prototypes
40 *============================================================================*/
41
42/*----------------------------------------------------------------------------
43 * Define halo structures for internal and distant ghost cells.
44 *
45 * parameters:
46 * mesh <-- pointer to cs_mesh_t structure
47 * face_ifs <-- pointer to faces interfaces
48 * vertex_ifs <-- pointer to vertex interfaces
49 * p_gcell_vtx_idx --> pointer to the connectivity index
50 * p_gcell_vtx_lst --> pointer to the connectivity list
51 *---------------------------------------------------------------------------*/
52
53void
54cs_mesh_halo_define(cs_mesh_t *mesh,
55 cs_interface_set_t *face_ifs,
56 cs_interface_set_t *vertex_ifs,
57 cs_lnum_t *p_gcell_vtx_idx[],
58 cs_lnum_t *p_gcell_vtx_lst[]);
59
60/*----------------------------------------------------------------------------*/
61
62#endif /* CS_MESH_HALO_H */
cs_base.h
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:325
cs_interface.h
cs_interface_set_t
struct _cs_interface_set_t cs_interface_set_t
Definition: cs_interface.h:57
cs_mesh.h
cs_mesh_halo_define
void cs_mesh_halo_define(cs_mesh_t *mesh, cs_interface_set_t *face_ifs, cs_interface_set_t *vertex_ifs, cs_lnum_t *p_gcell_vtx_idx[], cs_lnum_t *p_gcell_vtx_lst[])
Definition: cs_mesh_halo.cpp:2980
mesh
Definition: mesh.f90:26
cs_mesh_t
Definition: cs_mesh.h:85