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

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

last commit documented

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