DistributedVariable.f90

Go to the documentation of this file.

module distvariablemodule
  use constantsmodule, only: lencomponentname, lenvarname
  use kindmodule, only: i4b
  use listmodule, only: listtype
  use interfacemapmodule
 
  implicit none
  private
 
  public :: getdistvarfromlist
 
  ! types of variables
  integer(I4B), public, parameter :: sync_scl = 0 !< synchronize as scalar
  integer(I4B), public, parameter :: sync_nds = 1 !< synchronize over nodes
  integer(I4B), public, parameter :: sync_con = 2 !< synchronize over connections
  integer(I4B), public, parameter :: sync_exg = 3 !< synchronize as exchange variable
 
  type, public :: distvartype
    character(len=LENVARNAME) :: var_name !< name of variable, e.g. "K11"
    character(len=LENCOMPONENTNAME) :: subcomp_name !< subcomponent, e.g. "NPF"
    character(len=LENCOMPONENTNAME) :: comp_name !< component, e.g. the model or exchange name
    integer(I4B) :: map_type !< can be 0 = scalar, 1 = node based, 2 = connection based,
                             !! 3 = exchange based (connections crossing model boundaries)
    character(len=LENVARNAME) :: exg_var_name !< needed for exchange variables, e.g. SIMVALS
    integer(I4B), dimension(:), allocatable :: sync_stages !< when to sync, e.g. (/ BEFORE_AD, BEFORE_CF /)
  end type distvartype
 
contains
 
  function getdistvarfromlist(list, idx) result(res)
    implicit none
    type(listtype), intent(inout) :: list
    integer(I4B), intent(in) :: idx
    class(distvartype), pointer :: res
    ! local
    class(*), pointer :: obj
 
    obj => list%GetItem(idx)
    res => castasdistvar(obj)
    return
 
  end function getdistvarfromlist
 
  function castasdistvar(obj) result(res)
    implicit none
    class(*), pointer, intent(inout) :: obj
    class(distvartype), pointer :: res
 
    res => null()
    if (.not. associated(obj)) return
 
    select type (obj)
    class is (distvartype)
      res => obj
    end select
    return
  end function castasdistvar
 
end module distvariablemodule