9.1
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-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_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/*----------------------------------------------------------------------------*/
67/*----------------------------------------------------------------------------*/
68
69void
70cs_user_1d_wall_thermal(int iappel);
71
72/*----------------------------------------------------------------------------*/
78/*----------------------------------------------------------------------------*/
79
80/*----------------------------------------------------------------------------*/
93/*----------------------------------------------------------------------------*/
94
95void
96cs_user_atmo_1d_rad_prf(cs_real_t preray[],
97 cs_real_t temray[],
98 cs_real_t romray[],
99 cs_real_t qvray[],
100 cs_real_t qlray[],
101 cs_real_t ncray[],
102 cs_real_t aeroso[]);
103
104/*----------------------------------------------------------------------------*/
110/*----------------------------------------------------------------------------*/
111
112/*----------------------------------------------------------------------------*/
123/*----------------------------------------------------------------------------*/
124
125void
126cs_user_boundary_conditions_setup(cs_domain_t *domain);
127
128/*----------------------------------------------------------------------------*/
165/*----------------------------------------------------------------------------*/
166
167void
168cs_user_boundary_conditions(cs_domain_t *domain,
169 int bc_type[]);
170
171/*----------------------------------------------------------------------------*/
213/*----------------------------------------------------------------------------*/
214
215void
216cs_user_boundary_conditions_ale(cs_domain_t *domain,
217 int bc_type[],
218 int ale_bc_type[],
219 int impale[]);
220
221/*----------------------------------------------------------------------------*/
229/*----------------------------------------------------------------------------*/
230
231/*----------------------------------------------------------------------------*/
238/*----------------------------------------------------------------------------*/
239
240void
241cs_user_saturne_coupling(void);
242
243/*----------------------------------------------------------------------------*/
250/*----------------------------------------------------------------------------*/
251
252void
253cs_user_syrthes_coupling(void);
254
255/*----------------------------------------------------------------------------*/
265/*----------------------------------------------------------------------------*/
266
267void
268cs_user_syrthes_coupling_volume_h(int coupling_id,
269 const char *syrthes_name,
270 cs_lnum_t n_elts,
271 const cs_lnum_t elt_ids[],
272 cs_real_t h_vol[]);
273
274/*----------------------------------------------------------------------------*/
280/*----------------------------------------------------------------------------*/
281
282void
283cs_user_cathare_coupling(void);
284
287/*----------------------------------------------------------------------------*/
299/*----------------------------------------------------------------------------*/
300
301void
302cs_user_scaling_elec(const cs_mesh_t *mesh,
303 const cs_mesh_quantities_t *mesh_quantities,
304 cs_real_t *dt);
305
306/*----------------------------------------------------------------------------*/
312/*----------------------------------------------------------------------------*/
313
314/*----------------------------------------------------------------------------*/
326/*----------------------------------------------------------------------------*/
327
328/*----------------------------------------------------------------------------*/
340/*----------------------------------------------------------------------------*/
341
342void
343cs_user_extra_operations_initialize(cs_domain_t *domain);
344
345/*----------------------------------------------------------------------------*/
354/*----------------------------------------------------------------------------*/
355
356void
357cs_user_extra_operations(cs_domain_t *domain);
358
359/*----------------------------------------------------------------------------*/
368/*----------------------------------------------------------------------------*/
369
370void
371cs_user_extra_operations_finalize(cs_domain_t *domain);
372
373/*----------------------------------------------------------------------------*/
380/*----------------------------------------------------------------------------*/
381
382/*----------------------------------------------------------------------------*/
403/*----------------------------------------------------------------------------*/
404
405void
406cs_user_fsi_structure_define(int is_restart,
407 int n_structs,
408 int *plot,
409 cs_time_control_t *plot_time_control,
410 cs_real_t *aexxst,
411 cs_real_t *bexxst,
412 cs_real_t *cfopre,
413 cs_real_t xstr0[][3],
414 cs_real_t vstr0[][3],
415 cs_real_t xstreq[][3]);
416
417/*----------------------------------------------------------------------------*/
432/*----------------------------------------------------------------------------*/
433
434void
435cs_user_fsi_structure_values(int n_structs,
436 const cs_time_step_t *ts,
437 const cs_real_t xstreq[][3],
438 const cs_real_t xstr[][3],
439 const cs_real_t vstr[][3],
440 cs_real_t xmstru[][3][3],
441 cs_real_t xcstru[][3][3],
442 cs_real_t xkstru[][3][3],
443 cs_real_t forstr[][3],
444 cs_real_t dtstr[]);
445
446/*----------------------------------------------------------------------------*/
460/*----------------------------------------------------------------------------*/
461
462void
463cs_user_fsi_structure_num(cs_domain_t *domain,
464 int structure_num[],
465 cs_mobile_structure_type_t structure_typ[]);
466
467/*----------------------------------------------------------------------------*/
476/*----------------------------------------------------------------------------*/
477
478void
479cs_user_fsi_external_displacement(const cs_domain_t *domain,
480 const cs_real_3_t *b_stress,
481 cs_real_3_t *disaple);
482
483/*----------------------------------------------------------------------------*/
497/*----------------------------------------------------------------------------*/
498
499void
500cs_user_fsi_external_cvg(const cs_domain_t *domain,
501 const cs_real_t epsilon,
502 int *cvg_status,
503 cs_real_t *residual);
504
505/*----------------------------------------------------------------------------*/
511/*----------------------------------------------------------------------------*/
512
513/*----------------------------------------------------------------------------*/
531/*----------------------------------------------------------------------------*/
532
533void
534cs_user_head_losses(const cs_zone_t *zone,
535 cs_real_t cku[][6]);
536
537/*----------------------------------------------------------------------------*/
543/*----------------------------------------------------------------------------*/
544
545/*----------------------------------------------------------------------------*/
558/*----------------------------------------------------------------------------*/
559
560void
561cs_user_hgn_thermo_relax_time(const cs_mesh_t *mesh,
562 const cs_real_t *alpha_eq,
563 const cs_real_t *y_eq,
564 const cs_real_t *z_eq,
565 const cs_real_t *ei,
566 const cs_real_t *v,
567 cs_real_t *relax_tau);
568
569/*----------------------------------------------------------------------------*/
575/*----------------------------------------------------------------------------*/
576
577/*----------------------------------------------------------------------------*/
589/*----------------------------------------------------------------------------*/
590
591void
592cs_user_initial_conditions(cs_domain_t *domain);
593
594/*----------------------------------------------------------------------------*/
606/*----------------------------------------------------------------------------*/
607
608void
609cs_user_initialization(cs_domain_t *domain);
610
611/*----------------------------------------------------------------------------*/
619/*----------------------------------------------------------------------------*/
620
621/*----------------------------------------------------------------------------*/
632/*----------------------------------------------------------------------------*/
633
634void
635cs_user_mesh_restart_mode(void);
636
637/*----------------------------------------------------------------------------*/
641/*----------------------------------------------------------------------------*/
642
643void
644cs_user_mesh_input(void);
645
646/*----------------------------------------------------------------------------*/
650/*----------------------------------------------------------------------------*/
651
652void
653cs_user_mesh_cartesian_define(void);
654
655/*----------------------------------------------------------------------------*/
659/*----------------------------------------------------------------------------*/
660
661void
662cs_user_join(void);
663
664/*----------------------------------------------------------------------------*/
668/*----------------------------------------------------------------------------*/
669
670void
671cs_user_periodicity(void);
672
673/*----------------------------------------------------------------------------*/
677/*----------------------------------------------------------------------------*/
678
679void
680cs_user_mesh_warping(void);
681
682/*----------------------------------------------------------------------------*/
688/*----------------------------------------------------------------------------*/
689
690void
691cs_user_mesh_boundary(cs_mesh_t *mesh);
692
693/*----------------------------------------------------------------------------*/
699/*----------------------------------------------------------------------------*/
700
701void
702cs_user_mesh_modify(cs_mesh_t *mesh);
703
704/*----------------------------------------------------------------------------*/
710/*----------------------------------------------------------------------------*/
711
712void
713cs_user_mesh_smoothe(cs_mesh_t *mesh);
714
715/*----------------------------------------------------------------------------*/
723/*----------------------------------------------------------------------------*/
724
725void
726cs_user_mesh_save(cs_mesh_t *mesh);
727
728/*----------------------------------------------------------------------------*/
735/*----------------------------------------------------------------------------*/
736
737void
738cs_user_mesh_bad_cells_tag(cs_mesh_t *mesh,
739 cs_mesh_quantities_t *mesh_quantities);
740
741/*----------------------------------------------------------------------------*/
749/*----------------------------------------------------------------------------*/
750
751void
752cs_user_mesh_modify_partial(cs_mesh_t *mesh,
753 cs_mesh_quantities_t *mesh_quantities);
754
755/*----------------------------------------------------------------------------*/
763/*----------------------------------------------------------------------------*/
764
765/*----------------------------------------------------------------------------*/
769/*----------------------------------------------------------------------------*/
770
771void
772cs_user_paramedmem_define_couplings(void);
773
774/*----------------------------------------------------------------------------*/
778/*----------------------------------------------------------------------------*/
779
780void
781cs_user_paramedmem_define_meshes(void);
782
783/*----------------------------------------------------------------------------*/
787/*----------------------------------------------------------------------------*/
788
789void
790cs_user_paramedmem_define_fields(void);
791
792/*----------------------------------------------------------------------------*/
800/*----------------------------------------------------------------------------*/
801
802/*----------------------------------------------------------------------------*/
809/*----------------------------------------------------------------------------*/
810
811void
812cs_user_model(void);
813
814/*----------------------------------------------------------------------------*/
828/*----------------------------------------------------------------------------*/
829
830void
831cs_user_parameters(cs_domain_t *domain);
832
833/*----------------------------------------------------------------------------*/
847/*----------------------------------------------------------------------------*/
848
849void
850cs_user_linear_solvers(void);
851
852/*----------------------------------------------------------------------------*/
860/*----------------------------------------------------------------------------*/
861
862void
863cs_user_time_moments(void);
864
865/*----------------------------------------------------------------------------*/
871/*----------------------------------------------------------------------------*/
872
873void
874cs_user_internal_coupling(void);
875
876/*----------------------------------------------------------------------------*/
885/*----------------------------------------------------------------------------*/
886
887void
888cs_user_finalize_setup(cs_domain_t *domain);
889
890/*----------------------------------------------------------------------------*/
898/*----------------------------------------------------------------------------*/
899
900/*----------------------------------------------------------------------------*/
904/*----------------------------------------------------------------------------*/
905
906void
907cs_user_numbering(void);
908
909/*----------------------------------------------------------------------------*/
913/*----------------------------------------------------------------------------*/
914
915void
916cs_user_partition(void);
917
918/*----------------------------------------------------------------------------*/
922/*----------------------------------------------------------------------------*/
923
924void
925cs_user_parallel_io(void);
926
927/*----------------------------------------------------------------------------*/
931/*----------------------------------------------------------------------------*/
932
933void
934cs_user_matrix_tuning(void);
935
936/*----------------------------------------------------------------------------*/
942/*----------------------------------------------------------------------------*/
943
944/*----------------------------------------------------------------------------*/
950/*----------------------------------------------------------------------------*/
951
952void
953cs_user_physical_properties(cs_domain_t *domain);
954
955/*----------------------------------------------------------------------------*/
973/*----------------------------------------------------------------------------*/
974
975void
976cs_user_physical_properties_h_to_t(cs_domain_t *domain,
977 const cs_zone_t *z,
978 bool z_local,
979 const cs_real_t h[],
980 cs_real_t t[]);
981
982/*----------------------------------------------------------------------------*/
1000/*----------------------------------------------------------------------------*/
1001
1002void
1003cs_user_physical_properties_t_to_h(cs_domain_t *domain,
1004 const cs_zone_t *z,
1005 bool z_local,
1006 const cs_real_t t[],
1007 cs_real_t h[]);
1008
1009/*----------------------------------------------------------------------------*/
1018/*----------------------------------------------------------------------------*/
1019
1020void
1021cs_user_physical_properties_turb_viscosity(cs_domain_t *domain);
1022
1023/*----------------------------------------------------------------------------*/
1037/*----------------------------------------------------------------------------*/
1038
1039void
1040cs_user_physical_properties_td_pressure(cs_real_t *td_p);
1041
1042/*----------------------------------------------------------------------------*/
1050/*----------------------------------------------------------------------------*/
1051
1052/*----------------------------------------------------------------------------*/
1062/*----------------------------------------------------------------------------*/
1063
1064void
1065cs_user_porosity(cs_domain_t *domain);
1066
1067/*----------------------------------------------------------------------------*/
1071/*----------------------------------------------------------------------------*/
1072
1073/*----------------------------------------------------------------------------*/
1082/*----------------------------------------------------------------------------*/
1083
1084void
1085cs_user_postprocess_writers(void);
1086
1087/*----------------------------------------------------------------------------*/
1095/*----------------------------------------------------------------------------*/
1096
1097void
1098cs_user_postprocess_meshes(void);
1099
1100/*----------------------------------------------------------------------------*/
1106/*----------------------------------------------------------------------------*/
1107
1108void
1109cs_user_postprocess_probes(void);
1110
1111/*----------------------------------------------------------------------------*/
1135/*----------------------------------------------------------------------------*/
1136
1137void
1138cs_user_postprocess_values(const char *mesh_name,
1139 int mesh_id,
1140 int cat_id,
1141 cs_probe_set_t *probes,
1142 cs_lnum_t n_cells,
1143 cs_lnum_t n_i_faces,
1144 cs_lnum_t n_b_faces,
1145 cs_lnum_t n_vertices,
1146 const cs_lnum_t cell_list[],
1147 const cs_lnum_t i_face_list[],
1148 const cs_lnum_t b_face_list[],
1149 const cs_lnum_t vertex_list[],
1150 const cs_time_step_t *ts);
1151
1152/*----------------------------------------------------------------------------*/
1162/*----------------------------------------------------------------------------*/
1163
1164void
1165cs_user_postprocess_activate(int nt_max_abs,
1166 int nt_cur_abs,
1167 double t_cur_abs);
1168
1169/*----------------------------------------------------------------------------*/
1177/*----------------------------------------------------------------------------*/
1178
1179/*-----------------------------------------------------------------------------*/
1196/*----------------------------------------------------------------------------*/
1197
1198void
1199cs_user_rad_transfer_absorption(const int bc_type[],
1200 cs_real_t ck[]);
1201
1202/*----------------------------------------------------------------------------*/
1221/*----------------------------------------------------------------------------*/
1222
1223void
1224cs_user_rad_transfer_net_flux(const int itypfb[],
1225 const cs_real_t twall[],
1226 const cs_real_t qincid[],
1227 const cs_real_t xlam[],
1228 const cs_real_t epa[],
1229 const cs_real_t eps[],
1230 const cs_real_t ck[],
1231 cs_real_t net_flux[]);
1232
1233/*----------------------------------------------------------------------------*/
1234/*
1235 *! \file cs_user_radiative_transfer_bcs.cpp
1236 */
1237/*----------------------------------------------------------------------------*/
1238
1239/*----------------------------------------------------------------------------*/
1296/*----------------------------------------------------------------------------*/
1297
1298void
1299cs_user_radiative_transfer_bcs(cs_domain_t *domain,
1300 const int bc_type[],
1301 int isothp[],
1302 cs_real_t *tmin,
1303 cs_real_t *tmax,
1304 cs_real_t *tx,
1305 const cs_real_t dt[],
1306 const cs_real_t thwall[],
1307 const cs_real_t qincid[],
1308 cs_real_t hfcnvp[],
1309 cs_real_t flcnvp[],
1310 cs_real_t xlamp[],
1311 cs_real_t epap[],
1312 cs_real_t epsp[],
1313 cs_real_t textp[]);
1314
1315/*----------------------------------------------------------------------------*/
1323/*----------------------------------------------------------------------------*/
1324
1325/*----------------------------------------------------------------------------*/
1331/*----------------------------------------------------------------------------*/
1332
1333int
1334cs_user_solver_set(void);
1335
1336/*----------------------------------------------------------------------------*/
1343/*----------------------------------------------------------------------------*/
1344
1345void
1346cs_user_solver(const cs_mesh_t *mesh,
1347 const cs_mesh_quantities_t *mesh_quantities);
1348
1349/*----------------------------------------------------------------------------*/
1357/*----------------------------------------------------------------------------*/
1358
1359/*----------------------------------------------------------------------------*/
1442/*----------------------------------------------------------------------------*/
1443
1444void
1445cs_user_source_terms(cs_domain_t *domain,
1446 int f_id,
1447 cs_real_t *st_exp,
1448 cs_real_t *st_imp);
1449
1450/*----------------------------------------------------------------------------*/
1458/*----------------------------------------------------------------------------*/
1459
1460/*----------------------------------------------------------------------------*/
1467/*----------------------------------------------------------------------------*/
1468
1469void
1470cs_user_time_table(void);
1471
1472/*----------------------------------------------------------------------------*/
1480/*----------------------------------------------------------------------------*/
1481
1482/*----------------------------------------------------------------------------*/
1486/*----------------------------------------------------------------------------*/
1487
1488void
1489cs_user_turbomachinery(void);
1490
1491/*----------------------------------------------------------------------------*/
1495/*----------------------------------------------------------------------------*/
1496
1497void
1498cs_user_turbomachinery_rotor(void);
1499
1500/*----------------------------------------------------------------------------*/
1504/*----------------------------------------------------------------------------*/
1505
1506void
1507cs_user_turbomachinery_set_rotation_velocity(void);
1508
1509/*----------------------------------------------------------------------------*/
1516/*----------------------------------------------------------------------------*/
1517
1518/*----------------------------------------------------------------------------*/
1615/*----------------------------------------------------------------------------*/
1616
1617void
1618cs_user_wall_condensation(int iappel);
1619
1620/*----------------------------------------------------------------------------*/
1624/*----------------------------------------------------------------------------*/
1625
1626/*----------------------------------------------------------------------------*/
1632/*----------------------------------------------------------------------------*/
1633
1634void
1635cs_user_zones(void);
1636
1637/*----------------------------------------------------------------------------*/
1638
1639END_C_DECLS
1640
1641#endif /* __CS_PROTOTYPES_H__ */
cs_base.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:554
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:357
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:374
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_domain.h
cs_field.h
t
@ t
Definition: cs_field_pointer.h:95
xlam
@ xlam
Definition: cs_field_pointer.h:162
eps
@ eps
Definition: cs_field_pointer.h:73
h
@ h
Definition: cs_field_pointer.h:94
epa
@ epa
Definition: cs_field_pointer.h:163
dt
@ dt
Definition: cs_field_pointer.h:65
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:47
cs_probe.h
cs_probe_set_t
struct _cs_probe_set_t cs_probe_set_t
Definition: cs_probe.h:53
cs_user_postprocess_meshes
void cs_user_postprocess_meshes(void)
Define post-processing meshes.
Definition: cs_user_postprocess.cpp:83
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:77
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:211
cs_user_mesh_boundary
void cs_user_mesh_boundary(cs_mesh_t *mesh)
Insert boundaries into a mesh.
Definition: cs_user_mesh.cpp:151
cs_user_zones
void cs_user_zones(void)
Define volume and surface zones.
Definition: cs_user_zones.cpp:61
cs_user_model
void cs_user_model(void)
Select physical model options, including user fields.
Definition: cs_user_parameters.cpp:68
cs_user_join
void cs_user_join(void)
Define mesh joinings.
Definition: cs_user_mesh.cpp:113
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:104
cs_user_internal_coupling
void cs_user_internal_coupling(void)
Define internal coupling options.
Definition: cs_user_parameters.cpp:142
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:87
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:98
cs_user_syrthes_coupling
void cs_user_syrthes_coupling(void)
Define couplings with the SYRTHES code.
Definition: cs_user_coupling.cpp:79
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:90
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:102
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:173
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:148
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:145
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:67
cs_user_turbomachinery_rotor
void cs_user_turbomachinery_rotor(void)
Define rotor axes, associated cells, and rotor/stator faces.
Definition: cs_user_turbomachinery.cpp:77
cs_user_turbomachinery_set_rotation_velocity
void cs_user_turbomachinery_set_rotation_velocity(void)
Define rotation velocity of rotor.
Definition: cs_user_turbomachinery.cpp:89
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:163
cs_user_linear_solvers
void cs_user_linear_solvers(void)
Define linear solver options.
Definition: cs_user_parameters.cpp:112
cs_user_initial_conditions
void cs_user_initial_conditions(cs_domain_t *domain)
Define initial conditions for variables.
Definition: cs_user_initialization.cpp:72
cs_user_periodicity
void cs_user_periodicity(void)
Define periodic faces.
Definition: cs_user_mesh.cpp:125
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:63
cs_user_mesh_cartesian_define
void cs_user_mesh_cartesian_define(void)
Define a cartesian mesh.
Definition: cs_user_mesh.cpp:101
cs_user_mesh_modify
void cs_user_mesh_modify(cs_mesh_t *mesh)
Modify geometry and mesh.
Definition: cs_user_mesh.cpp:165
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:88
cs_user_postprocess_probes
void cs_user_postprocess_probes(void)
Define monitoring probes and profiles.
Definition: cs_user_postprocess.cpp:97
cs_user_numbering
void cs_user_numbering(void)
Define advanced mesh numbering options.
Definition: cs_user_performance_tuning.cpp:62
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:111
cs_user_time_moments
void cs_user_time_moments(void)
Define time moments.
Definition: cs_user_parameters.cpp:128
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:124
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:67
cs_user_solver_set
int cs_user_solver_set(void)
Set user solver.
Definition: cs_user_solver.cpp:63
cs_user_mesh_input
void cs_user_mesh_input(void)
Define mesh files to read and optional associated transformations.
Definition: cs_user_mesh.cpp:89
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:61
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:66
cs_user_mesh_restart_mode
void cs_user_mesh_restart_mode(void)
Force preprocessing behavior in case of restart.
Definition: cs_user_mesh.cpp:77
cs_user_mesh_save
void cs_user_mesh_save(cs_mesh_t *mesh)
Enable or disable mesh saving.
Definition: cs_user_mesh.cpp:195
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:63
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:71
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:67
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:130
cs_user_matrix_tuning
void cs_user_matrix_tuning(void)
Define sparse matrix tuning options.
Definition: cs_user_performance_tuning.cpp:98
cs_user_paramedmem_define_fields
void cs_user_paramedmem_define_fields(void)
Define fields to couple with ParaMEDMEM.
Definition: cs_user_paramedmem_coupling.cpp:89
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:167
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:231
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:62
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:72
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:194
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:76
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:80
cs_user_postprocess_writers
void cs_user_postprocess_writers(void)
Define post-processing writers.
Definition: cs_user_postprocess.cpp:67
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:108
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:82
cs_user_mesh_smoothe
void cs_user_mesh_smoothe(cs_mesh_t *mesh)
Mesh smoothing.
Definition: cs_user_mesh.cpp:179
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:91
cs_user_initialization
void cs_user_initialization(cs_domain_t *domain)
Initialize variables.
Definition: cs_user_initialization.cpp:92
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:70
cs_user_cathare_coupling
void cs_user_cathare_coupling(void)
Define couplings with CATHARE code.
Definition: cs_user_coupling.cpp:119
cs_user_paramedmem_define_couplings
void cs_user_paramedmem_define_couplings(void)
Define ParaMEDMEM coupling(s)
Definition: cs_user_paramedmem_coupling.cpp:65
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:69
cs_user_mesh_warping
void cs_user_mesh_warping(void)
Set options for cutting of warped faces.
Definition: cs_user_mesh.cpp:137
cs_user_partition
void cs_user_partition(void)
Define advanced partitioning options.
Definition: cs_user_performance_tuning.cpp:74
cs_user_parallel_io
void cs_user_parallel_io(void)
Define parallel IO settings.
Definition: cs_user_performance_tuning.cpp:86
cs_user_paramedmem_define_meshes
void cs_user_paramedmem_define_meshes(void)
Define coupled meshes.
Definition: cs_user_paramedmem_coupling.cpp:77
cs_user_finalize_setup
void cs_user_finalize_setup(cs_domain_t *domain)
Define or modify output user parameters.
Definition: cs_user_parameters.cpp:159
cs_user_saturne_coupling
void cs_user_saturne_coupling(void)
Define couplings with other instances of code_saturne.
Definition: cs_user_coupling.cpp:64
cs_user_turbomachinery
void cs_user_turbomachinery(void)
Define rotor/stator model.
Definition: cs_user_turbomachinery.cpp:65
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:129
cs_mesh_quantities_t
Definition: cs_mesh_quantities.h:92
cs_mesh_t
Definition: cs_mesh.h:85
cs_time_control_t
Definition: cs_time_control.h:96
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64
cs_zone_t
Definition: cs_zone.h:55