xref: /petsc/src/tao/interface/taosolver.c (revision 79f5d8ca3868d863653cbc51029f4e819bdb5366)
1441846f8SBarry Smith #define TAO_DLL
2a7e14dcfSSatish Balay 
3af0996ceSBarry Smith #include <petsc/private/taoimpl.h> /*I "petsctao.h" I*/
4a7e14dcfSSatish Balay 
5441846f8SBarry Smith PetscBool TaoRegisterAllCalled = PETSC_FALSE;
6441846f8SBarry Smith PetscFunctionList TaoList = NULL;
7a7e14dcfSSatish Balay 
8441846f8SBarry Smith PetscClassId TAO_CLASSID;
9441846f8SBarry Smith PetscLogEvent Tao_Solve, Tao_ObjectiveEval, Tao_GradientEval, Tao_ObjGradientEval, Tao_HessianEval, Tao_ConstraintsEval, Tao_JacobianEval;
10a7e14dcfSSatish Balay 
115b0d99aeSBarry Smith const char *TaoSubSetTypes[] = {  "subvec","mask","matrixfree","TaoSubSetType","TAO_SUBSET_",0};
12a7e14dcfSSatish Balay 
13e882e171SHong Zhang struct _n_TaoMonitorDrawCtx {
14e882e171SHong Zhang   PetscViewer viewer;
15e882e171SHong Zhang   PetscInt    howoften;  /* when > 0 uses iteration % howoften, when negative only final solution plotted */
16e882e171SHong Zhang };
17e882e171SHong Zhang 
18a7e14dcfSSatish Balay /*@
19a7e14dcfSSatish Balay   TaoCreate - Creates a TAO solver
20a7e14dcfSSatish Balay 
21a7e14dcfSSatish Balay   Collective on MPI_Comm
22a7e14dcfSSatish Balay 
23a7e14dcfSSatish Balay   Input Parameter:
24a7e14dcfSSatish Balay . comm - MPI communicator
25a7e14dcfSSatish Balay 
26a7e14dcfSSatish Balay   Output Parameter:
27441846f8SBarry Smith . newtao - the new Tao context
28a7e14dcfSSatish Balay 
29a7e14dcfSSatish Balay   Available methods include:
3058417fe7SBarry Smith +    nls - Newton's method with line search for unconstrained minimization
3158417fe7SBarry Smith .    ntr - Newton's method with trust region for unconstrained minimization
3258417fe7SBarry Smith .    ntl - Newton's method with trust region, line search for unconstrained minimization
3358417fe7SBarry Smith .    lmvm - Limited memory variable metric method for unconstrained minimization
3458417fe7SBarry Smith .    cg - Nonlinear conjugate gradient method for unconstrained minimization
3558417fe7SBarry Smith .    nm - Nelder-Mead algorithm for derivate-free unconstrained minimization
3658417fe7SBarry Smith .    tron - Newton Trust Region method for bound constrained minimization
3758417fe7SBarry Smith .    gpcg - Newton Trust Region method for quadratic bound constrained minimization
3858417fe7SBarry Smith .    blmvm - Limited memory variable metric method for bound constrained minimization
3958417fe7SBarry Smith .    lcl - Linearly constrained Lagrangian method for pde-constrained minimization
4058417fe7SBarry Smith -    pounders - Model-based algorithm for nonlinear least squares
41a7e14dcfSSatish Balay 
42a7e14dcfSSatish Balay    Options Database Keys:
4358417fe7SBarry Smith .   -tao_type - select which method TAO should use
44a7e14dcfSSatish Balay 
45a7e14dcfSSatish Balay    Level: beginner
46a7e14dcfSSatish Balay 
47a7e14dcfSSatish Balay .seealso: TaoSolve(), TaoDestroy()
48a7e14dcfSSatish Balay @*/
49441846f8SBarry Smith PetscErrorCode TaoCreate(MPI_Comm comm, Tao *newtao)
50a7e14dcfSSatish Balay {
51a7e14dcfSSatish Balay   PetscErrorCode ierr;
52441846f8SBarry Smith   Tao            tao;
53a7e14dcfSSatish Balay 
54a7e14dcfSSatish Balay   PetscFunctionBegin;
55a7e14dcfSSatish Balay   PetscValidPointer(newtao,2);
5647a47007SBarry Smith   *newtao = NULL;
57a7e14dcfSSatish Balay 
58a7e14dcfSSatish Balay   ierr = TaoInitializePackage();CHKERRQ(ierr);
59a7e14dcfSSatish Balay   ierr = TaoLineSearchInitializePackage();CHKERRQ(ierr);
60a7e14dcfSSatish Balay 
6173107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(tao,TAO_CLASSID,"Tao","Optimization solver","Tao",comm,TaoDestroy,TaoView);CHKERRQ(ierr);
62a7e14dcfSSatish Balay   tao->ops->computeobjective=0;
63a7e14dcfSSatish Balay   tao->ops->computeobjectiveandgradient=0;
64a7e14dcfSSatish Balay   tao->ops->computegradient=0;
65a7e14dcfSSatish Balay   tao->ops->computehessian=0;
66a7e14dcfSSatish Balay   tao->ops->computeseparableobjective=0;
67a7e14dcfSSatish Balay   tao->ops->computeconstraints=0;
68a7e14dcfSSatish Balay   tao->ops->computejacobian=0;
69a7e14dcfSSatish Balay   tao->ops->computejacobianequality=0;
70a7e14dcfSSatish Balay   tao->ops->computejacobianinequality=0;
71a7e14dcfSSatish Balay   tao->ops->computeequalityconstraints=0;
72a7e14dcfSSatish Balay   tao->ops->computeinequalityconstraints=0;
73a7e14dcfSSatish Balay   tao->ops->convergencetest=TaoDefaultConvergenceTest;
74a7e14dcfSSatish Balay   tao->ops->convergencedestroy=0;
75a7e14dcfSSatish Balay   tao->ops->computedual=0;
76a7e14dcfSSatish Balay   tao->ops->setup=0;
77a7e14dcfSSatish Balay   tao->ops->solve=0;
78a7e14dcfSSatish Balay   tao->ops->view=0;
79a7e14dcfSSatish Balay   tao->ops->setfromoptions=0;
80a7e14dcfSSatish Balay   tao->ops->destroy=0;
81a7e14dcfSSatish Balay 
8247a47007SBarry Smith   tao->solution=NULL;
8347a47007SBarry Smith   tao->gradient=NULL;
8447a47007SBarry Smith   tao->sep_objective = NULL;
8547a47007SBarry Smith   tao->constraints=NULL;
8647a47007SBarry Smith   tao->constraints_equality=NULL;
8747a47007SBarry Smith   tao->constraints_inequality=NULL;
88125ddc8aSJason Sarich   tao->sep_weights_v=NULL;
89125ddc8aSJason Sarich   tao->sep_weights_w=NULL;
9047a47007SBarry Smith   tao->stepdirection=NULL;
918931d482SJason Sarich   tao->niter=0;
928931d482SJason Sarich   tao->ntotalits=0;
9347a47007SBarry Smith   tao->XL = NULL;
9447a47007SBarry Smith   tao->XU = NULL;
9547a47007SBarry Smith   tao->IL = NULL;
9647a47007SBarry Smith   tao->IU = NULL;
9747a47007SBarry Smith   tao->DI = NULL;
9847a47007SBarry Smith   tao->DE = NULL;
99a9603a14SPatrick Farrell   tao->gradient_norm = NULL;
100a9603a14SPatrick Farrell   tao->gradient_norm_tmp = NULL;
10147a47007SBarry Smith   tao->hessian = NULL;
10247a47007SBarry Smith   tao->hessian_pre = NULL;
10347a47007SBarry Smith   tao->jacobian = NULL;
10447a47007SBarry Smith   tao->jacobian_pre = NULL;
10547a47007SBarry Smith   tao->jacobian_state = NULL;
10647a47007SBarry Smith   tao->jacobian_state_pre = NULL;
10747a47007SBarry Smith   tao->jacobian_state_inv = NULL;
10847a47007SBarry Smith   tao->jacobian_design = NULL;
10947a47007SBarry Smith   tao->jacobian_design_pre = NULL;
11047a47007SBarry Smith   tao->jacobian_equality = NULL;
11147a47007SBarry Smith   tao->jacobian_equality_pre = NULL;
11247a47007SBarry Smith   tao->jacobian_inequality = NULL;
11347a47007SBarry Smith   tao->jacobian_inequality_pre = NULL;
11447a47007SBarry Smith   tao->state_is = NULL;
11547a47007SBarry Smith   tao->design_is = NULL;
116a7e14dcfSSatish Balay 
117a7e14dcfSSatish Balay   tao->max_it     = 10000;
118a7e14dcfSSatish Balay   tao->max_funcs   = 10000;
1196f4723b1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
1206f4723b1SBarry Smith   tao->gatol       = 1e-5;
1216f4723b1SBarry Smith   tao->grtol       = 1e-5;
1226f4723b1SBarry Smith #else
123a7e14dcfSSatish Balay   tao->gatol       = 1e-8;
124a7e14dcfSSatish Balay   tao->grtol       = 1e-8;
1256f4723b1SBarry Smith #endif
126a7e14dcfSSatish Balay   tao->crtol       = 0.0;
1276552cf8aSJason Sarich   tao->catol       = 0.0;
1286552cf8aSJason Sarich   tao->gttol       = 0.0;
1294f1535bcSTodd Munson   tao->steptol     = 0.0;
130e270355aSBarry Smith   tao->trust0      = PETSC_INFINITY;
1316f4723b1SBarry Smith   tao->fmin        = PETSC_NINFINITY;
132ae93cb3cSJason Sarich   tao->hist_malloc = PETSC_FALSE;
133a7e14dcfSSatish Balay   tao->hist_reset = PETSC_TRUE;
134a7e14dcfSSatish Balay   tao->hist_max = 0;
135a7e14dcfSSatish Balay   tao->hist_len = 0;
13647a47007SBarry Smith   tao->hist_obj = NULL;
13747a47007SBarry Smith   tao->hist_resid = NULL;
13847a47007SBarry Smith   tao->hist_cnorm = NULL;
139ae93cb3cSJason Sarich   tao->hist_lits = NULL;
140a7e14dcfSSatish Balay 
141a7e14dcfSSatish Balay   tao->numbermonitors=0;
142a7e14dcfSSatish Balay   tao->viewsolution=PETSC_FALSE;
143a7e14dcfSSatish Balay   tao->viewhessian=PETSC_FALSE;
144a7e14dcfSSatish Balay   tao->viewgradient=PETSC_FALSE;
145a7e14dcfSSatish Balay   tao->viewjacobian=PETSC_FALSE;
146a7e14dcfSSatish Balay   tao->viewconstraints = PETSC_FALSE;
147a7e14dcfSSatish Balay 
1486552cf8aSJason Sarich   /* These flags prevents algorithms from overriding user options */
1496552cf8aSJason Sarich   tao->max_it_changed   =PETSC_FALSE;
1506552cf8aSJason Sarich   tao->max_funcs_changed=PETSC_FALSE;
1516552cf8aSJason Sarich   tao->gatol_changed    =PETSC_FALSE;
1526552cf8aSJason Sarich   tao->grtol_changed    =PETSC_FALSE;
1536552cf8aSJason Sarich   tao->gttol_changed    =PETSC_FALSE;
1546552cf8aSJason Sarich   tao->steptol_changed  =PETSC_FALSE;
1556552cf8aSJason Sarich   tao->trust0_changed   =PETSC_FALSE;
1566552cf8aSJason Sarich   tao->fmin_changed     =PETSC_FALSE;
1576552cf8aSJason Sarich   tao->catol_changed    =PETSC_FALSE;
1586552cf8aSJason Sarich   tao->crtol_changed    =PETSC_FALSE;
159a7e14dcfSSatish Balay   ierr = TaoResetStatistics(tao);CHKERRQ(ierr);
160a7e14dcfSSatish Balay   *newtao = tao;
161a7e14dcfSSatish Balay   PetscFunctionReturn(0);
162a7e14dcfSSatish Balay }
163a7e14dcfSSatish Balay 
164a7e14dcfSSatish Balay /*@
165a7e14dcfSSatish Balay   TaoSolve - Solves an optimization problem min F(x) s.t. l <= x <= u
166a7e14dcfSSatish Balay 
167441846f8SBarry Smith   Collective on Tao
168a7e14dcfSSatish Balay 
169a7e14dcfSSatish Balay   Input Parameters:
170441846f8SBarry Smith . tao - the Tao context
171a7e14dcfSSatish Balay 
172a7e14dcfSSatish Balay   Notes:
173441846f8SBarry Smith   The user must set up the Tao with calls to TaoSetInitialVector(),
174a7e14dcfSSatish Balay   TaoSetObjectiveRoutine(),
175a7e14dcfSSatish Balay   TaoSetGradientRoutine(), and (if using 2nd order method) TaoSetHessianRoutine().
176a7e14dcfSSatish Balay 
177a35d58b8SBarry Smith   You should call TaoGetConvergedReason() or run with -tao_converged_reason to determine if the optimization algorithm actually succeeded or
178a35d58b8SBarry Smith   why it failed.
179a35d58b8SBarry Smith 
180a7e14dcfSSatish Balay   Level: beginner
181a7e14dcfSSatish Balay 
182a35d58b8SBarry Smith .seealso: TaoCreate(), TaoSetObjectiveRoutine(), TaoSetGradientRoutine(), TaoSetHessianRoutine(), TaoGetConvergedReason()
183a7e14dcfSSatish Balay  @*/
184441846f8SBarry Smith PetscErrorCode TaoSolve(Tao tao)
185a7e14dcfSSatish Balay {
186a7e14dcfSSatish Balay   PetscErrorCode   ierr;
187e2379f4fSBarry Smith   static PetscBool set = PETSC_FALSE;
18847a47007SBarry Smith 
189a7e14dcfSSatish Balay   PetscFunctionBegin;
190441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
191e2379f4fSBarry Smith   ierr = PetscCitationsRegister("@TechReport{tao-user-ref,\n"
192e2379f4fSBarry Smith                                 "title   = {Toolkit for Advanced Optimization (TAO) Users Manual},\n"
193e2379f4fSBarry Smith                                 "author  = {Todd Munson and Jason Sarich and Stefan Wild and Steve Benson and Lois Curfman McInnes},\n"
194e2379f4fSBarry Smith                                 "Institution = {Argonne National Laboratory},\n"
195e2379f4fSBarry Smith                                 "Year   = 2014,\n"
196e2379f4fSBarry Smith                                 "Number = {ANL/MCS-TM-322 - Revision 3.5},\n"
197302440fdSBarry Smith                                 "url    = {http://www.mcs.anl.gov/tao}\n}\n",&set);CHKERRQ(ierr);
198e2379f4fSBarry Smith 
199a7e14dcfSSatish Balay   ierr = TaoSetUp(tao);CHKERRQ(ierr);
200a7e14dcfSSatish Balay   ierr = TaoResetStatistics(tao);CHKERRQ(ierr);
201a7e14dcfSSatish Balay   if (tao->linesearch) {
202a7e14dcfSSatish Balay     ierr = TaoLineSearchReset(tao->linesearch);CHKERRQ(ierr);
203a7e14dcfSSatish Balay   }
204a7e14dcfSSatish Balay 
205441846f8SBarry Smith   ierr = PetscLogEventBegin(Tao_Solve,tao,0,0,0);CHKERRQ(ierr);
206a7e14dcfSSatish Balay   if (tao->ops->solve){ ierr = (*tao->ops->solve)(tao);CHKERRQ(ierr); }
207441846f8SBarry Smith   ierr = PetscLogEventEnd(Tao_Solve,tao,0,0,0);CHKERRQ(ierr);
208a7e14dcfSSatish Balay 
2098931d482SJason Sarich   tao->ntotalits += tao->niter;
210fbe0838dSJason Sarich   ierr = TaoViewFromOptions(tao,NULL,"-tao_view");CHKERRQ(ierr);
211a7e14dcfSSatish Balay 
212a7e14dcfSSatish Balay   if (tao->printreason) {
213a7e14dcfSSatish Balay     if (tao->reason > 0) {
2148931d482SJason Sarich       ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve converged due to %s iterations %D\n",TaoConvergedReasons[tao->reason],tao->niter);CHKERRQ(ierr);
215a7e14dcfSSatish Balay     } else {
2168931d482SJason Sarich       ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve did not converge due to %s iteration %D\n",TaoConvergedReasons[tao->reason],tao->niter);CHKERRQ(ierr);
217a7e14dcfSSatish Balay     }
218a7e14dcfSSatish Balay   }
219a7e14dcfSSatish Balay   PetscFunctionReturn(0);
220a7e14dcfSSatish Balay }
221a7e14dcfSSatish Balay 
222a7e14dcfSSatish Balay /*@
223a7e14dcfSSatish Balay   TaoSetUp - Sets up the internal data structures for the later use
224a7e14dcfSSatish Balay   of a Tao solver
225a7e14dcfSSatish Balay 
226a7e14dcfSSatish Balay   Collective on tao
227a7e14dcfSSatish Balay 
228a7e14dcfSSatish Balay   Input Parameters:
229a7e14dcfSSatish Balay . tao - the TAO context
230a7e14dcfSSatish Balay 
231a7e14dcfSSatish Balay   Notes:
232a7e14dcfSSatish Balay   The user will not need to explicitly call TaoSetUp(), as it will
233a7e14dcfSSatish Balay   automatically be called in TaoSolve().  However, if the user
234a7e14dcfSSatish Balay   desires to call it explicitly, it should come after TaoCreate()
235a7e14dcfSSatish Balay   and any TaoSetSomething() routines, but before TaoSolve().
236a7e14dcfSSatish Balay 
237a7e14dcfSSatish Balay   Level: advanced
238a7e14dcfSSatish Balay 
239a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
240a7e14dcfSSatish Balay @*/
241441846f8SBarry Smith PetscErrorCode TaoSetUp(Tao tao)
242a7e14dcfSSatish Balay {
243a7e14dcfSSatish Balay   PetscErrorCode ierr;
24447a47007SBarry Smith 
245a7e14dcfSSatish Balay   PetscFunctionBegin;
246441846f8SBarry Smith   PetscValidHeaderSpecific(tao, TAO_CLASSID,1);
247a7e14dcfSSatish Balay   if (tao->setupcalled) PetscFunctionReturn(0);
248a7e14dcfSSatish Balay 
24947a47007SBarry Smith   if (!tao->solution) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TaoSetInitialVector");
250a7e14dcfSSatish Balay   if (tao->ops->setup) {
251a7e14dcfSSatish Balay     ierr = (*tao->ops->setup)(tao);CHKERRQ(ierr);
252a7e14dcfSSatish Balay   }
253a7e14dcfSSatish Balay   tao->setupcalled = PETSC_TRUE;
254a7e14dcfSSatish Balay   PetscFunctionReturn(0);
255a7e14dcfSSatish Balay }
256a7e14dcfSSatish Balay 
257a7e14dcfSSatish Balay /*@
258a7e14dcfSSatish Balay   TaoDestroy - Destroys the TAO context that was created with
259a7e14dcfSSatish Balay   TaoCreate()
260a7e14dcfSSatish Balay 
261441846f8SBarry Smith   Collective on Tao
262a7e14dcfSSatish Balay 
263a7e14dcfSSatish Balay   Input Parameter:
264441846f8SBarry Smith . tao - the Tao context
265a7e14dcfSSatish Balay 
266a7e14dcfSSatish Balay   Level: beginner
267a7e14dcfSSatish Balay 
268a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
269a7e14dcfSSatish Balay @*/
270441846f8SBarry Smith PetscErrorCode TaoDestroy(Tao *tao)
271a7e14dcfSSatish Balay {
272a7e14dcfSSatish Balay   PetscErrorCode ierr;
27347a47007SBarry Smith 
274a7e14dcfSSatish Balay   PetscFunctionBegin;
275a7e14dcfSSatish Balay   if (!*tao) PetscFunctionReturn(0);
276441846f8SBarry Smith   PetscValidHeaderSpecific(*tao,TAO_CLASSID,1);
277a7e14dcfSSatish Balay   if (--((PetscObject)*tao)->refct > 0) {*tao=0;PetscFunctionReturn(0);}
278a7e14dcfSSatish Balay 
279a7e14dcfSSatish Balay   if ((*tao)->ops->destroy) {
280a7e14dcfSSatish Balay     ierr = (*((*tao))->ops->destroy)(*tao);CHKERRQ(ierr);
281a7e14dcfSSatish Balay   }
282a7e14dcfSSatish Balay   ierr = KSPDestroy(&(*tao)->ksp);CHKERRQ(ierr);
283a7e14dcfSSatish Balay   ierr = TaoLineSearchDestroy(&(*tao)->linesearch);CHKERRQ(ierr);
284a7e14dcfSSatish Balay 
285a7e14dcfSSatish Balay   if ((*tao)->ops->convergencedestroy) {
286a7e14dcfSSatish Balay     ierr = (*(*tao)->ops->convergencedestroy)((*tao)->cnvP);CHKERRQ(ierr);
287a7e14dcfSSatish Balay     if ((*tao)->jacobian_state_inv) {
288a7e14dcfSSatish Balay       ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr);
289a7e14dcfSSatish Balay     }
290a7e14dcfSSatish Balay   }
291a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->solution);CHKERRQ(ierr);
292a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->gradient);CHKERRQ(ierr);
293a7e14dcfSSatish Balay 
294a9603a14SPatrick Farrell   if ((*tao)->gradient_norm) {
295a9603a14SPatrick Farrell     ierr = PetscObjectDereference((PetscObject)(*tao)->gradient_norm);CHKERRQ(ierr);
296a9603a14SPatrick Farrell     ierr = VecDestroy(&(*tao)->gradient_norm_tmp);CHKERRQ(ierr);
297a9603a14SPatrick Farrell   }
298a9603a14SPatrick Farrell 
299a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->XL);CHKERRQ(ierr);
300a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->XU);CHKERRQ(ierr);
301a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->IL);CHKERRQ(ierr);
302a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->IU);CHKERRQ(ierr);
303a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->DE);CHKERRQ(ierr);
304a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->DI);CHKERRQ(ierr);
305a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->constraints_equality);CHKERRQ(ierr);
306a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->constraints_inequality);CHKERRQ(ierr);
307a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->stepdirection);CHKERRQ(ierr);
308a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->hessian_pre);CHKERRQ(ierr);
309a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->hessian);CHKERRQ(ierr);
310a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_pre);CHKERRQ(ierr);
311a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian);CHKERRQ(ierr);
312a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state_pre);CHKERRQ(ierr);
313a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state);CHKERRQ(ierr);
314a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr);
315067f330cSJason Sarich   ierr = MatDestroy(&(*tao)->jacobian_design);CHKERRQ(ierr);
316a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_equality);CHKERRQ(ierr);
317a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_equality_pre);CHKERRQ(ierr);
318a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_inequality);CHKERRQ(ierr);
319a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_inequality_pre);CHKERRQ(ierr);
320a7e14dcfSSatish Balay   ierr = ISDestroy(&(*tao)->state_is);CHKERRQ(ierr);
321a7e14dcfSSatish Balay   ierr = ISDestroy(&(*tao)->design_is);CHKERRQ(ierr);
322125ddc8aSJason Sarich   ierr = VecDestroy(&(*tao)->sep_weights_v);CHKERRQ(ierr);
323a7e14dcfSSatish Balay   ierr = TaoCancelMonitors(*tao);CHKERRQ(ierr);
324ae93cb3cSJason Sarich   if ((*tao)->hist_malloc) {
325ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_obj);CHKERRQ(ierr);
326ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_resid);CHKERRQ(ierr);
327ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_cnorm);CHKERRQ(ierr);
328ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_lits);CHKERRQ(ierr);
329ae93cb3cSJason Sarich   }
330125ddc8aSJason Sarich   if ((*tao)->sep_weights_n) {
331125ddc8aSJason Sarich     ierr = PetscFree((*tao)->sep_weights_rows);CHKERRQ(ierr);
332125ddc8aSJason Sarich     ierr = PetscFree((*tao)->sep_weights_cols);CHKERRQ(ierr);
333125ddc8aSJason Sarich     ierr = PetscFree((*tao)->sep_weights_w);CHKERRQ(ierr);
334125ddc8aSJason Sarich   }
335a7e14dcfSSatish Balay   ierr = PetscHeaderDestroy(tao);CHKERRQ(ierr);
336a7e14dcfSSatish Balay   PetscFunctionReturn(0);
337a7e14dcfSSatish Balay }
338a7e14dcfSSatish Balay 
339a7e14dcfSSatish Balay /*@
340441846f8SBarry Smith   TaoSetFromOptions - Sets various Tao parameters from user
341a7e14dcfSSatish Balay   options.
342a7e14dcfSSatish Balay 
343441846f8SBarry Smith   Collective on Tao
344a7e14dcfSSatish Balay 
345a7e14dcfSSatish Balay   Input Paremeter:
346441846f8SBarry Smith . tao - the Tao solver context
347a7e14dcfSSatish Balay 
348a7e14dcfSSatish Balay   options Database Keys:
34958417fe7SBarry Smith + -tao_type <type> - The algorithm that TAO uses (lmvm, nls, etc.)
350a7e14dcfSSatish Balay . -tao_gatol <gatol> - absolute error tolerance for ||gradient||
351a7e14dcfSSatish Balay . -tao_grtol <grtol> - relative error tolerance for ||gradient||
352a7e14dcfSSatish Balay . -tao_gttol <gttol> - reduction of ||gradient|| relative to initial gradient
353a7e14dcfSSatish Balay . -tao_max_it <max> - sets maximum number of iterations
354a7e14dcfSSatish Balay . -tao_max_funcs <max> - sets maximum number of function evaluations
355a7e14dcfSSatish Balay . -tao_fmin <fmin> - stop if function value reaches fmin
356a7e14dcfSSatish Balay . -tao_steptol <tol> - stop if trust region radius less than <tol>
357a7e14dcfSSatish Balay . -tao_trust0 <t> - initial trust region radius
358a7e14dcfSSatish Balay . -tao_monitor - prints function value and residual at each iteration
359a7e14dcfSSatish Balay . -tao_smonitor - same as tao_monitor, but truncates very small values
360a7e14dcfSSatish Balay . -tao_cmonitor - prints function value, residual, and constraint norm at each iteration
361a7e14dcfSSatish Balay . -tao_view_solution - prints solution vector at each iteration
362a7e14dcfSSatish Balay . -tao_view_separableobjective - prints separable objective vector at each iteration
363a7e14dcfSSatish Balay . -tao_view_step - prints step direction vector at each iteration
364a7e14dcfSSatish Balay . -tao_view_gradient - prints gradient vector at each iteration
365a7e14dcfSSatish Balay . -tao_draw_solution - graphically view solution vector at each iteration
366a7e14dcfSSatish Balay . -tao_draw_step - graphically view step vector at each iteration
367a7e14dcfSSatish Balay . -tao_draw_gradient - graphically view gradient at each iteration
368a7e14dcfSSatish Balay . -tao_fd_gradient - use gradient computed with finite differences
369f4c1ad5cSStefano Zampini . -tao_fd_hessian - use hessian computed with finite differences
370f4c1ad5cSStefano Zampini . -tao_mf_hessian - use matrix-free hessian computed with finite differences
371a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors (except those set with command line)
372441846f8SBarry Smith . -tao_view - prints information about the Tao after solving
373a7e14dcfSSatish Balay - -tao_converged_reason - prints the reason TAO stopped iterating
374a7e14dcfSSatish Balay 
375a7e14dcfSSatish Balay   Notes:
376a7e14dcfSSatish Balay   To see all options, run your program with the -help option or consult the
377a7e14dcfSSatish Balay   user's manual. Should be called after TaoCreate() but before TaoSolve()
378a7e14dcfSSatish Balay 
379a7e14dcfSSatish Balay   Level: beginner
380a7e14dcfSSatish Balay @*/
381441846f8SBarry Smith PetscErrorCode TaoSetFromOptions(Tao tao)
382a7e14dcfSSatish Balay {
383a7e14dcfSSatish Balay   PetscErrorCode ierr;
38458417fe7SBarry Smith   const TaoType  default_type = TAOLMVM;
385a7e14dcfSSatish Balay   char           type[256], monfilename[PETSC_MAX_PATH_LEN];
386a7e14dcfSSatish Balay   PetscViewer    monviewer;
387a7e14dcfSSatish Balay   PetscBool      flg;
388a7e14dcfSSatish Balay   MPI_Comm       comm;
389a7e14dcfSSatish Balay 
390a7e14dcfSSatish Balay   PetscFunctionBegin;
391441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
392a7e14dcfSSatish Balay   ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
393125ddc8aSJason Sarich 
394a7e14dcfSSatish Balay   /* So no warnings are given about unused options */
395c5929fdfSBarry Smith   ierr = PetscOptionsHasName(((PetscObject)tao)->options,((PetscObject)tao)->prefix,"-tao_ls_type",&flg);CHKERRQ(ierr);
396a7e14dcfSSatish Balay 
397a7e14dcfSSatish Balay   ierr = PetscObjectOptionsBegin((PetscObject)tao);CHKERRQ(ierr);
398a7e14dcfSSatish Balay   {
399441846f8SBarry Smith     ierr = TaoRegisterAll();CHKERRQ(ierr);
400a7e14dcfSSatish Balay     if (((PetscObject)tao)->type_name) {
401a7e14dcfSSatish Balay       default_type = ((PetscObject)tao)->type_name;
402a7e14dcfSSatish Balay     }
403a7e14dcfSSatish Balay     /* Check for type from options */
404441846f8SBarry Smith     ierr = PetscOptionsFList("-tao_type","Tao Solver type","TaoSetType",TaoList,default_type,type,256,&flg);CHKERRQ(ierr);
405a7e14dcfSSatish Balay     if (flg) {
406a7e14dcfSSatish Balay       ierr = TaoSetType(tao,type);CHKERRQ(ierr);
407a7e14dcfSSatish Balay     } else if (!((PetscObject)tao)->type_name) {
408302440fdSBarry Smith       ierr = TaoSetType(tao,default_type);CHKERRQ(ierr);
409a7e14dcfSSatish Balay     }
410a7e14dcfSSatish Balay 
4116552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_catol","Stop if constraints violations within","TaoSetConstraintTolerances",tao->catol,&tao->catol,&flg);CHKERRQ(ierr);
4126552cf8aSJason Sarich     if (flg) tao->catol_changed=PETSC_TRUE;
4136552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_crtol","Stop if relative contraint violations within","TaoSetConstraintTolerances",tao->crtol,&tao->crtol,&flg);CHKERRQ(ierr);
4146552cf8aSJason Sarich     if (flg) tao->crtol_changed=PETSC_TRUE;
4156552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_gatol","Stop if norm of gradient less than","TaoSetTolerances",tao->gatol,&tao->gatol,&flg);CHKERRQ(ierr);
4166552cf8aSJason Sarich     if (flg) tao->gatol_changed=PETSC_TRUE;
4176552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_grtol","Stop if norm of gradient divided by the function value is less than","TaoSetTolerances",tao->grtol,&tao->grtol,&flg);CHKERRQ(ierr);
4186552cf8aSJason Sarich     if (flg) tao->grtol_changed=PETSC_TRUE;
4196552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_gttol","Stop if the norm of the gradient is less than the norm of the initial gradient times tol","TaoSetTolerances",tao->gttol,&tao->gttol,&flg);CHKERRQ(ierr);
4206552cf8aSJason Sarich     if (flg) tao->gttol_changed=PETSC_TRUE;
4216552cf8aSJason Sarich     ierr = PetscOptionsInt("-tao_max_it","Stop if iteration number exceeds","TaoSetMaximumIterations",tao->max_it,&tao->max_it,&flg);CHKERRQ(ierr);
4226552cf8aSJason Sarich     if (flg) tao->max_it_changed=PETSC_TRUE;
4236552cf8aSJason Sarich     ierr = PetscOptionsInt("-tao_max_funcs","Stop if number of function evaluations exceeds","TaoSetMaximumFunctionEvaluations",tao->max_funcs,&tao->max_funcs,&flg);CHKERRQ(ierr);
4246552cf8aSJason Sarich     if (flg) tao->max_funcs_changed=PETSC_TRUE;
4256552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_fmin","Stop if function less than","TaoSetFunctionLowerBound",tao->fmin,&tao->fmin,&flg);CHKERRQ(ierr);
4266552cf8aSJason Sarich     if (flg) tao->fmin_changed=PETSC_TRUE;
4276552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_steptol","Stop if step size or trust region radius less than","",tao->steptol,&tao->steptol,&flg);CHKERRQ(ierr);
4286552cf8aSJason Sarich     if (flg) tao->steptol_changed=PETSC_TRUE;
4296552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_trust0","Initial trust region radius","TaoSetTrustRegionRadius",tao->trust0,&tao->trust0,&flg);CHKERRQ(ierr);
4306552cf8aSJason Sarich     if (flg) tao->trust0_changed=PETSC_TRUE;
431a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_solution","view solution vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
432a7e14dcfSSatish Balay     if (flg) {
433a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
434a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoSolutionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
435a7e14dcfSSatish Balay     }
436a7e14dcfSSatish Balay 
4378afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_converged_reason","Print reason for TAO converged","TaoSolve",tao->printreason,&tao->printreason,NULL);CHKERRQ(ierr);
438a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_gradient","view gradient vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
439a7e14dcfSSatish Balay     if (flg) {
440a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
441a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoGradientMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
442a7e14dcfSSatish Balay     }
443a7e14dcfSSatish Balay 
444a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_stepdirection","view step direction vector after each iteration","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
445a7e14dcfSSatish Balay     if (flg) {
446a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
447a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoStepDirectionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
448a7e14dcfSSatish Balay     }
449a7e14dcfSSatish Balay 
450a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_separableobjective","view separable objective vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
451a7e14dcfSSatish Balay     if (flg) {
452a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
453a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoSeparableObjectiveMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
454a7e14dcfSSatish Balay     }
455a7e14dcfSSatish Balay 
456a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_monitor","Use the default convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
457a7e14dcfSSatish Balay     if (flg) {
458a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
459a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
460a7e14dcfSSatish Balay     }
461a7e14dcfSSatish Balay 
462a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_smonitor","Use the short convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
463a7e14dcfSSatish Balay     if (flg) {
464a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
465a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultSMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
466a7e14dcfSSatish Balay     }
467a7e14dcfSSatish Balay 
468a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_cmonitor","Use the default convergence monitor with constraint norm","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
469a7e14dcfSSatish Balay     if (flg) {
470a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
471a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultCMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
472a7e14dcfSSatish Balay     }
473a7e14dcfSSatish Balay 
474a7e14dcfSSatish Balay 
4758afaa268SBarry Smith     flg = PETSC_FALSE;
4768afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_cancelmonitors","cancel all monitors and call any registered destroy routines","TaoCancelMonitors",flg,&flg,NULL);CHKERRQ(ierr);
477a7e14dcfSSatish Balay     if (flg) {ierr = TaoCancelMonitors(tao);CHKERRQ(ierr);}
478a7e14dcfSSatish Balay 
4798afaa268SBarry Smith     flg = PETSC_FALSE;
4808afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_draw_solution","Plot solution vector at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr);
481a7e14dcfSSatish Balay     if (flg) {
482e882e171SHong Zhang       TaoMonitorDrawCtx drawctx;
483e882e171SHong Zhang       PetscInt          howoften = 1;
484e882e171SHong Zhang       ierr = TaoMonitorDrawCtxCreate(PetscObjectComm((PetscObject)tao),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&drawctx);CHKERRQ(ierr);
485e882e171SHong Zhang       ierr = TaoSetMonitor(tao,TaoDrawSolutionMonitor,drawctx,(PetscErrorCode (*)(void**))TaoMonitorDrawCtxDestroy);CHKERRQ(ierr);
486a7e14dcfSSatish Balay     }
487a7e14dcfSSatish Balay 
4888afaa268SBarry Smith     flg = PETSC_FALSE;
4898afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_draw_step","plots step direction at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr);
490a7e14dcfSSatish Balay     if (flg) {
49147a47007SBarry Smith       ierr = TaoSetMonitor(tao,TaoDrawStepMonitor,NULL,NULL);CHKERRQ(ierr);
492a7e14dcfSSatish Balay     }
493a7e14dcfSSatish Balay 
4948afaa268SBarry Smith     flg = PETSC_FALSE;
4958afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_draw_gradient","plots gradient at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr);
496a7e14dcfSSatish Balay     if (flg) {
497e882e171SHong Zhang       TaoMonitorDrawCtx drawctx;
498e882e171SHong Zhang       PetscInt          howoften = 1;
499e882e171SHong Zhang       ierr = TaoMonitorDrawCtxCreate(PetscObjectComm((PetscObject)tao),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&drawctx);CHKERRQ(ierr);
500e882e171SHong Zhang       ierr = TaoSetMonitor(tao,TaoDrawGradientMonitor,drawctx,(PetscErrorCode (*)(void**))TaoMonitorDrawCtxDestroy);CHKERRQ(ierr);
501a7e14dcfSSatish Balay     }
5028afaa268SBarry Smith     flg = PETSC_FALSE;
5038afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_fd_gradient","compute gradient using finite differences","TaoDefaultComputeGradient",flg,&flg,NULL);CHKERRQ(ierr);
504a7e14dcfSSatish Balay     if (flg) {
50547a47007SBarry Smith       ierr = TaoSetGradientRoutine(tao,TaoDefaultComputeGradient,NULL);CHKERRQ(ierr);
506a7e14dcfSSatish Balay     }
507f4c1ad5cSStefano Zampini     flg = PETSC_FALSE;
508f4c1ad5cSStefano Zampini     ierr = PetscOptionsBool("-tao_fd_hessian","compute hessian using finite differences","TaoDefaultComputeHessian",flg,&flg,NULL);CHKERRQ(ierr);
509f4c1ad5cSStefano Zampini     if (flg) {
510f4c1ad5cSStefano Zampini       Mat H;
511f4c1ad5cSStefano Zampini 
512f4c1ad5cSStefano Zampini       ierr = MatCreate(PetscObjectComm((PetscObject)tao),&H);CHKERRQ(ierr);
513f4c1ad5cSStefano Zampini       ierr = MatSetType(H,MATAIJ);CHKERRQ(ierr);
514f4c1ad5cSStefano Zampini       ierr = TaoSetHessianRoutine(tao,H,H,TaoDefaultComputeHessian,NULL);CHKERRQ(ierr);
515f4c1ad5cSStefano Zampini       ierr = MatDestroy(&H);CHKERRQ(ierr);
516f4c1ad5cSStefano Zampini     }
517f4c1ad5cSStefano Zampini     flg = PETSC_FALSE;
518f4c1ad5cSStefano Zampini     ierr = PetscOptionsBool("-tao_mf_hessian","compute matrix-free hessian using finite differences","TaoDefaultComputeHessianMFFD",flg,&flg,NULL);CHKERRQ(ierr);
519f4c1ad5cSStefano Zampini     if (flg) {
520f4c1ad5cSStefano Zampini       Mat H;
521f4c1ad5cSStefano Zampini 
522f4c1ad5cSStefano Zampini       ierr = MatCreate(PetscObjectComm((PetscObject)tao),&H);CHKERRQ(ierr);
523f4c1ad5cSStefano Zampini       ierr = TaoSetHessianRoutine(tao,H,H,TaoDefaultComputeHessianMFFD,NULL);CHKERRQ(ierr);
524f4c1ad5cSStefano Zampini       ierr = MatDestroy(&H);CHKERRQ(ierr);
525f4c1ad5cSStefano Zampini     }
526f4c1ad5cSStefano Zampini     ierr = PetscOptionsEnum("-tao_subset_type","subset type","",TaoSubSetTypes,(PetscEnum)tao->subset_type,(PetscEnum*)&tao->subset_type,NULL);CHKERRQ(ierr);
527a7e14dcfSSatish Balay 
528a7e14dcfSSatish Balay     if (tao->ops->setfromoptions) {
5291a1499c8SBarry Smith       ierr = (*tao->ops->setfromoptions)(PetscOptionsObject,tao);CHKERRQ(ierr);
530a7e14dcfSSatish Balay     }
531a7e14dcfSSatish Balay   }
532a7e14dcfSSatish Balay   ierr = PetscOptionsEnd();CHKERRQ(ierr);
533a7e14dcfSSatish Balay   PetscFunctionReturn(0);
534a7e14dcfSSatish Balay }
535a7e14dcfSSatish Balay 
536a7e14dcfSSatish Balay /*@C
537441846f8SBarry Smith   TaoView - Prints information about the Tao
538a7e14dcfSSatish Balay 
539441846f8SBarry Smith   Collective on Tao
540a7e14dcfSSatish Balay 
541a7e14dcfSSatish Balay   InputParameters:
542441846f8SBarry Smith + tao - the Tao context
543a7e14dcfSSatish Balay - viewer - visualization context
544a7e14dcfSSatish Balay 
545a7e14dcfSSatish Balay   Options Database Key:
546a7e14dcfSSatish Balay . -tao_view - Calls TaoView() at the end of TaoSolve()
547a7e14dcfSSatish Balay 
548a7e14dcfSSatish Balay   Notes:
549a7e14dcfSSatish Balay   The available visualization contexts include
550a7e14dcfSSatish Balay +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
551a7e14dcfSSatish Balay -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
552a7e14dcfSSatish Balay          output where only the first processor opens
553a7e14dcfSSatish Balay          the file.  All other processors send their
554a7e14dcfSSatish Balay          data to the first processor to print.
555a7e14dcfSSatish Balay 
556a7e14dcfSSatish Balay   Level: beginner
557a7e14dcfSSatish Balay 
558a7e14dcfSSatish Balay .seealso: PetscViewerASCIIOpen()
559a7e14dcfSSatish Balay @*/
560441846f8SBarry Smith PetscErrorCode TaoView(Tao tao, PetscViewer viewer)
561a7e14dcfSSatish Balay {
562a7e14dcfSSatish Balay   PetscErrorCode      ierr;
563a7e14dcfSSatish Balay   PetscBool           isascii,isstring;
564441846f8SBarry Smith   const TaoType type;
56547a47007SBarry Smith 
566a7e14dcfSSatish Balay   PetscFunctionBegin;
567441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
568a7e14dcfSSatish Balay   if (!viewer) {
569a7e14dcfSSatish Balay     ierr = PetscViewerASCIIGetStdout(((PetscObject)tao)->comm,&viewer);CHKERRQ(ierr);
570a7e14dcfSSatish Balay   }
571a7e14dcfSSatish Balay   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
572a7e14dcfSSatish Balay   PetscCheckSameComm(tao,1,viewer,2);
573a7e14dcfSSatish Balay 
574a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
575a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
576a7e14dcfSSatish Balay   if (isascii) {
577a7e14dcfSSatish Balay     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)tao,viewer);CHKERRQ(ierr);
578a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
579a7e14dcfSSatish Balay 
580a7e14dcfSSatish Balay     if (tao->ops->view) {
581a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
582a7e14dcfSSatish Balay       ierr = (*tao->ops->view)(tao,viewer);CHKERRQ(ierr);
583a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
584a7e14dcfSSatish Balay     }
585a7e14dcfSSatish Balay     if (tao->linesearch) {
586a7e14dcfSSatish Balay       ierr = PetscObjectPrintClassNamePrefixType((PetscObject)(tao->linesearch),viewer);CHKERRQ(ierr);
587a7e14dcfSSatish Balay     }
588a7e14dcfSSatish Balay     if (tao->ksp) {
589a7e14dcfSSatish Balay       ierr = PetscObjectPrintClassNamePrefixType((PetscObject)(tao->ksp),viewer);CHKERRQ(ierr);
590ae93cb3cSJason Sarich       ierr = PetscViewerASCIIPrintf(viewer,"total KSP iterations: %D\n",tao->ksp_tot_its);CHKERRQ(ierr);
591a7e14dcfSSatish Balay     }
592a7e14dcfSSatish Balay     if (tao->XL || tao->XU) {
593302440fdSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Active Set subset type: %s\n",TaoSubSetTypes[tao->subset_type]);CHKERRQ(ierr);
594a7e14dcfSSatish Balay     }
595a7e14dcfSSatish Balay 
59647a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: gatol=%g,",(double)tao->gatol);CHKERRQ(ierr);
59747a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," steptol=%g,",(double)tao->steptol);CHKERRQ(ierr);
59847a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," gttol=%g\n",(double)tao->gttol);CHKERRQ(ierr);
599a7e14dcfSSatish Balay 
60047a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Residual in Function/Gradient:=%g\n",(double)tao->residual);CHKERRQ(ierr);
601a7e14dcfSSatish Balay 
602a7e14dcfSSatish Balay     if (tao->cnorm>0 || tao->catol>0 || tao->crtol>0){
603a7e14dcfSSatish Balay       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances:");CHKERRQ(ierr);
60447a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer," catol=%g,",(double)tao->catol);CHKERRQ(ierr);
60547a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer," crtol=%g\n",(double)tao->crtol);CHKERRQ(ierr);
60647a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Residual in Constraints:=%g\n",(double)tao->cnorm);CHKERRQ(ierr);
607a7e14dcfSSatish Balay     }
608a7e14dcfSSatish Balay 
609a7e14dcfSSatish Balay     if (tao->trust < tao->steptol){
61047a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: steptol=%g\n",(double)tao->steptol);CHKERRQ(ierr);
61147a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"Final trust region radius:=%g\n",(double)tao->trust);CHKERRQ(ierr);
612a7e14dcfSSatish Balay     }
613a7e14dcfSSatish Balay 
614a7e14dcfSSatish Balay     if (tao->fmin>-1.e25){
61547a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: function minimum=%g\n",(double)tao->fmin);CHKERRQ(ierr);
616a7e14dcfSSatish Balay     }
61747a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Objective value=%g\n",(double)tao->fc);CHKERRQ(ierr);
618a7e14dcfSSatish Balay 
61947a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"total number of iterations=%D,          ",tao->niter);CHKERRQ(ierr);
620a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPrintf(viewer,"              (max: %D)\n",tao->max_it);CHKERRQ(ierr);
621a7e14dcfSSatish Balay 
622a7e14dcfSSatish Balay     if (tao->nfuncs>0){
62347a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of function evaluations=%D,",tao->nfuncs);CHKERRQ(ierr);
62447a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"                max: %D\n",tao->max_funcs);CHKERRQ(ierr);
625a7e14dcfSSatish Balay     }
626a7e14dcfSSatish Balay     if (tao->ngrads>0){
62747a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of gradient evaluations=%D,",tao->ngrads);CHKERRQ(ierr);
62847a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"                max: %D\n",tao->max_funcs);CHKERRQ(ierr);
629a7e14dcfSSatish Balay     }
630a7e14dcfSSatish Balay     if (tao->nfuncgrads>0){
63147a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of function/gradient evaluations=%D,",tao->nfuncgrads);CHKERRQ(ierr);
63247a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    (max: %D)\n",tao->max_funcs);CHKERRQ(ierr);
633a7e14dcfSSatish Balay     }
634a7e14dcfSSatish Balay     if (tao->nhess>0){
63547a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of Hessian evaluations=%D\n",tao->nhess);CHKERRQ(ierr);
636a7e14dcfSSatish Balay     }
637a7e14dcfSSatish Balay     /*  if (tao->linear_its>0){
63847a47007SBarry Smith      ierr = PetscViewerASCIIPrintf(viewer,"  total Krylov method iterations=%D\n",tao->linear_its);CHKERRQ(ierr);
639a7e14dcfSSatish Balay      }*/
640a7e14dcfSSatish Balay     if (tao->nconstraints>0){
64147a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of constraint function evaluations=%D\n",tao->nconstraints);CHKERRQ(ierr);
642a7e14dcfSSatish Balay     }
643a7e14dcfSSatish Balay     if (tao->njac>0){
64447a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of Jacobian evaluations=%D\n",tao->njac);CHKERRQ(ierr);
645a7e14dcfSSatish Balay     }
646a7e14dcfSSatish Balay 
647a7e14dcfSSatish Balay     if (tao->reason>0){
648a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer,    "Solution converged: ");CHKERRQ(ierr);
649a7e14dcfSSatish Balay       switch (tao->reason) {
650a7e14dcfSSatish Balay       case TAO_CONVERGED_GATOL:
651a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)|| <= gatol\n");CHKERRQ(ierr);
652a7e14dcfSSatish Balay         break;
653a7e14dcfSSatish Balay       case TAO_CONVERGED_GRTOL:
654a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/|f(X)| <= grtol\n");CHKERRQ(ierr);
655a7e14dcfSSatish Balay         break;
656a7e14dcfSSatish Balay       case TAO_CONVERGED_GTTOL:
657a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/||g(X0)|| <= gttol\n");CHKERRQ(ierr);
658a7e14dcfSSatish Balay         break;
659a7e14dcfSSatish Balay       case TAO_CONVERGED_STEPTOL:
660a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," Steptol -- step size small\n");CHKERRQ(ierr);
661a7e14dcfSSatish Balay         break;
662a7e14dcfSSatish Balay       case TAO_CONVERGED_MINF:
663a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," Minf --  f < fmin\n");CHKERRQ(ierr);
664a7e14dcfSSatish Balay         break;
665a7e14dcfSSatish Balay       case TAO_CONVERGED_USER:
666a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr);
667a7e14dcfSSatish Balay         break;
668a7e14dcfSSatish Balay       default:
669a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
670a7e14dcfSSatish Balay         break;
671a7e14dcfSSatish Balay       }
672a7e14dcfSSatish Balay 
673a7e14dcfSSatish Balay     } else {
67447cfc4faSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Solver terminated: %d",tao->reason);CHKERRQ(ierr);
675a7e14dcfSSatish Balay       switch (tao->reason) {
676a7e14dcfSSatish Balay       case TAO_DIVERGED_MAXITS:
67747a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Maximum Iterations\n");CHKERRQ(ierr);
678a7e14dcfSSatish Balay         break;
679a7e14dcfSSatish Balay       case TAO_DIVERGED_NAN:
68047a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," NAN or Inf encountered\n");CHKERRQ(ierr);
681a7e14dcfSSatish Balay         break;
682a7e14dcfSSatish Balay       case TAO_DIVERGED_MAXFCN:
68347a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Maximum Function Evaluations\n");CHKERRQ(ierr);
684a7e14dcfSSatish Balay         break;
685a7e14dcfSSatish Balay       case TAO_DIVERGED_LS_FAILURE:
68647a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Line Search Failure\n");CHKERRQ(ierr);
687a7e14dcfSSatish Balay         break;
688a7e14dcfSSatish Balay       case TAO_DIVERGED_TR_REDUCTION:
68947a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Trust Region too small\n");CHKERRQ(ierr);
690a7e14dcfSSatish Balay         break;
691a7e14dcfSSatish Balay       case TAO_DIVERGED_USER:
69247a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr);
693a7e14dcfSSatish Balay         break;
694a7e14dcfSSatish Balay       default:
695a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
696a7e14dcfSSatish Balay         break;
697a7e14dcfSSatish Balay       }
698a7e14dcfSSatish Balay     }
699a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
700a7e14dcfSSatish Balay   } else if (isstring) {
701a7e14dcfSSatish Balay     ierr = TaoGetType(tao,&type);CHKERRQ(ierr);
702a7e14dcfSSatish Balay     ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr);
703a7e14dcfSSatish Balay   }
704a7e14dcfSSatish Balay   PetscFunctionReturn(0);
705a7e14dcfSSatish Balay }
706a7e14dcfSSatish Balay 
707a7e14dcfSSatish Balay /*@
708a7e14dcfSSatish Balay   TaoSetTolerances - Sets parameters used in TAO convergence tests
709a7e14dcfSSatish Balay 
710441846f8SBarry Smith   Logically collective on Tao
711a7e14dcfSSatish Balay 
712a7e14dcfSSatish Balay   Input Parameters:
713441846f8SBarry Smith + tao - the Tao context
714a7e14dcfSSatish Balay . gatol - stop if norm of gradient is less than this
715a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this
716a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by this factor
717a7e14dcfSSatish Balay 
718a7e14dcfSSatish Balay   Options Database Keys:
719e52336cbSBarry Smith + -tao_gatol <gatol> - Sets gatol
720a7e14dcfSSatish Balay . -tao_grtol <grtol> - Sets grtol
721a7e14dcfSSatish Balay - -tao_gttol <gttol> - Sets gttol
722a7e14dcfSSatish Balay 
723a7e14dcfSSatish Balay   Stopping Criteria:
724a7e14dcfSSatish Balay $ ||g(X)||                            <= gatol
725a7e14dcfSSatish Balay $ ||g(X)|| / |f(X)|                   <= grtol
726a7e14dcfSSatish Balay $ ||g(X)|| / ||g(X0)||                <= gttol
727a7e14dcfSSatish Balay 
728a7e14dcfSSatish Balay   Notes:
729a7e14dcfSSatish Balay   Use PETSC_DEFAULT to leave one or more tolerances unchanged.
730a7e14dcfSSatish Balay 
731a7e14dcfSSatish Balay   Level: beginner
732a7e14dcfSSatish Balay 
733a7e14dcfSSatish Balay .seealso: TaoGetTolerances()
734a7e14dcfSSatish Balay 
735a7e14dcfSSatish Balay @*/
736e52336cbSBarry Smith PetscErrorCode TaoSetTolerances(Tao tao, PetscReal gatol, PetscReal grtol, PetscReal gttol)
737a7e14dcfSSatish Balay {
738a7e14dcfSSatish Balay   PetscErrorCode ierr;
73947a47007SBarry Smith 
740a7e14dcfSSatish Balay   PetscFunctionBegin;
741441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
742a7e14dcfSSatish Balay 
743a7e14dcfSSatish Balay   if (gatol != PETSC_DEFAULT) {
744a7e14dcfSSatish Balay     if (gatol<0) {
745955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative gatol -- ignored.\n");CHKERRQ(ierr);
746a7e14dcfSSatish Balay     } else {
747a7e14dcfSSatish Balay       tao->gatol = PetscMax(0,gatol);
7486552cf8aSJason Sarich       tao->gatol_changed=PETSC_TRUE;
749a7e14dcfSSatish Balay     }
750a7e14dcfSSatish Balay   }
751a7e14dcfSSatish Balay 
752a7e14dcfSSatish Balay   if (grtol != PETSC_DEFAULT) {
753a7e14dcfSSatish Balay     if (grtol<0) {
754955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative grtol -- ignored.\n");CHKERRQ(ierr);
755a7e14dcfSSatish Balay     } else {
756a7e14dcfSSatish Balay       tao->grtol = PetscMax(0,grtol);
7576552cf8aSJason Sarich       tao->grtol_changed=PETSC_TRUE;
758a7e14dcfSSatish Balay     }
759a7e14dcfSSatish Balay   }
760a7e14dcfSSatish Balay 
761a7e14dcfSSatish Balay   if (gttol != PETSC_DEFAULT) {
762a7e14dcfSSatish Balay     if (gttol<0) {
763955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative gttol -- ignored.\n");CHKERRQ(ierr);
764a7e14dcfSSatish Balay     } else {
765a7e14dcfSSatish Balay       tao->gttol = PetscMax(0,gttol);
7666552cf8aSJason Sarich       tao->gttol_changed=PETSC_TRUE;
767a7e14dcfSSatish Balay     }
768a7e14dcfSSatish Balay   }
769a7e14dcfSSatish Balay   PetscFunctionReturn(0);
770a7e14dcfSSatish Balay }
771a7e14dcfSSatish Balay 
772a7e14dcfSSatish Balay /*@
77358417fe7SBarry Smith   TaoSetConstraintTolerances - Sets constraint tolerance parameters used in TAO  convergence tests
774a7e14dcfSSatish Balay 
775441846f8SBarry Smith   Logically collective on Tao
776a7e14dcfSSatish Balay 
777a7e14dcfSSatish Balay   Input Parameters:
778441846f8SBarry Smith + tao - the Tao context
779e52336cbSBarry Smith . catol - absolute constraint tolerance, constraint norm must be less than catol for used for gatol convergence criteria
780e52336cbSBarry Smith - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for gatol, gttol convergence criteria
781a7e14dcfSSatish Balay 
782a7e14dcfSSatish Balay   Options Database Keys:
783a7e14dcfSSatish Balay + -tao_catol <catol> - Sets catol
784a7e14dcfSSatish Balay - -tao_crtol <crtol> - Sets crtol
785a7e14dcfSSatish Balay 
7866552cf8aSJason Sarich   Notes:
7876552cf8aSJason Sarich   Use PETSC_DEFAULT to leave any tolerance unchanged.
7886552cf8aSJason Sarich 
789a7e14dcfSSatish Balay   Level: intermediate
790a7e14dcfSSatish Balay 
79158417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoGetConstraintTolerances(), TaoSetTolerances()
792a7e14dcfSSatish Balay 
793a7e14dcfSSatish Balay @*/
794441846f8SBarry Smith PetscErrorCode TaoSetConstraintTolerances(Tao tao, PetscReal catol, PetscReal crtol)
795a7e14dcfSSatish Balay {
796a7e14dcfSSatish Balay   PetscErrorCode ierr;
79747a47007SBarry Smith 
798a7e14dcfSSatish Balay   PetscFunctionBegin;
799441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
800a7e14dcfSSatish Balay 
801a7e14dcfSSatish Balay   if (catol != PETSC_DEFAULT) {
802a7e14dcfSSatish Balay     if (catol<0) {
803955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative catol -- ignored.\n");CHKERRQ(ierr);
804a7e14dcfSSatish Balay     } else {
805a7e14dcfSSatish Balay       tao->catol = PetscMax(0,catol);
8066552cf8aSJason Sarich       tao->catol_changed=PETSC_TRUE;
807a7e14dcfSSatish Balay     }
808a7e14dcfSSatish Balay   }
809a7e14dcfSSatish Balay 
810a7e14dcfSSatish Balay   if (crtol != PETSC_DEFAULT) {
811a7e14dcfSSatish Balay     if (crtol<0) {
812955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative crtol -- ignored.\n");CHKERRQ(ierr);
813a7e14dcfSSatish Balay     } else {
814a7e14dcfSSatish Balay       tao->crtol = PetscMax(0,crtol);
8156552cf8aSJason Sarich       tao->crtol_changed=PETSC_TRUE;
816a7e14dcfSSatish Balay     }
817a7e14dcfSSatish Balay   }
818a7e14dcfSSatish Balay   PetscFunctionReturn(0);
819a7e14dcfSSatish Balay }
820a7e14dcfSSatish Balay 
82158417fe7SBarry Smith /*@
82258417fe7SBarry Smith   TaoGetConstraintTolerances - Gets constraint tolerance parameters used in TAO  convergence tests
82358417fe7SBarry Smith 
82458417fe7SBarry Smith   Not ollective
82558417fe7SBarry Smith 
82658417fe7SBarry Smith   Input Parameter:
82758417fe7SBarry Smith . tao - the Tao context
82858417fe7SBarry Smith 
82958417fe7SBarry Smith   Output Parameter:
830e52336cbSBarry Smith + catol - absolute constraint tolerance, constraint norm must be less than catol for used for gatol convergence criteria
831e52336cbSBarry Smith - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for gatol, gttol convergence criteria
83258417fe7SBarry Smith 
83358417fe7SBarry Smith   Level: intermediate
83458417fe7SBarry Smith 
83558417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoSetTolerances(), TaoSetConstraintTolerances()
83658417fe7SBarry Smith 
83758417fe7SBarry Smith @*/
83858417fe7SBarry Smith PetscErrorCode TaoGetConstraintTolerances(Tao tao, PetscReal *catol, PetscReal *crtol)
83958417fe7SBarry Smith {
84058417fe7SBarry Smith   PetscFunctionBegin;
84158417fe7SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
84258417fe7SBarry Smith   if (catol) *catol = tao->catol;
84358417fe7SBarry Smith   if (crtol) *crtol = tao->crtol;
84458417fe7SBarry Smith   PetscFunctionReturn(0);
84558417fe7SBarry Smith }
84658417fe7SBarry Smith 
847a7e14dcfSSatish Balay /*@
848a7e14dcfSSatish Balay    TaoSetFunctionLowerBound - Sets a bound on the solution objective value.
849a7e14dcfSSatish Balay    When an approximate solution with an objective value below this number
850a7e14dcfSSatish Balay    has been found, the solver will terminate.
851a7e14dcfSSatish Balay 
852441846f8SBarry Smith    Logically Collective on Tao
853a7e14dcfSSatish Balay 
854a7e14dcfSSatish Balay    Input Parameters:
855441846f8SBarry Smith +  tao - the Tao solver context
856a7e14dcfSSatish Balay -  fmin - the tolerance
857a7e14dcfSSatish Balay 
858a7e14dcfSSatish Balay    Options Database Keys:
859a7e14dcfSSatish Balay .    -tao_fmin <fmin> - sets the minimum function value
860a7e14dcfSSatish Balay 
861a7e14dcfSSatish Balay    Level: intermediate
862a7e14dcfSSatish Balay 
863a7e14dcfSSatish Balay .seealso: TaoSetTolerances()
864a7e14dcfSSatish Balay @*/
865441846f8SBarry Smith PetscErrorCode TaoSetFunctionLowerBound(Tao tao,PetscReal fmin)
866a7e14dcfSSatish Balay {
867a7e14dcfSSatish Balay   PetscFunctionBegin;
868441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
869a7e14dcfSSatish Balay   tao->fmin = fmin;
8706552cf8aSJason Sarich   tao->fmin_changed=PETSC_TRUE;
871a7e14dcfSSatish Balay   PetscFunctionReturn(0);
872a7e14dcfSSatish Balay }
873a7e14dcfSSatish Balay 
874a7e14dcfSSatish Balay /*@
8758e96d397SJason Sarich    TaoGetFunctionLowerBound - Gets the bound on the solution objective value.
876a7e14dcfSSatish Balay    When an approximate solution with an objective value below this number
877a7e14dcfSSatish Balay    has been found, the solver will terminate.
878a7e14dcfSSatish Balay 
879441846f8SBarry Smith    Not collective on Tao
880a7e14dcfSSatish Balay 
881a7e14dcfSSatish Balay    Input Parameters:
882441846f8SBarry Smith .  tao - the Tao solver context
883a7e14dcfSSatish Balay 
884a7e14dcfSSatish Balay    OutputParameters:
885a7e14dcfSSatish Balay .  fmin - the minimum function value
886a7e14dcfSSatish Balay 
887a7e14dcfSSatish Balay    Level: intermediate
888a7e14dcfSSatish Balay 
889a7e14dcfSSatish Balay .seealso: TaoSetFunctionLowerBound()
890a7e14dcfSSatish Balay @*/
891441846f8SBarry Smith PetscErrorCode TaoGetFunctionLowerBound(Tao tao,PetscReal *fmin)
892a7e14dcfSSatish Balay {
893a7e14dcfSSatish Balay   PetscFunctionBegin;
894441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
895a7e14dcfSSatish Balay   *fmin = tao->fmin;
896a7e14dcfSSatish Balay   PetscFunctionReturn(0);
897a7e14dcfSSatish Balay }
898a7e14dcfSSatish Balay 
899a7e14dcfSSatish Balay /*@
900a7e14dcfSSatish Balay    TaoSetMaximumFunctionEvaluations - Sets a maximum number of
901a7e14dcfSSatish Balay    function evaluations.
902a7e14dcfSSatish Balay 
903441846f8SBarry Smith    Logically Collective on Tao
904a7e14dcfSSatish Balay 
905a7e14dcfSSatish Balay    Input Parameters:
906441846f8SBarry Smith +  tao - the Tao solver context
907a7e14dcfSSatish Balay -  nfcn - the maximum number of function evaluations (>=0)
908a7e14dcfSSatish Balay 
909a7e14dcfSSatish Balay    Options Database Keys:
910a7e14dcfSSatish Balay .    -tao_max_funcs <nfcn> - sets the maximum number of function evaluations
911a7e14dcfSSatish Balay 
912a7e14dcfSSatish Balay    Level: intermediate
913a7e14dcfSSatish Balay 
914a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumIterations()
915a7e14dcfSSatish Balay @*/
916a7e14dcfSSatish Balay 
917441846f8SBarry Smith PetscErrorCode TaoSetMaximumFunctionEvaluations(Tao tao,PetscInt nfcn)
918a7e14dcfSSatish Balay {
919a7e14dcfSSatish Balay   PetscFunctionBegin;
920441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
92147a47007SBarry Smith   tao->max_funcs = PetscMax(0,nfcn);
9226552cf8aSJason Sarich   tao->max_funcs_changed=PETSC_TRUE;
923a7e14dcfSSatish Balay   PetscFunctionReturn(0);
924a7e14dcfSSatish Balay }
925a7e14dcfSSatish Balay 
926a7e14dcfSSatish Balay /*@
927a7e14dcfSSatish Balay    TaoGetMaximumFunctionEvaluations - Sets a maximum number of
928a7e14dcfSSatish Balay    function evaluations.
929a7e14dcfSSatish Balay 
930a7e14dcfSSatish Balay    Not Collective
931a7e14dcfSSatish Balay 
932a7e14dcfSSatish Balay    Input Parameters:
933441846f8SBarry Smith .  tao - the Tao solver context
934a7e14dcfSSatish Balay 
935a7e14dcfSSatish Balay    Output Parameters:
936a7e14dcfSSatish Balay .  nfcn - the maximum number of function evaluations
937a7e14dcfSSatish Balay 
938a7e14dcfSSatish Balay    Level: intermediate
939a7e14dcfSSatish Balay 
940a7e14dcfSSatish Balay .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumIterations()
941a7e14dcfSSatish Balay @*/
942a7e14dcfSSatish Balay 
943441846f8SBarry Smith PetscErrorCode TaoGetMaximumFunctionEvaluations(Tao tao,PetscInt *nfcn)
944a7e14dcfSSatish Balay {
945a7e14dcfSSatish Balay   PetscFunctionBegin;
946441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
947a7e14dcfSSatish Balay   *nfcn = tao->max_funcs;
948a7e14dcfSSatish Balay   PetscFunctionReturn(0);
949a7e14dcfSSatish Balay }
950a7e14dcfSSatish Balay 
951770232b9SCe Qin /*@
952770232b9SCe Qin    TaoGetCurrentFunctionEvaluations - Get current number of
953770232b9SCe Qin    function evaluations.
954770232b9SCe Qin 
955770232b9SCe Qin    Not Collective
956770232b9SCe Qin 
957770232b9SCe Qin    Input Parameters:
958770232b9SCe Qin .  tao - the Tao solver context
959770232b9SCe Qin 
960770232b9SCe Qin    Output Parameters:
961770232b9SCe Qin .  nfuncs - the current number of function evaluations
962770232b9SCe Qin 
963770232b9SCe Qin    Level: intermediate
964770232b9SCe Qin 
965770232b9SCe Qin .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumFunctionEvaluations(), TaoGetMaximumIterations()
966770232b9SCe Qin @*/
967770232b9SCe Qin 
968770232b9SCe Qin PetscErrorCode TaoGetCurrentFunctionEvaluations(Tao tao,PetscInt *nfuncs)
969770232b9SCe Qin {
970770232b9SCe Qin   PetscFunctionBegin;
971770232b9SCe Qin   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
972770232b9SCe Qin   *nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads);
973770232b9SCe Qin   PetscFunctionReturn(0);
974770232b9SCe Qin }
975770232b9SCe Qin 
976a7e14dcfSSatish Balay /*@
977a7e14dcfSSatish Balay    TaoSetMaximumIterations - Sets a maximum number of iterates.
978a7e14dcfSSatish Balay 
979441846f8SBarry Smith    Logically Collective on Tao
980a7e14dcfSSatish Balay 
981a7e14dcfSSatish Balay    Input Parameters:
982441846f8SBarry Smith +  tao - the Tao solver context
983a7e14dcfSSatish Balay -  maxits - the maximum number of iterates (>=0)
984a7e14dcfSSatish Balay 
985a7e14dcfSSatish Balay    Options Database Keys:
986a7e14dcfSSatish Balay .    -tao_max_it <its> - sets the maximum number of iterations
987a7e14dcfSSatish Balay 
988a7e14dcfSSatish Balay    Level: intermediate
989a7e14dcfSSatish Balay 
990a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumFunctionEvaluations()
991a7e14dcfSSatish Balay @*/
992441846f8SBarry Smith PetscErrorCode TaoSetMaximumIterations(Tao tao,PetscInt maxits)
993a7e14dcfSSatish Balay {
994a7e14dcfSSatish Balay   PetscFunctionBegin;
995441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
99647a47007SBarry Smith   tao->max_it = PetscMax(0,maxits);
9976552cf8aSJason Sarich   tao->max_it_changed=PETSC_TRUE;
998a7e14dcfSSatish Balay   PetscFunctionReturn(0);
999a7e14dcfSSatish Balay }
1000a7e14dcfSSatish Balay 
1001a7e14dcfSSatish Balay /*@
1002a7e14dcfSSatish Balay    TaoGetMaximumIterations - Sets a maximum number of iterates.
1003a7e14dcfSSatish Balay 
1004a7e14dcfSSatish Balay    Not Collective
1005a7e14dcfSSatish Balay 
1006a7e14dcfSSatish Balay    Input Parameters:
1007441846f8SBarry Smith .  tao - the Tao solver context
1008a7e14dcfSSatish Balay 
1009a7e14dcfSSatish Balay    Output Parameters:
1010a7e14dcfSSatish Balay .  maxits - the maximum number of iterates
1011a7e14dcfSSatish Balay 
1012a7e14dcfSSatish Balay    Level: intermediate
1013a7e14dcfSSatish Balay 
1014a7e14dcfSSatish Balay .seealso: TaoSetMaximumIterations(), TaoGetMaximumFunctionEvaluations()
1015a7e14dcfSSatish Balay @*/
1016441846f8SBarry Smith PetscErrorCode TaoGetMaximumIterations(Tao tao,PetscInt *maxits)
1017a7e14dcfSSatish Balay {
1018a7e14dcfSSatish Balay   PetscFunctionBegin;
1019441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1020a7e14dcfSSatish Balay   *maxits = tao->max_it;
1021a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1022a7e14dcfSSatish Balay }
1023a7e14dcfSSatish Balay 
1024a7e14dcfSSatish Balay /*@
1025a7e14dcfSSatish Balay    TaoSetInitialTrustRegionRadius - Sets the initial trust region radius.
1026a7e14dcfSSatish Balay 
1027441846f8SBarry Smith    Logically collective on Tao
1028a7e14dcfSSatish Balay 
1029a7e14dcfSSatish Balay    Input Parameter:
1030a7e14dcfSSatish Balay +  tao - a TAO optimization solver
1031a7e14dcfSSatish Balay -  radius - the trust region radius
1032a7e14dcfSSatish Balay 
1033a7e14dcfSSatish Balay    Level: intermediate
1034a7e14dcfSSatish Balay 
1035a7e14dcfSSatish Balay    Options Database Key:
1036a7e14dcfSSatish Balay .  -tao_trust0 <t0> - sets initial trust region radius
1037a7e14dcfSSatish Balay 
1038a7e14dcfSSatish Balay .seealso: TaoGetTrustRegionRadius(), TaoSetTrustRegionTolerance()
1039a7e14dcfSSatish Balay @*/
1040441846f8SBarry Smith PetscErrorCode TaoSetInitialTrustRegionRadius(Tao tao, PetscReal radius)
1041a7e14dcfSSatish Balay {
1042a7e14dcfSSatish Balay   PetscFunctionBegin;
1043441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1044a7e14dcfSSatish Balay   tao->trust0 = PetscMax(0.0,radius);
10456552cf8aSJason Sarich   tao->trust0_changed=PETSC_TRUE;
1046a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1047a7e14dcfSSatish Balay }
1048a7e14dcfSSatish Balay 
1049a7e14dcfSSatish Balay /*@
1050a7e14dcfSSatish Balay    TaoGetInitialTrustRegionRadius - Sets the initial trust region radius.
1051a7e14dcfSSatish Balay 
1052a7e14dcfSSatish Balay    Not Collective
1053a7e14dcfSSatish Balay 
1054a7e14dcfSSatish Balay    Input Parameter:
1055a7e14dcfSSatish Balay .  tao - a TAO optimization solver
1056a7e14dcfSSatish Balay 
1057a7e14dcfSSatish Balay    Output Parameter:
1058a7e14dcfSSatish Balay .  radius - the trust region radius
1059a7e14dcfSSatish Balay 
1060a7e14dcfSSatish Balay    Level: intermediate
1061a7e14dcfSSatish Balay 
1062a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetCurrentTrustRegionRadius()
1063a7e14dcfSSatish Balay @*/
1064441846f8SBarry Smith PetscErrorCode TaoGetInitialTrustRegionRadius(Tao tao, PetscReal *radius)
1065a7e14dcfSSatish Balay {
1066a7e14dcfSSatish Balay   PetscFunctionBegin;
1067441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1068a7e14dcfSSatish Balay   *radius = tao->trust0;
1069a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1070a7e14dcfSSatish Balay }
1071a7e14dcfSSatish Balay 
1072a7e14dcfSSatish Balay /*@
1073a7e14dcfSSatish Balay    TaoGetCurrentTrustRegionRadius - Gets the current trust region radius.
1074a7e14dcfSSatish Balay 
1075a7e14dcfSSatish Balay    Not Collective
1076a7e14dcfSSatish Balay 
1077a7e14dcfSSatish Balay    Input Parameter:
1078a7e14dcfSSatish Balay .  tao - a TAO optimization solver
1079a7e14dcfSSatish Balay 
1080a7e14dcfSSatish Balay    Output Parameter:
1081a7e14dcfSSatish Balay .  radius - the trust region radius
1082a7e14dcfSSatish Balay 
1083a7e14dcfSSatish Balay    Level: intermediate
1084a7e14dcfSSatish Balay 
1085a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetInitialTrustRegionRadius()
1086a7e14dcfSSatish Balay @*/
1087441846f8SBarry Smith PetscErrorCode TaoGetCurrentTrustRegionRadius(Tao tao, PetscReal *radius)
1088a7e14dcfSSatish Balay {
1089a7e14dcfSSatish Balay   PetscFunctionBegin;
1090441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1091a7e14dcfSSatish Balay   *radius = tao->trust;
1092a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1093a7e14dcfSSatish Balay }
1094a7e14dcfSSatish Balay 
1095a7e14dcfSSatish Balay /*@
1096a7e14dcfSSatish Balay   TaoGetTolerances - gets the current values of tolerances
1097a7e14dcfSSatish Balay 
1098a7e14dcfSSatish Balay   Not Collective
1099a7e14dcfSSatish Balay 
1100a7e14dcfSSatish Balay   Input Parameters:
1101441846f8SBarry Smith . tao - the Tao context
1102a7e14dcfSSatish Balay 
1103a7e14dcfSSatish Balay   Output Parameters:
1104e52336cbSBarry Smith + gatol - stop if norm of gradient is less than this
1105a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this
1106a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by a this factor
1107a7e14dcfSSatish Balay 
110847a47007SBarry Smith   Note: NULL can be used as an argument if not all tolerances values are needed
1109a7e14dcfSSatish Balay 
1110a7e14dcfSSatish Balay .seealso TaoSetTolerances()
1111a7e14dcfSSatish Balay 
1112a7e14dcfSSatish Balay   Level: intermediate
1113a7e14dcfSSatish Balay @*/
1114e52336cbSBarry Smith PetscErrorCode TaoGetTolerances(Tao tao, PetscReal *gatol, PetscReal *grtol, PetscReal *gttol)
1115a7e14dcfSSatish Balay {
1116a7e14dcfSSatish Balay   PetscFunctionBegin;
1117441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1118a7e14dcfSSatish Balay   if (gatol) *gatol=tao->gatol;
1119a7e14dcfSSatish Balay   if (grtol) *grtol=tao->grtol;
1120a7e14dcfSSatish Balay   if (gttol) *gttol=tao->gttol;
1121a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1122a7e14dcfSSatish Balay }
1123a7e14dcfSSatish Balay 
1124a7e14dcfSSatish Balay /*@
1125a7e14dcfSSatish Balay   TaoGetKSP - Gets the linear solver used by the optimization solver.
1126a7e14dcfSSatish Balay   Application writers should use TaoGetKSP if they need direct access
1127a7e14dcfSSatish Balay   to the PETSc KSP object.
1128a7e14dcfSSatish Balay 
1129a7e14dcfSSatish Balay   Not Collective
1130a7e14dcfSSatish Balay 
1131a7e14dcfSSatish Balay    Input Parameters:
1132a7e14dcfSSatish Balay .  tao - the TAO solver
1133a7e14dcfSSatish Balay 
1134a7e14dcfSSatish Balay    Output Parameters:
1135a7e14dcfSSatish Balay .  ksp - the KSP linear solver used in the optimization solver
1136a7e14dcfSSatish Balay 
1137a7e14dcfSSatish Balay    Level: intermediate
1138a7e14dcfSSatish Balay 
1139a7e14dcfSSatish Balay @*/
1140441846f8SBarry Smith PetscErrorCode TaoGetKSP(Tao tao, KSP *ksp)
114147a47007SBarry Smith {
1142a7e14dcfSSatish Balay   PetscFunctionBegin;
1143a7e14dcfSSatish Balay   *ksp = tao->ksp;
1144a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1145a7e14dcfSSatish Balay }
1146a7e14dcfSSatish Balay 
1147025e9500SJason Sarich /*@
1148025e9500SJason Sarich    TaoGetLinearSolveIterations - Gets the total number of linear iterations
1149025e9500SJason Sarich    used by the TAO solver
1150025e9500SJason Sarich 
1151025e9500SJason Sarich    Not Collective
1152025e9500SJason Sarich 
1153025e9500SJason Sarich    Input Parameter:
1154025e9500SJason Sarich .  tao - TAO context
1155025e9500SJason Sarich 
1156025e9500SJason Sarich    Output Parameter:
1157025e9500SJason Sarich .  lits - number of linear iterations
1158025e9500SJason Sarich 
1159025e9500SJason Sarich    Notes:
1160025e9500SJason Sarich    This counter is reset to zero for each successive call to TaoSolve()
1161025e9500SJason Sarich 
1162025e9500SJason Sarich    Level: intermediate
1163025e9500SJason Sarich 
1164025e9500SJason Sarich .keywords: TAO
1165025e9500SJason Sarich 
1166025e9500SJason Sarich .seealso:  TaoGetKSP()
1167025e9500SJason Sarich @*/
1168025e9500SJason Sarich PetscErrorCode  TaoGetLinearSolveIterations(Tao tao,PetscInt *lits)
1169025e9500SJason Sarich {
1170025e9500SJason Sarich   PetscFunctionBegin;
1171025e9500SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1172025e9500SJason Sarich   PetscValidIntPointer(lits,2);
11732d9aa51bSJason Sarich   *lits = tao->ksp_tot_its;
1174025e9500SJason Sarich   PetscFunctionReturn(0);
1175025e9500SJason Sarich }
1176025e9500SJason Sarich 
1177a7e14dcfSSatish Balay /*@
1178a7e14dcfSSatish Balay   TaoGetLineSearch - Gets the line search used by the optimization solver.
1179a7e14dcfSSatish Balay   Application writers should use TaoGetLineSearch if they need direct access
1180a7e14dcfSSatish Balay   to the TaoLineSearch object.
1181a7e14dcfSSatish Balay 
1182a7e14dcfSSatish Balay   Not Collective
1183a7e14dcfSSatish Balay 
1184a7e14dcfSSatish Balay    Input Parameters:
1185a7e14dcfSSatish Balay .  tao - the TAO solver
1186a7e14dcfSSatish Balay 
1187a7e14dcfSSatish Balay    Output Parameters:
1188a7e14dcfSSatish Balay .  ls - the line search used in the optimization solver
1189a7e14dcfSSatish Balay 
1190a7e14dcfSSatish Balay    Level: intermediate
1191a7e14dcfSSatish Balay 
1192a7e14dcfSSatish Balay @*/
1193441846f8SBarry Smith PetscErrorCode TaoGetLineSearch(Tao tao, TaoLineSearch *ls)
119447a47007SBarry Smith {
1195a7e14dcfSSatish Balay   PetscFunctionBegin;
1196a7e14dcfSSatish Balay   *ls = tao->linesearch;
1197a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1198a7e14dcfSSatish Balay }
1199a7e14dcfSSatish Balay 
1200a7e14dcfSSatish Balay /*@
1201a7e14dcfSSatish Balay   TaoAddLineSearchCounts - Adds the number of function evaluations spent
1202a7e14dcfSSatish Balay   in the line search to the running total.
1203a7e14dcfSSatish Balay 
1204a7e14dcfSSatish Balay    Input Parameters:
1205a7e14dcfSSatish Balay +  tao - the TAO solver
1206a7e14dcfSSatish Balay -  ls - the line search used in the optimization solver
1207a7e14dcfSSatish Balay 
1208a7e14dcfSSatish Balay    Level: developer
1209a7e14dcfSSatish Balay 
1210a7e14dcfSSatish Balay .seealso: TaoLineSearchApply()
1211a7e14dcfSSatish Balay @*/
1212441846f8SBarry Smith PetscErrorCode TaoAddLineSearchCounts(Tao tao)
121347a47007SBarry Smith {
1214a7e14dcfSSatish Balay   PetscErrorCode ierr;
1215a7e14dcfSSatish Balay   PetscBool      flg;
1216a7e14dcfSSatish Balay   PetscInt       nfeval,ngeval,nfgeval;
121747a47007SBarry Smith 
1218a7e14dcfSSatish Balay   PetscFunctionBegin;
1219441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1220a7e14dcfSSatish Balay   if (tao->linesearch) {
1221302440fdSBarry Smith     ierr = TaoLineSearchIsUsingTaoRoutines(tao->linesearch,&flg);CHKERRQ(ierr);
122294ae4db5SBarry Smith     if (!flg) {
122347a47007SBarry Smith       ierr = TaoLineSearchGetNumberFunctionEvaluations(tao->linesearch,&nfeval,&ngeval,&nfgeval);CHKERRQ(ierr);
1224a7e14dcfSSatish Balay       tao->nfuncs+=nfeval;
1225a7e14dcfSSatish Balay       tao->ngrads+=ngeval;
1226a7e14dcfSSatish Balay       tao->nfuncgrads+=nfgeval;
1227a7e14dcfSSatish Balay     }
1228a7e14dcfSSatish Balay   }
1229a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1230a7e14dcfSSatish Balay }
1231a7e14dcfSSatish Balay 
1232a7e14dcfSSatish Balay /*@
1233a7e14dcfSSatish Balay   TaoGetSolutionVector - Returns the vector with the current TAO solution
1234a7e14dcfSSatish Balay 
1235a7e14dcfSSatish Balay   Not Collective
1236a7e14dcfSSatish Balay 
1237a7e14dcfSSatish Balay   Input Parameter:
1238441846f8SBarry Smith . tao - the Tao context
1239a7e14dcfSSatish Balay 
1240a7e14dcfSSatish Balay   Output Parameter:
1241a7e14dcfSSatish Balay . X - the current solution
1242a7e14dcfSSatish Balay 
1243a7e14dcfSSatish Balay   Level: intermediate
1244a7e14dcfSSatish Balay 
1245a7e14dcfSSatish Balay   Note:  The returned vector will be the same object that was passed into TaoSetInitialVector()
1246a7e14dcfSSatish Balay @*/
1247441846f8SBarry Smith PetscErrorCode TaoGetSolutionVector(Tao tao, Vec *X)
1248a7e14dcfSSatish Balay {
1249a7e14dcfSSatish Balay   PetscFunctionBegin;
1250441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1251a7e14dcfSSatish Balay   *X = tao->solution;
1252a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1253a7e14dcfSSatish Balay }
1254a7e14dcfSSatish Balay 
1255a7e14dcfSSatish Balay /*@
1256a7e14dcfSSatish Balay   TaoGetGradientVector - Returns the vector with the current TAO gradient
1257a7e14dcfSSatish Balay 
1258a7e14dcfSSatish Balay   Not Collective
1259a7e14dcfSSatish Balay 
1260a7e14dcfSSatish Balay   Input Parameter:
1261441846f8SBarry Smith . tao - the Tao context
1262a7e14dcfSSatish Balay 
1263a7e14dcfSSatish Balay   Output Parameter:
1264a7e14dcfSSatish Balay . G - the current solution
1265a7e14dcfSSatish Balay 
1266a7e14dcfSSatish Balay   Level: intermediate
1267a7e14dcfSSatish Balay @*/
1268441846f8SBarry Smith PetscErrorCode TaoGetGradientVector(Tao tao, Vec *G)
1269a7e14dcfSSatish Balay {
1270a7e14dcfSSatish Balay   PetscFunctionBegin;
1271441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1272a7e14dcfSSatish Balay   *G = tao->gradient;
1273a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1274a7e14dcfSSatish Balay }
1275a7e14dcfSSatish Balay 
1276a7e14dcfSSatish Balay /*@
1277a7e14dcfSSatish Balay    TaoResetStatistics - Initialize the statistics used by TAO for all of the solvers.
1278a7e14dcfSSatish Balay    These statistics include the iteration number, residual norms, and convergence status.
1279a7e14dcfSSatish Balay    This routine gets called before solving each optimization problem.
1280a7e14dcfSSatish Balay 
1281441846f8SBarry Smith    Collective on Tao
1282a7e14dcfSSatish Balay 
1283a7e14dcfSSatish Balay    Input Parameters:
1284441846f8SBarry Smith .  solver - the Tao context
1285a7e14dcfSSatish Balay 
1286a7e14dcfSSatish Balay    Level: developer
1287a7e14dcfSSatish Balay 
1288a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
1289a7e14dcfSSatish Balay @*/
1290441846f8SBarry Smith PetscErrorCode TaoResetStatistics(Tao tao)
1291a7e14dcfSSatish Balay {
1292a7e14dcfSSatish Balay   PetscFunctionBegin;
1293441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1294a7e14dcfSSatish Balay   tao->niter        = 0;
1295a7e14dcfSSatish Balay   tao->nfuncs       = 0;
1296a7e14dcfSSatish Balay   tao->nfuncgrads   = 0;
1297a7e14dcfSSatish Balay   tao->ngrads       = 0;
1298a7e14dcfSSatish Balay   tao->nhess        = 0;
1299a7e14dcfSSatish Balay   tao->njac         = 0;
1300a7e14dcfSSatish Balay   tao->nconstraints = 0;
1301a7e14dcfSSatish Balay   tao->ksp_its      = 0;
1302ae93cb3cSJason Sarich   tao->ksp_tot_its  = 0;
1303a7e14dcfSSatish Balay   tao->reason       = TAO_CONTINUE_ITERATING;
1304a7e14dcfSSatish Balay   tao->residual     = 0.0;
1305a7e14dcfSSatish Balay   tao->cnorm        = 0.0;
1306a7e14dcfSSatish Balay   tao->step         = 0.0;
1307a7e14dcfSSatish Balay   tao->lsflag       = PETSC_FALSE;
1308a7e14dcfSSatish Balay   if (tao->hist_reset) tao->hist_len=0;
1309a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1310a7e14dcfSSatish Balay }
1311a7e14dcfSSatish Balay 
1312a7e14dcfSSatish Balay /*@C
1313a7e14dcfSSatish Balay   TaoSetConvergenceTest - Sets the function that is to be used to test
1314a7e14dcfSSatish Balay   for convergence o fthe iterative minimization solution.  The new convergence
1315a7e14dcfSSatish Balay   testing routine will replace TAO's default convergence test.
1316a7e14dcfSSatish Balay 
1317441846f8SBarry Smith   Logically Collective on Tao
1318a7e14dcfSSatish Balay 
1319a7e14dcfSSatish Balay   Input Parameters:
1320441846f8SBarry Smith + tao - the Tao object
1321a7e14dcfSSatish Balay . conv - the routine to test for convergence
1322a7e14dcfSSatish Balay - ctx - [optional] context for private data for the convergence routine
132347a47007SBarry Smith         (may be NULL)
1324a7e14dcfSSatish Balay 
1325a7e14dcfSSatish Balay   Calling sequence of conv:
1326441846f8SBarry Smith $   PetscErrorCode conv(Tao tao, void *ctx)
1327a7e14dcfSSatish Balay 
1328441846f8SBarry Smith + tao - the Tao object
1329a7e14dcfSSatish Balay - ctx - [optional] convergence context
1330a7e14dcfSSatish Balay 
1331e4cb33bbSBarry Smith   Note: The new convergence testing routine should call TaoSetConvergedReason().
1332a7e14dcfSSatish Balay 
1333a7e14dcfSSatish Balay   Level: advanced
1334a7e14dcfSSatish Balay 
1335e4cb33bbSBarry Smith .seealso: TaoSetConvergedReason(), TaoGetSolutionStatus(), TaoGetTolerances(), TaoSetMonitor
1336a7e14dcfSSatish Balay 
1337a7e14dcfSSatish Balay @*/
1338441846f8SBarry Smith PetscErrorCode TaoSetConvergenceTest(Tao tao, PetscErrorCode (*conv)(Tao,void*), void *ctx)
1339a7e14dcfSSatish Balay {
1340a7e14dcfSSatish Balay   PetscFunctionBegin;
1341441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1342a7e14dcfSSatish Balay   (tao)->ops->convergencetest = conv;
1343a7e14dcfSSatish Balay   (tao)->cnvP = ctx;
1344a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1345a7e14dcfSSatish Balay }
1346a7e14dcfSSatish Balay 
1347a7e14dcfSSatish Balay /*@C
1348a7e14dcfSSatish Balay    TaoSetMonitor - Sets an ADDITIONAL function that is to be used at every
1349a7e14dcfSSatish Balay    iteration of the solver to display the iteration's
1350a7e14dcfSSatish Balay    progress.
1351a7e14dcfSSatish Balay 
1352441846f8SBarry Smith    Logically Collective on Tao
1353a7e14dcfSSatish Balay 
1354a7e14dcfSSatish Balay    Input Parameters:
1355441846f8SBarry Smith +  tao - the Tao solver context
1356a7e14dcfSSatish Balay .  mymonitor - monitoring routine
1357a7e14dcfSSatish Balay -  mctx - [optional] user-defined context for private data for the
135847a47007SBarry Smith           monitor routine (may be NULL)
1359a7e14dcfSSatish Balay 
1360a7e14dcfSSatish Balay    Calling sequence of mymonitor:
1361441846f8SBarry Smith $     int mymonitor(Tao tao,void *mctx)
1362a7e14dcfSSatish Balay 
1363441846f8SBarry Smith +    tao - the Tao solver context
1364a7e14dcfSSatish Balay -    mctx - [optional] monitoring context
1365a7e14dcfSSatish Balay 
1366a7e14dcfSSatish Balay 
1367a7e14dcfSSatish Balay    Options Database Keys:
1368a7e14dcfSSatish Balay +    -tao_monitor        - sets TaoDefaultMonitor()
1369a7e14dcfSSatish Balay .    -tao_smonitor       - sets short monitor
1370a7e14dcfSSatish Balay .    -tao_cmonitor       - same as smonitor plus constraint norm
1371a7e14dcfSSatish Balay .    -tao_view_solution   - view solution at each iteration
1372a7e14dcfSSatish Balay .    -tao_view_gradient   - view gradient at each iteration
1373a7e14dcfSSatish Balay .    -tao_view_separableobjective - view separable objective function at each iteration
1374a7e14dcfSSatish Balay -    -tao_cancelmonitors - cancels all monitors that have been hardwired into a code by calls to TaoSetMonitor(), but does not cancel those set via the options database.
1375a7e14dcfSSatish Balay 
1376a7e14dcfSSatish Balay 
1377a7e14dcfSSatish Balay    Notes:
1378a7e14dcfSSatish Balay    Several different monitoring routines may be set by calling
1379a7e14dcfSSatish Balay    TaoSetMonitor() multiple times; all will be called in the
1380a7e14dcfSSatish Balay    order in which they were set.
1381a7e14dcfSSatish Balay 
1382a7e14dcfSSatish Balay    Fortran Notes: Only one monitor function may be set
1383a7e14dcfSSatish Balay 
1384a7e14dcfSSatish Balay    Level: intermediate
1385a7e14dcfSSatish Balay 
1386a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoCancelMonitors(),  TaoSetDestroyRoutine()
1387a7e14dcfSSatish Balay @*/
1388441846f8SBarry Smith PetscErrorCode TaoSetMonitor(Tao tao, PetscErrorCode (*func)(Tao, void*), void *ctx,PetscErrorCode (*dest)(void**))
1389a7e14dcfSSatish Balay {
139008d19d1fSJason Sarich   PetscErrorCode ierr;
139108d19d1fSJason Sarich   PetscInt       i;
139208d19d1fSJason Sarich 
1393a7e14dcfSSatish Balay   PetscFunctionBegin;
1394441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
139547a47007SBarry Smith   if (tao->numbermonitors >= MAXTAOMONITORS) SETERRQ1(PETSC_COMM_SELF,1,"Cannot attach another monitor -- max=",MAXTAOMONITORS);
139608d19d1fSJason Sarich 
139708d19d1fSJason Sarich   for (i=0; i<tao->numbermonitors;i++) {
139808d19d1fSJason Sarich     if (func == tao->monitor[i] && dest == tao->monitordestroy[i] && ctx == tao->monitorcontext[i]) {
139908d19d1fSJason Sarich       if (dest) {
140008d19d1fSJason Sarich         ierr = (*dest)(&ctx);CHKERRQ(ierr);
140108d19d1fSJason Sarich       }
140208d19d1fSJason Sarich       PetscFunctionReturn(0);
140308d19d1fSJason Sarich     }
140408d19d1fSJason Sarich   }
1405a7e14dcfSSatish Balay   tao->monitor[tao->numbermonitors] = func;
1406a7e14dcfSSatish Balay   tao->monitorcontext[tao->numbermonitors] = ctx;
1407a7e14dcfSSatish Balay   tao->monitordestroy[tao->numbermonitors] = dest;
1408a7e14dcfSSatish Balay   ++tao->numbermonitors;
1409a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1410a7e14dcfSSatish Balay }
1411a7e14dcfSSatish Balay 
1412a7e14dcfSSatish Balay /*@
1413441846f8SBarry Smith    TaoCancelMonitors - Clears all the monitor functions for a Tao object.
1414a7e14dcfSSatish Balay 
1415441846f8SBarry Smith    Logically Collective on Tao
1416a7e14dcfSSatish Balay 
1417a7e14dcfSSatish Balay    Input Parameters:
1418441846f8SBarry Smith .  tao - the Tao solver context
1419a7e14dcfSSatish Balay 
1420a7e14dcfSSatish Balay    Options Database:
1421a7e14dcfSSatish Balay .  -tao_cancelmonitors - cancels all monitors that have been hardwired
1422a7e14dcfSSatish Balay     into a code by calls to TaoSetMonitor(), but does not cancel those
1423a7e14dcfSSatish Balay     set via the options database
1424a7e14dcfSSatish Balay 
1425a7e14dcfSSatish Balay    Notes:
1426441846f8SBarry Smith    There is no way to clear one specific monitor from a Tao object.
1427a7e14dcfSSatish Balay 
1428a7e14dcfSSatish Balay    Level: advanced
1429a7e14dcfSSatish Balay 
1430a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1431a7e14dcfSSatish Balay @*/
1432441846f8SBarry Smith PetscErrorCode TaoCancelMonitors(Tao tao)
1433a7e14dcfSSatish Balay {
1434a7e14dcfSSatish Balay   PetscInt       i;
1435a7e14dcfSSatish Balay   PetscErrorCode ierr;
143647a47007SBarry Smith 
1437a7e14dcfSSatish Balay   PetscFunctionBegin;
1438441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1439a7e14dcfSSatish Balay   for (i=0;i<tao->numbermonitors;i++) {
1440a7e14dcfSSatish Balay     if (tao->monitordestroy[i]) {
1441a7e14dcfSSatish Balay       ierr = (*tao->monitordestroy[i])(&tao->monitorcontext[i]);CHKERRQ(ierr);
1442a7e14dcfSSatish Balay     }
1443a7e14dcfSSatish Balay   }
1444a7e14dcfSSatish Balay   tao->numbermonitors=0;
1445a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1446a7e14dcfSSatish Balay }
1447a7e14dcfSSatish Balay 
14487fab98ebSJason Sarich /*@
1449a7e14dcfSSatish Balay    TaoDefaultMonitor - Default routine for monitoring progress of the
1450441846f8SBarry Smith    Tao solvers (default).  This monitor prints the function value and gradient
1451a7e14dcfSSatish Balay    norm at each iteration.  It can be turned on from the command line using the
1452a7e14dcfSSatish Balay    -tao_monitor option
1453a7e14dcfSSatish Balay 
1454441846f8SBarry Smith    Collective on Tao
1455a7e14dcfSSatish Balay 
1456a7e14dcfSSatish Balay    Input Parameters:
1457441846f8SBarry Smith +  tao - the Tao context
145847a47007SBarry Smith -  ctx - PetscViewer context or NULL
1459a7e14dcfSSatish Balay 
1460a7e14dcfSSatish Balay    Options Database Keys:
1461a7e14dcfSSatish Balay .  -tao_monitor
1462a7e14dcfSSatish Balay 
1463a7e14dcfSSatish Balay    Level: advanced
1464a7e14dcfSSatish Balay 
1465a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1466a7e14dcfSSatish Balay @*/
1467441846f8SBarry Smith PetscErrorCode TaoDefaultMonitor(Tao tao, void *ctx)
1468a7e14dcfSSatish Balay {
1469a7e14dcfSSatish Balay   PetscErrorCode ierr;
1470a7e14dcfSSatish Balay   PetscInt       its;
1471a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
14728163d661SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
147347a47007SBarry Smith 
1474a7e14dcfSSatish Balay   PetscFunctionBegin;
14758163d661SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1476a7e14dcfSSatish Balay   its=tao->niter;
1477a7e14dcfSSatish Balay   fct=tao->fc;
1478a7e14dcfSSatish Balay   gnorm=tao->residual;
1479a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr);
148047a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr);
148108d19d1fSJason Sarich   if (gnorm >= PETSC_INFINITY) {
148208d19d1fSJason Sarich     ierr=PetscViewerASCIIPrintf(viewer,"  Residual: Inf \n");CHKERRQ(ierr);
148308d19d1fSJason Sarich   } else {
148447a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer,"  Residual: %g \n",(double)gnorm);CHKERRQ(ierr);
148508d19d1fSJason Sarich   }
1486a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1487a7e14dcfSSatish Balay }
1488a7e14dcfSSatish Balay 
14897fab98ebSJason Sarich /*@
1490a7e14dcfSSatish Balay    TaoDefaultSMonitor - Default routine for monitoring progress of the
1491a7e14dcfSSatish Balay    solver. Same as TaoDefaultMonitor() except
1492a7e14dcfSSatish Balay    it prints fewer digits of the residual as the residual gets smaller.
1493a7e14dcfSSatish Balay    This is because the later digits are meaningless and are often
1494a7e14dcfSSatish Balay    different on different machines; by using this routine different
1495a7e14dcfSSatish Balay    machines will usually generate the same output. It can be turned on
1496a7e14dcfSSatish Balay    by using the -tao_smonitor option
1497a7e14dcfSSatish Balay 
1498441846f8SBarry Smith    Collective on Tao
1499a7e14dcfSSatish Balay 
1500a7e14dcfSSatish Balay    Input Parameters:
1501441846f8SBarry Smith +  tao - the Tao context
15024d4332d5SBarry Smith -  ctx - PetscViewer context of type ASCII
1503a7e14dcfSSatish Balay 
1504a7e14dcfSSatish Balay    Options Database Keys:
1505a7e14dcfSSatish Balay .  -tao_smonitor
1506a7e14dcfSSatish Balay 
1507a7e14dcfSSatish Balay    Level: advanced
1508a7e14dcfSSatish Balay 
1509a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1510a7e14dcfSSatish Balay @*/
1511441846f8SBarry Smith PetscErrorCode TaoDefaultSMonitor(Tao tao, void *ctx)
1512a7e14dcfSSatish Balay {
1513a7e14dcfSSatish Balay   PetscErrorCode ierr;
1514a7e14dcfSSatish Balay   PetscInt       its;
1515a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
15164d4332d5SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
151747a47007SBarry Smith 
1518a7e14dcfSSatish Balay   PetscFunctionBegin;
15194d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1520a7e14dcfSSatish Balay   its=tao->niter;
1521a7e14dcfSSatish Balay   fct=tao->fc;
1522a7e14dcfSSatish Balay   gnorm=tao->residual;
1523a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr);
152447a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value %g,",(double)fct);CHKERRQ(ierr);
1525d393f493SBarry Smith   if (gnorm >= PETSC_INFINITY) {
152608d19d1fSJason Sarich     ierr=PetscViewerASCIIPrintf(viewer," Residual: Inf \n");CHKERRQ(ierr);
152708d19d1fSJason Sarich   } else if (gnorm > 1.e-6) {
152847a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr);
1529a7e14dcfSSatish Balay   } else if (gnorm > 1.e-11) {
1530a7e14dcfSSatish Balay     ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-6 \n");CHKERRQ(ierr);
1531a7e14dcfSSatish Balay   } else {
1532a7e14dcfSSatish Balay     ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-11 \n");CHKERRQ(ierr);
1533a7e14dcfSSatish Balay   }
1534a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1535a7e14dcfSSatish Balay }
1536a7e14dcfSSatish Balay 
15377fab98ebSJason Sarich /*@
1538a7e14dcfSSatish Balay    TaoDefaultCMonitor - same as TaoDefaultMonitor() except
1539a7e14dcfSSatish Balay    it prints the norm of the constraints function. It can be turned on
1540a7e14dcfSSatish Balay    from the command line using the -tao_cmonitor option
1541a7e14dcfSSatish Balay 
1542441846f8SBarry Smith    Collective on Tao
1543a7e14dcfSSatish Balay 
1544a7e14dcfSSatish Balay    Input Parameters:
1545441846f8SBarry Smith +  tao - the Tao context
154647a47007SBarry Smith -  ctx - PetscViewer context or NULL
1547a7e14dcfSSatish Balay 
1548a7e14dcfSSatish Balay    Options Database Keys:
1549a7e14dcfSSatish Balay .  -tao_cmonitor
1550a7e14dcfSSatish Balay 
1551a7e14dcfSSatish Balay    Level: advanced
1552a7e14dcfSSatish Balay 
1553a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1554a7e14dcfSSatish Balay @*/
1555441846f8SBarry Smith PetscErrorCode TaoDefaultCMonitor(Tao tao, void *ctx)
1556a7e14dcfSSatish Balay {
1557a7e14dcfSSatish Balay   PetscErrorCode ierr;
1558a7e14dcfSSatish Balay   PetscInt       its;
1559a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1560d393f493SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
1561a7e14dcfSSatish Balay 
1562a7e14dcfSSatish Balay   PetscFunctionBegin;
1563d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1564a7e14dcfSSatish Balay   its=tao->niter;
1565a7e14dcfSSatish Balay   fct=tao->fc;
1566a7e14dcfSSatish Balay   gnorm=tao->residual;
1567a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %D,",its);CHKERRQ(ierr);
156847a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr);
156947a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer,"  Residual: %g ",(double)gnorm);CHKERRQ(ierr);
157047a47007SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"  Constraint: %g \n",(double)tao->cnorm);CHKERRQ(ierr);
1571a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1572a7e14dcfSSatish Balay }
1573a7e14dcfSSatish Balay 
1574a7e14dcfSSatish Balay /*@C
1575a7e14dcfSSatish Balay    TaoSolutionMonitor - Views the solution at each iteration
1576a7e14dcfSSatish Balay    It can be turned on from the command line using the
1577a7e14dcfSSatish Balay    -tao_view_solution option
1578a7e14dcfSSatish Balay 
1579441846f8SBarry Smith    Collective on Tao
1580a7e14dcfSSatish Balay 
1581a7e14dcfSSatish Balay    Input Parameters:
1582441846f8SBarry Smith +  tao - the Tao context
158347a47007SBarry Smith -  ctx - PetscViewer context or NULL
1584a7e14dcfSSatish Balay 
1585a7e14dcfSSatish Balay    Options Database Keys:
1586a7e14dcfSSatish Balay .  -tao_view_solution
1587a7e14dcfSSatish Balay 
1588a7e14dcfSSatish Balay    Level: advanced
1589a7e14dcfSSatish Balay 
1590a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1591a7e14dcfSSatish Balay @*/
1592441846f8SBarry Smith PetscErrorCode TaoSolutionMonitor(Tao tao, void *ctx)
1593a7e14dcfSSatish Balay {
1594a7e14dcfSSatish Balay   PetscErrorCode ierr;
1595d393f493SBarry Smith   PetscViewer    viewer  = (PetscViewer)ctx;;
159647a47007SBarry Smith 
1597a7e14dcfSSatish Balay   PetscFunctionBegin;
1598d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1599a7e14dcfSSatish Balay   ierr = VecView(tao->solution, viewer);CHKERRQ(ierr);
1600a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1601a7e14dcfSSatish Balay }
1602a7e14dcfSSatish Balay 
1603a7e14dcfSSatish Balay /*@C
1604a7e14dcfSSatish Balay    TaoGradientMonitor - Views the gradient at each iteration
1605a7e14dcfSSatish Balay    It can be turned on from the command line using the
1606a7e14dcfSSatish Balay    -tao_view_gradient option
1607a7e14dcfSSatish Balay 
1608441846f8SBarry Smith    Collective on Tao
1609a7e14dcfSSatish Balay 
1610a7e14dcfSSatish Balay    Input Parameters:
1611441846f8SBarry Smith +  tao - the Tao context
161247a47007SBarry Smith -  ctx - PetscViewer context or NULL
1613a7e14dcfSSatish Balay 
1614a7e14dcfSSatish Balay    Options Database Keys:
1615a7e14dcfSSatish Balay .  -tao_view_gradient
1616a7e14dcfSSatish Balay 
1617a7e14dcfSSatish Balay    Level: advanced
1618a7e14dcfSSatish Balay 
1619a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1620a7e14dcfSSatish Balay @*/
1621441846f8SBarry Smith PetscErrorCode TaoGradientMonitor(Tao tao, void *ctx)
1622a7e14dcfSSatish Balay {
1623a7e14dcfSSatish Balay   PetscErrorCode ierr;
1624d393f493SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
162547a47007SBarry Smith 
1626a7e14dcfSSatish Balay   PetscFunctionBegin;
1627d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1628a7e14dcfSSatish Balay   ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr);
1629a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1630a7e14dcfSSatish Balay }
1631a7e14dcfSSatish Balay 
1632a7e14dcfSSatish Balay /*@C
1633a7e14dcfSSatish Balay    TaoStepDirectionMonitor - Views the gradient at each iteration
1634a7e14dcfSSatish Balay    It can be turned on from the command line using the
1635a7e14dcfSSatish Balay    -tao_view_gradient option
1636a7e14dcfSSatish Balay 
1637441846f8SBarry Smith    Collective on Tao
1638a7e14dcfSSatish Balay 
1639a7e14dcfSSatish Balay    Input Parameters:
1640441846f8SBarry Smith +  tao - the Tao context
164147a47007SBarry Smith -  ctx - PetscViewer context or NULL
1642a7e14dcfSSatish Balay 
1643a7e14dcfSSatish Balay    Options Database Keys:
1644a7e14dcfSSatish Balay .  -tao_view_gradient
1645a7e14dcfSSatish Balay 
1646a7e14dcfSSatish Balay    Level: advanced
1647a7e14dcfSSatish Balay 
1648a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1649a7e14dcfSSatish Balay @*/
1650441846f8SBarry Smith PetscErrorCode TaoStepDirectionMonitor(Tao tao, void *ctx)
1651a7e14dcfSSatish Balay {
1652a7e14dcfSSatish Balay   PetscErrorCode ierr;
1653d393f493SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
1654d393f493SBarry Smith 
1655a7e14dcfSSatish Balay   PetscFunctionBegin;
1656d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1657a7e14dcfSSatish Balay   ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr);
1658a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1659a7e14dcfSSatish Balay }
1660a7e14dcfSSatish Balay 
1661a7e14dcfSSatish Balay /*@C
1662a7e14dcfSSatish Balay    TaoDrawSolutionMonitor - Plots the solution at each iteration
1663a7e14dcfSSatish Balay    It can be turned on from the command line using the
1664a7e14dcfSSatish Balay    -tao_draw_solution option
1665a7e14dcfSSatish Balay 
1666441846f8SBarry Smith    Collective on Tao
1667a7e14dcfSSatish Balay 
1668a7e14dcfSSatish Balay    Input Parameters:
1669441846f8SBarry Smith +  tao - the Tao context
1670e882e171SHong Zhang -  ctx - TaoMonitorDraw context
1671a7e14dcfSSatish Balay 
1672a7e14dcfSSatish Balay    Options Database Keys:
1673a7e14dcfSSatish Balay .  -tao_draw_solution
1674a7e14dcfSSatish Balay 
1675a7e14dcfSSatish Balay    Level: advanced
1676a7e14dcfSSatish Balay 
1677a7e14dcfSSatish Balay .seealso: TaoSolutionMonitor(), TaoSetMonitor(), TaoDrawGradientMonitor
1678a7e14dcfSSatish Balay @*/
1679441846f8SBarry Smith PetscErrorCode TaoDrawSolutionMonitor(Tao tao, void *ctx)
1680a7e14dcfSSatish Balay {
1681a7e14dcfSSatish Balay   PetscErrorCode    ierr;
1682e882e171SHong Zhang   TaoMonitorDrawCtx ictx = (TaoMonitorDrawCtx)ctx;
168347a47007SBarry Smith 
1684a7e14dcfSSatish Balay   PetscFunctionBegin;
1685e882e171SHong Zhang   if (!(((ictx->howoften > 0) && (!(tao->niter % ictx->howoften))) || ((ictx->howoften == -1) && tao->reason))) PetscFunctionReturn(0);
1686e882e171SHong Zhang   ierr = VecView(tao->solution,ictx->viewer);CHKERRQ(ierr);
1687a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1688a7e14dcfSSatish Balay }
1689a7e14dcfSSatish Balay 
1690a7e14dcfSSatish Balay /*@C
1691a7e14dcfSSatish Balay    TaoDrawGradientMonitor - Plots the gradient at each iteration
1692a7e14dcfSSatish Balay    It can be turned on from the command line using the
1693a7e14dcfSSatish Balay    -tao_draw_gradient option
1694a7e14dcfSSatish Balay 
1695441846f8SBarry Smith    Collective on Tao
1696a7e14dcfSSatish Balay 
1697a7e14dcfSSatish Balay    Input Parameters:
1698441846f8SBarry Smith +  tao - the Tao context
1699f55353a2SBarry Smith -  ctx - PetscViewer context
1700a7e14dcfSSatish Balay 
1701a7e14dcfSSatish Balay    Options Database Keys:
1702a7e14dcfSSatish Balay .  -tao_draw_gradient
1703a7e14dcfSSatish Balay 
1704a7e14dcfSSatish Balay    Level: advanced
1705a7e14dcfSSatish Balay 
1706a7e14dcfSSatish Balay .seealso: TaoGradientMonitor(), TaoSetMonitor(), TaoDrawSolutionMonitor
1707a7e14dcfSSatish Balay @*/
1708441846f8SBarry Smith PetscErrorCode TaoDrawGradientMonitor(Tao tao, void *ctx)
1709a7e14dcfSSatish Balay {
1710a7e14dcfSSatish Balay   PetscErrorCode    ierr;
1711e882e171SHong Zhang   TaoMonitorDrawCtx ictx = (TaoMonitorDrawCtx)ctx;
171247a47007SBarry Smith 
1713a7e14dcfSSatish Balay   PetscFunctionBegin;
1714e882e171SHong Zhang   if (!(((ictx->howoften > 0) && (!(tao->niter % ictx->howoften))) || ((ictx->howoften == -1) && tao->reason))) PetscFunctionReturn(0);
1715e882e171SHong Zhang   ierr = VecView(tao->gradient,ictx->viewer);CHKERRQ(ierr);
1716a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1717a7e14dcfSSatish Balay }
1718a7e14dcfSSatish Balay 
1719a7e14dcfSSatish Balay /*@C
1720a7e14dcfSSatish Balay    TaoDrawStepMonitor - Plots the step direction at each iteration
1721a7e14dcfSSatish Balay    It can be turned on from the command line using the
1722a7e14dcfSSatish Balay    -tao_draw_step option
1723a7e14dcfSSatish Balay 
1724441846f8SBarry Smith    Collective on Tao
1725a7e14dcfSSatish Balay 
1726a7e14dcfSSatish Balay    Input Parameters:
1727441846f8SBarry Smith +  tao - the Tao context
1728f55353a2SBarry Smith -  ctx - PetscViewer context
1729a7e14dcfSSatish Balay 
1730a7e14dcfSSatish Balay    Options Database Keys:
1731a7e14dcfSSatish Balay .  -tao_draw_step
1732a7e14dcfSSatish Balay 
1733a7e14dcfSSatish Balay    Level: advanced
1734a7e14dcfSSatish Balay 
1735a7e14dcfSSatish Balay .seealso: TaoSetMonitor(), TaoDrawSolutionMonitor
1736a7e14dcfSSatish Balay @*/
1737441846f8SBarry Smith PetscErrorCode TaoDrawStepMonitor(Tao tao, void *ctx)
1738a7e14dcfSSatish Balay {
1739a7e14dcfSSatish Balay   PetscErrorCode ierr;
1740a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer)(ctx);
174147a47007SBarry Smith 
1742a7e14dcfSSatish Balay   PetscFunctionBegin;
1743a7e14dcfSSatish Balay   ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr);
1744a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1745a7e14dcfSSatish Balay }
1746a7e14dcfSSatish Balay 
1747a7e14dcfSSatish Balay /*@C
1748a7e14dcfSSatish Balay    TaoSeparableObjectiveMonitor - Views the separable objective function at each iteration
1749a7e14dcfSSatish Balay    It can be turned on from the command line using the
1750a7e14dcfSSatish Balay    -tao_view_separableobjective option
1751a7e14dcfSSatish Balay 
1752441846f8SBarry Smith    Collective on Tao
1753a7e14dcfSSatish Balay 
1754a7e14dcfSSatish Balay    Input Parameters:
1755441846f8SBarry Smith +  tao - the Tao context
175647a47007SBarry Smith -  ctx - PetscViewer context or NULL
1757a7e14dcfSSatish Balay 
1758a7e14dcfSSatish Balay    Options Database Keys:
1759a7e14dcfSSatish Balay .  -tao_view_separableobjective
1760a7e14dcfSSatish Balay 
1761a7e14dcfSSatish Balay    Level: advanced
1762a7e14dcfSSatish Balay 
1763a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1764a7e14dcfSSatish Balay @*/
1765441846f8SBarry Smith PetscErrorCode TaoSeparableObjectiveMonitor(Tao tao, void *ctx)
1766a7e14dcfSSatish Balay {
1767a7e14dcfSSatish Balay   PetscErrorCode ierr;
1768d393f493SBarry Smith   PetscViewer    viewer  = (PetscViewer)ctx;
176947a47007SBarry Smith 
1770a7e14dcfSSatish Balay   PetscFunctionBegin;
1771d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1772a7e14dcfSSatish Balay   ierr = VecView(tao->sep_objective,viewer);CHKERRQ(ierr);
1773a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1774a7e14dcfSSatish Balay }
1775a7e14dcfSSatish Balay 
17767fab98ebSJason Sarich /*@
1777a7e14dcfSSatish Balay    TaoDefaultConvergenceTest - Determines whether the solver should continue iterating
1778a7e14dcfSSatish Balay    or terminate.
1779a7e14dcfSSatish Balay 
1780441846f8SBarry Smith    Collective on Tao
1781a7e14dcfSSatish Balay 
1782a7e14dcfSSatish Balay    Input Parameters:
1783441846f8SBarry Smith +  tao - the Tao context
1784a7e14dcfSSatish Balay -  dummy - unused dummy context
1785a7e14dcfSSatish Balay 
1786a7e14dcfSSatish Balay    Output Parameter:
1787a7e14dcfSSatish Balay .  reason - for terminating
1788a7e14dcfSSatish Balay 
1789a7e14dcfSSatish Balay    Notes:
1790a7e14dcfSSatish Balay    This routine checks the residual in the optimality conditions, the
1791a7e14dcfSSatish Balay    relative residual in the optimity conditions, the number of function
1792a7e14dcfSSatish Balay    evaluations, and the function value to test convergence.  Some
1793a7e14dcfSSatish Balay    solvers may use different convergence routines.
1794a7e14dcfSSatish Balay 
1795a7e14dcfSSatish Balay    Level: developer
1796a7e14dcfSSatish Balay 
1797e4cb33bbSBarry Smith .seealso: TaoSetTolerances(),TaoGetConvergedReason(),TaoSetConvergedReason()
1798a7e14dcfSSatish Balay @*/
1799a7e14dcfSSatish Balay 
1800441846f8SBarry Smith PetscErrorCode TaoDefaultConvergenceTest(Tao tao,void *dummy)
1801a7e14dcfSSatish Balay {
1802a7e14dcfSSatish Balay   PetscInt           niter=tao->niter, nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads);
1803a7e14dcfSSatish Balay   PetscInt           max_funcs=tao->max_funcs;
1804a7e14dcfSSatish Balay   PetscReal          gnorm=tao->residual, gnorm0=tao->gnorm0;
1805a7e14dcfSSatish Balay   PetscReal          f=tao->fc, steptol=tao->steptol,trradius=tao->step;
1806a7e14dcfSSatish Balay   PetscReal          gatol=tao->gatol,grtol=tao->grtol,gttol=tao->gttol;
1807e52336cbSBarry Smith   PetscReal          catol=tao->catol,crtol=tao->crtol;
1808e52336cbSBarry Smith   PetscReal          fmin=tao->fmin, cnorm=tao->cnorm;
1809e4cb33bbSBarry Smith   TaoConvergedReason reason=tao->reason;
1810a7e14dcfSSatish Balay   PetscErrorCode     ierr;
1811a7e14dcfSSatish Balay 
1812a7e14dcfSSatish Balay   PetscFunctionBegin;
1813441846f8SBarry Smith   PetscValidHeaderSpecific(tao, TAO_CLASSID,1);
1814a7e14dcfSSatish Balay   if (reason != TAO_CONTINUE_ITERATING) {
1815a7e14dcfSSatish Balay     PetscFunctionReturn(0);
1816a7e14dcfSSatish Balay   }
1817a7e14dcfSSatish Balay 
1818a7e14dcfSSatish Balay   if (PetscIsInfOrNanReal(f)) {
1819a7e14dcfSSatish Balay     ierr = PetscInfo(tao,"Failed to converged, function value is Inf or NaN\n");CHKERRQ(ierr);
1820a7e14dcfSSatish Balay     reason = TAO_DIVERGED_NAN;
1821a7e14dcfSSatish Balay   } else if (f <= fmin && cnorm <=catol) {
182247a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to function value %g < minimum function value %g\n", (double)f,(double)fmin);CHKERRQ(ierr);
1823a7e14dcfSSatish Balay     reason = TAO_CONVERGED_MINF;
1824a7e14dcfSSatish Balay   } else if (gnorm<= gatol && cnorm <=catol) {
182547a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to residual norm ||g(X)||=%g < %g\n",(double)gnorm,(double)gatol);CHKERRQ(ierr);
1826a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GATOL;
1827a7e14dcfSSatish Balay   } else if ( f!=0 && PetscAbsReal(gnorm/f) <= grtol && cnorm <= crtol) {
182847a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to residual ||g(X)||/|f(X)| =%g < %g\n",(double)(gnorm/f),(double)grtol);CHKERRQ(ierr);
1829a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GRTOL;
1830e1d16bb9SBarry Smith   } else if (gnorm0 != 0 && ((gttol == 0 && gnorm == 0) || gnorm/gnorm0 < gttol) && cnorm <= crtol) {
183147a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to relative residual norm ||g(X)||/||g(X0)|| = %g < %g\n",(double)(gnorm/gnorm0),(double)gttol);CHKERRQ(ierr);
1832a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GTTOL;
1833a7e14dcfSSatish Balay   } else if (nfuncs > max_funcs){
1834a7e14dcfSSatish Balay     ierr = PetscInfo2(tao,"Exceeded maximum number of function evaluations: %D > %D\n", nfuncs,max_funcs);CHKERRQ(ierr);
1835a7e14dcfSSatish Balay     reason = TAO_DIVERGED_MAXFCN;
1836a7e14dcfSSatish Balay   } else if ( tao->lsflag != 0 ){
1837a7e14dcfSSatish Balay     ierr = PetscInfo(tao,"Tao Line Search failure.\n");CHKERRQ(ierr);
1838a7e14dcfSSatish Balay     reason = TAO_DIVERGED_LS_FAILURE;
1839a7e14dcfSSatish Balay   } else if (trradius < steptol && niter > 0){
184047a47007SBarry Smith     ierr = PetscInfo2(tao,"Trust region/step size too small: %g < %g\n", (double)trradius,(double)steptol);CHKERRQ(ierr);
1841a7e14dcfSSatish Balay     reason = TAO_CONVERGED_STEPTOL;
1842a7e14dcfSSatish Balay   } else if (niter > tao->max_it) {
1843a7e14dcfSSatish Balay     ierr = PetscInfo2(tao,"Exceeded maximum number of iterations: %D > %D\n",niter,tao->max_it);CHKERRQ(ierr);
1844a7e14dcfSSatish Balay     reason = TAO_DIVERGED_MAXITS;
1845a7e14dcfSSatish Balay   } else {
1846a7e14dcfSSatish Balay     reason = TAO_CONTINUE_ITERATING;
1847a7e14dcfSSatish Balay   }
1848a7e14dcfSSatish Balay   tao->reason = reason;
1849a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1850a7e14dcfSSatish Balay }
1851a7e14dcfSSatish Balay 
1852a7e14dcfSSatish Balay /*@C
1853a7e14dcfSSatish Balay    TaoSetOptionsPrefix - Sets the prefix used for searching for all
1854a7e14dcfSSatish Balay    TAO options in the database.
1855a7e14dcfSSatish Balay 
1856a7e14dcfSSatish Balay 
1857441846f8SBarry Smith    Logically Collective on Tao
1858a7e14dcfSSatish Balay 
1859a7e14dcfSSatish Balay    Input Parameters:
1860441846f8SBarry Smith +  tao - the Tao context
1861a7e14dcfSSatish Balay -  prefix - the prefix string to prepend to all TAO option requests
1862a7e14dcfSSatish Balay 
1863a7e14dcfSSatish Balay    Notes:
1864a7e14dcfSSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
1865a7e14dcfSSatish Balay    The first character of all runtime options is AUTOMATICALLY the hyphen.
1866a7e14dcfSSatish Balay 
1867a7e14dcfSSatish Balay    For example, to distinguish between the runtime options for two
1868a7e14dcfSSatish Balay    different TAO solvers, one could call
1869a7e14dcfSSatish Balay .vb
1870a7e14dcfSSatish Balay       TaoSetOptionsPrefix(tao1,"sys1_")
1871a7e14dcfSSatish Balay       TaoSetOptionsPrefix(tao2,"sys2_")
1872a7e14dcfSSatish Balay .ve
1873a7e14dcfSSatish Balay 
1874a7e14dcfSSatish Balay    This would enable use of different options for each system, such as
1875a7e14dcfSSatish Balay .vb
1876a7e14dcfSSatish Balay       -sys1_tao_method blmvm -sys1_tao_gtol 1.e-3
1877a7e14dcfSSatish Balay       -sys2_tao_method lmvm  -sys2_tao_gtol 1.e-4
1878a7e14dcfSSatish Balay .ve
1879a7e14dcfSSatish Balay 
1880a7e14dcfSSatish Balay 
1881a7e14dcfSSatish Balay    Level: advanced
1882a7e14dcfSSatish Balay 
1883a7e14dcfSSatish Balay .seealso: TaoAppendOptionsPrefix(), TaoGetOptionsPrefix()
1884a7e14dcfSSatish Balay @*/
1885a7e14dcfSSatish Balay 
1886441846f8SBarry Smith PetscErrorCode TaoSetOptionsPrefix(Tao tao, const char p[])
1887a7e14dcfSSatish Balay {
1888a7e14dcfSSatish Balay   PetscErrorCode ierr;
188947a47007SBarry Smith 
1890a7e14dcfSSatish Balay   PetscFunctionBegin;
1891a7e14dcfSSatish Balay   ierr = PetscObjectSetOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr);
1892a7e14dcfSSatish Balay   if (tao->linesearch) {
1893a7e14dcfSSatish Balay     ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr);
1894a7e14dcfSSatish Balay   }
1895a7e14dcfSSatish Balay   if (tao->ksp) {
1896a7e14dcfSSatish Balay     ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr);
1897a7e14dcfSSatish Balay   }
1898a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1899a7e14dcfSSatish Balay }
1900a7e14dcfSSatish Balay 
1901a7e14dcfSSatish Balay /*@C
1902a7e14dcfSSatish Balay    TaoAppendOptionsPrefix - Appends to the prefix used for searching for all
1903a7e14dcfSSatish Balay    TAO options in the database.
1904a7e14dcfSSatish Balay 
1905a7e14dcfSSatish Balay 
1906441846f8SBarry Smith    Logically Collective on Tao
1907a7e14dcfSSatish Balay 
1908a7e14dcfSSatish Balay    Input Parameters:
1909441846f8SBarry Smith +  tao - the Tao solver context
1910a7e14dcfSSatish Balay -  prefix - the prefix string to prepend to all TAO option requests
1911a7e14dcfSSatish Balay 
1912a7e14dcfSSatish Balay    Notes:
1913a7e14dcfSSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
1914a7e14dcfSSatish Balay    The first character of all runtime options is AUTOMATICALLY the hyphen.
1915a7e14dcfSSatish Balay 
1916a7e14dcfSSatish Balay 
1917a7e14dcfSSatish Balay    Level: advanced
1918a7e14dcfSSatish Balay 
1919a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoGetOptionsPrefix()
1920a7e14dcfSSatish Balay @*/
1921441846f8SBarry Smith PetscErrorCode TaoAppendOptionsPrefix(Tao tao, const char p[])
1922a7e14dcfSSatish Balay {
1923a7e14dcfSSatish Balay   PetscErrorCode ierr;
192447a47007SBarry Smith 
1925a7e14dcfSSatish Balay   PetscFunctionBegin;
1926a7e14dcfSSatish Balay   ierr = PetscObjectAppendOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr);
1927a7e14dcfSSatish Balay   if (tao->linesearch) {
1928a7e14dcfSSatish Balay     ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr);
1929a7e14dcfSSatish Balay   }
1930a7e14dcfSSatish Balay   if (tao->ksp) {
1931a7e14dcfSSatish Balay     ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr);
1932a7e14dcfSSatish Balay   }
1933a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1934a7e14dcfSSatish Balay }
1935a7e14dcfSSatish Balay 
1936a7e14dcfSSatish Balay /*@C
1937a7e14dcfSSatish Balay   TaoGetOptionsPrefix - Gets the prefix used for searching for all
1938a7e14dcfSSatish Balay   TAO options in the database
1939a7e14dcfSSatish Balay 
1940a7e14dcfSSatish Balay   Not Collective
1941a7e14dcfSSatish Balay 
1942a7e14dcfSSatish Balay   Input Parameters:
1943441846f8SBarry Smith . tao - the Tao context
1944a7e14dcfSSatish Balay 
1945a7e14dcfSSatish Balay   Output Parameters:
1946a7e14dcfSSatish Balay . prefix - pointer to the prefix string used is returned
1947a7e14dcfSSatish Balay 
1948a7e14dcfSSatish Balay   Notes: On the fortran side, the user should pass in a string 'prefix' of
1949a7e14dcfSSatish Balay   sufficient length to hold the prefix.
1950a7e14dcfSSatish Balay 
1951a7e14dcfSSatish Balay   Level: advanced
1952a7e14dcfSSatish Balay 
1953a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoAppendOptionsPrefix()
1954a7e14dcfSSatish Balay @*/
1955441846f8SBarry Smith PetscErrorCode TaoGetOptionsPrefix(Tao tao, const char *p[])
1956a7e14dcfSSatish Balay {
195747a47007SBarry Smith    return PetscObjectGetOptionsPrefix((PetscObject)tao,p);
1958a7e14dcfSSatish Balay }
1959a7e14dcfSSatish Balay 
1960a7e14dcfSSatish Balay /*@C
1961a7e14dcfSSatish Balay    TaoSetType - Sets the method for the unconstrained minimization solver.
1962a7e14dcfSSatish Balay 
1963441846f8SBarry Smith    Collective on Tao
1964a7e14dcfSSatish Balay 
1965a7e14dcfSSatish Balay    Input Parameters:
1966441846f8SBarry Smith +  solver - the Tao solver context
1967a7e14dcfSSatish Balay -  type - a known method
1968a7e14dcfSSatish Balay 
1969a7e14dcfSSatish Balay    Options Database Key:
197058417fe7SBarry Smith .  -tao_type <type> - Sets the method; use -help for a list
197158417fe7SBarry Smith    of available methods (for instance, "-tao_type lmvm" or "-tao_type tron")
1972a7e14dcfSSatish Balay 
1973a7e14dcfSSatish Balay    Available methods include:
197458417fe7SBarry Smith +    nls - Newton's method with line search for unconstrained minimization
197558417fe7SBarry Smith .    ntr - Newton's method with trust region for unconstrained minimization
197658417fe7SBarry Smith .    ntl - Newton's method with trust region, line search for unconstrained minimization
197758417fe7SBarry Smith .    lmvm - Limited memory variable metric method for unconstrained minimization
197858417fe7SBarry Smith .    cg - Nonlinear conjugate gradient method for unconstrained minimization
197958417fe7SBarry Smith .    nm - Nelder-Mead algorithm for derivate-free unconstrained minimization
198058417fe7SBarry Smith .    tron - Newton Trust Region method for bound constrained minimization
198158417fe7SBarry Smith .    gpcg - Newton Trust Region method for quadratic bound constrained minimization
198258417fe7SBarry Smith .    blmvm - Limited memory variable metric method for bound constrained minimization
19831eb8069cSJason Sarich -    pounders - Model-based algorithm pounder extended for nonlinear least squares
1984a7e14dcfSSatish Balay 
1985a7e14dcfSSatish Balay   Level: intermediate
1986a7e14dcfSSatish Balay 
19871eb8069cSJason Sarich .seealso: TaoCreate(), TaoGetType(), TaoType
1988a7e14dcfSSatish Balay 
1989a7e14dcfSSatish Balay @*/
1990441846f8SBarry Smith PetscErrorCode TaoSetType(Tao tao, const TaoType type)
1991a7e14dcfSSatish Balay {
1992a7e14dcfSSatish Balay   PetscErrorCode ierr;
1993441846f8SBarry Smith   PetscErrorCode (*create_xxx)(Tao);
1994a7e14dcfSSatish Balay   PetscBool      issame;
1995a7e14dcfSSatish Balay 
1996a7e14dcfSSatish Balay   PetscFunctionBegin;
1997441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1998a7e14dcfSSatish Balay 
1999a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)tao,type,&issame);CHKERRQ(ierr);
2000a7e14dcfSSatish Balay   if (issame) PetscFunctionReturn(0);
2001a7e14dcfSSatish Balay 
2002441846f8SBarry Smith   ierr = PetscFunctionListFind(TaoList, type, (void(**)(void))&create_xxx);CHKERRQ(ierr);
2003441846f8SBarry Smith   if (!create_xxx) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested Tao type %s",type);
2004a7e14dcfSSatish Balay 
2005a7e14dcfSSatish Balay   /* Destroy the existing solver information */
2006a7e14dcfSSatish Balay   if (tao->ops->destroy) {
2007a7e14dcfSSatish Balay     ierr = (*tao->ops->destroy)(tao);CHKERRQ(ierr);
2008a7e14dcfSSatish Balay   }
2009a7e14dcfSSatish Balay   ierr = KSPDestroy(&tao->ksp);CHKERRQ(ierr);
2010a7e14dcfSSatish Balay   ierr = TaoLineSearchDestroy(&tao->linesearch);CHKERRQ(ierr);
2011a7e14dcfSSatish Balay   ierr = VecDestroy(&tao->gradient);CHKERRQ(ierr);
2012a7e14dcfSSatish Balay   ierr = VecDestroy(&tao->stepdirection);CHKERRQ(ierr);
2013a7e14dcfSSatish Balay 
2014a7e14dcfSSatish Balay   tao->ops->setup = 0;
2015a7e14dcfSSatish Balay   tao->ops->solve = 0;
2016a7e14dcfSSatish Balay   tao->ops->view  = 0;
2017a7e14dcfSSatish Balay   tao->ops->setfromoptions = 0;
2018a7e14dcfSSatish Balay   tao->ops->destroy = 0;
2019a7e14dcfSSatish Balay 
2020a7e14dcfSSatish Balay   tao->setupcalled = PETSC_FALSE;
2021a7e14dcfSSatish Balay 
2022a7e14dcfSSatish Balay   ierr = (*create_xxx)(tao);CHKERRQ(ierr);
2023a7e14dcfSSatish Balay   ierr = PetscObjectChangeTypeName((PetscObject)tao,type);CHKERRQ(ierr);
2024a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2025a7e14dcfSSatish Balay }
202647a47007SBarry Smith 
2027a7e14dcfSSatish Balay /*MC
2028441846f8SBarry Smith    TaoRegister - Adds a method to the TAO package for unconstrained minimization.
2029a7e14dcfSSatish Balay 
2030a7e14dcfSSatish Balay    Synopsis:
2031441846f8SBarry Smith    TaoRegister(char *name_solver,char *path,char *name_Create,int (*routine_Create)(Tao))
2032a7e14dcfSSatish Balay 
2033a7e14dcfSSatish Balay    Not collective
2034a7e14dcfSSatish Balay 
2035a7e14dcfSSatish Balay    Input Parameters:
2036a7e14dcfSSatish Balay +  sname - name of a new user-defined solver
2037a7e14dcfSSatish Balay -  func - routine to Create method context
2038a7e14dcfSSatish Balay 
2039a7e14dcfSSatish Balay    Notes:
2040441846f8SBarry Smith    TaoRegister() may be called multiple times to add several user-defined solvers.
2041a7e14dcfSSatish Balay 
2042a7e14dcfSSatish Balay    Sample usage:
2043a7e14dcfSSatish Balay .vb
2044441846f8SBarry Smith    TaoRegister("my_solver",MySolverCreate);
2045a7e14dcfSSatish Balay .ve
2046a7e14dcfSSatish Balay 
2047a7e14dcfSSatish Balay    Then, your solver can be chosen with the procedural interface via
2048a7e14dcfSSatish Balay $     TaoSetType(tao,"my_solver")
2049a7e14dcfSSatish Balay    or at runtime via the option
205058417fe7SBarry Smith $     -tao_type my_solver
2051a7e14dcfSSatish Balay 
2052a7e14dcfSSatish Balay    Level: advanced
2053a7e14dcfSSatish Balay 
2054441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegisterDestroy()
2055a7e14dcfSSatish Balay M*/
2056441846f8SBarry Smith PetscErrorCode TaoRegister(const char sname[], PetscErrorCode (*func)(Tao))
2057a7e14dcfSSatish Balay {
2058a7e14dcfSSatish Balay   PetscErrorCode ierr;
2059a7e14dcfSSatish Balay 
2060a7e14dcfSSatish Balay   PetscFunctionBegin;
2061441846f8SBarry Smith   ierr = PetscFunctionListAdd(&TaoList,sname, (void (*)(void))func);CHKERRQ(ierr);
2062a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2063a7e14dcfSSatish Balay }
2064a7e14dcfSSatish Balay 
2065a7e14dcfSSatish Balay /*@C
2066441846f8SBarry Smith    TaoRegisterDestroy - Frees the list of minimization solvers that were
2067441846f8SBarry Smith    registered by TaoRegisterDynamic().
2068a7e14dcfSSatish Balay 
2069a7e14dcfSSatish Balay    Not Collective
2070a7e14dcfSSatish Balay 
2071a7e14dcfSSatish Balay    Level: advanced
2072a7e14dcfSSatish Balay 
2073441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegister()
2074a7e14dcfSSatish Balay @*/
2075441846f8SBarry Smith PetscErrorCode TaoRegisterDestroy(void)
2076a7e14dcfSSatish Balay {
2077a7e14dcfSSatish Balay   PetscErrorCode ierr;
2078a7e14dcfSSatish Balay   PetscFunctionBegin;
2079441846f8SBarry Smith   ierr = PetscFunctionListDestroy(&TaoList);CHKERRQ(ierr);
2080441846f8SBarry Smith   TaoRegisterAllCalled = PETSC_FALSE;
2081a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2082a7e14dcfSSatish Balay }
208347a47007SBarry Smith 
20848931d482SJason Sarich /*@
20858931d482SJason Sarich    TaoGetIterationNumber - Gets the number of Tao iterations completed
20868931d482SJason Sarich    at this time.
20878931d482SJason Sarich 
20888931d482SJason Sarich    Not Collective
20898931d482SJason Sarich 
20908931d482SJason Sarich    Input Parameter:
20918931d482SJason Sarich .  tao - Tao context
20928931d482SJason Sarich 
20938931d482SJason Sarich    Output Parameter:
20948931d482SJason Sarich .  iter - iteration number
20958931d482SJason Sarich 
20968931d482SJason Sarich    Notes:
20978931d482SJason Sarich    For example, during the computation of iteration 2 this would return 1.
20988931d482SJason Sarich 
20998931d482SJason Sarich 
21008931d482SJason Sarich    Level: intermediate
21018931d482SJason Sarich 
21028931d482SJason Sarich .keywords: Tao, nonlinear, get, iteration, number,
21038931d482SJason Sarich 
2104*79f5d8caSBarry Smith .seealso:   TaoGetLinearSolveIterations(), TaoGetResidualNorm(), TaoGetObjective()
21058931d482SJason Sarich @*/
21068931d482SJason Sarich PetscErrorCode  TaoGetIterationNumber(Tao tao,PetscInt *iter)
21078931d482SJason Sarich {
21088931d482SJason Sarich   PetscFunctionBegin;
21098931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
21108931d482SJason Sarich   PetscValidIntPointer(iter,2);
21118931d482SJason Sarich   *iter = tao->niter;
21128931d482SJason Sarich   PetscFunctionReturn(0);
21138931d482SJason Sarich }
21148931d482SJason Sarich 
21158931d482SJason Sarich /*@
2116*79f5d8caSBarry Smith    TaoGetObjective - Gets the current value of the objective function
2117*79f5d8caSBarry Smith    at this time.
2118*79f5d8caSBarry Smith 
2119*79f5d8caSBarry Smith    Not Collective
2120*79f5d8caSBarry Smith 
2121*79f5d8caSBarry Smith    Input Parameter:
2122*79f5d8caSBarry Smith .  tao - Tao context
2123*79f5d8caSBarry Smith 
2124*79f5d8caSBarry Smith    Output Parameter:
2125*79f5d8caSBarry Smith .  value - the current value
2126*79f5d8caSBarry Smith 
2127*79f5d8caSBarry Smith    Level: intermediate
2128*79f5d8caSBarry Smith 
2129*79f5d8caSBarry Smith .keywords: Tao, nonlinear, get, iteration, number,
2130*79f5d8caSBarry Smith 
2131*79f5d8caSBarry Smith .seealso:   TaoGetLinearSolveIterations(), TaoGetIterationNumber(), TaoGetResidualNorm()
2132*79f5d8caSBarry Smith @*/
2133*79f5d8caSBarry Smith PetscErrorCode  TaoGetObjective(Tao tao,PetscReal *value)
2134*79f5d8caSBarry Smith {
2135*79f5d8caSBarry Smith   PetscFunctionBegin;
2136*79f5d8caSBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2137*79f5d8caSBarry Smith   PetscValidRealPointer(value,2);
2138*79f5d8caSBarry Smith   *value = tao->fc;
2139*79f5d8caSBarry Smith   PetscFunctionReturn(0);
2140*79f5d8caSBarry Smith }
2141*79f5d8caSBarry Smith 
2142*79f5d8caSBarry Smith /*@
2143*79f5d8caSBarry Smith    TaoGetResidualNorm - Gets the current value of the norm of the residual
2144*79f5d8caSBarry Smith    at this time.
2145*79f5d8caSBarry Smith 
2146*79f5d8caSBarry Smith    Not Collective
2147*79f5d8caSBarry Smith 
2148*79f5d8caSBarry Smith    Input Parameter:
2149*79f5d8caSBarry Smith .  tao - Tao context
2150*79f5d8caSBarry Smith 
2151*79f5d8caSBarry Smith    Output Parameter:
2152*79f5d8caSBarry Smith .  value - the current value
2153*79f5d8caSBarry Smith 
2154*79f5d8caSBarry Smith    Level: intermediate
2155*79f5d8caSBarry Smith 
2156*79f5d8caSBarry Smith    Developer Note: This is the 2-norm of the residual, we cannot use TaoGetGradientNorm() because that has
2157*79f5d8caSBarry Smith                    a different meaning. For some reason Tao sometimes calls the gradient the residual.
2158*79f5d8caSBarry Smith 
2159*79f5d8caSBarry Smith .keywords: Tao, nonlinear, get, iteration, number,
2160*79f5d8caSBarry Smith 
2161*79f5d8caSBarry Smith .seealso:   TaoGetLinearSolveIterations(), TaoGetIterationNumber(), TaoGetObjective()
2162*79f5d8caSBarry Smith @*/
2163*79f5d8caSBarry Smith PetscErrorCode  TaoGetResidualNorm(Tao tao,PetscReal *value)
2164*79f5d8caSBarry Smith {
2165*79f5d8caSBarry Smith   PetscFunctionBegin;
2166*79f5d8caSBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2167*79f5d8caSBarry Smith   PetscValidRealPointer(value,2);
2168*79f5d8caSBarry Smith   *value = tao->residual;
2169*79f5d8caSBarry Smith   PetscFunctionReturn(0);
2170*79f5d8caSBarry Smith }
2171*79f5d8caSBarry Smith 
2172*79f5d8caSBarry Smith /*@
21738931d482SJason Sarich    TaoSetIterationNumber - Sets the current iteration number.
21748931d482SJason Sarich 
21758931d482SJason Sarich    Not Collective
21768931d482SJason Sarich 
21778931d482SJason Sarich    Input Parameter:
21788931d482SJason Sarich .  tao - Tao context
21798931d482SJason Sarich .  iter - iteration number
21808931d482SJason Sarich 
21818931d482SJason Sarich    Level: developer
21828931d482SJason Sarich 
21838931d482SJason Sarich .keywords: Tao, nonlinear, set, iteration, number,
21848931d482SJason Sarich 
21858931d482SJason Sarich .seealso:   TaoGetLinearSolveIterations()
21868931d482SJason Sarich @*/
21878931d482SJason Sarich PetscErrorCode  TaoSetIterationNumber(Tao tao,PetscInt iter)
21888931d482SJason Sarich {
21898931d482SJason Sarich   PetscErrorCode ierr;
21908931d482SJason Sarich 
21918931d482SJason Sarich   PetscFunctionBegin;
21928931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
21938931d482SJason Sarich   ierr       = PetscObjectSAWsTakeAccess((PetscObject)tao);CHKERRQ(ierr);
21948931d482SJason Sarich   tao->niter = iter;
21958931d482SJason Sarich   ierr       = PetscObjectSAWsGrantAccess((PetscObject)tao);CHKERRQ(ierr);
21968931d482SJason Sarich   PetscFunctionReturn(0);
21978931d482SJason Sarich }
21988931d482SJason Sarich 
21998931d482SJason Sarich /*@
22008931d482SJason Sarich    TaoGetTotalIterationNumber - Gets the total number of Tao iterations
22018931d482SJason Sarich    completed. This number keeps accumulating if multiple solves
22028931d482SJason Sarich    are called with the Tao object.
22038931d482SJason Sarich 
22048931d482SJason Sarich    Not Collective
22058931d482SJason Sarich 
22068931d482SJason Sarich    Input Parameter:
22078931d482SJason Sarich .  tao - Tao context
22088931d482SJason Sarich 
22098931d482SJason Sarich    Output Parameter:
22108931d482SJason Sarich .  iter - iteration number
22118931d482SJason Sarich 
22128931d482SJason Sarich    Notes:
22138931d482SJason Sarich    The total iteration count is updated after each solve, if there is a current
22148931d482SJason Sarich    TaoSolve() in progress then those iterations are not yet counted.
22158931d482SJason Sarich 
22168931d482SJason Sarich    Level: intermediate
22178931d482SJason Sarich 
22188931d482SJason Sarich .keywords: Tao, nonlinear, get, iteration, number,
22198931d482SJason Sarich 
22208931d482SJason Sarich .seealso:   TaoGetLinearSolveIterations()
22218931d482SJason Sarich @*/
22228931d482SJason Sarich PetscErrorCode  TaoGetTotalIterationNumber(Tao tao,PetscInt *iter)
22238931d482SJason Sarich {
22248931d482SJason Sarich   PetscFunctionBegin;
22258931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
22268931d482SJason Sarich   PetscValidIntPointer(iter,2);
22278931d482SJason Sarich   *iter = tao->ntotalits;
22288931d482SJason Sarich   PetscFunctionReturn(0);
22298931d482SJason Sarich }
22308931d482SJason Sarich 
22318931d482SJason Sarich /*@
22328931d482SJason Sarich    TaoSetTotalIterationNumber - Sets the current total iteration number.
22338931d482SJason Sarich 
22348931d482SJason Sarich    Not Collective
22358931d482SJason Sarich 
22368931d482SJason Sarich    Input Parameter:
22378931d482SJason Sarich .  tao - Tao context
22388931d482SJason Sarich .  iter - iteration number
22398931d482SJason Sarich 
22408931d482SJason Sarich    Level: developer
22418931d482SJason Sarich 
22428931d482SJason Sarich .keywords: Tao, nonlinear, set, iteration, number,
22438931d482SJason Sarich 
22448931d482SJason Sarich .seealso:   TaoGetLinearSolveIterations()
22458931d482SJason Sarich @*/
22468931d482SJason Sarich PetscErrorCode  TaoSetTotalIterationNumber(Tao tao,PetscInt iter)
22478931d482SJason Sarich {
22488931d482SJason Sarich   PetscErrorCode ierr;
22498931d482SJason Sarich 
22508931d482SJason Sarich   PetscFunctionBegin;
22518931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
22528931d482SJason Sarich   ierr       = PetscObjectSAWsTakeAccess((PetscObject)tao);CHKERRQ(ierr);
22538931d482SJason Sarich   tao->ntotalits = iter;
22548931d482SJason Sarich   ierr       = PetscObjectSAWsGrantAccess((PetscObject)tao);CHKERRQ(ierr);
22558931d482SJason Sarich   PetscFunctionReturn(0);
22568931d482SJason Sarich }
22578931d482SJason Sarich 
2258a7e14dcfSSatish Balay /*@
2259e4cb33bbSBarry Smith   TaoSetConvergedReason - Sets the termination flag on a Tao object
2260a7e14dcfSSatish Balay 
2261441846f8SBarry Smith   Logically Collective on Tao
2262a7e14dcfSSatish Balay 
2263a7e14dcfSSatish Balay   Input Parameters:
2264441846f8SBarry Smith + tao - the Tao context
2265a7e14dcfSSatish Balay - reason - one of
2266a7e14dcfSSatish Balay $     TAO_CONVERGED_ATOL (2),
2267a7e14dcfSSatish Balay $     TAO_CONVERGED_RTOL (3),
2268a7e14dcfSSatish Balay $     TAO_CONVERGED_STEPTOL (4),
2269a7e14dcfSSatish Balay $     TAO_CONVERGED_MINF (5),
2270a7e14dcfSSatish Balay $     TAO_CONVERGED_USER (6),
2271a7e14dcfSSatish Balay $     TAO_DIVERGED_MAXITS (-2),
2272a7e14dcfSSatish Balay $     TAO_DIVERGED_NAN (-4),
2273a7e14dcfSSatish Balay $     TAO_DIVERGED_MAXFCN (-5),
2274a7e14dcfSSatish Balay $     TAO_DIVERGED_LS_FAILURE (-6),
2275a7e14dcfSSatish Balay $     TAO_DIVERGED_TR_REDUCTION (-7),
2276a7e14dcfSSatish Balay $     TAO_DIVERGED_USER (-8),
2277a7e14dcfSSatish Balay $     TAO_CONTINUE_ITERATING (0)
2278a7e14dcfSSatish Balay 
2279a7e14dcfSSatish Balay    Level: intermediate
2280a7e14dcfSSatish Balay 
2281a7e14dcfSSatish Balay @*/
2282e4cb33bbSBarry Smith PetscErrorCode TaoSetConvergedReason(Tao tao, TaoConvergedReason reason)
2283a7e14dcfSSatish Balay {
2284441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2285a7e14dcfSSatish Balay   PetscFunctionBegin;
2286a7e14dcfSSatish Balay   tao->reason = reason;
2287a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2288a7e14dcfSSatish Balay }
2289a7e14dcfSSatish Balay 
2290a7e14dcfSSatish Balay /*@
2291e4cb33bbSBarry Smith    TaoGetConvergedReason - Gets the reason the Tao iteration was stopped.
2292a7e14dcfSSatish Balay 
2293a7e14dcfSSatish Balay    Not Collective
2294a7e14dcfSSatish Balay 
2295a7e14dcfSSatish Balay    Input Parameter:
2296441846f8SBarry Smith .  tao - the Tao solver context
2297a7e14dcfSSatish Balay 
2298a7e14dcfSSatish Balay    Output Parameter:
2299a7e14dcfSSatish Balay .  reason - one of
2300a7e14dcfSSatish Balay $  TAO_CONVERGED_GATOL (3)           ||g(X)|| < gatol
2301a7e14dcfSSatish Balay $  TAO_CONVERGED_GRTOL (4)           ||g(X)|| / f(X)  < grtol
2302a7e14dcfSSatish Balay $  TAO_CONVERGED_GTTOL (5)           ||g(X)|| / ||g(X0)|| < gttol
2303a7e14dcfSSatish Balay $  TAO_CONVERGED_STEPTOL (6)         step size small
2304a7e14dcfSSatish Balay $  TAO_CONVERGED_MINF (7)            F < F_min
2305a7e14dcfSSatish Balay $  TAO_CONVERGED_USER (8)            User defined
2306a7e14dcfSSatish Balay $  TAO_DIVERGED_MAXITS (-2)          its > maxits
2307a7e14dcfSSatish Balay $  TAO_DIVERGED_NAN (-4)             Numerical problems
2308a7e14dcfSSatish Balay $  TAO_DIVERGED_MAXFCN (-5)          fevals > max_funcsals
2309a7e14dcfSSatish Balay $  TAO_DIVERGED_LS_FAILURE (-6)      line search failure
2310a7e14dcfSSatish Balay $  TAO_DIVERGED_TR_REDUCTION (-7)    trust region failure
2311a7e14dcfSSatish Balay $  TAO_DIVERGED_USER(-8)             (user defined)
2312a7e14dcfSSatish Balay  $  TAO_CONTINUE_ITERATING (0)
2313a7e14dcfSSatish Balay 
2314a7e14dcfSSatish Balay    where
2315a7e14dcfSSatish Balay +  X - current solution
2316a7e14dcfSSatish Balay .  X0 - initial guess
2317a7e14dcfSSatish Balay .  f(X) - current function value
2318a7e14dcfSSatish Balay .  f(X*) - true solution (estimated)
2319a7e14dcfSSatish Balay .  g(X) - current gradient
2320a7e14dcfSSatish Balay .  its - current iterate number
2321a7e14dcfSSatish Balay .  maxits - maximum number of iterates
2322a7e14dcfSSatish Balay .  fevals - number of function evaluations
2323a7e14dcfSSatish Balay -  max_funcsals - maximum number of function evaluations
2324a7e14dcfSSatish Balay 
2325a7e14dcfSSatish Balay    Level: intermediate
2326a7e14dcfSSatish Balay 
2327a7e14dcfSSatish Balay .seealso: TaoSetConvergenceTest(), TaoSetTolerances()
2328a7e14dcfSSatish Balay 
2329a7e14dcfSSatish Balay @*/
2330e4cb33bbSBarry Smith PetscErrorCode TaoGetConvergedReason(Tao tao, TaoConvergedReason *reason)
2331a7e14dcfSSatish Balay {
2332a7e14dcfSSatish Balay   PetscFunctionBegin;
2333441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2334a7e14dcfSSatish Balay   PetscValidPointer(reason,2);
2335a7e14dcfSSatish Balay   *reason = tao->reason;
2336a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2337a7e14dcfSSatish Balay }
2338a7e14dcfSSatish Balay 
2339a7e14dcfSSatish Balay /*@
2340a7e14dcfSSatish Balay   TaoGetSolutionStatus - Get the current iterate, objective value,
2341a7e14dcfSSatish Balay   residual, infeasibility, and termination
2342a7e14dcfSSatish Balay 
2343a7e14dcfSSatish Balay   Not Collective
2344a7e14dcfSSatish Balay 
2345a7e14dcfSSatish Balay    Input Parameters:
2346441846f8SBarry Smith .  tao - the Tao context
2347a7e14dcfSSatish Balay 
2348a7e14dcfSSatish Balay    Output Parameters:
2349a7e14dcfSSatish Balay +  iterate - the current iterate number (>=0)
2350a7e14dcfSSatish Balay .  f - the current function value
235158417fe7SBarry Smith .  gnorm - the square of the gradient norm, duality gap, or other measure indicating distance from optimality.
2352a7e14dcfSSatish Balay .  cnorm - the infeasibility of the current solution with regard to the constraints.
2353a7e14dcfSSatish Balay .  xdiff - the step length or trust region radius of the most recent iterate.
2354a7e14dcfSSatish Balay -  reason - The termination reason, which can equal TAO_CONTINUE_ITERATING
2355a7e14dcfSSatish Balay 
2356a7e14dcfSSatish Balay    Level: intermediate
2357a7e14dcfSSatish Balay 
2358a7e14dcfSSatish Balay    Note:
2359a7e14dcfSSatish Balay    TAO returns the values set by the solvers in the routine TaoMonitor().
2360a7e14dcfSSatish Balay 
2361a7e14dcfSSatish Balay    Note:
236247a47007SBarry Smith    If any of the output arguments are set to NULL, no corresponding value will be returned.
2363a7e14dcfSSatish Balay 
2364e4cb33bbSBarry Smith .seealso: TaoMonitor(), TaoGetConvergedReason()
2365a7e14dcfSSatish Balay @*/
2366e4cb33bbSBarry Smith PetscErrorCode TaoGetSolutionStatus(Tao tao, PetscInt *its, PetscReal *f, PetscReal *gnorm, PetscReal *cnorm, PetscReal *xdiff, TaoConvergedReason *reason)
2367a7e14dcfSSatish Balay {
2368a7e14dcfSSatish Balay   PetscFunctionBegin;
2369a7e14dcfSSatish Balay   if (its) *its=tao->niter;
2370a7e14dcfSSatish Balay   if (f) *f=tao->fc;
2371a7e14dcfSSatish Balay   if (gnorm) *gnorm=tao->residual;
2372a7e14dcfSSatish Balay   if (cnorm) *cnorm=tao->cnorm;
2373a7e14dcfSSatish Balay   if (reason) *reason=tao->reason;
2374a7e14dcfSSatish Balay   if (xdiff) *xdiff=tao->step;
2375a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2376a7e14dcfSSatish Balay }
2377a7e14dcfSSatish Balay 
2378a7e14dcfSSatish Balay /*@C
2379441846f8SBarry Smith    TaoGetType - Gets the current Tao algorithm.
2380a7e14dcfSSatish Balay 
2381a7e14dcfSSatish Balay    Not Collective
2382a7e14dcfSSatish Balay 
2383a7e14dcfSSatish Balay    Input Parameter:
2384441846f8SBarry Smith .  tao - the Tao solver context
2385a7e14dcfSSatish Balay 
2386a7e14dcfSSatish Balay    Output Parameter:
2387441846f8SBarry Smith .  type - Tao method
2388a7e14dcfSSatish Balay 
2389a7e14dcfSSatish Balay    Level: intermediate
2390a7e14dcfSSatish Balay 
2391a7e14dcfSSatish Balay @*/
2392441846f8SBarry Smith PetscErrorCode TaoGetType(Tao tao, const TaoType *type)
2393a7e14dcfSSatish Balay {
2394a7e14dcfSSatish Balay   PetscFunctionBegin;
2395441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2396a7e14dcfSSatish Balay   PetscValidPointer(type,2);
2397a7e14dcfSSatish Balay   *type=((PetscObject)tao)->type_name;
2398a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2399a7e14dcfSSatish Balay }
2400a7e14dcfSSatish Balay 
2401a7e14dcfSSatish Balay /*@C
2402a7e14dcfSSatish Balay   TaoMonitor - Monitor the solver and the current solution.  This
2403a7e14dcfSSatish Balay   routine will record the iteration number and residual statistics,
2404a7e14dcfSSatish Balay   call any monitors specified by the user, and calls the convergence-check routine.
2405a7e14dcfSSatish Balay 
2406a7e14dcfSSatish Balay    Input Parameters:
2407441846f8SBarry Smith +  tao - the Tao context
2408a7e14dcfSSatish Balay .  its - the current iterate number (>=0)
2409a7e14dcfSSatish Balay .  f - the current objective function value
241058417fe7SBarry Smith .  res - the gradient norm, square root of the duality gap, or other measure indicating distince from optimality.  This measure will be recorded and
2411a7e14dcfSSatish Balay           used for some termination tests.
2412a7e14dcfSSatish Balay .  cnorm - the infeasibility of the current solution with regard to the constraints.
2413a7e14dcfSSatish Balay -  steplength - multiple of the step direction added to the previous iterate.
2414a7e14dcfSSatish Balay 
2415a7e14dcfSSatish Balay    Output Parameters:
2416a7e14dcfSSatish Balay .  reason - The termination reason, which can equal TAO_CONTINUE_ITERATING
2417a7e14dcfSSatish Balay 
2418a7e14dcfSSatish Balay    Options Database Key:
2419a7e14dcfSSatish Balay .  -tao_monitor - Use the default monitor, which prints statistics to standard output
2420a7e14dcfSSatish Balay 
2421e4cb33bbSBarry Smith .seealso TaoGetConvergedReason(), TaoDefaultMonitor(), TaoSetMonitor()
2422a7e14dcfSSatish Balay 
2423a7e14dcfSSatish Balay    Level: developer
2424a7e14dcfSSatish Balay 
2425a7e14dcfSSatish Balay @*/
2426e4cb33bbSBarry Smith PetscErrorCode TaoMonitor(Tao tao, PetscInt its, PetscReal f, PetscReal res, PetscReal cnorm, PetscReal steplength, TaoConvergedReason *reason)
2427a7e14dcfSSatish Balay {
2428a7e14dcfSSatish Balay   PetscErrorCode ierr;
242947a47007SBarry Smith   PetscInt       i;
243047a47007SBarry Smith 
2431a7e14dcfSSatish Balay   PetscFunctionBegin;
2432441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2433a7e14dcfSSatish Balay   tao->fc = f;
2434a7e14dcfSSatish Balay   tao->residual = res;
2435a7e14dcfSSatish Balay   tao->cnorm = cnorm;
2436a7e14dcfSSatish Balay   tao->step = steplength;
2437e52336cbSBarry Smith   if (!its) {
2438a7e14dcfSSatish Balay     tao->cnorm0 = cnorm; tao->gnorm0 = res;
2439a7e14dcfSSatish Balay   }
2440ae93cb3cSJason Sarich   TaoLogConvergenceHistory(tao,f,res,cnorm,tao->ksp_its);
244147a47007SBarry Smith   if (PetscIsInfOrNanReal(f) || PetscIsInfOrNanReal(res)) SETERRQ(PETSC_COMM_SELF,1, "User provided compute function generated Inf or NaN");
2442a7e14dcfSSatish Balay   if (tao->ops->convergencetest) {
2443a7e14dcfSSatish Balay     ierr = (*tao->ops->convergencetest)(tao,tao->cnvP);CHKERRQ(ierr);
2444a7e14dcfSSatish Balay   }
2445a7e14dcfSSatish Balay   for (i=0;i<tao->numbermonitors;i++) {
2446a7e14dcfSSatish Balay     ierr = (*tao->monitor[i])(tao,tao->monitorcontext[i]);CHKERRQ(ierr);
2447a7e14dcfSSatish Balay   }
2448a7e14dcfSSatish Balay   *reason = tao->reason;
2449a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2450a7e14dcfSSatish Balay }
2451a7e14dcfSSatish Balay 
2452a7e14dcfSSatish Balay /*@
2453ae93cb3cSJason Sarich    TaoSetConvergenceHistory - Sets the array used to hold the convergence history.
2454a7e14dcfSSatish Balay 
2455441846f8SBarry Smith    Logically Collective on Tao
2456a7e14dcfSSatish Balay 
2457a7e14dcfSSatish Balay    Input Parameters:
2458441846f8SBarry Smith +  tao - the Tao solver context
2459a7e14dcfSSatish Balay .  obj   - array to hold objective value history
2460a7e14dcfSSatish Balay .  resid - array to hold residual history
2461a7e14dcfSSatish Balay .  cnorm - array to hold constraint violation history
2462be1558d8SJason Sarich .  lits - integer array holds the number of linear iterations for each Tao iteration
2463a7e14dcfSSatish Balay .  na  - size of obj, resid, and cnorm
2464a7e14dcfSSatish Balay -  reset - PetscTrue indicates each new minimization resets the history counter to zero,
2465a7e14dcfSSatish Balay            else it continues storing new values for new minimizations after the old ones
2466a7e14dcfSSatish Balay 
2467a7e14dcfSSatish Balay    Notes:
2468a7e14dcfSSatish Balay    If set, TAO will fill the given arrays with the indicated
2469ae93cb3cSJason Sarich    information at each iteration.  If 'obj','resid','cnorm','lits' are
2470ae93cb3cSJason Sarich    *all* NULL then space (using size na, or 1000 if na is PETSC_DECIDE or
2471ae93cb3cSJason Sarich    PETSC_DEFAULT) is allocated for the history.
2472be1558d8SJason Sarich    If not all are NULL, then only the non-NULL information categories
2473ae93cb3cSJason Sarich    will be stored, the others will be ignored.
2474ae93cb3cSJason Sarich 
2475ae93cb3cSJason Sarich    Any convergence information after iteration number 'na' will not be stored.
2476a7e14dcfSSatish Balay 
2477a7e14dcfSSatish Balay    This routine is useful, e.g., when running a code for purposes
2478a7e14dcfSSatish Balay    of accurate performance monitoring, when no I/O should be done
2479a7e14dcfSSatish Balay    during the section of code that is being timed.
2480a7e14dcfSSatish Balay 
2481a7e14dcfSSatish Balay    Level: intermediate
2482a7e14dcfSSatish Balay 
2483ae93cb3cSJason Sarich .seealso: TaoGetConvergenceHistory()
2484a7e14dcfSSatish Balay 
2485a7e14dcfSSatish Balay @*/
24861b266c99SBarry Smith PetscErrorCode TaoSetConvergenceHistory(Tao tao, PetscReal obj[], PetscReal resid[], PetscReal cnorm[], PetscInt lits[], PetscInt na,PetscBool reset)
2487a7e14dcfSSatish Balay {
2488ae93cb3cSJason Sarich   PetscErrorCode ierr;
2489ae93cb3cSJason Sarich 
2490a7e14dcfSSatish Balay   PetscFunctionBegin;
2491441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2492ae93cb3cSJason Sarich   if (obj) PetscValidScalarPointer(obj,2);
2493ae93cb3cSJason Sarich   if (resid) PetscValidScalarPointer(resid,3);
2494ae93cb3cSJason Sarich   if (cnorm) PetscValidScalarPointer(cnorm,4);
2495ae93cb3cSJason Sarich   if (lits) PetscValidIntPointer(lits,5);
2496ae93cb3cSJason Sarich 
2497ae93cb3cSJason Sarich   if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000;
2498ae93cb3cSJason Sarich   if (!obj && !resid && !cnorm && !lits) {
2499ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&obj);CHKERRQ(ierr);
2500ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&resid);CHKERRQ(ierr);
2501ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&cnorm);CHKERRQ(ierr);
2502ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&lits);CHKERRQ(ierr);
2503ae93cb3cSJason Sarich     tao->hist_malloc=PETSC_TRUE;
2504ae93cb3cSJason Sarich   }
2505ae93cb3cSJason Sarich 
2506a7e14dcfSSatish Balay   tao->hist_obj = obj;
2507a7e14dcfSSatish Balay   tao->hist_resid = resid;
2508a7e14dcfSSatish Balay   tao->hist_cnorm = cnorm;
2509ae93cb3cSJason Sarich   tao->hist_lits = lits;
2510a7e14dcfSSatish Balay   tao->hist_max   = na;
2511a7e14dcfSSatish Balay   tao->hist_reset = reset;
2512ae93cb3cSJason Sarich   tao->hist_len = 0;
2513a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2514a7e14dcfSSatish Balay }
2515a7e14dcfSSatish Balay 
2516a7e14dcfSSatish Balay /*@C
2517ae93cb3cSJason Sarich    TaoGetConvergenceHistory - Gets the arrays used to hold the convergence history.
2518a7e14dcfSSatish Balay 
2519441846f8SBarry Smith    Collective on Tao
2520a7e14dcfSSatish Balay 
2521a7e14dcfSSatish Balay    Input Parameter:
2522441846f8SBarry Smith .  tao - the Tao context
2523a7e14dcfSSatish Balay 
2524a7e14dcfSSatish Balay    Output Parameters:
2525a7e14dcfSSatish Balay +  obj   - array used to hold objective value history
2526a7e14dcfSSatish Balay .  resid - array used to hold residual history
2527a7e14dcfSSatish Balay .  cnorm - array used to hold constraint violation history
2528ae93cb3cSJason Sarich .  lits  - integer array used to hold linear solver iteration count
2529ae93cb3cSJason Sarich -  nhist  - size of obj, resid, cnorm, and lits (will be less than or equal to na given in TaoSetHistory)
2530a7e14dcfSSatish Balay 
2531a7e14dcfSSatish Balay    Notes:
2532ae93cb3cSJason Sarich     This routine must be preceded by calls to TaoSetConvergenceHistory()
2533ae93cb3cSJason Sarich     and TaoSolve(), otherwise it returns useless information.
2534ae93cb3cSJason Sarich 
2535a7e14dcfSSatish Balay     The calling sequence for this routine in Fortran is
2536ae93cb3cSJason Sarich $   call TaoGetConvergenceHistory(Tao tao, PetscInt nhist, PetscErrorCode ierr)
2537a7e14dcfSSatish Balay 
2538a7e14dcfSSatish Balay    This routine is useful, e.g., when running a code for purposes
2539a7e14dcfSSatish Balay    of accurate performance monitoring, when no I/O should be done
2540a7e14dcfSSatish Balay    during the section of code that is being timed.
2541a7e14dcfSSatish Balay 
2542a7e14dcfSSatish Balay    Level: advanced
2543a7e14dcfSSatish Balay 
2544ae93cb3cSJason Sarich .seealso: TaoSetConvergenceHistory()
2545a7e14dcfSSatish Balay 
2546a7e14dcfSSatish Balay @*/
2547ae93cb3cSJason Sarich PetscErrorCode TaoGetConvergenceHistory(Tao tao, PetscReal **obj, PetscReal **resid, PetscReal **cnorm, PetscInt **lits, PetscInt *nhist)
2548a7e14dcfSSatish Balay {
2549a7e14dcfSSatish Balay   PetscFunctionBegin;
2550441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2551a7e14dcfSSatish Balay   if (obj)   *obj   = tao->hist_obj;
2552a7e14dcfSSatish Balay   if (cnorm) *cnorm = tao->hist_cnorm;
2553a7e14dcfSSatish Balay   if (resid) *resid = tao->hist_resid;
2554a7e14dcfSSatish Balay   if (nhist) *nhist   = tao->hist_len;
2555a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2556a7e14dcfSSatish Balay }
2557a7e14dcfSSatish Balay 
2558a7e14dcfSSatish Balay /*@
2559a7e14dcfSSatish Balay    TaoSetApplicationContext - Sets the optional user-defined context for
2560a7e14dcfSSatish Balay    a solver.
2561a7e14dcfSSatish Balay 
2562441846f8SBarry Smith    Logically Collective on Tao
2563a7e14dcfSSatish Balay 
2564a7e14dcfSSatish Balay    Input Parameters:
2565441846f8SBarry Smith +  tao  - the Tao context
2566a7e14dcfSSatish Balay -  usrP - optional user context
2567a7e14dcfSSatish Balay 
2568a7e14dcfSSatish Balay    Level: intermediate
2569a7e14dcfSSatish Balay 
2570a7e14dcfSSatish Balay .seealso: TaoGetApplicationContext(), TaoSetApplicationContext()
2571a7e14dcfSSatish Balay @*/
2572441846f8SBarry Smith PetscErrorCode  TaoSetApplicationContext(Tao tao,void *usrP)
2573a7e14dcfSSatish Balay {
2574a7e14dcfSSatish Balay   PetscFunctionBegin;
2575441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2576a7e14dcfSSatish Balay   tao->user = usrP;
2577a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2578a7e14dcfSSatish Balay }
2579a7e14dcfSSatish Balay 
2580a7e14dcfSSatish Balay /*@
2581a7e14dcfSSatish Balay    TaoGetApplicationContext - Gets the user-defined context for a
2582a7e14dcfSSatish Balay    TAO solvers.
2583a7e14dcfSSatish Balay 
2584a7e14dcfSSatish Balay    Not Collective
2585a7e14dcfSSatish Balay 
2586a7e14dcfSSatish Balay    Input Parameter:
2587441846f8SBarry Smith .  tao  - Tao context
2588a7e14dcfSSatish Balay 
2589a7e14dcfSSatish Balay    Output Parameter:
2590a7e14dcfSSatish Balay .  usrP - user context
2591a7e14dcfSSatish Balay 
2592a7e14dcfSSatish Balay    Level: intermediate
2593a7e14dcfSSatish Balay 
2594a7e14dcfSSatish Balay .seealso: TaoSetApplicationContext()
2595a7e14dcfSSatish Balay @*/
2596441846f8SBarry Smith PetscErrorCode  TaoGetApplicationContext(Tao tao,void *usrP)
2597a7e14dcfSSatish Balay {
2598a7e14dcfSSatish Balay   PetscFunctionBegin;
2599441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2600a7e14dcfSSatish Balay   *(void**)usrP = tao->user;
2601a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2602a7e14dcfSSatish Balay }
2603a9603a14SPatrick Farrell 
2604a9603a14SPatrick Farrell /*@
2605a9603a14SPatrick Farrell    TaoSetGradientNorm - Sets the matrix used to define the inner product that measures the size of the gradient.
2606a9603a14SPatrick Farrell 
2607a9603a14SPatrick Farrell    Collective on tao
2608a9603a14SPatrick Farrell 
2609a9603a14SPatrick Farrell    Input Parameters:
2610a9603a14SPatrick Farrell +  tao  - the Tao context
2611a9603a14SPatrick Farrell -  M    - gradient norm
2612a9603a14SPatrick Farrell 
2613a9603a14SPatrick Farrell    Level: beginner
2614a9603a14SPatrick Farrell 
2615a9603a14SPatrick Farrell .seealso: TaoGetGradientNorm(), TaoGradientNorm()
2616a9603a14SPatrick Farrell @*/
2617a9603a14SPatrick Farrell PetscErrorCode  TaoSetGradientNorm(Tao tao, Mat M)
2618a9603a14SPatrick Farrell {
2619a9603a14SPatrick Farrell   PetscErrorCode ierr;
2620a9603a14SPatrick Farrell 
2621a9603a14SPatrick Farrell   PetscFunctionBegin;
2622a9603a14SPatrick Farrell   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2623a9603a14SPatrick Farrell 
2624a9603a14SPatrick Farrell   if (tao->gradient_norm) {
2625a9603a14SPatrick Farrell     ierr = PetscObjectDereference((PetscObject)tao->gradient_norm);CHKERRQ(ierr);
2626a9603a14SPatrick Farrell     ierr = VecDestroy(&tao->gradient_norm_tmp);CHKERRQ(ierr);
2627a9603a14SPatrick Farrell   }
2628a9603a14SPatrick Farrell 
2629a9603a14SPatrick Farrell   ierr = PetscObjectReference((PetscObject)M);CHKERRQ(ierr);
2630a9603a14SPatrick Farrell   tao->gradient_norm = M;
2631a9603a14SPatrick Farrell   ierr = MatCreateVecs(M, NULL, &tao->gradient_norm_tmp);CHKERRQ(ierr);
2632a9603a14SPatrick Farrell   PetscFunctionReturn(0);
2633a9603a14SPatrick Farrell }
2634a9603a14SPatrick Farrell 
2635a9603a14SPatrick Farrell /*@
2636a9603a14SPatrick Farrell    TaoGetGradientNorm - Returns the matrix used to define the inner product for measuring the size of the gradient.
2637a9603a14SPatrick Farrell 
2638a9603a14SPatrick Farrell    Not Collective
2639a9603a14SPatrick Farrell 
2640a9603a14SPatrick Farrell    Input Parameter:
2641a9603a14SPatrick Farrell .  tao  - Tao context
2642a9603a14SPatrick Farrell 
2643a9603a14SPatrick Farrell    Output Parameter:
2644a9603a14SPatrick Farrell .  M - gradient norm
2645a9603a14SPatrick Farrell 
2646a9603a14SPatrick Farrell    Level: beginner
2647a9603a14SPatrick Farrell 
2648a9603a14SPatrick Farrell .seealso: TaoSetGradientNorm(), TaoGradientNorm()
2649a9603a14SPatrick Farrell @*/
2650a9603a14SPatrick Farrell PetscErrorCode  TaoGetGradientNorm(Tao tao, Mat *M)
2651a9603a14SPatrick Farrell {
2652a9603a14SPatrick Farrell   PetscFunctionBegin;
2653a9603a14SPatrick Farrell   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2654a9603a14SPatrick Farrell   *M = tao->gradient_norm;
2655a9603a14SPatrick Farrell   PetscFunctionReturn(0);
2656a9603a14SPatrick Farrell }
2657a9603a14SPatrick Farrell 
2658a9603a14SPatrick Farrell /*c
2659a9603a14SPatrick Farrell    TaoGradientNorm - Compute the norm with respect to the inner product the user has set.
2660a9603a14SPatrick Farrell 
2661a9603a14SPatrick Farrell    Collective on tao
2662a9603a14SPatrick Farrell 
2663a9603a14SPatrick Farrell    Input Parameter:
2664a9603a14SPatrick Farrell .  tao      - the Tao context
2665a9603a14SPatrick Farrell .  gradient - the gradient to be computed
2666a9603a14SPatrick Farrell .  norm     - the norm type
2667a9603a14SPatrick Farrell 
2668a9603a14SPatrick Farrell    Output Parameter:
2669a9603a14SPatrick Farrell .  gnorm    - the gradient norm
2670a9603a14SPatrick Farrell 
2671a9603a14SPatrick Farrell    Level: developer
2672a9603a14SPatrick Farrell 
2673a9603a14SPatrick Farrell .seealso: TaoSetGradientNorm(), TaoGetGradientNorm()
2674a9603a14SPatrick Farrell @*/
2675a9603a14SPatrick Farrell PetscErrorCode  TaoGradientNorm(Tao tao, Vec gradient, NormType type, PetscReal *gnorm)
2676a9603a14SPatrick Farrell {
2677a9603a14SPatrick Farrell   PetscErrorCode ierr;
2678a9603a14SPatrick Farrell 
2679a9603a14SPatrick Farrell   PetscFunctionBegin;
2680a9603a14SPatrick Farrell   PetscValidHeaderSpecific(gradient,VEC_CLASSID,1);
2681a9603a14SPatrick Farrell 
2682a9603a14SPatrick Farrell   if (tao->gradient_norm) {
2683680e2bc7SPatrick Farrell     PetscScalar gnorms;
2684680e2bc7SPatrick Farrell 
2685a9603a14SPatrick Farrell     if (type != NORM_2) SETERRQ(PetscObjectComm((PetscObject)gradient), PETSC_ERR_ARG_WRONGSTATE, "Norm type must be NORM_2 if an inner product for the gradient norm is set.");
2686a9603a14SPatrick Farrell     ierr = MatMult(tao->gradient_norm, gradient, tao->gradient_norm_tmp);CHKERRQ(ierr);
2687680e2bc7SPatrick Farrell     ierr = VecDot(gradient, tao->gradient_norm_tmp, &gnorms);CHKERRQ(ierr);
26887bb79937SPatrick Farrell     *gnorm = PetscRealPart(PetscSqrtScalar(gnorms));
2689a9603a14SPatrick Farrell   } else {
2690a9603a14SPatrick Farrell     ierr = VecNorm(gradient, type, gnorm);CHKERRQ(ierr);
2691a9603a14SPatrick Farrell   }
2692a9603a14SPatrick Farrell   PetscFunctionReturn(0);
2693a9603a14SPatrick Farrell }
2694a9603a14SPatrick Farrell 
2695e882e171SHong Zhang /*@C
2696e882e171SHong Zhang    TaoMonitorDrawCtxCreate - Creates the monitor context for TaoMonitorDrawCtx
2697a9603a14SPatrick Farrell 
2698e882e171SHong Zhang    Collective on Tao
2699e882e171SHong Zhang 
2700e882e171SHong Zhang    Output Patameter:
2701e882e171SHong Zhang .    ctx - the monitor context
2702e882e171SHong Zhang 
2703e882e171SHong Zhang    Options Database:
2704e882e171SHong Zhang .   -tao_draw_solution_initial - show initial guess as well as current solution
2705e882e171SHong Zhang 
2706e882e171SHong Zhang    Level: intermediate
2707e882e171SHong Zhang 
2708e882e171SHong Zhang .keywords: Tao,  vector, monitor, view
2709e882e171SHong Zhang 
2710e882e171SHong Zhang .seealso: TaoMonitorSet(), TaoMonitorDefault(), VecView(), TaoMonitorDrawCtx()
2711e882e171SHong Zhang @*/
2712e882e171SHong Zhang PetscErrorCode  TaoMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TaoMonitorDrawCtx *ctx)
2713e882e171SHong Zhang {
2714e882e171SHong Zhang   PetscErrorCode   ierr;
2715e882e171SHong Zhang 
2716e882e171SHong Zhang   PetscFunctionBegin;
2717e882e171SHong Zhang   ierr = PetscNew(ctx);CHKERRQ(ierr);
2718e882e171SHong Zhang   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
2719e882e171SHong Zhang   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
2720e882e171SHong Zhang   (*ctx)->howoften = howoften;
2721e882e171SHong Zhang   PetscFunctionReturn(0);
2722e882e171SHong Zhang }
2723e882e171SHong Zhang 
2724e882e171SHong Zhang /*@C
2725e882e171SHong Zhang    TaoMonitorDrawCtxDestroy - Destroys the monitor context for TaoMonitorDrawSolution()
2726e882e171SHong Zhang 
2727e882e171SHong Zhang    Collective on Tao
2728e882e171SHong Zhang 
2729e882e171SHong Zhang    Input Parameters:
2730e882e171SHong Zhang .    ctx - the monitor context
2731e882e171SHong Zhang 
2732e882e171SHong Zhang    Level: intermediate
2733e882e171SHong Zhang 
2734e882e171SHong Zhang .keywords: Tao,  vector, monitor, view
2735e882e171SHong Zhang 
2736e882e171SHong Zhang .seealso: TaoMonitorSet(), TaoMonitorDefault(), VecView(), TaoMonitorDrawSolution()
2737e882e171SHong Zhang @*/
2738e882e171SHong Zhang PetscErrorCode  TaoMonitorDrawCtxDestroy(TaoMonitorDrawCtx *ictx)
2739e882e171SHong Zhang {
2740e882e171SHong Zhang   PetscErrorCode ierr;
2741e882e171SHong Zhang 
2742e882e171SHong Zhang   PetscFunctionBegin;
2743e882e171SHong Zhang   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
2744e882e171SHong Zhang   ierr = PetscFree(*ictx);CHKERRQ(ierr);
2745e882e171SHong Zhang   PetscFunctionReturn(0);
2746e882e171SHong Zhang }
2747