7.1
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  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_base.h"
35 
36 /*----------------------------------------------------------------------------*/
37 
39 
40 /*============================================================================
41  * Local Macro definitions
42  *============================================================================*/
43 
44 /*============================================================================
45  * Type definitions
46  *============================================================================*/
47 
48 /*----------------------------------------------------------------------------
49  * Atmospheric models
50  *----------------------------------------------------------------------------*/
51 
52 typedef enum {
53 
58 
60 
61 /*----------------------------------------------------------------------------
62  * Atmospheric nucleation models
63  *----------------------------------------------------------------------------*/
64 
65 typedef enum {
66 
71 
73 
74 /*----------------------------------------------------------------------------
75  * Atmospheric aerosol external library
76  *----------------------------------------------------------------------------*/
77 
78 typedef enum {
79 
82 
84 
85 /*============================================================================
86  * Type definitions
87  *============================================================================*/
88 
93 /*----------------------------------------------------------------------------
94  * Atmospheric model options descriptor
95  *----------------------------------------------------------------------------*/
96 
97 typedef struct {
98  /* Space and time reference of the run */
100  int syear;
102  int squant;
104  int shour;
106  int smin;
118  int nbmetd;
120  int nbmett;
123  int nbmetm;
124  int nbmaxt;
128 
131 
133 
134  /* Model options */
168 
171 
210 
211  /* Altitudes of the temperature profile */
213  /* Time (in sec) of the meteo profile */
215  /* Hydrostatic pressure from Laplace integration */
217 
219 
220 /*----------------------------------------------------------------------------
221  * Atmospheric model constants descriptor
222  *----------------------------------------------------------------------------*/
223 
224 typedef struct {
225  /* Space and time reference of the run */
228 
230 
231 /*----------------------------------------------------------------------------
232  * Atmospheric chemistry options descriptor
233  *----------------------------------------------------------------------------*/
234 
235 typedef struct {
236 
244  int model;
247 
248  /* Flag to deactivate photolysis */
250 
255 
263  int n_layer;
265  int n_size;
267  int *species_to_scalar_id; // used only in Fortran
271  int *chempoint;
272 
282 
283 /*============================================================================
284  * Static global variables
285  *============================================================================*/
286 
287 /* Pointer to atmo options structure */
289 
290 /* Pointer to atmo constants structure */
292 
293 /* Pointer to atmo chemistry structure */
295 
296 /*============================================================================
297  * Public function definitions
298  *============================================================================*/
299 
300 /*----------------------------------------------------------------------------*/
304 /*----------------------------------------------------------------------------*/
305 
306 void
308 
309 /*----------------------------------------------------------------------------*/
313 /*----------------------------------------------------------------------------*/
314 
315 void
317 
318 /*----------------------------------------------------------------------------*/
340 /*----------------------------------------------------------------------------*/
341 
342 void
344 
345 /*----------------------------------------------------------------------------*/
363 /*----------------------------------------------------------------------------*/
364 
365 void
367 
368 /*----------------------------------------------------------------------------*/
376 /*----------------------------------------------------------------------------*/
377 
378 cs_real_t
380  cs_real_t dlmo);
381 
382 /*----------------------------------------------------------------------------*/
390 /*----------------------------------------------------------------------------*/
391 
392 cs_real_t
394  cs_real_t dlmo);
395 
396 /*----------------------------------------------------------------------------*/
405 /*----------------------------------------------------------------------------*/
406 
407 cs_real_t
409  cs_real_t z0,
410  cs_real_t dlmo);
411 
412 /*----------------------------------------------------------------------------*/
421 /*----------------------------------------------------------------------------*/
422 
423 cs_real_t
425  cs_real_t z0,
426  cs_real_t dlmo);
427 
428 
429 /*----------------------------------------------------------------------------*/
435 /*----------------------------------------------------------------------------*/
436 
437 void
438 cs_atmo_set_meteo_file_name(const char *file_name);
439 
440 /*----------------------------------------------------------------------------*/
446 /*----------------------------------------------------------------------------*/
447 
448 void
449 cs_atmo_set_chem_conc_file_name(const char *file_name);
450 
451 /*----------------------------------------------------------------------------*/
457 /*----------------------------------------------------------------------------*/
458 
459 void
460 cs_atmo_set_aero_conc_file_name(const char *file_name);
461 
462 /*----------------------------------------------------------------------------*/
468 /*----------------------------------------------------------------------------*/
469 
470 void
471 cs_atmo_chemistry_set_spack_file_name(const char *file_name);
472 
473 /*----------------------------------------------------------------------------*/
479 /*----------------------------------------------------------------------------*/
480 
481 void
482 cs_atmo_chemistry_set_aerosol_file_name(const char *file_name);
483 
484 /*----------------------------------------------------------------------------*/
490 /*----------------------------------------------------------------------------*/
491 
492 void
494 
495 /*----------------------------------------------------------------------------*/
515 /*----------------------------------------------------------------------------*/
516 
517 void
519  cs_real_t xlong,
520  cs_real_t jour,
521  cs_real_t heurtu,
522  int imer,
523  cs_real_t *albe,
524  cs_real_t *muzero,
525  cs_real_t *omega,
526  cs_real_t *fo);
527 
528 /*----------------------------------------------------------------------------*/
532 /*----------------------------------------------------------------------------*/
533 
534 void
535 cs_atmo_log_setup(void);
536 
537 /*----------------------------------------------------------------------------*/
541 /*----------------------------------------------------------------------------*/
542 
543 void
545 
546 /*----------------------------------------------------------------------------*/
550 /*----------------------------------------------------------------------------*/
551 
552 void
554 
555 /*----------------------------------------------------------------------------*/
559 /*----------------------------------------------------------------------------*/
560 
561 void
562 cs_atmo_finalize(void);
563 
564 /*----------------------------------------------------------------------------*/
565 
567 
568 #endif /* __CS_ATMO_H__ */
int nbmaxt
Definition: cs_atmo.h:124
cs_real_t meteo_zi
Definition: cs_atmo.h:179
cs_atmo_chemistry_t * cs_glob_atmo_chemistry
int * species_to_field_id
Definition: cs_atmo.h:268
cs_real_t meteo_zref
Definition: cs_atmo.h:177
void cs_atmo_hydrostatic_profiles_compute(void)
Compute hydrostatic profiles of density and pressure.
Definition: cs_atmo.c:1460
Definition: cs_atmo.h:54
char * chem_conc_file_name
Definition: cs_atmo.h:277
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:1916
cs_real_t meteo_ustar0
Definition: cs_atmo.h:195
cs_atmo_option_t * cs_glob_atmo_option
cs_real_t * z_temp_met
Definition: cs_atmo.h:212
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:1665
cs_atmo_aerosol_type_t aerosol_model
Definition: cs_atmo.h:254
cs_real_t meteo_u2
Definition: cs_atmo.h:193
cs_real_t meteo_z0
Definition: cs_atmo.h:175
Definition: cs_atmo.h:55
cs_real_t meteo_psea
Definition: cs_atmo.h:209
int subgrid_model
Definition: cs_atmo.h:155
int smin
Definition: cs_atmo.h:106
double precision, dimension(ncharm), save omega
Definition: cpincl.f90:99
void cs_atmo_set_aero_conc_file_name(const char *file_name)
This function set the file name of the aerosol concentration file.
Definition: cs_atmo.c:1723
#define BEGIN_C_DECLS
Definition: cs_defs.h:510
int deposition_model
Definition: cs_atmo.h:138
int n_layer
Definition: cs_atmo.h:263
Definition: cs_atmo.h:56
bool compute_z_ground
Definition: cs_atmo.h:130
cs_real_t meteo_u1
Definition: cs_atmo.h:191
cs_real_t * time_met
Definition: cs_atmo.h:214
int sedimentation_model
Definition: cs_atmo.h:136
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:1780
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:67
Definition: cs_atmo.h:68
double cs_real_t
Floating-point value.
Definition: cs_defs.h:322
bool chemistry_with_photolysis
Definition: cs_atmo.h:249
cs_real_t meteo_zu2
Definition: cs_atmo.h:183
int n_size
Definition: cs_atmo.h:265
cs_real_t ps
Definition: cs_atmo.h:227
Definition: cs_atmo.h:81
char * aero_file_name
Definition: cs_atmo.h:274
cs_real_t meteo_zt2
Definition: cs_atmo.h:187
cs_real_t y_l93
Definition: cs_atmo.h:116
int meteo_profile
Definition: cs_atmo.h:167
cs_real_t x_l93
Definition: cs_atmo.h:114
void cs_atmo_log_setup(void)
Print the atmospheric module options to setup.log.
Definition: cs_atmo.c:2007
void cs_atmo_chemistry_log_setup(void)
Print the atmospheric chemistry options to setup.log.
Definition: cs_atmo.c:2121
cs_real_t meteo_t0
Definition: cs_atmo.h:201
cs_atmo_constants_t * cs_glob_atmo_constants
Definition: cs_atmo.h:224
int n_reactions
Definition: cs_atmo.h:246
Definition: cs_atmo.h:235
char * spack_file_name
Definition: cs_atmo.h:266
cs_atmo_aerosol_type_t
Definition: cs_atmo.h:78
cs_real_t meteo_uref
Definition: cs_atmo.h:189
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:1755
int nucleation_model
Definition: cs_atmo.h:147
bool frozen_gas_chem
Definition: cs_atmo.h:257
Definition: cs_atmo.h:97
void cs_atmo_init_meteo_profiles(void)
Initialize meteo profiles if no meteo file is given.
Definition: cs_atmo.c:891
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:102
cs_real_t meteo_t2
Definition: cs_atmo.h:205
real(c_double), pointer, save xlat
latitude of the domain origin
Definition: atincl.f90:205
int open_bcs_treatment
Definition: cs_atmo.h:132
int shour
Definition: cs_atmo.h:104
int n_species
Definition: cs_atmo.h:245
int nbmetd
Definition: cs_atmo.h:118
cs_real_t latitude
Definition: cs_atmo.h:112
#define END_C_DECLS
Definition: cs_defs.h:511
int model
Definition: cs_atmo.h:244
char * meteo_file_name
Definition: cs_atmo.h:170
Definition: cs_atmo.h:69
Definition: cs_atmo.h:57
cs_real_t domain_orientation
Definition: cs_atmo.h:127
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:1804
cs_atmo_nucleation_type_t
Definition: cs_atmo.h:65
bool init_aero_with_lib
Definition: cs_atmo.h:261
cs_real_t meteo_t1
Definition: cs_atmo.h:203
cs_real_t meteo_dlmo
Definition: cs_atmo.h:173
Definition: cs_atmo.h:80
int nbmetm
Definition: cs_atmo.h:123
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:160
cs_real_t * hyd_p_met
Definition: cs_atmo.h:216
cs_real_t * molar_mass
Definition: cs_atmo.h:270
cs_real_t meteo_zu1
Definition: cs_atmo.h:181
cs_real_t meteo_zt1
Definition: cs_atmo.h:185
int nbmett
Definition: cs_atmo.h:120
int syear
Definition: cs_atmo.h:100
cs_real_t ssec
Definition: cs_atmo.h:108
void cs_atmo_z_ground_compute(void)
This function computes the ground elevation.
Definition: cs_atmo.c:1249
char * aero_conc_file_name
Definition: cs_atmo.h:280
Definition: cs_atmo.h:70
void cs_atmo_set_chem_conc_file_name(const char *file_name)
This function set the file name of the chemistry concentration file.
Definition: cs_atmo.c:1694
void cs_atmo_finalize(void)
Deallocate arrays for atmo module.
Definition: cs_atmo.c:2232
cs_real_t meteo_angle
Definition: cs_atmo.h:199
cs_atmo_model_t
Definition: cs_atmo.h:52
cs_real_t meteo_tstar
Definition: cs_atmo.h:207
cs_real_t meteo_wstar0
Definition: cs_atmo.h:197
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:110
void cs_atmo_aerosol_log_setup(void)
Print the atmospheric aerosols options to setup.log.
Definition: cs_atmo.c:2186
bool init_gas_with_lib
Definition: cs_atmo.h:259
int * chempoint
Definition: cs_atmo.h:271
void cs_atmo_compute_meteo_profiles(void)
Compute meteo profiles if no meteo file is given.
Definition: cs_atmo.c:1059
int * species_to_scalar_id
Definition: cs_atmo.h:267