MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
virtualdatacontainermodule::virtualdatacontainertype Type Reference

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

Inheritance diagram for virtualdatacontainermodule::virtualdatacontainertype:
Inheritance graph
Collaboration diagram for virtualdatacontainermodule::virtualdatacontainertype:
Collaboration graph

Public Member Functions

procedure vdc_create (this, name, id, is_local)
generic map (this, vd, stages)
generic map (this, vd, nrow, stages)
generic map (this, vd, ncol, nrow, stages)
procedure prepare_stage (this, stage)
procedure link_items (this, stage)
 Link all local data items to memory.
procedure 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.
procedure get_vrt_mem_path (this, var_name, subcomp_name)
 Get virtual memory path for a certain variable.
procedure destroy (this)
procedure set_orig_rank (this, rank)
procedure get_send_items (this, stg, rank, vi)
 Get indexes of virtual data items to be.
procedure get_recv_items (this, stg, rank, vi)
 Get indexes of virtual data items to be.
procedure get_virtual_data (this, var_name, subcomp_name)
procedure print_items (this, imon, items)
procedure set (this, field, var_name, subcmp_name, map_id, is_local)
 Init virtual data item, without allocation, and store it in this container. The 'is_local' flag makes it possible to mark some fields local in an.

Public Attributes

integer(i4b) id
 unique identifier matching with the real counterpart
integer(i4b) container_type
 to identify the actual type of this container
character(lencomponentname) name
 container name (model, exchange, ...) used in the memory path
character(lencontextname) vmem_ctx
 prefixes virtual memory located on remote processes
logical(lgp) is_local
 when true, the physical object resides on the same process. However, some of its variables can still be remote
logical(lgp) is_active
 when true, this container is being synchronized
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
type(stlvecint) rcv_ranks
 the ranks of processes, other than orig_rank, having this container active (only guaranteed to be complete after synchronization)
type(listtype) virtual_data_list
 a list with all virtual data items for this container
type(vdcelementmaptype), dimension(nr_vdc_element_maps) element_maps
 a list with all element maps
type(vdcelementluttype), dimension(nr_vdc_element_maps) element_luts
 lookup tables from remote index to local index

Private Member Functions

procedure, private add_to_list (this, virtual_data)
procedure, private map_scalar (this, vd, stages)
procedure, private map_array1d (this, vd, nrow, stages)
procedure, private map_array2d (this, vd, ncol, nrow, stages)
procedure, private map_internal (this, vd, shape, stages)
procedure, private vdc_get_virtual_data (this, var_name, subcomp_name)
procedure, private get_items_for_stage (this, stage, virtual_items)

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 ( class(virtualdatacontainertype) this,
class(virtualdatatype), pointer virtual_data )
private

Definition at line 86 of file VirtualDataContainer.f90.

◆ destroy()

procedure virtualdatacontainermodule::virtualdatacontainertype::destroy ( class(virtualdatacontainertype) this)

Definition at line 77 of file VirtualDataContainer.f90.

◆ get_items_for_stage()

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

Definition at line 92 of file VirtualDataContainer.f90.

◆ get_recv_items()

procedure virtualdatacontainermodule::virtualdatacontainertype::get_recv_items ( class(virtualdatacontainertype) this,
integer(i4b) stg,
integer(i4b) rank,
type(stlvecint) vi )

Definition at line 80 of file VirtualDataContainer.f90.

◆ get_send_items()

procedure virtualdatacontainermodule::virtualdatacontainertype::get_send_items ( class(virtualdatacontainertype) this,
integer(i4b) stg,
integer(i4b) rank,
type(stlvecint) vi )

Definition at line 79 of file VirtualDataContainer.f90.

◆ get_virtual_data()

procedure virtualdatacontainermodule::virtualdatacontainertype::get_virtual_data ( class(virtualdatacontainertype) this,
character(len=*) var_name,
character(len=*) subcomp_name )

Definition at line 81 of file VirtualDataContainer.f90.

◆ get_vrt_mem_path()

procedure virtualdatacontainermodule::virtualdatacontainertype::get_vrt_mem_path ( class(virtualdatacontainertype) this,
character(len=*) var_name,
character(len=*) subcomp_name )

Definition at line 76 of file VirtualDataContainer.f90.

◆ link_items()

procedure virtualdatacontainermodule::virtualdatacontainertype::link_items ( class(virtualdatacontainertype) this,
integer(i4b) stage )

Definition at line 74 of file VirtualDataContainer.f90.

◆ map() [1/3]

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

Definition at line 72 of file VirtualDataContainer.f90.

◆ map() [2/3]

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

Definition at line 72 of file VirtualDataContainer.f90.

◆ map() [3/3]

generic virtualdatacontainermodule::virtualdatacontainertype::map ( class(virtualdatacontainertype) this,
class(virtualdatatype), pointer vd,
integer(i4b), dimension(:) stages )

Definition at line 72 of file VirtualDataContainer.f90.

Here is the call graph for this function:

◆ map_array1d()

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

Definition at line 88 of file VirtualDataContainer.f90.

◆ map_array2d()

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

Definition at line 89 of file VirtualDataContainer.f90.

◆ map_internal()

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

Definition at line 90 of file VirtualDataContainer.f90.

◆ map_scalar()

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

Definition at line 87 of file VirtualDataContainer.f90.

◆ prepare_stage()

procedure virtualdatacontainermodule::virtualdatacontainertype::prepare_stage ( class(virtualdatacontainertype) this,
integer(i4b) stage )

Definition at line 73 of file VirtualDataContainer.f90.

◆ print_items()

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

Definition at line 82 of file VirtualDataContainer.f90.

◆ set()

procedure virtualdatacontainermodule::virtualdatacontainertype::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 )

Definition at line 84 of file VirtualDataContainer.f90.

◆ set_element_map()

procedure virtualdatacontainermodule::virtualdatacontainertype::set_element_map ( class(virtualdatacontainertype) this,
integer(i4b), dimension(:), pointer, contiguous src_indexes,
integer(i4b) map_id )

Definition at line 75 of file VirtualDataContainer.f90.

◆ set_orig_rank()

procedure virtualdatacontainermodule::virtualdatacontainertype::set_orig_rank ( class(virtualdatacontainertype) this,
integer(i4b) rank )

Definition at line 78 of file VirtualDataContainer.f90.

◆ vdc_create()

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

Definition at line 71 of file VirtualDataContainer.f90.

◆ vdc_get_virtual_data()

procedure, private virtualdatacontainermodule::virtualdatacontainertype::vdc_get_virtual_data ( class(virtualdatacontainertype) this,
character(len=*) var_name,
character(len=*) subcomp_name )
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: