programmer's documentation
cs_rad_transfer.h
Go to the documentation of this file.
1 #ifndef __CS_RAD_TRANSFER_H__
2 #define __CS_RAD_TRANSFER_H__
3 
4 /*============================================================================
5  * Radiation solver operations.
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_defs.h"
35 
36 /*----------------------------------------------------------------------------*/
37 
39 
40 /*=============================================================================
41  * Local Macro definitions
42  *============================================================================*/
43 
44 /*============================================================================
45  * Type definition
46  *============================================================================*/
47 
48 /* Radiative transfer model type */
49 
50 typedef enum {
51 
55 
57 
58 /* Quadrature types */
59 
60 typedef enum {
61 
70 
72 
73 /*============================================================================
74  * Global variables
75  *============================================================================*/
76 
78 extern const char *cs_rad_transfer_model_name[];
79 
81 extern const char *cs_rad_transfer_quadrature_name[];
82 
83 typedef struct {
84 
87  int nrphas;
88  int iimpar;
89  int iimlum;
90  int imodak;
91  int imoadf;
92  int iwrp1t;
93  int imfsck;
94  double xnp1mx;
95  int idiver;
97  int ndirec;
98  int ndirs;
101  int restart;
102  int nfreqr;
103  int nwsgg;
105  int nzfrad;
106  int itpimp;
107  int ipgrno;
108  int iprefl;
109  int ifgrno;
110  int ifrefl;
111  int itpt1d;
112  int ifinfe;
113 
116  bool dispersion;
129 
131 
132 /*=============================================================================
133  * Public function prototypes
134  *============================================================================*/
135 
136 /*----------------------------------------------------------------------------*/
140 /*----------------------------------------------------------------------------*/
141 
142 void
144 
145 /*----------------------------------------------------------------------------*/
146 
148 
149 #endif /* __CS_RAD_TRANSFER_H__ */
Definition: cs_rad_transfer.h:62
int ndirec
Definition: cs_rad_transfer.h:97
cs_rad_transfer_model_t
Definition: cs_rad_transfer.h:50
int itpimp
Definition: cs_rad_transfer.h:106
const char * cs_rad_transfer_model_name[]
bool atmo_ir_absorption
Definition: cs_rad_transfer.h:114
Definition: cs_rad_transfer.h:66
const char * cs_rad_transfer_quadrature_name[]
int iimlum
Definition: cs_rad_transfer.h:89
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
cs_rad_quadrature_type_t
Definition: cs_rad_transfer.h:60
int nwsgg
Definition: cs_rad_transfer.h:103
Definition: cs_rad_transfer.h:63
int i_quadrature
Definition: cs_rad_transfer.h:96
cs_real_3_t * vect_s
Definition: cs_rad_transfer.h:99
double cs_real_t
Floating-point value.
Definition: cs_defs.h:302
Structure containing the radiation module parameters.
Definition: cs_rad_transfer.h:83
Definition: cs_rad_transfer.h:64
void cs_rad_transfer_finalize(void)
Finalize radiative transfer module.
Definition: cs_rad_transfer.c:299
cs_rad_transfer_model_t type
Definition: cs_rad_transfer.h:85
int nzfrad
Definition: cs_rad_transfer.h:105
int iimpar
Definition: cs_rad_transfer.h:88
int ndirs
Definition: cs_rad_transfer.h:98
int ifinfe
Definition: cs_rad_transfer.h:112
bool dispersion
Definition: cs_rad_transfer.h:116
Definition: cs_rad_transfer.h:65
Definition: cs_rad_transfer.h:52
int itpt1d
Definition: cs_rad_transfer.h:111
int imfsck
Definition: cs_rad_transfer.h:93
int nrphas
Definition: cs_rad_transfer.h:87
int imoadf
Definition: cs_rad_transfer.h:91
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:315
cs_real_t * wq
Definition: cs_rad_transfer.h:104
cs_rad_transfer_params_t * cs_glob_rad_transfer_params
int ifrefl
Definition: cs_rad_transfer.h:110
#define END_C_DECLS
Definition: cs_defs.h:468
int iprefl
Definition: cs_rad_transfer.h:108
double xnp1mx
Definition: cs_rad_transfer.h:94
int restart
Definition: cs_rad_transfer.h:101
Definition: cs_rad_transfer.h:53
cs_real_t * angsol
Definition: cs_rad_transfer.h:100
Definition: cs_rad_transfer.h:67
int nfreqr
Definition: cs_rad_transfer.h:102
Definition: cs_rad_transfer.h:68
cs_real_t dispersion_coeff
Definition: cs_rad_transfer.h:117
int idiver
Definition: cs_rad_transfer.h:95
int iwrp1t
Definition: cs_rad_transfer.h:92
Definition: cs_rad_transfer.h:54
int ifgrno
Definition: cs_rad_transfer.h:109
int imodak
Definition: cs_rad_transfer.h:90
Definition: cs_rad_transfer.h:69
int ipgrno
Definition: cs_rad_transfer.h:107