virtualexchangemodule Module Reference

Data Types
type	virtualexchangetype
	The Virtual Exchange is based on two Virtual Models and is therefore not always strictly local or remote. We have to consider three different cases: More...

Functions/Subroutines
subroutine	vx_create (this, name, exg_id, m1_id, m2_id)
	Create the virtual exchange base. More...
subroutine	init_virtual_data (this)
subroutine	vx_prepare_stage (this, stage)
subroutine	vx_get_recv_items (this, stg, rank, vi)
subroutine	vx_get_send_items (this, stg, rank, vi)
subroutine	add_vdi_for_stage (this, vdata_item, stage, virtual_items)
	Convenience routine to add virtual data item to a list. More...
logical(lgp) function	vx_has_mover (this)
	Checks if there is an active mover in the exchange. More...
subroutine	vx_destroy (this)
subroutine	allocate_data (this)
subroutine	deallocate_data (this)
class(virtualexchangetype) function, pointer, public	get_virtual_exchange (exg_id)
	Returns a virtual exchange with the specified id. More...
class(virtualexchangetype) function, pointer, public	get_virtual_exchange_from_list (list, idx)
class(virtualexchangetype) function, pointer, private	cast_as_virtual_exchange (obj_ptr)

Function/Subroutine Documentation

add_vdi_for_stage()

subroutine virtualexchangemodule::add_vdi_for_stage ( class(virtualexchangetype)  this, class(virtualdatatype), pointer  vdata_item, integer(i4b)  stage, type(stlvecint)  virtual_items  )

private

Definition at line 248 of file VirtualExchange.f90.

    class(VirtualExchangeType) :: this
    class(VirtualDataType), pointer :: vdata_item
    integer(I4B) :: stage
    type(STLVecInt) :: virtual_items
    ! local
    class(*), pointer :: vdi
    integer(I4B) :: idx
 
    vdi => vdata_item
    idx = this%virtual_data_list%GetIndex(vdi)
    if (vdata_item%check_stage(stage)) then
      call virtual_items%push_back(idx)
    end if
 

allocate_data()

subroutine virtualexchangemodule::allocate_data ( class(virtualexchangetype)  this )

private

Definition at line 283 of file VirtualExchange.f90.

    class(VirtualExchangeType) :: this
 
    allocate (this%nexg)
    allocate (this%naux)
    allocate (this%ianglex)
    allocate (this%nodem1)
    allocate (this%nodem2)
    allocate (this%ihc)
    allocate (this%cl1)
    allocate (this%cl2)
    allocate (this%hwva)
    allocate (this%auxvar)
 

cast_as_virtual_exchange()

class(virtualexchangetype) function, pointer, private virtualexchangemodule::cast_as_virtual_exchange ( class(*), pointer  obj_ptr )

private

Definition at line 351 of file VirtualExchange.f90.

    class(*), pointer :: obj_ptr
    class(VirtualExchangeType), pointer :: virtual_exg
 
    virtual_exg => null()
    select type (obj_ptr)
    class is (virtualexchangetype)
      virtual_exg => obj_ptr
    end select
 

Here is the caller graph for this function:

deallocate_data()

subroutine virtualexchangemodule::deallocate_data ( class(virtualexchangetype)  this )

private

Definition at line 299 of file VirtualExchange.f90.

    class(VirtualExchangeType) :: this
 
    deallocate (this%nexg)
    deallocate (this%naux)
    deallocate (this%ianglex)
    deallocate (this%nodem1)
    deallocate (this%nodem2)
    deallocate (this%ihc)
    deallocate (this%cl1)
    deallocate (this%cl2)
    deallocate (this%hwva)
    deallocate (this%auxvar)
 

get_virtual_exchange()

class(virtualexchangetype) function, pointer, public virtualexchangemodule::get_virtual_exchange

(

integer(i4b)

exg_id

)

Definition at line 317 of file VirtualExchange.f90.

    use virtualdatalistsmodule, only: virtual_exchange_list
    integer(I4B) :: exg_id
    class(VirtualExchangeType), pointer :: virtual_exg
    ! local
    integer(I4B) :: i
    class(*), pointer :: ve
 
    virtual_exg => null()
    do i = 1, virtual_exchange_list%Count()
      ve => virtual_exchange_list%GetItem(i)
      select type (ve)
      class is (virtualexchangetype)
        if (ve%id == exg_id) then
          virtual_exg => ve
          return
        end if
      end select
    end do
 

Here is the caller graph for this function:

get_virtual_exchange_from_list()

class(virtualexchangetype) function, pointer, public virtualexchangemodule::get_virtual_exchange_from_list	(	type(listtype)	list,
		integer(i4b)	idx
	)

Definition at line 339 of file VirtualExchange.f90.

    type(ListType) :: list
    integer(I4B) :: idx
    class(VirtualExchangeType), pointer :: virtual_exg
    ! local
    class(*), pointer :: obj_ptr
 
    obj_ptr => list%GetItem(idx)
    virtual_exg => cast_as_virtual_exchange(obj_ptr)
 

Here is the call graph for this function:

Here is the caller graph for this function:

init_virtual_data()

subroutine virtualexchangemodule::init_virtual_data ( class(virtualexchangetype)  this )

private

Definition at line 125 of file VirtualExchange.f90.

    class(VirtualExchangeType) :: this
    ! local
 
    call this%set(this%nexg%base(), 'NEXG', '', map_all_type)
    call this%set(this%naux%base(), 'NAUX', '', map_all_type)
    call this%set(this%ianglex%base(), 'IANGLEX', '', map_all_type)
 
    ! exchanges can be hybrid with both local and remote
    ! fields, nodem1/2 array only local when corresponding
    ! model sits on the same process, so we pass the
    ! optional "is_local" argument to the following:
    call this%set(this%nodem1%base(), 'NODEM1', '', &
                  map_all_type, this%v_model1%is_local)
    call this%set(this%nodem2%base(), 'NODEM2', '', &
                  map_all_type, this%v_model2%is_local)
 
    call this%set(this%ihc%base(), 'IHC', '', map_all_type)
    call this%set(this%cl1%base(), 'CL1', '', map_all_type)
    call this%set(this%cl2%base(), 'CL2', '', map_all_type)
    call this%set(this%hwva%base(), 'HWVA', '', map_all_type)
    call this%set(this%auxvar%base(), 'AUXVAR', '', map_all_type)
 

vx_create()

subroutine virtualexchangemodule::vx_create	(	class(virtualexchangetype)	this,
		character(len=*)	name,
		integer(i4b)	exg_id,
		integer(i4b)	m1_id,
		integer(i4b)	m2_id
	)

Definition at line 102 of file VirtualExchange.f90.

    class(VirtualExchangeType) :: this
    character(len=*) :: name
    integer(I4B) :: exg_id
    integer(I4B) :: m1_id
    integer(I4B) :: m2_id
    ! local
    logical(LGP) :: is_local
 
    this%v_model1 => get_virtual_model(m1_id)
    this%v_model2 => get_virtual_model(m2_id)
 
    ! 1) both models local:  is_local = true
    ! 2) only one of them:   is_local = true
    ! 3) both models remote: is_local = false
    is_local = this%v_model1%is_local .or. this%v_model2%is_local
    call this%VirtualDataContainerType%vdc_create(name, exg_id, is_local)
 
    call this%allocate_data()
    call this%init_virtual_data()
 

vx_destroy()

subroutine virtualexchangemodule::vx_destroy ( class(virtualexchangetype)  this )

private

Definition at line 275 of file VirtualExchange.f90.

    class(VirtualExchangeType) :: this
 
    call this%VirtualDataContainerType%destroy()
    call this%deallocate_data()
 

vx_get_recv_items()

subroutine virtualexchangemodule::vx_get_recv_items ( class(virtualexchangetype)  this, integer(i4b)  stg, integer(i4b)  rank, type(stlvecint)  vi  )

private

Definition at line 180 of file VirtualExchange.f90.

    class(VirtualExchangeType) :: this
    integer(I4B) :: stg
    integer(I4B) :: rank
    type(STLVecInt) :: vi
 
    if (this%is_local .and. rank == this%orig_rank) then
      ! treat the primary exchange case independently, we
      ! have all data available except for nodem1 or nodem2
      if (stg < stg_bfr_con_df) then
        if (this%nodem1%is_remote) then
          call this%add_vdi_for_stage(this%nodem1%base(), stg, vi)
        end if
        if (this%nodem2%is_remote) then
          call this%add_vdi_for_stage(this%nodem2%base(), stg, vi)
        end if
      end if
    else
      ! send/receive all
      call this%add_vdi_for_stage(this%nexg%base(), stg, vi)
      call this%add_vdi_for_stage(this%naux%base(), stg, vi)
      call this%add_vdi_for_stage(this%ianglex%base(), stg, vi)
      call this%add_vdi_for_stage(this%nodem1%base(), stg, vi)
      call this%add_vdi_for_stage(this%nodem2%base(), stg, vi)
      call this%add_vdi_for_stage(this%ihc%base(), stg, vi)
      call this%add_vdi_for_stage(this%cl1%base(), stg, vi)
      call this%add_vdi_for_stage(this%cl2%base(), stg, vi)
      call this%add_vdi_for_stage(this%hwva%base(), stg, vi)
      call this%add_vdi_for_stage(this%auxvar%base(), stg, vi)
    end if
 

vx_get_send_items()

subroutine virtualexchangemodule::vx_get_send_items ( class(virtualexchangetype)  this, integer(i4b)  stg, integer(i4b)  rank, type(stlvecint)  vi  )

private

Definition at line 213 of file VirtualExchange.f90.

    class(VirtualExchangeType) :: this
    integer(I4B) :: stg
    integer(I4B) :: rank
    type(STLVecInt) :: vi
 
    if (this%is_local .and. rank == this%orig_rank) then
      ! this is a primary exchange, all we need to send are
      ! the node numbers nodem1 or nodem2
      if (stg < stg_bfr_con_df) then
        if (.not. this%nodem1%is_remote) then
          call this%add_vdi_for_stage(this%nodem1%base(), stg, vi)
        end if
        if (.not. this%nodem2%is_remote) then
          call this%add_vdi_for_stage(this%nodem2%base(), stg, vi)
        end if
      end if
    else
      ! send/receive all
      call this%add_vdi_for_stage(this%nexg%base(), stg, vi)
      call this%add_vdi_for_stage(this%naux%base(), stg, vi)
      call this%add_vdi_for_stage(this%ianglex%base(), stg, vi)
      call this%add_vdi_for_stage(this%nodem1%base(), stg, vi)
      call this%add_vdi_for_stage(this%nodem2%base(), stg, vi)
      call this%add_vdi_for_stage(this%ihc%base(), stg, vi)
      call this%add_vdi_for_stage(this%cl1%base(), stg, vi)
      call this%add_vdi_for_stage(this%cl2%base(), stg, vi)
      call this%add_vdi_for_stage(this%hwva%base(), stg, vi)
      call this%add_vdi_for_stage(this%auxvar%base(), stg, vi)
    end if
 

vx_has_mover()

logical(lgp) function virtualexchangemodule::vx_has_mover ( class(virtualexchangetype)  this )

private

Definition at line 267 of file VirtualExchange.f90.

    class(VirtualExchangeType) :: this
    logical(LGP) :: has_mover
 
    has_mover = .false.
 

vx_prepare_stage()

subroutine virtualexchangemodule::vx_prepare_stage ( class(virtualexchangetype)  this, integer(i4b)  stage  )

private

Definition at line 150 of file VirtualExchange.f90.

    class(VirtualExchangeType) :: this
    integer(I4B) :: stage
    ! local
    integer(I4B) :: nexg, naux
 
    if (stage == stg_aft_exg_df) then
 
      call this%map(this%nexg%base(), (/stg_aft_exg_df/))
      call this%map(this%naux%base(), (/stg_aft_exg_df/))
      call this%map(this%ianglex%base(), (/stg_aft_exg_df/))
 
    else if (stage == stg_aft_con_cr) then
 
      nexg = this%nexg%get()
      naux = this%naux%get()
      call this%map(this%nodem1%base(), nexg, (/stg_aft_con_cr, &
                                                stg_bfr_con_df/))
      call this%map(this%nodem2%base(), nexg, (/stg_aft_con_cr, &
                                                stg_bfr_con_df/))
      call this%map(this%ihc%base(), nexg, (/stg_aft_con_cr/))
      call this%map(this%cl1%base(), nexg, (/stg_aft_con_cr/))
      call this%map(this%cl2%base(), nexg, (/stg_aft_con_cr/))
      call this%map(this%hwva%base(), nexg, (/stg_aft_con_cr/))
      call this%map(this%auxvar%base(), naux, nexg, (/stg_aft_con_cr/))
 
    end if