scale_timeint_rk Module Reference

Module common / Runge-Kutta scheme. More...

Data Types
type	timeint_rk
	Derived type to provide RK scheme. More...
type	timeint_rk_var
	Derived type to store pointer to variable data when using varlist in RK advance procedures. More...

Functions/Subroutines
subroutine	timeint_rk_init (this, rk_scheme_name, dt, var_num, ndim, size_each_var)
	Initialize a object to provide RK scheme.

Detailed Description

Module common / Runge-Kutta scheme.

Description

Driver module to provide various Runge-Kutta schemes.

Author

Yuta Kawai, Team SCALE

Function/Subroutine Documentation

timeint_rk_init()

subroutine scale_timeint_rk::timeint_rk_init	(	class(timeint_rk), intent(inout)	this,
		character(*), intent(in)	rk_scheme_name,
		real(rp), intent(in)	dt,
		integer, intent(in)	var_num,
		integer, intent(in)	ndim,
		integer, dimension(ndim), intent(in)	size_each_var )

Initialize a object to provide RK scheme.

Parameters

rk_scheme_name	Name of RK scheme
dt	Timestep
ndim	Number of spatial Dimension
var_num	Number of variables
size_each_var	Array to store size of each dimension

Definition at line 135 of file scale_timeint_rk.F90.

 
    use scale_timeint_rk_butcher_tab, only: &
      timeint_rk_butcher_tab_get_info,      &
      timeint_rk_butcher_tab_get      
    implicit none
    class(timeint_rk), intent(inout) :: this
    character(*), intent(in) :: rk_scheme_name
    real(RP), intent(in) :: dt
    integer, intent(in) :: var_num
    integer, intent(in) :: ndim
    integer, intent(in) :: size_each_var(ndim)
    !----------------------------------------
 
    !$acc enter data create(this)
 
    this%dt = dt
    this%ndim = ndim
    this%var_num = var_num
    allocate( this%size_each_var(ndim) )
    this%size_each_var(:) = size_each_var(:)
    !$acc enter data copyin( this%size_each_var )
    !$acc enter data attach( this%size_each_var )
 
    call timeint_rk_butcher_tab_get_info( rk_scheme_name, & ! (in)
      this%nstage, this%tend_buf_size,                    & ! (out)
      this%low_storage_flag, this%imex_flag               ) ! (out)
    
    allocate ( this%coef_a_ex(this%nstage,this%nstage), this%coef_b_ex(this%nstage), this%coef_c_ex(this%nstage) )
    allocate ( this%coef_sig_ex(this%nstage+1,this%nstage), this%coef_gam_ex(this%nstage+1,this%nstage) )
!    if (this%imex_flag) then
      allocate ( this%coef_a_im(this%nstage,this%nstage), this%coef_b_im(this%nstage), this%coef_c_im(this%nstage) )
!    end if
 
    select case(this%ndim)
    case(1)
      allocate( this%tend_buf1D_ex(size_each_var(1), var_num, this%tend_buf_size) )
      !$acc enter data create( this%tend_buf1D_ex )
      if ( this%imex_flag ) then
        allocate( this%tend_buf1D_im(size_each_var(1), var_num, this%tend_buf_size) )
      else
        allocate( this%tend_buf1D_im(1,1,1) ) ! dummy allocation to avoid error in the case of non-IMEX scheme
      end if
      !$acc enter data create( this%tend_buf1D_im )
      allocate( this%var0_1D(size_each_var(1), var_num) )
      allocate( this%varTmp_1D(size_each_var(1), var_num) ) 
      !$acc enter data create( this%var0_1D, this%varTmp_1D )
    case(2)
      allocate( this%tend_buf2D_ex(size_each_var(1),size_each_var(2), var_num, this%tend_buf_size) )
      !$acc enter data create( this%tend_buf2D_ex )
      if ( this%imex_flag ) then
        allocate( this%tend_buf2D_im(size_each_var(1),size_each_var(2), var_num, this%tend_buf_size) )
      else
        allocate( this%tend_buf2D_im(1,1,1,1) ) ! dummy allocation to avoid error in the case of non-IMEX scheme
      end if
      !$acc enter data create( this%tend_buf2D_im )
      allocate( this%var0_2D(size_each_var(1),size_each_var(2), var_num) )
      allocate( this%varTmp_2D(size_each_var(1),size_each_var(2), var_num) ) 
      !$acc enter data create( this%var0_2D, this%varTmp_2D )
    case(3)
      allocate( this%tend_buf3D_ex(size_each_var(1),size_each_var(2),size_each_var(3), var_num, this%tend_buf_size) )
      !$acc enter data create( this%tend_buf3D_ex )
      if ( this%imex_flag ) then
        allocate( this%tend_buf3D_im(size_each_var(1),size_each_var(2),size_each_var(3), var_num, this%tend_buf_size) )
      else
        allocate( this%tend_buf3D_im(1,1,1,1,1) ) ! dummy allocation to avoid error in the case of non-IMEX scheme
      end if
      !$acc enter data create( this%tend_buf3D_im )
      allocate( this%var0_3D(size_each_var(1),size_each_var(2),size_each_var(3), var_num) )
      allocate( this%varTmp_3D(size_each_var(1),size_each_var(2),size_each_var(3), var_num) ) 
      !$acc enter data create( this%var0_3D, this%varTmp_3D )
    end select
    allocate( this%tend_buf_indmap(this%nstage) )
 
    call timeint_rk_butcher_tab_get( &
      rk_scheme_name, this%nstage, this%imex_flag,    & ! (in)
      this%coef_a_ex, this%coef_b_ex, this%coef_c_ex, & ! (out)
      this%coef_sig_ex, this%coef_gam_ex,             & ! (out)
      this%coef_a_im, this%coef_b_im, this%coef_c_im, & ! (out)
      this%tend_buf_indmap                            ) ! (out)
 
    !$acc enter data copyin( this%coef_a_ex, this%coef_b_ex, this%coef_c_ex, &
    !$acc this%coef_sig_ex, this%coef_gam_ex,                                &
    !$acc this%coef_a_im, this%coef_b_im, this%coef_c_im,                    &
    !$acc this%tend_buf_indmap )      
 
    !$acc enter data attach( this%coef_a_ex, this%coef_b_ex, this%coef_c_ex, &
    !$acc this%coef_sig_ex, this%coef_gam_ex,                                &
    !$acc this%coef_a_im, this%coef_b_im, this%coef_c_im,                    &
    !$acc this%tend_buf_indmap )      
 
    !$acc update device( this%dt, this%rk_scheme_id_ex, this%rk_scheme_id_im, this%nstage, this%tend_buf_size, this%var_num, this%low_storage_flag, this%imex_flag, this%ndim )
    return

References scale_timeint_rk_butcher_tab::timeint_rk_butcher_tab_get(), and scale_timeint_rk_butcher_tab::timeint_rk_butcher_tab_get_info().