My Project
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-2019 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 
38 BEGIN_C_DECLS
39 
40 /*============================================================================
41  * Public function definitions
42  *============================================================================*/
43 
44 /*-----------------------------------------------------------------------------
45  * Free GUI-defined radiative transfer parameters
46  *----------------------------------------------------------------------------*/
47 
48 void
49 cs_gui_radiative_transfers_finalize(void);
50 
51 /*----------------------------------------------------------------------------
52  * Read GUI-defined radiative transfer parameters
53  *----------------------------------------------------------------------------*/
54 
55 void
56 cs_gui_radiative_transfer_parameters(void);
57 
58 /*----------------------------------------------------------------------------
59  * Set the radiative transfer absorption coefficient
60  *
61  * parameters:
62  * ck --> absorption coefficient at cells
63  *----------------------------------------------------------------------------*/
64 
65 void
66 cs_gui_rad_transfer_absorption(cs_real_t ck[]);
67 
68 /*----------------------------------------------------------------------------
69  * Postprocessing settings for radiative transfer
70  *----------------------------------------------------------------------------*/
71 
72 void
73 cs_gui_radiative_transfer_postprocess(void);
74 
75 /*----------------------------------------------------------------------------
76  * Radiative transfer boundary conditions
77  *----------------------------------------------------------------------------*/
78 
79 void
80 cs_gui_radiative_transfer_bcs(const int itypfb[],
81  int nvar,
82  int ivart,
83  int *isothp,
84  double *epsp,
85  double *epap,
86  double *tintp,
87  double *textp,
88  double *xlamp,
89  double *rcodcl);
90 
91 /*----------------------------------------------------------------------------*/
92 
93 END_C_DECLS
94 
95 #endif /* __CS_GUI_RADIATIVE_TRANSFER_H__ */
itypfb
void const int const int const int const int int int int int int int int int int int int int * itypfb
Definition: cs_gui_boundary_conditions.h:64
cs_gui_rad_transfer_absorption
void cs_gui_rad_transfer_absorption(cs_real_t ck[])
Definition: cs_gui_radiative_transfer.c:330
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:468
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:302
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
nvar
void const cs_int_t const cs_int_t * nvar
Definition: cs_prototypes.h:104
cs_gui_radiative_transfers_finalize
void cs_gui_radiative_transfers_finalize(void)
Definition: cs_gui_radiative_transfer.c:230
cs_gui_radiative_transfer_parameters
void cs_gui_radiative_transfer_parameters(void)
Definition: cs_gui_radiative_transfer.c:256
cs_gui_radiative_transfer_bcs
void cs_gui_radiative_transfer_bcs(const int itypfb[], int nvar, int ivart, int *isothp, double *epsp, double *epap, double *tintp, double *textp, double *xlamp, double *rcodcl)
Definition: cs_gui_radiative_transfer.c:443
cs_gui_radiative_transfer_postprocess
void cs_gui_radiative_transfer_postprocess(void)
Definition: cs_gui_radiative_transfer.c:363
cs_base.h
rcodcl
void const int const int const int const int int int int int int int int int int int int int int int double double double double double double double double double double int double * rcodcl
Definition: cs_gui_boundary_conditions.h:64
Generated on Thu Apr 9 2020 17:26:56 for My Project by   doxygen 1.8.16