xref: /petsc/include/petscmat.h (revision 512a5fc54713208fb168f8fed09a6fe4e3465c57)
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;
90e884886fSBarry Smith extern PetscCookie PETSCMAT_DLLEXPORT MATMFFD_COOKIE;
91c06d978dSMatthew Knepley 
92ceb03754SKris Buschelman /*E
93ceb03754SKris Buschelman     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
94ceb03754SKris Buschelman      or MatGetSubMatrix() are to be reused to store the new matrix values.
95ceb03754SKris Buschelman 
96ceb03754SKris Buschelman     Level: beginner
97ceb03754SKris Buschelman 
98ceb03754SKris Buschelman    Any additions/changes here MUST also be made in include/finclude/petscmat.h
99ceb03754SKris Buschelman 
1000c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
101ceb03754SKris Buschelman E*/
102ceb03754SKris Buschelman typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX} MatReuse;
103ceb03754SKris Buschelman 
104e5bd5246SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(const char[]);
105c06d978dSMatthew Knepley 
106f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*);
107a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A)
108a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A)
109f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
110f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,MatType);
111be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat);
112be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat);
113be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
114be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
11530de9b25SBarry Smith 
116f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]);
117f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]);
118f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]);
119f69a0ea3SMatthew Knepley 
12030de9b25SBarry Smith /*MC
12130de9b25SBarry Smith    MatRegisterDynamic - Adds a new matrix type
12230de9b25SBarry Smith 
12330de9b25SBarry Smith    Synopsis:
124c1ac3661SBarry Smith    PetscErrorCode MatRegisterDynamic(char *name,char *path,char *name_create,PetscErrorCode (*routine_create)(Mat))
12530de9b25SBarry Smith 
12630de9b25SBarry Smith    Not Collective
12730de9b25SBarry Smith 
12830de9b25SBarry Smith    Input Parameters:
12930de9b25SBarry Smith +  name - name of a new user-defined matrix type
13030de9b25SBarry Smith .  path - path (either absolute or relative) the library containing this solver
13130de9b25SBarry Smith .  name_create - name of routine to create method context
13230de9b25SBarry Smith -  routine_create - routine to create method context
13330de9b25SBarry Smith 
13430de9b25SBarry Smith    Notes:
13530de9b25SBarry Smith    MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
13630de9b25SBarry Smith 
13730de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
13830de9b25SBarry Smith    is ignored.
13930de9b25SBarry Smith 
14030de9b25SBarry Smith    Sample usage:
14130de9b25SBarry Smith .vb
14230de9b25SBarry Smith    MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
14330de9b25SBarry Smith                "MyMatCreate",MyMatCreate);
14430de9b25SBarry Smith .ve
14530de9b25SBarry Smith 
14630de9b25SBarry Smith    Then, your solver can be chosen with the procedural interface via
14730de9b25SBarry Smith $     MatSetType(Mat,"my_mat")
14830de9b25SBarry Smith    or at runtime via the option
14930de9b25SBarry Smith $     -mat_type my_mat
15030de9b25SBarry Smith 
15130de9b25SBarry Smith    Level: advanced
15230de9b25SBarry Smith 
153ab901514SBarry Smith    Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
15430de9b25SBarry Smith          If your function is not being put into a shared library then use VecRegister() instead
15530de9b25SBarry Smith 
15630de9b25SBarry Smith .keywords: Mat, register
15730de9b25SBarry Smith 
15830de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy()
15930de9b25SBarry Smith 
16030de9b25SBarry Smith M*/
161273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
162273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
163273d9f13SBarry Smith #else
164273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
16530de9b25SBarry Smith #endif
16630de9b25SBarry Smith 
1679c666560SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
168273d9f13SBarry Smith extern PetscTruth MatRegisterAllCalled;
169b0a32e0cSBarry Smith extern PetscFList MatList;
17028988994SBarry Smith 
171be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
172be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
173be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
174ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A)
175ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A)
176ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A)
177ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A)
178ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A))
179ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A))
180ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A))
181be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
182ba966639SSatish 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)
183ba966639SSatish 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)
184ba966639SSatish 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)
185ba966639SSatish 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)
186ba966639SSatish 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))
187ba966639SSatish 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))
188ba966639SSatish 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))
189ba966639SSatish 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)
190ba966639SSatish 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)
191ba966639SSatish 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)
192ba966639SSatish 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)
193ba966639SSatish 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))
194ba966639SSatish 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))
195ba966639SSatish 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))
19663ab93bfSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
1978d7a6e47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
1988d7a6e47SBarry Smith 
199be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIRowbs(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
200be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*);
201be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*);
202be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
203ba966639SSatish 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)
204ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
205ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
206ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
207ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
208ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
209ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
210be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
211ba966639SSatish 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)
212ba966639SSatish 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)
213ba966639SSatish 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)
214ba966639SSatish 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)
215ba966639SSatish 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))
216ba966639SSatish 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))
217ba966639SSatish 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))
218ba966639SSatish 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)
219ba966639SSatish 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)
220ba966639SSatish 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)
221ba966639SSatish 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)
222ba966639SSatish 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))
223ba966639SSatish 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))
224ba966639SSatish 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))
225be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
226be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
227ba966639SSatish 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)
228ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
229ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
230ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
231ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
232ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
233ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
234be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
235ba966639SSatish 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)
236ba966639SSatish 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)
237ba966639SSatish 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)
238ba966639SSatish 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)
239ba966639SSatish 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))
240ba966639SSatish 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))
241ba966639SSatish 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))
242ba966639SSatish 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)
243ba966639SSatish 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)
244ba966639SSatish 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)
245ba966639SSatish 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)
246ba966639SSatish 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))
247ba966639SSatish 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))
248ba966639SSatish 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))
249be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
250ba966639SSatish 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)
251ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A)
252be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
253be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*);
254ba966639SSatish Balay PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A)
255ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*);
256284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
2571472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
2581472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPICRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
2592a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateScatter(MPI_Comm,VecScatter,Mat*);
2602a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterSetVecScatter(Mat,VecScatter);
2612a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterGetVecScatter(Mat,VecScatter*);
2628cdf2d9bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
263793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeAddMat(Mat,Mat);
264b52f573bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeMerge(Mat);
265793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
2665a7f1df3SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqFFTW(MPI_Comm,PetscInt,const PetscInt[],Mat*);
2671472f72bSBarry Smith 
268f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat);
269be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat);
27021c89e3eSBarry Smith 
2710c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat);
27299cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat);
27399cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat);
27499cafbc1SBarry Smith 
2758ed539a5SBarry Smith /* ------------------------------------------------------------*/
276be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
277be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
27887d4246cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
279f259bd47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
28084cb2905SBarry Smith 
2812ef4de8bSBarry Smith /*S
2822ef4de8bSBarry Smith      MatStencil - Data structure (C struct) for storing information about a single row or
2832ef4de8bSBarry Smith         column of a matrix as index on an associated grid.
2842ef4de8bSBarry Smith 
2852ef4de8bSBarry Smith    Level: beginner
2862ef4de8bSBarry Smith 
2872ef4de8bSBarry Smith   Concepts: matrix; linear operator
2882ef4de8bSBarry Smith 
289d7bd93baSBarry Smith .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
2902ef4de8bSBarry Smith S*/
291435da068SBarry Smith typedef struct {
292c1ac3661SBarry Smith   PetscInt k,j,i,c;
293435da068SBarry Smith } MatStencil;
2942ef4de8bSBarry Smith 
295be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
296be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
297be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
298435da068SBarry Smith 
299be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring);
300be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*);
301be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*);
3023a7fca6bSBarry Smith 
303d91e6319SBarry Smith /*E
304d91e6319SBarry Smith     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
305d91e6319SBarry Smith      to continue to add values to it
306d91e6319SBarry Smith 
307d91e6319SBarry Smith     Level: beginner
308d91e6319SBarry Smith 
309d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd()
310d91e6319SBarry Smith E*/
3116d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
312be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType);
313be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType);
314be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*);
3154f9c727eSBarry Smith 
316be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt    MatSetValue_Row;
317be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt    MatSetValue_Column;
318be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscScalar MatSetValue_Value;
3191d73ed98SBarry Smith 
32030de9b25SBarry Smith /*MC
32130de9b25SBarry Smith    MatSetValue - Set a single entry into a matrix.
32230de9b25SBarry Smith 
32330de9b25SBarry Smith    Synopsis:
324c1ac3661SBarry Smith    PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode);
32530de9b25SBarry Smith 
32630de9b25SBarry Smith    Not collective
32730de9b25SBarry Smith 
32830de9b25SBarry Smith    Input Parameters:
32930de9b25SBarry Smith +  m - the matrix
33030de9b25SBarry Smith .  row - the row location of the entry
33130de9b25SBarry Smith .  col - the column location of the entry
33230de9b25SBarry Smith .  value - the value to insert
33330de9b25SBarry Smith -  mode - either INSERT_VALUES or ADD_VALUES
33430de9b25SBarry Smith 
33530de9b25SBarry Smith    Notes:
33630de9b25SBarry Smith    For efficiency one should use MatSetValues() and set several or many
33730de9b25SBarry Smith    values simultaneously if possible.
33830de9b25SBarry Smith 
33930de9b25SBarry Smith    Level: beginner
34030de9b25SBarry Smith 
34130de9b25SBarry Smith .seealso: MatSetValues(), MatSetValueLocal()
34230de9b25SBarry Smith M*/
343b951964fSBarry Smith #define MatSetValue(v,i,j,va,mode) \
344f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \
3451d73ed98SBarry Smith    MatSetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode))
34630de9b25SBarry Smith 
347ea06a074SBarry Smith #define MatGetValue(v,i,j,va) \
348f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,0) || \
3491d73ed98SBarry Smith    MatGetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&va))
35030de9b25SBarry Smith 
351d91e6319SBarry Smith #define MatSetValueLocal(v,i,j,va,mode) \
352f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \
3531d73ed98SBarry Smith    MatSetValuesLocal(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode))
35430de9b25SBarry Smith 
355d91e6319SBarry Smith /*E
356d91e6319SBarry Smith     MatOption - Options that may be set for a matrix and its behavior or storage
357d91e6319SBarry Smith 
358d91e6319SBarry Smith     Level: beginner
359d91e6319SBarry Smith 
3600a835dfdSSatish Balay    Any additions/changes here MUST also be made in include/finclude/petscmat.h
361d91e6319SBarry Smith 
362d91e6319SBarry Smith .seealso: MatSetOption()
363d91e6319SBarry Smith E*/
364*512a5fc5SBarry Smith typedef enum {MAT_ROW_ORIENTED,MAT_NEW_NONZERO_LOCATIONS,
3654e0d8c25SBarry Smith               MAT_SYMMETRIC,
3664e0d8c25SBarry Smith               MAT_STRUCTURALLY_SYMMETRIC,
3674e0d8c25SBarry Smith               MAT_NEW_DIAGONALS,MAT_INODE_LIMIT_1,
3684e0d8c25SBarry Smith               MAT_INODE_LIMIT_2,MAT_INODE_LIMIT_3,MAT_INODE_LIMIT_4,
3694e0d8c25SBarry Smith               MAT_INODE_LIMIT_5,MAT_IGNORE_OFF_PROC_ENTRIES,
3704e0d8c25SBarry Smith               MAT_NEW_NONZERO_LOCATION_ERR,
3714e0d8c25SBarry Smith               MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE,
3724e0d8c25SBarry Smith               MAT_KEEP_ZEROED_ROWS,MAT_IGNORE_ZERO_ENTRIES,
3734e0d8c25SBarry Smith               MAT_USE_INODES,
3744e0d8c25SBarry Smith               MAT_HERMITIAN,
3754e0d8c25SBarry Smith               MAT_SYMMETRY_ETERNAL,
3764e0d8c25SBarry Smith               MAT_USE_COMPRESSEDROW,
3774e0d8c25SBarry Smith               MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR,
3784e0d8c25SBarry Smith               MAT_GETROW_UPPERTRIANGULAR} MatOption;
379290bbb0aSBarry Smith extern const char *MatOptions[];
3804e0d8c25SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption,PetscTruth);
381be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,MatType*);
382ba966639SSatish Balay PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),MatType,t)
38384cb2905SBarry Smith 
384be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
385be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
386be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
387f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat);
388f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat);
389be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
390be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
391be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt);
392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]);
393ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
394be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]);
395be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *);
396ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
397be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt);
3987b80b807SBarry Smith 
399be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec);
400be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec);
401ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
402be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec);
403be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*);
404ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t)
405e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscTruth,t)
4061cbb95d3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscTruth*);
407be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec);
408ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
409be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec);
410be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec);
4112bebee5dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat,Mat,Mat);
412f5edf698SHong Zhang 
413d91e6319SBarry Smith /*E
414d91e6319SBarry Smith     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
415d91e6319SBarry Smith   its numerical values copied over or just its nonzero structure.
416d91e6319SBarry Smith 
417d91e6319SBarry Smith     Level: beginner
418d91e6319SBarry Smith 
419d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
420d91e6319SBarry Smith 
421d91e6319SBarry Smith .seealso: MatDuplicate()
422d91e6319SBarry Smith E*/
4232e8a6d31SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES} MatDuplicateOption;
4242e8a6d31SBarry Smith 
425f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,MatType,MatReuse,Mat*);
426ba966639SSatish Balay PetscPolymorphicFunction(MatConvert,(Mat A,MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a)
427be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*);
428ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a)
429ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a)
43094a9d846SBarry Smith 
431d91e6319SBarry Smith /*E
432d91e6319SBarry Smith     MatStructure - Indicates if the matrix has the same nonzero structure
433d91e6319SBarry Smith 
434d91e6319SBarry Smith     Level: beginner
435d91e6319SBarry Smith 
436d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
437d91e6319SBarry Smith 
43894b7f48cSBarry Smith .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
439d91e6319SBarry Smith E*/
440c537a176SHong Zhang typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure;
441cb5b572fSBarry Smith 
442be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure);
443be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer);
444be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*);
445ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t)
446e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscTruth,t)
447be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*);
448ba966639SSatish Balay PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t)
4491cbb95d3SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscReal,PetscTruth*);
4501cbb95d3SBarry Smith PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,0,&t),PetscTruth,t)
451be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*);
452be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*);
453f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(PetscViewer,MatType,Mat*);
454ba966639SSatish Balay PetscPolymorphicFunction(MatLoad,(PetscViewer v,MatType t),(v,t,&a),Mat,a)
4557b80b807SBarry Smith 
4568f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
4578f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
4588f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
4598f7157efSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
460d4fbbf0eSBarry Smith 
461d91e6319SBarry Smith /*S
462d91e6319SBarry Smith      MatInfo - Context of matrix information, used with MatGetInfo()
463d91e6319SBarry Smith 
464d91e6319SBarry Smith    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
465d91e6319SBarry Smith 
466d91e6319SBarry Smith    Level: intermediate
467d91e6319SBarry Smith 
468d91e6319SBarry Smith   Concepts: matrix^nonzero information
469d91e6319SBarry Smith 
470d9274352SBarry Smith .seealso:  MatGetInfo(), MatInfoType
471d91e6319SBarry Smith S*/
4724e220ebcSLois Curfman McInnes typedef struct {
473b0a32e0cSBarry Smith   PetscLogDouble rows_global,columns_global;         /* number of global rows and columns */
474b0a32e0cSBarry Smith   PetscLogDouble rows_local,columns_local;           /* number of local rows and columns */
475b0a32e0cSBarry Smith   PetscLogDouble block_size;                         /* block size */
476b0a32e0cSBarry Smith   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
477b0a32e0cSBarry Smith   PetscLogDouble memory;                             /* memory allocated */
478b0a32e0cSBarry Smith   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
479b0a32e0cSBarry Smith   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
480b0a32e0cSBarry Smith   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
481b0a32e0cSBarry Smith   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
4824e220ebcSLois Curfman McInnes } MatInfo;
4834e220ebcSLois Curfman McInnes 
484d9274352SBarry Smith /*E
485d9274352SBarry Smith     MatInfoType - Indicates if you want information about the local part of the matrix,
486d9274352SBarry Smith      the entire parallel matrix or the maximum over all the local parts.
487d9274352SBarry Smith 
488d9274352SBarry Smith     Level: beginner
489d9274352SBarry Smith 
490d9274352SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
491d9274352SBarry Smith 
492d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo
493d9274352SBarry Smith E*/
4947b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
495be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*);
496be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatValid(Mat,PetscTruth*);
497be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec);
498985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec,PetscInt[]);
499985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMin(Mat,Vec,PetscInt[]);
500985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
50186697f06SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowSum(Mat,Vec);
502be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,Mat*);
503ba966639SSatish Balay PetscPolymorphicFunction(MatTranspose,(Mat A),(A,&t),Mat,t)
504be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *);
505ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
506be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
507be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec);
508be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode);
509be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*);
510ba966639SSatish Balay PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t)
511be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*);
512be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*);
513be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*);
514be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*);
5157b80b807SBarry Smith 
516be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *);
517ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
518be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat);
519f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar);
520f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar);
521f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*);
522f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*);
5237b80b807SBarry Smith 
524be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth);
525be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec);
526be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec);
5275ef9f2a5SBarry Smith 
528be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*);
529be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*);
530be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
5318ee2e534SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRanges(Mat,const PetscInt**);
532f4b8409dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
5337b80b807SBarry Smith 
534be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
535be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]);
536be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,PetscInt,MatReuse,Mat *);
537abf0e977SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrixRaw(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt,MatReuse,Mat *);
538be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
539be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
540be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
541be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat);
542be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat);
543be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*);
544be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
545be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
546be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscScalar**,Mat*);
54743eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE)
548cd116e26SSatish Balay #include "petscctable.h"
54943eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
55043eb5e2fSMatthew Knepley #else
55143eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
55243eb5e2fSMatthew Knepley #endif
5538efafbd8SBarry Smith 
554be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
5557b80b807SBarry Smith 
556be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
557be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
558be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat);
55922440eb1SKris Buschelman 
560be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
561be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
562be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat);
56322440eb1SKris Buschelman 
564be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
565be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
566be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat);
567bc011b1eSHong Zhang 
568f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure);
56904aac2b0SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat,MatStructure);
570be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompress(Mat);
5711c741599SHong Zhang 
572f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar);
573f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar);
5747b80b807SBarry Smith 
575be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
576be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
577f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar);
578f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar);
579be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
580be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
581052efed2SBarry Smith 
582be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt);
583be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
58490f02eecSBarry Smith 
585be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec);
5860c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec);
587ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
588be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec);
589be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*);
59069db28dcSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);
591bd481603SBarry Smith 
592bd481603SBarry Smith /*MC
5930d2a7ff2SSatish Balay    MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
594bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
595bd481603SBarry Smith 
596bd481603SBarry Smith    Synopsis:
597c1ac3661SBarry Smith    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
598bd481603SBarry Smith 
599bd481603SBarry Smith    Collective on MPI_Comm
600bd481603SBarry Smith 
601bd481603SBarry Smith    Input Parameters:
602bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
603859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
604859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
605bd481603SBarry Smith 
606bd481603SBarry Smith    Output Parameters:
607bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
608bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
609bd481603SBarry Smith 
610bd481603SBarry Smith 
611bd481603SBarry Smith    Level: intermediate
612bd481603SBarry Smith 
613bd481603SBarry Smith    Notes:
614bd481603SBarry Smith    See the chapter in the users manual on performance for more details
615bd481603SBarry Smith 
6161d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
617bd481603SBarry Smith 
618bd481603SBarry Smith    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
619bd481603SBarry Smith 
620bd481603SBarry Smith   Concepts: preallocation^Matrix
621bd481603SBarry Smith 
622bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
623bd481603SBarry Smith           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
624bd481603SBarry Smith M*/
625c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
6267c922b88SBarry Smith { \
627c1ac3661SBarry Smith   PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
628c1ac3661SBarry Smith   _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\
629c1ac3661SBarry Smith   _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\
630c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
631c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp;
6327c922b88SBarry Smith 
633bd481603SBarry Smith /*MC
6340d2a7ff2SSatish Balay    MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
635bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
636bd481603SBarry Smith 
637bd481603SBarry Smith    Synopsis:
638c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
639bd481603SBarry Smith 
640bd481603SBarry Smith    Collective on MPI_Comm
641bd481603SBarry Smith 
642bd481603SBarry Smith    Input Parameters:
643bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
644859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
645859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
646bd481603SBarry Smith 
647bd481603SBarry Smith    Output Parameters:
648bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
649bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
650bd481603SBarry Smith 
651bd481603SBarry Smith 
652bd481603SBarry Smith    Level: intermediate
653bd481603SBarry Smith 
654bd481603SBarry Smith    Notes:
655bd481603SBarry Smith    See the chapter in the users manual on performance for more details
656bd481603SBarry Smith 
6571d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
658bd481603SBarry Smith 
659bd481603SBarry Smith   Concepts: preallocation^Matrix
660bd481603SBarry Smith 
661bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
662bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
663bd481603SBarry Smith M*/
664222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
665222b16d4SBarry Smith { \
666c1ac3661SBarry Smith   PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__end; \
667c1ac3661SBarry Smith   _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\
668c1ac3661SBarry Smith   _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\
669c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
670c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp;
671222b16d4SBarry Smith 
672bd481603SBarry Smith /*MC
673bd481603SBarry Smith    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
674bd481603SBarry Smith        inserted using a local number of the rows and columns
675bd481603SBarry Smith 
676bd481603SBarry Smith    Synopsis:
677c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
678bd481603SBarry Smith 
679bd481603SBarry Smith    Not Collective
680bd481603SBarry Smith 
681bd481603SBarry Smith    Input Parameters:
682bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
683bd481603SBarry Smith .  nrows - the number of rows indicated
6841d73ed98SBarry Smith .  rows - the indices of the rows
685bd481603SBarry Smith .  ncols - the number of columns in the matrix
686bd481603SBarry Smith .  cols - the columns indicated
687bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
688bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
689bd481603SBarry Smith 
690bd481603SBarry Smith 
691bd481603SBarry Smith    Level: intermediate
692bd481603SBarry Smith 
693bd481603SBarry Smith    Notes:
694bd481603SBarry Smith    See the chapter in the users manual on performance for more details
695bd481603SBarry Smith 
6961d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
697bd481603SBarry Smith 
698bd481603SBarry Smith   Concepts: preallocation^Matrix
699bd481603SBarry Smith 
700bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
701bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
702bd481603SBarry Smith M*/
703c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
704c4f061fbSSatish Balay {\
705c1ac3661SBarry Smith   PetscInt __l;\
706ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
707ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
708c4f061fbSSatish Balay   for (__l=0;__l<nrows;__l++) {\
709ef66eb69SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
710c4f061fbSSatish Balay   }\
711c4f061fbSSatish Balay }
712c4f061fbSSatish Balay 
713bd481603SBarry Smith /*MC
714bd481603SBarry Smith    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
715bd481603SBarry Smith        inserted using a local number of the rows and columns
716bd481603SBarry Smith 
717bd481603SBarry Smith    Synopsis:
718c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
719bd481603SBarry Smith 
720bd481603SBarry Smith    Not Collective
721bd481603SBarry Smith 
722bd481603SBarry Smith    Input Parameters:
723bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
724bd481603SBarry Smith .  nrows - the number of rows indicated
7251d73ed98SBarry Smith .  rows - the indices of the rows
726bd481603SBarry Smith .  ncols - the number of columns in the matrix
727bd481603SBarry Smith .  cols - the columns indicated
728bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
729bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
730bd481603SBarry Smith 
731bd481603SBarry Smith 
732bd481603SBarry Smith    Level: intermediate
733bd481603SBarry Smith 
734bd481603SBarry Smith    Notes:
735bd481603SBarry Smith    See the chapter in the users manual on performance for more details
736bd481603SBarry Smith 
737bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
738bd481603SBarry Smith 
739bd481603SBarry Smith   Concepts: preallocation^Matrix
740bd481603SBarry Smith 
741bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
742bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
743bd481603SBarry Smith M*/
744d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
745d3d32019SBarry Smith {\
746c1ac3661SBarry Smith   PetscInt __l;\
747d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
748d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
749d3d32019SBarry Smith   for (__l=0;__l<nrows;__l++) {\
750d3d32019SBarry Smith     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
751d3d32019SBarry Smith   }\
752d3d32019SBarry Smith }
753d3d32019SBarry Smith 
754bd481603SBarry Smith /*MC
755bd481603SBarry Smith    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
756bd481603SBarry Smith        inserted using a local number of the rows and columns
757bd481603SBarry Smith 
758bd481603SBarry Smith    Synopsis:
759c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
760bd481603SBarry Smith 
761bd481603SBarry Smith    Not Collective
762bd481603SBarry Smith 
763bd481603SBarry Smith    Input Parameters:
76464075487SBarry Smith +  row - the row
765bd481603SBarry Smith .  ncols - the number of columns in the matrix
766a50f8bf6SHong Zhang -  cols - the columns indicated
767a50f8bf6SHong Zhang 
768a50f8bf6SHong Zhang    Output Parameters:
769a50f8bf6SHong Zhang +  dnz - the array that will be passed to the matrix preallocation routines
770bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
771bd481603SBarry Smith 
772bd481603SBarry Smith 
773bd481603SBarry Smith    Level: intermediate
774bd481603SBarry Smith 
775bd481603SBarry Smith    Notes:
776bd481603SBarry Smith    See the chapter in the users manual on performance for more details
777bd481603SBarry Smith 
778bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
779bd481603SBarry Smith 
780bd481603SBarry Smith   Concepts: preallocation^Matrix
781bd481603SBarry Smith 
782bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
783bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
784bd481603SBarry Smith M*/
785c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
786c1ac3661SBarry Smith { PetscInt __i; \
7878ee2e534SBarry Smith   if (row < __rstart) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\
7888ee2e534SBarry 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);\
7897c922b88SBarry Smith   for (__i=0; __i<nc; __i++) {\
79064075487SBarry Smith     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
7917cc688d7SBarry Smith     else dnz[row - __rstart]++;\
7927c922b88SBarry Smith   }\
7937c922b88SBarry Smith }
7947c922b88SBarry Smith 
795bd481603SBarry Smith /*MC
796bd481603SBarry Smith    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
797bd481603SBarry Smith        inserted using a local number of the rows and columns
798bd481603SBarry Smith 
799bd481603SBarry Smith    Synopsis:
800c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
801bd481603SBarry Smith 
802bd481603SBarry Smith    Not Collective
803bd481603SBarry Smith 
804bd481603SBarry Smith    Input Parameters:
805bd481603SBarry Smith +  nrows - the number of rows indicated
8061d73ed98SBarry Smith .  rows - the indices of the rows
807bd481603SBarry Smith .  ncols - the number of columns in the matrix
808bd481603SBarry Smith .  cols - the columns indicated
809bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
810bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
811bd481603SBarry Smith 
812bd481603SBarry Smith 
813bd481603SBarry Smith    Level: intermediate
814bd481603SBarry Smith 
815bd481603SBarry Smith    Notes:
816bd481603SBarry Smith    See the chapter in the users manual on performance for more details
817bd481603SBarry Smith 
818bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
819bd481603SBarry Smith 
820bd481603SBarry Smith   Concepts: preallocation^Matrix
821bd481603SBarry Smith 
822bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
823bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
824bd481603SBarry Smith M*/
825d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
826c1ac3661SBarry Smith { PetscInt __i; \
827d3d32019SBarry Smith   for (__i=0; __i<nc; __i++) {\
828d3d32019SBarry Smith     if (cols[__i] >= __end) onz[row - __rstart]++; \
829d3d32019SBarry Smith     else if (cols[__i] >= row) dnz[row - __rstart]++;\
830d3d32019SBarry Smith   }\
831d3d32019SBarry Smith }
832d3d32019SBarry Smith 
833bd481603SBarry Smith /*MC
8340d2a7ff2SSatish Balay    MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
835bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
836bd481603SBarry Smith 
837bd481603SBarry Smith    Synopsis:
838c1ac3661SBarry Smith    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
839bd481603SBarry Smith 
840bd481603SBarry Smith    Collective on MPI_Comm
841bd481603SBarry Smith 
842bd481603SBarry Smith    Input Parameters:
843bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
844bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
845bd481603SBarry Smith 
846bd481603SBarry Smith 
847bd481603SBarry Smith    Level: intermediate
848bd481603SBarry Smith 
849bd481603SBarry Smith    Notes:
850bd481603SBarry Smith    See the chapter in the users manual on performance for more details
851bd481603SBarry Smith 
852bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
853bd481603SBarry Smith 
854bd481603SBarry Smith   Concepts: preallocation^Matrix
855bd481603SBarry Smith 
856bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
857bd481603SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
858bd481603SBarry Smith M*/
859ef66eb69SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree(dnz);CHKERRQ(_4_ierr);}
8607c922b88SBarry Smith 
861bd481603SBarry Smith 
862bd481603SBarry Smith 
8637b80b807SBarry Smith /* Routines unique to particular data structures */
864be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **);
865ba966639SSatish Balay PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
866be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBDiagGetData(Mat,PetscInt*,PetscInt*,PetscInt*[],PetscInt*[],PetscScalar***);
867698d4c6aSKris Buschelman 
868be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*);
869be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
870698d4c6aSKris Buschelman 
871be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
872be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
873be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
874c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
875c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
8767b80b807SBarry Smith 
877a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4
878a96a251dSBarry Smith 
879be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
880ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
881be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
882ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
883be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
884ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
885be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDensePreallocation(Mat,PetscScalar[]);
886be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]);
887273d9f13SBarry Smith 
888be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
889ba966639SSatish Balay PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
890be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
891be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
89253803f26SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
893be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
894be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
895be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]);
896be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
897be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
898284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
899be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]);
900be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
901be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
902be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void));
903273d9f13SBarry Smith 
904be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt);
905ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*);
9061b807ce4Svictorle 
907be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat);
908be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat);
9092e8a6d31SBarry Smith 
910be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*);
9113a7fca6bSBarry Smith 
9127b80b807SBarry Smith /*
9137b80b807SBarry Smith   These routines are not usually accessed directly, rather solving is
91494b7f48cSBarry Smith   done through the KSP and PC interfaces.
9157b80b807SBarry Smith */
9167b80b807SBarry Smith 
917d9274352SBarry Smith /*E
918d9274352SBarry Smith     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
919d9274352SBarry Smith        with an optional dynamic library name, for example
920d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
921d9274352SBarry Smith 
922d9274352SBarry Smith    Level: beginner
923d9274352SBarry Smith 
924e5a9bf91SBarry Smith    Cannot use const because the PC objects manipulate the string
925e5a9bf91SBarry Smith 
926d9274352SBarry Smith .seealso: MatGetOrdering()
927d9274352SBarry Smith E*/
92849773a63SBarry Smith #define MatOrderingType char*
929b12f92e5SBarry Smith #define MATORDERING_NATURAL   "natural"
930b12f92e5SBarry Smith #define MATORDERING_ND        "nd"
931b12f92e5SBarry Smith #define MATORDERING_1WD       "1wd"
932b12f92e5SBarry Smith #define MATORDERING_RCM       "rcm"
933b12f92e5SBarry Smith #define MATORDERING_QMD       "qmd"
934b12f92e5SBarry Smith #define MATORDERING_ROWLENGTH "rowlength"
93562152c8bSBarry Smith #define MATORDERING_DSC_ND    "dsc_nd"
93662152c8bSBarry Smith #define MATORDERING_DSC_MMD   "dsc_mmd"
93762152c8bSBarry Smith #define MATORDERING_DSC_MDF   "dsc_mdf"
938c06d978dSMatthew Knepley #define MATORDERING_CONSTRAINED "constrained"
939c06d978dSMatthew Knepley #define MATORDERING_IDENTITY  "identity"
940c06d978dSMatthew Knepley #define MATORDERING_REVERSE   "reverse"
941b12f92e5SBarry Smith 
942be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
943be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list);
944be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
94530de9b25SBarry Smith 
94630de9b25SBarry Smith /*MC
94730de9b25SBarry Smith    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the
94830de9b25SBarry Smith                                matrix package.
94930de9b25SBarry Smith 
95030de9b25SBarry Smith    Synopsis:
951c1ac3661SBarry Smith    PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
95230de9b25SBarry Smith 
95330de9b25SBarry Smith    Not Collective
95430de9b25SBarry Smith 
95530de9b25SBarry Smith    Input Parameters:
95630de9b25SBarry Smith +  sname - name of ordering (for example MATORDERING_ND)
95730de9b25SBarry Smith .  path - location of library where creation routine is
95830de9b25SBarry Smith .  name - name of function that creates the ordering type,a string
95930de9b25SBarry Smith -  function - function pointer that creates the ordering
96030de9b25SBarry Smith 
96130de9b25SBarry Smith    Level: developer
96230de9b25SBarry Smith 
96330de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
96430de9b25SBarry Smith    is ignored.
96530de9b25SBarry Smith 
96630de9b25SBarry Smith    Sample usage:
96730de9b25SBarry Smith .vb
96830de9b25SBarry Smith    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
96930de9b25SBarry Smith                "MyOrder",MyOrder);
97030de9b25SBarry Smith .ve
97130de9b25SBarry Smith 
97230de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
97330de9b25SBarry Smith $     MatOrderingSetType(part,"my_order)
97430de9b25SBarry Smith    or at runtime via the option
9752401956bSBarry Smith $     -pc_factor_mat_ordering_type my_order
97630de9b25SBarry Smith 
977ab901514SBarry Smith    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
97830de9b25SBarry Smith 
97930de9b25SBarry Smith .keywords: matrix, ordering, register
98030de9b25SBarry Smith 
98130de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
98230de9b25SBarry Smith M*/
983aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
984f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
985b12f92e5SBarry Smith #else
986f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
987b12f92e5SBarry Smith #endif
98830de9b25SBarry Smith 
989be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void);
990be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]);
9912bad1931SBarry Smith extern PetscTruth MatOrderingRegisterAllCalled;
992b0a32e0cSBarry Smith extern PetscFList MatOrderingList;
993d4fbbf0eSBarry Smith 
994be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
995a2ce50c7SBarry Smith 
996d91e6319SBarry Smith /*S
9972401956bSBarry Smith    MatFactorInfo - Data passed into the matrix factorization routines
998b00f7748SHong Zhang 
99915e8a5b3SHong Zhang    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE
1000b00f7748SHong Zhang 
100115e8a5b3SHong Zhang    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1002b00f7748SHong Zhang 
1003b00f7748SHong Zhang    Level: developer
1004b00f7748SHong Zhang 
1005d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1006d7d82daaSBarry Smith           MatFactorInfoInitialize()
1007b00f7748SHong Zhang 
1008b00f7748SHong Zhang S*/
1009b00f7748SHong Zhang typedef struct {
10100a29876aSHong Zhang   PetscReal     shiftnz;        /* scaling of identity added to matrix to prevent zero pivots */
1011fbf22428SSatish Balay   PetscReal     shiftpd;        /* if true, shift until positive pivots */
10122cea7109SBarry Smith   PetscReal     shift_fraction; /* record shift fraction taken */
101315e8a5b3SHong Zhang   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
101415e8a5b3SHong Zhang   PetscReal     dt;             /* drop tolerance */
1015b00f7748SHong Zhang   PetscReal     dtcol;          /* tolerance for pivoting */
101615e8a5b3SHong Zhang   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
101767e28bfeSBarry Smith   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1018348344bbSBarry Smith   PetscReal     levels;         /* ICC/ILU(levels) */
1019bcd9e38bSBarry Smith   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1020bcd9e38bSBarry Smith                                    factorization may be faster if do not pivot */
102115e8a5b3SHong Zhang   PetscReal     zeropivot;      /* pivot is called zero if less than this */
102215e8a5b3SHong Zhang } MatFactorInfo;
1023ffa6d0a5SLois Curfman McInnes 
1024be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*);
1025be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,MatFactorInfo*);
1026be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
1027be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,MatFactorInfo*,Mat*);
1028be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,MatFactorInfo*);
1029be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,MatFactorInfo*);
1030be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
1031be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
1032be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
1033be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,MatFactorInfo*);
1034be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,MatFactorInfo*,Mat*);
1035be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactor(Mat,IS,IS,MatFactorInfo*,Mat *);
1036be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1037be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec);
1038be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec);
1039be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec);
1040be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec);
1041be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec);
1042be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1043be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs);
10448ed539a5SBarry Smith 
1045be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat);
1046bb5a7306SBarry Smith 
1047d91e6319SBarry Smith /*E
1048d91e6319SBarry Smith     MatSORType - What type of (S)SOR to perform
1049bb1eb677SSatish Balay 
1050d91e6319SBarry Smith     Level: beginner
1051d91e6319SBarry Smith 
1052d9274352SBarry Smith    May be bitwise ORd together
1053d9274352SBarry Smith 
1054d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1055d91e6319SBarry Smith 
10564e7234bfSBarry Smith    MatSORType may be bitwise ORd together, so do not change the numbers
10574e7234bfSBarry Smith 
1058a1d92eedSBarry Smith .seealso: MatRelax(), MatPBRelax()
1059d91e6319SBarry Smith E*/
1060ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1061ee50ffe9SBarry Smith               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1062ee50ffe9SBarry Smith               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
106384cb2905SBarry Smith               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1064be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1065be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
10668ed539a5SBarry Smith 
1067d4fbbf0eSBarry Smith /*
1068639f9d9dSBarry Smith     These routines are for efficiently computing Jacobians via finite differences.
1069639f9d9dSBarry Smith */
1070b12f92e5SBarry Smith 
1071d9274352SBarry Smith /*E
1072d9274352SBarry Smith     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1073d9274352SBarry Smith        with an optional dynamic library name, for example
1074d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1075d9274352SBarry Smith 
1076d9274352SBarry Smith    Level: beginner
1077d9274352SBarry Smith 
1078d9274352SBarry Smith .seealso: MatGetColoring()
1079d9274352SBarry Smith E*/
1080e5a9bf91SBarry Smith #define MatColoringType const char*
1081b12f92e5SBarry Smith #define MATCOLORING_NATURAL "natural"
1082b12f92e5SBarry Smith #define MATCOLORING_SL      "sl"
1083b12f92e5SBarry Smith #define MATCOLORING_LF      "lf"
1084b12f92e5SBarry Smith #define MATCOLORING_ID      "id"
1085b12f92e5SBarry Smith 
10862e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,MatColoringType,ISColoring*);
10872e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *));
108830de9b25SBarry Smith 
108930de9b25SBarry Smith /*MC
109030de9b25SBarry Smith    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
109130de9b25SBarry Smith                                matrix package.
109230de9b25SBarry Smith 
109330de9b25SBarry Smith    Synopsis:
1094c1ac3661SBarry Smith    PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring))
109530de9b25SBarry Smith 
109630de9b25SBarry Smith    Not Collective
109730de9b25SBarry Smith 
109830de9b25SBarry Smith    Input Parameters:
109930de9b25SBarry Smith +  sname - name of Coloring (for example MATCOLORING_SL)
110030de9b25SBarry Smith .  path - location of library where creation routine is
110130de9b25SBarry Smith .  name - name of function that creates the Coloring type, a string
110230de9b25SBarry Smith -  function - function pointer that creates the coloring
110330de9b25SBarry Smith 
110430de9b25SBarry Smith    Level: developer
110530de9b25SBarry Smith 
110630de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
110730de9b25SBarry Smith    is ignored.
110830de9b25SBarry Smith 
110930de9b25SBarry Smith    Sample usage:
111030de9b25SBarry Smith .vb
111130de9b25SBarry Smith    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
111230de9b25SBarry Smith                "MyColor",MyColor);
111330de9b25SBarry Smith .ve
111430de9b25SBarry Smith 
111530de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
111630de9b25SBarry Smith $     MatColoringSetType(part,"my_color")
111730de9b25SBarry Smith    or at runtime via the option
111830de9b25SBarry Smith $     -mat_coloring_type my_color
111930de9b25SBarry Smith 
1120ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
112130de9b25SBarry Smith 
112230de9b25SBarry Smith .keywords: matrix, Coloring, register
112330de9b25SBarry Smith 
112430de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
112530de9b25SBarry Smith M*/
1126aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1127f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1128b12f92e5SBarry Smith #else
1129f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1130b12f92e5SBarry Smith #endif
113130de9b25SBarry Smith 
11322bad1931SBarry Smith extern PetscTruth MatColoringRegisterAllCalled;
1133f1144a30SSatish Balay 
1134be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]);
1135be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void);
1136be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1137639f9d9dSBarry Smith 
1138d9274352SBarry Smith /*S
1139d9274352SBarry Smith      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1140d9274352SBarry Smith         and coloring
1141639f9d9dSBarry Smith 
1142d9274352SBarry Smith    Level: beginner
1143d9274352SBarry Smith 
1144d9274352SBarry Smith   Concepts: coloring, sparse Jacobian, finite differences
1145d9274352SBarry Smith 
1146d9274352SBarry Smith .seealso:  MatFDColoringCreate()
1147d9274352SBarry Smith S*/
1148e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring;
1149639f9d9dSBarry Smith 
1150be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1151be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring);
1152be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer);
1153be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
11544a9d489dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1155be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1156be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFrequency(MatFDColoring,PetscInt);
1157be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFrequency(MatFDColoring,PetscInt*);
1158be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring);
1159be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1160be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1161be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetRecompute(MatFDColoring);
1162be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec);
1163be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1164639f9d9dSBarry Smith /*
11650752156aSBarry Smith     These routines are for partitioning matrices: currently used only
11663eda8832SBarry Smith   for adjacency matrix, MatCreateMPIAdj().
11670752156aSBarry Smith */
1168ca161407SBarry Smith 
1169d9274352SBarry Smith /*S
1170d9274352SBarry Smith      MatPartitioning - Object for managing the partitioning of a matrix or graph
1171d9274352SBarry Smith 
1172d9274352SBarry Smith    Level: beginner
1173d9274352SBarry Smith 
1174d9274352SBarry Smith   Concepts: partitioning
1175d9274352SBarry Smith 
1176743a1026Svictorle .seealso:  MatPartitioningCreate(), MatPartitioningType
1177d9274352SBarry Smith S*/
117891e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning;
1179d9274352SBarry Smith 
1180d9274352SBarry Smith /*E
11815bc6e7ccSvictorle     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1182d9274352SBarry Smith        with an optional dynamic library name, for example
1183d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1184d9274352SBarry Smith 
1185d9274352SBarry Smith    Level: beginner
1186d9274352SBarry Smith 
1187b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning
1188d9274352SBarry Smith E*/
1189e5a9bf91SBarry Smith #define MatPartitioningType const char*
11908ba1e511SMatthew Knepley #define MAT_PARTITIONING_CURRENT  "current"
1191c2ec2a73SHong Zhang #define MAT_PARTITIONING_SQUARE   "square"
11928ba1e511SMatthew Knepley #define MAT_PARTITIONING_PARMETIS "parmetis"
119371306c60Sjroman #define MAT_PARTITIONING_CHACO    "chaco"
119471306c60Sjroman #define MAT_PARTITIONING_JOSTLE   "jostle"
119571306c60Sjroman #define MAT_PARTITIONING_PARTY    "party"
119671306c60Sjroman #define MAT_PARTITIONING_SCOTCH   "scotch"
119771306c60Sjroman 
1198ca161407SBarry Smith 
1199be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*);
12002e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,MatPartitioningType);
1201be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt);
1202be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat);
1203be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1204be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1205be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*);
1206be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning);
12072aabb6bbSBarry Smith 
1208be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
120930de9b25SBarry Smith 
121030de9b25SBarry Smith /*MC
121130de9b25SBarry Smith    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
121230de9b25SBarry Smith    matrix package.
121330de9b25SBarry Smith 
121430de9b25SBarry Smith    Synopsis:
1215c1ac3661SBarry Smith    PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
121630de9b25SBarry Smith 
121730de9b25SBarry Smith    Not Collective
121830de9b25SBarry Smith 
121930de9b25SBarry Smith    Input Parameters:
122030de9b25SBarry Smith +  sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis
122130de9b25SBarry Smith .  path - location of library where creation routine is
122230de9b25SBarry Smith .  name - name of function that creates the partitioning type, a string
122330de9b25SBarry Smith -  function - function pointer that creates the partitioning type
122430de9b25SBarry Smith 
122530de9b25SBarry Smith    Level: developer
122630de9b25SBarry Smith 
122730de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
122830de9b25SBarry Smith    is ignored.
122930de9b25SBarry Smith 
123030de9b25SBarry Smith    Sample usage:
123130de9b25SBarry Smith .vb
123230de9b25SBarry Smith    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
123330de9b25SBarry Smith                "MyPartCreate",MyPartCreate);
123430de9b25SBarry Smith .ve
123530de9b25SBarry Smith 
123630de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
123730de9b25SBarry Smith $     MatPartitioningSetType(part,"my_part")
123830de9b25SBarry Smith    or at runtime via the option
123930de9b25SBarry Smith $     -mat_partitioning_type my_part
124030de9b25SBarry Smith 
1241ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
124230de9b25SBarry Smith 
124330de9b25SBarry Smith .keywords: matrix, partitioning, register
124430de9b25SBarry Smith 
124530de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
124630de9b25SBarry Smith M*/
1247aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1248f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
12492aabb6bbSBarry Smith #else
1250f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
12512aabb6bbSBarry Smith #endif
12522aabb6bbSBarry Smith 
12532bad1931SBarry Smith extern PetscTruth MatPartitioningRegisterAllCalled;
1254f1144a30SSatish Balay 
1255be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]);
1256be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void);
12572bad1931SBarry Smith 
1258be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer);
1259be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning);
1260be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,MatPartitioningType*);
1261ca161407SBarry Smith 
1262be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
12630752156aSBarry Smith 
1264be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1265be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning);
126671306c60Sjroman 
1267954b3ec6SBarry Smith typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType;
1268be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
126971306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1270be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1271be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
127271306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1273be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1274be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1275be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
127671306c60Sjroman 
127771306c60Sjroman #define MP_PARTY_OPT "opt"
127871306c60Sjroman #define MP_PARTY_LIN "lin"
127971306c60Sjroman #define MP_PARTY_SCA "sca"
128071306c60Sjroman #define MP_PARTY_RAN "ran"
128171306c60Sjroman #define MP_PARTY_GBF "gbf"
128271306c60Sjroman #define MP_PARTY_GCF "gcf"
128371306c60Sjroman #define MP_PARTY_BUB "bub"
128471306c60Sjroman #define MP_PARTY_DEF "def"
1285be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*);
128671306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs"
128771306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl"
128871306c60Sjroman #define MP_PARTY_NONE "no"
1289be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*);
1290be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1291be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth);
1292be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth);
129371306c60Sjroman 
129471306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1295be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*);
1296be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning);
1297be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1298be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1299be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*);
130071306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1301be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1302be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning);
1303be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*);
130471306c60Sjroman 
13050752156aSBarry Smith /*
13060a835dfdSSatish Balay     If you add entries here you must also add them to finclude/petscmat.h
1307d4fbbf0eSBarry Smith */
13081c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0,
13091c1c02c0SLois Curfman McInnes                MATOP_GET_ROW=1,
13101c1c02c0SLois Curfman McInnes                MATOP_RESTORE_ROW=2,
13111c1c02c0SLois Curfman McInnes                MATOP_MULT=3,
13121c1c02c0SLois Curfman McInnes                MATOP_MULT_ADD=4,
13137c922b88SBarry Smith                MATOP_MULT_TRANSPOSE=5,
13147c922b88SBarry Smith                MATOP_MULT_TRANSPOSE_ADD=6,
13151c1c02c0SLois Curfman McInnes                MATOP_SOLVE=7,
13161c1c02c0SLois Curfman McInnes                MATOP_SOLVE_ADD=8,
13177c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE=9,
13187c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE_ADD=10,
13191c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR=11,
13201c1c02c0SLois Curfman McInnes                MATOP_CHOLESKYFACTOR=12,
13211c1c02c0SLois Curfman McInnes                MATOP_RELAX=13,
13221c1c02c0SLois Curfman McInnes                MATOP_TRANSPOSE=14,
13231c1c02c0SLois Curfman McInnes                MATOP_GETINFO=15,
13241c1c02c0SLois Curfman McInnes                MATOP_EQUAL=16,
13251c1c02c0SLois Curfman McInnes                MATOP_GET_DIAGONAL=17,
13261c1c02c0SLois Curfman McInnes                MATOP_DIAGONAL_SCALE=18,
13271c1c02c0SLois Curfman McInnes                MATOP_NORM=19,
13281c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_BEGIN=20,
13291c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_END=21,
13301c1c02c0SLois Curfman McInnes                MATOP_COMPRESS=22,
13311c1c02c0SLois Curfman McInnes                MATOP_SET_OPTION=23,
13321c1c02c0SLois Curfman McInnes                MATOP_ZERO_ENTRIES=24,
13331c1c02c0SLois Curfman McInnes                MATOP_ZERO_ROWS=25,
13341c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR_SYMBOLIC=26,
13351c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR_NUMERIC=27,
13361c1c02c0SLois Curfman McInnes                MATOP_CHOLESKY_FACTOR_SYMBOLIC=28,
13371c1c02c0SLois Curfman McInnes                MATOP_CHOLESKY_FACTOR_NUMERIC=29,
1338d643ce63SMatthew Knepley                MATOP_SETUP_PREALLOCATION=30,
1339d643ce63SMatthew Knepley                MATOP_ILUFACTOR_SYMBOLIC=31,
1340d643ce63SMatthew Knepley                MATOP_ICCFACTOR_SYMBOLIC=32,
1341d643ce63SMatthew Knepley                MATOP_GET_ARRAY=33,
1342d643ce63SMatthew Knepley                MATOP_RESTORE_ARRAY=34,
1343e26f1c3cSBarry Smith                MATOP_DUPLICATE=35,
1344d643ce63SMatthew Knepley                MATOP_FORWARD_SOLVE=36,
1345d643ce63SMatthew Knepley                MATOP_BACKWARD_SOLVE=37,
1346d643ce63SMatthew Knepley                MATOP_ILUFACTOR=38,
1347d643ce63SMatthew Knepley                MATOP_ICCFACTOR=39,
1348d643ce63SMatthew Knepley                MATOP_AXPY=40,
1349d643ce63SMatthew Knepley                MATOP_GET_SUBMATRICES=41,
1350d643ce63SMatthew Knepley                MATOP_INCREASE_OVERLAP=42,
1351d643ce63SMatthew Knepley                MATOP_GET_VALUES=43,
1352d643ce63SMatthew Knepley                MATOP_COPY=44,
1353d643ce63SMatthew Knepley                MATOP_PRINT_HELP=45,
1354d643ce63SMatthew Knepley                MATOP_SCALE=46,
1355d643ce63SMatthew Knepley                MATOP_SHIFT=47,
1356d643ce63SMatthew Knepley                MATOP_DIAGONAL_SHIFT=48,
1357d643ce63SMatthew Knepley                MATOP_ILUDT_FACTOR=49,
1358d643ce63SMatthew Knepley                MATOP_GET_BLOCK_SIZE=50,
1359d643ce63SMatthew Knepley                MATOP_GET_ROW_IJ=51,
1360d643ce63SMatthew Knepley                MATOP_RESTORE_ROW_IJ=52,
1361d643ce63SMatthew Knepley                MATOP_GET_COLUMN_IJ=53,
1362d643ce63SMatthew Knepley                MATOP_RESTORE_COLUMN_IJ=54,
1363d643ce63SMatthew Knepley                MATOP_FDCOLORING_CREATE=55,
1364d643ce63SMatthew Knepley                MATOP_COLORING_PATCH=56,
1365d643ce63SMatthew Knepley                MATOP_SET_UNFACTORED=57,
1366d643ce63SMatthew Knepley                MATOP_PERMUTE=58,
1367d643ce63SMatthew Knepley                MATOP_SET_VALUES_BLOCKED=59,
1368d643ce63SMatthew Knepley                MATOP_GET_SUBMATRIX=60,
1369d643ce63SMatthew Knepley                MATOP_DESTROY=61,
1370d643ce63SMatthew Knepley                MATOP_VIEW=62,
1371d643ce63SMatthew Knepley                MATOP_GET_MAPS=63,
1372d643ce63SMatthew Knepley                MATOP_USE_SCALED_FORM=64,
1373d643ce63SMatthew Knepley                MATOP_SCALE_SYSTEM=65,
1374d643ce63SMatthew Knepley                MATOP_UNSCALE_SYSTEM=66,
1375ba16a8cbSKris Buschelman                MATOP_SET_LOCAL_TO_GLOBAL_MAP=67,
1376d643ce63SMatthew Knepley                MATOP_SET_VALUES_LOCAL=68,
1377d643ce63SMatthew Knepley                MATOP_ZERO_ROWS_LOCAL=69,
1378d643ce63SMatthew Knepley                MATOP_GET_ROW_MAX=70,
1379d643ce63SMatthew Knepley                MATOP_CONVERT=71,
1380d643ce63SMatthew Knepley                MATOP_SET_COLORING=72,
1381d643ce63SMatthew Knepley                MATOP_SET_VALUES_ADIC=73,
1382d643ce63SMatthew Knepley                MATOP_SET_VALUES_ADIFOR=74,
1383d643ce63SMatthew Knepley                MATOP_FD_COLORING_APPLY=75,
1384d643ce63SMatthew Knepley                MATOP_SET_FROM_OPTIONS=76,
1385ba16a8cbSKris Buschelman                MATOP_MULT_CON=77,
1386ba16a8cbSKris Buschelman                MATOP_MULT_TRANSPOSE_CON=78,
1387ba16a8cbSKris Buschelman                MATOP_ILU_FACTOR_SYMBOLIC_CON=79,
1388d643ce63SMatthew Knepley                MATOP_PERMUTE_SPARSIFY=80,
1389d643ce63SMatthew Knepley                MATOP_MULT_MULTIPLE=81,
139041acf15aSKris Buschelman                MATOP_SOLVE_MULTIPLE=82,
139141acf15aSKris Buschelman                MATOP_GET_INERTIA=83,
139241acf15aSKris Buschelman                MATOP_LOAD=84,
139341acf15aSKris Buschelman                MATOP_IS_SYMMETRIC=85,
139441acf15aSKris Buschelman                MATOP_IS_HERMITIAN=86,
139541acf15aSKris Buschelman                MATOP_IS_STRUCTURALLY_SYMMETRIC=87,
139641acf15aSKris Buschelman                MATOP_PB_RELAX=88,
139741acf15aSKris Buschelman                MATOP_GET_VECS=89,
139841acf15aSKris Buschelman                MATOP_MAT_MULT=90,
139941acf15aSKris Buschelman                MATOP_MAT_MULT_SYMBOLIC=91,
140041acf15aSKris Buschelman                MATOP_MAT_MULT_NUMERIC=92,
140141acf15aSKris Buschelman                MATOP_PTAP=93,
140241acf15aSKris Buschelman                MATOP_PTAP_SYMBOLIC=94,
1403bc011b1eSHong Zhang                MATOP_PTAP_NUMERIC=95,
1404bc011b1eSHong Zhang                MATOP_MAT_MULTTRANSPOSE=96,
1405bc011b1eSHong Zhang                MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=97,
14067ba1a0bfSKris Buschelman                MATOP_MAT_MULTTRANSPOSE_NUMERIC=98,
14077ba1a0bfSKris Buschelman                MATOP_PTAP_SYMBOLIC_SEQAIJ=99,
14087ba1a0bfSKris Buschelman                MATOP_PTAP_NUMERIC_SEQAIJ=100,
14097ba1a0bfSKris Buschelman                MATOP_PTAP_SYMBOLIC_MPIAIJ=101,
141087d4246cSBarry Smith                MATOP_PTAP_NUMERIC_MPIAIJ=102,
1411f5edf698SHong Zhang                MATOP_SET_VALUES_ROW = 105,
1412d5c63f83SSatish Balay                MATOP_GET_ROW_UTRIANGULAR=108,
14132bebee5dSHong Zhang                MATOP_RESTORE_ROW_UTRIANGULAR=109,
141469db28dcSHong Zhang                MATOP_MATSOLVE=110,
141569db28dcSHong Zhang                MATOP_GET_REDUNDANTMATRIX=111
1416fae171e0SBarry Smith              } MatOperation;
1417be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*);
1418be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void));
1419be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void));
1420be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*);
1421112a2221SBarry Smith 
142290ace30eSBarry Smith /*
142390ace30eSBarry Smith    Codes for matrices stored on disk. By default they are
142490ace30eSBarry Smith  stored in a universal format. By changing the format with
1425fb9695e5SSatish Balay  PetscViewerSetFormat(viewer,PETSC_VIEWER_BINARY_NATIVE); the matrices will
142690ace30eSBarry Smith  be stored in a way natural for the matrix, for example dense matrices
142790ace30eSBarry Smith  would be stored as dense. Matrices stored this way may only be
142890ace30eSBarry Smith  read into matrices of the same time.
142990ace30eSBarry Smith */
143090ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1
143190ace30eSBarry Smith 
1432be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1433be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*);
14341f4e1ec7SBarry Smith 
1435d9274352SBarry Smith /*S
1436d9274352SBarry Smith      MatNullSpace - Object that removes a null space from a vector, i.e.
1437d9274352SBarry Smith          orthogonalizes the vector to a subsapce
1438d9274352SBarry Smith 
1439f7a9e4ceSBarry Smith    Level: advanced
1440d9274352SBarry Smith 
1441d9274352SBarry Smith   Concepts: matrix; linear operator, null space
1442d9274352SBarry Smith 
14436e1639daSBarry Smith   Users manual sections:
14446e1639daSBarry Smith .   sec_singular
14456e1639daSBarry Smith 
1446d9274352SBarry Smith .seealso:  MatNullSpaceCreate()
1447d9274352SBarry Smith S*/
144874637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace;
1449d9274352SBarry Smith 
1450be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*);
1451281d1b2eSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(Vec,void*),void*);
1452be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace);
1453be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1454be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace);
1455be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat);
145674637425SBarry Smith 
1457be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS);
1458be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1459be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
146046129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat);
14613f1d51d7SBarry Smith 
1462be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*);
1463be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*);
1464be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*);
1465c4f061fbSSatish Balay 
1466be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*);
1467b0a32e0cSBarry Smith 
1468be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec);
146904f1ad80SBarry Smith 
1470fef1beadSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
14713ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetBase(Mat,Vec,Vec);
14723ec795f1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1473e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1474e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1475e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDAddNullSpace(Mat,MatNullSpace);
1476e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1477e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDResetHHistory(Mat);
1478e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctionError(Mat,PetscReal);
1479e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetPeriod(Mat,PetscInt);
1480e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDGetH(Mat,PetscScalar *);
1481e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFromOptions(Mat);
1482e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1483e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1484e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDDSSetUmin(Mat,PetscReal);
1485e884886fSBarry Smith 
1486e884886fSBarry Smith 
1487e884886fSBarry Smith typedef struct _p_MatMFFD* MatMFFD;
1488e884886fSBarry Smith 
1489e884886fSBarry Smith /*E
1490e884886fSBarry Smith     MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1491e884886fSBarry Smith 
1492e884886fSBarry Smith    Level: beginner
1493e884886fSBarry Smith 
1494e884886fSBarry Smith .seealso: MatMFFDSetType(), MatMFFDRegister()
1495e884886fSBarry Smith E*/
1496e884886fSBarry Smith #define MatMFFDType const char*
1497e884886fSBarry Smith #define MATMFFD_DS  "ds"
1498e884886fSBarry Smith #define MATMFFD_WP  "wp"
1499e884886fSBarry Smith 
1500e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetType(Mat,MatMFFDType);
1501e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD));
1502e884886fSBarry Smith 
1503e884886fSBarry Smith /*MC
1504e884886fSBarry Smith    MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry.
1505e884886fSBarry Smith 
1506e884886fSBarry Smith    Synopsis:
1507e884886fSBarry Smith    PetscErrorCode MatMFFDRegisterDynamic(char *name_solver,char *path,char *name_create,PetscErrorCode (*routine_create)(MatMFFD))
1508e884886fSBarry Smith 
1509e884886fSBarry Smith    Not Collective
1510e884886fSBarry Smith 
1511e884886fSBarry Smith    Input Parameters:
1512e884886fSBarry Smith +  name_solver - name of a new user-defined compute-h module
1513e884886fSBarry Smith .  path - path (either absolute or relative) the library containing this solver
1514e884886fSBarry Smith .  name_create - name of routine to create method context
1515e884886fSBarry Smith -  routine_create - routine to create method context
1516e884886fSBarry Smith 
1517e884886fSBarry Smith    Level: developer
1518e884886fSBarry Smith 
1519e884886fSBarry Smith    Notes:
1520e884886fSBarry Smith    MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers.
1521e884886fSBarry Smith 
1522e884886fSBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
1523e884886fSBarry Smith    is ignored.
1524e884886fSBarry Smith 
1525e884886fSBarry Smith    Sample usage:
1526e884886fSBarry Smith .vb
1527e884886fSBarry Smith    MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a,
1528e884886fSBarry Smith                "MyHCreate",MyHCreate);
1529e884886fSBarry Smith .ve
1530e884886fSBarry Smith 
1531e884886fSBarry Smith    Then, your solver can be chosen with the procedural interface via
1532e884886fSBarry Smith $     MatMFFDSetType(mfctx,"my_h")
1533e884886fSBarry Smith    or at runtime via the option
1534e884886fSBarry Smith $     -snes_mf_type my_h
1535e884886fSBarry Smith 
1536e884886fSBarry Smith .keywords: MatMFFD, register
1537e884886fSBarry Smith 
1538e884886fSBarry Smith .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy()
1539e884886fSBarry Smith M*/
1540e884886fSBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1541e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0)
1542e884886fSBarry Smith #else
1543e884886fSBarry Smith #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d)
1544e884886fSBarry Smith #endif
1545e884886fSBarry Smith 
1546e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterAll(const char[]);
1547e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterDestroy(void);
1548e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDDefaultSetUmin(Mat,PetscReal);
1549e884886fSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDWPSetComputeNormU(Mat,PetscTruth);
1550e884886fSBarry Smith 
1551e884886fSBarry Smith 
1552be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1553be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
15547dbadf16SMatthew Knepley 
1555e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END
15562eac72dbSBarry Smith #endif
1557