Data Types
type	mappertype

Functions/Subroutines
subroutine	init (this)

subroutine	add_exchange_vars (this)
	Add virtual exchange variables. More...

subroutine	add_interface_vars (this)
	Add distributed interface variables as memory mapped items. More...

subroutine	add_dist_vars (this, sol_id, var_list, iface_map)

subroutine	map_model_data (this, sol_id, iface_map, model_idx, dist_var)
	Map data from model memory to a target memory entry, with the specified map. The source and target items have. More...

subroutine	map_exg_data (this, sol_id, iface_map, exg_idx, dist_var)
	Map memory from a Exchange to the specified memory entry,. More...

subroutine	map_data_full (this, controller_id, tgt_name, tgt_path, src_name, src_path, stages)
	Full copy between two variables in memory. More...

subroutine	map_data (this, controller_id, tgt_name, tgt_path, tgt_idx, src_name, src_path, src_idx, sign_array, lookup_table, stages)
	Generic mapping between two variables in memory, using. More...

subroutine	scatter (this, controller_id, stage)
	Scatter the mapped memory, typically into. More...

logical(lgp) function	check_stage (var_stage, current_stage)

subroutine	destroy (this)

Function/Subroutine Documentation

◆ add_dist_vars()

subroutine mappermodule::add_dist_vars	(	class(mappertype)	this,
		integer(i4b)	sol_id,
		type(listtype)	var_list,
		type(interfacemaptype), pointer	iface_map
	)

Definition at line 128 of file Mapper.f90.

     class(MapperType) :: this
     integer(I4B) :: sol_id
     type(ListType) :: var_list
     type(InterfaceMapType), pointer :: iface_map
     ! local
     integer(I4B) :: i, m, e
     type(DistVarType), pointer :: dist_var
  
     ! loop over variables
     do i = 1, var_list%Count()
       dist_var => getdistvarfromlist(var_list, i)
       if (dist_var%map_type == sync_nds .or. & ! models
           dist_var%map_type == sync_con) then
         do m = 1, iface_map%nr_models
           call this%map_model_data(sol_id, iface_map, m, dist_var)
         end do
       else if (dist_var%map_type == sync_exg) then ! exchanges
         do e = 1, iface_map%nr_exchanges
           call this%map_exg_data(sol_id, iface_map, e, dist_var)
         end do
       end if
     end do
  

Here is the call graph for this function:

◆ add_exchange_vars()

subroutine mappermodule::add_exchange_vars ( class(mappertype) this )

private

Definition at line 43 of file Mapper.f90.

     use simstagesmodule
     use listsmodule, only: baseconnectionlist
     use spatialmodelconnectionmodule, only: spatialmodelconnectiontype, &
                                             get_smc_from_list
     use virtualexchangemodule, only: virtualexchangetype, get_virtual_exchange
     class(MapperType) :: this
     ! local
     integer(I4B) :: iconn
     class(SpatialModelConnectionType), pointer :: conn
     class(VirtualExchangeType), pointer :: virt_exg
     character(len=LENMEMPATH) :: virt_mem_path, local_mem_path
  
     do iconn = 1, baseconnectionlist%Count()
       conn => get_smc_from_list(baseconnectionlist, iconn)
       virt_exg => get_virtual_exchange(conn%prim_exchange%id)
       if (.not. virt_exg%v_model1%is_local) then
         virt_mem_path = virt_exg%get_vrt_mem_path('NODEM1', '')
         call this%map_data_full(0, 'NODEM1', conn%prim_exchange%memoryPath, &
                                 'NODEM1', virt_mem_path, (/stg_bfr_con_df/))
  
         ! these are only present when there is a mover:
         if (virt_exg%has_mover()) then
           local_mem_path = create_mem_path(virt_exg%name, 'MVR')
           virt_mem_path = virt_exg%get_vrt_mem_path('QPACTUAL_M1', 'MVR')
           call this%map_data_full(conn%owner%idsoln, 'QPACTUAL_M1', &
                                   local_mem_path, 'QPACTUAL_M1', &
                                   virt_mem_path, (/stg_bfr_exg_fc/))
           virt_mem_path = virt_exg%get_vrt_mem_path('QAVAILABLE_M1', 'MVR')
           call this%map_data_full(conn%owner%idsoln, 'QAVAILABLE_M1', &
                                   local_mem_path, 'QAVAILABLE_M1', &
                                   virt_mem_path, (/stg_bfr_exg_fc/))
           virt_mem_path = virt_exg%get_vrt_mem_path('ID_MAPPED_M1', 'MVR')
           call this%map_data_full(conn%owner%idsoln, 'ID_MAPPED_M1', &
                                   local_mem_path, 'ID_MAPPED_M1', &
                                   virt_mem_path, (/stg_aft_con_rp/))
         end if
       end if
       if (.not. virt_exg%v_model2%is_local) then
         virt_mem_path = virt_exg%get_vrt_mem_path('NODEM2', '')
         call this%map_data_full(0, 'NODEM2', conn%prim_exchange%memoryPath, &
                                 'NODEM2', virt_mem_path, (/stg_bfr_con_df/))
  
         ! these are only present when there is a mover:
         if (virt_exg%has_mover()) then
           local_mem_path = create_mem_path(virt_exg%name, 'MVR')
           virt_mem_path = virt_exg%get_vrt_mem_path('QPACTUAL_M2', 'MVR')
           call this%map_data_full(conn%owner%idsoln, 'QPACTUAL_M2', &
                                   local_mem_path, 'QPACTUAL_M2', &
                                   virt_mem_path, (/stg_bfr_exg_fc/))
           virt_mem_path = virt_exg%get_vrt_mem_path('QAVAILABLE_M2', 'MVR')
           call this%map_data_full(conn%owner%idsoln, 'QAVAILABLE_M2', &
                                   local_mem_path, 'QAVAILABLE_M2', &
                                   virt_mem_path, (/stg_bfr_exg_fc/))
           virt_mem_path = virt_exg%get_vrt_mem_path('ID_MAPPED_M2', 'MVR')
           call this%map_data_full(conn%owner%idsoln, 'ID_MAPPED_M2', &
                                   local_mem_path, 'ID_MAPPED_M2', &
                                   virt_mem_path, (/stg_aft_con_rp/))
         end if
       end if
     end do
  

Here is the call graph for this function:

◆ add_interface_vars()

subroutine mappermodule::add_interface_vars ( class(mappertype) this )

Definition at line 109 of file Mapper.f90.

     use listsmodule, only: baseconnectionlist
     use spatialmodelconnectionmodule, only: spatialmodelconnectiontype, &
                                             get_smc_from_list
     class(MapperType) :: this
     ! local
     integer(I4B) :: iconn
     class(SpatialModelConnectionType), pointer :: conn
  
     do iconn = 1, baseconnectionlist%Count()
       conn => get_smc_from_list(baseconnectionlist, iconn)
       ! add the variables for this interface model to our mapper
       call this%add_dist_vars(conn%owner%idsoln, &
                               conn%iface_dist_vars, &
                               conn%interface_map)
     end do
  

Here is the call graph for this function:

◆ check_stage()

logical(lgp) function mappermodule::check_stage	(	integer(i4b)	var_stage,
		integer(i4b)	current_stage
	)

private

Definition at line 330 of file Mapper.f90.

     integer(I4B) :: var_stage
     integer(I4B) :: current_stage
     logical(LGP) :: is_sync
  
     is_sync = iand(var_stage, ibset(0, current_stage)) == ibset(0, current_stage)
  

Here is the caller graph for this function:

◆ destroy()

subroutine mappermodule::destroy ( class(mappertype) this )

private

Definition at line 339 of file Mapper.f90.

     class(MapperType) :: this
  
     call this%mapped_data_list%Clear(destroy=.true.)

Here is the call graph for this function:

◆ init()

subroutine mappermodule::init ( class(mappertype) this )

private

Definition at line 36 of file Mapper.f90.

37 class(MapperType) :: this

38

◆ map_data()

subroutine mappermodule::map_data	(	class(mappertype)	this,
		integer(i4b)	controller_id,
		character(len=*), intent(in)	tgt_name,
		character(len=*), intent(in)	tgt_path,
		integer(i4b), dimension(:), pointer	tgt_idx,
		character(len=*), intent(in)	src_name,
		character(len=*), intent(in)	src_path,
		integer(i4b), dimension(:), pointer	src_idx,
		integer(i4b), dimension(:), pointer	sign_array,
		integer(i4b), dimension(:), pointer	lookup_table,
		integer(i4b), dimension(:), intent(in)	stages
	)

private

Definition at line 260 of file Mapper.f90.

     class(MapperType) :: this
     integer(I4B) :: controller_id
     character(len=*), intent(in) :: tgt_name
     character(len=*), intent(in) :: tgt_path
     integer(I4B), dimension(:), pointer :: tgt_idx
     character(len=*), intent(in) :: src_name
     character(len=*), intent(in) :: src_path
     integer(I4B), dimension(:), pointer :: src_idx
     integer(I4B), dimension(:), pointer :: sign_array
     integer(I4B), dimension(:), pointer :: lookup_table
     integer(I4B), dimension(:), intent(in) :: stages
     ! local
     integer(I4B) :: istage, i
     type(MappedMemoryType), pointer :: mapped_data
     class(*), pointer :: obj
  
     ! loop and set stage bits
     istage = 0
     do i = 1, size(stages)
       istage = ibset(istage, stages(i))
     end do
  
     ! create MappedVariable and add to list
     allocate (mapped_data)
     mapped_data%controller_id = controller_id
     mapped_data%sync_stage = istage
     mapped_data%src_name = src_name
     mapped_data%src_path = src_path
     mapped_data%src => null()
     mapped_data%tgt_name = tgt_name
     mapped_data%tgt_path = tgt_path
     mapped_data%tgt => null()
     mapped_data%copy_all = .not. associated(src_idx)
     mapped_data%src_idx => src_idx
     mapped_data%tgt_idx => tgt_idx
     mapped_data%sign => sign_array
     mapped_data%lut => lookup_table
     obj => mapped_data
     call this%mapped_data_list%Add(obj)
  

◆ map_data_full()

subroutine mappermodule::map_data_full	(	class(mappertype)	this,
		integer(i4b)	controller_id,
		character(len=*), intent(in)	tgt_name,
		character(len=*), intent(in)	tgt_path,
		character(len=*), intent(in)	src_name,
		character(len=*), intent(in)	src_path,
		integer(i4b), dimension(:), intent(in)	stages
	)

private

Definition at line 242 of file Mapper.f90.

     class(MapperType) :: this
     integer(I4B) :: controller_id
     character(len=*), intent(in) :: tgt_name
     character(len=*), intent(in) :: tgt_path
     character(len=*), intent(in) :: src_name
     character(len=*), intent(in) :: src_path
     integer(I4B), dimension(:), intent(in) :: stages
  
     call this%map_data(controller_id, tgt_name, tgt_path, null(), &
                        src_name, src_path, null(), &
                        null(), null(), stages)
  

◆ map_exg_data()

subroutine mappermodule::map_exg_data	(	class(mappertype)	this,
		integer(i4b)	sol_id,
		type(interfacemaptype), pointer	iface_map,
		integer(i4b), intent(in)	exg_idx,
		type(distvartype), pointer	dist_var
	)

Parameters

	sol_id	the numerical solution where synchr. is controlled
	iface_map	the full interface map
[in]	exg_idx	the index (not id) for the exchange
	dist_var	the distributed variable to map

Definition at line 212 of file Mapper.f90.

     class(MapperType) :: this
     integer(I4B) :: sol_id !< the numerical solution where synchr. is controlled
     type(InterfaceMapType), pointer :: iface_map !< the full interface map
     integer(I4B), intent(in) :: exg_idx !< the index (not id) for the exchange
     type(DistVarType), pointer :: dist_var !< the distributed variable to map
     ! local
     character(len=LENMEMPATH) :: src_mem_path, tgt_mem_path
     class(VirtualExchangeType), pointer :: v_exchange
     type(IndexMapSgnType), pointer :: idx_map
  
     v_exchange => get_virtual_exchange(iface_map%exchange_ids(exg_idx))
  
     idx_map => iface_map%exchange_maps(exg_idx)
  
     if (len_trim(dist_var%subcomp_name) > 0) then
       tgt_mem_path = create_mem_path(dist_var%comp_name, dist_var%subcomp_name)
     else
       tgt_mem_path = create_mem_path(dist_var%comp_name)
     end if
  
     src_mem_path = v_exchange%get_vrt_mem_path(dist_var%exg_var_name, '')
     call this%map_data(sol_id, &
                        dist_var%var_name, tgt_mem_path, idx_map%tgt_idx, &
                        dist_var%exg_var_name, src_mem_path, idx_map%src_idx, &
                        idx_map%sign, null(), dist_var%sync_stages)
  

Here is the call graph for this function:

◆ map_model_data()

subroutine mappermodule::map_model_data	(	class(mappertype)	this,
		integer(i4b)	sol_id,
		type(interfacemaptype), pointer	iface_map,
		integer(i4b)	model_idx,
		type(distvartype), pointer	dist_var
	)

private

Parameters

this	this mapper instance
sol_id	the numerical solution where synchr. is controlled
iface_map	the full interface map
model_idx	the model index (not id) in the interface map
dist_var	the distributed variable to map

Definition at line 159 of file Mapper.f90.

     use simmodule, only: ustop
     class(MapperType) :: this !< this mapper instance
     integer(I4B) :: sol_id !< the numerical solution where synchr. is controlled
     type(InterfaceMapType), pointer :: iface_map !< the full interface map
     integer(I4B) :: model_idx !< the model index (not id) in the interface map
     type(DistVarType), pointer :: dist_var !< the distributed variable to map
     ! local
     character(len=LENVARNAME) :: src_var_name
     character(len=LENMEMPATH) :: src_mem_path, tgt_mem_path
     class(VirtualModelType), pointer :: v_model
     type(IndexMapType), pointer :: idx_map
     integer(I4B), dimension(:), pointer, contiguous :: lookup_table
     class(VirtualDataType), pointer :: vd
  
     v_model => get_virtual_model(iface_map%model_ids(model_idx))
     vd => v_model%get_virtual_data(dist_var%var_name, dist_var%subcomp_name)
  
     ! pick the right index map: connection based or node based,
     ! and reduced data items require a lookup table
     lookup_table => null()
     if (dist_var%map_type == sync_nds) then
       idx_map => iface_map%node_maps(model_idx)
       if (vd%is_reduced) then
         lookup_table => v_model%element_luts(map_node_type)%remote_to_virtual
       end if
     else if (dist_var%map_type == sync_con) then
       idx_map => iface_map%conn_maps(model_idx)
       if (vd%is_reduced) then
         lookup_table => v_model%element_luts(map_conn_type)%remote_to_virtual
       end if
     else
       write (*, *) "Unknown map type for distributed variable ", dist_var%var_name
       call ustop()
     end if
  
     if (len_trim(dist_var%subcomp_name) > 0) then
       tgt_mem_path = create_mem_path(dist_var%comp_name, dist_var%subcomp_name)
     else
       tgt_mem_path = create_mem_path(dist_var%comp_name)
     end if
  
     src_var_name = dist_var%var_name
     src_mem_path = v_model%get_vrt_mem_path(src_var_name, dist_var%subcomp_name)
     call this%map_data(sol_id, &
                        src_var_name, tgt_mem_path, idx_map%tgt_idx, &
                        src_var_name, src_mem_path, idx_map%src_idx, &
                        null(), lookup_table, dist_var%sync_stages)
  

Here is the call graph for this function:

◆ scatter()

subroutine mappermodule::scatter	(	class(mappertype)	this,
		integer(i4b)	controller_id,
		integer(i4b), intent(in)	stage
	)

private

Definition at line 307 of file Mapper.f90.

     class(MapperType) :: this
     integer(I4B) :: controller_id
     integer(I4B), intent(in) :: stage
     ! local
     integer(I4B) :: i
     class(*), pointer :: obj
     class(MappedMemoryType), pointer :: mapped_data
  
     ! sync all variables (src => tgt) for a given stage
     do i = 1, this%mapped_data_list%Count()
       obj => this%mapped_data_list%GetItem(i)
       mapped_data => castasmappeddata(obj)
       if (controller_id > 0 .and. &
           mapped_data%controller_id /= controller_id) cycle
       if (.not. check_stage(mapped_data%sync_stage, stage)) cycle
  
       ! copy data
       call mapped_data%sync()
     end do
  

Here is the call graph for this function:

Data Types

Functions/Subroutines

Function/Subroutine Documentation

◆ add_dist_vars()

◆ add_exchange_vars()

◆ add_interface_vars()

◆ check_stage()

◆ destroy()

◆ init()

◆ map_data()

◆ map_data_full()

◆ map_exg_data()

◆ map_model_data()

◆ scatter()