xref: /petsc/src/tao/bound/impls/bnk/bnk.c (revision 8d5ead369b7916272d211d106c850283b970bae2)
1eb910715SAlp Dener #include <petsctaolinesearch.h>
2eb910715SAlp Dener #include <../src/tao/bound/impls/bnk/bnk.h>
3eb910715SAlp Dener 
4eb910715SAlp Dener #include <petscksp.h>
5eb910715SAlp Dener 
6eb910715SAlp Dener /* Routine for BFGS preconditioner */
7eb910715SAlp Dener 
8eb910715SAlp Dener PetscErrorCode MatLMVMSolveShell(PC pc, Vec b, Vec x)
9eb910715SAlp Dener {
10eb910715SAlp Dener   PetscErrorCode ierr;
11eb910715SAlp Dener   Mat            M;
12eb910715SAlp Dener 
13eb910715SAlp Dener   PetscFunctionBegin;
14eb910715SAlp Dener   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
15eb910715SAlp Dener   PetscValidHeaderSpecific(b,VEC_CLASSID,2);
16eb910715SAlp Dener   PetscValidHeaderSpecific(x,VEC_CLASSID,3);
17eb910715SAlp Dener   ierr = PCShellGetContext(pc,(void**)&M);CHKERRQ(ierr);
1809164190SAlp Dener   ierr = MatLMVMSolveInactive(M, b, x);CHKERRQ(ierr);
19eb910715SAlp Dener   PetscFunctionReturn(0);
20eb910715SAlp Dener }
21eb910715SAlp Dener 
22df278d8fSAlp Dener /*------------------------------------------------------------*/
23df278d8fSAlp Dener 
24df278d8fSAlp Dener /* Routine for initializing the KSP solver, the BFGS preconditioner, and the initial trust radius estimation */
25df278d8fSAlp Dener 
26eb910715SAlp Dener PetscErrorCode TaoBNKInitialize(Tao tao)
27eb910715SAlp Dener {
28eb910715SAlp Dener   PetscErrorCode               ierr;
29eb910715SAlp Dener   TAO_BNK                      *bnk = (TAO_BNK *)tao->data;
30eb910715SAlp Dener   KSPType                      ksp_type;
31eb910715SAlp Dener   PC                           pc;
32eb910715SAlp Dener 
3387602d1eSAlp Dener   PetscReal                    fmin, ftrial, prered, actred, kappa, sigma, dnorm;
34eb910715SAlp Dener   PetscReal                    tau, tau_1, tau_2, tau_max, tau_min, max_radius;
35eb910715SAlp Dener   PetscReal                    delta, step = 1.0;
36eb910715SAlp Dener 
37eb910715SAlp Dener   PetscInt                     n,N,needH = 1;
38eb910715SAlp Dener 
39eb910715SAlp Dener   PetscInt                     i_max = 5;
40eb910715SAlp Dener   PetscInt                     j_max = 1;
41eb910715SAlp Dener   PetscInt                     i, j;
42eb910715SAlp Dener 
43eb910715SAlp Dener   PetscFunctionBegin;
44eb910715SAlp Dener   /* Number of times ksp stopped because of these reasons */
45eb910715SAlp Dener   bnk->ksp_atol = 0;
46eb910715SAlp Dener   bnk->ksp_rtol = 0;
47eb910715SAlp Dener   bnk->ksp_dtol = 0;
48eb910715SAlp Dener   bnk->ksp_ctol = 0;
49eb910715SAlp Dener   bnk->ksp_negc = 0;
50eb910715SAlp Dener   bnk->ksp_iter = 0;
51eb910715SAlp Dener   bnk->ksp_othr = 0;
52eb910715SAlp Dener 
53fed79b8eSAlp Dener   /* Initialize the Hessian perturbation */
54fed79b8eSAlp Dener   bnk->pert = bnk->sval;
55fed79b8eSAlp Dener 
56eb910715SAlp Dener   /* Initialize trust-region radius when using nash, stcg, or gltr
57eb910715SAlp Dener      Command automatically ignored for other methods
58eb910715SAlp Dener      Will be reset during the first iteration
59eb910715SAlp Dener   */
60eb910715SAlp Dener   ierr = KSPGetType(tao->ksp,&ksp_type);CHKERRQ(ierr);
61eb910715SAlp Dener   ierr = PetscStrcmp(ksp_type,KSPCGNASH,&bnk->is_nash);CHKERRQ(ierr);
62eb910715SAlp Dener   ierr = PetscStrcmp(ksp_type,KSPCGSTCG,&bnk->is_stcg);CHKERRQ(ierr);
63eb910715SAlp Dener   ierr = PetscStrcmp(ksp_type,KSPCGGLTR,&bnk->is_gltr);CHKERRQ(ierr);
64eb910715SAlp Dener 
65eb910715SAlp Dener   ierr = KSPCGSetRadius(tao->ksp,bnk->max_radius);CHKERRQ(ierr);
66eb910715SAlp Dener 
67eb910715SAlp Dener   if (bnk->is_nash || bnk->is_stcg || bnk->is_gltr) {
68eb910715SAlp Dener     if (tao->trust0 < 0.0) SETERRQ(PETSC_COMM_SELF,1,"Initial radius negative");
69eb910715SAlp Dener     tao->trust = tao->trust0;
70eb910715SAlp Dener     tao->trust = PetscMax(tao->trust, bnk->min_radius);
71eb910715SAlp Dener     tao->trust = PetscMin(tao->trust, bnk->max_radius);
72eb910715SAlp Dener   }
73eb910715SAlp Dener 
74eb910715SAlp Dener   /* Get vectors we will need */
75eb910715SAlp Dener   if (BNK_PC_BFGS == bnk->pc_type && !bnk->M) {
76eb910715SAlp Dener     ierr = VecGetLocalSize(tao->solution,&n);CHKERRQ(ierr);
77eb910715SAlp Dener     ierr = VecGetSize(tao->solution,&N);CHKERRQ(ierr);
78eb910715SAlp Dener     ierr = MatCreateLMVM(((PetscObject)tao)->comm,n,N,&bnk->M);CHKERRQ(ierr);
79eb910715SAlp Dener     ierr = MatLMVMAllocateVectors(bnk->M,tao->solution);CHKERRQ(ierr);
80eb910715SAlp Dener   }
81eb910715SAlp Dener 
82eb910715SAlp Dener   /* create vectors for the limited memory preconditioner */
83eb910715SAlp Dener   if ((BNK_PC_BFGS == bnk->pc_type) && (BFGS_SCALE_BFGS != bnk->bfgs_scale_type)) {
84eb910715SAlp Dener     if (!bnk->Diag) {
85eb910715SAlp Dener       ierr = VecDuplicate(tao->solution,&bnk->Diag);CHKERRQ(ierr);
86eb910715SAlp Dener     }
87eb910715SAlp Dener   }
88eb910715SAlp Dener 
89eb910715SAlp Dener   /* Modify the preconditioner to use the bfgs approximation */
90eb910715SAlp Dener   ierr = KSPGetPC(tao->ksp, &pc);CHKERRQ(ierr);
91eb910715SAlp Dener   switch(bnk->pc_type) {
92eb910715SAlp Dener   case BNK_PC_NONE:
93eb910715SAlp Dener     ierr = PCSetType(pc, PCNONE);CHKERRQ(ierr);
94eb910715SAlp Dener     ierr = PCSetFromOptions(pc);CHKERRQ(ierr);
95eb910715SAlp Dener     break;
96eb910715SAlp Dener 
97eb910715SAlp Dener   case BNK_PC_AHESS:
98eb910715SAlp Dener     ierr = PCSetType(pc, PCJACOBI);CHKERRQ(ierr);
99eb910715SAlp Dener     ierr = PCSetFromOptions(pc);CHKERRQ(ierr);
100eb910715SAlp Dener     ierr = PCJacobiSetUseAbs(pc,PETSC_TRUE);CHKERRQ(ierr);
101eb910715SAlp Dener     break;
102eb910715SAlp Dener 
103eb910715SAlp Dener   case BNK_PC_BFGS:
104eb910715SAlp Dener     ierr = PCSetType(pc, PCSHELL);CHKERRQ(ierr);
105eb910715SAlp Dener     ierr = PCSetFromOptions(pc);CHKERRQ(ierr);
106eb910715SAlp Dener     ierr = PCShellSetName(pc, "bfgs");CHKERRQ(ierr);
107eb910715SAlp Dener     ierr = PCShellSetContext(pc, bnk->M);CHKERRQ(ierr);
108eb910715SAlp Dener     ierr = PCShellSetApply(pc, MatLMVMSolveShell);CHKERRQ(ierr);
109eb910715SAlp Dener     break;
110eb910715SAlp Dener 
111eb910715SAlp Dener   default:
112eb910715SAlp Dener     /* Use the pc method set by pc_type */
113eb910715SAlp Dener     break;
114eb910715SAlp Dener   }
115eb910715SAlp Dener 
116eb910715SAlp Dener   /* Initialize trust-region radius.  The initialization is only performed
117eb910715SAlp Dener      when we are using Nash, Steihaug-Toint or the Generalized Lanczos method. */
118eb910715SAlp Dener   if (bnk->is_nash || bnk->is_stcg || bnk->is_gltr) {
119eb910715SAlp Dener     switch(bnk->init_type) {
120eb910715SAlp Dener     case BNK_INIT_CONSTANT:
121eb910715SAlp Dener       /* Use the initial radius specified */
122eb910715SAlp Dener       break;
123eb910715SAlp Dener 
124eb910715SAlp Dener     case BNK_INIT_INTERPOLATION:
125eb910715SAlp Dener       /* Use the initial radius specified */
126eb910715SAlp Dener       max_radius = 0.0;
127eb910715SAlp Dener 
128eb910715SAlp Dener       for (j = 0; j < j_max; ++j) {
129eb910715SAlp Dener         fmin = bnk->f;
130eb910715SAlp Dener         sigma = 0.0;
131eb910715SAlp Dener 
132eb910715SAlp Dener         if (needH) {
13362602cfbSAlp Dener           /* Compute the Hessian at the new step, and extract the inactive subsystem */
134eb910715SAlp Dener           ierr = TaoComputeHessian(tao, tao->solution,tao->hessian,tao->hessian_pre);CHKERRQ(ierr);
13562602cfbSAlp Dener           ierr = ISDestroy(&bnk->inactive_idx);CHKERRQ(ierr);
13662602cfbSAlp Dener           ierr = VecWhichInactive(tao->XL,tao->solution,bnk->unprojected_gradient,tao->XU,PETSC_TRUE,&bnk->inactive_idx);CHKERRQ(ierr);
13762602cfbSAlp Dener           ierr = TaoMatGetSubMat(tao->hessian, bnk->inactive_idx, bnk->Xwork, TAO_SUBSET_MASK, &bnk->H_inactive);CHKERRQ(ierr);
138eb910715SAlp Dener           needH = 0;
139eb910715SAlp Dener         }
140eb910715SAlp Dener 
141eb910715SAlp Dener         for (i = 0; i < i_max; ++i) {
14262602cfbSAlp Dener           /* Take a steepest descent step and snap it to bounds */
14362602cfbSAlp Dener           ierr = VecCopy(tao->solution, bnk->Xold);CHKERRQ(ierr);
14462602cfbSAlp Dener           ierr = VecAXPY(tao->solution, -tao->trust/bnk->gnorm, tao->gradient);CHKERRQ(ierr);
14562602cfbSAlp Dener           ierr = VecMedian(tao->XL, tao->solution, tao->XU, tao->solution);CHKERRQ(ierr);
14662602cfbSAlp Dener           /* Adjust the trust radius if the bound snapping changed the step */
147eb910715SAlp Dener           ierr = VecCopy(tao->solution, bnk->W);CHKERRQ(ierr);
14862602cfbSAlp Dener           ierr = VecAXPY(bnk->W, -1.0, bnk->Xold);CHKERRQ(ierr);
14987602d1eSAlp Dener           ierr = VecNorm(bnk->W, NORM_2, &dnorm);CHKERRQ(ierr);
150*8d5ead36SAlp Dener           if (dnorm != tao->trust) tao->trust = dnorm;
15162602cfbSAlp Dener           /* Compute the objective at the trial */
15262602cfbSAlp Dener           ierr = TaoComputeObjective(tao, tao->solution, &ftrial);CHKERRQ(ierr);
15362602cfbSAlp Dener           ierr = VecCopy(bnk->Xold, tao->solution);CHKERRQ(ierr);
154eb910715SAlp Dener           if (PetscIsInfOrNanReal(ftrial)) {
155eb910715SAlp Dener             tau = bnk->gamma1_i;
156eb910715SAlp Dener           } else {
157eb910715SAlp Dener             if (ftrial < fmin) {
158eb910715SAlp Dener               fmin = ftrial;
159eb910715SAlp Dener               sigma = -tao->trust / bnk->gnorm;
160eb910715SAlp Dener             }
161eb910715SAlp Dener 
16262602cfbSAlp Dener             ierr = MatMult(bnk->H_inactive, tao->gradient, bnk->W);CHKERRQ(ierr);
16362602cfbSAlp Dener             ierr = VecDot(tao->gradient, bnk->W, &prered);CHKERRQ(ierr);
164eb910715SAlp Dener 
165eb910715SAlp Dener             prered = tao->trust * (bnk->gnorm - 0.5 * tao->trust * prered / (bnk->gnorm * bnk->gnorm));
166eb910715SAlp Dener             actred = bnk->f - ftrial;
167eb910715SAlp Dener             if ((PetscAbsScalar(actred) <= bnk->epsilon) && (PetscAbsScalar(prered) <= bnk->epsilon)) {
168eb910715SAlp Dener               kappa = 1.0;
169eb910715SAlp Dener             } else {
170eb910715SAlp Dener               kappa = actred / prered;
171eb910715SAlp Dener             }
172eb910715SAlp Dener 
173eb910715SAlp Dener             tau_1 = bnk->theta_i * bnk->gnorm * tao->trust / (bnk->theta_i * bnk->gnorm * tao->trust + (1.0 - bnk->theta_i) * prered - actred);
174eb910715SAlp Dener             tau_2 = bnk->theta_i * bnk->gnorm * tao->trust / (bnk->theta_i * bnk->gnorm * tao->trust - (1.0 + bnk->theta_i) * prered + actred);
175eb910715SAlp Dener             tau_min = PetscMin(tau_1, tau_2);
176eb910715SAlp Dener             tau_max = PetscMax(tau_1, tau_2);
177eb910715SAlp Dener 
178eb910715SAlp Dener             if (PetscAbsScalar(kappa - 1.0) <= bnk->mu1_i) {
179eb910715SAlp Dener               /* Great agreement */
180eb910715SAlp Dener               max_radius = PetscMax(max_radius, tao->trust);
181eb910715SAlp Dener 
182eb910715SAlp Dener               if (tau_max < 1.0) {
183eb910715SAlp Dener                 tau = bnk->gamma3_i;
184eb910715SAlp Dener               } else if (tau_max > bnk->gamma4_i) {
185eb910715SAlp Dener                 tau = bnk->gamma4_i;
186eb910715SAlp Dener               } else if (tau_1 >= 1.0 && tau_1 <= bnk->gamma4_i && tau_2 < 1.0) {
187eb910715SAlp Dener                 tau = tau_1;
188eb910715SAlp Dener               } else if (tau_2 >= 1.0 && tau_2 <= bnk->gamma4_i && tau_1 < 1.0) {
189eb910715SAlp Dener                 tau = tau_2;
190eb910715SAlp Dener               } else {
191eb910715SAlp Dener                 tau = tau_max;
192eb910715SAlp Dener               }
193eb910715SAlp Dener             } else if (PetscAbsScalar(kappa - 1.0) <= bnk->mu2_i) {
194eb910715SAlp Dener               /* Good agreement */
195eb910715SAlp Dener               max_radius = PetscMax(max_radius, tao->trust);
196eb910715SAlp Dener 
197eb910715SAlp Dener               if (tau_max < bnk->gamma2_i) {
198eb910715SAlp Dener                 tau = bnk->gamma2_i;
199eb910715SAlp Dener               } else if (tau_max > bnk->gamma3_i) {
200eb910715SAlp Dener                 tau = bnk->gamma3_i;
201eb910715SAlp Dener               } else {
202eb910715SAlp Dener                 tau = tau_max;
203eb910715SAlp Dener               }
204eb910715SAlp Dener             } else {
205eb910715SAlp Dener               /* Not good agreement */
206eb910715SAlp Dener               if (tau_min > 1.0) {
207eb910715SAlp Dener                 tau = bnk->gamma2_i;
208eb910715SAlp Dener               } else if (tau_max < bnk->gamma1_i) {
209eb910715SAlp Dener                 tau = bnk->gamma1_i;
210eb910715SAlp Dener               } else if ((tau_min < bnk->gamma1_i) && (tau_max >= 1.0)) {
211eb910715SAlp Dener                 tau = bnk->gamma1_i;
212eb910715SAlp Dener               } else if ((tau_1 >= bnk->gamma1_i) && (tau_1 < 1.0) && ((tau_2 < bnk->gamma1_i) || (tau_2 >= 1.0))) {
213eb910715SAlp Dener                 tau = tau_1;
214eb910715SAlp Dener               } else if ((tau_2 >= bnk->gamma1_i) && (tau_2 < 1.0) && ((tau_1 < bnk->gamma1_i) || (tau_2 >= 1.0))) {
215eb910715SAlp Dener                 tau = tau_2;
216eb910715SAlp Dener               } else {
217eb910715SAlp Dener                 tau = tau_max;
218eb910715SAlp Dener               }
219eb910715SAlp Dener             }
220eb910715SAlp Dener           }
221eb910715SAlp Dener           tao->trust = tau * tao->trust;
222eb910715SAlp Dener         }
223eb910715SAlp Dener 
224eb910715SAlp Dener         if (fmin < bnk->f) {
225eb910715SAlp Dener           bnk->f = fmin;
226eb910715SAlp Dener           ierr = VecAXPY(tao->solution,sigma,tao->gradient);CHKERRQ(ierr);
22787602d1eSAlp Dener           ierr = VecMedian(tao->XL, tao->solution, tao->XU, tao->solution);CHKERRQ(ierr);
22809164190SAlp Dener           ierr = TaoComputeGradient(tao,tao->solution,bnk->unprojected_gradient);CHKERRQ(ierr);
22909164190SAlp Dener           ierr = VecBoundGradientProjection(bnk->unprojected_gradient,tao->solution,tao->XL,tao->XU,tao->gradient);CHKERRQ(ierr);
230eb910715SAlp Dener 
231eb910715SAlp Dener           ierr = TaoGradientNorm(tao, tao->gradient,NORM_2,&bnk->gnorm);CHKERRQ(ierr);
232eb910715SAlp Dener           if (PetscIsInfOrNanReal(bnk->gnorm)) SETERRQ(PETSC_COMM_SELF,1, "User provided compute gradient generated Inf or NaN");
233eb910715SAlp Dener           needH = 1;
23462602cfbSAlp Dener           ierr = MatDestroy(&bnk->H_inactive);CHKERRQ(ierr);
235eb910715SAlp Dener 
236eb910715SAlp Dener           ierr = TaoLogConvergenceHistory(tao,bnk->f,bnk->gnorm,0.0,tao->ksp_its);CHKERRQ(ierr);
237eb910715SAlp Dener           ierr = TaoMonitor(tao,tao->niter,bnk->f,bnk->gnorm,0.0,step);CHKERRQ(ierr);
238eb910715SAlp Dener           ierr = (*tao->ops->convergencetest)(tao,tao->cnvP);CHKERRQ(ierr);
239eb910715SAlp Dener           if (tao->reason != TAO_CONTINUE_ITERATING) PetscFunctionReturn(0);
240eb910715SAlp Dener         }
241eb910715SAlp Dener       }
242eb910715SAlp Dener       tao->trust = PetscMax(tao->trust, max_radius);
243eb910715SAlp Dener 
244eb910715SAlp Dener       /* Modify the radius if it is too large or small */
245eb910715SAlp Dener       tao->trust = PetscMax(tao->trust, bnk->min_radius);
246eb910715SAlp Dener       tao->trust = PetscMin(tao->trust, bnk->max_radius);
247eb910715SAlp Dener       break;
248eb910715SAlp Dener 
249eb910715SAlp Dener     default:
250eb910715SAlp Dener       /* Norm of the first direction will initialize radius */
251eb910715SAlp Dener       tao->trust = 0.0;
252eb910715SAlp Dener       break;
253eb910715SAlp Dener     }
254eb910715SAlp Dener   }
255eb910715SAlp Dener 
256eb910715SAlp Dener   /* Set initial scaling for the BFGS preconditioner
257eb910715SAlp Dener      This step is done after computing the initial trust-region radius
258eb910715SAlp Dener      since the function value may have decreased */
259eb910715SAlp Dener   if (BNK_PC_BFGS == bnk->pc_type) {
260eb910715SAlp Dener     if (bnk->f != 0.0) {
261eb910715SAlp Dener       delta = 2.0 * PetscAbsScalar(bnk->f) / (bnk->gnorm*bnk->gnorm);
262eb910715SAlp Dener     } else {
263eb910715SAlp Dener       delta = 2.0 / (bnk->gnorm*bnk->gnorm);
264eb910715SAlp Dener     }
265eb910715SAlp Dener     ierr = MatLMVMSetDelta(bnk->M,delta);CHKERRQ(ierr);
266eb910715SAlp Dener   }
267eb910715SAlp Dener 
268eb910715SAlp Dener   /* Set counter for gradient/reset steps*/
269eb910715SAlp Dener   bnk->newt = 0;
270eb910715SAlp Dener   bnk->bfgs = 0;
271eb910715SAlp Dener   bnk->sgrad = 0;
272eb910715SAlp Dener   bnk->grad = 0;
273eb910715SAlp Dener   PetscFunctionReturn(0);
274eb910715SAlp Dener }
275eb910715SAlp Dener 
276df278d8fSAlp Dener /*------------------------------------------------------------*/
277df278d8fSAlp Dener 
278df278d8fSAlp Dener /* Routine for computing the Newton step.
279df278d8fSAlp Dener 
280df278d8fSAlp Dener   If the safeguard is enabled, the Newton step is verified to be a
281df278d8fSAlp Dener   descent direction, with fallbacks onto BFGS, scaled gradient, and unscaled
282df278d8fSAlp Dener   gradient steps if/when necessary.
283df278d8fSAlp Dener 
284df278d8fSAlp Dener   The function reports back on which type of step has ultimately been stored
285df278d8fSAlp Dener   under tao->stepdirection.
286df278d8fSAlp Dener */
287df278d8fSAlp Dener 
288fed79b8eSAlp Dener PetscErrorCode TaoBNKComputeStep(Tao tao, PetscBool safeguard, PetscInt *stepType)
289eb910715SAlp Dener {
290eb910715SAlp Dener   PetscErrorCode               ierr;
291eb910715SAlp Dener   TAO_BNK                      *bnk = (TAO_BNK *)tao->data;
292eb910715SAlp Dener   KSPConvergedReason           ksp_reason;
293eb910715SAlp Dener 
294*8d5ead36SAlp Dener   Vec                          active_step;
295080d2917SAlp Dener   PetscReal                    gdx, delta, e_min;
296eb910715SAlp Dener   PetscInt                     bfgsUpdates = 0;
297eb910715SAlp Dener   PetscInt                     kspits;
298eb910715SAlp Dener 
299eb910715SAlp Dener   PetscFunctionBegin;
300eb910715SAlp Dener   /* Shift the Hessian matrix */
301eb910715SAlp Dener   if (bnk->pert > 0) {
302eb910715SAlp Dener     ierr = MatShift(tao->hessian, bnk->pert);CHKERRQ(ierr);
303eb910715SAlp Dener     if (tao->hessian != tao->hessian_pre) {
304eb910715SAlp Dener       ierr = MatShift(tao->hessian_pre, bnk->pert);CHKERRQ(ierr);
305eb910715SAlp Dener     }
306eb910715SAlp Dener   }
307eb910715SAlp Dener 
308*8d5ead36SAlp Dener   /* Determine the inactive and active sets */
30909164190SAlp Dener   ierr = ISDestroy(&bnk->inactive_idx);CHKERRQ(ierr);
310*8d5ead36SAlp Dener   ierr = ISDestroy(&bnk->active_idx);CHKERRQ(ierr);
31109164190SAlp Dener   ierr = VecWhichInactive(tao->XL,tao->solution,bnk->unprojected_gradient,tao->XU,PETSC_TRUE,&bnk->inactive_idx);CHKERRQ(ierr);
312*8d5ead36SAlp Dener   ierr = ISComplementVec(bnk->inactive_idx, tao->solution, &bnk->active_idx);CHKERRQ(ierr);
31309164190SAlp Dener 
314eb3ba6a7SAlp Dener   /* Prepare masked matrices for the inactive set */
31509164190SAlp Dener   ierr = MatLMVMSetInactive(bnk->M, bnk->inactive_idx);CHKERRQ(ierr);
31609164190SAlp Dener   ierr = VecSet(tao->stepdirection, 0.0);CHKERRQ(ierr);
317eb3ba6a7SAlp Dener   ierr = TaoMatGetSubMat(tao->hessian, bnk->inactive_idx, bnk->Xwork, TAO_SUBSET_MASK, &bnk->H_inactive);CHKERRQ(ierr);
318eb3ba6a7SAlp Dener   if (tao->hessian == tao->hessian_pre) {
319eb3ba6a7SAlp Dener     bnk->Hpre_inactive = bnk->H_inactive;
320eb3ba6a7SAlp Dener   } else {
321eb3ba6a7SAlp Dener     ierr = TaoMatGetSubMat(tao->hessian_pre, bnk->inactive_idx, bnk->Xwork, TAO_SUBSET_MASK, &bnk->Hpre_inactive);CHKERRQ(ierr);
322eb3ba6a7SAlp Dener   }
32309164190SAlp Dener 
324eb910715SAlp Dener   /* Solve the Newton system of equations */
32509164190SAlp Dener   ierr = KSPSetOperators(tao->ksp,bnk->H_inactive,bnk->Hpre_inactive);CHKERRQ(ierr);
326eb910715SAlp Dener   if (bnk->is_nash || bnk->is_stcg || bnk->is_gltr) {
327fed79b8eSAlp Dener     ierr = KSPCGSetRadius(tao->ksp,tao->trust);CHKERRQ(ierr);
328eb3ba6a7SAlp Dener     ierr = KSPSolve(tao->ksp, tao->gradient, tao->stepdirection);CHKERRQ(ierr);
329eb910715SAlp Dener     ierr = KSPGetIterationNumber(tao->ksp,&kspits);CHKERRQ(ierr);
330eb910715SAlp Dener     tao->ksp_its+=kspits;
331eb910715SAlp Dener     tao->ksp_tot_its+=kspits;
332080d2917SAlp Dener     ierr = KSPCGGetNormD(tao->ksp,&bnk->dnorm);CHKERRQ(ierr);
333eb910715SAlp Dener 
334eb910715SAlp Dener     if (0.0 == tao->trust) {
335eb910715SAlp Dener       /* Radius was uninitialized; use the norm of the direction */
336080d2917SAlp Dener       if (bnk->dnorm > 0.0) {
337080d2917SAlp Dener         tao->trust = bnk->dnorm;
338eb910715SAlp Dener 
339eb910715SAlp Dener         /* Modify the radius if it is too large or small */
340eb910715SAlp Dener         tao->trust = PetscMax(tao->trust, bnk->min_radius);
341eb910715SAlp Dener         tao->trust = PetscMin(tao->trust, bnk->max_radius);
342eb910715SAlp Dener       } else {
343eb910715SAlp Dener         /* The direction was bad; set radius to default value and re-solve
344eb910715SAlp Dener            the trust-region subproblem to get a direction */
345eb910715SAlp Dener         tao->trust = tao->trust0;
346eb910715SAlp Dener 
347eb910715SAlp Dener         /* Modify the radius if it is too large or small */
348eb910715SAlp Dener         tao->trust = PetscMax(tao->trust, bnk->min_radius);
349eb910715SAlp Dener         tao->trust = PetscMin(tao->trust, bnk->max_radius);
350eb910715SAlp Dener 
351fed79b8eSAlp Dener         ierr = KSPCGSetRadius(tao->ksp,tao->trust);CHKERRQ(ierr);
352eb3ba6a7SAlp Dener         ierr = KSPSolve(tao->ksp, tao->gradient, tao->stepdirection);CHKERRQ(ierr);
353eb910715SAlp Dener         ierr = KSPGetIterationNumber(tao->ksp,&kspits);CHKERRQ(ierr);
354eb910715SAlp Dener         tao->ksp_its+=kspits;
355eb910715SAlp Dener         tao->ksp_tot_its+=kspits;
356080d2917SAlp Dener         ierr = KSPCGGetNormD(tao->ksp,&bnk->dnorm);CHKERRQ(ierr);
357eb910715SAlp Dener 
358080d2917SAlp Dener         if (bnk->dnorm == 0.0) SETERRQ(PETSC_COMM_SELF,1, "Initial direction zero");
359eb910715SAlp Dener       }
360eb910715SAlp Dener     }
361eb910715SAlp Dener   } else {
362eb3ba6a7SAlp Dener     ierr = KSPSolve(tao->ksp, tao->gradient, tao->stepdirection);CHKERRQ(ierr);
363eb910715SAlp Dener     ierr = KSPGetIterationNumber(tao->ksp, &kspits);CHKERRQ(ierr);
364eb910715SAlp Dener     tao->ksp_its += kspits;
365eb910715SAlp Dener     tao->ksp_tot_its+=kspits;
366eb910715SAlp Dener   }
367fed79b8eSAlp Dener   ierr = VecScale(tao->stepdirection, -1.0);CHKERRQ(ierr);
368fed79b8eSAlp Dener   ierr = KSPGetConvergedReason(tao->ksp, &ksp_reason);CHKERRQ(ierr);
369fed79b8eSAlp Dener 
370fed79b8eSAlp Dener   /* Make sure the BFGS preconditioner is healthy */
371fed79b8eSAlp Dener   if (bnk->pc_type == BNK_PC_BFGS) {
372fed79b8eSAlp Dener     ierr = MatLMVMGetUpdates(bnk->M, &bfgsUpdates);CHKERRQ(ierr);
373fed79b8eSAlp Dener     if ((KSP_DIVERGED_INDEFINITE_PC == ksp_reason) && (bfgsUpdates > 1)) {
374fed79b8eSAlp Dener       /* Preconditioner is numerically indefinite; reset the approximation. */
375eb910715SAlp Dener       if (bnk->f != 0.0) {
376eb910715SAlp Dener         delta = 2.0 * PetscAbsScalar(bnk->f) / (bnk->gnorm*bnk->gnorm);
377eb910715SAlp Dener       } else {
378eb910715SAlp Dener         delta = 2.0 / (bnk->gnorm*bnk->gnorm);
379eb910715SAlp Dener       }
380eb910715SAlp Dener       ierr = MatLMVMSetDelta(bnk->M,delta);CHKERRQ(ierr);
381eb910715SAlp Dener       ierr = MatLMVMReset(bnk->M);CHKERRQ(ierr);
38209164190SAlp Dener       ierr = MatLMVMUpdate(bnk->M, tao->solution, bnk->unprojected_gradient);CHKERRQ(ierr);
383eb910715SAlp Dener       bfgsUpdates = 1;
384eb910715SAlp Dener     }
385fed79b8eSAlp Dener   }
386eb910715SAlp Dener 
387eb910715SAlp Dener   if (KSP_CONVERGED_ATOL == ksp_reason) {
388eb910715SAlp Dener     ++bnk->ksp_atol;
389eb910715SAlp Dener   } else if (KSP_CONVERGED_RTOL == ksp_reason) {
390eb910715SAlp Dener     ++bnk->ksp_rtol;
391eb910715SAlp Dener   } else if (KSP_CONVERGED_CG_CONSTRAINED == ksp_reason) {
392eb910715SAlp Dener     ++bnk->ksp_ctol;
393eb910715SAlp Dener   } else if (KSP_CONVERGED_CG_NEG_CURVE == ksp_reason) {
394eb910715SAlp Dener     ++bnk->ksp_negc;
395eb910715SAlp Dener   } else if (KSP_DIVERGED_DTOL == ksp_reason) {
396eb910715SAlp Dener     ++bnk->ksp_dtol;
397eb910715SAlp Dener   } else if (KSP_DIVERGED_ITS == ksp_reason) {
398eb910715SAlp Dener     ++bnk->ksp_iter;
399eb910715SAlp Dener   } else {
400eb910715SAlp Dener     ++bnk->ksp_othr;
401eb910715SAlp Dener   }
402eb910715SAlp Dener 
403eb910715SAlp Dener   /* Check for success (descent direction) */
404fed79b8eSAlp Dener   if (safeguard) {
405080d2917SAlp Dener     ierr = VecDot(tao->stepdirection, tao->gradient, &gdx);CHKERRQ(ierr);
406eb910715SAlp Dener     if ((gdx >= 0.0) || PetscIsInfOrNanReal(gdx)) {
407eb910715SAlp Dener       /* Newton step is not descent or direction produced Inf or NaN
408eb910715SAlp Dener          Update the perturbation for next time */
409eb910715SAlp Dener       if (bnk->pert <= 0.0) {
410eb910715SAlp Dener         /* Initialize the perturbation */
411eb910715SAlp Dener         bnk->pert = PetscMin(bnk->imax, PetscMax(bnk->imin, bnk->imfac * bnk->gnorm));
412eb910715SAlp Dener         if (bnk->is_gltr) {
413eb910715SAlp Dener           ierr = KSPCGGLTRGetMinEig(tao->ksp,&e_min);CHKERRQ(ierr);
414eb910715SAlp Dener           bnk->pert = PetscMax(bnk->pert, -e_min);
415eb910715SAlp Dener         }
416eb910715SAlp Dener       } else {
417eb910715SAlp Dener         /* Increase the perturbation */
418eb910715SAlp Dener         bnk->pert = PetscMin(bnk->pmax, PetscMax(bnk->pgfac * bnk->pert, bnk->pmgfac * bnk->gnorm));
419eb910715SAlp Dener       }
420eb910715SAlp Dener 
421eb910715SAlp Dener       if (BNK_PC_BFGS != bnk->pc_type) {
422eb910715SAlp Dener         /* We don't have the bfgs matrix around and updated
423eb910715SAlp Dener            Must use gradient direction in this case */
424080d2917SAlp Dener         ierr = VecCopy(tao->gradient, tao->stepdirection);CHKERRQ(ierr);
425eb910715SAlp Dener         ++bnk->grad;
426eb910715SAlp Dener         *stepType = BNK_GRADIENT;
427eb910715SAlp Dener       } else {
428eb910715SAlp Dener         /* Attempt to use the BFGS direction */
42909164190SAlp Dener         ierr = MatLMVMSolve(bnk->M, bnk->unprojected_gradient, tao->stepdirection);CHKERRQ(ierr);
430eb910715SAlp Dener 
431*8d5ead36SAlp Dener         /* Check for success (descent direction)
432*8d5ead36SAlp Dener            NOTE: Negative gdx here means not a descent direction because
433*8d5ead36SAlp Dener            the fall-back step is missing a negative sign. */
434080d2917SAlp Dener         ierr = VecDot(tao->gradient, tao->stepdirection, &gdx);CHKERRQ(ierr);
435*8d5ead36SAlp Dener         if ((gdx <= 0) || PetscIsInfOrNanReal(gdx)) {
436eb910715SAlp Dener           /* BFGS direction is not descent or direction produced not a number
437eb910715SAlp Dener              We can assert bfgsUpdates > 1 in this case because
438eb910715SAlp Dener              the first solve produces the scaled gradient direction,
439eb910715SAlp Dener              which is guaranteed to be descent */
440eb910715SAlp Dener 
441eb910715SAlp Dener           /* Use steepest descent direction (scaled) */
442eb910715SAlp Dener           if (bnk->f != 0.0) {
443eb910715SAlp Dener             delta = 2.0 * PetscAbsScalar(bnk->f) / (bnk->gnorm*bnk->gnorm);
444eb910715SAlp Dener           } else {
445eb910715SAlp Dener             delta = 2.0 / (bnk->gnorm*bnk->gnorm);
446eb910715SAlp Dener           }
447eb910715SAlp Dener           ierr = MatLMVMSetDelta(bnk->M, delta);CHKERRQ(ierr);
448eb910715SAlp Dener           ierr = MatLMVMReset(bnk->M);CHKERRQ(ierr);
44909164190SAlp Dener           ierr = MatLMVMUpdate(bnk->M, tao->solution, bnk->unprojected_gradient);CHKERRQ(ierr);
45009164190SAlp Dener           ierr = MatLMVMSolve(bnk->M, bnk->unprojected_gradient, tao->stepdirection);CHKERRQ(ierr);
451eb910715SAlp Dener 
452eb910715SAlp Dener           bfgsUpdates = 1;
453eb910715SAlp Dener           ++bnk->sgrad;
454eb910715SAlp Dener           *stepType = BNK_SCALED_GRADIENT;
455eb910715SAlp Dener         } else {
456eb910715SAlp Dener           if (1 == bfgsUpdates) {
457eb910715SAlp Dener             /* The first BFGS direction is always the scaled gradient */
458eb910715SAlp Dener             ++bnk->sgrad;
459eb910715SAlp Dener             *stepType = BNK_SCALED_GRADIENT;
460eb910715SAlp Dener           } else {
461eb910715SAlp Dener             ++bnk->bfgs;
462eb910715SAlp Dener             *stepType = BNK_BFGS;
463eb910715SAlp Dener           }
464eb910715SAlp Dener         }
465eb910715SAlp Dener       }
466*8d5ead36SAlp Dener       /* Make sure the safeguarded fall-back step is zero for actively bounded variables */
467*8d5ead36SAlp Dener       ierr = VecScale(tao->stepdirection, -1.0);CHKERRQ(ierr);
468*8d5ead36SAlp Dener       ierr = VecGetSubVector(tao->stepdirection, bnk->active_idx, &active_step);CHKERRQ(ierr);
469*8d5ead36SAlp Dener       ierr = VecSet(active_step, 0.0);CHKERRQ(ierr);
470*8d5ead36SAlp Dener       ierr = VecRestoreSubVector(tao->stepdirection, bnk->active_idx, &active_step);CHKERRQ(ierr);
471eb910715SAlp Dener     } else {
472eb910715SAlp Dener       /* Computed Newton step is descent */
473eb910715SAlp Dener       switch (ksp_reason) {
474eb910715SAlp Dener       case KSP_DIVERGED_NANORINF:
475eb910715SAlp Dener       case KSP_DIVERGED_BREAKDOWN:
476eb910715SAlp Dener       case KSP_DIVERGED_INDEFINITE_MAT:
477eb910715SAlp Dener       case KSP_DIVERGED_INDEFINITE_PC:
478eb910715SAlp Dener       case KSP_CONVERGED_CG_NEG_CURVE:
479eb910715SAlp Dener         /* Matrix or preconditioner is indefinite; increase perturbation */
480eb910715SAlp Dener         if (bnk->pert <= 0.0) {
481eb910715SAlp Dener           /* Initialize the perturbation */
482eb910715SAlp Dener           bnk->pert = PetscMin(bnk->imax, PetscMax(bnk->imin, bnk->imfac * bnk->gnorm));
483eb910715SAlp Dener           if (bnk->is_gltr) {
484eb910715SAlp Dener             ierr = KSPCGGLTRGetMinEig(tao->ksp, &e_min);CHKERRQ(ierr);
485eb910715SAlp Dener             bnk->pert = PetscMax(bnk->pert, -e_min);
486eb910715SAlp Dener           }
487eb910715SAlp Dener         } else {
488eb910715SAlp Dener           /* Increase the perturbation */
489eb910715SAlp Dener           bnk->pert = PetscMin(bnk->pmax, PetscMax(bnk->pgfac * bnk->pert, bnk->pmgfac * bnk->gnorm));
490eb910715SAlp Dener         }
491eb910715SAlp Dener         break;
492eb910715SAlp Dener 
493eb910715SAlp Dener       default:
494eb910715SAlp Dener         /* Newton step computation is good; decrease perturbation */
495eb910715SAlp Dener         bnk->pert = PetscMin(bnk->psfac * bnk->pert, bnk->pmsfac * bnk->gnorm);
496eb910715SAlp Dener         if (bnk->pert < bnk->pmin) {
497eb910715SAlp Dener           bnk->pert = 0.0;
498eb910715SAlp Dener         }
499eb910715SAlp Dener         break;
500eb910715SAlp Dener       }
501eb910715SAlp Dener 
502eb910715SAlp Dener       ++bnk->newt;
503fed79b8eSAlp Dener       *stepType = BNK_NEWTON;
504fed79b8eSAlp Dener     }
505fed79b8eSAlp Dener   } else {
506fed79b8eSAlp Dener     ++bnk->newt;
507fed79b8eSAlp Dener     bnk->pert = 0.0;
508fed79b8eSAlp Dener     *stepType = BNK_NEWTON;
509eb910715SAlp Dener   }
510eb910715SAlp Dener   PetscFunctionReturn(0);
511eb910715SAlp Dener }
512eb910715SAlp Dener 
513df278d8fSAlp Dener /*------------------------------------------------------------*/
514df278d8fSAlp Dener 
515df278d8fSAlp Dener /* Routine for performing a bound-projected More-Thuente line search.
516df278d8fSAlp Dener 
517df278d8fSAlp Dener   Includes fallbacks to BFGS, scaled gradient, and unscaled gradient steps if the
518df278d8fSAlp Dener   Newton step does not produce a valid step length.
519df278d8fSAlp Dener */
520df278d8fSAlp Dener 
521c14b763aSAlp Dener PetscErrorCode TaoBNKPerformLineSearch(Tao tao, PetscInt stepType, PetscReal *steplen, TaoLineSearchConvergedReason *reason)
522c14b763aSAlp Dener {
523c14b763aSAlp Dener   TAO_BNK        *bnk = (TAO_BNK *)tao->data;
524c14b763aSAlp Dener   PetscErrorCode ierr;
525c14b763aSAlp Dener   TaoLineSearchConvergedReason ls_reason;
526c14b763aSAlp Dener 
527*8d5ead36SAlp Dener   Vec            active_step;
528c14b763aSAlp Dener   PetscReal      e_min, gdx, delta;
529c14b763aSAlp Dener   PetscInt       bfgsUpdates;
530c14b763aSAlp Dener 
531c14b763aSAlp Dener   PetscFunctionBegin;
532c14b763aSAlp Dener   /* Perform the linesearch */
533c14b763aSAlp Dener   ierr = TaoLineSearchApply(tao->linesearch, tao->solution, &bnk->f, bnk->unprojected_gradient, tao->stepdirection, steplen, &ls_reason);CHKERRQ(ierr);
534c14b763aSAlp Dener   ierr = VecBoundGradientProjection(bnk->unprojected_gradient,tao->solution,tao->XL,tao->XU,tao->gradient);CHKERRQ(ierr);
535c14b763aSAlp Dener   ierr = TaoAddLineSearchCounts(tao);CHKERRQ(ierr);
536c14b763aSAlp Dener 
537c14b763aSAlp Dener   while (ls_reason != TAOLINESEARCH_SUCCESS && ls_reason != TAOLINESEARCH_SUCCESS_USER && stepType != BNK_GRADIENT) {
538c14b763aSAlp Dener     /* Linesearch failed, revert solution */
539c14b763aSAlp Dener     bnk->f = bnk->fold;
540c14b763aSAlp Dener     ierr = VecCopy(bnk->Xold, tao->solution);CHKERRQ(ierr);
541c14b763aSAlp Dener     ierr = VecCopy(bnk->Gold, tao->gradient);CHKERRQ(ierr);
542c14b763aSAlp Dener     ierr = VecCopy(bnk->unprojected_gradient_old, bnk->unprojected_gradient);CHKERRQ(ierr);
543c14b763aSAlp Dener 
544c14b763aSAlp Dener     switch(stepType) {
545c14b763aSAlp Dener     case BNK_NEWTON:
546*8d5ead36SAlp Dener       /* Failed to obtain acceptable iterate with Newton step
547c14b763aSAlp Dener          Update the perturbation for next time */
548c14b763aSAlp Dener       --bnk->newt;
549c14b763aSAlp Dener       if (bnk->pert <= 0.0) {
550c14b763aSAlp Dener         /* Initialize the perturbation */
551c14b763aSAlp Dener         bnk->pert = PetscMin(bnk->imax, PetscMax(bnk->imin, bnk->imfac * bnk->gnorm));
552c14b763aSAlp Dener         if (bnk->is_gltr) {
553c14b763aSAlp Dener           ierr = KSPCGGLTRGetMinEig(tao->ksp,&e_min);CHKERRQ(ierr);
554c14b763aSAlp Dener           bnk->pert = PetscMax(bnk->pert, -e_min);
555c14b763aSAlp Dener         }
556c14b763aSAlp Dener       } else {
557c14b763aSAlp Dener         /* Increase the perturbation */
558c14b763aSAlp Dener         bnk->pert = PetscMin(bnk->pmax, PetscMax(bnk->pgfac * bnk->pert, bnk->pmgfac * bnk->gnorm));
559c14b763aSAlp Dener       }
560c14b763aSAlp Dener 
561c14b763aSAlp Dener       if (BNK_PC_BFGS != bnk->pc_type) {
562c14b763aSAlp Dener         /* We don't have the bfgs matrix around and being updated
563c14b763aSAlp Dener            Must use gradient direction in this case */
564c14b763aSAlp Dener         ierr = VecCopy(tao->gradient, tao->stepdirection);CHKERRQ(ierr);
565c14b763aSAlp Dener         ++bnk->grad;
566c14b763aSAlp Dener         stepType = BNK_GRADIENT;
567c14b763aSAlp Dener       } else {
568c14b763aSAlp Dener         /* Attempt to use the BFGS direction */
569c14b763aSAlp Dener         ierr = MatLMVMSolve(bnk->M, bnk->unprojected_gradient, tao->stepdirection);CHKERRQ(ierr);
570*8d5ead36SAlp Dener         /* Check for success (descent direction)
571*8d5ead36SAlp Dener            NOTE: Negative gdx means not a descent direction because the step here is missing a negative sign. */
572c14b763aSAlp Dener         ierr = VecDot(tao->gradient, tao->stepdirection, &gdx);CHKERRQ(ierr);
573c14b763aSAlp Dener         if ((gdx <= 0) || PetscIsInfOrNanReal(gdx)) {
574c14b763aSAlp Dener           /* BFGS direction is not descent or direction produced not a number
575c14b763aSAlp Dener              We can assert bfgsUpdates > 1 in this case
576c14b763aSAlp Dener              Use steepest descent direction (scaled) */
577c14b763aSAlp Dener           if (bnk->f != 0.0) {
578c14b763aSAlp Dener             delta = 2.0 * PetscAbsScalar(bnk->f) / (bnk->gnorm*bnk->gnorm);
579c14b763aSAlp Dener           } else {
580c14b763aSAlp Dener             delta = 2.0 / (bnk->gnorm*bnk->gnorm);
581c14b763aSAlp Dener           }
582c14b763aSAlp Dener           ierr = MatLMVMSetDelta(bnk->M, delta);CHKERRQ(ierr);
583c14b763aSAlp Dener           ierr = MatLMVMReset(bnk->M);CHKERRQ(ierr);
584c14b763aSAlp Dener           ierr = MatLMVMUpdate(bnk->M, tao->solution, bnk->unprojected_gradient);CHKERRQ(ierr);
585c14b763aSAlp Dener           ierr = MatLMVMSolve(bnk->M, bnk->unprojected_gradient, tao->stepdirection);CHKERRQ(ierr);
586c14b763aSAlp Dener 
587c14b763aSAlp Dener           bfgsUpdates = 1;
588c14b763aSAlp Dener           ++bnk->sgrad;
589c14b763aSAlp Dener           stepType = BNK_SCALED_GRADIENT;
590c14b763aSAlp Dener         } else {
591c14b763aSAlp Dener           ierr = MatLMVMGetUpdates(bnk->M, &bfgsUpdates);CHKERRQ(ierr);
592c14b763aSAlp Dener           if (1 == bfgsUpdates) {
593c14b763aSAlp Dener             /* The first BFGS direction is always the scaled gradient */
594c14b763aSAlp Dener             ++bnk->sgrad;
595c14b763aSAlp Dener             stepType = BNK_SCALED_GRADIENT;
596c14b763aSAlp Dener           } else {
597c14b763aSAlp Dener             ++bnk->bfgs;
598c14b763aSAlp Dener             stepType = BNK_BFGS;
599c14b763aSAlp Dener           }
600c14b763aSAlp Dener         }
601c14b763aSAlp Dener       }
602c14b763aSAlp Dener       break;
603c14b763aSAlp Dener 
604c14b763aSAlp Dener     case BNK_BFGS:
605c14b763aSAlp Dener       /* Can only enter if pc_type == BNK_PC_BFGS
606c14b763aSAlp Dener          Failed to obtain acceptable iterate with BFGS step
607c14b763aSAlp Dener          Attempt to use the scaled gradient direction */
608c14b763aSAlp Dener       if (bnk->f != 0.0) {
609c14b763aSAlp Dener         delta = 2.0 * PetscAbsScalar(bnk->f) / (bnk->gnorm*bnk->gnorm);
610c14b763aSAlp Dener       } else {
611c14b763aSAlp Dener         delta = 2.0 / (bnk->gnorm*bnk->gnorm);
612c14b763aSAlp Dener       }
613c14b763aSAlp Dener       ierr = MatLMVMSetDelta(bnk->M, delta);CHKERRQ(ierr);
614c14b763aSAlp Dener       ierr = MatLMVMReset(bnk->M);CHKERRQ(ierr);
615c14b763aSAlp Dener       ierr = MatLMVMUpdate(bnk->M, tao->solution, bnk->unprojected_gradient);CHKERRQ(ierr);
616c14b763aSAlp Dener       ierr = MatLMVMSolve(bnk->M, bnk->unprojected_gradient, tao->stepdirection);CHKERRQ(ierr);
617c14b763aSAlp Dener 
618c14b763aSAlp Dener       bfgsUpdates = 1;
619c14b763aSAlp Dener       ++bnk->sgrad;
620c14b763aSAlp Dener       stepType = BNK_SCALED_GRADIENT;
621c14b763aSAlp Dener       break;
622c14b763aSAlp Dener 
623c14b763aSAlp Dener     case BNK_SCALED_GRADIENT:
624c14b763aSAlp Dener       /* Can only enter if pc_type == BNK_PC_BFGS
625c14b763aSAlp Dener          The scaled gradient step did not produce a new iterate;
626c14b763aSAlp Dener          attemp to use the gradient direction.
627c14b763aSAlp Dener          Need to make sure we are not using a different diagonal scaling */
628c14b763aSAlp Dener       ierr = MatLMVMSetScale(bnk->M,0);CHKERRQ(ierr);
629c14b763aSAlp Dener       ierr = MatLMVMSetDelta(bnk->M,1.0);CHKERRQ(ierr);
630c14b763aSAlp Dener       ierr = MatLMVMReset(bnk->M);CHKERRQ(ierr);
631c14b763aSAlp Dener       ierr = MatLMVMUpdate(bnk->M, tao->solution, bnk->unprojected_gradient);CHKERRQ(ierr);
632c14b763aSAlp Dener       ierr = MatLMVMSolve(bnk->M, bnk->unprojected_gradient, tao->stepdirection);CHKERRQ(ierr);
633c14b763aSAlp Dener 
634c14b763aSAlp Dener       bfgsUpdates = 1;
635c14b763aSAlp Dener       ++bnk->grad;
636c14b763aSAlp Dener       stepType = BNK_GRADIENT;
637c14b763aSAlp Dener       break;
638c14b763aSAlp Dener     }
639*8d5ead36SAlp Dener     /* Make sure the safeguarded fall-back step is zero for actively bounded variables */
640*8d5ead36SAlp Dener     ierr = VecScale(tao->stepdirection, -1.0);CHKERRQ(ierr);
641*8d5ead36SAlp Dener     ierr = VecGetSubVector(tao->stepdirection, bnk->active_idx, &active_step);CHKERRQ(ierr);
642*8d5ead36SAlp Dener     ierr = VecSet(active_step, 0.0);CHKERRQ(ierr);
643*8d5ead36SAlp Dener     ierr = VecRestoreSubVector(tao->stepdirection, bnk->active_idx, &active_step);CHKERRQ(ierr);
644c14b763aSAlp Dener 
645*8d5ead36SAlp Dener     /* Perform one last line search with the fall-back step */
646c14b763aSAlp Dener     ierr = TaoLineSearchApply(tao->linesearch, tao->solution, &bnk->f, bnk->unprojected_gradient, tao->stepdirection, steplen, &ls_reason);CHKERRQ(ierr);
647c14b763aSAlp Dener     ierr = VecBoundGradientProjection(bnk->unprojected_gradient,tao->solution,tao->XL,tao->XU,tao->gradient);CHKERRQ(ierr);
648c14b763aSAlp Dener     ierr = TaoAddLineSearchCounts(tao);CHKERRQ(ierr);
649c14b763aSAlp Dener   }
650c14b763aSAlp Dener   *reason = ls_reason;
651c14b763aSAlp Dener   PetscFunctionReturn(0);
652c14b763aSAlp Dener }
653c14b763aSAlp Dener 
654df278d8fSAlp Dener /*------------------------------------------------------------*/
655df278d8fSAlp Dener 
656df278d8fSAlp Dener /* Routine for updating the trust radius.
657df278d8fSAlp Dener 
658df278d8fSAlp Dener   Function features three different update methods:
659df278d8fSAlp Dener   1) Line-search step length based
660df278d8fSAlp Dener   2) Predicted decrease on the CG quadratic model
661df278d8fSAlp Dener   3) Interpolation
662df278d8fSAlp Dener */
663df278d8fSAlp Dener 
664b1c2d0e3SAlp Dener PetscErrorCode TaoBNKUpdateTrustRadius(Tao tao, PetscReal prered, PetscReal actred, PetscInt stepType, PetscBool *accept)
665080d2917SAlp Dener {
666080d2917SAlp Dener   TAO_BNK        *bnk = (TAO_BNK *)tao->data;
667080d2917SAlp Dener   PetscErrorCode ierr;
668080d2917SAlp Dener 
669b1c2d0e3SAlp Dener   PetscReal      step, kappa;
670080d2917SAlp Dener   PetscReal      gdx, tau_1, tau_2, tau_min, tau_max;
671080d2917SAlp Dener 
672080d2917SAlp Dener   PetscFunctionBegin;
673080d2917SAlp Dener   /* Update trust region radius */
674080d2917SAlp Dener   *accept = PETSC_FALSE;
675080d2917SAlp Dener   switch(bnk->update_type) {
676080d2917SAlp Dener   case BNK_UPDATE_STEP:
677c14b763aSAlp Dener     *accept = PETSC_TRUE; /* always accept here because line search succeeded */
678080d2917SAlp Dener     if (stepType == BNK_NEWTON) {
679080d2917SAlp Dener       ierr = TaoLineSearchGetStepLength(tao->linesearch, &step);CHKERRQ(ierr);
680080d2917SAlp Dener       if (step < bnk->nu1) {
681080d2917SAlp Dener         /* Very bad step taken; reduce radius */
682080d2917SAlp Dener         tao->trust = bnk->omega1 * PetscMin(bnk->dnorm, tao->trust);
683080d2917SAlp Dener       } else if (step < bnk->nu2) {
684080d2917SAlp Dener         /* Reasonably bad step taken; reduce radius */
685080d2917SAlp Dener         tao->trust = bnk->omega2 * PetscMin(bnk->dnorm, tao->trust);
686080d2917SAlp Dener       } else if (step < bnk->nu3) {
687080d2917SAlp Dener         /*  Reasonable step was taken; leave radius alone */
688080d2917SAlp Dener         if (bnk->omega3 < 1.0) {
689080d2917SAlp Dener           tao->trust = bnk->omega3 * PetscMin(bnk->dnorm, tao->trust);
690080d2917SAlp Dener         } else if (bnk->omega3 > 1.0) {
691080d2917SAlp Dener           tao->trust = PetscMax(bnk->omega3 * bnk->dnorm, tao->trust);
692080d2917SAlp Dener         }
693080d2917SAlp Dener       } else if (step < bnk->nu4) {
694080d2917SAlp Dener         /*  Full step taken; increase the radius */
695080d2917SAlp Dener         tao->trust = PetscMax(bnk->omega4 * bnk->dnorm, tao->trust);
696080d2917SAlp Dener       } else {
697080d2917SAlp Dener         /*  More than full step taken; increase the radius */
698080d2917SAlp Dener         tao->trust = PetscMax(bnk->omega5 * bnk->dnorm, tao->trust);
699080d2917SAlp Dener       }
700080d2917SAlp Dener     } else {
701080d2917SAlp Dener       /*  Newton step was not good; reduce the radius */
702080d2917SAlp Dener       tao->trust = bnk->omega1 * PetscMin(bnk->dnorm, tao->trust);
703080d2917SAlp Dener     }
704080d2917SAlp Dener     break;
705080d2917SAlp Dener 
706080d2917SAlp Dener   case BNK_UPDATE_REDUCTION:
707080d2917SAlp Dener     if (stepType == BNK_NEWTON) {
708b1c2d0e3SAlp Dener       if (prered < 0.0) {
709fed79b8eSAlp Dener         /* The predicted reduction has the wrong sign.  This cannot
710fed79b8eSAlp Dener            happen in infinite precision arithmetic.  Step should
711fed79b8eSAlp Dener            be rejected! */
712080d2917SAlp Dener         tao->trust = bnk->alpha1 * PetscMin(tao->trust, bnk->dnorm);
713fed79b8eSAlp Dener       }
714fed79b8eSAlp Dener       else {
715b1c2d0e3SAlp Dener         if (PetscIsInfOrNanReal(actred)) {
716080d2917SAlp Dener           tao->trust = bnk->alpha1 * PetscMin(tao->trust, bnk->dnorm);
717080d2917SAlp Dener         } else {
718080d2917SAlp Dener           if ((PetscAbsScalar(actred) <= bnk->epsilon) &&
719080d2917SAlp Dener               (PetscAbsScalar(prered) <= bnk->epsilon)) {
720080d2917SAlp Dener             kappa = 1.0;
721fed79b8eSAlp Dener           }
722fed79b8eSAlp Dener           else {
723080d2917SAlp Dener             kappa = actred / prered;
724080d2917SAlp Dener           }
725fed79b8eSAlp Dener 
726fed79b8eSAlp Dener           /* Accept or reject the step and update radius */
727080d2917SAlp Dener           if (kappa < bnk->eta1) {
728fed79b8eSAlp Dener             /* Reject the step */
729080d2917SAlp Dener             tao->trust = bnk->alpha1 * PetscMin(tao->trust, bnk->dnorm);
730fed79b8eSAlp Dener           }
731fed79b8eSAlp Dener           else {
732fed79b8eSAlp Dener             /* Accept the step */
733c133c014SAlp Dener             *accept = PETSC_TRUE;
734c133c014SAlp Dener             /* Update the trust region radius only if the computed step is at the trust radius boundary */
735*8d5ead36SAlp Dener             if (bnk->dnorm == tao->trust) {
736080d2917SAlp Dener               if (kappa < bnk->eta2) {
737080d2917SAlp Dener                 /* Marginal bad step */
738c133c014SAlp Dener                 tao->trust = bnk->alpha2 * tao->trust;
739080d2917SAlp Dener               }
740fed79b8eSAlp Dener               else if (kappa < bnk->eta3) {
741fed79b8eSAlp Dener                 /* Reasonable step */
742fed79b8eSAlp Dener                 tao->trust = bnk->alpha3 * tao->trust;
743fed79b8eSAlp Dener               }
744fed79b8eSAlp Dener               else if (kappa < bnk->eta4) {
745080d2917SAlp Dener                 /* Good step */
746c133c014SAlp Dener                 tao->trust = bnk->alpha4 * tao->trust;
747fed79b8eSAlp Dener               }
748fed79b8eSAlp Dener               else {
749080d2917SAlp Dener                 /* Very good step */
750c133c014SAlp Dener                 tao->trust = bnk->alpha5 * tao->trust;
751080d2917SAlp Dener               }
752c133c014SAlp Dener             }
753080d2917SAlp Dener           }
754080d2917SAlp Dener         }
755080d2917SAlp Dener       }
756080d2917SAlp Dener     } else {
757080d2917SAlp Dener       /*  Newton step was not good; reduce the radius */
758080d2917SAlp Dener       tao->trust = bnk->alpha1 * PetscMin(bnk->dnorm, tao->trust);
759080d2917SAlp Dener     }
760080d2917SAlp Dener     break;
761080d2917SAlp Dener 
762080d2917SAlp Dener   default:
763080d2917SAlp Dener     if (stepType == BNK_NEWTON) {
764b1c2d0e3SAlp Dener       if (prered < 0.0) {
765080d2917SAlp Dener         /*  The predicted reduction has the wrong sign.  This cannot */
766080d2917SAlp Dener         /*  happen in infinite precision arithmetic.  Step should */
767080d2917SAlp Dener         /*  be rejected! */
768080d2917SAlp Dener         tao->trust = bnk->gamma1 * PetscMin(tao->trust, bnk->dnorm);
769080d2917SAlp Dener       } else {
770b1c2d0e3SAlp Dener         if (PetscIsInfOrNanReal(actred)) {
771080d2917SAlp Dener           tao->trust = bnk->gamma1 * PetscMin(tao->trust, bnk->dnorm);
772080d2917SAlp Dener         } else {
773080d2917SAlp Dener           if ((PetscAbsScalar(actred) <= bnk->epsilon) && (PetscAbsScalar(prered) <= bnk->epsilon)) {
774080d2917SAlp Dener             kappa = 1.0;
775080d2917SAlp Dener           } else {
776080d2917SAlp Dener             kappa = actred / prered;
777080d2917SAlp Dener           }
778080d2917SAlp Dener 
779080d2917SAlp Dener           ierr = VecDot(tao->gradient, tao->stepdirection, &gdx);CHKERRQ(ierr);
780080d2917SAlp Dener           tau_1 = bnk->theta * gdx / (bnk->theta * gdx - (1.0 - bnk->theta) * prered + actred);
781080d2917SAlp Dener           tau_2 = bnk->theta * gdx / (bnk->theta * gdx + (1.0 + bnk->theta) * prered - actred);
782080d2917SAlp Dener           tau_min = PetscMin(tau_1, tau_2);
783080d2917SAlp Dener           tau_max = PetscMax(tau_1, tau_2);
784080d2917SAlp Dener 
785080d2917SAlp Dener           if (kappa >= 1.0 - bnk->mu1) {
786080d2917SAlp Dener             /*  Great agreement */
787080d2917SAlp Dener             *accept = PETSC_TRUE;
788080d2917SAlp Dener             if (tau_max < 1.0) {
789080d2917SAlp Dener               tao->trust = PetscMax(tao->trust, bnk->gamma3 * bnk->dnorm);
790080d2917SAlp Dener             } else if (tau_max > bnk->gamma4) {
791080d2917SAlp Dener               tao->trust = PetscMax(tao->trust, bnk->gamma4 * bnk->dnorm);
792080d2917SAlp Dener             } else {
793080d2917SAlp Dener               tao->trust = PetscMax(tao->trust, tau_max * bnk->dnorm);
794080d2917SAlp Dener             }
795080d2917SAlp Dener           } else if (kappa >= 1.0 - bnk->mu2) {
796080d2917SAlp Dener             /*  Good agreement */
797080d2917SAlp Dener             *accept = PETSC_TRUE;
798080d2917SAlp Dener             if (tau_max < bnk->gamma2) {
799080d2917SAlp Dener               tao->trust = bnk->gamma2 * PetscMin(tao->trust, bnk->dnorm);
800080d2917SAlp Dener             } else if (tau_max > bnk->gamma3) {
801080d2917SAlp Dener               tao->trust = PetscMax(tao->trust, bnk->gamma3 * bnk->dnorm);
802080d2917SAlp Dener             } else if (tau_max < 1.0) {
803080d2917SAlp Dener               tao->trust = tau_max * PetscMin(tao->trust, bnk->dnorm);
804080d2917SAlp Dener             } else {
805080d2917SAlp Dener               tao->trust = PetscMax(tao->trust, tau_max * bnk->dnorm);
806080d2917SAlp Dener             }
807080d2917SAlp Dener           } else {
808080d2917SAlp Dener             /*  Not good agreement */
809080d2917SAlp Dener             if (tau_min > 1.0) {
810080d2917SAlp Dener               tao->trust = bnk->gamma2 * PetscMin(tao->trust, bnk->dnorm);
811080d2917SAlp Dener             } else if (tau_max < bnk->gamma1) {
812080d2917SAlp Dener               tao->trust = bnk->gamma1 * PetscMin(tao->trust, bnk->dnorm);
813080d2917SAlp Dener             } else if ((tau_min < bnk->gamma1) && (tau_max >= 1.0)) {
814080d2917SAlp Dener               tao->trust = bnk->gamma1 * PetscMin(tao->trust, bnk->dnorm);
815080d2917SAlp Dener             } else if ((tau_1 >= bnk->gamma1) && (tau_1 < 1.0) && ((tau_2 < bnk->gamma1) || (tau_2 >= 1.0))) {
816080d2917SAlp Dener               tao->trust = tau_1 * PetscMin(tao->trust, bnk->dnorm);
817080d2917SAlp Dener             } else if ((tau_2 >= bnk->gamma1) && (tau_2 < 1.0) && ((tau_1 < bnk->gamma1) || (tau_2 >= 1.0))) {
818080d2917SAlp Dener               tao->trust = tau_2 * PetscMin(tao->trust, bnk->dnorm);
819080d2917SAlp Dener             } else {
820080d2917SAlp Dener               tao->trust = tau_max * PetscMin(tao->trust, bnk->dnorm);
821080d2917SAlp Dener             }
822080d2917SAlp Dener           }
823080d2917SAlp Dener         }
824080d2917SAlp Dener       }
825080d2917SAlp Dener     } else {
826080d2917SAlp Dener       /*  Newton step was not good; reduce the radius */
827080d2917SAlp Dener       tao->trust = bnk->gamma1 * PetscMin(bnk->dnorm, tao->trust);
828080d2917SAlp Dener     }
829080d2917SAlp Dener   }
830c133c014SAlp Dener   /* Make sure the radius does not violate min and max settings */
831c133c014SAlp Dener   tao->trust = PetscMin(tao->trust, bnk->max_radius);
832fed79b8eSAlp Dener   tao->trust = PetscMax(tao->trust, bnk->min_radius);
833080d2917SAlp Dener   PetscFunctionReturn(0);
834080d2917SAlp Dener }
835080d2917SAlp Dener 
836eb910715SAlp Dener /* ---------------------------------------------------------- */
837df278d8fSAlp Dener 
838eb910715SAlp Dener static PetscErrorCode TaoSetUp_BNK(Tao tao)
839eb910715SAlp Dener {
840eb910715SAlp Dener   TAO_BNK        *bnk = (TAO_BNK *)tao->data;
841eb910715SAlp Dener   PetscErrorCode ierr;
842eb910715SAlp Dener 
843eb910715SAlp Dener   PetscFunctionBegin;
844eb910715SAlp Dener   if (!tao->gradient) {ierr = VecDuplicate(tao->solution,&tao->gradient);CHKERRQ(ierr);}
845eb910715SAlp Dener   if (!tao->stepdirection) {ierr = VecDuplicate(tao->solution,&tao->stepdirection);CHKERRQ(ierr);}
846eb910715SAlp Dener   if (!bnk->W) {ierr = VecDuplicate(tao->solution,&bnk->W);CHKERRQ(ierr);}
847eb910715SAlp Dener   if (!bnk->Xold) {ierr = VecDuplicate(tao->solution,&bnk->Xold);CHKERRQ(ierr);}
848eb910715SAlp Dener   if (!bnk->Gold) {ierr = VecDuplicate(tao->solution,&bnk->Gold);CHKERRQ(ierr);}
84909164190SAlp Dener   if (!bnk->Xwork) {ierr = VecDuplicate(tao->solution,&bnk->Xwork);CHKERRQ(ierr);}
85009164190SAlp Dener   if (!bnk->Gwork) {ierr = VecDuplicate(tao->solution,&bnk->Gwork);CHKERRQ(ierr);}
85109164190SAlp Dener   if (!bnk->unprojected_gradient) {ierr = VecDuplicate(tao->solution,&bnk->unprojected_gradient);CHKERRQ(ierr);}
85209164190SAlp Dener   if (!bnk->unprojected_gradient_old) {ierr = VecDuplicate(tao->solution,&bnk->unprojected_gradient_old);CHKERRQ(ierr);}
853eb910715SAlp Dener   bnk->Diag = 0;
854eb910715SAlp Dener   bnk->M = 0;
85509164190SAlp Dener   bnk->H_inactive = 0;
85609164190SAlp Dener   bnk->Hpre_inactive = 0;
857eb910715SAlp Dener   PetscFunctionReturn(0);
858eb910715SAlp Dener }
859eb910715SAlp Dener 
860eb910715SAlp Dener /*------------------------------------------------------------*/
861df278d8fSAlp Dener 
862eb910715SAlp Dener static PetscErrorCode TaoDestroy_BNK(Tao tao)
863eb910715SAlp Dener {
864eb910715SAlp Dener   TAO_BNK        *bnk = (TAO_BNK *)tao->data;
865eb910715SAlp Dener   PetscErrorCode ierr;
866eb910715SAlp Dener 
867eb910715SAlp Dener   PetscFunctionBegin;
868eb910715SAlp Dener   if (tao->setupcalled) {
869eb910715SAlp Dener     ierr = VecDestroy(&bnk->W);CHKERRQ(ierr);
870eb910715SAlp Dener     ierr = VecDestroy(&bnk->Xold);CHKERRQ(ierr);
871eb910715SAlp Dener     ierr = VecDestroy(&bnk->Gold);CHKERRQ(ierr);
87209164190SAlp Dener     ierr = VecDestroy(&bnk->Xwork);CHKERRQ(ierr);
87309164190SAlp Dener     ierr = VecDestroy(&bnk->Gwork);CHKERRQ(ierr);
87409164190SAlp Dener     ierr = VecDestroy(&bnk->unprojected_gradient);CHKERRQ(ierr);
87509164190SAlp Dener     ierr = VecDestroy(&bnk->unprojected_gradient_old);CHKERRQ(ierr);
876eb910715SAlp Dener   }
877eb910715SAlp Dener   ierr = VecDestroy(&bnk->Diag);CHKERRQ(ierr);
878eb910715SAlp Dener   ierr = MatDestroy(&bnk->M);CHKERRQ(ierr);
879eb910715SAlp Dener   ierr = PetscFree(tao->data);CHKERRQ(ierr);
880eb910715SAlp Dener   PetscFunctionReturn(0);
881eb910715SAlp Dener }
882eb910715SAlp Dener 
883eb910715SAlp Dener /*------------------------------------------------------------*/
884df278d8fSAlp Dener 
885eb910715SAlp Dener static PetscErrorCode TaoSetFromOptions_BNK(PetscOptionItems *PetscOptionsObject,Tao tao)
886eb910715SAlp Dener {
887eb910715SAlp Dener   TAO_BNK        *bnk = (TAO_BNK *)tao->data;
888eb910715SAlp Dener   PetscErrorCode ierr;
889eb910715SAlp Dener 
890eb910715SAlp Dener   PetscFunctionBegin;
891eb910715SAlp Dener   ierr = PetscOptionsHead(PetscOptionsObject,"Newton line search method for unconstrained optimization");CHKERRQ(ierr);
892*8d5ead36SAlp Dener   ierr = PetscOptionsEList("-tao_bnk_pc_type", "pc type", "", BNK_PC, BNK_PC_TYPES, BNK_PC[bnk->pc_type], &bnk->pc_type, 0);CHKERRQ(ierr);
893*8d5ead36SAlp Dener   ierr = PetscOptionsEList("-tao_bnk_bfgs_scale_type", "bfgs scale type", "", BFGS_SCALE, BFGS_SCALE_TYPES, BFGS_SCALE[bnk->bfgs_scale_type], &bnk->bfgs_scale_type, 0);CHKERRQ(ierr);
894*8d5ead36SAlp Dener   ierr = PetscOptionsEList("-tao_bnk_init_type", "radius initialization type", "", BNK_INIT, BNK_INIT_TYPES, BNK_INIT[bnk->init_type], &bnk->init_type, 0);CHKERRQ(ierr);
895*8d5ead36SAlp Dener   ierr = PetscOptionsEList("-tao_bnk_update_type", "radius update type", "", BNK_UPDATE, BNK_UPDATE_TYPES, BNK_UPDATE[bnk->update_type], &bnk->update_type, 0);CHKERRQ(ierr);
896*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_sval", "perturbation starting value", "", bnk->sval, &bnk->sval,NULL);CHKERRQ(ierr);
897*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_imin", "minimum initial perturbation", "", bnk->imin, &bnk->imin,NULL);CHKERRQ(ierr);
898*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_imax", "maximum initial perturbation", "", bnk->imax, &bnk->imax,NULL);CHKERRQ(ierr);
899*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_imfac", "initial merit factor", "", bnk->imfac, &bnk->imfac,NULL);CHKERRQ(ierr);
900*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_pmin", "minimum perturbation", "", bnk->pmin, &bnk->pmin,NULL);CHKERRQ(ierr);
901*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_pmax", "maximum perturbation", "", bnk->pmax, &bnk->pmax,NULL);CHKERRQ(ierr);
902*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_pgfac", "growth factor", "", bnk->pgfac, &bnk->pgfac,NULL);CHKERRQ(ierr);
903*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_psfac", "shrink factor", "", bnk->psfac, &bnk->psfac,NULL);CHKERRQ(ierr);
904*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_pmgfac", "merit growth factor", "", bnk->pmgfac, &bnk->pmgfac,NULL);CHKERRQ(ierr);
905*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_pmsfac", "merit shrink factor", "", bnk->pmsfac, &bnk->pmsfac,NULL);CHKERRQ(ierr);
906*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_eta1", "poor steplength; reduce radius", "", bnk->eta1, &bnk->eta1,NULL);CHKERRQ(ierr);
907*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_eta2", "reasonable steplength; leave radius alone", "", bnk->eta2, &bnk->eta2,NULL);CHKERRQ(ierr);
908*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_eta3", "good steplength; increase radius", "", bnk->eta3, &bnk->eta3,NULL);CHKERRQ(ierr);
909*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_eta4", "excellent steplength; greatly increase radius", "", bnk->eta4, &bnk->eta4,NULL);CHKERRQ(ierr);
910*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_alpha1", "", "", bnk->alpha1, &bnk->alpha1,NULL);CHKERRQ(ierr);
911*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_alpha2", "", "", bnk->alpha2, &bnk->alpha2,NULL);CHKERRQ(ierr);
912*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_alpha3", "", "", bnk->alpha3, &bnk->alpha3,NULL);CHKERRQ(ierr);
913*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_alpha4", "", "", bnk->alpha4, &bnk->alpha4,NULL);CHKERRQ(ierr);
914*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_alpha5", "", "", bnk->alpha5, &bnk->alpha5,NULL);CHKERRQ(ierr);
915*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_nu1", "poor steplength; reduce radius", "", bnk->nu1, &bnk->nu1,NULL);CHKERRQ(ierr);
916*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_nu2", "reasonable steplength; leave radius alone", "", bnk->nu2, &bnk->nu2,NULL);CHKERRQ(ierr);
917*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_nu3", "good steplength; increase radius", "", bnk->nu3, &bnk->nu3,NULL);CHKERRQ(ierr);
918*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_nu4", "excellent steplength; greatly increase radius", "", bnk->nu4, &bnk->nu4,NULL);CHKERRQ(ierr);
919*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_omega1", "", "", bnk->omega1, &bnk->omega1,NULL);CHKERRQ(ierr);
920*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_omega2", "", "", bnk->omega2, &bnk->omega2,NULL);CHKERRQ(ierr);
921*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_omega3", "", "", bnk->omega3, &bnk->omega3,NULL);CHKERRQ(ierr);
922*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_omega4", "", "", bnk->omega4, &bnk->omega4,NULL);CHKERRQ(ierr);
923*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_omega5", "", "", bnk->omega5, &bnk->omega5,NULL);CHKERRQ(ierr);
924*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_mu1_i", "", "", bnk->mu1_i, &bnk->mu1_i,NULL);CHKERRQ(ierr);
925*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_mu2_i", "", "", bnk->mu2_i, &bnk->mu2_i,NULL);CHKERRQ(ierr);
926*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_gamma1_i", "", "", bnk->gamma1_i, &bnk->gamma1_i,NULL);CHKERRQ(ierr);
927*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_gamma2_i", "", "", bnk->gamma2_i, &bnk->gamma2_i,NULL);CHKERRQ(ierr);
928*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_gamma3_i", "", "", bnk->gamma3_i, &bnk->gamma3_i,NULL);CHKERRQ(ierr);
929*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_gamma4_i", "", "", bnk->gamma4_i, &bnk->gamma4_i,NULL);CHKERRQ(ierr);
930*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_theta_i", "", "", bnk->theta_i, &bnk->theta_i,NULL);CHKERRQ(ierr);
931*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_mu1", "", "", bnk->mu1, &bnk->mu1,NULL);CHKERRQ(ierr);
932*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_mu2", "", "", bnk->mu2, &bnk->mu2,NULL);CHKERRQ(ierr);
933*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_gamma1", "", "", bnk->gamma1, &bnk->gamma1,NULL);CHKERRQ(ierr);
934*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_gamma2", "", "", bnk->gamma2, &bnk->gamma2,NULL);CHKERRQ(ierr);
935*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_gamma3", "", "", bnk->gamma3, &bnk->gamma3,NULL);CHKERRQ(ierr);
936*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_gamma4", "", "", bnk->gamma4, &bnk->gamma4,NULL);CHKERRQ(ierr);
937*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_theta", "", "", bnk->theta, &bnk->theta,NULL);CHKERRQ(ierr);
938*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_min_radius", "lower bound on initial radius", "", bnk->min_radius, &bnk->min_radius,NULL);CHKERRQ(ierr);
939*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_max_radius", "upper bound on radius", "", bnk->max_radius, &bnk->max_radius,NULL);CHKERRQ(ierr);
940*8d5ead36SAlp Dener   ierr = PetscOptionsReal("-tao_bnk_epsilon", "tolerance used when computing actual and predicted reduction", "", bnk->epsilon, &bnk->epsilon,NULL);CHKERRQ(ierr);
941eb910715SAlp Dener   ierr = PetscOptionsTail();CHKERRQ(ierr);
942eb910715SAlp Dener   ierr = TaoLineSearchSetFromOptions(tao->linesearch);CHKERRQ(ierr);
943eb910715SAlp Dener   ierr = KSPSetFromOptions(tao->ksp);CHKERRQ(ierr);
944eb910715SAlp Dener   PetscFunctionReturn(0);
945eb910715SAlp Dener }
946eb910715SAlp Dener 
947eb910715SAlp Dener /*------------------------------------------------------------*/
948df278d8fSAlp Dener 
949eb910715SAlp Dener static PetscErrorCode TaoView_BNK(Tao tao, PetscViewer viewer)
950eb910715SAlp Dener {
951eb910715SAlp Dener   TAO_BNK        *bnk = (TAO_BNK *)tao->data;
952eb910715SAlp Dener   PetscInt       nrejects;
953eb910715SAlp Dener   PetscBool      isascii;
954eb910715SAlp Dener   PetscErrorCode ierr;
955eb910715SAlp Dener 
956eb910715SAlp Dener   PetscFunctionBegin;
957eb910715SAlp Dener   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
958eb910715SAlp Dener   if (isascii) {
959eb910715SAlp Dener     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
960eb910715SAlp Dener     if (BNK_PC_BFGS == bnk->pc_type && bnk->M) {
961eb910715SAlp Dener       ierr = MatLMVMGetRejects(bnk->M,&nrejects);CHKERRQ(ierr);
962eb910715SAlp Dener       ierr = PetscViewerASCIIPrintf(viewer, "Rejected matrix updates: %D\n",nrejects);CHKERRQ(ierr);
963eb910715SAlp Dener     }
964eb910715SAlp Dener     ierr = PetscViewerASCIIPrintf(viewer, "Newton steps: %D\n", bnk->newt);CHKERRQ(ierr);
965eb910715SAlp Dener     ierr = PetscViewerASCIIPrintf(viewer, "BFGS steps: %D\n", bnk->bfgs);CHKERRQ(ierr);
966eb910715SAlp Dener     ierr = PetscViewerASCIIPrintf(viewer, "Scaled gradient steps: %D\n", bnk->sgrad);CHKERRQ(ierr);
967eb910715SAlp Dener     ierr = PetscViewerASCIIPrintf(viewer, "Gradient steps: %D\n", bnk->grad);CHKERRQ(ierr);
968eb910715SAlp Dener     ierr = PetscViewerASCIIPrintf(viewer, "KSP termination reasons:\n");CHKERRQ(ierr);
969eb910715SAlp Dener     ierr = PetscViewerASCIIPrintf(viewer, "  atol: %D\n", bnk->ksp_atol);CHKERRQ(ierr);
970eb910715SAlp Dener     ierr = PetscViewerASCIIPrintf(viewer, "  rtol: %D\n", bnk->ksp_rtol);CHKERRQ(ierr);
971eb910715SAlp Dener     ierr = PetscViewerASCIIPrintf(viewer, "  ctol: %D\n", bnk->ksp_ctol);CHKERRQ(ierr);
972eb910715SAlp Dener     ierr = PetscViewerASCIIPrintf(viewer, "  negc: %D\n", bnk->ksp_negc);CHKERRQ(ierr);
973eb910715SAlp Dener     ierr = PetscViewerASCIIPrintf(viewer, "  dtol: %D\n", bnk->ksp_dtol);CHKERRQ(ierr);
974eb910715SAlp Dener     ierr = PetscViewerASCIIPrintf(viewer, "  iter: %D\n", bnk->ksp_iter);CHKERRQ(ierr);
975eb910715SAlp Dener     ierr = PetscViewerASCIIPrintf(viewer, "  othr: %D\n", bnk->ksp_othr);CHKERRQ(ierr);
976eb910715SAlp Dener     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
977eb910715SAlp Dener   }
978eb910715SAlp Dener   PetscFunctionReturn(0);
979eb910715SAlp Dener }
980eb910715SAlp Dener 
981eb910715SAlp Dener /* ---------------------------------------------------------- */
982df278d8fSAlp Dener 
983eb910715SAlp Dener /*MC
984eb910715SAlp Dener   TAOBNK - Shared base-type for Bounded Newton-Krylov type algorithms.
98566ed3702SAlp Dener   At each iteration, the BNK methods solve the symmetric
986eb910715SAlp Dener   system of equations to obtain the step diretion dk:
987eb910715SAlp Dener               Hk dk = -gk
9882b97c8d8SAlp Dener   for free variables only. The step can be globalized either through
9892b97c8d8SAlp Dener   trust-region methods, or a line search, or a heuristic mixture of both.
990eb910715SAlp Dener 
991eb910715SAlp Dener     Options Database Keys:
992*8d5ead36SAlp Dener + -tao_bnk_pc_type - "none","ahess","bfgs","petsc"
993*8d5ead36SAlp Dener . -tao_bnk_bfgs_scale_type - "ahess","phess","bfgs"
994*8d5ead36SAlp Dener . -tao_bnk_init_type - "constant","direction","interpolation"
995*8d5ead36SAlp Dener . -tao_bnk_update_type - "step","direction","interpolation"
996*8d5ead36SAlp Dener . -tao_bnk_sval - perturbation starting value
997*8d5ead36SAlp Dener . -tao_bnk_imin - minimum initial perturbation
998*8d5ead36SAlp Dener . -tao_bnk_imax - maximum initial perturbation
999*8d5ead36SAlp Dener . -tao_bnk_pmin - minimum perturbation
1000*8d5ead36SAlp Dener . -tao_bnk_pmax - maximum perturbation
1001*8d5ead36SAlp Dener . -tao_bnk_pgfac - growth factor
1002*8d5ead36SAlp Dener . -tao_bnk_psfac - shrink factor
1003*8d5ead36SAlp Dener . -tao_bnk_imfac - initial merit factor
1004*8d5ead36SAlp Dener . -tao_bnk_pmgfac - merit growth factor
1005*8d5ead36SAlp Dener . -tao_bnk_pmsfac - merit shrink factor
1006*8d5ead36SAlp Dener . -tao_bnk_eta1 - poor steplength; reduce radius
1007*8d5ead36SAlp Dener . -tao_bnk_eta2 - reasonable steplength; leave radius
1008*8d5ead36SAlp Dener . -tao_bnk_eta3 - good steplength; increase readius
1009*8d5ead36SAlp Dener . -tao_bnk_eta4 - excellent steplength; greatly increase radius
1010*8d5ead36SAlp Dener . -tao_bnk_alpha1 - alpha1 reduction
1011*8d5ead36SAlp Dener . -tao_bnk_alpha2 - alpha2 reduction
1012*8d5ead36SAlp Dener . -tao_bnk_alpha3 - alpha3 reduction
1013*8d5ead36SAlp Dener . -tao_bnk_alpha4 - alpha4 reduction
1014*8d5ead36SAlp Dener . -tao_bnk_alpha - alpha5 reduction
1015*8d5ead36SAlp Dener . -tao_bnk_mu1 - mu1 interpolation update
1016*8d5ead36SAlp Dener . -tao_bnk_mu2 - mu2 interpolation update
1017*8d5ead36SAlp Dener . -tao_bnk_gamma1 - gamma1 interpolation update
1018*8d5ead36SAlp Dener . -tao_bnk_gamma2 - gamma2 interpolation update
1019*8d5ead36SAlp Dener . -tao_bnk_gamma3 - gamma3 interpolation update
1020*8d5ead36SAlp Dener . -tao_bnk_gamma4 - gamma4 interpolation update
1021*8d5ead36SAlp Dener . -tao_bnk_theta - theta interpolation update
1022*8d5ead36SAlp Dener . -tao_bnk_omega1 - omega1 step update
1023*8d5ead36SAlp Dener . -tao_bnk_omega2 - omega2 step update
1024*8d5ead36SAlp Dener . -tao_bnk_omega3 - omega3 step update
1025*8d5ead36SAlp Dener . -tao_bnk_omega4 - omega4 step update
1026*8d5ead36SAlp Dener . -tao_bnk_omega5 - omega5 step update
1027*8d5ead36SAlp Dener . -tao_bnk_mu1_i -  mu1 interpolation init factor
1028*8d5ead36SAlp Dener . -tao_bnk_mu2_i -  mu2 interpolation init factor
1029*8d5ead36SAlp Dener . -tao_bnk_gamma1_i -  gamma1 interpolation init factor
1030*8d5ead36SAlp Dener . -tao_bnk_gamma2_i -  gamma2 interpolation init factor
1031*8d5ead36SAlp Dener . -tao_bnk_gamma3_i -  gamma3 interpolation init factor
1032*8d5ead36SAlp Dener . -tao_bnk_gamma4_i -  gamma4 interpolation init factor
1033*8d5ead36SAlp Dener - -tao_bnk_theta_i -  theta interpolation init factor
1034eb910715SAlp Dener 
1035eb910715SAlp Dener   Level: beginner
1036eb910715SAlp Dener M*/
1037eb910715SAlp Dener 
1038eb910715SAlp Dener PetscErrorCode TaoCreate_BNK(Tao tao)
1039eb910715SAlp Dener {
1040eb910715SAlp Dener   TAO_BNK        *bnk;
1041eb910715SAlp Dener   const char     *morethuente_type = TAOLINESEARCHMT;
1042eb910715SAlp Dener   PetscErrorCode ierr;
1043eb910715SAlp Dener 
1044eb910715SAlp Dener   PetscFunctionBegin;
1045eb910715SAlp Dener   ierr = PetscNewLog(tao,&bnk);CHKERRQ(ierr);
1046eb910715SAlp Dener 
1047eb910715SAlp Dener   tao->ops->setup = TaoSetUp_BNK;
1048eb910715SAlp Dener   tao->ops->view = TaoView_BNK;
1049eb910715SAlp Dener   tao->ops->setfromoptions = TaoSetFromOptions_BNK;
1050eb910715SAlp Dener   tao->ops->destroy = TaoDestroy_BNK;
1051eb910715SAlp Dener 
1052eb910715SAlp Dener   /*  Override default settings (unless already changed) */
1053eb910715SAlp Dener   if (!tao->max_it_changed) tao->max_it = 50;
1054eb910715SAlp Dener   if (!tao->trust0_changed) tao->trust0 = 100.0;
1055eb910715SAlp Dener 
1056eb910715SAlp Dener   tao->data = (void*)bnk;
1057eb910715SAlp Dener 
105866ed3702SAlp Dener   /*  Hessian shifting parameters */
1059eb910715SAlp Dener   bnk->sval   = 0.0;
1060eb910715SAlp Dener   bnk->imin   = 1.0e-4;
1061eb910715SAlp Dener   bnk->imax   = 1.0e+2;
1062eb910715SAlp Dener   bnk->imfac  = 1.0e-1;
1063eb910715SAlp Dener 
1064eb910715SAlp Dener   bnk->pmin   = 1.0e-12;
1065eb910715SAlp Dener   bnk->pmax   = 1.0e+2;
1066eb910715SAlp Dener   bnk->pgfac  = 1.0e+1;
1067eb910715SAlp Dener   bnk->psfac  = 4.0e-1;
1068eb910715SAlp Dener   bnk->pmgfac = 1.0e-1;
1069eb910715SAlp Dener   bnk->pmsfac = 1.0e-1;
1070eb910715SAlp Dener 
1071eb910715SAlp Dener   /*  Default values for trust-region radius update based on steplength */
1072eb910715SAlp Dener   bnk->nu1 = 0.25;
1073eb910715SAlp Dener   bnk->nu2 = 0.50;
1074eb910715SAlp Dener   bnk->nu3 = 1.00;
1075eb910715SAlp Dener   bnk->nu4 = 1.25;
1076eb910715SAlp Dener 
1077eb910715SAlp Dener   bnk->omega1 = 0.25;
1078eb910715SAlp Dener   bnk->omega2 = 0.50;
1079eb910715SAlp Dener   bnk->omega3 = 1.00;
1080eb910715SAlp Dener   bnk->omega4 = 2.00;
1081eb910715SAlp Dener   bnk->omega5 = 4.00;
1082eb910715SAlp Dener 
1083eb910715SAlp Dener   /*  Default values for trust-region radius update based on reduction */
1084eb910715SAlp Dener   bnk->eta1 = 1.0e-4;
1085eb910715SAlp Dener   bnk->eta2 = 0.25;
1086eb910715SAlp Dener   bnk->eta3 = 0.50;
1087eb910715SAlp Dener   bnk->eta4 = 0.90;
1088eb910715SAlp Dener 
1089eb910715SAlp Dener   bnk->alpha1 = 0.25;
1090eb910715SAlp Dener   bnk->alpha2 = 0.50;
1091eb910715SAlp Dener   bnk->alpha3 = 1.00;
1092eb910715SAlp Dener   bnk->alpha4 = 2.00;
1093eb910715SAlp Dener   bnk->alpha5 = 4.00;
1094eb910715SAlp Dener 
1095eb910715SAlp Dener   /*  Default values for trust-region radius update based on interpolation */
1096eb910715SAlp Dener   bnk->mu1 = 0.10;
1097eb910715SAlp Dener   bnk->mu2 = 0.50;
1098eb910715SAlp Dener 
1099eb910715SAlp Dener   bnk->gamma1 = 0.25;
1100eb910715SAlp Dener   bnk->gamma2 = 0.50;
1101eb910715SAlp Dener   bnk->gamma3 = 2.00;
1102eb910715SAlp Dener   bnk->gamma4 = 4.00;
1103eb910715SAlp Dener 
1104eb910715SAlp Dener   bnk->theta = 0.05;
1105eb910715SAlp Dener 
1106eb910715SAlp Dener   /*  Default values for trust region initialization based on interpolation */
1107eb910715SAlp Dener   bnk->mu1_i = 0.35;
1108eb910715SAlp Dener   bnk->mu2_i = 0.50;
1109eb910715SAlp Dener 
1110eb910715SAlp Dener   bnk->gamma1_i = 0.0625;
1111eb910715SAlp Dener   bnk->gamma2_i = 0.5;
1112eb910715SAlp Dener   bnk->gamma3_i = 2.0;
1113eb910715SAlp Dener   bnk->gamma4_i = 5.0;
1114eb910715SAlp Dener 
1115eb910715SAlp Dener   bnk->theta_i = 0.25;
1116eb910715SAlp Dener 
1117eb910715SAlp Dener   /*  Remaining parameters */
1118eb910715SAlp Dener   bnk->min_radius = 1.0e-10;
1119eb910715SAlp Dener   bnk->max_radius = 1.0e10;
1120eb910715SAlp Dener   bnk->epsilon = 1.0e-6;
1121eb910715SAlp Dener 
1122eb910715SAlp Dener   bnk->pc_type         = BNK_PC_BFGS;
1123eb910715SAlp Dener   bnk->bfgs_scale_type = BFGS_SCALE_PHESS;
1124eb910715SAlp Dener   bnk->init_type       = BNK_INIT_INTERPOLATION;
1125fed79b8eSAlp Dener   bnk->update_type     = BNK_UPDATE_INTERPOLATION;
1126eb910715SAlp Dener 
1127eb910715SAlp Dener   ierr = TaoLineSearchCreate(((PetscObject)tao)->comm,&tao->linesearch);CHKERRQ(ierr);
1128eb910715SAlp Dener   ierr = PetscObjectIncrementTabLevel((PetscObject)tao->linesearch, (PetscObject)tao, 1);CHKERRQ(ierr);
1129eb910715SAlp Dener   ierr = TaoLineSearchSetType(tao->linesearch,morethuente_type);CHKERRQ(ierr);
1130eb910715SAlp Dener   ierr = TaoLineSearchUseTaoRoutines(tao->linesearch,tao);CHKERRQ(ierr);
1131eb910715SAlp Dener   ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,tao->hdr.prefix);CHKERRQ(ierr);
1132eb910715SAlp Dener 
1133eb910715SAlp Dener   /*  Set linear solver to default for symmetric matrices */
1134eb910715SAlp Dener   ierr = KSPCreate(((PetscObject)tao)->comm,&tao->ksp);CHKERRQ(ierr);
1135eb910715SAlp Dener   ierr = PetscObjectIncrementTabLevel((PetscObject)tao->ksp, (PetscObject)tao, 1);CHKERRQ(ierr);
1136eb910715SAlp Dener   ierr = KSPSetOptionsPrefix(tao->ksp,tao->hdr.prefix);CHKERRQ(ierr);
1137eb910715SAlp Dener   ierr = KSPSetType(tao->ksp,KSPCGSTCG);CHKERRQ(ierr);
1138eb910715SAlp Dener   PetscFunctionReturn(0);
1139eb910715SAlp Dener }
1140