module Atmosphere / Dynamics More...

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

subroutine, public	atmos_dyn_vars_fillhalo
	HALO Communication. More...

subroutine, public	atmos_dyn_vars_restart_open
	Open restart file for read. More...

subroutine, public	atmos_dyn_vars_restart_read
	Read restart. More...

subroutine, public	atmos_dyn_vars_restart_create
	Create restart file. More...

subroutine, public	atmos_dyn_vars_restart_enddef
	Exit netCDF define mode. More...

subroutine, public	atmos_dyn_vars_restart_close
	Close restart file. More...

subroutine, public	atmos_dyn_vars_restart_def_var
	Define variables in restart file. More...

subroutine, public	atmos_dyn_vars_restart_write
	Write variables to restart file. More...

subroutine	atmos_dyn_vars_check

Variables
logical, public	atmos_dyn_restart_output = .false.
	output restart file? More...

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

logical, public	atmos_dyn_restart_in_aggregate
	Switch to use aggregate file. More...

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

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

logical, public	atmos_dyn_restart_out_aggregate
	Switch to use aggregate file. More...

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

character(len=h_mid), public	atmos_dyn_restart_out_title = 'ATMOS_DYN restart'
	title of the output file More...

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

real(rp), dimension(:,:,:,:), allocatable, public	prog

Detailed Description

module Atmosphere / Dynamics

Description: Container for mod_atmos_dyn

Author: Team SCALE

NAMELIST

PARAM_ATMOS_DYN_VARS

name	type	default value	comment
ATMOS_DYN_RESTART_IN_BASENAME	character(len=H_LONG)	''	Basename of the input file
ATMOS_DYN_RESTART_IN_AGGREGATE	logical		Switch to use aggregate file
ATMOS_DYN_RESTART_IN_POSTFIX_TIMELABEL	logical	.false.	Add timelabel to the basename of input file?
ATMOS_DYN_RESTART_OUTPUT	logical	.false.	output restart file?
ATMOS_DYN_RESTART_OUT_BASENAME	character(len=H_LONG)	''	Basename of the output file
ATMOS_DYN_RESTART_OUT_AGGREGATE	logical		Switch to use aggregate file
ATMOS_DYN_RESTART_OUT_POSTFIX_TIMELABEL	logical	.true.	Add timelabel to the basename of output file?
ATMOS_DYN_RESTART_OUT_TITLE	character(len=H_MID)	'ATMOS_DYN restart'	title of the output file
ATMOS_DYN_RESTART_OUT_DTYPE	character(len=H_SHORT)	'DEFAULT'	REAL4 or REAL8

History Output: No history output

Function/Subroutine Documentation

◆ atmos_dyn_vars_setup()

subroutine, public mod_atmos_dyn_vars::atmos_dyn_vars_setup

Setup.

Definition at line 80 of file mod_atmos_dyn_vars.F90.

     use scale_prc, only: &
        prc_abort
     use scale_const, only: &
        undef => const_undef
     use mod_atmos_admin, only: &
        atmos_dyn_type
     use scale_atmos_dyn_tstep_short, only: &
        atmos_dyn_tstep_short_regist
     implicit none
  
     namelist / param_atmos_dyn_vars / &
        atmos_dyn_restart_in_basename,           &
        atmos_dyn_restart_in_aggregate,          &
        atmos_dyn_restart_in_postfix_timelabel,  &
        atmos_dyn_restart_output,                &
        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
  
     integer :: ierr
     integer :: iv
     !---------------------------------------------------------------------------
  
     log_newline
     log_info("ATMOS_DYN_vars_setup",*) 'Setup'
  
     !--- read namelist
     rewind(io_fid_conf)
     read(io_fid_conf,nml=param_atmos_dyn_vars,iostat=ierr)
     if( ierr < 0 ) then !--- missing
        log_info("ATMOS_DYN_vars_setup",*) 'Not found namelist. Default used.'
     elseif( ierr > 0 ) then !--- fatal error
        log_error("ATMOS_DYN_vars_setup",*) 'Not appropriate names in namelist PARAM_ATMOS_DYN_VARS. Check!'
        call prc_abort
     endif
     log_nml(param_atmos_dyn_vars)
  
     call atmos_dyn_tstep_short_regist( atmos_dyn_type, & ! [IN]
                                        va,             & ! [OUT]
                                        var_name,       & ! [OUT]
                                        var_desc,       & ! [OUT]
                                        var_unit        ) ! [OUT]
  
     if ( va > 0 ) then ! additional prognostic variables
  
        if ( va > vmax ) then
           log_error("ATMOS_DYN_vars_setup",*) 'number of the prognostic variables is exceed the limit', va, ' > ', vmax
           call prc_abort
        endif
        allocate( prog(ka,ia,ja,va) )
        prog(:,:,:,:) = undef
  
        log_newline
        log_info("ATMOS_DYN_vars_setup",*) '[ATMOS_DYN] prognostic/diagnostic variables'
        log_info_cont('(1x,A,A24,A,A48,A,A12,A)') &
                   '      |', 'VARNAME                 ','|', &
                   'DESCRIPTION                                     ', '[', 'UNIT        ', ']'
        do iv = 1, va
           log_info_cont('(1x,A,I3,A,A24,A,A48,A,A12,A)') &
                      'NO.',iv,'|',var_name(iv),'|',var_desc(iv),'[',var_unit(iv),']'
        enddo
  
        log_newline
        if ( atmos_dyn_restart_in_basename /= '' ) then
           log_info("ATMOS_DYN_vars_setup",*) 'Restart input?  : YES, file = ', trim(atmos_dyn_restart_in_basename)
           log_info("ATMOS_DYN_vars_setup",*) 'Add timelabel?  : ', atmos_dyn_restart_in_postfix_timelabel
        else
           log_info("ATMOS_DYN_vars_setup",*) 'Restart input?  : NO'
        endif
        if (       atmos_dyn_restart_output             &
             .AND. atmos_dyn_restart_out_basename /= '' ) then
           log_info("ATMOS_DYN_vars_setup",*) 'Restart output? : YES, file = ', trim(atmos_dyn_restart_out_basename)
           log_info("ATMOS_DYN_vars_setup",*) 'Add timelabel?  : ', atmos_dyn_restart_out_postfix_timelabel
        else
           log_info("ATMOS_DYN_vars_setup",*) 'Restart output? : NO'
           atmos_dyn_restart_output = .false.
        endif
  
     else ! no additional prognostic variables
  
        allocate( prog(ka,ia,ja,1) ) ! for safety
        prog(:,:,:,:) = undef
        atmos_dyn_restart_output = .false.
  
     endif
  
     return

References atmos_dyn_restart_in_aggregate, atmos_dyn_restart_in_basename, atmos_dyn_restart_in_postfix_timelabel, atmos_dyn_restart_out_aggregate, atmos_dyn_restart_out_basename, atmos_dyn_restart_out_dtype, atmos_dyn_restart_out_postfix_timelabel, atmos_dyn_restart_out_title, atmos_dyn_restart_output, scale_atmos_dyn_tstep_short::atmos_dyn_tstep_short_regist(), mod_atmos_admin::atmos_dyn_type, scale_const::const_undef, scale_atmos_grid_cartesc_index::ia, scale_io::io_fid_conf, scale_atmos_grid_cartesc_index::ja, scale_atmos_grid_cartesc_index::ka, scale_prc::prc_abort(), prog, and scale_index::va.

Referenced by mod_atmos_vars::atmos_vars_setup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmos_dyn_vars_fillhalo()

subroutine, public mod_atmos_dyn_vars::atmos_dyn_vars_fillhalo

HALO Communication.

Definition at line 174 of file mod_atmos_dyn_vars.F90.

     use scale_comm_cartesc, only: &
        comm_vars8, &
        comm_wait
     implicit none
  
     integer :: i, j, iv
     !---------------------------------------------------------------------------
  
     do iv = 1, va
        do j  = js, je
        do i  = is, ie
           prog(   1:ks-1,i,j,iv) = prog(ks,i,j,iv)
           prog(ke+1:ka,  i,j,iv) = prog(ke,i,j,iv)
        enddo
        enddo
  
        call comm_vars8( prog(:,:,:,iv), iv )
     enddo
  
     do iv = 1, va
        call comm_wait ( prog(:,:,:,iv), iv )
     enddo
  
     return

References scale_atmos_grid_cartesc_index::ie, scale_atmos_grid_cartesc_index::is, scale_atmos_grid_cartesc_index::je, scale_atmos_grid_cartesc_index::js, scale_atmos_grid_cartesc_index::ka, scale_atmos_grid_cartesc_index::ke, scale_atmos_grid_cartesc_index::ks, prog, and scale_index::va.

Referenced by atmos_dyn_vars_restart_read(), and atmos_dyn_vars_restart_write().

Here is the caller graph for this function:

◆ atmos_dyn_vars_restart_open()

subroutine, public mod_atmos_dyn_vars::atmos_dyn_vars_restart_open

Open restart file for read.

Definition at line 203 of file mod_atmos_dyn_vars.F90.

     use scale_time, only: &
        time_gettimelabel
     use scale_file_cartesc, only: &
        file_cartesc_open
     implicit none
  
     character(len=19)     :: timelabel
     character(len=H_LONG) :: basename
     !---------------------------------------------------------------------------
  
     if ( va < 1 ) return
  
     log_newline
     log_info("ATMOS_DYN_vars_restart_open",*) 'Open restart file (ATMOS_DYN) '
  
     if ( atmos_dyn_restart_in_basename /= '' ) then
  
        if ( atmos_dyn_restart_in_postfix_timelabel ) then
           call time_gettimelabel( timelabel )
           basename = trim(atmos_dyn_restart_in_basename)//'_'//trim(timelabel)
        else
           basename = trim(atmos_dyn_restart_in_basename)
        endif
  
        log_info("ATMOS_DYN_vars_restart_open",*) 'basename: ', trim(basename)
  
        call file_cartesc_open( basename, restart_fid, aggregate=atmos_dyn_restart_in_aggregate )
     else
        log_info("ATMOS_DYN_vars_restart_open",*) 'restart file for ATMOS_DYN is not specified.'
     endif
  
     return

References atmos_dyn_restart_in_aggregate, atmos_dyn_restart_in_basename, atmos_dyn_restart_in_postfix_timelabel, scale_file_cartesc::file_cartesc_open(), scale_time::time_gettimelabel(), and scale_index::va.

Referenced by mod_atmos_vars::atmos_vars_restart_open().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmos_dyn_vars_restart_read()

subroutine, public mod_atmos_dyn_vars::atmos_dyn_vars_restart_read

Read restart.

Definition at line 240 of file mod_atmos_dyn_vars.F90.

     use scale_prc, only: &
        prc_abort
     use scale_file, only: &
        file_get_aggregate
     use scale_file_cartesc, only: &
        file_cartesc_read, &
        file_cartesc_flush
     implicit none
  
     integer  :: i, j, iv
     !---------------------------------------------------------------------------
  
     if ( restart_fid /= -1 ) then
        log_newline
        log_info("ATMOS_DYN_vars_restart_read",*) 'Read from restart file (ATMOS_DYN) '
  
        do iv = 1, va
           call file_cartesc_read( restart_fid, var_name(iv), 'ZXY', & ! [IN]
                                   prog(:,:,:,iv)                    ) ! [OUT]
        enddo
  
        if ( file_get_aggregate(restart_fid) ) then
           call file_cartesc_flush( restart_fid )
           ! X/Y halos have been read from file
  
           ! fill K halos
           do iv = 1, va
              do j  = 1, ja
              do i  = 1, ia
                 prog(   1:ks-1,i,j,iv) = prog(ks,i,j,iv)
                 prog(ke+1:ka,  i,j,iv) = prog(ke,i,j,iv)
              enddo
              enddo
           enddo
        else
           call atmos_dyn_vars_fillhalo
        end if
  
        call atmos_dyn_vars_check
  
     else
        if ( va > 0 ) then
           log_error("ATMOS_DYN_vars_restart_read",*) 'invalid restart file ID for ATMOS_DYN.'
           call prc_abort
        end if
     endif
  
     return

References atmos_dyn_vars_check(), atmos_dyn_vars_fillhalo(), scale_file_cartesc::file_cartesc_flush(), scale_file::file_get_aggregate(), scale_atmos_grid_cartesc_index::ia, scale_atmos_grid_cartesc_index::ja, scale_atmos_grid_cartesc_index::ka, scale_atmos_grid_cartesc_index::ke, scale_atmos_grid_cartesc_index::ks, scale_prc::prc_abort(), prog, and scale_index::va.

Referenced by mod_atmos_vars::atmos_vars_restart_read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmos_dyn_vars_restart_create()

subroutine, public mod_atmos_dyn_vars::atmos_dyn_vars_restart_create

Create restart file.

Definition at line 292 of file mod_atmos_dyn_vars.F90.

     use scale_time, only: &
        time_gettimelabel
     use scale_file_cartesc, only: &
        file_cartesc_create
     implicit none
  
     character(len=19)     :: timelabel
     character(len=H_LONG) :: basename
     !---------------------------------------------------------------------------
  
     if ( va < 1 ) return
  
     if ( atmos_dyn_restart_out_basename /= '' ) then
  
        log_newline
        log_info("ATMOS_DYN_vars_restart_create",*) 'Create restart file (ATMOS_DYN) '
  
        if ( atmos_dyn_restart_out_postfix_timelabel ) then
           call time_gettimelabel( timelabel )
           basename = trim(atmos_dyn_restart_out_basename)//'_'//trim(timelabel)
        else
           basename = trim(atmos_dyn_restart_out_basename)
        endif
  
        log_info("ATMOS_DYN_vars_restart_create",*) 'basename: ', trim(basename)
  
        call file_cartesc_create( &
             basename, atmos_dyn_restart_out_title, atmos_dyn_restart_out_dtype, & ! [IN]
             restart_fid,                                                        & ! [OUT]
             aggregate=atmos_dyn_restart_out_aggregate                           ) ! [IN]
  
     endif
  
     return

References atmos_dyn_restart_out_aggregate, atmos_dyn_restart_out_basename, atmos_dyn_restart_out_dtype, atmos_dyn_restart_out_postfix_timelabel, atmos_dyn_restart_out_title, scale_file_cartesc::file_cartesc_create(), scale_time::time_gettimelabel(), and scale_index::va.

Referenced by mod_atmos_vars::atmos_vars_restart_create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmos_dyn_vars_restart_enddef()

subroutine, public mod_atmos_dyn_vars::atmos_dyn_vars_restart_enddef

Exit netCDF define mode.

Definition at line 331 of file mod_atmos_dyn_vars.F90.

     use scale_file_cartesc, only: &
        file_cartesc_enddef
     implicit none
  
     if ( restart_fid /= -1 .and. va > 0 ) then
        call file_cartesc_enddef( restart_fid ) ! [IN]
     endif
  
     return

References scale_file_cartesc::file_cartesc_enddef(), and scale_index::va.

Referenced by mod_atmos_vars::atmos_vars_restart_enddef().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmos_dyn_vars_restart_close()

subroutine, public mod_atmos_dyn_vars::atmos_dyn_vars_restart_close

Close restart file.

Definition at line 345 of file mod_atmos_dyn_vars.F90.

     use scale_file_cartesc, only: &
        file_cartesc_close
     implicit none
     !---------------------------------------------------------------------------
  
     if ( restart_fid /= -1 ) then
        log_newline
        log_info("ATMOS_DYN_vars_restart_close",*) 'Close restart file (ATMOS_DYN) '
  
        call file_cartesc_close( restart_fid ) ! [IN]
  
        restart_fid = -1
     endif
  
     return

References scale_file_cartesc::file_cartesc_close().

Referenced by mod_atmos_vars::atmos_vars_restart_close().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmos_dyn_vars_restart_def_var()

subroutine, public mod_atmos_dyn_vars::atmos_dyn_vars_restart_def_var

Define variables in restart file.

Definition at line 365 of file mod_atmos_dyn_vars.F90.

     use scale_file_cartesc, only: &
        file_cartesc_def_var
     implicit none
  
     integer iv
     !---------------------------------------------------------------------------
  
     if ( restart_fid /= -1 ) then
  
        do iv = 1, va
           call file_cartesc_def_var( restart_fid, var_name(iv), var_desc(iv), var_unit(iv), 'ZXY', atmos_dyn_restart_out_dtype, &
                                      var_id(iv) )
        enddo
  
     endif
  
     return

References atmos_dyn_restart_out_dtype, scale_file_cartesc::file_cartesc_def_var(), and scale_index::va.

Referenced by mod_atmos_vars::atmos_vars_restart_def_var().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmos_dyn_vars_restart_write()

subroutine, public mod_atmos_dyn_vars::atmos_dyn_vars_restart_write

Write variables to restart file.

Definition at line 387 of file mod_atmos_dyn_vars.F90.

     use scale_file_cartesc, only: &
        file_cartesc_write_var
     implicit none
  
     integer  :: iv
     !---------------------------------------------------------------------------
  
     if ( restart_fid /= -1 ) then
  
        call atmos_dyn_vars_fillhalo
  
        call atmos_dyn_vars_check
  
        do iv = 1, va
           call file_cartesc_write_var( restart_fid, var_id(iv), prog(:,:,:,iv), var_name(iv), 'ZXY' ) ! [IN]
        enddo
  
     endif
  
     return

References atmos_dyn_vars_check(), atmos_dyn_vars_fillhalo(), prog, and scale_index::va.

Referenced by mod_atmos_vars::atmos_vars_restart_write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmos_dyn_vars_check()

subroutine mod_atmos_dyn_vars::atmos_dyn_vars_check

Definition at line 410 of file mod_atmos_dyn_vars.F90.

     use scale_statistics, only: &
        statistics_total
     use scale_atmos_grid_cartesc_real, only: &
        atmos_grid_cartesc_real_vol, &
        atmos_grid_cartesc_real_totvol
     implicit none
     integer :: iv
  
     do iv = 1, va
        call valcheck( ka, ks, ke, ia, is, ie, ja, js, je, &
                       prog(:,:,:,iv),                      & ! (in)
                       -1.0e20_rp, 1.0e20_rp, var_name(iv), & ! (in)
                       __file__, __line__                   ) ! (in)
        call statistics_total( ka, ks, ke, ia, is, ie, ja, js, je, &
                               prog(:,:,:,iv), var_name(iv),       & ! (in)
                               atmos_grid_cartesc_real_vol(:,:,:), & ! (in)
                               atmos_grid_cartesc_real_totvol      ) ! (in)
     enddo
  
     return