6.3
general documentation
cs_volume_zone.h
Go to the documentation of this file.
1 #ifndef __CS_VOLUME_ZONE_H__
2 #define __CS_VOLUME_ZONE_H__
3 
4 /*============================================================================
5  * Volume zones handling.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2020 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 #include "cs_zone.h"
41 
42 /*----------------------------------------------------------------------------*/
43 
45 
46 /*============================================================================
47  * Macro definitions
48  *============================================================================*/
49 
56 /*
57  * Zone type
58  */
59 
61 #define CS_VOLUME_ZONE_INITIALIZATION (1 << 0)
62 
64 #define CS_VOLUME_ZONE_POROSITY (1 << 1)
65 
67 #define CS_VOLUME_ZONE_HEAD_LOSS (1 << 2)
68 
70 #define CS_VOLUME_ZONE_SOURCE_TERM (1 << 3)
71 
73 #define CS_VOLUME_ZONE_MASS_SOURCE_TERM (1 << 4)
74 
76 #define CS_VOLUME_ZONE_GWF_SOIL (1 << 5)
77 
79 #define CS_VOLUME_ZONE_SOLID (1 << 6)
80 
83 /*============================================================================
84  * Type definitions
85  *============================================================================*/
86 
87 /*=============================================================================
88  * Global variables
89  *============================================================================*/
90 
91 /*============================================================================
92  * Public function prototypes
93  *============================================================================*/
94 
95 /*----------------------------------------------------------------------------*/
103 /*----------------------------------------------------------------------------*/
104 
105 void
107 
108 /*----------------------------------------------------------------------------*/
112 /*----------------------------------------------------------------------------*/
113 
114 void
116 
117 /*----------------------------------------------------------------------------*/
121 /*----------------------------------------------------------------------------*/
122 
123 int
125 
126 /*----------------------------------------------------------------------------*/
132 /*----------------------------------------------------------------------------*/
133 
134 int
136 
137 /*----------------------------------------------------------------------------*/
145 /*----------------------------------------------------------------------------*/
146 
147 void
148 cs_volume_zone_build_all(bool mesh_modified);
149 
150 /*----------------------------------------------------------------------------*/
160 /*----------------------------------------------------------------------------*/
161 
162 int
163 cs_volume_zone_define(const char *name,
164  const char *criteria,
165  int type_flag);
166 
167 /*----------------------------------------------------------------------------*/
185 /*----------------------------------------------------------------------------*/
186 
187 int
188 cs_volume_zone_define_by_func(const char *name,
190  void *input,
191  int type_flag);
192 
193 /*----------------------------------------------------------------------------*/
203 /*----------------------------------------------------------------------------*/
204 
205 const cs_zone_t *
206 cs_volume_zone_by_id(int id);
207 
208 /*----------------------------------------------------------------------------*/
218 /*----------------------------------------------------------------------------*/
219 
220 const cs_zone_t *
221 cs_volume_zone_by_name(const char *name);
222 
223 /*----------------------------------------------------------------------------*/
233 /*----------------------------------------------------------------------------*/
234 
235 const cs_zone_t *
236 cs_volume_zone_by_name_try(const char *name);
237 
238 /*----------------------------------------------------------------------------*/
245 /*----------------------------------------------------------------------------*/
246 
247 void
249  int type_flag);
250 
251 /*----------------------------------------------------------------------------*/
258 /*----------------------------------------------------------------------------*/
259 
260 void
262  bool time_varying);
263 
264 /*----------------------------------------------------------------------------*/
271 /*----------------------------------------------------------------------------*/
272 
273 void
275  bool allow_overlay)
276 ;
277 /*----------------------------------------------------------------------------*/
284 /*----------------------------------------------------------------------------*/
285 
286 const int *
288 
289 /*----------------------------------------------------------------------------*/
295 /*----------------------------------------------------------------------------*/
296 
297 void
299 
300 /*----------------------------------------------------------------------------*/
304 /*----------------------------------------------------------------------------*/
305 
306 void
308 
309 /*----------------------------------------------------------------------------*/
318 /*----------------------------------------------------------------------------*/
319 
320 int
321 cs_volume_zone_n_type_zones(int type_flag);
322 
323 /*----------------------------------------------------------------------------*/
335 /*----------------------------------------------------------------------------*/
336 
337 cs_lnum_t
338 cs_volume_zone_n_type_cells(int type_flag);
339 
340 /*----------------------------------------------------------------------------*/
351 /*----------------------------------------------------------------------------*/
352 
353 void
355  cs_lnum_t cell_ids[]);
356 
357 /*----------------------------------------------------------------------------*/
361 /*----------------------------------------------------------------------------*/
362 
363 void
365 
366 /*----------------------------------------------------------------------------*/
367 
369 
370 #endif /* __CS_VOLUME_ZONE_H__ */
cs_zone_t
Definition: cs_zone.h:55
cs_mesh_location_select_t
void() cs_mesh_location_select_t(void *input, const cs_mesh_t *m, int location_id, cs_lnum_t *n_elts, cs_lnum_t **elt_ids)
Definition: cs_mesh_location.h:99
cs_volume_zone_finalize
void cs_volume_zone_finalize(void)
Free all volume zone structures.
Definition: cs_volume_zone.c:422
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:493
cs_volume_zone_n_type_cells
cs_lnum_t cs_volume_zone_n_type_cells(int type_flag)
Return number of volume zone cells associated with a given zone flag.
Definition: cs_volume_zone.c:910
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:492
cs_volume_zone_set_overlay
void cs_volume_zone_set_overlay(int id, bool allow_overlay)
Set overlay behavior for a given volume zone.
Definition: cs_volume_zone.c:778
cs_volume_zone_define
int cs_volume_zone_define(const char *name, const char *criteria, int type_flag)
Define a new volume zone using a selection criteria string.
Definition: cs_volume_zone.c:592
cs_volume_zone_set_type
void cs_volume_zone_set_type(int id, int type_flag)
Set type flag for a given volume zone.
Definition: cs_volume_zone.c:742
cs_volume_zone_cell_zone_id
const int * cs_volume_zone_cell_zone_id(void)
Return pointer to zone id associated with each cell.
Definition: cs_volume_zone.c:796
cs_volume_zone_initialize
void cs_volume_zone_initialize(void)
Initialize volume zone structures.
Definition: cs_volume_zone.c:396
cs_volume_zone_n_zones
int cs_volume_zone_n_zones(void)
Return number of volume zones defined.
Definition: cs_volume_zone.c:446
cs_volume_zone_by_id
const cs_zone_t * cs_volume_zone_by_id(int id)
Return a pointer to a volume zone based on its id.
Definition: cs_volume_zone.c:671
cs_volume_zone_log_setup
void cs_volume_zone_log_setup(void)
Log setup information relative to defined volume zones.
Definition: cs_volume_zone.c:857
cs_volume_zone_n_zones_time_varying
int cs_volume_zone_n_zones_time_varying(void)
Return number of volume zones which may vary in time.
Definition: cs_volume_zone.c:460
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:298
cs_zone.h
cs_volume_zone_by_name
const cs_zone_t * cs_volume_zone_by_name(const char *name)
Return a pointer to a volume zone based on its name if present.
Definition: cs_volume_zone.c:695
cs_mesh_location.h
cs_volume_zone_n_type_zones
int cs_volume_zone_n_type_zones(int type_flag)
Return number of volume zones associated with a given zone flag.
Definition: cs_volume_zone.c:883
cs_volume_zone_log_info
void cs_volume_zone_log_info(const cs_zone_t *z)
Print info relative to a given volume zone to log file.
Definition: cs_volume_zone.c:810
cs_volume_zone_define_by_func
int cs_volume_zone_define_by_func(const char *name, cs_mesh_location_select_t *func, void *input, int type_flag)
Define a new mesh location with an associated selection function.
Definition: cs_volume_zone.c:636
cs_volume_zone_print_info
void cs_volume_zone_print_info(void)
Print volume zones information to listing file.
Definition: cs_volume_zone.c:969
cs_volume_zone_build_all
void cs_volume_zone_build_all(bool mesh_modified)
Update association of volume zones with a mesh.
Definition: cs_volume_zone.c:483
cs_base.h
cs_volume_zone_by_name_try
const cs_zone_t * cs_volume_zone_by_name_try(const char *name)
Return a pointer to a volume zone based on its name if present.
Definition: cs_volume_zone.c:721
cs_volume_zone_set_time_varying
void cs_volume_zone_set_time_varying(int id, bool time_varying)
Set time varying behavior for a given volume zone.
Definition: cs_volume_zone.c:760
cs_volume_zone_select_type_cells
void cs_volume_zone_select_type_cells(int type_flag, cs_lnum_t cell_ids[])
Select cells associated with volume zones of a given type.
Definition: cs_volume_zone.c:936