xref: /petsc/include/petscmat.h (revision 87d4246c4e6f032faf9d328cc0e6ec758a7a5646)
12eac72dbSBarry Smith /*
22eac72dbSBarry Smith      Include file for the matrix component of PETSc
32eac72dbSBarry Smith */
40a835dfdSSatish Balay #ifndef __PETSCMAT_H
50a835dfdSSatish Balay #define __PETSCMAT_H
60a835dfdSSatish Balay #include "petscvec.h"
7e9fa29b7SSatish Balay PETSC_EXTERN_CXX_BEGIN
82eac72dbSBarry Smith 
9d9274352SBarry Smith /*S
10d9274352SBarry Smith      Mat - Abstract PETSc matrix object
112eac72dbSBarry Smith 
12d91e6319SBarry Smith    Level: beginner
13d91e6319SBarry Smith 
14d9274352SBarry Smith   Concepts: matrix; linear operator
15d9274352SBarry Smith 
16d9274352SBarry Smith .seealso:  MatCreate(), MatType, MatSetType()
17d9274352SBarry Smith S*/
18d9274352SBarry Smith typedef struct _p_Mat*           Mat;
19d9274352SBarry Smith 
20d9274352SBarry Smith /*E
21d9274352SBarry Smith     MatType - String with the name of a PETSc matrix or the creation function
22d9274352SBarry Smith        with an optional dynamic library name, for example
23d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:mymatcreate()
24d9274352SBarry Smith 
25d9274352SBarry Smith    Level: beginner
26d9274352SBarry Smith 
27d9274352SBarry Smith .seealso: MatSetType(), Mat
28d91e6319SBarry Smith E*/
29273d9f13SBarry Smith #define MATSAME            "same"
30273d9f13SBarry Smith #define MATSEQMAIJ         "seqmaij"
31273d9f13SBarry Smith #define MATMPIMAIJ         "mpimaij"
32209238afSKris Buschelman #define MATMAIJ            "maij"
33273d9f13SBarry Smith #define MATIS              "is"
34273d9f13SBarry Smith #define MATMPIROWBS        "mpirowbs"
35273d9f13SBarry Smith #define MATSEQAIJ          "seqaij"
36273d9f13SBarry Smith #define MATMPIAIJ          "mpiaij"
37209238afSKris Buschelman #define MATAIJ             "aij"
38273d9f13SBarry Smith #define MATSHELL           "shell"
39273d9f13SBarry Smith #define MATSEQBDIAG        "seqbdiag"
40273d9f13SBarry Smith #define MATMPIBDIAG        "mpibdiag"
41209238afSKris Buschelman #define MATBDIAG           "bdiag"
42209238afSKris Buschelman #define MATSEQDENSE        "seqdense"
43273d9f13SBarry Smith #define MATMPIDENSE        "mpidense"
44209238afSKris Buschelman #define MATDENSE           "dense"
45273d9f13SBarry Smith #define MATSEQBAIJ         "seqbaij"
46273d9f13SBarry Smith #define MATMPIBAIJ         "mpibaij"
47209238afSKris Buschelman #define MATBAIJ            "baij"
48273d9f13SBarry Smith #define MATMPIADJ          "mpiadj"
49273d9f13SBarry Smith #define MATSEQSBAIJ        "seqsbaij"
50273d9f13SBarry Smith #define MATMPISBAIJ        "mpisbaij"
51209238afSKris Buschelman #define MATSBAIJ           "sbaij"
52cebc7f6cSBarry Smith #define MATDAAD            "daad"
53cebc7f6cSBarry Smith #define MATMFFD            "mffd"
54c8a8475eSBarry Smith #define MATNORMAL          "normal"
55ab92ecdeSBarry Smith #define MATLRC             "lrc"
56b3a1e11cSKris Buschelman #define MATSEQAIJSPOOLES   "seqaijspooles"
57d10c748bSKris Buschelman #define MATMPIAIJSPOOLES   "mpiaijspooles"
589abb65ffSKris Buschelman #define MATSEQSBAIJSPOOLES "seqsbaijspooles"
5922191285SKris Buschelman #define MATMPISBAIJSPOOLES "mpisbaijspooles"
60bb4d4166SHong Zhang #define MATAIJSPOOLES      "aijspooles"
61bb4d4166SHong Zhang #define MATSBAIJSPOOLES    "sbaijspooles"
6214b396bbSKris Buschelman #define MATSUPERLU         "superlu"
631d96aa28SKris Buschelman #define MATSUPERLU_DIST    "superlu_dist"
641677d0b8SKris Buschelman #define MATUMFPACK         "umfpack"
65e8aa55a4SKris Buschelman #define MATESSL            "essl"
664eb8e494SKris Buschelman #define MATLUSOL           "lusol"
67397b6df1SKris Buschelman #define MATAIJMUMPS        "aijmumps"
68397b6df1SKris Buschelman #define MATSBAIJMUMPS      "sbaijmumps"
698da957c5SKris Buschelman #define MATDSCPACK         "dscpack"
707065e2aaSKris Buschelman #define MATMATLAB          "matlab"
714b8d99adSRichard Tran Mills #define MATSEQCSRPERM      "seqcsrperm"
7218def556SRichard Tran Mills #define MATMPICSRPERM      "mpicsrperm"
73814655b8SBarry Smith #define MATCSRPERM         "csrperm"
74c0aa2d19SHong Zhang #define MATPLAPACK         "plapack"
75f69a0ea3SMatthew Knepley #define MatType const char*
76d91e6319SBarry Smith 
77c06d978dSMatthew Knepley /* Logging support */
78552e946dSBarry Smith #define    MAT_FILE_COOKIE 1211216    /* used to indicate matrices in binary files */
79be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_COOKIE;
80be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_FDCOLORING_COOKIE;
81be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_PARTITIONING_COOKIE;
82be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_NULLSPACE_COOKIE;
836849ba73SBarry Smith extern PetscEvent  MAT_Mult, MAT_MultMatrixFree, MAT_Mults, MAT_MultConstrained, MAT_MultAdd, MAT_MultTranspose;
846849ba73SBarry Smith extern PetscEvent  MAT_MultTransposeConstrained, MAT_MultTransposeAdd, MAT_Solve, MAT_Solves, MAT_SolveAdd, MAT_SolveTranspose;
856849ba73SBarry Smith extern PetscEvent  MAT_SolveTransposeAdd, MAT_Relax, MAT_ForwardSolve, MAT_BackwardSolve, MAT_LUFactor, MAT_LUFactorSymbolic;
866849ba73SBarry Smith extern PetscEvent  MAT_LUFactorNumeric, MAT_CholeskyFactor, MAT_CholeskyFactorSymbolic, MAT_CholeskyFactorNumeric, MAT_ILUFactor;
876849ba73SBarry Smith extern PetscEvent  MAT_ILUFactorSymbolic, MAT_ICCFactorSymbolic, MAT_Copy, MAT_Convert, MAT_Scale, MAT_AssemblyBegin;
886849ba73SBarry Smith extern PetscEvent  MAT_AssemblyEnd, MAT_SetValues, MAT_GetValues, MAT_GetRow, MAT_GetSubMatrices, MAT_GetColoring, MAT_GetOrdering;
896849ba73SBarry Smith extern PetscEvent  MAT_IncreaseOverlap, MAT_Partitioning, MAT_ZeroEntries, MAT_Load, MAT_View, MAT_AXPY, MAT_FDColoringCreate;
906849ba73SBarry Smith extern PetscEvent  MAT_FDColoringApply, MAT_Transpose, MAT_FDColoringFunction;
91cb00f407SKris Buschelman extern PetscEvent  MAT_MatMult, MAT_MatMultSymbolic, MAT_MatMultNumeric;
92534c1384SKris Buschelman extern PetscEvent  MAT_PtAP, MAT_PtAPSymbolic, MAT_PtAPNumeric;
93bc011b1eSHong Zhang extern PetscEvent  MAT_MatMultTranspose, MAT_MatMultTransposeSymbolic, MAT_MatMultTransposeNumeric;
94c06d978dSMatthew Knepley 
95ceb03754SKris Buschelman /*E
96ceb03754SKris Buschelman     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
97ceb03754SKris Buschelman      or MatGetSubMatrix() are to be reused to store the new matrix values.
98ceb03754SKris Buschelman 
99ceb03754SKris Buschelman     Level: beginner
100ceb03754SKris Buschelman 
101ceb03754SKris Buschelman    Any additions/changes here MUST also be made in include/finclude/petscmat.h
102ceb03754SKris Buschelman 
1030c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
104ceb03754SKris Buschelman E*/
105ceb03754SKris Buschelman typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX} MatReuse;
106ceb03754SKris Buschelman 
107be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(char *);
108c06d978dSMatthew Knepley 
109f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*);
110ba966639SSatish Balay PetscPolymorphicFunction(MatCreate,(MPI_Comm comm,void *ctx),(comm,&A),Mat,A)
111ba966639SSatish Balay PetscPolymorphicFunction(MatCreate,(void *ctx),(PETSC_COMM_WORLD,&A),Mat,A)
112f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
113f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,MatType);
114be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat);
115be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat);
116be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
117be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
11830de9b25SBarry Smith 
119f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]);
120f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]);
121f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]);
122f69a0ea3SMatthew Knepley 
12330de9b25SBarry Smith /*MC
12430de9b25SBarry Smith    MatRegisterDynamic - Adds a new matrix type
12530de9b25SBarry Smith 
12630de9b25SBarry Smith    Synopsis:
127c1ac3661SBarry Smith    PetscErrorCode MatRegisterDynamic(char *name,char *path,char *name_create,PetscErrorCode (*routine_create)(Mat))
12830de9b25SBarry Smith 
12930de9b25SBarry Smith    Not Collective
13030de9b25SBarry Smith 
13130de9b25SBarry Smith    Input Parameters:
13230de9b25SBarry Smith +  name - name of a new user-defined matrix type
13330de9b25SBarry Smith .  path - path (either absolute or relative) the library containing this solver
13430de9b25SBarry Smith .  name_create - name of routine to create method context
13530de9b25SBarry Smith -  routine_create - routine to create method context
13630de9b25SBarry Smith 
13730de9b25SBarry Smith    Notes:
13830de9b25SBarry Smith    MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
13930de9b25SBarry Smith 
14030de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
14130de9b25SBarry Smith    is ignored.
14230de9b25SBarry Smith 
14330de9b25SBarry Smith    Sample usage:
14430de9b25SBarry Smith .vb
14530de9b25SBarry Smith    MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
14630de9b25SBarry Smith                "MyMatCreate",MyMatCreate);
14730de9b25SBarry Smith .ve
14830de9b25SBarry Smith 
14930de9b25SBarry Smith    Then, your solver can be chosen with the procedural interface via
15030de9b25SBarry Smith $     MatSetType(Mat,"my_mat")
15130de9b25SBarry Smith    or at runtime via the option
15230de9b25SBarry Smith $     -mat_type my_mat
15330de9b25SBarry Smith 
15430de9b25SBarry Smith    Level: advanced
15530de9b25SBarry Smith 
156ab901514SBarry Smith    Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
15730de9b25SBarry Smith          If your function is not being put into a shared library then use VecRegister() instead
15830de9b25SBarry Smith 
15930de9b25SBarry Smith .keywords: Mat, register
16030de9b25SBarry Smith 
16130de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy()
16230de9b25SBarry Smith 
16330de9b25SBarry Smith M*/
164273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
165273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
166273d9f13SBarry Smith #else
167273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
16830de9b25SBarry Smith #endif
16930de9b25SBarry Smith 
170273d9f13SBarry Smith extern PetscTruth MatRegisterAllCalled;
171b0a32e0cSBarry Smith extern PetscFList MatList;
17228988994SBarry Smith 
173be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
174be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
175be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
176ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A)
177ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A)
178ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A)
179ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A)
180ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A))
181ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A))
182ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A))
183be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
184ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
185ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
186ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
187ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
188ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
189ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,m,n,M,N,0,nnz,0,onz,A))
190ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
191ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
192ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
193ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
194ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
195ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
196ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,m,n,M,N,0,nnz,0,onz,A))
197ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
198be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIRowbs(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
199be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*);
200be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*);
201be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
202ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A)
203ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
204ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
205ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
206ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
207ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
208ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
209be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
210ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
211ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
212ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
213ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
214ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
215ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,bs,m,n,M,N,0,nnz,0,onz,A))
216ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
217ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
218ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
219ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
220ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
221ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
222ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,A))
223ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
224be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
225be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
226ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A)
227ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
228ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
229ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
230ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
231ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
232ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
233be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
234ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
235ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
236ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
237ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
238ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
239ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,bs,m,n,M,N,0,nnz,0,onz,A))
240ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
241ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A)
242ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A)
243ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A)
244ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A)
245ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A))
246ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,A))
247ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A))
248be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
249ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(comm,m,n,M,N,ctx,&A),Mat,A)
250ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A)
251be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
252be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*);
253ba966639SSatish Balay PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A)
254ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*);
255284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
256f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat);
257be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat);
25821c89e3eSBarry Smith 
259be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPrintHelp(Mat);
260be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetPetscMaps(Mat,PetscMap*,PetscMap*);
261ec0117caSBarry Smith 
2620c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat);
2638ed539a5SBarry Smith /* ------------------------------------------------------------*/
264be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
265be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
266*87d4246cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
26784cb2905SBarry Smith 
2682ef4de8bSBarry Smith /*S
2692ef4de8bSBarry Smith      MatStencil - Data structure (C struct) for storing information about a single row or
2702ef4de8bSBarry Smith         column of a matrix as index on an associated grid.
2712ef4de8bSBarry Smith 
2722ef4de8bSBarry Smith    Level: beginner
2732ef4de8bSBarry Smith 
2742ef4de8bSBarry Smith   Concepts: matrix; linear operator
2752ef4de8bSBarry Smith 
276d7bd93baSBarry Smith .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
2772ef4de8bSBarry Smith S*/
278435da068SBarry Smith typedef struct {
279c1ac3661SBarry Smith   PetscInt k,j,i,c;
280435da068SBarry Smith } MatStencil;
2812ef4de8bSBarry Smith 
282be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
283be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
284be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
285435da068SBarry Smith 
286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring);
287be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*);
288be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*);
2893a7fca6bSBarry Smith 
290d91e6319SBarry Smith /*E
291d91e6319SBarry Smith     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
292d91e6319SBarry Smith      to continue to add values to it
293d91e6319SBarry Smith 
294d91e6319SBarry Smith     Level: beginner
295d91e6319SBarry Smith 
296d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd()
297d91e6319SBarry Smith E*/
2986d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
299be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType);
300be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType);
301be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*);
3024f9c727eSBarry Smith 
303be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt    MatSetValue_Row;
304be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt    MatSetValue_Column;
305be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscScalar MatSetValue_Value;
3061d73ed98SBarry Smith 
30730de9b25SBarry Smith /*MC
30830de9b25SBarry Smith    MatSetValue - Set a single entry into a matrix.
30930de9b25SBarry Smith 
31030de9b25SBarry Smith    Synopsis:
311c1ac3661SBarry Smith    PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode);
31230de9b25SBarry Smith 
31330de9b25SBarry Smith    Not collective
31430de9b25SBarry Smith 
31530de9b25SBarry Smith    Input Parameters:
31630de9b25SBarry Smith +  m - the matrix
31730de9b25SBarry Smith .  row - the row location of the entry
31830de9b25SBarry Smith .  col - the column location of the entry
31930de9b25SBarry Smith .  value - the value to insert
32030de9b25SBarry Smith -  mode - either INSERT_VALUES or ADD_VALUES
32130de9b25SBarry Smith 
32230de9b25SBarry Smith    Notes:
32330de9b25SBarry Smith    For efficiency one should use MatSetValues() and set several or many
32430de9b25SBarry Smith    values simultaneously if possible.
32530de9b25SBarry Smith 
32630de9b25SBarry Smith    Level: beginner
32730de9b25SBarry Smith 
32830de9b25SBarry Smith .seealso: MatSetValues(), MatSetValueLocal()
32930de9b25SBarry Smith M*/
330b951964fSBarry Smith #define MatSetValue(v,i,j,va,mode) \
331f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \
3321d73ed98SBarry Smith    MatSetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode))
33330de9b25SBarry Smith 
334ea06a074SBarry Smith #define MatGetValue(v,i,j,va) \
335f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,0) || \
3361d73ed98SBarry Smith    MatGetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&va))
33730de9b25SBarry Smith 
338d91e6319SBarry Smith #define MatSetValueLocal(v,i,j,va,mode) \
339f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \
3401d73ed98SBarry Smith    MatSetValuesLocal(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode))
34130de9b25SBarry Smith 
342d91e6319SBarry Smith /*E
343d91e6319SBarry Smith     MatOption - Options that may be set for a matrix and its behavior or storage
344d91e6319SBarry Smith 
345d91e6319SBarry Smith     Level: beginner
346d91e6319SBarry Smith 
3470a835dfdSSatish Balay    Any additions/changes here MUST also be made in include/finclude/petscmat.h
348d91e6319SBarry Smith 
349d91e6319SBarry Smith .seealso: MatSetOption()
350d91e6319SBarry Smith E*/
3516d4a8577SBarry Smith typedef enum {MAT_ROW_ORIENTED=1,MAT_COLUMN_ORIENTED=2,MAT_ROWS_SORTED=4,
3526d4a8577SBarry Smith               MAT_COLUMNS_SORTED=8,MAT_NO_NEW_NONZERO_LOCATIONS=16,
3536d4a8577SBarry Smith               MAT_YES_NEW_NONZERO_LOCATIONS=32,MAT_SYMMETRIC=64,
3546ca9ecd3SBarry Smith               MAT_STRUCTURALLY_SYMMETRIC=65,MAT_NO_NEW_DIAGONALS=66,
3556ca9ecd3SBarry Smith               MAT_YES_NEW_DIAGONALS=67,MAT_INODE_LIMIT_1=68,MAT_INODE_LIMIT_2=69,
3566ca9ecd3SBarry Smith               MAT_INODE_LIMIT_3=70,MAT_INODE_LIMIT_4=71,MAT_INODE_LIMIT_5=72,
3576ca9ecd3SBarry Smith               MAT_IGNORE_OFF_PROC_ENTRIES=73,MAT_ROWS_UNSORTED=74,
3584787f768SSatish Balay               MAT_COLUMNS_UNSORTED=75,MAT_NEW_NONZERO_LOCATION_ERR=76,
3597c922b88SBarry Smith               MAT_NEW_NONZERO_ALLOCATION_ERR=77,MAT_USE_HASH_TABLE=78,
3602bad1931SBarry Smith               MAT_KEEP_ZEROED_ROWS=79,MAT_IGNORE_ZERO_ENTRIES=80,MAT_USE_INODES=81,
361efcf0fc3SBarry Smith               MAT_DO_NOT_USE_INODES=82,MAT_NOT_SYMMETRIC=83,MAT_HERMITIAN=84,
3629a4540c5SBarry Smith               MAT_NOT_STRUCTURALLY_SYMMETRIC=85,MAT_NOT_HERMITIAN=86,
363d487561eSHong Zhang               MAT_SYMMETRY_ETERNAL=87,MAT_NOT_SYMMETRY_ETERNAL=88,
364941593c8SHong Zhang               MAT_USE_COMPRESSEDROW=89,MAT_DO_NOT_USE_COMPRESSEDROW=90,
365941593c8SHong Zhang               MAT_IGNORE_LOWER_TRIANGULAR=91,MAT_ERROR_LOWER_TRIANGULAR=92} MatOption;
366be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption);
367be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,MatType*);
368ba966639SSatish Balay PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),MatType,t)
36984cb2905SBarry Smith 
370be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
371be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
372be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
373be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
374be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
375be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt);
376be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]);
377ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
378be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]);
379be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *);
380ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
381be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt);
3827b80b807SBarry Smith 
383be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec);
384be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec);
385ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
386be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec);
387be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*);
388ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t)
389ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0.0,&t),PetscTruth,t)
390be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec);
391ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec);
393be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec);
3942eac72dbSBarry Smith 
395d91e6319SBarry Smith /*E
396d91e6319SBarry Smith     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
397d91e6319SBarry Smith   its numerical values copied over or just its nonzero structure.
398d91e6319SBarry Smith 
399d91e6319SBarry Smith     Level: beginner
400d91e6319SBarry Smith 
401d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
402d91e6319SBarry Smith 
403d91e6319SBarry Smith .seealso: MatDuplicate()
404d91e6319SBarry Smith E*/
4052e8a6d31SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES} MatDuplicateOption;
4062e8a6d31SBarry Smith 
407be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegister(const char[],const char[],const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat*));
408273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
409273d9f13SBarry Smith #define MatConvertRegisterDynamic(a,b,c,d) MatConvertRegister(a,b,c,0)
410273d9f13SBarry Smith #else
411273d9f13SBarry Smith #define MatConvertRegisterDynamic(a,b,c,d) MatConvertRegister(a,b,c,d)
412273d9f13SBarry Smith #endif
413be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegisterAll(const char[]);
414be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegisterDestroy(void);
415273d9f13SBarry Smith extern PetscTruth MatConvertRegisterAllCalled;
416b0a32e0cSBarry Smith extern PetscFList MatConvertList;
417f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,MatType,MatReuse,Mat*);
418ba966639SSatish Balay PetscPolymorphicFunction(MatConvert,(Mat A,MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a)
419be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*);
420ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a)
421ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a)
42294a9d846SBarry Smith 
423d91e6319SBarry Smith /*E
424d91e6319SBarry Smith     MatStructure - Indicates if the matrix has the same nonzero structure
425d91e6319SBarry Smith 
426d91e6319SBarry Smith     Level: beginner
427d91e6319SBarry Smith 
428d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
429d91e6319SBarry Smith 
43094b7f48cSBarry Smith .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
431d91e6319SBarry Smith E*/
432c537a176SHong Zhang typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure;
433cb5b572fSBarry Smith 
434be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure);
435be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer);
436be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*);
437ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t)
438ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0.0,&t),PetscTruth,t)
439be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*);
440ba966639SSatish Balay PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t)
441be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscTruth*);
442ba966639SSatish Balay PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,&t),PetscTruth,t)
443be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*);
444be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*);
445f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(PetscViewer,MatType,Mat*);
446ba966639SSatish Balay PetscPolymorphicFunction(MatLoad,(PetscViewer v,MatType t),(v,t,&a),Mat,a)
4477b80b807SBarry Smith 
448be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
449be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
450be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
451be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
452d4fbbf0eSBarry Smith 
453d91e6319SBarry Smith /*S
454d91e6319SBarry Smith      MatInfo - Context of matrix information, used with MatGetInfo()
455d91e6319SBarry Smith 
456d91e6319SBarry Smith    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
457d91e6319SBarry Smith 
458d91e6319SBarry Smith    Level: intermediate
459d91e6319SBarry Smith 
460d91e6319SBarry Smith   Concepts: matrix^nonzero information
461d91e6319SBarry Smith 
462d9274352SBarry Smith .seealso:  MatGetInfo(), MatInfoType
463d91e6319SBarry Smith S*/
4644e220ebcSLois Curfman McInnes typedef struct {
465b0a32e0cSBarry Smith   PetscLogDouble rows_global,columns_global;         /* number of global rows and columns */
466b0a32e0cSBarry Smith   PetscLogDouble rows_local,columns_local;           /* number of local rows and columns */
467b0a32e0cSBarry Smith   PetscLogDouble block_size;                         /* block size */
468b0a32e0cSBarry Smith   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
469b0a32e0cSBarry Smith   PetscLogDouble memory;                             /* memory allocated */
470b0a32e0cSBarry Smith   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
471b0a32e0cSBarry Smith   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
472b0a32e0cSBarry Smith   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
473b0a32e0cSBarry Smith   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
4744e220ebcSLois Curfman McInnes } MatInfo;
4754e220ebcSLois Curfman McInnes 
476d9274352SBarry Smith /*E
477d9274352SBarry Smith     MatInfoType - Indicates if you want information about the local part of the matrix,
478d9274352SBarry Smith      the entire parallel matrix or the maximum over all the local parts.
479d9274352SBarry Smith 
480d9274352SBarry Smith     Level: beginner
481d9274352SBarry Smith 
482d9274352SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
483d9274352SBarry Smith 
484d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo
485d9274352SBarry Smith E*/
4867b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
487be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*);
488be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatValid(Mat,PetscTruth*);
489be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec);
490be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec);
491be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,Mat*);
492ba966639SSatish Balay PetscPolymorphicFunction(MatTranspose,(Mat A),(A,&t),Mat,t)
493be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *);
494ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
495be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
496be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec);
497be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode);
498be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*);
499ba966639SSatish Balay PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t)
500be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*);
501be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*);
502be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*);
503be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*);
5047b80b807SBarry Smith 
505be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *);
506ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
507be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat);
508f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar);
509f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar);
510f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*);
511f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*);
5127b80b807SBarry Smith 
513be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth);
514be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec);
515be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec);
5165ef9f2a5SBarry Smith 
517be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*);
518be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*);
519be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
5207b80b807SBarry Smith 
521be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
522be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]);
523be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,PetscInt,MatReuse,Mat *);
524abf0e977SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrixRaw(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt,MatReuse,Mat *);
525be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
526be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
527be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
528be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat);
529be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat);
530be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*);
531be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
532be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
533be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscScalar**,Mat*);
53443eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE)
535cd116e26SSatish Balay #include "petscctable.h"
53643eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
53743eb5e2fSMatthew Knepley #else
53843eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
53943eb5e2fSMatthew Knepley #endif
5408efafbd8SBarry Smith 
541be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
5427b80b807SBarry Smith 
543be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
544be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
545be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat);
54622440eb1SKris Buschelman 
547be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
548be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
549be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat);
55022440eb1SKris Buschelman 
551be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
552be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
553be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat);
554bc011b1eSHong Zhang 
555f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure);
556f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat);
557be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompress(Mat);
5581c741599SHong Zhang 
559f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar);
560f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar);
5617b80b807SBarry Smith 
562be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
563be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
564f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar);
565f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar);
566be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
567be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
568052efed2SBarry Smith 
569be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt);
570be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
57190f02eecSBarry Smith 
572be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec);
5730c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec);
574ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
575be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec);
576be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*);
577bd481603SBarry Smith 
578bd481603SBarry Smith /*MC
579bd481603SBarry Smith    MatPreallocInitialize - Begins the block of code that will count the number of nonzeros per
580bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
581bd481603SBarry Smith 
582bd481603SBarry Smith    Synopsis:
583c1ac3661SBarry Smith    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
584bd481603SBarry Smith 
585bd481603SBarry Smith    Collective on MPI_Comm
586bd481603SBarry Smith 
587bd481603SBarry Smith    Input Parameters:
588bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
589859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
590859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
591bd481603SBarry Smith 
592bd481603SBarry Smith    Output Parameters:
593bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
594bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
595bd481603SBarry Smith 
596bd481603SBarry Smith 
597bd481603SBarry Smith    Level: intermediate
598bd481603SBarry Smith 
599bd481603SBarry Smith    Notes:
600bd481603SBarry Smith    See the chapter in the users manual on performance for more details
601bd481603SBarry Smith 
6021d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
603bd481603SBarry Smith 
604bd481603SBarry Smith    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
605bd481603SBarry Smith 
606bd481603SBarry Smith   Concepts: preallocation^Matrix
607bd481603SBarry Smith 
608bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
609bd481603SBarry Smith           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
610bd481603SBarry Smith M*/
611c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
6127c922b88SBarry Smith { \
613c1ac3661SBarry Smith   PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
614c1ac3661SBarry Smith   _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\
615c1ac3661SBarry Smith   _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\
616c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
617c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp;
6187c922b88SBarry Smith 
619bd481603SBarry Smith /*MC
620bd481603SBarry Smith    MatPreallocSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
621bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
622bd481603SBarry Smith 
623bd481603SBarry Smith    Synopsis:
624c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
625bd481603SBarry Smith 
626bd481603SBarry Smith    Collective on MPI_Comm
627bd481603SBarry Smith 
628bd481603SBarry Smith    Input Parameters:
629bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
630859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
631859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
632bd481603SBarry Smith 
633bd481603SBarry Smith    Output Parameters:
634bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
635bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
636bd481603SBarry Smith 
637bd481603SBarry Smith 
638bd481603SBarry Smith    Level: intermediate
639bd481603SBarry Smith 
640bd481603SBarry Smith    Notes:
641bd481603SBarry Smith    See the chapter in the users manual on performance for more details
642bd481603SBarry Smith 
6431d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
644bd481603SBarry Smith 
645bd481603SBarry Smith   Concepts: preallocation^Matrix
646bd481603SBarry Smith 
647bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
648bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
649bd481603SBarry Smith M*/
650222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
651222b16d4SBarry Smith { \
652c1ac3661SBarry Smith   PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__end; \
653c1ac3661SBarry Smith   _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\
654c1ac3661SBarry Smith   _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\
655c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
656c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp;
657222b16d4SBarry Smith 
658bd481603SBarry Smith /*MC
659bd481603SBarry Smith    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
660bd481603SBarry Smith        inserted using a local number of the rows and columns
661bd481603SBarry Smith 
662bd481603SBarry Smith    Synopsis:
663c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
664bd481603SBarry Smith 
665bd481603SBarry Smith    Not Collective
666bd481603SBarry Smith 
667bd481603SBarry Smith    Input Parameters:
668bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
669bd481603SBarry Smith .  nrows - the number of rows indicated
6701d73ed98SBarry Smith .  rows - the indices of the rows
671bd481603SBarry Smith .  ncols - the number of columns in the matrix
672bd481603SBarry Smith .  cols - the columns indicated
673bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
674bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
675bd481603SBarry Smith 
676bd481603SBarry Smith 
677bd481603SBarry Smith    Level: intermediate
678bd481603SBarry Smith 
679bd481603SBarry Smith    Notes:
680bd481603SBarry Smith    See the chapter in the users manual on performance for more details
681bd481603SBarry Smith 
6821d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
683bd481603SBarry Smith 
684bd481603SBarry Smith   Concepts: preallocation^Matrix
685bd481603SBarry Smith 
686bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
687bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
688bd481603SBarry Smith M*/
689c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
690c4f061fbSSatish Balay {\
691c1ac3661SBarry Smith   PetscInt __l;\
692ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
693ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
694c4f061fbSSatish Balay   for (__l=0;__l<nrows;__l++) {\
695ef66eb69SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
696c4f061fbSSatish Balay   }\
697c4f061fbSSatish Balay }
698c4f061fbSSatish Balay 
699bd481603SBarry Smith /*MC
700bd481603SBarry Smith    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
701bd481603SBarry Smith        inserted using a local number of the rows and columns
702bd481603SBarry Smith 
703bd481603SBarry Smith    Synopsis:
704c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
705bd481603SBarry Smith 
706bd481603SBarry Smith    Not Collective
707bd481603SBarry Smith 
708bd481603SBarry Smith    Input Parameters:
709bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
710bd481603SBarry Smith .  nrows - the number of rows indicated
7111d73ed98SBarry Smith .  rows - the indices of the rows
712bd481603SBarry Smith .  ncols - the number of columns in the matrix
713bd481603SBarry Smith .  cols - the columns indicated
714bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
715bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
716bd481603SBarry Smith 
717bd481603SBarry Smith 
718bd481603SBarry Smith    Level: intermediate
719bd481603SBarry Smith 
720bd481603SBarry Smith    Notes:
721bd481603SBarry Smith    See the chapter in the users manual on performance for more details
722bd481603SBarry Smith 
723bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
724bd481603SBarry Smith 
725bd481603SBarry Smith   Concepts: preallocation^Matrix
726bd481603SBarry Smith 
727bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
728bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
729bd481603SBarry Smith M*/
730d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
731d3d32019SBarry Smith {\
732c1ac3661SBarry Smith   PetscInt __l;\
733d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
734d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
735d3d32019SBarry Smith   for (__l=0;__l<nrows;__l++) {\
736d3d32019SBarry Smith     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
737d3d32019SBarry Smith   }\
738d3d32019SBarry Smith }
739d3d32019SBarry Smith 
740bd481603SBarry Smith /*MC
741bd481603SBarry Smith    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
742bd481603SBarry Smith        inserted using a local number of the rows and columns
743bd481603SBarry Smith 
744bd481603SBarry Smith    Synopsis:
745c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
746bd481603SBarry Smith 
747bd481603SBarry Smith    Not Collective
748bd481603SBarry Smith 
749bd481603SBarry Smith    Input Parameters:
750bd481603SBarry Smith +  nrows - the number of rows indicated
7511d73ed98SBarry Smith .  rows - the indices of the rows
752bd481603SBarry Smith .  ncols - the number of columns in the matrix
753a50f8bf6SHong Zhang -  cols - the columns indicated
754a50f8bf6SHong Zhang 
755a50f8bf6SHong Zhang    Output Parameters:
756a50f8bf6SHong Zhang +  dnz - the array that will be passed to the matrix preallocation routines
757bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
758bd481603SBarry Smith 
759bd481603SBarry Smith 
760bd481603SBarry Smith    Level: intermediate
761bd481603SBarry Smith 
762bd481603SBarry Smith    Notes:
763bd481603SBarry Smith    See the chapter in the users manual on performance for more details
764bd481603SBarry Smith 
765bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
766bd481603SBarry Smith 
767bd481603SBarry Smith   Concepts: preallocation^Matrix
768bd481603SBarry Smith 
769bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
770bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
771bd481603SBarry Smith M*/
772c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
773c1ac3661SBarry Smith { PetscInt __i; \
7747c922b88SBarry Smith   for (__i=0; __i<nc; __i++) {\
7757c922b88SBarry Smith     if (cols[__i] < __start || cols[__i] >= __end) onz[row - __rstart]++; \
7767c922b88SBarry Smith   }\
7777c922b88SBarry Smith   dnz[row - __rstart] = nc - onz[row - __rstart];\
7787c922b88SBarry Smith }
7797c922b88SBarry Smith 
780bd481603SBarry Smith /*MC
781bd481603SBarry Smith    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
782bd481603SBarry Smith        inserted using a local number of the rows and columns
783bd481603SBarry Smith 
784bd481603SBarry Smith    Synopsis:
785c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
786bd481603SBarry Smith 
787bd481603SBarry Smith    Not Collective
788bd481603SBarry Smith 
789bd481603SBarry Smith    Input Parameters:
790bd481603SBarry Smith +  nrows - the number of rows indicated
7911d73ed98SBarry Smith .  rows - the indices of the rows
792bd481603SBarry Smith .  ncols - the number of columns in the matrix
793bd481603SBarry Smith .  cols - the columns indicated
794bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
795bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
796bd481603SBarry Smith 
797bd481603SBarry Smith 
798bd481603SBarry Smith    Level: intermediate
799bd481603SBarry Smith 
800bd481603SBarry Smith    Notes:
801bd481603SBarry Smith    See the chapter in the users manual on performance for more details
802bd481603SBarry Smith 
803bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
804bd481603SBarry Smith 
805bd481603SBarry Smith   Concepts: preallocation^Matrix
806bd481603SBarry Smith 
807bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
808bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
809bd481603SBarry Smith M*/
810d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
811c1ac3661SBarry Smith { PetscInt __i; \
812d3d32019SBarry Smith   for (__i=0; __i<nc; __i++) {\
813d3d32019SBarry Smith     if (cols[__i] >= __end) onz[row - __rstart]++; \
814d3d32019SBarry Smith     else if (cols[__i] >= row) dnz[row - __rstart]++;\
815d3d32019SBarry Smith   }\
816d3d32019SBarry Smith }
817d3d32019SBarry Smith 
818bd481603SBarry Smith /*MC
819bd481603SBarry Smith    MatPreallocFinalize - Ends the block of code that will count the number of nonzeros per
820bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
821bd481603SBarry Smith 
822bd481603SBarry Smith    Synopsis:
823c1ac3661SBarry Smith    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
824bd481603SBarry Smith 
825bd481603SBarry Smith    Collective on MPI_Comm
826bd481603SBarry Smith 
827bd481603SBarry Smith    Input Parameters:
828bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
829bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
830bd481603SBarry Smith 
831bd481603SBarry Smith 
832bd481603SBarry Smith    Level: intermediate
833bd481603SBarry Smith 
834bd481603SBarry Smith    Notes:
835bd481603SBarry Smith    See the chapter in the users manual on performance for more details
836bd481603SBarry Smith 
837bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
838bd481603SBarry Smith 
839bd481603SBarry Smith   Concepts: preallocation^Matrix
840bd481603SBarry Smith 
841bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
842bd481603SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
843bd481603SBarry Smith M*/
844ef66eb69SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree(dnz);CHKERRQ(_4_ierr);}
8457c922b88SBarry Smith 
846bd481603SBarry Smith 
847bd481603SBarry Smith 
8487b80b807SBarry Smith /* Routines unique to particular data structures */
849be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **);
850ba966639SSatish Balay PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
851be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBDiagGetData(Mat,PetscInt*,PetscInt*,PetscInt*[],PetscInt*[],PetscScalar***);
852698d4c6aSKris Buschelman 
853be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*);
854be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
855698d4c6aSKris Buschelman 
856be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
857be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
858be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
8597b80b807SBarry Smith 
860a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4
861a96a251dSBarry Smith 
862be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
863ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
864be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
865ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
866be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
867ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
868be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDensePreallocation(Mat,PetscScalar[]);
869be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]);
870273d9f13SBarry Smith 
871be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
872ba966639SSatish Balay PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
873be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
874be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
875be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
876be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
877be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDensePreallocation(Mat,PetscScalar[]);
878be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]);
879be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
880be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
881284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
882be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]);
883be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
884be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
885be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void));
886273d9f13SBarry Smith 
887be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt);
888ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*);
8891b807ce4Svictorle 
890be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat);
891be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat);
8922e8a6d31SBarry Smith 
893be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*);
8943a7fca6bSBarry Smith 
8957b80b807SBarry Smith /*
8967b80b807SBarry Smith   These routines are not usually accessed directly, rather solving is
89794b7f48cSBarry Smith   done through the KSP and PC interfaces.
8987b80b807SBarry Smith */
8997b80b807SBarry Smith 
900d9274352SBarry Smith /*E
901d9274352SBarry Smith     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
902d9274352SBarry Smith        with an optional dynamic library name, for example
903d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
904d9274352SBarry Smith 
905d9274352SBarry Smith    Level: beginner
906d9274352SBarry Smith 
907d9274352SBarry Smith .seealso: MatGetOrdering()
908d9274352SBarry Smith E*/
90949773a63SBarry Smith #define MatOrderingType char*
910b12f92e5SBarry Smith #define MATORDERING_NATURAL   "natural"
911b12f92e5SBarry Smith #define MATORDERING_ND        "nd"
912b12f92e5SBarry Smith #define MATORDERING_1WD       "1wd"
913b12f92e5SBarry Smith #define MATORDERING_RCM       "rcm"
914b12f92e5SBarry Smith #define MATORDERING_QMD       "qmd"
915b12f92e5SBarry Smith #define MATORDERING_ROWLENGTH "rowlength"
91662152c8bSBarry Smith #define MATORDERING_DSC_ND    "dsc_nd"
91762152c8bSBarry Smith #define MATORDERING_DSC_MMD   "dsc_mmd"
91862152c8bSBarry Smith #define MATORDERING_DSC_MDF   "dsc_mdf"
919c06d978dSMatthew Knepley #define MATORDERING_CONSTRAINED "constrained"
920c06d978dSMatthew Knepley #define MATORDERING_IDENTITY  "identity"
921c06d978dSMatthew Knepley #define MATORDERING_REVERSE   "reverse"
922b12f92e5SBarry Smith 
923be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
924be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list);
925be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
92630de9b25SBarry Smith 
92730de9b25SBarry Smith /*MC
92830de9b25SBarry Smith    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the
92930de9b25SBarry Smith                                matrix package.
93030de9b25SBarry Smith 
93130de9b25SBarry Smith    Synopsis:
932c1ac3661SBarry Smith    PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
93330de9b25SBarry Smith 
93430de9b25SBarry Smith    Not Collective
93530de9b25SBarry Smith 
93630de9b25SBarry Smith    Input Parameters:
93730de9b25SBarry Smith +  sname - name of ordering (for example MATORDERING_ND)
93830de9b25SBarry Smith .  path - location of library where creation routine is
93930de9b25SBarry Smith .  name - name of function that creates the ordering type,a string
94030de9b25SBarry Smith -  function - function pointer that creates the ordering
94130de9b25SBarry Smith 
94230de9b25SBarry Smith    Level: developer
94330de9b25SBarry Smith 
94430de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
94530de9b25SBarry Smith    is ignored.
94630de9b25SBarry Smith 
94730de9b25SBarry Smith    Sample usage:
94830de9b25SBarry Smith .vb
94930de9b25SBarry Smith    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
95030de9b25SBarry Smith                "MyOrder",MyOrder);
95130de9b25SBarry Smith .ve
95230de9b25SBarry Smith 
95330de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
95430de9b25SBarry Smith $     MatOrderingSetType(part,"my_order)
95530de9b25SBarry Smith    or at runtime via the option
95630de9b25SBarry Smith $     -pc_ilu_mat_ordering_type my_order
95730de9b25SBarry Smith $     -pc_lu_mat_ordering_type my_order
95830de9b25SBarry Smith 
959ab901514SBarry Smith    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
96030de9b25SBarry Smith 
96130de9b25SBarry Smith .keywords: matrix, ordering, register
96230de9b25SBarry Smith 
96330de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
96430de9b25SBarry Smith M*/
965aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
966f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
967b12f92e5SBarry Smith #else
968f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
969b12f92e5SBarry Smith #endif
97030de9b25SBarry Smith 
971be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void);
972be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]);
9732bad1931SBarry Smith extern PetscTruth MatOrderingRegisterAllCalled;
974b0a32e0cSBarry Smith extern PetscFList MatOrderingList;
975d4fbbf0eSBarry Smith 
976be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
977a2ce50c7SBarry Smith 
978d91e6319SBarry Smith /*S
97915e8a5b3SHong Zhang    MatFactorInfo - Data based into the matrix factorization routines
980b00f7748SHong Zhang 
98115e8a5b3SHong Zhang    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE
982b00f7748SHong Zhang 
98315e8a5b3SHong Zhang    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
984b00f7748SHong Zhang 
985b00f7748SHong Zhang    Level: developer
986b00f7748SHong Zhang 
987d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
988d7d82daaSBarry Smith           MatFactorInfoInitialize()
989b00f7748SHong Zhang 
990b00f7748SHong Zhang S*/
991b00f7748SHong Zhang typedef struct {
9920a29876aSHong Zhang   PetscReal     shiftnz;        /* scaling of identity added to matrix to prevent zero pivots */
993fbf22428SSatish Balay   PetscReal     shiftpd;        /* if true, shift until positive pivots */
9942cea7109SBarry Smith   PetscReal     shift_fraction; /* record shift fraction taken */
99515e8a5b3SHong Zhang   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
99615e8a5b3SHong Zhang   PetscReal     dt;             /* drop tolerance */
997b00f7748SHong Zhang   PetscReal     dtcol;          /* tolerance for pivoting */
99815e8a5b3SHong Zhang   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
999f6275e2eSBarry Smith   PetscReal     fill;           /* expected fill; nonzeros in factored matrix/nonzeros in original matrix*/
1000348344bbSBarry Smith   PetscReal     levels;         /* ICC/ILU(levels) */
1001bcd9e38bSBarry Smith   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1002bcd9e38bSBarry Smith                                    factorization may be faster if do not pivot */
100315e8a5b3SHong Zhang   PetscReal     zeropivot;      /* pivot is called zero if less than this */
100415e8a5b3SHong Zhang } MatFactorInfo;
1005ffa6d0a5SLois Curfman McInnes 
1006be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*);
1007be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,MatFactorInfo*);
1008be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
1009be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,MatFactorInfo*,Mat*);
1010be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,MatFactorInfo*);
1011be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,MatFactorInfo*);
1012be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
1013be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
1014be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
1015be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,MatFactorInfo*);
1016be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,MatFactorInfo*,Mat*);
1017be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactor(Mat,IS,IS,MatFactorInfo*,Mat *);
1018be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1019be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec);
1020be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec);
1021be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec);
1022be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec);
1023be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec);
1024be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1025be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs);
10268ed539a5SBarry Smith 
1027be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat);
1028bb5a7306SBarry Smith 
1029d91e6319SBarry Smith /*E
1030d91e6319SBarry Smith     MatSORType - What type of (S)SOR to perform
1031bb1eb677SSatish Balay 
1032d91e6319SBarry Smith     Level: beginner
1033d91e6319SBarry Smith 
1034d9274352SBarry Smith    May be bitwise ORd together
1035d9274352SBarry Smith 
1036d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1037d91e6319SBarry Smith 
10384e7234bfSBarry Smith    MatSORType may be bitwise ORd together, so do not change the numbers
10394e7234bfSBarry Smith 
1040a1d92eedSBarry Smith .seealso: MatRelax(), MatPBRelax()
1041d91e6319SBarry Smith E*/
1042ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1043ee50ffe9SBarry Smith               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1044ee50ffe9SBarry Smith               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
104584cb2905SBarry Smith               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1046be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1047be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
10488ed539a5SBarry Smith 
1049d4fbbf0eSBarry Smith /*
1050639f9d9dSBarry Smith     These routines are for efficiently computing Jacobians via finite differences.
1051639f9d9dSBarry Smith */
1052b12f92e5SBarry Smith 
1053d9274352SBarry Smith /*E
1054d9274352SBarry Smith     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1055d9274352SBarry Smith        with an optional dynamic library name, for example
1056d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1057d9274352SBarry Smith 
1058d9274352SBarry Smith    Level: beginner
1059d9274352SBarry Smith 
1060d9274352SBarry Smith .seealso: MatGetColoring()
1061d9274352SBarry Smith E*/
106249773a63SBarry Smith #define MatColoringType char*
1063b12f92e5SBarry Smith #define MATCOLORING_NATURAL "natural"
1064b12f92e5SBarry Smith #define MATCOLORING_SL      "sl"
1065b12f92e5SBarry Smith #define MATCOLORING_LF      "lf"
1066b12f92e5SBarry Smith #define MATCOLORING_ID      "id"
1067b12f92e5SBarry Smith 
1068be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*);
1069be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatColoringType,ISColoring *));
107030de9b25SBarry Smith 
107130de9b25SBarry Smith /*MC
107230de9b25SBarry Smith    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
107330de9b25SBarry Smith                                matrix package.
107430de9b25SBarry Smith 
107530de9b25SBarry Smith    Synopsis:
1076c1ac3661SBarry Smith    PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring))
107730de9b25SBarry Smith 
107830de9b25SBarry Smith    Not Collective
107930de9b25SBarry Smith 
108030de9b25SBarry Smith    Input Parameters:
108130de9b25SBarry Smith +  sname - name of Coloring (for example MATCOLORING_SL)
108230de9b25SBarry Smith .  path - location of library where creation routine is
108330de9b25SBarry Smith .  name - name of function that creates the Coloring type, a string
108430de9b25SBarry Smith -  function - function pointer that creates the coloring
108530de9b25SBarry Smith 
108630de9b25SBarry Smith    Level: developer
108730de9b25SBarry Smith 
108830de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
108930de9b25SBarry Smith    is ignored.
109030de9b25SBarry Smith 
109130de9b25SBarry Smith    Sample usage:
109230de9b25SBarry Smith .vb
109330de9b25SBarry Smith    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
109430de9b25SBarry Smith                "MyColor",MyColor);
109530de9b25SBarry Smith .ve
109630de9b25SBarry Smith 
109730de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
109830de9b25SBarry Smith $     MatColoringSetType(part,"my_color")
109930de9b25SBarry Smith    or at runtime via the option
110030de9b25SBarry Smith $     -mat_coloring_type my_color
110130de9b25SBarry Smith 
1102ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
110330de9b25SBarry Smith 
110430de9b25SBarry Smith .keywords: matrix, Coloring, register
110530de9b25SBarry Smith 
110630de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
110730de9b25SBarry Smith M*/
1108aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1109f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1110b12f92e5SBarry Smith #else
1111f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1112b12f92e5SBarry Smith #endif
111330de9b25SBarry Smith 
11142bad1931SBarry Smith extern PetscTruth MatColoringRegisterAllCalled;
1115f1144a30SSatish Balay 
1116be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]);
1117be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void);
1118be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1119639f9d9dSBarry Smith 
1120d9274352SBarry Smith /*S
1121d9274352SBarry Smith      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1122d9274352SBarry Smith         and coloring
1123639f9d9dSBarry Smith 
1124d9274352SBarry Smith    Level: beginner
1125d9274352SBarry Smith 
1126d9274352SBarry Smith   Concepts: coloring, sparse Jacobian, finite differences
1127d9274352SBarry Smith 
1128d9274352SBarry Smith .seealso:  MatFDColoringCreate()
1129d9274352SBarry Smith S*/
1130e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring;
1131639f9d9dSBarry Smith 
1132be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1133be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring);
1134be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer);
1135be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1136be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1137be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFrequency(MatFDColoring,PetscInt);
1138be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFrequency(MatFDColoring,PetscInt*);
1139be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring);
1140be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1141be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1142be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetRecompute(MatFDColoring);
1143be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec);
1144be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1145639f9d9dSBarry Smith /*
11460752156aSBarry Smith     These routines are for partitioning matrices: currently used only
11473eda8832SBarry Smith   for adjacency matrix, MatCreateMPIAdj().
11480752156aSBarry Smith */
1149ca161407SBarry Smith 
1150d9274352SBarry Smith /*S
1151d9274352SBarry Smith      MatPartitioning - Object for managing the partitioning of a matrix or graph
1152d9274352SBarry Smith 
1153d9274352SBarry Smith    Level: beginner
1154d9274352SBarry Smith 
1155d9274352SBarry Smith   Concepts: partitioning
1156d9274352SBarry Smith 
1157743a1026Svictorle .seealso:  MatPartitioningCreate(), MatPartitioningType
1158d9274352SBarry Smith S*/
115991e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning;
1160d9274352SBarry Smith 
1161d9274352SBarry Smith /*E
11625bc6e7ccSvictorle     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1163d9274352SBarry Smith        with an optional dynamic library name, for example
1164d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1165d9274352SBarry Smith 
1166d9274352SBarry Smith    Level: beginner
1167d9274352SBarry Smith 
1168b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning
1169d9274352SBarry Smith E*/
117049773a63SBarry Smith #define MatPartitioningType char*
11718ba1e511SMatthew Knepley #define MAT_PARTITIONING_CURRENT  "current"
1172c2ec2a73SHong Zhang #define MAT_PARTITIONING_SQUARE   "square"
11738ba1e511SMatthew Knepley #define MAT_PARTITIONING_PARMETIS "parmetis"
117471306c60Sjroman #define MAT_PARTITIONING_CHACO    "chaco"
117571306c60Sjroman #define MAT_PARTITIONING_JOSTLE   "jostle"
117671306c60Sjroman #define MAT_PARTITIONING_PARTY    "party"
117771306c60Sjroman #define MAT_PARTITIONING_SCOTCH   "scotch"
117871306c60Sjroman 
1179ca161407SBarry Smith 
1180be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1181be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1182be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt);
1183be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat);
1184be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1185be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1186be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*);
1187be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning);
11882aabb6bbSBarry Smith 
1189be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
119030de9b25SBarry Smith 
119130de9b25SBarry Smith /*MC
119230de9b25SBarry Smith    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
119330de9b25SBarry Smith    matrix package.
119430de9b25SBarry Smith 
119530de9b25SBarry Smith    Synopsis:
1196c1ac3661SBarry Smith    PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
119730de9b25SBarry Smith 
119830de9b25SBarry Smith    Not Collective
119930de9b25SBarry Smith 
120030de9b25SBarry Smith    Input Parameters:
120130de9b25SBarry Smith +  sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis
120230de9b25SBarry Smith .  path - location of library where creation routine is
120330de9b25SBarry Smith .  name - name of function that creates the partitioning type, a string
120430de9b25SBarry Smith -  function - function pointer that creates the partitioning type
120530de9b25SBarry Smith 
120630de9b25SBarry Smith    Level: developer
120730de9b25SBarry Smith 
120830de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
120930de9b25SBarry Smith    is ignored.
121030de9b25SBarry Smith 
121130de9b25SBarry Smith    Sample usage:
121230de9b25SBarry Smith .vb
121330de9b25SBarry Smith    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
121430de9b25SBarry Smith                "MyPartCreate",MyPartCreate);
121530de9b25SBarry Smith .ve
121630de9b25SBarry Smith 
121730de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
121830de9b25SBarry Smith $     MatPartitioningSetType(part,"my_part")
121930de9b25SBarry Smith    or at runtime via the option
122030de9b25SBarry Smith $     -mat_partitioning_type my_part
122130de9b25SBarry Smith 
1222ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
122330de9b25SBarry Smith 
122430de9b25SBarry Smith .keywords: matrix, partitioning, register
122530de9b25SBarry Smith 
122630de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
122730de9b25SBarry Smith M*/
1228aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1229f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
12302aabb6bbSBarry Smith #else
1231f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
12322aabb6bbSBarry Smith #endif
12332aabb6bbSBarry Smith 
12342bad1931SBarry Smith extern PetscTruth MatPartitioningRegisterAllCalled;
1235f1144a30SSatish Balay 
1236be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]);
1237be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void);
12382bad1931SBarry Smith 
1239be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer);
1240be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning);
1241be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,MatPartitioningType*);
1242ca161407SBarry Smith 
1243be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
12440752156aSBarry Smith 
1245be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1246be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning);
124771306c60Sjroman 
124871306c60Sjroman typedef enum { MP_CHACO_MULTILEVEL_KL, MP_CHACO_SPECTRAL, MP_CHACO_LINEAR,
124971306c60Sjroman     MP_CHACO_RANDOM, MP_CHACO_SCATTERED } MPChacoGlobalType;
1250be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
125171306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1252be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1253be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
125471306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1255be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1256be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1257be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
125871306c60Sjroman 
125971306c60Sjroman #define MP_PARTY_OPT "opt"
126071306c60Sjroman #define MP_PARTY_LIN "lin"
126171306c60Sjroman #define MP_PARTY_SCA "sca"
126271306c60Sjroman #define MP_PARTY_RAN "ran"
126371306c60Sjroman #define MP_PARTY_GBF "gbf"
126471306c60Sjroman #define MP_PARTY_GCF "gcf"
126571306c60Sjroman #define MP_PARTY_BUB "bub"
126671306c60Sjroman #define MP_PARTY_DEF "def"
1267be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*);
126871306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs"
126971306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl"
127071306c60Sjroman #define MP_PARTY_NONE "no"
1271be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*);
1272be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1273be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth);
1274be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth);
127571306c60Sjroman 
127671306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1277be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*);
1278be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning);
1279be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1280be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1281be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*);
128271306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1283be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1284be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning);
1285be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*);
128671306c60Sjroman 
12870752156aSBarry Smith /*
12880a835dfdSSatish Balay     If you add entries here you must also add them to finclude/petscmat.h
1289d4fbbf0eSBarry Smith */
12901c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0,
12911c1c02c0SLois Curfman McInnes                MATOP_GET_ROW=1,
12921c1c02c0SLois Curfman McInnes                MATOP_RESTORE_ROW=2,
12931c1c02c0SLois Curfman McInnes                MATOP_MULT=3,
12941c1c02c0SLois Curfman McInnes                MATOP_MULT_ADD=4,
12957c922b88SBarry Smith                MATOP_MULT_TRANSPOSE=5,
12967c922b88SBarry Smith                MATOP_MULT_TRANSPOSE_ADD=6,
12971c1c02c0SLois Curfman McInnes                MATOP_SOLVE=7,
12981c1c02c0SLois Curfman McInnes                MATOP_SOLVE_ADD=8,
12997c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE=9,
13007c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE_ADD=10,
13011c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR=11,
13021c1c02c0SLois Curfman McInnes                MATOP_CHOLESKYFACTOR=12,
13031c1c02c0SLois Curfman McInnes                MATOP_RELAX=13,
13041c1c02c0SLois Curfman McInnes                MATOP_TRANSPOSE=14,
13051c1c02c0SLois Curfman McInnes                MATOP_GETINFO=15,
13061c1c02c0SLois Curfman McInnes                MATOP_EQUAL=16,
13071c1c02c0SLois Curfman McInnes                MATOP_GET_DIAGONAL=17,
13081c1c02c0SLois Curfman McInnes                MATOP_DIAGONAL_SCALE=18,
13091c1c02c0SLois Curfman McInnes                MATOP_NORM=19,
13101c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_BEGIN=20,
13111c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_END=21,
13121c1c02c0SLois Curfman McInnes                MATOP_COMPRESS=22,
13131c1c02c0SLois Curfman McInnes                MATOP_SET_OPTION=23,
13141c1c02c0SLois Curfman McInnes                MATOP_ZERO_ENTRIES=24,
13151c1c02c0SLois Curfman McInnes                MATOP_ZERO_ROWS=25,
13161c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR_SYMBOLIC=26,
13171c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR_NUMERIC=27,
13181c1c02c0SLois Curfman McInnes                MATOP_CHOLESKY_FACTOR_SYMBOLIC=28,
13191c1c02c0SLois Curfman McInnes                MATOP_CHOLESKY_FACTOR_NUMERIC=29,
1320d643ce63SMatthew Knepley                MATOP_SETUP_PREALLOCATION=30,
1321d643ce63SMatthew Knepley                MATOP_ILUFACTOR_SYMBOLIC=31,
1322d643ce63SMatthew Knepley                MATOP_ICCFACTOR_SYMBOLIC=32,
1323d643ce63SMatthew Knepley                MATOP_GET_ARRAY=33,
1324d643ce63SMatthew Knepley                MATOP_RESTORE_ARRAY=34,
1325e26f1c3cSBarry Smith                MATOP_DUPLICATE=35,
1326d643ce63SMatthew Knepley                MATOP_FORWARD_SOLVE=36,
1327d643ce63SMatthew Knepley                MATOP_BACKWARD_SOLVE=37,
1328d643ce63SMatthew Knepley                MATOP_ILUFACTOR=38,
1329d643ce63SMatthew Knepley                MATOP_ICCFACTOR=39,
1330d643ce63SMatthew Knepley                MATOP_AXPY=40,
1331d643ce63SMatthew Knepley                MATOP_GET_SUBMATRICES=41,
1332d643ce63SMatthew Knepley                MATOP_INCREASE_OVERLAP=42,
1333d643ce63SMatthew Knepley                MATOP_GET_VALUES=43,
1334d643ce63SMatthew Knepley                MATOP_COPY=44,
1335d643ce63SMatthew Knepley                MATOP_PRINT_HELP=45,
1336d643ce63SMatthew Knepley                MATOP_SCALE=46,
1337d643ce63SMatthew Knepley                MATOP_SHIFT=47,
1338d643ce63SMatthew Knepley                MATOP_DIAGONAL_SHIFT=48,
1339d643ce63SMatthew Knepley                MATOP_ILUDT_FACTOR=49,
1340d643ce63SMatthew Knepley                MATOP_GET_BLOCK_SIZE=50,
1341d643ce63SMatthew Knepley                MATOP_GET_ROW_IJ=51,
1342d643ce63SMatthew Knepley                MATOP_RESTORE_ROW_IJ=52,
1343d643ce63SMatthew Knepley                MATOP_GET_COLUMN_IJ=53,
1344d643ce63SMatthew Knepley                MATOP_RESTORE_COLUMN_IJ=54,
1345d643ce63SMatthew Knepley                MATOP_FDCOLORING_CREATE=55,
1346d643ce63SMatthew Knepley                MATOP_COLORING_PATCH=56,
1347d643ce63SMatthew Knepley                MATOP_SET_UNFACTORED=57,
1348d643ce63SMatthew Knepley                MATOP_PERMUTE=58,
1349d643ce63SMatthew Knepley                MATOP_SET_VALUES_BLOCKED=59,
1350d643ce63SMatthew Knepley                MATOP_GET_SUBMATRIX=60,
1351d643ce63SMatthew Knepley                MATOP_DESTROY=61,
1352d643ce63SMatthew Knepley                MATOP_VIEW=62,
1353d643ce63SMatthew Knepley                MATOP_GET_MAPS=63,
1354d643ce63SMatthew Knepley                MATOP_USE_SCALED_FORM=64,
1355d643ce63SMatthew Knepley                MATOP_SCALE_SYSTEM=65,
1356d643ce63SMatthew Knepley                MATOP_UNSCALE_SYSTEM=66,
1357ba16a8cbSKris Buschelman                MATOP_SET_LOCAL_TO_GLOBAL_MAP=67,
1358d643ce63SMatthew Knepley                MATOP_SET_VALUES_LOCAL=68,
1359d643ce63SMatthew Knepley                MATOP_ZERO_ROWS_LOCAL=69,
1360d643ce63SMatthew Knepley                MATOP_GET_ROW_MAX=70,
1361d643ce63SMatthew Knepley                MATOP_CONVERT=71,
1362d643ce63SMatthew Knepley                MATOP_SET_COLORING=72,
1363d643ce63SMatthew Knepley                MATOP_SET_VALUES_ADIC=73,
1364d643ce63SMatthew Knepley                MATOP_SET_VALUES_ADIFOR=74,
1365d643ce63SMatthew Knepley                MATOP_FD_COLORING_APPLY=75,
1366d643ce63SMatthew Knepley                MATOP_SET_FROM_OPTIONS=76,
1367ba16a8cbSKris Buschelman                MATOP_MULT_CON=77,
1368ba16a8cbSKris Buschelman                MATOP_MULT_TRANSPOSE_CON=78,
1369ba16a8cbSKris Buschelman                MATOP_ILU_FACTOR_SYMBOLIC_CON=79,
1370d643ce63SMatthew Knepley                MATOP_PERMUTE_SPARSIFY=80,
1371d643ce63SMatthew Knepley                MATOP_MULT_MULTIPLE=81,
137241acf15aSKris Buschelman                MATOP_SOLVE_MULTIPLE=82,
137341acf15aSKris Buschelman                MATOP_GET_INERTIA=83,
137441acf15aSKris Buschelman                MATOP_LOAD=84,
137541acf15aSKris Buschelman                MATOP_IS_SYMMETRIC=85,
137641acf15aSKris Buschelman                MATOP_IS_HERMITIAN=86,
137741acf15aSKris Buschelman                MATOP_IS_STRUCTURALLY_SYMMETRIC=87,
137841acf15aSKris Buschelman                MATOP_PB_RELAX=88,
137941acf15aSKris Buschelman                MATOP_GET_VECS=89,
138041acf15aSKris Buschelman                MATOP_MAT_MULT=90,
138141acf15aSKris Buschelman                MATOP_MAT_MULT_SYMBOLIC=91,
138241acf15aSKris Buschelman                MATOP_MAT_MULT_NUMERIC=92,
138341acf15aSKris Buschelman                MATOP_PTAP=93,
138441acf15aSKris Buschelman                MATOP_PTAP_SYMBOLIC=94,
1385bc011b1eSHong Zhang                MATOP_PTAP_NUMERIC=95,
1386bc011b1eSHong Zhang                MATOP_MAT_MULTTRANSPOSE=96,
1387bc011b1eSHong Zhang                MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=97,
13887ba1a0bfSKris Buschelman                MATOP_MAT_MULTTRANSPOSE_NUMERIC=98,
13897ba1a0bfSKris Buschelman                MATOP_PTAP_SYMBOLIC_SEQAIJ=99,
13907ba1a0bfSKris Buschelman                MATOP_PTAP_NUMERIC_SEQAIJ=100,
13917ba1a0bfSKris Buschelman                MATOP_PTAP_SYMBOLIC_MPIAIJ=101,
1392*87d4246cSBarry Smith                MATOP_PTAP_NUMERIC_MPIAIJ=102,
1393*87d4246cSBarry Smith                MATOP_SET_VALUES_ROW = 105
1394fae171e0SBarry Smith              } MatOperation;
1395be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*);
1396be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void));
1397be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void));
1398be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*);
1399112a2221SBarry Smith 
140090ace30eSBarry Smith /*
140190ace30eSBarry Smith    Codes for matrices stored on disk. By default they are
140290ace30eSBarry Smith  stored in a universal format. By changing the format with
1403fb9695e5SSatish Balay  PetscViewerSetFormat(viewer,PETSC_VIEWER_BINARY_NATIVE); the matrices will
140490ace30eSBarry Smith  be stored in a way natural for the matrix, for example dense matrices
140590ace30eSBarry Smith  would be stored as dense. Matrices stored this way may only be
140690ace30eSBarry Smith  read into matrices of the same time.
140790ace30eSBarry Smith */
140890ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1
140990ace30eSBarry Smith 
1410be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1411be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsGetColor(Mat,ISColoring *);
1412860d1616SSatish Balay 
1413be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*);
14141f4e1ec7SBarry Smith 
1415d9274352SBarry Smith /*S
1416d9274352SBarry Smith      MatNullSpace - Object that removes a null space from a vector, i.e.
1417d9274352SBarry Smith          orthogonalizes the vector to a subsapce
1418d9274352SBarry Smith 
1419f7a9e4ceSBarry Smith    Level: advanced
1420d9274352SBarry Smith 
1421d9274352SBarry Smith   Concepts: matrix; linear operator, null space
1422d9274352SBarry Smith 
14236e1639daSBarry Smith   Users manual sections:
14246e1639daSBarry Smith .   sec_singular
14256e1639daSBarry Smith 
1426d9274352SBarry Smith .seealso:  MatNullSpaceCreate()
1427d9274352SBarry Smith S*/
142874637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace;
1429d9274352SBarry Smith 
1430be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*);
1431be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace);
1432be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1433be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace);
1434be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat);
143574637425SBarry Smith 
1436be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS);
1437be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1438be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
143946129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat);
14403f1d51d7SBarry Smith 
1441be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*);
1442be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*);
1443be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*);
1444c4f061fbSSatish Balay 
1445be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*);
1446b0a32e0cSBarry Smith 
1447be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec);
144804f1ad80SBarry Smith 
1449be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1450be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
14517dbadf16SMatthew Knepley 
1452e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END
14532eac72dbSBarry Smith #endif
1454