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

Inheritance diagram for virtualdatacontainermodule::virtualdatacontainertype:

Collaboration diagram for virtualdatacontainermodule::virtualdatacontainertype:

Public Member Functions
procedure	vdc_create

generic	map => map_scalar, map_array1d, map_array2d

procedure	prepare_stage => vdc_prepare_stage

procedure	link_items => vdc_link_items

procedure	set_element_map => vdc_set_element_map

procedure	get_vrt_mem_path => vdc_get_vrt_mem_path

procedure	destroy => vdc_destroy

procedure	set_orig_rank => vdc_set_orig_rank

procedure	get_send_items => vdc_get_send_items

procedure	get_recv_items => vdc_get_recv_items

procedure	get_virtual_data => vdc_get_virtual_data

procedure	print_items

procedure	set

Public Attributes
integer(i4b)	id
	unique identifier matching with the real counterpart More...

integer(i4b)	container_type
	to identify the actual type of this container More...

character(lencomponentname)	name
	container name (model, exchange, ...) used in the memory path More...

character(lencontextname)	vmem_ctx
	prefixes virtual memory located on remote processes More...

logical(lgp)	is_local
	when true, the physical object resides on the same process. However, some of its variables can still be remote More...

logical(lgp)	is_active
	when true, this container is being synchronized More...

integer(i4b)	orig_rank
	the global rank of the process which holds the physical data for this container, for exchanges this is set to be where model1 sits, or if model1 is local, where model2 sits More...

type(stlvecint)	rcv_ranks
	the ranks of processes, other than orig_rank, having this container active (only guaranteed to be complete after synchronization) More...

type(listtype)	virtual_data_list
	a list with all virtual data items for this container More...

type(vdcelementmaptype), dimension(nr_vdc_element_maps)	element_maps
	a list with all element maps More...

type(vdcelementluttype), dimension(nr_vdc_element_maps)	element_luts
	lookup tables from remote index to local index More...

Private Member Functions
procedure, private	add_to_list

procedure, private	map_scalar

procedure, private	map_array1d

procedure, private	map_array2d

procedure, private	map_internal

procedure, private	vdc_get_virtual_data

procedure, private	get_items_for_stage

Detailed Description

A virtual model or exchange derives from this base and can add the component-specific items to the list of virtual data items. As far as synchronization of virtual objects is concerned, all that is needed

Definition at line 53 of file VirtualDataContainer.f90.

Member Function/Subroutine Documentation

◆ add_to_list()

procedure, private virtualdatacontainermodule::virtualdatacontainertype::add_to_list

private

Definition at line 86 of file VirtualDataContainer.f90.

◆ destroy()

procedure virtualdatacontainermodule::virtualdatacontainertype::destroy

Definition at line 77 of file VirtualDataContainer.f90.

◆ get_items_for_stage()

procedure, private virtualdatacontainermodule::virtualdatacontainertype::get_items_for_stage

private

Definition at line 92 of file VirtualDataContainer.f90.

◆ get_recv_items()

procedure virtualdatacontainermodule::virtualdatacontainertype::get_recv_items

Definition at line 80 of file VirtualDataContainer.f90.

◆ get_send_items()

procedure virtualdatacontainermodule::virtualdatacontainertype::get_send_items

Definition at line 79 of file VirtualDataContainer.f90.

◆ get_virtual_data()

procedure virtualdatacontainermodule::virtualdatacontainertype::get_virtual_data

Definition at line 81 of file VirtualDataContainer.f90.

◆ get_vrt_mem_path()

procedure virtualdatacontainermodule::virtualdatacontainertype::get_vrt_mem_path

Definition at line 76 of file VirtualDataContainer.f90.

◆ link_items()

procedure virtualdatacontainermodule::virtualdatacontainertype::link_items

Definition at line 74 of file VirtualDataContainer.f90.

◆ map()

generic virtualdatacontainermodule::virtualdatacontainertype::map

Definition at line 72 of file VirtualDataContainer.f90.

Here is the call graph for this function:

◆ map_array1d()

procedure, private virtualdatacontainermodule::virtualdatacontainertype::map_array1d

private

Definition at line 88 of file VirtualDataContainer.f90.

◆ map_array2d()

procedure, private virtualdatacontainermodule::virtualdatacontainertype::map_array2d

private

Definition at line 89 of file VirtualDataContainer.f90.

◆ map_internal()

procedure, private virtualdatacontainermodule::virtualdatacontainertype::map_internal

private

Definition at line 90 of file VirtualDataContainer.f90.

◆ map_scalar()

procedure, private virtualdatacontainermodule::virtualdatacontainertype::map_scalar

private

Definition at line 87 of file VirtualDataContainer.f90.

◆ prepare_stage()

procedure virtualdatacontainermodule::virtualdatacontainertype::prepare_stage

Definition at line 73 of file VirtualDataContainer.f90.

◆ print_items()

procedure virtualdatacontainermodule::virtualdatacontainertype::print_items

Definition at line 82 of file VirtualDataContainer.f90.

◆ set()

procedure virtualdatacontainermodule::virtualdatacontainertype::set

Definition at line 84 of file VirtualDataContainer.f90.

◆ set_element_map()

procedure virtualdatacontainermodule::virtualdatacontainertype::set_element_map

Definition at line 75 of file VirtualDataContainer.f90.

◆ set_orig_rank()

procedure virtualdatacontainermodule::virtualdatacontainertype::set_orig_rank

Definition at line 78 of file VirtualDataContainer.f90.

◆ vdc_create()

procedure virtualdatacontainermodule::virtualdatacontainertype::vdc_create

Definition at line 71 of file VirtualDataContainer.f90.

◆ vdc_get_virtual_data()

procedure, private virtualdatacontainermodule::virtualdatacontainertype::vdc_get_virtual_data

private

Definition at line 91 of file VirtualDataContainer.f90.

Member Data Documentation

◆ container_type

integer(i4b) virtualdatacontainermodule::virtualdatacontainertype::container_type

Definition at line 55 of file VirtualDataContainer.f90.

55 integer(I4B) :: container_type !< to identify the actual type of this container

◆ element_luts

type(vdcelementluttype), dimension(nr_vdc_element_maps) virtualdatacontainermodule::virtualdatacontainertype::element_luts

Definition at line 69 of file VirtualDataContainer.f90.

69 type(VdcElementLutType), dimension(NR_VDC_ELEMENT_MAPS) :: element_luts !< lookup tables from remote index to local index

◆ element_maps

type(vdcelementmaptype), dimension(nr_vdc_element_maps) virtualdatacontainermodule::virtualdatacontainertype::element_maps

Definition at line 68 of file VirtualDataContainer.f90.

68 type(VdcElementMapType), dimension(NR_VDC_ELEMENT_MAPS) :: element_maps !< a list with all element maps

◆ id

integer(i4b) virtualdatacontainermodule::virtualdatacontainertype::id

Definition at line 54 of file VirtualDataContainer.f90.

54 integer(I4B) :: id !< unique identifier matching with the real counterpart

◆ is_active

logical(lgp) virtualdatacontainermodule::virtualdatacontainertype::is_active

Definition at line 60 of file VirtualDataContainer.f90.

60 logical(LGP) :: is_active !< when true, this container is being synchronized

◆ is_local

logical(lgp) virtualdatacontainermodule::virtualdatacontainertype::is_local

Definition at line 58 of file VirtualDataContainer.f90.

58 logical(LGP) :: is_local !< when true, the physical object resides on the same process. However,

◆ name

character(lencomponentname) virtualdatacontainermodule::virtualdatacontainertype::name

Definition at line 56 of file VirtualDataContainer.f90.

56 character(LENCOMPONENTNAME) :: name !< container name (model, exchange, ...) used in the memory path

◆ orig_rank

integer(i4b) virtualdatacontainermodule::virtualdatacontainertype::orig_rank

Definition at line 61 of file VirtualDataContainer.f90.

61 integer(I4B) :: orig_rank !< the global rank of the process which holds the physical data for this container,

◆ rcv_ranks

type(stlvecint) virtualdatacontainermodule::virtualdatacontainertype::rcv_ranks

Definition at line 64 of file VirtualDataContainer.f90.

64 type(STLVecInt) :: rcv_ranks !< the ranks of processes, other than orig_rank, having this container active

◆ virtual_data_list

type(listtype) virtualdatacontainermodule::virtualdatacontainertype::virtual_data_list

Definition at line 67 of file VirtualDataContainer.f90.

67 type(ListType) :: virtual_data_list !< a list with all virtual data items for this container

◆ vmem_ctx

character(lencontextname) virtualdatacontainermodule::virtualdatacontainertype::vmem_ctx

Definition at line 57 of file VirtualDataContainer.f90.

57 character(LENCONTEXTNAME) :: vmem_ctx !< prefixes virtual memory located on remote processes

The documentation for this type was generated from the following file:

/home/runner/work/modflow6/modflow6/src/Distributed/VirtualDataContainer.f90

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Member Function/Subroutine Documentation

◆ add_to_list()

◆ destroy()

◆ get_items_for_stage()

◆ get_recv_items()

◆ get_send_items()

◆ get_virtual_data()

◆ get_vrt_mem_path()

◆ link_items()

◆ map()

◆ map_array1d()

◆ map_array2d()

◆ map_internal()

◆ map_scalar()

◆ prepare_stage()

◆ print_items()

◆ set()

◆ set_element_map()

◆ set_orig_rank()

◆ vdc_create()

◆ vdc_get_virtual_data()

Member Data Documentation

◆ container_type

◆ element_luts

◆ element_maps

◆ id

◆ is_active

◆ is_local

◆ name

◆ orig_rank

◆ rcv_ranks

◆ virtual_data_list

◆ vmem_ctx