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);

325: /* ------------------------------------------------------------*/
326: EXTERN PetscErrorCode  MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
327: EXTERN PetscErrorCode  MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
328: EXTERN PetscErrorCode  MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
329: EXTERN PetscErrorCode  MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);

331: /*S
332:      MatStencil - Data structure (C struct) for storing information about a single row or
333:         column of a matrix as index on an associated grid.

335:    Level: beginner

337:   Concepts: matrix; linear operator

339: .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil()
340: S*/
341: typedef struct {
342:   PetscInt k,j,i,c;
343: } MatStencil;

345: EXTERN PetscErrorCode  MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
346: EXTERN PetscErrorCode  MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
347: EXTERN PetscErrorCode  MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);

349: EXTERN PetscErrorCode  MatSetColoring(Mat,ISColoring);
350: EXTERN PetscErrorCode  MatSetValuesAdic(Mat,void*);
351: EXTERN PetscErrorCode  MatSetValuesAdifor(Mat,PetscInt,void*);

353: /*E
354:     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan 
355:      to continue to add values to it

357:     Level: beginner

359: .seealso: MatAssemblyBegin(), MatAssemblyEnd()
360: E*/
361: typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
362: EXTERN PetscErrorCode  MatAssemblyBegin(Mat,MatAssemblyType);
363: EXTERN PetscErrorCode  MatAssemblyEnd(Mat,MatAssemblyType);
364: EXTERN PetscErrorCode  MatAssembled(Mat,PetscTruth*);



368: /*E
369:     MatOption - Options that may be set for a matrix and its behavior or storage

371:     Level: beginner

373:    Any additions/changes here MUST also be made in include/finclude/petscmat.h

375: .seealso: MatSetOption()
376: E*/
377: typedef enum {MAT_ROW_ORIENTED,MAT_NEW_NONZERO_LOCATIONS,
378:               MAT_SYMMETRIC,
379:               MAT_STRUCTURALLY_SYMMETRIC,
380:               MAT_NEW_DIAGONALS,MAT_IGNORE_OFF_PROC_ENTRIES,
381:               MAT_NEW_NONZERO_LOCATION_ERR,
382:               MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE,
383:               MAT_KEEP_ZEROED_ROWS,MAT_IGNORE_ZERO_ENTRIES,
384:               MAT_USE_INODES,
385:               MAT_HERMITIAN,
386:               MAT_SYMMETRY_ETERNAL,
387:               MAT_USE_COMPRESSEDROW,
388:               MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR,
389:               MAT_GETROW_UPPERTRIANGULAR,MAT_UNUSED_NONZERO_LOCATION_ERR,
390:               NUM_MAT_OPTIONS} MatOption;
392: EXTERN PetscErrorCode  MatSetOption(Mat,MatOption,PetscTruth);
393: EXTERN PetscErrorCode  MatGetType(Mat,const MatType*);
394: PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),const MatType,t)

396: EXTERN PetscErrorCode  MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
397: EXTERN PetscErrorCode  MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
398: EXTERN PetscErrorCode  MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
399: EXTERN PetscErrorCode  MatGetRowUpperTriangular(Mat);
400: EXTERN PetscErrorCode  MatRestoreRowUpperTriangular(Mat);
401: EXTERN PetscErrorCode  MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
402: EXTERN PetscErrorCode  MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
403: EXTERN PetscErrorCode  MatGetColumnVector(Mat,Vec,PetscInt);
404: EXTERN PetscErrorCode  MatGetArray(Mat,PetscScalar *[]);
405: PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a)
406: EXTERN PetscErrorCode  MatRestoreArray(Mat,PetscScalar *[]);
407: EXTERN PetscErrorCode  MatGetBlockSize(Mat,PetscInt *);
408: PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a)
409: EXTERN PetscErrorCode  MatSetBlockSize(Mat,PetscInt);


412: EXTERN PetscErrorCode  MatMult(Mat,Vec,Vec);
413: EXTERN PetscErrorCode  MatMultAdd(Mat,Vec,Vec,Vec);
414: PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
415: EXTERN PetscErrorCode  MatMultTranspose(Mat,Vec,Vec);
416: EXTERN PetscErrorCode  MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*);
417: PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t)
418: PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscTruth,t)
419: EXTERN PetscErrorCode  MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscTruth*);
420: EXTERN PetscErrorCode  MatMultTransposeAdd(Mat,Vec,Vec,Vec);
421: PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
422: EXTERN PetscErrorCode  MatMultConstrained(Mat,Vec,Vec);
423: EXTERN PetscErrorCode  MatMultTransposeConstrained(Mat,Vec,Vec);
424: EXTERN PetscErrorCode  MatMatSolve(Mat,Mat,Mat);

426: /*E
427:     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
428:   its numerical values copied over or just its nonzero structure.

430:     Level: beginner

432:    Any additions/changes here MUST also be made in include/finclude/petscmat.h

434: .seealso: MatDuplicate()
435: E*/
436: typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES} MatDuplicateOption;

438: EXTERN PetscErrorCode  MatConvert(Mat,const MatType,MatReuse,Mat*);
439: PetscPolymorphicFunction(MatConvert,(Mat A,const MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a)
440: EXTERN PetscErrorCode  MatDuplicate(Mat,MatDuplicateOption,Mat*);
441: PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a)
442: PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a)


445: EXTERN PetscErrorCode  MatCopy(Mat,Mat,MatStructure);
446: EXTERN PetscErrorCode  MatView(Mat,PetscViewer);
447: EXTERN PetscErrorCode  MatIsSymmetric(Mat,PetscReal,PetscTruth*);
448: PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t)
449: PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscTruth,t)
450: EXTERN PetscErrorCode  MatIsStructurallySymmetric(Mat,PetscTruth*);
451: PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t)
452: EXTERN PetscErrorCode  MatIsHermitian(Mat,PetscReal,PetscTruth*);
453: PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,0,&t),PetscTruth,t)
454: EXTERN PetscErrorCode  MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*);
455: EXTERN PetscErrorCode  MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*);
456: EXTERN PetscErrorCode  MatMissingDiagonal(Mat,PetscTruth *,PetscInt *);
457: EXTERN PetscErrorCode  MatLoad(PetscViewer,const MatType,Mat*);
458: PetscPolymorphicFunction(MatLoad,(PetscViewer v,const MatType t),(v,t,&a),Mat,a)

460: EXTERN PetscErrorCode  MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
461: EXTERN PetscErrorCode  MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);
462: EXTERN PetscErrorCode  MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *);
463: EXTERN PetscErrorCode  MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *);

465: /*S
466:      MatInfo - Context of matrix information, used with MatGetInfo()

468:    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE

470:    Level: intermediate

472:   Concepts: matrix^nonzero information

474: .seealso:  MatGetInfo(), MatInfoType
475: S*/
476: typedef struct {
477:   PetscLogDouble block_size;                         /* block size */
478:   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
479:   PetscLogDouble memory;                             /* memory allocated */
480:   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
481:   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
482:   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
483:   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
484: } MatInfo;

486: /*E
487:     MatInfoType - Indicates if you want information about the local part of the matrix,
488:      the entire parallel matrix or the maximum over all the local parts.

490:     Level: beginner

492:    Any additions/changes here MUST also be made in include/finclude/petscmat.h

494: .seealso: MatGetInfo(), MatInfo
495: E*/
496: typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
497: EXTERN PetscErrorCode  MatGetInfo(Mat,MatInfoType,MatInfo*);
498: EXTERN PetscErrorCode  MatValid(Mat,PetscTruth*);
499: EXTERN PetscErrorCode  MatGetDiagonal(Mat,Vec);
500: EXTERN PetscErrorCode  MatGetRowMax(Mat,Vec,PetscInt[]);
501: EXTERN PetscErrorCode  MatGetRowMin(Mat,Vec,PetscInt[]);
502: EXTERN PetscErrorCode  MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
503: EXTERN PetscErrorCode  MatGetRowMinAbs(Mat,Vec,PetscInt[]);
504: EXTERN PetscErrorCode  MatGetRowSum(Mat,Vec);
505: EXTERN PetscErrorCode  MatTranspose(Mat,MatReuse,Mat*);
506: PetscPolymorphicFunction(MatTranspose,(Mat A),(A,MAT_INITIAL_MATRIX,&t),Mat,t)
507: EXTERN PetscErrorCode  MatPermute(Mat,IS,IS,Mat *);
508: PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t)
509: EXTERN PetscErrorCode  MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *);
510: EXTERN PetscErrorCode  MatDiagonalScale(Mat,Vec,Vec);
511: EXTERN PetscErrorCode  MatDiagonalSet(Mat,Vec,InsertMode);
512: EXTERN PetscErrorCode  MatEqual(Mat,Mat,PetscTruth*);
513: PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t)
514: EXTERN PetscErrorCode  MatMultEqual(Mat,Mat,PetscInt,PetscTruth*);
515: EXTERN PetscErrorCode  MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*);
516: EXTERN PetscErrorCode  MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*);
517: EXTERN PetscErrorCode  MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*);

519: EXTERN PetscErrorCode  MatNorm(Mat,NormType,PetscReal *);
520: PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n)
521: EXTERN PetscErrorCode  MatZeroEntries(Mat);
522: EXTERN PetscErrorCode  MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar);
523: EXTERN PetscErrorCode  MatZeroRowsIS(Mat,IS,PetscScalar);
524: EXTERN PetscErrorCode  MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*);
525: EXTERN PetscErrorCode  MatZeroColumnsIS(Mat,IS,const PetscScalar*);

527: EXTERN PetscErrorCode  MatUseScaledForm(Mat,PetscTruth);
528: EXTERN PetscErrorCode  MatScaleSystem(Mat,Vec,Vec);
529: EXTERN PetscErrorCode  MatUnScaleSystem(Mat,Vec,Vec);

531: EXTERN PetscErrorCode  MatGetSize(Mat,PetscInt*,PetscInt*);
532: EXTERN PetscErrorCode  MatGetLocalSize(Mat,PetscInt*,PetscInt*);
533: EXTERN PetscErrorCode  MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
534: EXTERN PetscErrorCode  MatGetOwnershipRanges(Mat,const PetscInt**);
535: EXTERN PetscErrorCode  MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
536: EXTERN PetscErrorCode  MatGetOwnershipRangesColumn(Mat,const PetscInt**);

538: EXTERN PetscErrorCode  MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
539: EXTERN PetscErrorCode  MatDestroyMatrices(PetscInt,Mat *[]);
540: EXTERN PetscErrorCode  MatGetSubMatrix(Mat,IS,IS,PetscInt,MatReuse,Mat *);
541: EXTERN PetscErrorCode  MatGetSubMatrixRaw(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt,MatReuse,Mat *);
542: EXTERN PetscErrorCode  MatGetSeqNonzeroStructure(Mat,Mat *[]);
543: EXTERN PetscErrorCode  MatDestroySeqNonzeroStructure(Mat *[]);

545: EXTERN PetscErrorCode  MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
546: EXTERN PetscErrorCode  MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
547: EXTERN PetscErrorCode  MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
548: EXTERN PetscErrorCode  MatMerge_SeqsToMPINumeric(Mat,Mat);
549: EXTERN PetscErrorCode  MatDestroy_MPIAIJ_SeqsToMPI(Mat);
550: EXTERN PetscErrorCode  MatGetLocalMat(Mat,MatReuse,Mat*);
551: EXTERN PetscErrorCode  MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
552: EXTERN PetscErrorCode  MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*);
553: EXTERN PetscErrorCode  MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,MatScalar**,Mat*);
554: #if defined (PETSC_USE_CTABLE)
555:  #include petscctable.h
556: EXTERN PetscErrorCode  MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
557: #else
558: EXTERN PetscErrorCode  MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
559: #endif

561: EXTERN PetscErrorCode  MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);

563: EXTERN PetscErrorCode  MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
564: EXTERN PetscErrorCode  MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
565: EXTERN PetscErrorCode  MatMatMultNumeric(Mat,Mat,Mat);

567: EXTERN PetscErrorCode  MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
568: EXTERN PetscErrorCode  MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
569: EXTERN PetscErrorCode  MatPtAPNumeric(Mat,Mat,Mat);

571: EXTERN PetscErrorCode  MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*);
572: EXTERN PetscErrorCode  MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*);
573: EXTERN PetscErrorCode  MatMatMultTransposeNumeric(Mat,Mat,Mat);

575: EXTERN PetscErrorCode  MatAXPY(Mat,PetscScalar,Mat,MatStructure);
576: EXTERN PetscErrorCode  MatAYPX(Mat,PetscScalar,Mat,MatStructure);
577: EXTERN PetscErrorCode  MatCompress(Mat);

579: EXTERN PetscErrorCode  MatScale(Mat,PetscScalar);
580: EXTERN PetscErrorCode  MatShift(Mat,PetscScalar);

582: EXTERN PetscErrorCode  MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping);
583: EXTERN PetscErrorCode  MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping);
584: EXTERN PetscErrorCode  MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar);
585: EXTERN PetscErrorCode  MatZeroRowsLocalIS(Mat,IS,PetscScalar);
586: EXTERN PetscErrorCode  MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
587: EXTERN PetscErrorCode  MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);

589: EXTERN PetscErrorCode  MatStashSetInitialSize(Mat,PetscInt,PetscInt);
590: EXTERN PetscErrorCode  MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);

592: EXTERN PetscErrorCode  MatInterpolate(Mat,Vec,Vec);
593: EXTERN PetscErrorCode  MatInterpolateAdd(Mat,Vec,Vec,Vec);
594: PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y))
595: EXTERN PetscErrorCode  MatRestrict(Mat,Vec,Vec);
596: EXTERN PetscErrorCode  MatGetVecs(Mat,Vec*,Vec*);
597: EXTERN PetscErrorCode  MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);

599: /*MC
600:    MatSetValue - Set a single entry into a matrix.

602:    Not collective

604:    Input Parameters:
605: +  m - the matrix
606: .  row - the row location of the entry
607: .  col - the column location of the entry
608: .  value - the value to insert
609: -  mode - either INSERT_VALUES or ADD_VALUES

611:    Notes: 
612:    For efficiency one should use MatSetValues() and set several or many
613:    values simultaneously if possible.

615:    Level: beginner

617: .seealso: MatSetValues(), MatSetValueLocal()
618: M*/
619: PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);}

621: PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}

623: PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);}

625: /*MC
626:    MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
627:        row in a matrix providing the data that one can use to correctly preallocate the matrix.

629:    Synopsis:
630:    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)

632:    Collective on MPI_Comm

634:    Input Parameters:
635: +  comm - the communicator that will share the eventually allocated matrix
636: .  nrows - the number of LOCAL rows in the matrix
637: -  ncols - the number of LOCAL columns in the matrix

639:    Output Parameters:
640: +  dnz - the array that will be passed to the matrix preallocation routines
641: -  ozn - the other array passed to the matrix preallocation routines


644:    Level: intermediate

646:    Notes:
647:    See the chapter in the users manual on performance for more details

649:    Do not malloc or free dnz and onz, that is handled internally by these routines

651:    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)

653:    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().

655:   Concepts: preallocation^Matrix

657: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
658:           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
659: M*/
660: #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
661: { \
662:   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
663:   _4_PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
664:   _4_PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
665:   _4_PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
666:   _4_MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
667:   _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;

669: /*MC
670:    MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per
671:        row in a matrix providing the data that one can use to correctly preallocate the matrix.

673:    Synopsis:
674:    PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)

676:    Collective on MPI_Comm

678:    Input Parameters:
679: +  comm - the communicator that will share the eventually allocated matrix
680: .  nrows - the number of LOCAL rows in the matrix
681: -  ncols - the number of LOCAL columns in the matrix

683:    Output Parameters:
684: +  dnz - the array that will be passed to the matrix preallocation routines
685: -  ozn - the other array passed to the matrix preallocation routines


688:    Level: intermediate

690:    Notes:
691:    See the chapter in the users manual on performance for more details

693:    Do not malloc or free dnz and onz, that is handled internally by these routines

695:    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().

697:   Concepts: preallocation^Matrix

699: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
700:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
701: M*/
702: #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \
703: { \
704:   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__end; \
705:   _4_PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
706:   _4_PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
707:   _4_PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
708:   _4_MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\
709:   _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;

711: /*MC
712:    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
713:        inserted using a local number of the rows and columns

715:    Synopsis:
716:    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

718:    Not Collective

720:    Input Parameters:
721: +  map - the mapping between local numbering and global numbering
722: .  nrows - the number of rows indicated
723: .  rows - the indices of the rows 
724: .  ncols - the number of columns in the matrix
725: .  cols - the columns indicated
726: .  dnz - the array that will be passed to the matrix preallocation routines
727: -  ozn - the other array passed to the matrix preallocation routines


730:    Level: intermediate

732:    Notes:
733:    See the chapter in the users manual on performance for more details

735:    Do not malloc or free dnz and onz, that is handled internally by these routines

737:   Concepts: preallocation^Matrix

739: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
740:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
741: M*/
742: #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
743: {\
744:   PetscInt __l;\
745:   _4_ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
746:   _4_ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
747:   for (__l=0;__l<nrows;__l++) {\
748:     _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
749:   }\
750: }
751: 
752: /*MC
753:    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
754:        inserted using a local number of the rows and columns

756:    Synopsis:
757:    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

759:    Not Collective

761:    Input Parameters:
762: +  map - the mapping between local numbering and global numbering
763: .  nrows - the number of rows indicated
764: .  rows - the indices of the rows 
765: .  ncols - the number of columns in the matrix
766: .  cols - the columns indicated
767: .  dnz - the array that will be passed to the matrix preallocation routines
768: -  ozn - the other array passed to the matrix preallocation routines


771:    Level: intermediate

773:    Notes:
774:    See the chapter in the users manual on performance for more details

776:    Do not malloc or free dnz and onz that is handled internally by these routines

778:   Concepts: preallocation^Matrix

780: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
781:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
782: M*/
783: #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
784: {\
785:   PetscInt __l;\
786:   _4_ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
787:   _4_ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
788:   for (__l=0;__l<nrows;__l++) {\
789:     _4_MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
790:   }\
791: }

793: /*MC
794:    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
795:        inserted using a local number of the rows and columns

797:    Synopsis:
798:    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

800:    Not Collective

802:    Input Parameters:
803: +  row - the row
804: .  ncols - the number of columns in the matrix
805: -  cols - the columns indicated

807:    Output Parameters:
808: +  dnz - the array that will be passed to the matrix preallocation routines
809: -  ozn - the other array passed to the matrix preallocation routines


812:    Level: intermediate

814:    Notes:
815:    See the chapter in the users manual on performance for more details

817:    Do not malloc or free dnz and onz that is handled internally by these routines

819:    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().

821:   Concepts: preallocation^Matrix

823: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
824:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
825: M*/
826: #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
827: { PetscInt __i; \
828:   if (row < __rstart) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\
829:   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);\
830:   for (__i=0; __i<nc; __i++) {\
831:     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
832:     else dnz[row - __rstart]++;\
833:   }\
834: }

836: /*MC
837:    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
838:        inserted using a local number of the rows and columns

840:    Synopsis:
841:    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

843:    Not Collective

845:    Input Parameters:
846: +  nrows - the number of rows indicated
847: .  rows - the indices of the rows 
848: .  ncols - the number of columns in the matrix
849: .  cols - the columns indicated
850: .  dnz - the array that will be passed to the matrix preallocation routines
851: -  ozn - the other array passed to the matrix preallocation routines


854:    Level: intermediate

856:    Notes:
857:    See the chapter in the users manual on performance for more details

859:    Do not malloc or free dnz and onz that is handled internally by these routines

861:    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().

863:   Concepts: preallocation^Matrix

865: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
866:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
867: M*/
868: #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
869: { PetscInt __i; \
870:   for (__i=0; __i<nc; __i++) {\
871:     if (cols[__i] >= __end) onz[row - __rstart]++; \
872:     else if (cols[__i] >= row) dnz[row - __rstart]++;\
873:   }\
874: }

876: /*MC
877:    MatPreallocateLocation -  An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists

879:    Synopsis:
880:    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)

882:    Not Collective

884:    Input Parameters:
885: .  A - matrix
886: .  row - row where values exist (must be local to this process)
887: .  ncols - number of columns
888: .  cols - columns with nonzeros
889: .  dnz - the array that will be passed to the matrix preallocation routines
890: -  ozn - the other array passed to the matrix preallocation routines


893:    Level: intermediate

895:    Notes:
896:    See the chapter in the users manual on performance for more details

898:    Do not malloc or free dnz and onz that is handled internally by these routines

900:    This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.

902:   Concepts: preallocation^Matrix

904: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
905:           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
906: M*/
907: #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);}


910: /*MC
911:    MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
912:        row in a matrix providing the data that one can use to correctly preallocate the matrix.

914:    Synopsis:
915:    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)

917:    Collective on MPI_Comm

919:    Input Parameters:
920: +  dnz - the array that was be passed to the matrix preallocation routines
921: -  ozn - the other array passed to the matrix preallocation routines


924:    Level: intermediate

926:    Notes:
927:    See the chapter in the users manual on performance for more details

929:    Do not malloc or free dnz and onz that is handled internally by these routines

931:    This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().

933:   Concepts: preallocation^Matrix

935: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
936:           MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal()
937: M*/
938: #define MatPreallocateFinalize(dnz,onz) 0;_4_PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}



942: /* Routines unique to particular data structures */
943: EXTERN PetscErrorCode  MatShellGetContext(Mat,void **);
944: PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t)

946: EXTERN PetscErrorCode  MatInodeAdjustForInodes(Mat,IS*,IS*);
947: EXTERN PetscErrorCode  MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);

949: EXTERN PetscErrorCode  MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
950: EXTERN PetscErrorCode  MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
951: EXTERN PetscErrorCode  MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
952: EXTERN PetscErrorCode  MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
953: EXTERN PetscErrorCode  MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);

955: #define MAT_SKIP_ALLOCATION -4

957: EXTERN PetscErrorCode  MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
958: PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
959: EXTERN PetscErrorCode  MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
960: PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz))
961: EXTERN PetscErrorCode  MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
962: PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz))

964: EXTERN PetscErrorCode  MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
965: PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz))
966: EXTERN PetscErrorCode  MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
967: EXTERN PetscErrorCode  MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
968: EXTERN PetscErrorCode  MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
969: EXTERN PetscErrorCode  MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
970: EXTERN PetscErrorCode  MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
971: EXTERN PetscErrorCode  MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
972: EXTERN PetscErrorCode  MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
973: EXTERN PetscErrorCode  MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
974: EXTERN PetscErrorCode  MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
975: EXTERN PetscErrorCode  MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]);
976: EXTERN PetscErrorCode  MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
977: EXTERN PetscErrorCode  MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
978: EXTERN PetscErrorCode  MatAdicSetLocalFunction(Mat,void (*)(void));

980: EXTERN PetscErrorCode  MatSeqDenseSetLDA(Mat,PetscInt);
981: EXTERN PetscErrorCode  MatDenseGetLocalMatrix(Mat,Mat*);

983: EXTERN PetscErrorCode  MatStoreValues(Mat);
984: EXTERN PetscErrorCode  MatRetrieveValues(Mat);

986: EXTERN PetscErrorCode  MatDAADSetCtx(Mat,void*);

988: /* 
989:   These routines are not usually accessed directly, rather solving is 
990:   done through the KSP and PC interfaces.
991: */

993: /*E
994:     MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
995:        with an optional dynamic library name, for example 
996:        http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()

998:    Level: beginner

1000:    Cannot use const because the PC objects manipulate the string

1002: .seealso: MatGetOrdering()
1003: E*/
1004: #define MatOrderingType char*
1005: #define MATORDERING_NATURAL   "natural"
1006: #define MATORDERING_ND        "nd"
1007: #define MATORDERING_1WD       "1wd"
1008: #define MATORDERING_RCM       "rcm"
1009: #define MATORDERING_QMD       "qmd"
1010: #define MATORDERING_ROWLENGTH "rowlength"
1011: #define MATORDERING_DSC_ND    "dsc_nd"
1012: #define MATORDERING_DSC_MMD   "dsc_mmd"
1013: #define MATORDERING_DSC_MDF   "dsc_mdf"
1014: #define MATORDERING_CONSTRAINED "constrained"
1015: #define MATORDERING_IDENTITY  "identity"
1016: #define MATORDERING_REVERSE   "reverse"

1018: EXTERN PetscErrorCode  MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
1019: EXTERN PetscErrorCode  MatGetOrderingList(PetscFList *list);
1020: EXTERN PetscErrorCode  MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));

1022: /*MC
1023:    MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the 
1024:                                matrix package. 

1026:    Synopsis:
1027:    PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering))

1029:    Not Collective

1031:    Input Parameters:
1032: +  sname - name of ordering (for example MATORDERING_ND)
1033: .  path - location of library where creation routine is 
1034: .  name - name of function that creates the ordering type,a string
1035: -  function - function pointer that creates the ordering

1037:    Level: developer

1039:    If dynamic libraries are used, then the fourth input argument (function)
1040:    is ignored.

1042:    Sample usage:
1043: .vb
1044:    MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
1045:                "MyOrder",MyOrder);
1046: .ve

1048:    Then, your partitioner can be chosen with the procedural interface via
1049: $     MatOrderingSetType(part,"my_order)
1050:    or at runtime via the option
1051: $     -pc_factor_mat_ordering_type my_order

1053:    ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.

1055: .keywords: matrix, ordering, register

1057: .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
1058: M*/
1059: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1060: #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
1061: #else
1062: #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
1063: #endif

1065: EXTERN PetscErrorCode  MatOrderingRegisterDestroy(void);
1066: EXTERN PetscErrorCode  MatOrderingRegisterAll(const char[]);

1070: EXTERN PetscErrorCode  MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);

1072: /*S 
1073:    MatFactorInfo - Data passed into the matrix factorization routines

1075:    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
1076: $     MatFactorInfo  info(MAT_FACTORINFO_SIZE)

1078:    Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.

1080:       You can use MatFactorInfoInitialize() to set default values.

1082:    Level: developer

1084: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 
1085:           MatFactorInfoInitialize()

1087: S*/
1088: typedef struct {
1089:   PetscReal     shiftnz;        /* scaling of identity added to matrix to prevent zero pivots */
1090:   PetscReal     shiftpd;        /* if true, shift until positive pivots */
1091:   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
1092:   PetscReal     usedt;
1093:   PetscReal     dt;             /* drop tolerance */
1094:   PetscReal     dtcol;          /* tolerance for pivoting */
1095:   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
1096:   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1097:   PetscReal     levels;         /* ICC/ILU(levels) */
1098:   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 
1099:                                    factorization may be faster if do not pivot */
1100:   PetscReal     shiftinblocks;  /* if block in block factorization has zero pivot then shift diagonal until non-singular */
1101:   PetscReal     zeropivot;      /* pivot is called zero if less than this */
1102: } MatFactorInfo;

1104: EXTERN PetscErrorCode  MatFactorInfoInitialize(MatFactorInfo*);
1105: EXTERN PetscErrorCode  MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
1106: EXTERN PetscErrorCode  MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1107: EXTERN PetscErrorCode  MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
1108: EXTERN PetscErrorCode  MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
1109: EXTERN PetscErrorCode  MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
1110: EXTERN PetscErrorCode  MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1111: EXTERN PetscErrorCode  MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1112: EXTERN PetscErrorCode  MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1113: EXTERN PetscErrorCode  MatICCFactor(Mat,IS,const MatFactorInfo*);
1114: EXTERN PetscErrorCode  MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1115: EXTERN PetscErrorCode  MatILUDTFactor(Mat,IS,IS,const MatFactorInfo*,Mat *);
1116: EXTERN PetscErrorCode  MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1117: EXTERN PetscErrorCode  MatSolve(Mat,Vec,Vec);
1118: EXTERN PetscErrorCode  MatForwardSolve(Mat,Vec,Vec);
1119: EXTERN PetscErrorCode  MatBackwardSolve(Mat,Vec,Vec);
1120: EXTERN PetscErrorCode  MatSolveAdd(Mat,Vec,Vec,Vec);
1121: EXTERN PetscErrorCode  MatSolveTranspose(Mat,Vec,Vec);
1122: EXTERN PetscErrorCode  MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1123: EXTERN PetscErrorCode  MatSolves(Mat,Vecs,Vecs);

1125: EXTERN PetscErrorCode  MatSetUnfactored(Mat);

1127: /*E
1128:     MatSORType - What type of (S)SOR to perform

1130:     Level: beginner

1132:    May be bitwise ORd together

1134:    Any additions/changes here MUST also be made in include/finclude/petscmat.h

1136:    MatSORType may be bitwise ORd together, so do not change the numbers 

1138: .seealso: MatRelax(), MatPBRelax()
1139: E*/
1140: typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1141:               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1142:               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1143:               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1144: EXTERN PetscErrorCode  MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1145: EXTERN PetscErrorCode  MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);

1147: /* 
1148:     These routines are for efficiently computing Jacobians via finite differences.
1149: */

1151: /*E
1152:     MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1153:        with an optional dynamic library name, for example 
1154:        http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()

1156:    Level: beginner

1158: .seealso: MatGetColoring()
1159: E*/
1160: #define MatColoringType char*
1161: #define MATCOLORING_NATURAL "natural"
1162: #define MATCOLORING_SL      "sl"
1163: #define MATCOLORING_LF      "lf"
1164: #define MATCOLORING_ID      "id"

1166: EXTERN PetscErrorCode  MatGetColoring(Mat,const MatColoringType,ISColoring*);
1167: EXTERN PetscErrorCode  MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *));

1169: /*MC
1170:    MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the 
1171:                                matrix package. 

1173:    Synopsis:
1174:    PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring))

1176:    Not Collective

1178:    Input Parameters:
1179: +  sname - name of Coloring (for example MATCOLORING_SL)
1180: .  path - location of library where creation routine is 
1181: .  name - name of function that creates the Coloring type, a string
1182: -  function - function pointer that creates the coloring

1184:    Level: developer

1186:    If dynamic libraries are used, then the fourth input argument (function)
1187:    is ignored.

1189:    Sample usage:
1190: .vb
1191:    MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
1192:                "MyColor",MyColor);
1193: .ve

1195:    Then, your partitioner can be chosen with the procedural interface via
1196: $     MatColoringSetType(part,"my_color")
1197:    or at runtime via the option
1198: $     -mat_coloring_type my_color

1200:    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.

1202: .keywords: matrix, Coloring, register

1204: .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
1205: M*/
1206: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1207: #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1208: #else
1209: #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1210: #endif


1214: EXTERN PetscErrorCode  MatColoringRegisterAll(const char[]);
1215: EXTERN PetscErrorCode  MatColoringRegisterDestroy(void);
1216: EXTERN PetscErrorCode  MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);

1218: /*S
1219:      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1220:         and coloring

1222:    Level: beginner

1224:   Concepts: coloring, sparse Jacobian, finite differences

1226: .seealso:  MatFDColoringCreate()
1227: S*/
1228: typedef struct _p_MatFDColoring* MatFDColoring;

1230: EXTERN PetscErrorCode  MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1231: EXTERN PetscErrorCode  MatFDColoringDestroy(MatFDColoring);
1232: EXTERN PetscErrorCode  MatFDColoringView(MatFDColoring,PetscViewer);
1233: EXTERN PetscErrorCode  MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1234: EXTERN PetscErrorCode  MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1235: EXTERN PetscErrorCode  MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1236: EXTERN PetscErrorCode  MatFDColoringSetFromOptions(MatFDColoring);
1237: EXTERN PetscErrorCode  MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1238: EXTERN PetscErrorCode  MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *);
1239: EXTERN PetscErrorCode  MatFDColoringSetF(MatFDColoring,Vec);
1240: EXTERN PetscErrorCode  MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1241: /* 
1242:     These routines are for partitioning matrices: currently used only 
1243:   for adjacency matrix, MatCreateMPIAdj().
1244: */

1246: /*S
1247:      MatPartitioning - Object for managing the partitioning of a matrix or graph

1249:    Level: beginner

1251:   Concepts: partitioning

1253: .seealso:  MatPartitioningCreate(), MatPartitioningType
1254: S*/
1255: typedef struct _p_MatPartitioning* MatPartitioning;

1257: /*E
1258:     MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1259:        with an optional dynamic library name, for example 
1260:        http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()

1262:    Level: beginner

1264: .seealso: MatPartitioningCreate(), MatPartitioning
1265: E*/
1266: #define MatPartitioningType char*
1267: #define MAT_PARTITIONING_CURRENT  "current"
1268: #define MAT_PARTITIONING_SQUARE   "square"
1269: #define MAT_PARTITIONING_PARMETIS "parmetis"
1270: #define MAT_PARTITIONING_CHACO    "chaco"
1271: #define MAT_PARTITIONING_JOSTLE   "jostle"
1272: #define MAT_PARTITIONING_PARTY    "party"
1273: #define MAT_PARTITIONING_SCOTCH   "scotch"


1276: EXTERN PetscErrorCode  MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1277: EXTERN PetscErrorCode  MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1278: EXTERN PetscErrorCode  MatPartitioningSetNParts(MatPartitioning,PetscInt);
1279: EXTERN PetscErrorCode  MatPartitioningSetAdjacency(MatPartitioning,Mat);
1280: EXTERN PetscErrorCode  MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1281: EXTERN PetscErrorCode  MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1282: EXTERN PetscErrorCode  MatPartitioningApply(MatPartitioning,IS*);
1283: EXTERN PetscErrorCode  MatPartitioningDestroy(MatPartitioning);

1285: EXTERN PetscErrorCode  MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));

1287: /*MC
1288:    MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the 
1289:    matrix package. 

1291:    Synopsis:
1292:    PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))

1294:    Not Collective

1296:    Input Parameters:
1297: +  sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis
1298: .  path - location of library where creation routine is 
1299: .  name - name of function that creates the partitioning type, a string
1300: -  function - function pointer that creates the partitioning type

1302:    Level: developer

1304:    If dynamic libraries are used, then the fourth input argument (function)
1305:    is ignored.

1307:    Sample usage:
1308: .vb
1309:    MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
1310:                "MyPartCreate",MyPartCreate);
1311: .ve

1313:    Then, your partitioner can be chosen with the procedural interface via
1314: $     MatPartitioningSetType(part,"my_part")
1315:    or at runtime via the option
1316: $     -mat_partitioning_type my_part

1318:    $PETSC_ARCH occuring in pathname will be replaced with appropriate values.

1320: .keywords: matrix, partitioning, register

1322: .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
1323: M*/
1324: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1325: #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
1326: #else
1327: #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
1328: #endif


1332: EXTERN PetscErrorCode  MatPartitioningRegisterAll(const char[]);
1333: EXTERN PetscErrorCode  MatPartitioningRegisterDestroy(void);

1335: EXTERN PetscErrorCode  MatPartitioningView(MatPartitioning,PetscViewer);
1336: EXTERN PetscErrorCode  MatPartitioningSetFromOptions(MatPartitioning);
1337: EXTERN PetscErrorCode  MatPartitioningGetType(MatPartitioning,const MatPartitioningType*);

1339: EXTERN PetscErrorCode  MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1340: EXTERN PetscErrorCode  MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);

1342: EXTERN PetscErrorCode  MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal);
1343: EXTERN PetscErrorCode  MatPartitioningJostleSetCoarseSequential(MatPartitioning);

1345: typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType;
1346: EXTERN PetscErrorCode  MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType);
1347: typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType;
1348: EXTERN PetscErrorCode  MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType);
1349: EXTERN PetscErrorCode  MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1350: typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType;
1351: EXTERN PetscErrorCode  MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1352: EXTERN PetscErrorCode  MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal);
1353: EXTERN PetscErrorCode  MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt);

1355: #define MP_PARTY_OPT "opt"
1356: #define MP_PARTY_LIN "lin"
1357: #define MP_PARTY_SCA "sca"
1358: #define MP_PARTY_RAN "ran"
1359: #define MP_PARTY_GBF "gbf"
1360: #define MP_PARTY_GCF "gcf"
1361: #define MP_PARTY_BUB "bub"
1362: #define MP_PARTY_DEF "def"
1363: EXTERN PetscErrorCode  MatPartitioningPartySetGlobal(MatPartitioning, const char*);
1364: #define MP_PARTY_HELPFUL_SETS "hs"
1365: #define MP_PARTY_KERNIGHAN_LIN "kl"
1366: #define MP_PARTY_NONE "no"
1367: EXTERN PetscErrorCode  MatPartitioningPartySetLocal(MatPartitioning, const char*);
1368: EXTERN PetscErrorCode  MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1369: EXTERN PetscErrorCode  MatPartitioningPartySetBipart(MatPartitioning,PetscTruth);
1370: EXTERN PetscErrorCode  MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth);

1372: typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType;
1373: EXTERN PetscErrorCode  MatPartitioningScotchSetArch(MatPartitioning,const char*);
1374: EXTERN PetscErrorCode  MatPartitioningScotchSetMultilevel(MatPartitioning);
1375: EXTERN PetscErrorCode  MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType);
1376: EXTERN PetscErrorCode  MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal);
1377: EXTERN PetscErrorCode  MatPartitioningScotchSetHostList(MatPartitioning,const char*);
1378: typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType;
1379: EXTERN PetscErrorCode  MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType);
1380: EXTERN PetscErrorCode  MatPartitioningScotchSetMapping(MatPartitioning);
1381: EXTERN PetscErrorCode  MatPartitioningScotchSetStrategy(MatPartitioning,char*);

1383: /*
1384:     If you add entries here you must also add them to finclude/petscmat.h
1385: */
1386: typedef enum { MATOP_SET_VALUES=0,
1387:                MATOP_GET_ROW=1,
1388:                MATOP_RESTORE_ROW=2,
1389:                MATOP_MULT=3,
1390:                MATOP_MULT_ADD=4,
1391:                MATOP_MULT_TRANSPOSE=5,
1392:                MATOP_MULT_TRANSPOSE_ADD=6,
1393:                MATOP_SOLVE=7,
1394:                MATOP_SOLVE_ADD=8,
1395:                MATOP_SOLVE_TRANSPOSE=9,
1396:                MATOP_SOLVE_TRANSPOSE_ADD=10,
1397:                MATOP_LUFACTOR=11,
1398:                MATOP_CHOLESKYFACTOR=12,
1399:                MATOP_RELAX=13,
1400:                MATOP_TRANSPOSE=14,
1401:                MATOP_GETINFO=15,
1402:                MATOP_EQUAL=16,
1403:                MATOP_GET_DIAGONAL=17,
1404:                MATOP_DIAGONAL_SCALE=18,
1405:                MATOP_NORM=19,
1406:                MATOP_ASSEMBLY_BEGIN=20,
1407:                MATOP_ASSEMBLY_END=21,
1408:                MATOP_COMPRESS=22,
1409:                MATOP_SET_OPTION=23,
1410:                MATOP_ZERO_ENTRIES=24,
1411:                MATOP_ZERO_ROWS=25,
1412:                MATOP_LUFACTOR_SYMBOLIC=26,
1413:                MATOP_LUFACTOR_NUMERIC=27,
1414:                MATOP_CHOLESKY_FACTOR_SYMBOLIC=28,
1415:                MATOP_CHOLESKY_FACTOR_NUMERIC=29,
1416:                MATOP_SETUP_PREALLOCATION=30,
1417:                MATOP_ILUFACTOR_SYMBOLIC=31,
1418:                MATOP_ICCFACTOR_SYMBOLIC=32,
1419:                MATOP_GET_ARRAY=33,
1420:                MATOP_RESTORE_ARRAY=34,
1421:                MATOP_DUPLICATE=35,
1422:                MATOP_FORWARD_SOLVE=36,
1423:                MATOP_BACKWARD_SOLVE=37,
1424:                MATOP_ILUFACTOR=38,
1425:                MATOP_ICCFACTOR=39,
1426:                MATOP_AXPY=40,
1427:                MATOP_GET_SUBMATRICES=41,
1428:                MATOP_INCREASE_OVERLAP=42,
1429:                MATOP_GET_VALUES=43,
1430:                MATOP_COPY=44,
1431:                MATOP_GET_ROW_MAX=45,
1432:                MATOP_SCALE=46,
1433:                MATOP_SHIFT=47,
1434:                MATOP_DIAGONAL_SHIFT=48,
1435:                MATOP_ILUDT_FACTOR=49,
1436:                MATOP_SET_BLOCK_SIZE=50,
1437:                MATOP_GET_ROW_IJ=51,
1438:                MATOP_RESTORE_ROW_IJ=52,
1439:                MATOP_GET_COLUMN_IJ=53,
1440:                MATOP_RESTORE_COLUMN_IJ=54,
1441:                MATOP_FDCOLORING_CREATE=55,
1442:                MATOP_COLORING_PATCH=56,
1443:                MATOP_SET_UNFACTORED=57,
1444:                MATOP_PERMUTE=58,
1445:                MATOP_SET_VALUES_BLOCKED=59,
1446:                MATOP_GET_SUBMATRIX=60,
1447:                MATOP_DESTROY=61,
1448:                MATOP_VIEW=62,
1449:                MATOP_CONVERT_FROM=63,
1450:                MATOP_USE_SCALED_FORM=64,
1451:                MATOP_SCALE_SYSTEM=65,
1452:                MATOP_UNSCALE_SYSTEM=66,
1453:                MATOP_SET_LOCAL_TO_GLOBAL_MAP=67,
1454:                MATOP_SET_VALUES_LOCAL=68,
1455:                MATOP_ZERO_ROWS_LOCAL=69,
1456:                MATOP_GET_ROW_MAX_ABS=70,
1457:                MATOP_GET_ROW_MIN_ABS=71,
1458:                MATOP_CONVERT=72,
1459:                MATOP_SET_COLORING=73,
1460:                MATOP_SET_VALUES_ADIC=74,
1461:                MATOP_SET_VALUES_ADIFOR=75,
1462:                MATOP_FD_COLORING_APPLY=76,
1463:                MATOP_SET_FROM_OPTIONS=77,
1464:                MATOP_MULT_CON=78,
1465:                MATOP_MULT_TRANSPOSE_CON=79,
1466:                MATOP_PERMUTE_SPARSIFY=80,
1467:                MATOP_MULT_MULTIPLE=81,
1468:                MATOP_SOLVE_MULTIPLE=82,
1469:                MATOP_GET_INERTIA=83,
1470:                MATOP_LOAD=84,
1471:                MATOP_IS_SYMMETRIC=85,
1472:                MATOP_IS_HERMITIAN=86,
1473:                MATOP_IS_STRUCTURALLY_SYMMETRIC=87,
1474:                MATOP_PB_RELAX=88,
1475:                MATOP_GET_VECS=89,
1476:                MATOP_MAT_MULT=90,
1477:                MATOP_MAT_MULT_SYMBOLIC=91,
1478:                MATOP_MAT_MULT_NUMERIC=92,
1479:                MATOP_PTAP=93,
1480:                MATOP_PTAP_SYMBOLIC=94,
1481:                MATOP_PTAP_NUMERIC=95,
1482:                MATOP_MAT_MULTTRANSPOSE=96,
1483:                MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=97,
1484:                MATOP_MAT_MULTTRANSPOSE_NUMERIC=98,
1485:                MATOP_PTAP_SYMBOLIC_SEQAIJ=99,
1486:                MATOP_PTAP_NUMERIC_SEQAIJ=100,
1487:                MATOP_PTAP_SYMBOLIC_MPIAIJ=101,
1488:                MATOP_PTAP_NUMERIC_MPIAIJ=102,
1489:                MATOP_CONJUGATE=103,
1490:                MATOP_SET_SIZES=104,
1491:                MATOP_SET_VALUES_ROW = 105,
1492:                MATOP_REAL_PART=106,
1493:                MATOP_IMAG_PART=107,
1494:                MATOP_GET_ROW_UTRIANGULAR=108,
1495:                MATOP_RESTORE_ROW_UTRIANGULAR=109,
1496:                MATOP_MATSOLVE=110,
1497:                MATOP_GET_REDUNDANTMATRIX=111,
1498:                MATOP_GET_ROW_MIN=112,
1499:                MATOP_GET_COLUMN_VEC=113,
1500:                MATOP_MISSING_DIAGONAL=114,
1501:                MATOP_MATGETSEQNONZEROSTRUCTURE=115,
1502:                MATOP_DESTROY_SOLVER=116
1503:              } MatOperation;
1504: EXTERN PetscErrorCode  MatHasOperation(Mat,MatOperation,PetscTruth*);
1505: EXTERN PetscErrorCode  MatShellSetOperation(Mat,MatOperation,void(*)(void));
1506: EXTERN PetscErrorCode  MatShellGetOperation(Mat,MatOperation,void(**)(void));
1507: EXTERN PetscErrorCode  MatShellSetContext(Mat,void*);

1509: /*
1510:    Codes for matrices stored on disk. By default they are
1511:  stored in a universal format. By changing the format with 
1512:  PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1513:  be stored in a way natural for the matrix, for example dense matrices
1514:  would be stored as dense. Matrices stored this way may only be
1515:  read into matrices of the same time.
1516: */
1517: #define MATRIX_BINARY_FORMAT_DENSE -1

1519: EXTERN PetscErrorCode  MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1520: EXTERN PetscErrorCode  MatISGetLocalMat(Mat,Mat*);

1522: /*S
1523:      MatNullSpace - Object that removes a null space from a vector, i.e.
1524:          orthogonalizes the vector to a subsapce

1526:    Level: advanced

1528:   Concepts: matrix; linear operator, null space

1530:   Users manual sections:
1531: .   Section 4.15 Solving Singular Systems

1533: .seealso:  MatNullSpaceCreate()
1534: S*/
1535: typedef struct _p_MatNullSpace* MatNullSpace;

1537: EXTERN PetscErrorCode  MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*);
1538: EXTERN PetscErrorCode  MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(Vec,void*),void*);
1539: EXTERN PetscErrorCode  MatNullSpaceDestroy(MatNullSpace);
1540: EXTERN PetscErrorCode  MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1541: EXTERN PetscErrorCode  MatNullSpaceAttach(Mat,MatNullSpace);
1542: EXTERN PetscErrorCode  MatNullSpaceTest(MatNullSpace,Mat,PetscTruth *);

1544: EXTERN PetscErrorCode  MatReorderingSeqSBAIJ(Mat,IS);
1545: EXTERN PetscErrorCode  MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1546: EXTERN PetscErrorCode  MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1547: EXTERN PetscErrorCode  MatSeqBAIJInvertBlockDiagonal(Mat);

1549: EXTERN PetscErrorCode  MatCreateMAIJ(Mat,PetscInt,Mat*);
1550: EXTERN PetscErrorCode  MatMAIJRedimension(Mat,PetscInt,Mat*);
1551: EXTERN PetscErrorCode  MatMAIJGetAIJ(Mat,Mat*);

1553: EXTERN PetscErrorCode  MatComputeExplicitOperator(Mat,Mat*);

1555: EXTERN PetscErrorCode  MatDiagonalScaleLocal(Mat,Vec);

1557: EXTERN PetscErrorCode  MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1558: EXTERN PetscErrorCode  MatMFFDSetBase(Mat,Vec,Vec);
1559: EXTERN PetscErrorCode  MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1560: EXTERN PetscErrorCode  MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1561: EXTERN PetscErrorCode  MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1562: EXTERN PetscErrorCode  MatMFFDAddNullSpace(Mat,MatNullSpace);
1563: EXTERN PetscErrorCode  MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1564: EXTERN PetscErrorCode  MatMFFDResetHHistory(Mat);
1565: EXTERN PetscErrorCode  MatMFFDSetFunctionError(Mat,PetscReal);
1566: EXTERN PetscErrorCode  MatMFFDSetPeriod(Mat,PetscInt);
1567: EXTERN PetscErrorCode  MatMFFDGetH(Mat,PetscScalar *);
1568: EXTERN PetscErrorCode  MatMFFDSetFromOptions(Mat);
1569: EXTERN PetscErrorCode  MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1570: EXTERN PetscErrorCode  MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1571: EXTERN PetscErrorCode  MatMFFDDSSetUmin(Mat,PetscReal);


1574: typedef struct _p_MatMFFD* MatMFFD;

1576: /*E
1577:     MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function

1579:    Level: beginner

1581: .seealso: MatMFFDSetType(), MatMFFDRegister()
1582: E*/
1583: #define MatMFFDType char*
1584: #define MATMFFD_DS  "ds"
1585: #define MATMFFD_WP  "wp"

1587: EXTERN PetscErrorCode  MatMFFDSetType(Mat,const MatMFFDType);
1588: EXTERN PetscErrorCode  MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD));

1590: /*MC
1591:    MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry.

1593:    Synopsis:
1594:    PetscErrorCode MatMFFDRegisterDynamic(char *name_solver,char *path,char *name_create,PetscErrorCode (*routine_create)(MatMFFD))

1596:    Not Collective

1598:    Input Parameters:
1599: +  name_solver - name of a new user-defined compute-h module
1600: .  path - path (either absolute or relative) the library containing this solver
1601: .  name_create - name of routine to create method context
1602: -  routine_create - routine to create method context

1604:    Level: developer

1606:    Notes:
1607:    MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers.

1609:    If dynamic libraries are used, then the fourth input argument (routine_create)
1610:    is ignored.

1612:    Sample usage:
1613: .vb
1614:    MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a,
1615:                "MyHCreate",MyHCreate);
1616: .ve

1618:    Then, your solver can be chosen with the procedural interface via
1619: $     MatMFFDSetType(mfctx,"my_h")
1620:    or at runtime via the option
1621: $     -snes_mf_type my_h

1623: .keywords: MatMFFD, register

1625: .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy()
1626: M*/
1627: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1628: #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0)
1629: #else
1630: #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d)
1631: #endif

1633: EXTERN PetscErrorCode  MatMFFDRegisterAll(const char[]);
1634: EXTERN PetscErrorCode  MatMFFDRegisterDestroy(void);
1635: EXTERN PetscErrorCode  MatMFFDDefaultSetUmin(Mat,PetscReal);
1636: EXTERN PetscErrorCode  MatMFFDWPSetComputeNormU(Mat,PetscTruth);


1639: EXTERN PetscErrorCode  PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1640: EXTERN PetscErrorCode  PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);

1643: #endif