Actual source code: petscmat.h
1: /*
2: Include file for the matrix component of PETSc
3: */
4: #ifndef __PETSCMAT_H
6: #include petscvec.h
9: /*S
10: Mat - Abstract PETSc matrix object
12: Level: beginner
14: Concepts: matrix; linear operator
16: .seealso: MatCreate(), MatType, MatSetType()
17: S*/
18: typedef struct _p_Mat* Mat;
20: /*E
21: MatType - String with the name of a PETSc matrix or the creation function
22: with an optional dynamic library name, for example
23: http://www.mcs.anl.gov/petsc/lib.a:mymatcreate()
25: Level: beginner
27: .seealso: MatSetType(), Mat, MatSolverPackage
28: E*/
29: #define MatType char*
30: #define MATSAME "same"
31: #define MATSEQMAIJ "seqmaij"
32: #define MATMPIMAIJ "mpimaij"
33: #define MATMAIJ "maij"
34: #define MATIS "is"
35: #define MATSEQAIJ "seqaij"
36: #define MATMPIAIJ "mpiaij"
37: #define MATAIJ "aij"
38: #define MATSHELL "shell"
39: #define MATSEQDENSE "seqdense"
40: #define MATMPIDENSE "mpidense"
41: #define MATDENSE "dense"
42: #define MATSEQBAIJ "seqbaij"
43: #define MATMPIBAIJ "mpibaij"
44: #define MATBAIJ "baij"
45: #define MATMPIADJ "mpiadj"
46: #define MATSEQSBAIJ "seqsbaij"
47: #define MATMPISBAIJ "mpisbaij"
48: #define MATSBAIJ "sbaij"
49: #define MATDAAD "daad"
50: #define MATMFFD "mffd"
51: #define MATNORMAL "normal"
52: #define MATLRC "lrc"
53: #define MATSEQCSRPERM "seqcsrperm"
54: #define MATMPICSRPERM "mpicsrperm"
55: #define MATCSRPERM "csrperm"
56: #define MATSEQCRL "seqcrl"
57: #define MATMPICRL "mpicrl"
58: #define MATCRL "crl"
59: #define MATSCATTER "scatter"
60: #define MATBLOCKMAT "blockmat"
61: #define MATCOMPOSITE "composite"
62: #define MATSEQFFTW "seqfftw"
63: #define MATTRANSPOSEMAT "transpose"
64: #define MATSCHURCOMPLEMENT "schurcomplement"
65: #define MATPYTHON "python"
66: #define MATHYPRESTRUCT "hyprestruct"
67: #define MATHYPRESSTRUCT "hypresstruct"
68: #define MATSUBMATRIX "submatrix"
70: #ifdef PETSC_USE_MATFWK
71: #define MATFWK "matfwk"
72: #endif
74: /*E
75: MatSolverPackage - String with the name of a PETSc matrix solver type.
77: For example: "petsc" indicates what PETSc provides, "superlu" indicates either
78: SuperLU or SuperLU_Dist etc.
81: Level: beginner
83: .seealso: MatGetFactor(), Mat, MatSetType(), MatType
84: E*/
85: #define MatSolverPackage char*
86: #define MAT_SOLVER_SPOOLES "spooles"
87: #define MAT_SOLVER_SUPERLU "superlu"
88: #define MAT_SOLVER_SUPERLU_DIST "superlu_dist"
89: #define MAT_SOLVER_UMFPACK "umfpack"
90: #define MAT_SOLVER_ESSL "essl"
91: #define MAT_SOLVER_LUSOL "lusol"
92: #define MAT_SOLVER_MUMPS "mumps"
93: #define MAT_SOLVER_PASTIX "pastix"
94: #define MAT_SOLVER_DSCPACK "dscpack"
95: #define MAT_SOLVER_MATLAB "matlab"
96: #define MAT_SOLVER_PETSC "petsc"
97: #define MAT_SOLVER_PLAPACK "plapack"
98: #define MAT_SOLVER_BAS "bas"
100: /*E
101: MatFactorType - indicates what type of factorization is requested
103: Level: beginner
105: Any additions/changes here MUST also be made in include/finclude/petscmat.h
107: .seealso: MatSolverPackage, MatGetFactor()
108: E*/
109: typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
110: EXTERN PetscErrorCode MatGetFactor(Mat,const MatSolverPackage,MatFactorType,Mat*);
111: EXTERN PetscErrorCode MatGetFactorAvailable(Mat,const MatSolverPackage,MatFactorType,PetscTruth*);
112: EXTERN PetscErrorCode MatFactorGetSolverPackage(Mat,const MatSolverPackage*);
113: EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*);
115: /* Logging support */
116: #define MAT_FILE_COOKIE 1211216 /* used to indicate matrices in binary files */
123: /*E
124: MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
125: or MatGetSubMatrix() are to be reused to store the new matrix values.
127: Level: beginner
129: Any additions/changes here MUST also be made in include/finclude/petscmat.h
131: .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
132: E*/
133: typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX} MatReuse;
135: /*E
136: MatGetSubMatrixOption - Indicates if matrices obtained from a call to MatGetSubMatrices()
137: include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().
139: Level: beginner
141: .seealso: MatGetSeqNonzerostructure()
142: E*/
143: typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatGetSubMatrixOption;
145: EXTERN PetscErrorCode MatInitializePackage(const char[]);
147: EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*);
148: PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A)
149: PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A)
150: EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
151: EXTERN PetscErrorCode MatSetType(Mat,const MatType);
152: EXTERN PetscErrorCode MatSetFromOptions(Mat);
153: EXTERN PetscErrorCode MatSetUpPreallocation(Mat);
154: EXTERN PetscErrorCode MatRegisterAll(const char[]);
155: EXTERN PetscErrorCode MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
157: EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]);
158: EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]);
159: EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]);
161: /*MC
162: MatRegisterDynamic - Adds a new matrix type
164: Synopsis:
165: PetscErrorCode MatRegisterDynamic(const char *name,const char *path,const char *name_create,PetscErrorCode (*routine_create)(Mat))
167: Not Collective
169: Input Parameters:
170: + name - name of a new user-defined matrix type
171: . path - path (either absolute or relative) the library containing this solver
172: . name_create - name of routine to create method context
173: - routine_create - routine to create method context
175: Notes:
176: MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
178: If dynamic libraries are used, then the fourth input argument (routine_create)
179: is ignored.
181: Sample usage:
182: .vb
183: MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
184: "MyMatCreate",MyMatCreate);
185: .ve
187: Then, your solver can be chosen with the procedural interface via
188: $ MatSetType(Mat,"my_mat")
189: or at runtime via the option
190: $ -mat_type my_mat
192: Level: advanced
194: Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
195: If your function is not being put into a shared library then use VecRegister() instead
197: .keywords: Mat, register
199: .seealso: MatRegisterAll(), MatRegisterDestroy()
201: M*/
202: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
203: #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
204: #else
205: #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
206: #endif
213: /*E
214: MatStructure - Indicates if the matrix has the same nonzero structure
216: Level: beginner
218: Any additions/changes here MUST also be made in include/finclude/petscmat.h
220: .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
221: E*/
222: typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure;
224: EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
225: EXTERN PetscErrorCode MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
226: EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
227: PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A)
228: PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A)
229: PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A)
230: PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A)
231: PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A))
232: PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A))
233: PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A))
234: EXTERN PetscErrorCode MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
235: 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)
236: 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)
237: 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)
238: 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)
239: 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))
240: 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))
241: 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))
242: 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)
243: 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)
244: 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)
245: 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)
246: 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))
247: 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))
248: 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))
249: EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
250: EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
252: EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
253: PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A)
254: PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
255: PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
256: PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
257: PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
258: PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
259: PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
260: EXTERN PetscErrorCode MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
261: 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)
262: 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)
263: 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)
264: 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)
265: 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))
266: 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))
267: 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))
268: 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)
269: 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)
270: 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)
271: 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)
272: 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))
273: 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))
274: 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))
275: EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
276: EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
277: PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A)
278: PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
279: PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
280: PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
281: PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
282: PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
283: PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
284: EXTERN PetscErrorCode MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
285: 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)
286: 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)
287: 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)
288: 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)
289: 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))
290: 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))
291: 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))
292: 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)
293: 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)
294: 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)
295: 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)
296: 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))
297: 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))
298: 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))
299: EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
300: PetscPolymorphicFunction(MatCreateShell,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(comm,m,n,M,N,ctx,&A),Mat,A)
301: PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A)
302: EXTERN PetscErrorCode MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
303: EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*);
304: PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A)
305: EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Mat,Mat*);
306: EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
307: EXTERN PetscErrorCode MatCreateSeqCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
308: EXTERN PetscErrorCode MatCreateMPICRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
309: EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*);
310: EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter);
311: EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*);
312: EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
313: EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat);
314: EXTERN PetscErrorCode MatCompositeMerge(Mat);
315: EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
316: typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
317: EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType);
319: #ifdef PETSC_USE_MATFWK
320: typedef enum {MATFWK_ADDITIVE, MATFWK_MULTIPLICATIVE} MatFwkType;
321: typedef enum {MATFWK_MERGED, MATFWK_SPLIT} MatFwkMode;
323: EXTERN PetscErrorCode MatCreateFwk(MPI_Comm,Mat *);
324: EXTERN PetscErrorCode MatFwkSetType(Mat,MatFwkType);
325: EXTERN PetscErrorCode MatFwkGetType(Mat,MatFwkType*);
326: EXTERN PetscErrorCode MatFwkSetMode(Mat,MatFwkMode);
327: EXTERN PetscErrorCode MatFwkGetMode(Mat,MatFwkMode*);
328: EXTERN PetscErrorCode MatFwkAddBlock(Mat, IS, IS, Mat*);
329: EXTERN PetscErrorCode MatFwkBlockSetMat(Mat, Mat);
330: EXTERN PetscErrorCode MatFwkBlockGetMat(Mat, Mat*);
331: #endif
333: EXTERN PetscErrorCode MatCreateSeqFFTW(MPI_Comm,PetscInt,const PetscInt[],Mat*);
334: EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
335: EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,Mat*);
336: EXTERN PetscErrorCode MatSubMatrixUpdate(Mat,Mat,IS,IS);
338: EXTERN PetscErrorCode MatCreatePython(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const char[],Mat*);
339: EXTERN PetscErrorCode MatPythonSetType(Mat,const char[]);
342: EXTERN PetscErrorCode MatSetUp(Mat);
343: EXTERN PetscErrorCode MatDestroy(Mat);
345: EXTERN PetscErrorCode MatConjugate(Mat);
346: EXTERN PetscErrorCode MatRealPart(Mat);
347: EXTERN PetscErrorCode MatImaginaryPart(Mat);
348: EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,PetscTruth*,MatReuse,Mat*);
349: EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*);
351: /* ------------------------------------------------------------*/
352: EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
353: EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
354: EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
355: EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
357: /*S
358: MatStencil - Data structure (C struct) for storing information about a single row or
359: column of a matrix as index on an associated grid.
361: Level: beginner
363: Concepts: matrix; linear operator
365: .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
366: S*/
367: typedef struct {
368: PetscInt k,j,i,c;
369: } MatStencil;
371: EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
372: EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
373: EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
375: EXTERN PetscErrorCode MatSetColoring(Mat,ISColoring);
376: EXTERN PetscErrorCode MatSetValuesAdic(Mat,void*);
377: EXTERN PetscErrorCode MatSetValuesAdifor(Mat,PetscInt,void*);
379: /*E
380: MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
381: to continue to add values to it
383: Level: beginner
385: .seealso: MatAssemblyBegin(), MatAssemblyEnd()
386: E*/
387: typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
388: EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType);
389: EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType);
390: EXTERN PetscErrorCode MatAssembled(Mat,PetscTruth*);
394: /*E
395: MatOption - Options that may be set for a matrix and its behavior or storage
397: Level: beginner
399: Any additions/changes here MUST also be made in include/finclude/petscmat.h
401: .seealso: MatSetOption()
402: E*/
403: typedef enum {MAT_ROW_ORIENTED,MAT_NEW_NONZERO_LOCATIONS,
404: MAT_SYMMETRIC,
405: MAT_STRUCTURALLY_SYMMETRIC,
406: MAT_NEW_DIAGONALS,MAT_IGNORE_OFF_PROC_ENTRIES,
407: MAT_NEW_NONZERO_LOCATION_ERR,
408: MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE,
409: MAT_KEEP_NONZERO_PATTERN,MAT_IGNORE_ZERO_ENTRIES,
410: MAT_USE_INODES,
411: MAT_HERMITIAN,
412: MAT_SYMMETRY_ETERNAL,
413: MAT_USE_COMPRESSEDROW,
414: MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR,
415: MAT_GETROW_UPPERTRIANGULAR,MAT_UNUSED_NONZERO_LOCATION_ERR,
416: NUM_MAT_OPTIONS} MatOption;
418: EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscTruth);
419: EXTERN PetscErrorCode MatGetType(Mat,const MatType*);
420: PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),const MatType,t)
422: EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
423: EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
424: EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
425: EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
426: EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
427: EXTERN PetscErrorCode MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
428: EXTERN PetscErrorCode MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
429: EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt);
430: EXTERN PetscErrorCode MatGetArray(Mat,PetscScalar *[]);
431: PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
432: EXTERN PetscErrorCode MatRestoreArray(Mat,PetscScalar *[]);
433: EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *);
434: PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
435: EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt);
438: EXTERN PetscErrorCode MatMult(Mat,Vec,Vec);
439: EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec);
440: EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec);
441: PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
442: EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec);
443: EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec);
444: EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*);
445: PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t)
446: PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscTruth,t)
447: EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscTruth*);
448: EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec);
449: EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
450: PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
451: EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec);
452: EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec);
453: EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat);
455: /*E
456: MatDuplicateOption - Indicates if a duplicated sparse matrix should have
457: its numerical values copied over or just its nonzero structure.
459: Level: beginner
461: Any additions/changes here MUST also be made in include/finclude/petscmat.h
463: $ MAT_SHARE_NONZERO_PATTERN - the i and j arrays in the new matrix will be shared with the original matrix
464: $ this also triggers the MAT_DO_NOT_COPY_VALUES option. This is used when you
465: $ have several matrices with the same nonzero pattern.
467: .seealso: MatDuplicate()
468: E*/
469: typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;
471: EXTERN PetscErrorCode MatConvert(Mat,const MatType,MatReuse,Mat*);
472: PetscPolymorphicFunction(MatConvert,(Mat A,const MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a)
473: EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);
474: PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a)
475: PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a)
478: EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
479: EXTERN PetscErrorCode MatView(Mat,PetscViewer);
480: EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscTruth*);
481: PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t)
482: PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscTruth,t)
483: EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscTruth*);
484: PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t)
485: EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscTruth*);
486: PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,0,&t),PetscTruth,t)
487: EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*);
488: EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*);
489: EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscTruth *,PetscInt *);
490: EXTERN PetscErrorCode MatLoad(PetscViewer,const MatType,Mat*);
491: PetscPolymorphicFunction(MatLoad,(PetscViewer v,const MatType t),(v,t,&a),Mat,a)
493: EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
494: EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
495: EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
496: EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
498: /*S
499: MatInfo - Context of matrix information, used with MatGetInfo()
501: In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
503: Level: intermediate
505: Concepts: matrix^nonzero information
507: .seealso: MatGetInfo(), MatInfoType
508: S*/
509: typedef struct {
510: PetscLogDouble block_size; /* block size */
511: PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */
512: PetscLogDouble memory; /* memory allocated */
513: PetscLogDouble assemblies; /* number of matrix assemblies called */
514: PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */
515: PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
516: PetscLogDouble factor_mallocs; /* number of mallocs during factorization */
517: } MatInfo;
519: /*E
520: MatInfoType - Indicates if you want information about the local part of the matrix,
521: the entire parallel matrix or the maximum over all the local parts.
523: Level: beginner
525: Any additions/changes here MUST also be made in include/finclude/petscmat.h
527: .seealso: MatGetInfo(), MatInfo
528: E*/
529: typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
530: EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*);
531: EXTERN PetscErrorCode MatValid(Mat,PetscTruth*);
532: EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec);
533: EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]);
534: EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]);
535: EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
536: EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]);
537: EXTERN PetscErrorCode MatGetRowSum(Mat,Vec);
538: EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*);
539: PetscPolymorphicFunction(MatTranspose,(Mat A),(A,MAT_INITIAL_MATRIX,&t),Mat,t)
540: EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*);
541: EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat *);
542: PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
543: EXTERN PetscErrorCode MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
544: EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec);
545: EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode);
546: EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscTruth*);
547: PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t)
548: EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscTruth*);
549: EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*);
550: EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*);
551: EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*);
553: EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal *);
554: PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
555: EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal *);
556: EXTERN PetscErrorCode MatZeroEntries(Mat);
557: EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar);
558: EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar);
559: EXTERN PetscErrorCode MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*);
560: EXTERN PetscErrorCode MatZeroColumnsIS(Mat,IS,const PetscScalar*);
562: EXTERN PetscErrorCode MatUseScaledForm(Mat,PetscTruth);
563: EXTERN PetscErrorCode MatScaleSystem(Mat,Vec,Vec);
564: EXTERN PetscErrorCode MatUnScaleSystem(Mat,Vec,Vec);
566: EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
567: EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
568: EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
569: EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
570: EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
571: EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
573: EXTERN PetscErrorCode MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
574: EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
575: EXTERN PetscErrorCode MatGetSubMatrix(Mat,IS,IS,MatReuse,Mat *);
576: EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*);
577: EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*);
579: EXTERN PetscErrorCode MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
580: EXTERN PetscErrorCode MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
581: EXTERN PetscErrorCode MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
582: EXTERN PetscErrorCode MatMerge_SeqsToMPINumeric(Mat,Mat);
583: EXTERN PetscErrorCode MatDestroy_MPIAIJ_SeqsToMPI(Mat);
584: EXTERN PetscErrorCode MatGetLocalMat(Mat,MatReuse,Mat*);
585: EXTERN PetscErrorCode MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
586: EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
587: EXTERN PetscErrorCode MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscInt**,MatScalar**,Mat*);
588: #if defined (PETSC_USE_CTABLE)
589: #include petscctable.h
590: EXTERN PetscErrorCode MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
591: #else
592: EXTERN PetscErrorCode MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
593: #endif
594: EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);
596: EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
598: EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
599: EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
600: EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat);
602: EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
603: EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
604: EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat);
606: EXTERN PetscErrorCode MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
607: EXTERN PetscErrorCode MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
608: EXTERN PetscErrorCode MatMatMultTransposeNumeric(Mat,Mat,Mat);
610: EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
611: EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);
613: EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
614: EXTERN PetscErrorCode MatShift(Mat,PetscScalar);
616: EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
617: EXTERN PetscErrorCode MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
618: EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar);
619: EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar);
620: EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
621: EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
623: EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt);
624: EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
626: EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec);
627: EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec);
628: PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
629: EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec);
630: EXTERN PetscErrorCode MatGetVecs(Mat,Vec*,Vec*);
631: EXTERN PetscErrorCode MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);
633: /*MC
634: MatSetValue - Set a single entry into a matrix.
636: Not collective
638: Input Parameters:
639: + m - the matrix
640: . row - the row location of the entry
641: . col - the column location of the entry
642: . value - the value to insert
643: - mode - either INSERT_VALUES or ADD_VALUES
645: Notes:
646: For efficiency one should use MatSetValues() and set several or many
647: values simultaneously if possible.
649: Level: beginner
651: .seealso: MatSetValues(), MatSetValueLocal()
652: M*/
653: PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);}
655: PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
657: PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);}
659: /*MC
660: MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
661: row in a matrix providing the data that one can use to correctly preallocate the matrix.
663: Synopsis:
664: PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
666: Collective on MPI_Comm
668: Input Parameters:
669: + comm - the communicator that will share the eventually allocated matrix
670: . nrows - the number of LOCAL rows in the matrix
671: - ncols - the number of LOCAL columns in the matrix
673: Output Parameters:
674: + dnz - the array that will be passed to the matrix preallocation routines
675: - ozn - the other array passed to the matrix preallocation routines
678: Level: intermediate
680: Notes:
681: See the chapter in the users manual on performance for more details
683: Do not malloc or free dnz and onz, that is handled internally by these routines
685: Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
687: This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
689: Concepts: preallocation^Matrix
691: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
692: MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
693: M*/
694: #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
695: { \
696: PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
697: _4_PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
698: _4_PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
699: _4_PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
700: _4_MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
701: _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
703: /*MC
704: MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
705: row in a matrix providing the data that one can use to correctly preallocate the matrix.
707: Synopsis:
708: PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
710: Collective on MPI_Comm
712: Input Parameters:
713: + comm - the communicator that will share the eventually allocated matrix
714: . nrows - the number of LOCAL rows in the matrix
715: - ncols - the number of LOCAL columns in the matrix
717: Output Parameters:
718: + dnz - the array that will be passed to the matrix preallocation routines
719: - ozn - the other array passed to the matrix preallocation routines
722: Level: intermediate
724: Notes:
725: See the chapter in the users manual on performance for more details
727: Do not malloc or free dnz and onz, that is handled internally by these routines
729: This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
731: Concepts: preallocation^Matrix
733: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
734: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
735: M*/
736: #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
737: { \
738: PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__end; \
739: _4_PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
740: _4_PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
741: _4_PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
742: _4_MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
743: _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
745: /*MC
746: MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
747: inserted using a local number of the rows and columns
749: Synopsis:
750: PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
752: Not Collective
754: Input Parameters:
755: + map - the mapping between local numbering and global numbering
756: . nrows - the number of rows indicated
757: . rows - the indices of the rows
758: . ncols - the number of columns in the matrix
759: . cols - the columns indicated
760: . dnz - the array that will be passed to the matrix preallocation routines
761: - ozn - the other array passed to the matrix preallocation routines
764: Level: intermediate
766: Notes:
767: See the chapter in the users manual on performance for more details
769: Do not malloc or free dnz and onz, that is handled internally by these routines
771: Concepts: preallocation^Matrix
773: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
774: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
775: M*/
776: #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
777: {\
778: PetscInt __l;\
779: _4_ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
780: _4_ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
781: for (__l=0;__l<nrows;__l++) {\
782: _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
783: }\
784: }
785:
786: /*MC
787: MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
788: inserted using a local number of the rows and columns
790: Synopsis:
791: PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
793: Not Collective
795: Input Parameters:
796: + map - the mapping between local numbering and global numbering
797: . nrows - the number of rows indicated
798: . rows - the indices of the rows
799: . ncols - the number of columns in the matrix
800: . cols - the columns indicated
801: . dnz - the array that will be passed to the matrix preallocation routines
802: - ozn - the other array passed to the matrix preallocation routines
805: Level: intermediate
807: Notes:
808: See the chapter in the users manual on performance for more details
810: Do not malloc or free dnz and onz that is handled internally by these routines
812: Concepts: preallocation^Matrix
814: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
815: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
816: M*/
817: #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
818: {\
819: PetscInt __l;\
820: _4_ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
821: _4_ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
822: for (__l=0;__l<nrows;__l++) {\
823: _4_MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
824: }\
825: }
827: /*MC
828: MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
829: inserted using a local number of the rows and columns
831: Synopsis:
832: PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
834: Not Collective
836: Input Parameters:
837: + row - the row
838: . ncols - the number of columns in the matrix
839: - cols - the columns indicated
841: Output Parameters:
842: + dnz - the array that will be passed to the matrix preallocation routines
843: - ozn - the other array passed to the matrix preallocation routines
846: Level: intermediate
848: Notes:
849: See the chapter in the users manual on performance for more details
851: Do not malloc or free dnz and onz that is handled internally by these routines
853: This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
855: Concepts: preallocation^Matrix
857: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
858: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
859: M*/
860: #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
861: { PetscInt __i; \
862: if (row < __rstart) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\
863: if (row >= __rstart+__nrows) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D greater than last local row %D",row,__rstart+__nrows-1);\
864: for (__i=0; __i<nc; __i++) {\
865: if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
866: else dnz[row - __rstart]++;\
867: }\
868: }
870: /*MC
871: MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
872: inserted using a local number of the rows and columns
874: Synopsis:
875: PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
877: Not Collective
879: Input Parameters:
880: + nrows - the number of rows indicated
881: . rows - the indices of the rows
882: . ncols - the number of columns in the matrix
883: . cols - the columns indicated
884: . dnz - the array that will be passed to the matrix preallocation routines
885: - ozn - the other array passed to the matrix preallocation routines
888: Level: intermediate
890: Notes:
891: See the chapter in the users manual on performance for more details
893: Do not malloc or free dnz and onz that is handled internally by these routines
895: This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
897: Concepts: preallocation^Matrix
899: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
900: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
901: M*/
902: #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
903: { PetscInt __i; \
904: for (__i=0; __i<nc; __i++) {\
905: if (cols[__i] >= __end) onz[row - __rstart]++; \
906: else if (cols[__i] >= row) dnz[row - __rstart]++;\
907: }\
908: }
910: /*MC
911: MatPreallocateLocation - An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists
913: Synopsis:
914: PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
916: Not Collective
918: Input Parameters:
919: . A - matrix
920: . row - row where values exist (must be local to this process)
921: . ncols - number of columns
922: . cols - columns with nonzeros
923: . dnz - the array that will be passed to the matrix preallocation routines
924: - ozn - the other array passed to the matrix preallocation routines
927: Level: intermediate
929: Notes:
930: See the chapter in the users manual on performance for more details
932: Do not malloc or free dnz and onz that is handled internally by these routines
934: This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
936: Concepts: preallocation^Matrix
938: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
939: MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
940: M*/
941: #define MatPreallocateLocation(A,row,ncols,cols,dnz,onz) 0;if (A) {MatSetValues(A,1,&row,ncols,cols,PETSC_NULL,INSERT_VALUES);} else { MatPreallocateSet(row,ncols,cols,dnz,onz);}
944: /*MC
945: MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
946: row in a matrix providing the data that one can use to correctly preallocate the matrix.
948: Synopsis:
949: PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
951: Collective on MPI_Comm
953: Input Parameters:
954: + dnz - the array that was be passed to the matrix preallocation routines
955: - ozn - the other array passed to the matrix preallocation routines
958: Level: intermediate
960: Notes:
961: See the chapter in the users manual on performance for more details
963: Do not malloc or free dnz and onz that is handled internally by these routines
965: This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
967: Concepts: preallocation^Matrix
969: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
970: MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
971: M*/
972: #define MatPreallocateFinalize(dnz,onz) 0;_4_PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}
976: /* Routines unique to particular data structures */
977: EXTERN PetscErrorCode MatShellGetContext(Mat,void **);
978: PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
980: EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
981: EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
983: EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
984: EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
985: EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
986: EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
987: EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
989: #define MAT_SKIP_ALLOCATION -4
991: EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
992: PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
993: EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
994: PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
995: EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
996: PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
998: EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
999: PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
1000: EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1001: EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1002: EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1003: EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1004: EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1005: EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1006: EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1007: EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1008: EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
1009: EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
1010: EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
1011: EXTERN PetscErrorCode MatAdicSetLocalFunction(Mat,void (*)(void));
1013: EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt);
1014: EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);
1016: EXTERN PetscErrorCode MatStoreValues(Mat);
1017: EXTERN PetscErrorCode MatRetrieveValues(Mat);
1019: EXTERN PetscErrorCode MatDAADSetCtx(Mat,void*);
1021: /*
1022: These routines are not usually accessed directly, rather solving is
1023: done through the KSP and PC interfaces.
1024: */
1026: /*E
1027: MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
1028: with an optional dynamic library name, for example
1029: http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
1031: Level: beginner
1033: Cannot use const because the PC objects manipulate the string
1035: .seealso: MatGetOrdering()
1036: E*/
1037: #define MatOrderingType char*
1038: #define MATORDERING_NATURAL "natural"
1039: #define MATORDERING_ND "nd"
1040: #define MATORDERING_1WD "1wd"
1041: #define MATORDERING_RCM "rcm"
1042: #define MATORDERING_QMD "qmd"
1043: #define MATORDERING_ROWLENGTH "rowlength"
1044: #define MATORDERING_DSC_ND "dsc_nd" /* these three are only for DSCPACK, see its documentation for details */
1045: #define MATORDERING_DSC_MMD "dsc_mmd"
1046: #define MATORDERING_DSC_MDF "dsc_mdf"
1047: #define MATORDERING_CONSTRAINED "constrained"
1048: #define MATORDERING_IDENTITY "identity"
1049: #define MATORDERING_REVERSE "reverse"
1050: #define MATORDERING_FLOW "flow"
1051: #define MATORDERING_AMD "amd"
1053: EXTERN PetscErrorCode MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
1054: EXTERN PetscErrorCode MatGetOrderingList(PetscFList *list);
1055: EXTERN PetscErrorCode MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
1057: /*MC
1058: MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the matrix package.
1060: Synopsis:
1061: PetscErrorCode MatOrderingRegisterDynamic(const char *name_ordering,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
1063: Not Collective
1065: Input Parameters:
1066: + sname - name of ordering (for example MATORDERING_ND)
1067: . path - location of library where creation routine is
1068: . name - name of function that creates the ordering type,a string
1069: - function - function pointer that creates the ordering
1071: Level: developer
1073: If dynamic libraries are used, then the fourth input argument (function)
1074: is ignored.
1076: Sample usage:
1077: .vb
1078: MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
1079: "MyOrder",MyOrder);
1080: .ve
1082: Then, your partitioner can be chosen with the procedural interface via
1083: $ MatOrderingSetType(part,"my_order)
1084: or at runtime via the option
1085: $ -pc_factor_mat_ordering_type my_order
1087: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
1089: .keywords: matrix, ordering, register
1091: .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
1092: M*/
1093: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1094: #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
1095: #else
1096: #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
1097: #endif
1099: EXTERN PetscErrorCode MatOrderingRegisterDestroy(void);
1100: EXTERN PetscErrorCode MatOrderingRegisterAll(const char[]);
1104: EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1106: /*S
1107: MatFactorShiftType - Numeric Shift.
1109: Level: beginner
1111: S*/
1112: typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1115: /*S
1116: MatFactorInfo - Data passed into the matrix factorization routines
1118: In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
1119: $ MatFactorInfo info(MAT_FACTORINFO_SIZE)
1121: Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1123: You can use MatFactorInfoInitialize() to set default values.
1125: Level: developer
1127: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1128: MatFactorInfoInitialize()
1130: S*/
1131: typedef struct {
1132: PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */
1133: PetscReal usedt;
1134: PetscReal dt; /* drop tolerance */
1135: PetscReal dtcol; /* tolerance for pivoting */
1136: PetscReal dtcount; /* maximum nonzeros to be allowed per row */
1137: PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1138: PetscReal levels; /* ICC/ILU(levels) */
1139: PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1140: factorization may be faster if do not pivot */
1141: PetscReal zeropivot; /* pivot is called zero if less than this */
1142: PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */
1143: PetscReal shiftamount; /* how large the shift is */
1144: } MatFactorInfo;
1146: EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
1147: EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
1148: EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1149: EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
1150: EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
1151: EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
1152: EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1153: EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1154: EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1155: EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
1156: EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1157: EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1158: EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
1159: EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
1160: EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
1161: EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
1162: EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
1163: EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1164: EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);
1166: EXTERN PetscErrorCode MatSetUnfactored(Mat);
1168: /*E
1169: MatSORType - What type of (S)SOR to perform
1171: Level: beginner
1173: May be bitwise ORd together
1175: Any additions/changes here MUST also be made in include/finclude/petscmat.h
1177: MatSORType may be bitwise ORd together, so do not change the numbers
1179: .seealso: MatSOR()
1180: E*/
1181: typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1182: SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1183: SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1184: SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1185: EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1187: /*
1188: These routines are for efficiently computing Jacobians via finite differences.
1189: */
1191: /*E
1192: MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1193: with an optional dynamic library name, for example
1194: http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1196: Level: beginner
1198: .seealso: MatGetColoring()
1199: E*/
1200: #define MatColoringType char*
1201: #define MATCOLORING_NATURAL "natural"
1202: #define MATCOLORING_SL "sl"
1203: #define MATCOLORING_LF "lf"
1204: #define MATCOLORING_ID "id"
1206: EXTERN PetscErrorCode MatGetColoring(Mat,const MatColoringType,ISColoring*);
1207: EXTERN PetscErrorCode MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *));
1209: /*MC
1210: MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
1211: matrix package.
1213: Synopsis:
1214: PetscErrorCode MatColoringRegisterDynamic(const char *name_coloring,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatColoring))
1216: Not Collective
1218: Input Parameters:
1219: + sname - name of Coloring (for example MATCOLORING_SL)
1220: . path - location of library where creation routine is
1221: . name - name of function that creates the Coloring type, a string
1222: - function - function pointer that creates the coloring
1224: Level: developer
1226: If dynamic libraries are used, then the fourth input argument (function)
1227: is ignored.
1229: Sample usage:
1230: .vb
1231: MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
1232: "MyColor",MyColor);
1233: .ve
1235: Then, your partitioner can be chosen with the procedural interface via
1236: $ MatColoringSetType(part,"my_color")
1237: or at runtime via the option
1238: $ -mat_coloring_type my_color
1240: $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
1242: .keywords: matrix, Coloring, register
1244: .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
1245: M*/
1246: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1247: #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1248: #else
1249: #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1250: #endif
1254: EXTERN PetscErrorCode MatColoringRegisterAll(const char[]);
1255: EXTERN PetscErrorCode MatColoringRegisterDestroy(void);
1256: EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1258: /*S
1259: MatFDColoring - Object for computing a sparse Jacobian via finite differences
1260: and coloring
1262: Level: beginner
1264: Concepts: coloring, sparse Jacobian, finite differences
1266: .seealso: MatFDColoringCreate()
1267: S*/
1268: typedef struct _p_MatFDColoring* MatFDColoring;
1270: EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1271: EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring);
1272: EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
1273: EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1274: EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1275: EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1276: EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1277: EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1278: EXTERN PetscErrorCode MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1279: EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
1280: EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1281: /*
1282: These routines are for partitioning matrices: currently used only
1283: for adjacency matrix, MatCreateMPIAdj().
1284: */
1286: /*S
1287: MatPartitioning - Object for managing the partitioning of a matrix or graph
1289: Level: beginner
1291: Concepts: partitioning
1293: .seealso: MatPartitioningCreate(), MatPartitioningType
1294: S*/
1295: typedef struct _p_MatPartitioning* MatPartitioning;
1297: /*E
1298: MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1299: with an optional dynamic library name, for example
1300: http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1302: Level: beginner
1304: .seealso: MatPartitioningCreate(), MatPartitioning
1305: E*/
1306: #define MatPartitioningType char*
1307: #define MAT_PARTITIONING_CURRENT "current"
1308: #define MAT_PARTITIONING_SQUARE "square"
1309: #define MAT_PARTITIONING_PARMETIS "parmetis"
1310: #define MAT_PARTITIONING_CHACO "chaco"
1311: #define MAT_PARTITIONING_JOSTLE "jostle"
1312: #define MAT_PARTITIONING_PARTY "party"
1313: #define MAT_PARTITIONING_SCOTCH "scotch"
1316: EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1317: EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1318: EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
1319: EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
1320: EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1321: EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1322: EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
1323: EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning);
1325: EXTERN PetscErrorCode MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
1327: /*MC
1328: MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
1329: matrix package.
1331: Synopsis:
1332: PetscErrorCode MatPartitioningRegisterDynamic(const char *name_partitioning,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
1334: Not Collective
1336: Input Parameters:
1337: + sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis
1338: . path - location of library where creation routine is
1339: . name - name of function that creates the partitioning type, a string
1340: - function - function pointer that creates the partitioning type
1342: Level: developer
1344: If dynamic libraries are used, then the fourth input argument (function)
1345: is ignored.
1347: Sample usage:
1348: .vb
1349: MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
1350: "MyPartCreate",MyPartCreate);
1351: .ve
1353: Then, your partitioner can be chosen with the procedural interface via
1354: $ MatPartitioningSetType(part,"my_part")
1355: or at runtime via the option
1356: $ -mat_partitioning_type my_part
1358: $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
1360: .keywords: matrix, partitioning, register
1362: .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
1363: M*/
1364: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1365: #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
1366: #else
1367: #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
1368: #endif
1372: EXTERN PetscErrorCode MatPartitioningRegisterAll(const char[]);
1373: EXTERN PetscErrorCode MatPartitioningRegisterDestroy(void);
1375: EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1376: EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1377: EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,const MatPartitioningType*);
1379: EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1380: EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
1382: EXTERN PetscErrorCode MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1383: EXTERN PetscErrorCode MatPartitioningJostleSetCoarseSequential(MatPartitioning);
1385: typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType;
1386: EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
1387: typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1388: EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1389: EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1390: typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1391: EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1392: EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1393: EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
1395: #define MP_PARTY_OPT "opt"
1396: #define MP_PARTY_LIN "lin"
1397: #define MP_PARTY_SCA "sca"
1398: #define MP_PARTY_RAN "ran"
1399: #define MP_PARTY_GBF "gbf"
1400: #define MP_PARTY_GCF "gcf"
1401: #define MP_PARTY_BUB "bub"
1402: #define MP_PARTY_DEF "def"
1403: EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning, const char*);
1404: #define MP_PARTY_HELPFUL_SETS "hs"
1405: #define MP_PARTY_KERNIGHAN_LIN "kl"
1406: #define MP_PARTY_NONE "no"
1407: EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning, const char*);
1408: EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1409: EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscTruth);
1410: EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth);
1412: typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1413: EXTERN PetscErrorCode MatPartitioningScotchSetArch(MatPartitioning,const char*);
1414: EXTERN PetscErrorCode MatPartitioningScotchSetMultilevel(MatPartitioning);
1415: EXTERN PetscErrorCode MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1416: EXTERN PetscErrorCode MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1417: EXTERN PetscErrorCode MatPartitioningScotchSetHostList(MatPartitioning,const char*);
1418: typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1419: EXTERN PetscErrorCode MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1420: EXTERN PetscErrorCode MatPartitioningScotchSetMapping(MatPartitioning);
1421: EXTERN PetscErrorCode MatPartitioningScotchSetStrategy(MatPartitioning,char*);
1423: EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1424: EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);
1426: /*
1427: If you add entries here you must also add them to finclude/petscmat.h
1428: */
1429: typedef enum { MATOP_SET_VALUES=0,
1430: MATOP_GET_ROW=1,
1431: MATOP_RESTORE_ROW=2,
1432: MATOP_MULT=3,
1433: MATOP_MULT_ADD=4,
1434: MATOP_MULT_TRANSPOSE=5,
1435: MATOP_MULT_TRANSPOSE_ADD=6,
1436: MATOP_SOLVE=7,
1437: MATOP_SOLVE_ADD=8,
1438: MATOP_SOLVE_TRANSPOSE=9,
1439: MATOP_SOLVE_TRANSPOSE_ADD=10,
1440: MATOP_LUFACTOR=11,
1441: MATOP_CHOLESKYFACTOR=12,
1442: MATOP_SOR=13,
1443: MATOP_TRANSPOSE=14,
1444: MATOP_GETINFO=15,
1445: MATOP_EQUAL=16,
1446: MATOP_GET_DIAGONAL=17,
1447: MATOP_DIAGONAL_SCALE=18,
1448: MATOP_NORM=19,
1449: MATOP_ASSEMBLY_BEGIN=20,
1450: MATOP_ASSEMBLY_END=21,
1451: MATOP_SET_OPTION=22,
1452: MATOP_ZERO_ENTRIES=23,
1453: MATOP_ZERO_ROWS=24,
1454: MATOP_LUFACTOR_SYMBOLIC=25,
1455: MATOP_LUFACTOR_NUMERIC=26,
1456: MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1457: MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1458: MATOP_SETUP_PREALLOCATION=29,
1459: MATOP_ILUFACTOR_SYMBOLIC=30,
1460: MATOP_ICCFACTOR_SYMBOLIC=31,
1461: MATOP_GET_ARRAY=32,
1462: MATOP_RESTORE_ARRAY=33,
1463: MATOP_DUPLICATE=34,
1464: MATOP_FORWARD_SOLVE=35,
1465: MATOP_BACKWARD_SOLVE=36,
1466: MATOP_ILUFACTOR=37,
1467: MATOP_ICCFACTOR=38,
1468: MATOP_AXPY=39,
1469: MATOP_GET_SUBMATRICES=40,
1470: MATOP_INCREASE_OVERLAP=41,
1471: MATOP_GET_VALUES=42,
1472: MATOP_COPY=43,
1473: MATOP_GET_ROW_MAX=44,
1474: MATOP_SCALE=45,
1475: MATOP_SHIFT=46,
1476: MATOP_DIAGONAL_SET=47,
1477: MATOP_ILUDT_FACTOR=48,
1478: MATOP_SET_BLOCK_SIZE=49,
1479: MATOP_GET_ROW_IJ=50,
1480: MATOP_RESTORE_ROW_IJ=51,
1481: MATOP_GET_COLUMN_IJ=52,
1482: MATOP_RESTORE_COLUMN_IJ=53,
1483: MATOP_FDCOLORING_CREATE=54,
1484: MATOP_COLORING_PATCH=55,
1485: MATOP_SET_UNFACTORED=56,
1486: MATOP_PERMUTE=57,
1487: MATOP_SET_VALUES_BLOCKED=58,
1488: MATOP_GET_SUBMATRIX=59,
1489: MATOP_DESTROY=60,
1490: MATOP_VIEW=61,
1491: MATOP_CONVERT_FROM=62,
1492: MATOP_USE_SCALED_FORM=63,
1493: MATOP_SCALE_SYSTEM=64,
1494: MATOP_UNSCALE_SYSTEM=65,
1495: MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1496: MATOP_SET_VALUES_LOCAL=67,
1497: MATOP_ZERO_ROWS_LOCAL=68,
1498: MATOP_GET_ROW_MAX_ABS=69,
1499: MATOP_GET_ROW_MIN_ABS=70,
1500: MATOP_CONVERT=71,
1501: MATOP_SET_COLORING=72,
1502: MATOP_SET_VALUES_ADIC=73,
1503: MATOP_SET_VALUES_ADIFOR=74,
1504: MATOP_FD_COLORING_APPLY=75,
1505: MATOP_SET_FROM_OPTIONS=76,
1506: MATOP_MULT_CON=77,
1507: MATOP_MULT_TRANSPOSE_CON=78,
1508: MATOP_PERMUTE_SPARSIFY=79,
1509: MATOP_MULT_MULTIPLE=80,
1510: MATOP_SOLVE_MULTIPLE=81,
1511: MATOP_GET_INERTIA=82,
1512: MATOP_LOAD=83,
1513: MATOP_IS_SYMMETRIC=84,
1514: MATOP_IS_HERMITIAN=85,
1515: MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
1516: MATOP_DUMMY=87,
1517: MATOP_GET_VECS=88,
1518: MATOP_MAT_MULT=89,
1519: MATOP_MAT_MULT_SYMBOLIC=90,
1520: MATOP_MAT_MULT_NUMERIC=91,
1521: MATOP_PTAP=92,
1522: MATOP_PTAP_SYMBOLIC=93,
1523: MATOP_PTAP_NUMERIC=94,
1524: MATOP_MAT_MULTTRANSPOSE=95,
1525: MATOP_MAT_MULTTRANSPOSE_SYM=96,
1526: MATOP_MAT_MULTTRANSPOSE_NUM=97,
1527: MATOP_PTAP_SYMBOLIC_SEQAIJ=98,
1528: MATOP_PTAP_NUMERIC_SEQAIJ=99,
1529: MATOP_PTAP_SYMBOLIC_MPIAIJ=100,
1530: MATOP_PTAP_NUMERIC_MPIAIJ=101,
1531: MATOP_CONJUGATE=102,
1532: MATOP_SET_SIZES=103,
1533: MATOP_SET_VALUES_ROW=104,
1534: MATOP_REAL_PART=105,
1535: MATOP_IMAG_PART=106,
1536: MATOP_GET_ROW_UTRIANGULAR=107,
1537: MATOP_RESTORE_ROW_UTRIANGULAR=108,
1538: MATOP_MATSOLVE=109,
1539: MATOP_GET_REDUNDANTMATRIX=110,
1540: MATOP_GET_ROW_MIN=111,
1541: MATOP_GET_COLUMN_VEC=112,
1542: MATOP_MISSING_DIAGONAL=113,
1543: MATOP_MATGETSEQNONZEROSTRUCTURE=114,
1544: MATOP_CREATE=115,
1545: MATOP_GET_GHOSTS=116,
1546: MATOP_MULT_DIAGONAL_BLOCK=119,
1547: MATOP_HERMITIANTRANSPOSE=120,
1548: MATOP_MULTHERMITIANTRANSPOSE=121,
1549: MATOP_MULTHERMITIANTRANSPOSEADD=122
1550: } MatOperation;
1551: EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscTruth*);
1552: EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void));
1553: EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void));
1554: EXTERN PetscErrorCode MatShellSetContext(Mat,void*);
1556: /*
1557: Codes for matrices stored on disk. By default they are
1558: stored in a universal format. By changing the format with
1559: PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1560: be stored in a way natural for the matrix, for example dense matrices
1561: would be stored as dense. Matrices stored this way may only be
1562: read into matrices of the same time.
1563: */
1564: #define MATRIX_BINARY_FORMAT_DENSE -1
1566: EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1567: EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
1569: /*S
1570: MatNullSpace - Object that removes a null space from a vector, i.e.
1571: orthogonalizes the vector to a subsapce
1573: Level: advanced
1575: Concepts: matrix; linear operator, null space
1577: Users manual sections:
1578: . Section 4.15 Solving Singular Systems
1580: .seealso: MatNullSpaceCreate()
1581: S*/
1582: typedef struct _p_MatNullSpace* MatNullSpace;
1584: EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*);
1585: EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1586: EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace);
1587: EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1588: EXTERN PetscErrorCode MatNullSpaceAttach(Mat,MatNullSpace);
1589: EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscTruth *);
1591: EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1592: EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1593: EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1594: EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);
1596: EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1597: EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1598: EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);
1600: EXTERN PetscErrorCode MatComputeExplicitOperator(Mat,Mat*);
1602: EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);
1604: EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1605: EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
1606: EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1607: EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1608: EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1609: EXTERN PetscErrorCode MatMFFDAddNullSpace(Mat,MatNullSpace);
1610: EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1611: EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
1612: EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
1613: EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
1614: EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
1615: EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]);
1616: EXTERN PetscErrorCode MatMFFDSetFromOptions(Mat);
1617: EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1618: EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1620: /*S
1621: MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
1622: Jacobian vector products
1624: Notes: MATMFFD is a specific MatType which uses the MatMFFD data structure
1626: MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure
1628: Level: developer
1630: .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
1631: S*/
1632: typedef struct _p_MatMFFD* MatMFFD;
1634: /*E
1635: MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1637: Level: beginner
1639: .seealso: MatMFFDSetType(), MatMFFDRegister()
1640: E*/
1641: #define MatMFFDType char*
1642: #define MATMFFD_DS "ds"
1643: #define MATMFFD_WP "wp"
1645: EXTERN PetscErrorCode MatMFFDSetType(Mat,const MatMFFDType);
1646: EXTERN PetscErrorCode MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD));
1648: /*MC
1649: MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry.
1651: Synopsis:
1652: PetscErrorCode MatMFFDRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatMFFD))
1654: Not Collective
1656: Input Parameters:
1657: + name_solver - name of a new user-defined compute-h module
1658: . path - path (either absolute or relative) the library containing this solver
1659: . name_create - name of routine to create method context
1660: - routine_create - routine to create method context
1662: Level: developer
1664: Notes:
1665: MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers.
1667: If dynamic libraries are used, then the fourth input argument (routine_create)
1668: is ignored.
1670: Sample usage:
1671: .vb
1672: MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a,
1673: "MyHCreate",MyHCreate);
1674: .ve
1676: Then, your solver can be chosen with the procedural interface via
1677: $ MatMFFDSetType(mfctx,"my_h")
1678: or at runtime via the option
1679: $ -snes_mf_type my_h
1681: .keywords: MatMFFD, register
1683: .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy()
1684: M*/
1685: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1686: #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0)
1687: #else
1688: #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d)
1689: #endif
1691: EXTERN PetscErrorCode MatMFFDRegisterAll(const char[]);
1692: EXTERN PetscErrorCode MatMFFDRegisterDestroy(void);
1693: EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1694: EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscTruth);
1697: EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1698: EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
1700: /*
1701: PETSc interface to MUMPS
1702: */
1703: #ifdef PETSC_HAVE_MUMPS
1704: EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1705: #endif
1708: #endif