SURFEX  V8_0
Surfex V8_0 release
 All Classes Files Functions Variables
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 ('AGS', 'LAI', 'AST', 'LST', 'NIT', 'NCB' options)
104 !
105 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_BSLAI ! ratio d(biomass)/d(lai)
106 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_LAIMIN ! minimum LAI
107 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_SEFOLD ! e-folding time for senescence (s)
108 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_H_TREE ! height of vegetation
109 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_GMES ! mesophyll conductance (m s-1)
110 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_RE25 ! Ecosystem Respiration parameter (kg.m2.s-1)
111 !
112 !-------------------------------------------------------------------------------
113 !
114 ! - vegetation: Ags Stress parameters ('AST', 'LST', 'NIT', 'NCB' options)
115 !
116 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_STRESS ! defensive/offensive strategy (1/0)
117 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_F2I ! critical normilized soil water
118 ! ! content for stress parameterisation
119 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_GC ! cuticular conductance (m/s)
120 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_DMAX ! maximum air saturation deficit
121 ! ! tolerate by vegetation (kg/kg)
122 !
123 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_BSLAI_ST ! ratio d(biomass)/d(lai)
124 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_SEFOLD_ST ! e-folding time for senescence (s)
125 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_GMES_ST ! mesophyll conductance (m s-1)
126 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_GC_ST ! cuticular conductance (m/s)
127 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_DMAX_ST ! maximum air saturation deficit
128 ! ! tolerate by vegetation (kg/kg)
129 !-------------------------------------------------------------------------------
130 !
131 ! - vegetation: Ags Nitrogen-model parameters ('NIT', 'NCB' option)
132 !
133 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_CE_NITRO! leaf aera ratio sensitivity
134  ! to nitrogen concentration
135 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_CF_NITRO! lethal minimum value of leaf area ratio
136 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_CNA_NITRO! nitrogen concentration of active biomass
137 !
138 !-------------------------------------------------------------------------------
139 !
140 ! - soil: primary parameters
141 !
142 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_GROUND_DEPTH ! total soil depth
143 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_ROOT_DEPTH ! root depth
144 !-------------------------------------------------------------------------------
145 !
146 ! - Vegetation: Ags Prognostic (YPHOTO = ('LAI', 'LST', 'NIT', or 'NCB') or prescribed (YPHOTO='NON', 'AGS' or 'AST')
147 !
148 REAL, DIMENSION(:,:,:), ALLOCATABLE :: XDATA_LAI ! leaf area index (monthly)
149 REAL, DIMENSION(:,:,:), ALLOCATABLE :: XDATA_LAI_ALL_YEARS ! leaf area index fromm 2002 to 2007
150 !
151 !
152 TYPE (date_time), POINTER, DIMENSION(:,:) :: TDATA_SEED ! seeding date
153 TYPE (date_time), POINTER, DIMENSION(:,:) :: TDATA_REAP ! reaping date
154 !
155 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_WATSUP ! water supply quantity
156 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_IRRIG ! flag for irrigation
157 !
158 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_TOWN ! artificial surfaces fraction
159 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_NATURE ! natural and cul. fraction
160 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_WATER ! inland water fraction
161 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_SEA ! sea fraction
162 !
163 REAL, DIMENSION(:,:,:), ALLOCATABLE :: XDATA_GREEN ! greeness fraction (monthly)
164 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_SOILRC_SO2 ! for SO2 deposition
165 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_SOILRC_O3 ! for O3 deposition
166 !
167 !
168 ! Geometric Parameters:
169 !
170 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_GARDEN ! garden fraction
171 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_BLD ! building fraction in
172  ! artificial areas
173 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_BLD_HEIGHT ! buildings height h
174 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_WALL_O_HOR ! ratio of vert. surf.
175 ! ! over hor. surf.
176 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_CAN_HW_RATIO! canyons h/W ratio
177 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_Z0_TOWN ! town roughness length
178  ! for momentum
179 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_Z0H_TOWN ! town roughness length
180  ! for heat
181 !
182 ! Roof parameters
183 !
184 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_ALB_ROOF ! albedo of roofs
185 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_EMIS_ROOF ! emissivity of roofs
186 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_HC_ROOF ! heat capacity
187  ! for roof layers
188 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_TC_ROOF ! thermal conductivity
189  ! for roof layers
190 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_D_ROOF ! width of roof layers
191 !
192 ! Road parameters
193 !
194 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_ALB_ROAD ! albedo of roads
195 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_EMIS_ROAD ! emissivity of roads
196 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_HC_ROAD ! heat capacity
197  ! for road layers
198 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_TC_ROAD ! thermal conductivity
199  ! for road layers
200 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_D_ROAD ! width of road layers
201 !
202 ! Wall parameters
203 !
204 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_ALB_WALL ! albedo of roads
205 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_EMIS_WALL ! emissivity of roads
206 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_HC_WALL ! heat capacity
207  ! for wall layers
208 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_TC_WALL ! thermal conductivity
209  ! for wall layers
210 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_D_WALL ! width of wall layers
211 !
212 ! anthropogenic fluxes
213 !
214 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_H_TRAFFIC ! anthropogenic sensible
215 ! ! heat fluxes due to traffic
216 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_LE_TRAFFIC ! anthropogenic latent
217 ! ! heat fluxes due to traffic
218 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_H_INDUSTRY ! anthropogenic sensible
219 ! ! heat fluxes due to factories
220 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_LE_INDUSTRY ! anthropogenic latent
221 ! ! heat fluxes due to factories
222 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_HC_FLOOR ! heat capacity of floor layers [J m-3 K-1]
223 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_TC_FLOOR ! thermal conductivity of floor layers [W m-1 K-1]
224 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_D_FLOOR ! thickness of floor layers [m]
225 !
226 ! For multi-energy balance (MEB)
227 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_RGLGV !
228 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_GAMMAGV !
229 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_RSMINGV ! Understory minimum
230 ! ! stomatal resistance
231 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_ROOT_EXTINCTIONGV ! Understory Jackson coefficient
232 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_WRMAX_CFGV
233 REAL, DIMENSION(:,:,:), ALLOCATABLE :: XDATA_LAIGV ! Understory LAI
234 REAL, DIMENSION(:,:,:), ALLOCATABLE :: XDATA_GNDLITTER ! Ground litter coverage
235 REAL, DIMENSION(:,:,:), ALLOCATABLE :: XDATA_Z0LITTER ! Ground litter roughness length
236 REAL, DIMENSION(:,:), ALLOCATABLE :: XDATA_ROOT_DEPTHGV ! Understory root depth
237 REAL, DIMENSION(:,:,:), ALLOCATABLE :: XDATA_H_VEG ! Height of canopy vegetation
238 !
239 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_TCOOL_TARGET ! cooling setpoint of indoor air
240 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_THEAT_TARGET ! heating setpoint of indoor air
241 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_F_WASTE_CAN ! fraction of waste heat released into the canyon
242 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_EFF_HEAT ! efficiency of the heating system
243 !
244 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_QIN ! internal heat gains [W m-2(floor)]
245 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_QIN_FRAD ! radiant fraction of internal heat gains
246 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_SHGC ! solar transmitance of windows
247 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_U_WIN ! glazing thermal resistance [K m W-2]
248 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_GR ! glazing ratio
249 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_SHGC_SH ! solar transmitance of windows
250 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_FLOOR_HEIGHT ! building floor height [m]
251 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_INF ! infiltration/ventilation flow rate [AC/H]
252 !
253 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_F_WATER_COND
254 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_QIN_FLAT
255 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_HR_TARGET
256 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_V_VENT
257 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_CAP_SYS_HEAT
258 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_CAP_SYS_RAT
259 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_T_ADP
260 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_M_SYS_RAT
261 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_COP_RAT ! COP of the cooling system
262 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_T_SIZE_MAX
263 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_T_SIZE_MIN
264 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_SHADE
265 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_NATVENT
266 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_ROUGH_ROOF
267 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_ROUGH_WALL
268 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_RESIDENTIAL ! residential use fraction
269 
270 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_EMIS_PANEL ! emissivity of solar panels
271 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_ALB_PANEL ! albedo of solar panels
272 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_EFF_PANEL ! efficiency of solar panels
273 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_FRAC_PANEL ! fraction of solar panels on roofs
274 !
275 ! urban vegetation parameters
276 !
277 REAL, DIMENSION(:), ALLOCATABLE :: XDATA_FRAC_GR ! fraction of greenroof
278 !
279 !-------------------------------------------------------------------------------
280 !
281 END MODULE modd_data_cover