8.3
general documentation
cs_mesh_adjacencies.h
Go to the documentation of this file.
1#ifndef __CS_MESH_ADJACENCIES_H__
2#define __CS_MESH_ADJACENCIES_H__
3
4/*============================================================================
5 * Additional mesh adjacencies.
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2024 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 "cs_base.h"
35#include "cs_base_accel.h"
36#include "cs_halo.h"
37#include "cs_mesh.h"
38
39/*----------------------------------------------------------------------------*/
40
42
43/*=============================================================================
44 * Macro definitions
45 *============================================================================*/
46
54#define CS_ADJACENCY_SHARED (1 << 0)
56#define CS_ADJACENCY_STRIDE (1 << 1)
58#define CS_ADJACENCY_SIGNED (1 << 2)
59
62/*============================================================================
63 * Type definitions
64 *============================================================================*/
65
68typedef struct {
69
71 int stride;
76 short int *sgn;
79
82typedef struct {
83
84 /* metadata */
85
89 /* cells -> cells connectivity (standard) */
90
94 /* cells -> cells connectivity (extended) */
95
99 /* cells->interior faces connectivity
100 (same index as cells->cells connectivity) */
101
103 short int *cell_i_faces_sgn;
105 /* cells -> boundary faces connectivity */
106
110 /* cells -> hidden boundary faces connectivity, if present;
111 "hidden" boundary faces are those whose ids are in the meshe's
112 ] n_b_faces, n_b_faces_all ] range */
113
119 /* cells -> faces connectivity */
120
126 /* cells -> vertices connectivity */
127
134
135/*============================================================================
136 * Global variables
137 *============================================================================*/
138
139/* Read-only pointer to global mesh additional adjacencies structure */
140
142
143/*=============================================================================
144 * Public function prototypes
145 *============================================================================*/
146
147/*----------------------------------------------------------------------------*/
151/*----------------------------------------------------------------------------*/
152
155
156/*----------------------------------------------------------------------------*/
160/*----------------------------------------------------------------------------*/
161
162void
164
165/*----------------------------------------------------------------------------*/
169/*----------------------------------------------------------------------------*/
170
171void
173
174/*----------------------------------------------------------------------------*/
178/*----------------------------------------------------------------------------*/
179
180void
182
183/*----------------------------------------------------------------------------*/
188/*----------------------------------------------------------------------------*/
189
190void
192
193/*----------------------------------------------------------------------------*/
198/*----------------------------------------------------------------------------*/
199
200void
202
203/*----------------------------------------------------------------------------*/
212/*----------------------------------------------------------------------------*/
213
214void
216
217/*----------------------------------------------------------------------------*/
227/*----------------------------------------------------------------------------*/
228
229const cs_adjacency_t *
231
232/*----------------------------------------------------------------------------*/
240/*----------------------------------------------------------------------------*/
241
242const cs_adjacency_t *
244
245/*----------------------------------------------------------------------------*/
255/*----------------------------------------------------------------------------*/
256
259 int stride,
260 cs_lnum_t n_elts);
261
262/*----------------------------------------------------------------------------*/
274/*----------------------------------------------------------------------------*/
275
278 int stride,
279 cs_lnum_t *ids,
280 short int *sgn);
281
282/*----------------------------------------------------------------------------*/
294/*----------------------------------------------------------------------------*/
295
298 cs_lnum_t *idx,
299 cs_lnum_t *ids,
300 short int *sgn);
301
302/*----------------------------------------------------------------------------*/
308/*----------------------------------------------------------------------------*/
309
310void
312
313/*----------------------------------------------------------------------------*/
326/*----------------------------------------------------------------------------*/
327
329cs_adjacency_compose(int n_c_elts,
330 const cs_adjacency_t *a2b,
331 const cs_adjacency_t *b2c);
332
333/*----------------------------------------------------------------------------*/
349/*----------------------------------------------------------------------------*/
350
352 const cs_adjacency_t *a2b_2);
353
354/*----------------------------------------------------------------------------*/
370/*----------------------------------------------------------------------------*/
371
373 const cs_adjacency_t *a2b_2);
374
375/*----------------------------------------------------------------------------*/
385/*----------------------------------------------------------------------------*/
386
388cs_adjacency_transpose(int n_b_elts,
389 const cs_adjacency_t *a2b);
390
391/*----------------------------------------------------------------------------*/
398/*----------------------------------------------------------------------------*/
399
400void
402
403/*----------------------------------------------------------------------------*/
411/*----------------------------------------------------------------------------*/
412
413void
415
416/*----------------------------------------------------------------------------*/
425/*----------------------------------------------------------------------------*/
426
427void
428cs_adjacency_dump(const char *name,
429 FILE *_f,
430 cs_adjacency_t *adj);
431
432/*----------------------------------------------------------------------------*/
446/*----------------------------------------------------------------------------*/
447
450 int boundary_order);
451
452/*----------------------------------------------------------------------------*/
474/*----------------------------------------------------------------------------*/
475
478 int boundary_order);
479
480/*----------------------------------------------------------------------------*/
490/*----------------------------------------------------------------------------*/
491
494
495/*----------------------------------------------------------------------------*/
508/*----------------------------------------------------------------------------*/
509
512
513/*----------------------------------------------------------------------------*/
514
516
517#endif /* __CS_MESH_ADJACENCIES__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
#define END_C_DECLS
Definition: cs_defs.h:543
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:335
unsigned short int cs_flag_t
Definition: cs_defs.h:344
cs_alloc_mode_t
Definition: cs_mem.h:50
void cs_mesh_adjacencies_update_cell_cells_e(void)
Update extended cell -> cell connectivites in mesh adjacencies helper API relative to mesh.
Definition: cs_mesh_adjacencies.cpp:773
const cs_adjacency_t * cs_mesh_adjacencies_cell_faces(void)
Return cell -> face connectivites in mesh adjacencies helper API relative to mesh.
Definition: cs_mesh_adjacencies.cpp:877
cs_mesh_adjacencies_t * cs_mesh_adjacencies_get_global(void)
Get non-const pointer to cs_glob_mesh_adacencies.
Definition: cs_mesh_adjacencies.cpp:653
void cs_adjacency_destroy(cs_adjacency_t **p_adj)
Destroy a cs_adjacency_t structure.
Definition: cs_mesh_adjacencies.cpp:1065
cs_adjacency_t * cs_mesh_adjacency_c2f_boundary(const cs_mesh_t *m)
Build a cells to boundary faces adjacency structure.
Definition: cs_mesh_adjacencies.cpp:2035
void cs_adjacency_dump(const char *name, FILE *_f, cs_adjacency_t *adj)
Dump a cs_adjacency_t structure to a file or into the standard output.
Definition: cs_mesh_adjacencies.cpp:1723
cs_adjacency_t * cs_adjacency_compose(int n_c_elts, const cs_adjacency_t *a2b, const cs_adjacency_t *b2c)
Create a new cs_adjacency_t structure from the composition of two cs_adjacency_t structures: (1) A ->...
Definition: cs_mesh_adjacencies.cpp:1103
void cs_mesh_adjacencies_update_cell_i_faces(void)
Ensure presence of cell -> interior face connectivites in mesh adjacencies helper API relative to mes...
Definition: cs_mesh_adjacencies.cpp:791
cs_adjacency_t * cs_adjacency_create(cs_flag_t flag, int stride, cs_lnum_t n_elts)
Create a cs_adjacency_t structure of size n_elts.
Definition: cs_mesh_adjacencies.cpp:927
cs_adjacency_t * cs_adjacency_create_from_s_arrays(cs_lnum_t n_elts, int stride, cs_lnum_t *ids, short int *sgn)
Create a cs_adjacency_t structure sharing arrays scanned with a stride.
Definition: cs_mesh_adjacencies.cpp:987
void cs_mesh_adjacencies_initialize(void)
Initialize mesh adjacencies helper API.
Definition: cs_mesh_adjacencies.cpp:665
cs_adjacency_t * cs_adjacency_difference(const cs_adjacency_t *a2b_1, const cs_adjacency_t *a2b_2)
Create a new cs_adjacency_t structure from the difference of two cs_adjacency_t structures: A -> B cr...
Definition: cs_mesh_adjacencies.cpp:1420
cs_adjacency_t * cs_adjacency_transpose(int n_b_elts, const cs_adjacency_t *a2b)
Create a new cs_adjacency_t structure from a one corresponding to A -> B. The resulting structure dea...
Definition: cs_mesh_adjacencies.cpp:1506
void cs_adjacency_sort(cs_adjacency_t *adj)
Sort each sub-list related to an entry in a cs_adjacency_t structure.
Definition: cs_mesh_adjacencies.cpp:1634
cs_adjacency_t * cs_mesh_adjacency_c2f(const cs_mesh_t *m, int boundary_order)
Build a cells to faces adjacency structure.
Definition: cs_mesh_adjacencies.cpp:1816
cs_adjacency_t * cs_adjacency_create_from_i_arrays(cs_lnum_t n_elts, cs_lnum_t *idx, cs_lnum_t *ids, short int *sgn)
Create a cs_adjacency_t structure sharing arrays scanned with an index.
Definition: cs_mesh_adjacencies.cpp:1033
const cs_adjacency_t * cs_mesh_adjacencies_cell_vertices(void)
Return cell -> vertex connectivites in mesh adjacencies helper API relative to mesh.
Definition: cs_mesh_adjacencies.cpp:902
cs_adjacency_t * cs_mesh_adjacency_v2v(const cs_mesh_t *m)
Definition: cs_mesh_adjacencies.cpp:2096
void cs_mesh_adjacencies_update_device(cs_alloc_mode_t alloc_mode)
Map some global mesh adjacency arrays for use on device.
Definition: cs_mesh_adjacencies.cpp:811
void cs_mesh_adjacencies_update_mesh(void)
Update mesh adjacencies helper API relative to mesh.
Definition: cs_mesh_adjacencies.cpp:730
void cs_adjacency_remove_self_entries(cs_adjacency_t *adj)
In an indexed list, remove id(s) corresponding to the current index. Useful for instance in order to ...
Definition: cs_mesh_adjacencies.cpp:1685
void cs_mesh_adjacencies_finalize(void)
Finalize mesh adjacencies helper API.
Definition: cs_mesh_adjacencies.cpp:700
cs_adjacency_t * cs_adjacency_concatenate(const cs_adjacency_t *a2b_1, const cs_adjacency_t *a2b_2)
Create a new cs_adjacency_t structure from the concatenation of two cs_adjacency_t structures: A -> B...
Definition: cs_mesh_adjacencies.cpp:1322
const cs_mesh_adjacencies_t * cs_glob_mesh_adjacencies
cs_adjacency_t * cs_mesh_adjacency_c2f_lower(const cs_mesh_t *m, int boundary_order)
Build a partial cells to faces adjacency structure.
Definition: cs_mesh_adjacencies.cpp:1930
Definition: cs_mesh_adjacencies.h:68
int stride
Definition: cs_mesh_adjacencies.h:71
cs_lnum_t * idx
Definition: cs_mesh_adjacencies.h:74
cs_lnum_t n_elts
Definition: cs_mesh_adjacencies.h:73
cs_flag_t flag
Definition: cs_mesh_adjacencies.h:70
cs_lnum_t * ids
Definition: cs_mesh_adjacencies.h:75
short int * sgn
Definition: cs_mesh_adjacencies.h:76
Definition: cs_mesh_adjacencies.h:82
cs_lnum_t * cell_cells_idx
Definition: cs_mesh_adjacencies.h:91
cs_lnum_t * cell_cells
Definition: cs_mesh_adjacencies.h:92
cs_lnum_t * cell_hb_faces_idx
Definition: cs_mesh_adjacencies.h:114
const cs_lnum_t * cell_cells_e_idx
Definition: cs_mesh_adjacencies.h:96
short int * cell_i_faces_sgn
Definition: cs_mesh_adjacencies.h:103
cs_lnum_t * cell_b_faces
Definition: cs_mesh_adjacencies.h:108
bool single_faces_to_cells
Definition: cs_mesh_adjacencies.h:86
const cs_adjacency_t * c2v
Definition: cs_mesh_adjacencies.h:128
cs_lnum_t * cell_i_faces
Definition: cs_mesh_adjacencies.h:102
const cs_adjacency_t * c2f
Definition: cs_mesh_adjacencies.h:121
cs_lnum_t * cell_hb_faces
Definition: cs_mesh_adjacencies.h:116
cs_adjacency_t * _c2f
Definition: cs_mesh_adjacencies.h:123
const cs_lnum_t * cell_cells_e
Definition: cs_mesh_adjacencies.h:97
cs_lnum_t * cell_b_faces_idx
Definition: cs_mesh_adjacencies.h:107
cs_adjacency_t * _c2v
Definition: cs_mesh_adjacencies.h:130
Definition: cs_mesh.h:85