xref: /petsc/src/snes/interface/snesj2.c (revision c8a8475e04bcaa43590892a5c3e60c6f87bc31f7)
1 /*$Id: snesj2.c,v 1.31 2001/06/21 21:18:37 bsmith Exp $*/
2 
3 #include "src/mat/matimpl.h"      /*I  "petscmat.h"  I*/
4 #include "src/snes/snesimpl.h"    /*I  "petscsnes.h"  I*/
5 
6 #undef __FUNCT__
7 #define __FUNCT__ "SNESDefaultComputeJacobianColor"
8 /*@C
9     SNESDefaultComputeJacobianColor - Computes the Jacobian using
10     finite differences and coloring to exploit matrix sparsity.
11 
12     Collective on SNES
13 
14     Input Parameters:
15 +   snes - nonlinear solver object
16 .   x1 - location at which to evaluate Jacobian
17 -   ctx - coloring context, where ctx must have type MatFDColoring,
18           as created via MatFDColoringCreate()
19 
20     Output Parameters:
21 +   J - Jacobian matrix (not altered in this routine)
22 .   B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
23 -   flag - flag indicating whether the matrix sparsity structure has changed
24 
25     Options Database Keys:
26 .  -mat_fd_coloring_freq <freq> - Activates SNESDefaultComputeJacobianColor()
27 
28     Level: intermediate
29 
30 .keywords: SNES, finite differences, Jacobian, coloring, sparse
31 
32 .seealso: SNESSetJacobian(), SNESTestJacobian(), SNESDefaultComputeJacobian()
33           TSDefaultComputeJacobianColor(), MatFDColoringCreate(),
34           MatFDColoringSetFunction()
35 
36 @*/
37 int SNESDefaultComputeJacobianColor(SNES snes,Vec x1,Mat *J,Mat *B,MatStructure *flag,void *ctx)
38 {
39   MatFDColoring color = (MatFDColoring) ctx;
40   int           ierr,freq,it;
41   Vec           f;
42 
43   PetscFunctionBegin;
44   ierr = MatFDColoringGetFrequency(color,&freq);CHKERRQ(ierr);
45   ierr = SNESGetIterationNumber(snes,&it);CHKERRQ(ierr);
46 
47   if ((freq > 1) && ((it % freq))) {
48     PetscLogInfo(color,"SNESDefaultComputeJacobianColor:Skippingsnesj2.c and  Jacobian, it %d, freq %d\n",it,freq);
49     *flag = SAME_PRECONDITIONER;
50   } else {
51     PetscLogInfo(color,"SNESDefaultComputeJacobianColor:Computing Jacobian, it %d, freq %d\n",it,freq);
52     *flag = SAME_NONZERO_PATTERN;
53     ierr  = SNESGetFunction(snes,&f,0,0);CHKERRQ(ierr);
54     ierr  = MatFDColoringSetF(color,f);CHKERRQ(ierr);
55     ierr  = PetscLogEventBegin(SNES_FunctionEval,snes,x1,0,0);CHKERRQ(ierr);
56     PetscStackPush("SNES user function");
57     ierr  = MatFDColoringApply(*B,color,x1,flag,snes);CHKERRQ(ierr);
58     PetscStackPop;
59     snes->nfuncs++;
60     ierr = PetscLogEventEnd(SNES_FunctionEval,snes,x1,0,0);CHKERRQ(ierr);
61   }
62   if (J != B) {
63     ierr = MatAssemblyBegin(*J,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
64     ierr = MatAssemblyEnd(*J,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
65   }
66   PetscFunctionReturn(0);
67 }
68 
69 
70 
71