Star Forest Communication (PetscSF)

PetscSF provides an interface to “star forest” communication patterns that form much of the distributed memory communication in PETSc.

Beginner - Basic usage

PetscSFDuplicate PetscSFDuplicateOption PetscSFNode PetscSFPattern

PetscSFSetUp PetscSFType PetscSFView

VecScatter VecScatterSetFromOptions VecScatterType

Intermediate - Setting options for algorithms and data structures

PetscSF PetscSFBcastBegin PetscSFBcastEnd PetscSFBcastWithMemTypeBegin PetscSFCreate PetscSFCreateFromLayouts PetscSFCreateStridedSF PetscSFDestroy PetscSFGatherBegin PetscSFGatherEnd PetscSFGetGraph PetscSFGetGraphLayout

PetscSFGetType PetscSFMerge PetscSFReduceBegin PetscSFReduceEnd PetscSFReduceWithMemTypeBegin PetscSFScatterBegin PetscSFScatterEnd PetscSFSetFromOptions PetscSFSetGraph PetscSFSetGraphLayout PetscSFSetGraphWithPattern PetscSFSetType

PetscSFViewFromOptions VecScatterBegin VecScatterCreate VecScatterCreateToAll VecScatterCreateToZero VecScatterDestroy VecScatterEnd VecScatterGetType VecScatterSetType VecScatterSetUp VecScatterView VecScatterViewFromOptions

Advanced - Setting more advanced options and customization

PetscSFComputeDegreeBegin PetscSFConcatenate PetscSFConcatenateRootMode PetscSFCreateByMatchingIndices PetscSFCreateEmbeddedLeafSF PetscSFCreateEmbeddedRootSF PetscSFCreateInverseSF PetscSFCreateSectionSF PetscSFDistributeSection

PetscSFFetchAndOpBegin PetscSFFetchAndOpEnd PetscSFFetchAndOpWithMemTypeBegin PetscSFRegister PetscSFRegisterAll PetscSFReset PetscSFSetGraphFromCoordinates PetscSFSetRankOrder PetscSFWindowFlavorType

PetscSFWindowGetFlavorType PetscSFWindowGetInfo PetscSFWindowGetSyncType PetscSFWindowSetFlavorType PetscSFWindowSetInfo PetscSFWindowSetSyncType PetscSFWindowSyncType VecScatterCopy VecScatterRegister

Developer - Interfaces rarely needed by applications programmers

PetscSFCompose PetscSFComposeInverse PetscSFComputeDegreeEnd PetscSFComputeMultiRootOriginalNumbering PetscSFCreateRemoteOffsets PetscSFFinalizePackage

PetscSFGetGroups PetscSFGetLeafRange PetscSFGetLeafRanks PetscSFGetMultiSF PetscSFGetRanksSF PetscSFGetRootRanks

PetscSFInitializePackage PetscSFSetGraphSection PetscSFSetUpRanks VecScatterGetMerged VecScatterRemap

Single list of manual pages

PetscSF PetscSFBcastBegin PetscSFBcastEnd PetscSFBcastWithMemTypeBegin PetscSFCompose PetscSFComposeInverse PetscSFComputeDegreeBegin PetscSFComputeDegreeEnd PetscSFComputeMultiRootOriginalNumbering PetscSFConcatenate PetscSFConcatenateRootMode PetscSFCreate PetscSFCreateByMatchingIndices PetscSFCreateEmbeddedLeafSF PetscSFCreateEmbeddedRootSF PetscSFCreateFromLayouts PetscSFCreateInverseSF PetscSFCreateRemoteOffsets PetscSFCreateSectionSF PetscSFCreateStridedSF PetscSFDestroy PetscSFDistributeSection PetscSFDuplicate PetscSFDuplicateOption PetscSFFetchAndOpBegin PetscSFFetchAndOpEnd PetscSFFetchAndOpWithMemTypeBegin PetscSFFinalizePackage PetscSFGatherBegin PetscSFGatherEnd

PetscSFGetGraph PetscSFGetGraphLayout PetscSFGetGroups PetscSFGetLeafRange PetscSFGetLeafRanks PetscSFGetMultiSF PetscSFGetRanksSF PetscSFGetRootRanks PetscSFGetType PetscSFInitializePackage PetscSFMerge PetscSFNode PetscSFPattern PetscSFReduceBegin PetscSFReduceEnd PetscSFReduceWithMemTypeBegin PetscSFRegister PetscSFRegisterAll PetscSFReset PetscSFScatterBegin PetscSFScatterEnd PetscSFSetFromOptions PetscSFSetGraph PetscSFSetGraphFromCoordinates PetscSFSetGraphLayout PetscSFSetGraphSection PetscSFSetGraphWithPattern PetscSFSetRankOrder PetscSFSetType PetscSFSetUp

PetscSFSetUpRanks PetscSFType PetscSFView PetscSFViewFromOptions PetscSFWindowFlavorType PetscSFWindowGetFlavorType PetscSFWindowGetInfo PetscSFWindowGetSyncType PetscSFWindowSetFlavorType PetscSFWindowSetInfo PetscSFWindowSetSyncType PetscSFWindowSyncType VecScatter VecScatterBegin VecScatterCopy VecScatterCreate VecScatterCreateToAll VecScatterCreateToZero VecScatterDestroy VecScatterEnd VecScatterGetMerged VecScatterGetType VecScatterRegister VecScatterRemap VecScatterSetFromOptions VecScatterSetType VecScatterSetUp VecScatterType VecScatterView VecScatterViewFromOptions