!
!
! Description: Illustrates the use of VecCreateGhost()
!
!/*T
!   Concepts: vectors^assembling vectors;
!   Concepts: vectors^ghost padding;
!   Processors: n
!
!   Description: Ghost padding is one way to handle local calculations that
!      involve values from other processors. VecCreateGhostBlock() provides
!      a way to create vectors with extra room at the end of the vector 
!      array to contain the needed ghost values from other processors, 
!      vector computations are otherwise unaffected.
!T*/

      program main
      implicit none

!
!  The following include statements are required for Fortran programs
!  that use PETSc vectors:
!     petsc.h       - base PETSc routines
!     petscvec.h    - vectors
!

#include "include/finclude/petsc.h"
#include "include/finclude/petscvec.h"

      PetscMPIInt size,rank
      PetscInt nlocal,nghost,ifrom(2),i,rstart,rend,bs,ione
      PetscTruth      flag
      PetscErrorCode ierr
      PetscScalar  value,tarray(20)
      Vec          lx,gx,gxs

      nlocal = 6
      nghost = 2
      bs     = 2
      nlocal = bs*nlocal

      call PetscInitialize(PETSC_NULL_CHARACTER,ierr)
      call MPI_Comm_rank(PETSC_COMM_WORLD,rank,ierr) 
      call MPI_Comm_size(PETSC_COMM_WORLD,size,ierr) 

      if (size .ne. 2) then
       SETERRQ(1,'Must run with two processors',ierr)
      endif

!
!     Construct a two dimensional graph connecting nlocal degrees of 
!     freedom per processor. From this we will generate the global
!     indices of needed ghost values
!
!     For simplicity we generate the entire graph on each processor:
!     in real application the graph would stored in parallel, but this
!     example is only to demonstrate the management of ghost padding
!     with VecCreateGhost().
!
!     In this example we consider the vector as representing 
!     degrees of freedom in a one dimensional grid with periodic 
!     boundary conditions.
!
!        ----Processor  1-----------  ----Processor 2 --------
!         0 1 2 3 4 5 6 7 8 9 10 11    12 13 14 15 16 17 18 19 20 21 22 23
!                              |--|----|---| 
!         |-|--------------------------------------------------------|--|
!


      if (rank .eq. 0) then
        ifrom(1) = bs*11
        ifrom(2) = bs*6
      else
        ifrom(1) = bs*0
        ifrom(2) = bs*5
      endif

!     Create the vector with two slots for ghost points. Note that both 
!     the local vector (lx) and the global vector (gx) share the same 
!     array for storing vector values.

      call PetscOptionsHasName(PETSC_NULL_CHARACTER,'-allocate',flag,    &
     &                         ierr)
      if (flag .ne. 0) then
        call VecCreateGhostBlockWithArray(PETSC_COMM_WORLD,bs,nlocal,    &
     &        PETSC_DECIDE,nghost,ifrom,tarray,gxs,ierr)
      else 
        call VecCreateGhostBlock(PETSC_COMM_WORLD,bs,nlocal,             &
     &       PETSC_DECIDE,nghost,ifrom,gxs,ierr)
      endif


!      Test VecDuplicate

       call VecDuplicate(gxs,gx,ierr) 
       call VecDestroy(gxs,ierr) 

!      Access the local Form

       call VecGhostGetLocalForm(gx,lx,ierr) 

!     Set the values from 0 to 12 into the "global" vector 

       call VecGetOwnershipRange(gx,rstart,rend,ierr)

       ione = 1
       do 10, i=rstart,rend-1
         value = i
         call VecSetValues(gx,ione,i,value,INSERT_VALUES,ierr) 
 10    continue

       call VecAssemblyBegin(gx,ierr) 
       call VecAssemblyEnd(gx,ierr) 

       call VecGhostUpdateBegin(gx,INSERT_VALUES,SCATTER_FORWARD,ierr) 
       call VecGhostUpdateEnd(gx,INSERT_VALUES,SCATTER_FORWARD,ierr) 

!     Print out each vector, including the ghost padding region. 

       call VecView(lx,PETSC_VIEWER_STDOUT_SELF,ierr)

       call VecGhostRestoreLocalForm(gx,lx,ierr) 
       call VecDestroy(gx,ierr)
       call PetscFinalize(ierr)
       end
 


