scale_model_component.F90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
#include "scaleFElib.h"
module scale_model_component
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_io
  use scale_prof
 
  use scale_time_manager, only: &
    time_manager_component
 
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public type & procedure
  !
  
  type, abstract, public :: modelcomponent
    character(len=H_SHORT), private :: name
    logical, private :: is_activated = .false.
    type(time_manager_component) :: time_manager
  contains
    procedure(modelcomponent_setup), deferred, public :: setup
    procedure(modelcomponent_calc_tendency), deferred, public :: calc_tendency
    procedure(modelcomponent_update), deferred, public :: update
    procedure(modelcomponent_finalize), deferred, public :: finalize 
 
    procedure, public :: modelcomponent_init    
    procedure, public :: isactivated => modelcomponent_isactivated
    procedure, public :: getcomponentname => modelcomponent_getcompname
  end type modelcomponent
 
  interface
    subroutine modelcomponent_setup( this )
      import modelcomponent
      class(modelcomponent), intent(inout), target :: this
    end subroutine modelcomponent_setup
 
    subroutine modelcomponent_calc_tendency( this, force )
      import modelcomponent
      class(modelcomponent), intent(inout) :: this
      logical, intent(in) :: force
    end subroutine modelcomponent_calc_tendency
 
    subroutine modelcomponent_update( this )
      import modelcomponent
      class(modelcomponent), intent(inout) :: this
    end subroutine modelcomponent_update
 
    subroutine modelcomponent_finalize( this )
      import modelcomponent
      class(modelcomponent), intent(inout) :: this
    end subroutine modelcomponent_finalize    
  end interface
 
  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  !-----------------------------------------------------------------------------
 
contains
!OCL SERIAL
  subroutine modelcomponent_init( this, name, is_activated )
    implicit none
 
    class(modelcomponent), intent(inout) :: this
    character(len=*), intent(in) :: name
    logical, intent(in) :: is_activated 
    !---------------------------------------------------
    
    this%name = name
    this%is_activated = is_activated
 
    return
  end subroutine modelcomponent_init
 
!OCL SERIAL
  function modelcomponent_isactivated( this ) result( is_activated )
    implicit none
 
    class(modelcomponent), intent(in) :: this
    logical :: is_activated 
    !---------------------------------------------------
 
    is_activated = this%is_activated
    return
  end function modelcomponent_isactivated
 
!OCL SERIAL
  function modelcomponent_getcompname( this ) result( model_name )
    implicit none
 
    class(modelcomponent), intent(in) :: this
    character(len=H_SHORT) :: model_name
    !---------------------------------------------------
 
    model_name = this%name
    return
  end function modelcomponent_getcompname
 
end module scale_model_component