7.2
general documentation
cs_atmo_aerosol_ssh.h
Go to the documentation of this file.
1 #ifndef __CS_ATMO_AEROSOL_SSH_H__
2 #define __CS_ATMO_AEROSOL_SSH_H__
3 
4 /*============================================================================
5  * Main for atmospheric aerosols library SSH related functions
6  *============================================================================*/
7 
8 /*
9  This file is part of code_saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2022 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  * PLE library headers
32  *----------------------------------------------------------------------------*/
33 
34 #include <ple_locator.h>
35 
36 /*----------------------------------------------------------------------------
37  * Local headers
38  *----------------------------------------------------------------------------*/
39 
40 #include "fvm_nodal.h"
41 
42 #include "cs_base.h"
43 #include "cs_halo.h"
44 #include "cs_mesh.h"
45 #include "cs_mesh_quantities.h"
46 
47 /*----------------------------------------------------------------------------*/
48 
49 BEGIN_C_DECLS
50 
51 /*============================================================================
52  * Local Macro definitions
53  *============================================================================*/
54 
55 /*============================================================================
56  * Type definitions
57  *============================================================================*/
58 
59 /*============================================================================
60  * Static global variables
61  *============================================================================*/
62 
63 /*============================================================================
64  * Public function definitions
65  *============================================================================*/
66 
67 /*----------------------------------------------------------------------------*/
71 /*----------------------------------------------------------------------------*/
72 
73 void
74 cs_atmo_aerosol_ssh_initialize(void);
75 
76 /*----------------------------------------------------------------------------*/
80 /*----------------------------------------------------------------------------*/
81 
82 void
83 cs_atmo_aerosol_ssh_finalize(void);
84 
85 /*----------------------------------------------------------------------------*/
90 /*----------------------------------------------------------------------------*/
91 
92 void
93 cs_atmo_aerosol_ssh_set_aero(cs_real_t*);
94 
95 /*----------------------------------------------------------------------------*/
100 /*----------------------------------------------------------------------------*/
101 
102 void
103 cs_atmo_aerosol_ssh_get_aero(cs_real_t*);
104 
105 /*----------------------------------------------------------------------------*/
110 /*----------------------------------------------------------------------------*/
111 
112 void
113 cs_atmo_aerosol_ssh_set_gas(cs_real_t*);
114 
115 /*----------------------------------------------------------------------------*/
120 /*----------------------------------------------------------------------------*/
121 
122 void
123 cs_atmo_aerosol_ssh_get_gas(cs_real_t*);
124 
125 /*----------------------------------------------------------------------------*/
130 /*----------------------------------------------------------------------------*/
131 
132 void
133 cs_atmo_aerosol_ssh_time_advance(void);
134 
135 END_C_DECLS
136 
137 #endif /* __CS_ATMO_AEROSOL_SSH_H__ */
cs_base.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:510
cs_atmo_aerosol_ssh_set_gas
void cs_atmo_aerosol_ssh_set_gas(cs_real_t *)
This function uses the given array to update the gas concentrations in SSH-aerosol.
Definition: cs_atmo_aerosol_ssh.c:645
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:322
cs_atmo_aerosol_ssh_initialize
void cs_atmo_aerosol_ssh_initialize(void)
This function initializes SSH-aerosol.
Definition: cs_atmo_aerosol_ssh.c:356
fvm_nodal.h
cs_mesh_quantities.h
cs_atmo_aerosol_ssh_time_advance
void cs_atmo_aerosol_ssh_time_advance(void)
This function computes a time step of gaseous chemistry and aerosols dynamic using SSH-aerosol...
Definition: cs_atmo_aerosol_ssh.c:696
cs_halo.h
ple_locator.h
cs_mesh.h
cs_atmo_aerosol_ssh_set_aero
void cs_atmo_aerosol_ssh_set_aero(cs_real_t *)
This function uses the given array to update the aerosol concentrations and numbers in SSH-aerosol...
Definition: cs_atmo_aerosol_ssh.c:571
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:511
cs_atmo_aerosol_ssh_get_gas
void cs_atmo_aerosol_ssh_get_gas(cs_real_t *)
This function fills the given array with gas concentrations from SSH-aerosol.
Definition: cs_atmo_aerosol_ssh.c:669
cs_atmo_aerosol_ssh_finalize
void cs_atmo_aerosol_ssh_finalize(void)
This function finalizes SSH-aerosol.
Definition: cs_atmo_aerosol_ssh.c:545
cs_atmo_aerosol_ssh_get_aero
void cs_atmo_aerosol_ssh_get_aero(cs_real_t *)
This function fills the given array with aerosol concentrations and numbers from SSH-aerosol.
Definition: cs_atmo_aerosol_ssh.c:603