9.2
general documentation
cs_post_util.h
Go to the documentation of this file.
1#ifndef CS_POST_UTIL_H
2#define CS_POST_UTIL_H
3
4/*============================================================================
5 * Postprocessing utility functions.
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2026 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 "base/cs_defs.h"
35#include "mesh/cs_mesh_location.h"
36#include "base/cs_field_operator.h"
37
38/*=============================================================================
39 * Type Definitions
40 *============================================================================*/
41
42/*============================================================================
43 * Global variables
44 *============================================================================*/
45
46/*============================================================================
47 * Public function prototypes
48 *============================================================================*/
49
50/*----------------------------------------------------------------------------*/
77/*----------------------------------------------------------------------------*/
78
79[[deprecated("Use cs_mesh_intersect_segment_cell_select (rename) instead")]]
80void
81cs_cell_segment_intersect_select(void *input,
82 cs_lnum_t *n_cells,
83 cs_lnum_t **cell_ids);
84
85/*----------------------------------------------------------------------------*/
116/*----------------------------------------------------------------------------*/
117
118[[deprecated("Use cs_mesh_intersect_polyline_cell_select (rename) instead")]]
119void
120cs_cell_polyline_intersect_select(void *input,
121 cs_lnum_t n_points,
122 cs_lnum_t *n_cells,
123 cs_lnum_t **cell_ids,
124 cs_real_t **seg_c_len,
125 cs_real_3_t **seg_c_cen);
126
127/*----------------------------------------------------------------------------*/
158/*----------------------------------------------------------------------------*/
159
160[[deprecated("Use cs_probe_set_create_from_segment function instead")]]
161void
162cs_cell_segment_intersect_probes_define(void *input,
163 cs_lnum_t *n_elts,
164 cs_real_3_t **coords,
165 cs_real_t **s);
166
167/*----------------------------------------------------------------------------*/
179/*----------------------------------------------------------------------------*/
180
181void
182cs_b_face_criterion_probes_define(void *input,
183 cs_lnum_t *n_elts,
184 cs_real_3_t **coords,
185 cs_real_t **s);
186
187/*----------------------------------------------------------------------------*/
198/*----------------------------------------------------------------------------*/
199
200cs_real_t
201cs_post_turbomachinery_head(const char *criteria_in,
202 cs_mesh_location_type_t location_in,
203 const char *criteria_out,
204 cs_mesh_location_type_t location_out);
205
206/*----------------------------------------------------------------------------*/
217/*----------------------------------------------------------------------------*/
218
219cs_real_t
220cs_post_moment_of_force(cs_lnum_t n_b_faces,
221 const cs_lnum_t b_face_ids[],
222 cs_real_t axis[3]);
223
224/*----------------------------------------------------------------------------*/
233/*----------------------------------------------------------------------------*/
234
235void
236cs_post_stress_tangential(cs_lnum_t n_b_faces,
237 const cs_lnum_t b_face_ids[],
238 cs_real_3_t stress[]);
239
240/*----------------------------------------------------------------------------*/
248/*----------------------------------------------------------------------------*/
249
250void
251cs_post_b_pressure(cs_lnum_t n_b_faces,
252 const cs_lnum_t b_face_ids[],
253 cs_real_t pres[]);
254
255/*----------------------------------------------------------------------------*/
263/*----------------------------------------------------------------------------*/
264
265void
266cs_post_b_total_pressure(cs_lnum_t n_b_faces,
267 const cs_lnum_t b_face_ids[],
268 cs_real_t pres[]);
269
270/*----------------------------------------------------------------------------*/
283/*----------------------------------------------------------------------------*/
284
285void
286cs_post_evm_reynolds_stresses(cs_field_interpolate_t interpolation_type,
287 cs_lnum_t n_cells,
288 const cs_lnum_t cell_ids[],
289 const cs_real_3_t *coords,
290 cs_real_6_t *rst);
291
292/*----------------------------------------------------------------------------*/
303/*----------------------------------------------------------------------------*/
304
305void
306cs_post_anisotropy_invariant(cs_lnum_t n_cells,
307 const cs_lnum_t cell_ids[],
308 const cs_real_t coords[][3],
309 cs_real_t inv[][2]);
310
311/*----------------------------------------------------------------------------*/
322/*----------------------------------------------------------------------------*/
323
324void
325cs_post_boundary_flux(const char *scalar_name,
326 cs_lnum_t n_loc_b_faces,
327 const cs_lnum_t b_face_ids[],
328 cs_real_t b_face_flux[]);
329
330/*----------------------------------------------------------------------------*/
343/*----------------------------------------------------------------------------*/
344
345void
346cs_post_field_cell_to_b_face_values(const cs_field_t *f,
347 cs_lnum_t n_loc_b_faces,
348 const cs_lnum_t b_face_ids[],
349 cs_real_t *b_val);
350
351/*----------------------------------------------------------------------------*/
362/*----------------------------------------------------------------------------*/
363
364cs_real_t
365cs_post_scalar_boundary_integral(const cs_real_t *scalar_vals,
366 const cs_lnum_t n_loc_b_faces,
367 const cs_lnum_t b_face_ids[]);
368
369/*----------------------------------------------------------------------------*/
380/*----------------------------------------------------------------------------*/
381
382cs_real_t
383cs_post_bnd_scalar_boundary_integral(const cs_real_t *scalar_vals,
384 const cs_lnum_t n_loc_b_faces,
385 const cs_lnum_t b_face_ids[]);
386
387/*----------------------------------------------------------------------------*/
399/*----------------------------------------------------------------------------*/
400
401cs_real_t
402cs_post_scalar_boundary_mean(const cs_real_t *scalar_vals,
403 const cs_lnum_t n_loc_b_faces,
404 const cs_lnum_t b_face_ids[]);
405
406/*----------------------------------------------------------------------------*/
418/*----------------------------------------------------------------------------*/
419
420cs_real_t
421cs_post_bnd_scalar_boundary_mean(const cs_real_t *scalar_vals,
422 const cs_lnum_t n_loc_b_faces,
423 const cs_lnum_t b_face_ids[]);
424
425/*----------------------------------------------------------------------------*/
435/*----------------------------------------------------------------------------*/
436
437cs_real_t
438cs_post_scalar_b_zone_integral(const cs_zone_t *z,
439 const cs_real_t *scalar_vals);
440
441/*----------------------------------------------------------------------------*/
451/*----------------------------------------------------------------------------*/
452
453cs_real_t
454cs_post_bnd_scalar_b_zone_integral(const cs_zone_t *z,
455 const cs_real_t *scalar_vals);
456
457/*----------------------------------------------------------------------------*/
468/*----------------------------------------------------------------------------*/
469
470cs_real_t
471cs_post_scalar_b_zone_mean(const cs_zone_t *z,
472 const cs_real_t *scalar_vals);
473
474/*----------------------------------------------------------------------------*/
485/*----------------------------------------------------------------------------*/
486
487cs_real_t
488cs_post_bnd_scalar_b_zone_mean(const cs_zone_t *z,
489 const cs_real_t *scalar_vals);
490
491/*----------------------------------------------------------------------------*/
492
493#endif /* CS_POST_UTIL_H */
cs_field_t
Field descriptor.
Definition: cs_field.h:275
cs_defs.h
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:349
cs_real_6_t
cs_real_t cs_real_6_t[6]
vector of 6 floating-point values
Definition: cs_defs.h:351
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:325
cs_field_operator.h
cs_field_interpolate_t
cs_field_interpolate_t
Definition: cs_field_operator.h:50
cs_mesh_location.h
cs_mesh_location_type_t
cs_mesh_location_type_t
Definition: cs_mesh_location.h:60
cs_post_scalar_b_zone_integral
cs_real_t cs_post_scalar_b_zone_integral(const cs_zone_t *z, const cs_real_t *scalar_vals)
Compute the surface integral of a scalar array of values located on boundary faces over a boundary zo...
Definition: cs_post_util.cpp:1192
cs_post_boundary_flux
void cs_post_boundary_flux(const char *scalar_name, cs_lnum_t n_loc_b_faces, const cs_lnum_t b_face_ids[], cs_real_t b_face_flux[])
Compute scalar flux on a specific boundary region.
Definition: cs_post_util.cpp:841
cs_post_scalar_b_zone_mean
cs_real_t cs_post_scalar_b_zone_mean(const cs_zone_t *z, const cs_real_t *scalar_vals)
Compute the surface mean of a scalar array of values located on boundary faces over a boundary zone....
Definition: cs_post_util.cpp:1235
cs_post_scalar_boundary_mean
cs_real_t cs_post_scalar_boundary_mean(const cs_real_t *scalar_vals, const cs_lnum_t n_loc_b_faces, const cs_lnum_t b_face_ids[])
Compute the surface mean of a scalar array of values located on boundary faces over a selection of bo...
Definition: cs_post_util.cpp:1095
cs_cell_segment_intersect_probes_define
void cs_cell_segment_intersect_probes_define(void *input, cs_lnum_t *n_elts, cs_real_3_t **coords, cs_real_t **s)
Define probes based on the centers of cells intersected by a given segment.
Definition: cs_post_util.cpp:256
cs_post_moment_of_force
cs_real_t cs_post_moment_of_force(cs_lnum_t n_b_faces, const cs_lnum_t b_face_ids[], cs_real_t axis[3])
Compute the magnitude of a moment of force torque) given an axis and the stress on a specific boundar...
Definition: cs_post_util.cpp:508
cs_post_anisotropy_invariant
void cs_post_anisotropy_invariant(cs_lnum_t n_cells, const cs_lnum_t cell_ids[], const cs_real_t coords[][3], cs_real_t inv[][2])
Compute the invariant of the anisotropy tensor.
cs_post_bnd_scalar_b_zone_integral
cs_real_t cs_post_bnd_scalar_b_zone_integral(const cs_zone_t *z, const cs_real_t *scalar_vals)
Compute the surface integral of a scalar over a boundary zone faces, for an array of values located o...
Definition: cs_post_util.cpp:1213
cs_post_turbomachinery_head
cs_real_t cs_post_turbomachinery_head(const char *criteria_in, cs_mesh_location_type_t location_in, const char *criteria_out, cs_mesh_location_type_t location_out)
Compute the head of a turbomachinery (total pressure increase)
Definition: cs_post_util.cpp:374
cs_post_evm_reynolds_stresses
void cs_post_evm_reynolds_stresses(cs_field_interpolate_t interpolation_type, cs_lnum_t n_cells, const cs_lnum_t cell_ids[], const cs_real_3_t *coords, cs_real_6_t *rst)
Compute Reynolds stresses in case of Eddy Viscosity Models.
Definition: cs_post_util.cpp:696
cs_b_face_criterion_probes_define
void cs_b_face_criterion_probes_define(void *input, cs_lnum_t *n_elts, cs_real_3_t **coords, cs_real_t **s)
Define a profile based on centers of faces defined by a given criterion.
Definition: cs_post_util.cpp:324
cs_post_scalar_boundary_integral
cs_real_t cs_post_scalar_boundary_integral(const cs_real_t *scalar_vals, const cs_lnum_t n_loc_b_faces, const cs_lnum_t b_face_ids[])
Compute the surface integral of a scalar array of values located on boundary faces over a selection o...
Definition: cs_post_util.cpp:1006
cs_cell_polyline_intersect_select
void cs_cell_polyline_intersect_select(void *input, cs_lnum_t n_points, cs_lnum_t *n_cells, cs_lnum_t **cell_ids, cs_real_t **seg_c_len, cs_real_3_t **seg_c_cen)
Select cells cut by a line composed of segments.
Definition: cs_post_util.cpp:207
cs_post_bnd_scalar_b_zone_mean
cs_real_t cs_post_bnd_scalar_b_zone_mean(const cs_zone_t *z, const cs_real_t *scalar_vals)
Compute the surface mean of a scalar over a boundary zone faces, for an array of values located on th...
Definition: cs_post_util.cpp:1265
cs_post_bnd_scalar_boundary_integral
cs_real_t cs_post_bnd_scalar_boundary_integral(const cs_real_t *scalar_vals, const cs_lnum_t n_loc_b_faces, const cs_lnum_t b_face_ids[])
Compute the surface integral over a selection of boundary faces for a scalar array of values located ...
Definition: cs_post_util.cpp:1050
cs_post_b_total_pressure
void cs_post_b_total_pressure(cs_lnum_t n_b_faces, const cs_lnum_t b_face_ids[], cs_real_t pres[])
Compute total pressure on a specific boundary region.
Definition: cs_post_util.cpp:653
cs_post_bnd_scalar_boundary_mean
cs_real_t cs_post_bnd_scalar_boundary_mean(const cs_real_t *scalar_vals, const cs_lnum_t n_loc_b_faces, const cs_lnum_t b_face_ids[])
Compute the surface mean over a selection of boundary faces for a scalar array of values located over...
Definition: cs_post_util.cpp:1145
cs_post_b_pressure
void cs_post_b_pressure(cs_lnum_t n_b_faces, const cs_lnum_t b_face_ids[], cs_real_t pres[])
Compute pressure on a specific boundary region.
Definition: cs_post_util.cpp:578
cs_cell_segment_intersect_select
void cs_cell_segment_intersect_select(void *input, cs_lnum_t *n_cells, cs_lnum_t **cell_ids)
Select cells cut by a given segment.
Definition: cs_post_util.cpp:164
cs_post_field_cell_to_b_face_values
void cs_post_field_cell_to_b_face_values(const cs_field_t *f, cs_lnum_t n_loc_b_faces, const cs_lnum_t b_face_ids[], cs_real_t *b_val)
Compute values at a selection of boundary faces of a given field located on cells.
Definition: cs_post_util.cpp:890
cs_post_stress_tangential
void cs_post_stress_tangential(cs_lnum_t n_b_faces, const cs_lnum_t b_face_ids[], cs_real_3_t stress[])
Compute tangential stress on a specific boundary.
Definition: cs_post_util.cpp:547
cs_zone_t
Definition: cs_zone.h:51