src/mesh/cs_mesh_halo.h Source File

| programmer's documentation

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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-2013 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_interface.h"
36 #include "cs_mesh.h"
37
38 /*----------------------------------------------------------------------------*/
39
40 BEGIN_C_DECLS
41
42 /*=============================================================================
43 * Public function prototypes
44 *============================================================================*/
45
46 /*----------------------------------------------------------------------------
47 * Define halo structures for internal and distant ghost cells.
48 *
49 * parameters:
50 * mesh <-- pointer to cs_mesh_t structure
51 * face_ifs <-- pointer to faces interfaces
52 * vertex_ifs <-- pointer to vertex interfaces
53 * p_gcell_vtx_idx --> pointer to the connectivity index
54 * p_gcell_vtx_lst --> pointer to the connectivity list
55 *---------------------------------------------------------------------------*/
56
57 void
58 cs_mesh_halo_define(cs_mesh_t *mesh,
59 cs_interface_set_t *face_ifs,
60 cs_interface_set_t *vertex_ifs,
61 cs_int_t *p_gcell_vtx_idx[],
62 cs_int_t *p_gcell_vtx_lst[]);
63
64 /*----------------------------------------------------------------------------*/
65
66 END_C_DECLS
67
68 #endif /* __CS_MESH_HALO_H__ */