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

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

last commit documented

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