8.3
general documentation
cs_preprocess.h
Go to the documentation of this file.
1#ifndef __CS_PREPROCESS_H__
2#define __CS_PREPROCESS_H__
3
4/*============================================================================
5 * Handle successive preprocessing operations.
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_defs.h"
35
36#include "cs_halo.h"
37#include "cs_mesh.h"
38#include "cs_mesh_adjacencies.h"
39#include "cs_mesh_quantities.h"
40
41/*----------------------------------------------------------------------------*/
42
44
45/*=============================================================================
46 * Macro definitions
47 *============================================================================*/
48
49/*============================================================================
50 * Type definitions
51 *============================================================================*/
52
53/*=============================================================================
54 * Public function prototypes
55 *============================================================================*/
56
57/*----------------------------------------------------------------------------
58 * Define all mesh preprocessing operations.
59 *----------------------------------------------------------------------------*/
60
61void
63
64/*----------------------------------------------------------------------------
65 * Apply all mesh preprocessing operations.
66 *
67 * parameters:
68 * halo_type <-> type of halo (standard or extended)
69 *----------------------------------------------------------------------------*/
70
71void
73
74/*----------------------------------------------------------------------------*/
83/*----------------------------------------------------------------------------*/
84
85void
88 cs_lnum_t n_faces,
89 const cs_lnum_t face_ids[]);
90
91/*----------------------------------------------------------------------------
92 * Update fortran arrays relative to the global mesh.
93 *----------------------------------------------------------------------------*/
94
95void
97
98/*----------------------------------------------------------------------------*/
105/*----------------------------------------------------------------------------*/
106
107void
109
110/*----------------------------------------------------------------------------*/
111
113
114#endif /* __CS_PREPROCESS_H__ */
#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
cs_halo_type_t
Definition: cs_halo.h:56
void cs_preprocess_mesh(cs_halo_type_t halo_type)
Apply all mesh preprocessing operations.
Definition: cs_preprocess.cpp:241
void cs_preprocess_mesh_define(void)
Define all mesh preprocessing operations.
Definition: cs_preprocess.cpp:198
void cs_preprocess_mesh_update_fortran(void)
Update fortran arrays relative to the global mesh.
Definition: cs_preprocess.cpp:543
void cs_preprocess_mesh_selected_b_faces_ignore(cs_mesh_t *m, cs_mesh_quantities_t *mq, cs_lnum_t n_faces, const cs_lnum_t face_ids[])
Apply numbering changes to ignore selected boundary faces.
Definition: cs_preprocess.cpp:478
void cs_preprocess_mesh_update_device(void)
Map some mesh arrays for use on device.
Definition: cs_preprocess.cpp:588
Definition: cs_mesh_quantities.h:92
Definition: cs_mesh.h:85