8.3
general documentation
cs_mesh_quantities.h
Go to the documentation of this file.
1#ifndef __CS_MESH_QUANTITIES_H__
2#define __CS_MESH_QUANTITIES_H__
3
4/*============================================================================
5 * Management of mesh quantities
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2024 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_mesh.h"
36
37/*----------------------------------------------------------------------------*/
38
40
41/*=============================================================================
42 * Macro definitions
43 *============================================================================*/
44
51/*
52 * Cell quantities correction types
53 */
54
56#define CS_BAD_CELLS_WARPED_CORRECTION (1 << 0)
57
59#define CS_BAD_CELLS_REGULARISATION (1 << 1)
60
62#define CS_CELL_FACE_CENTER_CORRECTION (1 << 2)
63
65#define CS_CELL_CENTER_CORRECTION (1 << 3)
66
68#define CS_FACE_DISTANCE_CLIP (1 << 4)
69
71#define CS_FACE_RECONSTRUCTION_CLIP (1 << 5)
72
74#define CS_CELL_VOLUME_RATIO_CORRECTION (1 << 6)
75
79#define CS_FACE_CENTER_REFINE (1 << 7)
80
82#define CS_FACE_NULL_SURFACE (1 << 8)
83
86/*============================================================================
87 * Type definition
88 *============================================================================*/
89
90/* Structure associated to mesh quantities management */
91
92typedef struct {
93
94 cs_real_t *cell_cen; /* Cell center coordinates */
95 cs_real_t *cell_f_cen; /* Cell fluid center coordinates */
96 cs_real_t *cell_s_cen; /* Cell solid center coordinates */
97 cs_real_t *cell_vol; /* Cell volume */
98 cs_real_t *cell_f_vol; /* Cell fluid volume */
99
100 cs_real_t *i_face_normal; /* Surface normal of interior faces.
101 (L2 norm equals area of the face) */
102 cs_real_t *b_face_normal; /* Surface normal of border faces.
103 (L2 norm equals area of the face) */
104 cs_real_t *i_f_face_normal;/* Fluid surface normal of interior faces.
105 (L2 norm equals area of the face) */
106 cs_real_t *b_f_face_normal;/* Fluid surface normal of border faces.
107 (L2 norm equals area of the face) */
108 cs_real_t *c_w_face_normal;/* Solid surface normal immersed in the cells.
109 (L2 norm equals area of the face) */
110 cs_real_t *i_face_cog; /* Center of gravity of interior faces */
111 cs_real_t *b_face_cog; /* Center of gravity of border faces */
112
113 cs_real_t *i_f_face_cog; /* Center of gravity of fluid interior faces */
114 cs_real_t *b_f_face_cog; /* Center of gravity of fluid border faces */
115 cs_real_t *c_w_face_cog; /* Center of gravity of solid face
116 immersed in the cells */
117
118 cs_real_t *i_face_surf; /* Surface of interior faces. */
119 cs_real_t *b_face_surf; /* Surface of boundary faces. */
120
121 cs_real_t *i_f_face_surf; /* Fluid surface of interior faces. */
122 cs_real_t *b_f_face_surf; /* Fluid surface of boundary faces. */
123 cs_real_t *c_w_face_surf; /* Solid surface of cells. */
124
125 cs_nreal_3_t *i_face_u_normal; /* Unit normal of interior faces. */
126 cs_nreal_3_t *b_face_u_normal; /* Unit normal of boundary faces. */
127
128 cs_real_2_t *i_f_face_factor;/* Fluid surface factor of interior faces. */
129 cs_real_t *b_f_face_factor;/* Fluid surface factor of boundary faces. */
130
131 cs_real_3_t *dijpf; /* Vector I'J' for interior faces */
132 cs_rreal_3_t *diipb; /* Vector II' for border faces */
133 cs_real_t *dofij; /* Vector OF for interior faces */
134 cs_rreal_3_t *diipf; /* Vector II' for interior faces */
135 cs_rreal_3_t *djjpf; /* Vector JJ' for interior faces */
136
137 cs_real_t *i_dist; /* Distance between the centers of the two
138 cells sharing an interior face */
139 cs_real_t *b_dist; /* Distance between the cell center and
140 the center of gravity of border faces */
141 cs_real_t *c_w_dist_inv; /* Distance between the centers of the cell
142 and the solid face */
143
144 cs_real_t *weight; /* Interior faces weighting factor */
145 cs_real_t *i_f_weight; /* Interior faces weighting factor
146 with new cell center of gravity */
147
148 cs_real_t min_vol; /* Minimum cell volume */
149 cs_real_t max_vol; /* Maximum cell volume */
150 cs_real_t tot_vol; /* Total volume */
151
152 cs_real_t min_f_vol; /* Minimum cell volume */
153 cs_real_t max_f_vol; /* Maximum cell volume */
154 cs_real_t tot_f_vol; /* Total volume */
155
156 cs_real_t *corr_grad_lin_det; /* Determinant of geometrical matrix
157 linear gradient correction */
158 cs_real_33_t *corr_grad_lin; /* Geometrical matrix
159 linear gradient correction */
160
161 int *b_sym_flag; /* Symmetry flag for boundary faces */
162 int has_disable_flag; /* Is the cell disabled?
163 0: unactivated
164 1: activated */
165 int *c_disable_flag; /* Is the cell disabled?
166 used for fluid solid and porous models */
167 unsigned *bad_cell_flag; /* Flag (mask) for bad cells detected */
168
170
171/*============================================================================
172 * Global variables
173 *============================================================================*/
174
175/* Pointer to mesh quantities structure associated to the main mesh */
176
178
179/* Flag (mask) to activate bad cells correction */
180extern unsigned cs_glob_mesh_quantities_flag;
181
182/*=============================================================================
183 * Public function prototypes
184 *============================================================================*/
185
186/*----------------------------------------------------------------------------*/
194/*----------------------------------------------------------------------------*/
195
196static inline int
198 cs_lnum_t cell_id)
199{
200 return (1 - (mq->has_disable_flag
201 *mq->c_disable_flag[mq->has_disable_flag * cell_id]));
202}
203
204/*----------------------------------------------------------------------------*/
214/*----------------------------------------------------------------------------*/
215
216int
218
219/*----------------------------------------------------------------------------*/
230/*----------------------------------------------------------------------------*/
231
232int
234
235/*----------------------------------------------------------------------------*/
241/*----------------------------------------------------------------------------*/
242
245
246/*----------------------------------------------------------------------------*/
254/*----------------------------------------------------------------------------*/
255
258
259/*----------------------------------------------------------------------------*/
265/*----------------------------------------------------------------------------*/
266
267void
269
270/*----------------------------------------------------------------------------*/
277/*----------------------------------------------------------------------------*/
278
279void
282
283/*----------------------------------------------------------------------------*/
290/*----------------------------------------------------------------------------*/
291
292void
295
296/*----------------------------------------------------------------------------
297 * Compute fluid mesh quantities
298 *
299 * parameters:
300 * mesh <-- pointer to a cs_mesh_t structure
301 * mesh_quantities <-> pointer to a cs_mesh_quantities_t structure
302 *----------------------------------------------------------------------------*/
303
304void
306 cs_mesh_quantities_t *mesh_quantities);
307
308/*----------------------------------------------------------------------------
309 * Compute the total, min, and max fluid volumes of cells
310 *
311 * parameters:
312 * mesh <-- pointer to mesh structure
313 * mesh_quantities <-> pointer to a mesh quantities structure
314 *----------------------------------------------------------------------------*/
315
316void
318 cs_mesh_quantities_t *mesh_quantities);
319
320/*----------------------------------------------------------------------------
321 * Compute fluid section mesh quantities at the initial step
322 *
323 * parameters:
324 * mesh <-- pointer to a cs_mesh_t structure
325 * mesh_quantities <-> pointer to a cs_mesh_quantities_t structure
326 *----------------------------------------------------------------------------*/
327
328void
330 cs_mesh_quantities_t *mesh_quantities);
331
332/*----------------------------------------------------------------------------*/
341/*----------------------------------------------------------------------------*/
342
343void
345 const cs_real_3_t *cen_points,
347
348/*----------------------------------------------------------------------------
349 * Compute mesh quantities
350 *
351 * parameters:
352 * mesh <-- pointer to a cs_mesh_t structure
353 * mesh_quantities <-> pointer to a cs_mesh_quantities_t structure
354 *----------------------------------------------------------------------------*/
355
356void
358 cs_mesh_quantities_t *mesh_quantities);
359
360/*----------------------------------------------------------------------------
361 * Compute internal and border face normal.
362 *
363 * parameters:
364 * mesh <-- pointer to a cs_mesh_t structure
365 * p_i_face_normal <-> pointer to the internal face normal array
366 * p_b_face_normal <-> pointer to the border face normal array
367 *----------------------------------------------------------------------------*/
368
369void
371 cs_real_t *p_i_face_normal[],
372 cs_real_t *p_b_face_normal[]);
373
374/*----------------------------------------------------------------------------
375 * Compute interior face centers and normals.
376 *
377 * The corresponding arrays are allocated by this function, and it is the
378 * caller's responsibility to free them when they are no longer needed.
379 *
380 * parameters:
381 * mesh <-- pointer to a cs_mesh_t structure
382 * p_i_face_cog <-> pointer to the interior face center array
383 * p_i_face_normal <-> pointer to the interior face normal array
384 *----------------------------------------------------------------------------*/
385
386void
388 cs_real_t *p_i_face_cog[],
389 cs_real_t *p_i_face_normal[]);
390
391/*----------------------------------------------------------------------------
392 * Compute border face centers and normals.
393 *
394 * The corresponding arrays are allocated by this function, and it is the
395 * caller's responsibility to free them when they are no longer needed.
396 *
397 * parameters:
398 * mesh <-- pointer to a cs_mesh_t structure
399 * p_b_face_cog <-> pointer to the border face center array
400 * p_b_face_normal <-> pointer to the border face normal array
401 *----------------------------------------------------------------------------*/
402
403void
405 cs_real_t *p_b_face_cog[],
406 cs_real_t *p_b_face_normal[]);
407
408/*----------------------------------------------------------------------------*/
428/*----------------------------------------------------------------------------*/
429
430void
432 const cs_real_t i_face_norm[],
433 const cs_real_t i_face_cog[],
434 const cs_real_t b_face_norm[],
435 const cs_real_t b_face_cog[],
436 cs_real_t cell_cen[]);
437
438/*----------------------------------------------------------------------------
439 * Compute cell volumes.
440 *
441 * The corresponding array is allocated by this function, and it is the
442 * caller's responsability to free it when they are no longer needed.
443 *
444 * parameters:
445 * mesh <-- pointer to a cs_mesh_t structure
446 *
447 * return:
448 * pointer to newly allocated cell volumes array
449 *----------------------------------------------------------------------------*/
450
451cs_real_t *
453
454/*----------------------------------------------------------------------------
455 * Check that no negative volumes are present, and exit on error otherwise.
456 *
457 * parameters:
458 * mesh <-- pointer to mesh structure
459 * mesh_quantities <-- pointer to mesh quantities structure
460 * allow_error <-- 1 if errors are allowed, 0 otherwise
461 *----------------------------------------------------------------------------*/
462
463void
465 const cs_mesh_quantities_t *mesh_quantities,
466 int allow_error);
467
468/*----------------------------------------------------------------------------*/
481/*----------------------------------------------------------------------------*/
482
485 cs_real_t tolerance);
486
487/*----------------------------------------------------------------------------
488 * Return the number of times mesh quantities have been computed.
489 *
490 * returns:
491 * number of times mesh quantities have been computed
492 *----------------------------------------------------------------------------*/
493
494int
496
497/*----------------------------------------------------------------------------*/
507/*----------------------------------------------------------------------------*/
508
509void
511 const cs_mesh_quantities_t *mq,
512 int n_passes,
513 cs_real_t b_thickness[]);
514
515/*----------------------------------------------------------------------------*/
524/*----------------------------------------------------------------------------*/
525
526void
528 const cs_mesh_quantities_t *mq,
529 int n_passes,
530 cs_real_t b_thickness[]);
531
532/*----------------------------------------------------------------------------
533 * Compute quantities associated to a list of faces (border or internal)
534 *
535 * parameters:
536 * n_faces <-- number of faces
537 * vtx_coord <-- vertex coordinates
538 * face_vtx_idx <-- "face -> vertices" connectivity index
539 * face_vtx <-- "face -> vertices" connectivity
540 * face_cog --> coordinates of the center of gravity of the faces
541 * face_normal --> face surface normals
542 *----------------------------------------------------------------------------*/
543
544void
546 const cs_real_t vtx_coord[][3],
547 const cs_lnum_t face_vtx_idx[],
548 const cs_lnum_t face_vtx[],
549 cs_real_t face_cog[][3],
550 cs_real_t face_normal[][3]);
551
552/*----------------------------------------------------------------------------*/
556/*----------------------------------------------------------------------------*/
557
558void
560
561/*----------------------------------------------------------------------------
562 * Dump a cs_mesh_quantities_t structure
563 *
564 * parameters:
565 * mesh <-- pointer to a cs_mesh_t structure
566 * mesh_quantities <-- pointer to a cs_mesh_quantities_t structure
567 *----------------------------------------------------------------------------*/
568
569void
571 const cs_mesh_quantities_t *mesh_quantities);
572
573/*----------------------------------------------------------------------------*/
574
576
577#endif /* __CS_MESH_QUANTITIES_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
cs_rreal_t cs_rreal_3_t[3]
Definition: cs_defs.h:388
cs_nreal_t cs_nreal_3_t[3]
Definition: cs_defs.h:385
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:359
cs_real_t cs_real_2_t[2]
vector of 2 floating-point values
Definition: cs_defs.h:358
cs_real_t cs_real_6_t[6]
vector of 6 floating-point values
Definition: cs_defs.h:361
#define END_C_DECLS
Definition: cs_defs.h:543
cs_real_t cs_real_33_t[3][3]
3x3 matrix of floating-point values
Definition: cs_defs.h:368
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:335
void cs_mesh_quantities_sup_vectors(const cs_mesh_t *mesh, cs_mesh_quantities_t *mesh_quantities)
Definition: cs_mesh_quantities.cpp:4783
unsigned cs_glob_mesh_quantities_flag
cs_mesh_quantities_t * cs_mesh_quantities_destroy(cs_mesh_quantities_t *mq)
Destroy a mesh quantities structure.
Definition: cs_mesh_quantities.cpp:2957
void cs_mesh_quantities_face_normal(const cs_mesh_t *mesh, cs_real_t *p_i_face_normal[], cs_real_t *p_b_face_normal[])
Definition: cs_mesh_quantities.cpp:4818
void cs_mesh_quantities_log_setup(void)
Log mesh quantities options to setup file.
Definition: cs_mesh_quantities.cpp:5440
static int cs_mesh_quantities_cell_is_active(const cs_mesh_quantities_t *mq, cs_lnum_t cell_id)
Return 0 if cell is disabled, 1 otherwise.
Definition: cs_mesh_quantities.h:197
void cs_mesh_quantities_compute_preprocess(const cs_mesh_t *m, cs_mesh_quantities_t *mq)
Compute mesh quantities needed for preprocessing.
Definition: cs_mesh_quantities.cpp:3034
void cs_mesh_quantities_b_thickness_f(const cs_mesh_t *m, const cs_mesh_quantities_t *mq, int n_passes, cs_real_t b_thickness[])
Determine local boundary thickness around each boundary face.
Definition: cs_mesh_quantities.cpp:5370
void cs_mesh_quantities_solid_compute(const cs_mesh_t *m, const cs_real_3_t *cen_points, cs_mesh_quantities_t *mq)
Compute cell and faces quantities needed at the immersed boundaries.
Definition: cs_mesh_quantities.cpp:3290
int cs_mesh_quantities_compute_count(void)
Definition: cs_mesh_quantities.cpp:5262
void cs_mesh_quantities_check_vol(const cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities, int allow_error)
Definition: cs_mesh_quantities.cpp:5116
int cs_mesh_quantities_cell_cen_choice(int algo_choice)
Query or modification of the option for computing cell centers.
Definition: cs_mesh_quantities.cpp:2857
void cs_mesh_quantities_fluid_compute(const cs_mesh_t *mesh, cs_mesh_quantities_t *mesh_quantities)
Definition: cs_mesh_quantities.cpp:4681
void cs_mesh_quantities_fluid_vol_reductions(const cs_mesh_t *mesh, cs_mesh_quantities_t *mesh_quantities)
Definition: cs_mesh_quantities.cpp:4697
void cs_mesh_quantities_cell_faces_cog(const cs_mesh_t *mesh, const cs_real_t i_face_norm[], const cs_real_t i_face_cog[], const cs_real_t b_face_norm[], const cs_real_t b_face_cog[], cs_real_t cell_cen[])
Compute approximate cells centers as the mean of the given face centers weighted by the associated su...
Definition: cs_mesh_quantities.cpp:4941
int cs_mesh_quantities_face_cog_choice(int algo_choice)
Query or modification of the option for computing face centers.
Definition: cs_mesh_quantities.cpp:2879
void cs_mesh_init_fluid_sections(const cs_mesh_t *mesh, cs_mesh_quantities_t *mesh_quantities)
Definition: cs_mesh_quantities.cpp:4737
void cs_mesh_quantities_compute(const cs_mesh_t *m, cs_mesh_quantities_t *mq)
Compute mesh quantities.
Definition: cs_mesh_quantities.cpp:4493
void cs_mesh_quantities_free_all(cs_mesh_quantities_t *mq)
Reset a mesh quantities structure to its empty initial state.
Definition: cs_mesh_quantities.cpp:2975
void cs_mesh_quantities_compute_face_quantities(cs_lnum_t n_faces, const cs_real_t vtx_coord[][3], const cs_lnum_t face_vtx_idx[], const cs_lnum_t face_vtx[], cs_real_t face_cog[][3], cs_real_t face_normal[][3])
Definition: cs_mesh_quantities.cpp:5418
void cs_mesh_quantities_dump(const cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities)
Definition: cs_mesh_quantities.cpp:5485
cs_mesh_quantities_t * cs_mesh_quantities_create(void)
Create a mesh quantities structure.
Definition: cs_mesh_quantities.cpp:2896
void cs_mesh_quantities_i_faces(const cs_mesh_t *mesh, cs_real_t *p_i_face_cog[], cs_real_t *p_i_face_normal[])
Definition: cs_mesh_quantities.cpp:4865
void cs_mesh_quantities_b_thickness_v(const cs_mesh_t *m, const cs_mesh_quantities_t *mq, int n_passes, cs_real_t b_thickness[])
Determine local boundary thickness around each vertex.
Definition: cs_mesh_quantities.cpp:5280
cs_real_6_t * cs_mesh_quantities_cell_extents(const cs_mesh_t *m, cs_real_t tolerance)
Compute the bounding box for cells.
Definition: cs_mesh_quantities.cpp:5174
cs_real_t * cs_mesh_quantities_cell_volume(const cs_mesh_t *mesh)
Definition: cs_mesh_quantities.cpp:5075
cs_mesh_quantities_t * cs_glob_mesh_quantities
void cs_mesh_quantities_b_faces(const cs_mesh_t *mesh, cs_real_t *p_b_face_cog[], cs_real_t *p_b_face_normal[])
Definition: cs_mesh_quantities.cpp:4898
Definition: mesh.f90:26
Definition: cs_mesh_quantities.h:92
int * b_sym_flag
Definition: cs_mesh_quantities.h:161
cs_real_t * cell_f_cen
Definition: cs_mesh_quantities.h:95
cs_real_t * b_face_cog
Definition: cs_mesh_quantities.h:111
cs_real_t * i_f_weight
Definition: cs_mesh_quantities.h:145
cs_real_t * c_w_face_surf
Definition: cs_mesh_quantities.h:123
cs_real_t * i_face_surf
Definition: cs_mesh_quantities.h:118
cs_rreal_3_t * diipb
Definition: cs_mesh_quantities.h:132
cs_real_t max_f_vol
Definition: cs_mesh_quantities.h:153
cs_real_t * b_dist
Definition: cs_mesh_quantities.h:139
int has_disable_flag
Definition: cs_mesh_quantities.h:162
cs_real_2_t * i_f_face_factor
Definition: cs_mesh_quantities.h:128
cs_rreal_3_t * diipf
Definition: cs_mesh_quantities.h:134
cs_real_t * b_face_surf
Definition: cs_mesh_quantities.h:119
cs_real_t * i_dist
Definition: cs_mesh_quantities.h:137
cs_real_t * i_f_face_surf
Definition: cs_mesh_quantities.h:121
cs_real_t * dofij
Definition: cs_mesh_quantities.h:133
cs_real_t * c_w_face_normal
Definition: cs_mesh_quantities.h:108
cs_real_t max_vol
Definition: cs_mesh_quantities.h:149
cs_real_t * cell_vol
Definition: cs_mesh_quantities.h:97
cs_real_t * weight
Definition: cs_mesh_quantities.h:144
cs_real_t * i_face_cog
Definition: cs_mesh_quantities.h:110
cs_real_t * b_face_normal
Definition: cs_mesh_quantities.h:102
cs_real_33_t * corr_grad_lin
Definition: cs_mesh_quantities.h:158
cs_real_t * b_f_face_cog
Definition: cs_mesh_quantities.h:114
cs_real_t * c_w_face_cog
Definition: cs_mesh_quantities.h:115
cs_real_t tot_vol
Definition: cs_mesh_quantities.h:150
int * c_disable_flag
Definition: cs_mesh_quantities.h:165
cs_nreal_3_t * i_face_u_normal
Definition: cs_mesh_quantities.h:125
cs_real_t * cell_s_cen
Definition: cs_mesh_quantities.h:96
cs_real_t tot_f_vol
Definition: cs_mesh_quantities.h:154
cs_real_t * i_f_face_cog
Definition: cs_mesh_quantities.h:113
cs_real_t * cell_cen
Definition: cs_mesh_quantities.h:94
cs_real_t min_f_vol
Definition: cs_mesh_quantities.h:152
cs_real_t * i_f_face_normal
Definition: cs_mesh_quantities.h:104
cs_real_t * b_f_face_surf
Definition: cs_mesh_quantities.h:122
cs_real_t * b_f_face_factor
Definition: cs_mesh_quantities.h:129
cs_real_t * cell_f_vol
Definition: cs_mesh_quantities.h:98
cs_real_t min_vol
Definition: cs_mesh_quantities.h:148
cs_real_t * c_w_dist_inv
Definition: cs_mesh_quantities.h:141
cs_nreal_3_t * b_face_u_normal
Definition: cs_mesh_quantities.h:126
cs_real_t * corr_grad_lin_det
Definition: cs_mesh_quantities.h:156
cs_real_t * b_f_face_normal
Definition: cs_mesh_quantities.h:106
cs_real_t * i_face_normal
Definition: cs_mesh_quantities.h:100
cs_real_3_t * dijpf
Definition: cs_mesh_quantities.h:131
unsigned * bad_cell_flag
Definition: cs_mesh_quantities.h:167
cs_rreal_3_t * djjpf
Definition: cs_mesh_quantities.h:135
Definition: cs_mesh.h:85