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

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

unused variables remove from several routines

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