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

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

update of GPL copyright

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