MatProductSymbolic#

Perform the symbolic portion of a matrix-matrix product operation, this creates a data structure for use with the numerical product to be done with MatProductNumeric()

Synopsis#

#include "petscmat.h" 
PetscErrorCode MatProductSymbolic(Mat mat)

Collective

Input/Output Parameter#

mat - the matrix whose values are to be computed via a matrix-matrix product operation

Notes#

MatProductSetFromOptions() must have been called on mat before calling this function. For MATPRODUCT_AB and MATPRODUCT_AtB with AIJ inputs, setting MAT_STRUCTURE_ONLY on mat before MatProductSetFromOptions() requests an assembled graph without numerical values. These products use the native CPU symbolic algorithms (sorted for sequential AB, outerproduct for sequential AtB, and scalable for MPI products), overriding the selected algorithm, and return MATSEQAIJ or MATMPIAIJ, including for device AIJ inputs. Call MatProductClear() when the product context is no longer needed. MatProductNumeric() cannot be used on a structure-only result.