1a4963045SJacob Faibussowitsch #pragma once 2ac09b921SBarry Smith 32c8e378dSBarry Smith #include <petscis.h> 47588ac45SBarry Smith 5ac09b921SBarry Smith /* SUBMANSEC = AO */ 6ac09b921SBarry Smith 7b9617806SBarry Smith /*S 816a05f60SBarry Smith AO - Abstract PETSc object that manages mapping between different global numberings 9b9617806SBarry Smith 10b9617806SBarry Smith Level: intermediate 11b9617806SBarry Smith 12*af27ebaaSBarry Smith Note: 1395bd0b28SBarry Smith An application ordering is usually a mapping between an application-centric 1416a05f60SBarry Smith numbering (the ordering that is "natural" for the application) and 15*af27ebaaSBarry Smith the parallel numbering ($0$ to $n_0-1$ on the first MPI process, $n_0$ to $n_1 - 1$ on the second MPI process, etc) 16*af27ebaaSBarry Smith that PETSc uses. 1787497f52SBarry Smith 1887497f52SBarry Smith .seealso: `AOCreateBasic()`, `AOCreateBasicIS()`, `AOPetscToApplication()`, `AOView()`, `AOApplicationToPetsc()`, `AOType`, `AOSetType()` 19b9617806SBarry Smith S*/ 201ac94ccfSSatish Balay typedef struct _p_AO *AO; 217588ac45SBarry Smith 2276bdecfbSBarry Smith /*J 2316a05f60SBarry Smith AOType - String with the name of a PETSc application ordering type 24b439297aSHong Zhang 25b439297aSHong Zhang Level: beginner 26b439297aSHong Zhang 27*af27ebaaSBarry Smith .seealso: `AOSetType()`, `AO`, `AOApplicationToPetsc()`, `AOCreateBasic()`, `AOCreate()` 2876bdecfbSBarry Smith J*/ 2919fd82e9SBarry Smith typedef const char *AOType; 30b439297aSHong Zhang #define AOBASIC "basic" 31b439297aSHong Zhang #define AOADVANCED "advanced" 32b439297aSHong Zhang #define AOMAPPING "mapping" 330392740eSHong Zhang #define AOMEMORYSCALABLE "memoryscalable" 34b439297aSHong Zhang 358ba1e511SMatthew Knepley /* Logging support */ 36014dd563SJed Brown PETSC_EXTERN PetscClassId AO_CLASSID; 378ba1e511SMatthew Knepley 38607a6623SBarry Smith PETSC_EXTERN PetscErrorCode AOInitializePackage(void); 394bf303faSJacob Faibussowitsch PETSC_EXTERN PetscErrorCode AOFinalizePackage(void); 408ba1e511SMatthew Knepley 41014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOCreate(MPI_Comm, AO *); 42014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOSetIS(AO, IS, IS); 43014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOSetFromOptions(AO); 44b439297aSHong Zhang 45014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOCreateBasic(MPI_Comm, PetscInt, const PetscInt[], const PetscInt[], AO *); 46014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOCreateBasicIS(IS, IS, AO *); 47014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOCreateMemoryScalable(MPI_Comm, PetscInt, const PetscInt[], const PetscInt[], AO *); 48014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOCreateMemoryScalableIS(IS, IS, AO *); 49014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOCreateMapping(MPI_Comm, PetscInt, const PetscInt[], const PetscInt[], AO *); 50014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOCreateMappingIS(IS, IS, AO *); 514ebda54eSMatthew Knepley 52014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOView(AO, PetscViewer); 53fe2efc57SMark PETSC_EXTERN PetscErrorCode AOViewFromOptions(AO, PetscObject, const char[]); 54014dd563SJed Brown PETSC_EXTERN PetscErrorCode AODestroy(AO *); 55b439297aSHong Zhang 56b439297aSHong Zhang /* Dynamic creation and loading functions */ 5719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode AOSetType(AO, AOType); 5819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode AOGetType(AO, AOType *); 594ebda54eSMatthew Knepley 60bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode AORegister(const char[], PetscErrorCode (*)(AO)); 61da8c939bSJacob Faibussowitsch PETSC_EXTERN PetscErrorCode AORegisterAll(void); 62b439297aSHong Zhang 63014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOPetscToApplication(AO, PetscInt, PetscInt[]); 64014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOApplicationToPetsc(AO, PetscInt, PetscInt[]); 65014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOPetscToApplicationIS(AO, IS); 66014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOApplicationToPetscIS(AO, IS); 677588ac45SBarry Smith 68014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOPetscToApplicationPermuteInt(AO, PetscInt, PetscInt[]); 69014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOApplicationToPetscPermuteInt(AO, PetscInt, PetscInt[]); 70014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOPetscToApplicationPermuteReal(AO, PetscInt, PetscReal[]); 71014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOApplicationToPetscPermuteReal(AO, PetscInt, PetscReal[]); 724ebda54eSMatthew Knepley 73014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOMappingHasApplicationIndex(AO, PetscInt, PetscBool *); 74014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOMappingHasPetscIndex(AO, PetscInt, PetscBool *); 75