9.2
general documentation
cs_atmo_option_t Struct Reference

#include <cs_atmo.h>

+ Collaboration diagram for cs_atmo_option_t:

Public Member Functions

DISABLE_WARNING_PUSH DISABLE_WARNING (-Wdeprecated-declarations) cs_atmo_option_t()
 Default constructor with suppression of deprecated declarations, needed to hide warnings simply induced by including this header file. More...
 

Public Attributes

DISABLE_WARNING_POP 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}
 
cs_real_t y_l93 {1e12}
 
cs_real_t x_origin {1e12}
 
cs_real_t y_origin {1e12}
 
cs_atmo_projection_t projection_type {CS_ATMO_PROJ_UNDEF}
 
int utm_zone {0}
 
int met_1d_nlevels_d {0}
 
int & nbmetd {met_1d_nlevels_d}
 
int met_1d_nlevels_t {0}
 
int & nbmett {met_1d_nlevels_t}
 
int met_1d_ntimes {0}
 
int & nbmetm {met_1d_ntimes}
 
int met_1d_nlevels_max_t {0}
 
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}
 
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}
 
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}
 
cs_real_txyp_met {nullptr}
 
cs_real_tu_met {nullptr}
 
cs_real_tv_met {nullptr}
 
cs_real_tw_met {nullptr}
 
cs_real_tek_met {nullptr}
 
cs_real_tep_met {nullptr}
 
cs_real_ttemp_met {nullptr}
 
cs_real_trho_met {nullptr}
 
cs_real_tqw_met {nullptr}
 
cs_real_tndrop_met {nullptr}
 
cs_real_tz_dyn_met {nullptr}
 
cs_real_tz_temp_met {nullptr}
 
cs_real_ttime_met {nullptr}
 
cs_real_thyd_p_met {nullptr}
 
cs_real_tpot_t_met {nullptr}
 
cs_real_tdpdt_met {nullptr}
 
cs_real_3_tmom_met {nullptr}
 
cs_real_3_tmom_cs {nullptr}
 
int hydrostatic_pressure_model {0}
 
int qv_profile {0}
 
int ground_model {0}
 
cs_atmo_ground_cat_t ground_cat {(cs_atmo_ground_cat_t) 0}
 
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}
 
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_tground_cat_thermal_inertia {nullptr}
 
cs_real_tground_cat_roughness {nullptr}
 
cs_real_tground_cat_thermal_roughness {nullptr}
 
cs_real_tground_cat_albedo {nullptr}
 
cs_real_tground_cat_emissi {nullptr}
 
cs_real_tground_cat_vegeta {nullptr}
 
cs_real_tground_cat_w1 {nullptr}
 
cs_real_tground_cat_w2 {nullptr}
 
cs_real_tground_cat_r1 {nullptr}
 
cs_real_tground_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}
 

Member Function Documentation

◆ DISABLE_WARNING()

DISABLE_WARNING_PUSH DISABLE_WARNING ( -Wdeprecated-  declarations)
inline

Default constructor with suppression of deprecated declarations, needed to hide warnings simply induced by including this header file.

Member Data Documentation

◆ accretion

bool accretion {false}

◆ altitude

cs_real_t altitude {0.}

altitude of the domain origin

◆ aod_h2o_tot

cs_real_t aod_h2o_tot {0.1}

◆ aod_o3_tot

cs_real_t aod_o3_tot {0.2}

◆ autocollection_cloud

bool autocollection_cloud {false}

◆ autocollection_rain

bool autocollection_rain {false}

◆ autoconversion

bool autoconversion {false}

◆ cloud_type

int cloud_type {0}

◆ compute_z_ground

bool compute_z_ground {false}

Option to compute ground elevation in the domain

◆ deposition_model

int deposition_model {0}

Deposition flag

◆ distribution_model

int distribution_model {1}

Option for liquid water content distribution models 1: all or nothing 2: Gaussian distribution

◆ domain_orientation

cs_real_t domain_orientation {0.}

Domain orientation (angle in degree between y direction and north), 0 by default

◆ dpdt_met

cs_real_t* dpdt_met {nullptr}

Pressure drop integrated over a time step (used for automatic open boundaries) profile

◆ ek_met

cs_real_t* ek_met {nullptr}

meteo turbulent kinetic energy profile

◆ ep_met

cs_real_t* ep_met {nullptr}

meteo turbulent dissipation profile

◆ evaporation

bool evaporation {false}

◆ ground_cat

Ground categories:

  • CS_ATMO_GROUND_5_CAT
  • CS_ATMO_GROUND_7_CAT
  • CS_ATMO_GROUND_23_CAT

◆ ground_cat_albedo

cs_real_t* ground_cat_albedo {nullptr}

Albedo per ground category

◆ ground_cat_emissi

cs_real_t* ground_cat_emissi {nullptr}

emissivity per ground category

◆ ground_cat_r1

cs_real_t* ground_cat_r1 {nullptr}

Rij value for Rij1

◆ ground_cat_r2

cs_real_t* ground_cat_r2 {nullptr}

Rij value for Rij2

◆ ground_cat_roughness

cs_real_t* ground_cat_roughness {nullptr}

Dynamic roughness length

◆ ground_cat_thermal_inertia

cs_real_t* ground_cat_thermal_inertia {nullptr}

Thermal inertia of the ground

◆ ground_cat_thermal_roughness

cs_real_t* ground_cat_thermal_roughness {nullptr}

Thermal roughness length

◆ ground_cat_vegeta

cs_real_t* ground_cat_vegeta {nullptr}

Vegetation index per ground category

◆ ground_cat_w1

cs_real_t* ground_cat_w1 {nullptr}

maximum water capacity of shallow reservoir

◆ ground_cat_w2

cs_real_t* ground_cat_w2 {nullptr}

ratio of the maximum water capacity of the shallow reservoir to the deep reservoir [0,1]

◆ ground_humidity

cs_real_t ground_humidity {0.0}

initial ground specific humidity

◆ ground_meb_model

Solve supplementary heat budget equation (multi energy budget):

  • CS_ATMO_GROUND_GENUINE
  • CS_ATMO_GROUND_PHOTOVOLTAICS
  • CS_ATMO_GROUND_VEGETATION

◆ ground_model

int ground_model {0}

Ground model (1: on, 0: off)

◆ ground_surf_temp

cs_real_t ground_surf_temp {20.0}

initial ground surface temperature for Sea, it is also the surface temperature

◆ ground_temperature

cs_real_t ground_temperature {20.0}

initial deep ground temperature

◆ ground_w1_ini

cs_real_t ground_w1_ini {0.0}

initial water content of the first reservoir

◆ ground_w2_ini

cs_real_t ground_w2_ini {0.0}

initial water content of the second reservoir

◆ ground_zone_id

int ground_zone_id {-1}

Ground zone id (or -1 if inactive)

◆ hyd_p_met

cs_real_t* hyd_p_met {nullptr}

Hydrostatic pressure from Laplace integration

◆ hydrostatic_pressure_model

int hydrostatic_pressure_model {0}

◆ infrared_1D_profile

int infrared_1D_profile {-1}

1D infrared profile id

◆ latitude

cs_real_t latitude {1e12}

latitude of the domain origin

◆ longitude

cs_real_t longitude {1e12}

longitude of the domain origin

◆ met_1d_nlevels_d

int met_1d_nlevels_d {0}

◆ met_1d_nlevels_max_t

int met_1d_nlevels_max_t {0}

Number of vertical levels

◆ met_1d_nlevels_t

int met_1d_nlevels_t {0}

numbers of altitudes for the temperature and specific humidity

◆ met_1d_ntimes

int met_1d_ntimes {0}

numbers of time steps for the meteo profiles

◆ meteo_angle

cs_real_t meteo_angle {-1.}

Meteo wind direction

◆ meteo_dlmo

cs_real_t meteo_dlmo {0.}

Meteo Monin obukhov inverse length

◆ meteo_evapor

cs_real_t meteo_evapor {cs_dbl_max}

Meteo reference evaporation

◆ meteo_file_name

char* meteo_file_name {nullptr}

Meteo file

◆ meteo_phih_s

int meteo_phih_s {0}

Universal function Phi_h for stable condition

◆ meteo_phih_u

int meteo_phih_u {1}

Universal function Phi_h for unstable condition

◆ meteo_phim_s

int meteo_phim_s {0}

Universal function Phi_m for stable condition

◆ meteo_phim_u

int meteo_phim_u {1}

Universal function Phi_m for unstable condition

◆ meteo_profile

int meteo_profile {0}

Use meteo profile:

  • 0: not use
  • 1: use a meteo file
  • 2: directly enter values large scale values
  • 3: fill directly meteo_* fields

◆ meteo_psea

cs_real_t meteo_psea {101325.}

Meteo pressure at sea level

◆ meteo_ql0

cs_real_t meteo_ql0 {0.}

Meteo reference mass fraction at 2m

◆ meteo_qw0

cs_real_t meteo_qw0 {0.}

Meteo reference mass fraction at 2m

◆ meteo_qw1

cs_real_t meteo_qw1 {cs_dbl_max}

Meteo reference mass fraction 1

◆ meteo_qw2

cs_real_t meteo_qw2 {cs_dbl_max}

Meteo reference mass fraction 2

◆ meteo_qwstar

cs_real_t meteo_qwstar {cs_dbl_max}

Meteo reference ground friction mass fraction

◆ meteo_sensi

cs_real_t meteo_sensi {cs_dbl_max}

Meteo reference sensible heat

◆ meteo_t0

cs_real_t meteo_t0 {284.15}

Meteo reference temperature (ground temperature)

◆ meteo_t1

cs_real_t meteo_t1 {0.}

Meteo reference temperature 1

◆ meteo_t2

cs_real_t meteo_t2 {0.}

Meteo reference temperature 2

◆ meteo_tstar

cs_real_t meteo_tstar {0.}

Meteo reference ground friction temperature

◆ meteo_u1

cs_real_t meteo_u1 {-1.}

Meteo reference velocity 1

◆ meteo_u2

cs_real_t meteo_u2 {-1.}

Meteo reference velocity 2

◆ meteo_uref

cs_real_t meteo_uref {-1.}

Meteo reference velocity

◆ meteo_ustar0

cs_real_t meteo_ustar0 {-1.}

Meteo reference ground friction velocity

◆ meteo_wstar0

cs_real_t meteo_wstar0 {-1.}

Meteo reference convective velocity

◆ meteo_z0

cs_real_t meteo_z0 {-1.}

Meteo reference roughness

◆ meteo_zi

cs_real_t meteo_zi {-1.}

Meteo Boundary layer elevation

◆ meteo_zref

cs_real_t meteo_zref {-1.}

Meteo reference elevation for reference velocity

◆ meteo_zt1

cs_real_t meteo_zt1 {-1.}

Meteo reference elevation for reference temperature 1

◆ meteo_zt2

cs_real_t meteo_zt2 {-1.}

Meteo reference elevation for reference temperature 2

◆ meteo_zu1

cs_real_t meteo_zu1 {-1.}

Meteo reference elevation for reference velocity 1

◆ meteo_zu2

cs_real_t meteo_zu2 {-1.}

Meteo reference elevation for reference velocity 2

◆ mom_cs

cs_real_3_t* mom_cs {nullptr}

code_saturne momentum for each level

◆ mom_met

cs_real_3_t* mom_met {nullptr}

Momentum for each level (used for automatic open boundaries)

◆ nbmaxt

int& nbmaxt {met_1d_nlevels_max_t}

◆ nbmetd

int& nbmetd {met_1d_nlevels_d}

◆ nbmetm

int& nbmetm {met_1d_ntimes}

◆ nbmett

int& nbmett {met_1d_nlevels_t}

◆ ndrop_met

cs_real_t* ndrop_met {nullptr}

meteo number of droplets profile

◆ nucleation_model

int nucleation_model {0}

Option for nucleation 0: without nucleation 1: Pruppacher and Klett 1997 2: Cohard et al. 1998,1999 3: Abdul-Razzak et al. 1998,2000 logaritmic standard deviation of the log-normal law of the droplet spectrum

◆ open_bcs_treatment

int open_bcs_treatment {0}

◆ pot_t_met

cs_real_t* pot_t_met {nullptr}

potential temperature profile

◆ precipitation

bool precipitation {false}

◆ profiles_grid_id

int profiles_grid_id {-1}

id of grid formed by 1D profiles

◆ projection_type

Projection system used in computation

◆ qv_profile

int qv_profile {0}

flag for the standard atmo humidity profile qv_profile = 0 (default) qv_profile = 1 decreasing exponential

◆ qw_met

cs_real_t* qw_met {nullptr}

meteo water mass fraction profile

◆ rain

bool rain {false}

◆ rho_met

cs_real_t* rho_met {nullptr}

meteo density profile

◆ rupture

bool rupture {false}

◆ sedimentation_model

int sedimentation_model {0}

Sedimentation flag

◆ shour

int shour {-1}

Starting hour

◆ sigc

cs_real_t sigc {0.53}

adimensional : sigc=0.53 other referenced values are 0.28, 0.15

◆ smin

int smin {-1}

Starting minute

◆ solar_1D_profile

int solar_1D_profile {-1}

1D solar profile id

◆ squant

int squant {-1}

Starting quantile

◆ ssec

cs_real_t ssec {-1.}

Starting second

◆ subgrid_model

int subgrid_model {0}

Option for subgrid models 0: the simplest parameterization (for numerical verifications) 1: Bechtold et al. 1995 (Luc Musson-Genon) 2: Bouzereau et al. 2004 3: Cuijpers and Duynkerke 1993, Deardorff 1976, Sommeria and Deardorff 1977

◆ syear

DISABLE_WARNING_POP int syear {-1}

Starting year

◆ temp_met

cs_real_t* temp_met {nullptr}

meteo temperature profile

◆ theo_interp

int theo_interp {0}

◆ time_met

cs_real_t* time_met {nullptr}

Time (in seconds) of the meteo profile

◆ u_met

cs_real_t* u_met {nullptr}

meteo u profiles

◆ utm_zone

int utm_zone {0}

◆ v_met

cs_real_t* v_met {nullptr}

meteo v profiles

◆ w_met

cs_real_t* w_met {nullptr}

meteo w profiles

◆ x_l93

cs_real_t x_l93 {1e12}

x coordinate of the domain origin in Lambert-93

◆ x_origin

cs_real_t x_origin {1e12}

numbers of altitudes for the dynamics

XY coordinates of the domain origin in current projection system

◆ xyp_met

cs_real_t* xyp_met {nullptr}

meteo x, y, p at sea levels

◆ y_l93

cs_real_t y_l93 {1e12}

y coordinate of the domain origin in Lambert-93

◆ y_origin

cs_real_t y_origin {1e12}

◆ z_dyn_met

cs_real_t* z_dyn_met {nullptr}

flag to compute the hydrostatic pressure by Laplace integration in the meteo profiles 0: based on P (sea level) value by default 1: based on P computed for the standard atmosphere

Altitudes of the dynamic profiles

◆ z_temp_met

cs_real_t* z_temp_met {nullptr}

Altitudes of the temperature profile


The documentation for this struct was generated from the following file: