xref: /petsc/src/tao/interface/taosolver.c (revision 19b5c1014729ac30c47582d143b001f1b9cdc336)
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 
2097cf37e64SBarry Smith   ierr = VecViewFromOptions(tao->solution,(PetscObject)tao,"-tao_view_solution");CHKERRQ(ierr);
2107cf37e64SBarry Smith 
2118931d482SJason Sarich   tao->ntotalits += tao->niter;
212fbe0838dSJason Sarich   ierr = TaoViewFromOptions(tao,NULL,"-tao_view");CHKERRQ(ierr);
213a7e14dcfSSatish Balay 
214a7e14dcfSSatish Balay   if (tao->printreason) {
215a7e14dcfSSatish Balay     if (tao->reason > 0) {
2168931d482SJason Sarich       ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve converged due to %s iterations %D\n",TaoConvergedReasons[tao->reason],tao->niter);CHKERRQ(ierr);
217a7e14dcfSSatish Balay     } else {
2188931d482SJason Sarich       ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve did not converge due to %s iteration %D\n",TaoConvergedReasons[tao->reason],tao->niter);CHKERRQ(ierr);
219a7e14dcfSSatish Balay     }
220a7e14dcfSSatish Balay   }
221a7e14dcfSSatish Balay   PetscFunctionReturn(0);
222a7e14dcfSSatish Balay }
223a7e14dcfSSatish Balay 
224a7e14dcfSSatish Balay /*@
225a7e14dcfSSatish Balay   TaoSetUp - Sets up the internal data structures for the later use
226a7e14dcfSSatish Balay   of a Tao solver
227a7e14dcfSSatish Balay 
228a7e14dcfSSatish Balay   Collective on tao
229a7e14dcfSSatish Balay 
230a7e14dcfSSatish Balay   Input Parameters:
231a7e14dcfSSatish Balay . tao - the TAO context
232a7e14dcfSSatish Balay 
233a7e14dcfSSatish Balay   Notes:
234a7e14dcfSSatish Balay   The user will not need to explicitly call TaoSetUp(), as it will
235a7e14dcfSSatish Balay   automatically be called in TaoSolve().  However, if the user
236a7e14dcfSSatish Balay   desires to call it explicitly, it should come after TaoCreate()
237a7e14dcfSSatish Balay   and any TaoSetSomething() routines, but before TaoSolve().
238a7e14dcfSSatish Balay 
239a7e14dcfSSatish Balay   Level: advanced
240a7e14dcfSSatish Balay 
241a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
242a7e14dcfSSatish Balay @*/
243441846f8SBarry Smith PetscErrorCode TaoSetUp(Tao tao)
244a7e14dcfSSatish Balay {
245a7e14dcfSSatish Balay   PetscErrorCode ierr;
24647a47007SBarry Smith 
247a7e14dcfSSatish Balay   PetscFunctionBegin;
248441846f8SBarry Smith   PetscValidHeaderSpecific(tao, TAO_CLASSID,1);
249a7e14dcfSSatish Balay   if (tao->setupcalled) PetscFunctionReturn(0);
250a7e14dcfSSatish Balay 
25147a47007SBarry Smith   if (!tao->solution) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TaoSetInitialVector");
252a7e14dcfSSatish Balay   if (tao->ops->setup) {
253a7e14dcfSSatish Balay     ierr = (*tao->ops->setup)(tao);CHKERRQ(ierr);
254a7e14dcfSSatish Balay   }
255a7e14dcfSSatish Balay   tao->setupcalled = PETSC_TRUE;
256a7e14dcfSSatish Balay   PetscFunctionReturn(0);
257a7e14dcfSSatish Balay }
258a7e14dcfSSatish Balay 
259a7e14dcfSSatish Balay /*@
260a7e14dcfSSatish Balay   TaoDestroy - Destroys the TAO context that was created with
261a7e14dcfSSatish Balay   TaoCreate()
262a7e14dcfSSatish Balay 
263441846f8SBarry Smith   Collective on Tao
264a7e14dcfSSatish Balay 
265a7e14dcfSSatish Balay   Input Parameter:
266441846f8SBarry Smith . tao - the Tao context
267a7e14dcfSSatish Balay 
268a7e14dcfSSatish Balay   Level: beginner
269a7e14dcfSSatish Balay 
270a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
271a7e14dcfSSatish Balay @*/
272441846f8SBarry Smith PetscErrorCode TaoDestroy(Tao *tao)
273a7e14dcfSSatish Balay {
274a7e14dcfSSatish Balay   PetscErrorCode ierr;
27547a47007SBarry Smith 
276a7e14dcfSSatish Balay   PetscFunctionBegin;
277a7e14dcfSSatish Balay   if (!*tao) PetscFunctionReturn(0);
278441846f8SBarry Smith   PetscValidHeaderSpecific(*tao,TAO_CLASSID,1);
279a7e14dcfSSatish Balay   if (--((PetscObject)*tao)->refct > 0) {*tao=0;PetscFunctionReturn(0);}
280a7e14dcfSSatish Balay 
281a7e14dcfSSatish Balay   if ((*tao)->ops->destroy) {
282a7e14dcfSSatish Balay     ierr = (*((*tao))->ops->destroy)(*tao);CHKERRQ(ierr);
283a7e14dcfSSatish Balay   }
284a7e14dcfSSatish Balay   ierr = KSPDestroy(&(*tao)->ksp);CHKERRQ(ierr);
285a7e14dcfSSatish Balay   ierr = TaoLineSearchDestroy(&(*tao)->linesearch);CHKERRQ(ierr);
286a7e14dcfSSatish Balay 
287a7e14dcfSSatish Balay   if ((*tao)->ops->convergencedestroy) {
288a7e14dcfSSatish Balay     ierr = (*(*tao)->ops->convergencedestroy)((*tao)->cnvP);CHKERRQ(ierr);
289a7e14dcfSSatish Balay     if ((*tao)->jacobian_state_inv) {
290a7e14dcfSSatish Balay       ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr);
291a7e14dcfSSatish Balay     }
292a7e14dcfSSatish Balay   }
293a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->solution);CHKERRQ(ierr);
294a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->gradient);CHKERRQ(ierr);
295a7e14dcfSSatish Balay 
296a9603a14SPatrick Farrell   if ((*tao)->gradient_norm) {
297a9603a14SPatrick Farrell     ierr = PetscObjectDereference((PetscObject)(*tao)->gradient_norm);CHKERRQ(ierr);
298a9603a14SPatrick Farrell     ierr = VecDestroy(&(*tao)->gradient_norm_tmp);CHKERRQ(ierr);
299a9603a14SPatrick Farrell   }
300a9603a14SPatrick Farrell 
301a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->XL);CHKERRQ(ierr);
302a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->XU);CHKERRQ(ierr);
303a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->IL);CHKERRQ(ierr);
304a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->IU);CHKERRQ(ierr);
305a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->DE);CHKERRQ(ierr);
306a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->DI);CHKERRQ(ierr);
307a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->constraints_equality);CHKERRQ(ierr);
308a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->constraints_inequality);CHKERRQ(ierr);
309a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->stepdirection);CHKERRQ(ierr);
310a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->hessian_pre);CHKERRQ(ierr);
311a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->hessian);CHKERRQ(ierr);
312a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_pre);CHKERRQ(ierr);
313a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian);CHKERRQ(ierr);
314a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state_pre);CHKERRQ(ierr);
315a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state);CHKERRQ(ierr);
316a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr);
317067f330cSJason Sarich   ierr = MatDestroy(&(*tao)->jacobian_design);CHKERRQ(ierr);
318a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_equality);CHKERRQ(ierr);
319a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_equality_pre);CHKERRQ(ierr);
320a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_inequality);CHKERRQ(ierr);
321a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_inequality_pre);CHKERRQ(ierr);
322a7e14dcfSSatish Balay   ierr = ISDestroy(&(*tao)->state_is);CHKERRQ(ierr);
323a7e14dcfSSatish Balay   ierr = ISDestroy(&(*tao)->design_is);CHKERRQ(ierr);
324125ddc8aSJason Sarich   ierr = VecDestroy(&(*tao)->sep_weights_v);CHKERRQ(ierr);
325a7e14dcfSSatish Balay   ierr = TaoCancelMonitors(*tao);CHKERRQ(ierr);
326ae93cb3cSJason Sarich   if ((*tao)->hist_malloc) {
327ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_obj);CHKERRQ(ierr);
328ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_resid);CHKERRQ(ierr);
329ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_cnorm);CHKERRQ(ierr);
330ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_lits);CHKERRQ(ierr);
331ae93cb3cSJason Sarich   }
332125ddc8aSJason Sarich   if ((*tao)->sep_weights_n) {
333125ddc8aSJason Sarich     ierr = PetscFree((*tao)->sep_weights_rows);CHKERRQ(ierr);
334125ddc8aSJason Sarich     ierr = PetscFree((*tao)->sep_weights_cols);CHKERRQ(ierr);
335125ddc8aSJason Sarich     ierr = PetscFree((*tao)->sep_weights_w);CHKERRQ(ierr);
336125ddc8aSJason Sarich   }
337a7e14dcfSSatish Balay   ierr = PetscHeaderDestroy(tao);CHKERRQ(ierr);
338a7e14dcfSSatish Balay   PetscFunctionReturn(0);
339a7e14dcfSSatish Balay }
340a7e14dcfSSatish Balay 
341a7e14dcfSSatish Balay /*@
342441846f8SBarry Smith   TaoSetFromOptions - Sets various Tao parameters from user
343a7e14dcfSSatish Balay   options.
344a7e14dcfSSatish Balay 
345441846f8SBarry Smith   Collective on Tao
346a7e14dcfSSatish Balay 
347a7e14dcfSSatish Balay   Input Paremeter:
348441846f8SBarry Smith . tao - the Tao solver context
349a7e14dcfSSatish Balay 
350a7e14dcfSSatish Balay   options Database Keys:
35158417fe7SBarry Smith + -tao_type <type> - The algorithm that TAO uses (lmvm, nls, etc.)
352a7e14dcfSSatish Balay . -tao_gatol <gatol> - absolute error tolerance for ||gradient||
353a7e14dcfSSatish Balay . -tao_grtol <grtol> - relative error tolerance for ||gradient||
354a7e14dcfSSatish Balay . -tao_gttol <gttol> - reduction of ||gradient|| relative to initial gradient
355a7e14dcfSSatish Balay . -tao_max_it <max> - sets maximum number of iterations
356a7e14dcfSSatish Balay . -tao_max_funcs <max> - sets maximum number of function evaluations
357a7e14dcfSSatish Balay . -tao_fmin <fmin> - stop if function value reaches fmin
358a7e14dcfSSatish Balay . -tao_steptol <tol> - stop if trust region radius less than <tol>
359a7e14dcfSSatish Balay . -tao_trust0 <t> - initial trust region radius
360a7e14dcfSSatish Balay . -tao_monitor - prints function value and residual at each iteration
361a7e14dcfSSatish Balay . -tao_smonitor - same as tao_monitor, but truncates very small values
362a7e14dcfSSatish Balay . -tao_cmonitor - prints function value, residual, and constraint norm at each iteration
363a7e14dcfSSatish Balay . -tao_view_solution - prints solution vector at each iteration
364a7e14dcfSSatish Balay . -tao_view_separableobjective - prints separable objective vector at each iteration
365a7e14dcfSSatish Balay . -tao_view_step - prints step direction vector at each iteration
366a7e14dcfSSatish Balay . -tao_view_gradient - prints gradient vector at each iteration
367a7e14dcfSSatish Balay . -tao_draw_solution - graphically view solution vector at each iteration
368a7e14dcfSSatish Balay . -tao_draw_step - graphically view step vector at each iteration
369a7e14dcfSSatish Balay . -tao_draw_gradient - graphically view gradient at each iteration
370a7e14dcfSSatish Balay . -tao_fd_gradient - use gradient computed with finite differences
371f4c1ad5cSStefano Zampini . -tao_fd_hessian - use hessian computed with finite differences
372f4c1ad5cSStefano Zampini . -tao_mf_hessian - use matrix-free hessian computed with finite differences
373a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors (except those set with command line)
374441846f8SBarry Smith . -tao_view - prints information about the Tao after solving
375a7e14dcfSSatish Balay - -tao_converged_reason - prints the reason TAO stopped iterating
376a7e14dcfSSatish Balay 
377a7e14dcfSSatish Balay   Notes:
378a7e14dcfSSatish Balay   To see all options, run your program with the -help option or consult the
379a7e14dcfSSatish Balay   user's manual. Should be called after TaoCreate() but before TaoSolve()
380a7e14dcfSSatish Balay 
381a7e14dcfSSatish Balay   Level: beginner
382a7e14dcfSSatish Balay @*/
383441846f8SBarry Smith PetscErrorCode TaoSetFromOptions(Tao tao)
384a7e14dcfSSatish Balay {
385a7e14dcfSSatish Balay   PetscErrorCode ierr;
38658417fe7SBarry Smith   const TaoType  default_type = TAOLMVM;
387a7e14dcfSSatish Balay   char           type[256], monfilename[PETSC_MAX_PATH_LEN];
388a7e14dcfSSatish Balay   PetscViewer    monviewer;
389a7e14dcfSSatish Balay   PetscBool      flg;
390a7e14dcfSSatish Balay   MPI_Comm       comm;
391a7e14dcfSSatish Balay 
392a7e14dcfSSatish Balay   PetscFunctionBegin;
393441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
394a7e14dcfSSatish Balay   ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
395125ddc8aSJason Sarich 
396a7e14dcfSSatish Balay   /* So no warnings are given about unused options */
397c5929fdfSBarry Smith   ierr = PetscOptionsHasName(((PetscObject)tao)->options,((PetscObject)tao)->prefix,"-tao_ls_type",&flg);CHKERRQ(ierr);
398a7e14dcfSSatish Balay 
399a7e14dcfSSatish Balay   ierr = PetscObjectOptionsBegin((PetscObject)tao);CHKERRQ(ierr);
400a7e14dcfSSatish Balay   {
401441846f8SBarry Smith     ierr = TaoRegisterAll();CHKERRQ(ierr);
402a7e14dcfSSatish Balay     if (((PetscObject)tao)->type_name) {
403a7e14dcfSSatish Balay       default_type = ((PetscObject)tao)->type_name;
404a7e14dcfSSatish Balay     }
405a7e14dcfSSatish Balay     /* Check for type from options */
406441846f8SBarry Smith     ierr = PetscOptionsFList("-tao_type","Tao Solver type","TaoSetType",TaoList,default_type,type,256,&flg);CHKERRQ(ierr);
407a7e14dcfSSatish Balay     if (flg) {
408a7e14dcfSSatish Balay       ierr = TaoSetType(tao,type);CHKERRQ(ierr);
409a7e14dcfSSatish Balay     } else if (!((PetscObject)tao)->type_name) {
410302440fdSBarry Smith       ierr = TaoSetType(tao,default_type);CHKERRQ(ierr);
411a7e14dcfSSatish Balay     }
412a7e14dcfSSatish Balay 
4136552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_catol","Stop if constraints violations within","TaoSetConstraintTolerances",tao->catol,&tao->catol,&flg);CHKERRQ(ierr);
4146552cf8aSJason Sarich     if (flg) tao->catol_changed=PETSC_TRUE;
4156552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_crtol","Stop if relative contraint violations within","TaoSetConstraintTolerances",tao->crtol,&tao->crtol,&flg);CHKERRQ(ierr);
4166552cf8aSJason Sarich     if (flg) tao->crtol_changed=PETSC_TRUE;
4176552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_gatol","Stop if norm of gradient less than","TaoSetTolerances",tao->gatol,&tao->gatol,&flg);CHKERRQ(ierr);
4186552cf8aSJason Sarich     if (flg) tao->gatol_changed=PETSC_TRUE;
4196552cf8aSJason 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);
4206552cf8aSJason Sarich     if (flg) tao->grtol_changed=PETSC_TRUE;
4216552cf8aSJason 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);
4226552cf8aSJason Sarich     if (flg) tao->gttol_changed=PETSC_TRUE;
4236552cf8aSJason Sarich     ierr = PetscOptionsInt("-tao_max_it","Stop if iteration number exceeds","TaoSetMaximumIterations",tao->max_it,&tao->max_it,&flg);CHKERRQ(ierr);
4246552cf8aSJason Sarich     if (flg) tao->max_it_changed=PETSC_TRUE;
4256552cf8aSJason Sarich     ierr = PetscOptionsInt("-tao_max_funcs","Stop if number of function evaluations exceeds","TaoSetMaximumFunctionEvaluations",tao->max_funcs,&tao->max_funcs,&flg);CHKERRQ(ierr);
4266552cf8aSJason Sarich     if (flg) tao->max_funcs_changed=PETSC_TRUE;
4276552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_fmin","Stop if function less than","TaoSetFunctionLowerBound",tao->fmin,&tao->fmin,&flg);CHKERRQ(ierr);
4286552cf8aSJason Sarich     if (flg) tao->fmin_changed=PETSC_TRUE;
4296552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_steptol","Stop if step size or trust region radius less than","",tao->steptol,&tao->steptol,&flg);CHKERRQ(ierr);
4306552cf8aSJason Sarich     if (flg) tao->steptol_changed=PETSC_TRUE;
4316552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_trust0","Initial trust region radius","TaoSetTrustRegionRadius",tao->trust0,&tao->trust0,&flg);CHKERRQ(ierr);
4326552cf8aSJason Sarich     if (flg) tao->trust0_changed=PETSC_TRUE;
433a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_solution","view solution vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
434a7e14dcfSSatish Balay     if (flg) {
435a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
436a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoSolutionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
437a7e14dcfSSatish Balay     }
438a7e14dcfSSatish Balay 
4398afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_converged_reason","Print reason for TAO converged","TaoSolve",tao->printreason,&tao->printreason,NULL);CHKERRQ(ierr);
440a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_gradient","view gradient vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
441a7e14dcfSSatish Balay     if (flg) {
442a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
443a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoGradientMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
444a7e14dcfSSatish Balay     }
445a7e14dcfSSatish Balay 
446a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_stepdirection","view step direction vector after each iteration","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
447a7e14dcfSSatish Balay     if (flg) {
448a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
449a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoStepDirectionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
450a7e14dcfSSatish Balay     }
451a7e14dcfSSatish Balay 
452a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_separableobjective","view separable objective vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
453a7e14dcfSSatish Balay     if (flg) {
454a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
455a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoSeparableObjectiveMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
456a7e14dcfSSatish Balay     }
457a7e14dcfSSatish Balay 
458a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_monitor","Use the default convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
459a7e14dcfSSatish Balay     if (flg) {
460a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
46198ea980cSBarry Smith       ierr = TaoSetMonitor(tao,TaoMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
462a7e14dcfSSatish Balay     }
463a7e14dcfSSatish Balay 
464a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_smonitor","Use the short convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
465a7e14dcfSSatish Balay     if (flg) {
466a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
467a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultSMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
468a7e14dcfSSatish Balay     }
469a7e14dcfSSatish Balay 
470a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_cmonitor","Use the default convergence monitor with constraint norm","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
471a7e14dcfSSatish Balay     if (flg) {
472a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
473a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultCMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
474a7e14dcfSSatish Balay     }
475a7e14dcfSSatish Balay 
476a7e14dcfSSatish Balay 
4778afaa268SBarry Smith     flg = PETSC_FALSE;
4788afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_cancelmonitors","cancel all monitors and call any registered destroy routines","TaoCancelMonitors",flg,&flg,NULL);CHKERRQ(ierr);
479a7e14dcfSSatish Balay     if (flg) {ierr = TaoCancelMonitors(tao);CHKERRQ(ierr);}
480a7e14dcfSSatish Balay 
4818afaa268SBarry Smith     flg = PETSC_FALSE;
4828afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_draw_solution","Plot solution vector at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr);
483a7e14dcfSSatish Balay     if (flg) {
484e882e171SHong Zhang       TaoMonitorDrawCtx drawctx;
485e882e171SHong Zhang       PetscInt          howoften = 1;
486e882e171SHong Zhang       ierr = TaoMonitorDrawCtxCreate(PetscObjectComm((PetscObject)tao),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&drawctx);CHKERRQ(ierr);
487e882e171SHong Zhang       ierr = TaoSetMonitor(tao,TaoDrawSolutionMonitor,drawctx,(PetscErrorCode (*)(void**))TaoMonitorDrawCtxDestroy);CHKERRQ(ierr);
488a7e14dcfSSatish Balay     }
489a7e14dcfSSatish Balay 
4908afaa268SBarry Smith     flg = PETSC_FALSE;
4918afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_draw_step","plots step direction at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr);
492a7e14dcfSSatish Balay     if (flg) {
49347a47007SBarry Smith       ierr = TaoSetMonitor(tao,TaoDrawStepMonitor,NULL,NULL);CHKERRQ(ierr);
494a7e14dcfSSatish Balay     }
495a7e14dcfSSatish Balay 
4968afaa268SBarry Smith     flg = PETSC_FALSE;
4978afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_draw_gradient","plots gradient at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr);
498a7e14dcfSSatish Balay     if (flg) {
499e882e171SHong Zhang       TaoMonitorDrawCtx drawctx;
500e882e171SHong Zhang       PetscInt          howoften = 1;
501e882e171SHong Zhang       ierr = TaoMonitorDrawCtxCreate(PetscObjectComm((PetscObject)tao),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&drawctx);CHKERRQ(ierr);
502e882e171SHong Zhang       ierr = TaoSetMonitor(tao,TaoDrawGradientMonitor,drawctx,(PetscErrorCode (*)(void**))TaoMonitorDrawCtxDestroy);CHKERRQ(ierr);
503a7e14dcfSSatish Balay     }
5048afaa268SBarry Smith     flg = PETSC_FALSE;
5058afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_fd_gradient","compute gradient using finite differences","TaoDefaultComputeGradient",flg,&flg,NULL);CHKERRQ(ierr);
506a7e14dcfSSatish Balay     if (flg) {
50747a47007SBarry Smith       ierr = TaoSetGradientRoutine(tao,TaoDefaultComputeGradient,NULL);CHKERRQ(ierr);
508a7e14dcfSSatish Balay     }
509f4c1ad5cSStefano Zampini     flg = PETSC_FALSE;
510f4c1ad5cSStefano Zampini     ierr = PetscOptionsBool("-tao_fd_hessian","compute hessian using finite differences","TaoDefaultComputeHessian",flg,&flg,NULL);CHKERRQ(ierr);
511f4c1ad5cSStefano Zampini     if (flg) {
512f4c1ad5cSStefano Zampini       Mat H;
513f4c1ad5cSStefano Zampini 
514f4c1ad5cSStefano Zampini       ierr = MatCreate(PetscObjectComm((PetscObject)tao),&H);CHKERRQ(ierr);
515f4c1ad5cSStefano Zampini       ierr = MatSetType(H,MATAIJ);CHKERRQ(ierr);
516f4c1ad5cSStefano Zampini       ierr = TaoSetHessianRoutine(tao,H,H,TaoDefaultComputeHessian,NULL);CHKERRQ(ierr);
517f4c1ad5cSStefano Zampini       ierr = MatDestroy(&H);CHKERRQ(ierr);
518f4c1ad5cSStefano Zampini     }
519f4c1ad5cSStefano Zampini     flg = PETSC_FALSE;
520f4c1ad5cSStefano Zampini     ierr = PetscOptionsBool("-tao_mf_hessian","compute matrix-free hessian using finite differences","TaoDefaultComputeHessianMFFD",flg,&flg,NULL);CHKERRQ(ierr);
521f4c1ad5cSStefano Zampini     if (flg) {
522f4c1ad5cSStefano Zampini       Mat H;
523f4c1ad5cSStefano Zampini 
524f4c1ad5cSStefano Zampini       ierr = MatCreate(PetscObjectComm((PetscObject)tao),&H);CHKERRQ(ierr);
525f4c1ad5cSStefano Zampini       ierr = TaoSetHessianRoutine(tao,H,H,TaoDefaultComputeHessianMFFD,NULL);CHKERRQ(ierr);
526f4c1ad5cSStefano Zampini       ierr = MatDestroy(&H);CHKERRQ(ierr);
527f4c1ad5cSStefano Zampini     }
528f4c1ad5cSStefano Zampini     ierr = PetscOptionsEnum("-tao_subset_type","subset type","",TaoSubSetTypes,(PetscEnum)tao->subset_type,(PetscEnum*)&tao->subset_type,NULL);CHKERRQ(ierr);
529a7e14dcfSSatish Balay 
530a7e14dcfSSatish Balay     if (tao->ops->setfromoptions) {
5311a1499c8SBarry Smith       ierr = (*tao->ops->setfromoptions)(PetscOptionsObject,tao);CHKERRQ(ierr);
532a7e14dcfSSatish Balay     }
533a7e14dcfSSatish Balay   }
534a7e14dcfSSatish Balay   ierr = PetscOptionsEnd();CHKERRQ(ierr);
535a7e14dcfSSatish Balay   PetscFunctionReturn(0);
536a7e14dcfSSatish Balay }
537a7e14dcfSSatish Balay 
538a7e14dcfSSatish Balay /*@C
539441846f8SBarry Smith   TaoView - Prints information about the Tao
540a7e14dcfSSatish Balay 
541441846f8SBarry Smith   Collective on Tao
542a7e14dcfSSatish Balay 
543a7e14dcfSSatish Balay   InputParameters:
544441846f8SBarry Smith + tao - the Tao context
545a7e14dcfSSatish Balay - viewer - visualization context
546a7e14dcfSSatish Balay 
547a7e14dcfSSatish Balay   Options Database Key:
548a7e14dcfSSatish Balay . -tao_view - Calls TaoView() at the end of TaoSolve()
549a7e14dcfSSatish Balay 
550a7e14dcfSSatish Balay   Notes:
551a7e14dcfSSatish Balay   The available visualization contexts include
552a7e14dcfSSatish Balay +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
553a7e14dcfSSatish Balay -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
554a7e14dcfSSatish Balay          output where only the first processor opens
555a7e14dcfSSatish Balay          the file.  All other processors send their
556a7e14dcfSSatish Balay          data to the first processor to print.
557a7e14dcfSSatish Balay 
558a7e14dcfSSatish Balay   Level: beginner
559a7e14dcfSSatish Balay 
560a7e14dcfSSatish Balay .seealso: PetscViewerASCIIOpen()
561a7e14dcfSSatish Balay @*/
562441846f8SBarry Smith PetscErrorCode TaoView(Tao tao, PetscViewer viewer)
563a7e14dcfSSatish Balay {
564a7e14dcfSSatish Balay   PetscErrorCode      ierr;
565a7e14dcfSSatish Balay   PetscBool           isascii,isstring;
566441846f8SBarry Smith   const TaoType type;
56747a47007SBarry Smith 
568a7e14dcfSSatish Balay   PetscFunctionBegin;
569441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
570a7e14dcfSSatish Balay   if (!viewer) {
571a7e14dcfSSatish Balay     ierr = PetscViewerASCIIGetStdout(((PetscObject)tao)->comm,&viewer);CHKERRQ(ierr);
572a7e14dcfSSatish Balay   }
573a7e14dcfSSatish Balay   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
574a7e14dcfSSatish Balay   PetscCheckSameComm(tao,1,viewer,2);
575a7e14dcfSSatish Balay 
576a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
577a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
578a7e14dcfSSatish Balay   if (isascii) {
579*19b5c101SAlp Dener     ierr = PetscViewerASCIIAddTab(viewer, ((PetscObject)tao)->tablevel);CHKERRQ(ierr);
580a7e14dcfSSatish Balay     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)tao,viewer);CHKERRQ(ierr);
581a7e14dcfSSatish Balay 
582a7e14dcfSSatish Balay     if (tao->ops->view) {
583a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
584a7e14dcfSSatish Balay       ierr = (*tao->ops->view)(tao,viewer);CHKERRQ(ierr);
585a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
586a7e14dcfSSatish Balay     }
587a7e14dcfSSatish Balay     if (tao->linesearch) {
588*19b5c101SAlp Dener       ierr = TaoLineSearchView(tao->linesearch,viewer);CHKERRQ(ierr);
589a7e14dcfSSatish Balay     }
590a7e14dcfSSatish Balay     if (tao->ksp) {
591*19b5c101SAlp Dener       ierr = KSPView(tao->ksp,viewer);CHKERRQ(ierr);
592*19b5c101SAlp Dener       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
593ae93cb3cSJason Sarich       ierr = PetscViewerASCIIPrintf(viewer,"total KSP iterations: %D\n",tao->ksp_tot_its);CHKERRQ(ierr);
594*19b5c101SAlp Dener       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
595a7e14dcfSSatish Balay     }
596*19b5c101SAlp Dener 
597*19b5c101SAlp Dener     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
598*19b5c101SAlp Dener 
599a7e14dcfSSatish Balay     if (tao->XL || tao->XU) {
600302440fdSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Active Set subset type: %s\n",TaoSubSetTypes[tao->subset_type]);CHKERRQ(ierr);
601a7e14dcfSSatish Balay     }
602a7e14dcfSSatish Balay 
60347a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"convergence tolerances: gatol=%g,",(double)tao->gatol);CHKERRQ(ierr);
60447a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer," steptol=%g,",(double)tao->steptol);CHKERRQ(ierr);
60547a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer," gttol=%g\n",(double)tao->gttol);CHKERRQ(ierr);
60647a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Residual in Function/Gradient:=%g\n",(double)tao->residual);CHKERRQ(ierr);
607a7e14dcfSSatish Balay 
608a7e14dcfSSatish Balay     if (tao->cnorm>0 || tao->catol>0 || tao->crtol>0){
609a7e14dcfSSatish Balay       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances:");CHKERRQ(ierr);
61047a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer," catol=%g,",(double)tao->catol);CHKERRQ(ierr);
61147a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer," crtol=%g\n",(double)tao->crtol);CHKERRQ(ierr);
61247a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Residual in Constraints:=%g\n",(double)tao->cnorm);CHKERRQ(ierr);
613a7e14dcfSSatish Balay     }
614a7e14dcfSSatish Balay 
615a7e14dcfSSatish Balay     if (tao->trust < tao->steptol){
61647a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: steptol=%g\n",(double)tao->steptol);CHKERRQ(ierr);
61747a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"Final trust region radius:=%g\n",(double)tao->trust);CHKERRQ(ierr);
618a7e14dcfSSatish Balay     }
619a7e14dcfSSatish Balay 
620a7e14dcfSSatish Balay     if (tao->fmin>-1.e25){
62147a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: function minimum=%g\n",(double)tao->fmin);CHKERRQ(ierr);
622a7e14dcfSSatish Balay     }
62347a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Objective value=%g\n",(double)tao->fc);CHKERRQ(ierr);
624a7e14dcfSSatish Balay 
62547a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"total number of iterations=%D,          ",tao->niter);CHKERRQ(ierr);
626a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPrintf(viewer,"              (max: %D)\n",tao->max_it);CHKERRQ(ierr);
627a7e14dcfSSatish Balay 
628a7e14dcfSSatish Balay     if (tao->nfuncs>0){
62947a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of function evaluations=%D,",tao->nfuncs);CHKERRQ(ierr);
63047a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"                max: %D\n",tao->max_funcs);CHKERRQ(ierr);
631a7e14dcfSSatish Balay     }
632a7e14dcfSSatish Balay     if (tao->ngrads>0){
63347a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of gradient evaluations=%D,",tao->ngrads);CHKERRQ(ierr);
63447a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"                max: %D\n",tao->max_funcs);CHKERRQ(ierr);
635a7e14dcfSSatish Balay     }
636a7e14dcfSSatish Balay     if (tao->nfuncgrads>0){
63747a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of function/gradient evaluations=%D,",tao->nfuncgrads);CHKERRQ(ierr);
63847a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    (max: %D)\n",tao->max_funcs);CHKERRQ(ierr);
639a7e14dcfSSatish Balay     }
640a7e14dcfSSatish Balay     if (tao->nhess>0){
64147a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of Hessian evaluations=%D\n",tao->nhess);CHKERRQ(ierr);
642a7e14dcfSSatish Balay     }
643a7e14dcfSSatish Balay     /*  if (tao->linear_its>0){
64447a47007SBarry Smith      ierr = PetscViewerASCIIPrintf(viewer,"  total Krylov method iterations=%D\n",tao->linear_its);CHKERRQ(ierr);
645a7e14dcfSSatish Balay      }*/
646a7e14dcfSSatish Balay     if (tao->nconstraints>0){
64747a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of constraint function evaluations=%D\n",tao->nconstraints);CHKERRQ(ierr);
648a7e14dcfSSatish Balay     }
649a7e14dcfSSatish Balay     if (tao->njac>0){
65047a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of Jacobian evaluations=%D\n",tao->njac);CHKERRQ(ierr);
651a7e14dcfSSatish Balay     }
652a7e14dcfSSatish Balay 
653a7e14dcfSSatish Balay     if (tao->reason>0){
654a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer,    "Solution converged: ");CHKERRQ(ierr);
655a7e14dcfSSatish Balay       switch (tao->reason) {
656a7e14dcfSSatish Balay       case TAO_CONVERGED_GATOL:
657a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)|| <= gatol\n");CHKERRQ(ierr);
658a7e14dcfSSatish Balay         break;
659a7e14dcfSSatish Balay       case TAO_CONVERGED_GRTOL:
660a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/|f(X)| <= grtol\n");CHKERRQ(ierr);
661a7e14dcfSSatish Balay         break;
662a7e14dcfSSatish Balay       case TAO_CONVERGED_GTTOL:
663a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/||g(X0)|| <= gttol\n");CHKERRQ(ierr);
664a7e14dcfSSatish Balay         break;
665a7e14dcfSSatish Balay       case TAO_CONVERGED_STEPTOL:
666a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," Steptol -- step size small\n");CHKERRQ(ierr);
667a7e14dcfSSatish Balay         break;
668a7e14dcfSSatish Balay       case TAO_CONVERGED_MINF:
669a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," Minf --  f < fmin\n");CHKERRQ(ierr);
670a7e14dcfSSatish Balay         break;
671a7e14dcfSSatish Balay       case TAO_CONVERGED_USER:
672a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr);
673a7e14dcfSSatish Balay         break;
674a7e14dcfSSatish Balay       default:
675a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
676a7e14dcfSSatish Balay         break;
677a7e14dcfSSatish Balay       }
678a7e14dcfSSatish Balay 
679a7e14dcfSSatish Balay     } else {
68047cfc4faSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Solver terminated: %d",tao->reason);CHKERRQ(ierr);
681a7e14dcfSSatish Balay       switch (tao->reason) {
682a7e14dcfSSatish Balay       case TAO_DIVERGED_MAXITS:
68347a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Maximum Iterations\n");CHKERRQ(ierr);
684a7e14dcfSSatish Balay         break;
685a7e14dcfSSatish Balay       case TAO_DIVERGED_NAN:
68647a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," NAN or Inf encountered\n");CHKERRQ(ierr);
687a7e14dcfSSatish Balay         break;
688a7e14dcfSSatish Balay       case TAO_DIVERGED_MAXFCN:
68947a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Maximum Function Evaluations\n");CHKERRQ(ierr);
690a7e14dcfSSatish Balay         break;
691a7e14dcfSSatish Balay       case TAO_DIVERGED_LS_FAILURE:
69247a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Line Search Failure\n");CHKERRQ(ierr);
693a7e14dcfSSatish Balay         break;
694a7e14dcfSSatish Balay       case TAO_DIVERGED_TR_REDUCTION:
69547a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Trust Region too small\n");CHKERRQ(ierr);
696a7e14dcfSSatish Balay         break;
697a7e14dcfSSatish Balay       case TAO_DIVERGED_USER:
69847a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr);
699a7e14dcfSSatish Balay         break;
700a7e14dcfSSatish Balay       default:
701a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
702a7e14dcfSSatish Balay         break;
703a7e14dcfSSatish Balay       }
704a7e14dcfSSatish Balay     }
705a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
706*19b5c101SAlp Dener     ierr = PetscViewerASCIISubtractTab(viewer, ((PetscObject)tao)->tablevel);CHKERRQ(ierr);
707a7e14dcfSSatish Balay   } else if (isstring) {
708a7e14dcfSSatish Balay     ierr = TaoGetType(tao,&type);CHKERRQ(ierr);
709a7e14dcfSSatish Balay     ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr);
710a7e14dcfSSatish Balay   }
711a7e14dcfSSatish Balay   PetscFunctionReturn(0);
712a7e14dcfSSatish Balay }
713a7e14dcfSSatish Balay 
714a7e14dcfSSatish Balay /*@
715a7e14dcfSSatish Balay   TaoSetTolerances - Sets parameters used in TAO convergence tests
716a7e14dcfSSatish Balay 
717441846f8SBarry Smith   Logically collective on Tao
718a7e14dcfSSatish Balay 
719a7e14dcfSSatish Balay   Input Parameters:
720441846f8SBarry Smith + tao - the Tao context
721a7e14dcfSSatish Balay . gatol - stop if norm of gradient is less than this
722a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this
723a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by this factor
724a7e14dcfSSatish Balay 
725a7e14dcfSSatish Balay   Options Database Keys:
726e52336cbSBarry Smith + -tao_gatol <gatol> - Sets gatol
727a7e14dcfSSatish Balay . -tao_grtol <grtol> - Sets grtol
728a7e14dcfSSatish Balay - -tao_gttol <gttol> - Sets gttol
729a7e14dcfSSatish Balay 
730a7e14dcfSSatish Balay   Stopping Criteria:
731a7e14dcfSSatish Balay $ ||g(X)||                            <= gatol
732a7e14dcfSSatish Balay $ ||g(X)|| / |f(X)|                   <= grtol
733a7e14dcfSSatish Balay $ ||g(X)|| / ||g(X0)||                <= gttol
734a7e14dcfSSatish Balay 
735a7e14dcfSSatish Balay   Notes:
736a7e14dcfSSatish Balay   Use PETSC_DEFAULT to leave one or more tolerances unchanged.
737a7e14dcfSSatish Balay 
738a7e14dcfSSatish Balay   Level: beginner
739a7e14dcfSSatish Balay 
740a7e14dcfSSatish Balay .seealso: TaoGetTolerances()
741a7e14dcfSSatish Balay 
742a7e14dcfSSatish Balay @*/
743e52336cbSBarry Smith PetscErrorCode TaoSetTolerances(Tao tao, PetscReal gatol, PetscReal grtol, PetscReal gttol)
744a7e14dcfSSatish Balay {
745a7e14dcfSSatish Balay   PetscErrorCode ierr;
74647a47007SBarry Smith 
747a7e14dcfSSatish Balay   PetscFunctionBegin;
748441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
749a7e14dcfSSatish Balay 
750a7e14dcfSSatish Balay   if (gatol != PETSC_DEFAULT) {
751a7e14dcfSSatish Balay     if (gatol<0) {
752955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative gatol -- ignored.\n");CHKERRQ(ierr);
753a7e14dcfSSatish Balay     } else {
754a7e14dcfSSatish Balay       tao->gatol = PetscMax(0,gatol);
7556552cf8aSJason Sarich       tao->gatol_changed=PETSC_TRUE;
756a7e14dcfSSatish Balay     }
757a7e14dcfSSatish Balay   }
758a7e14dcfSSatish Balay 
759a7e14dcfSSatish Balay   if (grtol != PETSC_DEFAULT) {
760a7e14dcfSSatish Balay     if (grtol<0) {
761955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative grtol -- ignored.\n");CHKERRQ(ierr);
762a7e14dcfSSatish Balay     } else {
763a7e14dcfSSatish Balay       tao->grtol = PetscMax(0,grtol);
7646552cf8aSJason Sarich       tao->grtol_changed=PETSC_TRUE;
765a7e14dcfSSatish Balay     }
766a7e14dcfSSatish Balay   }
767a7e14dcfSSatish Balay 
768a7e14dcfSSatish Balay   if (gttol != PETSC_DEFAULT) {
769a7e14dcfSSatish Balay     if (gttol<0) {
770955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative gttol -- ignored.\n");CHKERRQ(ierr);
771a7e14dcfSSatish Balay     } else {
772a7e14dcfSSatish Balay       tao->gttol = PetscMax(0,gttol);
7736552cf8aSJason Sarich       tao->gttol_changed=PETSC_TRUE;
774a7e14dcfSSatish Balay     }
775a7e14dcfSSatish Balay   }
776a7e14dcfSSatish Balay   PetscFunctionReturn(0);
777a7e14dcfSSatish Balay }
778a7e14dcfSSatish Balay 
779a7e14dcfSSatish Balay /*@
78058417fe7SBarry Smith   TaoSetConstraintTolerances - Sets constraint tolerance parameters used in TAO  convergence tests
781a7e14dcfSSatish Balay 
782441846f8SBarry Smith   Logically collective on Tao
783a7e14dcfSSatish Balay 
784a7e14dcfSSatish Balay   Input Parameters:
785441846f8SBarry Smith + tao - the Tao context
786e52336cbSBarry Smith . catol - absolute constraint tolerance, constraint norm must be less than catol for used for gatol convergence criteria
787e52336cbSBarry Smith - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for gatol, gttol convergence criteria
788a7e14dcfSSatish Balay 
789a7e14dcfSSatish Balay   Options Database Keys:
790a7e14dcfSSatish Balay + -tao_catol <catol> - Sets catol
791a7e14dcfSSatish Balay - -tao_crtol <crtol> - Sets crtol
792a7e14dcfSSatish Balay 
7936552cf8aSJason Sarich   Notes:
7946552cf8aSJason Sarich   Use PETSC_DEFAULT to leave any tolerance unchanged.
7956552cf8aSJason Sarich 
796a7e14dcfSSatish Balay   Level: intermediate
797a7e14dcfSSatish Balay 
79858417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoGetConstraintTolerances(), TaoSetTolerances()
799a7e14dcfSSatish Balay 
800a7e14dcfSSatish Balay @*/
801441846f8SBarry Smith PetscErrorCode TaoSetConstraintTolerances(Tao tao, PetscReal catol, PetscReal crtol)
802a7e14dcfSSatish Balay {
803a7e14dcfSSatish Balay   PetscErrorCode ierr;
80447a47007SBarry Smith 
805a7e14dcfSSatish Balay   PetscFunctionBegin;
806441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
807a7e14dcfSSatish Balay 
808a7e14dcfSSatish Balay   if (catol != PETSC_DEFAULT) {
809a7e14dcfSSatish Balay     if (catol<0) {
810955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative catol -- ignored.\n");CHKERRQ(ierr);
811a7e14dcfSSatish Balay     } else {
812a7e14dcfSSatish Balay       tao->catol = PetscMax(0,catol);
8136552cf8aSJason Sarich       tao->catol_changed=PETSC_TRUE;
814a7e14dcfSSatish Balay     }
815a7e14dcfSSatish Balay   }
816a7e14dcfSSatish Balay 
817a7e14dcfSSatish Balay   if (crtol != PETSC_DEFAULT) {
818a7e14dcfSSatish Balay     if (crtol<0) {
819955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative crtol -- ignored.\n");CHKERRQ(ierr);
820a7e14dcfSSatish Balay     } else {
821a7e14dcfSSatish Balay       tao->crtol = PetscMax(0,crtol);
8226552cf8aSJason Sarich       tao->crtol_changed=PETSC_TRUE;
823a7e14dcfSSatish Balay     }
824a7e14dcfSSatish Balay   }
825a7e14dcfSSatish Balay   PetscFunctionReturn(0);
826a7e14dcfSSatish Balay }
827a7e14dcfSSatish Balay 
82858417fe7SBarry Smith /*@
82958417fe7SBarry Smith   TaoGetConstraintTolerances - Gets constraint tolerance parameters used in TAO  convergence tests
83058417fe7SBarry Smith 
83158417fe7SBarry Smith   Not ollective
83258417fe7SBarry Smith 
83358417fe7SBarry Smith   Input Parameter:
83458417fe7SBarry Smith . tao - the Tao context
83558417fe7SBarry Smith 
83658417fe7SBarry Smith   Output Parameter:
837e52336cbSBarry Smith + catol - absolute constraint tolerance, constraint norm must be less than catol for used for gatol convergence criteria
838e52336cbSBarry Smith - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for gatol, gttol convergence criteria
83958417fe7SBarry Smith 
84058417fe7SBarry Smith   Level: intermediate
84158417fe7SBarry Smith 
84258417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoSetTolerances(), TaoSetConstraintTolerances()
84358417fe7SBarry Smith 
84458417fe7SBarry Smith @*/
84558417fe7SBarry Smith PetscErrorCode TaoGetConstraintTolerances(Tao tao, PetscReal *catol, PetscReal *crtol)
84658417fe7SBarry Smith {
84758417fe7SBarry Smith   PetscFunctionBegin;
84858417fe7SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
84958417fe7SBarry Smith   if (catol) *catol = tao->catol;
85058417fe7SBarry Smith   if (crtol) *crtol = tao->crtol;
85158417fe7SBarry Smith   PetscFunctionReturn(0);
85258417fe7SBarry Smith }
85358417fe7SBarry Smith 
854a7e14dcfSSatish Balay /*@
855a7e14dcfSSatish Balay    TaoSetFunctionLowerBound - Sets a bound on the solution objective value.
856a7e14dcfSSatish Balay    When an approximate solution with an objective value below this number
857a7e14dcfSSatish Balay    has been found, the solver will terminate.
858a7e14dcfSSatish Balay 
859441846f8SBarry Smith    Logically Collective on Tao
860a7e14dcfSSatish Balay 
861a7e14dcfSSatish Balay    Input Parameters:
862441846f8SBarry Smith +  tao - the Tao solver context
863a7e14dcfSSatish Balay -  fmin - the tolerance
864a7e14dcfSSatish Balay 
865a7e14dcfSSatish Balay    Options Database Keys:
866a7e14dcfSSatish Balay .    -tao_fmin <fmin> - sets the minimum function value
867a7e14dcfSSatish Balay 
868a7e14dcfSSatish Balay    Level: intermediate
869a7e14dcfSSatish Balay 
870a7e14dcfSSatish Balay .seealso: TaoSetTolerances()
871a7e14dcfSSatish Balay @*/
872441846f8SBarry Smith PetscErrorCode TaoSetFunctionLowerBound(Tao tao,PetscReal fmin)
873a7e14dcfSSatish Balay {
874a7e14dcfSSatish Balay   PetscFunctionBegin;
875441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
876a7e14dcfSSatish Balay   tao->fmin = fmin;
8776552cf8aSJason Sarich   tao->fmin_changed=PETSC_TRUE;
878a7e14dcfSSatish Balay   PetscFunctionReturn(0);
879a7e14dcfSSatish Balay }
880a7e14dcfSSatish Balay 
881a7e14dcfSSatish Balay /*@
8828e96d397SJason Sarich    TaoGetFunctionLowerBound - Gets the bound on the solution objective value.
883a7e14dcfSSatish Balay    When an approximate solution with an objective value below this number
884a7e14dcfSSatish Balay    has been found, the solver will terminate.
885a7e14dcfSSatish Balay 
886441846f8SBarry Smith    Not collective on Tao
887a7e14dcfSSatish Balay 
888a7e14dcfSSatish Balay    Input Parameters:
889441846f8SBarry Smith .  tao - the Tao solver context
890a7e14dcfSSatish Balay 
891a7e14dcfSSatish Balay    OutputParameters:
892a7e14dcfSSatish Balay .  fmin - the minimum function value
893a7e14dcfSSatish Balay 
894a7e14dcfSSatish Balay    Level: intermediate
895a7e14dcfSSatish Balay 
896a7e14dcfSSatish Balay .seealso: TaoSetFunctionLowerBound()
897a7e14dcfSSatish Balay @*/
898441846f8SBarry Smith PetscErrorCode TaoGetFunctionLowerBound(Tao tao,PetscReal *fmin)
899a7e14dcfSSatish Balay {
900a7e14dcfSSatish Balay   PetscFunctionBegin;
901441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
902a7e14dcfSSatish Balay   *fmin = tao->fmin;
903a7e14dcfSSatish Balay   PetscFunctionReturn(0);
904a7e14dcfSSatish Balay }
905a7e14dcfSSatish Balay 
906a7e14dcfSSatish Balay /*@
907a7e14dcfSSatish Balay    TaoSetMaximumFunctionEvaluations - Sets a maximum number of
908a7e14dcfSSatish Balay    function evaluations.
909a7e14dcfSSatish Balay 
910441846f8SBarry Smith    Logically Collective on Tao
911a7e14dcfSSatish Balay 
912a7e14dcfSSatish Balay    Input Parameters:
913441846f8SBarry Smith +  tao - the Tao solver context
914a7e14dcfSSatish Balay -  nfcn - the maximum number of function evaluations (>=0)
915a7e14dcfSSatish Balay 
916a7e14dcfSSatish Balay    Options Database Keys:
917a7e14dcfSSatish Balay .    -tao_max_funcs <nfcn> - sets the maximum number of function evaluations
918a7e14dcfSSatish Balay 
919a7e14dcfSSatish Balay    Level: intermediate
920a7e14dcfSSatish Balay 
921a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumIterations()
922a7e14dcfSSatish Balay @*/
923a7e14dcfSSatish Balay 
924441846f8SBarry Smith PetscErrorCode TaoSetMaximumFunctionEvaluations(Tao tao,PetscInt nfcn)
925a7e14dcfSSatish Balay {
926a7e14dcfSSatish Balay   PetscFunctionBegin;
927441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
92847a47007SBarry Smith   tao->max_funcs = PetscMax(0,nfcn);
9296552cf8aSJason Sarich   tao->max_funcs_changed=PETSC_TRUE;
930a7e14dcfSSatish Balay   PetscFunctionReturn(0);
931a7e14dcfSSatish Balay }
932a7e14dcfSSatish Balay 
933a7e14dcfSSatish Balay /*@
934a7e14dcfSSatish Balay    TaoGetMaximumFunctionEvaluations - Sets a maximum number of
935a7e14dcfSSatish Balay    function evaluations.
936a7e14dcfSSatish Balay 
937a7e14dcfSSatish Balay    Not Collective
938a7e14dcfSSatish Balay 
939a7e14dcfSSatish Balay    Input Parameters:
940441846f8SBarry Smith .  tao - the Tao solver context
941a7e14dcfSSatish Balay 
942a7e14dcfSSatish Balay    Output Parameters:
943a7e14dcfSSatish Balay .  nfcn - the maximum number of function evaluations
944a7e14dcfSSatish Balay 
945a7e14dcfSSatish Balay    Level: intermediate
946a7e14dcfSSatish Balay 
947a7e14dcfSSatish Balay .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumIterations()
948a7e14dcfSSatish Balay @*/
949a7e14dcfSSatish Balay 
950441846f8SBarry Smith PetscErrorCode TaoGetMaximumFunctionEvaluations(Tao tao,PetscInt *nfcn)
951a7e14dcfSSatish Balay {
952a7e14dcfSSatish Balay   PetscFunctionBegin;
953441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
954a7e14dcfSSatish Balay   *nfcn = tao->max_funcs;
955a7e14dcfSSatish Balay   PetscFunctionReturn(0);
956a7e14dcfSSatish Balay }
957a7e14dcfSSatish Balay 
958770232b9SCe Qin /*@
959770232b9SCe Qin    TaoGetCurrentFunctionEvaluations - Get current number of
960770232b9SCe Qin    function evaluations.
961770232b9SCe Qin 
962770232b9SCe Qin    Not Collective
963770232b9SCe Qin 
964770232b9SCe Qin    Input Parameters:
965770232b9SCe Qin .  tao - the Tao solver context
966770232b9SCe Qin 
967770232b9SCe Qin    Output Parameters:
968770232b9SCe Qin .  nfuncs - the current number of function evaluations
969770232b9SCe Qin 
970770232b9SCe Qin    Level: intermediate
971770232b9SCe Qin 
972770232b9SCe Qin .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumFunctionEvaluations(), TaoGetMaximumIterations()
973770232b9SCe Qin @*/
974770232b9SCe Qin 
975770232b9SCe Qin PetscErrorCode TaoGetCurrentFunctionEvaluations(Tao tao,PetscInt *nfuncs)
976770232b9SCe Qin {
977770232b9SCe Qin   PetscFunctionBegin;
978770232b9SCe Qin   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
979770232b9SCe Qin   *nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads);
980770232b9SCe Qin   PetscFunctionReturn(0);
981770232b9SCe Qin }
982770232b9SCe Qin 
983a7e14dcfSSatish Balay /*@
984a7e14dcfSSatish Balay    TaoSetMaximumIterations - Sets a maximum number of iterates.
985a7e14dcfSSatish Balay 
986441846f8SBarry Smith    Logically Collective on Tao
987a7e14dcfSSatish Balay 
988a7e14dcfSSatish Balay    Input Parameters:
989441846f8SBarry Smith +  tao - the Tao solver context
990a7e14dcfSSatish Balay -  maxits - the maximum number of iterates (>=0)
991a7e14dcfSSatish Balay 
992a7e14dcfSSatish Balay    Options Database Keys:
993a7e14dcfSSatish Balay .    -tao_max_it <its> - sets the maximum number of iterations
994a7e14dcfSSatish Balay 
995a7e14dcfSSatish Balay    Level: intermediate
996a7e14dcfSSatish Balay 
997a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumFunctionEvaluations()
998a7e14dcfSSatish Balay @*/
999441846f8SBarry Smith PetscErrorCode TaoSetMaximumIterations(Tao tao,PetscInt maxits)
1000a7e14dcfSSatish Balay {
1001a7e14dcfSSatish Balay   PetscFunctionBegin;
1002441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
100347a47007SBarry Smith   tao->max_it = PetscMax(0,maxits);
10046552cf8aSJason Sarich   tao->max_it_changed=PETSC_TRUE;
1005a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1006a7e14dcfSSatish Balay }
1007a7e14dcfSSatish Balay 
1008a7e14dcfSSatish Balay /*@
1009a7e14dcfSSatish Balay    TaoGetMaximumIterations - Sets a maximum number of iterates.
1010a7e14dcfSSatish Balay 
1011a7e14dcfSSatish Balay    Not Collective
1012a7e14dcfSSatish Balay 
1013a7e14dcfSSatish Balay    Input Parameters:
1014441846f8SBarry Smith .  tao - the Tao solver context
1015a7e14dcfSSatish Balay 
1016a7e14dcfSSatish Balay    Output Parameters:
1017a7e14dcfSSatish Balay .  maxits - the maximum number of iterates
1018a7e14dcfSSatish Balay 
1019a7e14dcfSSatish Balay    Level: intermediate
1020a7e14dcfSSatish Balay 
1021a7e14dcfSSatish Balay .seealso: TaoSetMaximumIterations(), TaoGetMaximumFunctionEvaluations()
1022a7e14dcfSSatish Balay @*/
1023441846f8SBarry Smith PetscErrorCode TaoGetMaximumIterations(Tao tao,PetscInt *maxits)
1024a7e14dcfSSatish Balay {
1025a7e14dcfSSatish Balay   PetscFunctionBegin;
1026441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1027a7e14dcfSSatish Balay   *maxits = tao->max_it;
1028a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1029a7e14dcfSSatish Balay }
1030a7e14dcfSSatish Balay 
1031a7e14dcfSSatish Balay /*@
1032a7e14dcfSSatish Balay    TaoSetInitialTrustRegionRadius - Sets the initial trust region radius.
1033a7e14dcfSSatish Balay 
1034441846f8SBarry Smith    Logically collective on Tao
1035a7e14dcfSSatish Balay 
1036a7e14dcfSSatish Balay    Input Parameter:
1037a7e14dcfSSatish Balay +  tao - a TAO optimization solver
1038a7e14dcfSSatish Balay -  radius - the trust region radius
1039a7e14dcfSSatish Balay 
1040a7e14dcfSSatish Balay    Level: intermediate
1041a7e14dcfSSatish Balay 
1042a7e14dcfSSatish Balay    Options Database Key:
1043a7e14dcfSSatish Balay .  -tao_trust0 <t0> - sets initial trust region radius
1044a7e14dcfSSatish Balay 
1045a7e14dcfSSatish Balay .seealso: TaoGetTrustRegionRadius(), TaoSetTrustRegionTolerance()
1046a7e14dcfSSatish Balay @*/
1047441846f8SBarry Smith PetscErrorCode TaoSetInitialTrustRegionRadius(Tao tao, PetscReal radius)
1048a7e14dcfSSatish Balay {
1049a7e14dcfSSatish Balay   PetscFunctionBegin;
1050441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1051a7e14dcfSSatish Balay   tao->trust0 = PetscMax(0.0,radius);
10526552cf8aSJason Sarich   tao->trust0_changed=PETSC_TRUE;
1053a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1054a7e14dcfSSatish Balay }
1055a7e14dcfSSatish Balay 
1056a7e14dcfSSatish Balay /*@
1057a7e14dcfSSatish Balay    TaoGetInitialTrustRegionRadius - Sets the initial trust region radius.
1058a7e14dcfSSatish Balay 
1059a7e14dcfSSatish Balay    Not Collective
1060a7e14dcfSSatish Balay 
1061a7e14dcfSSatish Balay    Input Parameter:
1062a7e14dcfSSatish Balay .  tao - a TAO optimization solver
1063a7e14dcfSSatish Balay 
1064a7e14dcfSSatish Balay    Output Parameter:
1065a7e14dcfSSatish Balay .  radius - the trust region radius
1066a7e14dcfSSatish Balay 
1067a7e14dcfSSatish Balay    Level: intermediate
1068a7e14dcfSSatish Balay 
1069a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetCurrentTrustRegionRadius()
1070a7e14dcfSSatish Balay @*/
1071441846f8SBarry Smith PetscErrorCode TaoGetInitialTrustRegionRadius(Tao tao, PetscReal *radius)
1072a7e14dcfSSatish Balay {
1073a7e14dcfSSatish Balay   PetscFunctionBegin;
1074441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1075a7e14dcfSSatish Balay   *radius = tao->trust0;
1076a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1077a7e14dcfSSatish Balay }
1078a7e14dcfSSatish Balay 
1079a7e14dcfSSatish Balay /*@
1080a7e14dcfSSatish Balay    TaoGetCurrentTrustRegionRadius - Gets the current trust region radius.
1081a7e14dcfSSatish Balay 
1082a7e14dcfSSatish Balay    Not Collective
1083a7e14dcfSSatish Balay 
1084a7e14dcfSSatish Balay    Input Parameter:
1085a7e14dcfSSatish Balay .  tao - a TAO optimization solver
1086a7e14dcfSSatish Balay 
1087a7e14dcfSSatish Balay    Output Parameter:
1088a7e14dcfSSatish Balay .  radius - the trust region radius
1089a7e14dcfSSatish Balay 
1090a7e14dcfSSatish Balay    Level: intermediate
1091a7e14dcfSSatish Balay 
1092a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetInitialTrustRegionRadius()
1093a7e14dcfSSatish Balay @*/
1094441846f8SBarry Smith PetscErrorCode TaoGetCurrentTrustRegionRadius(Tao tao, PetscReal *radius)
1095a7e14dcfSSatish Balay {
1096a7e14dcfSSatish Balay   PetscFunctionBegin;
1097441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1098a7e14dcfSSatish Balay   *radius = tao->trust;
1099a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1100a7e14dcfSSatish Balay }
1101a7e14dcfSSatish Balay 
1102a7e14dcfSSatish Balay /*@
1103a7e14dcfSSatish Balay   TaoGetTolerances - gets the current values of tolerances
1104a7e14dcfSSatish Balay 
1105a7e14dcfSSatish Balay   Not Collective
1106a7e14dcfSSatish Balay 
1107a7e14dcfSSatish Balay   Input Parameters:
1108441846f8SBarry Smith . tao - the Tao context
1109a7e14dcfSSatish Balay 
1110a7e14dcfSSatish Balay   Output Parameters:
1111e52336cbSBarry Smith + gatol - stop if norm of gradient is less than this
1112a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this
1113a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by a this factor
1114a7e14dcfSSatish Balay 
111547a47007SBarry Smith   Note: NULL can be used as an argument if not all tolerances values are needed
1116a7e14dcfSSatish Balay 
1117a7e14dcfSSatish Balay .seealso TaoSetTolerances()
1118a7e14dcfSSatish Balay 
1119a7e14dcfSSatish Balay   Level: intermediate
1120a7e14dcfSSatish Balay @*/
1121e52336cbSBarry Smith PetscErrorCode TaoGetTolerances(Tao tao, PetscReal *gatol, PetscReal *grtol, PetscReal *gttol)
1122a7e14dcfSSatish Balay {
1123a7e14dcfSSatish Balay   PetscFunctionBegin;
1124441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1125a7e14dcfSSatish Balay   if (gatol) *gatol=tao->gatol;
1126a7e14dcfSSatish Balay   if (grtol) *grtol=tao->grtol;
1127a7e14dcfSSatish Balay   if (gttol) *gttol=tao->gttol;
1128a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1129a7e14dcfSSatish Balay }
1130a7e14dcfSSatish Balay 
1131a7e14dcfSSatish Balay /*@
1132a7e14dcfSSatish Balay   TaoGetKSP - Gets the linear solver used by the optimization solver.
1133a7e14dcfSSatish Balay   Application writers should use TaoGetKSP if they need direct access
1134a7e14dcfSSatish Balay   to the PETSc KSP object.
1135a7e14dcfSSatish Balay 
1136a7e14dcfSSatish Balay   Not Collective
1137a7e14dcfSSatish Balay 
1138a7e14dcfSSatish Balay    Input Parameters:
1139a7e14dcfSSatish Balay .  tao - the TAO solver
1140a7e14dcfSSatish Balay 
1141a7e14dcfSSatish Balay    Output Parameters:
1142a7e14dcfSSatish Balay .  ksp - the KSP linear solver used in the optimization solver
1143a7e14dcfSSatish Balay 
1144a7e14dcfSSatish Balay    Level: intermediate
1145a7e14dcfSSatish Balay 
1146a7e14dcfSSatish Balay @*/
1147441846f8SBarry Smith PetscErrorCode TaoGetKSP(Tao tao, KSP *ksp)
114847a47007SBarry Smith {
1149a7e14dcfSSatish Balay   PetscFunctionBegin;
1150a7e14dcfSSatish Balay   *ksp = tao->ksp;
1151a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1152a7e14dcfSSatish Balay }
1153a7e14dcfSSatish Balay 
1154025e9500SJason Sarich /*@
1155025e9500SJason Sarich    TaoGetLinearSolveIterations - Gets the total number of linear iterations
1156025e9500SJason Sarich    used by the TAO solver
1157025e9500SJason Sarich 
1158025e9500SJason Sarich    Not Collective
1159025e9500SJason Sarich 
1160025e9500SJason Sarich    Input Parameter:
1161025e9500SJason Sarich .  tao - TAO context
1162025e9500SJason Sarich 
1163025e9500SJason Sarich    Output Parameter:
1164025e9500SJason Sarich .  lits - number of linear iterations
1165025e9500SJason Sarich 
1166025e9500SJason Sarich    Notes:
1167025e9500SJason Sarich    This counter is reset to zero for each successive call to TaoSolve()
1168025e9500SJason Sarich 
1169025e9500SJason Sarich    Level: intermediate
1170025e9500SJason Sarich 
1171025e9500SJason Sarich .keywords: TAO
1172025e9500SJason Sarich 
1173025e9500SJason Sarich .seealso:  TaoGetKSP()
1174025e9500SJason Sarich @*/
1175025e9500SJason Sarich PetscErrorCode  TaoGetLinearSolveIterations(Tao tao,PetscInt *lits)
1176025e9500SJason Sarich {
1177025e9500SJason Sarich   PetscFunctionBegin;
1178025e9500SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1179025e9500SJason Sarich   PetscValidIntPointer(lits,2);
11802d9aa51bSJason Sarich   *lits = tao->ksp_tot_its;
1181025e9500SJason Sarich   PetscFunctionReturn(0);
1182025e9500SJason Sarich }
1183025e9500SJason Sarich 
1184a7e14dcfSSatish Balay /*@
1185a7e14dcfSSatish Balay   TaoGetLineSearch - Gets the line search used by the optimization solver.
1186a7e14dcfSSatish Balay   Application writers should use TaoGetLineSearch if they need direct access
1187a7e14dcfSSatish Balay   to the TaoLineSearch object.
1188a7e14dcfSSatish Balay 
1189a7e14dcfSSatish Balay   Not Collective
1190a7e14dcfSSatish Balay 
1191a7e14dcfSSatish Balay    Input Parameters:
1192a7e14dcfSSatish Balay .  tao - the TAO solver
1193a7e14dcfSSatish Balay 
1194a7e14dcfSSatish Balay    Output Parameters:
1195a7e14dcfSSatish Balay .  ls - the line search used in the optimization solver
1196a7e14dcfSSatish Balay 
1197a7e14dcfSSatish Balay    Level: intermediate
1198a7e14dcfSSatish Balay 
1199a7e14dcfSSatish Balay @*/
1200441846f8SBarry Smith PetscErrorCode TaoGetLineSearch(Tao tao, TaoLineSearch *ls)
120147a47007SBarry Smith {
1202a7e14dcfSSatish Balay   PetscFunctionBegin;
1203a7e14dcfSSatish Balay   *ls = tao->linesearch;
1204a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1205a7e14dcfSSatish Balay }
1206a7e14dcfSSatish Balay 
1207a7e14dcfSSatish Balay /*@
1208a7e14dcfSSatish Balay   TaoAddLineSearchCounts - Adds the number of function evaluations spent
1209a7e14dcfSSatish Balay   in the line search to the running total.
1210a7e14dcfSSatish Balay 
1211a7e14dcfSSatish Balay    Input Parameters:
1212a7e14dcfSSatish Balay +  tao - the TAO solver
1213a7e14dcfSSatish Balay -  ls - the line search used in the optimization solver
1214a7e14dcfSSatish Balay 
1215a7e14dcfSSatish Balay    Level: developer
1216a7e14dcfSSatish Balay 
1217a7e14dcfSSatish Balay .seealso: TaoLineSearchApply()
1218a7e14dcfSSatish Balay @*/
1219441846f8SBarry Smith PetscErrorCode TaoAddLineSearchCounts(Tao tao)
122047a47007SBarry Smith {
1221a7e14dcfSSatish Balay   PetscErrorCode ierr;
1222a7e14dcfSSatish Balay   PetscBool      flg;
1223a7e14dcfSSatish Balay   PetscInt       nfeval,ngeval,nfgeval;
122447a47007SBarry Smith 
1225a7e14dcfSSatish Balay   PetscFunctionBegin;
1226441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1227a7e14dcfSSatish Balay   if (tao->linesearch) {
1228302440fdSBarry Smith     ierr = TaoLineSearchIsUsingTaoRoutines(tao->linesearch,&flg);CHKERRQ(ierr);
122994ae4db5SBarry Smith     if (!flg) {
123047a47007SBarry Smith       ierr = TaoLineSearchGetNumberFunctionEvaluations(tao->linesearch,&nfeval,&ngeval,&nfgeval);CHKERRQ(ierr);
1231a7e14dcfSSatish Balay       tao->nfuncs+=nfeval;
1232a7e14dcfSSatish Balay       tao->ngrads+=ngeval;
1233a7e14dcfSSatish Balay       tao->nfuncgrads+=nfgeval;
1234a7e14dcfSSatish Balay     }
1235a7e14dcfSSatish Balay   }
1236a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1237a7e14dcfSSatish Balay }
1238a7e14dcfSSatish Balay 
1239a7e14dcfSSatish Balay /*@
1240a7e14dcfSSatish Balay   TaoGetSolutionVector - Returns the vector with the current TAO solution
1241a7e14dcfSSatish Balay 
1242a7e14dcfSSatish Balay   Not Collective
1243a7e14dcfSSatish Balay 
1244a7e14dcfSSatish Balay   Input Parameter:
1245441846f8SBarry Smith . tao - the Tao context
1246a7e14dcfSSatish Balay 
1247a7e14dcfSSatish Balay   Output Parameter:
1248a7e14dcfSSatish Balay . X - the current solution
1249a7e14dcfSSatish Balay 
1250a7e14dcfSSatish Balay   Level: intermediate
1251a7e14dcfSSatish Balay 
1252a7e14dcfSSatish Balay   Note:  The returned vector will be the same object that was passed into TaoSetInitialVector()
1253a7e14dcfSSatish Balay @*/
1254441846f8SBarry Smith PetscErrorCode TaoGetSolutionVector(Tao tao, Vec *X)
1255a7e14dcfSSatish Balay {
1256a7e14dcfSSatish Balay   PetscFunctionBegin;
1257441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1258a7e14dcfSSatish Balay   *X = tao->solution;
1259a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1260a7e14dcfSSatish Balay }
1261a7e14dcfSSatish Balay 
1262a7e14dcfSSatish Balay /*@
1263a7e14dcfSSatish Balay   TaoGetGradientVector - Returns the vector with the current TAO gradient
1264a7e14dcfSSatish Balay 
1265a7e14dcfSSatish Balay   Not Collective
1266a7e14dcfSSatish Balay 
1267a7e14dcfSSatish Balay   Input Parameter:
1268441846f8SBarry Smith . tao - the Tao context
1269a7e14dcfSSatish Balay 
1270a7e14dcfSSatish Balay   Output Parameter:
1271a7e14dcfSSatish Balay . G - the current solution
1272a7e14dcfSSatish Balay 
1273a7e14dcfSSatish Balay   Level: intermediate
1274a7e14dcfSSatish Balay @*/
1275441846f8SBarry Smith PetscErrorCode TaoGetGradientVector(Tao tao, Vec *G)
1276a7e14dcfSSatish Balay {
1277a7e14dcfSSatish Balay   PetscFunctionBegin;
1278441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1279a7e14dcfSSatish Balay   *G = tao->gradient;
1280a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1281a7e14dcfSSatish Balay }
1282a7e14dcfSSatish Balay 
1283a7e14dcfSSatish Balay /*@
1284a7e14dcfSSatish Balay    TaoResetStatistics - Initialize the statistics used by TAO for all of the solvers.
1285a7e14dcfSSatish Balay    These statistics include the iteration number, residual norms, and convergence status.
1286a7e14dcfSSatish Balay    This routine gets called before solving each optimization problem.
1287a7e14dcfSSatish Balay 
1288441846f8SBarry Smith    Collective on Tao
1289a7e14dcfSSatish Balay 
1290a7e14dcfSSatish Balay    Input Parameters:
1291441846f8SBarry Smith .  solver - the Tao context
1292a7e14dcfSSatish Balay 
1293a7e14dcfSSatish Balay    Level: developer
1294a7e14dcfSSatish Balay 
1295a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
1296a7e14dcfSSatish Balay @*/
1297441846f8SBarry Smith PetscErrorCode TaoResetStatistics(Tao tao)
1298a7e14dcfSSatish Balay {
1299a7e14dcfSSatish Balay   PetscFunctionBegin;
1300441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1301a7e14dcfSSatish Balay   tao->niter        = 0;
1302a7e14dcfSSatish Balay   tao->nfuncs       = 0;
1303a7e14dcfSSatish Balay   tao->nfuncgrads   = 0;
1304a7e14dcfSSatish Balay   tao->ngrads       = 0;
1305a7e14dcfSSatish Balay   tao->nhess        = 0;
1306a7e14dcfSSatish Balay   tao->njac         = 0;
1307a7e14dcfSSatish Balay   tao->nconstraints = 0;
1308a7e14dcfSSatish Balay   tao->ksp_its      = 0;
1309ae93cb3cSJason Sarich   tao->ksp_tot_its  = 0;
1310a7e14dcfSSatish Balay   tao->reason       = TAO_CONTINUE_ITERATING;
1311a7e14dcfSSatish Balay   tao->residual     = 0.0;
1312a7e14dcfSSatish Balay   tao->cnorm        = 0.0;
1313a7e14dcfSSatish Balay   tao->step         = 0.0;
1314a7e14dcfSSatish Balay   tao->lsflag       = PETSC_FALSE;
1315a7e14dcfSSatish Balay   if (tao->hist_reset) tao->hist_len=0;
1316a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1317a7e14dcfSSatish Balay }
1318a7e14dcfSSatish Balay 
1319a7e14dcfSSatish Balay /*@C
1320a7e14dcfSSatish Balay   TaoSetConvergenceTest - Sets the function that is to be used to test
1321a7e14dcfSSatish Balay   for convergence o fthe iterative minimization solution.  The new convergence
1322a7e14dcfSSatish Balay   testing routine will replace TAO's default convergence test.
1323a7e14dcfSSatish Balay 
1324441846f8SBarry Smith   Logically Collective on Tao
1325a7e14dcfSSatish Balay 
1326a7e14dcfSSatish Balay   Input Parameters:
1327441846f8SBarry Smith + tao - the Tao object
1328a7e14dcfSSatish Balay . conv - the routine to test for convergence
1329a7e14dcfSSatish Balay - ctx - [optional] context for private data for the convergence routine
133047a47007SBarry Smith         (may be NULL)
1331a7e14dcfSSatish Balay 
1332a7e14dcfSSatish Balay   Calling sequence of conv:
1333441846f8SBarry Smith $   PetscErrorCode conv(Tao tao, void *ctx)
1334a7e14dcfSSatish Balay 
1335441846f8SBarry Smith + tao - the Tao object
1336a7e14dcfSSatish Balay - ctx - [optional] convergence context
1337a7e14dcfSSatish Balay 
1338e4cb33bbSBarry Smith   Note: The new convergence testing routine should call TaoSetConvergedReason().
1339a7e14dcfSSatish Balay 
1340a7e14dcfSSatish Balay   Level: advanced
1341a7e14dcfSSatish Balay 
1342e4cb33bbSBarry Smith .seealso: TaoSetConvergedReason(), TaoGetSolutionStatus(), TaoGetTolerances(), TaoSetMonitor
1343a7e14dcfSSatish Balay 
1344a7e14dcfSSatish Balay @*/
1345441846f8SBarry Smith PetscErrorCode TaoSetConvergenceTest(Tao tao, PetscErrorCode (*conv)(Tao,void*), void *ctx)
1346a7e14dcfSSatish Balay {
1347a7e14dcfSSatish Balay   PetscFunctionBegin;
1348441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1349a7e14dcfSSatish Balay   (tao)->ops->convergencetest = conv;
1350a7e14dcfSSatish Balay   (tao)->cnvP = ctx;
1351a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1352a7e14dcfSSatish Balay }
1353a7e14dcfSSatish Balay 
1354a7e14dcfSSatish Balay /*@C
1355a7e14dcfSSatish Balay    TaoSetMonitor - Sets an ADDITIONAL function that is to be used at every
1356a7e14dcfSSatish Balay    iteration of the solver to display the iteration's
1357a7e14dcfSSatish Balay    progress.
1358a7e14dcfSSatish Balay 
1359441846f8SBarry Smith    Logically Collective on Tao
1360a7e14dcfSSatish Balay 
1361a7e14dcfSSatish Balay    Input Parameters:
1362441846f8SBarry Smith +  tao - the Tao solver context
1363a7e14dcfSSatish Balay .  mymonitor - monitoring routine
1364a7e14dcfSSatish Balay -  mctx - [optional] user-defined context for private data for the
136547a47007SBarry Smith           monitor routine (may be NULL)
1366a7e14dcfSSatish Balay 
1367a7e14dcfSSatish Balay    Calling sequence of mymonitor:
1368441846f8SBarry Smith $     int mymonitor(Tao tao,void *mctx)
1369a7e14dcfSSatish Balay 
1370441846f8SBarry Smith +    tao - the Tao solver context
1371a7e14dcfSSatish Balay -    mctx - [optional] monitoring context
1372a7e14dcfSSatish Balay 
1373a7e14dcfSSatish Balay 
1374a7e14dcfSSatish Balay    Options Database Keys:
137598ea980cSBarry Smith +    -tao_monitor        - sets TaoMonitorDefault()
1376a7e14dcfSSatish Balay .    -tao_smonitor       - sets short monitor
1377a7e14dcfSSatish Balay .    -tao_cmonitor       - same as smonitor plus constraint norm
1378a7e14dcfSSatish Balay .    -tao_view_solution   - view solution at each iteration
1379a7e14dcfSSatish Balay .    -tao_view_gradient   - view gradient at each iteration
1380a7e14dcfSSatish Balay .    -tao_view_separableobjective - view separable objective function at each iteration
1381a7e14dcfSSatish 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.
1382a7e14dcfSSatish Balay 
1383a7e14dcfSSatish Balay 
1384a7e14dcfSSatish Balay    Notes:
1385a7e14dcfSSatish Balay    Several different monitoring routines may be set by calling
1386a7e14dcfSSatish Balay    TaoSetMonitor() multiple times; all will be called in the
1387a7e14dcfSSatish Balay    order in which they were set.
1388a7e14dcfSSatish Balay 
1389a7e14dcfSSatish Balay    Fortran Notes: Only one monitor function may be set
1390a7e14dcfSSatish Balay 
1391a7e14dcfSSatish Balay    Level: intermediate
1392a7e14dcfSSatish Balay 
139398ea980cSBarry Smith .seealso: TaoMonitorDefault(), TaoCancelMonitors(),  TaoSetDestroyRoutine()
1394a7e14dcfSSatish Balay @*/
1395441846f8SBarry Smith PetscErrorCode TaoSetMonitor(Tao tao, PetscErrorCode (*func)(Tao, void*), void *ctx,PetscErrorCode (*dest)(void**))
1396a7e14dcfSSatish Balay {
139708d19d1fSJason Sarich   PetscErrorCode ierr;
139808d19d1fSJason Sarich   PetscInt       i;
139908d19d1fSJason Sarich 
1400a7e14dcfSSatish Balay   PetscFunctionBegin;
1401441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
140247a47007SBarry Smith   if (tao->numbermonitors >= MAXTAOMONITORS) SETERRQ1(PETSC_COMM_SELF,1,"Cannot attach another monitor -- max=",MAXTAOMONITORS);
140308d19d1fSJason Sarich 
140408d19d1fSJason Sarich   for (i=0; i<tao->numbermonitors;i++) {
140508d19d1fSJason Sarich     if (func == tao->monitor[i] && dest == tao->monitordestroy[i] && ctx == tao->monitorcontext[i]) {
140608d19d1fSJason Sarich       if (dest) {
140708d19d1fSJason Sarich         ierr = (*dest)(&ctx);CHKERRQ(ierr);
140808d19d1fSJason Sarich       }
140908d19d1fSJason Sarich       PetscFunctionReturn(0);
141008d19d1fSJason Sarich     }
141108d19d1fSJason Sarich   }
1412a7e14dcfSSatish Balay   tao->monitor[tao->numbermonitors] = func;
1413a7e14dcfSSatish Balay   tao->monitorcontext[tao->numbermonitors] = ctx;
1414a7e14dcfSSatish Balay   tao->monitordestroy[tao->numbermonitors] = dest;
1415a7e14dcfSSatish Balay   ++tao->numbermonitors;
1416a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1417a7e14dcfSSatish Balay }
1418a7e14dcfSSatish Balay 
1419a7e14dcfSSatish Balay /*@
1420441846f8SBarry Smith    TaoCancelMonitors - Clears all the monitor functions for a Tao object.
1421a7e14dcfSSatish Balay 
1422441846f8SBarry Smith    Logically Collective on Tao
1423a7e14dcfSSatish Balay 
1424a7e14dcfSSatish Balay    Input Parameters:
1425441846f8SBarry Smith .  tao - the Tao solver context
1426a7e14dcfSSatish Balay 
1427a7e14dcfSSatish Balay    Options Database:
1428a7e14dcfSSatish Balay .  -tao_cancelmonitors - cancels all monitors that have been hardwired
1429a7e14dcfSSatish Balay     into a code by calls to TaoSetMonitor(), but does not cancel those
1430a7e14dcfSSatish Balay     set via the options database
1431a7e14dcfSSatish Balay 
1432a7e14dcfSSatish Balay    Notes:
1433441846f8SBarry Smith    There is no way to clear one specific monitor from a Tao object.
1434a7e14dcfSSatish Balay 
1435a7e14dcfSSatish Balay    Level: advanced
1436a7e14dcfSSatish Balay 
143798ea980cSBarry Smith .seealso: TaoMonitorDefault(), TaoSetMonitor()
1438a7e14dcfSSatish Balay @*/
1439441846f8SBarry Smith PetscErrorCode TaoCancelMonitors(Tao tao)
1440a7e14dcfSSatish Balay {
1441a7e14dcfSSatish Balay   PetscInt       i;
1442a7e14dcfSSatish Balay   PetscErrorCode ierr;
144347a47007SBarry Smith 
1444a7e14dcfSSatish Balay   PetscFunctionBegin;
1445441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1446a7e14dcfSSatish Balay   for (i=0;i<tao->numbermonitors;i++) {
1447a7e14dcfSSatish Balay     if (tao->monitordestroy[i]) {
1448a7e14dcfSSatish Balay       ierr = (*tao->monitordestroy[i])(&tao->monitorcontext[i]);CHKERRQ(ierr);
1449a7e14dcfSSatish Balay     }
1450a7e14dcfSSatish Balay   }
1451a7e14dcfSSatish Balay   tao->numbermonitors=0;
1452a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1453a7e14dcfSSatish Balay }
1454a7e14dcfSSatish Balay 
14557fab98ebSJason Sarich /*@
145698ea980cSBarry Smith    TaoMonitorDefault - Default routine for monitoring progress of the
1457441846f8SBarry Smith    Tao solvers (default).  This monitor prints the function value and gradient
1458a7e14dcfSSatish Balay    norm at each iteration.  It can be turned on from the command line using the
1459a7e14dcfSSatish Balay    -tao_monitor option
1460a7e14dcfSSatish Balay 
1461441846f8SBarry Smith    Collective on Tao
1462a7e14dcfSSatish Balay 
1463a7e14dcfSSatish Balay    Input Parameters:
1464441846f8SBarry Smith +  tao - the Tao context
146547a47007SBarry Smith -  ctx - PetscViewer context or NULL
1466a7e14dcfSSatish Balay 
1467a7e14dcfSSatish Balay    Options Database Keys:
1468a7e14dcfSSatish Balay .  -tao_monitor
1469a7e14dcfSSatish Balay 
1470a7e14dcfSSatish Balay    Level: advanced
1471a7e14dcfSSatish Balay 
1472a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1473a7e14dcfSSatish Balay @*/
147498ea980cSBarry Smith PetscErrorCode TaoMonitorDefault(Tao tao, void *ctx)
1475a7e14dcfSSatish Balay {
1476a7e14dcfSSatish Balay   PetscErrorCode ierr;
1477a7e14dcfSSatish Balay   PetscInt       its;
1478a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
14798163d661SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
148047a47007SBarry Smith 
1481a7e14dcfSSatish Balay   PetscFunctionBegin;
14828163d661SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1483a7e14dcfSSatish Balay   its=tao->niter;
1484a7e14dcfSSatish Balay   fct=tao->fc;
1485a7e14dcfSSatish Balay   gnorm=tao->residual;
148698ea980cSBarry Smith   ierr=PetscViewerASCIIPrintf(viewer,"%3D TAO,",its);CHKERRQ(ierr);
148747a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr);
148808d19d1fSJason Sarich   if (gnorm >= PETSC_INFINITY) {
148908d19d1fSJason Sarich     ierr=PetscViewerASCIIPrintf(viewer,"  Residual: Inf \n");CHKERRQ(ierr);
149008d19d1fSJason Sarich   } else {
149147a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer,"  Residual: %g \n",(double)gnorm);CHKERRQ(ierr);
149208d19d1fSJason Sarich   }
1493a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1494a7e14dcfSSatish Balay }
1495a7e14dcfSSatish Balay 
14967fab98ebSJason Sarich /*@
1497a7e14dcfSSatish Balay    TaoDefaultSMonitor - Default routine for monitoring progress of the
149898ea980cSBarry Smith    solver. Same as TaoMonitorDefault() except
1499a7e14dcfSSatish Balay    it prints fewer digits of the residual as the residual gets smaller.
1500a7e14dcfSSatish Balay    This is because the later digits are meaningless and are often
1501a7e14dcfSSatish Balay    different on different machines; by using this routine different
1502a7e14dcfSSatish Balay    machines will usually generate the same output. It can be turned on
1503a7e14dcfSSatish Balay    by using the -tao_smonitor option
1504a7e14dcfSSatish Balay 
1505441846f8SBarry Smith    Collective on Tao
1506a7e14dcfSSatish Balay 
1507a7e14dcfSSatish Balay    Input Parameters:
1508441846f8SBarry Smith +  tao - the Tao context
15094d4332d5SBarry Smith -  ctx - PetscViewer context of type ASCII
1510a7e14dcfSSatish Balay 
1511a7e14dcfSSatish Balay    Options Database Keys:
1512a7e14dcfSSatish Balay .  -tao_smonitor
1513a7e14dcfSSatish Balay 
1514a7e14dcfSSatish Balay    Level: advanced
1515a7e14dcfSSatish Balay 
151698ea980cSBarry Smith .seealso: TaoMonitorDefault(), TaoSetMonitor()
1517a7e14dcfSSatish Balay @*/
1518441846f8SBarry Smith PetscErrorCode TaoDefaultSMonitor(Tao tao, void *ctx)
1519a7e14dcfSSatish Balay {
1520a7e14dcfSSatish Balay   PetscErrorCode ierr;
1521a7e14dcfSSatish Balay   PetscInt       its;
1522a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
15234d4332d5SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
152447a47007SBarry Smith 
1525a7e14dcfSSatish Balay   PetscFunctionBegin;
15264d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1527a7e14dcfSSatish Balay   its=tao->niter;
1528a7e14dcfSSatish Balay   fct=tao->fc;
1529a7e14dcfSSatish Balay   gnorm=tao->residual;
1530a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr);
153147a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value %g,",(double)fct);CHKERRQ(ierr);
1532d393f493SBarry Smith   if (gnorm >= PETSC_INFINITY) {
153308d19d1fSJason Sarich     ierr=PetscViewerASCIIPrintf(viewer," Residual: Inf \n");CHKERRQ(ierr);
153408d19d1fSJason Sarich   } else if (gnorm > 1.e-6) {
153547a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr);
1536a7e14dcfSSatish Balay   } else if (gnorm > 1.e-11) {
1537a7e14dcfSSatish Balay     ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-6 \n");CHKERRQ(ierr);
1538a7e14dcfSSatish Balay   } else {
1539a7e14dcfSSatish Balay     ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-11 \n");CHKERRQ(ierr);
1540a7e14dcfSSatish Balay   }
1541a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1542a7e14dcfSSatish Balay }
1543a7e14dcfSSatish Balay 
15447fab98ebSJason Sarich /*@
154598ea980cSBarry Smith    TaoDefaultCMonitor - same as TaoMonitorDefault() except
1546a7e14dcfSSatish Balay    it prints the norm of the constraints function. It can be turned on
1547a7e14dcfSSatish Balay    from the command line using the -tao_cmonitor option
1548a7e14dcfSSatish Balay 
1549441846f8SBarry Smith    Collective on Tao
1550a7e14dcfSSatish Balay 
1551a7e14dcfSSatish Balay    Input Parameters:
1552441846f8SBarry Smith +  tao - the Tao context
155347a47007SBarry Smith -  ctx - PetscViewer context or NULL
1554a7e14dcfSSatish Balay 
1555a7e14dcfSSatish Balay    Options Database Keys:
1556a7e14dcfSSatish Balay .  -tao_cmonitor
1557a7e14dcfSSatish Balay 
1558a7e14dcfSSatish Balay    Level: advanced
1559a7e14dcfSSatish Balay 
156098ea980cSBarry Smith .seealso: TaoMonitorDefault(), TaoSetMonitor()
1561a7e14dcfSSatish Balay @*/
1562441846f8SBarry Smith PetscErrorCode TaoDefaultCMonitor(Tao tao, void *ctx)
1563a7e14dcfSSatish Balay {
1564a7e14dcfSSatish Balay   PetscErrorCode ierr;
1565a7e14dcfSSatish Balay   PetscInt       its;
1566a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1567d393f493SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
1568a7e14dcfSSatish Balay 
1569a7e14dcfSSatish Balay   PetscFunctionBegin;
1570d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1571a7e14dcfSSatish Balay   its=tao->niter;
1572a7e14dcfSSatish Balay   fct=tao->fc;
1573a7e14dcfSSatish Balay   gnorm=tao->residual;
1574a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %D,",its);CHKERRQ(ierr);
157547a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr);
157647a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer,"  Residual: %g ",(double)gnorm);CHKERRQ(ierr);
157747a47007SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"  Constraint: %g \n",(double)tao->cnorm);CHKERRQ(ierr);
1578a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1579a7e14dcfSSatish Balay }
1580a7e14dcfSSatish Balay 
1581a7e14dcfSSatish Balay /*@C
1582a7e14dcfSSatish Balay    TaoSolutionMonitor - Views the solution at each iteration
1583a7e14dcfSSatish Balay    It can be turned on from the command line using the
1584a7e14dcfSSatish Balay    -tao_view_solution option
1585a7e14dcfSSatish Balay 
1586441846f8SBarry Smith    Collective on Tao
1587a7e14dcfSSatish Balay 
1588a7e14dcfSSatish Balay    Input Parameters:
1589441846f8SBarry Smith +  tao - the Tao context
159047a47007SBarry Smith -  ctx - PetscViewer context or NULL
1591a7e14dcfSSatish Balay 
1592a7e14dcfSSatish Balay    Options Database Keys:
1593a7e14dcfSSatish Balay .  -tao_view_solution
1594a7e14dcfSSatish Balay 
1595a7e14dcfSSatish Balay    Level: advanced
1596a7e14dcfSSatish Balay 
1597a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1598a7e14dcfSSatish Balay @*/
1599441846f8SBarry Smith PetscErrorCode TaoSolutionMonitor(Tao tao, void *ctx)
1600a7e14dcfSSatish Balay {
1601a7e14dcfSSatish Balay   PetscErrorCode ierr;
1602d393f493SBarry Smith   PetscViewer    viewer  = (PetscViewer)ctx;;
160347a47007SBarry Smith 
1604a7e14dcfSSatish Balay   PetscFunctionBegin;
1605d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1606a7e14dcfSSatish Balay   ierr = VecView(tao->solution, viewer);CHKERRQ(ierr);
1607a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1608a7e14dcfSSatish Balay }
1609a7e14dcfSSatish Balay 
1610a7e14dcfSSatish Balay /*@C
1611a7e14dcfSSatish Balay    TaoGradientMonitor - Views the gradient at each iteration
1612a7e14dcfSSatish Balay    It can be turned on from the command line using the
1613a7e14dcfSSatish Balay    -tao_view_gradient option
1614a7e14dcfSSatish Balay 
1615441846f8SBarry Smith    Collective on Tao
1616a7e14dcfSSatish Balay 
1617a7e14dcfSSatish Balay    Input Parameters:
1618441846f8SBarry Smith +  tao - the Tao context
161947a47007SBarry Smith -  ctx - PetscViewer context or NULL
1620a7e14dcfSSatish Balay 
1621a7e14dcfSSatish Balay    Options Database Keys:
1622a7e14dcfSSatish Balay .  -tao_view_gradient
1623a7e14dcfSSatish Balay 
1624a7e14dcfSSatish Balay    Level: advanced
1625a7e14dcfSSatish Balay 
1626a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1627a7e14dcfSSatish Balay @*/
1628441846f8SBarry Smith PetscErrorCode TaoGradientMonitor(Tao tao, void *ctx)
1629a7e14dcfSSatish Balay {
1630a7e14dcfSSatish Balay   PetscErrorCode ierr;
1631d393f493SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
163247a47007SBarry Smith 
1633a7e14dcfSSatish Balay   PetscFunctionBegin;
1634d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1635a7e14dcfSSatish Balay   ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr);
1636a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1637a7e14dcfSSatish Balay }
1638a7e14dcfSSatish Balay 
1639a7e14dcfSSatish Balay /*@C
1640a7e14dcfSSatish Balay    TaoStepDirectionMonitor - Views the gradient at each iteration
1641a7e14dcfSSatish Balay    It can be turned on from the command line using the
1642a7e14dcfSSatish Balay    -tao_view_gradient option
1643a7e14dcfSSatish Balay 
1644441846f8SBarry Smith    Collective on Tao
1645a7e14dcfSSatish Balay 
1646a7e14dcfSSatish Balay    Input Parameters:
1647441846f8SBarry Smith +  tao - the Tao context
164847a47007SBarry Smith -  ctx - PetscViewer context or NULL
1649a7e14dcfSSatish Balay 
1650a7e14dcfSSatish Balay    Options Database Keys:
1651a7e14dcfSSatish Balay .  -tao_view_gradient
1652a7e14dcfSSatish Balay 
1653a7e14dcfSSatish Balay    Level: advanced
1654a7e14dcfSSatish Balay 
1655a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1656a7e14dcfSSatish Balay @*/
1657441846f8SBarry Smith PetscErrorCode TaoStepDirectionMonitor(Tao tao, void *ctx)
1658a7e14dcfSSatish Balay {
1659a7e14dcfSSatish Balay   PetscErrorCode ierr;
1660d393f493SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
1661d393f493SBarry Smith 
1662a7e14dcfSSatish Balay   PetscFunctionBegin;
1663d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1664a7e14dcfSSatish Balay   ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr);
1665a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1666a7e14dcfSSatish Balay }
1667a7e14dcfSSatish Balay 
1668a7e14dcfSSatish Balay /*@C
1669a7e14dcfSSatish Balay    TaoDrawSolutionMonitor - Plots the solution at each iteration
1670a7e14dcfSSatish Balay    It can be turned on from the command line using the
1671a7e14dcfSSatish Balay    -tao_draw_solution option
1672a7e14dcfSSatish Balay 
1673441846f8SBarry Smith    Collective on Tao
1674a7e14dcfSSatish Balay 
1675a7e14dcfSSatish Balay    Input Parameters:
1676441846f8SBarry Smith +  tao - the Tao context
1677e882e171SHong Zhang -  ctx - TaoMonitorDraw context
1678a7e14dcfSSatish Balay 
1679a7e14dcfSSatish Balay    Options Database Keys:
1680a7e14dcfSSatish Balay .  -tao_draw_solution
1681a7e14dcfSSatish Balay 
1682a7e14dcfSSatish Balay    Level: advanced
1683a7e14dcfSSatish Balay 
1684a7e14dcfSSatish Balay .seealso: TaoSolutionMonitor(), TaoSetMonitor(), TaoDrawGradientMonitor
1685a7e14dcfSSatish Balay @*/
1686441846f8SBarry Smith PetscErrorCode TaoDrawSolutionMonitor(Tao tao, void *ctx)
1687a7e14dcfSSatish Balay {
1688a7e14dcfSSatish Balay   PetscErrorCode    ierr;
1689e882e171SHong Zhang   TaoMonitorDrawCtx ictx = (TaoMonitorDrawCtx)ctx;
169047a47007SBarry Smith 
1691a7e14dcfSSatish Balay   PetscFunctionBegin;
1692e882e171SHong Zhang   if (!(((ictx->howoften > 0) && (!(tao->niter % ictx->howoften))) || ((ictx->howoften == -1) && tao->reason))) PetscFunctionReturn(0);
1693e882e171SHong Zhang   ierr = VecView(tao->solution,ictx->viewer);CHKERRQ(ierr);
1694a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1695a7e14dcfSSatish Balay }
1696a7e14dcfSSatish Balay 
1697a7e14dcfSSatish Balay /*@C
1698a7e14dcfSSatish Balay    TaoDrawGradientMonitor - Plots the gradient at each iteration
1699a7e14dcfSSatish Balay    It can be turned on from the command line using the
1700a7e14dcfSSatish Balay    -tao_draw_gradient option
1701a7e14dcfSSatish Balay 
1702441846f8SBarry Smith    Collective on Tao
1703a7e14dcfSSatish Balay 
1704a7e14dcfSSatish Balay    Input Parameters:
1705441846f8SBarry Smith +  tao - the Tao context
1706f55353a2SBarry Smith -  ctx - PetscViewer context
1707a7e14dcfSSatish Balay 
1708a7e14dcfSSatish Balay    Options Database Keys:
1709a7e14dcfSSatish Balay .  -tao_draw_gradient
1710a7e14dcfSSatish Balay 
1711a7e14dcfSSatish Balay    Level: advanced
1712a7e14dcfSSatish Balay 
1713a7e14dcfSSatish Balay .seealso: TaoGradientMonitor(), TaoSetMonitor(), TaoDrawSolutionMonitor
1714a7e14dcfSSatish Balay @*/
1715441846f8SBarry Smith PetscErrorCode TaoDrawGradientMonitor(Tao tao, void *ctx)
1716a7e14dcfSSatish Balay {
1717a7e14dcfSSatish Balay   PetscErrorCode    ierr;
1718e882e171SHong Zhang   TaoMonitorDrawCtx ictx = (TaoMonitorDrawCtx)ctx;
171947a47007SBarry Smith 
1720a7e14dcfSSatish Balay   PetscFunctionBegin;
1721e882e171SHong Zhang   if (!(((ictx->howoften > 0) && (!(tao->niter % ictx->howoften))) || ((ictx->howoften == -1) && tao->reason))) PetscFunctionReturn(0);
1722e882e171SHong Zhang   ierr = VecView(tao->gradient,ictx->viewer);CHKERRQ(ierr);
1723a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1724a7e14dcfSSatish Balay }
1725a7e14dcfSSatish Balay 
1726a7e14dcfSSatish Balay /*@C
1727a7e14dcfSSatish Balay    TaoDrawStepMonitor - Plots the step direction at each iteration
1728a7e14dcfSSatish Balay    It can be turned on from the command line using the
1729a7e14dcfSSatish Balay    -tao_draw_step option
1730a7e14dcfSSatish Balay 
1731441846f8SBarry Smith    Collective on Tao
1732a7e14dcfSSatish Balay 
1733a7e14dcfSSatish Balay    Input Parameters:
1734441846f8SBarry Smith +  tao - the Tao context
1735f55353a2SBarry Smith -  ctx - PetscViewer context
1736a7e14dcfSSatish Balay 
1737a7e14dcfSSatish Balay    Options Database Keys:
1738a7e14dcfSSatish Balay .  -tao_draw_step
1739a7e14dcfSSatish Balay 
1740a7e14dcfSSatish Balay    Level: advanced
1741a7e14dcfSSatish Balay 
1742a7e14dcfSSatish Balay .seealso: TaoSetMonitor(), TaoDrawSolutionMonitor
1743a7e14dcfSSatish Balay @*/
1744441846f8SBarry Smith PetscErrorCode TaoDrawStepMonitor(Tao tao, void *ctx)
1745a7e14dcfSSatish Balay {
1746a7e14dcfSSatish Balay   PetscErrorCode ierr;
1747a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer)(ctx);
174847a47007SBarry Smith 
1749a7e14dcfSSatish Balay   PetscFunctionBegin;
1750a7e14dcfSSatish Balay   ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr);
1751a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1752a7e14dcfSSatish Balay }
1753a7e14dcfSSatish Balay 
1754a7e14dcfSSatish Balay /*@C
1755a7e14dcfSSatish Balay    TaoSeparableObjectiveMonitor - Views the separable objective function at each iteration
1756a7e14dcfSSatish Balay    It can be turned on from the command line using the
1757a7e14dcfSSatish Balay    -tao_view_separableobjective option
1758a7e14dcfSSatish Balay 
1759441846f8SBarry Smith    Collective on Tao
1760a7e14dcfSSatish Balay 
1761a7e14dcfSSatish Balay    Input Parameters:
1762441846f8SBarry Smith +  tao - the Tao context
176347a47007SBarry Smith -  ctx - PetscViewer context or NULL
1764a7e14dcfSSatish Balay 
1765a7e14dcfSSatish Balay    Options Database Keys:
1766a7e14dcfSSatish Balay .  -tao_view_separableobjective
1767a7e14dcfSSatish Balay 
1768a7e14dcfSSatish Balay    Level: advanced
1769a7e14dcfSSatish Balay 
1770a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1771a7e14dcfSSatish Balay @*/
1772441846f8SBarry Smith PetscErrorCode TaoSeparableObjectiveMonitor(Tao tao, void *ctx)
1773a7e14dcfSSatish Balay {
1774a7e14dcfSSatish Balay   PetscErrorCode ierr;
1775d393f493SBarry Smith   PetscViewer    viewer  = (PetscViewer)ctx;
177647a47007SBarry Smith 
1777a7e14dcfSSatish Balay   PetscFunctionBegin;
1778d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1779a7e14dcfSSatish Balay   ierr = VecView(tao->sep_objective,viewer);CHKERRQ(ierr);
1780a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1781a7e14dcfSSatish Balay }
1782a7e14dcfSSatish Balay 
17837fab98ebSJason Sarich /*@
1784a7e14dcfSSatish Balay    TaoDefaultConvergenceTest - Determines whether the solver should continue iterating
1785a7e14dcfSSatish Balay    or terminate.
1786a7e14dcfSSatish Balay 
1787441846f8SBarry Smith    Collective on Tao
1788a7e14dcfSSatish Balay 
1789a7e14dcfSSatish Balay    Input Parameters:
1790441846f8SBarry Smith +  tao - the Tao context
1791a7e14dcfSSatish Balay -  dummy - unused dummy context
1792a7e14dcfSSatish Balay 
1793a7e14dcfSSatish Balay    Output Parameter:
1794a7e14dcfSSatish Balay .  reason - for terminating
1795a7e14dcfSSatish Balay 
1796a7e14dcfSSatish Balay    Notes:
1797a7e14dcfSSatish Balay    This routine checks the residual in the optimality conditions, the
1798a7e14dcfSSatish Balay    relative residual in the optimity conditions, the number of function
1799a7e14dcfSSatish Balay    evaluations, and the function value to test convergence.  Some
1800a7e14dcfSSatish Balay    solvers may use different convergence routines.
1801a7e14dcfSSatish Balay 
1802a7e14dcfSSatish Balay    Level: developer
1803a7e14dcfSSatish Balay 
1804e4cb33bbSBarry Smith .seealso: TaoSetTolerances(),TaoGetConvergedReason(),TaoSetConvergedReason()
1805a7e14dcfSSatish Balay @*/
1806a7e14dcfSSatish Balay 
1807441846f8SBarry Smith PetscErrorCode TaoDefaultConvergenceTest(Tao tao,void *dummy)
1808a7e14dcfSSatish Balay {
1809a7e14dcfSSatish Balay   PetscInt           niter=tao->niter, nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads);
1810a7e14dcfSSatish Balay   PetscInt           max_funcs=tao->max_funcs;
1811a7e14dcfSSatish Balay   PetscReal          gnorm=tao->residual, gnorm0=tao->gnorm0;
1812a7e14dcfSSatish Balay   PetscReal          f=tao->fc, steptol=tao->steptol,trradius=tao->step;
1813a7e14dcfSSatish Balay   PetscReal          gatol=tao->gatol,grtol=tao->grtol,gttol=tao->gttol;
1814e52336cbSBarry Smith   PetscReal          catol=tao->catol,crtol=tao->crtol;
1815e52336cbSBarry Smith   PetscReal          fmin=tao->fmin, cnorm=tao->cnorm;
1816e4cb33bbSBarry Smith   TaoConvergedReason reason=tao->reason;
1817a7e14dcfSSatish Balay   PetscErrorCode     ierr;
1818a7e14dcfSSatish Balay 
1819a7e14dcfSSatish Balay   PetscFunctionBegin;
1820441846f8SBarry Smith   PetscValidHeaderSpecific(tao, TAO_CLASSID,1);
1821a7e14dcfSSatish Balay   if (reason != TAO_CONTINUE_ITERATING) {
1822a7e14dcfSSatish Balay     PetscFunctionReturn(0);
1823a7e14dcfSSatish Balay   }
1824a7e14dcfSSatish Balay 
1825a7e14dcfSSatish Balay   if (PetscIsInfOrNanReal(f)) {
1826a7e14dcfSSatish Balay     ierr = PetscInfo(tao,"Failed to converged, function value is Inf or NaN\n");CHKERRQ(ierr);
1827a7e14dcfSSatish Balay     reason = TAO_DIVERGED_NAN;
1828a7e14dcfSSatish Balay   } else if (f <= fmin && cnorm <=catol) {
182947a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to function value %g < minimum function value %g\n", (double)f,(double)fmin);CHKERRQ(ierr);
1830a7e14dcfSSatish Balay     reason = TAO_CONVERGED_MINF;
1831a7e14dcfSSatish Balay   } else if (gnorm<= gatol && cnorm <=catol) {
183247a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to residual norm ||g(X)||=%g < %g\n",(double)gnorm,(double)gatol);CHKERRQ(ierr);
1833a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GATOL;
1834a7e14dcfSSatish Balay   } else if ( f!=0 && PetscAbsReal(gnorm/f) <= grtol && cnorm <= crtol) {
183547a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to residual ||g(X)||/|f(X)| =%g < %g\n",(double)(gnorm/f),(double)grtol);CHKERRQ(ierr);
1836a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GRTOL;
1837e1d16bb9SBarry Smith   } else if (gnorm0 != 0 && ((gttol == 0 && gnorm == 0) || gnorm/gnorm0 < gttol) && cnorm <= crtol) {
183847a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to relative residual norm ||g(X)||/||g(X0)|| = %g < %g\n",(double)(gnorm/gnorm0),(double)gttol);CHKERRQ(ierr);
1839a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GTTOL;
1840a7e14dcfSSatish Balay   } else if (nfuncs > max_funcs){
1841a7e14dcfSSatish Balay     ierr = PetscInfo2(tao,"Exceeded maximum number of function evaluations: %D > %D\n", nfuncs,max_funcs);CHKERRQ(ierr);
1842a7e14dcfSSatish Balay     reason = TAO_DIVERGED_MAXFCN;
1843a7e14dcfSSatish Balay   } else if ( tao->lsflag != 0 ){
1844a7e14dcfSSatish Balay     ierr = PetscInfo(tao,"Tao Line Search failure.\n");CHKERRQ(ierr);
1845a7e14dcfSSatish Balay     reason = TAO_DIVERGED_LS_FAILURE;
1846a7e14dcfSSatish Balay   } else if (trradius < steptol && niter > 0){
184747a47007SBarry Smith     ierr = PetscInfo2(tao,"Trust region/step size too small: %g < %g\n", (double)trradius,(double)steptol);CHKERRQ(ierr);
1848a7e14dcfSSatish Balay     reason = TAO_CONVERGED_STEPTOL;
1849a7e14dcfSSatish Balay   } else if (niter > tao->max_it) {
1850a7e14dcfSSatish Balay     ierr = PetscInfo2(tao,"Exceeded maximum number of iterations: %D > %D\n",niter,tao->max_it);CHKERRQ(ierr);
1851a7e14dcfSSatish Balay     reason = TAO_DIVERGED_MAXITS;
1852a7e14dcfSSatish Balay   } else {
1853a7e14dcfSSatish Balay     reason = TAO_CONTINUE_ITERATING;
1854a7e14dcfSSatish Balay   }
1855a7e14dcfSSatish Balay   tao->reason = reason;
1856a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1857a7e14dcfSSatish Balay }
1858a7e14dcfSSatish Balay 
1859a7e14dcfSSatish Balay /*@C
1860a7e14dcfSSatish Balay    TaoSetOptionsPrefix - Sets the prefix used for searching for all
1861a7e14dcfSSatish Balay    TAO options in the database.
1862a7e14dcfSSatish Balay 
1863a7e14dcfSSatish Balay 
1864441846f8SBarry Smith    Logically Collective on Tao
1865a7e14dcfSSatish Balay 
1866a7e14dcfSSatish Balay    Input Parameters:
1867441846f8SBarry Smith +  tao - the Tao context
1868a7e14dcfSSatish Balay -  prefix - the prefix string to prepend to all TAO option requests
1869a7e14dcfSSatish Balay 
1870a7e14dcfSSatish Balay    Notes:
1871a7e14dcfSSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
1872a7e14dcfSSatish Balay    The first character of all runtime options is AUTOMATICALLY the hyphen.
1873a7e14dcfSSatish Balay 
1874a7e14dcfSSatish Balay    For example, to distinguish between the runtime options for two
1875a7e14dcfSSatish Balay    different TAO solvers, one could call
1876a7e14dcfSSatish Balay .vb
1877a7e14dcfSSatish Balay       TaoSetOptionsPrefix(tao1,"sys1_")
1878a7e14dcfSSatish Balay       TaoSetOptionsPrefix(tao2,"sys2_")
1879a7e14dcfSSatish Balay .ve
1880a7e14dcfSSatish Balay 
1881a7e14dcfSSatish Balay    This would enable use of different options for each system, such as
1882a7e14dcfSSatish Balay .vb
1883a7e14dcfSSatish Balay       -sys1_tao_method blmvm -sys1_tao_gtol 1.e-3
1884a7e14dcfSSatish Balay       -sys2_tao_method lmvm  -sys2_tao_gtol 1.e-4
1885a7e14dcfSSatish Balay .ve
1886a7e14dcfSSatish Balay 
1887a7e14dcfSSatish Balay 
1888a7e14dcfSSatish Balay    Level: advanced
1889a7e14dcfSSatish Balay 
1890a7e14dcfSSatish Balay .seealso: TaoAppendOptionsPrefix(), TaoGetOptionsPrefix()
1891a7e14dcfSSatish Balay @*/
1892a7e14dcfSSatish Balay 
1893441846f8SBarry Smith PetscErrorCode TaoSetOptionsPrefix(Tao tao, const char p[])
1894a7e14dcfSSatish Balay {
1895a7e14dcfSSatish Balay   PetscErrorCode ierr;
189647a47007SBarry Smith 
1897a7e14dcfSSatish Balay   PetscFunctionBegin;
1898a7e14dcfSSatish Balay   ierr = PetscObjectSetOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr);
1899a7e14dcfSSatish Balay   if (tao->linesearch) {
1900a7e14dcfSSatish Balay     ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr);
1901a7e14dcfSSatish Balay   }
1902a7e14dcfSSatish Balay   if (tao->ksp) {
1903a7e14dcfSSatish Balay     ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr);
1904a7e14dcfSSatish Balay   }
1905a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1906a7e14dcfSSatish Balay }
1907a7e14dcfSSatish Balay 
1908a7e14dcfSSatish Balay /*@C
1909a7e14dcfSSatish Balay    TaoAppendOptionsPrefix - Appends to the prefix used for searching for all
1910a7e14dcfSSatish Balay    TAO options in the database.
1911a7e14dcfSSatish Balay 
1912a7e14dcfSSatish Balay 
1913441846f8SBarry Smith    Logically Collective on Tao
1914a7e14dcfSSatish Balay 
1915a7e14dcfSSatish Balay    Input Parameters:
1916441846f8SBarry Smith +  tao - the Tao solver context
1917a7e14dcfSSatish Balay -  prefix - the prefix string to prepend to all TAO option requests
1918a7e14dcfSSatish Balay 
1919a7e14dcfSSatish Balay    Notes:
1920a7e14dcfSSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
1921a7e14dcfSSatish Balay    The first character of all runtime options is AUTOMATICALLY the hyphen.
1922a7e14dcfSSatish Balay 
1923a7e14dcfSSatish Balay 
1924a7e14dcfSSatish Balay    Level: advanced
1925a7e14dcfSSatish Balay 
1926a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoGetOptionsPrefix()
1927a7e14dcfSSatish Balay @*/
1928441846f8SBarry Smith PetscErrorCode TaoAppendOptionsPrefix(Tao tao, const char p[])
1929a7e14dcfSSatish Balay {
1930a7e14dcfSSatish Balay   PetscErrorCode ierr;
193147a47007SBarry Smith 
1932a7e14dcfSSatish Balay   PetscFunctionBegin;
1933a7e14dcfSSatish Balay   ierr = PetscObjectAppendOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr);
1934a7e14dcfSSatish Balay   if (tao->linesearch) {
1935a7e14dcfSSatish Balay     ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr);
1936a7e14dcfSSatish Balay   }
1937a7e14dcfSSatish Balay   if (tao->ksp) {
1938a7e14dcfSSatish Balay     ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr);
1939a7e14dcfSSatish Balay   }
1940a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1941a7e14dcfSSatish Balay }
1942a7e14dcfSSatish Balay 
1943a7e14dcfSSatish Balay /*@C
1944a7e14dcfSSatish Balay   TaoGetOptionsPrefix - Gets the prefix used for searching for all
1945a7e14dcfSSatish Balay   TAO options in the database
1946a7e14dcfSSatish Balay 
1947a7e14dcfSSatish Balay   Not Collective
1948a7e14dcfSSatish Balay 
1949a7e14dcfSSatish Balay   Input Parameters:
1950441846f8SBarry Smith . tao - the Tao context
1951a7e14dcfSSatish Balay 
1952a7e14dcfSSatish Balay   Output Parameters:
1953a7e14dcfSSatish Balay . prefix - pointer to the prefix string used is returned
1954a7e14dcfSSatish Balay 
1955a7e14dcfSSatish Balay   Notes: On the fortran side, the user should pass in a string 'prefix' of
1956a7e14dcfSSatish Balay   sufficient length to hold the prefix.
1957a7e14dcfSSatish Balay 
1958a7e14dcfSSatish Balay   Level: advanced
1959a7e14dcfSSatish Balay 
1960a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoAppendOptionsPrefix()
1961a7e14dcfSSatish Balay @*/
1962441846f8SBarry Smith PetscErrorCode TaoGetOptionsPrefix(Tao tao, const char *p[])
1963a7e14dcfSSatish Balay {
196447a47007SBarry Smith    return PetscObjectGetOptionsPrefix((PetscObject)tao,p);
1965a7e14dcfSSatish Balay }
1966a7e14dcfSSatish Balay 
1967a7e14dcfSSatish Balay /*@C
1968a7e14dcfSSatish Balay    TaoSetType - Sets the method for the unconstrained minimization solver.
1969a7e14dcfSSatish Balay 
1970441846f8SBarry Smith    Collective on Tao
1971a7e14dcfSSatish Balay 
1972a7e14dcfSSatish Balay    Input Parameters:
1973441846f8SBarry Smith +  solver - the Tao solver context
1974a7e14dcfSSatish Balay -  type - a known method
1975a7e14dcfSSatish Balay 
1976a7e14dcfSSatish Balay    Options Database Key:
197758417fe7SBarry Smith .  -tao_type <type> - Sets the method; use -help for a list
197858417fe7SBarry Smith    of available methods (for instance, "-tao_type lmvm" or "-tao_type tron")
1979a7e14dcfSSatish Balay 
1980a7e14dcfSSatish Balay    Available methods include:
198158417fe7SBarry Smith +    nls - Newton's method with line search for unconstrained minimization
198258417fe7SBarry Smith .    ntr - Newton's method with trust region for unconstrained minimization
198358417fe7SBarry Smith .    ntl - Newton's method with trust region, line search for unconstrained minimization
198458417fe7SBarry Smith .    lmvm - Limited memory variable metric method for unconstrained minimization
198558417fe7SBarry Smith .    cg - Nonlinear conjugate gradient method for unconstrained minimization
198658417fe7SBarry Smith .    nm - Nelder-Mead algorithm for derivate-free unconstrained minimization
198758417fe7SBarry Smith .    tron - Newton Trust Region method for bound constrained minimization
198858417fe7SBarry Smith .    gpcg - Newton Trust Region method for quadratic bound constrained minimization
198958417fe7SBarry Smith .    blmvm - Limited memory variable metric method for bound constrained minimization
19901eb8069cSJason Sarich -    pounders - Model-based algorithm pounder extended for nonlinear least squares
1991a7e14dcfSSatish Balay 
1992a7e14dcfSSatish Balay   Level: intermediate
1993a7e14dcfSSatish Balay 
19941eb8069cSJason Sarich .seealso: TaoCreate(), TaoGetType(), TaoType
1995a7e14dcfSSatish Balay 
1996a7e14dcfSSatish Balay @*/
1997441846f8SBarry Smith PetscErrorCode TaoSetType(Tao tao, const TaoType type)
1998a7e14dcfSSatish Balay {
1999a7e14dcfSSatish Balay   PetscErrorCode ierr;
2000441846f8SBarry Smith   PetscErrorCode (*create_xxx)(Tao);
2001a7e14dcfSSatish Balay   PetscBool      issame;
2002a7e14dcfSSatish Balay 
2003a7e14dcfSSatish Balay   PetscFunctionBegin;
2004441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2005a7e14dcfSSatish Balay 
2006a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)tao,type,&issame);CHKERRQ(ierr);
2007a7e14dcfSSatish Balay   if (issame) PetscFunctionReturn(0);
2008a7e14dcfSSatish Balay 
2009441846f8SBarry Smith   ierr = PetscFunctionListFind(TaoList, type, (void(**)(void))&create_xxx);CHKERRQ(ierr);
2010441846f8SBarry Smith   if (!create_xxx) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested Tao type %s",type);
2011a7e14dcfSSatish Balay 
2012a7e14dcfSSatish Balay   /* Destroy the existing solver information */
2013a7e14dcfSSatish Balay   if (tao->ops->destroy) {
2014a7e14dcfSSatish Balay     ierr = (*tao->ops->destroy)(tao);CHKERRQ(ierr);
2015a7e14dcfSSatish Balay   }
2016a7e14dcfSSatish Balay   ierr = KSPDestroy(&tao->ksp);CHKERRQ(ierr);
2017a7e14dcfSSatish Balay   ierr = TaoLineSearchDestroy(&tao->linesearch);CHKERRQ(ierr);
2018a7e14dcfSSatish Balay   ierr = VecDestroy(&tao->gradient);CHKERRQ(ierr);
2019a7e14dcfSSatish Balay   ierr = VecDestroy(&tao->stepdirection);CHKERRQ(ierr);
2020a7e14dcfSSatish Balay 
2021a7e14dcfSSatish Balay   tao->ops->setup = 0;
2022a7e14dcfSSatish Balay   tao->ops->solve = 0;
2023a7e14dcfSSatish Balay   tao->ops->view  = 0;
2024a7e14dcfSSatish Balay   tao->ops->setfromoptions = 0;
2025a7e14dcfSSatish Balay   tao->ops->destroy = 0;
2026a7e14dcfSSatish Balay 
2027a7e14dcfSSatish Balay   tao->setupcalled = PETSC_FALSE;
2028a7e14dcfSSatish Balay 
2029a7e14dcfSSatish Balay   ierr = (*create_xxx)(tao);CHKERRQ(ierr);
2030a7e14dcfSSatish Balay   ierr = PetscObjectChangeTypeName((PetscObject)tao,type);CHKERRQ(ierr);
2031a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2032a7e14dcfSSatish Balay }
203347a47007SBarry Smith 
2034a7e14dcfSSatish Balay /*MC
2035441846f8SBarry Smith    TaoRegister - Adds a method to the TAO package for unconstrained minimization.
2036a7e14dcfSSatish Balay 
2037a7e14dcfSSatish Balay    Synopsis:
2038441846f8SBarry Smith    TaoRegister(char *name_solver,char *path,char *name_Create,int (*routine_Create)(Tao))
2039a7e14dcfSSatish Balay 
2040a7e14dcfSSatish Balay    Not collective
2041a7e14dcfSSatish Balay 
2042a7e14dcfSSatish Balay    Input Parameters:
2043a7e14dcfSSatish Balay +  sname - name of a new user-defined solver
2044a7e14dcfSSatish Balay -  func - routine to Create method context
2045a7e14dcfSSatish Balay 
2046a7e14dcfSSatish Balay    Notes:
2047441846f8SBarry Smith    TaoRegister() may be called multiple times to add several user-defined solvers.
2048a7e14dcfSSatish Balay 
2049a7e14dcfSSatish Balay    Sample usage:
2050a7e14dcfSSatish Balay .vb
2051441846f8SBarry Smith    TaoRegister("my_solver",MySolverCreate);
2052a7e14dcfSSatish Balay .ve
2053a7e14dcfSSatish Balay 
2054a7e14dcfSSatish Balay    Then, your solver can be chosen with the procedural interface via
2055a7e14dcfSSatish Balay $     TaoSetType(tao,"my_solver")
2056a7e14dcfSSatish Balay    or at runtime via the option
205758417fe7SBarry Smith $     -tao_type my_solver
2058a7e14dcfSSatish Balay 
2059a7e14dcfSSatish Balay    Level: advanced
2060a7e14dcfSSatish Balay 
2061441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegisterDestroy()
2062a7e14dcfSSatish Balay M*/
2063441846f8SBarry Smith PetscErrorCode TaoRegister(const char sname[], PetscErrorCode (*func)(Tao))
2064a7e14dcfSSatish Balay {
2065a7e14dcfSSatish Balay   PetscErrorCode ierr;
2066a7e14dcfSSatish Balay 
2067a7e14dcfSSatish Balay   PetscFunctionBegin;
2068441846f8SBarry Smith   ierr = PetscFunctionListAdd(&TaoList,sname, (void (*)(void))func);CHKERRQ(ierr);
2069a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2070a7e14dcfSSatish Balay }
2071a7e14dcfSSatish Balay 
2072a7e14dcfSSatish Balay /*@C
2073441846f8SBarry Smith    TaoRegisterDestroy - Frees the list of minimization solvers that were
2074441846f8SBarry Smith    registered by TaoRegisterDynamic().
2075a7e14dcfSSatish Balay 
2076a7e14dcfSSatish Balay    Not Collective
2077a7e14dcfSSatish Balay 
2078a7e14dcfSSatish Balay    Level: advanced
2079a7e14dcfSSatish Balay 
2080441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegister()
2081a7e14dcfSSatish Balay @*/
2082441846f8SBarry Smith PetscErrorCode TaoRegisterDestroy(void)
2083a7e14dcfSSatish Balay {
2084a7e14dcfSSatish Balay   PetscErrorCode ierr;
2085a7e14dcfSSatish Balay   PetscFunctionBegin;
2086441846f8SBarry Smith   ierr = PetscFunctionListDestroy(&TaoList);CHKERRQ(ierr);
2087441846f8SBarry Smith   TaoRegisterAllCalled = PETSC_FALSE;
2088a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2089a7e14dcfSSatish Balay }
209047a47007SBarry Smith 
20918931d482SJason Sarich /*@
20928931d482SJason Sarich    TaoGetIterationNumber - Gets the number of Tao iterations completed
20938931d482SJason Sarich    at this time.
20948931d482SJason Sarich 
20958931d482SJason Sarich    Not Collective
20968931d482SJason Sarich 
20978931d482SJason Sarich    Input Parameter:
20988931d482SJason Sarich .  tao - Tao context
20998931d482SJason Sarich 
21008931d482SJason Sarich    Output Parameter:
21018931d482SJason Sarich .  iter - iteration number
21028931d482SJason Sarich 
21038931d482SJason Sarich    Notes:
21048931d482SJason Sarich    For example, during the computation of iteration 2 this would return 1.
21058931d482SJason Sarich 
21068931d482SJason Sarich 
21078931d482SJason Sarich    Level: intermediate
21088931d482SJason Sarich 
21098931d482SJason Sarich .keywords: Tao, nonlinear, get, iteration, number,
21108931d482SJason Sarich 
211179f5d8caSBarry Smith .seealso:   TaoGetLinearSolveIterations(), TaoGetResidualNorm(), TaoGetObjective()
21128931d482SJason Sarich @*/
21138931d482SJason Sarich PetscErrorCode  TaoGetIterationNumber(Tao tao,PetscInt *iter)
21148931d482SJason Sarich {
21158931d482SJason Sarich   PetscFunctionBegin;
21168931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
21178931d482SJason Sarich   PetscValidIntPointer(iter,2);
21188931d482SJason Sarich   *iter = tao->niter;
21198931d482SJason Sarich   PetscFunctionReturn(0);
21208931d482SJason Sarich }
21218931d482SJason Sarich 
21228931d482SJason Sarich /*@
212379f5d8caSBarry Smith    TaoGetObjective - Gets the current value of the objective function
212479f5d8caSBarry Smith    at this time.
212579f5d8caSBarry Smith 
212679f5d8caSBarry Smith    Not Collective
212779f5d8caSBarry Smith 
212879f5d8caSBarry Smith    Input Parameter:
212979f5d8caSBarry Smith .  tao - Tao context
213079f5d8caSBarry Smith 
213179f5d8caSBarry Smith    Output Parameter:
213279f5d8caSBarry Smith .  value - the current value
213379f5d8caSBarry Smith 
213479f5d8caSBarry Smith    Level: intermediate
213579f5d8caSBarry Smith 
213679f5d8caSBarry Smith .keywords: Tao, nonlinear, get, iteration, number,
213779f5d8caSBarry Smith 
213879f5d8caSBarry Smith .seealso:   TaoGetLinearSolveIterations(), TaoGetIterationNumber(), TaoGetResidualNorm()
213979f5d8caSBarry Smith @*/
214079f5d8caSBarry Smith PetscErrorCode  TaoGetObjective(Tao tao,PetscReal *value)
214179f5d8caSBarry Smith {
214279f5d8caSBarry Smith   PetscFunctionBegin;
214379f5d8caSBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
214479f5d8caSBarry Smith   PetscValidRealPointer(value,2);
214579f5d8caSBarry Smith   *value = tao->fc;
214679f5d8caSBarry Smith   PetscFunctionReturn(0);
214779f5d8caSBarry Smith }
214879f5d8caSBarry Smith 
214979f5d8caSBarry Smith /*@
215079f5d8caSBarry Smith    TaoGetResidualNorm - Gets the current value of the norm of the residual
215179f5d8caSBarry Smith    at this time.
215279f5d8caSBarry Smith 
215379f5d8caSBarry Smith    Not Collective
215479f5d8caSBarry Smith 
215579f5d8caSBarry Smith    Input Parameter:
215679f5d8caSBarry Smith .  tao - Tao context
215779f5d8caSBarry Smith 
215879f5d8caSBarry Smith    Output Parameter:
215979f5d8caSBarry Smith .  value - the current value
216079f5d8caSBarry Smith 
216179f5d8caSBarry Smith    Level: intermediate
216279f5d8caSBarry Smith 
216379f5d8caSBarry Smith    Developer Note: This is the 2-norm of the residual, we cannot use TaoGetGradientNorm() because that has
216479f5d8caSBarry Smith                    a different meaning. For some reason Tao sometimes calls the gradient the residual.
216579f5d8caSBarry Smith 
216679f5d8caSBarry Smith .keywords: Tao, nonlinear, get, iteration, number,
216779f5d8caSBarry Smith 
216879f5d8caSBarry Smith .seealso:   TaoGetLinearSolveIterations(), TaoGetIterationNumber(), TaoGetObjective()
216979f5d8caSBarry Smith @*/
217079f5d8caSBarry Smith PetscErrorCode  TaoGetResidualNorm(Tao tao,PetscReal *value)
217179f5d8caSBarry Smith {
217279f5d8caSBarry Smith   PetscFunctionBegin;
217379f5d8caSBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
217479f5d8caSBarry Smith   PetscValidRealPointer(value,2);
217579f5d8caSBarry Smith   *value = tao->residual;
217679f5d8caSBarry Smith   PetscFunctionReturn(0);
217779f5d8caSBarry Smith }
217879f5d8caSBarry Smith 
217979f5d8caSBarry Smith /*@
21808931d482SJason Sarich    TaoSetIterationNumber - Sets the current iteration number.
21818931d482SJason Sarich 
21828931d482SJason Sarich    Not Collective
21838931d482SJason Sarich 
21848931d482SJason Sarich    Input Parameter:
21858931d482SJason Sarich .  tao - Tao context
21868931d482SJason Sarich .  iter - iteration number
21878931d482SJason Sarich 
21888931d482SJason Sarich    Level: developer
21898931d482SJason Sarich 
21908931d482SJason Sarich .keywords: Tao, nonlinear, set, iteration, number,
21918931d482SJason Sarich 
21928931d482SJason Sarich .seealso:   TaoGetLinearSolveIterations()
21938931d482SJason Sarich @*/
21948931d482SJason Sarich PetscErrorCode  TaoSetIterationNumber(Tao tao,PetscInt iter)
21958931d482SJason Sarich {
21968931d482SJason Sarich   PetscErrorCode ierr;
21978931d482SJason Sarich 
21988931d482SJason Sarich   PetscFunctionBegin;
21998931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
22008931d482SJason Sarich   ierr       = PetscObjectSAWsTakeAccess((PetscObject)tao);CHKERRQ(ierr);
22018931d482SJason Sarich   tao->niter = iter;
22028931d482SJason Sarich   ierr       = PetscObjectSAWsGrantAccess((PetscObject)tao);CHKERRQ(ierr);
22038931d482SJason Sarich   PetscFunctionReturn(0);
22048931d482SJason Sarich }
22058931d482SJason Sarich 
22068931d482SJason Sarich /*@
22078931d482SJason Sarich    TaoGetTotalIterationNumber - Gets the total number of Tao iterations
22088931d482SJason Sarich    completed. This number keeps accumulating if multiple solves
22098931d482SJason Sarich    are called with the Tao object.
22108931d482SJason Sarich 
22118931d482SJason Sarich    Not Collective
22128931d482SJason Sarich 
22138931d482SJason Sarich    Input Parameter:
22148931d482SJason Sarich .  tao - Tao context
22158931d482SJason Sarich 
22168931d482SJason Sarich    Output Parameter:
22178931d482SJason Sarich .  iter - iteration number
22188931d482SJason Sarich 
22198931d482SJason Sarich    Notes:
22208931d482SJason Sarich    The total iteration count is updated after each solve, if there is a current
22218931d482SJason Sarich    TaoSolve() in progress then those iterations are not yet counted.
22228931d482SJason Sarich 
22238931d482SJason Sarich    Level: intermediate
22248931d482SJason Sarich 
22258931d482SJason Sarich .keywords: Tao, nonlinear, get, iteration, number,
22268931d482SJason Sarich 
22278931d482SJason Sarich .seealso:   TaoGetLinearSolveIterations()
22288931d482SJason Sarich @*/
22298931d482SJason Sarich PetscErrorCode  TaoGetTotalIterationNumber(Tao tao,PetscInt *iter)
22308931d482SJason Sarich {
22318931d482SJason Sarich   PetscFunctionBegin;
22328931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
22338931d482SJason Sarich   PetscValidIntPointer(iter,2);
22348931d482SJason Sarich   *iter = tao->ntotalits;
22358931d482SJason Sarich   PetscFunctionReturn(0);
22368931d482SJason Sarich }
22378931d482SJason Sarich 
22388931d482SJason Sarich /*@
22398931d482SJason Sarich    TaoSetTotalIterationNumber - Sets the current total iteration number.
22408931d482SJason Sarich 
22418931d482SJason Sarich    Not Collective
22428931d482SJason Sarich 
22438931d482SJason Sarich    Input Parameter:
22448931d482SJason Sarich .  tao - Tao context
22458931d482SJason Sarich .  iter - iteration number
22468931d482SJason Sarich 
22478931d482SJason Sarich    Level: developer
22488931d482SJason Sarich 
22498931d482SJason Sarich .keywords: Tao, nonlinear, set, iteration, number,
22508931d482SJason Sarich 
22518931d482SJason Sarich .seealso:   TaoGetLinearSolveIterations()
22528931d482SJason Sarich @*/
22538931d482SJason Sarich PetscErrorCode  TaoSetTotalIterationNumber(Tao tao,PetscInt iter)
22548931d482SJason Sarich {
22558931d482SJason Sarich   PetscErrorCode ierr;
22568931d482SJason Sarich 
22578931d482SJason Sarich   PetscFunctionBegin;
22588931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
22598931d482SJason Sarich   ierr       = PetscObjectSAWsTakeAccess((PetscObject)tao);CHKERRQ(ierr);
22608931d482SJason Sarich   tao->ntotalits = iter;
22618931d482SJason Sarich   ierr       = PetscObjectSAWsGrantAccess((PetscObject)tao);CHKERRQ(ierr);
22628931d482SJason Sarich   PetscFunctionReturn(0);
22638931d482SJason Sarich }
22648931d482SJason Sarich 
2265a7e14dcfSSatish Balay /*@
2266e4cb33bbSBarry Smith   TaoSetConvergedReason - Sets the termination flag on a Tao object
2267a7e14dcfSSatish Balay 
2268441846f8SBarry Smith   Logically Collective on Tao
2269a7e14dcfSSatish Balay 
2270a7e14dcfSSatish Balay   Input Parameters:
2271441846f8SBarry Smith + tao - the Tao context
2272a7e14dcfSSatish Balay - reason - one of
2273a7e14dcfSSatish Balay $     TAO_CONVERGED_ATOL (2),
2274a7e14dcfSSatish Balay $     TAO_CONVERGED_RTOL (3),
2275a7e14dcfSSatish Balay $     TAO_CONVERGED_STEPTOL (4),
2276a7e14dcfSSatish Balay $     TAO_CONVERGED_MINF (5),
2277a7e14dcfSSatish Balay $     TAO_CONVERGED_USER (6),
2278a7e14dcfSSatish Balay $     TAO_DIVERGED_MAXITS (-2),
2279a7e14dcfSSatish Balay $     TAO_DIVERGED_NAN (-4),
2280a7e14dcfSSatish Balay $     TAO_DIVERGED_MAXFCN (-5),
2281a7e14dcfSSatish Balay $     TAO_DIVERGED_LS_FAILURE (-6),
2282a7e14dcfSSatish Balay $     TAO_DIVERGED_TR_REDUCTION (-7),
2283a7e14dcfSSatish Balay $     TAO_DIVERGED_USER (-8),
2284a7e14dcfSSatish Balay $     TAO_CONTINUE_ITERATING (0)
2285a7e14dcfSSatish Balay 
2286a7e14dcfSSatish Balay    Level: intermediate
2287a7e14dcfSSatish Balay 
2288a7e14dcfSSatish Balay @*/
2289e4cb33bbSBarry Smith PetscErrorCode TaoSetConvergedReason(Tao tao, TaoConvergedReason reason)
2290a7e14dcfSSatish Balay {
2291441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2292a7e14dcfSSatish Balay   PetscFunctionBegin;
2293a7e14dcfSSatish Balay   tao->reason = reason;
2294a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2295a7e14dcfSSatish Balay }
2296a7e14dcfSSatish Balay 
2297a7e14dcfSSatish Balay /*@
2298e4cb33bbSBarry Smith    TaoGetConvergedReason - Gets the reason the Tao iteration was stopped.
2299a7e14dcfSSatish Balay 
2300a7e14dcfSSatish Balay    Not Collective
2301a7e14dcfSSatish Balay 
2302a7e14dcfSSatish Balay    Input Parameter:
2303441846f8SBarry Smith .  tao - the Tao solver context
2304a7e14dcfSSatish Balay 
2305a7e14dcfSSatish Balay    Output Parameter:
2306a7e14dcfSSatish Balay .  reason - one of
2307a7e14dcfSSatish Balay $  TAO_CONVERGED_GATOL (3)           ||g(X)|| < gatol
2308a7e14dcfSSatish Balay $  TAO_CONVERGED_GRTOL (4)           ||g(X)|| / f(X)  < grtol
2309a7e14dcfSSatish Balay $  TAO_CONVERGED_GTTOL (5)           ||g(X)|| / ||g(X0)|| < gttol
2310a7e14dcfSSatish Balay $  TAO_CONVERGED_STEPTOL (6)         step size small
2311a7e14dcfSSatish Balay $  TAO_CONVERGED_MINF (7)            F < F_min
2312a7e14dcfSSatish Balay $  TAO_CONVERGED_USER (8)            User defined
2313a7e14dcfSSatish Balay $  TAO_DIVERGED_MAXITS (-2)          its > maxits
2314a7e14dcfSSatish Balay $  TAO_DIVERGED_NAN (-4)             Numerical problems
2315a7e14dcfSSatish Balay $  TAO_DIVERGED_MAXFCN (-5)          fevals > max_funcsals
2316a7e14dcfSSatish Balay $  TAO_DIVERGED_LS_FAILURE (-6)      line search failure
2317a7e14dcfSSatish Balay $  TAO_DIVERGED_TR_REDUCTION (-7)    trust region failure
2318a7e14dcfSSatish Balay $  TAO_DIVERGED_USER(-8)             (user defined)
2319a7e14dcfSSatish Balay  $  TAO_CONTINUE_ITERATING (0)
2320a7e14dcfSSatish Balay 
2321a7e14dcfSSatish Balay    where
2322a7e14dcfSSatish Balay +  X - current solution
2323a7e14dcfSSatish Balay .  X0 - initial guess
2324a7e14dcfSSatish Balay .  f(X) - current function value
2325a7e14dcfSSatish Balay .  f(X*) - true solution (estimated)
2326a7e14dcfSSatish Balay .  g(X) - current gradient
2327a7e14dcfSSatish Balay .  its - current iterate number
2328a7e14dcfSSatish Balay .  maxits - maximum number of iterates
2329a7e14dcfSSatish Balay .  fevals - number of function evaluations
2330a7e14dcfSSatish Balay -  max_funcsals - maximum number of function evaluations
2331a7e14dcfSSatish Balay 
2332a7e14dcfSSatish Balay    Level: intermediate
2333a7e14dcfSSatish Balay 
2334a7e14dcfSSatish Balay .seealso: TaoSetConvergenceTest(), TaoSetTolerances()
2335a7e14dcfSSatish Balay 
2336a7e14dcfSSatish Balay @*/
2337e4cb33bbSBarry Smith PetscErrorCode TaoGetConvergedReason(Tao tao, TaoConvergedReason *reason)
2338a7e14dcfSSatish Balay {
2339a7e14dcfSSatish Balay   PetscFunctionBegin;
2340441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2341a7e14dcfSSatish Balay   PetscValidPointer(reason,2);
2342a7e14dcfSSatish Balay   *reason = tao->reason;
2343a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2344a7e14dcfSSatish Balay }
2345a7e14dcfSSatish Balay 
2346a7e14dcfSSatish Balay /*@
2347a7e14dcfSSatish Balay   TaoGetSolutionStatus - Get the current iterate, objective value,
2348a7e14dcfSSatish Balay   residual, infeasibility, and termination
2349a7e14dcfSSatish Balay 
2350a7e14dcfSSatish Balay   Not Collective
2351a7e14dcfSSatish Balay 
2352a7e14dcfSSatish Balay    Input Parameters:
2353441846f8SBarry Smith .  tao - the Tao context
2354a7e14dcfSSatish Balay 
2355a7e14dcfSSatish Balay    Output Parameters:
2356a7e14dcfSSatish Balay +  iterate - the current iterate number (>=0)
2357a7e14dcfSSatish Balay .  f - the current function value
235858417fe7SBarry Smith .  gnorm - the square of the gradient norm, duality gap, or other measure indicating distance from optimality.
2359a7e14dcfSSatish Balay .  cnorm - the infeasibility of the current solution with regard to the constraints.
2360a7e14dcfSSatish Balay .  xdiff - the step length or trust region radius of the most recent iterate.
2361a7e14dcfSSatish Balay -  reason - The termination reason, which can equal TAO_CONTINUE_ITERATING
2362a7e14dcfSSatish Balay 
2363a7e14dcfSSatish Balay    Level: intermediate
2364a7e14dcfSSatish Balay 
2365a7e14dcfSSatish Balay    Note:
2366a7e14dcfSSatish Balay    TAO returns the values set by the solvers in the routine TaoMonitor().
2367a7e14dcfSSatish Balay 
2368a7e14dcfSSatish Balay    Note:
236947a47007SBarry Smith    If any of the output arguments are set to NULL, no corresponding value will be returned.
2370a7e14dcfSSatish Balay 
2371e4cb33bbSBarry Smith .seealso: TaoMonitor(), TaoGetConvergedReason()
2372a7e14dcfSSatish Balay @*/
2373e4cb33bbSBarry Smith PetscErrorCode TaoGetSolutionStatus(Tao tao, PetscInt *its, PetscReal *f, PetscReal *gnorm, PetscReal *cnorm, PetscReal *xdiff, TaoConvergedReason *reason)
2374a7e14dcfSSatish Balay {
2375a7e14dcfSSatish Balay   PetscFunctionBegin;
2376a7e14dcfSSatish Balay   if (its) *its=tao->niter;
2377a7e14dcfSSatish Balay   if (f) *f=tao->fc;
2378a7e14dcfSSatish Balay   if (gnorm) *gnorm=tao->residual;
2379a7e14dcfSSatish Balay   if (cnorm) *cnorm=tao->cnorm;
2380a7e14dcfSSatish Balay   if (reason) *reason=tao->reason;
2381a7e14dcfSSatish Balay   if (xdiff) *xdiff=tao->step;
2382a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2383a7e14dcfSSatish Balay }
2384a7e14dcfSSatish Balay 
2385a7e14dcfSSatish Balay /*@C
2386441846f8SBarry Smith    TaoGetType - Gets the current Tao algorithm.
2387a7e14dcfSSatish Balay 
2388a7e14dcfSSatish Balay    Not Collective
2389a7e14dcfSSatish Balay 
2390a7e14dcfSSatish Balay    Input Parameter:
2391441846f8SBarry Smith .  tao - the Tao solver context
2392a7e14dcfSSatish Balay 
2393a7e14dcfSSatish Balay    Output Parameter:
2394441846f8SBarry Smith .  type - Tao method
2395a7e14dcfSSatish Balay 
2396a7e14dcfSSatish Balay    Level: intermediate
2397a7e14dcfSSatish Balay 
2398a7e14dcfSSatish Balay @*/
2399441846f8SBarry Smith PetscErrorCode TaoGetType(Tao tao, const TaoType *type)
2400a7e14dcfSSatish Balay {
2401a7e14dcfSSatish Balay   PetscFunctionBegin;
2402441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2403a7e14dcfSSatish Balay   PetscValidPointer(type,2);
2404a7e14dcfSSatish Balay   *type=((PetscObject)tao)->type_name;
2405a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2406a7e14dcfSSatish Balay }
2407a7e14dcfSSatish Balay 
2408a7e14dcfSSatish Balay /*@C
2409a7e14dcfSSatish Balay   TaoMonitor - Monitor the solver and the current solution.  This
2410a7e14dcfSSatish Balay   routine will record the iteration number and residual statistics,
2411a7e14dcfSSatish Balay   call any monitors specified by the user, and calls the convergence-check routine.
2412a7e14dcfSSatish Balay 
2413a7e14dcfSSatish Balay    Input Parameters:
2414441846f8SBarry Smith +  tao - the Tao context
2415a7e14dcfSSatish Balay .  its - the current iterate number (>=0)
2416a7e14dcfSSatish Balay .  f - the current objective function value
241758417fe7SBarry Smith .  res - the gradient norm, square root of the duality gap, or other measure indicating distince from optimality.  This measure will be recorded and
2418a7e14dcfSSatish Balay           used for some termination tests.
2419a7e14dcfSSatish Balay .  cnorm - the infeasibility of the current solution with regard to the constraints.
2420a7e14dcfSSatish Balay -  steplength - multiple of the step direction added to the previous iterate.
2421a7e14dcfSSatish Balay 
2422a7e14dcfSSatish Balay    Output Parameters:
2423a7e14dcfSSatish Balay .  reason - The termination reason, which can equal TAO_CONTINUE_ITERATING
2424a7e14dcfSSatish Balay 
2425a7e14dcfSSatish Balay    Options Database Key:
2426a7e14dcfSSatish Balay .  -tao_monitor - Use the default monitor, which prints statistics to standard output
2427a7e14dcfSSatish Balay 
242898ea980cSBarry Smith .seealso TaoGetConvergedReason(), TaoMonitorDefault(), TaoSetMonitor()
2429a7e14dcfSSatish Balay 
2430a7e14dcfSSatish Balay    Level: developer
2431a7e14dcfSSatish Balay 
2432a7e14dcfSSatish Balay @*/
2433e4cb33bbSBarry Smith PetscErrorCode TaoMonitor(Tao tao, PetscInt its, PetscReal f, PetscReal res, PetscReal cnorm, PetscReal steplength, TaoConvergedReason *reason)
2434a7e14dcfSSatish Balay {
2435a7e14dcfSSatish Balay   PetscErrorCode ierr;
243647a47007SBarry Smith   PetscInt       i;
243747a47007SBarry Smith 
2438a7e14dcfSSatish Balay   PetscFunctionBegin;
2439441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2440a7e14dcfSSatish Balay   tao->fc = f;
2441a7e14dcfSSatish Balay   tao->residual = res;
2442a7e14dcfSSatish Balay   tao->cnorm = cnorm;
2443a7e14dcfSSatish Balay   tao->step = steplength;
2444e52336cbSBarry Smith   if (!its) {
2445a7e14dcfSSatish Balay     tao->cnorm0 = cnorm; tao->gnorm0 = res;
2446a7e14dcfSSatish Balay   }
2447ae93cb3cSJason Sarich   TaoLogConvergenceHistory(tao,f,res,cnorm,tao->ksp_its);
244847a47007SBarry Smith   if (PetscIsInfOrNanReal(f) || PetscIsInfOrNanReal(res)) SETERRQ(PETSC_COMM_SELF,1, "User provided compute function generated Inf or NaN");
2449a7e14dcfSSatish Balay   if (tao->ops->convergencetest) {
2450a7e14dcfSSatish Balay     ierr = (*tao->ops->convergencetest)(tao,tao->cnvP);CHKERRQ(ierr);
2451a7e14dcfSSatish Balay   }
2452a7e14dcfSSatish Balay   for (i=0;i<tao->numbermonitors;i++) {
2453a7e14dcfSSatish Balay     ierr = (*tao->monitor[i])(tao,tao->monitorcontext[i]);CHKERRQ(ierr);
2454a7e14dcfSSatish Balay   }
2455a7e14dcfSSatish Balay   *reason = tao->reason;
2456a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2457a7e14dcfSSatish Balay }
2458a7e14dcfSSatish Balay 
2459a7e14dcfSSatish Balay /*@
2460ae93cb3cSJason Sarich    TaoSetConvergenceHistory - Sets the array used to hold the convergence history.
2461a7e14dcfSSatish Balay 
2462441846f8SBarry Smith    Logically Collective on Tao
2463a7e14dcfSSatish Balay 
2464a7e14dcfSSatish Balay    Input Parameters:
2465441846f8SBarry Smith +  tao - the Tao solver context
2466a7e14dcfSSatish Balay .  obj   - array to hold objective value history
2467a7e14dcfSSatish Balay .  resid - array to hold residual history
2468a7e14dcfSSatish Balay .  cnorm - array to hold constraint violation history
2469be1558d8SJason Sarich .  lits - integer array holds the number of linear iterations for each Tao iteration
2470a7e14dcfSSatish Balay .  na  - size of obj, resid, and cnorm
2471a7e14dcfSSatish Balay -  reset - PetscTrue indicates each new minimization resets the history counter to zero,
2472a7e14dcfSSatish Balay            else it continues storing new values for new minimizations after the old ones
2473a7e14dcfSSatish Balay 
2474a7e14dcfSSatish Balay    Notes:
2475a7e14dcfSSatish Balay    If set, TAO will fill the given arrays with the indicated
2476ae93cb3cSJason Sarich    information at each iteration.  If 'obj','resid','cnorm','lits' are
2477ae93cb3cSJason Sarich    *all* NULL then space (using size na, or 1000 if na is PETSC_DECIDE or
2478ae93cb3cSJason Sarich    PETSC_DEFAULT) is allocated for the history.
2479be1558d8SJason Sarich    If not all are NULL, then only the non-NULL information categories
2480ae93cb3cSJason Sarich    will be stored, the others will be ignored.
2481ae93cb3cSJason Sarich 
2482ae93cb3cSJason Sarich    Any convergence information after iteration number 'na' will not be stored.
2483a7e14dcfSSatish Balay 
2484a7e14dcfSSatish Balay    This routine is useful, e.g., when running a code for purposes
2485a7e14dcfSSatish Balay    of accurate performance monitoring, when no I/O should be done
2486a7e14dcfSSatish Balay    during the section of code that is being timed.
2487a7e14dcfSSatish Balay 
2488a7e14dcfSSatish Balay    Level: intermediate
2489a7e14dcfSSatish Balay 
2490ae93cb3cSJason Sarich .seealso: TaoGetConvergenceHistory()
2491a7e14dcfSSatish Balay 
2492a7e14dcfSSatish Balay @*/
24931b266c99SBarry Smith PetscErrorCode TaoSetConvergenceHistory(Tao tao, PetscReal obj[], PetscReal resid[], PetscReal cnorm[], PetscInt lits[], PetscInt na,PetscBool reset)
2494a7e14dcfSSatish Balay {
2495ae93cb3cSJason Sarich   PetscErrorCode ierr;
2496ae93cb3cSJason Sarich 
2497a7e14dcfSSatish Balay   PetscFunctionBegin;
2498441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2499ae93cb3cSJason Sarich   if (obj) PetscValidScalarPointer(obj,2);
2500ae93cb3cSJason Sarich   if (resid) PetscValidScalarPointer(resid,3);
2501ae93cb3cSJason Sarich   if (cnorm) PetscValidScalarPointer(cnorm,4);
2502ae93cb3cSJason Sarich   if (lits) PetscValidIntPointer(lits,5);
2503ae93cb3cSJason Sarich 
2504ae93cb3cSJason Sarich   if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000;
2505ae93cb3cSJason Sarich   if (!obj && !resid && !cnorm && !lits) {
2506ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&obj);CHKERRQ(ierr);
2507ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&resid);CHKERRQ(ierr);
2508ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&cnorm);CHKERRQ(ierr);
2509ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&lits);CHKERRQ(ierr);
2510ae93cb3cSJason Sarich     tao->hist_malloc=PETSC_TRUE;
2511ae93cb3cSJason Sarich   }
2512ae93cb3cSJason Sarich 
2513a7e14dcfSSatish Balay   tao->hist_obj = obj;
2514a7e14dcfSSatish Balay   tao->hist_resid = resid;
2515a7e14dcfSSatish Balay   tao->hist_cnorm = cnorm;
2516ae93cb3cSJason Sarich   tao->hist_lits = lits;
2517a7e14dcfSSatish Balay   tao->hist_max   = na;
2518a7e14dcfSSatish Balay   tao->hist_reset = reset;
2519ae93cb3cSJason Sarich   tao->hist_len = 0;
2520a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2521a7e14dcfSSatish Balay }
2522a7e14dcfSSatish Balay 
2523a7e14dcfSSatish Balay /*@C
2524ae93cb3cSJason Sarich    TaoGetConvergenceHistory - Gets the arrays used to hold the convergence history.
2525a7e14dcfSSatish Balay 
2526441846f8SBarry Smith    Collective on Tao
2527a7e14dcfSSatish Balay 
2528a7e14dcfSSatish Balay    Input Parameter:
2529441846f8SBarry Smith .  tao - the Tao context
2530a7e14dcfSSatish Balay 
2531a7e14dcfSSatish Balay    Output Parameters:
2532a7e14dcfSSatish Balay +  obj   - array used to hold objective value history
2533a7e14dcfSSatish Balay .  resid - array used to hold residual history
2534a7e14dcfSSatish Balay .  cnorm - array used to hold constraint violation history
2535ae93cb3cSJason Sarich .  lits  - integer array used to hold linear solver iteration count
2536ae93cb3cSJason Sarich -  nhist  - size of obj, resid, cnorm, and lits (will be less than or equal to na given in TaoSetHistory)
2537a7e14dcfSSatish Balay 
2538a7e14dcfSSatish Balay    Notes:
2539ae93cb3cSJason Sarich     This routine must be preceded by calls to TaoSetConvergenceHistory()
2540ae93cb3cSJason Sarich     and TaoSolve(), otherwise it returns useless information.
2541ae93cb3cSJason Sarich 
2542a7e14dcfSSatish Balay     The calling sequence for this routine in Fortran is
2543ae93cb3cSJason Sarich $   call TaoGetConvergenceHistory(Tao tao, PetscInt nhist, PetscErrorCode ierr)
2544a7e14dcfSSatish Balay 
2545a7e14dcfSSatish Balay    This routine is useful, e.g., when running a code for purposes
2546a7e14dcfSSatish Balay    of accurate performance monitoring, when no I/O should be done
2547a7e14dcfSSatish Balay    during the section of code that is being timed.
2548a7e14dcfSSatish Balay 
2549a7e14dcfSSatish Balay    Level: advanced
2550a7e14dcfSSatish Balay 
2551ae93cb3cSJason Sarich .seealso: TaoSetConvergenceHistory()
2552a7e14dcfSSatish Balay 
2553a7e14dcfSSatish Balay @*/
2554ae93cb3cSJason Sarich PetscErrorCode TaoGetConvergenceHistory(Tao tao, PetscReal **obj, PetscReal **resid, PetscReal **cnorm, PetscInt **lits, PetscInt *nhist)
2555a7e14dcfSSatish Balay {
2556a7e14dcfSSatish Balay   PetscFunctionBegin;
2557441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2558a7e14dcfSSatish Balay   if (obj)   *obj   = tao->hist_obj;
2559a7e14dcfSSatish Balay   if (cnorm) *cnorm = tao->hist_cnorm;
2560a7e14dcfSSatish Balay   if (resid) *resid = tao->hist_resid;
2561a7e14dcfSSatish Balay   if (nhist) *nhist   = tao->hist_len;
2562a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2563a7e14dcfSSatish Balay }
2564a7e14dcfSSatish Balay 
2565a7e14dcfSSatish Balay /*@
2566a7e14dcfSSatish Balay    TaoSetApplicationContext - Sets the optional user-defined context for
2567a7e14dcfSSatish Balay    a solver.
2568a7e14dcfSSatish Balay 
2569441846f8SBarry Smith    Logically Collective on Tao
2570a7e14dcfSSatish Balay 
2571a7e14dcfSSatish Balay    Input Parameters:
2572441846f8SBarry Smith +  tao  - the Tao context
2573a7e14dcfSSatish Balay -  usrP - optional user context
2574a7e14dcfSSatish Balay 
2575a7e14dcfSSatish Balay    Level: intermediate
2576a7e14dcfSSatish Balay 
2577a7e14dcfSSatish Balay .seealso: TaoGetApplicationContext(), TaoSetApplicationContext()
2578a7e14dcfSSatish Balay @*/
2579441846f8SBarry Smith PetscErrorCode  TaoSetApplicationContext(Tao tao,void *usrP)
2580a7e14dcfSSatish Balay {
2581a7e14dcfSSatish Balay   PetscFunctionBegin;
2582441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2583a7e14dcfSSatish Balay   tao->user = usrP;
2584a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2585a7e14dcfSSatish Balay }
2586a7e14dcfSSatish Balay 
2587a7e14dcfSSatish Balay /*@
2588a7e14dcfSSatish Balay    TaoGetApplicationContext - Gets the user-defined context for a
2589a7e14dcfSSatish Balay    TAO solvers.
2590a7e14dcfSSatish Balay 
2591a7e14dcfSSatish Balay    Not Collective
2592a7e14dcfSSatish Balay 
2593a7e14dcfSSatish Balay    Input Parameter:
2594441846f8SBarry Smith .  tao  - Tao context
2595a7e14dcfSSatish Balay 
2596a7e14dcfSSatish Balay    Output Parameter:
2597a7e14dcfSSatish Balay .  usrP - user context
2598a7e14dcfSSatish Balay 
2599a7e14dcfSSatish Balay    Level: intermediate
2600a7e14dcfSSatish Balay 
2601a7e14dcfSSatish Balay .seealso: TaoSetApplicationContext()
2602a7e14dcfSSatish Balay @*/
2603441846f8SBarry Smith PetscErrorCode  TaoGetApplicationContext(Tao tao,void *usrP)
2604a7e14dcfSSatish Balay {
2605a7e14dcfSSatish Balay   PetscFunctionBegin;
2606441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2607a7e14dcfSSatish Balay   *(void**)usrP = tao->user;
2608a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2609a7e14dcfSSatish Balay }
2610a9603a14SPatrick Farrell 
2611a9603a14SPatrick Farrell /*@
2612a9603a14SPatrick Farrell    TaoSetGradientNorm - Sets the matrix used to define the inner product that measures the size of the gradient.
2613a9603a14SPatrick Farrell 
2614a9603a14SPatrick Farrell    Collective on tao
2615a9603a14SPatrick Farrell 
2616a9603a14SPatrick Farrell    Input Parameters:
2617a9603a14SPatrick Farrell +  tao  - the Tao context
2618a9603a14SPatrick Farrell -  M    - gradient norm
2619a9603a14SPatrick Farrell 
2620a9603a14SPatrick Farrell    Level: beginner
2621a9603a14SPatrick Farrell 
2622a9603a14SPatrick Farrell .seealso: TaoGetGradientNorm(), TaoGradientNorm()
2623a9603a14SPatrick Farrell @*/
2624a9603a14SPatrick Farrell PetscErrorCode  TaoSetGradientNorm(Tao tao, Mat M)
2625a9603a14SPatrick Farrell {
2626a9603a14SPatrick Farrell   PetscErrorCode ierr;
2627a9603a14SPatrick Farrell 
2628a9603a14SPatrick Farrell   PetscFunctionBegin;
2629a9603a14SPatrick Farrell   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2630a9603a14SPatrick Farrell 
2631a9603a14SPatrick Farrell   if (tao->gradient_norm) {
2632a9603a14SPatrick Farrell     ierr = PetscObjectDereference((PetscObject)tao->gradient_norm);CHKERRQ(ierr);
2633a9603a14SPatrick Farrell     ierr = VecDestroy(&tao->gradient_norm_tmp);CHKERRQ(ierr);
2634a9603a14SPatrick Farrell   }
2635a9603a14SPatrick Farrell 
2636a9603a14SPatrick Farrell   ierr = PetscObjectReference((PetscObject)M);CHKERRQ(ierr);
2637a9603a14SPatrick Farrell   tao->gradient_norm = M;
2638a9603a14SPatrick Farrell   ierr = MatCreateVecs(M, NULL, &tao->gradient_norm_tmp);CHKERRQ(ierr);
2639a9603a14SPatrick Farrell   PetscFunctionReturn(0);
2640a9603a14SPatrick Farrell }
2641a9603a14SPatrick Farrell 
2642a9603a14SPatrick Farrell /*@
2643a9603a14SPatrick Farrell    TaoGetGradientNorm - Returns the matrix used to define the inner product for measuring the size of the gradient.
2644a9603a14SPatrick Farrell 
2645a9603a14SPatrick Farrell    Not Collective
2646a9603a14SPatrick Farrell 
2647a9603a14SPatrick Farrell    Input Parameter:
2648a9603a14SPatrick Farrell .  tao  - Tao context
2649a9603a14SPatrick Farrell 
2650a9603a14SPatrick Farrell    Output Parameter:
2651a9603a14SPatrick Farrell .  M - gradient norm
2652a9603a14SPatrick Farrell 
2653a9603a14SPatrick Farrell    Level: beginner
2654a9603a14SPatrick Farrell 
2655a9603a14SPatrick Farrell .seealso: TaoSetGradientNorm(), TaoGradientNorm()
2656a9603a14SPatrick Farrell @*/
2657a9603a14SPatrick Farrell PetscErrorCode  TaoGetGradientNorm(Tao tao, Mat *M)
2658a9603a14SPatrick Farrell {
2659a9603a14SPatrick Farrell   PetscFunctionBegin;
2660a9603a14SPatrick Farrell   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2661a9603a14SPatrick Farrell   *M = tao->gradient_norm;
2662a9603a14SPatrick Farrell   PetscFunctionReturn(0);
2663a9603a14SPatrick Farrell }
2664a9603a14SPatrick Farrell 
2665a9603a14SPatrick Farrell /*c
2666a9603a14SPatrick Farrell    TaoGradientNorm - Compute the norm with respect to the inner product the user has set.
2667a9603a14SPatrick Farrell 
2668a9603a14SPatrick Farrell    Collective on tao
2669a9603a14SPatrick Farrell 
2670a9603a14SPatrick Farrell    Input Parameter:
2671a9603a14SPatrick Farrell .  tao      - the Tao context
2672a9603a14SPatrick Farrell .  gradient - the gradient to be computed
2673a9603a14SPatrick Farrell .  norm     - the norm type
2674a9603a14SPatrick Farrell 
2675a9603a14SPatrick Farrell    Output Parameter:
2676a9603a14SPatrick Farrell .  gnorm    - the gradient norm
2677a9603a14SPatrick Farrell 
2678a9603a14SPatrick Farrell    Level: developer
2679a9603a14SPatrick Farrell 
2680a9603a14SPatrick Farrell .seealso: TaoSetGradientNorm(), TaoGetGradientNorm()
2681a9603a14SPatrick Farrell @*/
2682a9603a14SPatrick Farrell PetscErrorCode  TaoGradientNorm(Tao tao, Vec gradient, NormType type, PetscReal *gnorm)
2683a9603a14SPatrick Farrell {
2684a9603a14SPatrick Farrell   PetscErrorCode ierr;
2685a9603a14SPatrick Farrell 
2686a9603a14SPatrick Farrell   PetscFunctionBegin;
2687a9603a14SPatrick Farrell   PetscValidHeaderSpecific(gradient,VEC_CLASSID,1);
2688a9603a14SPatrick Farrell 
2689a9603a14SPatrick Farrell   if (tao->gradient_norm) {
2690680e2bc7SPatrick Farrell     PetscScalar gnorms;
2691680e2bc7SPatrick Farrell 
2692a9603a14SPatrick 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.");
2693a9603a14SPatrick Farrell     ierr = MatMult(tao->gradient_norm, gradient, tao->gradient_norm_tmp);CHKERRQ(ierr);
2694680e2bc7SPatrick Farrell     ierr = VecDot(gradient, tao->gradient_norm_tmp, &gnorms);CHKERRQ(ierr);
26957bb79937SPatrick Farrell     *gnorm = PetscRealPart(PetscSqrtScalar(gnorms));
2696a9603a14SPatrick Farrell   } else {
2697a9603a14SPatrick Farrell     ierr = VecNorm(gradient, type, gnorm);CHKERRQ(ierr);
2698a9603a14SPatrick Farrell   }
2699a9603a14SPatrick Farrell   PetscFunctionReturn(0);
2700a9603a14SPatrick Farrell }
2701a9603a14SPatrick Farrell 
2702e882e171SHong Zhang /*@C
2703e882e171SHong Zhang    TaoMonitorDrawCtxCreate - Creates the monitor context for TaoMonitorDrawCtx
2704a9603a14SPatrick Farrell 
2705e882e171SHong Zhang    Collective on Tao
2706e882e171SHong Zhang 
2707e882e171SHong Zhang    Output Patameter:
2708e882e171SHong Zhang .    ctx - the monitor context
2709e882e171SHong Zhang 
2710e882e171SHong Zhang    Options Database:
2711e882e171SHong Zhang .   -tao_draw_solution_initial - show initial guess as well as current solution
2712e882e171SHong Zhang 
2713e882e171SHong Zhang    Level: intermediate
2714e882e171SHong Zhang 
2715e882e171SHong Zhang .keywords: Tao,  vector, monitor, view
2716e882e171SHong Zhang 
2717e882e171SHong Zhang .seealso: TaoMonitorSet(), TaoMonitorDefault(), VecView(), TaoMonitorDrawCtx()
2718e882e171SHong Zhang @*/
2719e882e171SHong Zhang PetscErrorCode  TaoMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TaoMonitorDrawCtx *ctx)
2720e882e171SHong Zhang {
2721e882e171SHong Zhang   PetscErrorCode   ierr;
2722e882e171SHong Zhang 
2723e882e171SHong Zhang   PetscFunctionBegin;
2724e882e171SHong Zhang   ierr = PetscNew(ctx);CHKERRQ(ierr);
2725e882e171SHong Zhang   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
2726e882e171SHong Zhang   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
2727e882e171SHong Zhang   (*ctx)->howoften = howoften;
2728e882e171SHong Zhang   PetscFunctionReturn(0);
2729e882e171SHong Zhang }
2730e882e171SHong Zhang 
2731e882e171SHong Zhang /*@C
2732e882e171SHong Zhang    TaoMonitorDrawCtxDestroy - Destroys the monitor context for TaoMonitorDrawSolution()
2733e882e171SHong Zhang 
2734e882e171SHong Zhang    Collective on Tao
2735e882e171SHong Zhang 
2736e882e171SHong Zhang    Input Parameters:
2737e882e171SHong Zhang .    ctx - the monitor context
2738e882e171SHong Zhang 
2739e882e171SHong Zhang    Level: intermediate
2740e882e171SHong Zhang 
2741e882e171SHong Zhang .keywords: Tao,  vector, monitor, view
2742e882e171SHong Zhang 
2743e882e171SHong Zhang .seealso: TaoMonitorSet(), TaoMonitorDefault(), VecView(), TaoMonitorDrawSolution()
2744e882e171SHong Zhang @*/
2745e882e171SHong Zhang PetscErrorCode  TaoMonitorDrawCtxDestroy(TaoMonitorDrawCtx *ictx)
2746e882e171SHong Zhang {
2747e882e171SHong Zhang   PetscErrorCode ierr;
2748e882e171SHong Zhang 
2749e882e171SHong Zhang   PetscFunctionBegin;
2750e882e171SHong Zhang   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
2751e882e171SHong Zhang   ierr = PetscFree(*ictx);CHKERRQ(ierr);
2752e882e171SHong Zhang   PetscFunctionReturn(0);
2753e882e171SHong Zhang }
2754