scale_coriolis Module Reference

module Coriolis More...

Functions/Subroutines
subroutine, public	coriolis_setup (IA, JA, LAT, CY, DOMAIN_CENTER_Y)
	Setup. More...
subroutine, public	coriolis_finalize
	Finalize. More...

Variables
real(rp), dimension(:,:), allocatable, public	coriolis_f
real(rp), allocatable, public	coriolis
real(rp), allocatable, public	parameter
character(len=h_short), public	coriolis_type = 'PLANE'
character(len=h_short), public	type
character(len=h_short), public	of
character(len=h_short), public	force
real(rp), public	coriolis_f0 = 0.0_RP
	'PLANE' : f = CORIOLIS_f0 + CORIOLIS_beta * ( CY - CORIOLIS_y0 ) 'SPHERE': f = 2 * CONST_OHM * sin( lat ) More...
real(rp), public	coriolis_beta = 0.0_RP
real(rp), public	coriolis_y0
real(rp), public	default
real(rp), public	is
real(rp), public	domain
real(rp), public	center

Detailed Description

module Coriolis

Description

Coriolis module

Author

Team SCALE

NAMELIST

• PARAM_CORIOLIS

  name	type	default value	comment
  CORIOLIS_TYPE	character(len=H_SHORT)	'PLANE' !> type of coriolis force: 'PLANE', 'SPHERE'
  CORIOLIS_F0	real(RP)	0.0_RP
  CORIOLIS_BETA	real(RP)	0.0_RP
  CORIOLIS_Y0	real(RP)		> default is domain center

  
  

History Output

No history output

Function/Subroutine Documentation

coriolis_setup()

subroutine, public scale_coriolis::coriolis_setup	(	integer, intent(in)	IA,
		integer, intent(in)	JA,
		real(rp), dimension(ia,ja), intent(in)	LAT,
		real(rp), dimension (ja), intent(in)	CY,
		real(rp), intent(in)	DOMAIN_CENTER_Y
	)

Setup.

Parameters

[in]

domain_center_y

center position of global domain [m]: y

Definition at line 60 of file scale_coriolis.F90.

    use scale_prc, only: &
       prc_abort
    use scale_const, only: &
       ohm => const_ohm
    implicit none
    integer, intent(in) :: IA, JA
 
    real(RP), intent(in) :: LAT(IA,JA)
    real(RP), intent(in) :: CY (JA)
    real(RP), intent(in) :: DOMAIN_CENTER_Y
 
    namelist / param_coriolis / &
       coriolis_type, &
       coriolis_f0,   &
       coriolis_beta, &
       coriolis_y0
 
    integer :: i, j
 
    integer :: ierr
    !---------------------------------------------------------------------------
 
    log_newline
    log_info("CORIOLIS_setup",*) 'Setup'
 
    coriolis_y0 = domain_center_y
 
    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_coriolis,iostat=ierr)
 
    if( ierr < 0 ) then !--- missing
       log_info("CORIOLIS_setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       log_error("CORIOLIS_setup",*) 'Not appropriate names in namelist PARAM_CORIOLIS. Check!'
       call prc_abort
    endif
    log_nml(param_coriolis)
 
 
    allocate( coriolis_f(ia,ja) )
 
    ! coriolis parameter
    select case ( coriolis_type )
    case ( 'PLANE' )
       !omp parallel do collapse(2)
       do j = 1, ja
       do i = 1, ia
          coriolis_f(i,j) = coriolis_f0 + coriolis_beta * ( cy(j) - coriolis_y0 )
       end do
       end do
    case ( 'SPHERE' )
       !omp parallel do collapse(2)
       do j = 1, ja
       do i = 1, ia
          coriolis_f(i,j) = 2.0_rp * ohm * sin( lat(i,j) )
       end do
       end do
    case default
       log_error("CORIOLIS_setup",*) 'Coriolis type is invalid: ', trim(coriolis_type)
       log_error_cont(*) 'The type must be PLANE or SPHERE'
       call prc_abort
    end select
 
    !$acc enter data copyin(CORIOLIS_f)
 
    return

References scale_const::const_ohm, coriolis_beta, coriolis_f, coriolis_f0, coriolis_type, coriolis_y0, scale_io::io_fid_conf, and scale_prc::prc_abort().

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:

coriolis_finalize()

subroutine, public scale_coriolis::coriolis_finalize

Finalize.

Definition at line 132 of file scale_coriolis.F90.

    implicit none
    !---------------------------------------------------------------------------
 
    !$acc exit data delete(CORIOLIS_f)
    deallocate( coriolis_f )
 
    return

References coriolis_f.

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

Here is the caller graph for this function:

Variable Documentation

coriolis_f

real(rp), dimension(:,:), allocatable, public scale_coriolis::coriolis_f

Definition at line 34 of file scale_coriolis.F90.

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

Referenced by mod_atmos_dyn_driver::atmos_dyn_driver(), coriolis_finalize(), and coriolis_setup().

coriolis

character(len=h_short), allocatable, public scale_coriolis::coriolis

Definition at line 34 of file scale_coriolis.F90.

parameter

real(rp), allocatable, public scale_coriolis::parameter

Definition at line 34 of file scale_coriolis.F90.

coriolis_type

character(len=h_short), public scale_coriolis::coriolis_type = 'PLANE'

Definition at line 37 of file scale_coriolis.F90.

  character(len=H_SHORT), public :: CORIOLIS_type = 'PLANE'

Referenced by coriolis_setup().

type

character(len=h_short), public scale_coriolis::type

Definition at line 37 of file scale_coriolis.F90.

of

character(len=h_short), public scale_coriolis::of

Definition at line 37 of file scale_coriolis.F90.

force

character(len=h_short), public scale_coriolis::force

Definition at line 37 of file scale_coriolis.F90.

coriolis_f0

real(rp), public scale_coriolis::coriolis_f0 = 0.0_RP

'PLANE' : f = CORIOLIS_f0 + CORIOLIS_beta * ( CY - CORIOLIS_y0 ) 'SPHERE': f = 2 * CONST_OHM * sin( lat )

Definition at line 40 of file scale_coriolis.F90.

  real(RP),               public :: CORIOLIS_f0   = 0.0_rp

Referenced by coriolis_setup().

coriolis_beta

real(rp), public scale_coriolis::coriolis_beta = 0.0_RP

Definition at line 41 of file scale_coriolis.F90.

  real(RP),               public :: CORIOLIS_beta = 0.0_rp

Referenced by coriolis_setup().

coriolis_y0

real(rp), public scale_coriolis::coriolis_y0

Definition at line 42 of file scale_coriolis.F90.

  real(RP),               public :: CORIOLIS_y0

Referenced by coriolis_setup().

default

real(rp), public scale_coriolis::default

Definition at line 42 of file scale_coriolis.F90.

is

real(rp), public scale_coriolis::is

Definition at line 42 of file scale_coriolis.F90.

domain

real(rp), public scale_coriolis::domain

Definition at line 42 of file scale_coriolis.F90.

center

real(rp), public scale_coriolis::center

Definition at line 42 of file scale_coriolis.F90.