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

Last change on this file since 1832 was 1832, checked in by hoffmann, 5 years ago

last commit documented

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