SALSA Analysis Modules
Use of the analysis modules

Library Initialization

There are calls AnaModInitialize() and AnaModFinalize() which do global allocation. These are necessary.

Category registration

Every category needs to be registered before use with a call

Register<Category>Modules();

where the available categores are Inverse Cuthill-McKee distribution, Intelligent Preconditioner Recommendation System, Jones-Plassmann multi-colouring, Estimates for the departure from normality, Simple (normlike) quantities, Spectral properties, Structural properties, Measurements of element variance. The functions AnaModRegisterStandardModules() installs all standard available modules.

Quantity computation

After registring a category, its elements can be computed as

PetscErrorCode ComputeQuantity(char *cat,char *cmp,Mat A,AnalysisItem *res,PetscTruth *success);

with

  1. the name of the category
  2. the name of the element
  3. the matrix
  4. the result
  5. a success indicator

For the main user functions, see the module functions file

Commandline options are discussed in section Commandline options.

types

The AnalysisDataType type is an integer. To get a printable name of the datatype, use AnaModGetTypeName() or AnaModGetTypeMySQLName().