source: palm/trunk/SOURCE/parin.f90 @ 1826

Last change on this file since 1826 was 1826, checked in by maronga, 5 years ago

further modularization of radiation model and plant canopy model

  • Property svn:keywords set to Id
File size: 22.9 KB
Line 
1!> @file parin.f90
2!--------------------------------------------------------------------------------!
3! This file is part of PALM.
4!
5! PALM is free software: you can redistribute it and/or modify it under the terms
6! of the GNU General Public License as published by the Free Software Foundation,
7! either version 3 of the License, or (at your option) any later version.
8!
9! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
10! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
11! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
12!
13! You should have received a copy of the GNU General Public License along with
14! PALM. If not, see <http://www.gnu.org/licenses/>.
15!
16! Copyright 1997-2016 Leibniz Universitaet Hannover
17!--------------------------------------------------------------------------------!
18!
19! Current revisions:
20! -----------------
21! Added call to radiation model for reading of &radiation_par.
22! Added call to plant canopy model for reading of &canopy_par.
23!
24! Former revisions:
25! -----------------
26! $Id: parin.f90 1826 2016-04-07 12:01:39Z maronga $
27!
28! 1817 2016-04-06 15:44:20Z maronga
29! Added call to land surface model for reading of &lsm_par
30!
31! 1804 2016-04-05 16:30:18Z maronga
32! Removed code for parameter file check (__check)
33!
34! 1783 2016-03-06 18:36:17Z raasch
35! +netcdf_deflate in d3par, netcdf module and variable names changed
36!
37! 1764 2016-02-28 12:45:19Z raasch
38! cpp-statements for nesting removed, explicit settings of boundary conditions
39! in nest domains,
40! bugfix: npex/npey message moved from inipar to d3par
41! bugfix: check of lateral boundary conditions from check_parameters to here,
42! because they will be already used in init_pegrid and init_grid
43!
44! 1762 2016-02-25 12:31:13Z hellstea
45! Introduction of nested domain feature
46!
47! 1691 2015-10-26 16:17:44Z maronga
48! Added parameter most_method. Renamed prandtl_layer to constant_flux_layer.
49!
50! 1682 2015-10-07 23:56:08Z knoop
51! Code annotations made doxygen readable
52!
53! 1560 2015-03-06 10:48:54Z keck
54! +recycling_yshift
55!
56! 1496 2014-12-02 17:25:50Z maronga
57! Renamed: "radiation -> "cloud_top_radiation"
58!
59! 1484 2014-10-21 10:53:05Z kanani
60! Changes due to new module structure of the plant canopy model:
61!   canopy-model related parameters moved to new package canopy_par in
62!   subroutine package_parin
63!
64! 1429 2014-07-15 12:53:45Z knoop
65! +ensemble_member_nr to prepare the random_generator for ensemble runs
66!
67! 1402 2014-05-09 14:25:13Z raasch
68! location messages modified, batch_job included in envpar-NAMELIST
69!
70! 1384 2014-05-02 14:31:06Z raasch
71! location messages added
72!
73! 1365 2014-04-22 15:03:56Z boeske
74! Usage of large scale forcing enabled:
75! +use_subsidence_tendencies
76!
77! 1361 2014-04-16 15:17:48Z hoffmann
78! +call_microphysics_at_all_substeps
79!
80! 1359 2014-04-11 17:15:14Z hoffmann
81! REAL constants provided with KIND-attribute
82!
83! 1353 2014-04-08 15:21:23Z heinze
84! REAL constants provided with KIND-attribute
85!
86! 1327 2014-03-21 11:00:16Z raasch
87! -data_output_format, do3d_compress, do3d_comp_prec
88!
89! 1320 2014-03-20 08:40:49Z raasch
90! ONLY-attribute added to USE-statements,
91! kind-parameters added to all INTEGER and REAL declaration statements,
92! kinds are defined in new module kinds,
93! old module precision_kind is removed,
94! revision history before 2012 removed,
95! comment fields (!:) to be used for variable explanations added to
96! all variable declaration statements
97!
98! 1318 2014-03-17 13:35:16Z raasch
99! +cpu_log_barrierwait in d3par
100!
101! 1301 2014-03-06 13:29:46Z heinze
102! +large_scale_subsidence
103!
104! 1241 2013-10-30 11:36:58Z heinze
105! +nudging
106! +large_scale_forcing
107!
108! 1216 2013-08-26 09:31:42Z raasch
109! +transpose_compute_overlap in inipar
110!
111! 1195 2013-07-01 12:27:57Z heinze
112! Bugfix: allocate ref_state
113!
114! 1179 2013-06-14 05:57:58Z raasch
115! +reference_state in inipar
116!
117! 1159 2013-05-21 11:58:22Z fricke
118! +use_cmax
119!
120! 1128 2013-04-12 06:19:32Z raasch
121! +background_communication in inipar
122!
123! 1115 2013-03-26 18:16:16Z hoffmann
124! unused variables removed
125!
126! 1092 2013-02-02 11:24:22Z raasch
127! unused variables removed
128!
129! 1065 2012-11-22 17:42:36Z hoffmann
130! +nc, c_sedimentation, limiter_sedimentation, turbulence
131! -mu_constant, mu_constant_value
132!
133! 1053 2012-11-13 17:11:03Z hoffmann
134! necessary expansions according to the two new prognostic equations (nr, qr)
135! of the two-moment cloud physics scheme and steering parameters:
136! +*_init, *_surface, *_surface_initial_change, *_vertical_gradient,
137! +*_vertical_gradient_level, surface_waterflux_*,
138! +cloud_scheme, drizzle, mu_constant, mu_constant_value, ventilation_effect
139!
140! 1036 2012-10-22 13:43:42Z raasch
141! code put under GPL (PALM 3.9)
142!
143! 1015 2012-09-27 09:23:24Z raasch
144! -adjust_mixing_length
145!
146! 1003 2012-09-14 14:35:53Z raasch
147! -grid_matching
148!
149! 1001 2012-09-13 14:08:46Z raasch
150! -cut_spline_overshoot, long_filter_factor, overshoot_limit_*, ups_limit_*
151!
152! 996 2012-09-07 10:41:47Z raasch
153! -use_prior_plot1d_parameters
154!
155! 978 2012-08-09 08:28:32Z fricke
156! -km_damp_max, outflow_damping_width
157! +pt_damping_factor, pt_damping_width
158! +z0h_factor
159!
160! 964 2012-07-26 09:14:24Z raasch
161! -cross_normalized_x, cross_normalized_y, cross_xtext, z_max_do1d,
162! z_max_do1d_normalized
163!
164! 940 2012-07-09 14:31:00Z raasch
165! +neutral in inipar
166!
167! 927 2012-06-06 19:15:04Z raasch
168! +masking_method in inipar
169!
170! 824 2012-02-17 09:09:57Z raasch
171! +curvature_solution_effects in inipar
172!
173! 809 2012-01-30 13:32:58Z maronga
174! Bugfix: replaced .AND. and .NOT. with && and ! in the preprocessor directives
175!
176! 807 2012-01-25 11:53:51Z maronga
177! New cpp directive "__check" implemented which is used by check_namelist_files
178!
179! Revision 1.1  1997/07/24 11:22:50  raasch
180! Initial revision
181!
182!
183! Description:
184! ------------
185!> This subroutine reads variables controling the run from the NAMELIST files
186!------------------------------------------------------------------------------!
187 SUBROUTINE parin
188 
189
190    USE arrays_3d,                                                             &
191        ONLY:  pt_init, q_init, ref_state, sa_init, ug, u_init, v_init,        &
192               vg
193
194    USE plant_canopy_model_mod,                                                &
195         ONLY: pcm_parin 
196 
197    USE cloud_parameters,                                                      &
198        ONLY:  c_sedimentation, curvature_solution_effects,                    &
199               limiter_sedimentation, nc_const, ventilation_effect
200
201    USE control_parameters
202
203    USE cpulog,                                                                &
204        ONLY:  cpu_log_barrierwait
205
206    USE dvrp_variables,                                                        &
207        ONLY:  local_dvrserver_running
208
209    USE grid_variables,                                                        &
210        ONLY:  dx, dy
211
212    USE indices,                                                               &
213        ONLY:  nx, ny, nz
214
215    USE kinds
216
217    USE land_surface_model_mod,                                                &
218        ONLY: lsm_parin
219   
220    USE model_1d,                                                              &
221        ONLY:  damp_level_1d, dt_pr_1d, dt_run_control_1d, end_time_1d
222
223    USE pegrid
224
225    USE netcdf_interface,                                                      &
226        ONLY:  netcdf_data_format, netcdf_deflate, netcdf_precision
227
228    USE pmc_interface,                                                         &
229        ONLY:  nested_run
230
231    USE profil_parameter,                                                      &
232        ONLY:  cross_profiles, cross_ts_uymax, cross_ts_uymin,                 &
233               profile_columns, profile_rows
234
235    USE progress_bar,                                                          &
236        ONLY :  batch_job
237
238     USE radiation_model_mod,                                                  &
239         ONLY: radiation_parin 
240       
241    USE statistics,                                                            &
242        ONLY:  hom, hom_sum, pr_palm, region, statistic_regions
243
244
245    IMPLICIT NONE
246
247    INTEGER(iwp) ::  i   !<
248
249
250    NAMELIST /inipar/  alpha_surface, background_communication, bc_e_b, bc_lr, &
251                       bc_ns, bc_p_b, bc_p_t, bc_pt_b, bc_pt_t, bc_q_b,        &
252             bc_q_t,bc_s_b, bc_s_t, bc_sa_t, bc_uv_b, bc_uv_t,                 &
253             bottom_salinityflux, building_height, building_length_x,          &
254             building_length_y, building_wall_left, building_wall_south,       &
255             call_psolver_at_all_substeps, call_microphysics_at_all_substeps,  &
256             canyon_height,                                                    &
257             canyon_width_x, canyon_width_y, canyon_wall_left,                 &
258             canyon_wall_south, c_sedimentation, cfl_factor, cloud_droplets,   &
259             cloud_physics, cloud_scheme, cloud_top_radiation,                 &
260             collective_wait, conserve_volume_flow,                            &
261             conserve_volume_flow_mode, constant_flux_layer,                   &
262             coupling_start_time,                                              &
263             curvature_solution_effects, cycle_mg, damp_level_1d,              &
264             dissipation_1d,                                                   &
265             dp_external, dp_level_b, dp_smooth, dpdxy,                        &
266             drizzle, dt, dt_pr_1d, dt_run_control_1d, dx, dy, dz, dz_max,     & 
267             dz_stretch_factor, dz_stretch_level, end_time_1d,                 &
268             ensemble_member_nr,                                               &
269             e_init, e_min, fft_method, galilei_transformation, humidity,      &
270             inflow_damping_height, inflow_damping_width,                      &
271             inflow_disturbance_begin, inflow_disturbance_end,                 &
272             initializing_actions, km_constant,                                &
273             large_scale_forcing, large_scale_subsidence,                      &
274             limiter_sedimentation,                                            &
275             loop_optimization, masking_method, mg_cycles,                     &
276             mg_switch_to_pe0_level, mixing_length_1d, momentum_advec,         &
277             most_method, nc_const, netcdf_precision, neutral, ngsrb,          &
278             nsor, nsor_ini, nudging, nx, ny, nz, ocean, omega, omega_sor,     &
279             passive_scalar, phi,                                              &
280             prandtl_number, precipitation, psolver, pt_damping_factor,        &
281             pt_damping_width, pt_reference, pt_surface,                       &
282             pt_surface_initial_change, pt_vertical_gradient,                  &
283             pt_vertical_gradient_level, q_surface, q_surface_initial_change,  &
284             q_vertical_gradient, q_vertical_gradient_level,                   &
285             random_generator, random_heatflux,                                &
286             rayleigh_damping_factor, rayleigh_damping_height,                 &
287             recycling_width, recycling_yshift,                                &
288             reference_state, residual_limit,                                  &
289             roughness_length, sa_surface,                                     &
290             sa_vertical_gradient, sa_vertical_gradient_level, scalar_advec,   &
291             scalar_rayleigh_damping,                                          &
292             statistic_regions, subs_vertical_gradient,                        &
293             subs_vertical_gradient_level, surface_heatflux, surface_pressure, &
294             surface_scalarflux, surface_waterflux,                            &
295             s_surface, s_surface_initial_change, s_vertical_gradient,         &
296             s_vertical_gradient_level, timestep_scheme,                       &
297             topography, topography_grid_convention, top_heatflux,             &
298             top_momentumflux_u, top_momentumflux_v, top_salinityflux,         &
299             transpose_compute_overlap, turbulence, turbulent_inflow,          &
300             use_subsidence_tendencies, ug_surface, ug_vertical_gradient,      &
301             ug_vertical_gradient_level, use_surface_fluxes, use_cmax,         &
302             use_top_fluxes, use_ug_for_galilei_tr, use_upstream_for_tke,      &
303             uv_heights, u_bulk, u_profile, vg_surface, vg_vertical_gradient,  &
304             vg_vertical_gradient_level, v_bulk, v_profile, ventilation_effect,&
305             wall_adjustment, wall_heatflux, wall_humidityflux,                &
306             wall_scalarflux, zeta_max, zeta_min, z0h_factor
307     
308    NAMELIST /d3par/  averaging_interval, averaging_interval_pr,               &
309             cpu_log_barrierwait, create_disturbances,                         &
310             cross_profiles, cross_ts_uymax, cross_ts_uymin,                   &
311             data_output, data_output_masks,                                   &
312             data_output_pr, data_output_2d_on_each_pe, disturbance_amplitude, &
313             disturbance_energy_limit, disturbance_level_b,                    &
314             disturbance_level_t, do2d_at_begin, do3d_at_begin,                &
315             dt, dt_averaging_input, dt_averaging_input_pr,                    &
316             dt_coupling, dt_data_output, dt_data_output_av, dt_disturb,       &
317             dt_domask, dt_dopr, dt_dopr_listing, dt_dots, dt_do2d_xy,         &
318             dt_do2d_xz, dt_do2d_yz, dt_do3d, dt_max, dt_restart,              &
319             dt_run_control,end_time, force_print_header, mask_scale_x,        &
320             mask_scale_y, mask_scale_z, mask_x, mask_y, mask_z, mask_x_loop,  &
321             mask_y_loop, mask_z_loop, netcdf_data_format, netcdf_deflate,     &
322             normalizing_region, npex, npey, nz_do3d,                          &
323             precipitation_amount_interval, profile_columns, profile_rows,     &
324             restart_time, section_xy, section_xz, section_yz,                 &
325             skip_time_data_output, skip_time_data_output_av, skip_time_dopr,  &
326             skip_time_do2d_xy, skip_time_do2d_xz, skip_time_do2d_yz,          &
327             skip_time_do3d, skip_time_domask, synchronous_exchange,           &
328             termination_time_needed, z_max_do2d
329
330
331    NAMELIST /envpar/  batch_job, host, local_dvrserver_running,               &
332                       maximum_cpu_time_allowed, maximum_parallel_io_streams,  &
333                       revision, return_addres, return_username,               &
334                       run_identifier, tasks_per_node, write_binary
335
336!
337!-- First read values of environment variables (this NAMELIST file is
338!-- generated by mrun)
339    CALL location_message( 'reading environment parameters from ENVPAR', .FALSE. )
340    OPEN ( 90, FILE='ENVPAR', STATUS='OLD', FORM='FORMATTED', ERR=30 )
341    READ ( 90, envpar, ERR=31, END=32 )
342    CLOSE ( 90 )
343    CALL location_message( 'finished', .TRUE. )
344
345!
346!-- Calculate the number of groups into which parallel I/O is split.
347!-- The default for files which are opened by all PEs (or where each
348!-- PE opens his own independent file) is, that all PEs are doing input/output
349!-- in parallel at the same time. This might cause performance or even more
350!-- severe problems depending on the configuration of the underlying file
351!-- system.
352!-- First, set the default:
353    IF ( maximum_parallel_io_streams == -1  .OR.                               &
354         maximum_parallel_io_streams > numprocs )  THEN
355       maximum_parallel_io_streams = numprocs
356    ENDIF
357!
358!-- Now calculate the number of io_blocks and the io_group to which the
359!-- respective PE belongs. I/O of the groups is done in serial, but in parallel
360!-- for all PEs belonging to the same group.
361!-- These settings are repeated in init_pegrid for the communicator comm2d,
362!-- which is not available here
363    io_blocks = numprocs / maximum_parallel_io_streams
364    io_group  = MOD( myid+1, io_blocks )
365
366    CALL location_message( 'reading NAMELIST parameters from PARIN', .FALSE. )
367!
368!-- Data is read in parallel by groups of PEs
369    DO  i = 0, io_blocks-1
370       IF ( i == io_group )  THEN
371
372!
373!--       Open the NAMELIST-file which is send with this job
374          CALL check_open( 11 )
375
376!
377!--       Read the control parameters for initialization.
378!--       The namelist "inipar" must be provided in the NAMELIST-file.
379          READ ( 11, inipar, ERR=10, END=11 )
380
381          GOTO 12
382
383 10       message_string = 'errors in \$inipar &or no \$inipar-namelist ' //   &
384                           'found (CRAY-machines only)'
385          CALL message( 'parin', 'PA0271', 1, 2, 0, 6, 0 )
386
387 11       message_string = 'no \$inipar-namelist found'
388          CALL message( 'parin', 'PA0272', 1, 2, 0, 6, 0 )
389
390!
391!--       If required, read control parameters from restart file (produced by
392!--       a prior run). All PEs are reading from file created by PE0 (see
393!--       check_open)
394 12       IF ( TRIM( initializing_actions ) == 'read_restart_data' )  THEN
395             CALL read_var_list
396!
397!--          The restart file will be reopened when reading the subdomain data
398             CALL close_file( 13 )
399
400!
401!--          Increment the run count
402             runnr = runnr + 1
403          ENDIF
404
405!
406!--       In case of nested runs, explicitly set nesting boundary conditions
407!--       except for the root domain. This will overwrite the user settings.
408          IF ( nest_domain )  THEN
409             bc_lr   = 'nested'
410             bc_ns   = 'nested'
411             bc_uv_t = 'nested'
412             bc_pt_t = 'nested'
413             bc_p_t  = 'neumann'
414          ENDIF
415!
416!--       Check validity of lateral boundary conditions. This has to be done
417!--       here because they are already used in init_pegrid and init_grid and
418!--       therefore cannot be check in check_parameters
419          IF ( bc_lr /= 'cyclic'  .AND.  bc_lr /= 'dirichlet/radiation'  .AND. &
420               bc_lr /= 'radiation/dirichlet'  .AND.  bc_lr /= 'nested' )  THEN
421             message_string = 'unknown boundary condition: bc_lr = "' // &
422                              TRIM( bc_lr ) // '"'
423             CALL message( 'check_parameters', 'PA0049', 1, 2, 0, 6, 0 )
424          ENDIF
425          IF ( bc_ns /= 'cyclic'  .AND.  bc_ns /= 'dirichlet/radiation'  .AND. &
426               bc_ns /= 'radiation/dirichlet'  .AND.  bc_ns /= 'nested' )  THEN
427             message_string = 'unknown boundary condition: bc_ns = "' // &
428                              TRIM( bc_ns ) // '"'
429             CALL message( 'check_parameters', 'PA0050', 1, 2, 0, 6, 0 )
430          ENDIF
431
432!
433!--       Set internal variables used for speed optimization in if clauses
434          IF ( bc_lr /= 'cyclic' )               bc_lr_cyc    = .FALSE.
435          IF ( bc_lr == 'dirichlet/radiation' )  bc_lr_dirrad = .TRUE.
436          IF ( bc_lr == 'radiation/dirichlet' )  bc_lr_raddir = .TRUE.
437          IF ( bc_ns /= 'cyclic' )               bc_ns_cyc    = .FALSE.
438          IF ( bc_ns == 'dirichlet/radiation' )  bc_ns_dirrad = .TRUE.
439          IF ( bc_ns == 'radiation/dirichlet' )  bc_ns_raddir = .TRUE.
440
441!
442!--       Definition of names of areas used for computing statistics. They must
443!--       be defined at this place, because they are allowed to be redefined by
444!--       the user in user_parin.
445          region = 'total domain'
446
447!
448!--       Read runtime parameters given by the user for this run (namelist
449!--       "d3par"). The namelist "d3par" can be omitted. In that case, default
450!--       values are used for the parameters.
451          READ ( 11, d3par, END=20 )
452
453          IF ( nested_run )  THEN
454!
455!--          In nested domains, npex or npey can not be given in the d3par-
456!--          NAMELIST because here the PE-grids are always defined in the
457!--          nestpar-NAMELIST. Settings will be ignored.
458             IF ( ( npex /= -1 ) .OR. ( npey /= -1 ) )  THEN
459                message_string = 'npex or npey can not be given in \$d3par ' // &
460                                 'for nested runs & they will be ignored'
461                CALL message( 'parin', 'PA0352', 0, 1, 0, 6, 0 )
462             ENDIF
463          ENDIF
464
465         
466!
467!--       Check if land surface model is used and read &lsm_par if required
468          CALL lsm_parin
469 
470!
471!--       Check if radiation model is used and read &radiation_par if required
472          CALL radiation_parin
473 
474 
475!--       Check if plant canopy model is used and read &canopy_par if required
476          CALL pcm_parin
477 
478!
479!--       Read control parameters for optionally used model software packages
480 20       CALL package_parin
481
482!
483!--       Read user-defined variables
484          CALL user_parin
485
486!
487!--       Check in case of initial run, if the grid point numbers are well
488!--       defined and allocate some arrays which are already needed in
489!--       init_pegrid or check_parameters. During restart jobs, these arrays
490!--       will be allocated in read_var_list. All other arrays are allocated
491!--       in init_3d_model.
492          IF ( TRIM( initializing_actions ) /= 'read_restart_data' )  THEN
493
494             IF ( nx <= 0 )  THEN
495                WRITE( message_string, * ) 'no value or wrong value given',    &
496                                           ' for nx: nx=', nx
497                CALL message( 'parin', 'PA0273', 1, 2, 0, 6, 0 )
498             ENDIF
499             IF ( ny <= 0 )  THEN
500                WRITE( message_string, * ) 'no value or wrong value given',    &
501                                           ' for ny: ny=', ny
502                CALL message( 'parin', 'PA0274', 1, 2, 0, 6, 0 )
503             ENDIF
504             IF ( nz <= 0 )  THEN
505                WRITE( message_string, * ) 'no value or wrong value given',    &
506                                           ' for nz: nz=', nz
507                CALL message( 'parin', 'PA0275', 1, 2, 0, 6, 0 )
508             ENDIF
509!
510!--          ATTENTION: in case of changes to the following statement please
511!--                  also check the allocate statement in routine read_var_list
512             ALLOCATE( pt_init(0:nz+1), q_init(0:nz+1),                       &
513                       ref_state(0:nz+1), sa_init(0:nz+1), ug(0:nz+1),         &
514                       u_init(0:nz+1), v_init(0:nz+1), vg(0:nz+1),             &
515                       hom(0:nz+1,2,pr_palm+max_pr_user,0:statistic_regions),  &
516                       hom_sum(0:nz+1,pr_palm+max_pr_user,0:statistic_regions) )
517
518             hom = 0.0_wp
519
520          ENDIF
521
522!
523!--       NAMELIST-file is not needed anymore
524          CALL close_file( 11 )
525
526       ENDIF
527#if defined( __parallel )
528       CALL MPI_BARRIER( MPI_COMM_WORLD, ierr )
529#endif
530    ENDDO
531
532    CALL location_message( 'finished', .TRUE. )
533
534    RETURN
535
536 30 message_string = 'local file ENVPAR not found' //                          &
537                     '&some variables for steering may not be properly set'
538    CALL message( 'parin', 'PA0276', 0, 1, 0, 6, 0 )
539    RETURN
540
541 31 message_string = 'errors in local file ENVPAR' //                          &
542                     '&some variables for steering may not be properly set'
543    CALL message( 'parin', 'PA0277', 0, 1, 0, 6, 0 )
544    RETURN
545
546 32 message_string = 'no envpar-NAMELIST found in local file ENVPAR'  //       &
547                     '&some variables for steering may not be properly set'
548    CALL message( 'parin', 'PA0278', 0, 1, 0, 6, 0 )
549
550 END SUBROUTINE parin
Note: See TracBrowser for help on using the repository browser.