virtualtspexchangemodule Module Reference

Data Types
type	virtualtspexchangetype
	GWE and GWT work fully analogously, so we can do with only one virtual exchange for both, at least for now. More...

Functions/Subroutines
subroutine, public	add_virtual_tsp_exchange (name, exchange_id, m1_id, m2_id, qtype)
	Add a virtual GWT-GWT or GWE-GWE exchange to the simulation. More...
subroutine	vtx_create (this, name, exg_id, m1_id, m2_id)
	Create a virtual GWT-GWT exchange. More...
subroutine	init_virtual_data (this)
subroutine	vtx_prepare_stage (this, stage)
subroutine	vtx_get_recv_items (this, stg, rank, vi)
subroutine	vtx_get_send_items (this, stg, rank, vi)
logical(lgp) function	vtx_has_mover (this)
	Override. More...
subroutine	vtx_destroy (this)
subroutine	allocate_data (this)
subroutine	deallocate_data (this)

Function/Subroutine Documentation

add_virtual_tsp_exchange()

subroutine, public virtualtspexchangemodule::add_virtual_tsp_exchange	(	character(len=*)	name,
		integer(i4b)	exchange_id,
		integer(i4b)	m1_id,
		integer(i4b)	m2_id,
		character(len=*)	qtype
	)

Parameters

m1_id	id model 1
m2_id	id model 2
qtype	quantity type (for GWE and GWT)

Definition at line 44 of file VirtualTspExchange.f90.

    character(len=*) :: name
    integer(I4B) :: exchange_id
    integer(I4B) :: m1_id !< id model 1
    integer(I4B) :: m2_id !< id model 2
    character(len=*) :: qtype !< quantity type (for GWE and GWT)
    ! local
    class(VirtualTspExchangeType), pointer :: v_exg
    class(*), pointer :: obj_ptr
 
    allocate (v_exg)
 
    call v_exg%create(name, exchange_id, m1_id, m2_id)
    if (qtype == "concentration") then
      v_exg%container_type = vdc_gwtexg_type
    else if (qtype == "temperature") then
      v_exg%container_type = vdc_gweexg_type
    end if
 
    obj_ptr => v_exg
    call virtual_exchange_list%Add(obj_ptr)

Here is the caller graph for this function:

allocate_data()

subroutine virtualtspexchangemodule::allocate_data ( class(virtualtspexchangetype)  this )

private

Definition at line 218 of file VirtualTspExchange.f90.

    class(VirtualTspExchangeType) :: this
 
    allocate (this%inmvt)
    allocate (this%gwfsimvals)
    allocate (this%mvt_maxmvt)
    allocate (this%mvt_quantity_m1)
    allocate (this%mvt_quantity_m2)
 

deallocate_data()

subroutine virtualtspexchangemodule::deallocate_data ( class(virtualtspexchangetype)  this )

private

Definition at line 229 of file VirtualTspExchange.f90.

    class(VirtualTspExchangeType) :: this
 
    deallocate (this%inmvt)
    deallocate (this%gwfsimvals)
    deallocate (this%mvt_maxmvt)
    deallocate (this%mvt_quantity_m1)
    deallocate (this%mvt_quantity_m2)
 

init_virtual_data()

subroutine virtualtspexchangemodule::init_virtual_data ( class(virtualtspexchangetype)  this )

private

Definition at line 87 of file VirtualTspExchange.f90.

    class(VirtualTspExchangeType) :: this
 
    call this%set(this%inmvt%base(), 'INMVT', '', map_all_type)
    call this%set(this%gwfsimvals%base(), 'GWFSIMVALS', '', map_all_type)
    call this%set(this%mvt_maxmvt%base(), 'MAXMVT', 'MVT', map_all_type)
    call this%set(this%mvt_quantity_m1%base(), 'QUANTITY_M1', 'MVT', &
                  map_all_type, this%v_model1%is_local)
    call this%set(this%mvt_quantity_m2%base(), 'QUANTITY_M2', 'MVT', &
                  map_all_type, this%v_model2%is_local)
 

vtx_create()

subroutine virtualtspexchangemodule::vtx_create ( class(virtualtspexchangetype)  this, character(len=*)  name, integer(i4b)  exg_id, integer(i4b)  m1_id, integer(i4b)  m2_id  )

private

Definition at line 69 of file VirtualTspExchange.f90.

    class(VirtualTspExchangeType) :: this
    character(len=*) :: name
    integer(I4B) :: exg_id
    integer(I4B) :: m1_id
    integer(I4B) :: m2_id
 
    ! create base
    call this%VirtualExchangeType%create(name, exg_id, m1_id, m2_id)
 
    call this%allocate_data()
    call this%init_virtual_data()
 
    this%quantities_mapped = .false.
    this%has_mvt = .false.
 

vtx_destroy()

subroutine virtualtspexchangemodule::vtx_destroy ( class(virtualtspexchangetype)  this )

private

Definition at line 210 of file VirtualTspExchange.f90.

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

vtx_get_recv_items()

subroutine virtualtspexchangemodule::vtx_get_recv_items ( class(virtualtspexchangetype)  this, integer(i4b)  stg, integer(i4b)  rank, type(stlvecint)  vi  )

private

Parameters

stg	stage
rank	rank of remote process
vi	virtual data items

Definition at line 152 of file VirtualTspExchange.f90.

    class(VirtualTspExchangeType) :: this
    integer(I4B) :: stg !< stage
    integer(I4B) :: rank !< rank of remote process
    type(STLVecInt) :: vi !< virtual data items
 
    ! get base items to receive
    call this%VirtualExchangeType%get_recv_items(stg, rank, vi)
 
    ! add more MVT items that follow nodem1/nodem2 pattern,
    ! see comments in VirtualExchange for more details
    if (this%is_local .and. rank == this%orig_rank) then
      if (this%mvt_quantity_m1%is_remote) then
        ! only receive for model1
        call this%add_vdi_for_stage(this%mvt_quantity_m1%base(), stg, vi)
      end if
      if (this%mvt_quantity_m2%is_remote) then
        ! only receive for model2
        call this%add_vdi_for_stage(this%mvt_quantity_m2%base(), stg, vi)
      end if
    end if
 

vtx_get_send_items()

subroutine virtualtspexchangemodule::vtx_get_send_items ( class(virtualtspexchangetype)  this, integer(i4b)  stg, integer(i4b)  rank, type(stlvecint)  vi  )

private

Parameters

stg	stage
rank	rank of remote process
vi	virtual data items

Definition at line 176 of file VirtualTspExchange.f90.

    class(VirtualTspExchangeType) :: this
    integer(I4B) :: stg !< stage
    integer(I4B) :: rank !< rank of remote process
    type(STLVecInt) :: vi !< virtual data items
 
    ! get base items to send
    call this%VirtualExchangeType%get_send_items(stg, rank, vi)
 
    ! add more MVT items that follow nodem1/nodem2 pattern,
    ! see comments in VirtualExchange for more details
    if (this%is_local .and. rank == this%orig_rank) then
      if (.not. this%mvt_quantity_m1%is_remote) then
        ! only send for model1
        call this%add_vdi_for_stage(this%mvt_quantity_m1%base(), stg, vi)
      end if
      if (.not. this%mvt_quantity_m2%is_remote) then
        ! only send for model2
        call this%add_vdi_for_stage(this%mvt_quantity_m2%base(), stg, vi)
      end if
    end if
 

vtx_has_mover()

logical(lgp) function virtualtspexchangemodule::vtx_has_mover ( class(virtualtspexchangetype)  this )

private

Definition at line 202 of file VirtualTspExchange.f90.

    class(VirtualTspExchangeType) :: this
    logical(LGP) :: has_mover
 
    has_mover = this%has_mvt
 

vtx_prepare_stage()

subroutine virtualtspexchangemodule::vtx_prepare_stage ( class(virtualtspexchangetype)  this, integer(i4b)  stage  )

private

Definition at line 100 of file VirtualTspExchange.f90.

    class(VirtualTspExchangeType) :: this
    integer(I4B) :: stage
    ! local
    integer(I4B) :: nexg, nmax
 
    ! prepare base exchange data items
    call this%VirtualExchangeType%prepare_stage(stage)
 
    if (stage == stg_aft_exg_df) then
 
      ! always synchronize mover flag
      call this%map(this%inmvt%base(), (/stg_aft_exg_df/))
 
    else if (stage == stg_aft_con_cr) then
 
      ! at this point we know:
      if (this%inmvt%get() > 0) then
        this%has_mvt = .true.
      end if
 
    else if (stage == stg_bfr_con_ar) then
 
      nexg = this%nexg%get()
      call this%map(this%gwfsimvals%base(), nexg, (/stg_bfr_exg_ad/))
 
      ! only when MVT is locally active (i.e. primary exchange)
      if (this%has_mvt .and. this%is_local) then
        call this%map(this%mvt_maxmvt%base(), (/stg_bfr_con_ar/))
      end if
 
    else if (stage == stg_bfr_exg_ad) then
 
      ! only when MVT is locally active
      nmax = 0
      if (this%has_mvt .and. this%is_local) nmax = this%mvt_maxmvt%get()
 
      ! only map the arrays once, after the first read prepare is done
      if (.not. this%quantities_mapped) then
        if (nmax > 0) then
          call this%map(this%mvt_quantity_m1%base(), nmax, (/stg_bfr_exg_fc/))
          call this%map(this%mvt_quantity_m2%base(), nmax, (/stg_bfr_exg_fc/))
        else
          call this%map(this%mvt_quantity_m1%base(), 0, (/stg_never/))
          call this%map(this%mvt_quantity_m2%base(), 0, (/stg_never/))
        end if
        this%quantities_mapped = .true.
      end if
    end if