1230e2716SBarry Smith /* 230127c82SLois Curfman McInnes An application ordering is mapping between an application-centric 330127c82SLois Curfman McInnes ordering (the ordering that is "natural" for the application) and 47588ac45SBarry Smith the parallel ordering that PETSc uses. 57588ac45SBarry Smith */ 60a835dfdSSatish Balay #if !defined(__PETSCAO_H) 70a835dfdSSatish Balay #define __PETSCAO_H 8*2c8e378dSBarry Smith #include <petscis.h> 9*2c8e378dSBarry Smith #include <petscmat.h> 107588ac45SBarry Smith 11b9617806SBarry Smith /*S 12b9617806SBarry Smith AO - Abstract PETSc object that manages mapping between different global numbering 13b9617806SBarry Smith 14b9617806SBarry Smith Level: intermediate 15b9617806SBarry Smith 16b9617806SBarry Smith Concepts: global numbering 17b9617806SBarry Smith 180e83c824SBarry Smith .seealso: AOCreateBasic(), AOCreateBasicIS(), AOPetscToApplication(), AOView(), AOApplicationToPetsc() 19b9617806SBarry Smith S*/ 201ac94ccfSSatish Balay typedef struct _p_AO* AO; 217588ac45SBarry Smith 2276bdecfbSBarry Smith /*J 23b439297aSHong Zhang AOType - String with the name of a PETSc application ordering or the creation function 24b439297aSHong Zhang with an optional dynamic library name. 25b439297aSHong Zhang 26b439297aSHong Zhang Level: beginner 27b439297aSHong Zhang 28b439297aSHong Zhang .seealso: AOSetType(), AO 2976bdecfbSBarry Smith J*/ 30b439297aSHong Zhang #define AOType char* 31b439297aSHong Zhang #define AOBASIC "basic" 32b439297aSHong Zhang #define AOADVANCED "advanced" 33b439297aSHong Zhang #define AOMAPPING "mapping" 340392740eSHong Zhang #define AOMEMORYSCALABLE "memoryscalable" 35b439297aSHong Zhang 368ba1e511SMatthew Knepley /* Logging support */ 37014dd563SJed Brown PETSC_EXTERN PetscClassId AO_CLASSID; 388ba1e511SMatthew Knepley 39014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOInitializePackage(const char[]); 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); 53014dd563SJed Brown PETSC_EXTERN PetscErrorCode AODestroy(AO*); 54b439297aSHong Zhang 55b439297aSHong Zhang /* Dynamic creation and loading functions */ 56014dd563SJed Brown PETSC_EXTERN PetscFList AOList; 57014dd563SJed Brown PETSC_EXTERN PetscBool AORegisterAllCalled; 58014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOSetType(AO, const AOType); 59014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOGetType(AO, const AOType *); 604ebda54eSMatthew Knepley 61014dd563SJed Brown PETSC_EXTERN PetscErrorCode AORegister(const char [], const char [], const char [], PetscErrorCode (*)(AO)); 62014dd563SJed Brown PETSC_EXTERN PetscErrorCode AORegisterAll(const char []); 63014dd563SJed Brown PETSC_EXTERN PetscErrorCode AORegisterDestroy(void); 64b439297aSHong Zhang 654ebda54eSMatthew Knepley #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 66985db425SBarry Smith #define AORegisterDynamic(a,b,c,d) AORegister(a,b,c,0) 674ebda54eSMatthew Knepley #else 68985db425SBarry Smith #define AORegisterDynamic(a,b,c,d) AORegister(a,b,c,d) 694ebda54eSMatthew Knepley #endif 704ebda54eSMatthew Knepley 71014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOPetscToApplication(AO,PetscInt,PetscInt[]); 72014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOApplicationToPetsc(AO,PetscInt,PetscInt[]); 73014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOPetscToApplicationIS(AO,IS); 74014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOApplicationToPetscIS(AO,IS); 757588ac45SBarry Smith 76014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOPetscToApplicationPermuteInt(AO, PetscInt, PetscInt[]); 77014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOApplicationToPetscPermuteInt(AO, PetscInt, PetscInt[]); 78014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOPetscToApplicationPermuteReal(AO, PetscInt, PetscReal[]); 79014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOApplicationToPetscPermuteReal(AO, PetscInt, PetscReal[]); 804ebda54eSMatthew Knepley 81014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOMappingHasApplicationIndex(AO, PetscInt, PetscBool *); 82014dd563SJed Brown PETSC_EXTERN PetscErrorCode AOMappingHasPetscIndex(AO, PetscInt, PetscBool *); 837588ac45SBarry Smith 84376ee591SBarry Smith /* ----------------------------------------------------*/ 857588ac45SBarry Smith #endif 86