My Project
programmer's documentation
fvm_nodal_order.h
Go to the documentation of this file.
1 #ifndef __FVM_NODAL_ORDER_H__
2 #define __FVM_NODAL_ORDER_H__
3 
4 /*============================================================================
5  * Ordering of nodal mesh entity lists and connectivity
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 #include "cs_defs.h"
31 
32 /*----------------------------------------------------------------------------
33  * Local headers
34  *----------------------------------------------------------------------------*/
35 
36 #include "fvm_defs.h"
37 
38 /*----------------------------------------------------------------------------*/
39 
41 
42 /*=============================================================================
43  * Macro definitions
44  *============================================================================*/
45 
46 /*============================================================================
47  * Type definitions
48  *============================================================================*/
49 
50 /*=============================================================================
51  * Static global variables
52  *============================================================================*/
53 
54 /*=============================================================================
55  * Public function prototypes
56  *============================================================================*/
57 
58 /*----------------------------------------------------------------------------
59  * Locally order cells and associated connectivity for a nodal mesh
60  *
61  * parameters:
62  * this_nodal <-- pointer to nodal mesh structure.
63  * parent_global_number <-- global numbers of parent cells (if NULL, a
64  * default 1 to n numbering is considered).
65  *----------------------------------------------------------------------------*/
66 
67 void
68 fvm_nodal_order_cells(fvm_nodal_t *this_nodal,
69  const cs_gnum_t parent_global_number[]);
70 
71 /*----------------------------------------------------------------------------
72  * Locally order faces and associated connectivity for a nodal mesh
73  *
74  * parameters:
75  * this_nodal <-- pointer to nodal mesh structure.
76  * parent_global_number <-- global numbers of parent faces (if NULL, a
77  * default 1 to n numbering is considered).
78  *----------------------------------------------------------------------------*/
79 
80 void
81 fvm_nodal_order_faces(fvm_nodal_t *this_nodal,
82  const cs_gnum_t parent_global_number[]);
83 
84 /*----------------------------------------------------------------------------
85  * Locally order vertices and update connectivity for a nodal mesh
86  *
87  * parameters:
88  * this_nodal <-- pointer to nodal mesh structure.
89  * parent_global_number <-- global numbers of parent vertices (if NULL, a
90  * default 1 to n numbering is considered).
91  *----------------------------------------------------------------------------*/
92 
93 void
94 fvm_nodal_order_vertices(fvm_nodal_t *this_nodal,
95  const cs_gnum_t parent_global_number[]);
96 
97 /*----------------------------------------------------------------------------*/
98 
100 
101 #endif /* __FVM_NODAL_ORDER_H__ */
cs_defs.h
fvm_nodal_order_cells
void fvm_nodal_order_cells(fvm_nodal_t *this_nodal, const cs_gnum_t parent_global_number[])
Definition: fvm_nodal_order.c:275
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:468
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
fvm_nodal_order_faces
void fvm_nodal_order_faces(fvm_nodal_t *this_nodal, const cs_gnum_t parent_global_number[])
Definition: fvm_nodal_order.c:347
cs_gnum_t
unsigned long cs_gnum_t
global mesh entity number
Definition: cs_defs.h:286
fvm_defs.h
fvm_nodal_order_vertices
void fvm_nodal_order_vertices(fvm_nodal_t *this_nodal, const cs_gnum_t parent_global_number[])
Definition: fvm_nodal_order.c:419