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

Last change on this file since 965 was 965, checked in by raasch, 9 years ago

last commit documented

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