mod_user_base.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!> module USER_base
!!
!! @par Description
!!          User defined module (base class)
!!
!! @author Yuta Kawai, Team SCALE
!!
!<
!-------------------------------------------------------------------------------
#include "scaleFElib.h"
module mod_user_base
 
  !-----------------------------------------------------------------------------
  !
  !++ 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_experiment, only: experiment
 
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  type, public :: userbase
    logical :: user_do !< do user step?
  contains
    procedure :: mkinit_base => user_base_mkinit
    generic :: mkinit => mkinit_base
    procedure :: mkinit_base_ocn => user_base_mkinit_ocn_exp
    procedure :: mkinit_ocn => user_base_mkinit_ocn
    procedure :: mkfinal => user_base_mkfinal
    procedure :: setup_base => user_base_setup
    generic :: setup => setup_base
    procedure :: final => user_base_final
    procedure :: calc_tendency => user_base_calc_tendency
    procedure :: update_pre => user_base_update_pre
    procedure :: update => user_base_update
  end type userbase
 
  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
 
  !-----------------------------------------------------------------------------
contains
  subroutine user_base_mkinit( this, atm, exp )
    implicit none
    class(userbase), intent(inout) :: this
    class(atmoscomponent), intent(inout) :: atm
    class(experiment), intent(inout) :: exp
    !------------------------------------------
 
    call exp%SetInitCond( atm%mesh,                                            &
      atm%vars%container%PROGVARS_manager, atm%vars%container%AUXVARS_manager, &
      atm%vars%container%QTRCVARS_manager                                      )
    return
  end subroutine user_base_mkinit
 
  subroutine user_base_mkinit_ocn_exp( this, ocn, exp )
    implicit none
    class(userbase), intent(inout) :: this
    class(oceancomponent), intent(inout) :: ocn
    class(experiment), intent(inout) :: exp
    !------------------------------------------
 
    call exp%SetInitCond_ocn( ocn%mesh,                     &
      ocn%vars%PROGVARS_manager, ocn%vars%AUXVARS2D_manager )
    return
  end subroutine user_base_mkinit_ocn_exp
 
  subroutine user_base_mkinit_ocn( this, ocn )
    implicit none
    class(userbase), intent(inout) :: this
    class(oceancomponent), intent(inout), target :: ocn
    !------------------------------------------
    return
  end subroutine user_base_mkinit_ocn
 
  subroutine user_base_mkfinal( this )
    implicit none
    class(userbase), intent(inout) :: this
    !------------------------------------------
    return
  end subroutine user_base_mkfinal
 
  subroutine user_base_setup( this, atm, user_do )
    implicit none
    class(userbase), intent(inout) :: this
    class(atmoscomponent), intent(inout) :: atm
    logical, intent(in) :: user_do
    !------------------------------------------
    
    this%USER_do = user_do
    
    return
  end subroutine user_base_setup
 
  subroutine user_base_final( this )
    implicit none
    class(userbase), intent(inout) :: this
    !------------------------------------------
    return
  end subroutine user_base_final
  
  subroutine user_base_calc_tendency( this, atm )
    implicit none
    class(userbase), intent(inout) :: this
    class(atmoscomponent), intent(inout) :: atm
    !------------------------------------------
 
    return
  end subroutine user_base_calc_tendency
 
  subroutine user_base_update_pre( this, atm )
    implicit none
    class(userbase), intent(inout) :: this
    class(atmoscomponent), intent(inout) :: atm
    !------------------------------------------
    return
  end subroutine user_base_update_pre
 
  subroutine user_base_update( this, atm )
    implicit none
    class(userbase), intent(inout) :: this
    class(atmoscomponent), intent(inout) :: atm
    !------------------------------------------
    return
  end subroutine user_base_update
 
end module mod_user_base