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

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

cloud physics variables renamed

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