12eac72dbSBarry Smith /* 22eac72dbSBarry Smith Include file for the matrix component of PETSc 32eac72dbSBarry Smith */ 40a835dfdSSatish Balay #ifndef __PETSCMAT_H 50a835dfdSSatish Balay #define __PETSCMAT_H 60a835dfdSSatish Balay #include "petscvec.h" 7e9fa29b7SSatish Balay PETSC_EXTERN_CXX_BEGIN 82eac72dbSBarry Smith 9d9274352SBarry Smith /*S 10d9274352SBarry Smith Mat - Abstract PETSc matrix object 112eac72dbSBarry Smith 12d91e6319SBarry Smith Level: beginner 13d91e6319SBarry Smith 14d9274352SBarry Smith Concepts: matrix; linear operator 15d9274352SBarry Smith 16d9274352SBarry Smith .seealso: MatCreate(), MatType, MatSetType() 17d9274352SBarry Smith S*/ 18d9274352SBarry Smith typedef struct _p_Mat* Mat; 19d9274352SBarry Smith 20d9274352SBarry Smith /*E 21d9274352SBarry Smith MatType - String with the name of a PETSc matrix or the creation function 22d9274352SBarry Smith with an optional dynamic library name, for example 23d9274352SBarry Smith http://www.mcs.anl.gov/petsc/lib.a:mymatcreate() 24d9274352SBarry Smith 25d9274352SBarry Smith Level: beginner 26d9274352SBarry Smith 27c7393fdbSBarry Smith .seealso: MatSetType(), Mat, MatSolverPackage 28d91e6319SBarry Smith E*/ 29a313700dSBarry Smith #define MatType char* 30273d9f13SBarry Smith #define MATSAME "same" 31273d9f13SBarry Smith #define MATSEQMAIJ "seqmaij" 32273d9f13SBarry Smith #define MATMPIMAIJ "mpimaij" 33209238afSKris Buschelman #define MATMAIJ "maij" 34273d9f13SBarry Smith #define MATIS "is" 35273d9f13SBarry Smith #define MATSEQAIJ "seqaij" 36273d9f13SBarry Smith #define MATMPIAIJ "mpiaij" 37209238afSKris Buschelman #define MATAIJ "aij" 38273d9f13SBarry Smith #define MATSHELL "shell" 39209238afSKris Buschelman #define MATSEQDENSE "seqdense" 40273d9f13SBarry Smith #define MATMPIDENSE "mpidense" 41209238afSKris Buschelman #define MATDENSE "dense" 42273d9f13SBarry Smith #define MATSEQBAIJ "seqbaij" 43273d9f13SBarry Smith #define MATMPIBAIJ "mpibaij" 44209238afSKris Buschelman #define MATBAIJ "baij" 45273d9f13SBarry Smith #define MATMPIADJ "mpiadj" 46273d9f13SBarry Smith #define MATSEQSBAIJ "seqsbaij" 47273d9f13SBarry Smith #define MATMPISBAIJ "mpisbaij" 48209238afSKris Buschelman #define MATSBAIJ "sbaij" 49cebc7f6cSBarry Smith #define MATDAAD "daad" 50cebc7f6cSBarry Smith #define MATMFFD "mffd" 51c8a8475eSBarry Smith #define MATNORMAL "normal" 52ab92ecdeSBarry Smith #define MATLRC "lrc" 534b8d99adSRichard Tran Mills #define MATSEQCSRPERM "seqcsrperm" 5418def556SRichard Tran Mills #define MATMPICSRPERM "mpicsrperm" 55814655b8SBarry Smith #define MATCSRPERM "csrperm" 5681824310SBarry Smith #define MATSEQCRL "seqcrl" 57c02b24c5SBarry Smith #define MATMPICRL "mpicrl" 58c02b24c5SBarry Smith #define MATCRL "crl" 592a6744ebSBarry Smith #define MATSCATTER "scatter" 60421e10b8SBarry Smith #define MATBLOCKMAT "blockmat" 61793850ffSBarry Smith #define MATCOMPOSITE "composite" 625a7f1df3SHong Zhang #define MATSEQFFTW "seqfftw" 63557cca28SSatish Balay #define MATTRANSPOSEMAT "transpose" 6472ca8751SBarry Smith #define MATSCHURCOMPLEMENT "schurcomplement" 651d6018f0SLisandro Dalcin #define MATPYTHON "python" 66f91d8e95SBarry Smith #define MATHYPRESTRUCT "hyprestruct" 67a9e6138eSGlenn Hammond #define MATHYPRESSTRUCT "hypresstruct" 68ee1cef2cSJed Brown #define MATSUBMATRIX "submatrix" 69d91e6319SBarry Smith 70164db6ccSDmitry Karpeev 71dbc6227fSDmitry Karpeev #define MATDD "matdd" 72164db6ccSDmitry Karpeev 73ba2f8784SDmitry Karpeev #define MATIM "matim" 74ba2f8784SDmitry Karpeev 75773941d6SBarry Smith 769989ab13SBarry Smith /*E 77c7393fdbSBarry Smith MatSolverPackage - String with the name of a PETSc matrix solver type. 789989ab13SBarry Smith 799989ab13SBarry Smith For example: "petsc" indicates what PETSc provides, "superlu" indicates either 809989ab13SBarry Smith SuperLU or SuperLU_Dist etc. 819989ab13SBarry Smith 829989ab13SBarry Smith 839989ab13SBarry Smith Level: beginner 849989ab13SBarry Smith 855c9eb25fSBarry Smith .seealso: MatGetFactor(), Mat, MatSetType(), MatType 869989ab13SBarry Smith E*/ 87c7393fdbSBarry Smith #define MatSolverPackage char* 882692d6eeSBarry Smith #define MATSOLVERSPOOLES "spooles" 892692d6eeSBarry Smith #define MATSOLVERSUPERLU "superlu" 902692d6eeSBarry Smith #define MATSOLVERSUPERLU_DIST "superlu_dist" 912692d6eeSBarry Smith #define MATSOLVERUMFPACK "umfpack" 9220db9a53SJed Brown #define MATSOLVERCHOLMOD "cholmod" 932692d6eeSBarry Smith #define MATSOLVERESSL "essl" 942692d6eeSBarry Smith #define MATSOLVERLUSOL "lusol" 952692d6eeSBarry Smith #define MATSOLVERMUMPS "mumps" 962692d6eeSBarry Smith #define MATSOLVERPASTIX "pastix" 972692d6eeSBarry Smith #define MATSOLVERDSCPACK "dscpack" 982692d6eeSBarry Smith #define MATSOLVERMATLAB "matlab" 992692d6eeSBarry Smith #define MATSOLVERPETSC "petsc" 1002692d6eeSBarry Smith #define MATSOLVERPLAPACK "plapack" 1012692d6eeSBarry Smith #define MATSOLVERBAS "bas" 102773941d6SBarry Smith 103b24902e0SBarry Smith /*E 104b24902e0SBarry Smith MatFactorType - indicates what type of factorization is requested 105b24902e0SBarry Smith 106b24902e0SBarry Smith Level: beginner 107b24902e0SBarry Smith 108b24902e0SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 109b24902e0SBarry Smith 110c7393fdbSBarry Smith .seealso: MatSolverPackage, MatGetFactor() 111b24902e0SBarry Smith E*/ 112599ef60dSHong Zhang typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType; 11334918c53SJed Brown extern const char *const MatFactorTypes[]; 114e92e720dSBarry Smith 115c7393fdbSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactor(Mat,const MatSolverPackage,MatFactorType,Mat*); 116db4efbfdSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactorAvailable(Mat,const MatSolverPackage,MatFactorType,PetscTruth*); 11735bd34faSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorGetSolverPackage(Mat,const MatSolverPackage*); 1186335c336SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetFactorType(Mat,MatFactorType*); 1199989ab13SBarry Smith 120c06d978dSMatthew Knepley /* Logging support */ 1210700a824SBarry Smith #define MAT_FILE_CLASSID 1211216 /* used to indicate matrices in binary files */ 1220700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_CLASSID; 1230700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_FDCOLORING_CLASSID; 1240700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_PARTITIONING_CLASSID; 1250700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MAT_NULLSPACE_CLASSID; 1260700a824SBarry Smith extern PetscClassId PETSCMAT_DLLEXPORT MATMFFD_CLASSID; 127c06d978dSMatthew Knepley 128ceb03754SKris Buschelman /*E 129ceb03754SKris Buschelman MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices() 130ceb03754SKris Buschelman or MatGetSubMatrix() are to be reused to store the new matrix values. 131ceb03754SKris Buschelman 132ceb03754SKris Buschelman Level: beginner 133ceb03754SKris Buschelman 134ceb03754SKris Buschelman Any additions/changes here MUST also be made in include/finclude/petscmat.h 135ceb03754SKris Buschelman 1360c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert() 137ceb03754SKris Buschelman E*/ 138dfe085dbSJed Brown typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX} MatReuse; 139ceb03754SKris Buschelman 1405494a064SHong Zhang /*E 1415494a064SHong Zhang MatGetSubMatrixOption - Indicates if matrices obtained from a call to MatGetSubMatrices() 142829201f2SHong Zhang include the matrix values. Currently it is only used by MatGetSeqNonzerostructure(). 1435494a064SHong Zhang 1445494a064SHong Zhang Level: beginner 1455494a064SHong Zhang 146829201f2SHong Zhang .seealso: MatGetSeqNonzerostructure() 1475494a064SHong Zhang E*/ 1485494a064SHong Zhang typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatGetSubMatrixOption; 1495494a064SHong Zhang 150e5bd5246SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(const char[]); 151c06d978dSMatthew Knepley 152f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*); 153a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A) 154a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A) 155f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt); 156a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,const MatType); 157be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat); 158be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat); 159be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]); 160be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat)); 16130de9b25SBarry Smith 162f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]); 163f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]); 164f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]); 165f69a0ea3SMatthew Knepley 16630de9b25SBarry Smith /*MC 16730de9b25SBarry Smith MatRegisterDynamic - Adds a new matrix type 16830de9b25SBarry Smith 16930de9b25SBarry Smith Synopsis: 1701890ba74SBarry Smith PetscErrorCode MatRegisterDynamic(const char *name,const char *path,const char *name_create,PetscErrorCode (*routine_create)(Mat)) 17130de9b25SBarry Smith 17230de9b25SBarry Smith Not Collective 17330de9b25SBarry Smith 17430de9b25SBarry Smith Input Parameters: 17530de9b25SBarry Smith + name - name of a new user-defined matrix type 17630de9b25SBarry Smith . path - path (either absolute or relative) the library containing this solver 17730de9b25SBarry Smith . name_create - name of routine to create method context 17830de9b25SBarry Smith - routine_create - routine to create method context 17930de9b25SBarry Smith 18030de9b25SBarry Smith Notes: 18130de9b25SBarry Smith MatRegisterDynamic() may be called multiple times to add several user-defined solvers. 18230de9b25SBarry Smith 18330de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (routine_create) 18430de9b25SBarry Smith is ignored. 18530de9b25SBarry Smith 18630de9b25SBarry Smith Sample usage: 18730de9b25SBarry Smith .vb 18830de9b25SBarry Smith MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a, 18930de9b25SBarry Smith "MyMatCreate",MyMatCreate); 19030de9b25SBarry Smith .ve 19130de9b25SBarry Smith 19230de9b25SBarry Smith Then, your solver can be chosen with the procedural interface via 19330de9b25SBarry Smith $ MatSetType(Mat,"my_mat") 19430de9b25SBarry Smith or at runtime via the option 19530de9b25SBarry Smith $ -mat_type my_mat 19630de9b25SBarry Smith 19730de9b25SBarry Smith Level: advanced 19830de9b25SBarry Smith 199ab901514SBarry Smith Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values. 20030de9b25SBarry Smith If your function is not being put into a shared library then use VecRegister() instead 20130de9b25SBarry Smith 20230de9b25SBarry Smith .keywords: Mat, register 20330de9b25SBarry Smith 20430de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy() 20530de9b25SBarry Smith 20630de9b25SBarry Smith M*/ 207273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 208273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0) 209273d9f13SBarry Smith #else 210273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d) 21130de9b25SBarry Smith #endif 21230de9b25SBarry Smith 213273d9f13SBarry Smith extern PetscTruth MatRegisterAllCalled; 214b0a32e0cSBarry Smith extern PetscFList MatList; 215b022a5c1SBarry Smith extern PetscFList MatColoringList; 216b022a5c1SBarry Smith extern PetscFList MatPartitioningList; 21728988994SBarry Smith 2183b224e63SBarry Smith /*E 2193b224e63SBarry Smith MatStructure - Indicates if the matrix has the same nonzero structure 2203b224e63SBarry Smith 2213b224e63SBarry Smith Level: beginner 2223b224e63SBarry Smith 2233b224e63SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 2243b224e63SBarry Smith 2253b224e63SBarry Smith .seealso: MatCopy(), KSPSetOperators(), PCSetOperators() 2263b224e63SBarry Smith E*/ 2273b224e63SBarry Smith typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure; 2283b224e63SBarry Smith 229be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*); 230be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*); 231be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 232ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A) 233ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A) 234ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A) 235ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A) 236ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A)) 237ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A)) 238ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A)) 239be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 240ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A) 241ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A) 242ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,m,n,M,N,0,nnz,0,onz,&A),Mat,A) 243ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A) 244ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A)) 245ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,m,n,M,N,0,nnz,0,onz,A)) 246ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A)) 247ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A) 248ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A) 249ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,m,n,M,N,0,nnz,0,onz,&A),Mat,A) 250ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A) 251ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A)) 252ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,m,n,M,N,0,nnz,0,onz,A)) 253ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A)) 25463ab93bfSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *); 2558d7a6e47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*); 2568d7a6e47SBarry Smith 257be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 258ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A) 259ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A) 260ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A) 261ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A) 262ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A)) 263ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A)) 264ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A)) 265be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 266ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A) 267ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A) 268ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A) 269ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A) 270ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A)) 271ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,bs,m,n,M,N,0,nnz,0,onz,A)) 272ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A)) 273ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A) 274ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A) 275ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A) 276ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A) 277ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A)) 278ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,A)) 279ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A)) 280be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*); 281be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 282ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A) 283ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A) 284ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A) 285ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A) 286ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A)) 287ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A)) 288ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A)) 289be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 290ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A) 291ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A) 292ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A) 293ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A) 294ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A)) 295ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,bs,m,n,M,N,0,nnz,0,onz,A)) 296ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A)) 297ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A) 298ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A) 299ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A) 300ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A) 301ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A)) 302ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,A)) 303ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A)) 304be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*); 305ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(comm,m,n,M,N,ctx,&A),Mat,A) 306ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A) 307be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*); 308be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*); 309ba966639SSatish Balay PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A) 310ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*); 311284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*); 3121472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 3131472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPICRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 3142a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateScatter(MPI_Comm,VecScatter,Mat*); 3152a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterSetVecScatter(Mat,VecScatter); 3162a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterGetVecScatter(Mat,VecScatter*); 3178cdf2d9bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*); 318793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeAddMat(Mat,Mat); 319b52f573bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeMerge(Mat); 320793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*); 3216d7c1e57SBarry Smith typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType; 3226d7c1e57SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeSetType(Mat,MatCompositeType); 3236d7c1e57SBarry Smith 324dbc6227fSDmitry Karpeev typedef enum {MATDD_BLOCK_COMM_DEFAULT = 0, MATDD_BLOCK_COMM_SELF = -1, MATDD_BLOCK_COMM_DETERMINE = -2} MatDDBlockCommType; 325dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDAIJSetPreallocation(Mat A,PetscInt nz,PetscInt *nnz); 326dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDGetDefaltBlockType(Mat A, const MatType *type); 327dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetDefaltBlockType(Mat A, const MatType type); 328dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetPreallocation_AIJ(Mat A,PetscInt nz,PetscInt *nnz); 329dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDAddBlock(Mat A, PetscInt rowblock, PetscInt colblock, const MatType blockmattype, MatDDBlockCommType blockcommtype, Mat *block); 330dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetBlock(Mat A, PetscInt rowblock, PetscInt colblock, Mat block); 331dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDGetBlock(Mat A, PetscInt rowblock, PetscInt colblock, Mat *block); 332dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetScatters(Mat A, PetscInt blockcount, Mat scatters[]); 333dbc6227fSDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDDSetGathers(Mat A, PetscInt blockcount, Mat gathers[]); 33462ee7b53SDmitry Karpeev 335ba2f8784SDmitry Karpeev #if defined PETSC_HAVE_MATIM 336ba2f8784SDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIMSetIS(Mat A, IS in, IS out); 337ba2f8784SDmitry Karpeev EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIMGetIS(Mat A, IS *in, IS *out); 338ba2f8784SDmitry Karpeev #endif 339ba2f8784SDmitry Karpeev 340ba2f8784SDmitry Karpeev 341a6a5cd3fSDmitry Karpeev 3425a7f1df3SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqFFTW(MPI_Comm,PetscInt,const PetscInt[],Mat*); 343f20085c4SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateTranspose(Mat,Mat*); 344ee1cef2cSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSubMatrix(Mat,IS,IS,Mat*); 345ee1cef2cSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSubMatrixUpdate(Mat,Mat,IS,IS); 3461472f72bSBarry Smith 3471d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreatePython(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const char[],Mat*); 3481d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPythonSetType(Mat,const char[]); 3491d6018f0SLisandro Dalcin 3501d6018f0SLisandro Dalcin 351f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat); 352be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat); 35321c89e3eSBarry Smith 3540c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat); 35599cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat); 35699cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat); 357bfc7d00aSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonalBlock(Mat,PetscTruth*,MatReuse,Mat*); 358fe97e370SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetTrace(Mat,PetscScalar*); 35999cafbc1SBarry Smith 3608ed539a5SBarry Smith /* ------------------------------------------------------------*/ 361be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 362be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 36387d4246cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]); 364f259bd47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]); 36584cb2905SBarry Smith 3662ef4de8bSBarry Smith /*S 3672ef4de8bSBarry Smith MatStencil - Data structure (C struct) for storing information about a single row or 3682ef4de8bSBarry Smith column of a matrix as index on an associated grid. 3692ef4de8bSBarry Smith 3702ef4de8bSBarry Smith Level: beginner 3712ef4de8bSBarry Smith 3722ef4de8bSBarry Smith Concepts: matrix; linear operator 3732ef4de8bSBarry Smith 374d7bd93baSBarry Smith .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil() 3752ef4de8bSBarry Smith S*/ 376435da068SBarry Smith typedef struct { 377c1ac3661SBarry Smith PetscInt k,j,i,c; 378435da068SBarry Smith } MatStencil; 3792ef4de8bSBarry Smith 380be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 381be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 382be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt); 383435da068SBarry Smith 384be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring); 385be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*); 386be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*); 3873a7fca6bSBarry Smith 388d91e6319SBarry Smith /*E 389d91e6319SBarry Smith MatAssemblyType - Indicates if the matrix is now to be used, or if you plan 390d91e6319SBarry Smith to continue to add values to it 391d91e6319SBarry Smith 392d91e6319SBarry Smith Level: beginner 393d91e6319SBarry Smith 394d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd() 395d91e6319SBarry Smith E*/ 3966d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType; 397be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType); 398be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType); 399be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*); 4004f9c727eSBarry Smith 4011d73ed98SBarry Smith 40230de9b25SBarry Smith 403d91e6319SBarry Smith /*E 404d91e6319SBarry Smith MatOption - Options that may be set for a matrix and its behavior or storage 405d91e6319SBarry Smith 406d91e6319SBarry Smith Level: beginner 407d91e6319SBarry Smith 4080a835dfdSSatish Balay Any additions/changes here MUST also be made in include/finclude/petscmat.h 409d91e6319SBarry Smith 410d91e6319SBarry Smith .seealso: MatSetOption() 411d91e6319SBarry Smith E*/ 412512a5fc5SBarry Smith typedef enum {MAT_ROW_ORIENTED,MAT_NEW_NONZERO_LOCATIONS, 4134e0d8c25SBarry Smith MAT_SYMMETRIC, 4144e0d8c25SBarry Smith MAT_STRUCTURALLY_SYMMETRIC, 4158047e77bSBarry Smith MAT_NEW_DIAGONALS,MAT_IGNORE_OFF_PROC_ENTRIES, 4164e0d8c25SBarry Smith MAT_NEW_NONZERO_LOCATION_ERR, 4174e0d8c25SBarry Smith MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE, 418a9817697SBarry Smith MAT_KEEP_NONZERO_PATTERN,MAT_IGNORE_ZERO_ENTRIES, 4194e0d8c25SBarry Smith MAT_USE_INODES, 4204e0d8c25SBarry Smith MAT_HERMITIAN, 4214e0d8c25SBarry Smith MAT_SYMMETRY_ETERNAL, 4224e0d8c25SBarry Smith MAT_USE_COMPRESSEDROW, 4234e0d8c25SBarry Smith MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR, 42428b2fa4aSMatthew Knepley MAT_GETROW_UPPERTRIANGULAR,MAT_UNUSED_NONZERO_LOCATION_ERR, 42528b2fa4aSMatthew Knepley NUM_MAT_OPTIONS} MatOption; 426290bbb0aSBarry Smith extern const char *MatOptions[]; 4274e0d8c25SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption,PetscTruth); 428a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,const MatType*); 429a313700dSBarry Smith PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),const MatType,t) 43084cb2905SBarry Smith 431be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 432be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 433be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 434f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat); 435f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat); 436be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 437be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 438be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt); 439be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]); 440ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a) 441be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]); 442be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *); 443ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a) 444be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt); 4457b80b807SBarry Smith 4461620fd73SBarry Smith 447be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec); 44889c6957cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultDiagonalBlock(Mat,Vec,Vec); 449be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec); 450ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 451be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec); 452547795f9SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultHermitianTranspose(Mat,Vec,Vec); 453be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*); 454ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t) 455e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscTruth,t) 4561cbb95d3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscTruth*); 457be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec); 4585cb05578SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec); 459ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 460be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec); 461be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec); 4622bebee5dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat,Mat,Mat); 463f5edf698SHong Zhang 464d91e6319SBarry Smith /*E 465d91e6319SBarry Smith MatDuplicateOption - Indicates if a duplicated sparse matrix should have 466d91e6319SBarry Smith its numerical values copied over or just its nonzero structure. 467d91e6319SBarry Smith 468d91e6319SBarry Smith Level: beginner 469d91e6319SBarry Smith 470d91e6319SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 471d91e6319SBarry Smith 47270dcbbb9SBarry Smith $ MAT_SHARE_NONZERO_PATTERN - the i and j arrays in the new matrix will be shared with the original matrix 47370dcbbb9SBarry Smith $ this also triggers the MAT_DO_NOT_COPY_VALUES option. This is used when you 47470dcbbb9SBarry Smith $ have several matrices with the same nonzero pattern. 47570dcbbb9SBarry Smith 476d91e6319SBarry Smith .seealso: MatDuplicate() 477d91e6319SBarry Smith E*/ 47870dcbbb9SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption; 4792e8a6d31SBarry Smith 480a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,const MatType,MatReuse,Mat*); 481a313700dSBarry Smith PetscPolymorphicFunction(MatConvert,(Mat A,const MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a) 482be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*); 483ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a) 484ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a) 48594a9d846SBarry Smith 486cb5b572fSBarry Smith 487be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure); 488be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer); 489be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*); 490ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t) 491e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscTruth,t) 492be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*); 493ba966639SSatish Balay PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t) 4941cbb95d3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscReal,PetscTruth*); 4951cbb95d3SBarry Smith PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,0,&t),PetscTruth,t) 496be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*); 497be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*); 49864c62002SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMissingDiagonal(Mat,PetscTruth *,PetscInt *); 499a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(PetscViewer,const MatType,Mat*); 500*fbdbba38SShri Abhyankar EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoadnew(PetscViewer,Mat); 501a313700dSBarry Smith PetscPolymorphicFunction(MatLoad,(PetscViewer v,const MatType t),(v,t,&a),Mat,a) 5027b80b807SBarry Smith 5038f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *); 5048f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *); 5058f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *); 5068f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *); 507d4fbbf0eSBarry Smith 508d91e6319SBarry Smith /*S 509d91e6319SBarry Smith MatInfo - Context of matrix information, used with MatGetInfo() 510d91e6319SBarry Smith 511d91e6319SBarry Smith In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE 512d91e6319SBarry Smith 513d91e6319SBarry Smith Level: intermediate 514d91e6319SBarry Smith 515d91e6319SBarry Smith Concepts: matrix^nonzero information 516d91e6319SBarry Smith 517d9274352SBarry Smith .seealso: MatGetInfo(), MatInfoType 518d91e6319SBarry Smith S*/ 5194e220ebcSLois Curfman McInnes typedef struct { 520b0a32e0cSBarry Smith PetscLogDouble block_size; /* block size */ 521b0a32e0cSBarry Smith PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */ 522b0a32e0cSBarry Smith PetscLogDouble memory; /* memory allocated */ 523b0a32e0cSBarry Smith PetscLogDouble assemblies; /* number of matrix assemblies called */ 524b0a32e0cSBarry Smith PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */ 525b0a32e0cSBarry Smith PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */ 526b0a32e0cSBarry Smith PetscLogDouble factor_mallocs; /* number of mallocs during factorization */ 5274e220ebcSLois Curfman McInnes } MatInfo; 5284e220ebcSLois Curfman McInnes 529d9274352SBarry Smith /*E 530d9274352SBarry Smith MatInfoType - Indicates if you want information about the local part of the matrix, 531d9274352SBarry Smith the entire parallel matrix or the maximum over all the local parts. 532d9274352SBarry Smith 533d9274352SBarry Smith Level: beginner 534d9274352SBarry Smith 535d9274352SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 536d9274352SBarry Smith 537d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo 538d9274352SBarry Smith E*/ 5397b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 540be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*); 541be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatValid(Mat,PetscTruth*); 542be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec); 543985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec,PetscInt[]); 544985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMin(Mat,Vec,PetscInt[]); 545985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMaxAbs(Mat,Vec,PetscInt[]); 546c87e5d42SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMinAbs(Mat,Vec,PetscInt[]); 54786697f06SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowSum(Mat,Vec); 548fc4dec0aSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,MatReuse,Mat*); 549fc4dec0aSBarry Smith PetscPolymorphicFunction(MatTranspose,(Mat A),(A,MAT_INITIAL_MATRIX,&t),Mat,t) 550eeffb40dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHermitianTranspose(Mat,MatReuse,Mat*); 551be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *); 552ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t) 553be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *); 554be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec); 555be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode); 556be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*); 557ba966639SSatish Balay PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t) 558be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*); 559be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*); 560be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*); 561be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*); 5627b80b807SBarry Smith 563be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *); 564ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n) 565242f1d38SBarry Smith EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal *); 566be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat); 567f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar); 568f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar); 569f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*); 570f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*); 5717b80b807SBarry Smith 572be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth); 573be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec); 574be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec); 5755ef9f2a5SBarry Smith 576be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*); 577be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*); 578be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*); 5798ee2e534SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRanges(Mat,const PetscInt**); 580f4b8409dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*); 58172ca8751SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangesColumn(Mat,const PetscInt**); 5827b80b807SBarry Smith 583be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 584be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]); 5854aa3045dSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,MatReuse,Mat *); 586f6d58c54SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSeqNonzeroStructure(Mat,Mat*); 587f6d58c54SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroySeqNonzeroStructure(Mat*); 5885494a064SHong Zhang 589be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*); 590be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*); 591be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*); 592be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat); 593be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat); 594be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*); 595be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*); 596be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*); 5971d79065fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscInt**,MatScalar**,Mat*); 59843eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE) 599cd116e26SSatish Balay #include "petscctable.h" 60043eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *); 60143eb5e2fSMatthew Knepley #else 60243eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *); 60343eb5e2fSMatthew Knepley #endif 6048c7482ecSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetGhosts(Mat, PetscInt *,const PetscInt *[]); 6058efafbd8SBarry Smith 606be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt); 6077b80b807SBarry Smith 608be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 609be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*); 610be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat); 61122440eb1SKris Buschelman 612be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*); 613be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*); 614be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat); 61522440eb1SKris Buschelman 616be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*); 617be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*); 618be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat); 619bc011b1eSHong Zhang 620f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure); 62104aac2b0SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat,MatStructure); 6221c741599SHong Zhang 623f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar); 624f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar); 6257b80b807SBarry Smith 626be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping); 627be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping); 628f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar); 629f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar); 630be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 631be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 632052efed2SBarry Smith 633be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt); 634be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 63590f02eecSBarry Smith 636be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec); 6370c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec); 638ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 639be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec); 640be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*); 64169db28dcSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*); 642bd481603SBarry Smith 643bd481603SBarry Smith /*MC 6441620fd73SBarry Smith MatSetValue - Set a single entry into a matrix. 6451620fd73SBarry Smith 6461620fd73SBarry Smith Not collective 6471620fd73SBarry Smith 6481620fd73SBarry Smith Input Parameters: 6491620fd73SBarry Smith + m - the matrix 6501620fd73SBarry Smith . row - the row location of the entry 6511620fd73SBarry Smith . col - the column location of the entry 6521620fd73SBarry Smith . value - the value to insert 6531620fd73SBarry Smith - mode - either INSERT_VALUES or ADD_VALUES 6541620fd73SBarry Smith 6551620fd73SBarry Smith Notes: 6561620fd73SBarry Smith For efficiency one should use MatSetValues() and set several or many 6571620fd73SBarry Smith values simultaneously if possible. 6581620fd73SBarry Smith 6591620fd73SBarry Smith Level: beginner 6601620fd73SBarry Smith 6611620fd73SBarry Smith .seealso: MatSetValues(), MatSetValueLocal() 6621620fd73SBarry Smith M*/ 6631620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);} 6641620fd73SBarry Smith 6651620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);} 6661620fd73SBarry Smith 6671620fd73SBarry Smith PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);} 6681620fd73SBarry Smith 6691620fd73SBarry Smith /*MC 6700d2a7ff2SSatish Balay MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per 671bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 672bd481603SBarry Smith 673bd481603SBarry Smith Synopsis: 674c1ac3661SBarry Smith PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 675bd481603SBarry Smith 676bd481603SBarry Smith Collective on MPI_Comm 677bd481603SBarry Smith 678bd481603SBarry Smith Input Parameters: 679bd481603SBarry Smith + comm - the communicator that will share the eventually allocated matrix 680859fcb39SBarry Smith . nrows - the number of LOCAL rows in the matrix 681859fcb39SBarry Smith - ncols - the number of LOCAL columns in the matrix 682bd481603SBarry Smith 683bd481603SBarry Smith Output Parameters: 684bd481603SBarry Smith + dnz - the array that will be passed to the matrix preallocation routines 685bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 686bd481603SBarry Smith 687bd481603SBarry Smith 688bd481603SBarry Smith Level: intermediate 689bd481603SBarry Smith 690bd481603SBarry Smith Notes: 691bd481603SBarry Smith See the chapter in the users manual on performance for more details 692bd481603SBarry Smith 6931d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 694bd481603SBarry Smith 695bd481603SBarry Smith Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices) 696bd481603SBarry Smith 6971620fd73SBarry Smith This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize(). 6981620fd73SBarry Smith 699bd481603SBarry Smith Concepts: preallocation^Matrix 700bd481603SBarry Smith 701bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 702bd481603SBarry Smith MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal() 703bd481603SBarry Smith M*/ 704c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \ 7057c922b88SBarry Smith { \ 706a89bc211SBarry Smith PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \ 707a89bc211SBarry Smith _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \ 708a89bc211SBarry Smith _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 709a89bc211SBarry Smith _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 710c1ac3661SBarry Smith _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\ 711a89bc211SBarry Smith _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows; 7127c922b88SBarry Smith 713bd481603SBarry Smith /*MC 7140d2a7ff2SSatish Balay MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per 715bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 716bd481603SBarry Smith 717bd481603SBarry Smith Synopsis: 718c1ac3661SBarry Smith PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 719bd481603SBarry Smith 720bd481603SBarry Smith Collective on MPI_Comm 721bd481603SBarry Smith 722bd481603SBarry Smith Input Parameters: 723bd481603SBarry Smith + comm - the communicator that will share the eventually allocated matrix 724859fcb39SBarry Smith . nrows - the number of LOCAL rows in the matrix 725859fcb39SBarry Smith - ncols - the number of LOCAL columns in the matrix 726bd481603SBarry Smith 727bd481603SBarry Smith Output Parameters: 728bd481603SBarry Smith + dnz - the array that will be passed to the matrix preallocation routines 729bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 730bd481603SBarry Smith 731bd481603SBarry Smith 732bd481603SBarry Smith Level: intermediate 733bd481603SBarry Smith 734bd481603SBarry Smith Notes: 735bd481603SBarry Smith See the chapter in the users manual on performance for more details 736bd481603SBarry Smith 7371d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 738bd481603SBarry Smith 7391620fd73SBarry Smith This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize(). 7401620fd73SBarry Smith 741bd481603SBarry Smith Concepts: preallocation^Matrix 742bd481603SBarry Smith 743bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 744bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 745bd481603SBarry Smith M*/ 746222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \ 747222b16d4SBarry Smith { \ 748a89bc211SBarry Smith PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__end; \ 749a89bc211SBarry Smith _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \ 750a89bc211SBarry Smith _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 751a89bc211SBarry Smith _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 752c1ac3661SBarry Smith _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\ 753a89bc211SBarry Smith _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows; 754222b16d4SBarry Smith 755bd481603SBarry Smith /*MC 756bd481603SBarry Smith MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 757bd481603SBarry Smith inserted using a local number of the rows and columns 758bd481603SBarry Smith 759bd481603SBarry Smith Synopsis: 760c1ac3661SBarry Smith PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 761bd481603SBarry Smith 762bd481603SBarry Smith Not Collective 763bd481603SBarry Smith 764bd481603SBarry Smith Input Parameters: 765bd481603SBarry Smith + map - the mapping between local numbering and global numbering 766bd481603SBarry Smith . nrows - the number of rows indicated 7671d73ed98SBarry Smith . rows - the indices of the rows 768bd481603SBarry Smith . ncols - the number of columns in the matrix 769bd481603SBarry Smith . cols - the columns indicated 770bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 771bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 772bd481603SBarry Smith 773bd481603SBarry Smith 774bd481603SBarry Smith Level: intermediate 775bd481603SBarry Smith 776bd481603SBarry Smith Notes: 777bd481603SBarry Smith See the chapter in the users manual on performance for more details 778bd481603SBarry Smith 7791d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 780bd481603SBarry Smith 781bd481603SBarry Smith Concepts: preallocation^Matrix 782bd481603SBarry Smith 783bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 784bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 785bd481603SBarry Smith M*/ 786c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 787c4f061fbSSatish Balay {\ 788c1ac3661SBarry Smith PetscInt __l;\ 789ef66eb69SBarry Smith _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 790ef66eb69SBarry Smith _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 791c4f061fbSSatish Balay for (__l=0;__l<nrows;__l++) {\ 792ef66eb69SBarry Smith _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 793c4f061fbSSatish Balay }\ 794c4f061fbSSatish Balay } 795c4f061fbSSatish Balay 796bd481603SBarry Smith /*MC 797bd481603SBarry Smith MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 798bd481603SBarry Smith inserted using a local number of the rows and columns 799bd481603SBarry Smith 800bd481603SBarry Smith Synopsis: 801c1ac3661SBarry Smith PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 802bd481603SBarry Smith 803bd481603SBarry Smith Not Collective 804bd481603SBarry Smith 805bd481603SBarry Smith Input Parameters: 806bd481603SBarry Smith + map - the mapping between local numbering and global numbering 807bd481603SBarry Smith . nrows - the number of rows indicated 8081d73ed98SBarry Smith . rows - the indices of the rows 809bd481603SBarry Smith . ncols - the number of columns in the matrix 810bd481603SBarry Smith . cols - the columns indicated 811bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 812bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 813bd481603SBarry Smith 814bd481603SBarry Smith 815bd481603SBarry Smith Level: intermediate 816bd481603SBarry Smith 817bd481603SBarry Smith Notes: 818bd481603SBarry Smith See the chapter in the users manual on performance for more details 819bd481603SBarry Smith 820bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 821bd481603SBarry Smith 822bd481603SBarry Smith Concepts: preallocation^Matrix 823bd481603SBarry Smith 824bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 825bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 826bd481603SBarry Smith M*/ 827d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 828d3d32019SBarry Smith {\ 829c1ac3661SBarry Smith PetscInt __l;\ 830d3d32019SBarry Smith _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 831d3d32019SBarry Smith _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 832d3d32019SBarry Smith for (__l=0;__l<nrows;__l++) {\ 833d3d32019SBarry Smith _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 834d3d32019SBarry Smith }\ 835d3d32019SBarry Smith } 836d3d32019SBarry Smith 837bd481603SBarry Smith /*MC 838bd481603SBarry Smith MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 839bd481603SBarry Smith inserted using a local number of the rows and columns 840bd481603SBarry Smith 841bd481603SBarry Smith Synopsis: 842c1ac3661SBarry Smith PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 843bd481603SBarry Smith 844bd481603SBarry Smith Not Collective 845bd481603SBarry Smith 846bd481603SBarry Smith Input Parameters: 84764075487SBarry Smith + row - the row 848bd481603SBarry Smith . ncols - the number of columns in the matrix 849a50f8bf6SHong Zhang - cols - the columns indicated 850a50f8bf6SHong Zhang 851a50f8bf6SHong Zhang Output Parameters: 852a50f8bf6SHong Zhang + dnz - the array that will be passed to the matrix preallocation routines 853bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 854bd481603SBarry Smith 855bd481603SBarry Smith 856bd481603SBarry Smith Level: intermediate 857bd481603SBarry Smith 858bd481603SBarry Smith Notes: 859bd481603SBarry Smith See the chapter in the users manual on performance for more details 860bd481603SBarry Smith 861bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 862bd481603SBarry Smith 8631620fd73SBarry Smith This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize(). 8641620fd73SBarry Smith 865bd481603SBarry Smith Concepts: preallocation^Matrix 866bd481603SBarry Smith 867bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 868bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 869bd481603SBarry Smith M*/ 870c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\ 871c1ac3661SBarry Smith { PetscInt __i; \ 872e32f2f54SBarry Smith if (row < __rstart) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\ 873e32f2f54SBarry Smith if (row >= __rstart+__nrows) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D greater than last local row %D",row,__rstart+__nrows-1);\ 8747c922b88SBarry Smith for (__i=0; __i<nc; __i++) {\ 87564075487SBarry Smith if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \ 8767cc688d7SBarry Smith else dnz[row - __rstart]++;\ 8777c922b88SBarry Smith }\ 8787c922b88SBarry Smith } 8797c922b88SBarry Smith 880bd481603SBarry Smith /*MC 881bd481603SBarry Smith MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 882bd481603SBarry Smith inserted using a local number of the rows and columns 883bd481603SBarry Smith 884bd481603SBarry Smith Synopsis: 885c1ac3661SBarry Smith PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 886bd481603SBarry Smith 887bd481603SBarry Smith Not Collective 888bd481603SBarry Smith 889bd481603SBarry Smith Input Parameters: 890bd481603SBarry Smith + nrows - the number of rows indicated 8911d73ed98SBarry Smith . rows - the indices of the rows 892bd481603SBarry Smith . ncols - the number of columns in the matrix 893bd481603SBarry Smith . cols - the columns indicated 894bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 895bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 896bd481603SBarry Smith 897bd481603SBarry Smith 898bd481603SBarry Smith Level: intermediate 899bd481603SBarry Smith 900bd481603SBarry Smith Notes: 901bd481603SBarry Smith See the chapter in the users manual on performance for more details 902bd481603SBarry Smith 903bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 904bd481603SBarry Smith 9051620fd73SBarry Smith This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize(). 9061620fd73SBarry Smith 907bd481603SBarry Smith Concepts: preallocation^Matrix 908bd481603SBarry Smith 909bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 910bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 911bd481603SBarry Smith M*/ 912d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\ 913c1ac3661SBarry Smith { PetscInt __i; \ 914d3d32019SBarry Smith for (__i=0; __i<nc; __i++) {\ 915d3d32019SBarry Smith if (cols[__i] >= __end) onz[row - __rstart]++; \ 916d3d32019SBarry Smith else if (cols[__i] >= row) dnz[row - __rstart]++;\ 917d3d32019SBarry Smith }\ 918d3d32019SBarry Smith } 919d3d32019SBarry Smith 920bd481603SBarry Smith /*MC 92116371a99SBarry Smith MatPreallocateLocation - An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists 92216371a99SBarry Smith 92316371a99SBarry Smith Synopsis: 92416371a99SBarry Smith PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz) 92516371a99SBarry Smith 92616371a99SBarry Smith Not Collective 92716371a99SBarry Smith 92816371a99SBarry Smith Input Parameters: 92916371a99SBarry Smith . A - matrix 93016371a99SBarry Smith . row - row where values exist (must be local to this process) 93116371a99SBarry Smith . ncols - number of columns 93216371a99SBarry Smith . cols - columns with nonzeros 93316371a99SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 93416371a99SBarry Smith - ozn - the other array passed to the matrix preallocation routines 93516371a99SBarry Smith 93616371a99SBarry Smith 93716371a99SBarry Smith Level: intermediate 93816371a99SBarry Smith 93916371a99SBarry Smith Notes: 94016371a99SBarry Smith See the chapter in the users manual on performance for more details 94116371a99SBarry Smith 94216371a99SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 94316371a99SBarry Smith 94416371a99SBarry Smith This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines. 94516371a99SBarry Smith 94616371a99SBarry Smith Concepts: preallocation^Matrix 94716371a99SBarry Smith 94816371a99SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 94916371a99SBarry Smith MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal() 95016371a99SBarry Smith M*/ 95116371a99SBarry Smith #define MatPreallocateLocation(A,row,ncols,cols,dnz,onz) 0;if (A) {ierr = MatSetValues(A,1,&row,ncols,cols,PETSC_NULL,INSERT_VALUES);CHKERRQ(ierr);} else {ierr = MatPreallocateSet(row,ncols,cols,dnz,onz);CHKERRQ(ierr);} 95216371a99SBarry Smith 95316371a99SBarry Smith 95416371a99SBarry Smith /*MC 9550d2a7ff2SSatish Balay MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per 956bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 957bd481603SBarry Smith 958bd481603SBarry Smith Synopsis: 959c1ac3661SBarry Smith PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz) 960bd481603SBarry Smith 961bd481603SBarry Smith Collective on MPI_Comm 962bd481603SBarry Smith 963bd481603SBarry Smith Input Parameters: 96416371a99SBarry Smith + dnz - the array that was be passed to the matrix preallocation routines 965bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 966bd481603SBarry Smith 967bd481603SBarry Smith 968bd481603SBarry Smith Level: intermediate 969bd481603SBarry Smith 970bd481603SBarry Smith Notes: 971bd481603SBarry Smith See the chapter in the users manual on performance for more details 972bd481603SBarry Smith 973bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 974bd481603SBarry Smith 9751620fd73SBarry Smith This is a MACRO not a function because it closes the { started in MatPreallocateInitialize(). 9761620fd73SBarry Smith 977bd481603SBarry Smith Concepts: preallocation^Matrix 978bd481603SBarry Smith 979bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 980bd481603SBarry Smith MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal() 981bd481603SBarry Smith M*/ 982a89bc211SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);} 9837c922b88SBarry Smith 984bd481603SBarry Smith 985bd481603SBarry Smith 9867b80b807SBarry Smith /* Routines unique to particular data structures */ 987be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **); 988ba966639SSatish Balay PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t) 989698d4c6aSKris Buschelman 990be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*); 991be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 992698d4c6aSKris Buschelman 993be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 994be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 995be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 996c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 997c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 9987b80b807SBarry Smith 999a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4 1000a96a251dSBarry Smith 1001be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1002ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz)) 1003be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1004ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz)) 1005be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 1006ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz)) 1007273d9f13SBarry Smith 1008be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1009ba966639SSatish Balay PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz)) 1010be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1011be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 101253803f26SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []); 1013725b52f3SLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1014be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 1015be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1016be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 1017be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 1018284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 1019be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]); 1020be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]); 1021be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void)); 1022273d9f13SBarry Smith 1023be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt); 1024ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*); 10251b807ce4Svictorle 1026be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat); 1027be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat); 10282e8a6d31SBarry Smith 1029be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*); 10303a7fca6bSBarry Smith 10317b80b807SBarry Smith /* 10327b80b807SBarry Smith These routines are not usually accessed directly, rather solving is 103394b7f48cSBarry Smith done through the KSP and PC interfaces. 10347b80b807SBarry Smith */ 10357b80b807SBarry Smith 1036d9274352SBarry Smith /*E 1037d9274352SBarry Smith MatOrderingType - String with the name of a PETSc matrix ordering or the creation function 1038d9274352SBarry Smith with an optional dynamic library name, for example 1039d9274352SBarry Smith http://www.mcs.anl.gov/petsc/lib.a:orderingcreate() 1040d9274352SBarry Smith 1041d9274352SBarry Smith Level: beginner 1042d9274352SBarry Smith 1043e5a9bf91SBarry Smith Cannot use const because the PC objects manipulate the string 1044e5a9bf91SBarry Smith 1045d9274352SBarry Smith .seealso: MatGetOrdering() 1046d9274352SBarry Smith E*/ 10473eaad2caSSatish Balay #define MatOrderingType char* 10482692d6eeSBarry Smith #define MATORDERINGNATURAL "natural" 10492692d6eeSBarry Smith #define MATORDERINGND "nd" 10502692d6eeSBarry Smith #define MATORDERING1WD "1wd" 10512692d6eeSBarry Smith #define MATORDERINGRCM "rcm" 10522692d6eeSBarry Smith #define MATORDERINGQMD "qmd" 10532692d6eeSBarry Smith #define MATORDERINGROWLENGTH "rowlength" 10542692d6eeSBarry Smith #define MATORDERINGDSC_ND "dsc_nd" /* these three are only for DSCPACK, see its documentation for details */ 10552692d6eeSBarry Smith #define MATORDERINGDSC_MMD "dsc_mmd" 10562692d6eeSBarry Smith #define MATORDERINGDSC_MDF "dsc_mdf" 10572692d6eeSBarry Smith #define MATORDERINGCONSTRAINED "constrained" 10582692d6eeSBarry Smith #define MATORDERINGIDENTITY "identity" 10592692d6eeSBarry Smith #define MATORDERINGREVERSE "reverse" 10602692d6eeSBarry Smith #define MATORDERINGFLOW "flow" 10612692d6eeSBarry Smith #define MATORDERINGAMD "amd" 1062b12f92e5SBarry Smith 1063f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*); 1064be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list); 1065f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*)); 106630de9b25SBarry Smith 106730de9b25SBarry Smith /*MC 10681890ba74SBarry Smith MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the matrix package. 106930de9b25SBarry Smith 107030de9b25SBarry Smith Synopsis: 10711890ba74SBarry Smith PetscErrorCode MatOrderingRegisterDynamic(const char *name_ordering,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatOrdering)) 107230de9b25SBarry Smith 107330de9b25SBarry Smith Not Collective 107430de9b25SBarry Smith 107530de9b25SBarry Smith Input Parameters: 10762692d6eeSBarry Smith + sname - name of ordering (for example MATORDERINGND) 107730de9b25SBarry Smith . path - location of library where creation routine is 107830de9b25SBarry Smith . name - name of function that creates the ordering type,a string 107930de9b25SBarry Smith - function - function pointer that creates the ordering 108030de9b25SBarry Smith 108130de9b25SBarry Smith Level: developer 108230de9b25SBarry Smith 108330de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (function) 108430de9b25SBarry Smith is ignored. 108530de9b25SBarry Smith 108630de9b25SBarry Smith Sample usage: 108730de9b25SBarry Smith .vb 108830de9b25SBarry Smith MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a, 108930de9b25SBarry Smith "MyOrder",MyOrder); 109030de9b25SBarry Smith .ve 109130de9b25SBarry Smith 109230de9b25SBarry Smith Then, your partitioner can be chosen with the procedural interface via 109330de9b25SBarry Smith $ MatOrderingSetType(part,"my_order) 109430de9b25SBarry Smith or at runtime via the option 10952401956bSBarry Smith $ -pc_factor_mat_ordering_type my_order 109630de9b25SBarry Smith 1097ab901514SBarry Smith ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values. 109830de9b25SBarry Smith 109930de9b25SBarry Smith .keywords: matrix, ordering, register 110030de9b25SBarry Smith 110130de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll() 110230de9b25SBarry Smith M*/ 1103aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1104f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0) 1105b12f92e5SBarry Smith #else 1106f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d) 1107b12f92e5SBarry Smith #endif 110830de9b25SBarry Smith 1109be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void); 1110be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]); 11112bad1931SBarry Smith extern PetscTruth MatOrderingRegisterAllCalled; 1112b0a32e0cSBarry Smith extern PetscFList MatOrderingList; 1113d4fbbf0eSBarry Smith 1114be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 1115a2ce50c7SBarry Smith 1116d91e6319SBarry Smith /*S 1117d90ac83dSHong Zhang MatFactorShiftType - Numeric Shift. 1118d90ac83dSHong Zhang 1119d90ac83dSHong Zhang Level: beginner 1120d90ac83dSHong Zhang 1121d90ac83dSHong Zhang S*/ 1122d90ac83dSHong Zhang typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType; 1123d90ac83dSHong Zhang extern const char *MatFactorShiftTypes[]; 1124d90ac83dSHong Zhang 1125d90ac83dSHong Zhang /*S 11262401956bSBarry Smith MatFactorInfo - Data passed into the matrix factorization routines 1127b00f7748SHong Zhang 112861cad860SBarry Smith In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use 112961cad860SBarry Smith $ MatFactorInfo info(MAT_FACTORINFO_SIZE) 1130b00f7748SHong Zhang 113115e8a5b3SHong Zhang Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 1132b00f7748SHong Zhang 113361cad860SBarry Smith You can use MatFactorInfoInitialize() to set default values. 113461cad860SBarry Smith 1135b00f7748SHong Zhang Level: developer 1136b00f7748SHong Zhang 1137d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 1138d7d82daaSBarry Smith MatFactorInfoInitialize() 1139b00f7748SHong Zhang 1140b00f7748SHong Zhang S*/ 1141b00f7748SHong Zhang typedef struct { 114215e8a5b3SHong Zhang PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 114385317021SBarry Smith PetscReal usedt; 114415e8a5b3SHong Zhang PetscReal dt; /* drop tolerance */ 1145b00f7748SHong Zhang PetscReal dtcol; /* tolerance for pivoting */ 114615e8a5b3SHong Zhang PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 114767e28bfeSBarry Smith PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */ 1148348344bbSBarry Smith PetscReal levels; /* ICC/ILU(levels) */ 1149bcd9e38bSBarry Smith PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 1150bcd9e38bSBarry Smith factorization may be faster if do not pivot */ 115115e8a5b3SHong Zhang PetscReal zeropivot; /* pivot is called zero if less than this */ 1152f4db908eSBarry Smith PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */ 1153f4db908eSBarry Smith PetscReal shiftamount; /* how large the shift is */ 115415e8a5b3SHong Zhang } MatFactorInfo; 1155ffa6d0a5SLois Curfman McInnes 1156be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*); 11570481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,const MatFactorInfo*); 11580481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 11590481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*); 11600481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,const MatFactorInfo*); 11610481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,const MatFactorInfo*); 11620481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 11630481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 11640481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 11650481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,const MatFactorInfo*); 11660481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*); 1167be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 1168be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec); 1169be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec); 1170be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec); 1171be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec); 1172be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec); 1173be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 1174be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs); 11758ed539a5SBarry Smith 1176be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat); 1177bb5a7306SBarry Smith 1178d91e6319SBarry Smith /*E 1179d91e6319SBarry Smith MatSORType - What type of (S)SOR to perform 1180bb1eb677SSatish Balay 1181d91e6319SBarry Smith Level: beginner 1182d91e6319SBarry Smith 1183d9274352SBarry Smith May be bitwise ORd together 1184d9274352SBarry Smith 1185d91e6319SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 1186d91e6319SBarry Smith 11874e7234bfSBarry Smith MatSORType may be bitwise ORd together, so do not change the numbers 11884e7234bfSBarry Smith 118941f059aeSBarry Smith .seealso: MatSOR() 1190d91e6319SBarry Smith E*/ 1191ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1192ee50ffe9SBarry Smith SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1193ee50ffe9SBarry Smith SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 119484cb2905SBarry Smith SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 119541f059aeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 11968ed539a5SBarry Smith 1197d4fbbf0eSBarry Smith /* 1198639f9d9dSBarry Smith These routines are for efficiently computing Jacobians via finite differences. 1199639f9d9dSBarry Smith */ 1200b12f92e5SBarry Smith 1201d9274352SBarry Smith /*E 1202d9274352SBarry Smith MatColoringType - String with the name of a PETSc matrix coloring or the creation function 1203d9274352SBarry Smith with an optional dynamic library name, for example 1204d9274352SBarry Smith http://www.mcs.anl.gov/petsc/lib.a:coloringcreate() 1205d9274352SBarry Smith 1206d9274352SBarry Smith Level: beginner 1207d9274352SBarry Smith 1208d9274352SBarry Smith .seealso: MatGetColoring() 1209d9274352SBarry Smith E*/ 1210a313700dSBarry Smith #define MatColoringType char* 12112692d6eeSBarry Smith #define MATCOLORINGNATURAL "natural" 12122692d6eeSBarry Smith #define MATCOLORINGSL "sl" 12132692d6eeSBarry Smith #define MATCOLORINGLF "lf" 12142692d6eeSBarry Smith #define MATCOLORINGID "id" 1215b12f92e5SBarry Smith 1216ab970d9bSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*); 12172e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *)); 121830de9b25SBarry Smith 121930de9b25SBarry Smith /*MC 122030de9b25SBarry Smith MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the 122130de9b25SBarry Smith matrix package. 122230de9b25SBarry Smith 122330de9b25SBarry Smith Synopsis: 12241890ba74SBarry Smith PetscErrorCode MatColoringRegisterDynamic(const char *name_coloring,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatColoring)) 122530de9b25SBarry Smith 122630de9b25SBarry Smith Not Collective 122730de9b25SBarry Smith 122830de9b25SBarry Smith Input Parameters: 12292692d6eeSBarry Smith + sname - name of Coloring (for example MATCOLORINGSL) 123030de9b25SBarry Smith . path - location of library where creation routine is 123130de9b25SBarry Smith . name - name of function that creates the Coloring type, a string 123230de9b25SBarry Smith - function - function pointer that creates the coloring 123330de9b25SBarry Smith 123430de9b25SBarry Smith Level: developer 123530de9b25SBarry Smith 123630de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (function) 123730de9b25SBarry Smith is ignored. 123830de9b25SBarry Smith 123930de9b25SBarry Smith Sample usage: 124030de9b25SBarry Smith .vb 124130de9b25SBarry Smith MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a, 124230de9b25SBarry Smith "MyColor",MyColor); 124330de9b25SBarry Smith .ve 124430de9b25SBarry Smith 124530de9b25SBarry Smith Then, your partitioner can be chosen with the procedural interface via 124630de9b25SBarry Smith $ MatColoringSetType(part,"my_color") 124730de9b25SBarry Smith or at runtime via the option 124830de9b25SBarry Smith $ -mat_coloring_type my_color 124930de9b25SBarry Smith 1250ab901514SBarry Smith $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 125130de9b25SBarry Smith 125230de9b25SBarry Smith .keywords: matrix, Coloring, register 125330de9b25SBarry Smith 125430de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll() 125530de9b25SBarry Smith M*/ 1256aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1257f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0) 1258b12f92e5SBarry Smith #else 1259f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d) 1260b12f92e5SBarry Smith #endif 126130de9b25SBarry Smith 12622bad1931SBarry Smith extern PetscTruth MatColoringRegisterAllCalled; 1263f1144a30SSatish Balay 1264be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]); 1265be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void); 1266be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 1267639f9d9dSBarry Smith 1268d9274352SBarry Smith /*S 1269d9274352SBarry Smith MatFDColoring - Object for computing a sparse Jacobian via finite differences 1270d9274352SBarry Smith and coloring 1271639f9d9dSBarry Smith 1272d9274352SBarry Smith Level: beginner 1273d9274352SBarry Smith 1274d9274352SBarry Smith Concepts: coloring, sparse Jacobian, finite differences 1275d9274352SBarry Smith 1276d9274352SBarry Smith .seealso: MatFDColoringCreate() 1277d9274352SBarry Smith S*/ 1278e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring; 1279639f9d9dSBarry Smith 1280be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1281be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring); 1282be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer); 1283be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 12844a9d489dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1285be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring); 1287be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *); 1288be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *); 1289be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec); 1290be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]); 1291639f9d9dSBarry Smith /* 12920752156aSBarry Smith These routines are for partitioning matrices: currently used only 12933eda8832SBarry Smith for adjacency matrix, MatCreateMPIAdj(). 12940752156aSBarry Smith */ 1295ca161407SBarry Smith 1296d9274352SBarry Smith /*S 1297d9274352SBarry Smith MatPartitioning - Object for managing the partitioning of a matrix or graph 1298d9274352SBarry Smith 1299d9274352SBarry Smith Level: beginner 1300d9274352SBarry Smith 1301d9274352SBarry Smith Concepts: partitioning 1302d9274352SBarry Smith 1303743a1026Svictorle .seealso: MatPartitioningCreate(), MatPartitioningType 1304d9274352SBarry Smith S*/ 130591e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning; 1306d9274352SBarry Smith 1307d9274352SBarry Smith /*E 13085bc6e7ccSvictorle MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function 1309d9274352SBarry Smith with an optional dynamic library name, for example 1310d9274352SBarry Smith http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate() 1311d9274352SBarry Smith 1312d9274352SBarry Smith Level: beginner 1313d9274352SBarry Smith 1314b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning 1315d9274352SBarry Smith E*/ 1316a313700dSBarry Smith #define MatPartitioningType char* 13172692d6eeSBarry Smith #define MATPARTITIONINGCURRENT "current" 13182692d6eeSBarry Smith #define MATPARTITIONINGSQUARE "square" 13192692d6eeSBarry Smith #define MATPARTITIONINGPARMETIS "parmetis" 13202692d6eeSBarry Smith #define MATPARTITIONINGCHACO "chaco" 13212692d6eeSBarry Smith #define MATPARTITIONINGJOSTLE "jostle" 13222692d6eeSBarry Smith #define MATPARTITIONINGPARTY "party" 13232692d6eeSBarry Smith #define MATPARTITIONINGSCOTCH "scotch" 132471306c60Sjroman 1325ca161407SBarry Smith 1326be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*); 1327a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType); 1328be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt); 1329be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat); 1330be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1331be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1332be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*); 1333be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning); 13342aabb6bbSBarry Smith 1335be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning)); 133630de9b25SBarry Smith 133730de9b25SBarry Smith /*MC 133830de9b25SBarry Smith MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the 133930de9b25SBarry Smith matrix package. 134030de9b25SBarry Smith 134130de9b25SBarry Smith Synopsis: 13421890ba74SBarry Smith PetscErrorCode MatPartitioningRegisterDynamic(const char *name_partitioning,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatPartitioning)) 134330de9b25SBarry Smith 134430de9b25SBarry Smith Not Collective 134530de9b25SBarry Smith 134630de9b25SBarry Smith Input Parameters: 13472692d6eeSBarry Smith + sname - name of partitioning (for example MATPARTITIONINGCURRENT) or parmetis 134830de9b25SBarry Smith . path - location of library where creation routine is 134930de9b25SBarry Smith . name - name of function that creates the partitioning type, a string 135030de9b25SBarry Smith - function - function pointer that creates the partitioning type 135130de9b25SBarry Smith 135230de9b25SBarry Smith Level: developer 135330de9b25SBarry Smith 135430de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (function) 135530de9b25SBarry Smith is ignored. 135630de9b25SBarry Smith 135730de9b25SBarry Smith Sample usage: 135830de9b25SBarry Smith .vb 135930de9b25SBarry Smith MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a, 136030de9b25SBarry Smith "MyPartCreate",MyPartCreate); 136130de9b25SBarry Smith .ve 136230de9b25SBarry Smith 136330de9b25SBarry Smith Then, your partitioner can be chosen with the procedural interface via 136430de9b25SBarry Smith $ MatPartitioningSetType(part,"my_part") 136530de9b25SBarry Smith or at runtime via the option 136630de9b25SBarry Smith $ -mat_partitioning_type my_part 136730de9b25SBarry Smith 1368ab901514SBarry Smith $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 136930de9b25SBarry Smith 137030de9b25SBarry Smith .keywords: matrix, partitioning, register 137130de9b25SBarry Smith 137230de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll() 137330de9b25SBarry Smith M*/ 1374aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1375f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0) 13762aabb6bbSBarry Smith #else 1377f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d) 13782aabb6bbSBarry Smith #endif 13792aabb6bbSBarry Smith 13802bad1931SBarry Smith extern PetscTruth MatPartitioningRegisterAllCalled; 1381f1144a30SSatish Balay 1382be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]); 1383be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void); 13842bad1931SBarry Smith 1385be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer); 1386be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning); 1387a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,const MatPartitioningType*); 1388ca161407SBarry Smith 1389be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 13900e8af3caSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *); 13910752156aSBarry Smith 1392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal); 1393be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning); 139471306c60Sjroman 1395954b3ec6SBarry Smith typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType; 1396be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType); 139771306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType; 1398be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType); 1399be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 140071306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType; 1401be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1402be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal); 1403be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt); 140471306c60Sjroman 140571306c60Sjroman #define MP_PARTY_OPT "opt" 140671306c60Sjroman #define MP_PARTY_LIN "lin" 140771306c60Sjroman #define MP_PARTY_SCA "sca" 140871306c60Sjroman #define MP_PARTY_RAN "ran" 140971306c60Sjroman #define MP_PARTY_GBF "gbf" 141071306c60Sjroman #define MP_PARTY_GCF "gcf" 141171306c60Sjroman #define MP_PARTY_BUB "bub" 141271306c60Sjroman #define MP_PARTY_DEF "def" 1413be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*); 141471306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs" 141571306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl" 141671306c60Sjroman #define MP_PARTY_NONE "no" 1417be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*); 1418be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1419be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth); 1420be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth); 142171306c60Sjroman 142271306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType; 1423be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*); 1424be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning); 1425be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType); 1426be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal); 1427be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*); 142871306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType; 1429be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType); 1430be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning); 1431be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*); 143271306c60Sjroman 1433591294e4SBarry Smith EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*); 143414196391SBarry Smith EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*); 1435591294e4SBarry Smith 14360752156aSBarry Smith /* 14370a835dfdSSatish Balay If you add entries here you must also add them to finclude/petscmat.h 1438d4fbbf0eSBarry Smith */ 14391c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0, 14401c1c02c0SLois Curfman McInnes MATOP_GET_ROW=1, 14411c1c02c0SLois Curfman McInnes MATOP_RESTORE_ROW=2, 14421c1c02c0SLois Curfman McInnes MATOP_MULT=3, 14431c1c02c0SLois Curfman McInnes MATOP_MULT_ADD=4, 14447c922b88SBarry Smith MATOP_MULT_TRANSPOSE=5, 14457c922b88SBarry Smith MATOP_MULT_TRANSPOSE_ADD=6, 14461c1c02c0SLois Curfman McInnes MATOP_SOLVE=7, 14471c1c02c0SLois Curfman McInnes MATOP_SOLVE_ADD=8, 14487c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE=9, 14497c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE_ADD=10, 14501c1c02c0SLois Curfman McInnes MATOP_LUFACTOR=11, 14511c1c02c0SLois Curfman McInnes MATOP_CHOLESKYFACTOR=12, 1452a714c06dSBarry Smith MATOP_SOR=13, 14531c1c02c0SLois Curfman McInnes MATOP_TRANSPOSE=14, 14541c1c02c0SLois Curfman McInnes MATOP_GETINFO=15, 14551c1c02c0SLois Curfman McInnes MATOP_EQUAL=16, 14561c1c02c0SLois Curfman McInnes MATOP_GET_DIAGONAL=17, 14571c1c02c0SLois Curfman McInnes MATOP_DIAGONAL_SCALE=18, 14581c1c02c0SLois Curfman McInnes MATOP_NORM=19, 14591c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_BEGIN=20, 14601c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_END=21, 1461d519adbfSMatthew Knepley MATOP_SET_OPTION=22, 1462d519adbfSMatthew Knepley MATOP_ZERO_ENTRIES=23, 1463d519adbfSMatthew Knepley MATOP_ZERO_ROWS=24, 1464d519adbfSMatthew Knepley MATOP_LUFACTOR_SYMBOLIC=25, 1465d519adbfSMatthew Knepley MATOP_LUFACTOR_NUMERIC=26, 1466d519adbfSMatthew Knepley MATOP_CHOLESKY_FACTOR_SYMBOLIC=27, 1467d519adbfSMatthew Knepley MATOP_CHOLESKY_FACTOR_NUMERIC=28, 1468d519adbfSMatthew Knepley MATOP_SETUP_PREALLOCATION=29, 1469d519adbfSMatthew Knepley MATOP_ILUFACTOR_SYMBOLIC=30, 1470d519adbfSMatthew Knepley MATOP_ICCFACTOR_SYMBOLIC=31, 1471d519adbfSMatthew Knepley MATOP_GET_ARRAY=32, 1472d519adbfSMatthew Knepley MATOP_RESTORE_ARRAY=33, 1473d519adbfSMatthew Knepley MATOP_DUPLICATE=34, 1474d519adbfSMatthew Knepley MATOP_FORWARD_SOLVE=35, 1475d519adbfSMatthew Knepley MATOP_BACKWARD_SOLVE=36, 1476d519adbfSMatthew Knepley MATOP_ILUFACTOR=37, 1477d519adbfSMatthew Knepley MATOP_ICCFACTOR=38, 1478d519adbfSMatthew Knepley MATOP_AXPY=39, 1479d519adbfSMatthew Knepley MATOP_GET_SUBMATRICES=40, 1480d519adbfSMatthew Knepley MATOP_INCREASE_OVERLAP=41, 1481d519adbfSMatthew Knepley MATOP_GET_VALUES=42, 1482d519adbfSMatthew Knepley MATOP_COPY=43, 1483d519adbfSMatthew Knepley MATOP_GET_ROW_MAX=44, 1484d519adbfSMatthew Knepley MATOP_SCALE=45, 1485d519adbfSMatthew Knepley MATOP_SHIFT=46, 148635153367SBarry Smith MATOP_DIAGONAL_SET=47, 1487d519adbfSMatthew Knepley MATOP_ILUDT_FACTOR=48, 1488d519adbfSMatthew Knepley MATOP_SET_BLOCK_SIZE=49, 1489d519adbfSMatthew Knepley MATOP_GET_ROW_IJ=50, 1490d519adbfSMatthew Knepley MATOP_RESTORE_ROW_IJ=51, 1491d519adbfSMatthew Knepley MATOP_GET_COLUMN_IJ=52, 1492d519adbfSMatthew Knepley MATOP_RESTORE_COLUMN_IJ=53, 1493d519adbfSMatthew Knepley MATOP_FDCOLORING_CREATE=54, 1494d519adbfSMatthew Knepley MATOP_COLORING_PATCH=55, 1495d519adbfSMatthew Knepley MATOP_SET_UNFACTORED=56, 1496d519adbfSMatthew Knepley MATOP_PERMUTE=57, 1497d519adbfSMatthew Knepley MATOP_SET_VALUES_BLOCKED=58, 1498d519adbfSMatthew Knepley MATOP_GET_SUBMATRIX=59, 1499d519adbfSMatthew Knepley MATOP_DESTROY=60, 1500d519adbfSMatthew Knepley MATOP_VIEW=61, 1501d519adbfSMatthew Knepley MATOP_CONVERT_FROM=62, 1502d519adbfSMatthew Knepley MATOP_USE_SCALED_FORM=63, 1503d519adbfSMatthew Knepley MATOP_SCALE_SYSTEM=64, 1504d519adbfSMatthew Knepley MATOP_UNSCALE_SYSTEM=65, 1505d519adbfSMatthew Knepley MATOP_SET_LOCAL_TO_GLOBAL_MAP=66, 1506d519adbfSMatthew Knepley MATOP_SET_VALUES_LOCAL=67, 1507d519adbfSMatthew Knepley MATOP_ZERO_ROWS_LOCAL=68, 1508d519adbfSMatthew Knepley MATOP_GET_ROW_MAX_ABS=69, 1509d519adbfSMatthew Knepley MATOP_GET_ROW_MIN_ABS=70, 1510d519adbfSMatthew Knepley MATOP_CONVERT=71, 1511d519adbfSMatthew Knepley MATOP_SET_COLORING=72, 1512d519adbfSMatthew Knepley MATOP_SET_VALUES_ADIC=73, 1513d519adbfSMatthew Knepley MATOP_SET_VALUES_ADIFOR=74, 1514d519adbfSMatthew Knepley MATOP_FD_COLORING_APPLY=75, 1515d519adbfSMatthew Knepley MATOP_SET_FROM_OPTIONS=76, 1516d519adbfSMatthew Knepley MATOP_MULT_CON=77, 1517d519adbfSMatthew Knepley MATOP_MULT_TRANSPOSE_CON=78, 1518d519adbfSMatthew Knepley MATOP_PERMUTE_SPARSIFY=79, 1519d519adbfSMatthew Knepley MATOP_MULT_MULTIPLE=80, 1520d519adbfSMatthew Knepley MATOP_SOLVE_MULTIPLE=81, 1521d519adbfSMatthew Knepley MATOP_GET_INERTIA=82, 1522d519adbfSMatthew Knepley MATOP_LOAD=83, 1523d519adbfSMatthew Knepley MATOP_IS_SYMMETRIC=84, 1524d519adbfSMatthew Knepley MATOP_IS_HERMITIAN=85, 1525d519adbfSMatthew Knepley MATOP_IS_STRUCTURALLY_SYMMETRIC=86, 152641f059aeSBarry Smith MATOP_DUMMY=87, 1527d519adbfSMatthew Knepley MATOP_GET_VECS=88, 1528d519adbfSMatthew Knepley MATOP_MAT_MULT=89, 1529d519adbfSMatthew Knepley MATOP_MAT_MULT_SYMBOLIC=90, 1530d519adbfSMatthew Knepley MATOP_MAT_MULT_NUMERIC=91, 1531d519adbfSMatthew Knepley MATOP_PTAP=92, 1532d519adbfSMatthew Knepley MATOP_PTAP_SYMBOLIC=93, 1533d519adbfSMatthew Knepley MATOP_PTAP_NUMERIC=94, 1534d519adbfSMatthew Knepley MATOP_MAT_MULTTRANSPOSE=95, 15351763ac4eSSatish Balay MATOP_MAT_MULTTRANSPOSE_SYM=96, 15361763ac4eSSatish Balay MATOP_MAT_MULTTRANSPOSE_NUM=97, 1537d519adbfSMatthew Knepley MATOP_PTAP_SYMBOLIC_SEQAIJ=98, 1538d519adbfSMatthew Knepley MATOP_PTAP_NUMERIC_SEQAIJ=99, 1539d519adbfSMatthew Knepley MATOP_PTAP_SYMBOLIC_MPIAIJ=100, 1540d519adbfSMatthew Knepley MATOP_PTAP_NUMERIC_MPIAIJ=101, 1541d519adbfSMatthew Knepley MATOP_CONJUGATE=102, 1542d519adbfSMatthew Knepley MATOP_SET_SIZES=103, 1543d519adbfSMatthew Knepley MATOP_SET_VALUES_ROW=104, 1544d519adbfSMatthew Knepley MATOP_REAL_PART=105, 1545d519adbfSMatthew Knepley MATOP_IMAG_PART=106, 1546d519adbfSMatthew Knepley MATOP_GET_ROW_UTRIANGULAR=107, 1547d519adbfSMatthew Knepley MATOP_RESTORE_ROW_UTRIANGULAR=108, 1548d519adbfSMatthew Knepley MATOP_MATSOLVE=109, 1549d519adbfSMatthew Knepley MATOP_GET_REDUNDANTMATRIX=110, 1550d519adbfSMatthew Knepley MATOP_GET_ROW_MIN=111, 1551d519adbfSMatthew Knepley MATOP_GET_COLUMN_VEC=112, 1552d519adbfSMatthew Knepley MATOP_MISSING_DIAGONAL=113, 1553d519adbfSMatthew Knepley MATOP_MATGETSEQNONZEROSTRUCTURE=114, 155489c6957cSBarry Smith MATOP_CREATE=115, 155589c6957cSBarry Smith MATOP_GET_GHOSTS=116, 1556eeffb40dSHong Zhang MATOP_MULT_DIAGONAL_BLOCK=119, 1557547795f9SHong Zhang MATOP_HERMITIANTRANSPOSE=120, 1558547795f9SHong Zhang MATOP_MULTHERMITIANTRANSPOSE=121, 1559*fbdbba38SShri Abhyankar MATOP_MULTHERMITIANTRANSPOSEADD=122, 1560*fbdbba38SShri Abhyankar MATOP_LOADNEW=123, 1561fae171e0SBarry Smith } MatOperation; 1562be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*); 1563be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1564be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1565be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*); 1566112a2221SBarry Smith 156790ace30eSBarry Smith /* 156890ace30eSBarry Smith Codes for matrices stored on disk. By default they are 156990ace30eSBarry Smith stored in a universal format. By changing the format with 15707973ad04SBarry Smith PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will 157190ace30eSBarry Smith be stored in a way natural for the matrix, for example dense matrices 157290ace30eSBarry Smith would be stored as dense. Matrices stored this way may only be 157390ace30eSBarry Smith read into matrices of the same time. 157490ace30eSBarry Smith */ 157590ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1 157690ace30eSBarry Smith 1577be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 1578be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*); 15791f4e1ec7SBarry Smith 1580d9274352SBarry Smith /*S 1581d9274352SBarry Smith MatNullSpace - Object that removes a null space from a vector, i.e. 1582d9274352SBarry Smith orthogonalizes the vector to a subsapce 1583d9274352SBarry Smith 1584f7a9e4ceSBarry Smith Level: advanced 1585d9274352SBarry Smith 1586d9274352SBarry Smith Concepts: matrix; linear operator, null space 1587d9274352SBarry Smith 15886e1639daSBarry Smith Users manual sections: 15896e1639daSBarry Smith . sec_singular 15906e1639daSBarry Smith 1591d9274352SBarry Smith .seealso: MatNullSpaceCreate() 1592d9274352SBarry Smith S*/ 159374637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace; 1594d9274352SBarry Smith 1595be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*); 1596b22b330cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*); 1597be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace); 1598be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*); 1599be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace); 160095902228SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat,PetscTruth *); 160174637425SBarry Smith 1602be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS); 1603be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1604be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 160546129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat); 16063f1d51d7SBarry Smith 1607be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*); 1608be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*); 1609be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*); 1610c4f061fbSSatish Balay 1611be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*); 1612b0a32e0cSBarry Smith 1613be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec); 161404f1ad80SBarry Smith 1615fef1beadSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 16163ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetBase(Mat,Vec,Vec); 16173ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*); 1618e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*)); 1619e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec)); 1620e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDAddNullSpace(Mat,MatNullSpace); 1621e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt); 1622e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDResetHHistory(Mat); 1623e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctionError(Mat,PetscReal); 1624e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetPeriod(Mat,PetscInt); 1625e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDGetH(Mat,PetscScalar *); 16266aa9148fSLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetOptionsPrefix(Mat,const char[]); 1627e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFromOptions(Mat); 1628e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*); 1629e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*); 1630e884886fSBarry Smith 16316370053bSBarry Smith /*S 16326370053bSBarry Smith MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free 16336370053bSBarry Smith Jacobian vector products 1634e884886fSBarry Smith 16356370053bSBarry Smith Notes: MATMFFD is a specific MatType which uses the MatMFFD data structure 16366370053bSBarry Smith 16376370053bSBarry Smith MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure 16386370053bSBarry Smith 16396370053bSBarry Smith Level: developer 16406370053bSBarry Smith 16416370053bSBarry Smith .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister() 16426370053bSBarry Smith S*/ 1643e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD; 1644e884886fSBarry Smith 1645e884886fSBarry Smith /*E 1646e884886fSBarry Smith MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function 1647e884886fSBarry Smith 1648e884886fSBarry Smith Level: beginner 1649e884886fSBarry Smith 1650e884886fSBarry Smith .seealso: MatMFFDSetType(), MatMFFDRegister() 1651e884886fSBarry Smith E*/ 1652a313700dSBarry Smith #define MatMFFDType char* 1653e884886fSBarry Smith #define MATMFFD_DS "ds" 1654e884886fSBarry Smith #define MATMFFD_WP "wp" 1655e884886fSBarry Smith 1656a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetType(Mat,const MatMFFDType); 1657e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD)); 1658e884886fSBarry Smith 1659e884886fSBarry Smith /*MC 1660e884886fSBarry Smith MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry. 1661e884886fSBarry Smith 1662e884886fSBarry Smith Synopsis: 16631890ba74SBarry Smith PetscErrorCode MatMFFDRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatMFFD)) 1664e884886fSBarry Smith 1665e884886fSBarry Smith Not Collective 1666e884886fSBarry Smith 1667e884886fSBarry Smith Input Parameters: 1668e884886fSBarry Smith + name_solver - name of a new user-defined compute-h module 1669e884886fSBarry Smith . path - path (either absolute or relative) the library containing this solver 1670e884886fSBarry Smith . name_create - name of routine to create method context 1671e884886fSBarry Smith - routine_create - routine to create method context 1672e884886fSBarry Smith 1673e884886fSBarry Smith Level: developer 1674e884886fSBarry Smith 1675e884886fSBarry Smith Notes: 1676e884886fSBarry Smith MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers. 1677e884886fSBarry Smith 1678e884886fSBarry Smith If dynamic libraries are used, then the fourth input argument (routine_create) 1679e884886fSBarry Smith is ignored. 1680e884886fSBarry Smith 1681e884886fSBarry Smith Sample usage: 1682e884886fSBarry Smith .vb 1683e884886fSBarry Smith MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a, 1684e884886fSBarry Smith "MyHCreate",MyHCreate); 1685e884886fSBarry Smith .ve 1686e884886fSBarry Smith 1687e884886fSBarry Smith Then, your solver can be chosen with the procedural interface via 1688e884886fSBarry Smith $ MatMFFDSetType(mfctx,"my_h") 1689e884886fSBarry Smith or at runtime via the option 1690e884886fSBarry Smith $ -snes_mf_type my_h 1691e884886fSBarry Smith 1692e884886fSBarry Smith .keywords: MatMFFD, register 1693e884886fSBarry Smith 1694e884886fSBarry Smith .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy() 1695e884886fSBarry Smith M*/ 1696e884886fSBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1697e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0) 1698e884886fSBarry Smith #else 1699e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d) 1700e884886fSBarry Smith #endif 1701e884886fSBarry Smith 1702e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterAll(const char[]); 1703e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterDestroy(void); 17041d0fab5eSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDDSSetUmin(Mat,PetscReal); 1705e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDWPSetComputeNormU(Mat,PetscTruth); 1706e884886fSBarry Smith 1707e884886fSBarry Smith 1708be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1709be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 17107dbadf16SMatthew Knepley 171197969023SHong Zhang /* 171297969023SHong Zhang PETSc interface to MUMPS 171397969023SHong Zhang */ 171497969023SHong Zhang #ifdef PETSC_HAVE_MUMPS 171597969023SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMumpsSetIcntl(Mat,PetscInt,PetscInt); 171697969023SHong Zhang #endif 171723a5497aSJed Brown 171823a5497aSJed Brown PETSC_EXTERN_CXX_END 171923a5497aSJed Brown #endif 1720