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-2015 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 
34 /*============================================================================
35  * Macro definitions
36  *============================================================================*/
37 
38 /*============================================================================
39  * Type definitions
40  *============================================================================*/
41 
42 /*============================================================================
43  * Global variables
44  *============================================================================*/
45 
46 /*=============================================================================
47  * Public function prototypes for Fortran API
48  *============================================================================*/
49 
50 /* Plug-in to get aerosol function
51  from SIREAM library (ENPC - INRIA - EDF R&D) */
52 
53 void CS_PROCF(plug_aerosol, PLUG_AEROSOL)
54 (
55  cs_int_t *nx,
56  cs_int_t *ny,
57  cs_int_t *nz,
58  cs_int_t *ns,
59  cs_real_t *ts,
60  cs_real_t *dlhumid,
61  cs_real_t *dltemp,
62  cs_real_t *dlpress,
63  cs_real_t *delta_t,
64  cs_real_t *dlconc,
67  cs_int_t *ns_aer,
77  cs_real_t *dlconc_aer,
78  cs_real_t *dlnum_aer
79 );
80 
81 /* Plug-in to get compute_coagulation_coefficient function
82  from SIREAM library (ENPC - INRIA - EDF R&D) */
83 
85  PLUG_COMPUTE_COAGULATION_COEFFICIENT)
86 (
88  cs_real_t *bin_bound,
89  cs_int_t *couple,
90  cs_int_t *first_index,
91  cs_int_t *second_index,
92  cs_real_t *partition_coefficient
93  );
94 
95 /*----------------------------------------------------------------------------*/
96 
98 
99 #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:419
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:295
double precision, dimension(nbin_aer+1), save bin_bound_aer
Aerosol diameters at bin bounds.
Definition: siream.f90:79
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:420
double cs_real_t
Definition: cs_defs.h:296
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:125
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:192
#define CS_PROCF(x, y)
Definition: cs_defs.h:443
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