Doxygen Generated Documentation From Interface Source Code
Grid_getBlkIDFromPos.F90 File Reference

Go to the source code of this file.


subroutine Grid_getBlkIDFromPos (pos, ansBlockID, ansProcID, comm)

Function/Subroutine Documentation

◆ Grid_getBlkIDFromPos()

subroutine Grid_getBlkIDFromPos ( real, dimension(1:MDIM)  pos,
integer  ansBlockID,
integer  ansProcID,
integer, optional  comm 

Returns the processor and block ID containing the cell that overlaps with the specified position co-ordinate.

pos :: co-ordinates of the point ansBlockID :: the local blockID of the block that contains the point; or NONEXISTENT if no matching block was found globally. ansProcID :: the ID of the processor that contains the point; or NONEXISTENT if no matching block was found anywhere. comm :: if communication is necessary, a communicator must be specified here. Communication is necessary unless the setup uses BITTREE. The comm argument is ignored if BITTREE is used.


If a communicator comm is present and used, then this routine must be called collectively by all MPI tasks in the communicator. In a collective call, all tasks are expected to call with the same values for the coordinate tuple in pos. In other words, The intent(in) arguments should have the same values on all tasks.

On return, ansBlockID and ansBlockID will contain the same values on all tasks that provided the same input values for pos (and comm, if appropriate).

Definition at line 47 of file Grid_getBlkIDFromPos.F90.