mod_user.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
#include "scalelib.h"
module mod_user
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_io
  use scale_prof
  use scale_atmos_grid_cartesc_index
  use scale_tracer
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  public :: user_tracer_setup
  public :: user_setup
  public :: user_finalize
  public :: user_mkinit
  public :: user_calc_tendency
  public :: user_update
 
  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  logical, private :: USER_do = .false. 
 
  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  subroutine user_tracer_setup
    use scale_tracer, only: &
       tracer_regist
    implicit none
 
    ! if you want to add tracers, call the TRACER_regist subroutine.
    ! e.g.,
!    integer, parameter     :: NQ = 1
!    integer                :: QS
!    character(len=H_SHORT) :: NAME(NQ)
!    character(len=H_MID)   :: DESC(NQ)
!    character(len=H_SHORT) :: UNIT(NQ)
!
!    data NAME (/ 'name' /)
!    data DESC (/ 'tracer name' /)
!    data UNIT (/ 'kg/kg' /)
    !---------------------------------------------------------------------------
 
!    call TRACER_regist( QS,   & ! [OUT]
!                        NQ,   & ! [IN]
!                        NAME, & ! [IN]
!                        DESC, & ! [IN]
!                        UNIT  ) ! [IN]
 
    return
  end subroutine user_tracer_setup
 
  !-----------------------------------------------------------------------------
  subroutine user_setup
    use scale_prc, only: &
       prc_abort
    implicit none
 
    namelist / param_user / &
       user_do
 
    integer :: ierr
    !---------------------------------------------------------------------------
 
    log_newline
    log_info("USER_setup",*) 'Setup'
 
    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_user,iostat=ierr)
    if( ierr < 0 ) then !--- missing
       log_info("USER_setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       log_error("USER_setup",*) 'Not appropriate names in namelist PARAM_USER. Check!'
       call prc_abort
    endif
    log_nml(param_user)
 
    log_newline
    log_info("USER_setup",*) 'This module is dummy.'
 
    return
  end subroutine user_setup
 
  !-----------------------------------------------------------------------------
  subroutine user_finalize
    implicit none
    !---------------------------------------------------------------------------
 
    return
  end subroutine user_finalize
 
  !-----------------------------------------------------------------------------
  subroutine user_mkinit
    implicit none
    !---------------------------------------------------------------------------
 
    return
  end subroutine user_mkinit
 
  !-----------------------------------------------------------------------------
  subroutine user_calc_tendency
    implicit none
    !---------------------------------------------------------------------------
 
    return
  end subroutine user_calc_tendency
 
  !-----------------------------------------------------------------------------
  subroutine user_update
    use scale_prc, only: &
       prc_abort
    implicit none
    !---------------------------------------------------------------------------
 
    if ( user_do ) then
       call prc_abort
    endif
 
    return
  end subroutine user_update
 
end module mod_user