xref: /petsc/include/petscmat.h (revision d5c63f83461802b09b2f75bcb82186f61005cdcb)
12eac72dbSBarry Smith /*
22eac72dbSBarry Smith      Include file for the matrix component of PETSc
32eac72dbSBarry Smith */
40a835dfdSSatish Balay #ifndef __PETSCMAT_H
50a835dfdSSatish Balay #define __PETSCMAT_H
60a835dfdSSatish Balay #include "petscvec.h"
7e9fa29b7SSatish Balay PETSC_EXTERN_CXX_BEGIN
82eac72dbSBarry Smith 
9d9274352SBarry Smith /*S
10d9274352SBarry Smith      Mat - Abstract PETSc matrix object
112eac72dbSBarry Smith 
12d91e6319SBarry Smith    Level: beginner
13d91e6319SBarry Smith 
14d9274352SBarry Smith   Concepts: matrix; linear operator
15d9274352SBarry Smith 
16d9274352SBarry Smith .seealso:  MatCreate(), MatType, MatSetType()
17d9274352SBarry Smith S*/
18d9274352SBarry Smith typedef struct _p_Mat*           Mat;
19d9274352SBarry Smith 
20d9274352SBarry Smith /*E
21d9274352SBarry Smith     MatType - String with the name of a PETSc matrix or the creation function
22d9274352SBarry Smith        with an optional dynamic library name, for example
23d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:mymatcreate()
24d9274352SBarry Smith 
25d9274352SBarry Smith    Level: beginner
26d9274352SBarry Smith 
27d9274352SBarry Smith .seealso: MatSetType(), Mat
28d91e6319SBarry Smith E*/
29273d9f13SBarry Smith #define MATSAME            "same"
30273d9f13SBarry Smith #define MATSEQMAIJ         "seqmaij"
31273d9f13SBarry Smith #define MATMPIMAIJ         "mpimaij"
32209238afSKris Buschelman #define MATMAIJ            "maij"
33273d9f13SBarry Smith #define MATIS              "is"
34273d9f13SBarry Smith #define MATMPIROWBS        "mpirowbs"
35273d9f13SBarry Smith #define MATSEQAIJ          "seqaij"
36273d9f13SBarry Smith #define MATMPIAIJ          "mpiaij"
37209238afSKris Buschelman #define MATAIJ             "aij"
38273d9f13SBarry Smith #define MATSHELL           "shell"
39273d9f13SBarry Smith #define MATSEQBDIAG        "seqbdiag"
40273d9f13SBarry Smith #define MATMPIBDIAG        "mpibdiag"
41209238afSKris Buschelman #define MATBDIAG           "bdiag"
42209238afSKris Buschelman #define MATSEQDENSE        "seqdense"
43273d9f13SBarry Smith #define MATMPIDENSE        "mpidense"
44209238afSKris Buschelman #define MATDENSE           "dense"
45273d9f13SBarry Smith #define MATSEQBAIJ         "seqbaij"
46273d9f13SBarry Smith #define MATMPIBAIJ         "mpibaij"
47209238afSKris Buschelman #define MATBAIJ            "baij"
48273d9f13SBarry Smith #define MATMPIADJ          "mpiadj"
49273d9f13SBarry Smith #define MATSEQSBAIJ        "seqsbaij"
50273d9f13SBarry Smith #define MATMPISBAIJ        "mpisbaij"
51209238afSKris Buschelman #define MATSBAIJ           "sbaij"
52cebc7f6cSBarry Smith #define MATDAAD            "daad"
53cebc7f6cSBarry Smith #define MATMFFD            "mffd"
54c8a8475eSBarry Smith #define MATNORMAL          "normal"
55ab92ecdeSBarry Smith #define MATLRC             "lrc"
56b3a1e11cSKris Buschelman #define MATSEQAIJSPOOLES   "seqaijspooles"
57d10c748bSKris Buschelman #define MATMPIAIJSPOOLES   "mpiaijspooles"
589abb65ffSKris Buschelman #define MATSEQSBAIJSPOOLES "seqsbaijspooles"
5922191285SKris Buschelman #define MATMPISBAIJSPOOLES "mpisbaijspooles"
60bb4d4166SHong Zhang #define MATAIJSPOOLES      "aijspooles"
61bb4d4166SHong Zhang #define MATSBAIJSPOOLES    "sbaijspooles"
6214b396bbSKris Buschelman #define MATSUPERLU         "superlu"
631d96aa28SKris Buschelman #define MATSUPERLU_DIST    "superlu_dist"
641677d0b8SKris Buschelman #define MATUMFPACK         "umfpack"
65e8aa55a4SKris Buschelman #define MATESSL            "essl"
664eb8e494SKris Buschelman #define MATLUSOL           "lusol"
67397b6df1SKris Buschelman #define MATAIJMUMPS        "aijmumps"
68397b6df1SKris Buschelman #define MATSBAIJMUMPS      "sbaijmumps"
698da957c5SKris Buschelman #define MATDSCPACK         "dscpack"
707065e2aaSKris Buschelman #define MATMATLAB          "matlab"
714b8d99adSRichard Tran Mills #define MATSEQCSRPERM      "seqcsrperm"
7218def556SRichard Tran Mills #define MATMPICSRPERM      "mpicsrperm"
73814655b8SBarry Smith #define MATCSRPERM         "csrperm"
74c0aa2d19SHong Zhang #define MATPLAPACK         "plapack"
75f69a0ea3SMatthew Knepley #define MatType const char*
76d91e6319SBarry Smith 
77c06d978dSMatthew Knepley /* Logging support */
78552e946dSBarry Smith #define    MAT_FILE_COOKIE 1211216    /* used to indicate matrices in binary files */
79be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_COOKIE;
80be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_FDCOLORING_COOKIE;
81be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_PARTITIONING_COOKIE;
82be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_NULLSPACE_COOKIE;
836849ba73SBarry Smith extern PetscEvent  MAT_Mult, MAT_MultMatrixFree, MAT_Mults, MAT_MultConstrained, MAT_MultAdd, MAT_MultTranspose;
846849ba73SBarry Smith extern PetscEvent  MAT_MultTransposeConstrained, MAT_MultTransposeAdd, MAT_Solve, MAT_Solves, MAT_SolveAdd, MAT_SolveTranspose;
856849ba73SBarry Smith extern PetscEvent  MAT_SolveTransposeAdd, MAT_Relax, MAT_ForwardSolve, MAT_BackwardSolve, MAT_LUFactor, MAT_LUFactorSymbolic;
866849ba73SBarry Smith extern PetscEvent  MAT_LUFactorNumeric, MAT_CholeskyFactor, MAT_CholeskyFactorSymbolic, MAT_CholeskyFactorNumeric, MAT_ILUFactor;
876849ba73SBarry Smith extern PetscEvent  MAT_ILUFactorSymbolic, MAT_ICCFactorSymbolic, MAT_Copy, MAT_Convert, MAT_Scale, MAT_AssemblyBegin;
886849ba73SBarry Smith extern PetscEvent  MAT_AssemblyEnd, MAT_SetValues, MAT_GetValues, MAT_GetRow, MAT_GetSubMatrices, MAT_GetColoring, MAT_GetOrdering;
896849ba73SBarry Smith extern PetscEvent  MAT_IncreaseOverlap, MAT_Partitioning, MAT_ZeroEntries, MAT_Load, MAT_View, MAT_AXPY, MAT_FDColoringCreate;
906849ba73SBarry Smith extern PetscEvent  MAT_FDColoringApply, MAT_Transpose, MAT_FDColoringFunction;
91cb00f407SKris Buschelman extern PetscEvent  MAT_MatMult, MAT_MatMultSymbolic, MAT_MatMultNumeric;
92534c1384SKris Buschelman extern PetscEvent  MAT_PtAP, MAT_PtAPSymbolic, MAT_PtAPNumeric;
93bc011b1eSHong Zhang extern PetscEvent  MAT_MatMultTranspose, MAT_MatMultTransposeSymbolic, MAT_MatMultTransposeNumeric;
94c06d978dSMatthew Knepley 
95ceb03754SKris Buschelman /*E
96ceb03754SKris Buschelman     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
97ceb03754SKris Buschelman      or MatGetSubMatrix() are to be reused to store the new matrix values.
98ceb03754SKris Buschelman 
99ceb03754SKris Buschelman     Level: beginner
100ceb03754SKris Buschelman 
101ceb03754SKris Buschelman    Any additions/changes here MUST also be made in include/finclude/petscmat.h
102ceb03754SKris Buschelman 
1030c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
104ceb03754SKris Buschelman E*/
105ceb03754SKris Buschelman typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX} MatReuse;
106ceb03754SKris Buschelman 
107be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(char *);
108c06d978dSMatthew Knepley 
109f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*);
110a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A)
111a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A)
112f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
113f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,MatType);
114be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat);
115be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat);
116be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
117be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
11830de9b25SBarry Smith 
119f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]);
120f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]);
121f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]);
122f69a0ea3SMatthew Knepley 
12330de9b25SBarry Smith /*MC
12430de9b25SBarry Smith    MatRegisterDynamic - Adds a new matrix type
12530de9b25SBarry Smith 
12630de9b25SBarry Smith    Synopsis:
127c1ac3661SBarry Smith    PetscErrorCode MatRegisterDynamic(char *name,char *path,char *name_create,PetscErrorCode (*routine_create)(Mat))
12830de9b25SBarry Smith 
12930de9b25SBarry Smith    Not Collective
13030de9b25SBarry Smith 
13130de9b25SBarry Smith    Input Parameters:
13230de9b25SBarry Smith +  name - name of a new user-defined matrix type
13330de9b25SBarry Smith .  path - path (either absolute or relative) the library containing this solver
13430de9b25SBarry Smith .  name_create - name of routine to create method context
13530de9b25SBarry Smith -  routine_create - routine to create method context
13630de9b25SBarry Smith 
13730de9b25SBarry Smith    Notes:
13830de9b25SBarry Smith    MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
13930de9b25SBarry Smith 
14030de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
14130de9b25SBarry Smith    is ignored.
14230de9b25SBarry Smith 
14330de9b25SBarry Smith    Sample usage:
14430de9b25SBarry Smith .vb
14530de9b25SBarry Smith    MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
14630de9b25SBarry Smith                "MyMatCreate",MyMatCreate);
14730de9b25SBarry Smith .ve
14830de9b25SBarry Smith 
14930de9b25SBarry Smith    Then, your solver can be chosen with the procedural interface via
15030de9b25SBarry Smith $     MatSetType(Mat,"my_mat")
15130de9b25SBarry Smith    or at runtime via the option
15230de9b25SBarry Smith $     -mat_type my_mat
15330de9b25SBarry Smith 
15430de9b25SBarry Smith    Level: advanced
15530de9b25SBarry Smith 
156ab901514SBarry Smith    Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
15730de9b25SBarry Smith          If your function is not being put into a shared library then use VecRegister() instead
15830de9b25SBarry Smith 
15930de9b25SBarry Smith .keywords: Mat, register
16030de9b25SBarry Smith 
16130de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy()
16230de9b25SBarry Smith 
16330de9b25SBarry Smith M*/
164273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
165273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
166273d9f13SBarry Smith #else
167273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
16830de9b25SBarry Smith #endif
16930de9b25SBarry Smith 
170273d9f13SBarry Smith extern PetscTruth MatRegisterAllCalled;
171b0a32e0cSBarry Smith extern PetscFList MatList;
17228988994SBarry Smith 
173be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
174be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
175be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
176ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A)
177ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A)
178ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A)
179ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A)
180ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A))
181ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A))
182ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A))
183be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
184ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
185ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
186ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
187ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
188ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
189ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,m,n,M,N,0,nnz,0,onz,A))
190ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
191ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
192ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
193ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
194ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
195ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
196ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,m,n,M,N,0,nnz,0,onz,A))
197ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
198be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIRowbs(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
199be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*);
200be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*);
201be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
202ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A)
203ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
204ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
205ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
206ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
207ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
208ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
209be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
210ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
211ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
212ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
213ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
214ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
215ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,bs,m,n,M,N,0,nnz,0,onz,A))
216ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
217ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
218ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
219ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
220ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
221ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
222ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,A))
223ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
224be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
225be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
226ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A)
227ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
228ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
229ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
230ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
231ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
232ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
233be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
234ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
235ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
236ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
237ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
238ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
239ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,bs,m,n,M,N,0,nnz,0,onz,A))
240ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
241ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
242ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
243ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
244ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
245ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
246ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,A))
247ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
248be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
249ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(comm,m,n,M,N,ctx,&A),Mat,A)
250ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A)
251be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
252be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*);
253ba966639SSatish Balay PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A)
254ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*);
255284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
256f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat);
257be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat);
25821c89e3eSBarry Smith 
259be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPrintHelp(Mat);
260be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetPetscMaps(Mat,PetscMap*,PetscMap*);
261ec0117caSBarry Smith 
2620c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat);
26399cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat);
26499cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat);
26599cafbc1SBarry Smith 
2668ed539a5SBarry Smith /* ------------------------------------------------------------*/
267be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
268be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
26987d4246cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
270f259bd47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
27184cb2905SBarry Smith 
2722ef4de8bSBarry Smith /*S
2732ef4de8bSBarry Smith      MatStencil - Data structure (C struct) for storing information about a single row or
2742ef4de8bSBarry Smith         column of a matrix as index on an associated grid.
2752ef4de8bSBarry Smith 
2762ef4de8bSBarry Smith    Level: beginner
2772ef4de8bSBarry Smith 
2782ef4de8bSBarry Smith   Concepts: matrix; linear operator
2792ef4de8bSBarry Smith 
280d7bd93baSBarry Smith .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
2812ef4de8bSBarry Smith S*/
282435da068SBarry Smith typedef struct {
283c1ac3661SBarry Smith   PetscInt k,j,i,c;
284435da068SBarry Smith } MatStencil;
2852ef4de8bSBarry Smith 
286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
287be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
288be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
289435da068SBarry Smith 
290be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring);
291be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*);
292be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*);
2933a7fca6bSBarry Smith 
294d91e6319SBarry Smith /*E
295d91e6319SBarry Smith     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
296d91e6319SBarry Smith      to continue to add values to it
297d91e6319SBarry Smith 
298d91e6319SBarry Smith     Level: beginner
299d91e6319SBarry Smith 
300d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd()
301d91e6319SBarry Smith E*/
3026d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
303be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType);
304be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType);
305be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*);
3064f9c727eSBarry Smith 
307be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt    MatSetValue_Row;
308be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt    MatSetValue_Column;
309be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscScalar MatSetValue_Value;
3101d73ed98SBarry Smith 
31130de9b25SBarry Smith /*MC
31230de9b25SBarry Smith    MatSetValue - Set a single entry into a matrix.
31330de9b25SBarry Smith 
31430de9b25SBarry Smith    Synopsis:
315c1ac3661SBarry Smith    PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode);
31630de9b25SBarry Smith 
31730de9b25SBarry Smith    Not collective
31830de9b25SBarry Smith 
31930de9b25SBarry Smith    Input Parameters:
32030de9b25SBarry Smith +  m - the matrix
32130de9b25SBarry Smith .  row - the row location of the entry
32230de9b25SBarry Smith .  col - the column location of the entry
32330de9b25SBarry Smith .  value - the value to insert
32430de9b25SBarry Smith -  mode - either INSERT_VALUES or ADD_VALUES
32530de9b25SBarry Smith 
32630de9b25SBarry Smith    Notes:
32730de9b25SBarry Smith    For efficiency one should use MatSetValues() and set several or many
32830de9b25SBarry Smith    values simultaneously if possible.
32930de9b25SBarry Smith 
33030de9b25SBarry Smith    Level: beginner
33130de9b25SBarry Smith 
33230de9b25SBarry Smith .seealso: MatSetValues(), MatSetValueLocal()
33330de9b25SBarry Smith M*/
334b951964fSBarry Smith #define MatSetValue(v,i,j,va,mode) \
335f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \
3361d73ed98SBarry Smith    MatSetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode))
33730de9b25SBarry Smith 
338ea06a074SBarry Smith #define MatGetValue(v,i,j,va) \
339f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,0) || \
3401d73ed98SBarry Smith    MatGetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&va))
34130de9b25SBarry Smith 
342d91e6319SBarry Smith #define MatSetValueLocal(v,i,j,va,mode) \
343f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \
3441d73ed98SBarry Smith    MatSetValuesLocal(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode))
34530de9b25SBarry Smith 
346d91e6319SBarry Smith /*E
347d91e6319SBarry Smith     MatOption - Options that may be set for a matrix and its behavior or storage
348d91e6319SBarry Smith 
349d91e6319SBarry Smith     Level: beginner
350d91e6319SBarry Smith 
3510a835dfdSSatish Balay    Any additions/changes here MUST also be made in include/finclude/petscmat.h
352d91e6319SBarry Smith 
353d91e6319SBarry Smith .seealso: MatSetOption()
354d91e6319SBarry Smith E*/
3556d4a8577SBarry Smith typedef enum {MAT_ROW_ORIENTED=1,MAT_COLUMN_ORIENTED=2,MAT_ROWS_SORTED=4,
3566d4a8577SBarry Smith               MAT_COLUMNS_SORTED=8,MAT_NO_NEW_NONZERO_LOCATIONS=16,
3576d4a8577SBarry Smith               MAT_YES_NEW_NONZERO_LOCATIONS=32,MAT_SYMMETRIC=64,
3586ca9ecd3SBarry Smith               MAT_STRUCTURALLY_SYMMETRIC=65,MAT_NO_NEW_DIAGONALS=66,
3596ca9ecd3SBarry Smith               MAT_YES_NEW_DIAGONALS=67,MAT_INODE_LIMIT_1=68,MAT_INODE_LIMIT_2=69,
3606ca9ecd3SBarry Smith               MAT_INODE_LIMIT_3=70,MAT_INODE_LIMIT_4=71,MAT_INODE_LIMIT_5=72,
3616ca9ecd3SBarry Smith               MAT_IGNORE_OFF_PROC_ENTRIES=73,MAT_ROWS_UNSORTED=74,
3624787f768SSatish Balay               MAT_COLUMNS_UNSORTED=75,MAT_NEW_NONZERO_LOCATION_ERR=76,
3637c922b88SBarry Smith               MAT_NEW_NONZERO_ALLOCATION_ERR=77,MAT_USE_HASH_TABLE=78,
3642bad1931SBarry Smith               MAT_KEEP_ZEROED_ROWS=79,MAT_IGNORE_ZERO_ENTRIES=80,MAT_USE_INODES=81,
365efcf0fc3SBarry Smith               MAT_DO_NOT_USE_INODES=82,MAT_NOT_SYMMETRIC=83,MAT_HERMITIAN=84,
3669a4540c5SBarry Smith               MAT_NOT_STRUCTURALLY_SYMMETRIC=85,MAT_NOT_HERMITIAN=86,
367d487561eSHong Zhang               MAT_SYMMETRY_ETERNAL=87,MAT_NOT_SYMMETRY_ETERNAL=88,
368941593c8SHong Zhang               MAT_USE_COMPRESSEDROW=89,MAT_DO_NOT_USE_COMPRESSEDROW=90,
369f5edf698SHong Zhang               MAT_IGNORE_LOWER_TRIANGULAR=91,MAT_ERROR_LOWER_TRIANGULAR=92,MAT_GETROW_UPPERTRIANGULAR=93} MatOption;
370be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption);
371be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,MatType*);
372ba966639SSatish Balay PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),MatType,t)
37384cb2905SBarry Smith 
374be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
375be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
376be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
377f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat);
378f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat);
379be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
380be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
381be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt);
382be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]);
383ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
384be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]);
385be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *);
386ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
387be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt);
3887b80b807SBarry Smith 
389be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec);
390be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec);
391ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec);
393be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*);
394ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t)
395ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0.0,&t),PetscTruth,t)
396be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec);
397ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
398be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec);
399be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec);
4002eac72dbSBarry Smith 
401f5edf698SHong Zhang 
402f5edf698SHong Zhang 
403d91e6319SBarry Smith /*E
404d91e6319SBarry Smith     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
405d91e6319SBarry Smith   its numerical values copied over or just its nonzero structure.
406d91e6319SBarry Smith 
407d91e6319SBarry Smith     Level: beginner
408d91e6319SBarry Smith 
409d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
410d91e6319SBarry Smith 
411d91e6319SBarry Smith .seealso: MatDuplicate()
412d91e6319SBarry Smith E*/
4132e8a6d31SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES} MatDuplicateOption;
4142e8a6d31SBarry Smith 
415be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegister(const char[],const char[],const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat*));
416273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
417273d9f13SBarry Smith #define MatConvertRegisterDynamic(a,b,c,d) MatConvertRegister(a,b,c,0)
418273d9f13SBarry Smith #else
419273d9f13SBarry Smith #define MatConvertRegisterDynamic(a,b,c,d) MatConvertRegister(a,b,c,d)
420273d9f13SBarry Smith #endif
421be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegisterAll(const char[]);
422be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegisterDestroy(void);
423273d9f13SBarry Smith extern PetscTruth MatConvertRegisterAllCalled;
424b0a32e0cSBarry Smith extern PetscFList MatConvertList;
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)
446ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0.0,&t),PetscTruth,t)
447be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*);
448ba966639SSatish Balay PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t)
449be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscTruth*);
450ba966639SSatish Balay PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,&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 
456be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
457be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
458be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
459be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,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);
498be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec);
499be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,Mat*);
500ba966639SSatish Balay PetscPolymorphicFunction(MatTranspose,(Mat A),(A,&t),Mat,t)
501be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *);
502ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
503be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
504be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec);
505be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode);
506be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*);
507ba966639SSatish Balay PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t)
508be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*);
509be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*);
510be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*);
511be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*);
5127b80b807SBarry Smith 
513be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *);
514ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
515be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat);
516f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar);
517f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar);
518f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*);
519f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*);
5207b80b807SBarry Smith 
521be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth);
522be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec);
523be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec);
5245ef9f2a5SBarry Smith 
525be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*);
526be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*);
527be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
5287b80b807SBarry Smith 
529be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
530be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]);
531be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,PetscInt,MatReuse,Mat *);
532abf0e977SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrixRaw(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt,MatReuse,Mat *);
533be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
534be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
535be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
536be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat);
537be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat);
538be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*);
539be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
540be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
541be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscScalar**,Mat*);
54243eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE)
543cd116e26SSatish Balay #include "petscctable.h"
54443eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
54543eb5e2fSMatthew Knepley #else
54643eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
54743eb5e2fSMatthew Knepley #endif
5488efafbd8SBarry Smith 
549be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
5507b80b807SBarry Smith 
551be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
552be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
553be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat);
55422440eb1SKris Buschelman 
555be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
556be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
557be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat);
55822440eb1SKris Buschelman 
559be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
560be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
561be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat);
562bc011b1eSHong Zhang 
563f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure);
564f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat);
565be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompress(Mat);
5661c741599SHong Zhang 
567f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar);
568f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar);
5697b80b807SBarry Smith 
570be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
571be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
572f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar);
573f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar);
574be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
575be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
576052efed2SBarry Smith 
577be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt);
578be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
57990f02eecSBarry Smith 
580be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec);
5810c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec);
582ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
583be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec);
584be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*);
585bd481603SBarry Smith 
586bd481603SBarry Smith /*MC
587bd481603SBarry Smith    MatPreallocInitialize - Begins the block of code that will count the number of nonzeros per
588bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
589bd481603SBarry Smith 
590bd481603SBarry Smith    Synopsis:
591c1ac3661SBarry Smith    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
592bd481603SBarry Smith 
593bd481603SBarry Smith    Collective on MPI_Comm
594bd481603SBarry Smith 
595bd481603SBarry Smith    Input Parameters:
596bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
597859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
598859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
599bd481603SBarry Smith 
600bd481603SBarry Smith    Output Parameters:
601bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
602bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
603bd481603SBarry Smith 
604bd481603SBarry Smith 
605bd481603SBarry Smith    Level: intermediate
606bd481603SBarry Smith 
607bd481603SBarry Smith    Notes:
608bd481603SBarry Smith    See the chapter in the users manual on performance for more details
609bd481603SBarry Smith 
6101d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
611bd481603SBarry Smith 
612bd481603SBarry Smith    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
613bd481603SBarry Smith 
614bd481603SBarry Smith   Concepts: preallocation^Matrix
615bd481603SBarry Smith 
616bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
617bd481603SBarry Smith           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
618bd481603SBarry Smith M*/
619c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
6207c922b88SBarry Smith { \
621c1ac3661SBarry Smith   PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
622c1ac3661SBarry Smith   _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\
623c1ac3661SBarry Smith   _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\
624c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
625c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp;
6267c922b88SBarry Smith 
627bd481603SBarry Smith /*MC
628bd481603SBarry Smith    MatPreallocSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
629bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
630bd481603SBarry Smith 
631bd481603SBarry Smith    Synopsis:
632c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
633bd481603SBarry Smith 
634bd481603SBarry Smith    Collective on MPI_Comm
635bd481603SBarry Smith 
636bd481603SBarry Smith    Input Parameters:
637bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
638859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
639859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
640bd481603SBarry Smith 
641bd481603SBarry Smith    Output Parameters:
642bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
643bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
644bd481603SBarry Smith 
645bd481603SBarry Smith 
646bd481603SBarry Smith    Level: intermediate
647bd481603SBarry Smith 
648bd481603SBarry Smith    Notes:
649bd481603SBarry Smith    See the chapter in the users manual on performance for more details
650bd481603SBarry Smith 
6511d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
652bd481603SBarry Smith 
653bd481603SBarry Smith   Concepts: preallocation^Matrix
654bd481603SBarry Smith 
655bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
656bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
657bd481603SBarry Smith M*/
658222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
659222b16d4SBarry Smith { \
660c1ac3661SBarry Smith   PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__end; \
661c1ac3661SBarry Smith   _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\
662c1ac3661SBarry Smith   _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\
663c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
664c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp;
665222b16d4SBarry Smith 
666bd481603SBarry Smith /*MC
667bd481603SBarry Smith    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
668bd481603SBarry Smith        inserted using a local number of the rows and columns
669bd481603SBarry Smith 
670bd481603SBarry Smith    Synopsis:
671c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
672bd481603SBarry Smith 
673bd481603SBarry Smith    Not Collective
674bd481603SBarry Smith 
675bd481603SBarry Smith    Input Parameters:
676bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
677bd481603SBarry Smith .  nrows - the number of rows indicated
6781d73ed98SBarry Smith .  rows - the indices of the rows
679bd481603SBarry Smith .  ncols - the number of columns in the matrix
680bd481603SBarry Smith .  cols - the columns indicated
681bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
682bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
683bd481603SBarry Smith 
684bd481603SBarry Smith 
685bd481603SBarry Smith    Level: intermediate
686bd481603SBarry Smith 
687bd481603SBarry Smith    Notes:
688bd481603SBarry Smith    See the chapter in the users manual on performance for more details
689bd481603SBarry Smith 
6901d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
691bd481603SBarry Smith 
692bd481603SBarry Smith   Concepts: preallocation^Matrix
693bd481603SBarry Smith 
694bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
695bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
696bd481603SBarry Smith M*/
697c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
698c4f061fbSSatish Balay {\
699c1ac3661SBarry Smith   PetscInt __l;\
700ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
701ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
702c4f061fbSSatish Balay   for (__l=0;__l<nrows;__l++) {\
703ef66eb69SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
704c4f061fbSSatish Balay   }\
705c4f061fbSSatish Balay }
706c4f061fbSSatish Balay 
707bd481603SBarry Smith /*MC
708bd481603SBarry Smith    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
709bd481603SBarry Smith        inserted using a local number of the rows and columns
710bd481603SBarry Smith 
711bd481603SBarry Smith    Synopsis:
712c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
713bd481603SBarry Smith 
714bd481603SBarry Smith    Not Collective
715bd481603SBarry Smith 
716bd481603SBarry Smith    Input Parameters:
717bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
718bd481603SBarry Smith .  nrows - the number of rows indicated
7191d73ed98SBarry Smith .  rows - the indices of the rows
720bd481603SBarry Smith .  ncols - the number of columns in the matrix
721bd481603SBarry Smith .  cols - the columns indicated
722bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
723bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
724bd481603SBarry Smith 
725bd481603SBarry Smith 
726bd481603SBarry Smith    Level: intermediate
727bd481603SBarry Smith 
728bd481603SBarry Smith    Notes:
729bd481603SBarry Smith    See the chapter in the users manual on performance for more details
730bd481603SBarry Smith 
731bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
732bd481603SBarry Smith 
733bd481603SBarry Smith   Concepts: preallocation^Matrix
734bd481603SBarry Smith 
735bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
736bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
737bd481603SBarry Smith M*/
738d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
739d3d32019SBarry Smith {\
740c1ac3661SBarry Smith   PetscInt __l;\
741d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
742d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
743d3d32019SBarry Smith   for (__l=0;__l<nrows;__l++) {\
744d3d32019SBarry Smith     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
745d3d32019SBarry Smith   }\
746d3d32019SBarry Smith }
747d3d32019SBarry Smith 
748bd481603SBarry Smith /*MC
749bd481603SBarry Smith    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
750bd481603SBarry Smith        inserted using a local number of the rows and columns
751bd481603SBarry Smith 
752bd481603SBarry Smith    Synopsis:
753c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
754bd481603SBarry Smith 
755bd481603SBarry Smith    Not Collective
756bd481603SBarry Smith 
757bd481603SBarry Smith    Input Parameters:
758bd481603SBarry Smith +  nrows - the number of rows indicated
7591d73ed98SBarry Smith .  rows - the indices of the rows
760bd481603SBarry Smith .  ncols - the number of columns in the matrix
761a50f8bf6SHong Zhang -  cols - the columns indicated
762a50f8bf6SHong Zhang 
763a50f8bf6SHong Zhang    Output Parameters:
764a50f8bf6SHong Zhang +  dnz - the array that will be passed to the matrix preallocation routines
765bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
766bd481603SBarry Smith 
767bd481603SBarry Smith 
768bd481603SBarry Smith    Level: intermediate
769bd481603SBarry Smith 
770bd481603SBarry Smith    Notes:
771bd481603SBarry Smith    See the chapter in the users manual on performance for more details
772bd481603SBarry Smith 
773bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
774bd481603SBarry Smith 
775bd481603SBarry Smith   Concepts: preallocation^Matrix
776bd481603SBarry Smith 
777bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
778bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
779bd481603SBarry Smith M*/
780c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
781c1ac3661SBarry Smith { PetscInt __i; \
7827c922b88SBarry Smith   for (__i=0; __i<nc; __i++) {\
7837c922b88SBarry Smith     if (cols[__i] < __start || cols[__i] >= __end) onz[row - __rstart]++; \
7847c922b88SBarry Smith   }\
7857c922b88SBarry Smith   dnz[row - __rstart] = nc - onz[row - __rstart];\
7867c922b88SBarry Smith }
7877c922b88SBarry Smith 
788bd481603SBarry Smith /*MC
789bd481603SBarry Smith    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
790bd481603SBarry Smith        inserted using a local number of the rows and columns
791bd481603SBarry Smith 
792bd481603SBarry Smith    Synopsis:
793c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
794bd481603SBarry Smith 
795bd481603SBarry Smith    Not Collective
796bd481603SBarry Smith 
797bd481603SBarry Smith    Input Parameters:
798bd481603SBarry Smith +  nrows - the number of rows indicated
7991d73ed98SBarry Smith .  rows - the indices of the rows
800bd481603SBarry Smith .  ncols - the number of columns in the matrix
801bd481603SBarry Smith .  cols - the columns indicated
802bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
803bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
804bd481603SBarry Smith 
805bd481603SBarry Smith 
806bd481603SBarry Smith    Level: intermediate
807bd481603SBarry Smith 
808bd481603SBarry Smith    Notes:
809bd481603SBarry Smith    See the chapter in the users manual on performance for more details
810bd481603SBarry Smith 
811bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
812bd481603SBarry Smith 
813bd481603SBarry Smith   Concepts: preallocation^Matrix
814bd481603SBarry Smith 
815bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
816bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
817bd481603SBarry Smith M*/
818d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
819c1ac3661SBarry Smith { PetscInt __i; \
820d3d32019SBarry Smith   for (__i=0; __i<nc; __i++) {\
821d3d32019SBarry Smith     if (cols[__i] >= __end) onz[row - __rstart]++; \
822d3d32019SBarry Smith     else if (cols[__i] >= row) dnz[row - __rstart]++;\
823d3d32019SBarry Smith   }\
824d3d32019SBarry Smith }
825d3d32019SBarry Smith 
826bd481603SBarry Smith /*MC
827bd481603SBarry Smith    MatPreallocFinalize - Ends the block of code that will count the number of nonzeros per
828bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
829bd481603SBarry Smith 
830bd481603SBarry Smith    Synopsis:
831c1ac3661SBarry Smith    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
832bd481603SBarry Smith 
833bd481603SBarry Smith    Collective on MPI_Comm
834bd481603SBarry Smith 
835bd481603SBarry Smith    Input Parameters:
836bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
837bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
838bd481603SBarry Smith 
839bd481603SBarry Smith 
840bd481603SBarry Smith    Level: intermediate
841bd481603SBarry Smith 
842bd481603SBarry Smith    Notes:
843bd481603SBarry Smith    See the chapter in the users manual on performance for more details
844bd481603SBarry Smith 
845bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
846bd481603SBarry Smith 
847bd481603SBarry Smith   Concepts: preallocation^Matrix
848bd481603SBarry Smith 
849bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
850bd481603SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
851bd481603SBarry Smith M*/
852ef66eb69SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree(dnz);CHKERRQ(_4_ierr);}
8537c922b88SBarry Smith 
854bd481603SBarry Smith 
855bd481603SBarry Smith 
8567b80b807SBarry Smith /* Routines unique to particular data structures */
857be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **);
858ba966639SSatish Balay PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
859be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBDiagGetData(Mat,PetscInt*,PetscInt*,PetscInt*[],PetscInt*[],PetscScalar***);
860698d4c6aSKris Buschelman 
861be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*);
862be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
863698d4c6aSKris Buschelman 
864be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
865be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
866be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
8677b80b807SBarry Smith 
868a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4
869a96a251dSBarry Smith 
870be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
871ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
872be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
873ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
874be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
875ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
876be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDensePreallocation(Mat,PetscScalar[]);
877be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]);
878273d9f13SBarry Smith 
879be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
880ba966639SSatish Balay PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
881be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
882be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
883be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
884be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
885be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDensePreallocation(Mat,PetscScalar[]);
886be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]);
887be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
888be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
889284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
890be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]);
891be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
892be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
893be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void));
894273d9f13SBarry Smith 
895be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt);
896ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*);
8971b807ce4Svictorle 
898be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat);
899be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat);
9002e8a6d31SBarry Smith 
901be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*);
9023a7fca6bSBarry Smith 
9037b80b807SBarry Smith /*
9047b80b807SBarry Smith   These routines are not usually accessed directly, rather solving is
90594b7f48cSBarry Smith   done through the KSP and PC interfaces.
9067b80b807SBarry Smith */
9077b80b807SBarry Smith 
908d9274352SBarry Smith /*E
909d9274352SBarry Smith     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
910d9274352SBarry Smith        with an optional dynamic library name, for example
911d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
912d9274352SBarry Smith 
913d9274352SBarry Smith    Level: beginner
914d9274352SBarry Smith 
915d9274352SBarry Smith .seealso: MatGetOrdering()
916d9274352SBarry Smith E*/
91749773a63SBarry Smith #define MatOrderingType char*
918b12f92e5SBarry Smith #define MATORDERING_NATURAL   "natural"
919b12f92e5SBarry Smith #define MATORDERING_ND        "nd"
920b12f92e5SBarry Smith #define MATORDERING_1WD       "1wd"
921b12f92e5SBarry Smith #define MATORDERING_RCM       "rcm"
922b12f92e5SBarry Smith #define MATORDERING_QMD       "qmd"
923b12f92e5SBarry Smith #define MATORDERING_ROWLENGTH "rowlength"
92462152c8bSBarry Smith #define MATORDERING_DSC_ND    "dsc_nd"
92562152c8bSBarry Smith #define MATORDERING_DSC_MMD   "dsc_mmd"
92662152c8bSBarry Smith #define MATORDERING_DSC_MDF   "dsc_mdf"
927c06d978dSMatthew Knepley #define MATORDERING_CONSTRAINED "constrained"
928c06d978dSMatthew Knepley #define MATORDERING_IDENTITY  "identity"
929c06d978dSMatthew Knepley #define MATORDERING_REVERSE   "reverse"
930b12f92e5SBarry Smith 
931be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
932be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list);
933be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
93430de9b25SBarry Smith 
93530de9b25SBarry Smith /*MC
93630de9b25SBarry Smith    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the
93730de9b25SBarry Smith                                matrix package.
93830de9b25SBarry Smith 
93930de9b25SBarry Smith    Synopsis:
940c1ac3661SBarry Smith    PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
94130de9b25SBarry Smith 
94230de9b25SBarry Smith    Not Collective
94330de9b25SBarry Smith 
94430de9b25SBarry Smith    Input Parameters:
94530de9b25SBarry Smith +  sname - name of ordering (for example MATORDERING_ND)
94630de9b25SBarry Smith .  path - location of library where creation routine is
94730de9b25SBarry Smith .  name - name of function that creates the ordering type,a string
94830de9b25SBarry Smith -  function - function pointer that creates the ordering
94930de9b25SBarry Smith 
95030de9b25SBarry Smith    Level: developer
95130de9b25SBarry Smith 
95230de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
95330de9b25SBarry Smith    is ignored.
95430de9b25SBarry Smith 
95530de9b25SBarry Smith    Sample usage:
95630de9b25SBarry Smith .vb
95730de9b25SBarry Smith    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
95830de9b25SBarry Smith                "MyOrder",MyOrder);
95930de9b25SBarry Smith .ve
96030de9b25SBarry Smith 
96130de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
96230de9b25SBarry Smith $     MatOrderingSetType(part,"my_order)
96330de9b25SBarry Smith    or at runtime via the option
96430de9b25SBarry Smith $     -pc_ilu_mat_ordering_type my_order
96530de9b25SBarry Smith $     -pc_lu_mat_ordering_type my_order
96630de9b25SBarry Smith 
967ab901514SBarry Smith    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
96830de9b25SBarry Smith 
96930de9b25SBarry Smith .keywords: matrix, ordering, register
97030de9b25SBarry Smith 
97130de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
97230de9b25SBarry Smith M*/
973aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
974f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
975b12f92e5SBarry Smith #else
976f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
977b12f92e5SBarry Smith #endif
97830de9b25SBarry Smith 
979be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void);
980be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]);
9812bad1931SBarry Smith extern PetscTruth MatOrderingRegisterAllCalled;
982b0a32e0cSBarry Smith extern PetscFList MatOrderingList;
983d4fbbf0eSBarry Smith 
984be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
985a2ce50c7SBarry Smith 
986d91e6319SBarry Smith /*S
98715e8a5b3SHong Zhang    MatFactorInfo - Data based into the matrix factorization routines
988b00f7748SHong Zhang 
98915e8a5b3SHong Zhang    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE
990b00f7748SHong Zhang 
99115e8a5b3SHong Zhang    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
992b00f7748SHong Zhang 
993b00f7748SHong Zhang    Level: developer
994b00f7748SHong Zhang 
995d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
996d7d82daaSBarry Smith           MatFactorInfoInitialize()
997b00f7748SHong Zhang 
998b00f7748SHong Zhang S*/
999b00f7748SHong Zhang typedef struct {
10000a29876aSHong Zhang   PetscReal     shiftnz;        /* scaling of identity added to matrix to prevent zero pivots */
1001fbf22428SSatish Balay   PetscReal     shiftpd;        /* if true, shift until positive pivots */
10022cea7109SBarry Smith   PetscReal     shift_fraction; /* record shift fraction taken */
100315e8a5b3SHong Zhang   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
100415e8a5b3SHong Zhang   PetscReal     dt;             /* drop tolerance */
1005b00f7748SHong Zhang   PetscReal     dtcol;          /* tolerance for pivoting */
100615e8a5b3SHong Zhang   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
1007f6275e2eSBarry Smith   PetscReal     fill;           /* expected fill; nonzeros in factored matrix/nonzeros in original matrix*/
1008348344bbSBarry Smith   PetscReal     levels;         /* ICC/ILU(levels) */
1009bcd9e38bSBarry Smith   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1010bcd9e38bSBarry Smith                                    factorization may be faster if do not pivot */
101115e8a5b3SHong Zhang   PetscReal     zeropivot;      /* pivot is called zero if less than this */
101215e8a5b3SHong Zhang } MatFactorInfo;
1013ffa6d0a5SLois Curfman McInnes 
1014be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*);
1015be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,MatFactorInfo*);
1016be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
1017be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,MatFactorInfo*,Mat*);
1018be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,MatFactorInfo*);
1019be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,MatFactorInfo*);
1020be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
1021be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
1022be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
1023be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,MatFactorInfo*);
1024be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,MatFactorInfo*,Mat*);
1025be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactor(Mat,IS,IS,MatFactorInfo*,Mat *);
1026be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1027be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec);
1028be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec);
1029be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec);
1030be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec);
1031be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec);
1032be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1033be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs);
10348ed539a5SBarry Smith 
1035be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat);
1036bb5a7306SBarry Smith 
1037d91e6319SBarry Smith /*E
1038d91e6319SBarry Smith     MatSORType - What type of (S)SOR to perform
1039bb1eb677SSatish Balay 
1040d91e6319SBarry Smith     Level: beginner
1041d91e6319SBarry Smith 
1042d9274352SBarry Smith    May be bitwise ORd together
1043d9274352SBarry Smith 
1044d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1045d91e6319SBarry Smith 
10464e7234bfSBarry Smith    MatSORType may be bitwise ORd together, so do not change the numbers
10474e7234bfSBarry Smith 
1048a1d92eedSBarry Smith .seealso: MatRelax(), MatPBRelax()
1049d91e6319SBarry Smith E*/
1050ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1051ee50ffe9SBarry Smith               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1052ee50ffe9SBarry Smith               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
105384cb2905SBarry Smith               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1054be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1055be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
10568ed539a5SBarry Smith 
1057d4fbbf0eSBarry Smith /*
1058639f9d9dSBarry Smith     These routines are for efficiently computing Jacobians via finite differences.
1059639f9d9dSBarry Smith */
1060b12f92e5SBarry Smith 
1061d9274352SBarry Smith /*E
1062d9274352SBarry Smith     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1063d9274352SBarry Smith        with an optional dynamic library name, for example
1064d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1065d9274352SBarry Smith 
1066d9274352SBarry Smith    Level: beginner
1067d9274352SBarry Smith 
1068d9274352SBarry Smith .seealso: MatGetColoring()
1069d9274352SBarry Smith E*/
107049773a63SBarry Smith #define MatColoringType char*
1071b12f92e5SBarry Smith #define MATCOLORING_NATURAL "natural"
1072b12f92e5SBarry Smith #define MATCOLORING_SL      "sl"
1073b12f92e5SBarry Smith #define MATCOLORING_LF      "lf"
1074b12f92e5SBarry Smith #define MATCOLORING_ID      "id"
1075b12f92e5SBarry Smith 
1076be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*);
1077be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatColoringType,ISColoring *));
107830de9b25SBarry Smith 
107930de9b25SBarry Smith /*MC
108030de9b25SBarry Smith    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
108130de9b25SBarry Smith                                matrix package.
108230de9b25SBarry Smith 
108330de9b25SBarry Smith    Synopsis:
1084c1ac3661SBarry Smith    PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring))
108530de9b25SBarry Smith 
108630de9b25SBarry Smith    Not Collective
108730de9b25SBarry Smith 
108830de9b25SBarry Smith    Input Parameters:
108930de9b25SBarry Smith +  sname - name of Coloring (for example MATCOLORING_SL)
109030de9b25SBarry Smith .  path - location of library where creation routine is
109130de9b25SBarry Smith .  name - name of function that creates the Coloring type, a string
109230de9b25SBarry Smith -  function - function pointer that creates the coloring
109330de9b25SBarry Smith 
109430de9b25SBarry Smith    Level: developer
109530de9b25SBarry Smith 
109630de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
109730de9b25SBarry Smith    is ignored.
109830de9b25SBarry Smith 
109930de9b25SBarry Smith    Sample usage:
110030de9b25SBarry Smith .vb
110130de9b25SBarry Smith    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
110230de9b25SBarry Smith                "MyColor",MyColor);
110330de9b25SBarry Smith .ve
110430de9b25SBarry Smith 
110530de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
110630de9b25SBarry Smith $     MatColoringSetType(part,"my_color")
110730de9b25SBarry Smith    or at runtime via the option
110830de9b25SBarry Smith $     -mat_coloring_type my_color
110930de9b25SBarry Smith 
1110ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
111130de9b25SBarry Smith 
111230de9b25SBarry Smith .keywords: matrix, Coloring, register
111330de9b25SBarry Smith 
111430de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
111530de9b25SBarry Smith M*/
1116aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1117f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1118b12f92e5SBarry Smith #else
1119f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1120b12f92e5SBarry Smith #endif
112130de9b25SBarry Smith 
11222bad1931SBarry Smith extern PetscTruth MatColoringRegisterAllCalled;
1123f1144a30SSatish Balay 
1124be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]);
1125be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void);
1126be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1127639f9d9dSBarry Smith 
1128d9274352SBarry Smith /*S
1129d9274352SBarry Smith      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1130d9274352SBarry Smith         and coloring
1131639f9d9dSBarry Smith 
1132d9274352SBarry Smith    Level: beginner
1133d9274352SBarry Smith 
1134d9274352SBarry Smith   Concepts: coloring, sparse Jacobian, finite differences
1135d9274352SBarry Smith 
1136d9274352SBarry Smith .seealso:  MatFDColoringCreate()
1137d9274352SBarry Smith S*/
1138e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring;
1139639f9d9dSBarry Smith 
1140be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1141be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring);
1142be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer);
1143be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
11444a9d489dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1145be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1146be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFrequency(MatFDColoring,PetscInt);
1147be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFrequency(MatFDColoring,PetscInt*);
1148be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring);
1149be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1150be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1151be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetRecompute(MatFDColoring);
1152be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec);
1153be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1154639f9d9dSBarry Smith /*
11550752156aSBarry Smith     These routines are for partitioning matrices: currently used only
11563eda8832SBarry Smith   for adjacency matrix, MatCreateMPIAdj().
11570752156aSBarry Smith */
1158ca161407SBarry Smith 
1159d9274352SBarry Smith /*S
1160d9274352SBarry Smith      MatPartitioning - Object for managing the partitioning of a matrix or graph
1161d9274352SBarry Smith 
1162d9274352SBarry Smith    Level: beginner
1163d9274352SBarry Smith 
1164d9274352SBarry Smith   Concepts: partitioning
1165d9274352SBarry Smith 
1166743a1026Svictorle .seealso:  MatPartitioningCreate(), MatPartitioningType
1167d9274352SBarry Smith S*/
116891e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning;
1169d9274352SBarry Smith 
1170d9274352SBarry Smith /*E
11715bc6e7ccSvictorle     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1172d9274352SBarry Smith        with an optional dynamic library name, for example
1173d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1174d9274352SBarry Smith 
1175d9274352SBarry Smith    Level: beginner
1176d9274352SBarry Smith 
1177b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning
1178d9274352SBarry Smith E*/
117949773a63SBarry Smith #define MatPartitioningType char*
11808ba1e511SMatthew Knepley #define MAT_PARTITIONING_CURRENT  "current"
1181c2ec2a73SHong Zhang #define MAT_PARTITIONING_SQUARE   "square"
11828ba1e511SMatthew Knepley #define MAT_PARTITIONING_PARMETIS "parmetis"
118371306c60Sjroman #define MAT_PARTITIONING_CHACO    "chaco"
118471306c60Sjroman #define MAT_PARTITIONING_JOSTLE   "jostle"
118571306c60Sjroman #define MAT_PARTITIONING_PARTY    "party"
118671306c60Sjroman #define MAT_PARTITIONING_SCOTCH   "scotch"
118771306c60Sjroman 
1188ca161407SBarry Smith 
1189be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1190be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1191be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt);
1192be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat);
1193be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1194be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1195be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*);
1196be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning);
11972aabb6bbSBarry Smith 
1198be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
119930de9b25SBarry Smith 
120030de9b25SBarry Smith /*MC
120130de9b25SBarry Smith    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
120230de9b25SBarry Smith    matrix package.
120330de9b25SBarry Smith 
120430de9b25SBarry Smith    Synopsis:
1205c1ac3661SBarry Smith    PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
120630de9b25SBarry Smith 
120730de9b25SBarry Smith    Not Collective
120830de9b25SBarry Smith 
120930de9b25SBarry Smith    Input Parameters:
121030de9b25SBarry Smith +  sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis
121130de9b25SBarry Smith .  path - location of library where creation routine is
121230de9b25SBarry Smith .  name - name of function that creates the partitioning type, a string
121330de9b25SBarry Smith -  function - function pointer that creates the partitioning type
121430de9b25SBarry Smith 
121530de9b25SBarry Smith    Level: developer
121630de9b25SBarry Smith 
121730de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
121830de9b25SBarry Smith    is ignored.
121930de9b25SBarry Smith 
122030de9b25SBarry Smith    Sample usage:
122130de9b25SBarry Smith .vb
122230de9b25SBarry Smith    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
122330de9b25SBarry Smith                "MyPartCreate",MyPartCreate);
122430de9b25SBarry Smith .ve
122530de9b25SBarry Smith 
122630de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
122730de9b25SBarry Smith $     MatPartitioningSetType(part,"my_part")
122830de9b25SBarry Smith    or at runtime via the option
122930de9b25SBarry Smith $     -mat_partitioning_type my_part
123030de9b25SBarry Smith 
1231ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
123230de9b25SBarry Smith 
123330de9b25SBarry Smith .keywords: matrix, partitioning, register
123430de9b25SBarry Smith 
123530de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
123630de9b25SBarry Smith M*/
1237aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1238f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
12392aabb6bbSBarry Smith #else
1240f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
12412aabb6bbSBarry Smith #endif
12422aabb6bbSBarry Smith 
12432bad1931SBarry Smith extern PetscTruth MatPartitioningRegisterAllCalled;
1244f1144a30SSatish Balay 
1245be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]);
1246be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void);
12472bad1931SBarry Smith 
1248be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer);
1249be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning);
1250be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,MatPartitioningType*);
1251ca161407SBarry Smith 
1252be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
12530752156aSBarry Smith 
1254be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1255be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning);
125671306c60Sjroman 
1257954b3ec6SBarry Smith typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType;
1258be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
125971306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1260be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1261be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
126271306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1263be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1264be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1265be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
126671306c60Sjroman 
126771306c60Sjroman #define MP_PARTY_OPT "opt"
126871306c60Sjroman #define MP_PARTY_LIN "lin"
126971306c60Sjroman #define MP_PARTY_SCA "sca"
127071306c60Sjroman #define MP_PARTY_RAN "ran"
127171306c60Sjroman #define MP_PARTY_GBF "gbf"
127271306c60Sjroman #define MP_PARTY_GCF "gcf"
127371306c60Sjroman #define MP_PARTY_BUB "bub"
127471306c60Sjroman #define MP_PARTY_DEF "def"
1275be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*);
127671306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs"
127771306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl"
127871306c60Sjroman #define MP_PARTY_NONE "no"
1279be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*);
1280be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1281be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth);
1282be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth);
128371306c60Sjroman 
128471306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1285be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*);
1286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning);
1287be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1288be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1289be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*);
129071306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1291be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1292be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning);
1293be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*);
129471306c60Sjroman 
12950752156aSBarry Smith /*
12960a835dfdSSatish Balay     If you add entries here you must also add them to finclude/petscmat.h
1297d4fbbf0eSBarry Smith */
12981c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0,
12991c1c02c0SLois Curfman McInnes                MATOP_GET_ROW=1,
13001c1c02c0SLois Curfman McInnes                MATOP_RESTORE_ROW=2,
13011c1c02c0SLois Curfman McInnes                MATOP_MULT=3,
13021c1c02c0SLois Curfman McInnes                MATOP_MULT_ADD=4,
13037c922b88SBarry Smith                MATOP_MULT_TRANSPOSE=5,
13047c922b88SBarry Smith                MATOP_MULT_TRANSPOSE_ADD=6,
13051c1c02c0SLois Curfman McInnes                MATOP_SOLVE=7,
13061c1c02c0SLois Curfman McInnes                MATOP_SOLVE_ADD=8,
13077c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE=9,
13087c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE_ADD=10,
13091c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR=11,
13101c1c02c0SLois Curfman McInnes                MATOP_CHOLESKYFACTOR=12,
13111c1c02c0SLois Curfman McInnes                MATOP_RELAX=13,
13121c1c02c0SLois Curfman McInnes                MATOP_TRANSPOSE=14,
13131c1c02c0SLois Curfman McInnes                MATOP_GETINFO=15,
13141c1c02c0SLois Curfman McInnes                MATOP_EQUAL=16,
13151c1c02c0SLois Curfman McInnes                MATOP_GET_DIAGONAL=17,
13161c1c02c0SLois Curfman McInnes                MATOP_DIAGONAL_SCALE=18,
13171c1c02c0SLois Curfman McInnes                MATOP_NORM=19,
13181c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_BEGIN=20,
13191c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_END=21,
13201c1c02c0SLois Curfman McInnes                MATOP_COMPRESS=22,
13211c1c02c0SLois Curfman McInnes                MATOP_SET_OPTION=23,
13221c1c02c0SLois Curfman McInnes                MATOP_ZERO_ENTRIES=24,
13231c1c02c0SLois Curfman McInnes                MATOP_ZERO_ROWS=25,
13241c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR_SYMBOLIC=26,
13251c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR_NUMERIC=27,
13261c1c02c0SLois Curfman McInnes                MATOP_CHOLESKY_FACTOR_SYMBOLIC=28,
13271c1c02c0SLois Curfman McInnes                MATOP_CHOLESKY_FACTOR_NUMERIC=29,
1328d643ce63SMatthew Knepley                MATOP_SETUP_PREALLOCATION=30,
1329d643ce63SMatthew Knepley                MATOP_ILUFACTOR_SYMBOLIC=31,
1330d643ce63SMatthew Knepley                MATOP_ICCFACTOR_SYMBOLIC=32,
1331d643ce63SMatthew Knepley                MATOP_GET_ARRAY=33,
1332d643ce63SMatthew Knepley                MATOP_RESTORE_ARRAY=34,
1333e26f1c3cSBarry Smith                MATOP_DUPLICATE=35,
1334d643ce63SMatthew Knepley                MATOP_FORWARD_SOLVE=36,
1335d643ce63SMatthew Knepley                MATOP_BACKWARD_SOLVE=37,
1336d643ce63SMatthew Knepley                MATOP_ILUFACTOR=38,
1337d643ce63SMatthew Knepley                MATOP_ICCFACTOR=39,
1338d643ce63SMatthew Knepley                MATOP_AXPY=40,
1339d643ce63SMatthew Knepley                MATOP_GET_SUBMATRICES=41,
1340d643ce63SMatthew Knepley                MATOP_INCREASE_OVERLAP=42,
1341d643ce63SMatthew Knepley                MATOP_GET_VALUES=43,
1342d643ce63SMatthew Knepley                MATOP_COPY=44,
1343d643ce63SMatthew Knepley                MATOP_PRINT_HELP=45,
1344d643ce63SMatthew Knepley                MATOP_SCALE=46,
1345d643ce63SMatthew Knepley                MATOP_SHIFT=47,
1346d643ce63SMatthew Knepley                MATOP_DIAGONAL_SHIFT=48,
1347d643ce63SMatthew Knepley                MATOP_ILUDT_FACTOR=49,
1348d643ce63SMatthew Knepley                MATOP_GET_BLOCK_SIZE=50,
1349d643ce63SMatthew Knepley                MATOP_GET_ROW_IJ=51,
1350d643ce63SMatthew Knepley                MATOP_RESTORE_ROW_IJ=52,
1351d643ce63SMatthew Knepley                MATOP_GET_COLUMN_IJ=53,
1352d643ce63SMatthew Knepley                MATOP_RESTORE_COLUMN_IJ=54,
1353d643ce63SMatthew Knepley                MATOP_FDCOLORING_CREATE=55,
1354d643ce63SMatthew Knepley                MATOP_COLORING_PATCH=56,
1355d643ce63SMatthew Knepley                MATOP_SET_UNFACTORED=57,
1356d643ce63SMatthew Knepley                MATOP_PERMUTE=58,
1357d643ce63SMatthew Knepley                MATOP_SET_VALUES_BLOCKED=59,
1358d643ce63SMatthew Knepley                MATOP_GET_SUBMATRIX=60,
1359d643ce63SMatthew Knepley                MATOP_DESTROY=61,
1360d643ce63SMatthew Knepley                MATOP_VIEW=62,
1361d643ce63SMatthew Knepley                MATOP_GET_MAPS=63,
1362d643ce63SMatthew Knepley                MATOP_USE_SCALED_FORM=64,
1363d643ce63SMatthew Knepley                MATOP_SCALE_SYSTEM=65,
1364d643ce63SMatthew Knepley                MATOP_UNSCALE_SYSTEM=66,
1365ba16a8cbSKris Buschelman                MATOP_SET_LOCAL_TO_GLOBAL_MAP=67,
1366d643ce63SMatthew Knepley                MATOP_SET_VALUES_LOCAL=68,
1367d643ce63SMatthew Knepley                MATOP_ZERO_ROWS_LOCAL=69,
1368d643ce63SMatthew Knepley                MATOP_GET_ROW_MAX=70,
1369d643ce63SMatthew Knepley                MATOP_CONVERT=71,
1370d643ce63SMatthew Knepley                MATOP_SET_COLORING=72,
1371d643ce63SMatthew Knepley                MATOP_SET_VALUES_ADIC=73,
1372d643ce63SMatthew Knepley                MATOP_SET_VALUES_ADIFOR=74,
1373d643ce63SMatthew Knepley                MATOP_FD_COLORING_APPLY=75,
1374d643ce63SMatthew Knepley                MATOP_SET_FROM_OPTIONS=76,
1375ba16a8cbSKris Buschelman                MATOP_MULT_CON=77,
1376ba16a8cbSKris Buschelman                MATOP_MULT_TRANSPOSE_CON=78,
1377ba16a8cbSKris Buschelman                MATOP_ILU_FACTOR_SYMBOLIC_CON=79,
1378d643ce63SMatthew Knepley                MATOP_PERMUTE_SPARSIFY=80,
1379d643ce63SMatthew Knepley                MATOP_MULT_MULTIPLE=81,
138041acf15aSKris Buschelman                MATOP_SOLVE_MULTIPLE=82,
138141acf15aSKris Buschelman                MATOP_GET_INERTIA=83,
138241acf15aSKris Buschelman                MATOP_LOAD=84,
138341acf15aSKris Buschelman                MATOP_IS_SYMMETRIC=85,
138441acf15aSKris Buschelman                MATOP_IS_HERMITIAN=86,
138541acf15aSKris Buschelman                MATOP_IS_STRUCTURALLY_SYMMETRIC=87,
138641acf15aSKris Buschelman                MATOP_PB_RELAX=88,
138741acf15aSKris Buschelman                MATOP_GET_VECS=89,
138841acf15aSKris Buschelman                MATOP_MAT_MULT=90,
138941acf15aSKris Buschelman                MATOP_MAT_MULT_SYMBOLIC=91,
139041acf15aSKris Buschelman                MATOP_MAT_MULT_NUMERIC=92,
139141acf15aSKris Buschelman                MATOP_PTAP=93,
139241acf15aSKris Buschelman                MATOP_PTAP_SYMBOLIC=94,
1393bc011b1eSHong Zhang                MATOP_PTAP_NUMERIC=95,
1394bc011b1eSHong Zhang                MATOP_MAT_MULTTRANSPOSE=96,
1395bc011b1eSHong Zhang                MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=97,
13967ba1a0bfSKris Buschelman                MATOP_MAT_MULTTRANSPOSE_NUMERIC=98,
13977ba1a0bfSKris Buschelman                MATOP_PTAP_SYMBOLIC_SEQAIJ=99,
13987ba1a0bfSKris Buschelman                MATOP_PTAP_NUMERIC_SEQAIJ=100,
13997ba1a0bfSKris Buschelman                MATOP_PTAP_SYMBOLIC_MPIAIJ=101,
140087d4246cSBarry Smith                MATOP_PTAP_NUMERIC_MPIAIJ=102,
1401f5edf698SHong Zhang                MATOP_SET_VALUES_ROW = 105,
1402*d5c63f83SSatish Balay                MATOP_GET_ROW_UTRIANGULAR=108,
1403*d5c63f83SSatish Balay                MATOP_RESTORE_ROW_UTRIANGULAR=109
1404fae171e0SBarry Smith              } MatOperation;
1405be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*);
1406be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void));
1407be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void));
1408be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*);
1409112a2221SBarry Smith 
141090ace30eSBarry Smith /*
141190ace30eSBarry Smith    Codes for matrices stored on disk. By default they are
141290ace30eSBarry Smith  stored in a universal format. By changing the format with
1413fb9695e5SSatish Balay  PetscViewerSetFormat(viewer,PETSC_VIEWER_BINARY_NATIVE); the matrices will
141490ace30eSBarry Smith  be stored in a way natural for the matrix, for example dense matrices
141590ace30eSBarry Smith  would be stored as dense. Matrices stored this way may only be
141690ace30eSBarry Smith  read into matrices of the same time.
141790ace30eSBarry Smith */
141890ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1
141990ace30eSBarry Smith 
1420be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1421be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsGetColor(Mat,ISColoring *);
1422860d1616SSatish Balay 
1423be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*);
14241f4e1ec7SBarry Smith 
1425d9274352SBarry Smith /*S
1426d9274352SBarry Smith      MatNullSpace - Object that removes a null space from a vector, i.e.
1427d9274352SBarry Smith          orthogonalizes the vector to a subsapce
1428d9274352SBarry Smith 
1429f7a9e4ceSBarry Smith    Level: advanced
1430d9274352SBarry Smith 
1431d9274352SBarry Smith   Concepts: matrix; linear operator, null space
1432d9274352SBarry Smith 
14336e1639daSBarry Smith   Users manual sections:
14346e1639daSBarry Smith .   sec_singular
14356e1639daSBarry Smith 
1436d9274352SBarry Smith .seealso:  MatNullSpaceCreate()
1437d9274352SBarry Smith S*/
143874637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace;
1439d9274352SBarry Smith 
1440be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*);
1441281d1b2eSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(Vec,void*),void*);
1442be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace);
1443be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1444be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace);
1445be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat);
144674637425SBarry Smith 
1447be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS);
1448be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1449be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
145046129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat);
14513f1d51d7SBarry Smith 
1452be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*);
1453be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*);
1454be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*);
1455c4f061fbSSatish Balay 
1456be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*);
1457b0a32e0cSBarry Smith 
1458be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec);
145904f1ad80SBarry Smith 
1460be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1461be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
14627dbadf16SMatthew Knepley 
1463e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END
14642eac72dbSBarry Smith #endif
1465