#include "taosolver.h" PetscErrorCode TaoSetJacobianRoutine(TaoSolver tao, Mat J, Mat Jpre, PetscErrorCode (*func)(TaoSolver, Vec, Mat*, Mat *, MatStructure *, void*), void *ctx)Logically collective on TaoSolver
tao | - the TaoSolver context | |
J | - Matrix used for the jacobian | |
Jpre | - Matrix that will be used operated on by preconditioner, can be same as J | |
jac | - Jacobian evaluation routine | |
ctx | - [optional] user-defined context for private data for the Jacobian evaluation routine (may be PETSC_NULL) |
jac (TaoSolver tao,Vec x,Mat *J,Mat *Jpre,MatStructure *flag,void *ctx);
tao | - the TaoSolver context | |
x | - input vector | |
J | - Jacobian matrix | |
Jpre | - preconditioner matrix, usually the same as J | |
flag | - flag indicating information about the preconditioner matrix structure (see below) | |
ctx | - [optional] user-defined Jacobian context |
The function jac() takes Mat * as the matrix arguments rather than Mat. This allows the Jacobian evaluation routine to replace A and/or B with a completely new new matrix structure (not just different matrix elements) when appropriate, for instance, if the nonzero structure is changing throughout the global iterations.
The flag can be used to eliminate unnecessary work in the preconditioner during the repeated solution of linear systems of the same size. The available options are
SAME_PRECONDITIONER -
Jpre is identical during successive linear solves.
This option is intended for folks who are using
different Amat and Pmat matrices and want to reuse the
same preconditioner matrix. For example, this option
saves work by not recomputing incomplete factorization
for ILU/ICC preconditioners.
SAME_NONZERO_PATTERN -
Jpre has the same nonzero structure during
successive linear solves.
DIFFERENT_NONZERO_PATTERN -
Jpre does not have the same nonzero structure.
If in doubt about whether your preconditioner matrix has changed structure or not, use the flag DIFFERENT_NONZERO_PATTERN.
Level:intermediate
Location:src/interface/taosolver_hj.c
TAO Solver Index
Table of Contents