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 MATMPIROWBS "mpirowbs"
36: #define MATSEQAIJ "seqaij"
37: #define MATMPIAIJ "mpiaij"
38: #define MATAIJ "aij"
39: #define MATSHELL "shell"
40: #define MATSEQDENSE "seqdense"
41: #define MATMPIDENSE "mpidense"
42: #define MATDENSE "dense"
43: #define MATSEQBAIJ "seqbaij"
44: #define MATMPIBAIJ "mpibaij"
45: #define MATBAIJ "baij"
46: #define MATMPIADJ "mpiadj"
47: #define MATSEQSBAIJ "seqsbaij"
48: #define MATMPISBAIJ "mpisbaij"
49: #define MATSBAIJ "sbaij"
50: #define MATDAAD "daad"
51: #define MATMFFD "mffd"
52: #define MATNORMAL "normal"
53: #define MATLRC "lrc"
54: #define MATSEQCSRPERM "seqcsrperm"
55: #define MATMPICSRPERM "mpicsrperm"
56: #define MATCSRPERM "csrperm"
57: #define MATSEQCRL "seqcrl"
58: #define MATMPICRL "mpicrl"
59: #define MATCRL "crl"
60: #define MATSCATTER "scatter"
61: #define MATBLOCKMAT "blockmat"
62: #define MATCOMPOSITE "composite"
63: #define MATSEQFFTW "seqfftw"
64: #define MATTRANSPOSEMAT "transpose"
65: #define MATSCHURCOMPLEMENT "schurcomplement"
66: #define MATPYTHON "python"
68: /*E
69: MatSolverPackage - String with the name of a PETSc matrix solver type.
71: For example: "petsc" indicates what PETSc provides, "superlu" indicates either
72: SuperLU or SuperLU_Dist etc.
75: Level: beginner
77: .seealso: MatGetFactor(), Mat, MatSetType(), MatType
78: E*/
79: #define MatSolverPackage char*
80: #define MAT_SOLVER_SPOOLES "spooles"
81: #define MAT_SOLVER_SUPERLU "superlu"
82: #define MAT_SOLVER_SUPERLU_DIST "superlu_dist"
83: #define MAT_SOLVER_UMFPACK "umfpack"
84: #define MAT_SOLVER_ESSL "essl"
85: #define MAT_SOLVER_LUSOL "lusol"
86: #define MAT_SOLVER_MUMPS "mumps"
87: #define MAT_SOLVER_PASTIX "pastix"
88: #define MAT_SOLVER_DSCPACK "dscpack"
89: #define MAT_SOLVER_MATLAB "matlab"
90: #define MAT_SOLVER_PETSC "petsc"
91: #define MAT_SOLVER_PLAPACK "plapack"
93: /*E
94: MatFactorType - indicates what type of factorization is requested
96: Level: beginner
98: Any additions/changes here MUST also be made in include/finclude/petscmat.h
100: .seealso: MatSolverPackage, MatGetFactor()
101: E*/
102: typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC} MatFactorType;
103: EXTERN PetscErrorCode MatGetFactor(Mat,const MatSolverPackage,MatFactorType,Mat*);
104: EXTERN PetscErrorCode MatGetFactorAvailable(Mat,const MatSolverPackage,MatFactorType,PetscTruth*);
105: EXTERN PetscErrorCode MatFactorGetSolverPackage(Mat,const MatSolverPackage*);
108: /* Logging support */
109: #define MAT_FILE_COOKIE 1211216 /* used to indicate matrices in binary files */
116: /*E
117: MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
118: or MatGetSubMatrix() are to be reused to store the new matrix values.
120: Level: beginner
122: Any additions/changes here MUST also be made in include/finclude/petscmat.h
124: .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
125: E*/
126: typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX} MatReuse;
128: /*E
129: MatGetSubMatrixOption - Indicates if matrices obtained from a call to MatGetSubMatrices()
130: include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().
132: Level: beginner
134: .seealso: MatGetSeqNonzerostructure()
135: E*/
136: typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatGetSubMatrixOption;
138: EXTERN PetscErrorCode MatInitializePackage(const char[]);
140: EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*);
141: PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A)
142: PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A)
143: EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
144: EXTERN PetscErrorCode MatSetType(Mat,const MatType);
145: EXTERN PetscErrorCode MatSetFromOptions(Mat);
146: EXTERN PetscErrorCode MatSetUpPreallocation(Mat);
147: EXTERN PetscErrorCode MatRegisterAll(const char[]);
148: EXTERN PetscErrorCode MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
150: EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]);
151: EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]);
152: EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]);
154: /*MC
155: MatRegisterDynamic - Adds a new matrix type
157: Synopsis:
158: PetscErrorCode MatRegisterDynamic(char *name,char *path,char *name_create,PetscErrorCode (*routine_create)(Mat))
160: Not Collective
162: Input Parameters:
163: + name - name of a new user-defined matrix type
164: . path - path (either absolute or relative) the library containing this solver
165: . name_create - name of routine to create method context
166: - routine_create - routine to create method context
168: Notes:
169: MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
171: If dynamic libraries are used, then the fourth input argument (routine_create)
172: is ignored.
174: Sample usage:
175: .vb
176: MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
177: "MyMatCreate",MyMatCreate);
178: .ve
180: Then, your solver can be chosen with the procedural interface via
181: $ MatSetType(Mat,"my_mat")
182: or at runtime via the option
183: $ -mat_type my_mat
185: Level: advanced
187: Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
188: If your function is not being put into a shared library then use VecRegister() instead
190: .keywords: Mat, register
192: .seealso: MatRegisterAll(), MatRegisterDestroy()
194: M*/
195: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
196: #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
197: #else
198: #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
199: #endif
204: /*E
205: MatStructure - Indicates if the matrix has the same nonzero structure
207: Level: beginner
209: Any additions/changes here MUST also be made in include/finclude/petscmat.h
211: .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
212: E*/
213: typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure;
215: EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
216: EXTERN PetscErrorCode MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
217: EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
218: PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A)
219: PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A)
220: PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A)
221: PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A)
222: PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A))
223: PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A))
224: PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A))
225: EXTERN PetscErrorCode MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
226: 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)
227: 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)
228: 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)
229: 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)
230: 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))
231: 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))
232: 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))
233: 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)
234: 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)
235: 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)
236: 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)
237: 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))
238: 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))
239: 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))
240: EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
241: EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
243: EXTERN PetscErrorCode MatCreateMPIRowbs(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
244: EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
245: PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A)
246: PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
247: PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
248: PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
249: PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
250: PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
251: PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
252: EXTERN PetscErrorCode MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
253: 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)
254: 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)
255: 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)
256: 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)
257: 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))
258: 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))
259: 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))
260: 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)
261: 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)
262: 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)
263: 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)
264: 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))
265: 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))
266: 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))
267: EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
268: EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
269: PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A)
270: PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A)
271: PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A)
272: PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A)
273: PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A))
274: PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A))
275: PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A))
276: EXTERN PetscErrorCode MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
277: 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)
278: 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)
279: 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)
280: 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)
281: 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))
282: 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))
283: 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))
284: 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)
285: 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)
286: 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)
287: 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)
288: 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))
289: 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))
290: 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))
291: EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
292: PetscPolymorphicFunction(MatCreateShell,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(comm,m,n,M,N,ctx,&A),Mat,A)
293: PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A)
294: EXTERN PetscErrorCode MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
295: EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*);
296: PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A)
297: EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Mat,Mat*);
298: EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
299: EXTERN PetscErrorCode MatCreateSeqCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
300: EXTERN PetscErrorCode MatCreateMPICRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
301: EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*);
302: EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter);
303: EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*);
304: EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
305: EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat);
306: EXTERN PetscErrorCode MatCompositeMerge(Mat);
307: EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
308: typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
309: EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType);
311: EXTERN PetscErrorCode MatCreateSeqFFTW(MPI_Comm,PetscInt,const PetscInt[],Mat*);
312: EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
314: EXTERN PetscErrorCode MatCreatePython(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const char[],Mat*);
315: EXTERN PetscErrorCode MatPythonSetType(Mat,const char[]);
318: EXTERN PetscErrorCode MatSetUp(Mat);
319: EXTERN PetscErrorCode MatDestroy(Mat);
321: EXTERN PetscErrorCode MatConjugate(Mat);
322: EXTERN PetscErrorCode MatRealPart(Mat);
323: EXTERN PetscErrorCode MatImaginaryPart(Mat);
324: EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,PetscTruth*,MatReuse,Mat*);
326: /* ------------------------------------------------------------*/
327: EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
328: EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
329: EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
330: EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
332: /*S
333: MatStencil - Data structure (C struct) for storing information about a single row or
334: column of a matrix as index on an associated grid.
336: Level: beginner
338: Concepts: matrix; linear operator
340: .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
341: S*/
342: typedef struct {
343: PetscInt k,j,i,c;
344: } MatStencil;
346: EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
347: EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
348: EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
350: EXTERN PetscErrorCode MatSetColoring(Mat,ISColoring);
351: EXTERN PetscErrorCode MatSetValuesAdic(Mat,void*);
352: EXTERN PetscErrorCode MatSetValuesAdifor(Mat,PetscInt,void*);
354: /*E
355: MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
356: to continue to add values to it
358: Level: beginner
360: .seealso: MatAssemblyBegin(), MatAssemblyEnd()
361: E*/
362: typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
363: EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType);
364: EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType);
365: EXTERN PetscErrorCode MatAssembled(Mat,PetscTruth*);
369: /*E
370: MatOption - Options that may be set for a matrix and its behavior or storage
372: Level: beginner
374: Any additions/changes here MUST also be made in include/finclude/petscmat.h
376: .seealso: MatSetOption()
377: E*/
378: typedef enum {MAT_ROW_ORIENTED,MAT_NEW_NONZERO_LOCATIONS,
379: MAT_SYMMETRIC,
380: MAT_STRUCTURALLY_SYMMETRIC,
381: MAT_NEW_DIAGONALS,MAT_IGNORE_OFF_PROC_ENTRIES,
382: MAT_NEW_NONZERO_LOCATION_ERR,
383: MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE,
384: MAT_KEEP_ZEROED_ROWS,MAT_IGNORE_ZERO_ENTRIES,
385: MAT_USE_INODES,
386: MAT_HERMITIAN,
387: MAT_SYMMETRY_ETERNAL,
388: MAT_USE_COMPRESSEDROW,
389: MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR,
390: MAT_GETROW_UPPERTRIANGULAR,MAT_UNUSED_NONZERO_LOCATION_ERR,
391: NUM_MAT_OPTIONS} MatOption;
393: EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscTruth);
394: EXTERN PetscErrorCode MatGetType(Mat,const MatType*);
395: PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),const MatType,t)
397: EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
398: EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
399: EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
400: EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
401: EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
402: EXTERN PetscErrorCode MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
403: EXTERN PetscErrorCode MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
404: EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt);
405: EXTERN PetscErrorCode MatGetArray(Mat,PetscScalar *[]);
406: PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
407: EXTERN PetscErrorCode MatRestoreArray(Mat,PetscScalar *[]);
408: EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *);
409: PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
410: EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt);
413: EXTERN PetscErrorCode MatMult(Mat,Vec,Vec);
414: EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec);
415: PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
416: EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec);
417: EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*);
418: PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t)
419: PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscTruth,t)
420: EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscTruth*);
421: EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec);
422: PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
423: EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec);
424: EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec);
425: EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat);
427: /*E
428: MatDuplicateOption - Indicates if a duplicated sparse matrix should have
429: its numerical values copied over or just its nonzero structure.
431: Level: beginner
433: Any additions/changes here MUST also be made in include/finclude/petscmat.h
435: .seealso: MatDuplicate()
436: E*/
437: typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES} MatDuplicateOption;
439: EXTERN PetscErrorCode MatConvert(Mat,const MatType,MatReuse,Mat*);
440: PetscPolymorphicFunction(MatConvert,(Mat A,const MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a)
441: EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);
442: PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a)
443: PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a)
446: EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
447: EXTERN PetscErrorCode MatView(Mat,PetscViewer);
448: EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscTruth*);
449: PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t)
450: PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscTruth,t)
451: EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscTruth*);
452: PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t)
453: EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscTruth*);
454: PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,0,&t),PetscTruth,t)
455: EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*);
456: EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*);
457: EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscTruth *,PetscInt *);
458: EXTERN PetscErrorCode MatLoad(PetscViewer,const MatType,Mat*);
459: PetscPolymorphicFunction(MatLoad,(PetscViewer v,const MatType t),(v,t,&a),Mat,a)
461: EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
462: EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
463: EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
464: EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
466: /*S
467: MatInfo - Context of matrix information, used with MatGetInfo()
469: In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
471: Level: intermediate
473: Concepts: matrix^nonzero information
475: .seealso: MatGetInfo(), MatInfoType
476: S*/
477: typedef struct {
478: PetscLogDouble block_size; /* block size */
479: PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */
480: PetscLogDouble memory; /* memory allocated */
481: PetscLogDouble assemblies; /* number of matrix assemblies called */
482: PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */
483: PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
484: PetscLogDouble factor_mallocs; /* number of mallocs during factorization */
485: } MatInfo;
487: /*E
488: MatInfoType - Indicates if you want information about the local part of the matrix,
489: the entire parallel matrix or the maximum over all the local parts.
491: Level: beginner
493: Any additions/changes here MUST also be made in include/finclude/petscmat.h
495: .seealso: MatGetInfo(), MatInfo
496: E*/
497: typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
498: EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*);
499: EXTERN PetscErrorCode MatValid(Mat,PetscTruth*);
500: EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec);
501: EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]);
502: EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]);
503: EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
504: EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]);
505: EXTERN PetscErrorCode MatGetRowSum(Mat,Vec);
506: EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*);
507: PetscPolymorphicFunction(MatTranspose,(Mat A),(A,MAT_INITIAL_MATRIX,&t),Mat,t)
508: EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat *);
509: PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
510: EXTERN PetscErrorCode MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
511: EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec);
512: EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode);
513: EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscTruth*);
514: PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t)
515: EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscTruth*);
516: EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*);
517: EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*);
518: EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*);
520: EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal *);
521: PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
522: EXTERN PetscErrorCode MatZeroEntries(Mat);
523: EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar);
524: EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar);
525: EXTERN PetscErrorCode MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*);
526: EXTERN PetscErrorCode MatZeroColumnsIS(Mat,IS,const PetscScalar*);
528: EXTERN PetscErrorCode MatUseScaledForm(Mat,PetscTruth);
529: EXTERN PetscErrorCode MatScaleSystem(Mat,Vec,Vec);
530: EXTERN PetscErrorCode MatUnScaleSystem(Mat,Vec,Vec);
532: EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
533: EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
534: EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
535: EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
536: EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
537: EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
539: EXTERN PetscErrorCode MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
540: EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
541: EXTERN PetscErrorCode MatGetSubMatrix(Mat,IS,IS,PetscInt,MatReuse,Mat *);
542: EXTERN PetscErrorCode MatGetSubMatrixRaw(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt,MatReuse,Mat *);
543: EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat *[]);
544: EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat *[]);
546: EXTERN PetscErrorCode MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
547: EXTERN PetscErrorCode MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
548: EXTERN PetscErrorCode MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
549: EXTERN PetscErrorCode MatMerge_SeqsToMPINumeric(Mat,Mat);
550: EXTERN PetscErrorCode MatDestroy_MPIAIJ_SeqsToMPI(Mat);
551: EXTERN PetscErrorCode MatGetLocalMat(Mat,MatReuse,Mat*);
552: EXTERN PetscErrorCode MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
553: EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
554: EXTERN PetscErrorCode MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,MatScalar**,Mat*);
555: #if defined (PETSC_USE_CTABLE)
556: #include petscctable.h
557: EXTERN PetscErrorCode MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
558: #else
559: EXTERN PetscErrorCode MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
560: #endif
562: EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
564: EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
565: EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
566: EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat);
568: EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
569: EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
570: EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat);
572: EXTERN PetscErrorCode MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
573: EXTERN PetscErrorCode MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
574: EXTERN PetscErrorCode MatMatMultTransposeNumeric(Mat,Mat,Mat);
576: EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
577: EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);
578: EXTERN PetscErrorCode MatCompress(Mat);
580: EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
581: EXTERN PetscErrorCode MatShift(Mat,PetscScalar);
583: EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
584: EXTERN PetscErrorCode MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
585: EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar);
586: EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar);
587: EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
588: EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
590: EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt);
591: EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
593: EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec);
594: EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec);
595: PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
596: EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec);
597: EXTERN PetscErrorCode MatGetVecs(Mat,Vec*,Vec*);
598: EXTERN PetscErrorCode MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);
600: /*MC
601: MatSetValue - Set a single entry into a matrix.
603: Not collective
605: Input Parameters:
606: + m - the matrix
607: . row - the row location of the entry
608: . col - the column location of the entry
609: . value - the value to insert
610: - mode - either INSERT_VALUES or ADD_VALUES
612: Notes:
613: For efficiency one should use MatSetValues() and set several or many
614: values simultaneously if possible.
616: Level: beginner
618: .seealso: MatSetValues(), MatSetValueLocal()
619: M*/
620: PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);}
622: PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
624: PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);}
626: /*MC
627: MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
628: row in a matrix providing the data that one can use to correctly preallocate the matrix.
630: Synopsis:
631: PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
633: Collective on MPI_Comm
635: Input Parameters:
636: + comm - the communicator that will share the eventually allocated matrix
637: . nrows - the number of LOCAL rows in the matrix
638: - ncols - the number of LOCAL columns in the matrix
640: Output Parameters:
641: + dnz - the array that will be passed to the matrix preallocation routines
642: - ozn - the other array passed to the matrix preallocation routines
645: Level: intermediate
647: Notes:
648: See the chapter in the users manual on performance for more details
650: Do not malloc or free dnz and onz, that is handled internally by these routines
652: Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
654: This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
656: Concepts: preallocation^Matrix
658: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
659: MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
660: M*/
661: #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
662: { \
663: PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
664: _4_PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
665: _4_PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
666: _4_PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
667: _4_MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
668: _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
670: /*MC
671: MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
672: row in a matrix providing the data that one can use to correctly preallocate the matrix.
674: Synopsis:
675: PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
677: Collective on MPI_Comm
679: Input Parameters:
680: + comm - the communicator that will share the eventually allocated matrix
681: . nrows - the number of LOCAL rows in the matrix
682: - ncols - the number of LOCAL columns in the matrix
684: Output Parameters:
685: + dnz - the array that will be passed to the matrix preallocation routines
686: - ozn - the other array passed to the matrix preallocation routines
689: Level: intermediate
691: Notes:
692: See the chapter in the users manual on performance for more details
694: Do not malloc or free dnz and onz, that is handled internally by these routines
696: This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
698: Concepts: preallocation^Matrix
700: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
701: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
702: M*/
703: #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
704: { \
705: PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__end; \
706: _4_PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
707: _4_PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
708: _4_PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
709: _4_MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
710: _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
712: /*MC
713: MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
714: inserted using a local number of the rows and columns
716: Synopsis:
717: PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
719: Not Collective
721: Input Parameters:
722: + map - the mapping between local numbering and global numbering
723: . nrows - the number of rows indicated
724: . rows - the indices of the rows
725: . ncols - the number of columns in the matrix
726: . cols - the columns indicated
727: . dnz - the array that will be passed to the matrix preallocation routines
728: - ozn - the other array passed to the matrix preallocation routines
731: Level: intermediate
733: Notes:
734: See the chapter in the users manual on performance for more details
736: Do not malloc or free dnz and onz, that is handled internally by these routines
738: Concepts: preallocation^Matrix
740: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
741: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
742: M*/
743: #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
744: {\
745: PetscInt __l;\
746: _4_ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
747: _4_ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
748: for (__l=0;__l<nrows;__l++) {\
749: _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
750: }\
751: }
752:
753: /*MC
754: MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
755: inserted using a local number of the rows and columns
757: Synopsis:
758: PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
760: Not Collective
762: Input Parameters:
763: + map - the mapping between local numbering and global numbering
764: . nrows - the number of rows indicated
765: . rows - the indices of the rows
766: . ncols - the number of columns in the matrix
767: . cols - the columns indicated
768: . dnz - the array that will be passed to the matrix preallocation routines
769: - ozn - the other array passed to the matrix preallocation routines
772: Level: intermediate
774: Notes:
775: See the chapter in the users manual on performance for more details
777: Do not malloc or free dnz and onz that is handled internally by these routines
779: Concepts: preallocation^Matrix
781: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
782: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
783: M*/
784: #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
785: {\
786: PetscInt __l;\
787: _4_ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
788: _4_ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
789: for (__l=0;__l<nrows;__l++) {\
790: _4_MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
791: }\
792: }
794: /*MC
795: MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
796: inserted using a local number of the rows and columns
798: Synopsis:
799: PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
801: Not Collective
803: Input Parameters:
804: + row - the row
805: . ncols - the number of columns in the matrix
806: - cols - the columns indicated
808: Output Parameters:
809: + dnz - the array that will be passed to the matrix preallocation routines
810: - ozn - the other array passed to the matrix preallocation routines
813: Level: intermediate
815: Notes:
816: See the chapter in the users manual on performance for more details
818: Do not malloc or free dnz and onz that is handled internally by these routines
820: This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
822: Concepts: preallocation^Matrix
824: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
825: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
826: M*/
827: #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
828: { PetscInt __i; \
829: if (row < __rstart) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\
830: 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);\
831: for (__i=0; __i<nc; __i++) {\
832: if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
833: else dnz[row - __rstart]++;\
834: }\
835: }
837: /*MC
838: MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
839: inserted using a local number of the rows and columns
841: Synopsis:
842: PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
844: Not Collective
846: Input Parameters:
847: + nrows - the number of rows indicated
848: . rows - the indices of the rows
849: . ncols - the number of columns in the matrix
850: . cols - the columns indicated
851: . dnz - the array that will be passed to the matrix preallocation routines
852: - ozn - the other array passed to the matrix preallocation routines
855: Level: intermediate
857: Notes:
858: See the chapter in the users manual on performance for more details
860: Do not malloc or free dnz and onz that is handled internally by these routines
862: This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
864: Concepts: preallocation^Matrix
866: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
867: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
868: M*/
869: #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
870: { PetscInt __i; \
871: for (__i=0; __i<nc; __i++) {\
872: if (cols[__i] >= __end) onz[row - __rstart]++; \
873: else if (cols[__i] >= row) dnz[row - __rstart]++;\
874: }\
875: }
877: /*MC
878: MatPreallocateLocation - An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists
880: Synopsis:
881: PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
883: Not Collective
885: Input Parameters:
886: . A - matrix
887: . row - row where values exist (must be local to this process)
888: . ncols - number of columns
889: . cols - columns with nonzeros
890: . dnz - the array that will be passed to the matrix preallocation routines
891: - ozn - the other array passed to the matrix preallocation routines
894: Level: intermediate
896: Notes:
897: See the chapter in the users manual on performance for more details
899: Do not malloc or free dnz and onz that is handled internally by these routines
901: This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
903: Concepts: preallocation^Matrix
905: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
906: MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
907: M*/
908: #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);}
911: /*MC
912: MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
913: row in a matrix providing the data that one can use to correctly preallocate the matrix.
915: Synopsis:
916: PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
918: Collective on MPI_Comm
920: Input Parameters:
921: + dnz - the array that was be passed to the matrix preallocation routines
922: - ozn - the other array passed to the matrix preallocation routines
925: Level: intermediate
927: Notes:
928: See the chapter in the users manual on performance for more details
930: Do not malloc or free dnz and onz that is handled internally by these routines
932: This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
934: Concepts: preallocation^Matrix
936: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
937: MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
938: M*/
939: #define MatPreallocateFinalize(dnz,onz) 0;_4_PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}
943: /* Routines unique to particular data structures */
944: EXTERN PetscErrorCode MatShellGetContext(Mat,void **);
945: PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)
947: EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
948: EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
950: EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
951: EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
952: EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
953: EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
954: EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
956: #define MAT_SKIP_ALLOCATION -4
958: EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
959: PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
960: EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
961: PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
962: EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
963: PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))
965: EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
966: PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
967: EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
968: EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
969: EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
970: EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
971: EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
972: EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
973: EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
974: EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
975: EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
976: EXTERN PetscErrorCode MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]);
977: EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
978: EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
979: EXTERN PetscErrorCode MatAdicSetLocalFunction(Mat,void (*)(void));
981: EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt);
982: EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);
984: EXTERN PetscErrorCode MatStoreValues(Mat);
985: EXTERN PetscErrorCode MatRetrieveValues(Mat);
987: EXTERN PetscErrorCode MatDAADSetCtx(Mat,void*);
989: /*
990: These routines are not usually accessed directly, rather solving is
991: done through the KSP and PC interfaces.
992: */
994: /*E
995: MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
996: with an optional dynamic library name, for example
997: http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
999: Level: beginner
1001: Cannot use const because the PC objects manipulate the string
1003: .seealso: MatGetOrdering()
1004: E*/
1005: #define MatOrderingType char*
1006: #define MATORDERING_NATURAL "natural"
1007: #define MATORDERING_ND "nd"
1008: #define MATORDERING_1WD "1wd"
1009: #define MATORDERING_RCM "rcm"
1010: #define MATORDERING_QMD "qmd"
1011: #define MATORDERING_ROWLENGTH "rowlength"
1012: #define MATORDERING_DSC_ND "dsc_nd" /* these three are only for DSCPACK, see its documentation for details */
1013: #define MATORDERING_DSC_MMD "dsc_mmd"
1014: #define MATORDERING_DSC_MDF "dsc_mdf"
1015: #define MATORDERING_CONSTRAINED "constrained"
1016: #define MATORDERING_IDENTITY "identity"
1017: #define MATORDERING_REVERSE "reverse"
1019: EXTERN PetscErrorCode MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
1020: EXTERN PetscErrorCode MatGetOrderingList(PetscFList *list);
1021: EXTERN PetscErrorCode MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
1023: /*MC
1024: MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the
1025: matrix package.
1027: Synopsis:
1028: PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
1030: Not Collective
1032: Input Parameters:
1033: + sname - name of ordering (for example MATORDERING_ND)
1034: . path - location of library where creation routine is
1035: . name - name of function that creates the ordering type,a string
1036: - function - function pointer that creates the ordering
1038: Level: developer
1040: If dynamic libraries are used, then the fourth input argument (function)
1041: is ignored.
1043: Sample usage:
1044: .vb
1045: MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
1046: "MyOrder",MyOrder);
1047: .ve
1049: Then, your partitioner can be chosen with the procedural interface via
1050: $ MatOrderingSetType(part,"my_order)
1051: or at runtime via the option
1052: $ -pc_factor_mat_ordering_type my_order
1054: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
1056: .keywords: matrix, ordering, register
1058: .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
1059: M*/
1060: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1061: #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
1062: #else
1063: #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
1064: #endif
1066: EXTERN PetscErrorCode MatOrderingRegisterDestroy(void);
1067: EXTERN PetscErrorCode MatOrderingRegisterAll(const char[]);
1071: EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1073: /*S
1074: MatFactorInfo - Data passed into the matrix factorization routines
1076: In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
1077: $ MatFactorInfo info(MAT_FACTORINFO_SIZE)
1079: Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1081: You can use MatFactorInfoInitialize() to set default values.
1083: Level: developer
1085: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1086: MatFactorInfoInitialize()
1088: S*/
1089: typedef struct {
1090: PetscReal shiftnz; /* scaling of identity added to matrix to prevent zero pivots */
1091: PetscReal shiftpd; /* if true, shift until positive pivots */
1092: PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */
1093: PetscReal usedt;
1094: PetscReal dt; /* drop tolerance */
1095: PetscReal dtcol; /* tolerance for pivoting */
1096: PetscReal dtcount; /* maximum nonzeros to be allowed per row */
1097: PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1098: PetscReal levels; /* ICC/ILU(levels) */
1099: PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1100: factorization may be faster if do not pivot */
1101: PetscReal shiftinblocks; /* if block in block factorization has zero pivot then shift diagonal until non-singular */
1102: PetscReal zeropivot; /* pivot is called zero if less than this */
1103: } MatFactorInfo;
1105: EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
1106: EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
1107: EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1108: EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
1109: EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
1110: EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
1111: EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1112: EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1113: EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1114: EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
1115: EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1116: EXTERN PetscErrorCode MatILUDTFactor(Mat,IS,IS,const MatFactorInfo*,Mat *);
1117: EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1118: EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
1119: EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
1120: EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
1121: EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
1122: EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
1123: EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1124: EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);
1126: EXTERN PetscErrorCode MatSetUnfactored(Mat);
1128: /*E
1129: MatSORType - What type of (S)SOR to perform
1131: Level: beginner
1133: May be bitwise ORd together
1135: Any additions/changes here MUST also be made in include/finclude/petscmat.h
1137: MatSORType may be bitwise ORd together, so do not change the numbers
1139: .seealso: MatRelax(), MatPBRelax()
1140: E*/
1141: typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1142: SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1143: SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1144: SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1145: EXTERN PetscErrorCode MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1146: EXTERN PetscErrorCode MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1148: /*
1149: These routines are for efficiently computing Jacobians via finite differences.
1150: */
1152: /*E
1153: MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1154: with an optional dynamic library name, for example
1155: http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1157: Level: beginner
1159: .seealso: MatGetColoring()
1160: E*/
1161: #define MatColoringType char*
1162: #define MATCOLORING_NATURAL "natural"
1163: #define MATCOLORING_SL "sl"
1164: #define MATCOLORING_LF "lf"
1165: #define MATCOLORING_ID "id"
1167: EXTERN PetscErrorCode MatGetColoring(Mat,const MatColoringType,ISColoring*);
1168: EXTERN PetscErrorCode MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *));
1170: /*MC
1171: MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
1172: matrix package.
1174: Synopsis:
1175: PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring))
1177: Not Collective
1179: Input Parameters:
1180: + sname - name of Coloring (for example MATCOLORING_SL)
1181: . path - location of library where creation routine is
1182: . name - name of function that creates the Coloring type, a string
1183: - function - function pointer that creates the coloring
1185: Level: developer
1187: If dynamic libraries are used, then the fourth input argument (function)
1188: is ignored.
1190: Sample usage:
1191: .vb
1192: MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
1193: "MyColor",MyColor);
1194: .ve
1196: Then, your partitioner can be chosen with the procedural interface via
1197: $ MatColoringSetType(part,"my_color")
1198: or at runtime via the option
1199: $ -mat_coloring_type my_color
1201: $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
1203: .keywords: matrix, Coloring, register
1205: .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
1206: M*/
1207: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1208: #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1209: #else
1210: #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1211: #endif
1215: EXTERN PetscErrorCode MatColoringRegisterAll(const char[]);
1216: EXTERN PetscErrorCode MatColoringRegisterDestroy(void);
1217: EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1219: /*S
1220: MatFDColoring - Object for computing a sparse Jacobian via finite differences
1221: and coloring
1223: Level: beginner
1225: Concepts: coloring, sparse Jacobian, finite differences
1227: .seealso: MatFDColoringCreate()
1228: S*/
1229: typedef struct _p_MatFDColoring* MatFDColoring;
1231: EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1232: EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring);
1233: EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
1234: EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1235: EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1236: EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1237: EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1238: EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1239: EXTERN PetscErrorCode MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1240: EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
1241: EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1242: /*
1243: These routines are for partitioning matrices: currently used only
1244: for adjacency matrix, MatCreateMPIAdj().
1245: */
1247: /*S
1248: MatPartitioning - Object for managing the partitioning of a matrix or graph
1250: Level: beginner
1252: Concepts: partitioning
1254: .seealso: MatPartitioningCreate(), MatPartitioningType
1255: S*/
1256: typedef struct _p_MatPartitioning* MatPartitioning;
1258: /*E
1259: MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1260: with an optional dynamic library name, for example
1261: http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1263: Level: beginner
1265: .seealso: MatPartitioningCreate(), MatPartitioning
1266: E*/
1267: #define MatPartitioningType char*
1268: #define MAT_PARTITIONING_CURRENT "current"
1269: #define MAT_PARTITIONING_SQUARE "square"
1270: #define MAT_PARTITIONING_PARMETIS "parmetis"
1271: #define MAT_PARTITIONING_CHACO "chaco"
1272: #define MAT_PARTITIONING_JOSTLE "jostle"
1273: #define MAT_PARTITIONING_PARTY "party"
1274: #define MAT_PARTITIONING_SCOTCH "scotch"
1277: EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1278: EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1279: EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
1280: EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
1281: EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1282: EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1283: EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
1284: EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning);
1286: EXTERN PetscErrorCode MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
1288: /*MC
1289: MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
1290: matrix package.
1292: Synopsis:
1293: PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
1295: Not Collective
1297: Input Parameters:
1298: + sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis
1299: . path - location of library where creation routine is
1300: . name - name of function that creates the partitioning type, a string
1301: - function - function pointer that creates the partitioning type
1303: Level: developer
1305: If dynamic libraries are used, then the fourth input argument (function)
1306: is ignored.
1308: Sample usage:
1309: .vb
1310: MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
1311: "MyPartCreate",MyPartCreate);
1312: .ve
1314: Then, your partitioner can be chosen with the procedural interface via
1315: $ MatPartitioningSetType(part,"my_part")
1316: or at runtime via the option
1317: $ -mat_partitioning_type my_part
1319: $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
1321: .keywords: matrix, partitioning, register
1323: .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
1324: M*/
1325: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1326: #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
1327: #else
1328: #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
1329: #endif
1333: EXTERN PetscErrorCode MatPartitioningRegisterAll(const char[]);
1334: EXTERN PetscErrorCode MatPartitioningRegisterDestroy(void);
1336: EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1337: EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1338: EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,const MatPartitioningType*);
1340: EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1341: EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
1343: EXTERN PetscErrorCode MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1344: EXTERN PetscErrorCode MatPartitioningJostleSetCoarseSequential(MatPartitioning);
1346: typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType;
1347: EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
1348: typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1349: EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1350: EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1351: typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1352: EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1353: EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1354: EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);
1356: #define MP_PARTY_OPT "opt"
1357: #define MP_PARTY_LIN "lin"
1358: #define MP_PARTY_SCA "sca"
1359: #define MP_PARTY_RAN "ran"
1360: #define MP_PARTY_GBF "gbf"
1361: #define MP_PARTY_GCF "gcf"
1362: #define MP_PARTY_BUB "bub"
1363: #define MP_PARTY_DEF "def"
1364: EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning, const char*);
1365: #define MP_PARTY_HELPFUL_SETS "hs"
1366: #define MP_PARTY_KERNIGHAN_LIN "kl"
1367: #define MP_PARTY_NONE "no"
1368: EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning, const char*);
1369: EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1370: EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscTruth);
1371: EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth);
1373: typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1374: EXTERN PetscErrorCode MatPartitioningScotchSetArch(MatPartitioning,const char*);
1375: EXTERN PetscErrorCode MatPartitioningScotchSetMultilevel(MatPartitioning);
1376: EXTERN PetscErrorCode MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1377: EXTERN PetscErrorCode MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1378: EXTERN PetscErrorCode MatPartitioningScotchSetHostList(MatPartitioning,const char*);
1379: typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1380: EXTERN PetscErrorCode MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1381: EXTERN PetscErrorCode MatPartitioningScotchSetMapping(MatPartitioning);
1382: EXTERN PetscErrorCode MatPartitioningScotchSetStrategy(MatPartitioning,char*);
1384: /*
1385: If you add entries here you must also add them to finclude/petscmat.h
1386: */
1387: typedef enum { MATOP_SET_VALUES=0,
1388: MATOP_GET_ROW=1,
1389: MATOP_RESTORE_ROW=2,
1390: MATOP_MULT=3,
1391: MATOP_MULT_ADD=4,
1392: MATOP_MULT_TRANSPOSE=5,
1393: MATOP_MULT_TRANSPOSE_ADD=6,
1394: MATOP_SOLVE=7,
1395: MATOP_SOLVE_ADD=8,
1396: MATOP_SOLVE_TRANSPOSE=9,
1397: MATOP_SOLVE_TRANSPOSE_ADD=10,
1398: MATOP_LUFACTOR=11,
1399: MATOP_CHOLESKYFACTOR=12,
1400: MATOP_RELAX=13,
1401: MATOP_TRANSPOSE=14,
1402: MATOP_GETINFO=15,
1403: MATOP_EQUAL=16,
1404: MATOP_GET_DIAGONAL=17,
1405: MATOP_DIAGONAL_SCALE=18,
1406: MATOP_NORM=19,
1407: MATOP_ASSEMBLY_BEGIN=20,
1408: MATOP_ASSEMBLY_END=21,
1409: MATOP_COMPRESS=22,
1410: MATOP_SET_OPTION=23,
1411: MATOP_ZERO_ENTRIES=24,
1412: MATOP_ZERO_ROWS=25,
1413: MATOP_LUFACTOR_SYMBOLIC=26,
1414: MATOP_LUFACTOR_NUMERIC=27,
1415: MATOP_CHOLESKY_FACTOR_SYMBOLIC=28,
1416: MATOP_CHOLESKY_FACTOR_NUMERIC=29,
1417: MATOP_SETUP_PREALLOCATION=30,
1418: MATOP_ILUFACTOR_SYMBOLIC=31,
1419: MATOP_ICCFACTOR_SYMBOLIC=32,
1420: MATOP_GET_ARRAY=33,
1421: MATOP_RESTORE_ARRAY=34,
1422: MATOP_DUPLICATE=35,
1423: MATOP_FORWARD_SOLVE=36,
1424: MATOP_BACKWARD_SOLVE=37,
1425: MATOP_ILUFACTOR=38,
1426: MATOP_ICCFACTOR=39,
1427: MATOP_AXPY=40,
1428: MATOP_GET_SUBMATRICES=41,
1429: MATOP_INCREASE_OVERLAP=42,
1430: MATOP_GET_VALUES=43,
1431: MATOP_COPY=44,
1432: MATOP_GET_ROW_MAX=45,
1433: MATOP_SCALE=46,
1434: MATOP_SHIFT=47,
1435: MATOP_DIAGONAL_SHIFT=48,
1436: MATOP_ILUDT_FACTOR=49,
1437: MATOP_SET_BLOCK_SIZE=50,
1438: MATOP_GET_ROW_IJ=51,
1439: MATOP_RESTORE_ROW_IJ=52,
1440: MATOP_GET_COLUMN_IJ=53,
1441: MATOP_RESTORE_COLUMN_IJ=54,
1442: MATOP_FDCOLORING_CREATE=55,
1443: MATOP_COLORING_PATCH=56,
1444: MATOP_SET_UNFACTORED=57,
1445: MATOP_PERMUTE=58,
1446: MATOP_SET_VALUES_BLOCKED=59,
1447: MATOP_GET_SUBMATRIX=60,
1448: MATOP_DESTROY=61,
1449: MATOP_VIEW=62,
1450: MATOP_CONVERT_FROM=63,
1451: MATOP_USE_SCALED_FORM=64,
1452: MATOP_SCALE_SYSTEM=65,
1453: MATOP_UNSCALE_SYSTEM=66,
1454: MATOP_SET_LOCAL_TO_GLOBAL_MAP=67,
1455: MATOP_SET_VALUES_LOCAL=68,
1456: MATOP_ZERO_ROWS_LOCAL=69,
1457: MATOP_GET_ROW_MAX_ABS=70,
1458: MATOP_GET_ROW_MIN_ABS=71,
1459: MATOP_CONVERT=72,
1460: MATOP_SET_COLORING=73,
1461: MATOP_SET_VALUES_ADIC=74,
1462: MATOP_SET_VALUES_ADIFOR=75,
1463: MATOP_FD_COLORING_APPLY=76,
1464: MATOP_SET_FROM_OPTIONS=77,
1465: MATOP_MULT_CON=78,
1466: MATOP_MULT_TRANSPOSE_CON=79,
1467: MATOP_PERMUTE_SPARSIFY=80,
1468: MATOP_MULT_MULTIPLE=81,
1469: MATOP_SOLVE_MULTIPLE=82,
1470: MATOP_GET_INERTIA=83,
1471: MATOP_LOAD=84,
1472: MATOP_IS_SYMMETRIC=85,
1473: MATOP_IS_HERMITIAN=86,
1474: MATOP_IS_STRUCTURALLY_SYMMETRIC=87,
1475: MATOP_PB_RELAX=88,
1476: MATOP_GET_VECS=89,
1477: MATOP_MAT_MULT=90,
1478: MATOP_MAT_MULT_SYMBOLIC=91,
1479: MATOP_MAT_MULT_NUMERIC=92,
1480: MATOP_PTAP=93,
1481: MATOP_PTAP_SYMBOLIC=94,
1482: MATOP_PTAP_NUMERIC=95,
1483: MATOP_MAT_MULTTRANSPOSE=96,
1484: MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=97,
1485: MATOP_MAT_MULTTRANSPOSE_NUMERIC=98,
1486: MATOP_PTAP_SYMBOLIC_SEQAIJ=99,
1487: MATOP_PTAP_NUMERIC_SEQAIJ=100,
1488: MATOP_PTAP_SYMBOLIC_MPIAIJ=101,
1489: MATOP_PTAP_NUMERIC_MPIAIJ=102,
1490: MATOP_CONJUGATE=103,
1491: MATOP_SET_SIZES=104,
1492: MATOP_SET_VALUES_ROW = 105,
1493: MATOP_REAL_PART=106,
1494: MATOP_IMAG_PART=107,
1495: MATOP_GET_ROW_UTRIANGULAR=108,
1496: MATOP_RESTORE_ROW_UTRIANGULAR=109,
1497: MATOP_MATSOLVE=110,
1498: MATOP_GET_REDUNDANTMATRIX=111,
1499: MATOP_GET_ROW_MIN=112,
1500: MATOP_GET_COLUMN_VEC=113,
1501: MATOP_MISSING_DIAGONAL=114,
1502: MATOP_MATGETSEQNONZEROSTRUCTURE=115,
1503: MATOP_DESTROY_SOLVER=116
1504: } MatOperation;
1505: EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscTruth*);
1506: EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void));
1507: EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void));
1508: EXTERN PetscErrorCode MatShellSetContext(Mat,void*);
1510: /*
1511: Codes for matrices stored on disk. By default they are
1512: stored in a universal format. By changing the format with
1513: PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1514: be stored in a way natural for the matrix, for example dense matrices
1515: would be stored as dense. Matrices stored this way may only be
1516: read into matrices of the same time.
1517: */
1518: #define MATRIX_BINARY_FORMAT_DENSE -1
1520: EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1521: EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
1523: /*S
1524: MatNullSpace - Object that removes a null space from a vector, i.e.
1525: orthogonalizes the vector to a subsapce
1527: Level: advanced
1529: Concepts: matrix; linear operator, null space
1531: Users manual sections:
1532: . Section 4.15 Solving Singular Systems
1534: .seealso: MatNullSpaceCreate()
1535: S*/
1536: typedef struct _p_MatNullSpace* MatNullSpace;
1538: EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*);
1539: EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(Vec,void*),void*);
1540: EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace);
1541: EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1542: EXTERN PetscErrorCode MatNullSpaceAttach(Mat,MatNullSpace);
1543: EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscTruth *);
1545: EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1546: EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1547: EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1548: EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);
1550: EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1551: EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1552: EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);
1554: EXTERN PetscErrorCode MatComputeExplicitOperator(Mat,Mat*);
1556: EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);
1558: EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1559: EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
1560: EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1561: EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1562: EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1563: EXTERN PetscErrorCode MatMFFDAddNullSpace(Mat,MatNullSpace);
1564: EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1565: EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
1566: EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
1567: EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
1568: EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
1569: EXTERN PetscErrorCode MatMFFDSetFromOptions(Mat);
1570: EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1571: EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1572: EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1575: typedef struct _p_MatMFFD* MatMFFD;
1577: /*E
1578: MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1580: Level: beginner
1582: .seealso: MatMFFDSetType(), MatMFFDRegister()
1583: E*/
1584: #define MatMFFDType char*
1585: #define MATMFFD_DS "ds"
1586: #define MATMFFD_WP "wp"
1588: EXTERN PetscErrorCode MatMFFDSetType(Mat,const MatMFFDType);
1589: EXTERN PetscErrorCode MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD));
1591: /*MC
1592: MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry.
1594: Synopsis:
1595: PetscErrorCode MatMFFDRegisterDynamic(char *name_solver,char *path,char *name_create,PetscErrorCode (*routine_create)(MatMFFD))
1597: Not Collective
1599: Input Parameters:
1600: + name_solver - name of a new user-defined compute-h module
1601: . path - path (either absolute or relative) the library containing this solver
1602: . name_create - name of routine to create method context
1603: - routine_create - routine to create method context
1605: Level: developer
1607: Notes:
1608: MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers.
1610: If dynamic libraries are used, then the fourth input argument (routine_create)
1611: is ignored.
1613: Sample usage:
1614: .vb
1615: MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a,
1616: "MyHCreate",MyHCreate);
1617: .ve
1619: Then, your solver can be chosen with the procedural interface via
1620: $ MatMFFDSetType(mfctx,"my_h")
1621: or at runtime via the option
1622: $ -snes_mf_type my_h
1624: .keywords: MatMFFD, register
1626: .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy()
1627: M*/
1628: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1629: #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0)
1630: #else
1631: #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d)
1632: #endif
1634: EXTERN PetscErrorCode MatMFFDRegisterAll(const char[]);
1635: EXTERN PetscErrorCode MatMFFDRegisterDestroy(void);
1636: EXTERN PetscErrorCode MatMFFDDefaultSetUmin(Mat,PetscReal);
1637: EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscTruth);
1640: EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1641: EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
1644: #endif