source: palm/tags/release-3.8/SOURCE/parin.f90 @ 4343

Last change on this file since 4343 was 684, checked in by raasch, 10 years ago

last commit documented

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