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

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

last commit documented / copyright update

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