d7/de3/mod__admin__restart_8F90_source.html

!-------------------------------------------------------------------------------

!-------------------------------------------------------------------------------

#include "scalelib.h"

module mod_admin_restart

  !-----------------------------------------------------------------------------

  !

  !++ used modules

  !

  use scale_precision

  use scale_io

  use scale_prof

  !-----------------------------------------------------------------------------

  implicit none

  private

  !-----------------------------------------------------------------------------

  !

  !++ Public procedure

  !

  public :: admin_restart_setup

  public :: admin_restart_write

  public :: admin_restart_read


  !-----------------------------------------------------------------------------

  !

  !++ Public parameters & variables

  !

  !-----------------------------------------------------------------------------

  !

  !++ Private procedure

  !

  !-----------------------------------------------------------------------------

  !

  !++ Private parameters & variables

  !

  logical,                public :: restart_output                = .false.


  character(len=H_LONG),  public :: restart_in_basename           = ''

  logical,                public :: restart_in_aggregate

  logical,                public :: restart_in_postfix_timelabel  = .false.

  character(len=H_LONG),  public :: restart_out_basename          = ''

  logical,                public :: restart_out_aggregate

  logical,                public :: restart_out_postfix_timelabel = .true.

  character(len=H_MID),   public :: restart_out_title             = ''

  character(len=H_SHORT), public :: restart_out_dtype             = 'DEFAULT'


  !-----------------------------------------------------------------------------

contains

  !-----------------------------------------------------------------------------

  subroutine admin_restart_setup

    use scale_prc, only: &

       prc_abort

    use scale_file, only: &

       file_aggregate

    use mod_atmos_vars, only: &

       atmos_restart_output,                &

       atmos_restart_in_basename,           &

       atmos_restart_in_aggregate,          &

       atmos_restart_in_postfix_timelabel,  &

       atmos_restart_out_basename,          &

       atmos_restart_out_aggregate,         &

       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_aggregate,          &

       atmos_dyn_restart_in_postfix_timelabel,  &

       atmos_dyn_restart_out_basename,          &

       atmos_dyn_restart_out_aggregate,         &

       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_aggregate,          &

       atmos_phy_mp_restart_in_postfix_timelabel,  &

       atmos_phy_mp_restart_out_basename,          &

       atmos_phy_mp_restart_out_aggregate,         &

       atmos_phy_mp_restart_out_postfix_timelabel, &

       atmos_phy_mp_restart_out_title,             &

       atmos_phy_mp_restart_out_dtype

    use mod_atmos_phy_lt_vars, only: &

       atmos_phy_lt_restart_output,                &

       atmos_phy_lt_restart_in_basename,           &

       atmos_phy_lt_restart_in_aggregate,          &

       atmos_phy_lt_restart_in_postfix_timelabel,  &

       atmos_phy_lt_restart_out_basename,          &

       atmos_phy_lt_restart_out_aggregate,         &

       atmos_phy_lt_restart_out_postfix_timelabel, &

       atmos_phy_lt_restart_out_title,             &

       atmos_phy_lt_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_aggregate,          &

       atmos_phy_ae_restart_in_postfix_timelabel,  &

       atmos_phy_ae_restart_out_basename,          &

       atmos_phy_ae_restart_out_aggregate,         &

       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_aggregate,          &

       atmos_phy_ch_restart_in_postfix_timelabel,  &

       atmos_phy_ch_restart_out_basename,          &

       atmos_phy_ch_restart_out_aggregate,         &

       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_aggregate,          &

       atmos_phy_rd_restart_in_postfix_timelabel,  &

       atmos_phy_rd_restart_out_basename,          &

       atmos_phy_rd_restart_out_aggregate,         &

       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_aggregate,          &

       atmos_phy_sf_restart_in_postfix_timelabel,  &

       atmos_phy_sf_restart_out_basename,          &

       atmos_phy_sf_restart_out_aggregate,         &

       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_aggregate,          &

       atmos_phy_tb_restart_in_postfix_timelabel,  &

       atmos_phy_tb_restart_out_basename,          &

       atmos_phy_tb_restart_out_aggregate,         &

       atmos_phy_tb_restart_out_postfix_timelabel, &

       atmos_phy_tb_restart_out_title,             &

       atmos_phy_tb_restart_out_dtype

    use mod_atmos_phy_bl_vars, only: &

       atmos_phy_bl_restart_output,                &

       atmos_phy_bl_restart_in_basename,           &

       atmos_phy_bl_restart_in_aggregate,          &

       atmos_phy_bl_restart_in_postfix_timelabel,  &

       atmos_phy_bl_restart_out_basename,          &

       atmos_phy_bl_restart_out_aggregate,         &

       atmos_phy_bl_restart_out_postfix_timelabel, &

       atmos_phy_bl_restart_out_title,             &

       atmos_phy_bl_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_aggregate,          &

       atmos_phy_cp_restart_in_postfix_timelabel,  &

       atmos_phy_cp_restart_out_basename,          &

       atmos_phy_cp_restart_out_aggregate,         &

       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_aggregate,          &

       ocean_restart_in_postfix_timelabel,  &

       ocean_restart_out_basename,          &

       ocean_restart_out_aggregate,         &

       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_aggregate,          &

       land_restart_in_postfix_timelabel,  &

       land_restart_out_basename,          &

       land_restart_out_aggregate,         &

       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_aggregate,          &

       urban_restart_in_postfix_timelabel,  &

       urban_restart_out_basename,          &

       urban_restart_out_aggregate,         &

       urban_restart_out_postfix_timelabel, &

       urban_restart_out_title,             &

       urban_restart_out_dtype

    implicit none


    namelist / param_restart / &

       restart_output,                &

       restart_in_basename,           &

       restart_in_aggregate,          &

       restart_in_postfix_timelabel,  &

       restart_out_basename,          &

       restart_out_aggregate,         &

       restart_out_postfix_timelabel, &

       restart_out_title,             &

       restart_out_dtype


    integer :: ierr

    !---------------------------------------------------------------------------


    log_newline

    log_info("ADMIN_restart_setup",*) 'Setup'


    restart_in_aggregate  = file_aggregate

    restart_out_aggregate = file_aggregate


    !--- read namelist

    rewind(io_fid_conf)

    read(io_fid_conf,nml=param_restart,iostat=ierr)

    if( ierr < 0 ) then !--- missing

       log_info("ADMIN_restart_setup",*) 'Not found namelist. Default used.'

    elseif( ierr > 0 ) then !--- fatal error

       log_error("ADMIN_restart_setup",*) 'Not appropriate names in namelist PARAM_RESTART. Check!'

       call prc_abort

    endif

    log_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_lt_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_bl_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_lt_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_bl_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_aggregate         = restart_in_aggregate

    atmos_dyn_restart_in_aggregate     = restart_in_aggregate

    atmos_phy_mp_restart_in_aggregate  = restart_in_aggregate

    atmos_phy_lt_restart_in_aggregate  = restart_in_aggregate

    atmos_phy_ae_restart_in_aggregate  = restart_in_aggregate

    atmos_phy_ch_restart_in_aggregate  = restart_in_aggregate

    atmos_phy_rd_restart_in_aggregate  = restart_in_aggregate

    atmos_phy_sf_restart_in_aggregate  = restart_in_aggregate

    atmos_phy_tb_restart_in_aggregate  = restart_in_aggregate

    atmos_phy_bl_restart_in_aggregate  = restart_in_aggregate

    atmos_phy_cp_restart_in_aggregate  = restart_in_aggregate

    ocean_restart_in_aggregate         = restart_in_aggregate

    land_restart_in_aggregate          = restart_in_aggregate

    urban_restart_in_aggregate         = restart_in_aggregate


    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_lt_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_bl_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_lt_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_bl_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_aggregate         = restart_out_aggregate

    atmos_dyn_restart_out_aggregate     = restart_out_aggregate

    atmos_phy_mp_restart_out_aggregate  = restart_out_aggregate

    atmos_phy_lt_restart_out_aggregate  = restart_out_aggregate

    atmos_phy_ae_restart_out_aggregate  = restart_out_aggregate

    atmos_phy_ch_restart_out_aggregate  = restart_out_aggregate

    atmos_phy_rd_restart_out_aggregate  = restart_out_aggregate

    atmos_phy_sf_restart_out_aggregate  = restart_out_aggregate

    atmos_phy_tb_restart_out_aggregate  = restart_out_aggregate

    atmos_phy_bl_restart_out_aggregate  = restart_out_aggregate

    atmos_phy_cp_restart_out_aggregate  = restart_out_aggregate

    ocean_restart_out_aggregate         = restart_out_aggregate

    land_restart_out_aggregate          = restart_out_aggregate

    urban_restart_out_aggregate         = restart_out_aggregate


    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_lt_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_bl_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_lt_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_bl_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_lt_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_bl_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

  end subroutine admin_restart_setup


  !-----------------------------------------------------------------------------

  subroutine admin_restart_write

    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


    ! create 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

  end subroutine admin_restart_write


  !-----------------------------------------------------------------------------

  subroutine admin_restart_read

    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


  end subroutine admin_restart_read


end module mod_admin_restart