xref: /petsc/src/sys/utils/pbarrier.c (revision 4e278199b78715991f5c71ebbd945c1489263e6c)
1 
2 #include <petsc/private/petscimpl.h>              /*I "petscsys.h" I*/
3 
4 /* Logging support */
5 PetscLogEvent PETSC_Barrier;
6 
7 /*@C
8     PetscBarrier - Blocks until this routine is executed by all
9                    processors owning the object obj.
10 
11    Input Parameters:
12 .  obj - PETSc object  (Mat, Vec, IS, SNES etc...)
13         The object be caste with a (PetscObject). NULL can be used to indicate the barrier should be across MPI_COMM_WORLD
14 
15   Level: intermediate
16 
17   Notes:
18   This routine calls MPI_Barrier with the communicator of the PETSc Object obj
19 
20   Fortran Usage:
21     You may pass PETSC_NULL_VEC or any other PETSc null object, such as PETSC_NULL_MAT, to indicate the barrier should be
22     across MPI_COMM_WORLD. You can also pass in any PETSc object, Vec, Mat, etc
23 
24 @*/
25 PetscErrorCode  PetscBarrier(PetscObject obj)
26 {
27   PetscErrorCode ierr;
28   MPI_Comm       comm;
29 
30   PetscFunctionBegin;
31   if (obj) PetscValidHeader(obj,1);
32   ierr = PetscLogEventBegin(PETSC_Barrier,obj,0,0,0);CHKERRQ(ierr);
33   if (obj) {
34     ierr = PetscObjectGetComm(obj,&comm);CHKERRQ(ierr);
35   } else comm = PETSC_COMM_WORLD;
36   ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
37   ierr = PetscLogEventEnd(PETSC_Barrier,obj,0,0,0);CHKERRQ(ierr);
38   PetscFunctionReturn(0);
39 }
40 
41