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

Last change on this file since 1217 was 1217, checked in by raasch, 8 years ago

last commit documented

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