xref: /petsc/include/petscmat.h (revision 0c451bc42d7bade440162d987bcef1c8f26e50ee)
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"
55b3a1e11cSKris Buschelman #define MATSEQAIJSPOOLES   "seqaijspooles"
56d10c748bSKris Buschelman #define MATMPIAIJSPOOLES   "mpiaijspooles"
579abb65ffSKris Buschelman #define MATSEQSBAIJSPOOLES "seqsbaijspooles"
5822191285SKris Buschelman #define MATMPISBAIJSPOOLES "mpisbaijspooles"
59bb4d4166SHong Zhang #define MATAIJSPOOLES      "aijspooles"
60bb4d4166SHong Zhang #define MATSBAIJSPOOLES    "sbaijspooles"
6114b396bbSKris Buschelman #define MATSUPERLU         "superlu"
621d96aa28SKris Buschelman #define MATSUPERLU_DIST    "superlu_dist"
631677d0b8SKris Buschelman #define MATUMFPACK         "umfpack"
64e8aa55a4SKris Buschelman #define MATESSL            "essl"
654eb8e494SKris Buschelman #define MATLUSOL           "lusol"
66397b6df1SKris Buschelman #define MATAIJMUMPS        "aijmumps"
67397b6df1SKris Buschelman #define MATSBAIJMUMPS      "sbaijmumps"
688da957c5SKris Buschelman #define MATDSCPACK         "dscpack"
697065e2aaSKris Buschelman #define MATMATLAB          "matlab"
7049773a63SBarry Smith #define MatType char*
71d91e6319SBarry Smith 
72c06d978dSMatthew Knepley /* Logging support */
73552e946dSBarry Smith #define    MAT_FILE_COOKIE 1211216    /* used to indicate matrices in binary files */
74be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_COOKIE;
75be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_FDCOLORING_COOKIE;
76be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_PARTITIONING_COOKIE;
77be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_NULLSPACE_COOKIE;
786849ba73SBarry Smith extern PetscEvent  MAT_Mult, MAT_MultMatrixFree, MAT_Mults, MAT_MultConstrained, MAT_MultAdd, MAT_MultTranspose;
796849ba73SBarry Smith extern PetscEvent  MAT_MultTransposeConstrained, MAT_MultTransposeAdd, MAT_Solve, MAT_Solves, MAT_SolveAdd, MAT_SolveTranspose;
806849ba73SBarry Smith extern PetscEvent  MAT_SolveTransposeAdd, MAT_Relax, MAT_ForwardSolve, MAT_BackwardSolve, MAT_LUFactor, MAT_LUFactorSymbolic;
816849ba73SBarry Smith extern PetscEvent  MAT_LUFactorNumeric, MAT_CholeskyFactor, MAT_CholeskyFactorSymbolic, MAT_CholeskyFactorNumeric, MAT_ILUFactor;
826849ba73SBarry Smith extern PetscEvent  MAT_ILUFactorSymbolic, MAT_ICCFactorSymbolic, MAT_Copy, MAT_Convert, MAT_Scale, MAT_AssemblyBegin;
836849ba73SBarry Smith extern PetscEvent  MAT_AssemblyEnd, MAT_SetValues, MAT_GetValues, MAT_GetRow, MAT_GetSubMatrices, MAT_GetColoring, MAT_GetOrdering;
846849ba73SBarry Smith extern PetscEvent  MAT_IncreaseOverlap, MAT_Partitioning, MAT_ZeroEntries, MAT_Load, MAT_View, MAT_AXPY, MAT_FDColoringCreate;
856849ba73SBarry Smith extern PetscEvent  MAT_FDColoringApply, MAT_Transpose, MAT_FDColoringFunction;
86cb00f407SKris Buschelman extern PetscEvent  MAT_MatMult, MAT_MatMultSymbolic, MAT_MatMultNumeric;
87534c1384SKris Buschelman extern PetscEvent  MAT_PtAP, MAT_PtAPSymbolic, MAT_PtAPNumeric;
88bc011b1eSHong Zhang extern PetscEvent  MAT_MatMultTranspose, MAT_MatMultTransposeSymbolic, MAT_MatMultTransposeNumeric;
89c06d978dSMatthew Knepley 
90ceb03754SKris Buschelman /*E
91ceb03754SKris Buschelman     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
92ceb03754SKris Buschelman      or MatGetSubMatrix() are to be reused to store the new matrix values.
93ceb03754SKris Buschelman 
94ceb03754SKris Buschelman     Level: beginner
95ceb03754SKris Buschelman 
96ceb03754SKris Buschelman    Any additions/changes here MUST also be made in include/finclude/petscmat.h
97ceb03754SKris Buschelman 
98*0c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
99ceb03754SKris Buschelman E*/
100ceb03754SKris Buschelman typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX} MatReuse;
101ceb03754SKris Buschelman 
102be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(char *);
103c06d978dSMatthew Knepley 
104be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
105*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreate,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(comm,m,n,M,N,&A),Mat,A);
106*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreate,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,&A),Mat,A);
107be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,const MatType);
108be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat);
109be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat);
110be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]);
111be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
11230de9b25SBarry Smith 
11330de9b25SBarry Smith /*MC
11430de9b25SBarry Smith    MatRegisterDynamic - Adds a new matrix type
11530de9b25SBarry Smith 
11630de9b25SBarry Smith    Synopsis:
117c1ac3661SBarry Smith    PetscErrorCode MatRegisterDynamic(char *name,char *path,char *name_create,PetscErrorCode (*routine_create)(Mat))
11830de9b25SBarry Smith 
11930de9b25SBarry Smith    Not Collective
12030de9b25SBarry Smith 
12130de9b25SBarry Smith    Input Parameters:
12230de9b25SBarry Smith +  name - name of a new user-defined matrix type
12330de9b25SBarry Smith .  path - path (either absolute or relative) the library containing this solver
12430de9b25SBarry Smith .  name_create - name of routine to create method context
12530de9b25SBarry Smith -  routine_create - routine to create method context
12630de9b25SBarry Smith 
12730de9b25SBarry Smith    Notes:
12830de9b25SBarry Smith    MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
12930de9b25SBarry Smith 
13030de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
13130de9b25SBarry Smith    is ignored.
13230de9b25SBarry Smith 
13330de9b25SBarry Smith    Sample usage:
13430de9b25SBarry Smith .vb
13530de9b25SBarry Smith    MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
13630de9b25SBarry Smith                "MyMatCreate",MyMatCreate);
13730de9b25SBarry Smith .ve
13830de9b25SBarry Smith 
13930de9b25SBarry Smith    Then, your solver can be chosen with the procedural interface via
14030de9b25SBarry Smith $     MatSetType(Mat,"my_mat")
14130de9b25SBarry Smith    or at runtime via the option
14230de9b25SBarry Smith $     -mat_type my_mat
14330de9b25SBarry Smith 
14430de9b25SBarry Smith    Level: advanced
14530de9b25SBarry Smith 
146ab901514SBarry Smith    Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
14730de9b25SBarry Smith          If your function is not being put into a shared library then use VecRegister() instead
14830de9b25SBarry Smith 
14930de9b25SBarry Smith .keywords: Mat, register
15030de9b25SBarry Smith 
15130de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy()
15230de9b25SBarry Smith 
15330de9b25SBarry Smith M*/
154273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
155273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
156273d9f13SBarry Smith #else
157273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
15830de9b25SBarry Smith #endif
15930de9b25SBarry Smith 
160273d9f13SBarry Smith extern PetscTruth MatRegisterAllCalled;
161b0a32e0cSBarry Smith extern PetscFList MatList;
16228988994SBarry Smith 
163be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
164be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
165be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
166*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A);
167*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A);
168*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A);
169*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A);
170*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A));
171*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A));
172*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A));
173be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
174*0c451bc4SBarry Smith 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);
175*0c451bc4SBarry Smith 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);
176*0c451bc4SBarry Smith 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);
177*0c451bc4SBarry Smith 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);
178*0c451bc4SBarry Smith 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));
179*0c451bc4SBarry Smith 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));
180*0c451bc4SBarry Smith 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));
181*0c451bc4SBarry Smith 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);
182*0c451bc4SBarry Smith 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);
183*0c451bc4SBarry Smith 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);
184*0c451bc4SBarry Smith 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);
185*0c451bc4SBarry Smith 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));
186*0c451bc4SBarry Smith 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));
187*0c451bc4SBarry Smith 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));
188be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIRowbs(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
189be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*);
190be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*);
191be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
192*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A);
193*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A);
194*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A);
195*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A);
196*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A));
197*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A));
198*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A));
199be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
200*0c451bc4SBarry Smith 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);
201*0c451bc4SBarry Smith 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);
202*0c451bc4SBarry Smith 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);
203*0c451bc4SBarry Smith 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);
204*0c451bc4SBarry Smith 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));
205*0c451bc4SBarry Smith 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));
206*0c451bc4SBarry Smith 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));
207*0c451bc4SBarry Smith 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);
208*0c451bc4SBarry Smith 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);
209*0c451bc4SBarry Smith 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);
210*0c451bc4SBarry Smith 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);
211*0c451bc4SBarry Smith 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));
212*0c451bc4SBarry Smith 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));
213*0c451bc4SBarry Smith 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));
214be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
215be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
216*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A);
217*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A);
218*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A);
219*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A);
220*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A));
221*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A));
222*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A));
223be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
224*0c451bc4SBarry Smith 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);
225*0c451bc4SBarry Smith 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);
226*0c451bc4SBarry Smith 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);
227*0c451bc4SBarry Smith 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);
228*0c451bc4SBarry Smith 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));
229*0c451bc4SBarry Smith 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));
230*0c451bc4SBarry Smith 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));
231*0c451bc4SBarry Smith 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);
232*0c451bc4SBarry Smith 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);
233*0c451bc4SBarry Smith 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);
234*0c451bc4SBarry Smith 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);
235*0c451bc4SBarry Smith 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));
236*0c451bc4SBarry Smith 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));
237*0c451bc4SBarry Smith 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));
238be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
239*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateShell,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(comm,m,n,M,N,ctx,&A),Mat,A);
240*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A);
241be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
242be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*);
243*0c451bc4SBarry Smith PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A);
244be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat);
24521c89e3eSBarry Smith 
246be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPrintHelp(Mat);
247be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetPetscMaps(Mat,PetscMap*,PetscMap*);
248ec0117caSBarry Smith 
249*0c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat);
2508ed539a5SBarry Smith /* ------------------------------------------------------------*/
251be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
252be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
25384cb2905SBarry Smith 
2542ef4de8bSBarry Smith /*S
2552ef4de8bSBarry Smith      MatStencil - Data structure (C struct) for storing information about a single row or
2562ef4de8bSBarry Smith         column of a matrix as index on an associated grid.
2572ef4de8bSBarry Smith 
2582ef4de8bSBarry Smith    Level: beginner
2592ef4de8bSBarry Smith 
2602ef4de8bSBarry Smith   Concepts: matrix; linear operator
2612ef4de8bSBarry Smith 
262d7bd93baSBarry Smith .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
2632ef4de8bSBarry Smith S*/
264435da068SBarry Smith typedef struct {
265c1ac3661SBarry Smith   PetscInt k,j,i,c;
266435da068SBarry Smith } MatStencil;
2672ef4de8bSBarry Smith 
268be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
269be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
270be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
271435da068SBarry Smith 
272be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring);
273be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*);
274be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*);
2753a7fca6bSBarry Smith 
276d91e6319SBarry Smith /*E
277d91e6319SBarry Smith     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
278d91e6319SBarry Smith      to continue to add values to it
279d91e6319SBarry Smith 
280d91e6319SBarry Smith     Level: beginner
281d91e6319SBarry Smith 
282d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd()
283d91e6319SBarry Smith E*/
2846d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
285be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType);
286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType);
287be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*);
2884f9c727eSBarry Smith 
289be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt    MatSetValue_Row;
290be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt    MatSetValue_Column;
291be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscScalar MatSetValue_Value;
2921d73ed98SBarry Smith 
29330de9b25SBarry Smith /*MC
29430de9b25SBarry Smith    MatSetValue - Set a single entry into a matrix.
29530de9b25SBarry Smith 
29630de9b25SBarry Smith    Synopsis:
297c1ac3661SBarry Smith    PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode);
29830de9b25SBarry Smith 
29930de9b25SBarry Smith    Not collective
30030de9b25SBarry Smith 
30130de9b25SBarry Smith    Input Parameters:
30230de9b25SBarry Smith +  m - the matrix
30330de9b25SBarry Smith .  row - the row location of the entry
30430de9b25SBarry Smith .  col - the column location of the entry
30530de9b25SBarry Smith .  value - the value to insert
30630de9b25SBarry Smith -  mode - either INSERT_VALUES or ADD_VALUES
30730de9b25SBarry Smith 
30830de9b25SBarry Smith    Notes:
30930de9b25SBarry Smith    For efficiency one should use MatSetValues() and set several or many
31030de9b25SBarry Smith    values simultaneously if possible.
31130de9b25SBarry Smith 
31230de9b25SBarry Smith    Level: beginner
31330de9b25SBarry Smith 
31430de9b25SBarry Smith .seealso: MatSetValues(), MatSetValueLocal()
31530de9b25SBarry Smith M*/
316b951964fSBarry Smith #define MatSetValue(v,i,j,va,mode) \
317f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \
3181d73ed98SBarry Smith    MatSetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode))
31930de9b25SBarry Smith 
320ea06a074SBarry Smith #define MatGetValue(v,i,j,va) \
321f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,0) || \
3221d73ed98SBarry Smith    MatGetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&va))
32330de9b25SBarry Smith 
324d91e6319SBarry Smith #define MatSetValueLocal(v,i,j,va,mode) \
325f1144a30SSatish Balay   ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \
3261d73ed98SBarry Smith    MatSetValuesLocal(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode))
32730de9b25SBarry Smith 
328d91e6319SBarry Smith /*E
329d91e6319SBarry Smith     MatOption - Options that may be set for a matrix and its behavior or storage
330d91e6319SBarry Smith 
331d91e6319SBarry Smith     Level: beginner
332d91e6319SBarry Smith 
3330a835dfdSSatish Balay    Any additions/changes here MUST also be made in include/finclude/petscmat.h
334d91e6319SBarry Smith 
335d91e6319SBarry Smith .seealso: MatSetOption()
336d91e6319SBarry Smith E*/
3376d4a8577SBarry Smith typedef enum {MAT_ROW_ORIENTED=1,MAT_COLUMN_ORIENTED=2,MAT_ROWS_SORTED=4,
3386d4a8577SBarry Smith               MAT_COLUMNS_SORTED=8,MAT_NO_NEW_NONZERO_LOCATIONS=16,
3396d4a8577SBarry Smith               MAT_YES_NEW_NONZERO_LOCATIONS=32,MAT_SYMMETRIC=64,
3406ca9ecd3SBarry Smith               MAT_STRUCTURALLY_SYMMETRIC=65,MAT_NO_NEW_DIAGONALS=66,
3416ca9ecd3SBarry Smith               MAT_YES_NEW_DIAGONALS=67,MAT_INODE_LIMIT_1=68,MAT_INODE_LIMIT_2=69,
3426ca9ecd3SBarry Smith               MAT_INODE_LIMIT_3=70,MAT_INODE_LIMIT_4=71,MAT_INODE_LIMIT_5=72,
3436ca9ecd3SBarry Smith               MAT_IGNORE_OFF_PROC_ENTRIES=73,MAT_ROWS_UNSORTED=74,
3444787f768SSatish Balay               MAT_COLUMNS_UNSORTED=75,MAT_NEW_NONZERO_LOCATION_ERR=76,
3457c922b88SBarry Smith               MAT_NEW_NONZERO_ALLOCATION_ERR=77,MAT_USE_HASH_TABLE=78,
3462bad1931SBarry Smith               MAT_KEEP_ZEROED_ROWS=79,MAT_IGNORE_ZERO_ENTRIES=80,MAT_USE_INODES=81,
347efcf0fc3SBarry Smith               MAT_DO_NOT_USE_INODES=82,MAT_NOT_SYMMETRIC=83,MAT_HERMITIAN=84,
3489a4540c5SBarry Smith               MAT_NOT_STRUCTURALLY_SYMMETRIC=85,MAT_NOT_HERMITIAN=86,
349d487561eSHong Zhang               MAT_SYMMETRY_ETERNAL=87,MAT_NOT_SYMMETRY_ETERNAL=88,
350941593c8SHong Zhang               MAT_USE_COMPRESSEDROW=89,MAT_DO_NOT_USE_COMPRESSEDROW=90,
351941593c8SHong Zhang               MAT_IGNORE_LOWER_TRIANGULAR=91,MAT_ERROR_LOWER_TRIANGULAR=92} MatOption;
352be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption);
353be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,MatType*);
354*0c451bc4SBarry Smith PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),MatType,t);
35584cb2905SBarry Smith 
356be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
357be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
358be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
359be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
360be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
361be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt);
362be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]);
363*0c451bc4SBarry Smith PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a);
364be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]);
365be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *);
366*0c451bc4SBarry Smith PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a);
367be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt);
3687b80b807SBarry Smith 
369be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec);
370be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec);
371*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y));
372be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec);
373be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*);
374*0c451bc4SBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t);
375*0c451bc4SBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0.0,&t),PetscTruth,t);
376be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec);
377*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y));
378be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec);
379be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec);
3802eac72dbSBarry Smith 
381d91e6319SBarry Smith /*E
382d91e6319SBarry Smith     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
383d91e6319SBarry Smith   its numerical values copied over or just its nonzero structure.
384d91e6319SBarry Smith 
385d91e6319SBarry Smith     Level: beginner
386d91e6319SBarry Smith 
387d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
388d91e6319SBarry Smith 
389d91e6319SBarry Smith .seealso: MatDuplicate()
390d91e6319SBarry Smith E*/
3912e8a6d31SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES} MatDuplicateOption;
3922e8a6d31SBarry Smith 
393be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegister(const char[],const char[],const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat*));
394273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
395273d9f13SBarry Smith #define MatConvertRegisterDynamic(a,b,c,d) MatConvertRegister(a,b,c,0)
396273d9f13SBarry Smith #else
397273d9f13SBarry Smith #define MatConvertRegisterDynamic(a,b,c,d) MatConvertRegister(a,b,c,d)
398273d9f13SBarry Smith #endif
399be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegisterAll(const char[]);
400be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegisterDestroy(void);
401273d9f13SBarry Smith extern PetscTruth MatConvertRegisterAllCalled;
402b0a32e0cSBarry Smith extern PetscFList MatConvertList;
403be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,const MatType,MatReuse,Mat*);
404*0c451bc4SBarry Smith PetscPolymorphicFunction(MatConvert,(Mat A,const MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a);
405be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*);
406*0c451bc4SBarry Smith PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a);
407*0c451bc4SBarry Smith PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a);
40894a9d846SBarry Smith 
409d91e6319SBarry Smith /*E
410d91e6319SBarry Smith     MatStructure - Indicates if the matrix has the same nonzero structure
411d91e6319SBarry Smith 
412d91e6319SBarry Smith     Level: beginner
413d91e6319SBarry Smith 
414d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
415d91e6319SBarry Smith 
41694b7f48cSBarry Smith .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
417d91e6319SBarry Smith E*/
418c537a176SHong Zhang typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure;
419cb5b572fSBarry Smith 
420be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure);
421be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer);
422be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*);
423*0c451bc4SBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t);
424*0c451bc4SBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0.0,&t),PetscTruth,t);
425be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*);
426*0c451bc4SBarry Smith PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t);
427be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscTruth*);
428*0c451bc4SBarry Smith PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,&t),PetscTruth,t);
429be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*);
430be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*);
431be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(PetscViewer,const MatType,Mat*);
432*0c451bc4SBarry Smith PetscPolymorphicFunction(MatLoad,(PetscViewer v,const MatType t),(v,t,&a),Mat,a);
4337b80b807SBarry Smith 
434be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
435be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
436be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
437be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
438d4fbbf0eSBarry Smith 
439d91e6319SBarry Smith /*S
440d91e6319SBarry Smith      MatInfo - Context of matrix information, used with MatGetInfo()
441d91e6319SBarry Smith 
442d91e6319SBarry Smith    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
443d91e6319SBarry Smith 
444d91e6319SBarry Smith    Level: intermediate
445d91e6319SBarry Smith 
446d91e6319SBarry Smith   Concepts: matrix^nonzero information
447d91e6319SBarry Smith 
448d9274352SBarry Smith .seealso:  MatGetInfo(), MatInfoType
449d91e6319SBarry Smith S*/
4504e220ebcSLois Curfman McInnes typedef struct {
451b0a32e0cSBarry Smith   PetscLogDouble rows_global,columns_global;         /* number of global rows and columns */
452b0a32e0cSBarry Smith   PetscLogDouble rows_local,columns_local;           /* number of local rows and columns */
453b0a32e0cSBarry Smith   PetscLogDouble block_size;                         /* block size */
454b0a32e0cSBarry Smith   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
455b0a32e0cSBarry Smith   PetscLogDouble memory;                             /* memory allocated */
456b0a32e0cSBarry Smith   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
457b0a32e0cSBarry Smith   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
458b0a32e0cSBarry Smith   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
459b0a32e0cSBarry Smith   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
4604e220ebcSLois Curfman McInnes } MatInfo;
4614e220ebcSLois Curfman McInnes 
462d9274352SBarry Smith /*E
463d9274352SBarry Smith     MatInfoType - Indicates if you want information about the local part of the matrix,
464d9274352SBarry Smith      the entire parallel matrix or the maximum over all the local parts.
465d9274352SBarry Smith 
466d9274352SBarry Smith     Level: beginner
467d9274352SBarry Smith 
468d9274352SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
469d9274352SBarry Smith 
470d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo
471d9274352SBarry Smith E*/
4727b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
473be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*);
474be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatValid(Mat,PetscTruth*);
475be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec);
476be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec);
477be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,Mat*);
478*0c451bc4SBarry Smith PetscPolymorphicFunction(MatTranspose,(Mat A),(A,&t),Mat,t);
479be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *);
480*0c451bc4SBarry Smith PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t);
481be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
482be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec);
483be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode);
484be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*);
485*0c451bc4SBarry Smith PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t);
486be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*);
487be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*);
488be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*);
489be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*);
4907b80b807SBarry Smith 
491be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *);
492*0c451bc4SBarry Smith PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n);
493be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat);
494be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,IS,const PetscScalar*);
495be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,IS,const PetscScalar*);
4967b80b807SBarry Smith 
497be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth);
498be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec);
499be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec);
5005ef9f2a5SBarry Smith 
501be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*);
502be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*);
503be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
5047b80b807SBarry Smith 
505be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
506be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]);
507be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,PetscInt,MatReuse,Mat *);
508be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
509be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
510be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
511be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat);
512be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat);
513be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*);
514be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
515be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
516be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscScalar**,Mat*);
5178efafbd8SBarry Smith 
518be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
5197b80b807SBarry Smith 
520be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
521be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
522be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat);
52322440eb1SKris Buschelman 
524be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
525be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
526be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat);
52722440eb1SKris Buschelman 
528be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
529be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
530be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat);
531bc011b1eSHong Zhang 
532be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(const PetscScalar *,Mat,Mat,MatStructure);
533*0c451bc4SBarry Smith PetscPolymorphicScalar(MatAXPY,(PetscScalar _t,Mat x,Mat y,MatStructure s),(&_T,x,y,s))
534be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(const PetscScalar *,Mat,Mat);
535*0c451bc4SBarry Smith PetscPolymorphicScalar(MatAYPX,(PetscScalar _t,Mat x,Mat y),(&_T,x,y))
536be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompress(Mat);
5371c741599SHong Zhang 
538be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(const PetscScalar *,Mat);
539*0c451bc4SBarry Smith PetscPolymorphicScalar(MatScale,(PetscScalar _t,Mat x),(&_T,x))
540be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(const PetscScalar *,Mat);
541*0c451bc4SBarry Smith PetscPolymorphicScalar(MatShift,(PetscScalar _t,Mat x),(&_T,x))
5427b80b807SBarry Smith 
543be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
544be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
545be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,IS,const PetscScalar*);
546be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
547be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
548052efed2SBarry Smith 
549be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt);
550be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
55190f02eecSBarry Smith 
552be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec);
553*0c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec);
554*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y));
555be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec);
556be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*);
557bd481603SBarry Smith 
558bd481603SBarry Smith /*MC
559bd481603SBarry Smith    MatPreallocInitialize - Begins the block of code that will count the number of nonzeros per
560bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
561bd481603SBarry Smith 
562bd481603SBarry Smith    Synopsis:
563c1ac3661SBarry Smith    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
564bd481603SBarry Smith 
565bd481603SBarry Smith    Collective on MPI_Comm
566bd481603SBarry Smith 
567bd481603SBarry Smith    Input Parameters:
568bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
569859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
570859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
571bd481603SBarry Smith 
572bd481603SBarry Smith    Output Parameters:
573bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
574bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
575bd481603SBarry Smith 
576bd481603SBarry Smith 
577bd481603SBarry Smith    Level: intermediate
578bd481603SBarry Smith 
579bd481603SBarry Smith    Notes:
580bd481603SBarry Smith    See the chapter in the users manual on performance for more details
581bd481603SBarry Smith 
5821d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
583bd481603SBarry Smith 
584bd481603SBarry Smith    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
585bd481603SBarry Smith 
586bd481603SBarry Smith   Concepts: preallocation^Matrix
587bd481603SBarry Smith 
588bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
589bd481603SBarry Smith           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
590bd481603SBarry Smith M*/
591c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
5927c922b88SBarry Smith { \
593c1ac3661SBarry Smith   PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
594c1ac3661SBarry Smith   _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\
595c1ac3661SBarry Smith   _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\
596c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
597c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp;
5987c922b88SBarry Smith 
599bd481603SBarry Smith /*MC
600bd481603SBarry Smith    MatPreallocSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
601bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
602bd481603SBarry Smith 
603bd481603SBarry Smith    Synopsis:
604c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
605bd481603SBarry Smith 
606bd481603SBarry Smith    Collective on MPI_Comm
607bd481603SBarry Smith 
608bd481603SBarry Smith    Input Parameters:
609bd481603SBarry Smith +  comm - the communicator that will share the eventually allocated matrix
610859fcb39SBarry Smith .  nrows - the number of LOCAL rows in the matrix
611859fcb39SBarry Smith -  ncols - the number of LOCAL columns in the matrix
612bd481603SBarry Smith 
613bd481603SBarry Smith    Output Parameters:
614bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
615bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
616bd481603SBarry Smith 
617bd481603SBarry Smith 
618bd481603SBarry Smith    Level: intermediate
619bd481603SBarry Smith 
620bd481603SBarry Smith    Notes:
621bd481603SBarry Smith    See the chapter in the users manual on performance for more details
622bd481603SBarry Smith 
6231d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
624bd481603SBarry Smith 
625bd481603SBarry Smith   Concepts: preallocation^Matrix
626bd481603SBarry Smith 
627bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
628bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
629bd481603SBarry Smith M*/
630222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
631222b16d4SBarry Smith { \
632c1ac3661SBarry Smith   PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__end; \
633c1ac3661SBarry Smith   _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\
634c1ac3661SBarry Smith   _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\
635c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
636c1ac3661SBarry Smith   _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp;
637222b16d4SBarry Smith 
638bd481603SBarry Smith /*MC
639bd481603SBarry Smith    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
640bd481603SBarry Smith        inserted using a local number of the rows and columns
641bd481603SBarry Smith 
642bd481603SBarry Smith    Synopsis:
643c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
644bd481603SBarry Smith 
645bd481603SBarry Smith    Not Collective
646bd481603SBarry Smith 
647bd481603SBarry Smith    Input Parameters:
648bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
649bd481603SBarry Smith .  nrows - the number of rows indicated
6501d73ed98SBarry Smith .  rows - the indices of the rows
651bd481603SBarry Smith .  ncols - the number of columns in the matrix
652bd481603SBarry Smith .  cols - the columns indicated
653bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
654bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
655bd481603SBarry Smith 
656bd481603SBarry Smith 
657bd481603SBarry Smith    Level: intermediate
658bd481603SBarry Smith 
659bd481603SBarry Smith    Notes:
660bd481603SBarry Smith    See the chapter in the users manual on performance for more details
661bd481603SBarry Smith 
6621d73ed98SBarry Smith    Do not malloc or free dnz and onz, that is handled internally by these routines
663bd481603SBarry Smith 
664bd481603SBarry Smith   Concepts: preallocation^Matrix
665bd481603SBarry Smith 
666bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
667bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
668bd481603SBarry Smith M*/
669c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
670c4f061fbSSatish Balay {\
671c1ac3661SBarry Smith   PetscInt __l;\
672ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
673ef66eb69SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
674c4f061fbSSatish Balay   for (__l=0;__l<nrows;__l++) {\
675ef66eb69SBarry Smith     _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
676c4f061fbSSatish Balay   }\
677c4f061fbSSatish Balay }
678c4f061fbSSatish Balay 
679bd481603SBarry Smith /*MC
680bd481603SBarry Smith    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
681bd481603SBarry Smith        inserted using a local number of the rows and columns
682bd481603SBarry Smith 
683bd481603SBarry Smith    Synopsis:
684c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
685bd481603SBarry Smith 
686bd481603SBarry Smith    Not Collective
687bd481603SBarry Smith 
688bd481603SBarry Smith    Input Parameters:
689bd481603SBarry Smith +  map - the mapping between local numbering and global numbering
690bd481603SBarry Smith .  nrows - the number of rows indicated
6911d73ed98SBarry Smith .  rows - the indices of the rows
692bd481603SBarry Smith .  ncols - the number of columns in the matrix
693bd481603SBarry Smith .  cols - the columns indicated
694bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
695bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
696bd481603SBarry Smith 
697bd481603SBarry Smith 
698bd481603SBarry Smith    Level: intermediate
699bd481603SBarry Smith 
700bd481603SBarry Smith    Notes:
701bd481603SBarry Smith    See the chapter in the users manual on performance for more details
702bd481603SBarry Smith 
703bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
704bd481603SBarry Smith 
705bd481603SBarry Smith   Concepts: preallocation^Matrix
706bd481603SBarry Smith 
707bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
708bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
709bd481603SBarry Smith M*/
710d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
711d3d32019SBarry Smith {\
712c1ac3661SBarry Smith   PetscInt __l;\
713d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
714d3d32019SBarry Smith   _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
715d3d32019SBarry Smith   for (__l=0;__l<nrows;__l++) {\
716d3d32019SBarry Smith     _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
717d3d32019SBarry Smith   }\
718d3d32019SBarry Smith }
719d3d32019SBarry Smith 
720bd481603SBarry Smith /*MC
721bd481603SBarry Smith    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
722bd481603SBarry Smith        inserted using a local number of the rows and columns
723bd481603SBarry Smith 
724bd481603SBarry Smith    Synopsis:
725c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
726bd481603SBarry Smith 
727bd481603SBarry Smith    Not Collective
728bd481603SBarry Smith 
729bd481603SBarry Smith    Input Parameters:
730bd481603SBarry Smith +  nrows - the number of rows indicated
7311d73ed98SBarry Smith .  rows - the indices of the rows
732bd481603SBarry Smith .  ncols - the number of columns in the matrix
733a50f8bf6SHong Zhang -  cols - the columns indicated
734a50f8bf6SHong Zhang 
735a50f8bf6SHong Zhang    Output Parameters:
736a50f8bf6SHong Zhang +  dnz - the array that will be passed to the matrix preallocation routines
737bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
738bd481603SBarry Smith 
739bd481603SBarry Smith 
740bd481603SBarry Smith    Level: intermediate
741bd481603SBarry Smith 
742bd481603SBarry Smith    Notes:
743bd481603SBarry Smith    See the chapter in the users manual on performance for more details
744bd481603SBarry Smith 
745bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
746bd481603SBarry Smith 
747bd481603SBarry Smith   Concepts: preallocation^Matrix
748bd481603SBarry Smith 
749bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
750bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
751bd481603SBarry Smith M*/
752c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
753c1ac3661SBarry Smith { PetscInt __i; \
7547c922b88SBarry Smith   for (__i=0; __i<nc; __i++) {\
7557c922b88SBarry Smith     if (cols[__i] < __start || cols[__i] >= __end) onz[row - __rstart]++; \
7567c922b88SBarry Smith   }\
7577c922b88SBarry Smith   dnz[row - __rstart] = nc - onz[row - __rstart];\
7587c922b88SBarry Smith }
7597c922b88SBarry Smith 
760bd481603SBarry Smith /*MC
761bd481603SBarry Smith    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
762bd481603SBarry Smith        inserted using a local number of the rows and columns
763bd481603SBarry Smith 
764bd481603SBarry Smith    Synopsis:
765c1ac3661SBarry Smith    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
766bd481603SBarry Smith 
767bd481603SBarry Smith    Not Collective
768bd481603SBarry Smith 
769bd481603SBarry Smith    Input Parameters:
770bd481603SBarry Smith +  nrows - the number of rows indicated
7711d73ed98SBarry Smith .  rows - the indices of the rows
772bd481603SBarry Smith .  ncols - the number of columns in the matrix
773bd481603SBarry Smith .  cols - the columns indicated
774bd481603SBarry Smith .  dnz - the array that will be passed to the matrix preallocation routines
775bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
776bd481603SBarry Smith 
777bd481603SBarry Smith 
778bd481603SBarry Smith    Level: intermediate
779bd481603SBarry Smith 
780bd481603SBarry Smith    Notes:
781bd481603SBarry Smith    See the chapter in the users manual on performance for more details
782bd481603SBarry Smith 
783bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
784bd481603SBarry Smith 
785bd481603SBarry Smith   Concepts: preallocation^Matrix
786bd481603SBarry Smith 
787bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
788bd481603SBarry Smith           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
789bd481603SBarry Smith M*/
790d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
791c1ac3661SBarry Smith { PetscInt __i; \
792d3d32019SBarry Smith   for (__i=0; __i<nc; __i++) {\
793d3d32019SBarry Smith     if (cols[__i] >= __end) onz[row - __rstart]++; \
794d3d32019SBarry Smith     else if (cols[__i] >= row) dnz[row - __rstart]++;\
795d3d32019SBarry Smith   }\
796d3d32019SBarry Smith }
797d3d32019SBarry Smith 
798bd481603SBarry Smith /*MC
799bd481603SBarry Smith    MatPreallocFinalize - Ends the block of code that will count the number of nonzeros per
800bd481603SBarry Smith        row in a matrix providing the data that one can use to correctly preallocate the matrix.
801bd481603SBarry Smith 
802bd481603SBarry Smith    Synopsis:
803c1ac3661SBarry Smith    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
804bd481603SBarry Smith 
805bd481603SBarry Smith    Collective on MPI_Comm
806bd481603SBarry Smith 
807bd481603SBarry Smith    Input Parameters:
808bd481603SBarry Smith +  dnz - the array that will be passed to the matrix preallocation routines
809bd481603SBarry Smith -  ozn - the other array passed to the matrix preallocation routines
810bd481603SBarry Smith 
811bd481603SBarry Smith 
812bd481603SBarry Smith    Level: intermediate
813bd481603SBarry Smith 
814bd481603SBarry Smith    Notes:
815bd481603SBarry Smith    See the chapter in the users manual on performance for more details
816bd481603SBarry Smith 
817bd481603SBarry Smith    Do not malloc or free dnz and onz that is handled internally by these routines
818bd481603SBarry Smith 
819bd481603SBarry Smith   Concepts: preallocation^Matrix
820bd481603SBarry Smith 
821bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
822bd481603SBarry Smith           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
823bd481603SBarry Smith M*/
824ef66eb69SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree(dnz);CHKERRQ(_4_ierr);}
8257c922b88SBarry Smith 
826bd481603SBarry Smith 
827bd481603SBarry Smith 
8287b80b807SBarry Smith /* Routines unique to particular data structures */
829be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **);
830*0c451bc4SBarry Smith PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t);
831be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBDiagGetData(Mat,PetscInt*,PetscInt*,PetscInt*[],PetscInt*[],PetscScalar***);
832698d4c6aSKris Buschelman 
833be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*);
834be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
835698d4c6aSKris Buschelman 
836be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
837be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
838be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
8397b80b807SBarry Smith 
840a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4
841a96a251dSBarry Smith 
842be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
843*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz));
844be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
845*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz));
846be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
847*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz));
848be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDensePreallocation(Mat,PetscScalar[]);
849be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]);
850be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
851273d9f13SBarry Smith 
852be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
853*0c451bc4SBarry Smith PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz));
854be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
855be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
856be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
857be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
858be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDensePreallocation(Mat,PetscScalar[]);
859be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]);
860be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
861be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
862be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]);
863be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
864be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
865be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void));
866273d9f13SBarry Smith 
867be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt);
8681b807ce4Svictorle 
869be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat);
870be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat);
8712e8a6d31SBarry Smith 
872be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*);
8733a7fca6bSBarry Smith 
8747b80b807SBarry Smith /*
8757b80b807SBarry Smith   These routines are not usually accessed directly, rather solving is
87694b7f48cSBarry Smith   done through the KSP and PC interfaces.
8777b80b807SBarry Smith */
8787b80b807SBarry Smith 
879d9274352SBarry Smith /*E
880d9274352SBarry Smith     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
881d9274352SBarry Smith        with an optional dynamic library name, for example
882d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
883d9274352SBarry Smith 
884d9274352SBarry Smith    Level: beginner
885d9274352SBarry Smith 
886d9274352SBarry Smith .seealso: MatGetOrdering()
887d9274352SBarry Smith E*/
88849773a63SBarry Smith #define MatOrderingType char*
889b12f92e5SBarry Smith #define MATORDERING_NATURAL   "natural"
890b12f92e5SBarry Smith #define MATORDERING_ND        "nd"
891b12f92e5SBarry Smith #define MATORDERING_1WD       "1wd"
892b12f92e5SBarry Smith #define MATORDERING_RCM       "rcm"
893b12f92e5SBarry Smith #define MATORDERING_QMD       "qmd"
894b12f92e5SBarry Smith #define MATORDERING_ROWLENGTH "rowlength"
89562152c8bSBarry Smith #define MATORDERING_DSC_ND    "dsc_nd"
89662152c8bSBarry Smith #define MATORDERING_DSC_MMD   "dsc_mmd"
89762152c8bSBarry Smith #define MATORDERING_DSC_MDF   "dsc_mdf"
898c06d978dSMatthew Knepley #define MATORDERING_CONSTRAINED "constrained"
899c06d978dSMatthew Knepley #define MATORDERING_IDENTITY  "identity"
900c06d978dSMatthew Knepley #define MATORDERING_REVERSE   "reverse"
901b12f92e5SBarry Smith 
902be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
903be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list);
904be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
90530de9b25SBarry Smith 
90630de9b25SBarry Smith /*MC
90730de9b25SBarry Smith    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the
90830de9b25SBarry Smith                                matrix package.
90930de9b25SBarry Smith 
91030de9b25SBarry Smith    Synopsis:
911c1ac3661SBarry Smith    PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
91230de9b25SBarry Smith 
91330de9b25SBarry Smith    Not Collective
91430de9b25SBarry Smith 
91530de9b25SBarry Smith    Input Parameters:
91630de9b25SBarry Smith +  sname - name of ordering (for example MATORDERING_ND)
91730de9b25SBarry Smith .  path - location of library where creation routine is
91830de9b25SBarry Smith .  name - name of function that creates the ordering type,a string
91930de9b25SBarry Smith -  function - function pointer that creates the ordering
92030de9b25SBarry Smith 
92130de9b25SBarry Smith    Level: developer
92230de9b25SBarry Smith 
92330de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
92430de9b25SBarry Smith    is ignored.
92530de9b25SBarry Smith 
92630de9b25SBarry Smith    Sample usage:
92730de9b25SBarry Smith .vb
92830de9b25SBarry Smith    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
92930de9b25SBarry Smith                "MyOrder",MyOrder);
93030de9b25SBarry Smith .ve
93130de9b25SBarry Smith 
93230de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
93330de9b25SBarry Smith $     MatOrderingSetType(part,"my_order)
93430de9b25SBarry Smith    or at runtime via the option
93530de9b25SBarry Smith $     -pc_ilu_mat_ordering_type my_order
93630de9b25SBarry Smith $     -pc_lu_mat_ordering_type my_order
93730de9b25SBarry Smith 
938ab901514SBarry Smith    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
93930de9b25SBarry Smith 
94030de9b25SBarry Smith .keywords: matrix, ordering, register
94130de9b25SBarry Smith 
94230de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
94330de9b25SBarry Smith M*/
944aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
945f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
946b12f92e5SBarry Smith #else
947f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
948b12f92e5SBarry Smith #endif
94930de9b25SBarry Smith 
950be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void);
951be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]);
9522bad1931SBarry Smith extern PetscTruth MatOrderingRegisterAllCalled;
953b0a32e0cSBarry Smith extern PetscFList MatOrderingList;
954d4fbbf0eSBarry Smith 
955be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
956a2ce50c7SBarry Smith 
957d91e6319SBarry Smith /*S
95815e8a5b3SHong Zhang    MatFactorInfo - Data based into the matrix factorization routines
959b00f7748SHong Zhang 
96015e8a5b3SHong Zhang    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE
961b00f7748SHong Zhang 
96215e8a5b3SHong Zhang    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
963b00f7748SHong Zhang 
964b00f7748SHong Zhang    Level: developer
965b00f7748SHong Zhang 
966d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
967d7d82daaSBarry Smith           MatFactorInfoInitialize()
968b00f7748SHong Zhang 
969b00f7748SHong Zhang S*/
970b00f7748SHong Zhang typedef struct {
9710a29876aSHong Zhang   PetscReal     shiftnz;        /* scaling of identity added to matrix to prevent zero pivots */
9720a29876aSHong Zhang   PetscTruth    shiftpd;         /* if true, shift until positive pivots */
9732cea7109SBarry Smith   PetscReal     shift_fraction; /* record shift fraction taken */
97415e8a5b3SHong Zhang   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
97515e8a5b3SHong Zhang   PetscReal     dt;             /* drop tolerance */
976b00f7748SHong Zhang   PetscReal     dtcol;          /* tolerance for pivoting */
97715e8a5b3SHong Zhang   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
978f6275e2eSBarry Smith   PetscReal     fill;           /* expected fill; nonzeros in factored matrix/nonzeros in original matrix*/
979348344bbSBarry Smith   PetscReal     levels;         /* ICC/ILU(levels) */
980bcd9e38bSBarry Smith   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
981bcd9e38bSBarry Smith                                    factorization may be faster if do not pivot */
98215e8a5b3SHong Zhang   PetscReal     zeropivot;      /* pivot is called zero if less than this */
98315e8a5b3SHong Zhang } MatFactorInfo;
984ffa6d0a5SLois Curfman McInnes 
985be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*);
986be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,MatFactorInfo*);
987be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
988be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,MatFactorInfo*,Mat*);
989be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,MatFactorInfo*);
990be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,MatFactorInfo*);
991be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
992be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*);
993be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*);
994be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,MatFactorInfo*);
995be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,MatFactorInfo*,Mat*);
996be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactor(Mat,IS,IS,MatFactorInfo*,Mat *);
997be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
998be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec);
999be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec);
1000be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec);
1001be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec);
1002be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec);
1003be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1004be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs);
10058ed539a5SBarry Smith 
1006be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat);
1007bb5a7306SBarry Smith 
1008d91e6319SBarry Smith /*E
1009d91e6319SBarry Smith     MatSORType - What type of (S)SOR to perform
1010bb1eb677SSatish Balay 
1011d91e6319SBarry Smith     Level: beginner
1012d91e6319SBarry Smith 
1013d9274352SBarry Smith    May be bitwise ORd together
1014d9274352SBarry Smith 
1015d91e6319SBarry Smith    Any additions/changes here MUST also be made in include/finclude/petscmat.h
1016d91e6319SBarry Smith 
10174e7234bfSBarry Smith    MatSORType may be bitwise ORd together, so do not change the numbers
10184e7234bfSBarry Smith 
1019a1d92eedSBarry Smith .seealso: MatRelax(), MatPBRelax()
1020d91e6319SBarry Smith E*/
1021ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1022ee50ffe9SBarry Smith               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1023ee50ffe9SBarry Smith               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
102484cb2905SBarry Smith               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1025be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1026be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
10278ed539a5SBarry Smith 
1028d4fbbf0eSBarry Smith /*
1029639f9d9dSBarry Smith     These routines are for efficiently computing Jacobians via finite differences.
1030639f9d9dSBarry Smith */
1031b12f92e5SBarry Smith 
1032d9274352SBarry Smith /*E
1033d9274352SBarry Smith     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1034d9274352SBarry Smith        with an optional dynamic library name, for example
1035d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1036d9274352SBarry Smith 
1037d9274352SBarry Smith    Level: beginner
1038d9274352SBarry Smith 
1039d9274352SBarry Smith .seealso: MatGetColoring()
1040d9274352SBarry Smith E*/
104149773a63SBarry Smith #define MatColoringType char*
1042b12f92e5SBarry Smith #define MATCOLORING_NATURAL "natural"
1043b12f92e5SBarry Smith #define MATCOLORING_SL      "sl"
1044b12f92e5SBarry Smith #define MATCOLORING_LF      "lf"
1045b12f92e5SBarry Smith #define MATCOLORING_ID      "id"
1046b12f92e5SBarry Smith 
1047be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*);
1048be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatColoringType,ISColoring *));
104930de9b25SBarry Smith 
105030de9b25SBarry Smith /*MC
105130de9b25SBarry Smith    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
105230de9b25SBarry Smith                                matrix package.
105330de9b25SBarry Smith 
105430de9b25SBarry Smith    Synopsis:
1055c1ac3661SBarry Smith    PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring))
105630de9b25SBarry Smith 
105730de9b25SBarry Smith    Not Collective
105830de9b25SBarry Smith 
105930de9b25SBarry Smith    Input Parameters:
106030de9b25SBarry Smith +  sname - name of Coloring (for example MATCOLORING_SL)
106130de9b25SBarry Smith .  path - location of library where creation routine is
106230de9b25SBarry Smith .  name - name of function that creates the Coloring type, a string
106330de9b25SBarry Smith -  function - function pointer that creates the coloring
106430de9b25SBarry Smith 
106530de9b25SBarry Smith    Level: developer
106630de9b25SBarry Smith 
106730de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
106830de9b25SBarry Smith    is ignored.
106930de9b25SBarry Smith 
107030de9b25SBarry Smith    Sample usage:
107130de9b25SBarry Smith .vb
107230de9b25SBarry Smith    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
107330de9b25SBarry Smith                "MyColor",MyColor);
107430de9b25SBarry Smith .ve
107530de9b25SBarry Smith 
107630de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
107730de9b25SBarry Smith $     MatColoringSetType(part,"my_color")
107830de9b25SBarry Smith    or at runtime via the option
107930de9b25SBarry Smith $     -mat_coloring_type my_color
108030de9b25SBarry Smith 
1081ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
108230de9b25SBarry Smith 
108330de9b25SBarry Smith .keywords: matrix, Coloring, register
108430de9b25SBarry Smith 
108530de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
108630de9b25SBarry Smith M*/
1087aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1088f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1089b12f92e5SBarry Smith #else
1090f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1091b12f92e5SBarry Smith #endif
109230de9b25SBarry Smith 
10932bad1931SBarry Smith extern PetscTruth MatColoringRegisterAllCalled;
1094f1144a30SSatish Balay 
1095be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]);
1096be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void);
1097be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1098639f9d9dSBarry Smith 
1099d9274352SBarry Smith /*S
1100d9274352SBarry Smith      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1101d9274352SBarry Smith         and coloring
1102639f9d9dSBarry Smith 
1103d9274352SBarry Smith    Level: beginner
1104d9274352SBarry Smith 
1105d9274352SBarry Smith   Concepts: coloring, sparse Jacobian, finite differences
1106d9274352SBarry Smith 
1107d9274352SBarry Smith .seealso:  MatFDColoringCreate()
1108d9274352SBarry Smith S*/
1109e2a1c21fSSatish Balay typedef struct _p_MatFDColoring *MatFDColoring;
1110639f9d9dSBarry Smith 
1111be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1112be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring);
1113be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer);
1114be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1115be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1116be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFrequency(MatFDColoring,PetscInt);
1117be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFrequency(MatFDColoring,PetscInt*);
1118be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring);
1119be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1120be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1121be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetRecompute(MatFDColoring);
1122be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec);
1123be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1124639f9d9dSBarry Smith /*
11250752156aSBarry Smith     These routines are for partitioning matrices: currently used only
11263eda8832SBarry Smith   for adjacency matrix, MatCreateMPIAdj().
11270752156aSBarry Smith */
1128ca161407SBarry Smith 
1129d9274352SBarry Smith /*S
1130d9274352SBarry Smith      MatPartitioning - Object for managing the partitioning of a matrix or graph
1131d9274352SBarry Smith 
1132d9274352SBarry Smith    Level: beginner
1133d9274352SBarry Smith 
1134d9274352SBarry Smith   Concepts: partitioning
1135d9274352SBarry Smith 
1136743a1026Svictorle .seealso:  MatPartitioningCreate(), MatPartitioningType
1137d9274352SBarry Smith S*/
113891e9ee9fSBarry Smith typedef struct _p_MatPartitioning *MatPartitioning;
1139d9274352SBarry Smith 
1140d9274352SBarry Smith /*E
11415bc6e7ccSvictorle     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1142d9274352SBarry Smith        with an optional dynamic library name, for example
1143d9274352SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1144d9274352SBarry Smith 
1145d9274352SBarry Smith    Level: beginner
1146d9274352SBarry Smith 
1147b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning
1148d9274352SBarry Smith E*/
114949773a63SBarry Smith #define MatPartitioningType char*
11508ba1e511SMatthew Knepley #define MAT_PARTITIONING_CURRENT  "current"
1151c2ec2a73SHong Zhang #define MAT_PARTITIONING_SQUARE   "square"
11528ba1e511SMatthew Knepley #define MAT_PARTITIONING_PARMETIS "parmetis"
115371306c60Sjroman #define MAT_PARTITIONING_CHACO    "chaco"
115471306c60Sjroman #define MAT_PARTITIONING_JOSTLE   "jostle"
115571306c60Sjroman #define MAT_PARTITIONING_PARTY    "party"
115671306c60Sjroman #define MAT_PARTITIONING_SCOTCH   "scotch"
115771306c60Sjroman 
1158ca161407SBarry Smith 
1159be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1160be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1161be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt);
1162be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat);
1163be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1164be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1165be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*);
1166be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning);
11672aabb6bbSBarry Smith 
1168be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
116930de9b25SBarry Smith 
117030de9b25SBarry Smith /*MC
117130de9b25SBarry Smith    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
117230de9b25SBarry Smith    matrix package.
117330de9b25SBarry Smith 
117430de9b25SBarry Smith    Synopsis:
1175c1ac3661SBarry Smith    PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
117630de9b25SBarry Smith 
117730de9b25SBarry Smith    Not Collective
117830de9b25SBarry Smith 
117930de9b25SBarry Smith    Input Parameters:
118030de9b25SBarry Smith +  sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis
118130de9b25SBarry Smith .  path - location of library where creation routine is
118230de9b25SBarry Smith .  name - name of function that creates the partitioning type, a string
118330de9b25SBarry Smith -  function - function pointer that creates the partitioning type
118430de9b25SBarry Smith 
118530de9b25SBarry Smith    Level: developer
118630de9b25SBarry Smith 
118730de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (function)
118830de9b25SBarry Smith    is ignored.
118930de9b25SBarry Smith 
119030de9b25SBarry Smith    Sample usage:
119130de9b25SBarry Smith .vb
119230de9b25SBarry Smith    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
119330de9b25SBarry Smith                "MyPartCreate",MyPartCreate);
119430de9b25SBarry Smith .ve
119530de9b25SBarry Smith 
119630de9b25SBarry Smith    Then, your partitioner can be chosen with the procedural interface via
119730de9b25SBarry Smith $     MatPartitioningSetType(part,"my_part")
119830de9b25SBarry Smith    or at runtime via the option
119930de9b25SBarry Smith $     -mat_partitioning_type my_part
120030de9b25SBarry Smith 
1201ab901514SBarry Smith    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
120230de9b25SBarry Smith 
120330de9b25SBarry Smith .keywords: matrix, partitioning, register
120430de9b25SBarry Smith 
120530de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
120630de9b25SBarry Smith M*/
1207aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1208f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
12092aabb6bbSBarry Smith #else
1210f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
12112aabb6bbSBarry Smith #endif
12122aabb6bbSBarry Smith 
12132bad1931SBarry Smith extern PetscTruth MatPartitioningRegisterAllCalled;
1214f1144a30SSatish Balay 
1215be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]);
1216be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void);
12172bad1931SBarry Smith 
1218be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer);
1219be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning);
1220be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,MatPartitioningType*);
1221ca161407SBarry Smith 
1222be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
12230752156aSBarry Smith 
1224be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1225be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning);
122671306c60Sjroman 
122771306c60Sjroman typedef enum { MP_CHACO_MULTILEVEL_KL, MP_CHACO_SPECTRAL, MP_CHACO_LINEAR,
122871306c60Sjroman     MP_CHACO_RANDOM, MP_CHACO_SCATTERED } MPChacoGlobalType;
1229be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
123071306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1231be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1232be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
123371306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1234be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1235be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1236be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
123771306c60Sjroman 
123871306c60Sjroman #define MP_PARTY_OPT "opt"
123971306c60Sjroman #define MP_PARTY_LIN "lin"
124071306c60Sjroman #define MP_PARTY_SCA "sca"
124171306c60Sjroman #define MP_PARTY_RAN "ran"
124271306c60Sjroman #define MP_PARTY_GBF "gbf"
124371306c60Sjroman #define MP_PARTY_GCF "gcf"
124471306c60Sjroman #define MP_PARTY_BUB "bub"
124571306c60Sjroman #define MP_PARTY_DEF "def"
1246be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*);
124771306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs"
124871306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl"
124971306c60Sjroman #define MP_PARTY_NONE "no"
1250be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*);
1251be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1252be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth);
1253be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth);
125471306c60Sjroman 
125571306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1256be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*);
1257be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning);
1258be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1259be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1260be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*);
126171306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1262be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1263be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning);
1264be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*);
126571306c60Sjroman 
12660752156aSBarry Smith /*
12670a835dfdSSatish Balay     If you add entries here you must also add them to finclude/petscmat.h
1268d4fbbf0eSBarry Smith */
12691c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0,
12701c1c02c0SLois Curfman McInnes                MATOP_GET_ROW=1,
12711c1c02c0SLois Curfman McInnes                MATOP_RESTORE_ROW=2,
12721c1c02c0SLois Curfman McInnes                MATOP_MULT=3,
12731c1c02c0SLois Curfman McInnes                MATOP_MULT_ADD=4,
12747c922b88SBarry Smith                MATOP_MULT_TRANSPOSE=5,
12757c922b88SBarry Smith                MATOP_MULT_TRANSPOSE_ADD=6,
12761c1c02c0SLois Curfman McInnes                MATOP_SOLVE=7,
12771c1c02c0SLois Curfman McInnes                MATOP_SOLVE_ADD=8,
12787c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE=9,
12797c922b88SBarry Smith                MATOP_SOLVE_TRANSPOSE_ADD=10,
12801c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR=11,
12811c1c02c0SLois Curfman McInnes                MATOP_CHOLESKYFACTOR=12,
12821c1c02c0SLois Curfman McInnes                MATOP_RELAX=13,
12831c1c02c0SLois Curfman McInnes                MATOP_TRANSPOSE=14,
12841c1c02c0SLois Curfman McInnes                MATOP_GETINFO=15,
12851c1c02c0SLois Curfman McInnes                MATOP_EQUAL=16,
12861c1c02c0SLois Curfman McInnes                MATOP_GET_DIAGONAL=17,
12871c1c02c0SLois Curfman McInnes                MATOP_DIAGONAL_SCALE=18,
12881c1c02c0SLois Curfman McInnes                MATOP_NORM=19,
12891c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_BEGIN=20,
12901c1c02c0SLois Curfman McInnes                MATOP_ASSEMBLY_END=21,
12911c1c02c0SLois Curfman McInnes                MATOP_COMPRESS=22,
12921c1c02c0SLois Curfman McInnes                MATOP_SET_OPTION=23,
12931c1c02c0SLois Curfman McInnes                MATOP_ZERO_ENTRIES=24,
12941c1c02c0SLois Curfman McInnes                MATOP_ZERO_ROWS=25,
12951c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR_SYMBOLIC=26,
12961c1c02c0SLois Curfman McInnes                MATOP_LUFACTOR_NUMERIC=27,
12971c1c02c0SLois Curfman McInnes                MATOP_CHOLESKY_FACTOR_SYMBOLIC=28,
12981c1c02c0SLois Curfman McInnes                MATOP_CHOLESKY_FACTOR_NUMERIC=29,
1299d643ce63SMatthew Knepley                MATOP_SETUP_PREALLOCATION=30,
1300d643ce63SMatthew Knepley                MATOP_ILUFACTOR_SYMBOLIC=31,
1301d643ce63SMatthew Knepley                MATOP_ICCFACTOR_SYMBOLIC=32,
1302d643ce63SMatthew Knepley                MATOP_GET_ARRAY=33,
1303d643ce63SMatthew Knepley                MATOP_RESTORE_ARRAY=34,
1304d643ce63SMatthew Knepley                MATOP_DUPLCIATE=35,
1305d643ce63SMatthew Knepley                MATOP_FORWARD_SOLVE=36,
1306d643ce63SMatthew Knepley                MATOP_BACKWARD_SOLVE=37,
1307d643ce63SMatthew Knepley                MATOP_ILUFACTOR=38,
1308d643ce63SMatthew Knepley                MATOP_ICCFACTOR=39,
1309d643ce63SMatthew Knepley                MATOP_AXPY=40,
1310d643ce63SMatthew Knepley                MATOP_GET_SUBMATRICES=41,
1311d643ce63SMatthew Knepley                MATOP_INCREASE_OVERLAP=42,
1312d643ce63SMatthew Knepley                MATOP_GET_VALUES=43,
1313d643ce63SMatthew Knepley                MATOP_COPY=44,
1314d643ce63SMatthew Knepley                MATOP_PRINT_HELP=45,
1315d643ce63SMatthew Knepley                MATOP_SCALE=46,
1316d643ce63SMatthew Knepley                MATOP_SHIFT=47,
1317d643ce63SMatthew Knepley                MATOP_DIAGONAL_SHIFT=48,
1318d643ce63SMatthew Knepley                MATOP_ILUDT_FACTOR=49,
1319d643ce63SMatthew Knepley                MATOP_GET_BLOCK_SIZE=50,
1320d643ce63SMatthew Knepley                MATOP_GET_ROW_IJ=51,
1321d643ce63SMatthew Knepley                MATOP_RESTORE_ROW_IJ=52,
1322d643ce63SMatthew Knepley                MATOP_GET_COLUMN_IJ=53,
1323d643ce63SMatthew Knepley                MATOP_RESTORE_COLUMN_IJ=54,
1324d643ce63SMatthew Knepley                MATOP_FDCOLORING_CREATE=55,
1325d643ce63SMatthew Knepley                MATOP_COLORING_PATCH=56,
1326d643ce63SMatthew Knepley                MATOP_SET_UNFACTORED=57,
1327d643ce63SMatthew Knepley                MATOP_PERMUTE=58,
1328d643ce63SMatthew Knepley                MATOP_SET_VALUES_BLOCKED=59,
1329d643ce63SMatthew Knepley                MATOP_GET_SUBMATRIX=60,
1330d643ce63SMatthew Knepley                MATOP_DESTROY=61,
1331d643ce63SMatthew Knepley                MATOP_VIEW=62,
1332d643ce63SMatthew Knepley                MATOP_GET_MAPS=63,
1333d643ce63SMatthew Knepley                MATOP_USE_SCALED_FORM=64,
1334d643ce63SMatthew Knepley                MATOP_SCALE_SYSTEM=65,
1335d643ce63SMatthew Knepley                MATOP_UNSCALE_SYSTEM=66,
1336ba16a8cbSKris Buschelman                MATOP_SET_LOCAL_TO_GLOBAL_MAP=67,
1337d643ce63SMatthew Knepley                MATOP_SET_VALUES_LOCAL=68,
1338d643ce63SMatthew Knepley                MATOP_ZERO_ROWS_LOCAL=69,
1339d643ce63SMatthew Knepley                MATOP_GET_ROW_MAX=70,
1340d643ce63SMatthew Knepley                MATOP_CONVERT=71,
1341d643ce63SMatthew Knepley                MATOP_SET_COLORING=72,
1342d643ce63SMatthew Knepley                MATOP_SET_VALUES_ADIC=73,
1343d643ce63SMatthew Knepley                MATOP_SET_VALUES_ADIFOR=74,
1344d643ce63SMatthew Knepley                MATOP_FD_COLORING_APPLY=75,
1345d643ce63SMatthew Knepley                MATOP_SET_FROM_OPTIONS=76,
1346ba16a8cbSKris Buschelman                MATOP_MULT_CON=77,
1347ba16a8cbSKris Buschelman                MATOP_MULT_TRANSPOSE_CON=78,
1348ba16a8cbSKris Buschelman                MATOP_ILU_FACTOR_SYMBOLIC_CON=79,
1349d643ce63SMatthew Knepley                MATOP_PERMUTE_SPARSIFY=80,
1350d643ce63SMatthew Knepley                MATOP_MULT_MULTIPLE=81,
135141acf15aSKris Buschelman                MATOP_SOLVE_MULTIPLE=82,
135241acf15aSKris Buschelman                MATOP_GET_INERTIA=83,
135341acf15aSKris Buschelman                MATOP_LOAD=84,
135441acf15aSKris Buschelman                MATOP_IS_SYMMETRIC=85,
135541acf15aSKris Buschelman                MATOP_IS_HERMITIAN=86,
135641acf15aSKris Buschelman                MATOP_IS_STRUCTURALLY_SYMMETRIC=87,
135741acf15aSKris Buschelman                MATOP_PB_RELAX=88,
135841acf15aSKris Buschelman                MATOP_GET_VECS=89,
135941acf15aSKris Buschelman                MATOP_MAT_MULT=90,
136041acf15aSKris Buschelman                MATOP_MAT_MULT_SYMBOLIC=91,
136141acf15aSKris Buschelman                MATOP_MAT_MULT_NUMERIC=92,
136241acf15aSKris Buschelman                MATOP_PTAP=93,
136341acf15aSKris Buschelman                MATOP_PTAP_SYMBOLIC=94,
1364bc011b1eSHong Zhang                MATOP_PTAP_NUMERIC=95,
1365bc011b1eSHong Zhang                MATOP_MAT_MULTTRANSPOSE=96,
1366bc011b1eSHong Zhang                MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=97,
13677ba1a0bfSKris Buschelman                MATOP_MAT_MULTTRANSPOSE_NUMERIC=98,
13687ba1a0bfSKris Buschelman                MATOP_PTAP_SYMBOLIC_SEQAIJ=99,
13697ba1a0bfSKris Buschelman                MATOP_PTAP_NUMERIC_SEQAIJ=100,
13707ba1a0bfSKris Buschelman                MATOP_PTAP_SYMBOLIC_MPIAIJ=101,
13717ba1a0bfSKris Buschelman                MATOP_PTAP_NUMERIC_MPIAIJ=102
1372fae171e0SBarry Smith              } MatOperation;
1373be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*);
1374be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void));
1375be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void));
1376be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*);
1377112a2221SBarry Smith 
137890ace30eSBarry Smith /*
137990ace30eSBarry Smith    Codes for matrices stored on disk. By default they are
138090ace30eSBarry Smith  stored in a universal format. By changing the format with
1381fb9695e5SSatish Balay  PetscViewerSetFormat(viewer,PETSC_VIEWER_BINARY_NATIVE); the matrices will
138290ace30eSBarry Smith  be stored in a way natural for the matrix, for example dense matrices
138390ace30eSBarry Smith  would be stored as dense. Matrices stored this way may only be
138490ace30eSBarry Smith  read into matrices of the same time.
138590ace30eSBarry Smith */
138690ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1
138790ace30eSBarry Smith 
1388be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1389be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsGetColor(Mat,ISColoring *);
1390860d1616SSatish Balay 
1391be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*);
13921f4e1ec7SBarry Smith 
1393d9274352SBarry Smith /*S
1394d9274352SBarry Smith      MatNullSpace - Object that removes a null space from a vector, i.e.
1395d9274352SBarry Smith          orthogonalizes the vector to a subsapce
1396d9274352SBarry Smith 
1397f7a9e4ceSBarry Smith    Level: advanced
1398d9274352SBarry Smith 
1399d9274352SBarry Smith   Concepts: matrix; linear operator, null space
1400d9274352SBarry Smith 
14016e1639daSBarry Smith   Users manual sections:
14026e1639daSBarry Smith .   sec_singular
14036e1639daSBarry Smith 
1404d9274352SBarry Smith .seealso:  MatNullSpaceCreate()
1405d9274352SBarry Smith S*/
140674637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace;
1407d9274352SBarry Smith 
1408be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*);
1409be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace);
1410be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1411be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace);
1412be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat);
141374637425SBarry Smith 
1414be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS);
1415be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1416be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
141746129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat);
14183f1d51d7SBarry Smith 
1419be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*);
1420be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*);
1421be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*);
1422c4f061fbSSatish Balay 
1423be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*);
1424b0a32e0cSBarry Smith 
1425be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec);
142604f1ad80SBarry Smith 
1427be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1428be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
14297dbadf16SMatthew Knepley 
1430e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END
14312eac72dbSBarry Smith #endif
1432