xref: /petsc/include/petscmat.h (revision 99cafbc1c8410a2bf5238b670f881971629abfd8)
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 
27d9274352SBarry Smith .seealso: MatSetType(), Mat
28d91e6319SBarry Smith E*/
29273d9f13SBarry Smith #define MATSAME            "same"
30273d9f13SBarry Smith #define MATSEQMAIJ         "seqmaij"
31273d9f13SBarry Smith #define MATMPIMAIJ         "mpimaij"
32209238afSKris Buschelman #define MATMAIJ            "maij"
33273d9f13SBarry Smith #define MATIS              "is"
34273d9f13SBarry Smith #define MATMPIROWBS        "mpirowbs"
35273d9f13SBarry Smith #define MATSEQAIJ          "seqaij"
36273d9f13SBarry Smith #define MATMPIAIJ          "mpiaij"
37209238afSKris Buschelman #define MATAIJ             "aij"
38273d9f13SBarry Smith #define MATSHELL           "shell"
39273d9f13SBarry Smith #define MATSEQBDIAG        "seqbdiag"
40273d9f13SBarry Smith #define MATMPIBDIAG        "mpibdiag"
41209238afSKris Buschelman #define MATBDIAG           "bdiag"
42209238afSKris Buschelman #define MATSEQDENSE        "seqdense"
43273d9f13SBarry Smith #define MATMPIDENSE        "mpidense"
44209238afSKris Buschelman #define MATDENSE           "dense"
45273d9f13SBarry Smith #define MATSEQBAIJ         "seqbaij"
46273d9f13SBarry Smith #define MATMPIBAIJ         "mpibaij"
47209238afSKris Buschelman #define MATBAIJ            "baij"
48273d9f13SBarry Smith #define MATMPIADJ          "mpiadj"
49273d9f13SBarry Smith #define MATSEQSBAIJ        "seqsbaij"
50273d9f13SBarry Smith #define MATMPISBAIJ        "mpisbaij"
51209238afSKris Buschelman #define MATSBAIJ           "sbaij"
52cebc7f6cSBarry Smith #define MATDAAD            "daad"
53cebc7f6cSBarry Smith #define MATMFFD            "mffd"
54c8a8475eSBarry Smith #define MATNORMAL          "normal"
55ab92ecdeSBarry Smith #define MATLRC             "lrc"
56b3a1e11cSKris Buschelman #define MATSEQAIJSPOOLES   "seqaijspooles"
57d10c748bSKris Buschelman #define MATMPIAIJSPOOLES   "mpiaijspooles"
589abb65ffSKris Buschelman #define MATSEQSBAIJSPOOLES "seqsbaijspooles"
5922191285SKris Buschelman #define MATMPISBAIJSPOOLES "mpisbaijspooles"
60bb4d4166SHong Zhang #define MATAIJSPOOLES      "aijspooles"
61bb4d4166SHong Zhang #define MATSBAIJSPOOLES    "sbaijspooles"
6214b396bbSKris Buschelman #define MATSUPERLU         "superlu"
631d96aa28SKris Buschelman #define MATSUPERLU_DIST    "superlu_dist"
641677d0b8SKris Buschelman #define MATUMFPACK         "umfpack"
65e8aa55a4SKris Buschelman #define MATESSL            "essl"
664eb8e494SKris Buschelman #define MATLUSOL           "lusol"
67397b6df1SKris Buschelman #define MATAIJMUMPS        "aijmumps"
68397b6df1SKris Buschelman #define MATSBAIJMUMPS      "sbaijmumps"
698da957c5SKris Buschelman #define MATDSCPACK         "dscpack"
707065e2aaSKris Buschelman #define MATMATLAB          "matlab"
714b8d99adSRichard Tran Mills #define MATSEQCSRPERM      "seqcsrperm"
7218def556SRichard Tran Mills #define MATMPICSRPERM      "mpicsrperm"
73814655b8SBarry Smith #define MATCSRPERM         "csrperm"
74c0aa2d19SHong Zhang #define MATPLAPACK         "plapack"
75f69a0ea3SMatthew Knepley #define MatType const char*
76d91e6319SBarry Smith 
77c06d978dSMatthew Knepley /* Logging support */
78552e946dSBarry Smith #define    MAT_FILE_COOKIE 1211216    /* used to indicate matrices in binary files */
79be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_COOKIE;
80be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_FDCOLORING_COOKIE;
81be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_PARTITIONING_COOKIE;
82be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_NULLSPACE_COOKIE;
836849ba73SBarry Smith extern PetscEvent  MAT_Mult, MAT_MultMatrixFree, MAT_Mults, MAT_MultConstrained, MAT_MultAdd, MAT_MultTranspose;
846849ba73SBarry Smith extern PetscEvent  MAT_MultTransposeConstrained, MAT_MultTransposeAdd, MAT_Solve, MAT_Solves, MAT_SolveAdd, MAT_SolveTranspose;
856849ba73SBarry Smith extern PetscEvent  MAT_SolveTransposeAdd, MAT_Relax, MAT_ForwardSolve, MAT_BackwardSolve, MAT_LUFactor, MAT_LUFactorSymbolic;
866849ba73SBarry Smith extern PetscEvent  MAT_LUFactorNumeric, MAT_CholeskyFactor, MAT_CholeskyFactorSymbolic, MAT_CholeskyFactorNumeric, MAT_ILUFactor;
876849ba73SBarry Smith extern PetscEvent  MAT_ILUFactorSymbolic, MAT_ICCFactorSymbolic, MAT_Copy, MAT_Convert, MAT_Scale, MAT_AssemblyBegin;
886849ba73SBarry Smith extern PetscEvent  MAT_AssemblyEnd, MAT_SetValues, MAT_GetValues, MAT_GetRow, MAT_GetSubMatrices, MAT_GetColoring, MAT_GetOrdering;
896849ba73SBarry Smith extern PetscEvent  MAT_IncreaseOverlap, MAT_Partitioning, MAT_ZeroEntries, MAT_Load, MAT_View, MAT_AXPY, MAT_FDColoringCreate;
906849ba73SBarry Smith extern PetscEvent  MAT_FDColoringApply, MAT_Transpose, MAT_FDColoringFunction;
91cb00f407SKris Buschelman extern PetscEvent  MAT_MatMult, MAT_MatMultSymbolic, MAT_MatMultNumeric;
92534c1384SKris Buschelman extern PetscEvent  MAT_PtAP, MAT_PtAPSymbolic, MAT_PtAPNumeric;
93bc011b1eSHong Zhang extern PetscEvent  MAT_MatMultTranspose, MAT_MatMultTransposeSymbolic, MAT_MatMultTransposeNumeric;
94c06d978dSMatthew Knepley 
95ceb03754SKris Buschelman /*E
96ceb03754SKris Buschelman     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
97ceb03754SKris Buschelman      or MatGetSubMatrix() are to be reused to store the new matrix values.
98ceb03754SKris Buschelman 
99ceb03754SKris Buschelman     Level: beginner
100ceb03754SKris Buschelman 
101ceb03754SKris Buschelman    Any additions/changes here MUST also be made in include/finclude/petscmat.h
102ceb03754SKris Buschelman 
1030c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
104ceb03754SKris Buschelman E*/
105ceb03754SKris Buschelman typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX} MatReuse;
106ceb03754SKris Buschelman 
107be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(char *);
108c06d978dSMatthew Knepley 
109f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*);
110ba966639SSatish Balay PetscPolymorphicFunction(MatCreate,(MPI_Comm comm,void *ctx),(comm,&A),Mat,A)
111ba966639SSatish Balay PetscPolymorphicFunction(MatCreate,(void *ctx),(PETSC_COMM_WORLD,&A),Mat,A)
112f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
113f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,MatType);
114be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat);
115be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat);
116be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
117be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
11830de9b25SBarry Smith 
119f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]);
120f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]);
121f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]);
122f69a0ea3SMatthew Knepley 
12330de9b25SBarry Smith /*MC
12430de9b25SBarry Smith    MatRegisterDynamic - Adds a new matrix type
12530de9b25SBarry Smith 
12630de9b25SBarry Smith    Synopsis:
127c1ac3661SBarry Smith    PetscErrorCode MatRegisterDynamic(char *name,char *path,char *name_create,PetscErrorCode (*routine_create)(Mat))
12830de9b25SBarry Smith 
12930de9b25SBarry Smith    Not Collective
13030de9b25SBarry Smith 
13130de9b25SBarry Smith    Input Parameters:
13230de9b25SBarry Smith +  name - name of a new user-defined matrix type
13330de9b25SBarry Smith .  path - path (either absolute or relative) the library containing this solver
13430de9b25SBarry Smith .  name_create - name of routine to create method context
13530de9b25SBarry Smith -  routine_create - routine to create method context
13630de9b25SBarry Smith 
13730de9b25SBarry Smith    Notes:
13830de9b25SBarry Smith    MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
13930de9b25SBarry Smith 
14030de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
14130de9b25SBarry Smith    is ignored.
14230de9b25SBarry Smith 
14330de9b25SBarry Smith    Sample usage:
14430de9b25SBarry Smith .vb
14530de9b25SBarry Smith    MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
14630de9b25SBarry Smith                "MyMatCreate",MyMatCreate);
14730de9b25SBarry Smith .ve
14830de9b25SBarry Smith 
14930de9b25SBarry Smith    Then, your solver can be chosen with the procedural interface via
15030de9b25SBarry Smith $     MatSetType(Mat,"my_mat")
15130de9b25SBarry Smith    or at runtime via the option
15230de9b25SBarry Smith $     -mat_type my_mat
15330de9b25SBarry Smith 
15430de9b25SBarry Smith    Level: advanced
15530de9b25SBarry Smith 
156ab901514SBarry Smith    Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
15730de9b25SBarry Smith          If your function is not being put into a shared library then use VecRegister() instead
15830de9b25SBarry Smith 
15930de9b25SBarry Smith .keywords: Mat, register
16030de9b25SBarry Smith 
16130de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy()
16230de9b25SBarry Smith 
16330de9b25SBarry Smith M*/
164273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
165273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
166273d9f13SBarry Smith #else
167273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
16830de9b25SBarry Smith #endif
16930de9b25SBarry Smith 
170273d9f13SBarry Smith extern PetscTruth MatRegisterAllCalled;
171b0a32e0cSBarry Smith extern PetscFList MatList;
17228988994SBarry Smith 
173be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
174be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
175be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
176ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A)
177ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A)
178ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A)
179ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A)
180ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A))
181ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A))
182ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A))
183be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
184ba966639SSatish 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)
185ba966639SSatish 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)
186ba966639SSatish 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)
187ba966639SSatish 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)
188ba966639SSatish 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))
189ba966639SSatish 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))
190ba966639SSatish 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))
191ba966639SSatish 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)
192ba966639SSatish 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)
193ba966639SSatish 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)
194ba966639SSatish 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)
195ba966639SSatish 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))
196ba966639SSatish 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))
197ba966639SSatish 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))
198be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIRowbs(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
199be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*);
200be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*);
201be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
202ba966639SSatish 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)
203ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
204ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
205ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
206ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
207ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
208ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
209be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
210ba966639SSatish 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)
211ba966639SSatish 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)
212ba966639SSatish 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)
213ba966639SSatish 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)
214ba966639SSatish 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))
215ba966639SSatish 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))
216ba966639SSatish 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))
217ba966639SSatish 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)
218ba966639SSatish 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)
219ba966639SSatish 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)
220ba966639SSatish 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)
221ba966639SSatish 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))
222ba966639SSatish 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))
223ba966639SSatish 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))
224be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
225be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
226ba966639SSatish 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)
227ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
228ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
229ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
230ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
231ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
232ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
233be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
234ba966639SSatish 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)
235ba966639SSatish 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)
236ba966639SSatish 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)
237ba966639SSatish 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)
238ba966639SSatish 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))
239ba966639SSatish 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))
240ba966639SSatish 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))
241ba966639SSatish 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)
242ba966639SSatish 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)
243ba966639SSatish 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)
244ba966639SSatish 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)
245ba966639SSatish 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))
246ba966639SSatish 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))
247ba966639SSatish 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))
248be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
249ba966639SSatish 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)
250ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A)
251be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
252be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*);
253ba966639SSatish Balay PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A)
254ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*);
255284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
256f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat);
257be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat);
25821c89e3eSBarry Smith 
259be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPrintHelp(Mat);
260be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetPetscMaps(Mat,PetscMap*,PetscMap*);
261ec0117caSBarry Smith 
2620c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat);
263*99cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat);
264*99cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat);
265*99cafbc1SBarry Smith 
2668ed539a5SBarry Smith /* ------------------------------------------------------------*/
267be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
268be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
26987d4246cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
270f259bd47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
27184cb2905SBarry Smith 
2722ef4de8bSBarry Smith /*S
2732ef4de8bSBarry Smith      MatStencil - Data structure (C struct) for storing information about a single row or
2742ef4de8bSBarry Smith         column of a matrix as index on an associated grid.
2752ef4de8bSBarry Smith 
2762ef4de8bSBarry Smith    Level: beginner
2772ef4de8bSBarry Smith 
2782ef4de8bSBarry Smith   Concepts: matrix; linear operator
2792ef4de8bSBarry Smith 
280d7bd93baSBarry Smith .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
2812ef4de8bSBarry Smith S*/
282435da068SBarry Smith typedef struct {
283c1ac3661SBarry Smith   PetscInt k,j,i,c;
284435da068SBarry Smith } MatStencil;
2852ef4de8bSBarry Smith 
286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
287be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
288be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
289435da068SBarry Smith 
290be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring);
291be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*);
292be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*);
2933a7fca6bSBarry Smith 
294d91e6319SBarry Smith /*E
295d91e6319SBarry Smith     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
296d91e6319SBarry Smith      to continue to add values to it
297d91e6319SBarry Smith 
298d91e6319SBarry Smith     Level: beginner
299d91e6319SBarry Smith 
300d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd()
301d91e6319SBarry Smith E*/
3026d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
303be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType);
304be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType);
305be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*);
3064f9c727eSBarry Smith 
307be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt    MatSetValue_Row;
308be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt    MatSetValue_Column;
309be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscScalar MatSetValue_Value;
3101d73ed98SBarry Smith 
31130de9b25SBarry Smith /*MC
31230de9b25SBarry Smith    MatSetValue - Set a single entry into a matrix.
31330de9b25SBarry Smith 
31430de9b25SBarry Smith    Synopsis:
315c1ac3661SBarry Smith    PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode);
31630de9b25SBarry Smith 
31730de9b25SBarry Smith    Not collective
31830de9b25SBarry Smith 
31930de9b25SBarry Smith    Input Parameters:
32030de9b25SBarry Smith +  m - the matrix
32130de9b25SBarry Smith .  row - the row location of the entry
32230de9b25SBarry Smith .  col - the column location of the entry
32330de9b25SBarry Smith .  value - the value to insert
32430de9b25SBarry Smith -  mode - either INSERT_VALUES or ADD_VALUES
32530de9b25SBarry Smith 
32630de9b25SBarry Smith    Notes:
32730de9b25SBarry Smith    For efficiency one should use MatSetValues() and set several or many
32830de9b25SBarry Smith    values simultaneously if possible.
32930de9b25SBarry Smith 
33030de9b25SBarry Smith    Level: beginner
33130de9b25SBarry Smith 
33230de9b25SBarry Smith .seealso: MatSetValues(), MatSetValueLocal()
33330de9b25SBarry Smith M*/
334b951964fSBarry Smith #define MatSetValue(v,i,j,va,mode) \
335f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \
3361d73ed98SBarry Smith    MatSetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode))
33730de9b25SBarry Smith 
338ea06a074SBarry Smith #define MatGetValue(v,i,j,va) \
339f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,0) || \
3401d73ed98SBarry Smith    MatGetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&va))
34130de9b25SBarry Smith 
342d91e6319SBarry Smith #define MatSetValueLocal(v,i,j,va,mode) \
343f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \
3441d73ed98SBarry Smith    MatSetValuesLocal(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode))
34530de9b25SBarry Smith 
346d91e6319SBarry Smith /*E
347d91e6319SBarry Smith     MatOption - Options that may be set for a matrix and its behavior or storage
348d91e6319SBarry Smith 
349d91e6319SBarry Smith     Level: beginner
350d91e6319SBarry Smith 
3510a835dfdSSatish Balay    Any additions/changes here MUST also be made in include/finclude/petscmat.h
352d91e6319SBarry Smith 
353d91e6319SBarry Smith .seealso: MatSetOption()
354d91e6319SBarry Smith E*/
3556d4a8577SBarry Smith typedef enum {MAT_ROW_ORIENTED=1,MAT_COLUMN_ORIENTED=2,MAT_ROWS_SORTED=4,
3566d4a8577SBarry Smith               MAT_COLUMNS_SORTED=8,MAT_NO_NEW_NONZERO_LOCATIONS=16,
3576d4a8577SBarry Smith               MAT_YES_NEW_NONZERO_LOCATIONS=32,MAT_SYMMETRIC=64,
3586ca9ecd3SBarry Smith               MAT_STRUCTURALLY_SYMMETRIC=65,MAT_NO_NEW_DIAGONALS=66,
3596ca9ecd3SBarry Smith               MAT_YES_NEW_DIAGONALS=67,MAT_INODE_LIMIT_1=68,MAT_INODE_LIMIT_2=69,
3606ca9ecd3SBarry Smith               MAT_INODE_LIMIT_3=70,MAT_INODE_LIMIT_4=71,MAT_INODE_LIMIT_5=72,
3616ca9ecd3SBarry Smith               MAT_IGNORE_OFF_PROC_ENTRIES=73,MAT_ROWS_UNSORTED=74,
3624787f768SSatish Balay               MAT_COLUMNS_UNSORTED=75,MAT_NEW_NONZERO_LOCATION_ERR=76,
3637c922b88SBarry Smith               MAT_NEW_NONZERO_ALLOCATION_ERR=77,MAT_USE_HASH_TABLE=78,
3642bad1931SBarry Smith               MAT_KEEP_ZEROED_ROWS=79,MAT_IGNORE_ZERO_ENTRIES=80,MAT_USE_INODES=81,
365efcf0fc3SBarry Smith               MAT_DO_NOT_USE_INODES=82,MAT_NOT_SYMMETRIC=83,MAT_HERMITIAN=84,
3669a4540c5SBarry Smith               MAT_NOT_STRUCTURALLY_SYMMETRIC=85,MAT_NOT_HERMITIAN=86,
367d487561eSHong Zhang               MAT_SYMMETRY_ETERNAL=87,MAT_NOT_SYMMETRY_ETERNAL=88,
368941593c8SHong Zhang               MAT_USE_COMPRESSEDROW=89,MAT_DO_NOT_USE_COMPRESSEDROW=90,
369941593c8SHong Zhang               MAT_IGNORE_LOWER_TRIANGULAR=91,MAT_ERROR_LOWER_TRIANGULAR=92} MatOption;
370be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption);
371be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,MatType*);
372ba966639SSatish Balay PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),MatType,t)
37384cb2905SBarry Smith 
374be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
375be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
376be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
377be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
378be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
379be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt);
380be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]);
381ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
382be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]);
383be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *);
384ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
385be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt);
3867b80b807SBarry Smith 
387be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec);
388be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec);
389ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
390be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec);
391be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*);
392ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t)
393ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0.0,&t),PetscTruth,t)
394be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec);
395ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
396be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec);
397be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec);
3982eac72dbSBarry Smith 
399d91e6319SBarry Smith /*E
400d91e6319SBarry Smith     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
401d91e6319SBarry Smith   its numerical values copied over or just its nonzero structure.
402d91e6319SBarry Smith 
403d91e6319SBarry Smith     Level: beginner
404d91e6319SBarry Smith 
405d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
406d91e6319SBarry Smith 
407d91e6319SBarry Smith .seealso: MatDuplicate()
408d91e6319SBarry Smith E*/
4092e8a6d31SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES} MatDuplicateOption;
4102e8a6d31SBarry Smith 
411be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegister(const char[],const char[],const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat*));
412273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
413273d9f13SBarry Smith #define MatConvertRegisterDynamic(a,b,c,d) MatConvertRegister(a,b,c,0)
414273d9f13SBarry Smith #else
415273d9f13SBarry Smith #define MatConvertRegisterDynamic(a,b,c,d) MatConvertRegister(a,b,c,d)
416273d9f13SBarry Smith #endif
417be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegisterAll(const char[]);
418be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegisterDestroy(void);
419273d9f13SBarry Smith extern PetscTruth MatConvertRegisterAllCalled;
420b0a32e0cSBarry Smith extern PetscFList MatConvertList;
421f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,MatType,MatReuse,Mat*);
422ba966639SSatish Balay PetscPolymorphicFunction(MatConvert,(Mat A,MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a)
423be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*);
424ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a)
425ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a)
42694a9d846SBarry Smith 
427d91e6319SBarry Smith /*E
428d91e6319SBarry Smith     MatStructure - Indicates if the matrix has the same nonzero structure
429d91e6319SBarry Smith 
430d91e6319SBarry Smith     Level: beginner
431d91e6319SBarry Smith 
432d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
433d91e6319SBarry Smith 
43494b7f48cSBarry Smith .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
435d91e6319SBarry Smith E*/
436c537a176SHong Zhang typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure;
437cb5b572fSBarry Smith 
438be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure);
439be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer);
440be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*);
441ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t)
442ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0.0,&t),PetscTruth,t)
443be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*);
444ba966639SSatish Balay PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t)
445be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscTruth*);
446ba966639SSatish Balay PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,&t),PetscTruth,t)
447be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*);
448be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*);
449f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(PetscViewer,MatType,Mat*);
450ba966639SSatish Balay PetscPolymorphicFunction(MatLoad,(PetscViewer v,MatType t),(v,t,&a),Mat,a)
4517b80b807SBarry Smith 
452be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
453be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
454be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
455be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
456d4fbbf0eSBarry Smith 
457d91e6319SBarry Smith /*S
458d91e6319SBarry Smith      MatInfo - Context of matrix information, used with MatGetInfo()
459d91e6319SBarry Smith 
460d91e6319SBarry Smith    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
461d91e6319SBarry Smith 
462d91e6319SBarry Smith    Level: intermediate
463d91e6319SBarry Smith 
464d91e6319SBarry Smith   Concepts: matrix^nonzero information
465d91e6319SBarry Smith 
466d9274352SBarry Smith .seealso:  MatGetInfo(), MatInfoType
467d91e6319SBarry Smith S*/
4684e220ebcSLois Curfman McInnes typedef struct {
469b0a32e0cSBarry Smith   PetscLogDouble rows_global,columns_global;         /* number of global rows and columns */
470b0a32e0cSBarry Smith   PetscLogDouble rows_local,columns_local;           /* number of local rows and columns */
471b0a32e0cSBarry Smith   PetscLogDouble block_size;                         /* block size */
472b0a32e0cSBarry Smith   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
473b0a32e0cSBarry Smith   PetscLogDouble memory;                             /* memory allocated */
474b0a32e0cSBarry Smith   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
475b0a32e0cSBarry Smith   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
476b0a32e0cSBarry Smith   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
477b0a32e0cSBarry Smith   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
4784e220ebcSLois Curfman McInnes } MatInfo;
4794e220ebcSLois Curfman McInnes 
480d9274352SBarry Smith /*E
481d9274352SBarry Smith     MatInfoType - Indicates if you want information about the local part of the matrix,
482d9274352SBarry Smith      the entire parallel matrix or the maximum over all the local parts.
483d9274352SBarry Smith 
484d9274352SBarry Smith     Level: beginner
485d9274352SBarry Smith 
486d9274352SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
487d9274352SBarry Smith 
488d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo
489d9274352SBarry Smith E*/
4907b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
491be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*);
492be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatValid(Mat,PetscTruth*);
493be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec);
494be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec);
495be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,Mat*);
496ba966639SSatish Balay PetscPolymorphicFunction(MatTranspose,(Mat A),(A,&t),Mat,t)
497be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *);
498ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
499be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
500be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec);
501be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode);
502be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*);
503ba966639SSatish Balay PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t)
504be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*);
505be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*);
506be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*);
507be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*);
5087b80b807SBarry Smith 
509be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *);
510ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
511be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat);
512f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar);
513f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar);
514f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*);
515f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*);
5167b80b807SBarry Smith 
517be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth);
518be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec);
519be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec);
5205ef9f2a5SBarry Smith 
521be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*);
522be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*);
523be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
5247b80b807SBarry Smith 
525be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
526be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]);
527be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,PetscInt,MatReuse,Mat *);
528abf0e977SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrixRaw(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt,MatReuse,Mat *);
529be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
530be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
531be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
532be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat);
533be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat);
534be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*);
535be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
536be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
537be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscScalar**,Mat*);
53843eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE)
539cd116e26SSatish Balay #include "petscctable.h"
54043eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
54143eb5e2fSMatthew Knepley #else
54243eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
54343eb5e2fSMatthew Knepley #endif
5448efafbd8SBarry Smith 
545be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
5467b80b807SBarry Smith 
547be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
548be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
549be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat);
55022440eb1SKris Buschelman 
551be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
552be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
553be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat);
55422440eb1SKris Buschelman 
555be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
556be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
557be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat);
558bc011b1eSHong Zhang 
559f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure);
560f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat);
561be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompress(Mat);
5621c741599SHong Zhang 
563f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar);
564f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar);
5657b80b807SBarry Smith 
566be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
567be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
568f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar);
569f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar);
570be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
571be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
572052efed2SBarry Smith 
573be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt);
574be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
57590f02eecSBarry Smith 
576be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec);
5770c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec);
578ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
579be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec);
580be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*);
581bd481603SBarry Smith 
582bd481603SBarry Smith /*MC
583bd481603SBarry Smith    MatPreallocInitialize - Begins the block of code that will count the number of nonzeros per
584bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
585bd481603SBarry Smith 
586bd481603SBarry Smith    Synopsis:
587c1ac3661SBarry Smith    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
588bd481603SBarry Smith 
589bd481603SBarry Smith    Collective on MPI_Comm
590bd481603SBarry Smith 
591bd481603SBarry Smith    Input Parameters:
592bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
593859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
594859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
595bd481603SBarry Smith 
596bd481603SBarry Smith    Output Parameters:
597bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
598bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
599bd481603SBarry Smith 
600bd481603SBarry Smith 
601bd481603SBarry Smith    Level: intermediate
602bd481603SBarry Smith 
603bd481603SBarry Smith    Notes:
604bd481603SBarry Smith    See the chapter in the users manual on performance for more details
605bd481603SBarry Smith 
6061d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
607bd481603SBarry Smith 
608bd481603SBarry Smith    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
609bd481603SBarry Smith 
610bd481603SBarry Smith   Concepts: preallocation^Matrix
611bd481603SBarry Smith 
612bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
613bd481603SBarry Smith           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
614bd481603SBarry Smith M*/
615c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
6167c922b88SBarry Smith { \
617c1ac3661SBarry Smith   PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
618c1ac3661SBarry Smith   _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\
619c1ac3661SBarry Smith   _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\
620c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
621c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp;
6227c922b88SBarry Smith 
623bd481603SBarry Smith /*MC
624bd481603SBarry Smith    MatPreallocSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
625bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
626bd481603SBarry Smith 
627bd481603SBarry Smith    Synopsis:
628c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
629bd481603SBarry Smith 
630bd481603SBarry Smith    Collective on MPI_Comm
631bd481603SBarry Smith 
632bd481603SBarry Smith    Input Parameters:
633bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
634859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
635859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
636bd481603SBarry Smith 
637bd481603SBarry Smith    Output Parameters:
638bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
639bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
640bd481603SBarry Smith 
641bd481603SBarry Smith 
642bd481603SBarry Smith    Level: intermediate
643bd481603SBarry Smith 
644bd481603SBarry Smith    Notes:
645bd481603SBarry Smith    See the chapter in the users manual on performance for more details
646bd481603SBarry Smith 
6471d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
648bd481603SBarry Smith 
649bd481603SBarry Smith   Concepts: preallocation^Matrix
650bd481603SBarry Smith 
651bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
652bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
653bd481603SBarry Smith M*/
654222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
655222b16d4SBarry Smith { \
656c1ac3661SBarry Smith   PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__end; \
657c1ac3661SBarry Smith   _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\
658c1ac3661SBarry Smith   _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\
659c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
660c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp;
661222b16d4SBarry Smith 
662bd481603SBarry Smith /*MC
663bd481603SBarry Smith    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
664bd481603SBarry Smith        inserted using a local number of the rows and columns
665bd481603SBarry Smith 
666bd481603SBarry Smith    Synopsis:
667c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
668bd481603SBarry Smith 
669bd481603SBarry Smith    Not Collective
670bd481603SBarry Smith 
671bd481603SBarry Smith    Input Parameters:
672bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
673bd481603SBarry Smith .  nrows - the number of rows indicated
6741d73ed98SBarry Smith .  rows - the indices of the rows
675bd481603SBarry Smith .  ncols - the number of columns in the matrix
676bd481603SBarry Smith .  cols - the columns indicated
677bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
678bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
679bd481603SBarry Smith 
680bd481603SBarry Smith 
681bd481603SBarry Smith    Level: intermediate
682bd481603SBarry Smith 
683bd481603SBarry Smith    Notes:
684bd481603SBarry Smith    See the chapter in the users manual on performance for more details
685bd481603SBarry Smith 
6861d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
687bd481603SBarry Smith 
688bd481603SBarry Smith   Concepts: preallocation^Matrix
689bd481603SBarry Smith 
690bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
691bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
692bd481603SBarry Smith M*/
693c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
694c4f061fbSSatish Balay {\
695c1ac3661SBarry Smith   PetscInt __l;\
696ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
697ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
698c4f061fbSSatish Balay   for (__l=0;__l<nrows;__l++) {\
699ef66eb69SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
700c4f061fbSSatish Balay   }\
701c4f061fbSSatish Balay }
702c4f061fbSSatish Balay 
703bd481603SBarry Smith /*MC
704bd481603SBarry Smith    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
705bd481603SBarry Smith        inserted using a local number of the rows and columns
706bd481603SBarry Smith 
707bd481603SBarry Smith    Synopsis:
708c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
709bd481603SBarry Smith 
710bd481603SBarry Smith    Not Collective
711bd481603SBarry Smith 
712bd481603SBarry Smith    Input Parameters:
713bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
714bd481603SBarry Smith .  nrows - the number of rows indicated
7151d73ed98SBarry Smith .  rows - the indices of the rows
716bd481603SBarry Smith .  ncols - the number of columns in the matrix
717bd481603SBarry Smith .  cols - the columns indicated
718bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
719bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
720bd481603SBarry Smith 
721bd481603SBarry Smith 
722bd481603SBarry Smith    Level: intermediate
723bd481603SBarry Smith 
724bd481603SBarry Smith    Notes:
725bd481603SBarry Smith    See the chapter in the users manual on performance for more details
726bd481603SBarry Smith 
727bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
728bd481603SBarry Smith 
729bd481603SBarry Smith   Concepts: preallocation^Matrix
730bd481603SBarry Smith 
731bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
732bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
733bd481603SBarry Smith M*/
734d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
735d3d32019SBarry Smith {\
736c1ac3661SBarry Smith   PetscInt __l;\
737d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
738d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
739d3d32019SBarry Smith   for (__l=0;__l<nrows;__l++) {\
740d3d32019SBarry Smith     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
741d3d32019SBarry Smith   }\
742d3d32019SBarry Smith }
743d3d32019SBarry Smith 
744bd481603SBarry Smith /*MC
745bd481603SBarry Smith    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
746bd481603SBarry Smith        inserted using a local number of the rows and columns
747bd481603SBarry Smith 
748bd481603SBarry Smith    Synopsis:
749c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
750bd481603SBarry Smith 
751bd481603SBarry Smith    Not Collective
752bd481603SBarry Smith 
753bd481603SBarry Smith    Input Parameters:
754bd481603SBarry Smith +  nrows - the number of rows indicated
7551d73ed98SBarry Smith .  rows - the indices of the rows
756bd481603SBarry Smith .  ncols - the number of columns in the matrix
757a50f8bf6SHong Zhang -  cols - the columns indicated
758a50f8bf6SHong Zhang 
759a50f8bf6SHong Zhang    Output Parameters:
760a50f8bf6SHong Zhang +  dnz - the array that will be passed to the matrix preallocation routines
761bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
762bd481603SBarry Smith 
763bd481603SBarry Smith 
764bd481603SBarry Smith    Level: intermediate
765bd481603SBarry Smith 
766bd481603SBarry Smith    Notes:
767bd481603SBarry Smith    See the chapter in the users manual on performance for more details
768bd481603SBarry Smith 
769bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
770bd481603SBarry Smith 
771bd481603SBarry Smith   Concepts: preallocation^Matrix
772bd481603SBarry Smith 
773bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
774bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
775bd481603SBarry Smith M*/
776c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
777c1ac3661SBarry Smith { PetscInt __i; \
7787c922b88SBarry Smith   for (__i=0; __i<nc; __i++) {\
7797c922b88SBarry Smith     if (cols[__i] < __start || cols[__i] >= __end) onz[row - __rstart]++; \
7807c922b88SBarry Smith   }\
7817c922b88SBarry Smith   dnz[row - __rstart] = nc - onz[row - __rstart];\
7827c922b88SBarry Smith }
7837c922b88SBarry Smith 
784bd481603SBarry Smith /*MC
785bd481603SBarry Smith    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
786bd481603SBarry Smith        inserted using a local number of the rows and columns
787bd481603SBarry Smith 
788bd481603SBarry Smith    Synopsis:
789c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
790bd481603SBarry Smith 
791bd481603SBarry Smith    Not Collective
792bd481603SBarry Smith 
793bd481603SBarry Smith    Input Parameters:
794bd481603SBarry Smith +  nrows - the number of rows indicated
7951d73ed98SBarry Smith .  rows - the indices of the rows
796bd481603SBarry Smith .  ncols - the number of columns in the matrix
797bd481603SBarry Smith .  cols - the columns indicated
798bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
799bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
800bd481603SBarry Smith 
801bd481603SBarry Smith 
802bd481603SBarry Smith    Level: intermediate
803bd481603SBarry Smith 
804bd481603SBarry Smith    Notes:
805bd481603SBarry Smith    See the chapter in the users manual on performance for more details
806bd481603SBarry Smith 
807bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
808bd481603SBarry Smith 
809bd481603SBarry Smith   Concepts: preallocation^Matrix
810bd481603SBarry Smith 
811bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
812bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
813bd481603SBarry Smith M*/
814d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
815c1ac3661SBarry Smith { PetscInt __i; \
816d3d32019SBarry Smith   for (__i=0; __i<nc; __i++) {\
817d3d32019SBarry Smith     if (cols[__i] >= __end) onz[row - __rstart]++; \
818d3d32019SBarry Smith     else if (cols[__i] >= row) dnz[row - __rstart]++;\
819d3d32019SBarry Smith   }\
820d3d32019SBarry Smith }
821d3d32019SBarry Smith 
822bd481603SBarry Smith /*MC
823bd481603SBarry Smith    MatPreallocFinalize - Ends the block of code that will count the number of nonzeros per
824bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
825bd481603SBarry Smith 
826bd481603SBarry Smith    Synopsis:
827c1ac3661SBarry Smith    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
828bd481603SBarry Smith 
829bd481603SBarry Smith    Collective on MPI_Comm
830bd481603SBarry Smith 
831bd481603SBarry Smith    Input Parameters:
832bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
833bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
834bd481603SBarry Smith 
835bd481603SBarry Smith 
836bd481603SBarry Smith    Level: intermediate
837bd481603SBarry Smith 
838bd481603SBarry Smith    Notes:
839bd481603SBarry Smith    See the chapter in the users manual on performance for more details
840bd481603SBarry Smith 
841bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
842bd481603SBarry Smith 
843bd481603SBarry Smith   Concepts: preallocation^Matrix
844bd481603SBarry Smith 
845bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
846bd481603SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
847bd481603SBarry Smith M*/
848ef66eb69SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree(dnz);CHKERRQ(_4_ierr);}
8497c922b88SBarry Smith 
850bd481603SBarry Smith 
851bd481603SBarry Smith 
8527b80b807SBarry Smith /* Routines unique to particular data structures */
853be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **);
854ba966639SSatish Balay PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
855be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBDiagGetData(Mat,PetscInt*,PetscInt*,PetscInt*[],PetscInt*[],PetscScalar***);
856698d4c6aSKris Buschelman 
857be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*);
858be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
859698d4c6aSKris Buschelman 
860be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
861be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
862be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
8637b80b807SBarry Smith 
864a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4
865a96a251dSBarry Smith 
866be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
867ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
868be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
869ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
870be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
871ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
872be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDensePreallocation(Mat,PetscScalar[]);
873be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]);
874273d9f13SBarry Smith 
875be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
876ba966639SSatish Balay PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
877be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
878be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
879be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
880be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
881be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDensePreallocation(Mat,PetscScalar[]);
882be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]);
883be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
884be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
885284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
886be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]);
887be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
888be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
889be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void));
890273d9f13SBarry Smith 
891be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt);
892ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*);
8931b807ce4Svictorle 
894be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat);
895be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat);
8962e8a6d31SBarry Smith 
897be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*);
8983a7fca6bSBarry Smith 
8997b80b807SBarry Smith /*
9007b80b807SBarry Smith   These routines are not usually accessed directly, rather solving is
90194b7f48cSBarry Smith   done through the KSP and PC interfaces.
9027b80b807SBarry Smith */
9037b80b807SBarry Smith 
904d9274352SBarry Smith /*E
905d9274352SBarry Smith     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
906d9274352SBarry Smith        with an optional dynamic library name, for example
907d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
908d9274352SBarry Smith 
909d9274352SBarry Smith    Level: beginner
910d9274352SBarry Smith 
911d9274352SBarry Smith .seealso: MatGetOrdering()
912d9274352SBarry Smith E*/
91349773a63SBarry Smith #define MatOrderingType char*
914b12f92e5SBarry Smith #define MATORDERING_NATURAL   "natural"
915b12f92e5SBarry Smith #define MATORDERING_ND        "nd"
916b12f92e5SBarry Smith #define MATORDERING_1WD       "1wd"
917b12f92e5SBarry Smith #define MATORDERING_RCM       "rcm"
918b12f92e5SBarry Smith #define MATORDERING_QMD       "qmd"
919b12f92e5SBarry Smith #define MATORDERING_ROWLENGTH "rowlength"
92062152c8bSBarry Smith #define MATORDERING_DSC_ND    "dsc_nd"
92162152c8bSBarry Smith #define MATORDERING_DSC_MMD   "dsc_mmd"
92262152c8bSBarry Smith #define MATORDERING_DSC_MDF   "dsc_mdf"
923c06d978dSMatthew Knepley #define MATORDERING_CONSTRAINED "constrained"
924c06d978dSMatthew Knepley #define MATORDERING_IDENTITY  "identity"
925c06d978dSMatthew Knepley #define MATORDERING_REVERSE   "reverse"
926b12f92e5SBarry Smith 
927be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
928be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list);
929be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
93030de9b25SBarry Smith 
93130de9b25SBarry Smith /*MC
93230de9b25SBarry Smith    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the
93330de9b25SBarry Smith                                matrix package.
93430de9b25SBarry Smith 
93530de9b25SBarry Smith    Synopsis:
936c1ac3661SBarry Smith    PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
93730de9b25SBarry Smith 
93830de9b25SBarry Smith    Not Collective
93930de9b25SBarry Smith 
94030de9b25SBarry Smith    Input Parameters:
94130de9b25SBarry Smith +  sname - name of ordering (for example MATORDERING_ND)
94230de9b25SBarry Smith .  path - location of library where creation routine is
94330de9b25SBarry Smith .  name - name of function that creates the ordering type,a string
94430de9b25SBarry Smith -  function - function pointer that creates the ordering
94530de9b25SBarry Smith 
94630de9b25SBarry Smith    Level: developer
94730de9b25SBarry Smith 
94830de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
94930de9b25SBarry Smith    is ignored.
95030de9b25SBarry Smith 
95130de9b25SBarry Smith    Sample usage:
95230de9b25SBarry Smith .vb
95330de9b25SBarry Smith    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
95430de9b25SBarry Smith                "MyOrder",MyOrder);
95530de9b25SBarry Smith .ve
95630de9b25SBarry Smith 
95730de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
95830de9b25SBarry Smith $     MatOrderingSetType(part,"my_order)
95930de9b25SBarry Smith    or at runtime via the option
96030de9b25SBarry Smith $     -pc_ilu_mat_ordering_type my_order
96130de9b25SBarry Smith $     -pc_lu_mat_ordering_type my_order
96230de9b25SBarry Smith 
963ab901514SBarry Smith    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
96430de9b25SBarry Smith 
96530de9b25SBarry Smith .keywords: matrix, ordering, register
96630de9b25SBarry Smith 
96730de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
96830de9b25SBarry Smith M*/
969aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
970f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
971b12f92e5SBarry Smith #else
972f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
973b12f92e5SBarry Smith #endif
97430de9b25SBarry Smith 
975be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void);
976be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]);
9772bad1931SBarry Smith extern PetscTruth MatOrderingRegisterAllCalled;
978b0a32e0cSBarry Smith extern PetscFList MatOrderingList;
979d4fbbf0eSBarry Smith 
980be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
981a2ce50c7SBarry Smith 
982d91e6319SBarry Smith /*S
98315e8a5b3SHong Zhang    MatFactorInfo - Data based into the matrix factorization routines
984b00f7748SHong Zhang 
98515e8a5b3SHong Zhang    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE
986b00f7748SHong Zhang 
98715e8a5b3SHong Zhang    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
988b00f7748SHong Zhang 
989b00f7748SHong Zhang    Level: developer
990b00f7748SHong Zhang 
991d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
992d7d82daaSBarry Smith           MatFactorInfoInitialize()
993b00f7748SHong Zhang 
994b00f7748SHong Zhang S*/
995b00f7748SHong Zhang typedef struct {
9960a29876aSHong Zhang   PetscReal     shiftnz;        /* scaling of identity added to matrix to prevent zero pivots */
997fbf22428SSatish Balay   PetscReal     shiftpd;        /* if true, shift until positive pivots */
9982cea7109SBarry Smith   PetscReal     shift_fraction; /* record shift fraction taken */
99915e8a5b3SHong Zhang   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
100015e8a5b3SHong Zhang   PetscReal     dt;             /* drop tolerance */
1001b00f7748SHong Zhang   PetscReal     dtcol;          /* tolerance for pivoting */
100215e8a5b3SHong Zhang   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
1003f6275e2eSBarry Smith   PetscReal     fill;           /* expected fill; nonzeros in factored matrix/nonzeros in original matrix*/
1004348344bbSBarry Smith   PetscReal     levels;         /* ICC/ILU(levels) */
1005bcd9e38bSBarry Smith   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1006bcd9e38bSBarry Smith                                    factorization may be faster if do not pivot */
100715e8a5b3SHong Zhang   PetscReal     zeropivot;      /* pivot is called zero if less than this */
100815e8a5b3SHong Zhang } MatFactorInfo;
1009ffa6d0a5SLois Curfman McInnes 
1010be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*);
1011be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,MatFactorInfo*);
1012be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
1013be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,MatFactorInfo*,Mat*);
1014be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,MatFactorInfo*);
1015be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,MatFactorInfo*);
1016be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
1017be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
1018be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
1019be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,MatFactorInfo*);
1020be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,MatFactorInfo*,Mat*);
1021be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactor(Mat,IS,IS,MatFactorInfo*,Mat *);
1022be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1023be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec);
1024be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec);
1025be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec);
1026be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec);
1027be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec);
1028be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1029be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs);
10308ed539a5SBarry Smith 
1031be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat);
1032bb5a7306SBarry Smith 
1033d91e6319SBarry Smith /*E
1034d91e6319SBarry Smith     MatSORType - What type of (S)SOR to perform
1035bb1eb677SSatish Balay 
1036d91e6319SBarry Smith     Level: beginner
1037d91e6319SBarry Smith 
1038d9274352SBarry Smith    May be bitwise ORd together
1039d9274352SBarry Smith 
1040d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1041d91e6319SBarry Smith 
10424e7234bfSBarry Smith    MatSORType may be bitwise ORd together, so do not change the numbers
10434e7234bfSBarry Smith 
1044a1d92eedSBarry Smith .seealso: MatRelax(), MatPBRelax()
1045d91e6319SBarry Smith E*/
1046ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1047ee50ffe9SBarry Smith               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1048ee50ffe9SBarry Smith               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
104984cb2905SBarry Smith               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1050be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1051be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
10528ed539a5SBarry Smith 
1053d4fbbf0eSBarry Smith /*
1054639f9d9dSBarry Smith     These routines are for efficiently computing Jacobians via finite differences.
1055639f9d9dSBarry Smith */
1056b12f92e5SBarry Smith 
1057d9274352SBarry Smith /*E
1058d9274352SBarry Smith     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1059d9274352SBarry Smith        with an optional dynamic library name, for example
1060d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1061d9274352SBarry Smith 
1062d9274352SBarry Smith    Level: beginner
1063d9274352SBarry Smith 
1064d9274352SBarry Smith .seealso: MatGetColoring()
1065d9274352SBarry Smith E*/
106649773a63SBarry Smith #define MatColoringType char*
1067b12f92e5SBarry Smith #define MATCOLORING_NATURAL "natural"
1068b12f92e5SBarry Smith #define MATCOLORING_SL      "sl"
1069b12f92e5SBarry Smith #define MATCOLORING_LF      "lf"
1070b12f92e5SBarry Smith #define MATCOLORING_ID      "id"
1071b12f92e5SBarry Smith 
1072be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*);
1073be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatColoringType,ISColoring *));
107430de9b25SBarry Smith 
107530de9b25SBarry Smith /*MC
107630de9b25SBarry Smith    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
107730de9b25SBarry Smith                                matrix package.
107830de9b25SBarry Smith 
107930de9b25SBarry Smith    Synopsis:
1080c1ac3661SBarry Smith    PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring))
108130de9b25SBarry Smith 
108230de9b25SBarry Smith    Not Collective
108330de9b25SBarry Smith 
108430de9b25SBarry Smith    Input Parameters:
108530de9b25SBarry Smith +  sname - name of Coloring (for example MATCOLORING_SL)
108630de9b25SBarry Smith .  path - location of library where creation routine is
108730de9b25SBarry Smith .  name - name of function that creates the Coloring type, a string
108830de9b25SBarry Smith -  function - function pointer that creates the coloring
108930de9b25SBarry Smith 
109030de9b25SBarry Smith    Level: developer
109130de9b25SBarry Smith 
109230de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
109330de9b25SBarry Smith    is ignored.
109430de9b25SBarry Smith 
109530de9b25SBarry Smith    Sample usage:
109630de9b25SBarry Smith .vb
109730de9b25SBarry Smith    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
109830de9b25SBarry Smith                "MyColor",MyColor);
109930de9b25SBarry Smith .ve
110030de9b25SBarry Smith 
110130de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
110230de9b25SBarry Smith $     MatColoringSetType(part,"my_color")
110330de9b25SBarry Smith    or at runtime via the option
110430de9b25SBarry Smith $     -mat_coloring_type my_color
110530de9b25SBarry Smith 
1106ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
110730de9b25SBarry Smith 
110830de9b25SBarry Smith .keywords: matrix, Coloring, register
110930de9b25SBarry Smith 
111030de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
111130de9b25SBarry Smith M*/
1112aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1113f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1114b12f92e5SBarry Smith #else
1115f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1116b12f92e5SBarry Smith #endif
111730de9b25SBarry Smith 
11182bad1931SBarry Smith extern PetscTruth MatColoringRegisterAllCalled;
1119f1144a30SSatish Balay 
1120be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]);
1121be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void);
1122be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1123639f9d9dSBarry Smith 
1124d9274352SBarry Smith /*S
1125d9274352SBarry Smith      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1126d9274352SBarry Smith         and coloring
1127639f9d9dSBarry Smith 
1128d9274352SBarry Smith    Level: beginner
1129d9274352SBarry Smith 
1130d9274352SBarry Smith   Concepts: coloring, sparse Jacobian, finite differences
1131d9274352SBarry Smith 
1132d9274352SBarry Smith .seealso:  MatFDColoringCreate()
1133d9274352SBarry Smith S*/
1134e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring;
1135639f9d9dSBarry Smith 
1136be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1137be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring);
1138be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer);
1139be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
11404a9d489dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1141be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1142be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFrequency(MatFDColoring,PetscInt);
1143be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFrequency(MatFDColoring,PetscInt*);
1144be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring);
1145be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1146be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1147be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetRecompute(MatFDColoring);
1148be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec);
1149be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1150639f9d9dSBarry Smith /*
11510752156aSBarry Smith     These routines are for partitioning matrices: currently used only
11523eda8832SBarry Smith   for adjacency matrix, MatCreateMPIAdj().
11530752156aSBarry Smith */
1154ca161407SBarry Smith 
1155d9274352SBarry Smith /*S
1156d9274352SBarry Smith      MatPartitioning - Object for managing the partitioning of a matrix or graph
1157d9274352SBarry Smith 
1158d9274352SBarry Smith    Level: beginner
1159d9274352SBarry Smith 
1160d9274352SBarry Smith   Concepts: partitioning
1161d9274352SBarry Smith 
1162743a1026Svictorle .seealso:  MatPartitioningCreate(), MatPartitioningType
1163d9274352SBarry Smith S*/
116491e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning;
1165d9274352SBarry Smith 
1166d9274352SBarry Smith /*E
11675bc6e7ccSvictorle     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1168d9274352SBarry Smith        with an optional dynamic library name, for example
1169d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1170d9274352SBarry Smith 
1171d9274352SBarry Smith    Level: beginner
1172d9274352SBarry Smith 
1173b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning
1174d9274352SBarry Smith E*/
117549773a63SBarry Smith #define MatPartitioningType char*
11768ba1e511SMatthew Knepley #define MAT_PARTITIONING_CURRENT  "current"
1177c2ec2a73SHong Zhang #define MAT_PARTITIONING_SQUARE   "square"
11788ba1e511SMatthew Knepley #define MAT_PARTITIONING_PARMETIS "parmetis"
117971306c60Sjroman #define MAT_PARTITIONING_CHACO    "chaco"
118071306c60Sjroman #define MAT_PARTITIONING_JOSTLE   "jostle"
118171306c60Sjroman #define MAT_PARTITIONING_PARTY    "party"
118271306c60Sjroman #define MAT_PARTITIONING_SCOTCH   "scotch"
118371306c60Sjroman 
1184ca161407SBarry Smith 
1185be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1186be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1187be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt);
1188be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat);
1189be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1190be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1191be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*);
1192be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning);
11932aabb6bbSBarry Smith 
1194be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
119530de9b25SBarry Smith 
119630de9b25SBarry Smith /*MC
119730de9b25SBarry Smith    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
119830de9b25SBarry Smith    matrix package.
119930de9b25SBarry Smith 
120030de9b25SBarry Smith    Synopsis:
1201c1ac3661SBarry Smith    PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
120230de9b25SBarry Smith 
120330de9b25SBarry Smith    Not Collective
120430de9b25SBarry Smith 
120530de9b25SBarry Smith    Input Parameters:
120630de9b25SBarry Smith +  sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis
120730de9b25SBarry Smith .  path - location of library where creation routine is
120830de9b25SBarry Smith .  name - name of function that creates the partitioning type, a string
120930de9b25SBarry Smith -  function - function pointer that creates the partitioning type
121030de9b25SBarry Smith 
121130de9b25SBarry Smith    Level: developer
121230de9b25SBarry Smith 
121330de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
121430de9b25SBarry Smith    is ignored.
121530de9b25SBarry Smith 
121630de9b25SBarry Smith    Sample usage:
121730de9b25SBarry Smith .vb
121830de9b25SBarry Smith    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
121930de9b25SBarry Smith                "MyPartCreate",MyPartCreate);
122030de9b25SBarry Smith .ve
122130de9b25SBarry Smith 
122230de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
122330de9b25SBarry Smith $     MatPartitioningSetType(part,"my_part")
122430de9b25SBarry Smith    or at runtime via the option
122530de9b25SBarry Smith $     -mat_partitioning_type my_part
122630de9b25SBarry Smith 
1227ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
122830de9b25SBarry Smith 
122930de9b25SBarry Smith .keywords: matrix, partitioning, register
123030de9b25SBarry Smith 
123130de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
123230de9b25SBarry Smith M*/
1233aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1234f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
12352aabb6bbSBarry Smith #else
1236f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
12372aabb6bbSBarry Smith #endif
12382aabb6bbSBarry Smith 
12392bad1931SBarry Smith extern PetscTruth MatPartitioningRegisterAllCalled;
1240f1144a30SSatish Balay 
1241be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]);
1242be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void);
12432bad1931SBarry Smith 
1244be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer);
1245be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning);
1246be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,MatPartitioningType*);
1247ca161407SBarry Smith 
1248be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
12490752156aSBarry Smith 
1250be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1251be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning);
125271306c60Sjroman 
125371306c60Sjroman typedef enum { MP_CHACO_MULTILEVEL_KL, MP_CHACO_SPECTRAL, MP_CHACO_LINEAR,
125471306c60Sjroman     MP_CHACO_RANDOM, MP_CHACO_SCATTERED } MPChacoGlobalType;
1255be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
125671306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1257be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1258be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
125971306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1260be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1261be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1262be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
126371306c60Sjroman 
126471306c60Sjroman #define MP_PARTY_OPT "opt"
126571306c60Sjroman #define MP_PARTY_LIN "lin"
126671306c60Sjroman #define MP_PARTY_SCA "sca"
126771306c60Sjroman #define MP_PARTY_RAN "ran"
126871306c60Sjroman #define MP_PARTY_GBF "gbf"
126971306c60Sjroman #define MP_PARTY_GCF "gcf"
127071306c60Sjroman #define MP_PARTY_BUB "bub"
127171306c60Sjroman #define MP_PARTY_DEF "def"
1272be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*);
127371306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs"
127471306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl"
127571306c60Sjroman #define MP_PARTY_NONE "no"
1276be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*);
1277be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1278be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth);
1279be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth);
128071306c60Sjroman 
128171306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1282be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*);
1283be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning);
1284be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1285be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*);
128771306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1288be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1289be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning);
1290be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*);
129171306c60Sjroman 
12920752156aSBarry Smith /*
12930a835dfdSSatish Balay     If you add entries here you must also add them to finclude/petscmat.h
1294d4fbbf0eSBarry Smith */
12951c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0,
12961c1c02c0SLois Curfman McInnes                MATOP_GET_ROW=1,
12971c1c02c0SLois Curfman McInnes                MATOP_RESTORE_ROW=2,
12981c1c02c0SLois Curfman McInnes                MATOP_MULT=3,
12991c1c02c0SLois Curfman McInnes                MATOP_MULT_ADD=4,
13007c922b88SBarry Smith                MATOP_MULT_TRANSPOSE=5,
13017c922b88SBarry Smith                MATOP_MULT_TRANSPOSE_ADD=6,
13021c1c02c0SLois Curfman McInnes                MATOP_SOLVE=7,
13031c1c02c0SLois Curfman McInnes                MATOP_SOLVE_ADD=8,
13047c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE=9,
13057c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE_ADD=10,
13061c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR=11,
13071c1c02c0SLois Curfman McInnes                MATOP_CHOLESKYFACTOR=12,
13081c1c02c0SLois Curfman McInnes                MATOP_RELAX=13,
13091c1c02c0SLois Curfman McInnes                MATOP_TRANSPOSE=14,
13101c1c02c0SLois Curfman McInnes                MATOP_GETINFO=15,
13111c1c02c0SLois Curfman McInnes                MATOP_EQUAL=16,
13121c1c02c0SLois Curfman McInnes                MATOP_GET_DIAGONAL=17,
13131c1c02c0SLois Curfman McInnes                MATOP_DIAGONAL_SCALE=18,
13141c1c02c0SLois Curfman McInnes                MATOP_NORM=19,
13151c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_BEGIN=20,
13161c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_END=21,
13171c1c02c0SLois Curfman McInnes                MATOP_COMPRESS=22,
13181c1c02c0SLois Curfman McInnes                MATOP_SET_OPTION=23,
13191c1c02c0SLois Curfman McInnes                MATOP_ZERO_ENTRIES=24,
13201c1c02c0SLois Curfman McInnes                MATOP_ZERO_ROWS=25,
13211c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR_SYMBOLIC=26,
13221c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR_NUMERIC=27,
13231c1c02c0SLois Curfman McInnes                MATOP_CHOLESKY_FACTOR_SYMBOLIC=28,
13241c1c02c0SLois Curfman McInnes                MATOP_CHOLESKY_FACTOR_NUMERIC=29,
1325d643ce63SMatthew Knepley                MATOP_SETUP_PREALLOCATION=30,
1326d643ce63SMatthew Knepley                MATOP_ILUFACTOR_SYMBOLIC=31,
1327d643ce63SMatthew Knepley                MATOP_ICCFACTOR_SYMBOLIC=32,
1328d643ce63SMatthew Knepley                MATOP_GET_ARRAY=33,
1329d643ce63SMatthew Knepley                MATOP_RESTORE_ARRAY=34,
1330e26f1c3cSBarry Smith                MATOP_DUPLICATE=35,
1331d643ce63SMatthew Knepley                MATOP_FORWARD_SOLVE=36,
1332d643ce63SMatthew Knepley                MATOP_BACKWARD_SOLVE=37,
1333d643ce63SMatthew Knepley                MATOP_ILUFACTOR=38,
1334d643ce63SMatthew Knepley                MATOP_ICCFACTOR=39,
1335d643ce63SMatthew Knepley                MATOP_AXPY=40,
1336d643ce63SMatthew Knepley                MATOP_GET_SUBMATRICES=41,
1337d643ce63SMatthew Knepley                MATOP_INCREASE_OVERLAP=42,
1338d643ce63SMatthew Knepley                MATOP_GET_VALUES=43,
1339d643ce63SMatthew Knepley                MATOP_COPY=44,
1340d643ce63SMatthew Knepley                MATOP_PRINT_HELP=45,
1341d643ce63SMatthew Knepley                MATOP_SCALE=46,
1342d643ce63SMatthew Knepley                MATOP_SHIFT=47,
1343d643ce63SMatthew Knepley                MATOP_DIAGONAL_SHIFT=48,
1344d643ce63SMatthew Knepley                MATOP_ILUDT_FACTOR=49,
1345d643ce63SMatthew Knepley                MATOP_GET_BLOCK_SIZE=50,
1346d643ce63SMatthew Knepley                MATOP_GET_ROW_IJ=51,
1347d643ce63SMatthew Knepley                MATOP_RESTORE_ROW_IJ=52,
1348d643ce63SMatthew Knepley                MATOP_GET_COLUMN_IJ=53,
1349d643ce63SMatthew Knepley                MATOP_RESTORE_COLUMN_IJ=54,
1350d643ce63SMatthew Knepley                MATOP_FDCOLORING_CREATE=55,
1351d643ce63SMatthew Knepley                MATOP_COLORING_PATCH=56,
1352d643ce63SMatthew Knepley                MATOP_SET_UNFACTORED=57,
1353d643ce63SMatthew Knepley                MATOP_PERMUTE=58,
1354d643ce63SMatthew Knepley                MATOP_SET_VALUES_BLOCKED=59,
1355d643ce63SMatthew Knepley                MATOP_GET_SUBMATRIX=60,
1356d643ce63SMatthew Knepley                MATOP_DESTROY=61,
1357d643ce63SMatthew Knepley                MATOP_VIEW=62,
1358d643ce63SMatthew Knepley                MATOP_GET_MAPS=63,
1359d643ce63SMatthew Knepley                MATOP_USE_SCALED_FORM=64,
1360d643ce63SMatthew Knepley                MATOP_SCALE_SYSTEM=65,
1361d643ce63SMatthew Knepley                MATOP_UNSCALE_SYSTEM=66,
1362ba16a8cbSKris Buschelman                MATOP_SET_LOCAL_TO_GLOBAL_MAP=67,
1363d643ce63SMatthew Knepley                MATOP_SET_VALUES_LOCAL=68,
1364d643ce63SMatthew Knepley                MATOP_ZERO_ROWS_LOCAL=69,
1365d643ce63SMatthew Knepley                MATOP_GET_ROW_MAX=70,
1366d643ce63SMatthew Knepley                MATOP_CONVERT=71,
1367d643ce63SMatthew Knepley                MATOP_SET_COLORING=72,
1368d643ce63SMatthew Knepley                MATOP_SET_VALUES_ADIC=73,
1369d643ce63SMatthew Knepley                MATOP_SET_VALUES_ADIFOR=74,
1370d643ce63SMatthew Knepley                MATOP_FD_COLORING_APPLY=75,
1371d643ce63SMatthew Knepley                MATOP_SET_FROM_OPTIONS=76,
1372ba16a8cbSKris Buschelman                MATOP_MULT_CON=77,
1373ba16a8cbSKris Buschelman                MATOP_MULT_TRANSPOSE_CON=78,
1374ba16a8cbSKris Buschelman                MATOP_ILU_FACTOR_SYMBOLIC_CON=79,
1375d643ce63SMatthew Knepley                MATOP_PERMUTE_SPARSIFY=80,
1376d643ce63SMatthew Knepley                MATOP_MULT_MULTIPLE=81,
137741acf15aSKris Buschelman                MATOP_SOLVE_MULTIPLE=82,
137841acf15aSKris Buschelman                MATOP_GET_INERTIA=83,
137941acf15aSKris Buschelman                MATOP_LOAD=84,
138041acf15aSKris Buschelman                MATOP_IS_SYMMETRIC=85,
138141acf15aSKris Buschelman                MATOP_IS_HERMITIAN=86,
138241acf15aSKris Buschelman                MATOP_IS_STRUCTURALLY_SYMMETRIC=87,
138341acf15aSKris Buschelman                MATOP_PB_RELAX=88,
138441acf15aSKris Buschelman                MATOP_GET_VECS=89,
138541acf15aSKris Buschelman                MATOP_MAT_MULT=90,
138641acf15aSKris Buschelman                MATOP_MAT_MULT_SYMBOLIC=91,
138741acf15aSKris Buschelman                MATOP_MAT_MULT_NUMERIC=92,
138841acf15aSKris Buschelman                MATOP_PTAP=93,
138941acf15aSKris Buschelman                MATOP_PTAP_SYMBOLIC=94,
1390bc011b1eSHong Zhang                MATOP_PTAP_NUMERIC=95,
1391bc011b1eSHong Zhang                MATOP_MAT_MULTTRANSPOSE=96,
1392bc011b1eSHong Zhang                MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=97,
13937ba1a0bfSKris Buschelman                MATOP_MAT_MULTTRANSPOSE_NUMERIC=98,
13947ba1a0bfSKris Buschelman                MATOP_PTAP_SYMBOLIC_SEQAIJ=99,
13957ba1a0bfSKris Buschelman                MATOP_PTAP_NUMERIC_SEQAIJ=100,
13967ba1a0bfSKris Buschelman                MATOP_PTAP_SYMBOLIC_MPIAIJ=101,
139787d4246cSBarry Smith                MATOP_PTAP_NUMERIC_MPIAIJ=102,
139887d4246cSBarry Smith                MATOP_SET_VALUES_ROW = 105
1399fae171e0SBarry Smith              } MatOperation;
1400be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*);
1401be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void));
1402be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void));
1403be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*);
1404112a2221SBarry Smith 
140590ace30eSBarry Smith /*
140690ace30eSBarry Smith    Codes for matrices stored on disk. By default they are
140790ace30eSBarry Smith  stored in a universal format. By changing the format with
1408fb9695e5SSatish Balay  PetscViewerSetFormat(viewer,PETSC_VIEWER_BINARY_NATIVE); the matrices will
140990ace30eSBarry Smith  be stored in a way natural for the matrix, for example dense matrices
141090ace30eSBarry Smith  would be stored as dense. Matrices stored this way may only be
141190ace30eSBarry Smith  read into matrices of the same time.
141290ace30eSBarry Smith */
141390ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1
141490ace30eSBarry Smith 
1415be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1416be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsGetColor(Mat,ISColoring *);
1417860d1616SSatish Balay 
1418be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*);
14191f4e1ec7SBarry Smith 
1420d9274352SBarry Smith /*S
1421d9274352SBarry Smith      MatNullSpace - Object that removes a null space from a vector, i.e.
1422d9274352SBarry Smith          orthogonalizes the vector to a subsapce
1423d9274352SBarry Smith 
1424f7a9e4ceSBarry Smith    Level: advanced
1425d9274352SBarry Smith 
1426d9274352SBarry Smith   Concepts: matrix; linear operator, null space
1427d9274352SBarry Smith 
14286e1639daSBarry Smith   Users manual sections:
14296e1639daSBarry Smith .   sec_singular
14306e1639daSBarry Smith 
1431d9274352SBarry Smith .seealso:  MatNullSpaceCreate()
1432d9274352SBarry Smith S*/
143374637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace;
1434d9274352SBarry Smith 
1435be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*);
1436be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace);
1437be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1438be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace);
1439be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat);
144074637425SBarry Smith 
1441be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS);
1442be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1443be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
144446129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat);
14453f1d51d7SBarry Smith 
1446be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*);
1447be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*);
1448be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*);
1449c4f061fbSSatish Balay 
1450be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*);
1451b0a32e0cSBarry Smith 
1452be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec);
145304f1ad80SBarry Smith 
1454be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1455be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
14567dbadf16SMatthew Knepley 
1457e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END
14582eac72dbSBarry Smith #endif
1459