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

Last change on this file since 668 was 668, checked in by suehring, 11 years ago

last commit documented

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