xref: /petsc/src/snes/interface/snesj2.c (revision ff0cfa393765184a9047ba166a67ffec829df148)
1a5eb4965SSatish Balay #ifdef PETSC_RCS_HEADER
2*ff0cfa39SBarry Smith static char vcid[] = "$Id: snesj2.c,v 1.9 1997/09/25 22:40:16 curfman Exp curfman $";
391627157SBarry Smith #endif
491627157SBarry Smith 
5639f9d9dSBarry Smith #include "src/mat/matimpl.h"      /*I  "mat.h"  I*/
6639f9d9dSBarry Smith #include "src/snes/snesimpl.h"    /*I  "snes.h"  I*/
791627157SBarry Smith 
85615d1e5SSatish Balay #undef __FUNC__
95615d1e5SSatish Balay #define __FUNC__ "SNESDefaultComputeJacobianWithColoring"
1091627157SBarry Smith /*@C
11b4fc646aSLois Curfman McInnes     SNESDefaultComputeJacobianWithColoring - Computes the Jacobian using
12b4fc646aSLois Curfman McInnes     finite differences and coloring to exploit matrix sparsity.
1391627157SBarry Smith 
1491627157SBarry Smith     Input Parameters:
1591627157SBarry Smith .   snes - nonlinear solver object
1691627157SBarry Smith .   x1 - location at which to evaluate Jacobian
17*ff0cfa39SBarry Smith .   ctx - coloring context, where
18*ff0cfa39SBarry Smith $      ctx must have type MatFDColoring,
19*ff0cfa39SBarry Smith $      as created via MatFDColoringCreate()
2091627157SBarry Smith 
2191627157SBarry Smith     Output Parameters:
22b4fc646aSLois Curfman McInnes .   J - Jacobian matrix (not altered in this routine)
23b4fc646aSLois Curfman McInnes .   B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
24b4fc646aSLois Curfman McInnes .   flag - flag indicating whether the matrix sparsity structure has changed
2591627157SBarry Smith 
26b4fc646aSLois Curfman McInnes .keywords: SNES, finite differences, Jacobian, coloring, sparse
2791627157SBarry Smith 
28b4fc646aSLois Curfman McInnes .seealso: SNESSetJacobian(), SNESTestJacobian(), SNESDefaultComputeJacobian()
2991627157SBarry Smith @*/
30b4fc646aSLois Curfman McInnes int SNESDefaultComputeJacobianWithColoring(SNES snes,Vec x1,Mat *J,Mat *B,MatStructure *flag,void *ctx)
3191627157SBarry Smith {
3291627157SBarry Smith   MatFDColoring color = (MatFDColoring) ctx;
3343a90d84SBarry Smith   int           ierr;
3488389382SBarry Smith 
35005c665bSBarry Smith   ierr = MatFDColoringApply(*B,color,x1,flag,snes); CHKERRQ(ierr);
3691627157SBarry Smith   return 0;
3791627157SBarry Smith }
3891627157SBarry Smith 
3991627157SBarry Smith 
4091627157SBarry Smith 
41