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

Last change on this file since 1762 was 1762, checked in by hellstea, 6 years ago

Introduction of nested domain system

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