programmer's 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 Fortran functions and subroutines callable from C
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2018 EDF S.A.
12 
13  This program is free software; you can redistribute it and/or modify it under
14  the terms of the GNU General Public License as published by the Free Software
15  Foundation; either version 2 of the License, or (at your option) any later
16  version.
17 
18  This program is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21  details.
22 
23  You should have received a copy of the GNU General Public License along with
24  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25  Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 */
27 
28 /*----------------------------------------------------------------------------*/
29 
30 /*----------------------------------------------------------------------------
31  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_base.h"
35 #include "cs_mesh.h"
36 #include "cs_mesh_quantities.h"
37 #include "cs_mesh_bad_cells.h"
38 #include "cs_probe.h"
39 #include "cs_volume_zone.h"
40 
41 #include "cs_domain.h"
42 #include "cs_gwf_tracer.h"
43 #include "cs_gwf_soil.h"
44 /*----------------------------------------------------------------------------*/
45 
47 
48 /*============================================================================
49  * Macro definitions
50  *============================================================================*/
51 
52 /*=============================================================================
53  * Fortran function/subroutine prototypes
54  *============================================================================*/
55 
56 /*----------------------------------------------------------------------------
57  * Main Fortran subroutine
58  *----------------------------------------------------------------------------*/
59 
60 extern void CS_PROCF (caltri, CALTRI)
61 (
62  void
63 );
64 
65 /*----------------------------------------------------------------------------
66  * Convert gas temperature to and from enthalpy based on concentrations
67  *----------------------------------------------------------------------------*/
68 
69 extern void CS_PROCF (cpthp1, CPTHP1)
70 (
71  const cs_int_t *mode, /* <-- 1: h to t, 2: t to h */
72  cs_real_t *eh, /* <-> enthalpy of gas mix */
73  cs_real_t *xesp, /* <-- mas fraction of species */
74  cs_real_t *f1mc, /* <-- mean f1 */
75  cs_real_t *f2mc, /* <-- mean f2 */
76  cs_real_t *tp /* <-- gas temperature (K) */
77 );
78 
79 /*----------------------------------------------------------------------------
80  * Initialize Fortran base common block values
81  *----------------------------------------------------------------------------*/
82 
83 extern void CS_PROCF (csinit, CSINIT)
84 (
85  const cs_int_t *irgpar, /* <-- MPI Rank in parallel, -1 otherwise */
86  const cs_int_t *nrgpar /* <-- Number of MPI processes, or 1 */
87 );
88 
89 /*----------------------------------------------------------------------------
90  * Compute distance to wall by solving a 3d diffusion equation.
91  *----------------------------------------------------------------------------*/
92 
93 extern void CS_PROCF (distpr, DISTPR)
94 (
95  const cs_int_t *itypfb, /* <-- boudnary face types */
96  cs_real_t *distpa /* <-- wall distance */
97 );
98 
99 /*----------------------------------------------------------------------------
100  * Developer function for output of variables on a post-processing mesh
101  *----------------------------------------------------------------------------*/
102 
103 extern void CS_PROCF (dvvpst, DVVPST)
104 (
105  const cs_int_t *nummai, /* <-- number or post-processing mesh */
106  const cs_int_t *numtyp, /* <-- number or post-processing type
107  * (-1 as volume, -2 as boundary, or nummai) */
108  const cs_int_t *nvar, /* <-- number of variables */
109  const cs_int_t *ncelps, /* <-- number of post-processed cells */
110  const cs_int_t *nfbrps, /* <-- number of post processed boundary faces */
111  const cs_int_t lstcel[], /* <-- list of post-processed cells */
112  const cs_int_t lstfbr[], /* <-- list of post-processed boundary faces */
113  cs_real_t tracel[], /* --- work array for output cells */
114  cs_real_t trafbr[] /* --- work array for output boundary faces */
115 );
116 
117 /*----------------------------------------------------------------------------
118  * Find the nearest cell's center from a node
119  *----------------------------------------------------------------------------*/
120 
121 extern void CS_PROCF (findpt, FINDPT)
122 (
123  const cs_int_t *ncelet, /* <-- number of extended (real + ghost) cells */
124  const cs_int_t *ncel, /* <-- number of cells */
125  const cs_real_t *xyzcen, /* <-- cell centers */
126  const cs_real_t *xx, /* <-- node coordinate X */
127  const cs_real_t *yy, /* <-- node coordinate Y */
128  const cs_real_t *zz, /* <-- node coordinate Z */
129  cs_int_t *node, /* --> node we are looking for, zero if error */
130  cs_int_t *ndrang /* --> rank of associated process */
131 );
132 
133 /*----------------------------------------------------------------------------
134  * Check necessity of extended mesh from FORTRAN options.
135  *
136  * Interface Fortran :
137  *
138  * SUBROUTINE HALTYP (IVOSET)
139  * *****************
140  *
141  * INTEGER IVOSET : <-- : Indicator of necessity of extended mesh
142  *----------------------------------------------------------------------------*/
143 
144 extern void
145 CS_PROCF (haltyp, HALTYP)(const cs_int_t *ivoset);
146 
147 /*----------------------------------------------------------------------------
148  * Main Fortran options initialization
149  *----------------------------------------------------------------------------*/
150 
151 extern void CS_PROCF (initi1, INITI1)
152 (
153  void
154 );
155 
156 /*----------------------------------------------------------------------------
157  * User function for enthalpy <-> temperature conversion
158  *----------------------------------------------------------------------------*/
159 
160 void CS_PROCF (usthht, USTHHT)
161 (
162  const cs_int_t *mode, /* <-- -1 : t -> h ; 1 : h -> t */
163  cs_real_t *enthal, /* <-- enthalpy */
164  cs_real_t *temper /* <-- temperature */
165 );
166 
167 /*----------------------------------------------------------------------------
168  * User function for output of variables on a post-processing mesh
169  *----------------------------------------------------------------------------*/
170 
171 void CS_PROCF (usvpst, USVPST)
172 (
173  const cs_int_t *nummai, /* <-- number or post-processing mesh */
174  const cs_int_t *nvar, /* <-- number of variables */
175  const cs_int_t *nscal, /* <-- number of scalars */
176  const cs_int_t *nvlsta, /* <-- number of statistical variables (lagr) */
177  const cs_int_t *ncelps, /* <-- number of post-processed cells */
178  const cs_int_t *nfacps, /* <-- number of post processed interior faces */
179  const cs_int_t *nfbrps, /* <-- number of post processed boundary faces */
180  const cs_int_t itypps[3], /* <-- flag (0 or 1) for presence of cells, */
181  /* interior faces, and boundary faces */
182  const cs_int_t lstcel[], /* <-- list of post-processed cells */
183  const cs_int_t lstfac[], /* <-- list of post-processed interior faces */
184  const cs_int_t lstfbr[] /* <-- list of post-processed boundary faces */
185 );
186 
187 /*----------------------------------------------------------------------------*/
197 /*----------------------------------------------------------------------------*/
198 
199 void
201  cs_real_t cku[][6]);
202 
203 /*----------------------------------------------------------------------------
204  * Absorption coefficient for radiative module
205  *----------------------------------------------------------------------------*/
206 
207 void
208 cs_user_rad_transfer_absorption(const int bc_type[],
209  const cs_real_t dt[],
210  cs_real_t ck[]);
211 
212 /*----------------------------------------------------------------------------
213  * Compute the net radiation flux
214  *----------------------------------------------------------------------------*/
215 
216 void
218  const cs_real_t dt[],
219  const cs_real_t coefap[],
220  const cs_real_t coefbp[],
221  const cs_real_t cofafp[],
222  const cs_real_t cofbfp[],
223  const cs_real_t twall[],
224  const cs_real_t qincid[],
225  const cs_real_t xlam[],
226  const cs_real_t epa[],
227  const cs_real_t eps[],
228  const cs_real_t ck[],
229  cs_real_t net_flux[]);
230 
231 /*----------------------------------------------------------------------------
232  * Convert temperature to enthalpy at boundary
233  *----------------------------------------------------------------------------*/
234 
235 void CS_PROCF (b_t_to_h, b_t_to_h)
236 (
237  const cs_lnum_t *nlst, /* --> number of faces in list */
238  const cs_lnum_t *lstfac, /* --> list of boundary faces at which
239  conversion is requested */
240  const cs_real_t *t_b, /* --> temperature at boundary */
241  cs_real_t *h_b /* --> enthalpy at boundary */
242 );
243 
244 /*----------------------------------------------------------------------------
245  * Convert enthalpy to temperature at cells
246  *----------------------------------------------------------------------------*/
247 
248 void CS_PROCF (c_h_to_t, c_h_to_t)
249 (
250  const cs_real_t *h, /* --> enthalpy */
251  cs_real_t *t /* --> temperature */
252 );
253 
254 /*----------------------------------------------------------------------------
255  * Add field indexes associated with a new non-user solved variable,
256  * with default options
257  *
258  * parameters:
259  * f_id <-- field id
260  *
261  * returns:
262  * scalar number for defined field
263  *----------------------------------------------------------------------------*/
264 
265 int
267 
268 /*----------------------------------------------------------------------------
269  * Return Lagrangian model status.
270  *
271  * parameters:
272  * model_flag --> 0 without Lagrangian, 1 or 2 with Lagrangian
273  * restart_flag --> 1 for Lagrangian restart, 0 otherwise
274  * frozen_flag --> 1 for frozen Eulerian flow, 0 otherwise
275  *----------------------------------------------------------------------------*/
276 
277 void
278 cs_lagr_status(int *model_flag,
279  int *restart_flag,
280  int *frozen_flag);
281 
282 /*============================================================================
283  * User function prototypes
284  *============================================================================*/
285 
286 /*----------------------------------------------------------------------------
287  * Data Entry of the 1D wall thermal module.
288  *----------------------------------------------------------------------------*/
289 
290 void
291 cs_user_1d_wall_thermal(int iappel,
292  int isuit1);
293 
294 /*----------------------------------------------------------------------------
295  * Define global options for couplings.
296  *
297  * These options allow defining the time step synchronization policy,
298  * as well as a time step multiplier.
299  *----------------------------------------------------------------------------*/
300 
301 void
302 cs_user_coupling(void);
303 
304 /*----------------------------------------------------------------------------
305  * This function is called at each time step for boundary conditions.
306  *----------------------------------------------------------------------------*/
307 
308 void
310  int icodcl[],
311  int bc_type[],
312  cs_real_t rcodcl[]);
313 
314 /*----------------------------------------------------------------------------
315  * This function is called at the end of each time step.
316  *
317  * It has a very general purpose, although it is recommended to handle
318  * mainly postprocessing or data-extraction type operations.
319  *----------------------------------------------------------------------------*/
320 
321 void
323 
324 /*----------------------------------------------------------------------------
325  * This function is called one time step to initialize problem.
326  *----------------------------------------------------------------------------*/
327 
328 void
330 
331 /*----------------------------------------------------------------------------*/
337 /*----------------------------------------------------------------------------*/
338 
339 void
341 
342 /*----------------------------------------------------------------------------*/
351 /*----------------------------------------------------------------------------*/
352 
353 void
355 
356 /*----------------------------------------------------------------------------*/
364 /*----------------------------------------------------------------------------*/
365 
366 void
368 
369 /*----------------------------------------------------------------------------
370  * This function is called each time step to define physical properties.
371  *----------------------------------------------------------------------------*/
372 
373 void
375  const cs_mesh_quantities_t *mesh_quantities);
376 
377 /*----------------------------------------------------------------------------
378  * Define mesh joinings.
379  *----------------------------------------------------------------------------*/
380 
381 void
382 cs_user_join(void);
383 
384 /*----------------------------------------------------------------------------
385  * Define linear solver options.
386  *
387  * This function is called at the setup stage, once user and most model-based
388  * fields are defined.
389  *----------------------------------------------------------------------------*/
390 
391 void
393 
394 /*----------------------------------------------------------------------------*/
398 /*----------------------------------------------------------------------------*/
399 
400 void
401 cs_user_output(void);
402 
403 /*----------------------------------------------------------------------------
404  * Tag bad cells within the mesh based on geometric criteria.
405  *----------------------------------------------------------------------------*/
406 
407 void
409  cs_mesh_quantities_t *mesh_quantities);
410 
411 /*----------------------------------------------------------------------------
412  * Define mesh files to read and optional associated transformations.
413  *----------------------------------------------------------------------------*/
414 
415 void
416 cs_user_mesh_input(void);
417 
418 /*----------------------------------------------------------------------------
419  * Modifiy geometry and mesh.
420  *----------------------------------------------------------------------------*/
421 
422 void
424 
425 /*----------------------------------------------------------------------------
426  * Insert boundary wall into a mesh.
427  *----------------------------------------------------------------------------*/
428 
429 void
431 
432 /*----------------------------------------------------------------------------
433  * Mesh smoothing.
434  *
435  * parameters:
436  * mesh <-> pointer to mesh structure to smoothe
437  *----------------------------------------------------------------------------*/
438 
439 void
441 
442 /*----------------------------------------------------------------------------
443  * Enable or disable mesh saving.
444  *
445  * By default, mesh is saved when modified.
446  *
447  * parameters:
448  * mesh <-> pointer to mesh structure
449  *----------------------------------------------------------------------------*/
450 
451 void
453 
454 /*----------------------------------------------------------------------------
455  * Set options for cutting of warped faces
456  *
457  * parameters:
458  * mesh <-> pointer to mesh structure to smoothe
459  *----------------------------------------------------------------------------*/
460 
461 void
463 
464 /*----------------------------------------------------------------------------
465  * Select physical model options, including user fields.
466  *
467  * This function is called at the earliest stages of the data setup.
468  *----------------------------------------------------------------------------*/
469 
470 void
471 cs_user_model(void);
472 
473 /*----------------------------------------------------------------------------
474  * Define advanced mesh numbering options.
475  *----------------------------------------------------------------------------*/
476 
477 void
478 cs_user_numbering(void);
479 
480 /*----------------------------------------------------------------------------
481  * Define parallel IO settings.
482  *----------------------------------------------------------------------------*/
483 
484 void
485 cs_user_parallel_io(void);
486 
487 /*----------------------------------------------------------------------------
488  * Define advanced partitioning options.
489  *----------------------------------------------------------------------------*/
490 
491 void
492 cs_user_partition(void);
493 
494 /*----------------------------------------------------------------------------
495  * Define sparse matrix tuning options.
496  *----------------------------------------------------------------------------*/
497 
498 void
500 
501 /*----------------------------------------------------------------------------
502  * Define or modify general numerical and physical user parameters.
503  *
504  * At the calling point of this function, most model-related most variables
505  * and other fields have been defined, so speciic settings related to those
506  * fields may be set here.
507  *----------------------------------------------------------------------------*/
508 
509 void
510 cs_user_parameters(void);
511 
512 /*----------------------------------------------------------------------------
513  * User function for input of radiative transfer module options.
514  *----------------------------------------------------------------------------*/
515 
516 void
518 
519 /*-------------------------------------------------------------------------------*
520  * User subroutine for input of radiative transfer boundary conditions
521  *-------------------------------------------------------------------------------*/
522 
523 void
525  const int bc_type[],
526  int icodcl[],
527  int isothp[],
528  cs_real_t *tmin,
529  cs_real_t *tmax,
530  cs_real_t *tx,
531  const cs_real_t dt[],
532  cs_real_t rcodcl[],
533  const cs_real_t thwall[],
534  const cs_real_t qincid[],
535  cs_real_t hfcnvp[],
536  cs_real_t flcnvp[],
537  cs_real_t xlamp[],
538  cs_real_t epap[],
539  cs_real_t epsp[],
540  cs_real_t textp[],
541  cs_real_t tintp[]);
542 
543 /*----------------------------------------------------------------------------
544  * Define periodic faces.
545  *----------------------------------------------------------------------------*/
546 
547 void
548 cs_user_periodicity(void);
549 
550 /*----------------------------------------------------------------------------
551  * Define post-processing writers.
552  *
553  * The default output format and frequency may be configured, and additional
554  * post-processing writers allowing outputs in different formats or with
555  * different format options and output frequency than the main writer may
556  * be defined.
557  *----------------------------------------------------------------------------*/
558 
559 void
561 
562 /*-----------------------------------------------------------------------------
563  * Define monitoring probes and profiles. A profile is seen as a set of probes.
564  *----------------------------------------------------------------------------*/
565 
566 void
568 
569 /*----------------------------------------------------------------------------
570  * Define post-processing meshes.
571  *
572  * The main post-processing meshes may be configured, and additional
573  * post-processing meshes may be defined as a subset of the main mesh's
574  * cells or faces (both interior and boundary).
575  *----------------------------------------------------------------------------*/
576 
577 void
579 
580 /*----------------------------------------------------------------------------
581  * User function for output of values on a post-processing mesh.
582  *----------------------------------------------------------------------------*/
583 
584 void
585 cs_user_postprocess_values(const char *mesh_name,
586  int mesh_id,
587  int cat_id,
588  cs_probe_set_t *probes,
589  cs_lnum_t n_cells,
590  cs_lnum_t n_i_faces,
591  cs_lnum_t n_b_faces,
592  cs_lnum_t n_vertices,
593  const cs_lnum_t cell_list[],
594  const cs_lnum_t i_face_list[],
595  const cs_lnum_t b_face_list[],
596  const cs_lnum_t vertex_list[],
597  const cs_time_step_t *ts);
598 
599 /*----------------------------------------------------------------------------
600  * Override default frequency or calculation end based output.
601  *
602  * This allows fine-grained control of activation or deactivation,
603  *
604  * parameters:
605  * nt_max_abs <-- maximum time step number
606  * nt_cur_abs <-- current time step number
607  * t_cur_abs <-- absolute time at the current time step
608  *----------------------------------------------------------------------------*/
609 
610 void
611 cs_user_postprocess_activate(int nt_max_abs,
612  int nt_cur_abs,
613  double t_cur_abs);
614 
615 /*----------------------------------------------------------------------------
616  * Define couplings with other instances of Code_Saturne.
617  *----------------------------------------------------------------------------*/
618 
619 void
621 
622 /*----------------------------------------------------------------------------
623  * Set user solver.
624  *----------------------------------------------------------------------------*/
625 
626 int
627 cs_user_solver_set(void);
628 
629 /*----------------------------------------------------------------------------
630  * Main call to user solver.
631  *----------------------------------------------------------------------------*/
632 
633 void
635  const cs_mesh_quantities_t *mesh_quantities);
636 
637 /*----------------------------------------------------------------------------
638  * Define couplings with SYRTHES code.
639  *----------------------------------------------------------------------------*/
640 
641 void
643 
644 /*----------------------------------------------------------------------------
645  * Define time moments.
646  *----------------------------------------------------------------------------*/
647 
648 void
650 
651 /*----------------------------------------------------------------------------
652  * Define rotor/stator model.
653  *----------------------------------------------------------------------------*/
654 
655 void
657 
658 /*----------------------------------------------------------------------------
659  * Define rotor axes, associated cells, and rotor/stator faces.
660  *----------------------------------------------------------------------------*/
661 
662 void
664 
665 /*----------------------------------------------------------------------------*/
669 /*----------------------------------------------------------------------------*/
670 
671 void
672 cs_user_zones(void);
673 
674 /*----------------------------------------------------------------------------*/
678 /*----------------------------------------------------------------------------*/
679 
680 void
682  const cs_mesh_quantities_t *mesh_quantities,
683  cs_real_t *dt);
684 
685 /*============================================================================
686  * CDO User function prototypes
687  *============================================================================*/
688 
689 /*----------------------------------------------------------------------------*/
693 /*----------------------------------------------------------------------------*/
694 
695 int
697 
698 /*----------------------------------------------------------------------------*/
702 /*----------------------------------------------------------------------------*/
703 
704 void
706 
707 /*----------------------------------------------------------------------------*/
717 /*----------------------------------------------------------------------------*/
718 
719 void
721 
722 /*----------------------------------------------------------------------------*/
731 /*----------------------------------------------------------------------------*/
732 
733 void
735 
736 /*----------------------------------------------------------------------------*/
744 /*----------------------------------------------------------------------------*/
745 
746 void
748 
749 /*----------------------------------------------------------------------------*/
756 /*----------------------------------------------------------------------------*/
757 
760 
761 /*----------------------------------------------------------------------------*/
766 /*----------------------------------------------------------------------------*/
767 
768 void
770 
771 /*----------------------------------------------------------------------------*/
778 /*----------------------------------------------------------------------------*/
779 
780 void
782 
783 /*----------------------------------------------------------------------------*/
790 /*----------------------------------------------------------------------------*/
791 
792 void
793 cs_user_cdo_extra_op(const cs_domain_t *domain);
794 
795 /*----------------------------------------------------------------------------*/
802 /*----------------------------------------------------------------------------*/
803 
804 void
806 
807 /*----------------------------------------------------------------------------*/
814 /*----------------------------------------------------------------------------*/
815 
816 void
818  cs_real_t *density);
819 
820 /*----------------------------------------------------------------------------*/
821 
823 
824 #endif /* __CS_PROTOTYPES_H__ */
void cs_user_partition(void)
Define advanced partitioning options.
Definition: cs_user_performance_tuning.c:102
void b_t_to_h(const cs_lnum_t *nlst, const cs_lnum_t *lstfac, const cs_real_t *t_b, cs_real_t *h_b)
void cs_user_output(void)
Define or modify output user parameters.
Definition: cs_user_parameters.c:153
void cs_user_internal_coupling_add_volumes(cs_mesh_t *mesh)
Define volumes as internal coupling zones.
Definition: cs_user_parameters.c:222
void csinit(const cs_int_t *irgpar, const cs_int_t *nrgpar)
time step descriptor
Definition: cs_time_step.h:51
integer, save ncel
Definition: mesh.f90:50
void initi1(void)
Definition: initi1.f90:29
void cs_user_internal_coupling(void)
Define internal coupling options.
Definition: cs_user_parameters.c:205
void cs_user_cdo_end_extra_op(const cs_domain_t *domain)
Final step for user-defined operations on results provided by the CDO kernel.
Definition: cs_user_cdo_extra_op.c:145
void cs_user_periodicity(void)
Define periodic faces.
Definition: cs_user_mesh.c:131
void cpthp1(const cs_int_t *mode, cs_real_t *eh, cs_real_t *xesp, cs_real_t *f1mc, cs_real_t *f2mc, cs_real_t *tp)
void cs_user_turbomachinery(void)
Define rotor/stator model.
Definition: cs_user_turbomachinery.c:89
void caltri(void)
Definition: caltri.f90:24
#define BEGIN_C_DECLS
Definition: cs_defs.h:453
int cs_int_t
Fortran-compatible integer.
Definition: cs_defs.h:296
void cs_user_postprocess_activate(int nt_max_abs, int nt_cur_abs, double t_cur_abs)
Definition: cs_user_postprocess.c:184
void cs_user_postprocess_meshes(void)
Define post-processing meshes.
Definition: cs_user_postprocess.c:108
void cs_user_model(void)
Select physical model options, including user fields.
Definition: cs_user_parameters.c:125
void cs_user_coupling(void)
Define global options for couplings.
Definition: cs_user_coupling.c:87
void cs_user_cdo_extra_op(const cs_domain_t *domain)
Additional user-defined operations on results provided by the CDO kernel. Define advanced post-proces...
Definition: cs_user_cdo_extra_op.c:130
void cs_user_mesh_modify(cs_mesh_t *mesh)
Modify geometry and mesh.
Definition: cs_user_mesh.c:171
void cs_user_join(void)
Define mesh joinings.
Definition: cs_user_mesh.c:119
void dvvpst(const cs_int_t *nummai, const cs_int_t *numtyp, const cs_int_t *nvar, const cs_int_t *ncelps, const cs_int_t *nfbrps, const cs_int_t lstcel[], const cs_int_t lstfbr[], cs_real_t tracel[], cs_real_t trafbr[])
void cs_user_cdo_add_mesh_locations(void)
Specify additional mesh locations.
Definition: cs_user_cdo.c:103
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.c:154
void cs_user_scaling_elec(const cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities, cs_real_t *dt)
Define scaling parameter for electric model.
Definition: cs_user_electric_scaling.c:89
void cs_user_radiative_transfer_parameters(void)
User function for input of radiative transfer module options.
Definition: cs_user_radiative_transfer.c:111
Definition: cs_gwf_soil.h:161
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
void cs_user_numbering(void)
Define advanced mesh numbering options.
Definition: cs_user_performance_tuning.c:90
void usthht(const cs_int_t *mode, cs_real_t *enthal, cs_real_t *temper)
integer, save ncelet
Definition: mesh.f90:46
void cs_user_mesh_save(cs_mesh_t *mesh)
Enable or disable mesh saving.
Definition: cs_user_mesh.c:201
Definition: cs_mesh.h:63
void cs_user_parameters(void)
Define or modify general numerical and physical user parameters.
Definition: cs_user_parameters.c:141
double precision, dimension(:,:), pointer xyzcen
Definition: mesh.f90:114
void cs_user_matrix_tuning(void)
Define sparse matrix tuning options.
Definition: cs_user_performance_tuning.c:126
void cs_user_mesh_warping(void)
Set options for cutting of warped faces.
Definition: cs_user_mesh.c:143
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.c:105
int cs_user_cdo_activated(void)
Activate or not the CDO module.
Definition: cs_user_cdo.c:91
void cs_user_postprocess_probes(void)
Define monitoring probes and profiles.
Definition: cs_user_postprocess.c:122
void cs_lagr_status(int *model_flag, int *restart_flag, int *frozen_flag)
int cs_user_solver_set(void)
Set user solver.
Definition: cs_user_solver.c:89
Definition: cs_field_pointer.h:95
Definition: cs_field_pointer.h:65
Definition: cs_field_pointer.h:97
void cs_user_linear_solvers(void)
Define linear solver options.
Definition: cs_user_parameters.c:175
Definition: cs_mesh_quantities.h:82
void cs_user_cdo_start_extra_op(const cs_domain_t *domain)
Initial step for user-defined operations on results provided by the CDO kernel.
Definition: cs_user_cdo_extra_op.c:115
void cs_user_cdo_numeric_settings(void)
Setup advanced features concerning the numerical parameters of the equation resolved during the compu...
Definition: cs_user_cdo_numerics.c:106
void cs_user_internal_coupling_from_disjoint_meshes(cs_mesh_t *mesh)
Define volumesi from separated meshes as internal coupling zones.
Definition: cs_user_parameters.c:238
integer, dimension(:), pointer, save itypfb
Definition: pointe.f90:116
integer, save isuit1
Definition: optcal.f90:421
Definition: cs_domain.h:68
void cs_user_head_losses(const cs_volume_zone_t *zone, cs_real_t cku[][6])
Compute GUI-defined head losses for a given volume zone.
Definition: cs_user_head_losses.c:115
void usvpst(const cs_int_t *nummai, const cs_int_t *nvar, const cs_int_t *nscal, const cs_int_t *nvlsta, const cs_int_t *ncelps, const cs_int_t *nfacps, const cs_int_t *nfbrps, const cs_int_t itypps[3], const cs_int_t lstcel[], const cs_int_t lstfac[], const cs_int_t lstfbr[])
double precision, dimension(:,:,:), allocatable density
Definition: atimbr.f90:124
integer, save nvar
number of solved variables (must be lower than nvarmx)
Definition: dimens.f90:42
void distpr(const cs_int_t *itypfb, cs_real_t *distpa)
void cs_user_time_moments(void)
Define time moments.
Definition: cs_user_parameters.c:191
Definition: cs_field_pointer.h:178
void c_h_to_t(const cs_real_t *h, cs_real_t *t)
void cs_user_extra_operations(void)
This function is called at the end of each time step.
Definition: cs_user_extra_operations.c:111
void cs_user_mesh_input(void)
Define mesh files to read and optional associated transformations.
Definition: cs_user_mesh.c:107
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.c:216
void cs_user_postprocess_writers(void)
Define post-processing writers.
Definition: cs_user_postprocess.c:92
void findpt(const cs_int_t *ncelet, const cs_int_t *ncel, const cs_real_t *xyzcen, const cs_real_t *xx, const cs_real_t *yy, const cs_real_t *zz, cs_int_t *node, cs_int_t *ndrang)
void haltyp(const cs_int_t *ivoset)
void cs_user_cdo_init_setup(cs_domain_t *domain)
Start setting up the computational domain:
Definition: cs_user_cdo.c:121
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:293
void cs_user_radiative_transfer_bcs(int nvar, const int bc_type[], int icodcl[], int isothp[], cs_real_t *tmin, cs_real_t *tmax, cs_real_t *tx, const cs_real_t dt[], cs_real_t rcodcl[], 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[], cs_real_t tintp[])
User definition of radiative transfer boundary conditions.
Definition: cs_user_radiative_transfer_bcs.c:189
int cs_add_model_field_indexes(int f_id)
#define END_C_DECLS
Definition: cs_defs.h:454
cs_cdo_cell_center_algo_t cs_user_cdo_geometric_settings(void)
Setup advanced features concerning the way geometric quantities are built.
Definition: cs_user_cdo_numerics.c:84
void cs_user_cdo_finalize_setup(cs_domain_t *domain)
After the first step: cs_user_cdo_init_setup(), this second step concludes the setup of properties...
Definition: cs_user_cdo.c:153
integer, save nscal
number of solved user scalars effective number of scalars solutions of an advection equation...
Definition: dimens.f90:55
void cs_user_gwf_get_soil_density(const cs_gwf_soil_t *soil, cs_real_t *density)
Retrieve the bulk density related to a soil structure.
Definition: cs_user_cdo.c:168
struct _cs_probe_set_t cs_probe_set_t
Definition: cs_probe.h:53
void cs_user_cdo_setup_gwf(cs_domain_t *domain)
Specify for each soil and tracer how is defined each term of the the tracer equation. Soils and tracer equations have to be added previously.
Definition: cs_user_cdo.c:137
#define CS_PROCF(x, y)
Definition: cs_defs.h:467
void cs_user_mesh_boundary(cs_mesh_t *mesh)
Insert boundaries into a mesh.
Definition: cs_user_mesh.c:157
void cs_user_syrthes_coupling(void)
Define couplings with SYRTHES code.
Definition: cs_user_coupling.c:102
Definition: cs_field_pointer.h:96
void cs_user_physical_properties(const cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities)
Function called at each time step to define physical properties.
Definition: cs_user_physical_properties.c:107
void cs_user_turbomachinery_rotor(void)
Define rotor axes, associated cells, and rotor/stator faces.
Definition: cs_user_turbomachinery.c:101
Definition: cs_volume_zone.h:85
void cs_user_parallel_io(void)
Define parallel IO settings.
Definition: cs_user_performance_tuning.c:114
Definition: cs_field_pointer.h:71
cs_cdo_cell_center_algo_t
Definition: cs_cdo_quantities.h:57
void cs_user_saturne_coupling(void)
Define couplings with other instances of Code_Saturne.
Definition: cs_user_coupling.c:117
void cs_user_mesh_smoothe(cs_mesh_t *mesh)
Mesh smoothing.
Definition: cs_user_mesh.c:185
void cs_user_1d_wall_thermal(int iappel, int isuit1)
Definition: cs_user_1d_wall_thermal.c:116
void cs_user_boundary_conditions(int nvar, int icodcl[], int bc_type[], cs_real_t rcodcl[])
User definition of boundary conditions.
Definition: cs_user_boundary_conditions.c:100
void cs_user_rad_transfer_absorption(const int bc_type[], const cs_real_t dt[], cs_real_t ck[])
Absorption coefficient for radiative module.
Definition: cs_user_radiative_transfer.c:139
Definition: mesh.f90:26
void cs_user_rad_transfer_net_flux(const int itypfb[], const cs_real_t dt[], const cs_real_t coefap[], const cs_real_t coefbp[], const cs_real_t cofafp[], const cs_real_t cofbfp[], 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.c:177
Definition: cs_field_pointer.h:179
void cs_user_zones(void)
Define volume and surface zones.
Definition: cs_user_zones.c:82
void cs_user_initialization(void)
Definition: cs_user_initialization.c:113