mod_admin_restart.f90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
module mod_admin_restart
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_stdio
  use scale_prof
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  public :: admin_restart_setup
  public :: admin_restart

  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  logical,               public :: restart_run          = .false.   
  logical,               public :: restart_output       = .false.   

  character(len=H_LONG), public :: restart_in_basename  = ''
  character(len=H_LONG), public :: restart_out_basename = ''
  character(len=H_MID),  public :: restart_out_title    = ''
  character(len=H_MID),  public :: restart_out_dtype    = 'DEFAULT'

  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  subroutine admin_restart_setup
    use scale_process, only: &
       prc_mpistop
    use mod_atmos_vars, only: &
       atmos_restart_output,       &
       atmos_restart_in_basename,  &
       atmos_restart_out_basename, &
       atmos_restart_out_title,    &
       atmos_restart_out_dtype
    use mod_atmos_dyn_vars, only: &
       atmos_dyn_restart_output,       &
       atmos_dyn_restart_in_basename,  &
       atmos_dyn_restart_out_basename, &
       atmos_dyn_restart_out_title,    &
       atmos_dyn_restart_out_dtype
    use mod_atmos_phy_cp_vars, only: &
       atmos_phy_cp_restart_output,       &
       atmos_phy_cp_restart_in_basename,  &
       atmos_phy_cp_restart_out_basename, &
       atmos_phy_cp_restart_out_title,    &
       atmos_phy_cp_restart_out_dtype
    use mod_atmos_phy_mp_vars, only: &
       atmos_phy_mp_restart_output,       &
       atmos_phy_mp_restart_in_basename,  &
       atmos_phy_mp_restart_out_basename, &
       atmos_phy_mp_restart_out_title,    &
       atmos_phy_mp_restart_out_dtype
    use mod_atmos_phy_rd_vars, only: &
       atmos_phy_rd_restart_output,       &
       atmos_phy_rd_restart_in_basename,  &
       atmos_phy_rd_restart_out_basename, &
       atmos_phy_rd_restart_out_title,    &
       atmos_phy_rd_restart_out_dtype
    use mod_atmos_phy_sf_vars, only: &
       atmos_phy_sf_restart_output,       &
       atmos_phy_sf_restart_in_basename,  &
       atmos_phy_sf_restart_out_basename, &
       atmos_phy_sf_restart_out_title,    &
       atmos_phy_sf_restart_out_dtype
    use mod_atmos_phy_tb_vars, only: &
       atmos_phy_tb_restart_output,       &
       atmos_phy_tb_restart_in_basename,  &
       atmos_phy_tb_restart_out_basename, &
       atmos_phy_tb_restart_out_title,    &
       atmos_phy_tb_restart_out_dtype
    use mod_atmos_phy_ch_vars, only: &
       atmos_phy_ch_restart_output,       &
       atmos_phy_ch_restart_in_basename,  &
       atmos_phy_ch_restart_out_basename, &
       atmos_phy_ch_restart_out_title,    &
       atmos_phy_ch_restart_out_dtype
    use mod_atmos_phy_ae_vars, only: &
       atmos_phy_ae_restart_output,       &
       atmos_phy_ae_restart_in_basename,  &
       atmos_phy_ae_restart_out_basename, &
       atmos_phy_ae_restart_out_title,    &
       atmos_phy_ae_restart_out_dtype
    use mod_ocean_vars, only: &
       ocean_restart_output,       &
       ocean_restart_in_basename,  &
       ocean_restart_out_basename, &
       ocean_restart_out_title,    &
       ocean_restart_out_dtype
    use mod_land_vars, only: &
       land_restart_output,       &
       land_restart_in_basename,  &
       land_restart_out_basename, &
       land_restart_out_title,    &
       land_restart_out_dtype
    use mod_urban_vars, only: &
       urban_restart_output,       &
       urban_restart_in_basename,  &
       urban_restart_out_basename, &
       urban_restart_out_title,    &
       urban_restart_out_dtype

    implicit none

    namelist / param_restart / &
       restart_run,          &
       restart_output,       &
       restart_in_basename,  &
       restart_out_basename, &
       restart_out_title,    &
       restart_out_dtype

    integer :: ierr
    !---------------------------------------------------------------------------

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '++++++ Module[ADMIN] / Categ[RESTART] / Origin[SCALE-RM]'

    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_restart,iostat=ierr)
    if( ierr < 0 ) then !--- missing
       if( io_l ) write(io_fid_log,*) '*** Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       write(*,*) 'xxx Not appropriate names in namelist PARAM_RESTART. Check!'
       call prc_mpistop
    endif
    if( io_lnml ) write(io_fid_log,nml=param_restart)

    !--- set default output switch
    atmos_restart_output        = restart_output
    atmos_dyn_restart_output    = restart_output
    atmos_phy_cp_restart_output = restart_output
    atmos_phy_mp_restart_output = restart_output
    atmos_phy_rd_restart_output = restart_output
    atmos_phy_sf_restart_output = restart_output
    atmos_phy_tb_restart_output = restart_output
    atmos_phy_ch_restart_output = restart_output
    atmos_phy_ae_restart_output = restart_output
    ocean_restart_output        = restart_output
    land_restart_output         = restart_output
    urban_restart_output        = restart_output

    !--- set default input filename
    if ( restart_in_basename /= '' ) then
       atmos_restart_in_basename         = restart_in_basename
       atmos_dyn_restart_in_basename     = restart_in_basename
       atmos_phy_ae_restart_in_basename  = restart_in_basename
       atmos_phy_ch_restart_in_basename  = restart_in_basename
       atmos_phy_cp_restart_in_basename  = restart_in_basename
       atmos_phy_mp_restart_in_basename  = restart_in_basename
       atmos_phy_rd_restart_in_basename  = restart_in_basename
       atmos_phy_sf_restart_in_basename  = restart_in_basename
       atmos_phy_tb_restart_in_basename  = restart_in_basename
       ocean_restart_in_basename         = restart_in_basename
       land_restart_in_basename          = restart_in_basename
       urban_restart_in_basename         = restart_in_basename
    endif

    !--- set default output filename
    if ( restart_out_basename /= '' ) then
       atmos_restart_out_basename        = restart_out_basename
       atmos_dyn_restart_out_basename    = restart_out_basename
       atmos_phy_cp_restart_out_basename = restart_out_basename
       atmos_phy_mp_restart_out_basename = restart_out_basename
       atmos_phy_rd_restart_out_basename = restart_out_basename
       atmos_phy_sf_restart_out_basename = restart_out_basename
       atmos_phy_tb_restart_out_basename = restart_out_basename
       atmos_phy_ch_restart_out_basename = restart_out_basename
       atmos_phy_ae_restart_out_basename = restart_out_basename
       ocean_restart_out_basename        = restart_out_basename
       land_restart_out_basename         = restart_out_basename
       urban_restart_out_basename        = restart_out_basename
    endif

    !--- set default output title
    if ( restart_out_title /= '' ) then
       atmos_restart_out_title           = restart_out_title
       atmos_dyn_restart_out_title       = restart_out_title
       atmos_phy_cp_restart_out_title    = restart_out_title
       atmos_phy_mp_restart_out_title    = restart_out_title
       atmos_phy_rd_restart_out_title    = restart_out_title
       atmos_phy_sf_restart_out_title    = restart_out_title
       atmos_phy_tb_restart_out_title    = restart_out_title
       atmos_phy_ch_restart_out_title    = restart_out_title
       atmos_phy_ae_restart_out_title    = restart_out_title
       ocean_restart_out_title           = restart_out_title
       land_restart_out_title            = restart_out_title
       urban_restart_out_title           = restart_out_title
    endif

    !--- set default output data type
    if ( restart_out_dtype /= '' ) then
       atmos_restart_out_dtype           = restart_out_dtype
       atmos_dyn_restart_out_dtype       = restart_out_dtype
       atmos_phy_ae_restart_out_dtype    = restart_out_dtype
       atmos_phy_ch_restart_out_dtype    = restart_out_dtype
       atmos_phy_cp_restart_out_dtype    = restart_out_dtype
       atmos_phy_mp_restart_out_dtype    = restart_out_dtype
       atmos_phy_rd_restart_out_dtype    = restart_out_dtype
       atmos_phy_sf_restart_out_dtype    = restart_out_dtype
       atmos_phy_tb_restart_out_dtype    = restart_out_dtype
       ocean_restart_out_dtype           = restart_out_dtype
       land_restart_out_dtype            = restart_out_dtype
       urban_restart_out_dtype           = restart_out_dtype
    endif

    return
  end subroutine admin_restart_setup

  subroutine admin_restart
    use mod_ocean_vars, only: &
       ocean_sw_restart => ocean_restart_output, &
       ocean_vars_restart_create, &
       ocean_vars_restart_def_var, &
       ocean_vars_restart_enddef, &
       ocean_vars_restart_write_var, &
       ocean_vars_restart_close
    use mod_land_vars, only: &
       land_sw_restart => land_restart_output, &
       land_vars_restart_create, &
       land_vars_restart_def_var, &
       land_vars_restart_enddef, &
       land_vars_restart_write_var, &
       land_vars_restart_close
    use mod_urban_vars, only: &
       urban_sw_restart => urban_restart_output, &
       urban_vars_restart_create, &
       urban_vars_restart_def_var, &
       urban_vars_restart_enddef, &
       urban_vars_restart_write_var, &
       urban_vars_restart_close
    use mod_atmos_vars, only: &
       atmos_sw_restart => atmos_restart_output, &
       atmos_vars_restart_create, &
       atmos_vars_restart_def_var, &
       atmos_vars_restart_enddef, &
       atmos_vars_restart_write_var, &
       atmos_vars_restart_close
    use mod_admin_time, only: &
       time_doatmos_restart,  &
       time_doland_restart,   &
       time_dourban_restart,  &
       time_doocean_restart
    implicit none

    ! restart files can be different for different models

    ! cread restart netCDF file
    if( ocean_sw_restart .AND. time_doocean_restart ) call ocean_vars_restart_create
    if(  land_sw_restart .AND. time_doland_restart  ) call  land_vars_restart_create
    if( urban_sw_restart .AND. time_dourban_restart ) call urban_vars_restart_create
    if( atmos_sw_restart .AND. time_doatmos_restart ) call atmos_vars_restart_create

    ! define metadata in netCDF file
    if( ocean_sw_restart .AND. time_doocean_restart ) call ocean_vars_restart_def_var
    if(  land_sw_restart .AND. time_doland_restart  ) call  land_vars_restart_def_var
    if( urban_sw_restart .AND. time_dourban_restart ) call urban_vars_restart_def_var
    if( atmos_sw_restart .AND. time_doatmos_restart ) call atmos_vars_restart_def_var

    ! exit define mode
    if( ocean_sw_restart .AND. time_doocean_restart ) call ocean_vars_restart_enddef
    if(  land_sw_restart .AND. time_doland_restart  ) call  land_vars_restart_enddef
    if( urban_sw_restart .AND. time_dourban_restart ) call urban_vars_restart_enddef
    if( atmos_sw_restart .AND. time_doatmos_restart ) call atmos_vars_restart_enddef

    ! write variabes to netCDF file
    if( ocean_sw_restart .AND. time_doocean_restart ) call ocean_vars_restart_write_var
    if(  land_sw_restart .AND. time_doland_restart  ) call  land_vars_restart_write_var
    if( urban_sw_restart .AND. time_dourban_restart ) call urban_vars_restart_write_var
    if( atmos_sw_restart .AND. time_doatmos_restart ) call atmos_vars_restart_write_var

    ! clode the restart file
    if( ocean_sw_restart .AND. time_doocean_restart ) call ocean_vars_restart_close
    if(  land_sw_restart .AND. time_doland_restart  ) call  land_vars_restart_close
    if( urban_sw_restart .AND. time_dourban_restart ) call urban_vars_restart_close
    if( atmos_sw_restart .AND. time_doatmos_restart ) call atmos_vars_restart_close

  end subroutine admin_restart

end module mod_admin_restart