spatialmodelconnectionmodule Module Reference

Data Types
type	spatialmodelconnectiontype
	Class to manage spatial connection of a model to one or more models of the same type. Spatial connection here means that the model domains (spatial discretization) are adjacent and connected via DisConnExchangeType object(s). The connection itself is a Numerical Exchange as well, and part of a Numerical Solution providing the amat and rhs. More...

Functions/Subroutines
subroutine	spatialconnection_ctor (this, model, exchange, name)
	Construct the spatial connection base. More...
subroutine	createmodelhalo (this)
	Find all models that might participate in this interface. More...
recursive subroutine	addmodelneighbors (this, model_id, virtual_exchanges, depth, is_root, mask)
	Add neighbors and nbrs-of-nbrs to the model tree. More...
subroutine	spatialcon_df (this)
	Define this connection, this is where the discretization (DISU) for the interface model is. More...
subroutine	spatialcon_ar (this)
	Allocate the connection,. More...
subroutine	spatialcon_setmodelptrs (this)
	set model pointers to connection More...
subroutine	spatialcon_connect (this)
	map interface model connections to our sparse matrix, More...
subroutine	maskownerconnections (this)
	Mask the owner's connections. More...
subroutine	createcoefficientmatrix (this, sparse)
	Add connections, handled by the interface model,. More...
subroutine	validateconnection (this)
	Validate this connection. More...
subroutine	cfg_dv (this, var_name, subcomp_name, map_type, sync_stages, exg_var_name)
	Add a variable from the interface model to be synchronized at the configured stages by copying from the source memory in the models/exchanges that are part. More...
class(spatialmodelconnectiontype) function, pointer, public	cast_as_smc (obj)
	Cast to SpatialModelConnectionType. More...
subroutine, public	add_smc_to_list (list, conn)
	Add connection to a list. More...
class(spatialmodelconnectiontype) function, pointer, public	get_smc_from_list (list, idx)
	Get the connection from a list. More...

Function/Subroutine Documentation

add_smc_to_list()

subroutine, public spatialmodelconnectionmodule::add_smc_to_list	(	type(listtype), intent(inout)	list,
		class(spatialmodelconnectiontype), intent(in), pointer	conn
	)

Parameters

[in,out]	list	the list
[in]	conn	the connection

Definition at line 697 of file SpatialModelConnection.f90.

    implicit none
    ! -- dummy
    type(ListType), intent(inout) :: list !< the list
    class(SpatialModelConnectionType), pointer, intent(in) :: conn !< the connection
    ! -- local
    class(*), pointer :: obj
    !
    obj => conn
    call list%Add(obj)

Here is the caller graph for this function:

addmodelneighbors()

recursive subroutine spatialmodelconnectionmodule::addmodelneighbors ( class(spatialmodelconnectiontype)  this, integer(i4b)  model_id, type(listtype)  virtual_exchanges, integer(i4b), value  depth, logical(lgp)  is_root, integer(i4b), optional  mask  )

private

Parameters

this	this connection
model_id	the model (id) to add neighbors for
virtual_exchanges	list with all virtual exchanges
depth	the maximal number of exchanges between
is_root	true when called for neighbor from primary exchange
mask	don't add this one as a neighbor

Definition at line 154 of file SpatialModelConnection.f90.

    use virtualexchangemodule, only: get_virtual_exchange
    class(SpatialModelConnectionType) :: this !< this connection
    integer(I4B) :: model_id !< the model (id) to add neighbors for
    type(ListType) :: virtual_exchanges !< list with all virtual exchanges
    integer(I4B), value :: depth !< the maximal number of exchanges between
    logical(LGP) :: is_root !< true when called for neighbor from primary exchange
    integer(I4B), optional :: mask !< don't add this one as a neighbor
    ! local
    integer(I4B) :: i, n
    class(VirtualExchangeType), pointer :: v_exg
    integer(I4B) :: neighbor_id
    integer(I4B) :: model_mask
    type(STLVecInt) :: models_at_depth !< model ids at a certain depth, to
                                       !! recurse on for nbrs-of-nbrs search
 
    if (.not. present(mask)) then
      model_mask = 0
    else
      model_mask = mask
    end if
 
    call models_at_depth%init()
 
    if (is_root) then
      ! first layer in the recursive search
      call models_at_depth%push_back_unique(model_id)
 
      ! fetch primary neighbor
      if (this%prim_exchange%v_model1%id == this%owner%id) then
        neighbor_id = this%prim_exchange%v_model2%id
      else
        neighbor_id = this%prim_exchange%v_model1%id
      end if
      ! add
      call models_at_depth%push_back_unique(neighbor_id)
      call this%halo_models%push_back_unique(neighbor_id)
      call this%halo_exchanges%push_back_unique(this%prim_exchange%id)
    else
      ! find all direct neighbors of the model and add them,
      ! avoiding duplicates
      do i = 1, virtual_exchanges%Count()
        neighbor_id = -1
        v_exg => get_virtual_exchange_from_list(virtual_exchanges, i)
        if (v_exg%v_model1%id == model_id) then
          neighbor_id = v_exg%v_model2%id
        else if (v_exg%v_model2%id == model_id) then
          neighbor_id = v_exg%v_model1%id
        end if
 
        ! check if there is a neighbor, and it is not masked
        ! (to prevent back-and-forth connections)
        if (neighbor_id > 0) then
          ! check if masked
          if (neighbor_id == model_mask) cycle
          call models_at_depth%push_back_unique(neighbor_id)
          call this%halo_models%push_back_unique(neighbor_id)
          call this%halo_exchanges%push_back_unique(v_exg%id)
        end if
      end do
    end if
 
    depth = depth - 1
    if (depth == 0) then
      ! and we're done with this branch
      call models_at_depth%destroy()
      return
    end if
 
    ! now recurse on the neighbors up to the specified depth
    do n = 1, models_at_depth%size
      call this%addModelNeighbors(models_at_depth%at(n), virtual_exchanges, &
                                  depth, .false., model_id)
    end do
 
    ! we're done with the tree
    call models_at_depth%destroy()
 

Here is the call graph for this function:

cast_as_smc()

class(spatialmodelconnectiontype) function, pointer, public spatialmodelconnectionmodule::cast_as_smc

(

class(*), intent(inout), pointer

obj

)

Parameters

[in,out]

obj

object to be cast

Returns

the instance of SpatialModelConnectionType

Definition at line 681 of file SpatialModelConnection.f90.

    implicit none
    class(*), pointer, intent(inout) :: obj !< object to be cast
    class(SpatialModelConnectionType), pointer :: res !< the instance of SpatialModelConnectionType
    !
    res => null()
    if (.not. associated(obj)) return
    !
    select type (obj)
    class is (spatialmodelconnectiontype)
      res => obj
    end select

Here is the caller graph for this function:

cfg_dv()

subroutine spatialmodelconnectionmodule::cfg_dv	(	class(spatialmodelconnectiontype)	this,
		character(len=*)	var_name,
		character(len=*)	subcomp_name,
		integer(i4b)	map_type,
		integer(i4b), dimension(:)	sync_stages,
		character(len=*), optional	exg_var_name
	)

Parameters

this	this connection
var_name	name of variable, e.g. "K11"
subcomp_name	subcomponent, e.g. "NPF"
map_type	type of variable map
sync_stages	stages to sync
exg_var_name	needed for exchange variables, e.g. SIMVALS

Definition at line 652 of file SpatialModelConnection.f90.

    class(SpatialModelConnectionType) :: this !< this connection
    character(len=*) :: var_name !< name of variable, e.g. "K11"
    character(len=*) :: subcomp_name !< subcomponent, e.g. "NPF"
    integer(I4B) :: map_type !< type of variable map
    integer(I4B), dimension(:) :: sync_stages !< stages to sync
    character(len=*), optional :: exg_var_name !< needed for exchange variables, e.g. SIMVALS
    ! local
    type(DistVarType), pointer :: dist_var => null()
    class(*), pointer :: obj
 
    if (.not. present(exg_var_name)) exg_var_name = ''
 
    allocate (dist_var)
    dist_var%var_name = var_name
    dist_var%subcomp_name = subcomp_name
    dist_var%comp_name = this%interface_model%name
    dist_var%map_type = map_type
    dist_var%sync_stages = sync_stages
    dist_var%exg_var_name = exg_var_name
 
    obj => dist_var
    call this%iface_dist_vars%Add(obj)
 

createcoefficientmatrix()

subroutine spatialmodelconnectionmodule::createcoefficientmatrix	(	class(spatialmodelconnectiontype)	this,
		type(sparsematrix), intent(inout)	sparse
	)

Parameters

	this	this connection
[in,out]	sparse	the sparse matrix with the cell connections

Definition at line 610 of file SpatialModelConnection.f90.

    use simmodule, only: ustop
    class(SpatialModelConnectionType) :: this !< this connection
    type(sparsematrix), intent(inout) :: sparse !< the sparse matrix with the cell connections
 
    call sparse%sort()
    call this%matrix%init(sparse, this%memoryPath)
 

Here is the call graph for this function:

createmodelhalo()

subroutine spatialmodelconnectionmodule::createmodelhalo ( class(spatialmodelconnectiontype)  this )

private

Parameters

this	this connection

Definition at line 141 of file SpatialModelConnection.f90.

    class(SpatialModelConnectionType) :: this !< this connection
 
    call this%halo_models%init()
    call this%halo_exchanges%init()
 
    call this%addModelNeighbors(this%owner%id, virtual_exchange_list, &
                                this%exg_stencil_depth, .true.)
 

get_smc_from_list()

class(spatialmodelconnectiontype) function, pointer, public spatialmodelconnectionmodule::get_smc_from_list	(	type(listtype), intent(inout)	list,
		integer(i4b), intent(in)	idx
	)

Parameters

[in,out]	list	the list
[in]	idx	the index of the connection

Returns

the returned connection

Definition at line 711 of file SpatialModelConnection.f90.

    type(ListType), intent(inout) :: list !< the list
    integer(I4B), intent(in) :: idx !< the index of the connection
    class(SpatialModelConnectionType), pointer :: res !< the returned connection
 
    ! local
    class(*), pointer :: obj
    obj => list%GetItem(idx)
    res => cast_as_smc(obj)

Here is the call graph for this function:

Here is the caller graph for this function:

maskownerconnections()

subroutine spatialmodelconnectionmodule::maskownerconnections ( class(spatialmodelconnectiontype)  this )

private

Determine which connections are handled by the interface model (using the connections object in its discretization) and

Parameters

this	the connection

Definition at line 331 of file SpatialModelConnection.f90.

    use csrutilsmodule, only: getcsrindex
    class(SpatialModelConnectionType) :: this !< the connection
    ! local
    integer(I4B) :: ipos, n, m, nloc, mloc, csr_idx
    type(ConnectionsType), pointer :: conn
 
    ! set the mask on connections that are calculated by the interface model
    conn => this%interface_model%dis%con
    do n = 1, conn%nodes
      ! only for connections internal to the owning model
      if (.not. this%ig_builder%idxToGlobal(n)%v_model == this%owner) then
        cycle
      end if
      nloc = this%ig_builder%idxToGlobal(n)%index
 
      do ipos = conn%ia(n) + 1, conn%ia(n + 1) - 1
        m = conn%ja(ipos)
        if (.not. this%ig_builder%idxToGlobal(m)%v_model == this%owner) then
          cycle
        end if
        mloc = this%ig_builder%idxToGlobal(m)%index
 
        if (conn%mask(ipos) > 0) then
          ! calculated by interface model, set local model's mask to zero
          csr_idx = getcsrindex(nloc, mloc, this%owner%ia, this%owner%ja)
          if (csr_idx == -1) then
            ! this can only happen with periodic boundary conditions,
            ! then there is no need to set the mask
            if (this%ig_builder%isPeriodic(nloc, mloc)) cycle
 
            write (*, *) 'Error: cannot find cell connection in global system'
            call ustop()
          end if
 
          if (this%owner%dis%con%mask(csr_idx) > 0) then
            call this%owner%dis%con%set_mask(csr_idx, 0)
          else
            ! edge case, this connection is already being calculated
            ! so we ignore it here. This can happen in the overlap
            ! between two different exchanges when a larger stencil
            ! (XT3D) is applied.
            call conn%set_mask(ipos, 0)
          end if
        end if
      end do
    end do
 

Here is the call graph for this function:

spatialcon_ar()

subroutine spatialmodelconnectionmodule::spatialcon_ar ( class(spatialmodelconnectiontype)  this )

private

Parameters

this	this connection

Definition at line 266 of file SpatialModelConnection.f90.

    class(SpatialModelConnectionType) :: this !< this connection
    ! local
    integer(I4B) :: iface_idx, glob_idx
    class(GridConnectionType), pointer :: gc
 
    ! fill mapping to global index (which can be
    ! done now because moffset is set in sln_df)
    gc => this%ig_builder
    do iface_idx = 1, gc%nrOfCells
      glob_idx = gc%idxToGlobal(iface_idx)%index + &
                 gc%idxToGlobal(iface_idx)%v_model%moffset%get()
      gc%idxToGlobalIdx(iface_idx) = glob_idx
    end do
 

spatialcon_connect()

subroutine spatialmodelconnectionmodule::spatialcon_connect ( class(spatialmodelconnectiontype)  this )

private

Parameters

this	this connection

Definition at line 306 of file SpatialModelConnection.f90.

    class(SpatialModelConnectionType) :: this !< this connection
    ! local
    type(sparsematrix) :: sparse
    class(MatrixBaseType), pointer :: matrix_base
 
    call sparse%init(this%neq, this%neq, 7)
    call this%interface_model%model_ac(sparse)
 
    ! create amat from sparse
    call this%createCoefficientMatrix(sparse)
    call sparse%destroy()
 
    ! map connections
    matrix_base => this%matrix
    call this%interface_model%model_mc(matrix_base)
    call this%maskOwnerConnections()
 

spatialcon_df()

subroutine spatialmodelconnectionmodule::spatialcon_df

(

class(spatialmodelconnectiontype)

this

)

Parameters

this	this connection

Definition at line 239 of file SpatialModelConnection.f90.

    class(SpatialModelConnectionType) :: this !< this connection
    ! local
    integer(I4B) :: i
    class(VirtualModelType), pointer :: v_model
 
    ! create the grid connection data structure
    this%nr_connections = this%getNrOfConnections()
    call this%ig_builder%construct(this%owner, &
                                   this%nr_connections, &
                                   this%name)
    this%ig_builder%internalStencilDepth = this%int_stencil_depth
    this%ig_builder%exchangeStencilDepth = this%exg_stencil_depth
    this%ig_builder%haloExchanges => this%halo_exchanges
    do i = 1, this%halo_models%size
      v_model => get_virtual_model(this%halo_models%at(i))
      call this%ig_builder%addToRegionalModels(v_model)
    end do
    call this%setupGridConnection()
 
    this%neq = this%ig_builder%nrOfCells
    call this%allocateArrays()
 

spatialcon_setmodelptrs()

subroutine spatialmodelconnectionmodule::spatialcon_setmodelptrs ( class(spatialmodelconnectiontype)  this )

private

Parameters

this	this connection

Definition at line 285 of file SpatialModelConnection.f90.

    class(SpatialModelConnectionType) :: this !< this connection
 
    ! point x, ibound, and rhs to connection
    this%interface_model%x => this%x
    call mem_checkin(this%interface_model%x, 'X', &
                     this%interface_model%memoryPath, 'X', &
                     this%memoryPath)
    this%interface_model%rhs => this%rhs
    call mem_checkin(this%interface_model%rhs, 'RHS', &
                     this%interface_model%memoryPath, 'RHS', &
                     this%memoryPath)
    this%interface_model%ibound => this%active
    call mem_checkin(this%interface_model%ibound, 'IBOUND', &
                     this%interface_model%memoryPath, 'IBOUND', &
                     this%memoryPath)
 

spatialconnection_ctor()

subroutine spatialmodelconnectionmodule::spatialconnection_ctor	(	class(spatialmodelconnectiontype)	this,
		class(numericalmodeltype), intent(in), pointer	model,
		class(disconnexchangetype), intent(in), pointer	exchange,
		character(len=*), intent(in)	name
	)

This constructor is typically called from a derived class.

Parameters

	this	the connection
[in]	model	the model that owns the connection
[in]	exchange	the primary exchange from which the connection is created
[in]	name	the connection name (for memory management mostly)

Definition at line 111 of file SpatialModelConnection.f90.

    class(SpatialModelConnectionType) :: this !< the connection
    class(NumericalModelType), intent(in), pointer :: model !< the model that owns the connection
    class(DisConnExchangeType), intent(in), pointer :: exchange !< the primary exchange from which
                                                                !! the connection is created
    character(len=*), intent(in) :: name !< the connection name (for memory management mostly)
 
    this%name = name
    this%memoryPath = create_mem_path(this%name)
 
    this%owner => model
    this%prim_exchange => exchange
 
    allocate (this%ig_builder)
    allocate (this%halo_models)
    allocate (this%halo_exchanges)
    allocate (this%matrix)
    call this%allocateScalars()
 
    this%int_stencil_depth = 1
    this%exg_stencil_depth = 1
    this%nr_connections = 0
 
    ! this should be set in derived ctor
    this%interface_model => null()
 

Here is the call graph for this function:

Here is the caller graph for this function:

validateconnection()

subroutine spatialmodelconnectionmodule::validateconnection

(

class(spatialmodelconnectiontype)

this

)

Parameters

this	this connection

Definition at line 622 of file SpatialModelConnection.f90.

    use simvariablesmodule, only: errmsg
    use simmodule, only: store_error
    class(SpatialModelConnectionType) :: this !< this connection
    ! local
    class(DisConnExchangeType), pointer :: conEx => null()
 
    conex => this%prim_exchange
    if (conex%ixt3d > 0) then
      ! if XT3D, we need these angles:
      if (conex%v_model1%con_ianglex%get() == 0) then
        write (errmsg, '(a,a,a,a,a)') 'XT3D configured on the exchange ', &
          trim(conex%name), ' but the discretization in model ', &
          trim(conex%v_model1%name), ' has no ANGLDEGX specified'
        call store_error(errmsg)
      end if
      if (conex%v_model2%con_ianglex%get() == 0) then
        write (errmsg, '(a,a,a,a,a)') 'XT3D configured on the exchange ', &
          trim(conex%name), ' but the discretization in model ', &
          trim(conex%v_model2%name), ' has no ANGLDEGX specified'
        call store_error(errmsg)
      end if
    end if
 

Here is the call graph for this function: