programmer's documentation
cs_at_plugin.h
Go to the documentation of this file.
1 #ifndef __CS_ATPLUGIN_H__
2 #define __CS_ATPLUGIN_H__
3 
4 /*
5  This file is part of Code_Saturne, a general-purpose CFD tool.
6 
7  Copyright (C) 1998-2019 EDF S.A.
8 
9  This program is free software; you can redistribute it and/or modify it under
10  the terms of the GNU General Public License as published by the Free Software
11  Foundation; either version 2 of the License, or (at your option) any later
12  version.
13 
14  This program is distributed in the hope that it will be useful, but WITHOUT
15  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17  details.
18 
19  You should have received a copy of the GNU General Public License along with
20  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
21  Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 */
23 
24 /*----------------------------------------------------------------------------*/
25 
26 /*----------------------------------------------------------------------------
27  * Local headers
28  *----------------------------------------------------------------------------*/
29 
30 /*----------------------------------------------------------------------------*/
31 
33 
41 /*============================================================================
42  * Macro definitions
43  *============================================================================*/
44 
45 /*============================================================================
46  * Type definitions
47  *============================================================================*/
48 
49 /*============================================================================
50  * Global variables
51  *============================================================================*/
52 
53 /*=============================================================================
54  * Public function prototypes for Fortran API
55  *============================================================================*/
56 
57 /* Plug-in to get aerosol function
58  from SIREAM library (ENPC - INRIA - EDF R&D) */
59 
60 void CS_PROCF(plug_aerosol, PLUG_AEROSOL)
61 (
62  cs_int_t *nx,
63  cs_int_t *ny,
64  cs_int_t *nz,
65  cs_int_t *ns,
66  cs_real_t *ts,
67  cs_real_t *dlhumid,
68  cs_real_t *dltemp,
69  cs_real_t *dlpress,
70  cs_real_t *delta_t,
71  cs_real_t *dlconc,
74  cs_int_t *ns_aer,
84  cs_real_t *dlconc_aer,
85  cs_real_t *dlnum_aer
86 );
87 
88 /* Plug-in to get compute_coagulation_coefficient function
89  from SIREAM library (ENPC - INRIA - EDF R&D) */
90 
92  PLUG_COMPUTE_COAGULATION_COEFFICIENT)
93 (
95  cs_real_t *bin_bound,
96  cs_int_t *couple,
97  cs_int_t *first_index,
98  cs_int_t *second_index,
99  cs_real_t *partition_coefficient
100  );
101 
102 /*----------------------------------------------------------------------------*/
103 
105 
106 #endif /* __CS_ATPLUGIN_H__ */
double precision, dimension(nbin_aer), save density_aer
Size variable aerosol density ([g/m^3])
Definition: siream.f90:83
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
integer, dimension(nbin_aer, 4 *nbin_aer), save first_index_coag
First bin index of coagulation couples.
Definition: siream.f90:87
int cs_int_t
Fortran-compatible integer.
Definition: cs_defs.h:301
double precision, dimension(nbin_aer+1), save bin_bound_aer
Aerosol diameters at bin bounds.
Definition: siream.f90:79
double cs_real_t
Floating-point value.
Definition: cs_defs.h:302
integer ncycle_aer
Number of cycle in aerosol computation between ts and tf.
Definition: siream.f90:61
integer nbin_aer
Number of aerosol bins (can vary depending on the user)
Definition: siream.f90:57
double precision, dimension(nbin_aer, nbin_aer, nbin_aer), save coefficient_coag
Coagulation partition coefficient.
Definition: siream.f90:91
integer, dimension(nbin_aer, 4 *nbin_aer), save second_index_coag
Second bin index of coagulation couples.
Definition: siream.f90:89
integer noptions_aer
Number of aerosol module options.
Definition: siream.f90:64
integer, dimension(nbin_aer), save couples_coag
Coagulation couples for each bin.
Definition: siream.f90:85
#define END_C_DECLS
Definition: cs_defs.h:468
void plug_aerosol(cs_int_t *nx, cs_int_t *ny, cs_int_t *nz, cs_int_t *ns, cs_real_t *ts, cs_real_t *dlhumid, cs_real_t *dltemp, cs_real_t *dlpress, cs_real_t *delta_t, cs_real_t *dlconc, cs_int_t *noptions_aer, cs_int_t *options_aer, cs_int_t *ns_aer, cs_int_t *nbin_aer, cs_int_t *ncycle_aer, cs_real_t *bin_bound_aer, cs_real_t *fixed_density_aer, cs_real_t *density_aer, cs_int_t *couples_coag, cs_int_t *first_index_coag, cs_int_t *second_index_coag, cs_real_t *coefficient_coag, cs_real_t *dlconc_aer, cs_real_t *dlnum_aer)
Definition: cs_at_plugin.c:139
void plug_compute_coagulation_coefficient(cs_int_t *nbin_aer, cs_real_t *bin_bound, cs_int_t *couple, cs_int_t *first_index, cs_int_t *second_index, cs_real_t *partition_coefficient)
Definition: cs_at_plugin.c:211
#define CS_PROCF(x, y)
Definition: cs_defs.h:481
integer, dimension(noptions_aer), save options_aer
1D list of aerosol module options
Definition: siream.f90:68
double precision, save fixed_density_aer
Fixed aerosol density ([g/m^3])
Definition: siream.f90:81