mod_cpl_component.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!> module Coupler component
!!
!! @par Description
!!          Coupler component module
!!
!! @author Yuta Kawai, Team SCALE
!!
!<
!-------------------------------------------------------------------------------
#include "scaleFElib.h"
module mod_cpl_component
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_io
  use scale_prof
  use scale_prc
  use scale_model_component, only: modelcomponent
 
  use scale_mesh_base3d, only: meshbase3d
  use scale_mesh_base2d, only: meshbase2d
 
  use mod_cpl_vars, only: couplervars
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public type & procedure
  !
 
  !> Derived type to manage coupler component
  type, extends(modelcomponent), public :: couplercomponent
    type(couplervars) :: vars             !< Object to mange variables with coupler component
  contains
    procedure, public :: setup => coupler_setup
    procedure, public :: evaluate_activation => coupler_evaluate_activation
    procedure, public :: setup_vars => coupler_setup_vars
    procedure, public :: calc_tendency => coupler_calc_tendency
    procedure, public :: update => coupler_update
    procedure, public :: finalize => coupler_finalize
  end type couplercomponent
 
contains
  !> Initialize an object to manage coupler component 
  subroutine coupler_setup( this )
    class(couplercomponent), intent(inout), target :: this
    !------------------------------------------------------------------------------
    return
  end subroutine coupler_setup
 
  !> Evaluate whether the coupler component is needed or not
  subroutine coupler_evaluate_activation( this, &
    ocn_comp )
    implicit none
    class(couplercomponent), intent(inout) :: this
    class(modelcomponent), intent(in) :: ocn_comp
 
    logical :: is_needed
    !------------------------------------------------------------------------------
 
    log_info( 'CouplerComponent_setup',*) 'Check whether the coupler component is needed'
 
    if ( ocn_comp%IsActivated()  ) then
      is_needed = .true.
    else
      is_needed = .false.
    end if
    call this%ModelComponent_Init('COUPLER', is_needed )
    return
  end subroutine coupler_evaluate_activation
 
  !> Setup variables with coupler component
  subroutine coupler_setup_vars( this, &
    atm_mesh, ocn_mesh )
    implicit none
    class(couplercomponent), intent(inout) :: this
    class(meshbase3d), intent(in) :: atm_mesh
    class(meshbase3d), intent(in) :: ocn_mesh
 
    logical :: ACTIVATE_FLAG
    class(meshbase2d), pointer :: atm_mesh2D
    class(meshbase2d), pointer :: ocn_mesh2D
    !------------------------------------------------------------------------------
    
    call prof_rapstart( 'Coupler_setup_vars', 1)
    call atm_mesh%GetMesh2D( atm_mesh2d )
    call ocn_mesh%GetMesh2D( ocn_mesh2d )
 
    call this%vars%Init( atm_mesh, atm_mesh2d, ocn_mesh2d )
    call prof_rapend( 'Coupler_setup_vars', 1)
    return
  end subroutine coupler_setup_vars
 
  !> Finalize an object to manage coupler component
  subroutine coupler_finalize(this)
    class(couplercomponent), intent(inout) :: this
    !------------------------------------------------------------------------------
    log_info('CouplerComponent_finalize',*)
    if ( .not. this%IsActivated() ) return
 
    call this%vars%Final()
    return
  end subroutine coupler_finalize
 
 
! Dummy subroutines for the coupler component -------------------------------
 
  subroutine coupler_calc_tendency( this, force )
    class(couplercomponent), intent(inout) :: this
    logical, intent(in) :: force
    !------------------------------------------------------------------------------
    return
  end subroutine coupler_calc_tendency
 
  subroutine coupler_update( this )
    class(couplercomponent), intent(inout) :: this
    !------------------------------------------------------------------------------
    return
  end subroutine coupler_update
 
end module mod_cpl_component