mod_user.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!> module USER
!!
!! @par Description
!!          User defined module (dummy)
!!
!! @author Yuta Kawai, Team SCALE
!!
!<
!-------------------------------------------------------------------------------
#include "scaleFElib.h"
module mod_user
 
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_io
  use scale_prof
 
  use mod_atmos_component, only: &
    atmoscomponent
  use mod_ocean_component, only: &
    oceancomponent
  use mod_user_base, only: &
    userbase
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  type, public, extends(userbase) :: user
  contains
    procedure :: mkinit_ => user_mkinit
    generic :: mkinit => mkinit_
    procedure :: mkinit_ocn => user_mkinit_ocn
    procedure :: setup_ => user_setup
    generic :: setup => setup_
  end type user
 
  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  !-----------------------------------------------------------------------------
contains
!OCL SERIAL
  subroutine user_mkinit( this, atm )
    implicit none
    class(user), intent(inout) :: this
    class(atmoscomponent), intent(inout), target :: atm
    !------------------------------------------
    return
  end subroutine user_mkinit
!OCL SERIAL
  subroutine user_mkinit_ocn( this, ocn )
    implicit none
    class(user), intent(inout) :: this
    class(oceancomponent), intent(inout), target :: ocn
    !------------------------------------------
    return
  end subroutine user_mkinit_ocn
 
!OCL SERIAL  
  subroutine user_setup( this, atm )
    use scale_prc, only: &
       prc_abort
    implicit none
 
    class(user), intent(inout) :: this
    class(atmoscomponent), intent(inout) :: atm
    
    logical :: USER_do = .false.
    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.'
    
    call this%UserBase%Setup( atm, user_do )
 
    return
  end subroutine user_setup
end module mod_user