Data Types
type	vdcptrtype
	Wrapper for virtual data containers. More...

type	vdcelementmaptype

type	vdcelementluttype

type	virtualdatacontainertype
	Container (list) of virtual data items. More...

Functions/Subroutines
subroutine	vdc_create (this, name, id, is_local)

subroutine	set (this, field, var_name, subcmp_name, map_id, is_local)
	Init virtual data item, without allocation,. More...

subroutine	add_to_list (this, virtual_data)

subroutine	vdc_prepare_stage (this, stage)

subroutine	vdc_link_items (this, stage)
	Link all local data items to memory. More...

subroutine	vdc_set_element_map (this, src_indexes, map_id)
	Add the source indexes associated with map_id as a element map to this container, such that. More...

subroutine	map_scalar (this, vd, stages)

subroutine	map_array1d (this, vd, nrow, stages)

subroutine	map_array2d (this, vd, ncol, nrow, stages)

subroutine	map_internal (this, vd, shape, stages)

subroutine	vdc_get_send_items (this, stage, rank, virtual_items)
	Get indexes of virtual data items to be. More...

subroutine	vdc_get_recv_items (this, stage, rank, virtual_items)
	Get indexes of virtual data items to be. More...

subroutine	get_items_for_stage (this, stage, virtual_items)

subroutine	print_items (this, imon, items)

character(len=lenmempath) function	vdc_get_vrt_mem_path (this, var_name, subcomp_name)
	Get virtual memory path for a certain variable. More...

class(virtualdatatype) function, pointer	vdc_get_virtual_data (this, var_name, subcomp_name)

subroutine	vdc_destroy (this)

subroutine	vdc_set_orig_rank (this, rank)

class(virtualdatacontainertype) function, pointer, public	get_vdc_from_list (list, idx)

character(len=24) function, public	vdc_type_to_str (cntr_type)
	@ Converts a virtual container type to its string representation More...

Variables
integer(i4b), parameter, public	vdc_unknown_type = 0

integer(i4b), parameter, public	vdc_gwfmodel_type = 1

integer(i4b), parameter, public	vdc_gwtmodel_type = 2

integer(i4b), parameter, public	vdc_gwemodel_type = 3

integer(i4b), parameter, public	vdc_gwfexg_type = 4

integer(i4b), parameter, public	vdc_gwtexg_type = 5

integer(i4b), parameter, public	vdc_gweexg_type = 6

integer(i4b), parameter, public	vdc_gwfmvr_type = 7

integer(i4b), parameter, public	vdc_gwtmvt_type = 8

integer(i4b), parameter, public	vdc_gwemve_type = 9
	of VdcPtrType instead. More...

Function/Subroutine Documentation

◆ add_to_list()

subroutine virtualdatacontainermodule::add_to_list	(	class(virtualdatacontainertype)	this,
		class(virtualdatatype), pointer	virtual_data
	)

private

Definition at line 152 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     class(VirtualDataType), pointer :: virtual_data
     ! local
     class(*), pointer :: vdata_ptr
  
     vdata_ptr => virtual_data
     call this%virtual_data_list%Add(vdata_ptr)
  

◆ get_items_for_stage()

subroutine virtualdatacontainermodule::get_items_for_stage	(	class(virtualdatacontainertype)	this,
		integer(i4b)	stage,
		type(stlvecint)	virtual_items
	)

private

Definition at line 304 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     integer(I4B) :: stage
     type(STLVecInt) :: virtual_items
     ! local
     integer(I4B) :: i
     class(*), pointer :: obj_ptr
  
     do i = 1, this%virtual_data_list%Count()
       obj_ptr => this%virtual_data_list%GetItem(i)
       select type (obj_ptr)
       class is (virtualdatatype)
         if (.not. obj_ptr%check_stage(stage)) cycle
         call virtual_items%push_back(i)
       end select
     end do
  

◆ get_vdc_from_list()

class(virtualdatacontainertype) function, pointer, public virtualdatacontainermodule::get_vdc_from_list	(	type(listtype)	list,
		integer(i4b)	idx
	)

Definition at line 436 of file VirtualDataContainer.f90.

     type(ListType) :: list
     integer(I4B) :: idx
     class(VirtualDataContainerType), pointer :: vdc
     ! local
     class(*), pointer :: obj_ptr
  
     vdc => null()
     obj_ptr => list%GetItem(idx)
     select type (obj_ptr)
     class is (virtualdatacontainertype)
       vdc => obj_ptr
     end select
  

Here is the caller graph for this function:

◆ map_array1d()

subroutine virtualdatacontainermodule::map_array1d	(	class(virtualdatacontainertype)	this,
		class(virtualdatatype), pointer	vd,
		integer(i4b)	nrow,
		integer(i4b), dimension(:)	stages
	)

private

Definition at line 236 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     class(VirtualDataType), pointer :: vd
     integer(I4B) :: nrow
     integer(I4B), dimension(:) :: stages
  
     call this%map_internal(vd, (/nrow/), stages)
  

Here is the caller graph for this function:

◆ map_array2d()

subroutine virtualdatacontainermodule::map_array2d	(	class(virtualdatacontainertype)	this,
		class(virtualdatatype), pointer	vd,
		integer(i4b)	ncol,
		integer(i4b)	nrow,
		integer(i4b), dimension(:)	stages
	)

private

Definition at line 246 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     class(VirtualDataType), pointer :: vd
     integer(I4B) :: ncol
     integer(I4B) :: nrow
     integer(I4B), dimension(:) :: stages
  
     call this%map_internal(vd, (/ncol, nrow/), stages)
  

Here is the caller graph for this function:

◆ map_internal()

subroutine virtualdatacontainermodule::map_internal	(	class(virtualdatacontainertype)	this,
		class(virtualdatatype), pointer	vd,
		integer(i4b), dimension(:)	shape,
		integer(i4b), dimension(:)	stages
	)

private

Definition at line 257 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     class(VirtualDataType), pointer :: vd
     integer(I4B), dimension(:) :: shape
     integer(I4B), dimension(:) :: stages
     ! local
     character(len=LENMEMPATH) :: vm_pth
     logical(LGP) :: found
  
     vd%sync_stages = stages
     if (vd%is_remote) then
       ! create new virtual memory item
       vm_pth = this%get_vrt_mem_path(vd%var_name, vd%subcmp_name)
       call vd%vm_allocate(vd%var_name, vm_pth, shape)
       call get_from_memorylist(vd%var_name, vm_pth, vd%virtual_mt, found)
       if (vd%map_type > 0) then
         vd%remote_to_virtual => this%element_luts(vd%map_type)%remote_to_virtual
         vd%remote_elem_shift => this%element_maps(vd%map_type)%remote_elem_shift
       end if
     end if
  

Here is the call graph for this function:

◆ map_scalar()

subroutine virtualdatacontainermodule::map_scalar	(	class(virtualdatacontainertype)	this,
		class(virtualdatatype), pointer	vd,
		integer(i4b), dimension(:)	stages
	)

private

Definition at line 227 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     class(VirtualDataType), pointer :: vd
     integer(I4B), dimension(:) :: stages
  
     call this%map_internal(vd, (/0/), stages)
  

Here is the caller graph for this function:

◆ print_items()

subroutine virtualdatacontainermodule::print_items	(	class(virtualdatacontainertype)	this,
		integer(i4b)	imon,
		type(stlvecint)	items
	)

private

Definition at line 323 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     integer(I4B) :: imon
     type(STLVecInt) :: items
     ! local
     integer(I4B) :: i
     class(VirtualDataType), pointer :: vdi
  
     write (imon, *) "=====> items"
     do i = 1, items%size
       vdi => get_virtual_data_from_list(this%virtual_data_list, items%at(i))
       write (imon, *) vdi%var_name, ":", vdi%mem_path
     end do
     if (items%size == 0) then
       write (imon, *) "... empty ...", this%name
     end if
     write (imon, *) "<===== items"
  

Here is the call graph for this function:

◆ set()

subroutine virtualdatacontainermodule::set	(	class(virtualdatacontainertype)	this,
		class(virtualdatatype), pointer	field,
		character(len=*)	var_name,
		character(len=*)	subcmp_name,
		integer(i4b)	map_id,
		logical(lgp), optional	is_local
	)

private

Definition at line 126 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     class(VirtualDataType), pointer :: field
     character(len=*) :: var_name
     character(len=*) :: subcmp_name
     integer(I4B) :: map_id
     logical(LGP), optional :: is_local
  
     field%is_remote = .not. this%is_local
     field%map_type = map_id
     if (present(is_local)) field%is_remote = .not. is_local
     field%var_name = var_name
     field%subcmp_name = subcmp_name
     if (subcmp_name == '') then
       field%mem_path = create_mem_path(this%name)
     else
       field%mem_path = create_mem_path(this%name, subcmp_name)
     end if
     field%is_reduced = (field%is_remote .and. field%map_type > 0)
     field%remote_elem_shift => null()
     field%remote_to_virtual => null()
     field%virtual_mt => null()
     call this%add_to_list(field)
  

Here is the call graph for this function:

◆ vdc_create()

subroutine virtualdatacontainermodule::vdc_create	(	class(virtualdatacontainertype)	this,
		character(len=*)	name,
		integer(i4b)	id,
		logical(lgp)	is_local
	)

Definition at line 95 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     character(len=*) :: name
     integer(I4B) :: id
     logical(LGP) :: is_local
     ! local
     integer(I4B) :: i
  
     this%name = name
     this%id = id
     this%is_local = is_local
     this%vmem_ctx = 'undefined'
     this%orig_rank = 0
     this%is_active = .true.
     this%container_type = vdc_unknown_type
  
     do i = 1, size(this%element_maps)
       this%element_maps(i)%nr_virt_elems = 0
       this%element_maps(i)%remote_elem_shift => null()
     end do
     do i = 1, size(this%element_luts)
       this%element_luts(i)%max_remote_idx = 0
       this%element_luts(i)%remote_to_virtual => null()
     end do
  
     call this%rcv_ranks%init()
  

◆ vdc_destroy()

subroutine virtualdatacontainermodule::vdc_destroy ( class(virtualdatacontainertype) this )

Definition at line 395 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     ! local
     integer(I4B) :: i
     class(*), pointer :: obj
  
     call this%rcv_ranks%destroy()
  
     do i = 1, size(this%element_maps)
       if (associated(this%element_maps(i)%remote_elem_shift)) then
         deallocate (this%element_maps(i)%remote_elem_shift)
       end if
     end do
     do i = 1, size(this%element_luts)
       if (associated(this%element_luts(i)%remote_to_virtual)) then
         deallocate (this%element_luts(i)%remote_to_virtual)
       end if
     end do
  
     do i = 1, this%virtual_data_list%Count()
       obj => this%virtual_data_list%GetItem(i)
       select type (obj)
       class is (virtualdatatype)
         if (associated(obj%virtual_mt)) then
           call obj%vm_deallocate()
         end if
       end select
     end do
     call this%virtual_data_list%Clear()
  

◆ vdc_get_recv_items()

subroutine virtualdatacontainermodule::vdc_get_recv_items	(	class(virtualdatacontainertype)	this,
		integer(i4b)	stage,
		integer(i4b)	rank,
		type(stlvecint)	virtual_items
	)

private

Definition at line 294 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     integer(I4B) :: stage
     integer(I4B) :: rank
     type(STLVecInt) :: virtual_items
  
     call this%get_items_for_stage(stage, virtual_items)
  

◆ vdc_get_send_items()

subroutine virtualdatacontainermodule::vdc_get_send_items	(	class(virtualdatacontainertype)	this,
		integer(i4b)	stage,
		integer(i4b)	rank,
		type(stlvecint)	virtual_items
	)

private

Definition at line 282 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     integer(I4B) :: stage
     integer(I4B) :: rank
     type(STLVecInt) :: virtual_items
  
     call this%get_items_for_stage(stage, virtual_items)
  

◆ vdc_get_virtual_data()

class(virtualdatatype) function, pointer virtualdatacontainermodule::vdc_get_virtual_data	(	class(virtualdatacontainertype)	this,
		character(len=*)	var_name,
		character(len=*)	subcomp_name
	)

private

Definition at line 370 of file VirtualDataContainer.f90.

     use simmodule, only: ustop
     class(VirtualDataContainerType) :: this
     character(len=*) :: var_name
     character(len=*) :: subcomp_name
     class(VirtualDataType), pointer :: virtual_data
     ! local
     integer(I4B) :: i
     class(VirtualDataType), pointer :: vd
  
     virtual_data => null()
     do i = 1, this%virtual_data_list%Count()
       vd => get_virtual_data_from_list(this%virtual_data_list, i)
       if (vd%var_name == var_name .and. &
           vd%subcmp_name == subcomp_name) then
         virtual_data => vd
         return
       end if
     end do
  
     write (*, *) 'Error: unknown virtual variable ', var_name, ' ', subcomp_name
     call ustop()
  

Here is the call graph for this function:

◆ vdc_get_vrt_mem_path()

character(len=lenmempath) function virtualdatacontainermodule::vdc_get_vrt_mem_path	(	class(virtualdatacontainertype)	this,
		character(len=*)	var_name,
		character(len=*)	subcomp_name
	)

private

Definition at line 345 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     character(len=*) :: var_name
     character(len=*) :: subcomp_name
     character(len=LENMEMPATH) :: vrt_path
     ! local
     class(VirtualDataType), pointer :: vdi
  
     vdi => this%vdc_get_virtual_data(var_name, subcomp_name)
     if (vdi%is_remote) then
       if (subcomp_name == '') then
         vrt_path = create_mem_path(this%name, context=this%vmem_ctx)
       else
         vrt_path = create_mem_path(this%name, subcomp_name, context=this%vmem_ctx)
       end if
     else
       if (subcomp_name == '') then
         vrt_path = create_mem_path(this%name)
       else
         vrt_path = create_mem_path(this%name, subcomp_name)
       end if
     end if
  

Here is the call graph for this function:

◆ vdc_link_items()

subroutine virtualdatacontainermodule::vdc_link_items	(	class(virtualdatacontainertype)	this,
		integer(i4b)	stage
	)

Definition at line 175 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     integer(I4B) :: stage
     ! local
     integer(I4B) :: i
     class(*), pointer :: vdi
  
     do i = 1, this%virtual_data_list%Count()
       vdi => this%virtual_data_list%GetItem(i)
       select type (vdi)
       class is (virtualdatatype)
         if (vdi%is_remote) cycle
         if (vdi%check_stage(stage)) call vdi%link()
       end select
     end do
  

◆ vdc_prepare_stage()

subroutine virtualdatacontainermodule::vdc_prepare_stage	(	class(virtualdatacontainertype)	this,
		integer(i4b)	stage
	)

private

Definition at line 163 of file VirtualDataContainer.f90.

     use simmodule, only: ustop
     class(VirtualDataContainerType) :: this
     integer(I4B) :: stage
  
     write (*, *) 'Error: prepare_stage should be overridden'
     call ustop()
  

Here is the call graph for this function:

◆ vdc_set_element_map()

subroutine virtualdatacontainermodule::vdc_set_element_map	(	class(virtualdatacontainertype)	this,
		integer(i4b), dimension(:), pointer, contiguous	src_indexes,
		integer(i4b)	map_id
	)

private

Definition at line 196 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     integer(I4B), dimension(:), pointer, contiguous :: src_indexes
     integer(I4B) :: map_id
     ! local
     integer(I4B) :: i, idx_remote, max_remote_idx
  
     if (this%element_maps(map_id)%nr_virt_elems > 0) then
       write (*, *) "Error, VDC element map already set"
       call ustop()
     end if
  
     this%element_maps(map_id)%nr_virt_elems = size(src_indexes)
     allocate (this%element_maps(map_id)%remote_elem_shift(size(src_indexes)))
     do i = 1, size(src_indexes)
       this%element_maps(map_id)%remote_elem_shift(i) = src_indexes(i) - 1
     end do
  
     max_remote_idx = maxval(src_indexes)
     this%element_luts(map_id)%max_remote_idx = max_remote_idx
     allocate (this%element_luts(map_id)%remote_to_virtual(max_remote_idx))
     do i = 1, max_remote_idx
       this%element_luts(map_id)%remote_to_virtual(i) = -1
     end do
     do i = 1, size(src_indexes)
       idx_remote = src_indexes(i)
       this%element_luts(map_id)%remote_to_virtual(idx_remote) = i
     end do
  

Here is the call graph for this function:

◆ vdc_set_orig_rank()

subroutine virtualdatacontainermodule::vdc_set_orig_rank	(	class(virtualdatacontainertype)	this,
		integer(i4b)	rank
	)

private

Definition at line 427 of file VirtualDataContainer.f90.

     class(VirtualDataContainerType) :: this
     integer(I4B) :: rank
  
     this%orig_rank = rank
     write (this%vmem_ctx, '(a,i0,a)') '__P', rank, '__'
  

◆ vdc_type_to_str()

character(len=24) function, public virtualdatacontainermodule::vdc_type_to_str ( integer(i4b) cntr_type )

Definition at line 454 of file VirtualDataContainer.f90.

     integer(I4B) :: cntr_type
     character(len=24) :: cntr_str
  
     if (cntr_type == vdc_unknown_type) then; cntr_str = "unknown"
     else if (cntr_type == vdc_gwfmodel_type) then; cntr_str = "GWF Model"
     else if (cntr_type == vdc_gwtmodel_type) then; cntr_str = "GWT Model"
     else if (cntr_type == vdc_gwemodel_type) then; cntr_str = "GWE Model"
     else if (cntr_type == vdc_gwfexg_type) then; cntr_str = "GWF Exchange"
     else if (cntr_type == vdc_gwtexg_type) then; cntr_str = "GWT Exchange"
     else if (cntr_type == vdc_gweexg_type) then; cntr_str = "GWE Exchange"
     else if (cntr_type == vdc_gwfmvr_type) then; cntr_str = "GWF Mover"
     else if (cntr_type == vdc_gwtmvt_type) then; cntr_str = "GWT Mover"
     else if (cntr_type == vdc_gwemve_type) then; cntr_str = "GWE Mover"
     else; cntr_str = "Undefined"
     end if
  

Here is the caller graph for this function:

Variable Documentation

◆ vdc_gweexg_type

integer(i4b), parameter, public virtualdatacontainermodule::vdc_gweexg_type = 6

Definition at line 22 of file VirtualDataContainer.f90.

22 integer(I4B), public, parameter :: VDC_GWEEXG_TYPE = 6

◆ vdc_gwemodel_type

integer(i4b), parameter, public virtualdatacontainermodule::vdc_gwemodel_type = 3

Definition at line 19 of file VirtualDataContainer.f90.

19 integer(I4B), public, parameter :: VDC_GWEMODEL_TYPE = 3

◆ vdc_gwemve_type

integer(i4b), parameter, public virtualdatacontainermodule::vdc_gwemve_type = 9

Definition at line 25 of file VirtualDataContainer.f90.

25 integer(I4B), public, parameter :: VDC_GWEMVE_TYPE = 9

◆ vdc_gwfexg_type

integer(i4b), parameter, public virtualdatacontainermodule::vdc_gwfexg_type = 4

Definition at line 20 of file VirtualDataContainer.f90.

20 integer(I4B), public, parameter :: VDC_GWFEXG_TYPE = 4

◆ vdc_gwfmodel_type

integer(i4b), parameter, public virtualdatacontainermodule::vdc_gwfmodel_type = 1

Definition at line 17 of file VirtualDataContainer.f90.

17 integer(I4B), public, parameter :: VDC_GWFMODEL_TYPE = 1

◆ vdc_gwfmvr_type

integer(i4b), parameter, public virtualdatacontainermodule::vdc_gwfmvr_type = 7

Definition at line 23 of file VirtualDataContainer.f90.

23 integer(I4B), public, parameter :: VDC_GWFMVR_TYPE = 7

◆ vdc_gwtexg_type

integer(i4b), parameter, public virtualdatacontainermodule::vdc_gwtexg_type = 5

Definition at line 21 of file VirtualDataContainer.f90.

21 integer(I4B), public, parameter :: VDC_GWTEXG_TYPE = 5

◆ vdc_gwtmodel_type

integer(i4b), parameter, public virtualdatacontainermodule::vdc_gwtmodel_type = 2

Definition at line 18 of file VirtualDataContainer.f90.

18 integer(I4B), public, parameter :: VDC_GWTMODEL_TYPE = 2

◆ vdc_gwtmvt_type

integer(i4b), parameter, public virtualdatacontainermodule::vdc_gwtmvt_type = 8

Definition at line 24 of file VirtualDataContainer.f90.

24 integer(I4B), public, parameter :: VDC_GWTMVT_TYPE = 8

◆ vdc_unknown_type

integer(i4b), parameter, public virtualdatacontainermodule::vdc_unknown_type = 0

Definition at line 16 of file VirtualDataContainer.f90.

16 integer(I4B), public, parameter :: VDC_UNKNOWN_TYPE = 0

Data Types

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ add_to_list()

◆ get_items_for_stage()

◆ get_vdc_from_list()

◆ map_array1d()

◆ map_array2d()

◆ map_internal()

◆ map_scalar()

◆ print_items()

◆ set()

◆ vdc_create()

◆ vdc_destroy()

◆ vdc_get_recv_items()

◆ vdc_get_send_items()

◆ vdc_get_virtual_data()

◆ vdc_get_vrt_mem_path()

◆ vdc_link_items()

◆ vdc_prepare_stage()

◆ vdc_set_element_map()

◆ vdc_set_orig_rank()

◆ vdc_type_to_str()

Variable Documentation

◆ vdc_gweexg_type

◆ vdc_gwemodel_type

◆ vdc_gwemve_type

◆ vdc_gwfexg_type

◆ vdc_gwfmodel_type

◆ vdc_gwfmvr_type

◆ vdc_gwtexg_type

◆ vdc_gwtmodel_type

◆ vdc_gwtmvt_type

◆ vdc_unknown_type