SURFEX v8.1
General documentation of Surfex
modd_data_cover.F90
Go to the documentation of this file.
1 !SFX_LIC Copyright 1994-2014 CNRS, Meteo-France and Universite Paul Sabatier
2 !SFX_LIC This is part of the SURFEX software governed by the CeCILL-C licence
3 !SFX_LIC version 1. See LICENSE, CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt
4 !SFX_LIC for details. version 1.
5 ! #####################
7 ! #####################
8 !
9 !!**** *MODD_DATA_COVER* - declaration of correspondances between surface
10 !! classes and variables
11 !!
12 !! PURPOSE
13 !! -------
14 ! The purpose of this declarative module is to specify the
15 ! arrays with correspondances between surface classes and
16 ! variables
17 !
18 !!
19 !!** IMPLICIT ARGUMENTS
20 !! ------------------
21 !!
22 !! REFERENCE
23 !! ---------
24 !!
25 !!
26 !! AUTHOR
27 !! ------
28 !! V. Masson *Meteo France*
29 !!
30 !! MODIFICATIONS
31 !! -------------
32 !! Original 15/12/97
33 !! F.solmon 01/06/00 adaptation for patch approach +
34 !! 1D for surface fields of ISBA
35 !! V. Masson 01/2004 surface externalization
36 !! P Le Moigne 09/2005 AGS modifs of L. Jarlan
37 !! P Le Moigne 06/2006 seeding and irrigation
38 !! G Pigeon 08/2012 ROUGH_ROOF, ROUGH_WALL
39 !! V. Masson 08/2013 Adds solar panel variables
40 !! P Samuelsson 10/2014 Multi-energy balance (MEB)
41 !!----------------------------------------------------------------------
42 !
43 !* 0. DECLARATIONS
44 ! ------------
46 !
47 IMPLICIT NONE
48 !
49 LOGICAL :: lread_data_cover ! true if ecoclimap(2) parameters are read in binary files
50 LOGICAL :: ldata_irrig ! true if ecoclimap2 irrigation parameters have been modified by user
51 LOGICAL :: lclim_lai =.true. ! F: uses current year LAI (if between 2002 and 2006).
52 ! ! T: uses average of LAI (average is done using the 5 years)
53 INTEGER :: neco2_start_year =2002 ! first year of data for ecoclimap2
54 INTEGER :: neco2_end_year =2006 ! last year of data for ecoclimap2
55 !-------------------------------------------------------------------------------
56 !
57 ! Mask and number of grid elements containing patches/tiles:
58 !
59 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_vegtype ! fractions of veg. types
60 !
61 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_dice ! depth of the soil column for the calculation
62 ! of the frozen soil fraction (m)
63 !
64 ! Input Parameters, per patch:
65 !
66 ! - vegetation + bare soil:
67 !
68 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_z0_o_z0h! ratio of z0 for momentum and heat
69 !
70 REAL, DIMENSION(:,:,:), ALLOCATABLE :: xdata_emis_eco! (emissivity vg + bare ground)
71 ! ! monthly
72 REAL, DIMENSION(:,:,:), ALLOCATABLE :: xdata_z0 ! dynamical veg. roughness length
73 !
74 ! - vegetation: ! (monthly)
75 !
76 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_albnir_veg ! near infra-red albedo
77 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_albvis_veg ! visible albedo
78 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_albuv_veg ! UV albedo
79 !
80 REAL, DIMENSION(:,:,:), ALLOCATABLE :: xdata_alb_veg_nir ! near infra-red albedo
81 REAL, DIMENSION(:,:,:), ALLOCATABLE :: xdata_alb_veg_vis ! visible albedo
82 REAL, DIMENSION(:,:,:), ALLOCATABLE :: xdata_alb_soil_nir ! near infra-red albedo
83 REAL, DIMENSION(:,:,:), ALLOCATABLE :: xdata_alb_soil_vis ! visible albedo
84 !
85 ! - vegetation: default option (Jarvis) and general parameters:
86 !
87 REAL, DIMENSION(:,:,:), ALLOCATABLE :: xdata_veg ! veg. fraction (monthly)
88 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_wrmax_cf ! coefficient for interception reservoir
89 !
90 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_rsmin ! minimum stomatal resistance
91 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_gamma !
92 !
93 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_cv ! inverse of veg. thermal capacity
94 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_rgl !
95 !
96 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_root_extinction! root extinction
97 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_root_lin ! ponderation coefficient between
98  ! root frac.
99  ! formulations
100 !
101 !-------------------------------------------------------------------------------
102 !
103 ! - vegetation: Ags parameters ('AST', 'NIT', 'NCB' options)
104 !
105 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_bslai ! ratio d(biomass)/d(lai)
106 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_sefold ! e-folding time for senescence (s)
107 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_gmes ! mesophyll conductance (m s-1)
108 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_gc ! cuticular conductance (m/s)
109 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_dmax ! maximum air saturation deficit
110 ! ! tolerate by vegetation (kg/kg)
111 !
112 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_bslai_st ! ratio d(biomass)/d(lai)
113 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_sefold_st ! e-folding time for senescence (s)
114 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_gmes_st ! mesophyll conductance (m s-1)
115 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_gc_st ! cuticular conductance (m/s)
116 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_dmax_st ! maximum air saturation deficit
117 ! ! tolerate by vegetation (kg/kg)
118 !-------------------------------------------------------------------------------
119 !
120 ! - vegetation: Ags Stress parameters ('AST', 'NIT', 'NCB' options)
121 !
122 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_laimin ! minimum LAI
123 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_h_tree ! height of vegetation
124 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_re25 ! Ecosystem Respiration parameter (kg.m2.s-1)
125 !
126 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_stress ! defensive/offensive strategy (1/0)
127 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_f2i ! critical normilized soil water
128 ! ! content for stress parameterisation
129 !
130 !-------------------------------------------------------------------------------
131 !
132 ! - vegetation: Ags Nitrogen-model parameters ('NIT', 'NCB' option)
133 !
134 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_ce_nitro! leaf aera ratio sensitivity
135  ! to nitrogen concentration
136 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_cf_nitro! lethal minimum value of leaf area ratio
137 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_cna_nitro! nitrogen concentration of active biomass
138 !
139 !-------------------------------------------------------------------------------
140 !
141 ! - soil: primary parameters
142 !
143 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_ground_depth ! total soil depth
144 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_root_depth ! root depth
145 !-------------------------------------------------------------------------------
146 !
147 ! - Vegetation: Ags Prognostic (YPHOTO = ('NIT', or 'NCB') or prescribed (YPHOTO='NON' or 'AST')
148 !
149 REAL, DIMENSION(:,:,:), ALLOCATABLE :: xdata_lai ! leaf area index (monthly)
150 REAL, DIMENSION(:,:,:), ALLOCATABLE :: xdata_lai_all_years ! leaf area index fromm 2002 to 2007
151 !
152 !
153 type(date_time), POINTER, DIMENSION(:,:) :: tdata_seed ! seeding date
154 type(date_time), POINTER, DIMENSION(:,:) :: tdata_reap ! reaping date
155 !
156 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_watsup ! water supply quantity
157 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_irrig ! flag for irrigation
158 !
159 REAL, DIMENSION(:), ALLOCATABLE :: xdata_town ! artificial surfaces fraction
160 REAL, DIMENSION(:), ALLOCATABLE :: xdata_nature ! natural and cul. fraction
161 REAL, DIMENSION(:), ALLOCATABLE :: xdata_water ! inland water fraction
162 REAL, DIMENSION(:), ALLOCATABLE :: xdata_sea ! sea fraction
163 !
164 REAL, DIMENSION(:,:,:), ALLOCATABLE :: xdata_green ! greeness fraction (monthly)
165 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_soilrc_so2 ! for SO2 deposition
166 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_soilrc_o3 ! for O3 deposition
167 !
168 !
169 ! Geometric Parameters:
170 !
171 REAL, DIMENSION(:), ALLOCATABLE :: xdata_garden ! garden fraction
172 REAL, DIMENSION(:), ALLOCATABLE :: xdata_bld ! building fraction in
173  ! artificial areas
174 REAL, DIMENSION(:), ALLOCATABLE :: xdata_bld_height ! buildings height h
175 REAL, DIMENSION(:), ALLOCATABLE :: xdata_wall_o_hor ! ratio of vert. surf.
176 ! ! over hor. surf.
177 REAL, DIMENSION(:), ALLOCATABLE :: xdata_can_hw_ratio! canyons h/W ratio
178 REAL, DIMENSION(:), ALLOCATABLE :: xdata_z0_town ! town roughness length
179  ! for momentum
180 REAL, DIMENSION(:), ALLOCATABLE :: xdata_z0h_town ! town roughness length
181  ! for heat
182 !
183 ! Roof parameters
184 !
185 REAL, DIMENSION(:), ALLOCATABLE :: xdata_alb_roof ! albedo of roofs
186 REAL, DIMENSION(:), ALLOCATABLE :: xdata_emis_roof ! emissivity of roofs
187 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_hc_roof ! heat capacity
188  ! for roof layers
189 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_tc_roof ! thermal conductivity
190  ! for roof layers
191 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_d_roof ! width of roof layers
192 !
193 ! Road parameters
194 !
195 REAL, DIMENSION(:), ALLOCATABLE :: xdata_alb_road ! albedo of roads
196 REAL, DIMENSION(:), ALLOCATABLE :: xdata_emis_road ! emissivity of roads
197 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_hc_road ! heat capacity
198  ! for road layers
199 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_tc_road ! thermal conductivity
200  ! for road layers
201 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_d_road ! width of road layers
202 !
203 ! Wall parameters
204 !
205 REAL, DIMENSION(:), ALLOCATABLE :: xdata_alb_wall ! albedo of roads
206 REAL, DIMENSION(:), ALLOCATABLE :: xdata_emis_wall ! emissivity of roads
207 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_hc_wall ! heat capacity
208  ! for wall layers
209 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_tc_wall ! thermal conductivity
210  ! for wall layers
211 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_d_wall ! width of wall layers
212 !
213 ! anthropogenic fluxes
214 !
215 REAL, DIMENSION(:), ALLOCATABLE :: xdata_h_traffic ! anthropogenic sensible
216 ! ! heat fluxes due to traffic
217 REAL, DIMENSION(:), ALLOCATABLE :: xdata_le_traffic ! anthropogenic latent
218 ! ! heat fluxes due to traffic
219 REAL, DIMENSION(:), ALLOCATABLE :: xdata_h_industry ! anthropogenic sensible
220 ! ! heat fluxes due to factories
221 REAL, DIMENSION(:), ALLOCATABLE :: xdata_le_industry ! anthropogenic latent
222 ! ! heat fluxes due to factories
223 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_hc_floor ! heat capacity of floor layers [J m-3 K-1]
224 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_tc_floor ! thermal conductivity of floor layers [W m-1 K-1]
225 REAL, DIMENSION(:,:), ALLOCATABLE :: xdata_d_floor ! thickness of floor layers [m]
226 !
227 ! For multi-energy balance (MEB)
228 REAL, DIMENSION(:,:,:), ALLOCATABLE :: xdata_gndlitter ! Ground litter coverage
229 REAL, DIMENSION(:,:,:), ALLOCATABLE :: xdata_z0litter ! Ground litter roughness length
230 REAL, DIMENSION(:,:,:), ALLOCATABLE :: xdata_h_veg ! Height of canopy vegetation
231 !
232 REAL, DIMENSION(:), ALLOCATABLE :: xdata_tcool_target ! cooling setpoint of indoor air
233 REAL, DIMENSION(:), ALLOCATABLE :: xdata_theat_target ! heating setpoint of indoor air
234 REAL, DIMENSION(:), ALLOCATABLE :: xdata_f_waste_can ! fraction of waste heat released into the canyon
235 REAL, DIMENSION(:), ALLOCATABLE :: xdata_eff_heat ! efficiency of the heating system
236 !
237 REAL, DIMENSION(:), ALLOCATABLE :: xdata_qin ! internal heat gains [W m-2(floor)]
238 REAL, DIMENSION(:), ALLOCATABLE :: xdata_qin_frad ! radiant fraction of internal heat gains
239 REAL, DIMENSION(:), ALLOCATABLE :: xdata_shgc ! solar transmitance of windows
240 REAL, DIMENSION(:), ALLOCATABLE :: xdata_u_win ! glazing thermal resistance [K m W-2]
241 REAL, DIMENSION(:), ALLOCATABLE :: xdata_gr ! glazing ratio
242 REAL, DIMENSION(:), ALLOCATABLE :: xdata_shgc_sh ! solar transmitance of windows
243 REAL, DIMENSION(:), ALLOCATABLE :: xdata_floor_height ! building floor height [m]
244 REAL, DIMENSION(:), ALLOCATABLE :: xdata_inf ! infiltration/ventilation flow rate [AC/H]
245 !
246 REAL, DIMENSION(:), ALLOCATABLE :: xdata_f_water_cond
247 REAL, DIMENSION(:), ALLOCATABLE :: xdata_qin_flat
248 REAL, DIMENSION(:), ALLOCATABLE :: xdata_hr_target
249 REAL, DIMENSION(:), ALLOCATABLE :: xdata_v_vent
250 REAL, DIMENSION(:), ALLOCATABLE :: xdata_cap_sys_heat
251 REAL, DIMENSION(:), ALLOCATABLE :: xdata_cap_sys_rat
252 REAL, DIMENSION(:), ALLOCATABLE :: xdata_t_adp
253 REAL, DIMENSION(:), ALLOCATABLE :: xdata_m_sys_rat
254 REAL, DIMENSION(:), ALLOCATABLE :: xdata_cop_rat ! COP of the cooling system
255 REAL, DIMENSION(:), ALLOCATABLE :: xdata_t_size_max
256 REAL, DIMENSION(:), ALLOCATABLE :: xdata_t_size_min
257 REAL, DIMENSION(:), ALLOCATABLE :: xdata_shade
258 REAL, DIMENSION(:), ALLOCATABLE :: xdata_natvent
259 REAL, DIMENSION(:), ALLOCATABLE :: xdata_rough_roof
260 REAL, DIMENSION(:), ALLOCATABLE :: xdata_rough_wall
261 REAL, DIMENSION(:), ALLOCATABLE :: xdata_residential ! residential use fraction
262 
263 REAL, DIMENSION(:), ALLOCATABLE :: xdata_emis_panel ! emissivity of solar panels
264 REAL, DIMENSION(:), ALLOCATABLE :: xdata_alb_panel ! albedo of solar panels
265 REAL, DIMENSION(:), ALLOCATABLE :: xdata_eff_panel ! efficiency of solar panels
266 REAL, DIMENSION(:), ALLOCATABLE :: xdata_frac_panel ! fraction of solar panels on roofs
267 !
268 ! urban vegetation parameters
269 !
270 REAL, DIMENSION(:), ALLOCATABLE :: xdata_frac_gr ! fraction of greenroof
271 !
272 !-------------------------------------------------------------------------------
273 !
274 END MODULE modd_data_cover
real, dimension(:,:), allocatable xdata_irrig
real, dimension(:,:), allocatable xdata_ce_nitro
real, dimension(:,:), allocatable xdata_albnir_veg
real, dimension(:,:), allocatable xdata_sefold_st
real, dimension(:,:), allocatable xdata_hc_roof
real, dimension(:,:), allocatable xdata_root_lin
real, dimension(:), allocatable xdata_shgc_sh
real, dimension(:,:), allocatable xdata_albvis_veg
real, dimension(:,:), allocatable xdata_soilrc_so2
real, dimension(:,:,:), allocatable xdata_z0
real, dimension(:,:), allocatable xdata_rgl
real, dimension(:), allocatable xdata_alb_road
real, dimension(:), allocatable xdata_v_vent
real, dimension(:,:), allocatable xdata_gc
real, dimension(:,:), allocatable xdata_dmax
type(date_time), dimension(:,:), pointer tdata_seed
real, dimension(:,:), allocatable xdata_gmes_st
real, dimension(:), allocatable xdata_residential
real, dimension(:), allocatable xdata_emis_wall
real, dimension(:,:), allocatable xdata_d_roof
real, dimension(:), allocatable xdata_bld
real, dimension(:,:), allocatable xdata_albuv_veg
real, dimension(:,:,:), allocatable xdata_alb_soil_nir
real, dimension(:), allocatable xdata_t_adp
real, dimension(:,:,:), allocatable xdata_lai_all_years
real, dimension(:,:), allocatable xdata_gamma
real, dimension(:), allocatable xdata_f_waste_can
real, dimension(:,:), allocatable xdata_root_depth
real, dimension(:), allocatable xdata_qin_frad
real, dimension(:), allocatable xdata_le_traffic
real, dimension(:), allocatable xdata_qin_flat
real, dimension(:,:), allocatable xdata_laimin
real, dimension(:,:), allocatable xdata_gmes
real, dimension(:), allocatable xdata_z0h_town
real, dimension(:,:), allocatable xdata_vegtype
real, dimension(:), allocatable xdata_water
real, dimension(:,:), allocatable xdata_cv
real, dimension(:), allocatable xdata_tcool_target
real, dimension(:,:), allocatable xdata_tc_road
real, dimension(:), allocatable xdata_wall_o_hor
real, dimension(:,:), allocatable xdata_hc_wall
real, dimension(:,:), allocatable xdata_z0_o_z0h
real, dimension(:), allocatable xdata_sea
real, dimension(:), allocatable xdata_theat_target
real, dimension(:,:), allocatable xdata_bslai
real, dimension(:,:), allocatable xdata_dmax_st
type(date_time), dimension(:,:), pointer tdata_reap
real, dimension(:,:), allocatable xdata_rsmin
real, dimension(:), allocatable xdata_gr
real, dimension(:), allocatable xdata_u_win
real, dimension(:), allocatable xdata_alb_wall
real, dimension(:,:), allocatable xdata_bslai_st
real, dimension(:,:), allocatable xdata_tc_roof
real, dimension(:,:), allocatable xdata_d_road
real, dimension(:), allocatable xdata_shade
real, dimension(:), allocatable xdata_t_size_max
real, dimension(:), allocatable xdata_emis_panel
real, dimension(:,:,:), allocatable xdata_alb_veg_nir
real, dimension(:), allocatable xdata_m_sys_rat
real, dimension(:,:), allocatable xdata_cf_nitro
real, dimension(:), allocatable xdata_shgc
real, dimension(:,:), allocatable xdata_d_floor
real, dimension(:), allocatable xdata_emis_road
real, dimension(:,:), allocatable xdata_wrmax_cf
real, dimension(:), allocatable xdata_alb_panel
real, dimension(:), allocatable xdata_eff_panel
real, dimension(:,:,:), allocatable xdata_veg
real, dimension(:), allocatable xdata_inf
real, dimension(:), allocatable xdata_frac_gr
real, dimension(:,:), allocatable xdata_dice
real, dimension(:), allocatable xdata_f_water_cond
real, dimension(:), allocatable xdata_h_traffic
real, dimension(:), allocatable xdata_rough_roof
real, dimension(:), allocatable xdata_can_hw_ratio
real, dimension(:,:,:), allocatable xdata_h_veg
real, dimension(:,:), allocatable xdata_h_tree
real, dimension(:,:), allocatable xdata_tc_floor
real, dimension(:,:,:), allocatable xdata_alb_veg_vis
real, dimension(:,:,:), allocatable xdata_green
real, dimension(:), allocatable xdata_hr_target
real, dimension(:,:,:), allocatable xdata_lai
real, dimension(:), allocatable xdata_garden
real, dimension(:,:,:), allocatable xdata_z0litter
real, dimension(:,:), allocatable xdata_soilrc_o3
real, dimension(:,:), allocatable xdata_watsup
real, dimension(:,:), allocatable xdata_gc_st
real, dimension(:), allocatable xdata_le_industry
real, dimension(:), allocatable xdata_qin
real, dimension(:), allocatable xdata_natvent
real, dimension(:,:), allocatable xdata_hc_floor
real, dimension(:,:), allocatable xdata_re25
real, dimension(:), allocatable xdata_bld_height
real, dimension(:,:), allocatable xdata_tc_wall
real, dimension(:), allocatable xdata_h_industry
real, dimension(:,:), allocatable xdata_ground_depth
real, dimension(:,:), allocatable xdata_cna_nitro
real, dimension(:,:), allocatable xdata_stress
real, dimension(:), allocatable xdata_cop_rat
real, dimension(:), allocatable xdata_z0_town
real, dimension(:), allocatable xdata_cap_sys_heat
real, dimension(:), allocatable xdata_rough_wall
real, dimension(:,:), allocatable xdata_f2i
real, dimension(:), allocatable xdata_emis_roof
real, dimension(:,:,:), allocatable xdata_emis_eco
real, dimension(:), allocatable xdata_alb_roof
real, dimension(:,:), allocatable xdata_sefold
real, dimension(:,:), allocatable xdata_hc_road
real, dimension(:), allocatable xdata_cap_sys_rat
real, dimension(:), allocatable xdata_floor_height
real, dimension(:), allocatable xdata_town
real, dimension(:), allocatable xdata_t_size_min
real, dimension(:), allocatable xdata_frac_panel
real, dimension(:,:,:), allocatable xdata_alb_soil_vis
real, dimension(:), allocatable xdata_nature
real, dimension(:,:), allocatable xdata_root_extinction
real, dimension(:,:), allocatable xdata_d_wall
real, dimension(:,:,:), allocatable xdata_gndlitter
real, dimension(:), allocatable xdata_eff_heat