module Atmosphere / Physics Chemistry More...

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

subroutine, public	atmos_phy_ch_vars_fillhalo
	HALO Communication. More...

subroutine, public	atmos_phy_ch_vars_restart_read
	Read restart. More...

subroutine, public	atmos_phy_ch_vars_restart_write
	Write restart. More...

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

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

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

subroutine, public	atmos_phy_ch_vars_restart_def_var
	Write restart. More...

subroutine, public	atmos_phy_ch_vars_restart_write_var
	Write restart. More...

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

character(len=h_long), public	atmos_phy_ch_restart_in_basename = ''
	basename of the restart file More...

character(len=h_long), public	atmos_phy_ch_restart_out_basename = ''
	basename of the output file More...

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

character(len=h_mid), public	atmos_phy_ch_restart_out_dtype = 'DEFAULT'
	REAL4 or REAL8. More...

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

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

Detailed Description

module Atmosphere / Physics Chemistry

Description: Container for mod_atmos_phy_ch

Author: Team SCALE

History

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

NAMELIST

PARAM_ATMOS_PHY_CH_VARS

name	type	default value	comment
ATMOS_PHY_CH_RESTART_IN_BASENAME	character(len=H_LONG)	''	basename of the restart file
ATMOS_PHY_CH_RESTART_OUTPUT	logical	.false.	output restart file?
ATMOS_PHY_CH_RESTART_OUT_BASENAME	character(len=H_LONG)	''	basename of the output file
ATMOS_PHY_CH_RESTART_OUT_TITLE	character(len=H_MID)	'ATMOS_PHY_CH restart'	title of the output file
ATMOS_PHY_CH_RESTART_OUT_DTYPE	character(len=H_MID)	'DEFAULT'	REAL4 or REAL8

History Output: No history output

Function/Subroutine Documentation

◆ atmos_phy_ch_vars_setup()

subroutine, public mod_atmos_phy_ch_vars::atmos_phy_ch_vars_setup ( )

Setup.

Definition at line 83 of file mod_atmos_phy_ch_vars.f90.

References atmos_phy_ch_o3, atmos_phy_ch_restart_in_basename, atmos_phy_ch_restart_out_basename, atmos_phy_ch_restart_out_dtype, atmos_phy_ch_restart_out_title, atmos_phy_ch_restart_output, atmos_phy_ch_rhoq_t, scale_const::const_undef, scale_grid_index::ia, scale_stdio::io_fid_conf, scale_stdio::io_fid_log, scale_stdio::io_l, scale_stdio::io_lnml, scale_grid_index::ja, scale_grid_index::ka, scale_process::prc_mpistop(), and scale_tracer::qa.

Referenced by mod_atmos_vars::atmos_vars_setup().

     use scale_process, only: &
        prc_mpistop
     use scale_const, only: &
        undef => const_undef
     implicit none
 
     namelist / param_atmos_phy_ch_vars / &
        atmos_phy_ch_restart_in_basename,  &
        atmos_phy_ch_restart_output,       &
        atmos_phy_ch_restart_out_basename, &
        atmos_phy_ch_restart_out_title,    &
        atmos_phy_ch_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 PHY_CH] / Origin[SCALE-RM]'
 
     allocate( atmos_phy_ch_rhoq_t(ka,ia,ja,qa) )
     atmos_phy_ch_rhoq_t(:,:,:,:) = undef
 
     allocate( atmos_phy_ch_o3(ka,ia,ja) )
     atmos_phy_ch_o3(:,:,:) = undef
 
     !--- read namelist
     rewind(io_fid_conf)
     read(io_fid_conf,nml=param_atmos_phy_ch_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_PHY_CH_VARS. Check!'
        call prc_mpistop
     endif
     if( io_lnml ) write(io_fid_log,nml=param_atmos_phy_ch_vars)
 
     if( io_l ) write(io_fid_log,*)
     if( io_l ) write(io_fid_log,*) '*** [ATMOS_PHY_CH] prognostic/diagnostic variables'
     if( io_l ) write(io_fid_log,'(1x,A,A15,A,A32,3(A))') &
                '***       |','VARNAME        ','|', 'DESCRIPTION                     ','[', 'UNIT            ',']'
     do iv = 1, vmax
        if( io_l ) write(io_fid_log,'(1x,A,i3,A,A15,A,A32,3(A))') &
                   '*** NO.',iv,'|',var_name(iv),'|',var_desc(iv),'[',var_unit(iv),']'
     enddo
 
     if( io_l ) write(io_fid_log,*)
     if ( atmos_phy_ch_restart_in_basename /= '' ) then
        if( io_l ) write(io_fid_log,*) '*** Restart input?  : ', trim(atmos_phy_ch_restart_in_basename)
     else
        if( io_l ) write(io_fid_log,*) '*** Restart input?  : NO'
     endif
     if (       atmos_phy_ch_restart_output             &
          .AND. atmos_phy_ch_restart_out_basename /= '' ) then
        if( io_l ) write(io_fid_log,*) '*** Restart output? : ', trim(atmos_phy_ch_restart_out_basename)
     else
        if( io_l ) write(io_fid_log,*) '*** Restart output? : NO'
        atmos_phy_ch_restart_output = .false.
     endif
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmos_phy_ch_vars_fillhalo()

subroutine, public mod_atmos_phy_ch_vars::atmos_phy_ch_vars_fillhalo ( )

HALO Communication.

Definition at line 149 of file mod_atmos_phy_ch_vars.f90.

References atmos_phy_ch_o3, scale_grid_index::ie, scale_grid_index::is, scale_grid_index::je, scale_grid_index::js, scale_grid_index::ka, scale_grid_index::ke, and scale_grid_index::ks.

Referenced by atmos_phy_ch_vars_restart_read().

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

Here is the caller graph for this function:

◆ atmos_phy_ch_vars_restart_read()

subroutine, public mod_atmos_phy_ch_vars::atmos_phy_ch_vars_restart_read ( )

Read restart.

Definition at line 173 of file mod_atmos_phy_ch_vars.f90.

References atmos_phy_ch_o3, atmos_phy_ch_restart_in_basename, atmos_phy_ch_vars_fillhalo(), scale_stdio::io_fid_log, and scale_stdio::io_l.

Referenced by mod_atmos_vars::atmos_vars_restart_read().

     use scale_fileio, only: &
        fileio_read
     use scale_rm_statistics, only: &
        stat_total
     implicit none
 
     real(RP) :: total
     !---------------------------------------------------------------------------
 
     if( io_l ) write(io_fid_log,*)
     if( io_l ) write(io_fid_log,*) '*** Input restart file (ATMOS_PHY_CH) ***'
 
     if ( atmos_phy_ch_restart_in_basename /= '' ) then
        if( io_l ) write(io_fid_log,*) '*** basename: ', trim(atmos_phy_ch_restart_in_basename)
 
        call fileio_read( atmos_phy_ch_o3(:,:,:),                                      & ! [OUT]
                          atmos_phy_ch_restart_in_basename, var_name(1), 'ZXY', step=1 ) ! [IN]
 
        call atmos_phy_ch_vars_fillhalo
 
        call stat_total( total, atmos_phy_ch_o3(:,:,:), var_name(1) )
     else
        if( io_l ) write(io_fid_log,*) '*** restart file for ATMOS_PHY_CH is not specified.'
     endif
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmos_phy_ch_vars_restart_write()

subroutine, public mod_atmos_phy_ch_vars::atmos_phy_ch_vars_restart_write ( )

Write restart.

Definition at line 204 of file mod_atmos_phy_ch_vars.f90.

References atmos_phy_ch_o3, atmos_phy_ch_restart_out_basename, atmos_phy_ch_restart_out_dtype, atmos_phy_ch_restart_out_title, scale_stdio::io_fid_log, scale_stdio::io_l, and scale_time::time_gettimelabel().

Referenced by mod_atmos_vars::atmos_vars_restart_write().

     use scale_time, only: &
        time_gettimelabel
     use scale_fileio, only: &
        fileio_write
     implicit none
 
     character(len=20)     :: timelabel
     character(len=H_LONG) :: basename
     !---------------------------------------------------------------------------
 
     if ( atmos_phy_ch_restart_out_basename /= '' ) then
 
        call time_gettimelabel( timelabel )
        write(basename,'(A,A,A)') trim(atmos_phy_ch_restart_out_basename), '_', trim(timelabel)
 
        if( io_l ) write(io_fid_log,*)
        if( io_l ) write(io_fid_log,*) '*** Output restart file (ATMOS_PHY_CH) ***'
        if( io_l ) write(io_fid_log,*) '*** basename: ', trim(basename)
 
        call fileio_write( atmos_phy_ch_o3(:,:,:), basename,             atmos_phy_ch_restart_out_title, & ! [IN]
                           var_name(1), var_desc(1), var_unit(1), 'ZXY', atmos_phy_ch_restart_out_dtype  ) ! [IN]
 
     endif
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmos_phy_ch_vars_restart_create()

subroutine, public mod_atmos_phy_ch_vars::atmos_phy_ch_vars_restart_create ( )

Create restart file.

Definition at line 234 of file mod_atmos_phy_ch_vars.f90.

References atmos_phy_ch_restart_out_basename, atmos_phy_ch_restart_out_dtype, atmos_phy_ch_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=20)     :: timelabel
     character(len=H_LONG) :: basename
     !---------------------------------------------------------------------------
 
     if ( atmos_phy_ch_restart_out_basename /= '' ) then
 
        call time_gettimelabel( timelabel )
        write(basename,'(A,A,A)') trim(atmos_phy_ch_restart_out_basename), '_', trim(timelabel)
 
        if( io_l ) write(io_fid_log,*)
        if( io_l ) write(io_fid_log,*) '*** Output restart file (ATMOS_PHY_CH) ***'
        if( io_l ) write(io_fid_log,*) '*** basename: ', trim(basename)
 
        call fileio_create(restart_fid, basename, atmos_phy_ch_restart_out_title, &
                           atmos_phy_ch_restart_out_dtype )
 
     endif
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmos_phy_ch_vars_restart_enddef()

subroutine, public mod_atmos_phy_ch_vars::atmos_phy_ch_vars_restart_enddef ( )

Exit netCDF define mode.

Definition at line 264 of file mod_atmos_phy_ch_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 .NE. -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_phy_ch_vars_restart_close()

subroutine, public mod_atmos_phy_ch_vars::atmos_phy_ch_vars_restart_close ( )

Close restart file.

Definition at line 278 of file mod_atmos_phy_ch_vars.f90.

References scale_fileio::fileio_close().

Referenced by mod_atmos_vars::atmos_vars_restart_close().

     use scale_fileio, only: &
        fileio_close
     implicit none
 
     if ( restart_fid .NE. -1 ) then
        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_phy_ch_vars_restart_def_var()

subroutine, public mod_atmos_phy_ch_vars::atmos_phy_ch_vars_restart_def_var ( )

Write restart.

Definition at line 293 of file mod_atmos_phy_ch_vars.f90.

References atmos_phy_ch_restart_out_dtype, and scale_fileio::fileio_def_var().

Referenced by mod_atmos_vars::atmos_vars_restart_def_var().

     use scale_fileio, only: &
        fileio_def_var
     implicit none
 
     !---------------------------------------------------------------------------
 
     if ( restart_fid .NE. -1 ) then
        call fileio_def_var( restart_fid, var_id(1), var_name(1), var_desc(1), &
                             var_unit(1), 'ZXY', atmos_phy_ch_restart_out_dtype  ) ! [IN]
     endif
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmos_phy_ch_vars_restart_write_var()

subroutine, public mod_atmos_phy_ch_vars::atmos_phy_ch_vars_restart_write_var ( )

Write restart.

Definition at line 310 of file mod_atmos_phy_ch_vars.f90.

References atmos_phy_ch_o3.

Referenced by mod_atmos_vars::atmos_vars_restart_write_var().

     use scale_fileio, only: &
        fileio_write_var
     implicit none
 
     !---------------------------------------------------------------------------
 
     if ( restart_fid .NE. -1 ) then
        call fileio_write_var( restart_fid, var_id(1), atmos_phy_ch_o3(:,:,:), &
                           var_name(1), 'ZXY' ) ! [IN]
     endif
 
     return