xref: /petsc/src/sys/utils/pbarrier.c (revision 6d8694c4fbab79f9439f1ad13c0386ba7ee1ca4b)

#include <petsc/private/petscimpl.h> /*I "petscsys.h" I*/

/* Logging support */
PetscLogEvent PETSC_Barrier;

/*@
  PetscBarrier - Blocks until this routine is executed by all processors owning the object `obj`.

  Input Parameter:
. obj - PETSc object  (`Mat`, `Vec`, `IS`, `SNES` etc...)

  Level: intermediate

  Fortran Note:
  You may pass `PETSC_NULL_VEC` or any other PETSc null object, such as `PETSC_NULL_MAT`, to
  indicate the barrier should be across `PETSC_COMM_WORLD`. You can also pass in any PETSc
  object, `Vec`, `Mat`, etc.

  Note:
  The object must be cast with a (`PetscObject`). `NULL` can be used to indicate the barrier
  should be across `PETSC_COMM_WORLD`.

  Developer Note:
  This routine calls `MPI_Barrier()` with the communicator of the `PetscObject`

.seealso: `PetscObject`, `MPI_Comm`, `MPI_Barrier`
@*/
PetscErrorCode PetscBarrier(PetscObject obj)
{
  MPI_Comm comm = PETSC_COMM_WORLD;

  PetscFunctionBegin;
  if (obj) {
    PetscValidHeader(obj, 1);
    PetscCall(PetscObjectGetComm(obj, &comm));
  }
  PetscCall(PetscLogEventBegin(PETSC_Barrier, obj, 0, 0, 0));
  PetscCallMPI(MPI_Barrier(comm));
  PetscCall(PetscLogEventEnd(PETSC_Barrier, obj, 0, 0, 0));
  PetscFunctionReturn(PETSC_SUCCESS);
}