mod_rm_prep.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
#include "scalelib.h"
module mod_rm_prep
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_io
  use scale_atmos_grid_cartesc_index
  use scale_prof
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ included parameters
  !
#include "scale-rm.h"
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  public :: rm_prep
 
  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  character(len=H_MID), private, parameter :: MODELNAME = "SCALE-RM ver. "//version
 
  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  subroutine rm_prep( &
       comm_world, &
       cnf_fname,  &
       path,       &
       add_path    )
    use scale_file, only: &
       file_finalize, &
       file_close_all
    use scale_prc, only: &
       prc_local_setup
    use scale_prc_cartesc, only: &
       prc_cartesc_setup, &
       prc_cartesc_finalize
    use scale_const, only: &
       tem00  => const_tem00, &
       lhv0   => const_lhv0, &
       lhf0   => const_lhf0, &
       rdry   => const_rdry, &
       rvap   => const_rvap, &
       cl     => const_cl, &
       ci     => const_ci, &
       karman => const_karman, &
       grav   => const_grav, &
       stb    => const_stb, &
       const_setup, &
       const_finalize
    use scale_atmos_solarins, only: &
       solarins_constant => atmos_solarins_constant
    use scale_calendar, only: &
       calendar_setup
    use scale_random, only: &
       random_setup, &
       random_finalize
    use scale_tracer, only: &
       tracer_finalize
    use scale_atmos_grid_cartesc_index, only: &
       atmos_grid_cartesc_index_setup, &
       ia, ja
    use scale_atmos_grid_cartesc, only: &
       atmos_grid_cartesc_setup, &
       atmos_grid_cartesc_finalize, &
       domain_center_y => atmos_grid_cartesc_domain_center_y, &
       cy => atmos_grid_cartesc_cy, &
       dx, dy
    use scale_comm_cartesc_nest, only: &
       comm_cartesc_nest_setup, &
       comm_cartesc_nest_finalize
    use scale_ocean_grid_cartesc_index, only: &
       ocean_grid_cartesc_index_setup
    use scale_ocean_grid_cartesc, only: &
       ocean_grid_cartesc_setup, &
       ocean_grid_cartesc_finalize
    use scale_ocean_grid_cartesc_real, only: &
       ocean_grid_cartesc_real_setup, &
       ocean_grid_cartesc_real_finalize, &
       ocean_grid_cartesc_real_set_areavol
    use scale_land_grid_cartesc_index, only: &
       land_grid_cartesc_index_setup
    use scale_land_grid_cartesc, only: &
       land_grid_cartesc_setup, &
       land_grid_cartesc_finalize
    use scale_land_grid_cartesc_real, only: &
       land_grid_cartesc_real_setup, &
       land_grid_cartesc_real_finalize, &
       land_grid_cartesc_real_set_areavol
    use scale_urban_grid_cartesc_index, only: &
       urban_grid_cartesc_index_setup
    use scale_urban_grid_cartesc, only: &
       urban_grid_cartesc_setup, &
       urban_grid_cartesc_finalize
    use scale_urban_grid_cartesc_real, only: &
       urban_grid_cartesc_real_setup, &
       urban_grid_cartesc_real_finalize, &
       urban_grid_cartesc_real_set_areavol
    use scale_file_cartesc, only: &
       file_cartesc_setup, &
       file_cartesc_finalize
    use scale_file_grads, only: &
       file_grads_finalize
    use scale_comm_cartesc, only: &
       comm_setup,  &
       comm_regist, &
       comm_finalize
    use scale_topography, only: &
       topography_setup, &
       topography_write, &
       topography_finalize
    use scale_landuse, only: &
       landuse_setup, &
       landuse_write, &
       landuse_finalize
    use scale_atmos_grid_cartesc_real, only: &
       atmos_grid_cartesc_real_setup,        &
       atmos_grid_cartesc_real_calc_z,       &
       atmos_grid_cartesc_real_calc_areavol, &
       real_lat => atmos_grid_cartesc_real_lat, &
       atmos_grid_cartesc_real_finalize
    use scale_atmos_grid_cartesc_metric, only: &
       atmos_grid_cartesc_metric_setup, &
       atmos_grid_cartesc_metric_finalize, &
       atmos_grid_cartesc_metric_mapf
    use scale_statistics, only: &
       statistics_setup
    use scale_coriolis, only: &
       coriolis_setup, &
       coriolis_finalize
    use scale_atmos_hydrostatic, only: &
       atmos_hydrostatic_setup
    use scale_atmos_thermodyn, only: &
       atmos_thermodyn_setup
    use scale_atmos_hydrometeor, only: &
       atmos_hydrometeor_setup, &
       atmos_hydrometeor_finalize
    use scale_atmos_saturation, only: &
       atmos_saturation_setup
    use scale_bulkflux, only: &
       bulkflux_setup
    use mod_atmos_driver, only: &
       atmos_driver_tracer_setup
    use mod_admin_restart, only: &
       admin_restart_setup
    use mod_admin_versioncheck, only: &
       admin_versioncheck
    use mod_admin_time, only: &
       admin_time_setup
    use mod_atmos_admin, only: &
       atmos_admin_setup, &
       atmos_phy_mp_type, &
       atmos_do
    use mod_atmos_vars, only: &
       atmos_vars_setup, &
       atmos_vars_finalize
    use mod_atmos_phy_mp_vars, only: &
       qa_mp
    use mod_ocean_admin, only: &
       ocean_admin_setup, &
       ocean_do
    use mod_ocean_vars, only: &
       ocean_vars_setup, &
       ocean_vars_finalize
    use mod_land_admin, only: &
       land_admin_setup, &
       land_do
    use mod_land_vars, only: &
       land_vars_setup, &
       land_vars_finalize
    use mod_urban_admin, only: &
       urban_admin_setup, &
       urban_do, &
       urban_land
    use mod_urban_vars, only: &
       urban_vars_setup, &
       urban_vars_finalize
    use mod_lake_admin, only: &
       lake_admin_setup, &
       lake_do
    use mod_cpl_admin, only: &
       cpl_admin_setup, &
       cpl_sw
    use mod_cpl_vars, only: &
       cpl_vars_setup, &
       cpl_vars_finalize
    use mod_convert, only: &
       convert_setup, &
       convert
    use mod_mktopo, only: &
       mktopo_setup, &
       mktopo
    use mod_mkinit, only: &
       mkinit_setup, &
       mkinit_finalize, &
       mkinit
    use mod_user, only: &
       user_tracer_setup, &
       user_setup,    &
       user_finalize, &
       user_mkinit
    use mod_atmos_driver, only: &
       atmos_surface_get, &
       atmos_driver_setup, &
       atmos_driver_finalize
    use mod_ocean_driver, only: &
       ocean_surface_set
    use mod_land_driver, only: &
       land_surface_set
    use mod_urban_driver, only: &
       urban_surface_set
    use mod_admin_restart, only: &
       admin_restart_write
    use mod_admin_time, only: &
       time_doatmos_restart,  &
       time_doland_restart,   &
       time_dourban_restart,  &
       time_doocean_restart
#ifdef JMAPPLIB
    use pp_print_parm, only: &
       pp_print_parm_set_flg_out_msg
    use pp_phys_const, only: &
       pp_phys_const_set
#endif
    implicit none
 
    integer,          intent(in) :: comm_world
    character(len=*), intent(in) :: cnf_fname
    character(len=*), intent(in) :: path
    logical,          intent(in) :: add_path
 
    integer :: myrank
    logical :: ismaster
 
    logical :: output
 
    integer :: id
    !---------------------------------------------------------------------------
 
    !########## Initial setup ##########
 
    ! setup standard I/O
    if ( add_path .and. path /= "" ) then
       call io_setup( modelname, trim(path)//cnf_fname, prefix=path )
    else
       call io_setup( modelname, trim(path)//cnf_fname )
    end if
 
    ! setup MPI
    call prc_local_setup( comm_world, & ! [IN]
                          myrank,     & ! [OUT]
                          ismaster    ) ! [OUT]
 
    ! setup Log
    call io_log_setup( myrank, ismaster )
 
    ! namelist compatibility check
    call admin_versioncheck
 
    ! setup process
    call prc_cartesc_setup
 
    ! setup PROF
    call prof_setup
 
 
    ! profiler start
    call prof_setprefx('INIT')
    call prof_rapstart('Initialize', 0)
 
 
    ! setup constants
    call const_setup
 
    ! setup calendar
    call calendar_setup
 
    ! setup random number
    call random_setup
 
    ! setup submodel administrator
    call atmos_admin_setup
    call ocean_admin_setup
    call land_admin_setup
    call urban_admin_setup
    call lake_admin_setup
    call cpl_admin_setup
 
    ! setup horizontal/vertical grid coordinates (cartesian,idealized)
    if ( atmos_do ) then
       call atmos_grid_cartesc_index_setup
       call atmos_grid_cartesc_setup
    end if
 
    if ( ocean_do ) then
       call ocean_grid_cartesc_index_setup
       call ocean_grid_cartesc_setup
    end if
 
    if ( land_do ) then
       call land_grid_cartesc_index_setup
       call land_grid_cartesc_setup
    end if
 
    if ( urban_do ) then
       call urban_grid_cartesc_index_setup
       call urban_grid_cartesc_setup
    end if
 
    ! setup tracer index
    call atmos_hydrometeor_setup
    call atmos_driver_tracer_setup
    call user_tracer_setup
 
    ! setup file I/O
    call file_cartesc_setup
 
    ! setup mpi communication
    call comm_setup
    call comm_regist( ka, ia, ja, ihalo, jhalo, id )
 
    ! setup topography
    call topography_setup
    ! setup land use category index/fraction
    call landuse_setup( ocean_do, (.not. urban_land), lake_do )
 
    ! setup grid coordinates (real world)
    if ( atmos_do ) call atmos_grid_cartesc_real_setup
    if ( ocean_do ) call ocean_grid_cartesc_real_setup
    if ( land_do  ) call land_grid_cartesc_real_setup
    if ( urban_do ) call urban_grid_cartesc_real_setup
 
    ! setup restart
    call admin_restart_setup
    ! setup time
    call admin_time_setup( setup_timeintegration = .false. )
    ! setup statistics
    call statistics_setup
 
    ! setup nesting grid
    call comm_cartesc_nest_setup( qa_mp, atmos_phy_mp_type )
 
    ! setup coriolis parameter
    call coriolis_setup( ia, ja, real_lat(:,:), cy(:), domain_center_y )
 
    ! setup common tools
    call atmos_hydrostatic_setup
    call atmos_thermodyn_setup
    call atmos_saturation_setup
 
#ifdef JMAPPLIB
    call pp_print_parm_set_flg_out_msg( 0 )
    call pp_phys_const_set( &
         tkelvn_in = tem00, &
         hlatnt_in = lhv0, &
         hlf_in    = lhf0, &
         rd_in     = rdry, &
         rv_in     = rvap, &
         cwater_in = cl, &
         cice_in   = ci, &
         vkman_in  = karman, &
         grav_in   = grav, &
         stb_in    = stb, &
         sc0_in    = solarins_constant)
#endif
 
    call bulkflux_setup( sqrt(dx**2+dy**2) )
 
    ! setup variable container
    if ( atmos_do ) call atmos_vars_setup
    if ( ocean_do ) call ocean_vars_setup
    if ( land_do  ) call land_vars_setup
    if ( urban_do ) call urban_vars_setup
    if ( cpl_sw   ) call cpl_vars_setup
 
    ! setup driver
    if ( atmos_do ) call atmos_driver_setup( .true. )
 
    ! setup preprocess converter
    call convert_setup
 
    ! setup mktopo
    call mktopo_setup
 
    ! setup mkinit
    call mkinit_setup
 
    ! setup mod_user
    call user_setup
 
    call prof_rapend('Initialize',0)
 
    !########## main ##########
 
    call prof_setprefx('MAIN')
    call prof_rapstart('Main_prep',0)
 
    ! execute preprocess
    call prof_rapstart('Convert',1)
    call convert
    call prof_rapend  ('Convert',1)
 
    ! execute mktopo
    call prof_rapstart('MkTopo',1)
    call mktopo
    call prof_rapend  ('MkTopo',1)
 
    ! re-setup
    call atmos_grid_cartesc_real_calc_z
    call atmos_grid_cartesc_metric_setup
    call atmos_grid_cartesc_real_calc_areavol( atmos_grid_cartesc_metric_mapf(:,:,:,:) )
    if ( ocean_do ) call ocean_grid_cartesc_real_set_areavol
    if ( land_do  ) call land_grid_cartesc_real_set_areavol
    if ( urban_do ) call urban_grid_cartesc_real_set_areavol
 
    ! execute mkinit
    call prof_rapstart('MkInit',1)
    call mkinit( output )
    call user_mkinit
    call prof_rapend  ('MkInit',1)
 
 
    ! output
    call topography_write
    call landuse_write
 
 
    if ( output ) then
      call prof_rapstart('MkInit_restart',1)
 
      ! setup surface condition
      call ocean_surface_set( countup = .false. )
      call land_surface_set ( countup = .false. )
      call urban_surface_set( countup = .false. )
      call atmos_surface_get
 
      ! output restart file
      time_doocean_restart = .true.
      time_doland_restart  = .true.
      time_dourban_restart = .true.
      time_doatmos_restart = .true.
      call admin_restart_write
 
      call prof_rapend  ('MkInit_restart',1)
 
   end if
 
    call prof_rapend('Main_prep',0)
 
    !########## Finalize ##########
 
    ! file I/O
    call prof_rapstart('File', 1)
    call file_cartesc_finalize
    call file_grads_finalize
    call file_close_all
    call file_finalize
    call prof_rapend  ('File', 1)
 
    call atmos_grid_cartesc_metric_finalize
 
    ! finalize mkinit
    call mkinit_finalize
 
    ! finalize atmosphere
    if ( atmos_do ) call atmos_driver_finalize( .true. )
 
    ! finalize variable container
    if ( atmos_do ) call atmos_vars_finalize
    if ( ocean_do ) call ocean_vars_finalize
    if ( land_do )  call land_vars_finalize
    if ( urban_do ) call urban_vars_finalize
    if ( cpl_sw   ) call cpl_vars_finalize
 
    ! finalize coriolis parameter
    call coriolis_finalize
 
    ! finalize nesting grid
    call comm_cartesc_nest_finalize 
 
    ! finalize grid coordinates (real world)
    if ( atmos_do ) call atmos_grid_cartesc_real_finalize
    if ( ocean_do ) call ocean_grid_cartesc_real_finalize
    if ( land_do  ) call land_grid_cartesc_real_finalize
    if ( urban_do ) call urban_grid_cartesc_real_finalize
 
    ! finalize land use category index/fraction
    call landuse_finalize
 
    ! finalize topography
    call topography_finalize
 
    ! finalize communication
    call comm_finalize
 
    ! user module
    call user_finalize
 
    ! finalize tracer
    call atmos_hydrometeor_finalize
    call tracer_finalize
 
    ! finalize horizontal/vertical grid coordinates (cartesian, idealized)
    if ( atmos_do ) call atmos_grid_cartesc_finalize
    if ( ocean_do ) call ocean_grid_cartesc_finalize
    if ( land_do  ) call land_grid_cartesc_finalize
    if ( urban_do ) call urban_grid_cartesc_finalize
 
    call prc_cartesc_finalize
 
    call random_finalize
 
    call const_finalize
 
    call prof_rapreport
 
    ! finalize profiler
    call prof_finalize
 
    ! finalize io
    call io_finalize
 
    return
  end subroutine rm_prep
 
end module mod_rm_prep