9.2
general documentation
cs_prototypes.h
Go to the documentation of this file.
1#ifndef CS_PROTOTYPES_H
2#define CS_PROTOTYPES_H
3
4/*============================================================================
5 * Prototypes for user-defined 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_base.h"
35#include "base/cs_field.h"
36#include "base/cs_mobile_structures.h"
37#include "base/cs_probe.h"
38#include "base/cs_time_control.h"
39#include "base/cs_volume_zone.h"
40#include "cdo/cs_domain.h"
41#include "mesh/cs_mesh.h"
42#include "mesh/cs_mesh_bad_cells.h"
43#include "mesh/cs_mesh_quantities.h"
44
45/*----------------------------------------------------------------------------*/
46
47BEGIN_C_DECLS
48
49/*============================================================================
50 * User function prototypes
51 *============================================================================*/
52
55/*----------------------------------------------------------------------------*/
60/*----------------------------------------------------------------------------*/
61
62void
63cs_user_1d_wall_thermal_setup(void);
64
65/*----------------------------------------------------------------------------*/
77/*----------------------------------------------------------------------------*/
78
79void
80cs_user_1d_wall_thermal(int iappel);
81
82/*----------------------------------------------------------------------------*/
88/*----------------------------------------------------------------------------*/
89
90/*----------------------------------------------------------------------------*/
103/*----------------------------------------------------------------------------*/
104
105void
106cs_user_atmo_1d_rad_prf(cs_real_t preray[],
107 cs_real_t temray[],
108 cs_real_t romray[],
109 cs_real_t qvray[],
110 cs_real_t qlray[],
111 cs_real_t ncray[],
112 cs_real_t aeroso[]);
113
114/*----------------------------------------------------------------------------*/
120/*----------------------------------------------------------------------------*/
121
122/*----------------------------------------------------------------------------*/
133/*----------------------------------------------------------------------------*/
134
135void
136cs_user_boundary_conditions_setup(cs_domain_t *domain);
137
138/*----------------------------------------------------------------------------*/
175/*----------------------------------------------------------------------------*/
176
177void
178cs_user_boundary_conditions(cs_domain_t *domain,
179 int bc_type[]);
180
181/*----------------------------------------------------------------------------*/
223/*----------------------------------------------------------------------------*/
224
225void
226cs_user_boundary_conditions_ale(cs_domain_t *domain,
227 int bc_type[],
228 int ale_bc_type[],
229 int impale[]);
230
231/*----------------------------------------------------------------------------*/
239/*----------------------------------------------------------------------------*/
240
241/*----------------------------------------------------------------------------*/
248/*----------------------------------------------------------------------------*/
249
250void
251cs_user_saturne_coupling(void);
252
253/*----------------------------------------------------------------------------*/
260/*----------------------------------------------------------------------------*/
261
262void
263cs_user_syrthes_coupling(void);
264
265/*----------------------------------------------------------------------------*/
275/*----------------------------------------------------------------------------*/
276
277void
278cs_user_syrthes_coupling_volume_h(int coupling_id,
279 const char *syrthes_name,
280 cs_lnum_t n_elts,
281 const cs_lnum_t elt_ids[],
282 cs_real_t h_vol[]);
283
284/*----------------------------------------------------------------------------*/
290/*----------------------------------------------------------------------------*/
291
292void
293cs_user_cathare_coupling(void);
294
297/*----------------------------------------------------------------------------*/
309/*----------------------------------------------------------------------------*/
310
311void
312cs_user_scaling_elec(const cs_mesh_t *mesh,
313 const cs_mesh_quantities_t *mesh_quantities,
314 cs_real_t *dt);
315
316/*----------------------------------------------------------------------------*/
322/*----------------------------------------------------------------------------*/
323
324/*----------------------------------------------------------------------------*/
336/*----------------------------------------------------------------------------*/
337
338/*----------------------------------------------------------------------------*/
350/*----------------------------------------------------------------------------*/
351
352void
353cs_user_extra_operations_initialize(cs_domain_t *domain);
354
355/*----------------------------------------------------------------------------*/
364/*----------------------------------------------------------------------------*/
365
366void
367cs_user_extra_operations(cs_domain_t *domain);
368
369/*----------------------------------------------------------------------------*/
378/*----------------------------------------------------------------------------*/
379
380void
381cs_user_extra_operations_finalize(cs_domain_t *domain);
382
383/*----------------------------------------------------------------------------*/
390/*----------------------------------------------------------------------------*/
391
392/*----------------------------------------------------------------------------*/
413/*----------------------------------------------------------------------------*/
414
415void
416cs_user_fsi_structure_define(int is_restart,
417 int n_structs,
418 int *plot,
419 cs_time_control_t *plot_time_control,
420 cs_real_t *aexxst,
421 cs_real_t *bexxst,
422 cs_real_t *cfopre,
423 cs_real_t xstr0[][3],
424 cs_real_t vstr0[][3],
425 cs_real_t xstreq[][3]);
426
427/*----------------------------------------------------------------------------*/
442/*----------------------------------------------------------------------------*/
443
444void
445cs_user_fsi_structure_values(int n_structs,
446 const cs_time_step_t *ts,
447 const cs_real_t xstreq[][3],
448 const cs_real_t xstr[][3],
449 const cs_real_t vstr[][3],
450 cs_real_t xmstru[][3][3],
451 cs_real_t xcstru[][3][3],
452 cs_real_t xkstru[][3][3],
453 cs_real_t forstr[][3],
454 cs_real_t dtstr[]);
455
456/*----------------------------------------------------------------------------*/
470/*----------------------------------------------------------------------------*/
471
472void
473cs_user_fsi_structure_num(cs_domain_t *domain,
474 int structure_num[],
475 cs_mobile_structure_type_t structure_typ[]);
476
477/*----------------------------------------------------------------------------*/
486/*----------------------------------------------------------------------------*/
487
488void
489cs_user_fsi_external_displacement(const cs_domain_t *domain,
490 const cs_real_3_t *b_stress,
491 cs_real_3_t *disaple);
492
493/*----------------------------------------------------------------------------*/
507/*----------------------------------------------------------------------------*/
508
509void
510cs_user_fsi_external_cvg(const cs_domain_t *domain,
511 const cs_real_t epsilon,
512 int *cvg_status,
513 cs_real_t *residual);
514
515/*----------------------------------------------------------------------------*/
521/*----------------------------------------------------------------------------*/
522
523/*----------------------------------------------------------------------------*/
541/*----------------------------------------------------------------------------*/
542
543void
544cs_user_head_losses(const cs_zone_t *zone,
545 cs_real_t cku[][6]);
546
547/*----------------------------------------------------------------------------*/
553/*----------------------------------------------------------------------------*/
554
555/*----------------------------------------------------------------------------*/
568/*----------------------------------------------------------------------------*/
569
570void
571cs_user_hgn_thermo_relax_time(const cs_mesh_t *mesh,
572 const cs_real_t *alpha_eq,
573 const cs_real_t *y_eq,
574 const cs_real_t *z_eq,
575 const cs_real_t *ei,
576 const cs_real_t *v,
577 cs_real_t *relax_tau);
578
579/*----------------------------------------------------------------------------*/
585/*----------------------------------------------------------------------------*/
586
587/*----------------------------------------------------------------------------*/
599/*----------------------------------------------------------------------------*/
600
601void
602cs_user_initial_conditions(cs_domain_t *domain);
603
604/*----------------------------------------------------------------------------*/
616/*----------------------------------------------------------------------------*/
617
618void
619cs_user_initialization(cs_domain_t *domain);
620
621/*----------------------------------------------------------------------------*/
629/*----------------------------------------------------------------------------*/
630
631/*----------------------------------------------------------------------------*/
635/*----------------------------------------------------------------------------*/
636
637void
638cs_user_mesh_input(void);
639
640/*----------------------------------------------------------------------------*/
644/*----------------------------------------------------------------------------*/
645
646void
647cs_user_mesh_cartesian_define(void);
648
649/*----------------------------------------------------------------------------*/
653/*----------------------------------------------------------------------------*/
654
655void
656cs_user_join(void);
657
658/*----------------------------------------------------------------------------*/
662/*----------------------------------------------------------------------------*/
663
664void
665cs_user_periodicity(void);
666
667/*----------------------------------------------------------------------------*/
671/*----------------------------------------------------------------------------*/
672
673void
674cs_user_mesh_warping(void);
675
676/*----------------------------------------------------------------------------*/
682/*----------------------------------------------------------------------------*/
683
684void
685cs_user_mesh_boundary(cs_mesh_t *mesh);
686
687/*----------------------------------------------------------------------------*/
693/*----------------------------------------------------------------------------*/
694
695void
696cs_user_mesh_modify(cs_mesh_t *mesh);
697
698/*----------------------------------------------------------------------------*/
704/*----------------------------------------------------------------------------*/
705
706void
707cs_user_mesh_smoothe(cs_mesh_t *mesh);
708
709/*----------------------------------------------------------------------------*/
717/*----------------------------------------------------------------------------*/
718
719void
720cs_user_mesh_save(cs_mesh_t *mesh);
721
722/*----------------------------------------------------------------------------*/
729/*----------------------------------------------------------------------------*/
730
731void
732cs_user_mesh_bad_cells_tag(cs_mesh_t *mesh,
733 cs_mesh_quantities_t *mesh_quantities);
734
735/*----------------------------------------------------------------------------*/
743/*----------------------------------------------------------------------------*/
744
745void
746cs_user_mesh_modify_partial(cs_mesh_t *mesh,
747 cs_mesh_quantities_t *mesh_quantities);
748
749/*----------------------------------------------------------------------------*/
757/*----------------------------------------------------------------------------*/
758
759/*----------------------------------------------------------------------------*/
763/*----------------------------------------------------------------------------*/
764
765void
766cs_user_paramedmem_define_couplings(void);
767
768/*----------------------------------------------------------------------------*/
772/*----------------------------------------------------------------------------*/
773
774void
775cs_user_paramedmem_define_meshes(void);
776
777/*----------------------------------------------------------------------------*/
781/*----------------------------------------------------------------------------*/
782
783void
784cs_user_paramedmem_define_fields(void);
785
786/*----------------------------------------------------------------------------*/
794/*----------------------------------------------------------------------------*/
795
796/*----------------------------------------------------------------------------*/
803/*----------------------------------------------------------------------------*/
804
805void
806cs_user_model(void);
807
808/*----------------------------------------------------------------------------*/
822/*----------------------------------------------------------------------------*/
823
824void
825cs_user_parameters(cs_domain_t *domain);
826
827/*----------------------------------------------------------------------------*/
841/*----------------------------------------------------------------------------*/
842
843void
844cs_user_linear_solvers(void);
845
846/*----------------------------------------------------------------------------*/
854/*----------------------------------------------------------------------------*/
855
856void
857cs_user_time_moments(void);
858
859/*----------------------------------------------------------------------------*/
865/*----------------------------------------------------------------------------*/
866
867void
868cs_user_internal_coupling(void);
869
870/*----------------------------------------------------------------------------*/
879/*----------------------------------------------------------------------------*/
880
881void
882cs_user_finalize_setup(cs_domain_t *domain);
883
884/*----------------------------------------------------------------------------*/
892/*----------------------------------------------------------------------------*/
893
894/*----------------------------------------------------------------------------*/
898/*----------------------------------------------------------------------------*/
899
900void
901cs_user_numbering(void);
902
903/*----------------------------------------------------------------------------*/
907/*----------------------------------------------------------------------------*/
908
909void
910cs_user_partition(void);
911
912/*----------------------------------------------------------------------------*/
916/*----------------------------------------------------------------------------*/
917
918void
919cs_user_parallel_io(void);
920
921/*----------------------------------------------------------------------------*/
925/*----------------------------------------------------------------------------*/
926
927void
928cs_user_matrix_tuning(void);
929
930/*----------------------------------------------------------------------------*/
936/*----------------------------------------------------------------------------*/
937
938/*----------------------------------------------------------------------------*/
944/*----------------------------------------------------------------------------*/
945
946void
947cs_user_physical_properties(cs_domain_t *domain);
948
949/*----------------------------------------------------------------------------*/
967/*----------------------------------------------------------------------------*/
968
969void
970cs_user_physical_properties_h_to_t(cs_domain_t *domain,
971 const cs_zone_t *z,
972 bool z_local,
973 const cs_real_t h[],
974 cs_real_t t[]);
975
976/*----------------------------------------------------------------------------*/
994/*----------------------------------------------------------------------------*/
995
996void
997cs_user_physical_properties_t_to_h(cs_domain_t *domain,
998 const cs_zone_t *z,
999 bool z_local,
1000 const cs_real_t t[],
1001 cs_real_t h[]);
1002
1003/*----------------------------------------------------------------------------*/
1012/*----------------------------------------------------------------------------*/
1013
1014void
1015cs_user_physical_properties_turb_viscosity(cs_domain_t *domain);
1016
1017/*----------------------------------------------------------------------------*/
1031/*----------------------------------------------------------------------------*/
1032
1033void
1034cs_user_physical_properties_td_pressure(cs_real_t *td_p);
1035
1036/*----------------------------------------------------------------------------*/
1044/*----------------------------------------------------------------------------*/
1045
1046/*----------------------------------------------------------------------------*/
1056/*----------------------------------------------------------------------------*/
1057
1058void
1059cs_user_porosity(cs_domain_t *domain);
1060
1061/*----------------------------------------------------------------------------*/
1065/*----------------------------------------------------------------------------*/
1066
1067/*----------------------------------------------------------------------------*/
1076/*----------------------------------------------------------------------------*/
1077
1078void
1079cs_user_postprocess_writers(void);
1080
1081/*----------------------------------------------------------------------------*/
1089/*----------------------------------------------------------------------------*/
1090
1091void
1092cs_user_postprocess_meshes(void);
1093
1094/*----------------------------------------------------------------------------*/
1100/*----------------------------------------------------------------------------*/
1101
1102void
1103cs_user_postprocess_probes(void);
1104
1105/*----------------------------------------------------------------------------*/
1129/*----------------------------------------------------------------------------*/
1130
1131void
1132cs_user_postprocess_values(const char *mesh_name,
1133 int mesh_id,
1134 int cat_id,
1135 cs_probe_set_t *probes,
1136 cs_lnum_t n_cells,
1137 cs_lnum_t n_i_faces,
1138 cs_lnum_t n_b_faces,
1139 cs_lnum_t n_vertices,
1140 const cs_lnum_t cell_list[],
1141 const cs_lnum_t i_face_list[],
1142 const cs_lnum_t b_face_list[],
1143 const cs_lnum_t vertex_list[],
1144 const cs_time_step_t *ts);
1145
1146/*----------------------------------------------------------------------------*/
1156/*----------------------------------------------------------------------------*/
1157
1158void
1159cs_user_postprocess_activate(int nt_max_abs,
1160 int nt_cur_abs,
1161 double t_cur_abs);
1162
1163/*----------------------------------------------------------------------------*/
1171/*----------------------------------------------------------------------------*/
1172
1173/*-----------------------------------------------------------------------------*/
1190/*----------------------------------------------------------------------------*/
1191
1192void
1193cs_user_rad_transfer_absorption(const int bc_type[],
1194 cs_real_t ck[]);
1195
1196/*----------------------------------------------------------------------------*/
1215/*----------------------------------------------------------------------------*/
1216
1217void
1218cs_user_rad_transfer_net_flux(const int itypfb[],
1219 const cs_real_t twall[],
1220 const cs_real_t qincid[],
1221 const cs_real_t xlam[],
1222 const cs_real_t epa[],
1223 const cs_real_t eps[],
1224 const cs_real_t ck[],
1225 cs_real_t net_flux[]);
1226
1227/*----------------------------------------------------------------------------*/
1228/*
1229 *! \file cs_user_radiative_transfer_bcs.cpp
1230 */
1231/*----------------------------------------------------------------------------*/
1232
1233/*----------------------------------------------------------------------------*/
1290/*----------------------------------------------------------------------------*/
1291
1292void
1293cs_user_radiative_transfer_bcs(cs_domain_t *domain,
1294 const int bc_type[],
1295 int isothp[],
1296 cs_real_t *tmin,
1297 cs_real_t *tmax,
1298 cs_real_t *tx,
1299 const cs_real_t dt[],
1300 const cs_real_t thwall[],
1301 const cs_real_t qincid[],
1302 cs_real_t hfcnvp[],
1303 cs_real_t flcnvp[],
1304 cs_real_t xlamp[],
1305 cs_real_t epap[],
1306 cs_real_t epsp[],
1307 cs_real_t textp[]);
1308
1309/*----------------------------------------------------------------------------*/
1317/*----------------------------------------------------------------------------*/
1318
1319/*----------------------------------------------------------------------------*/
1325/*----------------------------------------------------------------------------*/
1326
1327int
1328cs_user_solver_set(void);
1329
1330/*----------------------------------------------------------------------------*/
1337/*----------------------------------------------------------------------------*/
1338
1339void
1340cs_user_solver(const cs_mesh_t *mesh,
1341 const cs_mesh_quantities_t *mesh_quantities);
1342
1343/*----------------------------------------------------------------------------*/
1351/*----------------------------------------------------------------------------*/
1352
1353/*----------------------------------------------------------------------------*/
1436/*----------------------------------------------------------------------------*/
1437
1438void
1439cs_user_source_terms(cs_domain_t *domain,
1440 int f_id,
1441 cs_real_t *st_exp,
1442 cs_real_t *st_imp);
1443
1444/*----------------------------------------------------------------------------*/
1452/*----------------------------------------------------------------------------*/
1453
1454/*----------------------------------------------------------------------------*/
1461/*----------------------------------------------------------------------------*/
1462
1463void
1464cs_user_time_table(void);
1465
1466/*----------------------------------------------------------------------------*/
1474/*----------------------------------------------------------------------------*/
1475
1476/*----------------------------------------------------------------------------*/
1480/*----------------------------------------------------------------------------*/
1481
1482void
1483cs_user_turbomachinery(void);
1484
1485/*----------------------------------------------------------------------------*/
1489/*----------------------------------------------------------------------------*/
1490
1491void
1492cs_user_turbomachinery_rotor(void);
1493
1494/*----------------------------------------------------------------------------*/
1498/*----------------------------------------------------------------------------*/
1499
1500void
1501cs_user_turbomachinery_set_rotation_velocity(void);
1502
1503/*----------------------------------------------------------------------------*/
1510/*----------------------------------------------------------------------------*/
1511
1512/*----------------------------------------------------------------------------*/
1609/*----------------------------------------------------------------------------*/
1610
1611void
1612cs_user_wall_condensation(int iappel);
1613
1614/*----------------------------------------------------------------------------*/
1618/*----------------------------------------------------------------------------*/
1619
1620/*----------------------------------------------------------------------------*/
1626/*----------------------------------------------------------------------------*/
1627
1628void
1629cs_user_zones(void);
1630
1631/*----------------------------------------------------------------------------*/
1632
1633END_C_DECLS
1634
1635#endif /* CS_PROTOTYPES_H */
cs_time_control_t
Definition: cs_time_control.h:92
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:60
cs_base.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:528
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
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:529
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:325
cs_domain.h
cs_field.h
t
@ t
Definition: cs_field_pointer.h:91
xlam
@ xlam
Definition: cs_field_pointer.h:158
eps
@ eps
Definition: cs_field_pointer.h:69
h
@ h
Definition: cs_field_pointer.h:90
epa
@ epa
Definition: cs_field_pointer.h:159
dt
@ dt
Definition: cs_field_pointer.h:61
cs_mesh.h
cs_mesh_bad_cells.h
cs_mesh_quantities.h
cs_mobile_structures.h
cs_mobile_structure_type_t
cs_mobile_structure_type_t
Definition: cs_mobile_structures.h:45
cs_probe.h
cs_probe_set_t
struct _cs_probe_set_t cs_probe_set_t
Definition: cs_probe.h:49
cs_user_postprocess_meshes
void cs_user_postprocess_meshes(void)
Define post-processing meshes.
Definition: cs_user_postprocess.cpp:79
cs_user_rad_transfer_absorption
void cs_user_rad_transfer_absorption(const int bc_type[], cs_real_t ck[])
Absorption coefficient for radiative module.
Definition: cs_user_radiative_transfer.cpp:73
cs_user_mesh_bad_cells_tag
void cs_user_mesh_bad_cells_tag(cs_mesh_t *mesh, cs_mesh_quantities_t *mesh_quantities)
Tag bad cells within the mesh based on user-defined geometric criteria.
Definition: cs_user_mesh.cpp:188
cs_user_mesh_boundary
void cs_user_mesh_boundary(cs_mesh_t *mesh)
Insert boundaries into a mesh.
Definition: cs_user_mesh.cpp:128
cs_user_zones
void cs_user_zones(void)
Define volume and surface zones.
Definition: cs_user_zones.cpp:57
cs_user_model
void cs_user_model(void)
Select physical model options, including user fields.
Definition: cs_user_parameters.cpp:64
cs_user_join
void cs_user_join(void)
Define mesh joinings.
Definition: cs_user_mesh.cpp:90
cs_user_extra_operations_finalize
void cs_user_extra_operations_finalize(cs_domain_t *domain)
User operations called at the end of the calculation.
Definition: cs_user_extra_operations.cpp:100
cs_user_internal_coupling
void cs_user_internal_coupling(void)
Define internal coupling options.
Definition: cs_user_parameters.cpp:138
cs_user_extra_operations
void cs_user_extra_operations(cs_domain_t *domain)
User operations called at the end of each time step.
Definition: cs_user_extra_operations.cpp:83
cs_user_syrthes_coupling_volume_h
void cs_user_syrthes_coupling_volume_h(int coupling_id, const char *syrthes_name, cs_lnum_t n_elts, const cs_lnum_t elt_ids[], cs_real_t h_vol[])
Compute a volume exchange coefficient for SYRTHES couplings.
Definition: cs_user_coupling.cpp:94
cs_user_syrthes_coupling
void cs_user_syrthes_coupling(void)
Define couplings with the SYRTHES code.
Definition: cs_user_coupling.cpp:75
cs_user_parameters
void cs_user_parameters(cs_domain_t *domain)
Define or modify general numerical and physical user parameters.
Definition: cs_user_parameters.cpp:86
cs_user_boundary_conditions_ale
void cs_user_boundary_conditions_ale(cs_domain_t *domain, int bc_type[], int ale_bc_type[], int impale[])
User definition of boundary conditions for ALE.
Definition: cs_user_boundary_conditions.cpp:98
cs_user_physical_properties_td_pressure
void cs_user_physical_properties_td_pressure(cs_real_t *td_p)
User function to define a custom law for the thermodynamic pressure.
Definition: cs_user_physical_properties.cpp:169
cs_user_physical_properties_turb_viscosity
void cs_user_physical_properties_turb_viscosity(cs_domain_t *domain)
User modification of the turbulence viscosity.
Definition: cs_user_physical_properties.cpp:144
cs_user_fsi_structure_num
void cs_user_fsi_structure_num(cs_domain_t *domain, int structure_num[], cs_mobile_structure_type_t structure_typ[])
Define structure numbers for faces associated with internal or external (code_aster) structures.
Definition: cs_user_fluid_structure_interaction.cpp:141
cs_user_boundary_conditions_setup
void cs_user_boundary_conditions_setup(cs_domain_t *domain)
Setup boundary conditions to be applied.
Definition: cs_user_boundary_conditions.cpp:63
cs_user_turbomachinery_rotor
void cs_user_turbomachinery_rotor(void)
Define rotor axes, associated cells, and rotor/stator faces.
Definition: cs_user_turbomachinery.cpp:73
cs_user_turbomachinery_set_rotation_velocity
void cs_user_turbomachinery_set_rotation_velocity(void)
Define rotation velocity of rotor.
Definition: cs_user_turbomachinery.cpp:85
cs_user_postprocess_activate
void cs_user_postprocess_activate(int nt_max_abs, int nt_cur_abs, double t_cur_abs)
Override default frequency or calculation end based output.
Definition: cs_user_postprocess.cpp:159
cs_user_linear_solvers
void cs_user_linear_solvers(void)
Define linear solver options.
Definition: cs_user_parameters.cpp:108
cs_user_initial_conditions
void cs_user_initial_conditions(cs_domain_t *domain)
Define initial conditions for variables.
Definition: cs_user_initialization.cpp:68
cs_user_periodicity
void cs_user_periodicity(void)
Define periodic faces.
Definition: cs_user_mesh.cpp:102
cs_user_scaling_elec
void cs_user_scaling_elec(const cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities, cs_real_t *dt)
Rescale all electro-magnetic physical fields (electric potential, current density and Joule effect).
Definition: cs_user_electric_scaling.cpp:59
cs_user_mesh_cartesian_define
void cs_user_mesh_cartesian_define(void)
Define a cartesian mesh.
Definition: cs_user_mesh.cpp:78
cs_user_mesh_modify
void cs_user_mesh_modify(cs_mesh_t *mesh)
Modify geometry and mesh.
Definition: cs_user_mesh.cpp:142
cs_user_radiative_transfer_bcs
void cs_user_radiative_transfer_bcs(cs_domain_t *domain, const int bc_type[], int isothp[], cs_real_t *tmin, cs_real_t *tmax, cs_real_t *tx, const cs_real_t dt[], const cs_real_t thwall[], const cs_real_t qincid[], cs_real_t hfcnvp[], cs_real_t flcnvp[], cs_real_t xlamp[], cs_real_t epap[], cs_real_t epsp[], cs_real_t textp[])
User definition of radiative transfer boundary conditions.
Definition: cs_user_radiative_transfer_bcs.cpp:84
cs_user_postprocess_probes
void cs_user_postprocess_probes(void)
Define monitoring probes and profiles.
Definition: cs_user_postprocess.cpp:93
cs_user_numbering
void cs_user_numbering(void)
Define advanced mesh numbering options.
Definition: cs_user_performance_tuning.cpp:58
cs_user_fsi_structure_values
void cs_user_fsi_structure_values(int n_structs, const cs_time_step_t *ts, const cs_real_t xstreq[][3], const cs_real_t xstr[][3], const cs_real_t vstr[][3], cs_real_t xmstru[][3][3], cs_real_t xcstru[][3][3], cs_real_t xkstru[][3][3], cs_real_t forstr[][3], cs_real_t dtstr[])
Time-based settings for internal mobile structures.
Definition: cs_user_fluid_structure_interaction.cpp:107
cs_user_1d_wall_thermal_setup
void cs_user_1d_wall_thermal_setup(void)
setup function for 1D wall thermal module, used to define global parameters and options,...
Definition: cs_user_1d_wall_thermal.cpp:48
cs_user_time_moments
void cs_user_time_moments(void)
Define time moments.
Definition: cs_user_parameters.cpp:124
cs_user_physical_properties_t_to_h
void cs_user_physical_properties_t_to_h(cs_domain_t *domain, const cs_zone_t *z, bool z_local, const cs_real_t t[], cs_real_t h[])
User definition of temperature to enthalpy conversion.
Definition: cs_user_physical_properties.cpp:120
cs_user_wall_condensation
void cs_user_wall_condensation(int iappel)
Source terms associated at the boundary faces and the neighboring cells with surface condensation.
Definition: cs_user_wall_condensation.cpp:63
cs_user_solver_set
int cs_user_solver_set(void)
Set user solver.
Definition: cs_user_solver.cpp:59
cs_user_mesh_input
void cs_user_mesh_input(void)
Define mesh files to read and optional associated transformations.
Definition: cs_user_mesh.cpp:66
cs_user_time_table
void cs_user_time_table(void)
Define time tables using C API. This function is called at the begin of the simulation only.
Definition: cs_user_time_table.cpp:57
cs_user_1d_wall_thermal
void cs_user_1d_wall_thermal(int iappel)
Data Entry of the 1D wall thermal module.
Definition: cs_user_1d_wall_thermal.cpp:68
cs_user_mesh_save
void cs_user_mesh_save(cs_mesh_t *mesh)
Enable or disable mesh saving.
Definition: cs_user_mesh.cpp:172
cs_user_porosity
void cs_user_porosity(cs_domain_t *domain)
Compute the porosity (volume factor when the porosity model is activated. (cs_glob_porous_model > 0)...
Definition: cs_user_porosity.cpp:59
cs_user_source_terms
void cs_user_source_terms(cs_domain_t *domain, int f_id, cs_real_t *st_exp, cs_real_t *st_imp)
Additional user-defined source terms for variable equations (momentum, scalars, turbulence....
Definition: cs_user_source_terms.cpp:67
cs_user_atmo_1d_rad_prf
void cs_user_atmo_1d_rad_prf(cs_real_t preray[], cs_real_t temray[], cs_real_t romray[], cs_real_t qvray[], cs_real_t qlray[], cs_real_t ncray[], cs_real_t aeroso[])
Fill in vertical profiles of atmospheric properties prior to solving 1D radiative transfers.
Definition: cs_user_atmo.cpp:63
cs_user_postprocess_values
void cs_user_postprocess_values(const char *mesh_name, int mesh_id, int cat_id, cs_probe_set_t *probes, cs_lnum_t n_cells, cs_lnum_t n_i_faces, cs_lnum_t n_b_faces, cs_lnum_t n_vertices, const cs_lnum_t cell_list[], const cs_lnum_t i_face_list[], const cs_lnum_t b_face_list[], const cs_lnum_t vertex_list[], const cs_time_step_t *ts)
User function for output of values on a post-processing mesh.
Definition: cs_user_postprocess.cpp:126
cs_user_matrix_tuning
void cs_user_matrix_tuning(void)
Define sparse matrix tuning options.
Definition: cs_user_performance_tuning.cpp:94
cs_user_paramedmem_define_fields
void cs_user_paramedmem_define_fields(void)
Define fields to couple with ParaMEDMEM.
Definition: cs_user_paramedmem_coupling.cpp:85
cs_user_fsi_external_displacement
void cs_user_fsi_external_displacement(const cs_domain_t *domain, const cs_real_3_t *b_stress, cs_real_3_t *disaple)
Compute displacement fluid boundary for the external structures (code_aster excluded).
Definition: cs_user_fluid_structure_interaction.cpp:163
cs_user_mesh_modify_partial
void cs_user_mesh_modify_partial(cs_mesh_t *mesh, cs_mesh_quantities_t *mesh_quantities)
Apply partial modifications to the mesh after the preprocessing and initial postprocessing mesh build...
Definition: cs_user_mesh.cpp:208
cs_user_physical_properties
void cs_user_physical_properties(cs_domain_t *domain)
Function called at each time step to define physical properties.
Definition: cs_user_physical_properties.cpp:58
cs_user_head_losses
void cs_user_head_losses(const cs_zone_t *zone, cs_real_t cku[][6])
Define head losses for a given volume zone.
Definition: cs_user_head_losses.cpp:68
cs_user_fsi_external_cvg
void cs_user_fsi_external_cvg(const cs_domain_t *domain, const cs_real_t epsilon, int *cvg_status, cs_real_t *residual)
Compute convergence state of the external structures (code_aster excluded).
Definition: cs_user_fluid_structure_interaction.cpp:190
cs_user_fsi_structure_define
void cs_user_fsi_structure_define(int is_restart, int n_structs, int *plot, cs_time_control_t *plot_time_control, cs_real_t *aexxst, cs_real_t *bexxst, cs_real_t *cfopre, cs_real_t xstr0[][3], cs_real_t vstr0[][3], cs_real_t xstreq[][3])
Definition of internal mobile structures and corresponding initial conditions (initial displacement a...
Definition: cs_user_fluid_structure_interaction.cpp:72
cs_user_solver
void cs_user_solver(const cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities)
Main call to user solver.
Definition: cs_user_solver.cpp:76
cs_user_postprocess_writers
void cs_user_postprocess_writers(void)
Define post-processing writers.
Definition: cs_user_postprocess.cpp:63
cs_user_rad_transfer_net_flux
void cs_user_rad_transfer_net_flux(const int itypfb[], const cs_real_t twall[], const cs_real_t qincid[], const cs_real_t xlam[], const cs_real_t epa[], const cs_real_t eps[], const cs_real_t ck[], cs_real_t net_flux[])
Compute the net radiation flux.
Definition: cs_user_radiative_transfer.cpp:104
cs_user_boundary_conditions
void cs_user_boundary_conditions(cs_domain_t *domain, int bc_type[])
User definition of boundary conditions.
Definition: cs_user_boundary_conditions.cpp:78
cs_user_mesh_smoothe
void cs_user_mesh_smoothe(cs_mesh_t *mesh)
Mesh smoothing.
Definition: cs_user_mesh.cpp:156
cs_user_physical_properties_h_to_t
void cs_user_physical_properties_h_to_t(cs_domain_t *domain, const cs_zone_t *z, bool z_local, const cs_real_t h[], cs_real_t t[])
User definition of enthalpy to temperature conversion.
Definition: cs_user_physical_properties.cpp:87
cs_user_initialization
void cs_user_initialization(cs_domain_t *domain)
Initialize variables.
Definition: cs_user_initialization.cpp:88
cs_user_extra_operations_initialize
void cs_user_extra_operations_initialize(cs_domain_t *domain)
Initialize variables or setup extra operations.
Definition: cs_user_extra_operations.cpp:66
cs_user_cathare_coupling
void cs_user_cathare_coupling(void)
Define couplings with CATHARE code.
Definition: cs_user_coupling.cpp:115
cs_user_paramedmem_define_couplings
void cs_user_paramedmem_define_couplings(void)
Define ParaMEDMEM coupling(s)
Definition: cs_user_paramedmem_coupling.cpp:61
cs_user_hgn_thermo_relax_time
void cs_user_hgn_thermo_relax_time(const cs_mesh_t *mesh, const cs_real_t *alpha_eq, const cs_real_t *y_eq, const cs_real_t *z_eq, const cs_real_t *ei, const cs_real_t *v, cs_real_t *relax_tau)
Compute the relaxation time-scale to equilibrium in the frame of the homogeneous two-phase model....
Definition: cs_user_hgn.cpp:65
cs_user_mesh_warping
void cs_user_mesh_warping(void)
Set options for cutting of warped faces.
Definition: cs_user_mesh.cpp:114
cs_user_partition
void cs_user_partition(void)
Define advanced partitioning options.
Definition: cs_user_performance_tuning.cpp:70
cs_user_parallel_io
void cs_user_parallel_io(void)
Define parallel IO settings.
Definition: cs_user_performance_tuning.cpp:82
cs_user_paramedmem_define_meshes
void cs_user_paramedmem_define_meshes(void)
Define coupled meshes.
Definition: cs_user_paramedmem_coupling.cpp:73
cs_user_finalize_setup
void cs_user_finalize_setup(cs_domain_t *domain)
Define or modify output user parameters.
Definition: cs_user_parameters.cpp:155
cs_user_saturne_coupling
void cs_user_saturne_coupling(void)
Define couplings with other instances of code_saturne.
Definition: cs_user_coupling.cpp:60
cs_user_turbomachinery
void cs_user_turbomachinery(void)
Define rotor/stator model.
Definition: cs_user_turbomachinery.cpp:61
cs_time_control.h
cs_volume_zone.h
mesh
Definition: mesh.f90:26
cs_domain_t
Structure storing the main features of the computational domain and pointers to the main geometrical ...
Definition: cs_domain.h:120
cs_mesh_quantities_t
Definition: cs_mesh_quantities.h:88
cs_mesh_t
Definition: cs_mesh.h:85
cs_zone_t
Definition: cs_zone.h:51