7.0
general documentation
cs_atmo.h
Go to the documentation of this file.
1 #ifndef __CS_ATMO_H__
2 #define __CS_ATMO_H__
3 
4 /*============================================================================
5  * Main for atmospheric related functions
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2021 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  * Atmospheric models
61  *----------------------------------------------------------------------------*/
62 
63 typedef enum {
64 
69 
71 
72 /*----------------------------------------------------------------------------
73  * Atmospheric nucleation models
74  *----------------------------------------------------------------------------*/
75 
76 typedef enum {
77 
82 
84 
85 /*----------------------------------------------------------------------------
86  * Atmospheric aerosol external library
87  *----------------------------------------------------------------------------*/
88 
89 typedef enum {
90 
93 
95 
96 /*============================================================================
97  * Type definitions
98  *============================================================================*/
99 
104 /*----------------------------------------------------------------------------
105  * Atmospheric model options descriptor
106  *----------------------------------------------------------------------------*/
107 
108 typedef struct {
109  /* Space and time reference of the run */
111  int syear;
113  int squant;
115  int shour;
117  int smin;
125  int nbmetd;
127  int nbmett;
130  int nbmetm;
131  int nbmaxt;
135 
138 
140 
141  /* Model options */
175 
178 
217 
218  /* Altitudes of the temperature profile */
220  /* Time (in sec) of the meteo profile */
222  /* Hydrostatic pressure from Laplace integration */
224 
226 
227 /*----------------------------------------------------------------------------
228  * Atmospheric model constants descriptor
229  *----------------------------------------------------------------------------*/
230 
231 typedef struct {
232  /* Space and tim reference of the run */
235 
237 
238 /*----------------------------------------------------------------------------
239  * Atmospheric chemistry options descriptor
240  *----------------------------------------------------------------------------*/
241 
242 typedef struct {
243 
251  int model;
254 
255  /* Flag to deactivate photolysis */
257 
262 
270  int n_layer;
272  int n_size;
274  int *species_to_scalar_id; // used only in Fortran
278  int *chempoint;
279 
282 
284 
285 /*============================================================================
286  * Static global variables
287  *============================================================================*/
288 
289 /* Pointer to atmo options structure */
291 
292 /* Pointer to atmo constants structure */
294 
295 /* Pointer to atmo chemistry structure */
297 
298 /*============================================================================
299  * Public function definitions
300  *============================================================================*/
301 
302 /*----------------------------------------------------------------------------*/
310 /*----------------------------------------------------------------------------*/
311 
312 cs_real_t
314  cs_real_t dlmo);
315 
316 /*----------------------------------------------------------------------------*/
324 /*----------------------------------------------------------------------------*/
325 
326 cs_real_t
328  cs_real_t dlmo);
329 
330 /*----------------------------------------------------------------------------*/
339 /*----------------------------------------------------------------------------*/
340 
341 cs_real_t
343  cs_real_t z0,
344  cs_real_t dlmo);
345 
346 /*----------------------------------------------------------------------------*/
355 /*----------------------------------------------------------------------------*/
356 
357 cs_real_t
359  cs_real_t z0,
360  cs_real_t dlmo);
361 
362 
363 /*----------------------------------------------------------------------------*/
382 /*----------------------------------------------------------------------------*/
383 
384 void
386 
387 /*----------------------------------------------------------------------------*/
393 /*----------------------------------------------------------------------------*/
394 
395 void
396 cs_atmo_set_meteo_file_name(const char *file_name);
397 
398 /*----------------------------------------------------------------------------*/
404 /*----------------------------------------------------------------------------*/
405 
406 void
407 cs_atmo_chemistry_set_spack_file_name(const char *file_name);
408 
409 /*----------------------------------------------------------------------------*/
415 /*----------------------------------------------------------------------------*/
416 
417 void
418 cs_atmo_chemistry_set_aerosol_file_name(const char *file_name);
419 
420 /*----------------------------------------------------------------------------*/
442 /*----------------------------------------------------------------------------*/
443 
444 void
446 
447 /*----------------------------------------------------------------------------*/
453 /*----------------------------------------------------------------------------*/
454 
455 void
457 
458 /*----------------------------------------------------------------------------*/
478 /*----------------------------------------------------------------------------*/
479 
480 void
482  cs_real_t xlong,
483  cs_real_t jour,
484  cs_real_t heurtu,
485  int imer,
486  cs_real_t *albe,
487  cs_real_t *muzero,
488  cs_real_t *omega,
489  cs_real_t *fo);
490 
491 /*----------------------------------------------------------------------------*/
495 /*----------------------------------------------------------------------------*/
496 
497 void
498 cs_atmo_log_setup(void);
499 
500 /*----------------------------------------------------------------------------*/
504 /*----------------------------------------------------------------------------*/
505 
506 void
508 
509 /*----------------------------------------------------------------------------*/
513 /*----------------------------------------------------------------------------*/
514 
515 void
517 
518 /*----------------------------------------------------------------------------*/
519 
521 
522 #endif /* __CS_ATMO_H__ */
int nbmaxt
Definition: cs_atmo.h:131
cs_real_t meteo_zi
Definition: cs_atmo.h:186
cs_atmo_chemistry_t * cs_glob_atmo_chemistry
int * species_to_field_id
Definition: cs_atmo.h:275
cs_real_t meteo_zref
Definition: cs_atmo.h:184
void cs_atmo_hydrostatic_profiles_compute(void)
This function computes hydrostatic profiles of density and pressure.
Definition: cs_atmo.c:1333
Definition: cs_atmo.h:65
void cs_atmo_compute_solar_angles(cs_real_t xlat, cs_real_t xlong, cs_real_t jour, cs_real_t heurtu, int imer, cs_real_t *albe, cs_real_t *muzero, cs_real_t *omega, cs_real_t *fo)
1D Radiative scheme - Solar data + zenithal angle)
Definition: cs_atmo.c:1709
cs_real_t meteo_ustar0
Definition: cs_atmo.h:202
cs_atmo_option_t * cs_glob_atmo_option
cs_real_t * z_temp_met
Definition: cs_atmo.h:219
void cs_atmo_set_meteo_file_name(const char *file_name)
This function set the file name of the meteo file.
Definition: cs_atmo.c:1528
cs_atmo_aerosol_type_t aerosol_model
Definition: cs_atmo.h:261
cs_real_t meteo_u2
Definition: cs_atmo.h:200
cs_real_t meteo_z0
Definition: cs_atmo.h:182
Definition: cs_atmo.h:66
cs_real_t meteo_psea
Definition: cs_atmo.h:216
int subgrid_model
Definition: cs_atmo.h:162
int smin
Definition: cs_atmo.h:117
double precision, dimension(ncharm), save omega
Definition: cpincl.f90:99
#define BEGIN_C_DECLS
Definition: cs_defs.h:495
int deposition_model
Definition: cs_atmo.h:145
int n_layer
Definition: cs_atmo.h:270
Definition: cs_atmo.h:67
bool compute_z_ground
Definition: cs_atmo.h:137
cs_real_t meteo_u1
Definition: cs_atmo.h:198
cs_real_t * time_met
Definition: cs_atmo.h:221
int sedimentation_model
Definition: cs_atmo.h:143
void cs_atmo_chemistry_set_aerosol_file_name(const char *file_name)
This function sets the file name to initialize the aerosol library.
Definition: cs_atmo.c:1575
cs_real_t cs_mo_phim(cs_real_t z, cs_real_t dlmo)
Universal function phim for neutral, stable and unstable.
Definition: cs_atmo.h:78
Definition: cs_atmo.h:79
double cs_real_t
Floating-point value.
Definition: cs_defs.h:307
bool chemistry_with_photolysis
Definition: cs_atmo.h:256
cs_real_t meteo_zu2
Definition: cs_atmo.h:190
int n_size
Definition: cs_atmo.h:272
cs_real_t ps
Definition: cs_atmo.h:234
Definition: cs_atmo.h:92
char * aero_file_name
Definition: cs_atmo.h:281
cs_real_t meteo_zt2
Definition: cs_atmo.h:194
int meteo_profile
Definition: cs_atmo.h:174
void cs_atmo_log_setup(void)
Print the atmospheric module options to setup.log.
Definition: cs_atmo.c:1800
void cs_atmo_chemistry_log_setup(void)
Print the atmospheric chemistry options to setup.log.
Definition: cs_atmo.c:1911
cs_real_t meteo_t0
Definition: cs_atmo.h:208
cs_atmo_constants_t * cs_glob_atmo_constants
Definition: cs_atmo.h:231
int n_reactions
Definition: cs_atmo.h:253
Definition: cs_atmo.h:242
char * spack_file_name
Definition: cs_atmo.h:273
cs_atmo_aerosol_type_t
Definition: cs_atmo.h:89
cs_real_t meteo_uref
Definition: cs_atmo.h:196
void cs_atmo_chemistry_set_spack_file_name(const char *file_name)
This function set the file name of the SPACK file.
Definition: cs_atmo.c:1550
int nucleation_model
Definition: cs_atmo.h:154
bool frozen_gas_chem
Definition: cs_atmo.h:264
Definition: cs_atmo.h:108
cs_real_t cs_mo_psim(cs_real_t z, cs_real_t z0, cs_real_t dlmo)
Universal function psim for neutral, stable and unstable.
int squant
Definition: cs_atmo.h:113
cs_real_t meteo_t2
Definition: cs_atmo.h:212
real(c_double), pointer, save xlat
latitude of the domain origin
Definition: atincl.f90:205
int open_bcs_treatment
Definition: cs_atmo.h:139
int shour
Definition: cs_atmo.h:115
int n_species
Definition: cs_atmo.h:252
int nbmetd
Definition: cs_atmo.h:125
cs_real_t latitude
Definition: cs_atmo.h:123
#define END_C_DECLS
Definition: cs_defs.h:496
int model
Definition: cs_atmo.h:251
char * meteo_file_name
Definition: cs_atmo.h:177
Definition: cs_atmo.h:80
Definition: cs_atmo.h:68
cs_real_t domain_orientation
Definition: cs_atmo.h:134
void cs_atmo_declare_chem_from_spack(void)
This function declare additional transported variables for atmospheric module for the chemistry defin...
Definition: cs_atmo.c:1599
cs_atmo_nucleation_type_t
Definition: cs_atmo.h:76
bool init_aero_with_lib
Definition: cs_atmo.h:268
cs_real_t meteo_t1
Definition: cs_atmo.h:210
cs_real_t meteo_dlmo
Definition: cs_atmo.h:180
Definition: cs_atmo.h:91
int nbmetm
Definition: cs_atmo.h:130
cs_real_t cs_mo_psih(cs_real_t z, cs_real_t z0, cs_real_t dlmo)
Universal function psih for neutral, stable and unstable.
int distribution_model
Definition: cs_atmo.h:167
cs_real_t * hyd_p_met
Definition: cs_atmo.h:223
cs_real_t * molar_mass
Definition: cs_atmo.h:277
cs_real_t meteo_zu1
Definition: cs_atmo.h:188
cs_real_t meteo_zt1
Definition: cs_atmo.h:192
int nbmett
Definition: cs_atmo.h:127
int syear
Definition: cs_atmo.h:111
cs_real_t ssec
Definition: cs_atmo.h:119
void cs_atmo_z_ground_compute(void)
This function computes the ground elevation.
Definition: cs_atmo.c:1122
Definition: cs_atmo.h:81
cs_real_t meteo_angle
Definition: cs_atmo.h:206
cs_atmo_model_t
Definition: cs_atmo.h:63
cs_real_t meteo_tstar
Definition: cs_atmo.h:214
cs_real_t meteo_wstar0
Definition: cs_atmo.h:204
cs_real_t cs_mo_phih(cs_real_t z, cs_real_t dlmo)
Universal function phih for neutral, stable and unstable.
cs_real_t longitude
Definition: cs_atmo.h:121
void cs_atmo_aerosol_log_setup(void)
Print the atmospheric aerosols options to setup.log.
Definition: cs_atmo.c:1976
bool init_gas_with_lib
Definition: cs_atmo.h:266
int * chempoint
Definition: cs_atmo.h:278
int * species_to_scalar_id
Definition: cs_atmo.h:274