programmer's documentation
cs_zone.h
Go to the documentation of this file.
1 #ifndef __CS_ZONE_H__
2 #define __CS_ZONE_H__
3 
4 /*============================================================================
5  * Base zones handling.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2018 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  * Standard C library headers
32  *----------------------------------------------------------------------------*/
33 
34 /*----------------------------------------------------------------------------
35  * Local headers
36  *----------------------------------------------------------------------------*/
37 
38 #include "cs_base.h"
39 #include "cs_mesh_location.h"
40 
41 /*----------------------------------------------------------------------------*/
42 
44 
45 /*============================================================================
46  * Macro definitions
47  *============================================================================*/
48 
49 /*============================================================================
50  * Type definitions
51  *============================================================================*/
52 
55 typedef struct {
56 
57  const char *name;
59  int id;
60  int type;
65  const cs_lnum_t *elt_ids;
67  bool time_varying;
72 } cs_zone_t;
73 
79 typedef struct {
80 
81  const char *name;
83  int id;
84  int type;
92  bool time_varying;
98 
104 typedef struct {
105 
106  const char *name;
108  int id;
109  int type;
122 
123 /*============================================================================
124  * Public function prototypes
125  *============================================================================*/
126 
127 /*----------------------------------------------------------------------------*/
128 
130 
131 #endif /* __CS_ZONE_H__ */
cs_lnum_t n_elts
Definition: cs_zone.h:64
bool allow_overlay
Definition: cs_zone.h:119
int type
Definition: cs_zone.h:84
int location_id
Definition: cs_zone.h:62
int location_id
Definition: cs_zone.h:86
const cs_lnum_t * cell_ids
Definition: cs_zone.h:114
int id
Definition: cs_zone.h:59
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
const cs_lnum_t * elt_ids
Definition: cs_zone.h:65
bool allow_overlay
Definition: cs_zone.h:70
const char * name
Definition: cs_zone.h:81
cs_lnum_t n_faces
Definition: cs_zone.h:88
cs_lnum_t n_cells
Definition: cs_zone.h:113
const char * name
Definition: cs_zone.h:106
bool time_varying
Definition: cs_zone.h:92
int id
Definition: cs_zone.h:83
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:293
int id
Definition: cs_zone.h:108
const char * name
Definition: cs_zone.h:57
#define END_C_DECLS
Definition: cs_defs.h:462
bool time_varying
Definition: cs_zone.h:67
bool time_varying
Definition: cs_zone.h:117
int type
Definition: cs_zone.h:109
Definition: cs_zone.h:104
int location_id
Definition: cs_zone.h:111
int type
Definition: cs_zone.h:60
Definition: cs_zone.h:79
const cs_lnum_t * face_ids
Definition: cs_zone.h:89
bool allow_overlay
Definition: cs_zone.h:94
Definition: cs_zone.h:55