module administrator for restart More...

Functions/Subroutines
subroutine, public	admin_restart_setup
	Setup. More...

subroutine, public	admin_restart_write
	Write data to restart files. More...

subroutine, public	admin_restart_read
	Read from restart files. More...

Variables
logical, public	restart_run = .false.
	Is this run restart? More...

logical, public	restart_output = .false.
	Output restart file? More...

character(len=h_long), public	restart_in_basename = ''
	Basename of the input file. More...

logical, public	restart_in_postfix_timelabel = .false.
	Add timelabel to the basename of input file? More...

character(len=h_long), public	restart_out_basename = ''
	Basename of the output file. More...

logical, public	restart_out_postfix_timelabel = .true.
	Add timelabel to the basename of output file? More...

character(len=h_mid), public	restart_out_title = ''
	Title of the output file. More...

character(len=h_short), public	restart_out_dtype = 'DEFAULT'
	REAL4 or REAL8. More...

Detailed Description

module administrator for restart

Description: Restart administrator

Author: Team SCALE

NAMELIST

PARAM_RESTART

name	type	default value	comment
RESTART_RUN	logical	.false.	Is this run restart?
RESTART_OUTPUT	logical	.false.	Output restart file?
RESTART_IN_BASENAME	character(len=H_LONG)	''	Basename of the input file
RESTART_IN_POSTFIX_TIMELABEL	logical	.false.	Add timelabel to the basename of input file?
RESTART_OUT_BASENAME	character(len=H_LONG)	''	Basename of the output file
RESTART_OUT_POSTFIX_TIMELABEL	logical	.true.	Add timelabel to the basename of output file?
RESTART_OUT_TITLE	character(len=H_MID)	''	Title of the output file
RESTART_OUT_DTYPE	character(len=H_SHORT)	'DEFAULT'	REAL4 or REAL8

History Output: No history output

Function/Subroutine Documentation

◆ admin_restart_setup()

subroutine, public mod_admin_restart::admin_restart_setup ( )

Setup.

Definition at line 56 of file mod_admin_restart.f90.

Referenced by mod_rm_driver::scalerm(), and mod_rm_prep::scalerm_prep().

     use scale_process, only: &
        prc_mpistop
     use mod_atmos_vars, only: &
        atmos_restart_output,                &
        atmos_restart_in_basename,           &
        atmos_restart_in_postfix_timelabel,  &
        atmos_restart_out_basename,          &
        atmos_restart_out_postfix_timelabel, &
        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_in_postfix_timelabel,  &
        atmos_dyn_restart_out_basename,          &
        atmos_dyn_restart_out_postfix_timelabel, &
        atmos_dyn_restart_out_title,             &
        atmos_dyn_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_in_postfix_timelabel,  &
        atmos_phy_mp_restart_out_basename,          &
        atmos_phy_mp_restart_out_postfix_timelabel, &
        atmos_phy_mp_restart_out_title,             &
        atmos_phy_mp_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_in_postfix_timelabel,  &
        atmos_phy_ae_restart_out_basename,          &
        atmos_phy_ae_restart_out_postfix_timelabel, &
        atmos_phy_ae_restart_out_title,             &
        atmos_phy_ae_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_in_postfix_timelabel,  &
        atmos_phy_ch_restart_out_basename,          &
        atmos_phy_ch_restart_out_postfix_timelabel, &
        atmos_phy_ch_restart_out_title,             &
        atmos_phy_ch_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_in_postfix_timelabel,  &
        atmos_phy_rd_restart_out_basename,          &
        atmos_phy_rd_restart_out_postfix_timelabel, &
        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_in_postfix_timelabel,  &
        atmos_phy_sf_restart_out_basename,          &
        atmos_phy_sf_restart_out_postfix_timelabel, &
        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_in_postfix_timelabel,  &
        atmos_phy_tb_restart_out_basename,          &
        atmos_phy_tb_restart_out_postfix_timelabel, &
        atmos_phy_tb_restart_out_title,             &
        atmos_phy_tb_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_in_postfix_timelabel,  &
        atmos_phy_cp_restart_out_basename,          &
        atmos_phy_cp_restart_out_postfix_timelabel, &
        atmos_phy_cp_restart_out_title,             &
        atmos_phy_cp_restart_out_dtype
     use mod_ocean_vars, only: &
        ocean_restart_output,                &
        ocean_restart_in_basename,           &
        ocean_restart_in_postfix_timelabel,  &
        ocean_restart_out_basename,          &
        ocean_restart_out_postfix_timelabel, &
        ocean_restart_out_title,             &
        ocean_restart_out_dtype
     use mod_land_vars, only: &
        land_restart_output,                &
        land_restart_in_basename,           &
        land_restart_in_postfix_timelabel,  &
        land_restart_out_basename,          &
        land_restart_out_postfix_timelabel, &
        land_restart_out_title,             &
        land_restart_out_dtype
     use mod_urban_vars, only: &
        urban_restart_output,                &
        urban_restart_in_basename,           &
        urban_restart_in_postfix_timelabel,  &
        urban_restart_out_basename,          &
        urban_restart_out_postfix_timelabel, &
        urban_restart_out_title,             &
        urban_restart_out_dtype
     implicit none
 
     namelist / param_restart / &
        restart_run,                   &
        restart_output,                &
        restart_in_basename,           &
        restart_in_postfix_timelabel,  &
        restart_out_basename,          &
        restart_out_postfix_timelabel, &
        restart_out_title,             &
        restart_out_dtype
 
     integer :: ierr
     !---------------------------------------------------------------------------
 
     if( io_l ) write(io_fid_log,*)
     if( io_l ) write(io_fid_log,*) '++++++ Module[RESTART] / Categ[ADMIN] / 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_nml ) write(io_fid_nml,nml=param_restart)
 
     !--- set default output switch
     atmos_restart_output        = restart_output
     atmos_dyn_restart_output    = restart_output
     atmos_phy_mp_restart_output = restart_output
     atmos_phy_ae_restart_output = restart_output
     atmos_phy_ch_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_cp_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_mp_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_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
        atmos_phy_cp_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
 
     atmos_restart_in_postfix_timelabel         = restart_in_postfix_timelabel
     atmos_dyn_restart_in_postfix_timelabel     = restart_in_postfix_timelabel
     atmos_phy_mp_restart_in_postfix_timelabel  = restart_in_postfix_timelabel
     atmos_phy_ae_restart_in_postfix_timelabel  = restart_in_postfix_timelabel
     atmos_phy_ch_restart_in_postfix_timelabel  = restart_in_postfix_timelabel
     atmos_phy_rd_restart_in_postfix_timelabel  = restart_in_postfix_timelabel
     atmos_phy_sf_restart_in_postfix_timelabel  = restart_in_postfix_timelabel
     atmos_phy_tb_restart_in_postfix_timelabel  = restart_in_postfix_timelabel
     atmos_phy_cp_restart_in_postfix_timelabel  = restart_in_postfix_timelabel
     ocean_restart_in_postfix_timelabel         = restart_in_postfix_timelabel
     land_restart_in_postfix_timelabel          = restart_in_postfix_timelabel
     urban_restart_in_postfix_timelabel         = restart_in_postfix_timelabel
 
     !--- 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_mp_restart_out_basename = restart_out_basename
        atmos_phy_ae_restart_out_basename = restart_out_basename
        atmos_phy_ch_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_cp_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
 
     atmos_restart_out_postfix_timelabel         = restart_out_postfix_timelabel
     atmos_dyn_restart_out_postfix_timelabel     = restart_out_postfix_timelabel
     atmos_phy_mp_restart_out_postfix_timelabel  = restart_out_postfix_timelabel
     atmos_phy_ae_restart_out_postfix_timelabel  = restart_out_postfix_timelabel
     atmos_phy_ch_restart_out_postfix_timelabel  = restart_out_postfix_timelabel
     atmos_phy_rd_restart_out_postfix_timelabel  = restart_out_postfix_timelabel
     atmos_phy_sf_restart_out_postfix_timelabel  = restart_out_postfix_timelabel
     atmos_phy_tb_restart_out_postfix_timelabel  = restart_out_postfix_timelabel
     atmos_phy_cp_restart_out_postfix_timelabel  = restart_out_postfix_timelabel
     ocean_restart_out_postfix_timelabel         = restart_out_postfix_timelabel
     land_restart_out_postfix_timelabel          = restart_out_postfix_timelabel
     urban_restart_out_postfix_timelabel         = restart_out_postfix_timelabel
 
     !--- 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_mp_restart_out_title = restart_out_title
        atmos_phy_ae_restart_out_title = restart_out_title
        atmos_phy_ch_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_cp_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_mp_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_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
        atmos_phy_cp_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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ admin_restart_write()

subroutine, public mod_admin_restart::admin_restart_write ( )

Write data to restart files.

Definition at line 293 of file mod_admin_restart.f90.

References mod_atmos_vars::atmos_restart_output, mod_atmos_vars::atmos_vars_restart_close(), mod_atmos_vars::atmos_vars_restart_create(), mod_atmos_vars::atmos_vars_restart_def_var(), mod_atmos_vars::atmos_vars_restart_enddef(), mod_atmos_vars::atmos_vars_restart_write(), mod_land_vars::land_restart_output, mod_land_vars::land_vars_restart_close(), mod_land_vars::land_vars_restart_create(), mod_land_vars::land_vars_restart_def_var(), mod_land_vars::land_vars_restart_enddef(), mod_land_vars::land_vars_restart_write(), mod_ocean_vars::ocean_restart_output, mod_ocean_vars::ocean_vars_restart_close(), mod_ocean_vars::ocean_vars_restart_create(), mod_ocean_vars::ocean_vars_restart_def_var(), mod_ocean_vars::ocean_vars_restart_enddef(), mod_ocean_vars::ocean_vars_restart_write(), mod_admin_time::time_doatmos_restart, mod_admin_time::time_doland_restart, mod_admin_time::time_doocean_restart, mod_admin_time::time_dourban_restart, mod_urban_vars::urban_restart_output, mod_urban_vars::urban_vars_restart_close(), mod_urban_vars::urban_vars_restart_create(), mod_urban_vars::urban_vars_restart_def_var(), mod_urban_vars::urban_vars_restart_enddef(), and mod_urban_vars::urban_vars_restart_write().

Referenced by mod_mkinit::mkinit(), and mod_rm_driver::scalerm().

     use mod_admin_time, only: &
        time_doatmos_restart,  &
        time_doland_restart,   &
        time_dourban_restart,  &
        time_doocean_restart
     use mod_atmos_vars, only: &
        atmos_restart_output,         &
        atmos_vars_restart_create,    &
        atmos_vars_restart_def_var,   &
        atmos_vars_restart_enddef,    &
        atmos_vars_restart_write,     &
        atmos_vars_restart_close
     use mod_ocean_vars, only: &
        ocean_restart_output,         &
        ocean_vars_restart_create,    &
        ocean_vars_restart_def_var,   &
        ocean_vars_restart_enddef,    &
        ocean_vars_restart_write,     &
        ocean_vars_restart_close
     use mod_land_vars, only: &
        land_restart_output,         &
        land_vars_restart_create,    &
        land_vars_restart_def_var,   &
        land_vars_restart_enddef,    &
        land_vars_restart_write,     &
        land_vars_restart_close
     use mod_urban_vars, only: &
        urban_restart_output,         &
        urban_vars_restart_create,    &
        urban_vars_restart_def_var,   &
        urban_vars_restart_enddef,    &
        urban_vars_restart_write,     &
        urban_vars_restart_close
     implicit none
     !---------------------------------------------------------------------------
 
     ! restart files can be different for different models
 
     ! cread restart netCDF file(s)
     if( ocean_restart_output .AND. time_doocean_restart ) call ocean_vars_restart_create
     if(  land_restart_output .AND. time_doland_restart  ) call  land_vars_restart_create
     if( urban_restart_output .AND. time_dourban_restart ) call urban_vars_restart_create
     if( atmos_restart_output .AND. time_doatmos_restart ) call atmos_vars_restart_create
 
     ! define metadata (dimensions, variables, attributes) in netCDF file
     if( ocean_restart_output .AND. time_doocean_restart ) call ocean_vars_restart_def_var
     if(  land_restart_output .AND. time_doland_restart  ) call  land_vars_restart_def_var
     if( urban_restart_output .AND. time_dourban_restart ) call urban_vars_restart_def_var
     if( atmos_restart_output .AND. time_doatmos_restart ) call atmos_vars_restart_def_var
 
     ! exit define mode
     if( ocean_restart_output .AND. time_doocean_restart ) call ocean_vars_restart_enddef
     if(  land_restart_output .AND. time_doland_restart  ) call  land_vars_restart_enddef
     if( urban_restart_output .AND. time_dourban_restart ) call urban_vars_restart_enddef
     if( atmos_restart_output .AND. time_doatmos_restart ) call atmos_vars_restart_enddef
 
     ! write variabes to netCDF file
     if( ocean_restart_output .AND. time_doocean_restart ) call ocean_vars_restart_write
     if(  land_restart_output .AND. time_doland_restart  ) call  land_vars_restart_write
     if( urban_restart_output .AND. time_dourban_restart ) call urban_vars_restart_write
     if( atmos_restart_output .AND. time_doatmos_restart ) call atmos_vars_restart_write
 
     ! clode the restart file
     if( ocean_restart_output .AND. time_doocean_restart ) call ocean_vars_restart_close
     if(  land_restart_output .AND. time_doland_restart  ) call  land_vars_restart_close
     if( urban_restart_output .AND. time_dourban_restart ) call urban_vars_restart_close
     if( atmos_restart_output .AND. time_doatmos_restart ) call atmos_vars_restart_close
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ admin_restart_read()

subroutine, public mod_admin_restart::admin_restart_read ( )

Read from restart files.

Definition at line 367 of file mod_admin_restart.f90.

References mod_atmos_admin::atmos_do, mod_atmos_vars::atmos_vars_restart_close(), mod_atmos_vars::atmos_vars_restart_open(), mod_atmos_vars::atmos_vars_restart_read(), mod_land_admin::land_do, mod_land_vars::land_vars_restart_close(), mod_land_vars::land_vars_restart_open(), mod_land_vars::land_vars_restart_read(), mod_ocean_admin::ocean_do, mod_ocean_vars::ocean_vars_restart_close(), mod_ocean_vars::ocean_vars_restart_open(), mod_ocean_vars::ocean_vars_restart_read(), mod_urban_admin::urban_do, mod_urban_vars::urban_vars_restart_close(), mod_urban_vars::urban_vars_restart_open(), and mod_urban_vars::urban_vars_restart_read().

Referenced by mod_rm_driver::resume_state().

     use mod_atmos_admin, only: &
        atmos_do
     use mod_ocean_admin, only: &
        ocean_do
     use mod_land_admin, only: &
        land_do
     use mod_urban_admin, only: &
        urban_do
     use mod_ocean_vars, only: &
        ocean_vars_restart_open, &
        ocean_vars_restart_read, &
        ocean_vars_restart_close
     use mod_land_vars, only: &
        land_vars_restart_open, &
        land_vars_restart_read, &
        land_vars_restart_close
     use mod_urban_vars, only: &
        urban_vars_restart_open, &
        urban_vars_restart_read, &
        urban_vars_restart_close
     use mod_atmos_vars, only: &
        atmos_vars_restart_open, &
        atmos_vars_restart_read, &
        atmos_vars_restart_close
     implicit none
 
     ! restart files can be different for different models
 
     ! open restart netCDF file
     if ( atmos_do ) call atmos_vars_restart_open
     if ( ocean_do ) call ocean_vars_restart_open
     if ( land_do  ) call land_vars_restart_open
     if ( urban_do ) call urban_vars_restart_open
 
     ! read restart data
     if ( atmos_do ) call atmos_vars_restart_read
     if ( ocean_do ) call ocean_vars_restart_read
     if ( land_do  ) call land_vars_restart_read
     if ( urban_do ) call urban_vars_restart_read
 
     ! clode the restart file
     if ( atmos_do ) call atmos_vars_restart_close
     if ( ocean_do ) call ocean_vars_restart_close
     if ( land_do  ) call land_vars_restart_close
     if ( urban_do ) call urban_vars_restart_close
 