Actual source code: petscsf.h
petsc-3.7.1 2016-05-15
Report Typos and Errors

      1: /*
      2:    A star forest (SF) describes a communication pattern
      3: */
      6: #include <petscsys.h>
      7: #include <petscsftypes.h>

      9: PETSC_EXTERN PetscClassId PETSCSF_CLASSID;

     11: /*J
     12:     PetscSFType - String with the name of a PetscSF method or the creation function
     13:        with an optional dynamic library name, for example
     14:        http://www.mcs.anl.gov/petsc/lib.so:mysfcreate()

     16:    Level: beginner

     18:    Notes: The two approaches provided are
     19: $     PETSCSFBASIC which uses MPI 1 message passing to perform the communication and
     20: $     PETSCSFWINDOW which uses MPI 2 one-sided operations to perform the communication, this may be more efficient,
     21: $                   but may not be available for all MPI distributions. In particular OpenMPI has bugs in its one-sided
     22: $                   operations that prevent its use.

     24: .seealso: PetscSFSetType(), PetscSF
     25: J*/
     26: typedef const char *PetscSFType;
     27: #define PETSCSFBASIC  "basic"
     28: #define PETSCSFWINDOW "window"

     30: /*E
     31:     PetscSFWindowSyncType - Type of synchronization for PETSCSFWINDOW

     33: $  PETSCSF_WINDOW_SYNC_FENCE - simplest model, synchronizing across communicator
     34: $  PETSCSF_WINDOW_SYNC_LOCK - passive model, less synchronous, requires less setup than PETSCSF_WINDOW_SYNC_ACTIVE, but may require more handshakes
     35: $  PETSCSF_WINDOW_SYNC_ACTIVE - active model, provides most information to MPI implementation, needs to construct 2-way process groups (more setup than PETSCSF_WINDOW_SYNC_LOCK)

     37:    Level: advanced

     39: .seealso: PetscSFWindowSetSyncType(), PetscSFWindowGetSyncType()
     40: E*/
     41: typedef enum {PETSCSF_WINDOW_SYNC_FENCE,PETSCSF_WINDOW_SYNC_LOCK,PETSCSF_WINDOW_SYNC_ACTIVE} PetscSFWindowSyncType;
     42: PETSC_EXTERN const char *const PetscSFWindowSyncTypes[];

     44: /*E
     45:     PetscSFDuplicateOption - Aspects to preserve when duplicating a PetscSF

     47: $  PETSCSF_DUPLICATE_CONFONLY - configuration only, user must call PetscSFSetGraph()
     48: $  PETSCSF_DUPLICATE_RANKS - communication ranks preserved, but different graph (allows simpler setup after calling PetscSFSetGraph())
     49: $  PETSCSF_DUPLICATE_GRAPH - entire graph duplicated

     51:    Level: beginner

     53: .seealso: PetscSFDuplicate()
     54: E*/
     55: typedef enum {PETSCSF_DUPLICATE_CONFONLY,PETSCSF_DUPLICATE_RANKS,PETSCSF_DUPLICATE_GRAPH} PetscSFDuplicateOption;
     56: PETSC_EXTERN const char *const PetscSFDuplicateOptions[];

     58: PETSC_EXTERN PetscFunctionList PetscSFList;
     59: PETSC_EXTERN PetscErrorCode PetscSFRegister(const char[],PetscErrorCode (*)(PetscSF));

     61: PETSC_EXTERN PetscErrorCode PetscSFInitializePackage(void);
     62: PETSC_EXTERN PetscErrorCode PetscSFFinalizePackage(void);
     63: PETSC_EXTERN PetscErrorCode PetscSFCreate(MPI_Comm comm,PetscSF*);
     64: PETSC_EXTERN PetscErrorCode PetscSFDestroy(PetscSF*);
     65: PETSC_EXTERN PetscErrorCode PetscSFSetType(PetscSF,PetscSFType);
     66: PETSC_EXTERN PetscErrorCode PetscSFView(PetscSF,PetscViewer);
     67: PETSC_STATIC_INLINE PetscErrorCode PetscSFViewFromOptions(PetscSF A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
     68: PETSC_EXTERN PetscErrorCode PetscSFSetUp(PetscSF);
     69: PETSC_EXTERN PetscErrorCode PetscSFSetFromOptions(PetscSF);
     70: PETSC_EXTERN PetscErrorCode PetscSFDuplicate(PetscSF,PetscSFDuplicateOption,PetscSF*);
     71: PETSC_EXTERN PetscErrorCode PetscSFWindowSetSyncType(PetscSF,PetscSFWindowSyncType);
     72: PETSC_EXTERN PetscErrorCode PetscSFWindowGetSyncType(PetscSF,PetscSFWindowSyncType*);
     73: PETSC_EXTERN PetscErrorCode PetscSFSetRankOrder(PetscSF,PetscBool);
     74: PETSC_EXTERN PetscErrorCode PetscSFSetGraph(PetscSF,PetscInt,PetscInt,const PetscInt*,PetscCopyMode,const PetscSFNode*,PetscCopyMode);
     75: PETSC_EXTERN PetscErrorCode PetscSFGetGraph(PetscSF,PetscInt *nroots,PetscInt *nleaves,const PetscInt **ilocal,const PetscSFNode **iremote);
     76: PETSC_EXTERN PetscErrorCode PetscSFGetLeafRange(PetscSF,PetscInt*,PetscInt*);
     77: PETSC_EXTERN PetscErrorCode PetscSFCreateEmbeddedSF(PetscSF,PetscInt nroots,const PetscInt *selected,PetscSF *newsf);
     78: PETSC_EXTERN PetscErrorCode PetscSFCreateEmbeddedLeafSF(PetscSF,PetscInt,const PetscInt *, PetscSF *);
     79: PETSC_EXTERN PetscErrorCode PetscSFReset(PetscSF);
     80: PETSC_EXTERN PetscErrorCode PetscSFGetRanks(PetscSF,PetscInt*,const PetscMPIInt**,const PetscInt**,const PetscInt**,const PetscInt**);
     81: PETSC_EXTERN PetscErrorCode PetscSFGetGroups(PetscSF,MPI_Group*,MPI_Group*);
     82: PETSC_EXTERN PetscErrorCode PetscSFGetMultiSF(PetscSF,PetscSF*);
     83: PETSC_EXTERN PetscErrorCode PetscSFCreateInverseSF(PetscSF,PetscSF*);

     85: /* broadcasts rootdata to leafdata */
     86: PETSC_EXTERN PetscErrorCode PetscSFBcastBegin(PetscSF,MPI_Datatype,const void *rootdata,void *leafdata)
     87:   PetscAttrMPIPointerWithType(3,2) PetscAttrMPIPointerWithType(4,2);
     88: PETSC_EXTERN PetscErrorCode PetscSFBcastEnd(PetscSF,MPI_Datatype,const void *rootdata,void *leafdata)
     89:   PetscAttrMPIPointerWithType(3,2) PetscAttrMPIPointerWithType(4,2);
     90: /* Reduce leafdata into rootdata using provided operation */
     91: PETSC_EXTERN PetscErrorCode PetscSFReduceBegin(PetscSF,MPI_Datatype,const void *leafdata,void *rootdata,MPI_Op)
     92:   PetscAttrMPIPointerWithType(3,2) PetscAttrMPIPointerWithType(4,2);
     93: PETSC_EXTERN PetscErrorCode PetscSFReduceEnd(PetscSF,MPI_Datatype,const void *leafdata,void *rootdata,MPI_Op)
     94:   PetscAttrMPIPointerWithType(3,2) PetscAttrMPIPointerWithType(4,2);
     95: /* Atomically modifies (using provided operation) rootdata using leafdata from each leaf, value at root at time of modification is returned in leafupdate. */
     96: PETSC_EXTERN PetscErrorCode PetscSFFetchAndOpBegin(PetscSF,MPI_Datatype,void *rootdata,const void *leafdata,void *leafupdate,MPI_Op)
     97:   PetscAttrMPIPointerWithType(3,2) PetscAttrMPIPointerWithType(4,2) PetscAttrMPIPointerWithType(5,2);
     98: PETSC_EXTERN PetscErrorCode PetscSFFetchAndOpEnd(PetscSF,MPI_Datatype,void *rootdata,const void *leafdata,void *leafupdate,MPI_Op)
     99:   PetscAttrMPIPointerWithType(3,2) PetscAttrMPIPointerWithType(4,2) PetscAttrMPIPointerWithType(5,2);
    100: /* Compute the degree of every root vertex (number of leaves in its star) */
    101: PETSC_EXTERN PetscErrorCode PetscSFComputeDegreeBegin(PetscSF,const PetscInt **degree);
    102: PETSC_EXTERN PetscErrorCode PetscSFComputeDegreeEnd(PetscSF,const PetscInt **degree);
    103: /* Concatenate data from all leaves into roots */
    104: PETSC_EXTERN PetscErrorCode PetscSFGatherBegin(PetscSF,MPI_Datatype,const void *leafdata,void *multirootdata)
    105:   PetscAttrMPIPointerWithType(3,2) PetscAttrMPIPointerWithType(4,2);
    106: PETSC_EXTERN PetscErrorCode PetscSFGatherEnd(PetscSF,MPI_Datatype,const void *leafdata,void *multirootdata)
    107:   PetscAttrMPIPointerWithType(3,2) PetscAttrMPIPointerWithType(4,2);
    108: /* Distribute distinct values to each leaf from roots */
    109: PETSC_EXTERN PetscErrorCode PetscSFScatterBegin(PetscSF,MPI_Datatype,const void *multirootdata,void *leafdata)
    110:   PetscAttrMPIPointerWithType(3,2) PetscAttrMPIPointerWithType(4,2);
    111: PETSC_EXTERN PetscErrorCode PetscSFScatterEnd(PetscSF,MPI_Datatype,const void *multirootdata,void *leafdata)
    112:   PetscAttrMPIPointerWithType(3,2) PetscAttrMPIPointerWithType(4,2);

    114: PETSC_EXTERN PetscErrorCode PetscSFCompose(PetscSF,PetscSF,PetscSF*);

    116: #if defined(MPI_REPLACE)
    117: #  define MPIU_REPLACE MPI_REPLACE
    118: #else
    119: /* When using an old MPI such that MPI_REPLACE is not defined, we do not pass MPI_REPLACE to MPI at all.  Instead, we
    120:  * use it as a flag for our own reducer in the PETSCSFBASIC implementation.  This could be any unique value unlikely to
    121:  * collide with another MPI_Op so we'll just use the value that has been used by every version of MPICH since
    122:  * MPICH2-1.0.6. */
    123: #  define MPIU_REPLACE (MPI_Op)(0x5800000d)
    124: #endif

    126: #endif