My Project
programmer's 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-2019 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 
38 /*----------------------------------------------------------------------------*/
39 
40 BEGIN_C_DECLS
41 
42 /*=============================================================================
43  * Macro definitions
44  *============================================================================*/
45 
46 /*============================================================================
47  * Type definitions
48  *============================================================================*/
49 
50 /*=============================================================================
51  * Public function prototypes
52  *============================================================================*/
53 
54 /*----------------------------------------------------------------------------*/
64 /*----------------------------------------------------------------------------*/
65 
66 bool
67 cs_preprocess_mesh_is_needed(void);
68 
69 /*----------------------------------------------------------------------------
70  * Define all mesh preprocessing operations.
71  *----------------------------------------------------------------------------*/
72 
73 void
74 cs_preprocess_mesh_define(void);
75 
76 /*----------------------------------------------------------------------------
77  * Apply all mesh preprocessing operations.
78  *
79  * parameters:
80  * halo_type <-> type of halo (standard or extended)
81  *----------------------------------------------------------------------------*/
82 
83 void
84 cs_preprocess_mesh(cs_halo_type_t halo_type);
85 
86 /*----------------------------------------------------------------------------
87  * Update fortran arrays relative to the global mesh.
88  *----------------------------------------------------------------------------*/
89 
90 void
91 cs_preprocess_mesh_update_fortran(void);
92 
93 /*----------------------------------------------------------------------------*/
94 
95 END_C_DECLS
96 
97 #endif /* __CS_PREPROCESS_H__ */
cs_preprocess_mesh_is_needed
bool cs_preprocess_mesh_is_needed(void)
Determine if preprocessing is needed.
Definition: cs_preprocess.c:183
cs_defs.h
cs_preprocess_mesh
void cs_preprocess_mesh(cs_halo_type_t halo_type)
Apply all mesh preprocessing operations.
Definition: cs_preprocess.c:243
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:468
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
cs_preprocess_mesh_define
void cs_preprocess_mesh_define(void)
Define all mesh preprocessing operations.
Definition: cs_preprocess.c:214
cs_halo.h
cs_preprocess_mesh_update_fortran
void cs_preprocess_mesh_update_fortran(void)
Update fortran arrays relative to the global mesh.
Definition: cs_preprocess.c:443
cs_halo_type_t
cs_halo_type_t
Definition: cs_halo.h:50
Generated on Thu Apr 9 2020 17:26:56 for My Project by   doxygen 1.8.16