cs_atmo.h

Go to the documentation of this file.

#ifndef CS_ATMO_H
#define CS_ATMO_H
 
/*============================================================================
 * Main for atmospheric related functions
 *============================================================================*/
 
/*
  This file is part of code_saturne, a general-purpose CFD tool.
 
  Copyright (C) 1998-2026 EDF S.A.
 
  This program is free software; you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
  Foundation; either version 2 of the License, or (at your option) any later
  version.
 
  This program is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  details.
 
  You should have received a copy of the GNU General Public License along with
  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
  Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
 
/*----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------
 *  Local headers
 *----------------------------------------------------------------------------*/
 
#include "base/cs_base.h"
#include "base/cs_math.h"
 
/*----------------------------------------------------------------------------*/
 
BEGIN_C_DECLS
 
/*============================================================================
 * Local Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/*----------------------------------------------------------------------------
 * Atmospheric models
 *----------------------------------------------------------------------------*/
 
typedef enum {
 
  CS_ATMO_OFF = -1,
  CS_ATMO_CONSTANT_DENSITY = 0,
  CS_ATMO_DRY = 1,
  CS_ATMO_HUMID = 2,
 
} cs_atmo_model_t;
 
/*----------------------------------------------------------------------------
 * Atmospheric nucleation models
 *----------------------------------------------------------------------------*/
 
typedef enum {
 
  CS_ATMO_NUC_OFF = 0,
  CS_ATMO_NUC_PRUPPACHER_KLETT = 1,
  CS_ATMO_NUC_COHARD = 2,
  CS_ATMO_NUC_ABDUL_RAZZAK = 3
 
} cs_atmo_nucleation_type_t;
 
/*----------------------------------------------------------------------------
 * Atmospheric universal functions
 *----------------------------------------------------------------------------*/
 
typedef enum {
 
  CS_ATMO_UNIV_FN_CHENG = 0,
  CS_ATMO_UNIV_FN_HOGSTROM = 1,
  CS_ATMO_UNIV_FN_BUSINGER = 2,
  CS_ATMO_UNIV_FN_HARTOGENSIS = 3,
  CS_ATMO_UNIV_FN_CARL = 4,
 
} cs_atmo_universal_functions_t;
 
/*----------------------------------------------------------------------------
 * Atmospheric ground model
 *----------------------------------------------------------------------------*/
 
typedef enum {
 
  CS_ATMO_GROUND_5_CAT = 0,
  CS_ATMO_GROUND_7_CAT = 1,
  CS_ATMO_GROUND_23_CAT = 2,
 
} cs_atmo_ground_cat_t;
 
/*----------------------------------------------------------------------------
 * Atmospheric ground micro-scale options
 *----------------------------------------------------------------------------*/
 
typedef enum {
 
  CS_ATMO_GROUND_GENUINE = 0,
  CS_ATMO_GROUND_PHOTOVOLTAICS = 1,
  CS_ATMO_GROUND_VEGETATION = 2,
 
} cs_atmo_ground_meb_model_t;
 
/*----------------------------------------------------------------------------
 * Atmospheric ground micro-scale options
 *----------------------------------------------------------------------------*/
 
typedef enum {
 
  CS_ATMO_PROJ_UNDEF = -1,
  CS_ATMO_PROJ_WGS84 = 0,
  /* Lambert93 projection type */
  CS_ATMO_PROJ_LAMBERT_93 = 1,
  /* Universal transverse mercator, zone  needs to be indicated*/
  CS_ATMO_PROJ_UTM = 2,
  /* Tangantial */
  CS_ATMO_PROJ_TAN = 3,
 
} cs_atmo_projection_t;
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
/*----------------------------------------------------------------------------
 * Atmospheric model options descriptor
 *----------------------------------------------------------------------------*/
 
struct cs_atmo_option_t {
 
  /*--------------------------------------------------------------------------*/
  /*--------------------------------------------------------------------------*/
 
  DISABLE_WARNING_PUSH
  DISABLE_WARNING(-Wdeprecated-declarations)
 
  cs_atmo_option_t(){}
 
  DISABLE_WARNING_POP
 
  /* Space and time reference of the run */
  int syear{-1};
  int squant{-1};
  int shour{-1};
  int smin{-1};
  cs_real_t ssec{-1.};
  cs_real_t longitude{1e12};
  cs_real_t latitude{1e12};
  cs_real_t altitude{0.};
  cs_real_t x_l93{1e12}; // conserved for retrocompatibility
  cs_real_t y_l93{1e12}; //
  cs_real_t x_origin{1e12}; // similar to l93 but more general
  cs_real_t y_origin{1e12}; //
 
  cs_atmo_projection_t projection_type{CS_ATMO_PROJ_UNDEF};
  int utm_zone{0}; // If using utm, a zone needs to be specified
 
  int met_1d_nlevels_d{0};
  [[deprecated("Use met_1d_nlevels_d instead")]]
  int& nbmetd{met_1d_nlevels_d};
 
  int met_1d_nlevels_t{0};
  [[deprecated("Use met_1d_nlevels_t instead")]]
  int& nbmett{met_1d_nlevels_t};
 
  int met_1d_ntimes{0};
  [[deprecated("Use met_1d_ntimes instead")]]
  int& nbmetm{met_1d_ntimes};
 
  int met_1d_nlevels_max_t{0};
  [[deprecated("Use met_1d_nlevels_max_t instead")]]
  int& nbmaxt{met_1d_nlevels_max_t};
 
  cs_real_t domain_orientation{0.};
 
  bool compute_z_ground{false};
 
  int open_bcs_treatment{0};
  int theo_interp{0};
 
  /* Model options */
  int sedimentation_model{0};
  int deposition_model{0};
  int nucleation_model{0};
  int subgrid_model{0};
  int distribution_model{1};
  int meteo_profile{0};
 
  char *meteo_file_name{nullptr};
 
  cs_real_t meteo_dlmo{0.};
  cs_real_t meteo_z0{-1.};
  cs_real_t meteo_zref{-1.};
  cs_real_t meteo_zi{-1.};
  cs_real_t meteo_zu1{-1.};
  cs_real_t meteo_zu2{-1.};
  cs_real_t meteo_zt1{-1.};
  cs_real_t meteo_zt2{-1.};
  cs_real_t meteo_uref{-1.};
  cs_real_t meteo_u1{-1.};
  cs_real_t meteo_u2{-1.};
  cs_real_t meteo_ustar0{-1.};
  cs_real_t meteo_wstar0{-1.};
  cs_real_t meteo_angle{-1.};
  cs_real_t meteo_t0{284.15}; /* 11 deg C */
  cs_real_t meteo_t1{0.};
  cs_real_t meteo_t2{0.};
  cs_real_t meteo_tstar{0.};
  cs_real_t meteo_psea{101325.};
 
  cs_real_t meteo_qw0{0.};
  cs_real_t meteo_qwstar{cs_dbl_max};
  cs_real_t meteo_qw1{cs_dbl_max};
  cs_real_t meteo_qw2{cs_dbl_max};
  cs_real_t meteo_ql0{0.};
  cs_real_t meteo_evapor{cs_dbl_max};
  cs_real_t meteo_sensi{cs_dbl_max};
  int meteo_phim_s{0};
  int meteo_phih_s{0};
  int meteo_phim_u{1};
  int meteo_phih_u{1};
 
  /* 1D meteo profiles */
  cs_real_t *xyp_met{nullptr};
  cs_real_t *u_met{nullptr};
  cs_real_t *v_met{nullptr};
  cs_real_t *w_met{nullptr};
  cs_real_t *ek_met{nullptr};
  cs_real_t *ep_met{nullptr};
  cs_real_t *temp_met{nullptr};
  cs_real_t *rho_met{nullptr};
  cs_real_t *qw_met{nullptr};
  cs_real_t *ndrop_met{nullptr};
  cs_real_t *z_dyn_met{nullptr};
  cs_real_t *z_temp_met{nullptr};
  cs_real_t *time_met{nullptr};
  cs_real_t *hyd_p_met{nullptr};
  cs_real_t *pot_t_met{nullptr};
  cs_real_t *dpdt_met{nullptr};
  cs_real_3_t *mom_met{nullptr};
  cs_real_3_t *mom_cs{nullptr};
  int hydrostatic_pressure_model{0};
  int qv_profile{0};
 
  int ground_model{0}; /* off or user defined */
  cs_atmo_ground_cat_t ground_cat{(cs_atmo_ground_cat_t) 0}; /* CS_ATMO_GROUND_5_CAT */
  int ground_zone_id{-1};
  cs_atmo_ground_meb_model_t ground_meb_model{(cs_atmo_ground_meb_model_t) 0};
 
  bool rain{false};
  int cloud_type{0}; /* 0 Continental, 1 Maritime */
  bool accretion{false};
  bool autoconversion{false};
  bool autocollection_cloud{false};
  bool autocollection_rain{false};
  bool precipitation{false};
  bool evaporation{false};
  bool rupture{false};
 
  cs_real_t ground_surf_temp{20.0};
  cs_real_t ground_temperature{20.0};
  cs_real_t ground_humidity{0.0};
  cs_real_t ground_w1_ini{0.0};
  cs_real_t ground_w2_ini{0.0};
  cs_real_t *ground_cat_thermal_inertia{nullptr};
  cs_real_t *ground_cat_roughness{nullptr};
  cs_real_t *ground_cat_thermal_roughness{nullptr};
  cs_real_t *ground_cat_albedo{nullptr};
  cs_real_t *ground_cat_emissi{nullptr};
  cs_real_t *ground_cat_vegeta{nullptr};
  cs_real_t *ground_cat_w1{nullptr};
  cs_real_t *ground_cat_w2{nullptr};
  cs_real_t *ground_cat_r1{nullptr};
  cs_real_t *ground_cat_r2{nullptr};
  cs_real_t sigc{0.53};
  int infrared_1D_profile{-1};
  int solar_1D_profile{-1};
  int profiles_grid_id{-1};
 
  cs_real_t aod_o3_tot{0.2};
 
  cs_real_t aod_h2o_tot{0.1};
 
};// cs_atmo_option_t;
 
/*----------------------------------------------------------------------------
 * Atmospheric model constants descriptor
 *----------------------------------------------------------------------------*/
 
typedef struct {
 
  /* Space and time reference of the run */
  cs_real_t ps;
 
} cs_atmo_constants_t;
 
/*============================================================================
 * Static global variables
 *============================================================================*/
 
/* Pointer to atmo options structure */
extern cs_atmo_option_t *cs_glob_atmo_option;
 
/* Pointer to atmo constants structure */
extern cs_atmo_constants_t *cs_glob_atmo_constants;
 
/*============================================================================
 * Public function definitions
 *============================================================================*/
 
void
cs_atmo_phyvar_update(void);
 
/*----------------------------------------------------------------------------
 * initialize fields, stage 0
 *----------------------------------------------------------------------------*/
 
void
cs_atmo_fields_init0(void);
 
/*----------------------------------------------------------------------------
 * Automatic boundary condition for cooling towers
 *----------------------------------------------------------------------------*/
 
void
cs_atmo_bcond(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_atmo_init_meteo_profiles(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_atmo_compute_meteo_profiles(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_atmo_z_ground_compute(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_atmo_hydrostatic_profiles_compute(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_atmo_read_meteo_profile(int mode);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_real_t
cs_mo_phim(cs_real_t              z,
           cs_real_t              dlmo);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_real_t
cs_mo_phih(cs_real_t              z,
           cs_real_t              dlmo,
           cs_real_t              prt);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_real_t
cs_mo_psim(cs_real_t              z,
           cs_real_t              z0,
           cs_real_t              dlmo);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_real_t
cs_mo_psih(cs_real_t              z,
           cs_real_t              z0,
           cs_real_t              dlmo,
           cs_real_t              prt);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_mo_compute_from_thermal_diff(cs_real_t   z,
                                cs_real_t   z0,
                                cs_real_t   du,
                                cs_real_t   buoyant_param,
                                cs_real_t   dt,
                                cs_real_t   *dlmo,
                                cs_real_t   *ustar);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_mo_compute_from_thermal_flux(cs_real_t   z,
                                cs_real_t   z0,
                                cs_real_t   du,
                                cs_real_t   buoyant_param,
                                cs_real_t   flux,
                                cs_real_t   *dlmo,
                                cs_real_t   *ustar);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_atmo_set_meteo_file_name(const char *file_name);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
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 *za,
                             cs_real_t *muzero,
                             cs_real_t *omega,
                             cs_real_t *fo);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_atmo_log_setup(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_atmo_finalize(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_user_ground_model(void);
 
/*----------------------------------------------------------------------------*/
 
void
cs_atmo_get_ground_zone(cs_lnum_t         *n_elts,
                        int               *n_ground_cat,
                        const cs_lnum_t  **elt_ids);
 
/*----------------------------------------------------------------------------*/
 
void
cs_atmo_ground_init_arrays(int        *n_ground_cat,
                           cs_real_t  **csol,
                           cs_real_t  **rugdyn,
                           cs_real_t  **rugthe,
                           cs_real_t  **albedo,
                           cs_real_t  **emissi,
                           cs_real_t  **vegeta,
                           cs_real_t  **c1w,
                           cs_real_t  **c2w,
                           cs_real_t  **r1,
                           cs_real_t  **r2);
 
/*----------------------------------------------------------------------------*/
 
void
cs_atmo_projection
(
  cs_atmo_projection_t origin_projection,
  cs_atmo_projection_t target_projection,
  cs_real_t            x_origin,
  cs_real_t            y_origin,
  cs_real_t*           x_target,
  cs_real_t*           y_target,
  int                  utm_fixed_zone
);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* CS_ATMO_H */