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" 315a11e1b2SBarry Smith #define MATMAIJ "maij" 32273d9f13SBarry Smith #define MATSEQMAIJ "seqmaij" 33273d9f13SBarry Smith #define MATMPIMAIJ "mpimaij" 34273d9f13SBarry Smith #define MATIS "is" 355a11e1b2SBarry Smith #define MATAIJ "aij" 36273d9f13SBarry Smith #define MATSEQAIJ "seqaij" 37273d9f13SBarry Smith #define MATMPIAIJ "mpiaij" 385a11e1b2SBarry Smith #define MATAIJCRL "aijcrl" 395a11e1b2SBarry Smith #define MATSEQAIJCRL "seqaijcrl" 405a11e1b2SBarry Smith #define MATMPIAIJCRL "mpiaijcrl" 415a11e1b2SBarry Smith #define MATAIJCUDA "aijcuda" 425a11e1b2SBarry Smith #define MATSEQAIJCUDA "seqaijcuda" 435a11e1b2SBarry Smith #define MATMPIAIJCUDA "mpiaijcuda" 445a11e1b2SBarry Smith #define MATAIJPERM "aijperm" 455a11e1b2SBarry Smith #define MATSEQAIJPERM "seqaijperm" 465a11e1b2SBarry Smith #define MATMPIAIJPERM "mpiaijperm" 47273d9f13SBarry Smith #define MATSHELL "shell" 485a11e1b2SBarry Smith #define MATDENSE "dense" 49209238afSKris Buschelman #define MATSEQDENSE "seqdense" 50273d9f13SBarry Smith #define MATMPIDENSE "mpidense" 515a11e1b2SBarry Smith #define MATBAIJ "baij" 52273d9f13SBarry Smith #define MATSEQBAIJ "seqbaij" 53273d9f13SBarry Smith #define MATMPIBAIJ "mpibaij" 54273d9f13SBarry Smith #define MATMPIADJ "mpiadj" 555a11e1b2SBarry Smith #define MATSBAIJ "sbaij" 56273d9f13SBarry Smith #define MATSEQSBAIJ "seqsbaij" 57273d9f13SBarry Smith #define MATMPISBAIJ "mpisbaij" 58cebc7f6cSBarry Smith #define MATDAAD "daad" 59cebc7f6cSBarry Smith #define MATMFFD "mffd" 60c8a8475eSBarry Smith #define MATNORMAL "normal" 61ab92ecdeSBarry Smith #define MATLRC "lrc" 622a6744ebSBarry Smith #define MATSCATTER "scatter" 63421e10b8SBarry Smith #define MATBLOCKMAT "blockmat" 64793850ffSBarry Smith #define MATCOMPOSITE "composite" 655a7f1df3SHong Zhang #define MATSEQFFTW "seqfftw" 66557cca28SSatish Balay #define MATTRANSPOSEMAT "transpose" 6772ca8751SBarry Smith #define MATSCHURCOMPLEMENT "schurcomplement" 681d6018f0SLisandro Dalcin #define MATPYTHON "python" 69f91d8e95SBarry Smith #define MATHYPRESTRUCT "hyprestruct" 70a9e6138eSGlenn Hammond #define MATHYPRESSTRUCT "hypresstruct" 71ee1cef2cSJed Brown #define MATSUBMATRIX "submatrix" 72dbc6227fSDmitry Karpeev #define MATDD "matdd" 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*); 3125a11e1b2SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 3135a11e1b2SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJCRL(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, 4256fdc2a6dSBarry Smith MAT_SPD, 42628b2fa4aSMatthew Knepley NUM_MAT_OPTIONS} MatOption; 427290bbb0aSBarry Smith extern const char *MatOptions[]; 4284e0d8c25SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption,PetscTruth); 429a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,const MatType*); 430a313700dSBarry Smith PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),const MatType,t) 43184cb2905SBarry Smith 432be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 433be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 434be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 435f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat); 436f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat); 437be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 438be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 439be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt); 440be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]); 441ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a) 442be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]); 443be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *); 444ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a) 445be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt); 4467b80b807SBarry Smith 4471620fd73SBarry Smith 448be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec); 44989c6957cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultDiagonalBlock(Mat,Vec,Vec); 450be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec); 451ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 452be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec); 453547795f9SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultHermitianTranspose(Mat,Vec,Vec); 454be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*); 455ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t) 456e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscTruth,t) 4571cbb95d3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscTruth*); 458be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec); 4595cb05578SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec); 460ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 461be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec); 462be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec); 4632bebee5dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat,Mat,Mat); 464f5edf698SHong Zhang 465d91e6319SBarry Smith /*E 466d91e6319SBarry Smith MatDuplicateOption - Indicates if a duplicated sparse matrix should have 467d91e6319SBarry Smith its numerical values copied over or just its nonzero structure. 468d91e6319SBarry Smith 469d91e6319SBarry Smith Level: beginner 470d91e6319SBarry Smith 471d91e6319SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 472d91e6319SBarry Smith 47370dcbbb9SBarry Smith $ MAT_SHARE_NONZERO_PATTERN - the i and j arrays in the new matrix will be shared with the original matrix 47470dcbbb9SBarry Smith $ this also triggers the MAT_DO_NOT_COPY_VALUES option. This is used when you 47570dcbbb9SBarry Smith $ have several matrices with the same nonzero pattern. 47670dcbbb9SBarry Smith 477d91e6319SBarry Smith .seealso: MatDuplicate() 478d91e6319SBarry Smith E*/ 47970dcbbb9SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption; 4802e8a6d31SBarry Smith 481a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,const MatType,MatReuse,Mat*); 482a313700dSBarry Smith PetscPolymorphicFunction(MatConvert,(Mat A,const MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a) 483be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*); 484ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a) 485ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a) 48694a9d846SBarry Smith 487cb5b572fSBarry Smith 488be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure); 489be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer); 490be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*); 491ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t) 492e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscTruth,t) 493be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*); 494ba966639SSatish Balay PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t) 4951cbb95d3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscReal,PetscTruth*); 4961cbb95d3SBarry Smith PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,0,&t),PetscTruth,t) 497be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*); 498be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*); 49964c62002SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMissingDiagonal(Mat,PetscTruth *,PetscInt *); 500112444f4SShri Abhyankar EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(Mat, PetscViewer); 5017b80b807SBarry Smith 5028f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *); 5038f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *); 5048f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *); 5058f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *); 506d4fbbf0eSBarry Smith 507d91e6319SBarry Smith /*S 508d91e6319SBarry Smith MatInfo - Context of matrix information, used with MatGetInfo() 509d91e6319SBarry Smith 510d91e6319SBarry Smith In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE 511d91e6319SBarry Smith 512d91e6319SBarry Smith Level: intermediate 513d91e6319SBarry Smith 514d91e6319SBarry Smith Concepts: matrix^nonzero information 515d91e6319SBarry Smith 516d9274352SBarry Smith .seealso: MatGetInfo(), MatInfoType 517d91e6319SBarry Smith S*/ 5184e220ebcSLois Curfman McInnes typedef struct { 519b0a32e0cSBarry Smith PetscLogDouble block_size; /* block size */ 520b0a32e0cSBarry Smith PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */ 521b0a32e0cSBarry Smith PetscLogDouble memory; /* memory allocated */ 522b0a32e0cSBarry Smith PetscLogDouble assemblies; /* number of matrix assemblies called */ 523b0a32e0cSBarry Smith PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */ 524b0a32e0cSBarry Smith PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */ 525b0a32e0cSBarry Smith PetscLogDouble factor_mallocs; /* number of mallocs during factorization */ 5264e220ebcSLois Curfman McInnes } MatInfo; 5274e220ebcSLois Curfman McInnes 528d9274352SBarry Smith /*E 529d9274352SBarry Smith MatInfoType - Indicates if you want information about the local part of the matrix, 530d9274352SBarry Smith the entire parallel matrix or the maximum over all the local parts. 531d9274352SBarry Smith 532d9274352SBarry Smith Level: beginner 533d9274352SBarry Smith 534d9274352SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 535d9274352SBarry Smith 536d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo 537d9274352SBarry Smith E*/ 5387b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 539be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*); 540be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec); 541985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec,PetscInt[]); 542985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMin(Mat,Vec,PetscInt[]); 543985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMaxAbs(Mat,Vec,PetscInt[]); 544c87e5d42SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMinAbs(Mat,Vec,PetscInt[]); 54586697f06SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowSum(Mat,Vec); 546fc4dec0aSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,MatReuse,Mat*); 547fc4dec0aSBarry Smith PetscPolymorphicFunction(MatTranspose,(Mat A),(A,MAT_INITIAL_MATRIX,&t),Mat,t) 548eeffb40dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHermitianTranspose(Mat,MatReuse,Mat*); 549be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *); 550ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t) 551be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *); 552be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec); 553be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode); 554be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*); 555ba966639SSatish Balay PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t) 556be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*); 557be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*); 558be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*); 559be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*); 5607b80b807SBarry Smith 561be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *); 562ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n) 563242f1d38SBarry Smith EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal *); 564be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat); 565f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar); 566f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar); 567c504e21bSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar); 568f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*); 569f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*); 5707b80b807SBarry Smith 571be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth); 572be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec); 573be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec); 5745ef9f2a5SBarry Smith 575be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*); 576be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*); 577be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*); 5788ee2e534SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRanges(Mat,const PetscInt**); 579f4b8409dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*); 58072ca8751SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangesColumn(Mat,const PetscInt**); 5817b80b807SBarry Smith 582be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 583be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]); 5844aa3045dSJed Brown EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,MatReuse,Mat *); 585f6d58c54SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSeqNonzeroStructure(Mat,Mat*); 586f6d58c54SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroySeqNonzeroStructure(Mat*); 5875494a064SHong Zhang 588be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*); 589be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*); 590be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*); 591be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat); 592be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat); 593be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*); 594be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*); 595be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*); 5961d79065fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscInt**,MatScalar**,Mat*); 59743eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE) 598cd116e26SSatish Balay #include "petscctable.h" 59943eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *); 60043eb5e2fSMatthew Knepley #else 60143eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *); 60243eb5e2fSMatthew Knepley #endif 6038c7482ecSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetGhosts(Mat, PetscInt *,const PetscInt *[]); 6048efafbd8SBarry Smith 605be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt); 6067b80b807SBarry Smith 607be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 608be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*); 609be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat); 61022440eb1SKris Buschelman 611be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*); 612be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*); 613be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat); 61422440eb1SKris Buschelman 615be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*); 616be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*); 617be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat); 618bc011b1eSHong Zhang 619f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure); 62004aac2b0SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat,MatStructure); 6211c741599SHong Zhang 622f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar); 623f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar); 6247b80b807SBarry Smith 625be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping); 626be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping); 627f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar); 628f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar); 629be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 630be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 631052efed2SBarry Smith 632be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt); 633be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 63490f02eecSBarry Smith 635be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec); 6360c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec); 637ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 638be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec); 639be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*); 64069db28dcSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*); 641d6037b41SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetMultiProcBlock(Mat,MPI_Comm,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: 6910598bfebSBarry Smith See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual 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: 7350598bfebSBarry Smith See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual 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: 7770598bfebSBarry Smith See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual 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: 8180598bfebSBarry Smith See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual 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: 8590598bfebSBarry Smith See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual 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: 9010598bfebSBarry Smith See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual 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: 9400598bfebSBarry Smith See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual 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: 9710598bfebSBarry Smith See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual 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" 1057*312e372aSBarry Smith #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */ 1058b12f92e5SBarry Smith 1059f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*); 1060be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list); 1061f2416520SSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*)); 106230de9b25SBarry Smith 106330de9b25SBarry Smith /*MC 10641890ba74SBarry Smith MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the matrix package. 106530de9b25SBarry Smith 106630de9b25SBarry Smith Synopsis: 10671890ba74SBarry Smith PetscErrorCode MatOrderingRegisterDynamic(const char *name_ordering,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatOrdering)) 106830de9b25SBarry Smith 106930de9b25SBarry Smith Not Collective 107030de9b25SBarry Smith 107130de9b25SBarry Smith Input Parameters: 10722692d6eeSBarry Smith + sname - name of ordering (for example MATORDERINGND) 107330de9b25SBarry Smith . path - location of library where creation routine is 107430de9b25SBarry Smith . name - name of function that creates the ordering type,a string 107530de9b25SBarry Smith - function - function pointer that creates the ordering 107630de9b25SBarry Smith 107730de9b25SBarry Smith Level: developer 107830de9b25SBarry Smith 107930de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (function) 108030de9b25SBarry Smith is ignored. 108130de9b25SBarry Smith 108230de9b25SBarry Smith Sample usage: 108330de9b25SBarry Smith .vb 108430de9b25SBarry Smith MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a, 108530de9b25SBarry Smith "MyOrder",MyOrder); 108630de9b25SBarry Smith .ve 108730de9b25SBarry Smith 108830de9b25SBarry Smith Then, your partitioner can be chosen with the procedural interface via 108930de9b25SBarry Smith $ MatOrderingSetType(part,"my_order) 109030de9b25SBarry Smith or at runtime via the option 10912401956bSBarry Smith $ -pc_factor_mat_ordering_type my_order 109230de9b25SBarry Smith 1093ab901514SBarry Smith ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values. 109430de9b25SBarry Smith 109530de9b25SBarry Smith .keywords: matrix, ordering, register 109630de9b25SBarry Smith 109730de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll() 109830de9b25SBarry Smith M*/ 1099aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1100f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0) 1101b12f92e5SBarry Smith #else 1102f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d) 1103b12f92e5SBarry Smith #endif 110430de9b25SBarry Smith 1105be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void); 1106be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]); 11072bad1931SBarry Smith extern PetscTruth MatOrderingRegisterAllCalled; 1108b0a32e0cSBarry Smith extern PetscFList MatOrderingList; 1109d4fbbf0eSBarry Smith 1110be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 1111a2ce50c7SBarry Smith 1112d91e6319SBarry Smith /*S 1113d90ac83dSHong Zhang MatFactorShiftType - Numeric Shift. 1114d90ac83dSHong Zhang 1115d90ac83dSHong Zhang Level: beginner 1116d90ac83dSHong Zhang 1117d90ac83dSHong Zhang S*/ 1118d90ac83dSHong Zhang typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType; 1119d90ac83dSHong Zhang extern const char *MatFactorShiftTypes[]; 1120d90ac83dSHong Zhang 1121d90ac83dSHong Zhang /*S 11222401956bSBarry Smith MatFactorInfo - Data passed into the matrix factorization routines 1123b00f7748SHong Zhang 112461cad860SBarry Smith In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use 112561cad860SBarry Smith $ MatFactorInfo info(MAT_FACTORINFO_SIZE) 1126b00f7748SHong Zhang 112715e8a5b3SHong Zhang Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 1128b00f7748SHong Zhang 112961cad860SBarry Smith You can use MatFactorInfoInitialize() to set default values. 113061cad860SBarry Smith 1131b00f7748SHong Zhang Level: developer 1132b00f7748SHong Zhang 1133d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 1134d7d82daaSBarry Smith MatFactorInfoInitialize() 1135b00f7748SHong Zhang 1136b00f7748SHong Zhang S*/ 1137b00f7748SHong Zhang typedef struct { 113815e8a5b3SHong Zhang PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 113985317021SBarry Smith PetscReal usedt; 114015e8a5b3SHong Zhang PetscReal dt; /* drop tolerance */ 1141b00f7748SHong Zhang PetscReal dtcol; /* tolerance for pivoting */ 114215e8a5b3SHong Zhang PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 114367e28bfeSBarry Smith PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */ 1144348344bbSBarry Smith PetscReal levels; /* ICC/ILU(levels) */ 1145bcd9e38bSBarry Smith PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 1146bcd9e38bSBarry Smith factorization may be faster if do not pivot */ 114715e8a5b3SHong Zhang PetscReal zeropivot; /* pivot is called zero if less than this */ 1148f4db908eSBarry Smith PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */ 1149f4db908eSBarry Smith PetscReal shiftamount; /* how large the shift is */ 115015e8a5b3SHong Zhang } MatFactorInfo; 1151ffa6d0a5SLois Curfman McInnes 1152be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*); 11530481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,const MatFactorInfo*); 11540481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 11550481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*); 11560481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,const MatFactorInfo*); 11570481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,const MatFactorInfo*); 11580481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 11590481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 11600481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 11610481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,const MatFactorInfo*); 11620481f469SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*); 1163be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 1164be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec); 1165be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec); 1166be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec); 1167be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec); 1168be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec); 1169be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 1170be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs); 11718ed539a5SBarry Smith 1172be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat); 1173bb5a7306SBarry Smith 1174d91e6319SBarry Smith /*E 1175d91e6319SBarry Smith MatSORType - What type of (S)SOR to perform 1176bb1eb677SSatish Balay 1177d91e6319SBarry Smith Level: beginner 1178d91e6319SBarry Smith 1179d9274352SBarry Smith May be bitwise ORd together 1180d9274352SBarry Smith 1181d91e6319SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 1182d91e6319SBarry Smith 11834e7234bfSBarry Smith MatSORType may be bitwise ORd together, so do not change the numbers 11844e7234bfSBarry Smith 118541f059aeSBarry Smith .seealso: MatSOR() 1186d91e6319SBarry Smith E*/ 1187ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1188ee50ffe9SBarry Smith SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1189ee50ffe9SBarry Smith SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 119084cb2905SBarry Smith SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 119141f059aeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 11928ed539a5SBarry Smith 1193d4fbbf0eSBarry Smith /* 1194639f9d9dSBarry Smith These routines are for efficiently computing Jacobians via finite differences. 1195639f9d9dSBarry Smith */ 1196b12f92e5SBarry Smith 1197d9274352SBarry Smith /*E 1198d9274352SBarry Smith MatColoringType - String with the name of a PETSc matrix coloring or the creation function 1199d9274352SBarry Smith with an optional dynamic library name, for example 1200d9274352SBarry Smith http://www.mcs.anl.gov/petsc/lib.a:coloringcreate() 1201d9274352SBarry Smith 1202d9274352SBarry Smith Level: beginner 1203d9274352SBarry Smith 1204d9274352SBarry Smith .seealso: MatGetColoring() 1205d9274352SBarry Smith E*/ 1206a313700dSBarry Smith #define MatColoringType char* 12072692d6eeSBarry Smith #define MATCOLORINGNATURAL "natural" 12082692d6eeSBarry Smith #define MATCOLORINGSL "sl" 12092692d6eeSBarry Smith #define MATCOLORINGLF "lf" 12102692d6eeSBarry Smith #define MATCOLORINGID "id" 1211b12f92e5SBarry Smith 1212ab970d9bSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*); 12132e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *)); 121430de9b25SBarry Smith 121530de9b25SBarry Smith /*MC 121630de9b25SBarry Smith MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the 121730de9b25SBarry Smith matrix package. 121830de9b25SBarry Smith 121930de9b25SBarry Smith Synopsis: 12201890ba74SBarry Smith PetscErrorCode MatColoringRegisterDynamic(const char *name_coloring,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatColoring)) 122130de9b25SBarry Smith 122230de9b25SBarry Smith Not Collective 122330de9b25SBarry Smith 122430de9b25SBarry Smith Input Parameters: 12252692d6eeSBarry Smith + sname - name of Coloring (for example MATCOLORINGSL) 122630de9b25SBarry Smith . path - location of library where creation routine is 122730de9b25SBarry Smith . name - name of function that creates the Coloring type, a string 122830de9b25SBarry Smith - function - function pointer that creates the coloring 122930de9b25SBarry Smith 123030de9b25SBarry Smith Level: developer 123130de9b25SBarry Smith 123230de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (function) 123330de9b25SBarry Smith is ignored. 123430de9b25SBarry Smith 123530de9b25SBarry Smith Sample usage: 123630de9b25SBarry Smith .vb 123730de9b25SBarry Smith MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a, 123830de9b25SBarry Smith "MyColor",MyColor); 123930de9b25SBarry Smith .ve 124030de9b25SBarry Smith 124130de9b25SBarry Smith Then, your partitioner can be chosen with the procedural interface via 124230de9b25SBarry Smith $ MatColoringSetType(part,"my_color") 124330de9b25SBarry Smith or at runtime via the option 124430de9b25SBarry Smith $ -mat_coloring_type my_color 124530de9b25SBarry Smith 1246ab901514SBarry Smith $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 124730de9b25SBarry Smith 124830de9b25SBarry Smith .keywords: matrix, Coloring, register 124930de9b25SBarry Smith 125030de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll() 125130de9b25SBarry Smith M*/ 1252aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1253f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0) 1254b12f92e5SBarry Smith #else 1255f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d) 1256b12f92e5SBarry Smith #endif 125730de9b25SBarry Smith 12582bad1931SBarry Smith extern PetscTruth MatColoringRegisterAllCalled; 1259f1144a30SSatish Balay 1260be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]); 1261be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void); 1262be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 1263639f9d9dSBarry Smith 1264d9274352SBarry Smith /*S 1265d9274352SBarry Smith MatFDColoring - Object for computing a sparse Jacobian via finite differences 1266d9274352SBarry Smith and coloring 1267639f9d9dSBarry Smith 1268d9274352SBarry Smith Level: beginner 1269d9274352SBarry Smith 1270d9274352SBarry Smith Concepts: coloring, sparse Jacobian, finite differences 1271d9274352SBarry Smith 1272d9274352SBarry Smith .seealso: MatFDColoringCreate() 1273d9274352SBarry Smith S*/ 1274e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring; 1275639f9d9dSBarry Smith 1276be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1277be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring); 1278be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer); 1279be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 12804a9d489dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1281be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1282be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring); 1283be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *); 1284be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *); 1285be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec); 1286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]); 1287639f9d9dSBarry Smith /* 12880752156aSBarry Smith These routines are for partitioning matrices: currently used only 12893eda8832SBarry Smith for adjacency matrix, MatCreateMPIAdj(). 12900752156aSBarry Smith */ 1291ca161407SBarry Smith 1292d9274352SBarry Smith /*S 1293d9274352SBarry Smith MatPartitioning - Object for managing the partitioning of a matrix or graph 1294d9274352SBarry Smith 1295d9274352SBarry Smith Level: beginner 1296d9274352SBarry Smith 1297d9274352SBarry Smith Concepts: partitioning 1298d9274352SBarry Smith 1299743a1026Svictorle .seealso: MatPartitioningCreate(), MatPartitioningType 1300d9274352SBarry Smith S*/ 130191e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning; 1302d9274352SBarry Smith 1303d9274352SBarry Smith /*E 13045bc6e7ccSvictorle MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function 1305d9274352SBarry Smith with an optional dynamic library name, for example 1306d9274352SBarry Smith http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate() 1307d9274352SBarry Smith 1308d9274352SBarry Smith Level: beginner 1309d9274352SBarry Smith 1310b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning 1311d9274352SBarry Smith E*/ 1312a313700dSBarry Smith #define MatPartitioningType char* 13132692d6eeSBarry Smith #define MATPARTITIONINGCURRENT "current" 13142692d6eeSBarry Smith #define MATPARTITIONINGSQUARE "square" 13152692d6eeSBarry Smith #define MATPARTITIONINGPARMETIS "parmetis" 13162692d6eeSBarry Smith #define MATPARTITIONINGCHACO "chaco" 13172692d6eeSBarry Smith #define MATPARTITIONINGJOSTLE "jostle" 13182692d6eeSBarry Smith #define MATPARTITIONINGPARTY "party" 13192692d6eeSBarry Smith #define MATPARTITIONINGSCOTCH "scotch" 132071306c60Sjroman 1321ca161407SBarry Smith 1322be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*); 1323a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType); 1324be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt); 1325be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat); 1326be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1327be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1328be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*); 1329be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning); 13302aabb6bbSBarry Smith 1331be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning)); 133230de9b25SBarry Smith 133330de9b25SBarry Smith /*MC 133430de9b25SBarry Smith MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the 133530de9b25SBarry Smith matrix package. 133630de9b25SBarry Smith 133730de9b25SBarry Smith Synopsis: 13381890ba74SBarry Smith PetscErrorCode MatPartitioningRegisterDynamic(const char *name_partitioning,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatPartitioning)) 133930de9b25SBarry Smith 134030de9b25SBarry Smith Not Collective 134130de9b25SBarry Smith 134230de9b25SBarry Smith Input Parameters: 13432692d6eeSBarry Smith + sname - name of partitioning (for example MATPARTITIONINGCURRENT) or parmetis 134430de9b25SBarry Smith . path - location of library where creation routine is 134530de9b25SBarry Smith . name - name of function that creates the partitioning type, a string 134630de9b25SBarry Smith - function - function pointer that creates the partitioning type 134730de9b25SBarry Smith 134830de9b25SBarry Smith Level: developer 134930de9b25SBarry Smith 135030de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (function) 135130de9b25SBarry Smith is ignored. 135230de9b25SBarry Smith 135330de9b25SBarry Smith Sample usage: 135430de9b25SBarry Smith .vb 135530de9b25SBarry Smith MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a, 135630de9b25SBarry Smith "MyPartCreate",MyPartCreate); 135730de9b25SBarry Smith .ve 135830de9b25SBarry Smith 135930de9b25SBarry Smith Then, your partitioner can be chosen with the procedural interface via 136030de9b25SBarry Smith $ MatPartitioningSetType(part,"my_part") 136130de9b25SBarry Smith or at runtime via the option 136230de9b25SBarry Smith $ -mat_partitioning_type my_part 136330de9b25SBarry Smith 1364ab901514SBarry Smith $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 136530de9b25SBarry Smith 136630de9b25SBarry Smith .keywords: matrix, partitioning, register 136730de9b25SBarry Smith 136830de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll() 136930de9b25SBarry Smith M*/ 1370aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1371f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0) 13722aabb6bbSBarry Smith #else 1373f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d) 13742aabb6bbSBarry Smith #endif 13752aabb6bbSBarry Smith 13762bad1931SBarry Smith extern PetscTruth MatPartitioningRegisterAllCalled; 1377f1144a30SSatish Balay 1378be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]); 1379be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void); 13802bad1931SBarry Smith 1381be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer); 1382be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning); 1383a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,const MatPartitioningType*); 1384ca161407SBarry Smith 1385be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 13860e8af3caSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *); 13870752156aSBarry Smith 1388be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal); 1389be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning); 139071306c60Sjroman 1391954b3ec6SBarry Smith typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType; 1392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType); 139371306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType; 1394be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType); 1395be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 139671306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType; 1397be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1398be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal); 1399be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt); 140071306c60Sjroman 140171306c60Sjroman #define MP_PARTY_OPT "opt" 140271306c60Sjroman #define MP_PARTY_LIN "lin" 140371306c60Sjroman #define MP_PARTY_SCA "sca" 140471306c60Sjroman #define MP_PARTY_RAN "ran" 140571306c60Sjroman #define MP_PARTY_GBF "gbf" 140671306c60Sjroman #define MP_PARTY_GCF "gcf" 140771306c60Sjroman #define MP_PARTY_BUB "bub" 140871306c60Sjroman #define MP_PARTY_DEF "def" 1409be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*); 141071306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs" 141171306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl" 141271306c60Sjroman #define MP_PARTY_NONE "no" 1413be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*); 1414be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1415be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth); 1416be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth); 141771306c60Sjroman 141871306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType; 1419be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*); 1420be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning); 1421be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType); 1422be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal); 1423be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*); 142471306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType; 1425be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType); 1426be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning); 1427be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*); 142871306c60Sjroman 1429591294e4SBarry Smith EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*); 143014196391SBarry Smith EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*); 1431591294e4SBarry Smith 14320752156aSBarry Smith /* 14330a835dfdSSatish Balay If you add entries here you must also add them to finclude/petscmat.h 1434d4fbbf0eSBarry Smith */ 14351c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0, 14361c1c02c0SLois Curfman McInnes MATOP_GET_ROW=1, 14371c1c02c0SLois Curfman McInnes MATOP_RESTORE_ROW=2, 14381c1c02c0SLois Curfman McInnes MATOP_MULT=3, 14391c1c02c0SLois Curfman McInnes MATOP_MULT_ADD=4, 14407c922b88SBarry Smith MATOP_MULT_TRANSPOSE=5, 14417c922b88SBarry Smith MATOP_MULT_TRANSPOSE_ADD=6, 14421c1c02c0SLois Curfman McInnes MATOP_SOLVE=7, 14431c1c02c0SLois Curfman McInnes MATOP_SOLVE_ADD=8, 14447c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE=9, 14457c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE_ADD=10, 14461c1c02c0SLois Curfman McInnes MATOP_LUFACTOR=11, 14471c1c02c0SLois Curfman McInnes MATOP_CHOLESKYFACTOR=12, 1448a714c06dSBarry Smith MATOP_SOR=13, 14491c1c02c0SLois Curfman McInnes MATOP_TRANSPOSE=14, 14501c1c02c0SLois Curfman McInnes MATOP_GETINFO=15, 14511c1c02c0SLois Curfman McInnes MATOP_EQUAL=16, 14521c1c02c0SLois Curfman McInnes MATOP_GET_DIAGONAL=17, 14531c1c02c0SLois Curfman McInnes MATOP_DIAGONAL_SCALE=18, 14541c1c02c0SLois Curfman McInnes MATOP_NORM=19, 14551c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_BEGIN=20, 14561c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_END=21, 1457d519adbfSMatthew Knepley MATOP_SET_OPTION=22, 1458d519adbfSMatthew Knepley MATOP_ZERO_ENTRIES=23, 1459d519adbfSMatthew Knepley MATOP_ZERO_ROWS=24, 1460d519adbfSMatthew Knepley MATOP_LUFACTOR_SYMBOLIC=25, 1461d519adbfSMatthew Knepley MATOP_LUFACTOR_NUMERIC=26, 1462d519adbfSMatthew Knepley MATOP_CHOLESKY_FACTOR_SYMBOLIC=27, 1463d519adbfSMatthew Knepley MATOP_CHOLESKY_FACTOR_NUMERIC=28, 1464d519adbfSMatthew Knepley MATOP_SETUP_PREALLOCATION=29, 1465d519adbfSMatthew Knepley MATOP_ILUFACTOR_SYMBOLIC=30, 1466d519adbfSMatthew Knepley MATOP_ICCFACTOR_SYMBOLIC=31, 1467d519adbfSMatthew Knepley MATOP_GET_ARRAY=32, 1468d519adbfSMatthew Knepley MATOP_RESTORE_ARRAY=33, 1469d519adbfSMatthew Knepley MATOP_DUPLICATE=34, 1470d519adbfSMatthew Knepley MATOP_FORWARD_SOLVE=35, 1471d519adbfSMatthew Knepley MATOP_BACKWARD_SOLVE=36, 1472d519adbfSMatthew Knepley MATOP_ILUFACTOR=37, 1473d519adbfSMatthew Knepley MATOP_ICCFACTOR=38, 1474d519adbfSMatthew Knepley MATOP_AXPY=39, 1475d519adbfSMatthew Knepley MATOP_GET_SUBMATRICES=40, 1476d519adbfSMatthew Knepley MATOP_INCREASE_OVERLAP=41, 1477d519adbfSMatthew Knepley MATOP_GET_VALUES=42, 1478d519adbfSMatthew Knepley MATOP_COPY=43, 1479d519adbfSMatthew Knepley MATOP_GET_ROW_MAX=44, 1480d519adbfSMatthew Knepley MATOP_SCALE=45, 1481d519adbfSMatthew Knepley MATOP_SHIFT=46, 148235153367SBarry Smith MATOP_DIAGONAL_SET=47, 1483d519adbfSMatthew Knepley MATOP_ILUDT_FACTOR=48, 1484d519adbfSMatthew Knepley MATOP_SET_BLOCK_SIZE=49, 1485d519adbfSMatthew Knepley MATOP_GET_ROW_IJ=50, 1486d519adbfSMatthew Knepley MATOP_RESTORE_ROW_IJ=51, 1487d519adbfSMatthew Knepley MATOP_GET_COLUMN_IJ=52, 1488d519adbfSMatthew Knepley MATOP_RESTORE_COLUMN_IJ=53, 1489d519adbfSMatthew Knepley MATOP_FDCOLORING_CREATE=54, 1490d519adbfSMatthew Knepley MATOP_COLORING_PATCH=55, 1491d519adbfSMatthew Knepley MATOP_SET_UNFACTORED=56, 1492d519adbfSMatthew Knepley MATOP_PERMUTE=57, 1493d519adbfSMatthew Knepley MATOP_SET_VALUES_BLOCKED=58, 1494d519adbfSMatthew Knepley MATOP_GET_SUBMATRIX=59, 1495d519adbfSMatthew Knepley MATOP_DESTROY=60, 1496d519adbfSMatthew Knepley MATOP_VIEW=61, 1497d519adbfSMatthew Knepley MATOP_CONVERT_FROM=62, 1498d519adbfSMatthew Knepley MATOP_USE_SCALED_FORM=63, 1499d519adbfSMatthew Knepley MATOP_SCALE_SYSTEM=64, 1500d519adbfSMatthew Knepley MATOP_UNSCALE_SYSTEM=65, 1501d519adbfSMatthew Knepley MATOP_SET_LOCAL_TO_GLOBAL_MAP=66, 1502d519adbfSMatthew Knepley MATOP_SET_VALUES_LOCAL=67, 1503d519adbfSMatthew Knepley MATOP_ZERO_ROWS_LOCAL=68, 1504d519adbfSMatthew Knepley MATOP_GET_ROW_MAX_ABS=69, 1505d519adbfSMatthew Knepley MATOP_GET_ROW_MIN_ABS=70, 1506d519adbfSMatthew Knepley MATOP_CONVERT=71, 1507d519adbfSMatthew Knepley MATOP_SET_COLORING=72, 1508d519adbfSMatthew Knepley MATOP_SET_VALUES_ADIC=73, 1509d519adbfSMatthew Knepley MATOP_SET_VALUES_ADIFOR=74, 1510d519adbfSMatthew Knepley MATOP_FD_COLORING_APPLY=75, 1511d519adbfSMatthew Knepley MATOP_SET_FROM_OPTIONS=76, 1512d519adbfSMatthew Knepley MATOP_MULT_CON=77, 1513d519adbfSMatthew Knepley MATOP_MULT_TRANSPOSE_CON=78, 1514d519adbfSMatthew Knepley MATOP_PERMUTE_SPARSIFY=79, 1515d519adbfSMatthew Knepley MATOP_MULT_MULTIPLE=80, 1516d519adbfSMatthew Knepley MATOP_SOLVE_MULTIPLE=81, 1517d519adbfSMatthew Knepley MATOP_GET_INERTIA=82, 1518d519adbfSMatthew Knepley MATOP_LOAD=83, 1519d519adbfSMatthew Knepley MATOP_IS_SYMMETRIC=84, 1520d519adbfSMatthew Knepley MATOP_IS_HERMITIAN=85, 1521d519adbfSMatthew Knepley MATOP_IS_STRUCTURALLY_SYMMETRIC=86, 152241f059aeSBarry Smith MATOP_DUMMY=87, 1523d519adbfSMatthew Knepley MATOP_GET_VECS=88, 1524d519adbfSMatthew Knepley MATOP_MAT_MULT=89, 1525d519adbfSMatthew Knepley MATOP_MAT_MULT_SYMBOLIC=90, 1526d519adbfSMatthew Knepley MATOP_MAT_MULT_NUMERIC=91, 1527d519adbfSMatthew Knepley MATOP_PTAP=92, 1528d519adbfSMatthew Knepley MATOP_PTAP_SYMBOLIC=93, 1529d519adbfSMatthew Knepley MATOP_PTAP_NUMERIC=94, 1530d519adbfSMatthew Knepley MATOP_MAT_MULTTRANSPOSE=95, 15311763ac4eSSatish Balay MATOP_MAT_MULTTRANSPOSE_SYM=96, 15321763ac4eSSatish Balay MATOP_MAT_MULTTRANSPOSE_NUM=97, 1533d519adbfSMatthew Knepley MATOP_PTAP_SYMBOLIC_SEQAIJ=98, 1534d519adbfSMatthew Knepley MATOP_PTAP_NUMERIC_SEQAIJ=99, 1535d519adbfSMatthew Knepley MATOP_PTAP_SYMBOLIC_MPIAIJ=100, 1536d519adbfSMatthew Knepley MATOP_PTAP_NUMERIC_MPIAIJ=101, 1537d519adbfSMatthew Knepley MATOP_CONJUGATE=102, 1538d519adbfSMatthew Knepley MATOP_SET_SIZES=103, 1539d519adbfSMatthew Knepley MATOP_SET_VALUES_ROW=104, 1540d519adbfSMatthew Knepley MATOP_REAL_PART=105, 1541d519adbfSMatthew Knepley MATOP_IMAG_PART=106, 1542d519adbfSMatthew Knepley MATOP_GET_ROW_UTRIANGULAR=107, 1543d519adbfSMatthew Knepley MATOP_RESTORE_ROW_UTRIANGULAR=108, 1544d519adbfSMatthew Knepley MATOP_MATSOLVE=109, 1545d519adbfSMatthew Knepley MATOP_GET_REDUNDANTMATRIX=110, 1546d519adbfSMatthew Knepley MATOP_GET_ROW_MIN=111, 1547d519adbfSMatthew Knepley MATOP_GET_COLUMN_VEC=112, 1548d519adbfSMatthew Knepley MATOP_MISSING_DIAGONAL=113, 1549d519adbfSMatthew Knepley MATOP_MATGETSEQNONZEROSTRUCTURE=114, 155089c6957cSBarry Smith MATOP_CREATE=115, 155189c6957cSBarry Smith MATOP_GET_GHOSTS=116, 1552eeffb40dSHong Zhang MATOP_MULT_DIAGONAL_BLOCK=119, 1553547795f9SHong Zhang MATOP_HERMITIANTRANSPOSE=120, 1554547795f9SHong Zhang MATOP_MULTHERMITIANTRANSPOSE=121, 1555fbdbba38SShri Abhyankar MATOP_MULTHERMITIANTRANSPOSEADD=122, 1556d6037b41SHong Zhang MATOP_GETMULTIPROCBLOCK=123, 1557fae171e0SBarry Smith } MatOperation; 1558be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*); 1559be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1560be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1561be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*); 1562112a2221SBarry Smith 156390ace30eSBarry Smith /* 156490ace30eSBarry Smith Codes for matrices stored on disk. By default they are 156590ace30eSBarry Smith stored in a universal format. By changing the format with 15667973ad04SBarry Smith PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will 156790ace30eSBarry Smith be stored in a way natural for the matrix, for example dense matrices 156890ace30eSBarry Smith would be stored as dense. Matrices stored this way may only be 1569f4403165SShri Abhyankar read into matrices of the same type. 157090ace30eSBarry Smith */ 157190ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1 157290ace30eSBarry Smith 1573be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 1574be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*); 15751f4e1ec7SBarry Smith 1576d9274352SBarry Smith /*S 1577d9274352SBarry Smith MatNullSpace - Object that removes a null space from a vector, i.e. 1578d9274352SBarry Smith orthogonalizes the vector to a subsapce 1579d9274352SBarry Smith 1580f7a9e4ceSBarry Smith Level: advanced 1581d9274352SBarry Smith 1582d9274352SBarry Smith Concepts: matrix; linear operator, null space 1583d9274352SBarry Smith 15846e1639daSBarry Smith Users manual sections: 15856e1639daSBarry Smith . sec_singular 15866e1639daSBarry Smith 1587d9274352SBarry Smith .seealso: MatNullSpaceCreate() 1588d9274352SBarry Smith S*/ 158974637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace; 1590d9274352SBarry Smith 1591be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*); 1592b22b330cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*); 1593be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace); 1594be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*); 1595be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace); 159695902228SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat,PetscTruth *); 159774637425SBarry Smith 1598be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS); 1599be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1600be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 160146129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat); 16023f1d51d7SBarry Smith 1603be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*); 1604be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*); 1605be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*); 1606c4f061fbSSatish Balay 1607be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*); 1608b0a32e0cSBarry Smith 1609be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec); 161004f1ad80SBarry Smith 1611fef1beadSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 16123ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetBase(Mat,Vec,Vec); 16133ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*); 1614e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*)); 1615e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec)); 1616e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDAddNullSpace(Mat,MatNullSpace); 1617e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt); 1618e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDResetHHistory(Mat); 1619e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctionError(Mat,PetscReal); 1620e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetPeriod(Mat,PetscInt); 1621e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDGetH(Mat,PetscScalar *); 16226aa9148fSLisandro Dalcin EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetOptionsPrefix(Mat,const char[]); 1623e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFromOptions(Mat); 1624e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*); 1625e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*); 1626e884886fSBarry Smith 16276370053bSBarry Smith /*S 16286370053bSBarry Smith MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free 16296370053bSBarry Smith Jacobian vector products 1630e884886fSBarry Smith 16316370053bSBarry Smith Notes: MATMFFD is a specific MatType which uses the MatMFFD data structure 16326370053bSBarry Smith 16336370053bSBarry Smith MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure 16346370053bSBarry Smith 16356370053bSBarry Smith Level: developer 16366370053bSBarry Smith 16376370053bSBarry Smith .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister() 16386370053bSBarry Smith S*/ 1639e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD; 1640e884886fSBarry Smith 1641e884886fSBarry Smith /*E 1642e884886fSBarry Smith MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function 1643e884886fSBarry Smith 1644e884886fSBarry Smith Level: beginner 1645e884886fSBarry Smith 1646e884886fSBarry Smith .seealso: MatMFFDSetType(), MatMFFDRegister() 1647e884886fSBarry Smith E*/ 1648a313700dSBarry Smith #define MatMFFDType char* 1649e884886fSBarry Smith #define MATMFFD_DS "ds" 1650e884886fSBarry Smith #define MATMFFD_WP "wp" 1651e884886fSBarry Smith 1652a313700dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetType(Mat,const MatMFFDType); 1653e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD)); 1654e884886fSBarry Smith 1655e884886fSBarry Smith /*MC 1656e884886fSBarry Smith MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry. 1657e884886fSBarry Smith 1658e884886fSBarry Smith Synopsis: 16591890ba74SBarry Smith PetscErrorCode MatMFFDRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatMFFD)) 1660e884886fSBarry Smith 1661e884886fSBarry Smith Not Collective 1662e884886fSBarry Smith 1663e884886fSBarry Smith Input Parameters: 1664e884886fSBarry Smith + name_solver - name of a new user-defined compute-h module 1665e884886fSBarry Smith . path - path (either absolute or relative) the library containing this solver 1666e884886fSBarry Smith . name_create - name of routine to create method context 1667e884886fSBarry Smith - routine_create - routine to create method context 1668e884886fSBarry Smith 1669e884886fSBarry Smith Level: developer 1670e884886fSBarry Smith 1671e884886fSBarry Smith Notes: 1672e884886fSBarry Smith MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers. 1673e884886fSBarry Smith 1674e884886fSBarry Smith If dynamic libraries are used, then the fourth input argument (routine_create) 1675e884886fSBarry Smith is ignored. 1676e884886fSBarry Smith 1677e884886fSBarry Smith Sample usage: 1678e884886fSBarry Smith .vb 1679e884886fSBarry Smith MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a, 1680e884886fSBarry Smith "MyHCreate",MyHCreate); 1681e884886fSBarry Smith .ve 1682e884886fSBarry Smith 1683e884886fSBarry Smith Then, your solver can be chosen with the procedural interface via 1684e884886fSBarry Smith $ MatMFFDSetType(mfctx,"my_h") 1685e884886fSBarry Smith or at runtime via the option 1686e884886fSBarry Smith $ -snes_mf_type my_h 1687e884886fSBarry Smith 1688e884886fSBarry Smith .keywords: MatMFFD, register 1689e884886fSBarry Smith 1690e884886fSBarry Smith .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy() 1691e884886fSBarry Smith M*/ 1692e884886fSBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1693e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0) 1694e884886fSBarry Smith #else 1695e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d) 1696e884886fSBarry Smith #endif 1697e884886fSBarry Smith 1698e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterAll(const char[]); 1699e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterDestroy(void); 17001d0fab5eSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDDSSetUmin(Mat,PetscReal); 1701e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDWPSetComputeNormU(Mat,PetscTruth); 1702e884886fSBarry Smith 1703e884886fSBarry Smith 1704be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1705be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 17067dbadf16SMatthew Knepley 170797969023SHong Zhang /* 170897969023SHong Zhang PETSc interface to MUMPS 170997969023SHong Zhang */ 171097969023SHong Zhang #ifdef PETSC_HAVE_MUMPS 1711a1f19f5aSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetMumpsIcntl(Mat,PetscInt,PetscInt); 171297969023SHong Zhang #endif 171323a5497aSJed Brown 171423a5497aSJed Brown PETSC_EXTERN_CXX_END 171523a5497aSJed Brown #endif 1716