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-2022 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 "cs_base.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 aerosol external library
 *----------------------------------------------------------------------------*/

typedef enum {

  CS_ATMO_AEROSOL_OFF = 0,
  CS_ATMO_AEROSOL_SSH = 1

} cs_atmo_aerosol_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 soil model
 *----------------------------------------------------------------------------*/

typedef enum {

  CS_ATMO_SOIL_5_CAT = 0,
  CS_ATMO_SOIL_7_CAT = 1,
  CS_ATMO_SOIL_23_CAT = 2,

} cs_atmo_soil_cat_t;

/*============================================================================
 * Type definitions
 *============================================================================*/

/*----------------------------------------------------------------------------
 * Atmospheric model options descriptor
 *----------------------------------------------------------------------------*/

typedef struct {
  /* Space and time reference of the run */
  int syear;
  int squant;
  int shour;
  int smin;
  cs_real_t ssec;
  cs_real_t longitude;
  cs_real_t latitude;
  cs_real_t x_l93;
  cs_real_t y_l93;
  int nbmetd;
  int nbmett;
  int nbmetm;

  int radiative_model_1d;
  int nbmaxt;
  cs_real_t domain_orientation;

  bool compute_z_ground;

  int open_bcs_treatment;

  /* Model options */
  int sedimentation_model;
  int deposition_model;
  int nucleation_model;
  int subgrid_model;
  int distribution_model;
  int meteo_profile;

  char *meteo_file_name;

  cs_real_t meteo_dlmo;
  cs_real_t meteo_z0;
  cs_real_t meteo_zref;
  cs_real_t meteo_zi;
  cs_real_t meteo_zu1;
  cs_real_t meteo_zu2;
  cs_real_t meteo_zt1;
  cs_real_t meteo_zt2;
  cs_real_t meteo_uref;
  cs_real_t meteo_u1;
  cs_real_t meteo_u2;
  cs_real_t meteo_ustar0;
  cs_real_t meteo_wstar0;
  cs_real_t meteo_angle;
  cs_real_t meteo_t0;
  cs_real_t meteo_t1;
  cs_real_t meteo_t2;
  cs_real_t meteo_tstar;
  cs_real_t meteo_psea;

  int meteo_phim_s;
  int meteo_phih_s;
  int meteo_phim_u;
  int meteo_phih_u;

  cs_real_t *u_met;
  cs_real_t *v_met;
  cs_real_t *ek_met;
  cs_real_t *ep_met;

  cs_real_t *z_dyn_met;
  cs_real_t *z_temp_met;
  cs_real_t *time_met;
  cs_real_t *hyd_p_met;
  cs_real_t *pot_t_met;
  int soil_model;
  cs_atmo_soil_cat_t soil_cat;
  int soil_zone_id;

} 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;

/*----------------------------------------------------------------------------
 * Atmospheric chemistry options descriptor
 *----------------------------------------------------------------------------*/

typedef struct {

  int model;
  int n_species;
  int n_reactions;

  /* Flag to deactivate photolysis */
  bool  chemistry_with_photolysis;

  cs_atmo_aerosol_type_t aerosol_model;

  bool frozen_gas_chem;
  bool init_gas_with_lib;
  bool init_aero_with_lib;
  int n_layer;
  int n_size;
  char *spack_file_name;
  int *species_to_scalar_id; // used only in Fortran
  int *species_to_field_id;
  cs_real_t *molar_mass;
  int *chempoint;

  char *aero_file_name;
  char *chem_conc_file_name;
  char *aero_conc_file_name;
} cs_atmo_chemistry_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;

/* Pointer to atmo chemistry structure */
extern cs_atmo_chemistry_t *cs_glob_atmo_chemistry;

/*============================================================================
 * Public function definitions
 *============================================================================*/

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_atmo_add_property_fields(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);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

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
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);


/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_atmo_set_meteo_file_name(const char *file_name);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_atmo_set_chem_conc_file_name(const char *file_name);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_atmo_set_aero_conc_file_name(const char *file_name);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_atmo_chemistry_set_spack_file_name(const char *file_name);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_atmo_chemistry_set_aerosol_file_name(const char *file_name);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_atmo_declare_chem_from_spack(void);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

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);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_atmo_log_setup(void);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_atmo_chemistry_log_setup(void);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_atmo_aerosol_log_setup(void);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_atmo_finalize(void);

/*----------------------------------------------------------------------------*/

END_C_DECLS

#endif /* __CS_ATMO_H__ */