mod_atmos_dyn_vars Module Reference

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...

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_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_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

History

• 2014-05-04 (H.Yashiro) [new]

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_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_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 79 of file mod_atmos_dyn_vars.f90.

References atmos_dyn_restart_in_basename, atmos_dyn_restart_in_postfix_timelabel, 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_grid_index::ia, scale_stdio::io_fid_conf, scale_stdio::io_fid_log, scale_stdio::io_fid_nml, scale_stdio::io_l, scale_stdio::io_nml, scale_grid_index::ja, scale_grid_index::ka, scale_process::prc_mpistop(), prog, and scale_index::va.

Referenced by mod_atmos_vars::atmos_vars_setup().

    use scale_process, only: &
       prc_mpistop
    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_postfix_timelabel,  &
       atmos_dyn_restart_output,                &
       atmos_dyn_restart_out_basename,          &
       atmos_dyn_restart_out_postfix_timelabel, &
       atmos_dyn_restart_out_title,             &
       atmos_dyn_restart_out_dtype

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

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '++++++ Module[VARS] / Categ[ATMOS DYN] / Origin[SCALE-RM]'

    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_atmos_dyn_vars,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_ATMOS_DYN_VARS. Check!'
       call prc_mpistop
    endif
    if( io_nml ) write(io_fid_nml,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
          write(*,*) 'xxx number of the prognostic variables is exceed the limit', va, ' > ', vmax
          call prc_mpistop
       endif
       allocate( prog(ka,ia,ja,va) )
       prog(:,:,:,:) = undef

       if( io_l ) write(io_fid_log,*)
       if( io_l ) write(io_fid_log,*) '*** [ATMOS_DYN] prognostic/diagnostic variables'
       if( io_l ) write(io_fid_log,'(1x,A,A24,A,A48,A,A12,A)') &
                  '***       |', 'VARNAME                 ','|', &
                  'DESCRIPTION                                     ', '[', 'UNIT        ', ']'
       do iv = 1, va
          if( io_l ) write(io_fid_log,'(1x,A,I3,A,A24,A,A48,A,A12,A)') &
                     '*** NO.',iv,'|',var_name(iv),'|',var_desc(iv),'[',var_unit(iv),']'
       enddo

       if( io_l ) write(io_fid_log,*)
       if ( atmos_dyn_restart_in_basename /= '' ) then
          if( io_l ) write(io_fid_log,*) '*** Restart input?  : YES, file = ', trim(atmos_dyn_restart_in_basename)
          if( io_l ) write(io_fid_log,*) '*** Add timelabel?  : ', atmos_dyn_restart_in_postfix_timelabel
       else
          if( io_l ) write(io_fid_log,*) '*** Restart input?  : NO'
       endif
       if (       atmos_dyn_restart_output             &
            .AND. atmos_dyn_restart_out_basename /= '' ) then
          if( io_l ) write(io_fid_log,*) '*** Restart output? : YES, file = ', trim(atmos_dyn_restart_out_basename)
          if( io_l ) write(io_fid_log,*) '*** Add timelabel?  : ', atmos_dyn_restart_out_postfix_timelabel
       else
          if( io_l ) write(io_fid_log,*) '*** 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

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 171 of file mod_atmos_dyn_vars.f90.

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

Referenced by atmos_dyn_vars_restart_read(), and atmos_dyn_vars_restart_write().

    use scale_comm, 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

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 200 of file mod_atmos_dyn_vars.f90.

References atmos_dyn_restart_in_basename, atmos_dyn_restart_in_postfix_timelabel, scale_fileio::fileio_open(), scale_stdio::io_fid_log, scale_stdio::io_l, and scale_time::time_gettimelabel().

Referenced by mod_atmos_vars::atmos_vars_restart_open().

    use scale_time, only: &
       time_gettimelabel
    use scale_fileio, only: &
       fileio_open
    implicit none

    character(len=19)     :: timelabel
    character(len=H_LONG) :: basename
    !---------------------------------------------------------------------------

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '*** 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

       if( io_l ) write(io_fid_log,*) '*** basename: ', trim(basename)

       call fileio_open( restart_fid, basename )
    else
       if( io_l ) write(io_fid_log,*) '*** restart file for ATMOS_DYN is not specified.'
    endif

    return

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 235 of file mod_atmos_dyn_vars.f90.

References atmos_dyn_vars_fillhalo(), scale_fileio::fileio_flush(), scale_grid_index::ia, scale_stdio::io_aggregate, scale_stdio::io_fid_log, scale_stdio::io_l, scale_grid_index::ja, scale_grid_index::ka, scale_grid_index::ke, scale_grid_index::ks, prog, scale_rm_statistics::statistics_checktotal, and scale_index::va.

Referenced by mod_atmos_vars::atmos_vars_restart_read().

    use scale_rm_statistics, only: &
       statistics_checktotal, &
       stat_total
    use scale_fileio, only: &
       fileio_read, &
       fileio_flush
    implicit none

    real(RP) :: total
    integer  :: i, j, iv
    !---------------------------------------------------------------------------

    if ( restart_fid /= -1 ) then
       if( io_l ) write(io_fid_log,*)
       if( io_l ) write(io_fid_log,*) '*** Read from restart file (ATMOS_DYN) ***'

       do iv = 1, va
          call fileio_read( prog(:,:,:,iv),                          & ! [OUT]
                            restart_fid, var_name(iv), 'ZXY', step=1 ) ! [IN]
       enddo

       if ( io_aggregate ) then
          call fileio_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

       if ( statistics_checktotal ) then
          do iv = 1, va
             call stat_total( total, prog(:,:,:,iv), var_name(iv) )
          enddo
       endif
    else
       if( io_l ) write(io_fid_log,*) '*** invalid restart file ID for ATMOS_DYN.'
    endif

    return

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 287 of file mod_atmos_dyn_vars.f90.

References atmos_dyn_restart_out_basename, atmos_dyn_restart_out_dtype, atmos_dyn_restart_out_postfix_timelabel, atmos_dyn_restart_out_title, scale_fileio::fileio_create(), scale_stdio::io_fid_log, scale_stdio::io_l, and scale_time::time_gettimelabel().

Referenced by mod_atmos_vars::atmos_vars_restart_create().

    use scale_time, only: &
       time_gettimelabel
    use scale_fileio, only: &
       fileio_create
    implicit none

    character(len=19)     :: timelabel
    character(len=H_LONG) :: basename
    !---------------------------------------------------------------------------

    if ( atmos_dyn_restart_out_basename /= '' ) then

       if( io_l ) write(io_fid_log,*)
       if( io_l ) write(io_fid_log,*) '*** 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

       if( io_l ) write(io_fid_log,*) '*** basename: ', trim(basename)

       call fileio_create( restart_fid,                                                       & ! [OUT]
                           basename, atmos_dyn_restart_out_title, atmos_dyn_restart_out_dtype ) ! [IN]

    endif

    return

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 322 of file mod_atmos_dyn_vars.f90.

References scale_fileio::fileio_enddef().

Referenced by mod_atmos_vars::atmos_vars_restart_enddef().

    use scale_fileio, only: &
       fileio_enddef
    implicit none

    if ( restart_fid /= -1 ) then
       call fileio_enddef( restart_fid ) ! [IN]
    endif

    return

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 336 of file mod_atmos_dyn_vars.f90.

References scale_fileio::fileio_close(), scale_stdio::io_fid_log, and scale_stdio::io_l.

Referenced by mod_atmos_vars::atmos_vars_restart_close().

    use scale_fileio, only: &
       fileio_close
    implicit none
    !---------------------------------------------------------------------------

    if ( restart_fid /= -1 ) then
       if( io_l ) write(io_fid_log,*)
       if( io_l ) write(io_fid_log,*) '*** Close restart file (ATMOS_DYN) ***'

       call fileio_close( restart_fid ) ! [IN]

       restart_fid = -1
    endif

    return

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 356 of file mod_atmos_dyn_vars.f90.

References atmos_dyn_restart_out_dtype, scale_fileio::fileio_def_var(), and scale_index::va.

Referenced by mod_atmos_vars::atmos_vars_restart_def_var().

    use scale_fileio, only: &
       fileio_def_var
    implicit none

    integer iv
    !---------------------------------------------------------------------------

    if ( restart_fid /= -1 ) then

       do iv = 1, va
          call fileio_def_var( restart_fid, var_id(iv), var_name(iv), var_desc(iv), &
                               var_unit(iv), 'ZXY', atmos_dyn_restart_out_dtype     ) ! [IN]
       enddo

    endif

    return

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 378 of file mod_atmos_dyn_vars.f90.

References atmos_dyn_vars_fillhalo(), prog, scale_rm_statistics::statistics_checktotal, and scale_index::va.

Referenced by mod_atmos_vars::atmos_vars_restart_write().

    use scale_rm_statistics, only: &
       statistics_checktotal, &
       stat_total
    use scale_fileio, only: &
       fileio_write_var
    implicit none

    real(RP) :: total
    integer  :: iv
    !---------------------------------------------------------------------------

    if ( restart_fid /= -1 ) then

       call atmos_dyn_vars_fillhalo

       if ( statistics_checktotal ) then
          do iv = 1, va
             call stat_total( total, prog(:,:,:,iv), var_name(iv) )
          enddo
       endif

       do iv = 1, va
          call fileio_write_var( restart_fid, var_id(iv), prog(:,:,:,iv), var_name(iv), 'ZXY' ) ! [IN]
       enddo

    endif

    return

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

atmos_dyn_restart_output

logical, public mod_atmos_dyn_vars::atmos_dyn_restart_output = .false.

output restart file?

Definition at line 47 of file mod_atmos_dyn_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), and atmos_dyn_vars_setup().

  logical,               public :: ATMOS_DYN_RESTART_OUTPUT                = .false.             

atmos_dyn_restart_in_basename

character(len=h_long), public mod_atmos_dyn_vars::atmos_dyn_restart_in_basename = ''

Basename of the input file.

Definition at line 49 of file mod_atmos_dyn_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), atmos_dyn_vars_restart_open(), and atmos_dyn_vars_setup().

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

atmos_dyn_restart_in_postfix_timelabel

logical, public mod_atmos_dyn_vars::atmos_dyn_restart_in_postfix_timelabel = .false.

Add timelabel to the basename of input file?

Definition at line 50 of file mod_atmos_dyn_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), atmos_dyn_vars_restart_open(), and atmos_dyn_vars_setup().

  logical,                public :: ATMOS_DYN_RESTART_IN_POSTFIX_TIMELABEL  = .false.             

atmos_dyn_restart_out_basename

character(len=h_long), public mod_atmos_dyn_vars::atmos_dyn_restart_out_basename = ''

Basename of the output file.

Definition at line 51 of file mod_atmos_dyn_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), atmos_dyn_vars_restart_create(), and atmos_dyn_vars_setup().

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

atmos_dyn_restart_out_postfix_timelabel

logical, public mod_atmos_dyn_vars::atmos_dyn_restart_out_postfix_timelabel = .true.

Add timelabel to the basename of output file?

Definition at line 52 of file mod_atmos_dyn_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), atmos_dyn_vars_restart_create(), and atmos_dyn_vars_setup().

  logical,                public :: ATMOS_DYN_RESTART_OUT_POSTFIX_TIMELABEL = .true.              

atmos_dyn_restart_out_title

character(len=h_mid), public mod_atmos_dyn_vars::atmos_dyn_restart_out_title = 'ATMOS_DYN restart'

title of the output file

Definition at line 53 of file mod_atmos_dyn_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), atmos_dyn_vars_restart_create(), and atmos_dyn_vars_setup().

  character(len=H_MID),   public :: ATMOS_DYN_RESTART_OUT_TITLE             = 'ATMOS_DYN restart'

atmos_dyn_restart_out_dtype

character(len=h_short), public mod_atmos_dyn_vars::atmos_dyn_restart_out_dtype = 'DEFAULT'

REAL4 or REAL8.

Definition at line 54 of file mod_atmos_dyn_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), atmos_dyn_vars_restart_create(), atmos_dyn_vars_restart_def_var(), and atmos_dyn_vars_setup().

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

prog

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

Definition at line 57 of file mod_atmos_dyn_vars.f90.

Referenced by mod_atmos_dyn_driver::atmos_dyn_driver(), mod_atmos_dyn_driver::atmos_dyn_driver_setup(), atmos_dyn_vars_fillhalo(), atmos_dyn_vars_restart_read(), atmos_dyn_vars_restart_write(), and atmos_dyn_vars_setup().

  real(RP), public, allocatable :: PROG(:,:,:,:)