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

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

last commit documented, rc-file for example run updated

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