9.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-2026 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/fvm_nodal.h"
41
42#include "base/cs_base.h"
43#include "base/cs_halo.h"
44#include "mesh/cs_mesh.h"
45#include "mesh/cs_mesh_quantities.h"
46
47/*============================================================================
48 * Local Macro definitions
49 *============================================================================*/
50
51/*============================================================================
52 * Type definitions
53 *============================================================================*/
54
55/*============================================================================
56 * Static global variables
57 *============================================================================*/
58
59/*============================================================================
60 * Public function definitions
61 *============================================================================*/
62
63/*----------------------------------------------------------------------------*/
67/*----------------------------------------------------------------------------*/
68
69void
70cs_atmo_aerosol_ssh_initialize(void);
71
72/*----------------------------------------------------------------------------*/
76/*----------------------------------------------------------------------------*/
77
78void
79cs_atmo_aerosol_ssh_finalize(void);
80
81/*----------------------------------------------------------------------------*/
82/*
83 * \brief This function computes the number of aerosols using the given array
84 */
85/*----------------------------------------------------------------------------*/
86
87void
88cs_atmo_aerosol_ssh_compute_numbers(cs_real_t*);
89
90/*----------------------------------------------------------------------------*/
101/*----------------------------------------------------------------------------*/
102
103void
104cs_atmo_aerosol_ssh_set_t_p_h(cs_real_t *T,
105 cs_real_t *P,
106 cs_real_t *yw);
107
108/*----------------------------------------------------------------------------*/
113/*----------------------------------------------------------------------------*/
114
115void
116cs_atmo_aerosol_ssh_set_aero(cs_real_t*);
117
118/*----------------------------------------------------------------------------*/
123/*----------------------------------------------------------------------------*/
124
125void
126cs_atmo_aerosol_ssh_get_aero(cs_real_t*);
127
128/*----------------------------------------------------------------------------*/
133/*----------------------------------------------------------------------------*/
134
135void
136cs_atmo_aerosol_ssh_set_gas(cs_real_t*);
137
138/*----------------------------------------------------------------------------*/
143/*----------------------------------------------------------------------------*/
144
145void
146cs_atmo_aerosol_ssh_get_gas(cs_real_t*);
147
148/*----------------------------------------------------------------------------*/
153/*----------------------------------------------------------------------------*/
154
155void
156cs_atmo_aerosol_ssh_time_advance(void);
157
158/*----------------------------------------------------------------------------*/
159
160#endif /* CS_ATMO_AEROSOL_SSH_H */
cs_atmo_aerosol_ssh_initialize
void cs_atmo_aerosol_ssh_initialize(void)
This function initializes SSH-aerosol.
Definition: cs_atmo_aerosol_ssh.cpp:331
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.cpp:659
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.cpp:701
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.cpp:752
cs_atmo_aerosol_ssh_compute_numbers
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:547
cs_atmo_aerosol_ssh_finalize
void cs_atmo_aerosol_ssh_finalize(void)
This function finalizes SSH-aerosol.
Definition: cs_atmo_aerosol_ssh.cpp:522
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.cpp:725
cs_atmo_aerosol_ssh_set_t_p_h
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:590
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.cpp:627
cs_base.h
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
cs_halo.h
cs_mesh.h
cs_mesh_quantities.h
fvm_nodal.h
ple_locator.h