xref: /petsc/src/tao/constrained/impls/ipm/pdipm.c (revision 503c0ea9b45bcfbcebbb1ea5341243bbc69f0bea)
1 #include <../src/tao/constrained/impls/ipm/pdipm.h>
2 
3 /*
4    TaoPDIPMEvaluateFunctionsAndJacobians - Evaluate the objective function f, gradient fx, constraints, and all the Jacobians at current vector
5 
6    Collective on tao
7 
8    Input Parameter:
9 +  tao - solver context
10 -  x - vector at which all objects to be evaluated
11 
12    Level: beginner
13 
14 .seealso: TaoPDIPMUpdateConstraints(), TaoPDIPMSetUpBounds()
15 */
16 static PetscErrorCode TaoPDIPMEvaluateFunctionsAndJacobians(Tao tao,Vec x)
17 {
18   TAO_PDIPM      *pdipm=(TAO_PDIPM*)tao->data;
19 
20   PetscFunctionBegin;
21   /* Compute user objective function and gradient */
22   PetscCall(TaoComputeObjectiveAndGradient(tao,x,&pdipm->obj,tao->gradient));
23 
24   /* Equality constraints and Jacobian */
25   if (pdipm->Ng) {
26     PetscCall(TaoComputeEqualityConstraints(tao,x,tao->constraints_equality));
27     PetscCall(TaoComputeJacobianEquality(tao,x,tao->jacobian_equality,tao->jacobian_equality_pre));
28   }
29 
30   /* Inequality constraints and Jacobian */
31   if (pdipm->Nh) {
32     PetscCall(TaoComputeInequalityConstraints(tao,x,tao->constraints_inequality));
33     PetscCall(TaoComputeJacobianInequality(tao,x,tao->jacobian_inequality,tao->jacobian_inequality_pre));
34   }
35   PetscFunctionReturn(0);
36 }
37 
38 /*
39   TaoPDIPMUpdateConstraints - Update the vectors ce and ci at x
40 
41   Collective
42 
43   Input Parameter:
44 + tao - Tao context
45 - x - vector at which constraints to be evaluated
46 
47    Level: beginner
48 
49 .seealso: TaoPDIPMEvaluateFunctionsAndJacobians()
50 */
51 static PetscErrorCode TaoPDIPMUpdateConstraints(Tao tao,Vec x)
52 {
53   TAO_PDIPM         *pdipm=(TAO_PDIPM*)tao->data;
54   PetscInt          i,offset,offset1,k,xstart;
55   PetscScalar       *carr;
56   const PetscInt    *ubptr,*lbptr,*bxptr,*fxptr;
57   const PetscScalar *xarr,*xuarr,*xlarr,*garr,*harr;
58 
59   PetscFunctionBegin;
60   PetscCall(VecGetOwnershipRange(x,&xstart,NULL));
61 
62   PetscCall(VecGetArrayRead(x,&xarr));
63   PetscCall(VecGetArrayRead(tao->XU,&xuarr));
64   PetscCall(VecGetArrayRead(tao->XL,&xlarr));
65 
66   /* (1) Update ce vector */
67   PetscCall(VecGetArrayWrite(pdipm->ce,&carr));
68 
69   if (pdipm->Ng) {
70     /* (1.a) Inserting updated g(x) */
71     PetscCall(VecGetArrayRead(tao->constraints_equality,&garr));
72     PetscCall(PetscMemcpy(carr,garr,pdipm->ng*sizeof(PetscScalar)));
73     PetscCall(VecRestoreArrayRead(tao->constraints_equality,&garr));
74   }
75 
76   /* (1.b) Update xfixed */
77   if (pdipm->Nxfixed) {
78     offset = pdipm->ng;
79     PetscCall(ISGetIndices(pdipm->isxfixed,&fxptr)); /* global indices in x */
80     for (k=0;k < pdipm->nxfixed;k++) {
81       i = fxptr[k]-xstart;
82       carr[offset + k] = xarr[i] - xuarr[i];
83     }
84   }
85   PetscCall(VecRestoreArrayWrite(pdipm->ce,&carr));
86 
87   /* (2) Update ci vector */
88   PetscCall(VecGetArrayWrite(pdipm->ci,&carr));
89 
90   if (pdipm->Nh) {
91     /* (2.a) Inserting updated h(x) */
92     PetscCall(VecGetArrayRead(tao->constraints_inequality,&harr));
93     PetscCall(PetscMemcpy(carr,harr,pdipm->nh*sizeof(PetscScalar)));
94     PetscCall(VecRestoreArrayRead(tao->constraints_inequality,&harr));
95   }
96 
97   /* (2.b) Update xub */
98   offset = pdipm->nh;
99   if (pdipm->Nxub) {
100     PetscCall(ISGetIndices(pdipm->isxub,&ubptr));
101     for (k=0; k<pdipm->nxub; k++) {
102       i = ubptr[k]-xstart;
103       carr[offset + k] = xuarr[i] - xarr[i];
104     }
105   }
106 
107   if (pdipm->Nxlb) {
108     /* (2.c) Update xlb */
109     offset += pdipm->nxub;
110     PetscCall(ISGetIndices(pdipm->isxlb,&lbptr)); /* global indices in x */
111     for (k=0; k<pdipm->nxlb; k++) {
112       i = lbptr[k]-xstart;
113       carr[offset + k] = xarr[i] - xlarr[i];
114     }
115   }
116 
117   if (pdipm->Nxbox) {
118     /* (2.d) Update xbox */
119     offset += pdipm->nxlb;
120     offset1 = offset + pdipm->nxbox;
121     PetscCall(ISGetIndices(pdipm->isxbox,&bxptr)); /* global indices in x */
122     for (k=0; k<pdipm->nxbox; k++) {
123       i = bxptr[k]-xstart; /* local indices in x */
124       carr[offset+k]  = xuarr[i] - xarr[i];
125       carr[offset1+k] = xarr[i]  - xlarr[i];
126     }
127   }
128   PetscCall(VecRestoreArrayWrite(pdipm->ci,&carr));
129 
130   /* Restoring Vectors */
131   PetscCall(VecRestoreArrayRead(x,&xarr));
132   PetscCall(VecRestoreArrayRead(tao->XU,&xuarr));
133   PetscCall(VecRestoreArrayRead(tao->XL,&xlarr));
134   PetscFunctionReturn(0);
135 }
136 
137 /*
138    TaoPDIPMSetUpBounds - Create upper and lower bound vectors of x
139 
140    Collective
141 
142    Input Parameter:
143 .  tao - holds pdipm and XL & XU
144 
145    Level: beginner
146 
147 .seealso: TaoPDIPMUpdateConstraints
148 */
149 static PetscErrorCode TaoPDIPMSetUpBounds(Tao tao)
150 {
151   TAO_PDIPM         *pdipm=(TAO_PDIPM*)tao->data;
152   const PetscScalar *xl,*xu;
153   PetscInt          n,*ixlb,*ixub,*ixfixed,*ixfree,*ixbox,i,low,high,idx;
154   MPI_Comm          comm;
155   PetscInt          sendbuf[5],recvbuf[5];
156 
157   PetscFunctionBegin;
158   /* Creates upper and lower bounds vectors on x, if not created already */
159   PetscCall(TaoComputeVariableBounds(tao));
160 
161   PetscCall(VecGetLocalSize(tao->XL,&n));
162   PetscCall(PetscMalloc5(n,&ixlb,n,&ixub,n,&ixfree,n,&ixfixed,n,&ixbox));
163 
164   PetscCall(VecGetOwnershipRange(tao->XL,&low,&high));
165   PetscCall(VecGetArrayRead(tao->XL,&xl));
166   PetscCall(VecGetArrayRead(tao->XU,&xu));
167   for (i=0; i<n; i++) {
168     idx = low + i;
169     if ((PetscRealPart(xl[i]) > PETSC_NINFINITY) && (PetscRealPart(xu[i]) < PETSC_INFINITY)) {
170       if (PetscRealPart(xl[i]) == PetscRealPart(xu[i])) {
171         ixfixed[pdipm->nxfixed++]  = idx;
172       } else ixbox[pdipm->nxbox++] = idx;
173     } else {
174       if ((PetscRealPart(xl[i]) > PETSC_NINFINITY) && (PetscRealPart(xu[i]) >= PETSC_INFINITY)) {
175         ixlb[pdipm->nxlb++] = idx;
176       } else if ((PetscRealPart(xl[i]) <= PETSC_NINFINITY) && (PetscRealPart(xu[i]) < PETSC_INFINITY)) {
177         ixub[pdipm->nxlb++] = idx;
178       } else  ixfree[pdipm->nxfree++] = idx;
179     }
180   }
181   PetscCall(VecRestoreArrayRead(tao->XL,&xl));
182   PetscCall(VecRestoreArrayRead(tao->XU,&xu));
183 
184   PetscCall(PetscObjectGetComm((PetscObject)tao,&comm));
185   sendbuf[0] = pdipm->nxlb;
186   sendbuf[1] = pdipm->nxub;
187   sendbuf[2] = pdipm->nxfixed;
188   sendbuf[3] = pdipm->nxbox;
189   sendbuf[4] = pdipm->nxfree;
190 
191   PetscCallMPI(MPI_Allreduce(sendbuf,recvbuf,5,MPIU_INT,MPI_SUM,comm));
192   pdipm->Nxlb    = recvbuf[0];
193   pdipm->Nxub    = recvbuf[1];
194   pdipm->Nxfixed = recvbuf[2];
195   pdipm->Nxbox   = recvbuf[3];
196   pdipm->Nxfree  = recvbuf[4];
197 
198   if (pdipm->Nxlb) {
199     PetscCall(ISCreateGeneral(comm,pdipm->nxlb,ixlb,PETSC_COPY_VALUES,&pdipm->isxlb));
200   }
201   if (pdipm->Nxub) {
202     PetscCall(ISCreateGeneral(comm,pdipm->nxub,ixub,PETSC_COPY_VALUES,&pdipm->isxub));
203   }
204   if (pdipm->Nxfixed) {
205     PetscCall(ISCreateGeneral(comm,pdipm->nxfixed,ixfixed,PETSC_COPY_VALUES,&pdipm->isxfixed));
206   }
207   if (pdipm->Nxbox) {
208     PetscCall(ISCreateGeneral(comm,pdipm->nxbox,ixbox,PETSC_COPY_VALUES,&pdipm->isxbox));
209   }
210   if (pdipm->Nxfree) {
211     PetscCall(ISCreateGeneral(comm,pdipm->nxfree,ixfree,PETSC_COPY_VALUES,&pdipm->isxfree));
212   }
213   PetscCall(PetscFree5(ixlb,ixub,ixfixed,ixbox,ixfree));
214   PetscFunctionReturn(0);
215 }
216 
217 /*
218    TaoPDIPMInitializeSolution - Initialize PDIPM solution X = [x; lambdae; lambdai; z].
219    X consists of four subvectors in the order [x; lambdae; lambdai; z]. These
220      four subvectors need to be initialized and its values copied over to X. Instead
221      of copying, we use VecPlace/ResetArray functions to share the memory locations for
222      X and the subvectors
223 
224    Collective
225 
226    Input Parameter:
227 .  tao - Tao context
228 
229    Level: beginner
230 */
231 static PetscErrorCode TaoPDIPMInitializeSolution(Tao tao)
232 {
233   TAO_PDIPM         *pdipm = (TAO_PDIPM*)tao->data;
234   PetscScalar       *Xarr,*z,*lambdai;
235   PetscInt          i;
236   const PetscScalar *xarr,*h;
237 
238   PetscFunctionBegin;
239   PetscCall(VecGetArrayWrite(pdipm->X,&Xarr));
240 
241   /* Set Initialize X.x = tao->solution */
242   PetscCall(VecGetArrayRead(tao->solution,&xarr));
243   PetscCall(PetscMemcpy(Xarr,xarr,pdipm->nx*sizeof(PetscScalar)));
244   PetscCall(VecRestoreArrayRead(tao->solution,&xarr));
245 
246   /* Initialize X.lambdae = 0.0 */
247   if (pdipm->lambdae) {
248     PetscCall(VecSet(pdipm->lambdae,0.0));
249   }
250 
251   /* Initialize X.lambdai = push_init_lambdai, X.z = push_init_slack */
252   if (pdipm->Nci) {
253     PetscCall(VecSet(pdipm->lambdai,pdipm->push_init_lambdai));
254     PetscCall(VecSet(pdipm->z,pdipm->push_init_slack));
255 
256     /* Additional modification for X.lambdai and X.z */
257     PetscCall(VecGetArrayWrite(pdipm->lambdai,&lambdai));
258     PetscCall(VecGetArrayWrite(pdipm->z,&z));
259     if (pdipm->Nh) {
260       PetscCall(VecGetArrayRead(tao->constraints_inequality,&h));
261       for (i=0; i < pdipm->nh; i++) {
262         if (h[i] < -pdipm->push_init_slack) z[i] = -h[i];
263         if (pdipm->mu/z[i] > pdipm->push_init_lambdai) lambdai[i] = pdipm->mu/z[i];
264       }
265       PetscCall(VecRestoreArrayRead(tao->constraints_inequality,&h));
266     }
267     PetscCall(VecRestoreArrayWrite(pdipm->lambdai,&lambdai));
268     PetscCall(VecRestoreArrayWrite(pdipm->z,&z));
269   }
270 
271   PetscCall(VecRestoreArrayWrite(pdipm->X,&Xarr));
272   PetscFunctionReturn(0);
273 }
274 
275 /*
276    TaoSNESJacobian_PDIPM - Evaluate the Hessian matrix at X
277 
278    Input Parameter:
279    snes - SNES context
280    X - KKT Vector
281    *ctx - pdipm context
282 
283    Output Parameter:
284    J - Hessian matrix
285    Jpre - Preconditioner
286 */
287 static PetscErrorCode TaoSNESJacobian_PDIPM(SNES snes,Vec X, Mat J, Mat Jpre, void *ctx)
288 {
289   Tao               tao=(Tao)ctx;
290   TAO_PDIPM         *pdipm = (TAO_PDIPM*)tao->data;
291   PetscInt          i,row,cols[2],Jrstart,rjstart,nc,j;
292   const PetscInt    *aj,*ranges,*Jranges,*rranges,*cranges;
293   const PetscScalar *Xarr,*aa;
294   PetscScalar       vals[2];
295   PetscInt          proc,nx_all,*nce_all=pdipm->nce_all;
296   MPI_Comm          comm;
297   PetscMPIInt       rank,size;
298   Mat               jac_equality_trans=pdipm->jac_equality_trans,jac_inequality_trans=pdipm->jac_inequality_trans;
299 
300   PetscFunctionBegin;
301   PetscCall(PetscObjectGetComm((PetscObject)snes,&comm));
302   PetscCallMPI(MPI_Comm_rank(comm,&rank));
303   PetscCallMPI(MPI_Comm_rank(comm,&size));
304 
305   PetscCall(MatGetOwnershipRanges(Jpre,&Jranges));
306   PetscCall(MatGetOwnershipRange(Jpre,&Jrstart,NULL));
307   PetscCall(MatGetOwnershipRangesColumn(tao->hessian,&rranges));
308   PetscCall(MatGetOwnershipRangesColumn(tao->hessian,&cranges));
309 
310   PetscCall(VecGetArrayRead(X,&Xarr));
311 
312   /* (1) insert Z and Ci to the 4th block of Jpre -- overwrite existing values */
313   if (pdipm->solve_symmetric_kkt) { /* 1 for eq 17 revised pdipm doc 0 for eq 18 (symmetric KKT) */
314     vals[0] = 1.0;
315     for (i=0; i < pdipm->nci; i++) {
316         row     = Jrstart + pdipm->off_z + i;
317         cols[0] = Jrstart + pdipm->off_lambdai + i;
318         cols[1] = row;
319         vals[1] = Xarr[pdipm->off_lambdai + i]/Xarr[pdipm->off_z + i];
320         PetscCall(MatSetValues(Jpre,1,&row,2,cols,vals,INSERT_VALUES));
321     }
322   } else {
323     for (i=0; i < pdipm->nci; i++) {
324       row     = Jrstart + pdipm->off_z + i;
325       cols[0] = Jrstart + pdipm->off_lambdai + i;
326       cols[1] = row;
327       vals[0] = Xarr[pdipm->off_z + i];
328       vals[1] = Xarr[pdipm->off_lambdai + i];
329       PetscCall(MatSetValues(Jpre,1,&row,2,cols,vals,INSERT_VALUES));
330     }
331   }
332 
333   /* (2) insert 2nd row block of Jpre: [ grad g, 0, 0, 0] */
334   if (pdipm->Ng) {
335     PetscCall(MatGetOwnershipRange(tao->jacobian_equality,&rjstart,NULL));
336     for (i=0; i<pdipm->ng; i++) {
337       row = Jrstart + pdipm->off_lambdae + i;
338 
339       PetscCall(MatGetRow(tao->jacobian_equality,i+rjstart,&nc,&aj,&aa));
340       proc = 0;
341       for (j=0; j < nc; j++) {
342         while (aj[j] >= cranges[proc+1]) proc++;
343         cols[0] = aj[j] - cranges[proc] + Jranges[proc];
344         PetscCall(MatSetValue(Jpre,row,cols[0],aa[j],INSERT_VALUES));
345       }
346       PetscCall(MatRestoreRow(tao->jacobian_equality,i+rjstart,&nc,&aj,&aa));
347       if (pdipm->kkt_pd) {
348         /* add shift \delta_c */
349         PetscCall(MatSetValue(Jpre,row,row,-pdipm->deltac,INSERT_VALUES));
350       }
351     }
352   }
353 
354   /* (3) insert 3rd row block of Jpre: [ -grad h, 0, deltac, I] */
355   if (pdipm->Nh) {
356     PetscCall(MatGetOwnershipRange(tao->jacobian_inequality,&rjstart,NULL));
357     for (i=0; i < pdipm->nh; i++) {
358       row = Jrstart + pdipm->off_lambdai + i;
359       PetscCall(MatGetRow(tao->jacobian_inequality,i+rjstart,&nc,&aj,&aa));
360       proc = 0;
361       for (j=0; j < nc; j++) {
362         while (aj[j] >= cranges[proc+1]) proc++;
363         cols[0] = aj[j] - cranges[proc] + Jranges[proc];
364         PetscCall(MatSetValue(Jpre,row,cols[0],-aa[j],INSERT_VALUES));
365       }
366       PetscCall(MatRestoreRow(tao->jacobian_inequality,i+rjstart,&nc,&aj,&aa));
367       if (pdipm->kkt_pd) {
368         /* add shift \delta_c */
369         PetscCall(MatSetValue(Jpre,row,row,-pdipm->deltac,INSERT_VALUES));
370       }
371     }
372   }
373 
374   /* (4) insert 1st row block of Jpre: [Wxx, grad g', -grad h', 0] */
375   if (pdipm->Ng) { /* grad g' */
376     PetscCall(MatTranspose(tao->jacobian_equality,MAT_REUSE_MATRIX,&jac_equality_trans));
377   }
378   if (pdipm->Nh) { /* grad h' */
379     PetscCall(MatTranspose(tao->jacobian_inequality,MAT_REUSE_MATRIX,&jac_inequality_trans));
380   }
381 
382   PetscCall(VecPlaceArray(pdipm->x,Xarr));
383   PetscCall(TaoComputeHessian(tao,pdipm->x,tao->hessian,tao->hessian_pre));
384   PetscCall(VecResetArray(pdipm->x));
385 
386   PetscCall(MatGetOwnershipRange(tao->hessian,&rjstart,NULL));
387   for (i=0; i<pdipm->nx; i++) {
388     row = Jrstart + i;
389 
390     /* insert Wxx = fxx + ... -- provided by user */
391     PetscCall(MatGetRow(tao->hessian,i+rjstart,&nc,&aj,&aa));
392     proc = 0;
393     for (j=0; j < nc; j++) {
394       while (aj[j] >= cranges[proc+1]) proc++;
395       cols[0] = aj[j] - cranges[proc] + Jranges[proc];
396       if (row == cols[0] && pdipm->kkt_pd) {
397         /* add shift deltaw to Wxx component */
398         PetscCall(MatSetValue(Jpre,row,cols[0],aa[j]+pdipm->deltaw,INSERT_VALUES));
399       } else {
400         PetscCall(MatSetValue(Jpre,row,cols[0],aa[j],INSERT_VALUES));
401       }
402     }
403     PetscCall(MatRestoreRow(tao->hessian,i+rjstart,&nc,&aj,&aa));
404 
405     /* insert grad g' */
406     if (pdipm->ng) {
407       PetscCall(MatGetRow(jac_equality_trans,i+rjstart,&nc,&aj,&aa));
408       PetscCall(MatGetOwnershipRanges(tao->jacobian_equality,&ranges));
409       proc = 0;
410       for (j=0; j < nc; j++) {
411         /* find row ownership of */
412         while (aj[j] >= ranges[proc+1]) proc++;
413         nx_all = rranges[proc+1] - rranges[proc];
414         cols[0] = aj[j] - ranges[proc] + Jranges[proc] + nx_all;
415         PetscCall(MatSetValue(Jpre,row,cols[0],aa[j],INSERT_VALUES));
416       }
417       PetscCall(MatRestoreRow(jac_equality_trans,i+rjstart,&nc,&aj,&aa));
418     }
419 
420     /* insert -grad h' */
421     if (pdipm->nh) {
422       PetscCall(MatGetRow(jac_inequality_trans,i+rjstart,&nc,&aj,&aa));
423       PetscCall(MatGetOwnershipRanges(tao->jacobian_inequality,&ranges));
424       proc = 0;
425       for (j=0; j < nc; j++) {
426         /* find row ownership of */
427         while (aj[j] >= ranges[proc+1]) proc++;
428         nx_all = rranges[proc+1] - rranges[proc];
429         cols[0] = aj[j] - ranges[proc] + Jranges[proc] + nx_all + nce_all[proc];
430         PetscCall(MatSetValue(Jpre,row,cols[0],-aa[j],INSERT_VALUES));
431       }
432       PetscCall(MatRestoreRow(jac_inequality_trans,i+rjstart,&nc,&aj,&aa));
433     }
434   }
435   PetscCall(VecRestoreArrayRead(X,&Xarr));
436 
437   /* (6) assemble Jpre and J */
438   PetscCall(MatAssemblyBegin(Jpre,MAT_FINAL_ASSEMBLY));
439   PetscCall(MatAssemblyEnd(Jpre,MAT_FINAL_ASSEMBLY));
440 
441   if (J != Jpre) {
442     PetscCall(MatAssemblyBegin(J,MAT_FINAL_ASSEMBLY));
443     PetscCall(MatAssemblyEnd(J,MAT_FINAL_ASSEMBLY));
444   }
445   PetscFunctionReturn(0);
446 }
447 
448 /*
449    TaoSnesFunction_PDIPM - Evaluate KKT function at X
450 
451    Input Parameter:
452    snes - SNES context
453    X - KKT Vector
454    *ctx - pdipm
455 
456    Output Parameter:
457    F - Updated Lagrangian vector
458 */
459 static PetscErrorCode TaoSNESFunction_PDIPM(SNES snes,Vec X,Vec F,void *ctx)
460 {
461   Tao               tao=(Tao)ctx;
462   TAO_PDIPM         *pdipm = (TAO_PDIPM*)tao->data;
463   PetscScalar       *Farr;
464   Vec               x,L1;
465   PetscInt          i;
466   const PetscScalar *Xarr,*carr,*zarr,*larr;
467 
468   PetscFunctionBegin;
469   PetscCall(VecSet(F,0.0));
470 
471   PetscCall(VecGetArrayRead(X,&Xarr));
472   PetscCall(VecGetArrayWrite(F,&Farr));
473 
474   /* (0) Evaluate f, fx, gradG, gradH at X.x Note: pdipm->x is not changed below */
475   x = pdipm->x;
476   PetscCall(VecPlaceArray(x,Xarr));
477   PetscCall(TaoPDIPMEvaluateFunctionsAndJacobians(tao,x));
478 
479   /* Update ce, ci, and Jci at X.x */
480   PetscCall(TaoPDIPMUpdateConstraints(tao,x));
481   PetscCall(VecResetArray(x));
482 
483   /* (1) L1 = fx + (gradG'*DE + Jce_xfixed'*lambdae_xfixed) - (gradH'*DI + Jci_xb'*lambdai_xb) */
484   L1 = pdipm->x;
485   PetscCall(VecPlaceArray(L1,Farr)); /* L1 = 0.0 */
486   if (pdipm->Nci) {
487     if (pdipm->Nh) {
488       /* L1 += gradH'*DI. Note: tao->DI is not changed below */
489       PetscCall(VecPlaceArray(tao->DI,Xarr+pdipm->off_lambdai));
490       PetscCall(MatMultTransposeAdd(tao->jacobian_inequality,tao->DI,L1,L1));
491       PetscCall(VecResetArray(tao->DI));
492     }
493 
494     /* L1 += Jci_xb'*lambdai_xb */
495     PetscCall(VecPlaceArray(pdipm->lambdai_xb,Xarr+pdipm->off_lambdai+pdipm->nh));
496     PetscCall(MatMultTransposeAdd(pdipm->Jci_xb,pdipm->lambdai_xb,L1,L1));
497     PetscCall(VecResetArray(pdipm->lambdai_xb));
498 
499     /* L1 = - (gradH'*DI + Jci_xb'*lambdai_xb) */
500     PetscCall(VecScale(L1,-1.0));
501   }
502 
503   /* L1 += fx */
504   PetscCall(VecAXPY(L1,1.0,tao->gradient));
505 
506   if (pdipm->Nce) {
507     if (pdipm->Ng) {
508       /* L1 += gradG'*DE. Note: tao->DE is not changed below */
509       PetscCall(VecPlaceArray(tao->DE,Xarr+pdipm->off_lambdae));
510       PetscCall(MatMultTransposeAdd(tao->jacobian_equality,tao->DE,L1,L1));
511       PetscCall(VecResetArray(tao->DE));
512     }
513     if (pdipm->Nxfixed) {
514       /* L1 += Jce_xfixed'*lambdae_xfixed */
515       PetscCall(VecPlaceArray(pdipm->lambdae_xfixed,Xarr+pdipm->off_lambdae+pdipm->ng));
516       PetscCall(MatMultTransposeAdd(pdipm->Jce_xfixed,pdipm->lambdae_xfixed,L1,L1));
517       PetscCall(VecResetArray(pdipm->lambdae_xfixed));
518     }
519   }
520   PetscCall(VecResetArray(L1));
521 
522   /* (2) L2 = ce(x) */
523   if (pdipm->Nce) {
524     PetscCall(VecGetArrayRead(pdipm->ce,&carr));
525     for (i=0; i<pdipm->nce; i++) Farr[pdipm->off_lambdae + i] = carr[i];
526     PetscCall(VecRestoreArrayRead(pdipm->ce,&carr));
527   }
528 
529   if (pdipm->Nci) {
530     if (pdipm->solve_symmetric_kkt) {
531       /* (3) L3 = z - ci(x);
532          (4) L4 = Lambdai * e - mu/z *e  */
533       PetscCall(VecGetArrayRead(pdipm->ci,&carr));
534       larr = Xarr+pdipm->off_lambdai;
535       zarr = Xarr+pdipm->off_z;
536       for (i=0; i<pdipm->nci; i++) {
537         Farr[pdipm->off_lambdai + i] = zarr[i] - carr[i];
538         Farr[pdipm->off_z       + i] = larr[i] - pdipm->mu/zarr[i];
539       }
540       PetscCall(VecRestoreArrayRead(pdipm->ci,&carr));
541     } else {
542       /* (3) L3 = z - ci(x);
543          (4) L4 = Z * Lambdai * e - mu * e  */
544       PetscCall(VecGetArrayRead(pdipm->ci,&carr));
545       larr = Xarr+pdipm->off_lambdai;
546       zarr = Xarr+pdipm->off_z;
547       for (i=0; i<pdipm->nci; i++) {
548         Farr[pdipm->off_lambdai + i] = zarr[i] - carr[i];
549         Farr[pdipm->off_z       + i] = zarr[i]*larr[i] - pdipm->mu;
550       }
551       PetscCall(VecRestoreArrayRead(pdipm->ci,&carr));
552     }
553   }
554 
555   PetscCall(VecRestoreArrayRead(X,&Xarr));
556   PetscCall(VecRestoreArrayWrite(F,&Farr));
557   PetscFunctionReturn(0);
558 }
559 
560 /*
561   Evaluate F(X); then update update tao->gnorm0, tao->step = mu,
562   tao->residual = norm2(F_x,F_z) and tao->cnorm = norm2(F_ce,F_ci).
563 */
564 static PetscErrorCode TaoSNESFunction_PDIPM_residual(SNES snes,Vec X,Vec F,void *ctx)
565 {
566   Tao               tao=(Tao)ctx;
567   TAO_PDIPM         *pdipm = (TAO_PDIPM*)tao->data;
568   PetscScalar       *Farr,*tmparr;
569   Vec               L1;
570   PetscInt          i;
571   PetscReal         res[2],cnorm[2];
572   const PetscScalar *Xarr=NULL;
573 
574   PetscFunctionBegin;
575   PetscCall(TaoSNESFunction_PDIPM(snes,X,F,(void*)tao));
576   PetscCall(VecGetArrayWrite(F,&Farr));
577   PetscCall(VecGetArrayRead(X,&Xarr));
578 
579   /* compute res[0] = norm2(F_x) */
580   L1 = pdipm->x;
581   PetscCall(VecPlaceArray(L1,Farr));
582   PetscCall(VecNorm(L1,NORM_2,&res[0]));
583   PetscCall(VecResetArray(L1));
584 
585   /* compute res[1] = norm2(F_z), cnorm[1] = norm2(F_ci) */
586   if (pdipm->z) {
587     if (pdipm->solve_symmetric_kkt) {
588       PetscCall(VecPlaceArray(pdipm->z,Farr+pdipm->off_z));
589       if (pdipm->Nci) {
590         PetscCall(VecGetArrayWrite(pdipm->z,&tmparr));
591         for (i=0; i<pdipm->nci; i++) tmparr[i] *= Xarr[pdipm->off_z + i];
592         PetscCall(VecRestoreArrayWrite(pdipm->z,&tmparr));
593       }
594 
595       PetscCall(VecNorm(pdipm->z,NORM_2,&res[1]));
596 
597       if (pdipm->Nci) {
598         PetscCall(VecGetArrayWrite(pdipm->z,&tmparr));
599         for (i=0; i<pdipm->nci; i++) {
600           tmparr[i] /= Xarr[pdipm->off_z + i];
601         }
602         PetscCall(VecRestoreArrayWrite(pdipm->z,&tmparr));
603       }
604       PetscCall(VecResetArray(pdipm->z));
605     } else { /* !solve_symmetric_kkt */
606       PetscCall(VecPlaceArray(pdipm->z,Farr+pdipm->off_z));
607       PetscCall(VecNorm(pdipm->z,NORM_2,&res[1]));
608       PetscCall(VecResetArray(pdipm->z));
609     }
610 
611     PetscCall(VecPlaceArray(pdipm->ci,Farr+pdipm->off_lambdai));
612     PetscCall(VecNorm(pdipm->ci,NORM_2,&cnorm[1]));
613     PetscCall(VecResetArray(pdipm->ci));
614   } else {
615     res[1] = 0.0; cnorm[1] = 0.0;
616   }
617 
618   /* compute cnorm[0] = norm2(F_ce) */
619   if (pdipm->Nce) {
620     PetscCall(VecPlaceArray(pdipm->ce,Farr+pdipm->off_lambdae));
621     PetscCall(VecNorm(pdipm->ce,NORM_2,&cnorm[0]));
622     PetscCall(VecResetArray(pdipm->ce));
623   } else cnorm[0] = 0.0;
624 
625   PetscCall(VecRestoreArrayWrite(F,&Farr));
626   PetscCall(VecRestoreArrayRead(X,&Xarr));
627 
628   tao->gnorm0   = tao->residual;
629   tao->residual = PetscSqrtReal(res[0]*res[0] + res[1]*res[1]);
630   tao->cnorm    = PetscSqrtReal(cnorm[0]*cnorm[0] + cnorm[1]*cnorm[1]);
631   tao->step     = pdipm->mu;
632   PetscFunctionReturn(0);
633 }
634 
635 /*
636   KKTAddShifts - Check the inertia of Cholesky factor of KKT matrix.
637   If it does not match the numbers of prime and dual variables, add shifts to the KKT matrix.
638 */
639 static PetscErrorCode KKTAddShifts(Tao tao,SNES snes,Vec X)
640 {
641   TAO_PDIPM      *pdipm = (TAO_PDIPM*)tao->data;
642   KSP            ksp;
643   PC             pc;
644   Mat            Factor;
645   PetscBool      isCHOL;
646   PetscInt       nneg,nzero,npos;
647 
648   PetscFunctionBegin;
649   /* Get the inertia of Cholesky factor */
650   PetscCall(SNESGetKSP(snes,&ksp));
651   PetscCall(KSPGetPC(ksp,&pc));
652   PetscCall(PetscObjectTypeCompare((PetscObject)pc,PCCHOLESKY,&isCHOL));
653   if (!isCHOL) PetscFunctionReturn(0);
654 
655   PetscCall(PCFactorGetMatrix(pc,&Factor));
656   PetscCall(MatGetInertia(Factor,&nneg,&nzero,&npos));
657 
658   if (npos < pdipm->Nx+pdipm->Nci) {
659     pdipm->deltaw = PetscMax(pdipm->lastdeltaw/3, 1.e-4*PETSC_MACHINE_EPSILON);
660     PetscCall(PetscInfo(tao,"Test reduced deltaw=%g; previous MatInertia: nneg %D, nzero %D, npos %D(<%D)\n",(double)pdipm->deltaw,nneg,nzero,npos,pdipm->Nx+pdipm->Nci));
661     PetscCall(TaoSNESJacobian_PDIPM(snes,X, pdipm->K, pdipm->K, tao));
662     PetscCall(PCSetUp(pc));
663     PetscCall(MatGetInertia(Factor,&nneg,&nzero,&npos));
664 
665     if (npos < pdipm->Nx+pdipm->Nci) {
666       pdipm->deltaw = pdipm->lastdeltaw; /* in case reduction update does not help, this prevents that step from impacting increasing update */
667       while (npos < pdipm->Nx+pdipm->Nci && pdipm->deltaw <= 1./PETSC_SMALL) { /* increase deltaw */
668         PetscCall(PetscInfo(tao,"  deltaw=%g fails, MatInertia: nneg %D, nzero %D, npos %D(<%D)\n",(double)pdipm->deltaw,nneg,nzero,npos,pdipm->Nx+pdipm->Nci));
669         pdipm->deltaw = PetscMin(8*pdipm->deltaw,PetscPowReal(10,20));
670         PetscCall(TaoSNESJacobian_PDIPM(snes,X, pdipm->K, pdipm->K, tao));
671         PetscCall(PCSetUp(pc));
672         PetscCall(MatGetInertia(Factor,&nneg,&nzero,&npos));
673       }
674 
675       PetscCheck(pdipm->deltaw < 1./PETSC_SMALL,PetscObjectComm((PetscObject)tao),PETSC_ERR_CONV_FAILED,"Reached maximum delta w will not converge, try different initial x0");
676 
677       PetscCall(PetscInfo(tao,"Updated deltaw %g\n",(double)pdipm->deltaw));
678       pdipm->lastdeltaw = pdipm->deltaw;
679       pdipm->deltaw     = 0.0;
680     }
681   }
682 
683   if (nzero) { /* Jacobian is singular */
684     if (pdipm->deltac == 0.0) {
685       pdipm->deltac = PETSC_SQRT_MACHINE_EPSILON;
686     } else {
687       pdipm->deltac = pdipm->deltac*PetscPowReal(pdipm->mu,.25);
688     }
689     PetscCall(PetscInfo(tao,"Updated deltac=%g, MatInertia: nneg %D, nzero %D(!=0), npos %D\n",(double)pdipm->deltac,nneg,nzero,npos));
690     PetscCall(TaoSNESJacobian_PDIPM(snes,X, pdipm->K, pdipm->K, tao));
691     PetscCall(PCSetUp(pc));
692     PetscCall(MatGetInertia(Factor,&nneg,&nzero,&npos));
693   }
694   PetscFunctionReturn(0);
695 }
696 
697 /*
698   PCPreSolve_PDIPM -- called betwee MatFactorNumeric() and MatSolve()
699 */
700 PetscErrorCode PCPreSolve_PDIPM(PC pc,KSP ksp)
701 {
702   Tao            tao;
703   TAO_PDIPM      *pdipm;
704 
705   PetscFunctionBegin;
706   PetscCall(KSPGetApplicationContext(ksp,&tao));
707   pdipm = (TAO_PDIPM*)tao->data;
708   PetscCall(KKTAddShifts(tao,pdipm->snes,pdipm->X));
709   PetscFunctionReturn(0);
710 }
711 
712 /*
713    SNESLineSearch_PDIPM - Custom line search used with PDIPM.
714 
715    Collective on TAO
716 
717    Notes:
718    This routine employs a simple backtracking line-search to keep
719    the slack variables (z) and inequality constraints Lagrange multipliers
720    (lambdai) positive, i.e., z,lambdai >=0. It does this by calculating scalars
721    alpha_p and alpha_d to keep z,lambdai non-negative. The decision (x), and the
722    slack variables are updated as X = X - alpha_d*dx. The constraint multipliers
723    are updated as Lambdai = Lambdai + alpha_p*dLambdai. The barrier parameter mu
724    is also updated as mu = mu + z'lambdai/Nci
725 */
726 static PetscErrorCode SNESLineSearch_PDIPM(SNESLineSearch linesearch,void *ctx)
727 {
728   Tao               tao=(Tao)ctx;
729   TAO_PDIPM         *pdipm = (TAO_PDIPM*)tao->data;
730   SNES              snes;
731   Vec               X,F,Y;
732   PetscInt          i,iter;
733   PetscReal         alpha_p=1.0,alpha_d=1.0,alpha[4];
734   PetscScalar       *Xarr,*z,*lambdai,dot,*taosolarr;
735   const PetscScalar *dXarr,*dz,*dlambdai;
736 
737   PetscFunctionBegin;
738   PetscCall(SNESLineSearchGetSNES(linesearch,&snes));
739   PetscCall(SNESGetIterationNumber(snes,&iter));
740 
741   PetscCall(SNESLineSearchSetReason(linesearch,SNES_LINESEARCH_SUCCEEDED));
742   PetscCall(SNESLineSearchGetVecs(linesearch,&X,&F,&Y,NULL,NULL));
743 
744   PetscCall(VecGetArrayWrite(X,&Xarr));
745   PetscCall(VecGetArrayRead(Y,&dXarr));
746   z  = Xarr + pdipm->off_z;
747   dz = dXarr + pdipm->off_z;
748   for (i=0; i < pdipm->nci; i++) {
749     if (z[i] - dz[i] < 0.0) alpha_p = PetscMin(alpha_p, 0.9999*z[i]/dz[i]);
750   }
751 
752   lambdai  = Xarr + pdipm->off_lambdai;
753   dlambdai = dXarr + pdipm->off_lambdai;
754 
755   for (i=0; i<pdipm->nci; i++) {
756     if (lambdai[i] - dlambdai[i] < 0.0) alpha_d = PetscMin(0.9999*lambdai[i]/dlambdai[i], alpha_d);
757   }
758 
759   alpha[0] = alpha_p;
760   alpha[1] = alpha_d;
761   PetscCall(VecRestoreArrayRead(Y,&dXarr));
762   PetscCall(VecRestoreArrayWrite(X,&Xarr));
763 
764   /* alpha = min(alpha) over all processes */
765   PetscCallMPI(MPI_Allreduce(alpha,alpha+2,2,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)tao)));
766 
767   alpha_p = alpha[2];
768   alpha_d = alpha[3];
769 
770   /* X = X - alpha * Y */
771   PetscCall(VecGetArrayWrite(X,&Xarr));
772   PetscCall(VecGetArrayRead(Y,&dXarr));
773   for (i=0; i<pdipm->nx; i++) Xarr[i] -= alpha_p * dXarr[i];
774   for (i=0; i<pdipm->nce; i++) Xarr[i+pdipm->off_lambdae] -= alpha_d * dXarr[i+pdipm->off_lambdae];
775 
776   for (i=0; i<pdipm->nci; i++) {
777     Xarr[i+pdipm->off_lambdai] -= alpha_d * dXarr[i+pdipm->off_lambdai];
778     Xarr[i+pdipm->off_z]       -= alpha_p * dXarr[i+pdipm->off_z];
779   }
780   PetscCall(VecGetArrayWrite(tao->solution,&taosolarr));
781   PetscCall(PetscMemcpy(taosolarr,Xarr,pdipm->nx*sizeof(PetscScalar)));
782   PetscCall(VecRestoreArrayWrite(tao->solution,&taosolarr));
783 
784   PetscCall(VecRestoreArrayWrite(X,&Xarr));
785   PetscCall(VecRestoreArrayRead(Y,&dXarr));
786 
787   /* Update mu = mu_update_factor * dot(z,lambdai)/pdipm->nci at updated X */
788   if (pdipm->z) {
789     PetscCall(VecDot(pdipm->z,pdipm->lambdai,&dot));
790   } else dot = 0.0;
791 
792   /* if (PetscAbsReal(pdipm->gradL) < 0.9*pdipm->mu)  */
793   pdipm->mu = pdipm->mu_update_factor * dot/pdipm->Nci;
794 
795   /* Update F; get tao->residual and tao->cnorm */
796   PetscCall(TaoSNESFunction_PDIPM_residual(snes,X,F,(void*)tao));
797 
798   tao->niter++;
799   PetscCall(TaoLogConvergenceHistory(tao,pdipm->obj,tao->residual,tao->cnorm,tao->niter));
800   PetscCall(TaoMonitor(tao,tao->niter,pdipm->obj,tao->residual,tao->cnorm,pdipm->mu));
801 
802   PetscCall((*tao->ops->convergencetest)(tao,tao->cnvP));
803   if (tao->reason) {
804     PetscCall(SNESSetConvergedReason(snes,SNES_CONVERGED_FNORM_ABS));
805   }
806   PetscFunctionReturn(0);
807 }
808 
809 /*
810    TaoSolve_PDIPM
811 
812    Input Parameter:
813    tao - TAO context
814 
815    Output Parameter:
816    tao - TAO context
817 */
818 PetscErrorCode TaoSolve_PDIPM(Tao tao)
819 {
820   TAO_PDIPM          *pdipm = (TAO_PDIPM*)tao->data;
821   SNESLineSearch     linesearch; /* SNESLineSearch context */
822   Vec                dummy;
823 
824   PetscFunctionBegin;
825   PetscCheck(tao->constraints_equality || tao->constraints_inequality,PetscObjectComm((PetscObject)tao),PETSC_ERR_ARG_NULL,"Equality and inequality constraints are not set. Either set them or switch to a different algorithm");
826 
827   /* Initialize all variables */
828   PetscCall(TaoPDIPMInitializeSolution(tao));
829 
830   /* Set linesearch */
831   PetscCall(SNESGetLineSearch(pdipm->snes,&linesearch));
832   PetscCall(SNESLineSearchSetType(linesearch,SNESLINESEARCHSHELL));
833   PetscCall(SNESLineSearchShellSetUserFunc(linesearch,SNESLineSearch_PDIPM,tao));
834   PetscCall(SNESLineSearchSetFromOptions(linesearch));
835 
836   tao->reason = TAO_CONTINUE_ITERATING;
837 
838   /* -tao_monitor for iteration 0 and check convergence */
839   PetscCall(VecDuplicate(pdipm->X,&dummy));
840   PetscCall(TaoSNESFunction_PDIPM_residual(pdipm->snes,pdipm->X,dummy,(void*)tao));
841 
842   PetscCall(TaoLogConvergenceHistory(tao,pdipm->obj,tao->residual,tao->cnorm,tao->niter));
843   PetscCall(TaoMonitor(tao,tao->niter,pdipm->obj,tao->residual,tao->cnorm,pdipm->mu));
844   PetscCall(VecDestroy(&dummy));
845   PetscCall((*tao->ops->convergencetest)(tao,tao->cnvP));
846   if (tao->reason) {
847     PetscCall(SNESSetConvergedReason(pdipm->snes,SNES_CONVERGED_FNORM_ABS));
848   }
849 
850   while (tao->reason == TAO_CONTINUE_ITERATING) {
851     SNESConvergedReason reason;
852     PetscCall(SNESSolve(pdipm->snes,NULL,pdipm->X));
853 
854     /* Check SNES convergence */
855     PetscCall(SNESGetConvergedReason(pdipm->snes,&reason));
856     if (reason < 0) {
857       PetscCall(PetscPrintf(PetscObjectComm((PetscObject)pdipm->snes),"SNES solve did not converged due to reason %D\n",reason));
858     }
859 
860     /* Check TAO convergence */
861     PetscCheck(!PetscIsInfOrNanReal(pdipm->obj),PETSC_COMM_SELF,PETSC_ERR_SUP,"User-provided compute function generated Inf or NaN");
862   }
863   PetscFunctionReturn(0);
864 }
865 
866 /*
867   TaoView_PDIPM - View PDIPM
868 
869    Input Parameter:
870     tao - TAO object
871     viewer - PetscViewer
872 
873    Output:
874 */
875 PetscErrorCode TaoView_PDIPM(Tao tao,PetscViewer viewer)
876 {
877   TAO_PDIPM      *pdipm = (TAO_PDIPM *)tao->data;
878 
879   PetscFunctionBegin;
880   tao->constrained = PETSC_TRUE;
881   PetscCall(PetscViewerASCIIPushTab(viewer));
882   PetscCall(PetscViewerASCIIPrintf(viewer,"Number of prime=%D, Number of dual=%D\n",pdipm->Nx+pdipm->Nci,pdipm->Nce + pdipm->Nci));
883   if (pdipm->kkt_pd) {
884     PetscCall(PetscViewerASCIIPrintf(viewer,"KKT shifts deltaw=%g, deltac=%g\n",(double)pdipm->deltaw,(double)pdipm->deltac));
885   }
886   PetscCall(PetscViewerASCIIPopTab(viewer));
887   PetscFunctionReturn(0);
888 }
889 
890 /*
891    TaoSetup_PDIPM - Sets up tao and pdipm
892 
893    Input Parameter:
894    tao - TAO object
895 
896    Output:   pdipm - initialized object
897 */
898 PetscErrorCode TaoSetup_PDIPM(Tao tao)
899 {
900   TAO_PDIPM         *pdipm = (TAO_PDIPM*)tao->data;
901   PetscErrorCode    ierr;
902   MPI_Comm          comm;
903   PetscMPIInt       size;
904   PetscInt          row,col,Jcrstart,Jcrend,k,tmp,nc,proc,*nh_all,*ng_all;
905   PetscInt          offset,*xa,*xb,i,j,rstart,rend;
906   PetscScalar       one=1.0,neg_one=-1.0;
907   const PetscInt    *cols,*rranges,*cranges,*aj,*ranges;
908   const PetscScalar *aa,*Xarr;
909   Mat               J,jac_equality_trans,jac_inequality_trans;
910   Mat               Jce_xfixed_trans,Jci_xb_trans;
911   PetscInt          *dnz,*onz,rjstart,nx_all,*nce_all,*Jranges,cols1[2];
912 
913   PetscFunctionBegin;
914   PetscCall(PetscObjectGetComm((PetscObject)tao,&comm));
915   PetscCallMPI(MPI_Comm_size(comm,&size));
916 
917   /* (1) Setup Bounds and create Tao vectors */
918   PetscCall(TaoPDIPMSetUpBounds(tao));
919 
920   if (!tao->gradient) {
921     PetscCall(VecDuplicate(tao->solution,&tao->gradient));
922     PetscCall(VecDuplicate(tao->solution,&tao->stepdirection));
923   }
924 
925   /* (2) Get sizes */
926   /* Size of vector x - This is set by TaoSetSolution */
927   PetscCall(VecGetSize(tao->solution,&pdipm->Nx));
928   PetscCall(VecGetLocalSize(tao->solution,&pdipm->nx));
929 
930   /* Size of equality constraints and vectors */
931   if (tao->constraints_equality) {
932     PetscCall(VecGetSize(tao->constraints_equality,&pdipm->Ng));
933     PetscCall(VecGetLocalSize(tao->constraints_equality,&pdipm->ng));
934   } else {
935     pdipm->ng = pdipm->Ng = 0;
936   }
937 
938   pdipm->nce = pdipm->ng + pdipm->nxfixed;
939   pdipm->Nce = pdipm->Ng + pdipm->Nxfixed;
940 
941   /* Size of inequality constraints and vectors */
942   if (tao->constraints_inequality) {
943     PetscCall(VecGetSize(tao->constraints_inequality,&pdipm->Nh));
944     PetscCall(VecGetLocalSize(tao->constraints_inequality,&pdipm->nh));
945   } else {
946     pdipm->nh = pdipm->Nh = 0;
947   }
948 
949   pdipm->nci = pdipm->nh + pdipm->nxlb + pdipm->nxub + 2*pdipm->nxbox;
950   pdipm->Nci = pdipm->Nh + pdipm->Nxlb + pdipm->Nxub + 2*pdipm->Nxbox;
951 
952   /* Full size of the KKT system to be solved */
953   pdipm->n = pdipm->nx + pdipm->nce + 2*pdipm->nci;
954   pdipm->N = pdipm->Nx + pdipm->Nce + 2*pdipm->Nci;
955 
956   /* (3) Offsets for subvectors */
957   pdipm->off_lambdae = pdipm->nx;
958   pdipm->off_lambdai = pdipm->off_lambdae + pdipm->nce;
959   pdipm->off_z       = pdipm->off_lambdai + pdipm->nci;
960 
961   /* (4) Create vectors and subvectors */
962   /* Ce and Ci vectors */
963   PetscCall(VecCreate(comm,&pdipm->ce));
964   PetscCall(VecSetSizes(pdipm->ce,pdipm->nce,pdipm->Nce));
965   PetscCall(VecSetFromOptions(pdipm->ce));
966 
967   PetscCall(VecCreate(comm,&pdipm->ci));
968   PetscCall(VecSetSizes(pdipm->ci,pdipm->nci,pdipm->Nci));
969   PetscCall(VecSetFromOptions(pdipm->ci));
970 
971   /* X=[x; lambdae; lambdai; z] for the big KKT system */
972   PetscCall(VecCreate(comm,&pdipm->X));
973   PetscCall(VecSetSizes(pdipm->X,pdipm->n,pdipm->N));
974   PetscCall(VecSetFromOptions(pdipm->X));
975 
976   /* Subvectors; they share local arrays with X */
977   PetscCall(VecGetArrayRead(pdipm->X,&Xarr));
978   /* x shares local array with X.x */
979   if (pdipm->Nx) {
980     PetscCall(VecCreateMPIWithArray(comm,1,pdipm->nx,pdipm->Nx,Xarr,&pdipm->x));
981   }
982 
983   /* lambdae shares local array with X.lambdae */
984   if (pdipm->Nce) {
985     PetscCall(VecCreateMPIWithArray(comm,1,pdipm->nce,pdipm->Nce,Xarr+pdipm->off_lambdae,&pdipm->lambdae));
986   }
987 
988   /* tao->DE shares local array with X.lambdae_g */
989   if (pdipm->Ng) {
990     PetscCall(VecCreateMPIWithArray(comm,1,pdipm->ng,pdipm->Ng,Xarr+pdipm->off_lambdae,&tao->DE));
991 
992     PetscCall(VecCreate(comm,&pdipm->lambdae_xfixed));
993     PetscCall(VecSetSizes(pdipm->lambdae_xfixed,pdipm->nxfixed,PETSC_DECIDE));
994     PetscCall(VecSetFromOptions(pdipm->lambdae_xfixed));
995   }
996 
997   if (pdipm->Nci) {
998     /* lambdai shares local array with X.lambdai */
999     PetscCall(VecCreateMPIWithArray(comm,1,pdipm->nci,pdipm->Nci,Xarr+pdipm->off_lambdai,&pdipm->lambdai));
1000 
1001     /* z for slack variables; it shares local array with X.z */
1002     PetscCall(VecCreateMPIWithArray(comm,1,pdipm->nci,pdipm->Nci,Xarr+pdipm->off_z,&pdipm->z));
1003   }
1004 
1005   /* tao->DI which shares local array with X.lambdai_h */
1006   if (pdipm->Nh) {
1007     PetscCall(VecCreateMPIWithArray(comm,1,pdipm->nh,pdipm->Nh,Xarr+pdipm->off_lambdai,&tao->DI));
1008   }
1009   PetscCall(VecCreate(comm,&pdipm->lambdai_xb));
1010   PetscCall(VecSetSizes(pdipm->lambdai_xb,(pdipm->nci - pdipm->nh),PETSC_DECIDE));
1011   PetscCall(VecSetFromOptions(pdipm->lambdai_xb));
1012 
1013   PetscCall(VecRestoreArrayRead(pdipm->X,&Xarr));
1014 
1015   /* (5) Create Jacobians Jce_xfixed and Jci */
1016   /* (5.1) PDIPM Jacobian of equality bounds cebound(x) = J_nxfixed */
1017   if (pdipm->Nxfixed) {
1018     /* Create Jce_xfixed */
1019     PetscCall(MatCreate(comm,&pdipm->Jce_xfixed));
1020     PetscCall(MatSetSizes(pdipm->Jce_xfixed,pdipm->nxfixed,pdipm->nx,PETSC_DECIDE,pdipm->Nx));
1021     PetscCall(MatSetFromOptions(pdipm->Jce_xfixed));
1022     PetscCall(MatSeqAIJSetPreallocation(pdipm->Jce_xfixed,1,NULL));
1023     PetscCall(MatMPIAIJSetPreallocation(pdipm->Jce_xfixed,1,NULL,1,NULL));
1024 
1025     PetscCall(MatGetOwnershipRange(pdipm->Jce_xfixed,&Jcrstart,&Jcrend));
1026     PetscCall(ISGetIndices(pdipm->isxfixed,&cols));
1027     k = 0;
1028     for (row = Jcrstart; row < Jcrend; row++) {
1029       PetscCall(MatSetValues(pdipm->Jce_xfixed,1,&row,1,cols+k,&one,INSERT_VALUES));
1030       k++;
1031     }
1032     PetscCall(ISRestoreIndices(pdipm->isxfixed, &cols));
1033     PetscCall(MatAssemblyBegin(pdipm->Jce_xfixed,MAT_FINAL_ASSEMBLY));
1034     PetscCall(MatAssemblyEnd(pdipm->Jce_xfixed,MAT_FINAL_ASSEMBLY));
1035   }
1036 
1037   /* (5.2) PDIPM inequality Jacobian Jci = [tao->jacobian_inequality; ...] */
1038   PetscCall(MatCreate(comm,&pdipm->Jci_xb));
1039   PetscCall(MatSetSizes(pdipm->Jci_xb,pdipm->nci-pdipm->nh,pdipm->nx,PETSC_DECIDE,pdipm->Nx));
1040   PetscCall(MatSetFromOptions(pdipm->Jci_xb));
1041   PetscCall(MatSeqAIJSetPreallocation(pdipm->Jci_xb,1,NULL));
1042   PetscCall(MatMPIAIJSetPreallocation(pdipm->Jci_xb,1,NULL,1,NULL));
1043 
1044   PetscCall(MatGetOwnershipRange(pdipm->Jci_xb,&Jcrstart,&Jcrend));
1045   offset = Jcrstart;
1046   if (pdipm->Nxub) {
1047     /* Add xub to Jci_xb */
1048     PetscCall(ISGetIndices(pdipm->isxub,&cols));
1049     k = 0;
1050     for (row = offset; row < offset + pdipm->nxub; row++) {
1051       PetscCall(MatSetValues(pdipm->Jci_xb,1,&row,1,cols+k,&neg_one,INSERT_VALUES));
1052       k++;
1053     }
1054     PetscCall(ISRestoreIndices(pdipm->isxub, &cols));
1055   }
1056 
1057   if (pdipm->Nxlb) {
1058     /* Add xlb to Jci_xb */
1059     PetscCall(ISGetIndices(pdipm->isxlb,&cols));
1060     k = 0;
1061     offset += pdipm->nxub;
1062     for (row = offset; row < offset + pdipm->nxlb; row++) {
1063       PetscCall(MatSetValues(pdipm->Jci_xb,1,&row,1,cols+k,&one,INSERT_VALUES));
1064       k++;
1065     }
1066     PetscCall(ISRestoreIndices(pdipm->isxlb, &cols));
1067   }
1068 
1069   /* Add xbox to Jci_xb */
1070   if (pdipm->Nxbox) {
1071     PetscCall(ISGetIndices(pdipm->isxbox,&cols));
1072     k = 0;
1073     offset += pdipm->nxlb;
1074     for (row = offset; row < offset + pdipm->nxbox; row++) {
1075       PetscCall(MatSetValues(pdipm->Jci_xb,1,&row,1,cols+k,&neg_one,INSERT_VALUES));
1076       tmp = row + pdipm->nxbox;
1077       PetscCall(MatSetValues(pdipm->Jci_xb,1,&tmp,1,cols+k,&one,INSERT_VALUES));
1078       k++;
1079     }
1080     PetscCall(ISRestoreIndices(pdipm->isxbox, &cols));
1081   }
1082 
1083   PetscCall(MatAssemblyBegin(pdipm->Jci_xb,MAT_FINAL_ASSEMBLY));
1084   PetscCall(MatAssemblyEnd(pdipm->Jci_xb,MAT_FINAL_ASSEMBLY));
1085   /* PetscCall(MatView(pdipm->Jci_xb,PETSC_VIEWER_STDOUT_WORLD)); */
1086 
1087   /* (6) Set up ISs for PC Fieldsplit */
1088   if (pdipm->solve_reduced_kkt) {
1089     PetscCall(PetscMalloc2(pdipm->nx+pdipm->nce,&xa,2*pdipm->nci,&xb));
1090     for (i=0; i < pdipm->nx + pdipm->nce; i++) xa[i] = i;
1091     for (i=0; i < 2*pdipm->nci; i++) xb[i] = pdipm->off_lambdai + i;
1092 
1093     PetscCall(ISCreateGeneral(comm,pdipm->nx+pdipm->nce,xa,PETSC_OWN_POINTER,&pdipm->is1));
1094     PetscCall(ISCreateGeneral(comm,2*pdipm->nci,xb,PETSC_OWN_POINTER,&pdipm->is2));
1095   }
1096 
1097   /* (7) Gather offsets from all processes */
1098   PetscCall(PetscMalloc1(size,&pdipm->nce_all));
1099 
1100   /* Get rstart of KKT matrix */
1101   PetscCallMPI(MPI_Scan(&pdipm->n,&rstart,1,MPIU_INT,MPI_SUM,comm));
1102   rstart -= pdipm->n;
1103 
1104   PetscCallMPI(MPI_Allgather(&pdipm->nce,1,MPIU_INT,pdipm->nce_all,1,MPIU_INT,comm));
1105 
1106   PetscCall(PetscMalloc3(size,&ng_all,size,&nh_all,size,&Jranges));
1107   PetscCallMPI(MPI_Allgather(&rstart,1,MPIU_INT,Jranges,1,MPIU_INT,comm));
1108   PetscCallMPI(MPI_Allgather(&pdipm->nh,1,MPIU_INT,nh_all,1,MPIU_INT,comm));
1109   PetscCallMPI(MPI_Allgather(&pdipm->ng,1,MPIU_INT,ng_all,1,MPIU_INT,comm));
1110 
1111   PetscCall(MatGetOwnershipRanges(tao->hessian,&rranges));
1112   PetscCall(MatGetOwnershipRangesColumn(tao->hessian,&cranges));
1113 
1114   if (pdipm->Ng) {
1115     PetscCall(TaoComputeJacobianEquality(tao,tao->solution,tao->jacobian_equality,tao->jacobian_equality_pre));
1116     PetscCall(MatTranspose(tao->jacobian_equality,MAT_INITIAL_MATRIX,&pdipm->jac_equality_trans));
1117   }
1118   if (pdipm->Nh) {
1119     PetscCall(TaoComputeJacobianInequality(tao,tao->solution,tao->jacobian_inequality,tao->jacobian_inequality_pre));
1120     PetscCall(MatTranspose(tao->jacobian_inequality,MAT_INITIAL_MATRIX,&pdipm->jac_inequality_trans));
1121   }
1122 
1123   /* Count dnz,onz for preallocation of KKT matrix */
1124   jac_equality_trans   = pdipm->jac_equality_trans;
1125   jac_inequality_trans = pdipm->jac_inequality_trans;
1126   nce_all = pdipm->nce_all;
1127 
1128   if (pdipm->Nxfixed) {
1129     PetscCall(MatTranspose(pdipm->Jce_xfixed,MAT_INITIAL_MATRIX,&Jce_xfixed_trans));
1130   }
1131   PetscCall(MatTranspose(pdipm->Jci_xb,MAT_INITIAL_MATRIX,&Jci_xb_trans));
1132 
1133   ierr = MatPreallocateInitialize(comm,pdipm->n,pdipm->n,dnz,onz);PetscCall(ierr);
1134 
1135   /* 1st row block of KKT matrix: [Wxx; gradCe'; -gradCi'; 0] */
1136   PetscCall(TaoPDIPMEvaluateFunctionsAndJacobians(tao,pdipm->x));
1137   PetscCall(TaoComputeHessian(tao,tao->solution,tao->hessian,tao->hessian_pre));
1138 
1139   /* Insert tao->hessian */
1140   PetscCall(MatGetOwnershipRange(tao->hessian,&rjstart,NULL));
1141   for (i=0; i<pdipm->nx; i++) {
1142     row = rstart + i;
1143 
1144     PetscCall(MatGetRow(tao->hessian,i+rjstart,&nc,&aj,NULL));
1145     proc = 0;
1146     for (j=0; j < nc; j++) {
1147       while (aj[j] >= cranges[proc+1]) proc++;
1148       col = aj[j] - cranges[proc] + Jranges[proc];
1149       PetscCall(MatPreallocateSet(row,1,&col,dnz,onz));
1150     }
1151     PetscCall(MatRestoreRow(tao->hessian,i+rjstart,&nc,&aj,NULL));
1152 
1153     if (pdipm->ng) {
1154       /* Insert grad g' */
1155       PetscCall(MatGetRow(jac_equality_trans,i+rjstart,&nc,&aj,NULL));
1156       PetscCall(MatGetOwnershipRanges(tao->jacobian_equality,&ranges));
1157       proc = 0;
1158       for (j=0; j < nc; j++) {
1159         /* find row ownership of */
1160         while (aj[j] >= ranges[proc+1]) proc++;
1161         nx_all = rranges[proc+1] - rranges[proc];
1162         col = aj[j] - ranges[proc] + Jranges[proc] + nx_all;
1163         PetscCall(MatPreallocateSet(row,1,&col,dnz,onz));
1164       }
1165       PetscCall(MatRestoreRow(jac_equality_trans,i+rjstart,&nc,&aj,NULL));
1166     }
1167 
1168     /* Insert Jce_xfixed^T' */
1169     if (pdipm->nxfixed) {
1170       PetscCall(MatGetRow(Jce_xfixed_trans,i+rjstart,&nc,&aj,NULL));
1171       PetscCall(MatGetOwnershipRanges(pdipm->Jce_xfixed,&ranges));
1172       proc = 0;
1173       for (j=0; j < nc; j++) {
1174         /* find row ownership of */
1175         while (aj[j] >= ranges[proc+1]) proc++;
1176         nx_all = rranges[proc+1] - rranges[proc];
1177         col = aj[j] - ranges[proc] + Jranges[proc] + nx_all + ng_all[proc];
1178         PetscCall(MatPreallocateSet(row,1,&col,dnz,onz));
1179       }
1180       PetscCall(MatRestoreRow(Jce_xfixed_trans,i+rjstart,&nc,&aj,NULL));
1181     }
1182 
1183     if (pdipm->nh) {
1184       /* Insert -grad h' */
1185       PetscCall(MatGetRow(jac_inequality_trans,i+rjstart,&nc,&aj,NULL));
1186       PetscCall(MatGetOwnershipRanges(tao->jacobian_inequality,&ranges));
1187       proc = 0;
1188       for (j=0; j < nc; j++) {
1189         /* find row ownership of */
1190         while (aj[j] >= ranges[proc+1]) proc++;
1191         nx_all = rranges[proc+1] - rranges[proc];
1192         col = aj[j] - ranges[proc] + Jranges[proc] + nx_all + nce_all[proc];
1193         PetscCall(MatPreallocateSet(row,1,&col,dnz,onz));
1194       }
1195       PetscCall(MatRestoreRow(jac_inequality_trans,i+rjstart,&nc,&aj,NULL));
1196     }
1197 
1198     /* Insert Jci_xb^T' */
1199     PetscCall(MatGetRow(Jci_xb_trans,i+rjstart,&nc,&aj,NULL));
1200     PetscCall(MatGetOwnershipRanges(pdipm->Jci_xb,&ranges));
1201     proc = 0;
1202     for (j=0; j < nc; j++) {
1203       /* find row ownership of */
1204       while (aj[j] >= ranges[proc+1]) proc++;
1205       nx_all = rranges[proc+1] - rranges[proc];
1206       col = aj[j] - ranges[proc] + Jranges[proc] + nx_all + nce_all[proc] + nh_all[proc];
1207       PetscCall(MatPreallocateSet(row,1,&col,dnz,onz));
1208     }
1209     PetscCall(MatRestoreRow(Jci_xb_trans,i+rjstart,&nc,&aj,NULL));
1210   }
1211 
1212   /* 2nd Row block of KKT matrix: [grad Ce, deltac*I, 0, 0] */
1213   if (pdipm->Ng) {
1214     PetscCall(MatGetOwnershipRange(tao->jacobian_equality,&rjstart,NULL));
1215     for (i=0; i < pdipm->ng; i++) {
1216       row = rstart + pdipm->off_lambdae + i;
1217 
1218       PetscCall(MatGetRow(tao->jacobian_equality,i+rjstart,&nc,&aj,NULL));
1219       proc = 0;
1220       for (j=0; j < nc; j++) {
1221         while (aj[j] >= cranges[proc+1]) proc++;
1222         col = aj[j] - cranges[proc] + Jranges[proc];
1223         PetscCall(MatPreallocateSet(row,1,&col,dnz,onz)); /* grad g */
1224       }
1225       PetscCall(MatRestoreRow(tao->jacobian_equality,i+rjstart,&nc,&aj,NULL));
1226     }
1227   }
1228   /* Jce_xfixed */
1229   if (pdipm->Nxfixed) {
1230     PetscCall(MatGetOwnershipRange(pdipm->Jce_xfixed,&Jcrstart,NULL));
1231     for (i=0; i < (pdipm->nce - pdipm->ng); i++) {
1232       row = rstart + pdipm->off_lambdae + pdipm->ng + i;
1233 
1234       PetscCall(MatGetRow(pdipm->Jce_xfixed,i+Jcrstart,&nc,&cols,NULL));
1235       PetscCheck(nc == 1,PETSC_COMM_SELF,PETSC_ERR_SUP,"nc != 1");
1236 
1237       proc = 0;
1238       j    = 0;
1239       while (cols[j] >= cranges[proc+1]) proc++;
1240       col = cols[j] - cranges[proc] + Jranges[proc];
1241       PetscCall(MatPreallocateSet(row,1,&col,dnz,onz));
1242       PetscCall(MatRestoreRow(pdipm->Jce_xfixed,i+Jcrstart,&nc,&cols,NULL));
1243     }
1244   }
1245 
1246   /* 3rd Row block of KKT matrix: [ gradCi, 0, deltac*I, -I] */
1247   if (pdipm->Nh) {
1248     PetscCall(MatGetOwnershipRange(tao->jacobian_inequality,&rjstart,NULL));
1249     for (i=0; i < pdipm->nh; i++) {
1250       row = rstart + pdipm->off_lambdai + i;
1251 
1252       PetscCall(MatGetRow(tao->jacobian_inequality,i+rjstart,&nc,&aj,NULL));
1253       proc = 0;
1254       for (j=0; j < nc; j++) {
1255         while (aj[j] >= cranges[proc+1]) proc++;
1256         col = aj[j] - cranges[proc] + Jranges[proc];
1257         PetscCall(MatPreallocateSet(row,1,&col,dnz,onz)); /* grad h */
1258       }
1259       PetscCall(MatRestoreRow(tao->jacobian_inequality,i+rjstart,&nc,&aj,NULL));
1260     }
1261     /* I */
1262     for (i=0; i < pdipm->nh; i++) {
1263       row = rstart + pdipm->off_lambdai + i;
1264       col = rstart + pdipm->off_z + i;
1265       PetscCall(MatPreallocateSet(row,1,&col,dnz,onz));
1266     }
1267   }
1268 
1269   /* Jci_xb */
1270   PetscCall(MatGetOwnershipRange(pdipm->Jci_xb,&Jcrstart,NULL));
1271   for (i=0; i < (pdipm->nci - pdipm->nh); i++) {
1272     row = rstart + pdipm->off_lambdai + pdipm->nh + i;
1273 
1274     PetscCall(MatGetRow(pdipm->Jci_xb,i+Jcrstart,&nc,&cols,NULL));
1275     PetscCheck(nc == 1,PETSC_COMM_SELF,PETSC_ERR_SUP,"nc != 1");
1276     proc = 0;
1277     for (j=0; j < nc; j++) {
1278       while (cols[j] >= cranges[proc+1]) proc++;
1279       col = cols[j] - cranges[proc] + Jranges[proc];
1280       PetscCall(MatPreallocateSet(row,1,&col,dnz,onz));
1281     }
1282     PetscCall(MatRestoreRow(pdipm->Jci_xb,i+Jcrstart,&nc,&cols,NULL));
1283     /* I */
1284     col = rstart + pdipm->off_z + pdipm->nh + i;
1285     PetscCall(MatPreallocateSet(row,1,&col,dnz,onz));
1286   }
1287 
1288   /* 4-th Row block of KKT matrix: Z and Ci */
1289   for (i=0; i < pdipm->nci; i++) {
1290     row     = rstart + pdipm->off_z + i;
1291     cols1[0] = rstart + pdipm->off_lambdai + i;
1292     cols1[1] = row;
1293     PetscCall(MatPreallocateSet(row,2,cols1,dnz,onz));
1294   }
1295 
1296   /* diagonal entry */
1297   for (i=0; i<pdipm->n; i++) dnz[i]++; /* diagonal entry */
1298 
1299   /* Create KKT matrix */
1300   PetscCall(MatCreate(comm,&J));
1301   PetscCall(MatSetSizes(J,pdipm->n,pdipm->n,PETSC_DECIDE,PETSC_DECIDE));
1302   PetscCall(MatSetFromOptions(J));
1303   PetscCall(MatSeqAIJSetPreallocation(J,0,dnz));
1304   PetscCall(MatMPIAIJSetPreallocation(J,0,dnz,0,onz));
1305   ierr = MatPreallocateFinalize(dnz,onz);PetscCall(ierr);
1306   pdipm->K = J;
1307 
1308   /* (8) Insert constant entries to  K */
1309   /* Set 0.0 to diagonal of K, so that the solver does not complain *about missing diagonal value */
1310   PetscCall(MatGetOwnershipRange(J,&rstart,&rend));
1311   for (i=rstart; i<rend; i++) {
1312     PetscCall(MatSetValue(J,i,i,0.0,INSERT_VALUES));
1313   }
1314   /* In case Wxx has no diagonal entries preset set diagonal to deltaw given */
1315   if (pdipm->kkt_pd) {
1316       for (i=0; i<pdipm->nh; i++) {
1317         row  = rstart + i;
1318         PetscCall(MatSetValue(J,row,row,pdipm->deltaw,INSERT_VALUES));
1319       }
1320   }
1321 
1322   /* Row block of K: [ grad Ce, 0, 0, 0] */
1323   if (pdipm->Nxfixed) {
1324     PetscCall(MatGetOwnershipRange(pdipm->Jce_xfixed,&Jcrstart,NULL));
1325     for (i=0; i < (pdipm->nce - pdipm->ng); i++) {
1326       row = rstart + pdipm->off_lambdae + pdipm->ng + i;
1327 
1328       PetscCall(MatGetRow(pdipm->Jce_xfixed,i+Jcrstart,&nc,&cols,&aa));
1329       proc = 0;
1330       for (j=0; j < nc; j++) {
1331         while (cols[j] >= cranges[proc+1]) proc++;
1332         col = cols[j] - cranges[proc] + Jranges[proc];
1333         PetscCall(MatSetValue(J,row,col,aa[j],INSERT_VALUES)); /* grad Ce */
1334         PetscCall(MatSetValue(J,col,row,aa[j],INSERT_VALUES)); /* grad Ce' */
1335       }
1336       PetscCall(MatRestoreRow(pdipm->Jce_xfixed,i+Jcrstart,&nc,&cols,&aa));
1337     }
1338   }
1339 
1340   /* Row block of K: [ -grad Ci, 0, 0, I] */
1341   PetscCall(MatGetOwnershipRange(pdipm->Jci_xb,&Jcrstart,NULL));
1342   for (i=0; i < pdipm->nci - pdipm->nh; i++) {
1343     row = rstart + pdipm->off_lambdai + pdipm->nh + i;
1344 
1345     PetscCall(MatGetRow(pdipm->Jci_xb,i+Jcrstart,&nc,&cols,&aa));
1346     proc = 0;
1347     for (j=0; j < nc; j++) {
1348       while (cols[j] >= cranges[proc+1]) proc++;
1349       col = cols[j] - cranges[proc] + Jranges[proc];
1350       PetscCall(MatSetValue(J,col,row,-aa[j],INSERT_VALUES));
1351       PetscCall(MatSetValue(J,row,col,-aa[j],INSERT_VALUES));
1352     }
1353     PetscCall(MatRestoreRow(pdipm->Jci_xb,i+Jcrstart,&nc,&cols,&aa));
1354 
1355     col = rstart + pdipm->off_z + pdipm->nh + i;
1356     PetscCall(MatSetValue(J,row,col,1,INSERT_VALUES));
1357   }
1358 
1359   for (i=0; i < pdipm->nh; i++) {
1360     row = rstart + pdipm->off_lambdai + i;
1361     col = rstart + pdipm->off_z + i;
1362     PetscCall(MatSetValue(J,row,col,1,INSERT_VALUES));
1363   }
1364 
1365   /* Row block of K: [ 0, 0, I, ...] */
1366   for (i=0; i < pdipm->nci; i++) {
1367     row = rstart + pdipm->off_z + i;
1368     col = rstart + pdipm->off_lambdai + i;
1369     PetscCall(MatSetValue(J,row,col,1,INSERT_VALUES));
1370   }
1371 
1372   if (pdipm->Nxfixed) {
1373     PetscCall(MatDestroy(&Jce_xfixed_trans));
1374   }
1375   PetscCall(MatDestroy(&Jci_xb_trans));
1376   PetscCall(PetscFree3(ng_all,nh_all,Jranges));
1377 
1378   /* (9) Set up nonlinear solver SNES */
1379   PetscCall(SNESSetFunction(pdipm->snes,NULL,TaoSNESFunction_PDIPM,(void*)tao));
1380   PetscCall(SNESSetJacobian(pdipm->snes,J,J,TaoSNESJacobian_PDIPM,(void*)tao));
1381 
1382   if (pdipm->solve_reduced_kkt) {
1383     PC pc;
1384     PetscCall(KSPGetPC(tao->ksp,&pc));
1385     PetscCall(PCSetType(pc,PCFIELDSPLIT));
1386     PetscCall(PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR));
1387     PetscCall(PCFieldSplitSetIS(pc,"2",pdipm->is2));
1388     PetscCall(PCFieldSplitSetIS(pc,"1",pdipm->is1));
1389   }
1390   PetscCall(SNESSetFromOptions(pdipm->snes));
1391 
1392   /* (10) Setup PCPreSolve() for pdipm->solve_symmetric_kkt */
1393   if (pdipm->solve_symmetric_kkt) {
1394     KSP       ksp;
1395     PC        pc;
1396     PetscBool isCHOL;
1397     PetscCall(SNESGetKSP(pdipm->snes,&ksp));
1398     PetscCall(KSPGetPC(ksp,&pc));
1399     PetscCall(PCSetPreSolve(pc,PCPreSolve_PDIPM));
1400 
1401     PetscCall(PetscObjectTypeCompare((PetscObject)pc,PCCHOLESKY,&isCHOL));
1402     if (isCHOL) {
1403       Mat        Factor;
1404       PetscBool  isMUMPS;
1405       PetscCall(PCFactorGetMatrix(pc,&Factor));
1406       PetscCall(PetscObjectTypeCompare((PetscObject)Factor,"mumps",&isMUMPS));
1407       if (isMUMPS) { /* must set mumps ICNTL(13)=1 and ICNTL(24)=1 to call MatGetInertia() */
1408 #if defined(PETSC_HAVE_MUMPS)
1409         PetscCall(MatMumpsSetIcntl(Factor,24,1)); /* detection of null pivot rows */
1410         if (size > 1) {
1411           PetscCall(MatMumpsSetIcntl(Factor,13,1)); /* parallelism of the root node (enable ScaLAPACK) and its splitting */
1412         }
1413 #else
1414         SETERRQ(PetscObjectComm((PetscObject)tao),PETSC_ERR_SUP,"Requires external package MUMPS");
1415 #endif
1416       }
1417     }
1418   }
1419   PetscFunctionReturn(0);
1420 }
1421 
1422 /*
1423    TaoDestroy_PDIPM - Destroys the pdipm object
1424 
1425    Input:
1426    full pdipm
1427 
1428    Output:
1429    Destroyed pdipm
1430 */
1431 PetscErrorCode TaoDestroy_PDIPM(Tao tao)
1432 {
1433   TAO_PDIPM      *pdipm = (TAO_PDIPM*)tao->data;
1434 
1435   PetscFunctionBegin;
1436   /* Freeing Vectors assocaiated with KKT (X) */
1437   PetscCall(VecDestroy(&pdipm->x)); /* Solution x */
1438   PetscCall(VecDestroy(&pdipm->lambdae)); /* Equality constraints lagrangian multiplier*/
1439   PetscCall(VecDestroy(&pdipm->lambdai)); /* Inequality constraints lagrangian multiplier*/
1440   PetscCall(VecDestroy(&pdipm->z));       /* Slack variables */
1441   PetscCall(VecDestroy(&pdipm->X));       /* Big KKT system vector [x; lambdae; lambdai; z] */
1442 
1443   /* work vectors */
1444   PetscCall(VecDestroy(&pdipm->lambdae_xfixed));
1445   PetscCall(VecDestroy(&pdipm->lambdai_xb));
1446 
1447   /* Legrangian equality and inequality Vec */
1448   PetscCall(VecDestroy(&pdipm->ce)); /* Vec of equality constraints */
1449   PetscCall(VecDestroy(&pdipm->ci)); /* Vec of inequality constraints */
1450 
1451   /* Matrices */
1452   PetscCall(MatDestroy(&pdipm->Jce_xfixed));
1453   PetscCall(MatDestroy(&pdipm->Jci_xb)); /* Jacobian of inequality constraints Jci = [tao->jacobian_inequality ; J(nxub); J(nxlb); J(nxbx)] */
1454   PetscCall(MatDestroy(&pdipm->K));
1455 
1456   /* Index Sets */
1457   if (pdipm->Nxub) {
1458     PetscCall(ISDestroy(&pdipm->isxub));    /* Finite upper bound only -inf < x < ub */
1459   }
1460 
1461   if (pdipm->Nxlb) {
1462     PetscCall(ISDestroy(&pdipm->isxlb));    /* Finite lower bound only  lb <= x < inf */
1463   }
1464 
1465   if (pdipm->Nxfixed) {
1466     PetscCall(ISDestroy(&pdipm->isxfixed)); /* Fixed variables         lb =  x = ub */
1467   }
1468 
1469   if (pdipm->Nxbox) {
1470     PetscCall(ISDestroy(&pdipm->isxbox));   /* Boxed variables         lb <= x <= ub */
1471   }
1472 
1473   if (pdipm->Nxfree) {
1474     PetscCall(ISDestroy(&pdipm->isxfree));  /* Free variables        -inf <= x <= inf */
1475   }
1476 
1477   if (pdipm->solve_reduced_kkt) {
1478     PetscCall(ISDestroy(&pdipm->is1));
1479     PetscCall(ISDestroy(&pdipm->is2));
1480   }
1481 
1482   /* SNES */
1483   PetscCall(SNESDestroy(&pdipm->snes)); /* Nonlinear solver */
1484   PetscCall(PetscFree(pdipm->nce_all));
1485   PetscCall(MatDestroy(&pdipm->jac_equality_trans));
1486   PetscCall(MatDestroy(&pdipm->jac_inequality_trans));
1487 
1488   /* Destroy pdipm */
1489   PetscCall(PetscFree(tao->data)); /* Holding locations of pdipm */
1490 
1491   /* Destroy Dual */
1492   PetscCall(VecDestroy(&tao->DE)); /* equality dual */
1493   PetscCall(VecDestroy(&tao->DI)); /* dinequality dual */
1494   PetscFunctionReturn(0);
1495 }
1496 
1497 PetscErrorCode TaoSetFromOptions_PDIPM(PetscOptionItems *PetscOptionsObject,Tao tao)
1498 {
1499   TAO_PDIPM      *pdipm = (TAO_PDIPM*)tao->data;
1500 
1501   PetscFunctionBegin;
1502   PetscCall(PetscOptionsHead(PetscOptionsObject,"PDIPM method for constrained optimization"));
1503   PetscCall(PetscOptionsReal("-tao_pdipm_push_init_slack","parameter to push initial slack variables away from bounds",NULL,pdipm->push_init_slack,&pdipm->push_init_slack,NULL));
1504   PetscCall(PetscOptionsReal("-tao_pdipm_push_init_lambdai","parameter to push initial (inequality) dual variables away from bounds",NULL,pdipm->push_init_lambdai,&pdipm->push_init_lambdai,NULL));
1505   PetscCall(PetscOptionsBool("-tao_pdipm_solve_reduced_kkt","Solve reduced KKT system using Schur-complement",NULL,pdipm->solve_reduced_kkt,&pdipm->solve_reduced_kkt,NULL));
1506   PetscCall(PetscOptionsReal("-tao_pdipm_mu_update_factor","Update scalar for barrier parameter (mu) update",NULL,pdipm->mu_update_factor,&pdipm->mu_update_factor,NULL));
1507   PetscCall(PetscOptionsBool("-tao_pdipm_symmetric_kkt","Solve non reduced symmetric KKT system",NULL,pdipm->solve_symmetric_kkt,&pdipm->solve_symmetric_kkt,NULL));
1508   PetscCall(PetscOptionsBool("-tao_pdipm_kkt_shift_pd","Add shifts to make KKT matrix positive definite",NULL,pdipm->kkt_pd,&pdipm->kkt_pd,NULL));
1509   PetscCall(PetscOptionsTail());
1510   PetscFunctionReturn(0);
1511 }
1512 
1513 /*MC
1514   TAOPDIPM - Barrier-based primal-dual interior point algorithm for generally constrained optimization.
1515 
1516   Option Database Keys:
1517 +   -tao_pdipm_push_init_lambdai - parameter to push initial dual variables away from bounds (> 0)
1518 .   -tao_pdipm_push_init_slack - parameter to push initial slack variables away from bounds (> 0)
1519 .   -tao_pdipm_mu_update_factor - update scalar for barrier parameter (mu) update (> 0)
1520 .   -tao_pdipm_symmetric_kkt - Solve non-reduced symmetric KKT system
1521 -   -tao_pdipm_kkt_shift_pd - Add shifts to make KKT matrix positive definite
1522 
1523   Level: beginner
1524 M*/
1525 PETSC_EXTERN PetscErrorCode TaoCreate_PDIPM(Tao tao)
1526 {
1527   TAO_PDIPM      *pdipm;
1528 
1529   PetscFunctionBegin;
1530   tao->ops->setup          = TaoSetup_PDIPM;
1531   tao->ops->solve          = TaoSolve_PDIPM;
1532   tao->ops->setfromoptions = TaoSetFromOptions_PDIPM;
1533   tao->ops->view           = TaoView_PDIPM;
1534   tao->ops->destroy        = TaoDestroy_PDIPM;
1535 
1536   PetscCall(PetscNewLog(tao,&pdipm));
1537   tao->data = (void*)pdipm;
1538 
1539   pdipm->nx      = pdipm->Nx      = 0;
1540   pdipm->nxfixed = pdipm->Nxfixed = 0;
1541   pdipm->nxlb    = pdipm->Nxlb    = 0;
1542   pdipm->nxub    = pdipm->Nxub    = 0;
1543   pdipm->nxbox   = pdipm->Nxbox   = 0;
1544   pdipm->nxfree  = pdipm->Nxfree  = 0;
1545 
1546   pdipm->ng = pdipm->Ng = pdipm->nce = pdipm->Nce = 0;
1547   pdipm->nh = pdipm->Nh = pdipm->nci = pdipm->Nci = 0;
1548   pdipm->n  = pdipm->N  = 0;
1549   pdipm->mu = 1.0;
1550   pdipm->mu_update_factor = 0.1;
1551 
1552   pdipm->deltaw     = 0.0;
1553   pdipm->lastdeltaw = 3*1.e-4;
1554   pdipm->deltac     = 0.0;
1555   pdipm->kkt_pd     = PETSC_FALSE;
1556 
1557   pdipm->push_init_slack     = 1.0;
1558   pdipm->push_init_lambdai   = 1.0;
1559   pdipm->solve_reduced_kkt   = PETSC_FALSE;
1560   pdipm->solve_symmetric_kkt = PETSC_TRUE;
1561 
1562   /* Override default settings (unless already changed) */
1563   if (!tao->max_it_changed) tao->max_it = 200;
1564   if (!tao->max_funcs_changed) tao->max_funcs = 500;
1565 
1566   PetscCall(SNESCreate(((PetscObject)tao)->comm,&pdipm->snes));
1567   PetscCall(SNESSetOptionsPrefix(pdipm->snes,tao->hdr.prefix));
1568   PetscCall(SNESGetKSP(pdipm->snes,&tao->ksp));
1569   PetscCall(PetscObjectReference((PetscObject)tao->ksp));
1570   PetscCall(KSPSetApplicationContext(tao->ksp,(void *)tao));
1571   PetscFunctionReturn(0);
1572 }
1573