virtualbasemodule Module Reference

Data Types
type	virtualdatatype
	This is a generic data structure to virtualize pieces of memory in 2 distinct ways: More...
type	virtualinttype
type	virtualint1dtype
type	virtualdbltype
type	virtualdbl1dtype
type	virtualdbl2dtype
interface	vm_allocate_if
interface	vm_deallocate_if

Functions/Subroutines
class(virtualdatatype) function, pointer	vm_to_base (this)
logical(lgp) function	vm_check_stage (this, stage)
	Check if this data item requires syncing. More...
subroutine	vm_link (this)
integer(i4b) function, dimension(:), pointer, contiguous	get_element_map (this)
	Return array with offsets for elements. More...
subroutine	vm_allocate_int (this, var_name, mem_path, shape)
subroutine	vm_deallocate_int (this)
subroutine	vm_allocate_int1d (this, var_name, mem_path, shape)
subroutine	vm_deallocate_int1d (this)
subroutine	vm_allocate_dbl (this, var_name, mem_path, shape)
subroutine	vm_deallocate_dbl (this)
subroutine	vm_allocate_dbl1d (this, var_name, mem_path, shape)
subroutine	vm_deallocate_dbl1d (this)
subroutine	vm_allocate_dbl2d (this, var_name, mem_path, shape)
subroutine	vm_deallocate_dbl2d (this)
integer(i4b) function	get_int (this)
integer(i4b) function	get_int1d (this, i_rmt)
integer(i4b) function, dimension(:), pointer, contiguous	get_array_int1d (this)
real(dp) function	get_dbl (this)
real(dp) function	get_dbl1d (this, i_rmt)
real(dp) function, dimension(:), pointer, contiguous	get_array_dbl1d (this)
real(dp) function	get_dbl2d (this, j_cmp, i_rmt)
real(dp) function, dimension(:, :), pointer, contiguous	get_array_dbl2d (this)
class(virtualdatatype) function, pointer, public	get_virtual_data_from_list (list, idx)

Variables
integer(i4b), parameter, public	map_all_type = 0
integer(i4b), parameter, public	map_node_type = 1
integer(i4b), parameter, public	map_conn_type = 2
integer(i4b), parameter, public	nr_vdc_element_maps = 2

Function/Subroutine Documentation

get_array_dbl1d()

real(dp) function, dimension(:), pointer, contiguous virtualbasemodule::get_array_dbl1d ( class(virtualdbl1dtype)  this )

private

Definition at line 307 of file VirtualBase.f90.

    class(VirtualDbl1dType) :: this
    real(DP), dimension(:), pointer, contiguous :: array
 
    array => this%virtual_mt%adbl1d
 

get_array_dbl2d()

real(dp) function, dimension(:, :), pointer, contiguous virtualbasemodule::get_array_dbl2d ( class(virtualdbl2dtype)  this )

private

Definition at line 332 of file VirtualBase.f90.

    class(VirtualDbl2dType) :: this
    real(DP), dimension(:, :), pointer, contiguous :: array
 
    array => this%virtual_mt%adbl2d
 

get_array_int1d()

integer(i4b) function, dimension(:), pointer, contiguous virtualbasemodule::get_array_int1d ( class(virtualint1dtype)  this )

private

Definition at line 275 of file VirtualBase.f90.

    class(VirtualInt1dType) :: this
    integer(I4B), dimension(:), pointer, contiguous :: array
 
    array => this%virtual_mt%aint1d
 

get_dbl()

real(dp) function virtualbasemodule::get_dbl ( class(virtualdbltype)  this )

private

Definition at line 283 of file VirtualBase.f90.

    class(VirtualDblType) :: this
    real(DP) :: val
 
    val = this%virtual_mt%dblsclr
 

get_dbl1d()

real(dp) function virtualbasemodule::get_dbl1d ( class(virtualdbl1dtype)  this, integer(i4b)  i_rmt  )

private

Definition at line 291 of file VirtualBase.f90.

    class(VirtualDbl1dType) :: this
    integer(I4B) :: i_rmt
    real(DP) :: val
    ! local
    integer(I4B) :: i_vrt
 
    if (this%is_reduced) then
      i_vrt = this%remote_to_virtual(i_rmt)
    else
      i_vrt = i_rmt
    end if
    val = this%virtual_mt%adbl1d(i_vrt)
 

get_dbl2d()

real(dp) function virtualbasemodule::get_dbl2d ( class(virtualdbl2dtype)  this, integer(i4b)  j_cmp, integer(i4b)  i_rmt  )

private

Definition at line 315 of file VirtualBase.f90.

    class(VirtualDbl2dType) :: this
    integer(I4B) :: j_cmp
    integer(I4B) :: i_rmt
    real(DP) :: val
    ! local
    integer(I4B) :: i_vrt
 
    if (this%is_reduced) then
      i_vrt = this%remote_to_virtual(i_rmt)
    else
      i_vrt = i_rmt
    end if
    val = this%virtual_mt%adbl2d(j_cmp, i_vrt)
 

get_element_map()

integer(i4b) function, dimension(:), pointer, contiguous virtualbasemodule::get_element_map ( class(virtualdatatype), target  this )

private

Definition at line 155 of file VirtualBase.f90.

    class(VirtualDataType), target :: this
    integer(I4B), dimension(:), pointer, contiguous :: el_map
 
    el_map => null()
    if (this%map_type > 0) then
      el_map => this%remote_elem_shift
    end if
 

get_int()

integer(i4b) function virtualbasemodule::get_int ( class(virtualinttype)  this )

private

Definition at line 251 of file VirtualBase.f90.

    class(VirtualIntType) :: this
    integer(I4B) :: val
 
    val = this%virtual_mt%intsclr
 

get_int1d()

integer(i4b) function virtualbasemodule::get_int1d ( class(virtualint1dtype)  this, integer(i4b)  i_rmt  )

private

Definition at line 259 of file VirtualBase.f90.

    class(VirtualInt1dType) :: this
    integer(I4B) :: i_rmt
    integer(I4B) :: val
    ! local
    integer(I4B) :: i_vrt
 
    if (this%is_reduced) then
      i_vrt = this%remote_to_virtual(i_rmt)
    else
      i_vrt = i_rmt
    end if
    val = this%virtual_mt%aint1d(i_vrt)
 

get_virtual_data_from_list()

class(virtualdatatype) function, pointer, public virtualbasemodule::get_virtual_data_from_list	(	type(listtype)	list,
		integer(i4b)	idx
	)

Definition at line 340 of file VirtualBase.f90.

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

Here is the caller graph for this function:

vm_allocate_dbl()

subroutine virtualbasemodule::vm_allocate_dbl ( class(virtualdbltype)  this, character(len=*)  var_name, character(len=*)  mem_path, integer(i4b), dimension(:)  shape  )

private

Definition at line 200 of file VirtualBase.f90.

    class(VirtualDblType) :: this
    character(len=*) :: var_name
    character(len=*) :: mem_path
    integer(I4B), dimension(:) :: shape
 
    call mem_allocate(this%dblsclr, var_name, mem_path)
 

vm_allocate_dbl1d()

subroutine virtualbasemodule::vm_allocate_dbl1d ( class(virtualdbl1dtype)  this, character(len=*)  var_name, character(len=*)  mem_path, integer(i4b), dimension(:)  shape  )

private

Definition at line 217 of file VirtualBase.f90.

    class(VirtualDbl1dType) :: this
    character(len=*) :: var_name
    character(len=*) :: mem_path
    integer(I4B), dimension(:) :: shape
 
    call mem_allocate(this%dbl1d, shape(1), var_name, mem_path)
 

vm_allocate_dbl2d()

subroutine virtualbasemodule::vm_allocate_dbl2d ( class(virtualdbl2dtype)  this, character(len=*)  var_name, character(len=*)  mem_path, integer(i4b), dimension(:)  shape  )

private

Definition at line 234 of file VirtualBase.f90.

    class(VirtualDbl2dType) :: this
    character(len=*) :: var_name
    character(len=*) :: mem_path
    integer(I4B), dimension(:) :: shape
 
    call mem_allocate(this%dbl2d, shape(1), shape(2), var_name, mem_path)
 

vm_allocate_int()

subroutine virtualbasemodule::vm_allocate_int ( class(virtualinttype)  this, character(len=*)  var_name, character(len=*)  mem_path, integer(i4b), dimension(:)  shape  )

private

Definition at line 166 of file VirtualBase.f90.

    class(VirtualIntType) :: this
    character(len=*) :: var_name
    character(len=*) :: mem_path
    integer(I4B), dimension(:) :: shape
 
    call mem_allocate(this%intsclr, var_name, mem_path)
 

vm_allocate_int1d()

subroutine virtualbasemodule::vm_allocate_int1d ( class(virtualint1dtype)  this, character(len=*)  var_name, character(len=*)  mem_path, integer(i4b), dimension(:)  shape  )

private

Definition at line 183 of file VirtualBase.f90.

    class(VirtualInt1dType) :: this
    character(len=*) :: var_name
    character(len=*) :: mem_path
    integer(I4B), dimension(:) :: shape
 
    call mem_allocate(this%int1d, shape(1), var_name, mem_path)
 

vm_check_stage()

logical(lgp) function virtualbasemodule::vm_check_stage ( class(virtualdatatype), target  this, integer(i4b)  stage  )

private

Definition at line 129 of file VirtualBase.f90.

    use arrayhandlersmodule, only: ifind
    class(VirtualDataType), target :: this
    integer(I4B) :: stage, stg_idx
    logical(LGP) :: has_stage
 
    has_stage = .false.
    if (allocated(this%sync_stages)) then
      stg_idx = ifind(this%sync_stages, stage)
      has_stage = (stg_idx > 0)
    end if
 

vm_deallocate_dbl()

subroutine virtualbasemodule::vm_deallocate_dbl ( class(virtualdbltype)  this )

private

Definition at line 210 of file VirtualBase.f90.

    class(VirtualDblType) :: this
 
    if (this%is_remote) call mem_deallocate(this%dblsclr)
 

vm_deallocate_dbl1d()

subroutine virtualbasemodule::vm_deallocate_dbl1d ( class(virtualdbl1dtype)  this )

private

Definition at line 227 of file VirtualBase.f90.

    class(VirtualDbl1dType) :: this
 
    if (this%is_remote) call mem_deallocate(this%dbl1d)
 

vm_deallocate_dbl2d()

subroutine virtualbasemodule::vm_deallocate_dbl2d ( class(virtualdbl2dtype)  this )

private

Definition at line 244 of file VirtualBase.f90.

    class(VirtualDbl2dType) :: this
 
    if (this%is_remote) call mem_deallocate(this%dbl2d)
 

vm_deallocate_int()

subroutine virtualbasemodule::vm_deallocate_int ( class(virtualinttype)  this )

private

Definition at line 176 of file VirtualBase.f90.

    class(VirtualIntType) :: this
 
    if (this%is_remote) call mem_deallocate(this%intsclr)
 

vm_deallocate_int1d()

subroutine virtualbasemodule::vm_deallocate_int1d ( class(virtualint1dtype)  this )

private

Definition at line 193 of file VirtualBase.f90.

    class(VirtualInt1dType) :: this
 
    if (this%is_remote) call mem_deallocate(this%int1d)
 

vm_link()

subroutine virtualbasemodule::vm_link

(

class(virtualdatatype), target

this

)

Definition at line 143 of file VirtualBase.f90.

    class(VirtualDataType), target :: this
    ! local
    logical(LGP) :: found
 
    call get_from_memorystore(this%var_name, this%mem_path, &
                              this%virtual_mt, found)
 

Here is the call graph for this function:

vm_to_base()

class(virtualdatatype) function, pointer virtualbasemodule::vm_to_base ( class(virtualdatatype), target  this )

private

Definition at line 119 of file VirtualBase.f90.

    class(VirtualDataType), target :: this
    class(VirtualDataType), pointer :: base_ptr
 
    base_ptr => this
 

Variable Documentation

map_all_type

integer(i4b), parameter, public virtualbasemodule::map_all_type = 0

Definition at line 13 of file VirtualBase.f90.

  integer(I4B), public, parameter :: MAP_ALL_TYPE = 0

map_conn_type

integer(i4b), parameter, public virtualbasemodule::map_conn_type = 2

Definition at line 15 of file VirtualBase.f90.

  integer(I4B), public, parameter :: MAP_CONN_TYPE = 2

map_node_type

integer(i4b), parameter, public virtualbasemodule::map_node_type = 1

Definition at line 14 of file VirtualBase.f90.

  integer(I4B), public, parameter :: MAP_NODE_TYPE = 1

nr_vdc_element_maps

integer(i4b), parameter, public virtualbasemodule::nr_vdc_element_maps = 2

Definition at line 16 of file VirtualBase.f90.

  integer(I4B), public, parameter :: NR_VDC_ELEMENT_MAPS = 2