xref: /petsc/src/sys/utils/pbarrier.c (revision 0298fd7132830bec7daee99a80be0eddb2b310a5)
1e5c89e4eSSatish Balay 
2c6db04a5SJed Brown #include <petscsys.h>              /*I "petscsys.h" I*/
3e5c89e4eSSatish Balay 
4e5c89e4eSSatish Balay /* Logging support */
597486a04SSatish Balay PetscLogEvent PETSC_Barrier=0;
6e5c89e4eSSatish Balay 
7e5c89e4eSSatish Balay #undef __FUNCT__
8e5c89e4eSSatish Balay #define __FUNCT__ "PetscBarrier"
95075c446SSatish Balay /*@C
10e5c89e4eSSatish Balay     PetscBarrier - Blocks until this routine is executed by all
11e5c89e4eSSatish Balay                    processors owning the object A.
12e5c89e4eSSatish Balay 
13e5c89e4eSSatish Balay    Input Parameters:
14e5c89e4eSSatish Balay .  A - PETSc object  (Mat, Vec, IS, SNES etc...)
15*0298fd71SBarry Smith         Must be caste with a (PetscObject), can use NULL (for MPI_COMM_WORLD)
16e5c89e4eSSatish Balay 
17e5c89e4eSSatish Balay   Level: intermediate
18e5c89e4eSSatish Balay 
19e5c89e4eSSatish Balay   Notes:
20e5c89e4eSSatish Balay   This routine calls MPI_Barrier with the communicator of the PETSc Object "A".
21e5c89e4eSSatish Balay 
22*0298fd71SBarry Smith   With fortran Use NULL_OBJECT (instead of NULL)
235075c446SSatish Balay 
24e5c89e4eSSatish Balay    Concepts: barrier
25e5c89e4eSSatish Balay 
26e5c89e4eSSatish Balay @*/
277087cfbeSBarry Smith PetscErrorCode  PetscBarrier(PetscObject obj)
28e5c89e4eSSatish Balay {
29e5c89e4eSSatish Balay   PetscErrorCode ierr;
30e5c89e4eSSatish Balay   MPI_Comm       comm;
31e5c89e4eSSatish Balay 
32e5c89e4eSSatish Balay   PetscFunctionBegin;
33e5c89e4eSSatish Balay   if (obj) PetscValidHeader(obj,1);
34e5c89e4eSSatish Balay   ierr = PetscLogEventBegin(PETSC_Barrier,obj,0,0,0);CHKERRQ(ierr);
35e5c89e4eSSatish Balay   if (obj) {
36e5c89e4eSSatish Balay     ierr = PetscObjectGetComm(obj,&comm);CHKERRQ(ierr);
37a297a907SKarl Rupp   } else comm = PETSC_COMM_WORLD;
38e5c89e4eSSatish Balay   ierr = MPI_Barrier(comm);CHKERRQ(ierr);
39e5c89e4eSSatish Balay   ierr = PetscLogEventEnd(PETSC_Barrier,obj,0,0,0);CHKERRQ(ierr);
40e5c89e4eSSatish Balay   PetscFunctionReturn(0);
41e5c89e4eSSatish Balay }
42e5c89e4eSSatish Balay 
43