mod_user.f90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
module mod_user
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_stdio
  use scale_prof
  use scale_grid_index
  use scale_tracer
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  public :: user_config
  public :: user_setup
  public :: user_resume0
  public :: user_resume
  public :: user_step

  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  logical, private :: USER_do = .false. 

  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  subroutine user_config
    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_config

  !-----------------------------------------------------------------------------
  subroutine user_setup
    use scale_process, only: &
       prc_mpistop
    implicit none

    namelist / param_user / &
       user_do

    integer :: ierr
    !---------------------------------------------------------------------------

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '++++++ Module[DRIVER] / Categ[USER] / Origin[SCALE-RM]'

    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_user,iostat=ierr)
    if( ierr < 0 ) then !--- missing
       if( io_l ) write(io_fid_log,*) '*** Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       write(*,*) 'xxx Not appropriate names in namelist PARAM_USER. Check!'
       call prc_mpistop
    endif
    if( io_nml ) write(io_fid_nml,nml=param_user)

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '*** This module is dummy.'

    return
  end subroutine user_setup

  !-----------------------------------------------------------------------------
  subroutine user_resume0
    implicit none
    !---------------------------------------------------------------------------

    ! If you need, calculate first step and put diagnostic value to history buffer.
    ! USER_resume0 calls before setup of Atmos/Ocean/Land/Urban submodels.
    ! All variables are set before surface coupling.

    !call USER_step

    return
  end subroutine user_resume0

  !-----------------------------------------------------------------------------
  subroutine user_resume
    implicit none
    !---------------------------------------------------------------------------

    ! If you need, calculate first step and put diagnostic value to history buffer.
    ! USER_resume calls after setup of Atmos/Ocean/Land/Urban submodels.
    ! All variables are set after surface coupling.

    !call USER_step

    return
  end subroutine user_resume

  !-----------------------------------------------------------------------------
  subroutine user_step
    use scale_process, only: &
       prc_mpistop
    implicit none
    !---------------------------------------------------------------------------

    if ( user_do ) then
       call prc_mpistop
    endif

    return
  end subroutine user_step

end module mod_user