programmer's documentation
cs_gui_radiative_transfer.h
Go to the documentation of this file.
1 #ifndef __CS_GUI_RADIATIVE_TRANSFER_H__
2 #define __CS_GUI_RADIATIVE_TRANSFER_H__
3 
4 /*============================================================================
5  * Management of the GUI parameters file: radiative transfer
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2016 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 
36 /*----------------------------------------------------------------------------*/
37 
39 
40 /*============================================================================
41  * Public function prototypes for Fortran API
42  *============================================================================*/
43 
44 /*-----------------------------------------------------------------------------
45  * Free memory: clean global private variables.
46  *
47  * Fortran Interface:
48  *
49  * subroutine memui2
50  * *****************
51  *----------------------------------------------------------------------------*/
52 
53 void CS_PROCF (memui2, MEMUI2) (void);
54 
55 /*============================================================================
56  * Public function definitions
57  *============================================================================*/
58 
59 /*----------------------------------------------------------------------------
60  * Read GUI-defined radiative transfer parameters
61  *----------------------------------------------------------------------------*/
62 
63 void
65 
66 /*----------------------------------------------------------------------------
67  * Set the radiative transfer absorption coefficient
68  *
69  * parameters:
70  * ck --> absorption coefficient at cells
71  *----------------------------------------------------------------------------*/
72 
73 void
75 
76 /*----------------------------------------------------------------------------
77  * Postprocessing settings for radiative transfer
78  *----------------------------------------------------------------------------*/
79 
80 void
82 
83 /*----------------------------------------------------------------------------
84  * Radiative transfer boundary conditions
85  *----------------------------------------------------------------------------*/
86 
87 void
90  cs_lnum_t ivart,
91  int *izfrdp,
92  int *isothp,
93  const int *nozppm,
94  double *epsp,
95  double *epap,
96  double *tintp,
97  double *textp,
98  double *xlamp,
99  double *rcodcl);
100 
101 /*----------------------------------------------------------------------------*/
102 
104 
105 #endif /* __CS_GUI_RADIATIVE_TRANSFER_H__ */
integer, dimension(:), pointer itypfb
Definition: pointe.f90:122
#define BEGIN_C_DECLS
Definition: cs_defs.h:448
integer nozppm
maximum index of boundary zones
Definition: ppppar.f90:45
void cs_gui_radiative_transfer_postprocess(void)
Definition: cs_gui_radiative_transfer.c:568
double cs_real_t
Floating-point value.
Definition: cs_defs.h:296
void cs_gui_radiative_transfer_bcs(const int itypfb[], cs_lnum_t nvarcl, cs_lnum_t ivart, int *izfrdp, int *isothp, const int *nozppm, double *epsp, double *epap, double *tintp, double *textp, double *xlamp, double *rcodcl)
Definition: cs_gui_radiative_transfer.c:633
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:292
integer(c_int), pointer, save nvarcl
number of variable plus number of turbulent fluxes (used by the boundary conditions) ...
Definition: optcal.f90:661
#define END_C_DECLS
Definition: cs_defs.h:449
void memui2(void)
Definition: cs_gui_radiative_transfer.c:432
#define CS_PROCF(x, y)
Definition: cs_defs.h:472
void cs_gui_rad_transfer_absorption(cs_real_t ck[])
Definition: cs_gui_radiative_transfer.c:534
void cs_gui_radiative_transfer_parameters(void)
Definition: cs_gui_radiative_transfer.c:476