xref: /petsc/include/petscmat.h (revision 985db425e70a4ebf9c913944ac5a27064d560a7d)
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*/
29e5a9bf91SBarry Smith #define MatType const char*
30273d9f13SBarry Smith #define MATSAME            "same"
31273d9f13SBarry Smith #define MATSEQMAIJ         "seqmaij"
32273d9f13SBarry Smith #define MATMPIMAIJ         "mpimaij"
33209238afSKris Buschelman #define MATMAIJ            "maij"
34273d9f13SBarry Smith #define MATIS              "is"
35273d9f13SBarry Smith #define MATMPIROWBS        "mpirowbs"
36273d9f13SBarry Smith #define MATSEQAIJ          "seqaij"
37273d9f13SBarry Smith #define MATMPIAIJ          "mpiaij"
38209238afSKris Buschelman #define MATAIJ             "aij"
39273d9f13SBarry Smith #define MATSHELL           "shell"
40273d9f13SBarry Smith #define MATSEQBDIAG        "seqbdiag"
41273d9f13SBarry Smith #define MATMPIBDIAG        "mpibdiag"
42209238afSKris Buschelman #define MATBDIAG           "bdiag"
43209238afSKris Buschelman #define MATSEQDENSE        "seqdense"
44273d9f13SBarry Smith #define MATMPIDENSE        "mpidense"
45209238afSKris Buschelman #define MATDENSE           "dense"
46273d9f13SBarry Smith #define MATSEQBAIJ         "seqbaij"
47273d9f13SBarry Smith #define MATMPIBAIJ         "mpibaij"
48209238afSKris Buschelman #define MATBAIJ            "baij"
49273d9f13SBarry Smith #define MATMPIADJ          "mpiadj"
50273d9f13SBarry Smith #define MATSEQSBAIJ        "seqsbaij"
51273d9f13SBarry Smith #define MATMPISBAIJ        "mpisbaij"
52209238afSKris Buschelman #define MATSBAIJ           "sbaij"
53cebc7f6cSBarry Smith #define MATDAAD            "daad"
54cebc7f6cSBarry Smith #define MATMFFD            "mffd"
55c8a8475eSBarry Smith #define MATNORMAL          "normal"
56ab92ecdeSBarry Smith #define MATLRC             "lrc"
57b3a1e11cSKris Buschelman #define MATSEQAIJSPOOLES   "seqaijspooles"
58d10c748bSKris Buschelman #define MATMPIAIJSPOOLES   "mpiaijspooles"
599abb65ffSKris Buschelman #define MATSEQSBAIJSPOOLES "seqsbaijspooles"
6022191285SKris Buschelman #define MATMPISBAIJSPOOLES "mpisbaijspooles"
61bb4d4166SHong Zhang #define MATAIJSPOOLES      "aijspooles"
62bb4d4166SHong Zhang #define MATSBAIJSPOOLES    "sbaijspooles"
6314b396bbSKris Buschelman #define MATSUPERLU         "superlu"
641d96aa28SKris Buschelman #define MATSUPERLU_DIST    "superlu_dist"
651677d0b8SKris Buschelman #define MATUMFPACK         "umfpack"
66e8aa55a4SKris Buschelman #define MATESSL            "essl"
674eb8e494SKris Buschelman #define MATLUSOL           "lusol"
68397b6df1SKris Buschelman #define MATAIJMUMPS        "aijmumps"
69397b6df1SKris Buschelman #define MATSBAIJMUMPS      "sbaijmumps"
708da957c5SKris Buschelman #define MATDSCPACK         "dscpack"
717065e2aaSKris Buschelman #define MATMATLAB          "matlab"
724b8d99adSRichard Tran Mills #define MATSEQCSRPERM      "seqcsrperm"
7318def556SRichard Tran Mills #define MATMPICSRPERM      "mpicsrperm"
74814655b8SBarry Smith #define MATCSRPERM         "csrperm"
7581824310SBarry Smith #define MATSEQCRL          "seqcrl"
76c02b24c5SBarry Smith #define MATMPICRL          "mpicrl"
77c02b24c5SBarry Smith #define MATCRL             "crl"
78c0aa2d19SHong Zhang #define MATPLAPACK         "plapack"
792a6744ebSBarry Smith #define MATSCATTER         "scatter"
80421e10b8SBarry Smith #define MATBLOCKMAT        "blockmat"
81793850ffSBarry Smith #define MATCOMPOSITE       "composite"
825a7f1df3SHong Zhang #define MATSEQFFTW         "seqfftw"
83d91e6319SBarry Smith 
84c06d978dSMatthew Knepley /* Logging support */
85552e946dSBarry Smith #define    MAT_FILE_COOKIE 1211216    /* used to indicate matrices in binary files */
86be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_COOKIE;
87be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_FDCOLORING_COOKIE;
88be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_PARTITIONING_COOKIE;
89be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_NULLSPACE_COOKIE;
90c06d978dSMatthew Knepley 
91ceb03754SKris Buschelman /*E
92ceb03754SKris Buschelman     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
93ceb03754SKris Buschelman      or MatGetSubMatrix() are to be reused to store the new matrix values.
94ceb03754SKris Buschelman 
95ceb03754SKris Buschelman     Level: beginner
96ceb03754SKris Buschelman 
97ceb03754SKris Buschelman    Any additions/changes here MUST also be made in include/finclude/petscmat.h
98ceb03754SKris Buschelman 
990c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
100ceb03754SKris Buschelman E*/
101ceb03754SKris Buschelman typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX} MatReuse;
102ceb03754SKris Buschelman 
103be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(char *);
104c06d978dSMatthew Knepley 
105f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*);
106a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A)
107a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A)
108f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
109f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,MatType);
110be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat);
111be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat);
112be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
113be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
11430de9b25SBarry Smith 
115f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]);
116f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]);
117f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]);
118f69a0ea3SMatthew Knepley 
11930de9b25SBarry Smith /*MC
12030de9b25SBarry Smith    MatRegisterDynamic - Adds a new matrix type
12130de9b25SBarry Smith 
12230de9b25SBarry Smith    Synopsis:
123c1ac3661SBarry Smith    PetscErrorCode MatRegisterDynamic(char *name,char *path,char *name_create,PetscErrorCode (*routine_create)(Mat))
12430de9b25SBarry Smith 
12530de9b25SBarry Smith    Not Collective
12630de9b25SBarry Smith 
12730de9b25SBarry Smith    Input Parameters:
12830de9b25SBarry Smith +  name - name of a new user-defined matrix type
12930de9b25SBarry Smith .  path - path (either absolute or relative) the library containing this solver
13030de9b25SBarry Smith .  name_create - name of routine to create method context
13130de9b25SBarry Smith -  routine_create - routine to create method context
13230de9b25SBarry Smith 
13330de9b25SBarry Smith    Notes:
13430de9b25SBarry Smith    MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
13530de9b25SBarry Smith 
13630de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
13730de9b25SBarry Smith    is ignored.
13830de9b25SBarry Smith 
13930de9b25SBarry Smith    Sample usage:
14030de9b25SBarry Smith .vb
14130de9b25SBarry Smith    MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
14230de9b25SBarry Smith                "MyMatCreate",MyMatCreate);
14330de9b25SBarry Smith .ve
14430de9b25SBarry Smith 
14530de9b25SBarry Smith    Then, your solver can be chosen with the procedural interface via
14630de9b25SBarry Smith $     MatSetType(Mat,"my_mat")
14730de9b25SBarry Smith    or at runtime via the option
14830de9b25SBarry Smith $     -mat_type my_mat
14930de9b25SBarry Smith 
15030de9b25SBarry Smith    Level: advanced
15130de9b25SBarry Smith 
152ab901514SBarry Smith    Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
15330de9b25SBarry Smith          If your function is not being put into a shared library then use VecRegister() instead
15430de9b25SBarry Smith 
15530de9b25SBarry Smith .keywords: Mat, register
15630de9b25SBarry Smith 
15730de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy()
15830de9b25SBarry Smith 
15930de9b25SBarry Smith M*/
160273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
161273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
162273d9f13SBarry Smith #else
163273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
16430de9b25SBarry Smith #endif
16530de9b25SBarry Smith 
166273d9f13SBarry Smith extern PetscTruth MatRegisterAllCalled;
167b0a32e0cSBarry Smith extern PetscFList MatList;
16828988994SBarry Smith 
169be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
170be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
171be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
172ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A)
173ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A)
174ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A)
175ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A)
176ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A))
177ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A))
178ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A))
179be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
180ba966639SSatish 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)
181ba966639SSatish 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)
182ba966639SSatish 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)
183ba966639SSatish 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)
184ba966639SSatish 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))
185ba966639SSatish 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))
186ba966639SSatish 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))
187ba966639SSatish 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)
188ba966639SSatish 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)
189ba966639SSatish 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)
190ba966639SSatish 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)
191ba966639SSatish 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))
192ba966639SSatish 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))
193ba966639SSatish 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))
19463ab93bfSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
1958d7a6e47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
1968d7a6e47SBarry Smith 
197be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIRowbs(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
198be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*);
199be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*);
200be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
201ba966639SSatish 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)
202ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
203ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
204ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
205ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
206ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
207ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
208be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
209ba966639SSatish 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)
210ba966639SSatish 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)
211ba966639SSatish 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)
212ba966639SSatish 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)
213ba966639SSatish 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))
214ba966639SSatish 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))
215ba966639SSatish 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))
216ba966639SSatish 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)
217ba966639SSatish 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)
218ba966639SSatish 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)
219ba966639SSatish 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)
220ba966639SSatish 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))
221ba966639SSatish 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))
222ba966639SSatish 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))
223be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
224be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
225ba966639SSatish 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)
226ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
227ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
228ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
229ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
230ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
231ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
232be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
233ba966639SSatish 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)
234ba966639SSatish 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)
235ba966639SSatish 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)
236ba966639SSatish 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)
237ba966639SSatish 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))
238ba966639SSatish 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))
239ba966639SSatish 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))
240ba966639SSatish 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)
241ba966639SSatish 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)
242ba966639SSatish 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)
243ba966639SSatish 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)
244ba966639SSatish 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))
245ba966639SSatish 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))
246ba966639SSatish 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))
247be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
248ba966639SSatish 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)
249ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A)
250be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
251be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*);
252ba966639SSatish Balay PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A)
253ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*);
254284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
2551472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
2561472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPICRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
2572a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateScatter(MPI_Comm,VecScatter,Mat*);
2582a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterSetVecScatter(Mat,VecScatter);
2592a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterGetVecScatter(Mat,VecScatter*);
2608cdf2d9bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
261793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeAddMat(Mat,Mat);
262b52f573bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeMerge(Mat);
263793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
2645a7f1df3SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqFFTW(MPI_Comm,PetscInt,const PetscInt[],Mat*);
2651472f72bSBarry Smith 
266f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat);
267be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat);
26821c89e3eSBarry Smith 
2690c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat);
27099cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat);
27199cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat);
27299cafbc1SBarry Smith 
2738ed539a5SBarry Smith /* ------------------------------------------------------------*/
274be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
275be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
27687d4246cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
277f259bd47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
27884cb2905SBarry Smith 
2792ef4de8bSBarry Smith /*S
2802ef4de8bSBarry Smith      MatStencil - Data structure (C struct) for storing information about a single row or
2812ef4de8bSBarry Smith         column of a matrix as index on an associated grid.
2822ef4de8bSBarry Smith 
2832ef4de8bSBarry Smith    Level: beginner
2842ef4de8bSBarry Smith 
2852ef4de8bSBarry Smith   Concepts: matrix; linear operator
2862ef4de8bSBarry Smith 
287d7bd93baSBarry Smith .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
2882ef4de8bSBarry Smith S*/
289435da068SBarry Smith typedef struct {
290c1ac3661SBarry Smith   PetscInt k,j,i,c;
291435da068SBarry Smith } MatStencil;
2922ef4de8bSBarry Smith 
293be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
294be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
295be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
296435da068SBarry Smith 
297be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring);
298be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*);
299be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*);
3003a7fca6bSBarry Smith 
301d91e6319SBarry Smith /*E
302d91e6319SBarry Smith     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
303d91e6319SBarry Smith      to continue to add values to it
304d91e6319SBarry Smith 
305d91e6319SBarry Smith     Level: beginner
306d91e6319SBarry Smith 
307d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd()
308d91e6319SBarry Smith E*/
3096d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
310be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType);
311be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType);
312be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*);
3134f9c727eSBarry Smith 
314be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt    MatSetValue_Row;
315be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt    MatSetValue_Column;
316be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscScalar MatSetValue_Value;
3171d73ed98SBarry Smith 
31830de9b25SBarry Smith /*MC
31930de9b25SBarry Smith    MatSetValue - Set a single entry into a matrix.
32030de9b25SBarry Smith 
32130de9b25SBarry Smith    Synopsis:
322c1ac3661SBarry Smith    PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode);
32330de9b25SBarry Smith 
32430de9b25SBarry Smith    Not collective
32530de9b25SBarry Smith 
32630de9b25SBarry Smith    Input Parameters:
32730de9b25SBarry Smith +  m - the matrix
32830de9b25SBarry Smith .  row - the row location of the entry
32930de9b25SBarry Smith .  col - the column location of the entry
33030de9b25SBarry Smith .  value - the value to insert
33130de9b25SBarry Smith -  mode - either INSERT_VALUES or ADD_VALUES
33230de9b25SBarry Smith 
33330de9b25SBarry Smith    Notes:
33430de9b25SBarry Smith    For efficiency one should use MatSetValues() and set several or many
33530de9b25SBarry Smith    values simultaneously if possible.
33630de9b25SBarry Smith 
33730de9b25SBarry Smith    Level: beginner
33830de9b25SBarry Smith 
33930de9b25SBarry Smith .seealso: MatSetValues(), MatSetValueLocal()
34030de9b25SBarry Smith M*/
341b951964fSBarry Smith #define MatSetValue(v,i,j,va,mode) \
342f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \
3431d73ed98SBarry Smith    MatSetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode))
34430de9b25SBarry Smith 
345ea06a074SBarry Smith #define MatGetValue(v,i,j,va) \
346f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,0) || \
3471d73ed98SBarry Smith    MatGetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&va))
34830de9b25SBarry Smith 
349d91e6319SBarry Smith #define MatSetValueLocal(v,i,j,va,mode) \
350f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \
3511d73ed98SBarry Smith    MatSetValuesLocal(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode))
35230de9b25SBarry Smith 
353d91e6319SBarry Smith /*E
354d91e6319SBarry Smith     MatOption - Options that may be set for a matrix and its behavior or storage
355d91e6319SBarry Smith 
356d91e6319SBarry Smith     Level: beginner
357d91e6319SBarry Smith 
3580a835dfdSSatish Balay    Any additions/changes here MUST also be made in include/finclude/petscmat.h
359d91e6319SBarry Smith 
360d91e6319SBarry Smith .seealso: MatSetOption()
361d91e6319SBarry Smith E*/
362290bbb0aSBarry Smith typedef enum {MAT_ROW_ORIENTED,MAT_COLUMN_ORIENTED,MAT_ROWS_SORTED,
363290bbb0aSBarry Smith               MAT_COLUMNS_SORTED,MAT_NO_NEW_NONZERO_LOCATIONS,
364290bbb0aSBarry Smith               MAT_YES_NEW_NONZERO_LOCATIONS,MAT_SYMMETRIC,
365290bbb0aSBarry Smith               MAT_STRUCTURALLY_SYMMETRIC,MAT_NO_NEW_DIAGONALS,
366290bbb0aSBarry Smith               MAT_YES_NEW_DIAGONALS,MAT_INODE_LIMIT_1,MAT_INODE_LIMIT_2,
367290bbb0aSBarry Smith               MAT_INODE_LIMIT_3,MAT_INODE_LIMIT_4,MAT_INODE_LIMIT_5,
368290bbb0aSBarry Smith               MAT_IGNORE_OFF_PROC_ENTRIES,MAT_ROWS_UNSORTED,
369290bbb0aSBarry Smith               MAT_COLUMNS_UNSORTED,MAT_NEW_NONZERO_LOCATION_ERR,
370290bbb0aSBarry Smith               MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE,
371290bbb0aSBarry Smith               MAT_KEEP_ZEROED_ROWS,MAT_IGNORE_ZERO_ENTRIES,MAT_USE_INODES,
372290bbb0aSBarry Smith               MAT_DO_NOT_USE_INODES,MAT_NOT_SYMMETRIC,MAT_HERMITIAN,
373290bbb0aSBarry Smith               MAT_NOT_STRUCTURALLY_SYMMETRIC,MAT_NOT_HERMITIAN,
374290bbb0aSBarry Smith               MAT_SYMMETRY_ETERNAL,MAT_NOT_SYMMETRY_ETERNAL,
375290bbb0aSBarry Smith               MAT_USE_COMPRESSEDROW,MAT_DO_NOT_USE_COMPRESSEDROW,
376290bbb0aSBarry Smith               MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR,MAT_GETROW_UPPERTRIANGULAR} MatOption;
377290bbb0aSBarry Smith extern const char *MatOptions[];
378be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption);
379be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,MatType*);
380ba966639SSatish Balay PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),MatType,t)
38184cb2905SBarry Smith 
382be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
383be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
384be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
385f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat);
386f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat);
387be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
388be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
389be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt);
390be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]);
391ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]);
393be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *);
394ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
395be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt);
3967b80b807SBarry Smith 
397be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec);
398be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec);
399ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
400be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec);
401be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*);
402ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t)
403e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscTruth,t)
404be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec);
405ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
406be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec);
407be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec);
4082bebee5dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat,Mat,Mat);
409f5edf698SHong Zhang 
410d91e6319SBarry Smith /*E
411d91e6319SBarry Smith     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
412d91e6319SBarry Smith   its numerical values copied over or just its nonzero structure.
413d91e6319SBarry Smith 
414d91e6319SBarry Smith     Level: beginner
415d91e6319SBarry Smith 
416d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
417d91e6319SBarry Smith 
418d91e6319SBarry Smith .seealso: MatDuplicate()
419d91e6319SBarry Smith E*/
4202e8a6d31SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES} MatDuplicateOption;
4212e8a6d31SBarry Smith 
422f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,MatType,MatReuse,Mat*);
423ba966639SSatish Balay PetscPolymorphicFunction(MatConvert,(Mat A,MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a)
424be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*);
425ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a)
426ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a)
42794a9d846SBarry Smith 
428d91e6319SBarry Smith /*E
429d91e6319SBarry Smith     MatStructure - Indicates if the matrix has the same nonzero structure
430d91e6319SBarry Smith 
431d91e6319SBarry Smith     Level: beginner
432d91e6319SBarry Smith 
433d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
434d91e6319SBarry Smith 
43594b7f48cSBarry Smith .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
436d91e6319SBarry Smith E*/
437c537a176SHong Zhang typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure;
438cb5b572fSBarry Smith 
439be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure);
440be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer);
441be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*);
442ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t)
443e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscTruth,t)
444be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*);
445ba966639SSatish Balay PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t)
446be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscTruth*);
447ba966639SSatish Balay PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,&t),PetscTruth,t)
448be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*);
449be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*);
450f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(PetscViewer,MatType,Mat*);
451ba966639SSatish Balay PetscPolymorphicFunction(MatLoad,(PetscViewer v,MatType t),(v,t,&a),Mat,a)
4527b80b807SBarry Smith 
453be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
454be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
455be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
456be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
457d4fbbf0eSBarry Smith 
458d91e6319SBarry Smith /*S
459d91e6319SBarry Smith      MatInfo - Context of matrix information, used with MatGetInfo()
460d91e6319SBarry Smith 
461d91e6319SBarry Smith    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
462d91e6319SBarry Smith 
463d91e6319SBarry Smith    Level: intermediate
464d91e6319SBarry Smith 
465d91e6319SBarry Smith   Concepts: matrix^nonzero information
466d91e6319SBarry Smith 
467d9274352SBarry Smith .seealso:  MatGetInfo(), MatInfoType
468d91e6319SBarry Smith S*/
4694e220ebcSLois Curfman McInnes typedef struct {
470b0a32e0cSBarry Smith   PetscLogDouble rows_global,columns_global;         /* number of global rows and columns */
471b0a32e0cSBarry Smith   PetscLogDouble rows_local,columns_local;           /* number of local rows and columns */
472b0a32e0cSBarry Smith   PetscLogDouble block_size;                         /* block size */
473b0a32e0cSBarry Smith   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
474b0a32e0cSBarry Smith   PetscLogDouble memory;                             /* memory allocated */
475b0a32e0cSBarry Smith   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
476b0a32e0cSBarry Smith   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
477b0a32e0cSBarry Smith   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
478b0a32e0cSBarry Smith   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
4794e220ebcSLois Curfman McInnes } MatInfo;
4804e220ebcSLois Curfman McInnes 
481d9274352SBarry Smith /*E
482d9274352SBarry Smith     MatInfoType - Indicates if you want information about the local part of the matrix,
483d9274352SBarry Smith      the entire parallel matrix or the maximum over all the local parts.
484d9274352SBarry Smith 
485d9274352SBarry Smith     Level: beginner
486d9274352SBarry Smith 
487d9274352SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
488d9274352SBarry Smith 
489d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo
490d9274352SBarry Smith E*/
4917b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
492be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*);
493be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatValid(Mat,PetscTruth*);
494be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec);
495*985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec,PetscInt[]);
496*985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMin(Mat,Vec,PetscInt[]);
497*985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
498be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,Mat*);
499ba966639SSatish Balay PetscPolymorphicFunction(MatTranspose,(Mat A),(A,&t),Mat,t)
500be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *);
501ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
502be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
503be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec);
504be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode);
505be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*);
506ba966639SSatish Balay PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t)
507be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*);
508be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*);
509be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*);
510be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*);
5117b80b807SBarry Smith 
512be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *);
513ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
514be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat);
515f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar);
516f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar);
517f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*);
518f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*);
5197b80b807SBarry Smith 
520be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth);
521be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec);
522be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec);
5235ef9f2a5SBarry Smith 
524be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*);
525be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*);
526be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
5278ee2e534SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRanges(Mat,const PetscInt**);
5287b80b807SBarry Smith 
529be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
530be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]);
531be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,PetscInt,MatReuse,Mat *);
532abf0e977SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrixRaw(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt,MatReuse,Mat *);
533be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
534be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
535be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
536be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat);
537be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat);
538be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*);
539be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
540be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
541be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscScalar**,Mat*);
54243eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE)
543cd116e26SSatish Balay #include "petscctable.h"
54443eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
54543eb5e2fSMatthew Knepley #else
54643eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
54743eb5e2fSMatthew Knepley #endif
5488efafbd8SBarry Smith 
549be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
5507b80b807SBarry Smith 
551be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
552be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
553be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat);
55422440eb1SKris Buschelman 
555be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
556be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
557be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat);
55822440eb1SKris Buschelman 
559be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
560be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
561be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat);
562bc011b1eSHong Zhang 
563f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure);
56404aac2b0SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat,MatStructure);
565be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompress(Mat);
5661c741599SHong Zhang 
567f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar);
568f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar);
5697b80b807SBarry Smith 
570be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
571be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
572f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar);
573f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar);
574be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
575be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
576052efed2SBarry Smith 
577be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt);
578be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
57990f02eecSBarry Smith 
580be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec);
5810c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec);
582ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
583be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec);
584be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*);
58569db28dcSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);
586bd481603SBarry Smith 
587bd481603SBarry Smith /*MC
5880d2a7ff2SSatish Balay    MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
589bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
590bd481603SBarry Smith 
591bd481603SBarry Smith    Synopsis:
592c1ac3661SBarry Smith    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
593bd481603SBarry Smith 
594bd481603SBarry Smith    Collective on MPI_Comm
595bd481603SBarry Smith 
596bd481603SBarry Smith    Input Parameters:
597bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
598859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
599859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
600bd481603SBarry Smith 
601bd481603SBarry Smith    Output Parameters:
602bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
603bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
604bd481603SBarry Smith 
605bd481603SBarry Smith 
606bd481603SBarry Smith    Level: intermediate
607bd481603SBarry Smith 
608bd481603SBarry Smith    Notes:
609bd481603SBarry Smith    See the chapter in the users manual on performance for more details
610bd481603SBarry Smith 
6111d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
612bd481603SBarry Smith 
613bd481603SBarry Smith    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
614bd481603SBarry Smith 
615bd481603SBarry Smith   Concepts: preallocation^Matrix
616bd481603SBarry Smith 
617bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
618bd481603SBarry Smith           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
619bd481603SBarry Smith M*/
620c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
6217c922b88SBarry Smith { \
622c1ac3661SBarry Smith   PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
623c1ac3661SBarry Smith   _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\
624c1ac3661SBarry Smith   _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\
625c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
626c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp;
6277c922b88SBarry Smith 
628bd481603SBarry Smith /*MC
6290d2a7ff2SSatish Balay    MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
630bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
631bd481603SBarry Smith 
632bd481603SBarry Smith    Synopsis:
633c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
634bd481603SBarry Smith 
635bd481603SBarry Smith    Collective on MPI_Comm
636bd481603SBarry Smith 
637bd481603SBarry Smith    Input Parameters:
638bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
639859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
640859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
641bd481603SBarry Smith 
642bd481603SBarry Smith    Output Parameters:
643bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
644bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
645bd481603SBarry Smith 
646bd481603SBarry Smith 
647bd481603SBarry Smith    Level: intermediate
648bd481603SBarry Smith 
649bd481603SBarry Smith    Notes:
650bd481603SBarry Smith    See the chapter in the users manual on performance for more details
651bd481603SBarry Smith 
6521d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
653bd481603SBarry Smith 
654bd481603SBarry Smith   Concepts: preallocation^Matrix
655bd481603SBarry Smith 
656bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
657bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
658bd481603SBarry Smith M*/
659222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
660222b16d4SBarry Smith { \
661c1ac3661SBarry Smith   PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__end; \
662c1ac3661SBarry Smith   _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\
663c1ac3661SBarry Smith   _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\
664c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
665c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp;
666222b16d4SBarry Smith 
667bd481603SBarry Smith /*MC
668bd481603SBarry Smith    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
669bd481603SBarry Smith        inserted using a local number of the rows and columns
670bd481603SBarry Smith 
671bd481603SBarry Smith    Synopsis:
672c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
673bd481603SBarry Smith 
674bd481603SBarry Smith    Not Collective
675bd481603SBarry Smith 
676bd481603SBarry Smith    Input Parameters:
677bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
678bd481603SBarry Smith .  nrows - the number of rows indicated
6791d73ed98SBarry Smith .  rows - the indices of the rows
680bd481603SBarry Smith .  ncols - the number of columns in the matrix
681bd481603SBarry Smith .  cols - the columns indicated
682bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
683bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
684bd481603SBarry Smith 
685bd481603SBarry Smith 
686bd481603SBarry Smith    Level: intermediate
687bd481603SBarry Smith 
688bd481603SBarry Smith    Notes:
689bd481603SBarry Smith    See the chapter in the users manual on performance for more details
690bd481603SBarry Smith 
6911d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
692bd481603SBarry Smith 
693bd481603SBarry Smith   Concepts: preallocation^Matrix
694bd481603SBarry Smith 
695bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
696bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
697bd481603SBarry Smith M*/
698c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
699c4f061fbSSatish Balay {\
700c1ac3661SBarry Smith   PetscInt __l;\
701ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
702ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
703c4f061fbSSatish Balay   for (__l=0;__l<nrows;__l++) {\
704ef66eb69SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
705c4f061fbSSatish Balay   }\
706c4f061fbSSatish Balay }
707c4f061fbSSatish Balay 
708bd481603SBarry Smith /*MC
709bd481603SBarry Smith    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
710bd481603SBarry Smith        inserted using a local number of the rows and columns
711bd481603SBarry Smith 
712bd481603SBarry Smith    Synopsis:
713c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
714bd481603SBarry Smith 
715bd481603SBarry Smith    Not Collective
716bd481603SBarry Smith 
717bd481603SBarry Smith    Input Parameters:
718bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
719bd481603SBarry Smith .  nrows - the number of rows indicated
7201d73ed98SBarry Smith .  rows - the indices of the rows
721bd481603SBarry Smith .  ncols - the number of columns in the matrix
722bd481603SBarry Smith .  cols - the columns indicated
723bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
724bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
725bd481603SBarry Smith 
726bd481603SBarry Smith 
727bd481603SBarry Smith    Level: intermediate
728bd481603SBarry Smith 
729bd481603SBarry Smith    Notes:
730bd481603SBarry Smith    See the chapter in the users manual on performance for more details
731bd481603SBarry Smith 
732bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
733bd481603SBarry Smith 
734bd481603SBarry Smith   Concepts: preallocation^Matrix
735bd481603SBarry Smith 
736bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
737bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
738bd481603SBarry Smith M*/
739d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
740d3d32019SBarry Smith {\
741c1ac3661SBarry Smith   PetscInt __l;\
742d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
743d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
744d3d32019SBarry Smith   for (__l=0;__l<nrows;__l++) {\
745d3d32019SBarry Smith     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
746d3d32019SBarry Smith   }\
747d3d32019SBarry Smith }
748d3d32019SBarry Smith 
749bd481603SBarry Smith /*MC
750bd481603SBarry Smith    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
751bd481603SBarry Smith        inserted using a local number of the rows and columns
752bd481603SBarry Smith 
753bd481603SBarry Smith    Synopsis:
754c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
755bd481603SBarry Smith 
756bd481603SBarry Smith    Not Collective
757bd481603SBarry Smith 
758bd481603SBarry Smith    Input Parameters:
75964075487SBarry Smith +  row - the row
760bd481603SBarry Smith .  ncols - the number of columns in the matrix
761a50f8bf6SHong Zhang -  cols - the columns indicated
762a50f8bf6SHong Zhang 
763a50f8bf6SHong Zhang    Output Parameters:
764a50f8bf6SHong Zhang +  dnz - the array that will be passed to the matrix preallocation routines
765bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
766bd481603SBarry Smith 
767bd481603SBarry Smith 
768bd481603SBarry Smith    Level: intermediate
769bd481603SBarry Smith 
770bd481603SBarry Smith    Notes:
771bd481603SBarry Smith    See the chapter in the users manual on performance for more details
772bd481603SBarry Smith 
773bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
774bd481603SBarry Smith 
775bd481603SBarry Smith   Concepts: preallocation^Matrix
776bd481603SBarry Smith 
777bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
778bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
779bd481603SBarry Smith M*/
780c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
781c1ac3661SBarry Smith { PetscInt __i; \
7828ee2e534SBarry Smith   if (row < __rstart) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\
7838ee2e534SBarry Smith   if (row >= __rstart+__tmp) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D greater than last local row %D",row,__rstart+__tmp-1);\
7847c922b88SBarry Smith   for (__i=0; __i<nc; __i++) {\
78564075487SBarry Smith     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
7867cc688d7SBarry Smith     else dnz[row - __rstart]++;\
7877c922b88SBarry Smith   }\
7887c922b88SBarry Smith }
7897c922b88SBarry Smith 
790bd481603SBarry Smith /*MC
791bd481603SBarry Smith    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
792bd481603SBarry Smith        inserted using a local number of the rows and columns
793bd481603SBarry Smith 
794bd481603SBarry Smith    Synopsis:
795c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
796bd481603SBarry Smith 
797bd481603SBarry Smith    Not Collective
798bd481603SBarry Smith 
799bd481603SBarry Smith    Input Parameters:
800bd481603SBarry Smith +  nrows - the number of rows indicated
8011d73ed98SBarry Smith .  rows - the indices of the rows
802bd481603SBarry Smith .  ncols - the number of columns in the matrix
803bd481603SBarry Smith .  cols - the columns indicated
804bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
805bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
806bd481603SBarry Smith 
807bd481603SBarry Smith 
808bd481603SBarry Smith    Level: intermediate
809bd481603SBarry Smith 
810bd481603SBarry Smith    Notes:
811bd481603SBarry Smith    See the chapter in the users manual on performance for more details
812bd481603SBarry Smith 
813bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
814bd481603SBarry Smith 
815bd481603SBarry Smith   Concepts: preallocation^Matrix
816bd481603SBarry Smith 
817bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
818bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
819bd481603SBarry Smith M*/
820d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
821c1ac3661SBarry Smith { PetscInt __i; \
822d3d32019SBarry Smith   for (__i=0; __i<nc; __i++) {\
823d3d32019SBarry Smith     if (cols[__i] >= __end) onz[row - __rstart]++; \
824d3d32019SBarry Smith     else if (cols[__i] >= row) dnz[row - __rstart]++;\
825d3d32019SBarry Smith   }\
826d3d32019SBarry Smith }
827d3d32019SBarry Smith 
828bd481603SBarry Smith /*MC
8290d2a7ff2SSatish Balay    MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
830bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
831bd481603SBarry Smith 
832bd481603SBarry Smith    Synopsis:
833c1ac3661SBarry Smith    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
834bd481603SBarry Smith 
835bd481603SBarry Smith    Collective on MPI_Comm
836bd481603SBarry Smith 
837bd481603SBarry Smith    Input Parameters:
838bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
839bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
840bd481603SBarry Smith 
841bd481603SBarry Smith 
842bd481603SBarry Smith    Level: intermediate
843bd481603SBarry Smith 
844bd481603SBarry Smith    Notes:
845bd481603SBarry Smith    See the chapter in the users manual on performance for more details
846bd481603SBarry Smith 
847bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
848bd481603SBarry Smith 
849bd481603SBarry Smith   Concepts: preallocation^Matrix
850bd481603SBarry Smith 
851bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
852bd481603SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
853bd481603SBarry Smith M*/
854ef66eb69SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree(dnz);CHKERRQ(_4_ierr);}
8557c922b88SBarry Smith 
856bd481603SBarry Smith 
857bd481603SBarry Smith 
8587b80b807SBarry Smith /* Routines unique to particular data structures */
859be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **);
860ba966639SSatish Balay PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
861be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBDiagGetData(Mat,PetscInt*,PetscInt*,PetscInt*[],PetscInt*[],PetscScalar***);
862698d4c6aSKris Buschelman 
863be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*);
864be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
865698d4c6aSKris Buschelman 
866be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
867be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
868be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
869c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
870c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
8717b80b807SBarry Smith 
872a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4
873a96a251dSBarry Smith 
874be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
875ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
876be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
877ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
878be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
879ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
880be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDensePreallocation(Mat,PetscScalar[]);
881be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]);
882273d9f13SBarry Smith 
883be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
884ba966639SSatish Balay PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
885be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
886be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
88753803f26SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
888be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
889be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
890be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]);
891be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
892be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
893284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
894be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]);
895be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
896be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
897be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void));
898273d9f13SBarry Smith 
899be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt);
900ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*);
9011b807ce4Svictorle 
902be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat);
903be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat);
9042e8a6d31SBarry Smith 
905be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*);
9063a7fca6bSBarry Smith 
9077b80b807SBarry Smith /*
9087b80b807SBarry Smith   These routines are not usually accessed directly, rather solving is
90994b7f48cSBarry Smith   done through the KSP and PC interfaces.
9107b80b807SBarry Smith */
9117b80b807SBarry Smith 
912d9274352SBarry Smith /*E
913d9274352SBarry Smith     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
914d9274352SBarry Smith        with an optional dynamic library name, for example
915d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
916d9274352SBarry Smith 
917d9274352SBarry Smith    Level: beginner
918d9274352SBarry Smith 
919e5a9bf91SBarry Smith    Cannot use const because the PC objects manipulate the string
920e5a9bf91SBarry Smith 
921d9274352SBarry Smith .seealso: MatGetOrdering()
922d9274352SBarry Smith E*/
92349773a63SBarry Smith #define MatOrderingType char*
924b12f92e5SBarry Smith #define MATORDERING_NATURAL   "natural"
925b12f92e5SBarry Smith #define MATORDERING_ND        "nd"
926b12f92e5SBarry Smith #define MATORDERING_1WD       "1wd"
927b12f92e5SBarry Smith #define MATORDERING_RCM       "rcm"
928b12f92e5SBarry Smith #define MATORDERING_QMD       "qmd"
929b12f92e5SBarry Smith #define MATORDERING_ROWLENGTH "rowlength"
93062152c8bSBarry Smith #define MATORDERING_DSC_ND    "dsc_nd"
93162152c8bSBarry Smith #define MATORDERING_DSC_MMD   "dsc_mmd"
93262152c8bSBarry Smith #define MATORDERING_DSC_MDF   "dsc_mdf"
933c06d978dSMatthew Knepley #define MATORDERING_CONSTRAINED "constrained"
934c06d978dSMatthew Knepley #define MATORDERING_IDENTITY  "identity"
935c06d978dSMatthew Knepley #define MATORDERING_REVERSE   "reverse"
936b12f92e5SBarry Smith 
937be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
938be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list);
939be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
94030de9b25SBarry Smith 
94130de9b25SBarry Smith /*MC
94230de9b25SBarry Smith    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the
94330de9b25SBarry Smith                                matrix package.
94430de9b25SBarry Smith 
94530de9b25SBarry Smith    Synopsis:
946c1ac3661SBarry Smith    PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
94730de9b25SBarry Smith 
94830de9b25SBarry Smith    Not Collective
94930de9b25SBarry Smith 
95030de9b25SBarry Smith    Input Parameters:
95130de9b25SBarry Smith +  sname - name of ordering (for example MATORDERING_ND)
95230de9b25SBarry Smith .  path - location of library where creation routine is
95330de9b25SBarry Smith .  name - name of function that creates the ordering type,a string
95430de9b25SBarry Smith -  function - function pointer that creates the ordering
95530de9b25SBarry Smith 
95630de9b25SBarry Smith    Level: developer
95730de9b25SBarry Smith 
95830de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
95930de9b25SBarry Smith    is ignored.
96030de9b25SBarry Smith 
96130de9b25SBarry Smith    Sample usage:
96230de9b25SBarry Smith .vb
96330de9b25SBarry Smith    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
96430de9b25SBarry Smith                "MyOrder",MyOrder);
96530de9b25SBarry Smith .ve
96630de9b25SBarry Smith 
96730de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
96830de9b25SBarry Smith $     MatOrderingSetType(part,"my_order)
96930de9b25SBarry Smith    or at runtime via the option
9702401956bSBarry Smith $     -pc_factor_mat_ordering_type my_order
97130de9b25SBarry Smith 
972ab901514SBarry Smith    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
97330de9b25SBarry Smith 
97430de9b25SBarry Smith .keywords: matrix, ordering, register
97530de9b25SBarry Smith 
97630de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
97730de9b25SBarry Smith M*/
978aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
979f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
980b12f92e5SBarry Smith #else
981f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
982b12f92e5SBarry Smith #endif
98330de9b25SBarry Smith 
984be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void);
985be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]);
9862bad1931SBarry Smith extern PetscTruth MatOrderingRegisterAllCalled;
987b0a32e0cSBarry Smith extern PetscFList MatOrderingList;
988d4fbbf0eSBarry Smith 
989be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
990a2ce50c7SBarry Smith 
991d91e6319SBarry Smith /*S
9922401956bSBarry Smith    MatFactorInfo - Data passed into the matrix factorization routines
993b00f7748SHong Zhang 
99415e8a5b3SHong Zhang    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE
995b00f7748SHong Zhang 
99615e8a5b3SHong Zhang    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
997b00f7748SHong Zhang 
998b00f7748SHong Zhang    Level: developer
999b00f7748SHong Zhang 
1000d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1001d7d82daaSBarry Smith           MatFactorInfoInitialize()
1002b00f7748SHong Zhang 
1003b00f7748SHong Zhang S*/
1004b00f7748SHong Zhang typedef struct {
10050a29876aSHong Zhang   PetscReal     shiftnz;        /* scaling of identity added to matrix to prevent zero pivots */
1006fbf22428SSatish Balay   PetscReal     shiftpd;        /* if true, shift until positive pivots */
10072cea7109SBarry Smith   PetscReal     shift_fraction; /* record shift fraction taken */
100815e8a5b3SHong Zhang   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
100915e8a5b3SHong Zhang   PetscReal     dt;             /* drop tolerance */
1010b00f7748SHong Zhang   PetscReal     dtcol;          /* tolerance for pivoting */
101115e8a5b3SHong Zhang   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
101267e28bfeSBarry Smith   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1013348344bbSBarry Smith   PetscReal     levels;         /* ICC/ILU(levels) */
1014bcd9e38bSBarry Smith   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1015bcd9e38bSBarry Smith                                    factorization may be faster if do not pivot */
101615e8a5b3SHong Zhang   PetscReal     zeropivot;      /* pivot is called zero if less than this */
101715e8a5b3SHong Zhang } MatFactorInfo;
1018ffa6d0a5SLois Curfman McInnes 
1019be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*);
1020be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,MatFactorInfo*);
1021be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
1022be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,MatFactorInfo*,Mat*);
1023be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,MatFactorInfo*);
1024be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,MatFactorInfo*);
1025be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
1026be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
1027be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
1028be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,MatFactorInfo*);
1029be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,MatFactorInfo*,Mat*);
1030be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactor(Mat,IS,IS,MatFactorInfo*,Mat *);
1031be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1032be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec);
1033be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec);
1034be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec);
1035be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec);
1036be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec);
1037be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1038be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs);
10398ed539a5SBarry Smith 
1040be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat);
1041bb5a7306SBarry Smith 
1042d91e6319SBarry Smith /*E
1043d91e6319SBarry Smith     MatSORType - What type of (S)SOR to perform
1044bb1eb677SSatish Balay 
1045d91e6319SBarry Smith     Level: beginner
1046d91e6319SBarry Smith 
1047d9274352SBarry Smith    May be bitwise ORd together
1048d9274352SBarry Smith 
1049d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1050d91e6319SBarry Smith 
10514e7234bfSBarry Smith    MatSORType may be bitwise ORd together, so do not change the numbers
10524e7234bfSBarry Smith 
1053a1d92eedSBarry Smith .seealso: MatRelax(), MatPBRelax()
1054d91e6319SBarry Smith E*/
1055ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1056ee50ffe9SBarry Smith               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1057ee50ffe9SBarry Smith               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
105884cb2905SBarry Smith               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1059be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1060be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
10618ed539a5SBarry Smith 
1062d4fbbf0eSBarry Smith /*
1063639f9d9dSBarry Smith     These routines are for efficiently computing Jacobians via finite differences.
1064639f9d9dSBarry Smith */
1065b12f92e5SBarry Smith 
1066d9274352SBarry Smith /*E
1067d9274352SBarry Smith     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1068d9274352SBarry Smith        with an optional dynamic library name, for example
1069d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1070d9274352SBarry Smith 
1071d9274352SBarry Smith    Level: beginner
1072d9274352SBarry Smith 
1073d9274352SBarry Smith .seealso: MatGetColoring()
1074d9274352SBarry Smith E*/
1075e5a9bf91SBarry Smith #define MatColoringType const char*
1076b12f92e5SBarry Smith #define MATCOLORING_NATURAL "natural"
1077b12f92e5SBarry Smith #define MATCOLORING_SL      "sl"
1078b12f92e5SBarry Smith #define MATCOLORING_LF      "lf"
1079b12f92e5SBarry Smith #define MATCOLORING_ID      "id"
1080b12f92e5SBarry Smith 
10812e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,MatColoringType,ISColoring*);
10822e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *));
108330de9b25SBarry Smith 
108430de9b25SBarry Smith /*MC
108530de9b25SBarry Smith    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
108630de9b25SBarry Smith                                matrix package.
108730de9b25SBarry Smith 
108830de9b25SBarry Smith    Synopsis:
1089c1ac3661SBarry Smith    PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring))
109030de9b25SBarry Smith 
109130de9b25SBarry Smith    Not Collective
109230de9b25SBarry Smith 
109330de9b25SBarry Smith    Input Parameters:
109430de9b25SBarry Smith +  sname - name of Coloring (for example MATCOLORING_SL)
109530de9b25SBarry Smith .  path - location of library where creation routine is
109630de9b25SBarry Smith .  name - name of function that creates the Coloring type, a string
109730de9b25SBarry Smith -  function - function pointer that creates the coloring
109830de9b25SBarry Smith 
109930de9b25SBarry Smith    Level: developer
110030de9b25SBarry Smith 
110130de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
110230de9b25SBarry Smith    is ignored.
110330de9b25SBarry Smith 
110430de9b25SBarry Smith    Sample usage:
110530de9b25SBarry Smith .vb
110630de9b25SBarry Smith    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
110730de9b25SBarry Smith                "MyColor",MyColor);
110830de9b25SBarry Smith .ve
110930de9b25SBarry Smith 
111030de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
111130de9b25SBarry Smith $     MatColoringSetType(part,"my_color")
111230de9b25SBarry Smith    or at runtime via the option
111330de9b25SBarry Smith $     -mat_coloring_type my_color
111430de9b25SBarry Smith 
1115ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
111630de9b25SBarry Smith 
111730de9b25SBarry Smith .keywords: matrix, Coloring, register
111830de9b25SBarry Smith 
111930de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
112030de9b25SBarry Smith M*/
1121aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1122f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1123b12f92e5SBarry Smith #else
1124f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1125b12f92e5SBarry Smith #endif
112630de9b25SBarry Smith 
11272bad1931SBarry Smith extern PetscTruth MatColoringRegisterAllCalled;
1128f1144a30SSatish Balay 
1129be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]);
1130be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void);
1131be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1132639f9d9dSBarry Smith 
1133d9274352SBarry Smith /*S
1134d9274352SBarry Smith      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1135d9274352SBarry Smith         and coloring
1136639f9d9dSBarry Smith 
1137d9274352SBarry Smith    Level: beginner
1138d9274352SBarry Smith 
1139d9274352SBarry Smith   Concepts: coloring, sparse Jacobian, finite differences
1140d9274352SBarry Smith 
1141d9274352SBarry Smith .seealso:  MatFDColoringCreate()
1142d9274352SBarry Smith S*/
1143e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring;
1144639f9d9dSBarry Smith 
1145be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1146be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring);
1147be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer);
1148be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
11494a9d489dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1150be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1151be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFrequency(MatFDColoring,PetscInt);
1152be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFrequency(MatFDColoring,PetscInt*);
1153be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring);
1154be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1155be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1156be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetRecompute(MatFDColoring);
1157be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec);
1158be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1159639f9d9dSBarry Smith /*
11600752156aSBarry Smith     These routines are for partitioning matrices: currently used only
11613eda8832SBarry Smith   for adjacency matrix, MatCreateMPIAdj().
11620752156aSBarry Smith */
1163ca161407SBarry Smith 
1164d9274352SBarry Smith /*S
1165d9274352SBarry Smith      MatPartitioning - Object for managing the partitioning of a matrix or graph
1166d9274352SBarry Smith 
1167d9274352SBarry Smith    Level: beginner
1168d9274352SBarry Smith 
1169d9274352SBarry Smith   Concepts: partitioning
1170d9274352SBarry Smith 
1171743a1026Svictorle .seealso:  MatPartitioningCreate(), MatPartitioningType
1172d9274352SBarry Smith S*/
117391e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning;
1174d9274352SBarry Smith 
1175d9274352SBarry Smith /*E
11765bc6e7ccSvictorle     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1177d9274352SBarry Smith        with an optional dynamic library name, for example
1178d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1179d9274352SBarry Smith 
1180d9274352SBarry Smith    Level: beginner
1181d9274352SBarry Smith 
1182b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning
1183d9274352SBarry Smith E*/
1184e5a9bf91SBarry Smith #define MatPartitioningType const char*
11858ba1e511SMatthew Knepley #define MAT_PARTITIONING_CURRENT  "current"
1186c2ec2a73SHong Zhang #define MAT_PARTITIONING_SQUARE   "square"
11878ba1e511SMatthew Knepley #define MAT_PARTITIONING_PARMETIS "parmetis"
118871306c60Sjroman #define MAT_PARTITIONING_CHACO    "chaco"
118971306c60Sjroman #define MAT_PARTITIONING_JOSTLE   "jostle"
119071306c60Sjroman #define MAT_PARTITIONING_PARTY    "party"
119171306c60Sjroman #define MAT_PARTITIONING_SCOTCH   "scotch"
119271306c60Sjroman 
1193ca161407SBarry Smith 
1194be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*);
11952e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,MatPartitioningType);
1196be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt);
1197be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat);
1198be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1199be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1200be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*);
1201be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning);
12022aabb6bbSBarry Smith 
1203be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
120430de9b25SBarry Smith 
120530de9b25SBarry Smith /*MC
120630de9b25SBarry Smith    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
120730de9b25SBarry Smith    matrix package.
120830de9b25SBarry Smith 
120930de9b25SBarry Smith    Synopsis:
1210c1ac3661SBarry Smith    PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
121130de9b25SBarry Smith 
121230de9b25SBarry Smith    Not Collective
121330de9b25SBarry Smith 
121430de9b25SBarry Smith    Input Parameters:
121530de9b25SBarry Smith +  sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis
121630de9b25SBarry Smith .  path - location of library where creation routine is
121730de9b25SBarry Smith .  name - name of function that creates the partitioning type, a string
121830de9b25SBarry Smith -  function - function pointer that creates the partitioning type
121930de9b25SBarry Smith 
122030de9b25SBarry Smith    Level: developer
122130de9b25SBarry Smith 
122230de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
122330de9b25SBarry Smith    is ignored.
122430de9b25SBarry Smith 
122530de9b25SBarry Smith    Sample usage:
122630de9b25SBarry Smith .vb
122730de9b25SBarry Smith    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
122830de9b25SBarry Smith                "MyPartCreate",MyPartCreate);
122930de9b25SBarry Smith .ve
123030de9b25SBarry Smith 
123130de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
123230de9b25SBarry Smith $     MatPartitioningSetType(part,"my_part")
123330de9b25SBarry Smith    or at runtime via the option
123430de9b25SBarry Smith $     -mat_partitioning_type my_part
123530de9b25SBarry Smith 
1236ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
123730de9b25SBarry Smith 
123830de9b25SBarry Smith .keywords: matrix, partitioning, register
123930de9b25SBarry Smith 
124030de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
124130de9b25SBarry Smith M*/
1242aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1243f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
12442aabb6bbSBarry Smith #else
1245f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
12462aabb6bbSBarry Smith #endif
12472aabb6bbSBarry Smith 
12482bad1931SBarry Smith extern PetscTruth MatPartitioningRegisterAllCalled;
1249f1144a30SSatish Balay 
1250be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]);
1251be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void);
12522bad1931SBarry Smith 
1253be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer);
1254be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning);
1255be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,MatPartitioningType*);
1256ca161407SBarry Smith 
1257be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
12580752156aSBarry Smith 
1259be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1260be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning);
126171306c60Sjroman 
1262954b3ec6SBarry Smith typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType;
1263be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
126471306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1265be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1266be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
126771306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1268be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1269be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1270be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
127171306c60Sjroman 
127271306c60Sjroman #define MP_PARTY_OPT "opt"
127371306c60Sjroman #define MP_PARTY_LIN "lin"
127471306c60Sjroman #define MP_PARTY_SCA "sca"
127571306c60Sjroman #define MP_PARTY_RAN "ran"
127671306c60Sjroman #define MP_PARTY_GBF "gbf"
127771306c60Sjroman #define MP_PARTY_GCF "gcf"
127871306c60Sjroman #define MP_PARTY_BUB "bub"
127971306c60Sjroman #define MP_PARTY_DEF "def"
1280be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*);
128171306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs"
128271306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl"
128371306c60Sjroman #define MP_PARTY_NONE "no"
1284be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*);
1285be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth);
1287be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth);
128871306c60Sjroman 
128971306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1290be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*);
1291be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning);
1292be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1293be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1294be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*);
129571306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1296be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1297be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning);
1298be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*);
129971306c60Sjroman 
13000752156aSBarry Smith /*
13010a835dfdSSatish Balay     If you add entries here you must also add them to finclude/petscmat.h
1302d4fbbf0eSBarry Smith */
13031c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0,
13041c1c02c0SLois Curfman McInnes                MATOP_GET_ROW=1,
13051c1c02c0SLois Curfman McInnes                MATOP_RESTORE_ROW=2,
13061c1c02c0SLois Curfman McInnes                MATOP_MULT=3,
13071c1c02c0SLois Curfman McInnes                MATOP_MULT_ADD=4,
13087c922b88SBarry Smith                MATOP_MULT_TRANSPOSE=5,
13097c922b88SBarry Smith                MATOP_MULT_TRANSPOSE_ADD=6,
13101c1c02c0SLois Curfman McInnes                MATOP_SOLVE=7,
13111c1c02c0SLois Curfman McInnes                MATOP_SOLVE_ADD=8,
13127c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE=9,
13137c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE_ADD=10,
13141c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR=11,
13151c1c02c0SLois Curfman McInnes                MATOP_CHOLESKYFACTOR=12,
13161c1c02c0SLois Curfman McInnes                MATOP_RELAX=13,
13171c1c02c0SLois Curfman McInnes                MATOP_TRANSPOSE=14,
13181c1c02c0SLois Curfman McInnes                MATOP_GETINFO=15,
13191c1c02c0SLois Curfman McInnes                MATOP_EQUAL=16,
13201c1c02c0SLois Curfman McInnes                MATOP_GET_DIAGONAL=17,
13211c1c02c0SLois Curfman McInnes                MATOP_DIAGONAL_SCALE=18,
13221c1c02c0SLois Curfman McInnes                MATOP_NORM=19,
13231c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_BEGIN=20,
13241c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_END=21,
13251c1c02c0SLois Curfman McInnes                MATOP_COMPRESS=22,
13261c1c02c0SLois Curfman McInnes                MATOP_SET_OPTION=23,
13271c1c02c0SLois Curfman McInnes                MATOP_ZERO_ENTRIES=24,
13281c1c02c0SLois Curfman McInnes                MATOP_ZERO_ROWS=25,
13291c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR_SYMBOLIC=26,
13301c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR_NUMERIC=27,
13311c1c02c0SLois Curfman McInnes                MATOP_CHOLESKY_FACTOR_SYMBOLIC=28,
13321c1c02c0SLois Curfman McInnes                MATOP_CHOLESKY_FACTOR_NUMERIC=29,
1333d643ce63SMatthew Knepley                MATOP_SETUP_PREALLOCATION=30,
1334d643ce63SMatthew Knepley                MATOP_ILUFACTOR_SYMBOLIC=31,
1335d643ce63SMatthew Knepley                MATOP_ICCFACTOR_SYMBOLIC=32,
1336d643ce63SMatthew Knepley                MATOP_GET_ARRAY=33,
1337d643ce63SMatthew Knepley                MATOP_RESTORE_ARRAY=34,
1338e26f1c3cSBarry Smith                MATOP_DUPLICATE=35,
1339d643ce63SMatthew Knepley                MATOP_FORWARD_SOLVE=36,
1340d643ce63SMatthew Knepley                MATOP_BACKWARD_SOLVE=37,
1341d643ce63SMatthew Knepley                MATOP_ILUFACTOR=38,
1342d643ce63SMatthew Knepley                MATOP_ICCFACTOR=39,
1343d643ce63SMatthew Knepley                MATOP_AXPY=40,
1344d643ce63SMatthew Knepley                MATOP_GET_SUBMATRICES=41,
1345d643ce63SMatthew Knepley                MATOP_INCREASE_OVERLAP=42,
1346d643ce63SMatthew Knepley                MATOP_GET_VALUES=43,
1347d643ce63SMatthew Knepley                MATOP_COPY=44,
1348d643ce63SMatthew Knepley                MATOP_PRINT_HELP=45,
1349d643ce63SMatthew Knepley                MATOP_SCALE=46,
1350d643ce63SMatthew Knepley                MATOP_SHIFT=47,
1351d643ce63SMatthew Knepley                MATOP_DIAGONAL_SHIFT=48,
1352d643ce63SMatthew Knepley                MATOP_ILUDT_FACTOR=49,
1353d643ce63SMatthew Knepley                MATOP_GET_BLOCK_SIZE=50,
1354d643ce63SMatthew Knepley                MATOP_GET_ROW_IJ=51,
1355d643ce63SMatthew Knepley                MATOP_RESTORE_ROW_IJ=52,
1356d643ce63SMatthew Knepley                MATOP_GET_COLUMN_IJ=53,
1357d643ce63SMatthew Knepley                MATOP_RESTORE_COLUMN_IJ=54,
1358d643ce63SMatthew Knepley                MATOP_FDCOLORING_CREATE=55,
1359d643ce63SMatthew Knepley                MATOP_COLORING_PATCH=56,
1360d643ce63SMatthew Knepley                MATOP_SET_UNFACTORED=57,
1361d643ce63SMatthew Knepley                MATOP_PERMUTE=58,
1362d643ce63SMatthew Knepley                MATOP_SET_VALUES_BLOCKED=59,
1363d643ce63SMatthew Knepley                MATOP_GET_SUBMATRIX=60,
1364d643ce63SMatthew Knepley                MATOP_DESTROY=61,
1365d643ce63SMatthew Knepley                MATOP_VIEW=62,
1366d643ce63SMatthew Knepley                MATOP_GET_MAPS=63,
1367d643ce63SMatthew Knepley                MATOP_USE_SCALED_FORM=64,
1368d643ce63SMatthew Knepley                MATOP_SCALE_SYSTEM=65,
1369d643ce63SMatthew Knepley                MATOP_UNSCALE_SYSTEM=66,
1370ba16a8cbSKris Buschelman                MATOP_SET_LOCAL_TO_GLOBAL_MAP=67,
1371d643ce63SMatthew Knepley                MATOP_SET_VALUES_LOCAL=68,
1372d643ce63SMatthew Knepley                MATOP_ZERO_ROWS_LOCAL=69,
1373d643ce63SMatthew Knepley                MATOP_GET_ROW_MAX=70,
1374d643ce63SMatthew Knepley                MATOP_CONVERT=71,
1375d643ce63SMatthew Knepley                MATOP_SET_COLORING=72,
1376d643ce63SMatthew Knepley                MATOP_SET_VALUES_ADIC=73,
1377d643ce63SMatthew Knepley                MATOP_SET_VALUES_ADIFOR=74,
1378d643ce63SMatthew Knepley                MATOP_FD_COLORING_APPLY=75,
1379d643ce63SMatthew Knepley                MATOP_SET_FROM_OPTIONS=76,
1380ba16a8cbSKris Buschelman                MATOP_MULT_CON=77,
1381ba16a8cbSKris Buschelman                MATOP_MULT_TRANSPOSE_CON=78,
1382ba16a8cbSKris Buschelman                MATOP_ILU_FACTOR_SYMBOLIC_CON=79,
1383d643ce63SMatthew Knepley                MATOP_PERMUTE_SPARSIFY=80,
1384d643ce63SMatthew Knepley                MATOP_MULT_MULTIPLE=81,
138541acf15aSKris Buschelman                MATOP_SOLVE_MULTIPLE=82,
138641acf15aSKris Buschelman                MATOP_GET_INERTIA=83,
138741acf15aSKris Buschelman                MATOP_LOAD=84,
138841acf15aSKris Buschelman                MATOP_IS_SYMMETRIC=85,
138941acf15aSKris Buschelman                MATOP_IS_HERMITIAN=86,
139041acf15aSKris Buschelman                MATOP_IS_STRUCTURALLY_SYMMETRIC=87,
139141acf15aSKris Buschelman                MATOP_PB_RELAX=88,
139241acf15aSKris Buschelman                MATOP_GET_VECS=89,
139341acf15aSKris Buschelman                MATOP_MAT_MULT=90,
139441acf15aSKris Buschelman                MATOP_MAT_MULT_SYMBOLIC=91,
139541acf15aSKris Buschelman                MATOP_MAT_MULT_NUMERIC=92,
139641acf15aSKris Buschelman                MATOP_PTAP=93,
139741acf15aSKris Buschelman                MATOP_PTAP_SYMBOLIC=94,
1398bc011b1eSHong Zhang                MATOP_PTAP_NUMERIC=95,
1399bc011b1eSHong Zhang                MATOP_MAT_MULTTRANSPOSE=96,
1400bc011b1eSHong Zhang                MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=97,
14017ba1a0bfSKris Buschelman                MATOP_MAT_MULTTRANSPOSE_NUMERIC=98,
14027ba1a0bfSKris Buschelman                MATOP_PTAP_SYMBOLIC_SEQAIJ=99,
14037ba1a0bfSKris Buschelman                MATOP_PTAP_NUMERIC_SEQAIJ=100,
14047ba1a0bfSKris Buschelman                MATOP_PTAP_SYMBOLIC_MPIAIJ=101,
140587d4246cSBarry Smith                MATOP_PTAP_NUMERIC_MPIAIJ=102,
1406f5edf698SHong Zhang                MATOP_SET_VALUES_ROW = 105,
1407d5c63f83SSatish Balay                MATOP_GET_ROW_UTRIANGULAR=108,
14082bebee5dSHong Zhang                MATOP_RESTORE_ROW_UTRIANGULAR=109,
140969db28dcSHong Zhang                MATOP_MATSOLVE=110,
141069db28dcSHong Zhang                MATOP_GET_REDUNDANTMATRIX=111
1411fae171e0SBarry Smith              } MatOperation;
1412be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*);
1413be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void));
1414be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void));
1415be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*);
1416112a2221SBarry Smith 
141790ace30eSBarry Smith /*
141890ace30eSBarry Smith    Codes for matrices stored on disk. By default they are
141990ace30eSBarry Smith  stored in a universal format. By changing the format with
1420fb9695e5SSatish Balay  PetscViewerSetFormat(viewer,PETSC_VIEWER_BINARY_NATIVE); the matrices will
142190ace30eSBarry Smith  be stored in a way natural for the matrix, for example dense matrices
142290ace30eSBarry Smith  would be stored as dense. Matrices stored this way may only be
142390ace30eSBarry Smith  read into matrices of the same time.
142490ace30eSBarry Smith */
142590ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1
142690ace30eSBarry Smith 
1427be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1428be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*);
14291f4e1ec7SBarry Smith 
1430d9274352SBarry Smith /*S
1431d9274352SBarry Smith      MatNullSpace - Object that removes a null space from a vector, i.e.
1432d9274352SBarry Smith          orthogonalizes the vector to a subsapce
1433d9274352SBarry Smith 
1434f7a9e4ceSBarry Smith    Level: advanced
1435d9274352SBarry Smith 
1436d9274352SBarry Smith   Concepts: matrix; linear operator, null space
1437d9274352SBarry Smith 
14386e1639daSBarry Smith   Users manual sections:
14396e1639daSBarry Smith .   sec_singular
14406e1639daSBarry Smith 
1441d9274352SBarry Smith .seealso:  MatNullSpaceCreate()
1442d9274352SBarry Smith S*/
144374637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace;
1444d9274352SBarry Smith 
1445be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*);
1446281d1b2eSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(Vec,void*),void*);
1447be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace);
1448be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1449be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace);
1450be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat);
145174637425SBarry Smith 
1452be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS);
1453be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1454be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
145546129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat);
14563f1d51d7SBarry Smith 
1457be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*);
1458be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*);
1459be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*);
1460c4f061fbSSatish Balay 
1461be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*);
1462b0a32e0cSBarry Smith 
1463be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec);
146404f1ad80SBarry Smith 
1465be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1466be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
14677dbadf16SMatthew Knepley 
1468e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END
14692eac72dbSBarry Smith #endif
1470