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

Last change on this file since 1765 was 1765, checked in by raasch, 7 years ago

last commit documented

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