8.1
general 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-2023 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;
81  cs_real_t cog[3];
83 } cs_zone_t;
84 
90 typedef struct {
91 
92  const char *name;
94  int id;
95  int type;
108 
114 typedef struct {
115 
116  const char *name;
118  int id;
119  int type;
132 
133 /*============================================================================
134  * Public function prototypes
135  *============================================================================*/
136 
137 /*----------------------------------------------------------------------------*/
138 
140 
141 #endif /* __CS_ZONE_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
unsigned long cs_gnum_t
global mesh entity number
Definition: cs_defs.h:298
#define END_C_DECLS
Definition: cs_defs.h:515
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
Definition: cs_zone.h:90
const cs_lnum_t * face_ids
Definition: cs_zone.h:100
cs_lnum_t n_faces
Definition: cs_zone.h:99
bool allow_overlay
Definition: cs_zone.h:105
int id
Definition: cs_zone.h:94
int location_id
Definition: cs_zone.h:97
const char * name
Definition: cs_zone.h:92
bool time_varying
Definition: cs_zone.h:103
int type
Definition: cs_zone.h:95
Definition: cs_zone.h:114
bool allow_overlay
Definition: cs_zone.h:129
int id
Definition: cs_zone.h:118
cs_lnum_t n_cells
Definition: cs_zone.h:123
int location_id
Definition: cs_zone.h:121
const char * name
Definition: cs_zone.h:116
const cs_lnum_t * cell_ids
Definition: cs_zone.h:124
bool time_varying
Definition: cs_zone.h:127
int type
Definition: cs_zone.h:119
Definition: cs_zone.h:55
const cs_lnum_t * elt_ids
Definition: cs_zone.h:65
bool allow_overlay
Definition: cs_zone.h:70
int id
Definition: cs_zone.h:59
cs_real_t measure
Definition: cs_zone.h:74
cs_lnum_t n_elts
Definition: cs_zone.h:64
int location_id
Definition: cs_zone.h:62
const char * name
Definition: cs_zone.h:57
cs_real_t f_boundary_measure
Definition: cs_zone.h:79
bool time_varying
Definition: cs_zone.h:67
int type
Definition: cs_zone.h:60
cs_real_t f_measure
Definition: cs_zone.h:75
cs_real_t boundary_measure
Definition: cs_zone.h:77
cs_gnum_t n_g_elts
Definition: cs_zone.h:72