-
Notifications
You must be signed in to change notification settings - Fork 19
/
RunModule.f90
330 lines (277 loc) · 15.3 KB
/
RunModule.f90
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
! module for executing Noah-OWP-Modular model in a streamlined way
module RunModule
use NamelistRead
use LevelsType
use DomainType
use OptionsType
use ParametersType
use WaterType
use ForcingType
use EnergyType
use AsciiReadModule
use OutputModule
use UtilitiesModule
use ForcingModule
use InterceptionModule
use EnergyModule
use WaterModule
use DateTimeUtilsModule
implicit none
type :: noahowp_type
type(namelist_type) :: namelist
type(levels_type) :: levels
type(domain_type) :: domain
type(options_type) :: options
type(parameters_type) :: parameters
type(water_type) :: water
type(forcing_type) :: forcing
type(energy_type) :: energy
end type noahowp_type
contains
!== Initialize the model ================================================================================
SUBROUTINE initialize_from_file (model, config_filename)
implicit none
type(noahowp_type), target, intent(out) :: model
character(len=*), intent (in) :: config_filename ! config file from command line argument
integer :: forcing_timestep ! integer time step (set to dt) for some subroutine calls
associate(namelist => model%namelist, &
levels => model%levels, &
domain => model%domain, &
options => model%options, &
parameters => model%parameters, &
water => model%water, &
forcing => model%forcing, &
energy => model%energy)
!---------------------------------------------------------------------
! initialize
!---------------------------------------------------------------------
call namelist%ReadNamelist(config_filename)
call levels%Init
call levels%InitTransfer(namelist)
call domain%Init(namelist)
call domain%InitTransfer(namelist)
call options%Init()
call options%InitTransfer(namelist)
call parameters%Init(namelist)
call parameters%paramRead(namelist)
call forcing%Init(namelist)
call forcing%InitTransfer(namelist)
call energy%Init(namelist)
call energy%InitTransfer(namelist)
call water%Init(namelist)
call water%InitTransfer(namelist)
! Initializations
! for soil water
!water%zwt = -100.0 ! should only be needed for run=1
water%smcwtd = 0.0 ! should only be needed for run=5
water%deeprech = 0.0 ! should only be needed for run=5
water%qinsur = 0.0 !
water%runsrf = 0.0 !
water%runsub = 0.0 !
water%qdrain = 0.0 !
water%wcnd = 0.0 !
water%fcrmax = 0.0 !
water%snoflow = 0.0 ! glacier outflow for all RUNSUB options, [mm/s]
water%qseva = 0.0 ! soil evaporation [mm/s]
water%etrani = 0.0 ! transpiration from each level[mm/s]
water%btrani = 0.0 ! soil water transpiration factor (0 to 1) by soil layer
water%btran = 0.0 ! soil water transpiration factor (0 to 1)
! for canopy water
water%RAIN = 0.0 ! rainfall mm/s
water%SNOW = 0.0 ! snowfall mm/s
water%BDFALL = 0.0 ! bulk density of snowfall (kg/m3)
water%FB_snow = 0.0 ! canopy fraction buried by snow (computed from phenology)
water%FP = 1.0 ! fraction of the gridcell that receives precipitation
water%CANLIQ = 0.0 ! canopy liquid water [mm]
water%CANICE = 0.0 ! canopy frozen water [mm]
water%FWET = 0.0 ! canopy fraction wet or snow
water%CMC = 0.0 ! intercepted water per ground area (mm)
water%QINTR = 0.0 ! interception rate for rain (mm/s)
water%QDRIPR = 0.0 ! drip rate for rain (mm/s)
water%QTHROR = 0.0 ! throughfall for rain (mm/s)
water%QINTS = 0.0 ! interception (loading) rate for snowfall (mm/s)
water%QDRIPS = 0.0 ! drip (unloading) rate for intercepted snow (mm/s)
water%QTHROS = 0.0 ! throughfall of snowfall (mm/s)
water%QRAIN = 0.0 ! rain at ground srf (mm/s) [+]
water%QSNOW = 0.0 ! snow at ground srf (mm/s) [+]
water%SNOWHIN = 0.0 ! snow depth increasing rate (m/s)
water%ECAN = 0.0 ! evap of intercepted water (mm/s) [+]
water%ETRAN = 0.0 ! transpiration rate (mm/s) [+]
! for snow water
water%QVAP = 0.0 ! evaporation/sublimation rate mm/s
water%ISNOW = 0
water%SNOWH = 0.0
water%SNEQV = 0.0
water%SNEQVO = 0.0
water%BDSNO = 0.0
water%PONDING = 0.0
water%PONDING1 = 0.0
water%PONDING2 = 0.0
water%QSNBOT = 0.0
water%QSNFRO = 0.0
water%QSNSUB = 0.0
water%QDEW = 0.0
water%QSDEW = 0.0
water%SNICE = 0.0
water%SNLIQ = 0.0
water%FICEOLD = 0.0
water%FSNO = 0.0
! for energy-related variable
energy%TV = 298.0 ! leaf temperature [K]
energy%TG = 298.0 ! ground temperature [K]
energy%CM = 0.0 ! momentum drag coefficient
energy%CH = 0.0 ! heat drag coefficient
energy%FCEV = 5.0 ! constant canopy evaporation (w/m2) [+ to atm ]
energy%FCTR = 5.0 ! constant transpiration (w/m2) [+ to atm]
energy%IMELT = 1 ! freeze
energy%STC = 298.0
energy%COSZ = 0.7 ! cosine of solar zenith angle
energy%ICE = 0 ! 1 if sea ice, -1 if glacier, 0 if no land ice (seasonal snow)
energy%ALB = 0.6 ! initialize snow albedo in CLASS routine
energy%ALBOLD = 0.6 ! initialize snow albedo in CLASS routine
energy%FROZEN_CANOPY = .false. ! used to define latent heat pathway
energy%FROZEN_GROUND = .false.
! -- forcings
! these are initially set to huge(1) -- to trap errors may want to set to a recognizable flag if they are
! supposed to be assigned below (eg -9999)
!forcing%UU = 0.0 ! wind speed in u direction (m s-1)
!forcing%VV = 0.0 ! wind speed in v direction (m s-1)
!forcing%SFCPRS = 0.0 ! pressure (pa)
!forcing%SFCTMP = 0.0 ! surface air temperature [k]
!forcing%Q2 = 0.0 ! mixing ratio (kg/kg)
!forcing%PRCP = 0.0 ! convective precipitation entering [mm/s] ! MB/AN : v3.7
!forcing%SOLDN = 0.0 ! downward shortwave radiation (w/m2)
!forcing%LWDN = 0.0 ! downward longwave radiation (w/m2)
! forcing-related variables
forcing%PRCPCONV = 0.0 ! convective precipitation entering [mm/s] ! MB/AN : v3.7
forcing%PRCPNONC = 0.0 ! non-convective precipitation entering [mm/s] ! MB/AN : v3.7
forcing%PRCPSHCV = 0.0 ! shallow convective precip entering [mm/s] ! MB/AN : v3.7
forcing%PRCPSNOW = 0.0 ! snow entering land model [mm/s] ! MB/AN : v3.7
forcing%PRCPGRPL = 0.0 ! graupel entering land model [mm/s] ! MB/AN : v3.7
forcing%PRCPHAIL = 0.0 ! hail entering land model [mm/s] ! MB/AN : v3.7
forcing%THAIR = 0.0 ! potential temperature (k)
forcing%QAIR = 0.0 ! specific humidity (kg/kg) (q2/(1+q2))
forcing%EAIR = 0.0 ! vapor pressure air (pa)
forcing%RHOAIR = 0.0 ! density air (kg/m3)
forcing%SWDOWN = 0.0 ! downward solar filtered by sun angle [w/m2]
forcing%FPICE = 0.0 ! fraction of ice AJN
forcing%JULIAN = 0.0 ! Setting arbitrary julian day
forcing%YEARLEN = 365 ! Setting year to be normal (i.e. not a leap year)
forcing%FOLN = 1.0 ! foliage nitrogen concentration (%); for now, set to nitrogen saturation
forcing%TBOT = 285.0 ! bottom condition for soil temperature [K]
! domain variables
domain%zsnso(-namelist%nsnow+1:0) = 0.0
domain%zsnso(1:namelist%nsoil) = namelist%zsoil
! time variables
domain%nowdate = domain%startdate ! start the model with nowdate = startdate
forcing_timestep = domain%dt ! integer timestep for some subroutine calls
domain%itime = 1 ! initialize the time loop counter at 1
domain%time_dbl = 0.d0 ! start model run at t = 0
!---------------------------------------------------------------------
!--- set a time vector for simulation ---
!---------------------------------------------------------------------
! --- AWW: calculate start and end utimes & records for requested station data read period ---
call get_utime_list (domain%start_datetime, domain%end_datetime, domain%dt, domain%sim_datetimes) ! makes unix-time list for desired records (end-of-timestep)
domain%ntime = size (domain%sim_datetimes)
!print *, "---------";
!print *, 'Simulation startdate = ', domain%startdate, ' enddate = ', domain%enddate, ' dt(sec) = ', domain%dt, ' ntimes = ', domain%ntime ! YYYYMMDD dates
!print *, "---------"
!---------------------------------------------------------------------
! Open the forcing file
! Code adapted from the ASCII_IO from NOAH-MP V1.1
! Compiler directive NGEN_FORCING_ACTIVE to be defined if
! Nextgen forcing is being used (https://github.com/NOAA-OWP/ngen)
!---------------------------------------------------------------------
#ifndef NGEN_FORCING_ACTIVE
call open_forcing_file(namelist%forcing_filename)
#endif
!---------------------------------------------------------------------
! create output file and add initial values
! Compiler directive NGEN_OUTPUT_ACTIVE to be defined if
! Nextgen is writing model output (https://github.com/NOAA-OWP/ngen)
!---------------------------------------------------------------------
#ifndef NGEN_OUTPUT_ACTIVE
call initialize_output(namelist%output_filename, domain%ntime, levels%nsoil, levels%nsnow)
#endif
end associate ! terminate the associate block
END SUBROUTINE initialize_from_file
!== Finalize the model ================================================================================
SUBROUTINE cleanup(model)
implicit none
type(noahowp_type), intent(inout) :: model
!---------------------------------------------------------------------
! Compiler directive NGEN_OUTPUT_ACTIVE to be defined if
! Nextgen is writing model output (https://github.com/NOAA-OWP/ngen)
!---------------------------------------------------------------------
#ifndef NGEN_OUTPUT_ACTIVE
call finalize_output()
#endif
END SUBROUTINE cleanup
!== Move the model ahead one time step ================================================================
SUBROUTINE advance_in_time(model)
type (noahowp_type), intent (inout) :: model
call solve_noahowp(model)
model%domain%itime = model%domain%itime + 1 ! increment the integer time by 1
model%domain%time_dbl = dble(model%domain%time_dbl + model%domain%dt) ! increment model time in seconds by DT
END SUBROUTINE advance_in_time
!== Run one time step of the model ================================================================
SUBROUTINE solve_noahowp(model)
type (noahowp_type), intent (inout) :: model
integer, parameter :: iunit = 10 ! Fortran unit number to attach to the opened file
integer :: forcing_timestep ! integer time step (set to dt) for some subroutine calls
integer :: ierr ! error code for reading forcing data
integer :: curr_yr, curr_mo, curr_dy, curr_hr, curr_min, curr_sec ! current UNIX timestep details
associate(namelist => model%namelist, &
levels => model%levels, &
domain => model%domain, &
options => model%options, &
parameters => model%parameters, &
water => model%water, &
forcing => model%forcing, &
energy => model%energy)
! Compute the current UNIX datetime
domain%curr_datetime = domain%sim_datetimes(domain%itime) ! use end-of-timestep datetimes because initial var values are being written
call unix_to_date (domain%curr_datetime, curr_yr, curr_mo, curr_dy, curr_hr, curr_min, curr_sec)
! print '(2x,I4,1x,I2,1x,I2,1x,I2,1x,I2)', curr_yr, curr_mo, curr_dy, curr_hr, curr_min ! time check for debugging
!---------------------------------------------------------------------
! Read in the forcing data
! Compiler directive NGEN_FORCING_ACTIVE to be defined if
! Nextgen forcing is being used (https://github.com/NOAA-OWP/ngen)
! If it is defined, Nextgen MUST provide forcing
!---------------------------------------------------------------------
forcing_timestep = domain%dt
#ifndef NGEN_FORCING_ACTIVE
call read_forcing_text(iunit, domain%nowdate, forcing_timestep, &
forcing%UU, forcing%VV, forcing%SFCTMP, forcing%Q2, forcing%SFCPRS, forcing%SOLDN, forcing%LWDN, forcing%PRCP, ierr)
#endif
!---------------------------------------------------------------------
! call the main utility routines
!---------------------------------------------------------------------
call UtilitiesMain (domain%itime, domain, forcing, energy)
!---------------------------------------------------------------------
! call the main forcing routines
!---------------------------------------------------------------------
call ForcingMain (options, parameters, forcing, energy, water)
!---------------------------------------------------------------------
! call the main interception routines
!---------------------------------------------------------------------
call InterceptionMain (domain, levels, options, parameters, forcing, energy, water)
!---------------------------------------------------------------------
! call the main energy balance routines
!---------------------------------------------------------------------
call EnergyMain (domain, levels, options, parameters, forcing, energy, water)
!---------------------------------------------------------------------
! call the main water routines (canopy + snow + soil water components)
!---------------------------------------------------------------------
call WaterMain (domain, levels, options, parameters, forcing, energy, water)
!---------------------------------------------------------------------
! add to output file
! Compiler directive NGEN_OUTPUT_ACTIVE to be defined if
! Nextgen is writing model output (https://github.com/NOAA-OWP/ngen)
!---------------------------------------------------------------------
#ifndef NGEN_OUTPUT_ACTIVE
call add_to_output(domain, water, energy, forcing, domain%itime, levels%nsoil,levels%nsnow)
#endif
end associate ! terminate associate block
END SUBROUTINE solve_noahowp
end module RunModule