9.1
general documentation
cs_function_default.h
Go to the documentation of this file.
1#ifndef __CS_FUNCTION_DEFAULT_H__
2#define __CS_FUNCTION_DEFAULT_H__
3
4/*============================================================================
5 * Base predefined function objects.
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2025 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 "base/cs_function.h"
36
37/*----------------------------------------------------------------------------*/
38
39BEGIN_C_DECLS
40
41/*=============================================================================
42 * Macro definitions
43 *============================================================================*/
44
45/*============================================================================
46 * Type definitions
47 *============================================================================*/
48
51typedef enum {
52
53 CS_FUNCTION_CELL_RANK_ID,
54 CS_FUNCTION_B_FACE_RANK_ID
56} cs_function_predefined_t;
57
58/*============================================================================
59 * Global variables
60 *============================================================================*/
61
62/*=============================================================================
63 * Public function prototypes
64 *============================================================================*/
65
66/*----------------------------------------------------------------------------*/
70/*----------------------------------------------------------------------------*/
71
72void
73cs_function_default_define(void);
74
75/*----------------------------------------------------------------------------*/
84/*----------------------------------------------------------------------------*/
85
86cs_function_t *
87cs_function_define_mpi_rank_id(cs_mesh_location_type_t location_id);
88
89/*----------------------------------------------------------------------------*/
99/*----------------------------------------------------------------------------*/
100
101cs_function_t *
102cs_function_define_refinement_generation(cs_mesh_location_type_t location_id);
103
104/*----------------------------------------------------------------------------*/
111/*----------------------------------------------------------------------------*/
112
113cs_function_t *
114cs_function_define_boundary_stress_normal(void);
115
116/*----------------------------------------------------------------------------*/
123/*----------------------------------------------------------------------------*/
124
125cs_function_t *
126cs_function_define_boundary_stress_tangential(void);
127
128/*----------------------------------------------------------------------------*/
135/*----------------------------------------------------------------------------*/
136
137cs_function_t *
138cs_function_define_boundary_thermal_flux(void);
139
140/*----------------------------------------------------------------------------*/
147/*----------------------------------------------------------------------------*/
148
149cs_function_t *
150cs_function_define_q_criterion(void);
151
152/*----------------------------------------------------------------------------*/
171/*----------------------------------------------------------------------------*/
172
173void
174cs_function_class_or_zone_id(int location_id,
175 cs_lnum_t n_elts,
176 const cs_lnum_t *elt_ids,
177 void *input,
178 void *vals);
179
180/*----------------------------------------------------------------------------*/
194/*----------------------------------------------------------------------------*/
195
196void
197cs_function_field_boundary_nr(int location_id,
198 cs_lnum_t n_elts,
199 const cs_lnum_t *elt_ids,
200 void *input,
201 void *vals);
202
203/*----------------------------------------------------------------------------*/
217/*----------------------------------------------------------------------------*/
218
219void
220cs_function_boundary_stress_normal(int location_id,
221 cs_lnum_t n_elts,
222 const cs_lnum_t *elt_ids,
223 void *input,
224 void *vals);
225
226/*----------------------------------------------------------------------------*/
240/*----------------------------------------------------------------------------*/
241
242void
243cs_function_boundary_stress_tangential(int location_id,
244 cs_lnum_t n_elts,
245 const cs_lnum_t *elt_ids,
246 void *input,
247 void *vals);
248
249/*----------------------------------------------------------------------------*/
256/*----------------------------------------------------------------------------*/
257
258cs_function_t *
259cs_function_define_boundary_nusselt(void);
260
261/*----------------------------------------------------------------------------*/
275/*----------------------------------------------------------------------------*/
276
277void
278cs_function_boundary_thermal_flux(int location_id,
279 cs_lnum_t n_elts,
280 const cs_lnum_t *elt_ids,
281 void *input,
282 void *vals);
283
284/*----------------------------------------------------------------------------*/
298/*----------------------------------------------------------------------------*/
299
300void
301cs_function_boundary_nusselt(int location_id,
302 cs_lnum_t n_elts,
303 const cs_lnum_t *elt_ids,
304 void *input,
305 void *vals);
306
307/*----------------------------------------------------------------------------*/
330/*----------------------------------------------------------------------------*/
331
332void
333cs_function_q_criterion(int location_id,
334 cs_lnum_t n_elts,
335 const cs_lnum_t *elt_ids,
336 void *input,
337 void *vals);
338
339/*----------------------------------------------------------------------------*/
340/*
341 * \brief Define output function of a property (which is not a field).
342 */
343/*----------------------------------------------------------------------------*/
344
345cs_function_t *
346cs_function_define_property_cells
347(
348 char *property_name
349);
350
351/*----------------------------------------------------------------------------*/
352/*
353 * \brief Define output function for the vorticity.
354 */
355/*----------------------------------------------------------------------------*/
356
357cs_function_t *
358cs_function_define_vorticity
359(
360 cs_field_t *velocity_field
361);
362
363/*----------------------------------------------------------------------------*/
364
365END_C_DECLS
366
367#endif /* __CS_FUNCTION_DEFAULT_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:554
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:555
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:350
cs_function.h
cs_function_define_property_cells
cs_function_t * cs_function_define_property_cells(char *property_name)
Define output function of a property (which is not a field).
Definition: cs_function_default.cpp:1718
cs_function_define_boundary_thermal_flux
cs_function_t * cs_function_define_boundary_thermal_flux(void)
Define function object for computation of boundary thermal flux.
Definition: cs_function_default.cpp:917
cs_function_default_define
void cs_function_default_define(void)
Define functions based on code_saturne case setup.
Definition: cs_function_default.cpp:697
cs_function_define_q_criterion
cs_function_t * cs_function_define_q_criterion(void)
Define function for computation of cell Q criterion.
Definition: cs_function_default.cpp:1031
cs_function_define_mpi_rank_id
cs_function_t * cs_function_define_mpi_rank_id(cs_mesh_location_type_t location_id)
Create or access a function for evaluation of element's MPI rank id.
Definition: cs_function_default.cpp:736
cs_function_q_criterion
void cs_function_q_criterion(int location_id, cs_lnum_t n_elts, const cs_lnum_t *elt_ids, void *input, void *vals)
Compute the Q-criterion from Hunt et. al over each cell of a specified volume region.
Definition: cs_function_default.cpp:1675
cs_function_boundary_stress_normal
void cs_function_boundary_stress_normal(int location_id, cs_lnum_t n_elts, const cs_lnum_t *elt_ids, void *input, void *vals)
Compute normal stress at boundary.
Definition: cs_function_default.cpp:1273
cs_function_define_refinement_generation
cs_function_t * cs_function_define_refinement_generation(cs_mesh_location_type_t location_id)
Create or access a function for evaluation of mesh element's refinement generation (i....
Definition: cs_function_default.cpp:794
cs_function_define_boundary_stress_tangential
cs_function_t * cs_function_define_boundary_stress_tangential(void)
Define function object for computation of tangential boundary stress.
Definition: cs_function_default.cpp:883
cs_function_boundary_thermal_flux
void cs_function_boundary_thermal_flux(int location_id, cs_lnum_t n_elts, const cs_lnum_t *elt_ids, void *input, void *vals)
Compute thermal flux at boundary (in ),.
Definition: cs_function_default.cpp:1377
cs_function_define_vorticity
cs_function_t * cs_function_define_vorticity(cs_field_t *velocity_field)
Define output function for the vorticity.
Definition: cs_function_default.cpp:1755
cs_function_define_boundary_nusselt
cs_function_t * cs_function_define_boundary_nusselt(void)
Define function for computation of boundary layer Nusselt.
Definition: cs_function_default.cpp:971
cs_function_class_or_zone_id
void cs_function_class_or_zone_id(int location_id, cs_lnum_t n_elts, const cs_lnum_t *elt_ids, void *input, void *vals)
Extract optional boundary face class of element zone id.
Definition: cs_function_default.cpp:1073
cs_function_define_boundary_stress_normal
cs_function_t * cs_function_define_boundary_stress_normal(void)
Define function object for computation of normal boundary stress.
Definition: cs_function_default.cpp:849
cs_function_field_boundary_nr
void cs_function_field_boundary_nr(int location_id, cs_lnum_t n_elts, const cs_lnum_t *elt_ids, void *input, void *vals)
Compute non-reconstructed cell-based field values at boundary.
Definition: cs_function_default.cpp:1123
cs_function_predefined_t
cs_function_predefined_t
Definition: cs_function_default.h:51
CS_FUNCTION_CELL_RANK_ID
@ CS_FUNCTION_CELL_RANK_ID
Definition: cs_function_default.h:53
CS_FUNCTION_B_FACE_RANK_ID
@ CS_FUNCTION_B_FACE_RANK_ID
Definition: cs_function_default.h:54
cs_function_boundary_nusselt
void cs_function_boundary_nusselt(int location_id, cs_lnum_t n_elts, const cs_lnum_t *elt_ids, void *input, void *vals)
Compute local Nusselt number near boundary.
Definition: cs_function_default.cpp:1448
cs_function_boundary_stress_tangential
void cs_function_boundary_stress_tangential(int location_id, cs_lnum_t n_elts, const cs_lnum_t *elt_ids, void *input, void *vals)
Compute tangential stress at boundary.
Definition: cs_function_default.cpp:1323
cs_mesh_location_type_t
cs_mesh_location_type_t
Definition: cs_mesh_location.h:60
cs_field_t
Field descriptor.
Definition: cs_field.h:156
cs_function_t
Definition: cs_function.h:121