Functions/Subroutines
subroutine, public	spnudge_setup (KA, KS, KE, IA, IS, IE, JA, JS, JE)

subroutine, public	spnudge_finalize

Variables
logical, public	spnudge_uv = .false.

logical, public	spnudge_uv_divfree = .false.

integer, public	spnudge_uv_lm = 3

integer, public	spnudge_uv_mm = 3

logical, public	spnudge_pt = .false.

integer, public	spnudge_pt_lm = 3

integer, public	spnudge_pt_mm = 3

logical, public	spnudge_qv = .false.

integer, public	spnudge_qv_lm = 3

integer, public	spnudge_qv_mm = 3

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

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

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

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

Detailed Description

NAMELIST

PARAM_SPNUDGE

name	type	default value	comment
SPNUDGE_UV	logical	.false.
SPNUDGE_UV_DIVFREE	logical	.false.
SPNUDGE_UV_LM	integer	3
SPNUDGE_UV_MM	integer	3
SPNUDGE_UV_TAU	real(RP)	0.0_RP
SPNUDGE_PT	logical	.false.
SPNUDGE_PT_LM	integer	3
SPNUDGE_PT_MM	integer	3
SPNUDGE_PT_TAU	real(RP)	0.0_RP
SPNUDGE_QV	logical	.false.
SPNUDGE_QV_LM	integer	3
SPNUDGE_QV_MM	integer	3
SPNUDGE_QV_TAU	real(RP)	0.0_RP
SPNUDGE_LEVEL1	real(RP)	0.0_RP	> alpha = 0 for z < SPNUDGE_level1
SPNUDGE_LEVEL2	real(RP)	0.0_RP
SPNUDGE_LEVEL3	real(RP)	1E10_RP	> alpha = alpha for SPNUDGE_level2 <= z < SPNUDGE_level3
SPNUDGE_LEVEL4	real(RP)	1E10_RP	> alpha = 0 for z => SPNUDGE_level4

History Output: No history output

Function/Subroutine Documentation

◆ spnudge_setup()

subroutine, public scale_spnudge::spnudge_setup	(	integer, intent(in)	KA,
		integer, intent(in)	KS,
		integer, intent(in)	KE,
		integer, intent(in)	IA,
		integer, intent(in)	IS,
		integer, intent(in)	IE,
		integer, intent(in)	JA,
		integer, intent(in)	JS,
		integer, intent(in)	JE
	)

Definition at line 51 of file scale_spnudge.F90.

     use scale_dft, only: &
        dft_setup
     use scale_atmos_grid_cartesc_real, only: &
        real_cz => atmos_grid_cartesc_real_cz, &
        real_czuy => atmos_grid_cartesc_real_czuy, &
        real_czxv => atmos_grid_cartesc_real_czxv
     implicit none
     integer, intent(in) :: KA, KS, KE
     integer, intent(in) :: IA, IS, IE
     integer, intent(in) :: JA, JS, JE
  
     real(RP) :: SPNUDGE_uv_tau    = 0.0_rp
     real(RP) :: SPNUDGE_pt_tau = 0.0_rp
     real(RP) :: SPNUDGE_qv_tau = 0.0_rp
  
     real(RP) :: SPNUDGE_level1 = 0.0_rp
     real(RP) :: SPNUDGE_level2 = 0.0_rp
     real(RP) :: SPNUDGE_level3 = 1e10_rp
     real(RP) :: SPNUDGE_level4 = 1e10_rp
  
     namelist /param_spnudge/ &
       spnudge_uv, &
       spnudge_uv_divfree, &
       spnudge_uv_lm, &
       spnudge_uv_mm, &
       spnudge_uv_tau, &
       spnudge_pt, &
       spnudge_pt_lm, &
       spnudge_pt_mm, &
       spnudge_pt_tau, &
       spnudge_qv, &
       spnudge_qv_lm, &
       spnudge_qv_mm, &
       spnudge_qv_tau, &
       spnudge_level1, &
       spnudge_level2, &
       spnudge_level3, &
       spnudge_level4
  
     real(RP) :: uv_alpha, pt_alpha, qv_alpha
  
  
     integer :: k, i, j
     integer :: ierr
     !---------------------------------------------------------------------------
  
     log_newline
     log_info("SPNUDGE_setup",*) 'Setup'
  
     !--- read namelist
     rewind(io_fid_conf)
     read(io_fid_conf,nml=param_spnudge,iostat=ierr)
     if( ierr < 0 ) then !--- missing
        log_info("SPNUDGE_setup",*) 'Not found namelist. Default used.'
     elseif( ierr > 0 ) then !--- fatal error
        log_error("SPNUDGE_setup",*) 'Not appropriate names in namelist PARAM_SPNUDGE. Check!'
        call prc_abort
     endif
     log_nml(param_spnudge)
  
     if ( spnudge_level1 > spnudge_level2 ) then
        log_error("SPNUDGE_setup",*) 'SPNUDGE_level1 must be lowere or equal to SPNUDGE_level2'
        call prc_abort
     end if
     if ( spnudge_level2 > spnudge_level3 ) then
        log_error("SPNUDGE_setup",*) 'SPNUDGE_level2 must be lowere or equal to SPNUDGE_level3'
        call prc_abort
     end if
     if ( spnudge_level3 > spnudge_level4 ) then
        log_error("SPNUDGE_setup",*) 'SPNUDGE_level3 must be lowere or equal to SPNUDGE_level4'
        call prc_abort
     end if
  
     if ( spnudge_uv .or. spnudge_pt .or. spnudge_qv ) then
        log_warn("SPNUDGE_setup",*) 'Spectrul nudging is still experimental'
     end if
  
     allocate( spnudge_u_alpha(ka,ia,ja) )
     allocate( spnudge_v_alpha(ka,ia,ja) )
     allocate( spnudge_pt_alpha(ka,ia,ja) )
     allocate( spnudge_qv_alpha(ka,ia,ja) )
  
     if ( spnudge_uv .and. spnudge_uv_tau > 0.0_rp ) then
        uv_alpha = 1.0_rp / spnudge_uv_tau
  
        !$omp parallel do
        do j = js, je
        do i = is, ie
        do k = ks, ke
           if ( real_czuy(k,i,j) < spnudge_level1 ) then
              spnudge_u_alpha(k,i,j) = 0.0_rp
           elseif ( real_czuy(k,i,j) < spnudge_level2 ) then
              spnudge_u_alpha(k,i,j) = ( real_czuy(k,i,j) - spnudge_level1 ) / ( spnudge_level2 - spnudge_level1 ) * uv_alpha
           elseif ( real_czuy(k,i,j) < spnudge_level3 ) then
              spnudge_u_alpha(k,i,j) = uv_alpha
           elseif ( real_czuy(k,i,j) < spnudge_level4 ) then
              spnudge_u_alpha(k,i,j) = ( real_czuy(k,i,j) - spnudge_level3 ) / ( spnudge_level4 - spnudge_level3 ) * uv_alpha
           else
              spnudge_u_alpha(k,i,j) = 0.0_rp
           endif
        enddo
        enddo
        enddo
  
        !$omp parallel do
        do j = js, je
        do i = is, ie
        do k = ks, ke
           if ( real_czxv(k,i,j) < spnudge_level1 ) then
              spnudge_v_alpha(k,i,j) = 0.0_rp
           elseif ( real_czxv(k,i,j) < spnudge_level2 ) then
              spnudge_v_alpha(k,i,j) = ( real_czxv(k,i,j) - spnudge_level1 ) / ( spnudge_level2 - spnudge_level1 ) * uv_alpha
           elseif ( real_czxv(k,i,j) < spnudge_level3 ) then
              spnudge_v_alpha(k,i,j) = uv_alpha
           elseif ( real_czxv(k,i,j) < spnudge_level4 ) then
              spnudge_v_alpha(k,i,j) = ( real_czxv(k,i,j) - spnudge_level3 ) / ( spnudge_level4 - spnudge_level3 ) * uv_alpha
           else
              spnudge_v_alpha(k,i,j) = 0.0_rp
           endif
        enddo
        enddo
        enddo
  
     else
  
        !$omp parallel do
        do j = js, je
        do i = is, ie
        do k = ks, ke
           spnudge_u_alpha(k,i,j) = 0.0_rp
           spnudge_v_alpha(k,i,j) = 0.0_rp
        end do
        end do
        end do
  
     endif
  
     if ( spnudge_pt .and. spnudge_pt_tau > 0.0_rp ) then
         pt_alpha = 1.0_rp / spnudge_pt_tau
  
         !$omp parallel do
         do j = js, je
         do i = is, ie
         do k = ks, ke
            if ( real_cz(k,i,j) < spnudge_level1 ) then
               spnudge_pt_alpha(k,i,j) = 0.0_rp
            elseif ( real_cz(k,i,j) < spnudge_level2 ) then
               spnudge_pt_alpha(k,i,j) = ( real_cz(k,i,j) - spnudge_level1 ) / ( spnudge_level2 - spnudge_level1 ) * pt_alpha
            elseif ( real_cz(k,i,j) < spnudge_level3 ) then
               spnudge_pt_alpha(k,i,j) = pt_alpha
            elseif ( real_cz(k,i,j) < spnudge_level4 ) then
               spnudge_pt_alpha(k,i,j) = ( real_cz(k,i,j) - spnudge_level3 ) / ( spnudge_level4 - spnudge_level3 ) * pt_alpha
            else
               spnudge_pt_alpha(k,i,j) = 0.0_rp
            endif
         enddo
         enddo
         enddo
  
      else
  
         !$omp parallel do
         do j = js, je
         do i = is, ie
         do k = ks, ke
            spnudge_pt_alpha(k,i,j) = 0.0_rp
         end do
         end do
         end do
  
     endif
  
     if ( spnudge_qv .and. spnudge_qv_tau > 0.0_rp ) then
         qv_alpha = 1.0_rp / spnudge_qv_tau
  
         !$omp parallel do
         do j = js, je
         do i = is, ie
         do k = ks, ke
            if ( real_cz(k,i,j) < spnudge_level1 ) then
               spnudge_qv_alpha(k,i,j) = 0.0_rp
            elseif ( real_cz(k,i,j) < spnudge_level2 ) then
               spnudge_qv_alpha(k,i,j) = ( real_cz(k,i,j) - spnudge_level1 ) / ( spnudge_level2 - spnudge_level1 ) * qv_alpha
            elseif ( real_cz(k,i,j) < spnudge_level3 ) then
               spnudge_qv_alpha(k,i,j) = qv_alpha
            elseif ( real_cz(k,i,j) < spnudge_level4 ) then
               spnudge_qv_alpha(k,i,j) = ( real_cz(k,i,j) - spnudge_level3 ) / ( spnudge_level4 - spnudge_level3 ) * qv_alpha
            else
               spnudge_qv_alpha(k,i,j) = 0.0_rp
            endif
         enddo
         enddo
         enddo
  
      else
  
         !$omp parallel do
         do j = js, je
         do i = is, ie
         do k = ks, ke
            spnudge_qv_alpha(k,i,j) = 0.0_rp
         end do
         end do
         end do
  
      end if
  
      !$acc enter data copyin(SPNUDGE_u_alpha, SPNUDGE_v_alpha, SPNUDGE_pt_alpha, SPNUDGE_qv_alpha)
  
      call dft_setup( ka, ks, ke, ia, is, ie, ja, js, je, &
                      max( spnudge_uv_lm, spnudge_pt_lm, spnudge_qv_lm ), &
                      max( spnudge_uv_mm, spnudge_pt_mm, spnudge_qv_mm ) )
  
      return

References scale_atmos_grid_cartesc_real::atmos_grid_cartesc_real_cz, scale_atmos_grid_cartesc_real::atmos_grid_cartesc_real_czuy, scale_atmos_grid_cartesc_real::atmos_grid_cartesc_real_czxv, scale_dft::dft_setup(), scale_io::io_fid_conf, scale_prc::prc_abort(), spnudge_pt, spnudge_pt_alpha, spnudge_pt_lm, spnudge_pt_mm, spnudge_qv, spnudge_qv_alpha, spnudge_qv_lm, spnudge_qv_mm, spnudge_u_alpha, spnudge_uv, spnudge_uv_divfree, spnudge_uv_lm, spnudge_uv_mm, and spnudge_v_alpha.

Referenced by scale_atmos_dyn::atmos_dyn_setup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ spnudge_finalize()

subroutine, public scale_spnudge::spnudge_finalize

Definition at line 268 of file scale_spnudge.F90.

      use scale_dft, only: &
         dft_finalize
  
      call dft_finalize
  
     !$acc exit data delete(SPNUDGE_u_alpha, SPNUDGE_v_alpha, SPNUDGE_pt_alpha, SPNUDGE_qv_alpha)
      deallocate( spnudge_u_alpha )
      deallocate( spnudge_v_alpha )
      deallocate( spnudge_pt_alpha )
      deallocate( spnudge_qv_alpha )
  
      return