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

 SUBROUTINE parin

!------------------------------------------------------------------------------!
! Actual revisions:
! -----------------
! 
!
! Former revisions:
! -----------------
! $Log: parin.f90,v $
! Revision 1.57  2007/02/11 13:11:22  raasch
! Values of environment variables are now read from file ENVPAR instead of
! reading them with a system call, + NAMELIST envpar
!
! Revision 1.56  2006/08/22 14:13:56  raasch
! +dz_max in inipar
!
! Revision 1.55  2006/08/04 14:53:43  raasch
! +use_upstream_for_tke
!
! Revision 1.54  2006/03/17 08:45:44  raasch
! +skip_time_data_output_av
!
! Revision 1.53  2006/02/23 12:46:19  raasch
! parameters for 2d/3d averaging,
! +conserve_volume_flow, dissipation_1d, e_min, mixing_length_1d, topography, &
! wall_heatflux in inipar,
! +data_output, netcdf_64bit, skip_time_dosp, skip_time_dopr, etc. in d3par,
! allocation of nanz_2dh and nanz_3d moved to init_3d_model, ebene renamed
! section, average_period_pr1d removed, average_period_pl1d renamed
! averaging_interval_pr, dt_average renamed dt_averaging_input_pr,
! +parameters for single building topography settings
!
! Revision 1.52  2005/06/29 10:21:15  steinfeld
! +ug_surface, ug_vertical_gradient, ug_vertical_gradient_level,
!  vg_surface, vg_vertical_gradient, vg_vertical_gradient_level in inipar;
! arrays ug and vg are allocated during initialization runs
!
! Revision 1.51  2005/06/26 20:06:26  raasch
! +cloud_droplets in inipar
!
! Revision 1.50  2005/05/18 15:40:49  raasch
! +netcdf_precision in inipar, +data_output_format in d3par
!
! Revision 1.49  2005/04/23 09:35:23  raasch
! fcl_factor renamed cfl_factor
!
! Revision 1.48  2005/03/26 20:42:17  raasch
! +bc_lr, bc_ns, call_psolver_at_all_substeps, inflow_disturbance_begin, &
! inflow_disturbance_end, km_damp_max, outflow_damping_width in inipar
!
! Revision 1.47  2004/04/30 12:32:06  raasch
! +grid_matching in inipar, impulse_advec renamed momentum_advec
!
! Revision 1.46  2003/10/29 09:03:06  raasch
! +mg_cycles, mg_switch_to_pe0_level in d3par
!
! Revision 1.45  2003/03/16 09:42:23  raasch
! Two underscores (_) are placed in front of all define-strings
!
! Revision 1.44  2003/03/14 13:45:24  raasch
! +random_generator in inipar
!
! Revision 1.43  2003/03/12 16:35:55  raasch
! Reading of environment variable tasks_per_node moved from poisfft_hybrid
! to here
!
! Revision 1.42  2002/12/19 15:55:31  raasch
! Saving preliminary process-id-string for opening unit 14 (binary output for
! restart). Array hom is allocated during first run only, allocation during
! restart runs will now be done in read_var_list.
! +dt_restart, restart_time in d3par, STOP statement replaced by call of
! subroutine local_stop
!
! Revision 1.41  2002/04/16 08:10:50  raasch
! +bc_s_b, bc_s_t, surface_scalarflux, s_surface, s_surface_initial_change,
! s_vertical_gradient, s_vertical_gradient_level in inipar
!
! Revision 1.40  2001/08/21 09:54:27  raasch
! MPI_COMM_WORLD replaced by comm_palm, +wall_adjustment in inipar
!
! Revision 1.39  2001/07/20 13:10:07  raasch
! +cycle_mg, ngsrb, residual_limit in d3par
!
! Revision 1.38  2001/03/30 07:43:55  raasch
! Translation of remaining German identifiers (variables, subroutines, etc.),
! namelist d3par can also be omitted in the initial run
!
! Revision 1.37  2001/01/29 12:30:26  raasch
! +passive_scalar in inipar
!
! Revision 1.36  2001/01/25 07:17:39  raasch
! +fft_method, use_surface_fluxes in inipar
!
! Revision 1.35  2001/01/02 17:32:13  raasch
! Unit 11 closed at the end of the subroutine
!
! Revision 1.34  2000/12/28 13:24:51  raasch
! Call of package_parin. dt_dvrp and threshold moved
! from d3par to other namelists in subroutine package_parin
!
! Revision 1.33  2000/04/27 06:55:20  raasch
! +npex, npey in initial parameter list, comments have to be translated yet,
! -dt_plisos, dt_plpart, +dt_dvrp, threshold, in run-time parameter list,
! all comments translated into English, old revision remarks deleted
!
! Revision 1.32  2000/04/13 13:03:06  schroeter
! Erweitern der Parameterlist fuer Wolkenphysik
!
! Revision 1.31  2000/01/10  10:05:55  10:05:55  raasch (Siegfried Raasch)
! +use_ug_for_galilei_tr
! 
! Revision 1.1  1997/07/24 11:22:50  raasch
! Initial revision
!
!
! Description:
! ------------
! This subroutine reads variables controling the run from the NAMELIST files
!------------------------------------------------------------------------------!

    USE arrays_3d
    USE averaging
    USE control_parameters
    USE grid_variables
    USE indices
    USE model_1d
    USE pegrid
    USE profil_parameter
    USE statistics

    IMPLICIT NONE

    INTEGER ::  idum


    NAMELIST /inipar/  adjust_mixing_length, alpha_surface, bc_e_b, bc_lr, &
                       bc_ns, bc_p_b, bc_p_t, bc_pt_b, bc_pt_t, bc_q_b, &
                       bc_q_t,bc_s_b, bc_s_t, bc_uv_b, bc_uv_t, &
                       building_height, building_length_x, building_length_y, &
                       building_wall_left, building_wall_south, &
                       cloud_droplets, cloud_physics, conserve_volume_flow, &
                       cut_spline_overshoot, damp_level_1d, dissipation_1d, &
                       dt, dt_pr_1d, dt_run_control_1d, dx, dy, dz, dz_max, &
                       dz_stretch_factor, dz_stretch_level, e_min, &
                       end_time_1d, fft_method, galilei_transformation, &
                       grid_matching, inflow_disturbance_begin, &
                       inflow_disturbance_end, initializing_actions, &
                       km_constant, km_damp_max, long_filter_factor, &
                       mixing_length_1d, moisture, momentum_advec, &
                       netcdf_precision, npex, npey, nsor_ini, nx, ny, nz, &
                       omega, outflow_damping_width, overshoot_limit_e, &
                       overshoot_limit_pt, overshoot_limit_u, &
                       overshoot_limit_v, overshoot_limit_w, passive_scalar, &
                       phi, prandtl_layer, precipitation, pt_surface, &
                       pt_surface_initial_change, pt_vertical_gradient, &
                       pt_vertical_gradient_level, q_surface, &
                       q_surface_initial_change, q_vertical_gradient, &
                       q_vertical_gradient_level, radiation, random_generator, &
                       random_heatflux, rif_max, rif_min, roughness_length, &
                       scalar_advec, statistic_regions, surface_heatflux, &
                       surface_pressure, surface_scalarflux, surface_waterflux,&
                       s_surface, s_surface_initial_change, &
                       s_vertical_gradient, s_vertical_gradient_level, &
                       timestep_scheme, topography, ug_surface, &
                       ug_vertical_gradient, ug_vertical_gradient_level, &
                       ups_limit_e, ups_limit_pt, ups_limit_u, ups_limit_v, &
                       ups_limit_w, use_surface_fluxes, use_ug_for_galilei_tr, &
                       use_upstream_for_tke, vg_surface, vg_vertical_gradient, &
                       vg_vertical_gradient_level, wall_adjustment, &
                       wall_heatflux


    NAMELIST /d3par/   averaging_interval,  averaging_interval_pr, &
                       call_psolver_at_all_substeps, cfl_factor, &
                       create_disturbances, cross_normalized_x, &
                       cross_normalized_y, cross_profiles, cross_ts_uymax, &
                       cross_ts_uymin, cross_xtext, cycle_mg, data_output, &
                       data_output_format, data_output_pr, data_output_ts, &
                       data_output_2d_on_each_pe, disturbance_amplitude, &
                       disturbance_energy_limit, disturbance_level_b, &
                       disturbance_level_t, do2d_at_begin, do3d_at_begin, &
                       do3d_compress, do3d_comp_prec, dt, dt_averaging_input, &
                       dt_averaging_input_pr, dt_data_output, &
                       dt_data_output_av, dt_disturb, dt_dopr, &
                       dt_dopr_listing, dt_dots, dt_do2d_xy, dt_do2d_xz, &
                       dt_do2d_yz, dt_do3d, dt_restart, dt_run_control, &
                       end_time, force_print_header, mg_cycles, &
                       mg_switch_to_pe0_level, netcdf_64bit, ngsrb, &
                       normalizing_region, nsor, nz_do3d, omega_sor, &
                       prandtl_number, profile_columns, profile_rows, psolver, &
                       rayleigh_damping_factor, rayleigh_damping_height, &
                       residual_limit, restart_time, section_xy, section_xz, &
                       section_yz, skip_time_data_output, &
                       skip_time_data_output_av, skip_time_dopr, &
                       skip_time_dosp, skip_time_do2d_xy, skip_time_do2d_xz, &
                       skip_time_do2d_yz, skip_time_do3d, &
                       termination_time_needed, use_prior_plot1d_parameters, &
                       z_max_do1d, z_max_do1d_normalized, z_max_do2d


    NAMELIST /envpar/  host, maximum_cpu_time_allowed, run_identifier, &
                       tasks_per_node, write_binary


#if defined( __parallel )
!
!-- Preliminary determination of processor-id which is needed here to open the
!-- input files belonging to the corresponding processor and to produce
!-- messages by PE0 only (myid and myid_char are later determined in
!-- init_pegrid)
    CALL MPI_COMM_RANK( comm_palm, myid, ierr )
    WRITE (myid_char,'(''_'',I4.4)')  myid
!
!-- Since on IBM machines the process rank may be changed when the final
!-- communicator is defined, save the preliminary processor-id for opening
!-- the binary output file for restarts (unit 14), because otherwise
!-- a mismatch occurs when reading this file in the next job
    myid_char_14 = myid_char
#endif

!
!-- Open the NAMELIST-file which is send with this job
    CALL check_open( 11 )

!
!-- Read the control parameters for initialization.
!-- The namelist "inipar" must be provided in the NAMELIST-file. If this is
!-- not the case and the file contains - instead of "inipar" - any other
!-- namelist, a read error is created on t3e and control is transferred
!-- to the statement with label 10. Therefore, on t3e machines one can not
!-- distinguish between errors produced by a wrong "inipar" namelist or
!-- because this namelist is totally missing.
    READ ( 11, inipar, ERR=10, END=11 )
    GOTO 12
 10 IF ( myid == 0 )  THEN
       PRINT*, '+++ parin: errors in \$inipar'
       PRINT*, '           or no \$inipar-namelist found (CRAY-machines only)' 
    ENDIF
    CALL local_stop
 11 IF ( myid == 0 )  THEN
       PRINT*, '+++ parin: no \$inipar-namelist found'
    ENDIF
    CALL local_stop

!
!-- If required, read control parameters from restart file (produced by
!-- a prior run)
 12 IF ( TRIM( initializing_actions ) == 'read_restart_data' )  THEN

       CALL read_var_list
!
!--    Increment the run count
       runnr = runnr + 1

    ELSE
!
!--    This is not a restart job.
!--    Check, if the grid point numbers are well defined.
       IF ( nx <= 0 )  THEN
          IF ( myid == 0 )  THEN
             PRINT*, '+++ parin: no value or wrong value given for nx: nx=', nx
          ENDIF
          CALL local_stop
       ENDIF
       IF ( ny <= 0 )  THEN
          IF ( myid == 0 )  THEN
             PRINT*, '+++ parin: no value or wrong value given for ny: ny=', ny
          ENDIF
          CALL local_stop
       ENDIF
       IF ( nz <= 0 )  THEN
          IF ( myid == 0 )  THEN
             PRINT*, '+++ parin: no value or wrong value given for nz: nz=', nz
          ENDIF
          CALL local_stop
       ENDIF

!
!--    Allocate arrays which will be already initialized in init_pegrid or
!--    check_parameters. During restart jobs, these arrays will be allocated
!--    in read_var_list. All other arrays are allocated in init_3d_model.
       ALLOCATE( ug(0:nz+1), vg(0:nz+1), &
                 pt_init(0:nz+1), q_init(0:nz+1), u_init(0:nz+1), &
                 v_init(0:nz+1),                                  &
                 hom(0:nz+1,2,var_hom,0:statistic_regions) )
       hom = 0.0

    ENDIF

!
!-- Definition of names of areas used for computing statistics. They must
!-- be defined at this place, because they are allowed to be redefined by
!-- the user in user_parin.
    region = 'total domain'

!
!-- Read runtime parameters given by the user for this run (namelist "d3par").
!-- The namelist "d3par" can be omitted. In that case, default values are
!-- used for the parameters.
    READ ( 11, d3par, END=20 )

!
!-- Read control parameters for optionally used model software packages
 20 CALL package_parin

!
!-- Read user-defined variables
    CALL user_parin

!
!-- NAMELIST-file is not needed anymore
    CALL close_file( 11 )

!
!-- Read values of environment variables (this NAMELIST file is generated by
!-- mrun)
    OPEN ( 90, FILE='ENVPAR', STATUS='OLD', FORM='FORMATTED', ERR=30 )
    READ ( 90, envpar, ERR=31, END=32 )
    CLOSE ( 90 )
    RETURN

 30 IF ( myid == 0 )  THEN
       PRINT*, '+++ parin: WARNING: local file ENVPAR not found'
       PRINT*, '           some variables for steering may not be properly set'
    ENDIF
    RETURN

 31 IF ( myid == 0 )  THEN
       PRINT*, '+++ parin: WARNING: errors in local file ENVPAR'
       PRINT*, '           some variables for steering may not be properly set'
    ENDIF
    RETURN

 32 IF ( myid == 0 )  THEN
       PRINT*, '+++ parin: WARNING: no envpar-NAMELIST found in local file ', &
                           'ENVPAR'
       PRINT*, '           some variables for steering may not be properly set'
    ENDIF

 END SUBROUTINE parin