D.6.7 Get_Locus_Distributed_Vector Procedure

The main documentation of the Get_Locus_Distributed_Vector Procedure contains additional explanation of this code listing.

  function Get_Locus_Distributed_Vector (DV) result(Locus_DV)

    ! Input variable.

    type(Distributed_Vector_type), intent(in) :: DV  ! Variable to be queried.

    ! Output variable.

    type(character,name_length) :: Locus_DV          ! Locus of DV.

    !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    ! Verify requirements.

    VERIFY(Valid_State(DV),5)      ! DV is valid.

    ! Set the value.

    Locus_DV = Locus(DV%Structure)

    ! Verify guarantees - none.

    return
  end function Get_Locus_Distributed_Vector