xref: /petsc/src/tao/quadratic/impls/gpcg/gpcg.c (revision 0beef4918dacc264d49d2a0c02ab8bfbaa25bfe3)
1 #include <petscksp.h>
2 #include <../src/tao/quadratic/impls/gpcg/gpcg.h>        /*I "gpcg.h" I*/
3 
4 
5 static PetscErrorCode GPCGGradProjections(Tao tao);
6 static PetscErrorCode GPCGObjectiveAndGradient(TaoLineSearch,Vec,PetscReal*,Vec,void*);
7 
8 /*------------------------------------------------------------*/
9 static PetscErrorCode TaoDestroy_GPCG(Tao tao)
10 {
11   TAO_GPCG       *gpcg = (TAO_GPCG *)tao->data;
12   PetscErrorCode ierr;
13 
14   /* Free allocated memory in GPCG structure */
15   PetscFunctionBegin;
16   ierr = VecDestroy(&gpcg->B);CHKERRQ(ierr);
17   ierr = VecDestroy(&gpcg->Work);CHKERRQ(ierr);
18   ierr = VecDestroy(&gpcg->X_New);CHKERRQ(ierr);
19   ierr = VecDestroy(&gpcg->G_New);CHKERRQ(ierr);
20   ierr = VecDestroy(&gpcg->DXFree);CHKERRQ(ierr);
21   ierr = VecDestroy(&gpcg->R);CHKERRQ(ierr);
22   ierr = VecDestroy(&gpcg->PG);CHKERRQ(ierr);
23   ierr = MatDestroy(&gpcg->Hsub);CHKERRQ(ierr);
24   ierr = MatDestroy(&gpcg->Hsub_pre);CHKERRQ(ierr);
25   ierr = ISDestroy(&gpcg->Free_Local);CHKERRQ(ierr);
26   ierr = PetscFree(tao->data);CHKERRQ(ierr);
27   PetscFunctionReturn(0);
28 }
29 
30 /*------------------------------------------------------------*/
31 static PetscErrorCode TaoSetFromOptions_GPCG(PetscOptionItems *PetscOptionsObject,Tao tao)
32 {
33   TAO_GPCG       *gpcg = (TAO_GPCG *)tao->data;
34   PetscErrorCode ierr;
35   PetscBool      flg;
36 
37   PetscFunctionBegin;
38   ierr = PetscOptionsHead(PetscOptionsObject,"Gradient Projection, Conjugate Gradient method for bound constrained optimization");CHKERRQ(ierr);
39   ierr=PetscOptionsInt("-tao_gpcg_maxpgits","maximum number of gradient projections per GPCG iterate",NULL,gpcg->maxgpits,&gpcg->maxgpits,&flg);CHKERRQ(ierr);
40   ierr = PetscOptionsTail();CHKERRQ(ierr);
41   ierr = KSPSetFromOptions(tao->ksp);CHKERRQ(ierr);
42   ierr = TaoLineSearchSetFromOptions(tao->linesearch);CHKERRQ(ierr);
43   PetscFunctionReturn(0);
44 }
45 
46 /*------------------------------------------------------------*/
47 static PetscErrorCode TaoView_GPCG(Tao tao, PetscViewer viewer)
48 {
49   TAO_GPCG       *gpcg = (TAO_GPCG *)tao->data;
50   PetscBool      isascii;
51   PetscErrorCode ierr;
52 
53   PetscFunctionBegin;
54   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
55   if (isascii) {
56     ierr = PetscViewerASCIIPrintf(viewer,"Total PG its: %D,",gpcg->total_gp_its);CHKERRQ(ierr);
57     ierr = PetscViewerASCIIPrintf(viewer,"PG tolerance: %g \n",(double)gpcg->pg_ftol);CHKERRQ(ierr);
58   }
59   ierr = TaoLineSearchView(tao->linesearch,viewer);CHKERRQ(ierr);
60   PetscFunctionReturn(0);
61 }
62 
63 /* GPCGObjectiveAndGradient()
64    Compute f=0.5 * x'Hx + b'x + c
65            g=Hx + b
66 */
67 static PetscErrorCode GPCGObjectiveAndGradient(TaoLineSearch ls, Vec X, PetscReal *f, Vec G, void*tptr)
68 {
69   Tao            tao = (Tao)tptr;
70   TAO_GPCG       *gpcg = (TAO_GPCG*)tao->data;
71   PetscErrorCode ierr;
72   PetscReal      f1,f2;
73 
74   PetscFunctionBegin;
75   ierr = MatMult(tao->hessian,X,G);CHKERRQ(ierr);
76   ierr = VecDot(G,X,&f1);CHKERRQ(ierr);
77   ierr = VecDot(gpcg->B,X,&f2);CHKERRQ(ierr);
78   ierr = VecAXPY(G,1.0,gpcg->B);CHKERRQ(ierr);
79   *f=f1/2.0 + f2 + gpcg->c;
80   PetscFunctionReturn(0);
81 }
82 
83 /* ---------------------------------------------------------- */
84 static PetscErrorCode TaoSetup_GPCG(Tao tao)
85 {
86   PetscErrorCode ierr;
87   TAO_GPCG       *gpcg = (TAO_GPCG *)tao->data;
88 
89   PetscFunctionBegin;
90   /* Allocate some arrays */
91   if (!tao->gradient) {
92       ierr = VecDuplicate(tao->solution, &tao->gradient);CHKERRQ(ierr);
93   }
94   if (!tao->stepdirection) {
95       ierr = VecDuplicate(tao->solution, &tao->stepdirection);CHKERRQ(ierr);
96   }
97   if (!tao->XL) {
98       ierr = VecDuplicate(tao->solution,&tao->XL);CHKERRQ(ierr);
99       ierr = VecSet(tao->XL,PETSC_NINFINITY);CHKERRQ(ierr);
100   }
101   if (!tao->XU) {
102       ierr = VecDuplicate(tao->solution,&tao->XU);CHKERRQ(ierr);
103       ierr = VecSet(tao->XU,PETSC_INFINITY);CHKERRQ(ierr);
104   }
105 
106   ierr=VecDuplicate(tao->solution,&gpcg->B);CHKERRQ(ierr);
107   ierr=VecDuplicate(tao->solution,&gpcg->Work);CHKERRQ(ierr);
108   ierr=VecDuplicate(tao->solution,&gpcg->X_New);CHKERRQ(ierr);
109   ierr=VecDuplicate(tao->solution,&gpcg->G_New);CHKERRQ(ierr);
110   ierr=VecDuplicate(tao->solution,&gpcg->DXFree);CHKERRQ(ierr);
111   ierr=VecDuplicate(tao->solution,&gpcg->R);CHKERRQ(ierr);
112   ierr=VecDuplicate(tao->solution,&gpcg->PG);CHKERRQ(ierr);
113   /*
114     if (gpcg->ksp_type == GPCG_KSP_NASH) {
115         ierr = KSPSetType(tao->ksp,KSPCGNASH);CHKERRQ(ierr);
116       } else if (gpcg->ksp_type == GPCG_KSP_STCG) {
117         ierr = KSPSetType(tao->ksp,KSPCGSTCG);CHKERRQ(ierr);
118       } else {
119         ierr = KSPSetType(tao->ksp,KSPCGGLTR);CHKERRQ(ierr);
120       }
121       if (tao->ksp->ops->setfromoptions) {
122         (*tao->ksp->ops->setfromoptions)(tao->ksp);
123       }
124 
125     }
126   */
127   PetscFunctionReturn(0);
128 }
129 
130 static PetscErrorCode TaoSolve_GPCG(Tao tao)
131 {
132   TAO_GPCG                     *gpcg = (TAO_GPCG *)tao->data;
133   PetscErrorCode               ierr;
134   PetscInt                     its;
135   PetscReal                    actred,f,f_new,gnorm,gdx,stepsize,xtb;
136   PetscReal                    xtHx;
137   TaoLineSearchConvergedReason ls_status = TAOLINESEARCH_CONTINUE_ITERATING;
138 
139   PetscFunctionBegin;
140 
141   ierr = TaoComputeVariableBounds(tao);CHKERRQ(ierr);
142   ierr = VecMedian(tao->XL,tao->solution,tao->XU,tao->solution);CHKERRQ(ierr);
143   ierr = TaoLineSearchSetVariableBounds(tao->linesearch,tao->XL,tao->XU);CHKERRQ(ierr);
144 
145   /* Using f = .5*x'Hx + x'b + c and g=Hx + b,  compute b,c */
146   ierr = TaoComputeHessian(tao,tao->solution,tao->hessian,tao->hessian_pre);CHKERRQ(ierr);
147   ierr = TaoComputeObjectiveAndGradient(tao,tao->solution,&f,tao->gradient);CHKERRQ(ierr);
148   ierr = VecCopy(tao->gradient, gpcg->B);CHKERRQ(ierr);
149   ierr = MatMult(tao->hessian,tao->solution,gpcg->Work);CHKERRQ(ierr);
150   ierr = VecDot(gpcg->Work, tao->solution, &xtHx);CHKERRQ(ierr);
151   ierr = VecAXPY(gpcg->B,-1.0,gpcg->Work);CHKERRQ(ierr);
152   ierr = VecDot(gpcg->B,tao->solution,&xtb);CHKERRQ(ierr);
153   gpcg->c=f-xtHx/2.0-xtb;
154   if (gpcg->Free_Local) {
155       ierr = ISDestroy(&gpcg->Free_Local);CHKERRQ(ierr);
156   }
157   ierr = VecWhichInactive(tao->XL,tao->solution,tao->gradient,tao->XU,PETSC_TRUE,&gpcg->Free_Local);CHKERRQ(ierr);
158 
159   /* Project the gradient and calculate the norm */
160   ierr = VecCopy(tao->gradient,gpcg->G_New);CHKERRQ(ierr);
161   ierr = VecBoundGradientProjection(tao->gradient,tao->solution,tao->XL,tao->XU,gpcg->PG);CHKERRQ(ierr);
162   ierr = VecNorm(gpcg->PG,NORM_2,&gpcg->gnorm);CHKERRQ(ierr);
163   tao->step=1.0;
164   gpcg->f = f;
165 
166     /* Check Stopping Condition      */
167   tao->reason = TAO_CONTINUE_ITERATING;
168   ierr = TaoLogConvergenceHistory(tao,f,gpcg->gnorm,0.0,tao->ksp_its);CHKERRQ(ierr);
169   ierr = TaoMonitor(tao,tao->niter,f,gpcg->gnorm,0.0,tao->step);CHKERRQ(ierr);
170   ierr = (*tao->ops->convergencetest)(tao,tao->cnvP);CHKERRQ(ierr);
171 
172   while (tao->reason == TAO_CONTINUE_ITERATING){
173     tao->ksp_its=0;
174 
175     ierr = GPCGGradProjections(tao);CHKERRQ(ierr);
176     ierr = ISGetSize(gpcg->Free_Local,&gpcg->n_free);CHKERRQ(ierr);
177 
178     f=gpcg->f; gnorm=gpcg->gnorm;
179 
180     ierr = KSPReset(tao->ksp);CHKERRQ(ierr);
181 
182     if (gpcg->n_free > 0){
183       /* Create a reduced linear system */
184       ierr = VecDestroy(&gpcg->R);CHKERRQ(ierr);
185       ierr = VecDestroy(&gpcg->DXFree);CHKERRQ(ierr);
186       ierr = TaoVecGetSubVec(tao->gradient,gpcg->Free_Local, tao->subset_type, 0.0, &gpcg->R);CHKERRQ(ierr);
187       ierr = VecScale(gpcg->R, -1.0);CHKERRQ(ierr);
188       ierr = TaoVecGetSubVec(tao->stepdirection,gpcg->Free_Local,tao->subset_type, 0.0, &gpcg->DXFree);CHKERRQ(ierr);
189       ierr = VecSet(gpcg->DXFree,0.0);CHKERRQ(ierr);
190 
191       ierr = TaoMatGetSubMat(tao->hessian, gpcg->Free_Local, gpcg->Work, tao->subset_type, &gpcg->Hsub);CHKERRQ(ierr);
192 
193       if (tao->hessian_pre == tao->hessian) {
194         ierr = MatDestroy(&gpcg->Hsub_pre);CHKERRQ(ierr);
195         ierr = PetscObjectReference((PetscObject)gpcg->Hsub);CHKERRQ(ierr);
196         gpcg->Hsub_pre = gpcg->Hsub;
197       }  else {
198         ierr = TaoMatGetSubMat(tao->hessian, gpcg->Free_Local, gpcg->Work, tao->subset_type, &gpcg->Hsub_pre);CHKERRQ(ierr);
199       }
200 
201       ierr = KSPReset(tao->ksp);CHKERRQ(ierr);
202       ierr = KSPSetOperators(tao->ksp,gpcg->Hsub,gpcg->Hsub_pre);CHKERRQ(ierr);
203 
204       ierr = KSPSolve(tao->ksp,gpcg->R,gpcg->DXFree);CHKERRQ(ierr);
205       ierr = KSPGetIterationNumber(tao->ksp,&its);CHKERRQ(ierr);
206       tao->ksp_its+=its;
207       tao->ksp_tot_its+=its;
208       ierr = VecSet(tao->stepdirection,0.0);CHKERRQ(ierr);
209       ierr = VecISAXPY(tao->stepdirection,gpcg->Free_Local,1.0,gpcg->DXFree);CHKERRQ(ierr);
210 
211       ierr = VecDot(tao->stepdirection,tao->gradient,&gdx);CHKERRQ(ierr);
212       ierr = TaoLineSearchSetInitialStepLength(tao->linesearch,1.0);CHKERRQ(ierr);
213       f_new=f;
214       ierr = TaoLineSearchApply(tao->linesearch,tao->solution,&f_new,tao->gradient,tao->stepdirection,&stepsize,&ls_status);CHKERRQ(ierr);
215 
216       actred = f_new - f;
217 
218       /* Evaluate the function and gradient at the new point */
219       ierr = VecBoundGradientProjection(tao->gradient,tao->solution,tao->XL,tao->XU, gpcg->PG);CHKERRQ(ierr);
220       ierr = VecNorm(gpcg->PG, NORM_2, &gnorm);CHKERRQ(ierr);
221       f=f_new;
222       ierr = ISDestroy(&gpcg->Free_Local);CHKERRQ(ierr);
223       ierr = VecWhichInactive(tao->XL,tao->solution,tao->gradient,tao->XU,PETSC_TRUE,&gpcg->Free_Local);CHKERRQ(ierr);
224     } else {
225       actred = 0; gpcg->step=1.0;
226       /* if there were no free variables, no cg method */
227     }
228 
229     tao->niter++;
230     gpcg->f=f;gpcg->gnorm=gnorm; gpcg->actred=actred;
231     ierr = TaoLogConvergenceHistory(tao,f,gpcg->gnorm,0.0,tao->ksp_its);CHKERRQ(ierr);
232     ierr = TaoMonitor(tao,tao->niter,f,gpcg->gnorm,0.0,tao->step);CHKERRQ(ierr);
233     ierr = (*tao->ops->convergencetest)(tao,tao->cnvP);CHKERRQ(ierr);
234     if (tao->reason != TAO_CONTINUE_ITERATING) break;
235   }  /* END MAIN LOOP  */
236 
237   PetscFunctionReturn(0);
238 }
239 
240 static PetscErrorCode GPCGGradProjections(Tao tao)
241 {
242   PetscErrorCode                 ierr;
243   TAO_GPCG                       *gpcg = (TAO_GPCG *)tao->data;
244   PetscInt                       i;
245   PetscReal                      actred=-1.0,actred_max=0.0, gAg,gtg=gpcg->gnorm,alpha;
246   PetscReal                      f_new,gdx,stepsize;
247   Vec                            DX=tao->stepdirection,XL=tao->XL,XU=tao->XU,Work=gpcg->Work;
248   Vec                            X=tao->solution,G=tao->gradient;
249   TaoLineSearchConvergedReason lsflag=TAOLINESEARCH_CONTINUE_ITERATING;
250 
251   /*
252      The free, active, and binding variables should be already identified
253   */
254   PetscFunctionBegin;
255   for (i=0;i<gpcg->maxgpits;i++){
256     if ( -actred <= (gpcg->pg_ftol)*actred_max) break;
257     ierr = VecBoundGradientProjection(G,X,XL,XU,DX);CHKERRQ(ierr);
258     ierr = VecScale(DX,-1.0);CHKERRQ(ierr);
259     ierr = VecDot(DX,G,&gdx);CHKERRQ(ierr);
260 
261     ierr = MatMult(tao->hessian,DX,Work);CHKERRQ(ierr);
262     ierr = VecDot(DX,Work,&gAg);CHKERRQ(ierr);
263 
264     gpcg->gp_iterates++;
265     gpcg->total_gp_its++;
266 
267     gtg=-gdx;
268     if (PetscAbsReal(gAg) == 0.0) {
269       alpha = 1.0;
270     } else {
271       alpha = PetscAbsReal(gtg/gAg);
272     }
273     ierr = TaoLineSearchSetInitialStepLength(tao->linesearch,alpha);CHKERRQ(ierr);
274     f_new=gpcg->f;
275     ierr = TaoLineSearchApply(tao->linesearch,X,&f_new,G,DX,&stepsize,&lsflag);CHKERRQ(ierr);
276 
277     /* Update the iterate */
278     actred = f_new - gpcg->f;
279     actred_max = PetscMax(actred_max,-(f_new - gpcg->f));
280     gpcg->f = f_new;
281     ierr = ISDestroy(&gpcg->Free_Local);CHKERRQ(ierr);
282     ierr = VecWhichInactive(XL,X,tao->gradient,XU,PETSC_TRUE,&gpcg->Free_Local);CHKERRQ(ierr);
283   }
284 
285   gpcg->gnorm=gtg;
286   PetscFunctionReturn(0);
287 } /* End gradient projections */
288 
289 static PetscErrorCode TaoComputeDual_GPCG(Tao tao, Vec DXL, Vec DXU)
290 {
291   TAO_GPCG       *gpcg = (TAO_GPCG *)tao->data;
292   PetscErrorCode ierr;
293 
294   PetscFunctionBegin;
295   ierr = VecBoundGradientProjection(tao->gradient, tao->solution, tao->XL, tao->XU, gpcg->Work);CHKERRQ(ierr);
296   ierr = VecCopy(gpcg->Work, DXL);CHKERRQ(ierr);
297   ierr = VecAXPY(DXL,-1.0,tao->gradient);CHKERRQ(ierr);
298   ierr = VecSet(DXU,0.0);CHKERRQ(ierr);
299   ierr = VecPointwiseMax(DXL,DXL,DXU);CHKERRQ(ierr);
300 
301   ierr = VecCopy(tao->gradient,DXU);CHKERRQ(ierr);
302   ierr = VecAXPY(DXU,-1.0,gpcg->Work);CHKERRQ(ierr);
303   ierr = VecSet(gpcg->Work,0.0);CHKERRQ(ierr);
304   ierr = VecPointwiseMin(DXU,gpcg->Work,DXU);CHKERRQ(ierr);
305   PetscFunctionReturn(0);
306 }
307 
308 /*------------------------------------------------------------*/
309 /*MC
310   TAOGPCG - gradient projected conjugate gradient algorithm is an active-set
311         conjugate-gradient based method for bound-constrained minimization
312 
313   Options Database Keys:
314 + -tao_gpcg_maxpgits - maximum number of gradient projections for GPCG iterate
315 - -tao_subset_type - "subvec","mask","matrix-free", strategies for handling active-sets
316 
317   Level: beginner
318 M*/
319 PETSC_EXTERN PetscErrorCode TaoCreate_GPCG(Tao tao)
320 {
321   TAO_GPCG       *gpcg;
322   PetscErrorCode ierr;
323 
324   PetscFunctionBegin;
325   tao->ops->setup = TaoSetup_GPCG;
326   tao->ops->solve = TaoSolve_GPCG;
327   tao->ops->view  = TaoView_GPCG;
328   tao->ops->setfromoptions = TaoSetFromOptions_GPCG;
329   tao->ops->destroy = TaoDestroy_GPCG;
330   tao->ops->computedual = TaoComputeDual_GPCG;
331 
332   ierr = PetscNewLog(tao,&gpcg);CHKERRQ(ierr);
333   tao->data = (void*)gpcg;
334 
335   /* Override default settings (unless already changed) */
336   if (!tao->max_it_changed) tao->max_it=500;
337   if (!tao->max_funcs_changed) tao->max_funcs = 100000;
338 #if defined(PETSC_USE_REAL_SINGLE)
339   if (!tao->gatol_changed) tao->gatol=1e-6;
340   if (!tao->grtol_changed) tao->grtol=1e-6;
341 #else
342   if (!tao->gatol_changed) tao->gatol=1e-12;
343   if (!tao->grtol_changed) tao->grtol=1e-12;
344 #endif
345 
346   /* Initialize pointers and variables */
347   gpcg->n=0;
348   gpcg->maxgpits = 8;
349   gpcg->pg_ftol = 0.1;
350 
351   gpcg->gp_iterates=0; /* Cumulative number */
352   gpcg->total_gp_its = 0;
353 
354   /* Initialize pointers and variables */
355   gpcg->n_bind=0;
356   gpcg->n_free = 0;
357   gpcg->n_upper=0;
358   gpcg->n_lower=0;
359   gpcg->subset_type = TAO_SUBSET_MASK;
360   gpcg->Hsub=NULL;
361   gpcg->Hsub_pre=NULL;
362 
363   ierr = KSPCreate(((PetscObject)tao)->comm, &tao->ksp);CHKERRQ(ierr);
364   ierr = PetscObjectIncrementTabLevel((PetscObject)tao->ksp, (PetscObject)tao, 1);CHKERRQ(ierr);
365   ierr = KSPSetOptionsPrefix(tao->ksp, tao->hdr.prefix);CHKERRQ(ierr);
366   ierr = KSPSetType(tao->ksp,KSPCGNASH);CHKERRQ(ierr);
367 
368   ierr = TaoLineSearchCreate(((PetscObject)tao)->comm, &tao->linesearch);CHKERRQ(ierr);
369   ierr = PetscObjectIncrementTabLevel((PetscObject)tao->linesearch, (PetscObject)tao, 1);CHKERRQ(ierr);
370   ierr = TaoLineSearchSetType(tao->linesearch, TAOLINESEARCHGPCG);CHKERRQ(ierr);
371   ierr = TaoLineSearchSetObjectiveAndGradientRoutine(tao->linesearch, GPCGObjectiveAndGradient, tao);CHKERRQ(ierr);
372   ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,tao->hdr.prefix);CHKERRQ(ierr);
373   PetscFunctionReturn(0);
374 }
375