module TOPOGRAPHY More...

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

subroutine, public	topography_fillhalo (Zsfc, FILL_BND)
	HALO Communication. More...

subroutine, public	topography_finalize
	finalize More...

subroutine, public	topography_write
	Write topography. More...

subroutine, public	topography_calc_tan_slope (IA, IS, IE, JA, JS, JE, RCDX, RCDY, MAPF)

Variables
logical, public	topography_exist = .false.
	topography exists? More...

real(rp), dimension(:,:), allocatable, public	topography_zsfc
	absolute ground height [m] More...

real(rp), dimension(:,:), allocatable, public	topography_tansl_x
	tan(slope_x) More...

real(rp), dimension(:,:), allocatable, public	topography_tansl_y
	tan(slope_y) More...

Detailed Description

module TOPOGRAPHY

Description: Topography module

Author: Team SCALE

NAMELIST

PARAM_TOPOGRAPHY

name	type	default value	comment
TOPOGRAPHY_IN_BASENAME	character(len=H_LONG)	''	basename of the input file
TOPOGRAPHY_IN_VARNAME	character(len=H_LONG)	'topo'	variable name of topo in the input file
TOPOGRAPHY_IN_AGGREGATE	logical		> switch to use aggregated file
TOPOGRAPHY_IN_CHECK_COORDINATES	logical	.false.	> switch for check of coordinates
TOPOGRAPHY_OUT_BASENAME	character(len=H_LONG)	''	basename of the output file
TOPOGRAPHY_OUT_AGGREGATE	logical		> switch to use aggregated file
TOPOGRAPHY_OUT_DTYPE	character(len=H_SHORT)	'DEFAULT'	REAL4 or REAL8

History Output: No history output

Function/Subroutine Documentation

◆ topography_setup()

subroutine, public scale_topography::topography_setup

Setup.

Definition at line 67 of file scale_topography.F90.

     use scale_file, only: &
        file_aggregate
     use scale_prc, only: &
        prc_abort
     implicit none
  
     namelist / param_topography / &
        topography_in_basename,          &
        topography_in_varname,           &
        topography_in_aggregate,         &
        topography_in_check_coordinates, &
        topography_out_basename,         &
        topography_out_aggregate,        &
        topography_out_dtype
  
     integer :: ierr
     !---------------------------------------------------------------------------
  
     log_newline
     log_info("TOPOGRAPHY_setup",*) 'Setup'
  
     topography_in_aggregate  = file_aggregate
     topography_out_aggregate = file_aggregate
  
     !--- read namelist
     rewind(io_fid_conf)
     read(io_fid_conf,nml=param_topography,iostat=ierr)
     if( ierr < 0 ) then !--- missing
        log_info("TOPOGRAPHY_setup",*) 'Not found namelist. Default used.'
     elseif( ierr > 0 ) then !--- fatal error
        log_error("TOPOGRAPHY_setup",*) 'Not appropriate names in namelist PARAM_TOPOGRAPHY. Check!'
        call prc_abort
     endif
     log_nml(param_topography)
  
     allocate( topography_zsfc(ia,ja) )
     allocate( topography_tansl_x(ia,ja) )
     allocate( topography_tansl_y(ia,ja) )
     topography_zsfc(:,:) = 0.0_rp
     topography_tansl_x(:,:) = 0.0_rp
     topography_tansl_y(:,:) = 0.0_rp
     !$acc enter data copyin(TOPOGRAPHY_Zsfc, TOPOGRAPHY_TanSL_X, TOPOGRAPHY_TanSL_Y)
  
     ! read from file
     call topography_read
  
     return

References scale_file::file_aggregate, scale_atmos_grid_cartesc_index::ia, scale_io::io_fid_conf, scale_atmos_grid_cartesc_index::ja, scale_prc::prc_abort(), topography_tansl_x, topography_tansl_y, and topography_zsfc.

Referenced by mod_rm_driver::rm_driver(), and mod_rm_prep::rm_prep().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ topography_fillhalo()

subroutine, public scale_topography::topography_fillhalo	(	real(rp), dimension(ia,ja), intent(inout), optional	Zsfc,
		logical, intent(in), optional	FILL_BND
	)

HALO Communication.

Definition at line 119 of file scale_topography.F90.

     use scale_comm_cartesc, only: &
        comm_vars8, &
        comm_wait
     implicit none
  
     real(RP), intent(inout), optional :: Zsfc(IA,JA)
     logical,  intent(in),    optional :: FILL_BND
  
     logical :: FILL_BND_
     !---------------------------------------------------------------------------
  
     fill_bnd_ = .false.
     if ( present(fill_bnd) ) fill_bnd_ = fill_bnd
  
     if ( present(zsfc) ) then
        call comm_vars8( zsfc(:,:), 1 )
        call comm_wait ( zsfc(:,:), 1, fill_bnd_ )
     else
        call comm_vars8( topography_zsfc(:,:), 1 )
        call comm_wait ( topography_zsfc(:,:), 1, fill_bnd_ )
     end if
  
     return

References topography_zsfc.

Referenced by mod_cnvtopo::cnvtopo(), topography_calc_tan_slope(), topography_finalize(), and topography_write().

Here is the caller graph for this function:

◆ topography_finalize()

subroutine, public scale_topography::topography_finalize

finalize

Definition at line 147 of file scale_topography.F90.

     implicit none
     !---------------------------------------------------------------------------
  
     !$acc exit data delete(TOPOGRAPHY_Zsfc, TOPOGRAPHY_TanSL_X, TOPOGRAPHY_TanSL_Y)
     deallocate( topography_zsfc    )
     deallocate( topography_tansl_x )
     deallocate( topography_tansl_y )
  
     return

References scale_file_cartesc::file_cartesc_close(), scale_file_cartesc::file_cartesc_flush(), scale_file_cartesc::file_cartesc_open(), scale_prc::prc_abort(), topography_exist, topography_fillhalo(), topography_tansl_x, topography_tansl_y, and topography_zsfc.

Referenced by mod_rm_driver::rm_driver(), and mod_rm_prep::rm_prep().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ topography_write()

subroutine, public scale_topography::topography_write

Write topography.

Definition at line 208 of file scale_topography.F90.

     use scale_file_cartesc, only: &
        file_cartesc_create,    &
        file_cartesc_def_var,   &
        file_cartesc_enddef,    &
        file_cartesc_write_var, &
        file_cartesc_close
     implicit none
  
     integer :: fid, vid
     !---------------------------------------------------------------------------
  
     if ( topography_out_basename /= '' .and. topography_out_basename /= topography_in_basename ) then
  
        log_newline
        log_info("TOPOGRAPHY_write",*) 'Output topography file '
  
        call topography_fillhalo( fill_bnd=.false. )
  
        call file_cartesc_create( topography_out_basename, topography_out_title, topography_out_dtype, & ! [IN]
                                  fid,                                                                 & ! [OUT]
                                  haszcoord=.false., aggregate=topography_out_aggregate                ) ! [IN]
  
        call file_cartesc_def_var( fid, 'topo', 'Topography', 'm', 'XY', topography_out_dtype, & ! [IN]
                                   vid,                                                        & ! [OUT]
                                   standard_name="surface_altitude"                            ) ! [IN]
  
        call file_cartesc_enddef( fid )
  
        call file_cartesc_write_var( fid, vid, topography_zsfc(:,:), 'topo', 'XY' ) ! [IN]
  
  
        call file_cartesc_close( fid )
  
     endif
  
     return

References scale_file_cartesc::file_cartesc_close(), scale_file_cartesc::file_cartesc_create(), scale_file_cartesc::file_cartesc_def_var(), scale_file_cartesc::file_cartesc_enddef(), topography_fillhalo(), and topography_zsfc.

Referenced by mod_rm_driver::rm_driver(), and mod_rm_prep::rm_prep().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ topography_calc_tan_slope()

subroutine, public scale_topography::topography_calc_tan_slope	(	integer, intent(in)	IA,
		integer, intent(in)	IS,
		integer, intent(in)	IE,
		integer, intent(in)	JA,
		integer, intent(in)	JS,
		integer, intent(in)	JE,
		real(rp), dimension(ia), intent(in)	RCDX,
		real(rp), dimension(ja), intent(in)	RCDY,
		real(rp), dimension(ia,ja,2), intent(in)	MAPF
	)

Definition at line 249 of file scale_topography.F90.

     use scale_prc_cartesc, only: &
        prc_twod
     implicit none
     integer,  intent(in) :: IA, IS, IE
     integer,  intent(in) :: JA, JS, JE
     real(RP), intent(in) :: RCDX(IA), RCDY(JA)
     real(RP), intent(in) :: MAPF(IA,JA,2)
  
     integer :: i, j
  
     if ( prc_twod ) then
        !$omp parallel do
        !$acc kernels
        do j = js, je
        do i = is, ie
           topography_tansl_x(i,j) = 0.0_rp
        end do
        end do
        !$acc end kernels
     else
        !$omp parallel do
        !$acc kernels
        do j = js, je
        do i = is, ie
           topography_tansl_x(i,j) = ( ( topography_zsfc(i+1,j) + topography_zsfc(i  ,j) ) * 0.5_rp &
                                     - ( topography_zsfc(i  ,j) + topography_zsfc(i-1,j) ) * 0.5_rp ) &
                                     * rcdx(i) * mapf(i,j,1)
        end do
        end do
        !$acc end kernels
     end if
     !$omp parallel do
     !$acc kernels
     do j = js, je
     do i = is, ie
        topography_tansl_y(i,j) = ( ( topography_zsfc(i,j+1) + topography_zsfc(i,j  ) ) * 0.5_rp &
                                  - ( topography_zsfc(i,j  ) + topography_zsfc(i,j-1) ) * 0.5_rp ) &
                                * rcdy(j) * mapf(i,j,2)
     end do
     end do
     !$acc end kernels
  
     call topography_fillhalo( topography_tansl_x(:,:), .true. )
     call topography_fillhalo( topography_tansl_y(:,:), .true. )
     !$acc update host(TOPOGRAPHY_TanSL_X, TOPOGRAPHY_TanSL_Y)
  
     return