8.3
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-2024 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
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
73void
75
76/*----------------------------------------------------------------------------*/
80/*----------------------------------------------------------------------------*/
81
82void
84
85/*----------------------------------------------------------------------------*/
86/*
87 * \brief This function computes the number of aerosols using the given array
88 */
89/*----------------------------------------------------------------------------*/
90
91void
93
94/*----------------------------------------------------------------------------*/
105/*----------------------------------------------------------------------------*/
106
107void
109 cs_real_t *P,
110 cs_real_t *yw);
111
112/*----------------------------------------------------------------------------*/
117/*----------------------------------------------------------------------------*/
118
119void
121
122/*----------------------------------------------------------------------------*/
127/*----------------------------------------------------------------------------*/
128
129void
131
132/*----------------------------------------------------------------------------*/
137/*----------------------------------------------------------------------------*/
138
139void
141
142/*----------------------------------------------------------------------------*/
147/*----------------------------------------------------------------------------*/
148
149void
151
152/*----------------------------------------------------------------------------*/
157/*----------------------------------------------------------------------------*/
158
159void
161
163
164#endif /* __CS_ATMO_AEROSOL_SSH_H__ */
void cs_atmo_aerosol_ssh_initialize(void)
This function initializes SSH-aerosol.
Definition: cs_atmo_aerosol_ssh.cpp:341
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.cpp:670
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.cpp:712
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.cpp:763
void cs_atmo_aerosol_ssh_compute_numbers(cs_real_t *)
This function computes the number of aerosols using the given array.
Definition: cs_atmo_aerosol_ssh.cpp:558
void cs_atmo_aerosol_ssh_finalize(void)
This function finalizes SSH-aerosol.
Definition: cs_atmo_aerosol_ssh.cpp:533
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.cpp:736
void cs_atmo_aerosol_ssh_set_t_p_h(cs_real_t *T, cs_real_t *P, cs_real_t *yw)
This function takes as input absolute temperature T total pressure P water mass fraction yw It comput...
Definition: cs_atmo_aerosol_ssh.cpp:601
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.cpp:638
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
#define END_C_DECLS
Definition: cs_defs.h:543