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

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

last commit documented

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