xref: /petsc/src/tao/interface/taosolver.c (revision f55353a2a7c46e5e81f955495d9d64b6042b9555)
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 
13a7e14dcfSSatish Balay #undef __FUNCT__
14a7e14dcfSSatish Balay #define __FUNCT__ "TaoCreate"
15a7e14dcfSSatish Balay /*@
16a7e14dcfSSatish Balay   TaoCreate - Creates a TAO solver
17a7e14dcfSSatish Balay 
18a7e14dcfSSatish Balay   Collective on MPI_Comm
19a7e14dcfSSatish Balay 
20a7e14dcfSSatish Balay   Input Parameter:
21a7e14dcfSSatish Balay . comm - MPI communicator
22a7e14dcfSSatish Balay 
23a7e14dcfSSatish Balay   Output Parameter:
24441846f8SBarry Smith . newtao - the new Tao context
25a7e14dcfSSatish Balay 
26a7e14dcfSSatish Balay   Available methods include:
2758417fe7SBarry Smith +    nls - Newton's method with line search for unconstrained minimization
2858417fe7SBarry Smith .    ntr - Newton's method with trust region for unconstrained minimization
2958417fe7SBarry Smith .    ntl - Newton's method with trust region, line search for unconstrained minimization
3058417fe7SBarry Smith .    lmvm - Limited memory variable metric method for unconstrained minimization
3158417fe7SBarry Smith .    cg - Nonlinear conjugate gradient method for unconstrained minimization
3258417fe7SBarry Smith .    nm - Nelder-Mead algorithm for derivate-free unconstrained minimization
3358417fe7SBarry Smith .    tron - Newton Trust Region method for bound constrained minimization
3458417fe7SBarry Smith .    gpcg - Newton Trust Region method for quadratic bound constrained minimization
3558417fe7SBarry Smith .    blmvm - Limited memory variable metric method for bound constrained minimization
3658417fe7SBarry Smith .    lcl - Linearly constrained Lagrangian method for pde-constrained minimization
3758417fe7SBarry Smith -    pounders - Model-based algorithm for nonlinear least squares
38a7e14dcfSSatish Balay 
39a7e14dcfSSatish Balay    Options Database Keys:
4058417fe7SBarry Smith .   -tao_type - select which method TAO should use
41a7e14dcfSSatish Balay 
42a7e14dcfSSatish Balay    Level: beginner
43a7e14dcfSSatish Balay 
44a7e14dcfSSatish Balay .seealso: TaoSolve(), TaoDestroy()
45a7e14dcfSSatish Balay @*/
46441846f8SBarry Smith PetscErrorCode TaoCreate(MPI_Comm comm, Tao *newtao)
47a7e14dcfSSatish Balay {
48a7e14dcfSSatish Balay   PetscErrorCode ierr;
49441846f8SBarry Smith   Tao            tao;
50a7e14dcfSSatish Balay 
51a7e14dcfSSatish Balay   PetscFunctionBegin;
52a7e14dcfSSatish Balay   PetscValidPointer(newtao,2);
5347a47007SBarry Smith   *newtao = NULL;
54a7e14dcfSSatish Balay 
55a7e14dcfSSatish Balay   ierr = TaoInitializePackage();CHKERRQ(ierr);
56a7e14dcfSSatish Balay   ierr = TaoLineSearchInitializePackage();CHKERRQ(ierr);
57a7e14dcfSSatish Balay 
5873107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(tao,TAO_CLASSID,"Tao","Optimization solver","Tao",comm,TaoDestroy,TaoView);CHKERRQ(ierr);
59a7e14dcfSSatish Balay   tao->ops->computeobjective=0;
60a7e14dcfSSatish Balay   tao->ops->computeobjectiveandgradient=0;
61a7e14dcfSSatish Balay   tao->ops->computegradient=0;
62a7e14dcfSSatish Balay   tao->ops->computehessian=0;
63a7e14dcfSSatish Balay   tao->ops->computeseparableobjective=0;
64a7e14dcfSSatish Balay   tao->ops->computeconstraints=0;
65a7e14dcfSSatish Balay   tao->ops->computejacobian=0;
66a7e14dcfSSatish Balay   tao->ops->computejacobianequality=0;
67a7e14dcfSSatish Balay   tao->ops->computejacobianinequality=0;
68a7e14dcfSSatish Balay   tao->ops->computeequalityconstraints=0;
69a7e14dcfSSatish Balay   tao->ops->computeinequalityconstraints=0;
70a7e14dcfSSatish Balay   tao->ops->convergencetest=TaoDefaultConvergenceTest;
71a7e14dcfSSatish Balay   tao->ops->convergencedestroy=0;
72a7e14dcfSSatish Balay   tao->ops->computedual=0;
73a7e14dcfSSatish Balay   tao->ops->setup=0;
74a7e14dcfSSatish Balay   tao->ops->solve=0;
75a7e14dcfSSatish Balay   tao->ops->view=0;
76a7e14dcfSSatish Balay   tao->ops->setfromoptions=0;
77a7e14dcfSSatish Balay   tao->ops->destroy=0;
78a7e14dcfSSatish Balay 
7947a47007SBarry Smith   tao->solution=NULL;
8047a47007SBarry Smith   tao->gradient=NULL;
8147a47007SBarry Smith   tao->sep_objective = NULL;
8247a47007SBarry Smith   tao->constraints=NULL;
8347a47007SBarry Smith   tao->constraints_equality=NULL;
8447a47007SBarry Smith   tao->constraints_inequality=NULL;
8547a47007SBarry Smith   tao->stepdirection=NULL;
868931d482SJason Sarich   tao->niter=0;
878931d482SJason Sarich   tao->ntotalits=0;
8847a47007SBarry Smith   tao->XL = NULL;
8947a47007SBarry Smith   tao->XU = NULL;
9047a47007SBarry Smith   tao->IL = NULL;
9147a47007SBarry Smith   tao->IU = NULL;
9247a47007SBarry Smith   tao->DI = NULL;
9347a47007SBarry Smith   tao->DE = NULL;
9447a47007SBarry Smith   tao->hessian = NULL;
9547a47007SBarry Smith   tao->hessian_pre = NULL;
9647a47007SBarry Smith   tao->jacobian = NULL;
9747a47007SBarry Smith   tao->jacobian_pre = NULL;
9847a47007SBarry Smith   tao->jacobian_state = NULL;
9947a47007SBarry Smith   tao->jacobian_state_pre = NULL;
10047a47007SBarry Smith   tao->jacobian_state_inv = NULL;
10147a47007SBarry Smith   tao->jacobian_design = NULL;
10247a47007SBarry Smith   tao->jacobian_design_pre = NULL;
10347a47007SBarry Smith   tao->jacobian_equality = NULL;
10447a47007SBarry Smith   tao->jacobian_equality_pre = NULL;
10547a47007SBarry Smith   tao->jacobian_inequality = NULL;
10647a47007SBarry Smith   tao->jacobian_inequality_pre = NULL;
10747a47007SBarry Smith   tao->state_is = NULL;
10847a47007SBarry Smith   tao->design_is = NULL;
109a7e14dcfSSatish Balay 
110a7e14dcfSSatish Balay   tao->max_it     = 10000;
111a7e14dcfSSatish Balay   tao->max_funcs   = 10000;
1126f4723b1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
1136f4723b1SBarry Smith   tao->fatol       = 1e-5;
1146f4723b1SBarry Smith   tao->frtol       = 1e-5;
1156f4723b1SBarry Smith   tao->gatol       = 1e-5;
1166f4723b1SBarry Smith   tao->grtol       = 1e-5;
1176f4723b1SBarry Smith #else
118a7e14dcfSSatish Balay   tao->fatol       = 1e-8;
119a7e14dcfSSatish Balay   tao->frtol       = 1e-8;
120a7e14dcfSSatish Balay   tao->gatol       = 1e-8;
121a7e14dcfSSatish Balay   tao->grtol       = 1e-8;
1226f4723b1SBarry Smith #endif
123a7e14dcfSSatish Balay   tao->crtol       = 0.0;
1246552cf8aSJason Sarich   tao->catol       = 0.0;
125a7e14dcfSSatish Balay   tao->steptol     = 0.0;
1266552cf8aSJason Sarich   tao->gttol       = 0.0;
127e270355aSBarry Smith   tao->trust0      = PETSC_INFINITY;
1286f4723b1SBarry Smith   tao->fmin        = PETSC_NINFINITY;
129ae93cb3cSJason Sarich   tao->hist_malloc = PETSC_FALSE;
130a7e14dcfSSatish Balay   tao->hist_reset = PETSC_TRUE;
131a7e14dcfSSatish Balay   tao->hist_max = 0;
132a7e14dcfSSatish Balay   tao->hist_len = 0;
13347a47007SBarry Smith   tao->hist_obj = NULL;
13447a47007SBarry Smith   tao->hist_resid = NULL;
13547a47007SBarry Smith   tao->hist_cnorm = NULL;
136ae93cb3cSJason Sarich   tao->hist_lits = NULL;
137a7e14dcfSSatish Balay 
138a7e14dcfSSatish Balay   tao->numbermonitors=0;
139a7e14dcfSSatish Balay   tao->viewsolution=PETSC_FALSE;
140a7e14dcfSSatish Balay   tao->viewhessian=PETSC_FALSE;
141a7e14dcfSSatish Balay   tao->viewgradient=PETSC_FALSE;
142a7e14dcfSSatish Balay   tao->viewjacobian=PETSC_FALSE;
143a7e14dcfSSatish Balay   tao->viewconstraints = PETSC_FALSE;
144a7e14dcfSSatish Balay 
1456552cf8aSJason Sarich   /* These flags prevents algorithms from overriding user options */
1466552cf8aSJason Sarich   tao->max_it_changed   =PETSC_FALSE;
1476552cf8aSJason Sarich   tao->max_funcs_changed=PETSC_FALSE;
1486552cf8aSJason Sarich   tao->fatol_changed    =PETSC_FALSE;
1496552cf8aSJason Sarich   tao->frtol_changed    =PETSC_FALSE;
1506552cf8aSJason Sarich   tao->gatol_changed    =PETSC_FALSE;
1516552cf8aSJason Sarich   tao->grtol_changed    =PETSC_FALSE;
1526552cf8aSJason Sarich   tao->gttol_changed    =PETSC_FALSE;
1536552cf8aSJason Sarich   tao->steptol_changed  =PETSC_FALSE;
1546552cf8aSJason Sarich   tao->trust0_changed   =PETSC_FALSE;
1556552cf8aSJason Sarich   tao->fmin_changed     =PETSC_FALSE;
1566552cf8aSJason Sarich   tao->catol_changed    =PETSC_FALSE;
1576552cf8aSJason Sarich   tao->crtol_changed    =PETSC_FALSE;
158a7e14dcfSSatish Balay   ierr = TaoResetStatistics(tao);CHKERRQ(ierr);
159a7e14dcfSSatish Balay   *newtao = tao;
160a7e14dcfSSatish Balay   PetscFunctionReturn(0);
161a7e14dcfSSatish Balay }
162a7e14dcfSSatish Balay 
163a7e14dcfSSatish Balay #undef __FUNCT__
164a7e14dcfSSatish Balay #define __FUNCT__ "TaoSolve"
165a7e14dcfSSatish Balay /*@
166a7e14dcfSSatish Balay   TaoSolve - Solves an optimization problem min F(x) s.t. l <= x <= u
167a7e14dcfSSatish Balay 
168441846f8SBarry Smith   Collective on Tao
169a7e14dcfSSatish Balay 
170a7e14dcfSSatish Balay   Input Parameters:
171441846f8SBarry Smith . tao - the Tao context
172a7e14dcfSSatish Balay 
173a7e14dcfSSatish Balay   Notes:
174441846f8SBarry Smith   The user must set up the Tao with calls to TaoSetInitialVector(),
175a7e14dcfSSatish Balay   TaoSetObjectiveRoutine(),
176a7e14dcfSSatish Balay   TaoSetGradientRoutine(), and (if using 2nd order method) TaoSetHessianRoutine().
177a7e14dcfSSatish Balay 
178a7e14dcfSSatish Balay   Level: beginner
179a7e14dcfSSatish Balay 
180a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSetObjectiveRoutine(), TaoSetGradientRoutine(), TaoSetHessianRoutine()
181a7e14dcfSSatish Balay  @*/
182441846f8SBarry Smith PetscErrorCode TaoSolve(Tao tao)
183a7e14dcfSSatish Balay {
184a7e14dcfSSatish Balay   PetscErrorCode   ierr;
185e2379f4fSBarry Smith   static PetscBool set = PETSC_FALSE;
18647a47007SBarry Smith 
187a7e14dcfSSatish Balay   PetscFunctionBegin;
188441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
189e2379f4fSBarry Smith   ierr = PetscCitationsRegister("@TechReport{tao-user-ref,\n"
190e2379f4fSBarry Smith                                 "title   = {Toolkit for Advanced Optimization (TAO) Users Manual},\n"
191e2379f4fSBarry Smith                                 "author  = {Todd Munson and Jason Sarich and Stefan Wild and Steve Benson and Lois Curfman McInnes},\n"
192e2379f4fSBarry Smith                                 "Institution = {Argonne National Laboratory},\n"
193e2379f4fSBarry Smith                                 "Year   = 2014,\n"
194e2379f4fSBarry Smith                                 "Number = {ANL/MCS-TM-322 - Revision 3.5},\n"
195302440fdSBarry Smith                                 "url    = {http://www.mcs.anl.gov/tao}\n}\n",&set);CHKERRQ(ierr);
196e2379f4fSBarry Smith 
197a7e14dcfSSatish Balay   ierr = TaoSetUp(tao);CHKERRQ(ierr);
198a7e14dcfSSatish Balay   ierr = TaoResetStatistics(tao);CHKERRQ(ierr);
199a7e14dcfSSatish Balay   if (tao->linesearch) {
200a7e14dcfSSatish Balay     ierr = TaoLineSearchReset(tao->linesearch);CHKERRQ(ierr);
201a7e14dcfSSatish Balay   }
202a7e14dcfSSatish Balay 
203441846f8SBarry Smith   ierr = PetscLogEventBegin(Tao_Solve,tao,0,0,0);CHKERRQ(ierr);
204a7e14dcfSSatish Balay   if (tao->ops->solve){ ierr = (*tao->ops->solve)(tao);CHKERRQ(ierr); }
205441846f8SBarry Smith   ierr = PetscLogEventEnd(Tao_Solve,tao,0,0,0);CHKERRQ(ierr);
206a7e14dcfSSatish Balay 
2078931d482SJason Sarich   tao->ntotalits += tao->niter;
208fbe0838dSJason Sarich   ierr = TaoViewFromOptions(tao,NULL,"-tao_view");CHKERRQ(ierr);
209a7e14dcfSSatish Balay 
210a7e14dcfSSatish Balay   if (tao->printreason) {
211a7e14dcfSSatish Balay     if (tao->reason > 0) {
2128931d482SJason Sarich       ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve converged due to %s iterations %D\n",TaoConvergedReasons[tao->reason],tao->niter);CHKERRQ(ierr);
213a7e14dcfSSatish Balay     } else {
2148931d482SJason Sarich       ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve did not converge due to %s iteration %D\n",TaoConvergedReasons[tao->reason],tao->niter);CHKERRQ(ierr);
215a7e14dcfSSatish Balay     }
216a7e14dcfSSatish Balay   }
217a7e14dcfSSatish Balay   PetscFunctionReturn(0);
218a7e14dcfSSatish Balay }
219a7e14dcfSSatish Balay 
220a7e14dcfSSatish Balay #undef __FUNCT__
221a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetUp"
222a7e14dcfSSatish Balay /*@
223a7e14dcfSSatish Balay   TaoSetUp - Sets up the internal data structures for the later use
224a7e14dcfSSatish Balay   of a Tao solver
225a7e14dcfSSatish Balay 
226a7e14dcfSSatish Balay   Collective on tao
227a7e14dcfSSatish Balay 
228a7e14dcfSSatish Balay   Input Parameters:
229a7e14dcfSSatish Balay . tao - the TAO context
230a7e14dcfSSatish Balay 
231a7e14dcfSSatish Balay   Notes:
232a7e14dcfSSatish Balay   The user will not need to explicitly call TaoSetUp(), as it will
233a7e14dcfSSatish Balay   automatically be called in TaoSolve().  However, if the user
234a7e14dcfSSatish Balay   desires to call it explicitly, it should come after TaoCreate()
235a7e14dcfSSatish Balay   and any TaoSetSomething() routines, but before TaoSolve().
236a7e14dcfSSatish Balay 
237a7e14dcfSSatish Balay   Level: advanced
238a7e14dcfSSatish Balay 
239a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
240a7e14dcfSSatish Balay @*/
241441846f8SBarry Smith PetscErrorCode TaoSetUp(Tao tao)
242a7e14dcfSSatish Balay {
243a7e14dcfSSatish Balay   PetscErrorCode ierr;
24447a47007SBarry Smith 
245a7e14dcfSSatish Balay   PetscFunctionBegin;
246441846f8SBarry Smith   PetscValidHeaderSpecific(tao, TAO_CLASSID,1);
247a7e14dcfSSatish Balay   if (tao->setupcalled) PetscFunctionReturn(0);
248a7e14dcfSSatish Balay 
24947a47007SBarry Smith   if (!tao->solution) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TaoSetInitialVector");
250a7e14dcfSSatish Balay   if (tao->ops->setup) {
251a7e14dcfSSatish Balay     ierr = (*tao->ops->setup)(tao);CHKERRQ(ierr);
252a7e14dcfSSatish Balay   }
253a7e14dcfSSatish Balay   tao->setupcalled = PETSC_TRUE;
254a7e14dcfSSatish Balay   PetscFunctionReturn(0);
255a7e14dcfSSatish Balay }
256a7e14dcfSSatish Balay 
257a7e14dcfSSatish Balay #undef __FUNCT__
258a7e14dcfSSatish Balay #define __FUNCT__ "TaoDestroy"
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 
296a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->XL);CHKERRQ(ierr);
297a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->XU);CHKERRQ(ierr);
298a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->IL);CHKERRQ(ierr);
299a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->IU);CHKERRQ(ierr);
300a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->DE);CHKERRQ(ierr);
301a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->DI);CHKERRQ(ierr);
302a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->constraints_equality);CHKERRQ(ierr);
303a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->constraints_inequality);CHKERRQ(ierr);
304a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->stepdirection);CHKERRQ(ierr);
305a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->hessian_pre);CHKERRQ(ierr);
306a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->hessian);CHKERRQ(ierr);
307a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_pre);CHKERRQ(ierr);
308a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian);CHKERRQ(ierr);
309a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state_pre);CHKERRQ(ierr);
310a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state);CHKERRQ(ierr);
311a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr);
312067f330cSJason Sarich   ierr = MatDestroy(&(*tao)->jacobian_design);CHKERRQ(ierr);
313a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_equality);CHKERRQ(ierr);
314a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_equality_pre);CHKERRQ(ierr);
315a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_inequality);CHKERRQ(ierr);
316a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_inequality_pre);CHKERRQ(ierr);
317a7e14dcfSSatish Balay   ierr = ISDestroy(&(*tao)->state_is);CHKERRQ(ierr);
318a7e14dcfSSatish Balay   ierr = ISDestroy(&(*tao)->design_is);CHKERRQ(ierr);
319a7e14dcfSSatish Balay   ierr = TaoCancelMonitors(*tao);CHKERRQ(ierr);
320ae93cb3cSJason Sarich   if ((*tao)->hist_malloc) {
321ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_obj);CHKERRQ(ierr);
322ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_resid);CHKERRQ(ierr);
323ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_cnorm);CHKERRQ(ierr);
324ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_lits);CHKERRQ(ierr);
325ae93cb3cSJason Sarich   }
326a7e14dcfSSatish Balay   ierr = PetscHeaderDestroy(tao);CHKERRQ(ierr);
327a7e14dcfSSatish Balay   PetscFunctionReturn(0);
328a7e14dcfSSatish Balay }
329a7e14dcfSSatish Balay 
330a7e14dcfSSatish Balay #undef __FUNCT__
331a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetFromOptions"
332a7e14dcfSSatish Balay /*@
333441846f8SBarry Smith   TaoSetFromOptions - Sets various Tao parameters from user
334a7e14dcfSSatish Balay   options.
335a7e14dcfSSatish Balay 
336441846f8SBarry Smith   Collective on Tao
337a7e14dcfSSatish Balay 
338a7e14dcfSSatish Balay   Input Paremeter:
339441846f8SBarry Smith . tao - the Tao solver context
340a7e14dcfSSatish Balay 
341a7e14dcfSSatish Balay   options Database Keys:
34258417fe7SBarry Smith + -tao_type <type> - The algorithm that TAO uses (lmvm, nls, etc.)
343a7e14dcfSSatish Balay . -tao_fatol <fatol> - absolute error tolerance in function value
344a7e14dcfSSatish Balay . -tao_frtol <frtol> - relative error tolerance in function value
345a7e14dcfSSatish Balay . -tao_gatol <gatol> - absolute error tolerance for ||gradient||
346a7e14dcfSSatish Balay . -tao_grtol <grtol> - relative error tolerance for ||gradient||
347a7e14dcfSSatish Balay . -tao_gttol <gttol> - reduction of ||gradient|| relative to initial gradient
348a7e14dcfSSatish Balay . -tao_max_it <max> - sets maximum number of iterations
349a7e14dcfSSatish Balay . -tao_max_funcs <max> - sets maximum number of function evaluations
350a7e14dcfSSatish Balay . -tao_fmin <fmin> - stop if function value reaches fmin
351a7e14dcfSSatish Balay . -tao_steptol <tol> - stop if trust region radius less than <tol>
352a7e14dcfSSatish Balay . -tao_trust0 <t> - initial trust region radius
353a7e14dcfSSatish Balay . -tao_monitor - prints function value and residual at each iteration
354a7e14dcfSSatish Balay . -tao_smonitor - same as tao_monitor, but truncates very small values
355a7e14dcfSSatish Balay . -tao_cmonitor - prints function value, residual, and constraint norm at each iteration
356a7e14dcfSSatish Balay . -tao_view_solution - prints solution vector at each iteration
357a7e14dcfSSatish Balay . -tao_view_separableobjective - prints separable objective vector at each iteration
358a7e14dcfSSatish Balay . -tao_view_step - prints step direction vector at each iteration
359a7e14dcfSSatish Balay . -tao_view_gradient - prints gradient vector at each iteration
360a7e14dcfSSatish Balay . -tao_draw_solution - graphically view solution vector at each iteration
361a7e14dcfSSatish Balay . -tao_draw_step - graphically view step vector at each iteration
362a7e14dcfSSatish Balay . -tao_draw_gradient - graphically view gradient at each iteration
363a7e14dcfSSatish Balay . -tao_fd_gradient - use gradient computed with finite differences
364a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors (except those set with command line)
365441846f8SBarry Smith . -tao_view - prints information about the Tao after solving
366a7e14dcfSSatish Balay - -tao_converged_reason - prints the reason TAO stopped iterating
367a7e14dcfSSatish Balay 
368a7e14dcfSSatish Balay   Notes:
369a7e14dcfSSatish Balay   To see all options, run your program with the -help option or consult the
370a7e14dcfSSatish Balay   user's manual. Should be called after TaoCreate() but before TaoSolve()
371a7e14dcfSSatish Balay 
372a7e14dcfSSatish Balay   Level: beginner
373a7e14dcfSSatish Balay @*/
374441846f8SBarry Smith PetscErrorCode TaoSetFromOptions(Tao tao)
375a7e14dcfSSatish Balay {
376a7e14dcfSSatish Balay   PetscErrorCode ierr;
37758417fe7SBarry Smith   const TaoType  default_type = TAOLMVM;
378a7e14dcfSSatish Balay   const char     *prefix;
379a7e14dcfSSatish Balay   char           type[256], monfilename[PETSC_MAX_PATH_LEN];
380a7e14dcfSSatish Balay   PetscViewer    monviewer;
381a7e14dcfSSatish Balay   PetscBool      flg;
382a7e14dcfSSatish Balay   MPI_Comm       comm;
383a7e14dcfSSatish Balay 
384a7e14dcfSSatish Balay   PetscFunctionBegin;
385441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
386a7e14dcfSSatish Balay   ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
387302440fdSBarry Smith   ierr = TaoGetOptionsPrefix(tao,&prefix);CHKERRQ(ierr);
388a7e14dcfSSatish Balay   /* So no warnings are given about unused options */
389302440fdSBarry Smith   ierr = PetscOptionsHasName(prefix,"-tao_ls_type",&flg);CHKERRQ(ierr);
390a7e14dcfSSatish Balay 
391a7e14dcfSSatish Balay   ierr = PetscObjectOptionsBegin((PetscObject)tao);CHKERRQ(ierr);
392a7e14dcfSSatish Balay   {
393441846f8SBarry Smith     ierr = TaoRegisterAll();CHKERRQ(ierr);
394a7e14dcfSSatish Balay     if (((PetscObject)tao)->type_name) {
395a7e14dcfSSatish Balay       default_type = ((PetscObject)tao)->type_name;
396a7e14dcfSSatish Balay     }
397a7e14dcfSSatish Balay     /* Check for type from options */
398441846f8SBarry Smith     ierr = PetscOptionsFList("-tao_type","Tao Solver type","TaoSetType",TaoList,default_type,type,256,&flg);CHKERRQ(ierr);
399a7e14dcfSSatish Balay     if (flg) {
400a7e14dcfSSatish Balay       ierr = TaoSetType(tao,type);CHKERRQ(ierr);
401a7e14dcfSSatish Balay     } else if (!((PetscObject)tao)->type_name) {
402302440fdSBarry Smith       ierr = TaoSetType(tao,default_type);CHKERRQ(ierr);
403a7e14dcfSSatish Balay     }
404a7e14dcfSSatish Balay 
4056552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_fatol","Stop if solution within","TaoSetTolerances",tao->fatol,&tao->fatol,&flg);CHKERRQ(ierr);
4066552cf8aSJason Sarich     if (flg) tao->fatol_changed=PETSC_TRUE;
4076552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_frtol","Stop if relative solution within","TaoSetTolerances",tao->frtol,&tao->frtol,&flg);CHKERRQ(ierr);
4086552cf8aSJason Sarich     if (flg) tao->frtol_changed=PETSC_TRUE;
4096552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_catol","Stop if constraints violations within","TaoSetConstraintTolerances",tao->catol,&tao->catol,&flg);CHKERRQ(ierr);
4106552cf8aSJason Sarich     if (flg) tao->catol_changed=PETSC_TRUE;
4116552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_crtol","Stop if relative contraint violations within","TaoSetConstraintTolerances",tao->crtol,&tao->crtol,&flg);CHKERRQ(ierr);
4126552cf8aSJason Sarich     if (flg) tao->crtol_changed=PETSC_TRUE;
4136552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_gatol","Stop if norm of gradient less than","TaoSetTolerances",tao->gatol,&tao->gatol,&flg);CHKERRQ(ierr);
4146552cf8aSJason Sarich     if (flg) tao->gatol_changed=PETSC_TRUE;
4156552cf8aSJason 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);
4166552cf8aSJason Sarich     if (flg) tao->grtol_changed=PETSC_TRUE;
4176552cf8aSJason 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);
4186552cf8aSJason Sarich     if (flg) tao->gttol_changed=PETSC_TRUE;
4196552cf8aSJason Sarich     ierr = PetscOptionsInt("-tao_max_it","Stop if iteration number exceeds","TaoSetMaximumIterations",tao->max_it,&tao->max_it,&flg);CHKERRQ(ierr);
4206552cf8aSJason Sarich     if (flg) tao->max_it_changed=PETSC_TRUE;
4216552cf8aSJason Sarich     ierr = PetscOptionsInt("-tao_max_funcs","Stop if number of function evaluations exceeds","TaoSetMaximumFunctionEvaluations",tao->max_funcs,&tao->max_funcs,&flg);CHKERRQ(ierr);
4226552cf8aSJason Sarich     if (flg) tao->max_funcs_changed=PETSC_TRUE;
4236552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_fmin","Stop if function less than","TaoSetFunctionLowerBound",tao->fmin,&tao->fmin,&flg);CHKERRQ(ierr);
4246552cf8aSJason Sarich     if (flg) tao->fmin_changed=PETSC_TRUE;
4256552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_steptol","Stop if step size or trust region radius less than","",tao->steptol,&tao->steptol,&flg);CHKERRQ(ierr);
4266552cf8aSJason Sarich     if (flg) tao->steptol_changed=PETSC_TRUE;
4276552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_trust0","Initial trust region radius","TaoSetTrustRegionRadius",tao->trust0,&tao->trust0,&flg);CHKERRQ(ierr);
4286552cf8aSJason Sarich     if (flg) tao->trust0_changed=PETSC_TRUE;
429a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_solution","view solution vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
430a7e14dcfSSatish Balay     if (flg) {
431a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
432a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoSolutionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
433a7e14dcfSSatish Balay     }
434a7e14dcfSSatish Balay 
4358afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_converged_reason","Print reason for TAO converged","TaoSolve",tao->printreason,&tao->printreason,NULL);CHKERRQ(ierr);
436a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_gradient","view gradient vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
437a7e14dcfSSatish Balay     if (flg) {
438a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
439a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoGradientMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
440a7e14dcfSSatish Balay     }
441a7e14dcfSSatish Balay 
442a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_stepdirection","view step direction vector after each iteration","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
443a7e14dcfSSatish Balay     if (flg) {
444a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
445a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoStepDirectionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
446a7e14dcfSSatish Balay     }
447a7e14dcfSSatish Balay 
448a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_separableobjective","view separable objective vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
449a7e14dcfSSatish Balay     if (flg) {
450a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
451a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoSeparableObjectiveMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
452a7e14dcfSSatish Balay     }
453a7e14dcfSSatish Balay 
454a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_monitor","Use the default convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
455a7e14dcfSSatish Balay     if (flg) {
456a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
457a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
458a7e14dcfSSatish Balay     }
459a7e14dcfSSatish Balay 
460a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_smonitor","Use the short convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
461a7e14dcfSSatish Balay     if (flg) {
462a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
463a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultSMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
464a7e14dcfSSatish Balay     }
465a7e14dcfSSatish Balay 
466a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_cmonitor","Use the default convergence monitor with constraint norm","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
467a7e14dcfSSatish Balay     if (flg) {
468a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
469a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultCMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
470a7e14dcfSSatish Balay     }
471a7e14dcfSSatish Balay 
472a7e14dcfSSatish Balay 
4738afaa268SBarry Smith     flg = PETSC_FALSE;
4748afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_cancelmonitors","cancel all monitors and call any registered destroy routines","TaoCancelMonitors",flg,&flg,NULL);CHKERRQ(ierr);
475a7e14dcfSSatish Balay     if (flg) {ierr = TaoCancelMonitors(tao);CHKERRQ(ierr);}
476a7e14dcfSSatish Balay 
4778afaa268SBarry Smith     flg = PETSC_FALSE;
4788afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_draw_solution","Plot solution vector at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr);
479a7e14dcfSSatish Balay     if (flg) {
48047a47007SBarry Smith       ierr = TaoSetMonitor(tao,TaoDrawSolutionMonitor,NULL,NULL);CHKERRQ(ierr);
481a7e14dcfSSatish Balay     }
482a7e14dcfSSatish Balay 
4838afaa268SBarry Smith     flg = PETSC_FALSE;
4848afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_draw_step","plots step direction at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr);
485a7e14dcfSSatish Balay     if (flg) {
48647a47007SBarry Smith       ierr = TaoSetMonitor(tao,TaoDrawStepMonitor,NULL,NULL);CHKERRQ(ierr);
487a7e14dcfSSatish Balay     }
488a7e14dcfSSatish Balay 
4898afaa268SBarry Smith     flg = PETSC_FALSE;
4908afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_draw_gradient","plots gradient at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr);
491a7e14dcfSSatish Balay     if (flg) {
49247a47007SBarry Smith       ierr = TaoSetMonitor(tao,TaoDrawGradientMonitor,NULL,NULL);CHKERRQ(ierr);
493a7e14dcfSSatish Balay     }
4948afaa268SBarry Smith     flg = PETSC_FALSE;
4958afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_fd_gradient","compute gradient using finite differences","TaoDefaultComputeGradient",flg,&flg,NULL);CHKERRQ(ierr);
496a7e14dcfSSatish Balay     if (flg) {
49747a47007SBarry Smith       ierr = TaoSetGradientRoutine(tao,TaoDefaultComputeGradient,NULL);CHKERRQ(ierr);
498a7e14dcfSSatish Balay     }
499e1cc520bSBarry Smith     ierr = PetscOptionsEnum("-tao_subset_type","subset type", "", TaoSubSetTypes,(PetscEnum)tao->subset_type, (PetscEnum*)&tao->subset_type, 0);CHKERRQ(ierr);
500a7e14dcfSSatish Balay 
501a7e14dcfSSatish Balay     if (tao->ops->setfromoptions) {
5021a1499c8SBarry Smith       ierr = (*tao->ops->setfromoptions)(PetscOptionsObject,tao);CHKERRQ(ierr);
503a7e14dcfSSatish Balay     }
504a7e14dcfSSatish Balay   }
505a7e14dcfSSatish Balay   ierr = PetscOptionsEnd();CHKERRQ(ierr);
506a7e14dcfSSatish Balay   PetscFunctionReturn(0);
507a7e14dcfSSatish Balay }
508a7e14dcfSSatish Balay 
509a7e14dcfSSatish Balay #undef __FUNCT__
510a7e14dcfSSatish Balay #define __FUNCT__ "TaoView"
511a7e14dcfSSatish Balay /*@C
512441846f8SBarry Smith   TaoView - Prints information about the Tao
513a7e14dcfSSatish Balay 
514441846f8SBarry Smith   Collective on Tao
515a7e14dcfSSatish Balay 
516a7e14dcfSSatish Balay   InputParameters:
517441846f8SBarry Smith + tao - the Tao context
518a7e14dcfSSatish Balay - viewer - visualization context
519a7e14dcfSSatish Balay 
520a7e14dcfSSatish Balay   Options Database Key:
521a7e14dcfSSatish Balay . -tao_view - Calls TaoView() at the end of TaoSolve()
522a7e14dcfSSatish Balay 
523a7e14dcfSSatish Balay   Notes:
524a7e14dcfSSatish Balay   The available visualization contexts include
525a7e14dcfSSatish Balay +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
526a7e14dcfSSatish Balay -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
527a7e14dcfSSatish Balay          output where only the first processor opens
528a7e14dcfSSatish Balay          the file.  All other processors send their
529a7e14dcfSSatish Balay          data to the first processor to print.
530a7e14dcfSSatish Balay 
531a7e14dcfSSatish Balay   Level: beginner
532a7e14dcfSSatish Balay 
533a7e14dcfSSatish Balay .seealso: PetscViewerASCIIOpen()
534a7e14dcfSSatish Balay @*/
535441846f8SBarry Smith PetscErrorCode TaoView(Tao tao, PetscViewer viewer)
536a7e14dcfSSatish Balay {
537a7e14dcfSSatish Balay   PetscErrorCode      ierr;
538a7e14dcfSSatish Balay   PetscBool           isascii,isstring;
539441846f8SBarry Smith   const TaoType type;
54047a47007SBarry Smith 
541a7e14dcfSSatish Balay   PetscFunctionBegin;
542441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
543a7e14dcfSSatish Balay   if (!viewer) {
544a7e14dcfSSatish Balay     ierr = PetscViewerASCIIGetStdout(((PetscObject)tao)->comm,&viewer);CHKERRQ(ierr);
545a7e14dcfSSatish Balay   }
546a7e14dcfSSatish Balay   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
547a7e14dcfSSatish Balay   PetscCheckSameComm(tao,1,viewer,2);
548a7e14dcfSSatish Balay 
549a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
550a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
551a7e14dcfSSatish Balay   if (isascii) {
552a7e14dcfSSatish Balay     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)tao,viewer);CHKERRQ(ierr);
553a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
554a7e14dcfSSatish Balay 
555a7e14dcfSSatish Balay     if (tao->ops->view) {
556a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
557a7e14dcfSSatish Balay       ierr = (*tao->ops->view)(tao,viewer);CHKERRQ(ierr);
558a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
559a7e14dcfSSatish Balay     }
560a7e14dcfSSatish Balay     if (tao->linesearch) {
561a7e14dcfSSatish Balay       ierr = PetscObjectPrintClassNamePrefixType((PetscObject)(tao->linesearch),viewer);CHKERRQ(ierr);
562a7e14dcfSSatish Balay     }
563a7e14dcfSSatish Balay     if (tao->ksp) {
564a7e14dcfSSatish Balay       ierr = PetscObjectPrintClassNamePrefixType((PetscObject)(tao->ksp),viewer);CHKERRQ(ierr);
565ae93cb3cSJason Sarich       ierr = PetscViewerASCIIPrintf(viewer,"total KSP iterations: %D\n",tao->ksp_tot_its);CHKERRQ(ierr);
566a7e14dcfSSatish Balay     }
567a7e14dcfSSatish Balay     if (tao->XL || tao->XU) {
568302440fdSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Active Set subset type: %s\n",TaoSubSetTypes[tao->subset_type]);CHKERRQ(ierr);
569a7e14dcfSSatish Balay     }
570a7e14dcfSSatish Balay 
57147a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: fatol=%g,",(double)tao->fatol);CHKERRQ(ierr);
57247a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," frtol=%g\n",(double)tao->frtol);CHKERRQ(ierr);
573a7e14dcfSSatish Balay 
57447a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: gatol=%g,",(double)tao->gatol);CHKERRQ(ierr);
57547a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," steptol=%g,",(double)tao->steptol);CHKERRQ(ierr);
57647a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," gttol=%g\n",(double)tao->gttol);CHKERRQ(ierr);
577a7e14dcfSSatish Balay 
57847a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Residual in Function/Gradient:=%g\n",(double)tao->residual);CHKERRQ(ierr);
579a7e14dcfSSatish Balay 
580a7e14dcfSSatish Balay     if (tao->cnorm>0 || tao->catol>0 || tao->crtol>0){
581a7e14dcfSSatish Balay       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances:");CHKERRQ(ierr);
58247a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer," catol=%g,",(double)tao->catol);CHKERRQ(ierr);
58347a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer," crtol=%g\n",(double)tao->crtol);CHKERRQ(ierr);
58447a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Residual in Constraints:=%g\n",(double)tao->cnorm);CHKERRQ(ierr);
585a7e14dcfSSatish Balay     }
586a7e14dcfSSatish Balay 
587a7e14dcfSSatish Balay     if (tao->trust < tao->steptol){
58847a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: steptol=%g\n",(double)tao->steptol);CHKERRQ(ierr);
58947a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"Final trust region radius:=%g\n",(double)tao->trust);CHKERRQ(ierr);
590a7e14dcfSSatish Balay     }
591a7e14dcfSSatish Balay 
592a7e14dcfSSatish Balay     if (tao->fmin>-1.e25){
59347a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: function minimum=%g\n",(double)tao->fmin);CHKERRQ(ierr);
594a7e14dcfSSatish Balay     }
59547a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Objective value=%g\n",(double)tao->fc);CHKERRQ(ierr);
596a7e14dcfSSatish Balay 
59747a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"total number of iterations=%D,          ",tao->niter);CHKERRQ(ierr);
598a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPrintf(viewer,"              (max: %D)\n",tao->max_it);CHKERRQ(ierr);
599a7e14dcfSSatish Balay 
600a7e14dcfSSatish Balay     if (tao->nfuncs>0){
60147a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of function evaluations=%D,",tao->nfuncs);CHKERRQ(ierr);
60247a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"                max: %D\n",tao->max_funcs);CHKERRQ(ierr);
603a7e14dcfSSatish Balay     }
604a7e14dcfSSatish Balay     if (tao->ngrads>0){
60547a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of gradient evaluations=%D,",tao->ngrads);CHKERRQ(ierr);
60647a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"                max: %D\n",tao->max_funcs);CHKERRQ(ierr);
607a7e14dcfSSatish Balay     }
608a7e14dcfSSatish Balay     if (tao->nfuncgrads>0){
60947a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of function/gradient evaluations=%D,",tao->nfuncgrads);CHKERRQ(ierr);
61047a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    (max: %D)\n",tao->max_funcs);CHKERRQ(ierr);
611a7e14dcfSSatish Balay     }
612a7e14dcfSSatish Balay     if (tao->nhess>0){
61347a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of Hessian evaluations=%D\n",tao->nhess);CHKERRQ(ierr);
614a7e14dcfSSatish Balay     }
615a7e14dcfSSatish Balay     /*  if (tao->linear_its>0){
61647a47007SBarry Smith      ierr = PetscViewerASCIIPrintf(viewer,"  total Krylov method iterations=%D\n",tao->linear_its);CHKERRQ(ierr);
617a7e14dcfSSatish Balay      }*/
618a7e14dcfSSatish Balay     if (tao->nconstraints>0){
61947a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of constraint function evaluations=%D\n",tao->nconstraints);CHKERRQ(ierr);
620a7e14dcfSSatish Balay     }
621a7e14dcfSSatish Balay     if (tao->njac>0){
62247a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of Jacobian evaluations=%D\n",tao->njac);CHKERRQ(ierr);
623a7e14dcfSSatish Balay     }
624a7e14dcfSSatish Balay 
625a7e14dcfSSatish Balay     if (tao->reason>0){
626a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer,    "Solution converged: ");CHKERRQ(ierr);
627a7e14dcfSSatish Balay       switch (tao->reason) {
628a7e14dcfSSatish Balay       case TAO_CONVERGED_FATOL:
629a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"estimated f(x)-f(X*) <= fatol\n");CHKERRQ(ierr);
630a7e14dcfSSatish Balay         break;
631a7e14dcfSSatish Balay       case TAO_CONVERGED_FRTOL:
632a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"estimated |f(x)-f(X*)|/|f(X*)| <= frtol\n");CHKERRQ(ierr);
633a7e14dcfSSatish Balay         break;
634a7e14dcfSSatish Balay       case TAO_CONVERGED_GATOL:
635a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)|| <= gatol\n");CHKERRQ(ierr);
636a7e14dcfSSatish Balay         break;
637a7e14dcfSSatish Balay       case TAO_CONVERGED_GRTOL:
638a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/|f(X)| <= grtol\n");CHKERRQ(ierr);
639a7e14dcfSSatish Balay         break;
640a7e14dcfSSatish Balay       case TAO_CONVERGED_GTTOL:
641a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/||g(X0)|| <= gttol\n");CHKERRQ(ierr);
642a7e14dcfSSatish Balay         break;
643a7e14dcfSSatish Balay       case TAO_CONVERGED_STEPTOL:
644a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," Steptol -- step size small\n");CHKERRQ(ierr);
645a7e14dcfSSatish Balay         break;
646a7e14dcfSSatish Balay       case TAO_CONVERGED_MINF:
647a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," Minf --  f < fmin\n");CHKERRQ(ierr);
648a7e14dcfSSatish Balay         break;
649a7e14dcfSSatish Balay       case TAO_CONVERGED_USER:
650a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr);
651a7e14dcfSSatish Balay         break;
652a7e14dcfSSatish Balay       default:
653a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
654a7e14dcfSSatish Balay         break;
655a7e14dcfSSatish Balay       }
656a7e14dcfSSatish Balay 
657a7e14dcfSSatish Balay     } else {
658a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer,"Solver terminated: %D",tao->reason);CHKERRQ(ierr);
659a7e14dcfSSatish Balay       switch (tao->reason) {
660a7e14dcfSSatish Balay       case TAO_DIVERGED_MAXITS:
66147a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Maximum Iterations\n");CHKERRQ(ierr);
662a7e14dcfSSatish Balay         break;
663a7e14dcfSSatish Balay       case TAO_DIVERGED_NAN:
66447a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," NAN or Inf encountered\n");CHKERRQ(ierr);
665a7e14dcfSSatish Balay         break;
666a7e14dcfSSatish Balay       case TAO_DIVERGED_MAXFCN:
66747a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Maximum Function Evaluations\n");CHKERRQ(ierr);
668a7e14dcfSSatish Balay         break;
669a7e14dcfSSatish Balay       case TAO_DIVERGED_LS_FAILURE:
67047a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Line Search Failure\n");CHKERRQ(ierr);
671a7e14dcfSSatish Balay         break;
672a7e14dcfSSatish Balay       case TAO_DIVERGED_TR_REDUCTION:
67347a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Trust Region too small\n");CHKERRQ(ierr);
674a7e14dcfSSatish Balay         break;
675a7e14dcfSSatish Balay       case TAO_DIVERGED_USER:
67647a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr);
677a7e14dcfSSatish Balay         break;
678a7e14dcfSSatish Balay       default:
679a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
680a7e14dcfSSatish Balay         break;
681a7e14dcfSSatish Balay       }
682a7e14dcfSSatish Balay     }
683a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
684a7e14dcfSSatish Balay   } else if (isstring) {
685a7e14dcfSSatish Balay     ierr = TaoGetType(tao,&type);CHKERRQ(ierr);
686a7e14dcfSSatish Balay     ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr);
687a7e14dcfSSatish Balay   }
688a7e14dcfSSatish Balay   PetscFunctionReturn(0);
689a7e14dcfSSatish Balay }
690a7e14dcfSSatish Balay 
691a7e14dcfSSatish Balay #undef __FUNCT__
692a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetTolerances"
693a7e14dcfSSatish Balay /*@
694a7e14dcfSSatish Balay   TaoSetTolerances - Sets parameters used in TAO convergence tests
695a7e14dcfSSatish Balay 
696441846f8SBarry Smith   Logically collective on Tao
697a7e14dcfSSatish Balay 
698a7e14dcfSSatish Balay   Input Parameters:
699441846f8SBarry Smith + tao - the Tao context
700a7e14dcfSSatish Balay . fatol - absolute convergence tolerance
701a7e14dcfSSatish Balay . frtol - relative convergence tolerance
702a7e14dcfSSatish Balay . gatol - stop if norm of gradient is less than this
703a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this
704a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by this factor
705a7e14dcfSSatish Balay 
706a7e14dcfSSatish Balay   Options Database Keys:
707a7e14dcfSSatish Balay + -tao_fatol <fatol> - Sets fatol
708a7e14dcfSSatish Balay . -tao_frtol <frtol> - Sets frtol
709a7e14dcfSSatish Balay . -tao_gatol <gatol> - Sets gatol
710a7e14dcfSSatish Balay . -tao_grtol <grtol> - Sets grtol
711a7e14dcfSSatish Balay - -tao_gttol <gttol> - Sets gttol
712a7e14dcfSSatish Balay 
713a7e14dcfSSatish Balay   Stopping Criteria:
714a7e14dcfSSatish Balay $ f(X) - f(X*) (estimated)            <= fatol
715a7e14dcfSSatish Balay $ |f(X) - f(X*)| (estimated) / |f(X)| <= frtol
716a7e14dcfSSatish Balay $ ||g(X)||                            <= gatol
717a7e14dcfSSatish Balay $ ||g(X)|| / |f(X)|                   <= grtol
718a7e14dcfSSatish Balay $ ||g(X)|| / ||g(X0)||                <= gttol
719a7e14dcfSSatish Balay 
720a7e14dcfSSatish Balay   Notes:
721a7e14dcfSSatish Balay   Use PETSC_DEFAULT to leave one or more tolerances unchanged.
722a7e14dcfSSatish Balay 
723a7e14dcfSSatish Balay   Level: beginner
724a7e14dcfSSatish Balay 
725a7e14dcfSSatish Balay .seealso: TaoGetTolerances()
726a7e14dcfSSatish Balay 
727a7e14dcfSSatish Balay @*/
728441846f8SBarry Smith PetscErrorCode TaoSetTolerances(Tao tao, PetscReal fatol, PetscReal frtol, PetscReal gatol, PetscReal grtol, PetscReal gttol)
729a7e14dcfSSatish Balay {
730a7e14dcfSSatish Balay   PetscErrorCode ierr;
73147a47007SBarry Smith 
732a7e14dcfSSatish Balay   PetscFunctionBegin;
733441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
734a7e14dcfSSatish Balay 
735a7e14dcfSSatish Balay   if (fatol != PETSC_DEFAULT) {
736a7e14dcfSSatish Balay     if (fatol<0) {
737955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative fatol -- ignored.\n");CHKERRQ(ierr);
738a7e14dcfSSatish Balay     } else {
739a7e14dcfSSatish Balay       tao->fatol = PetscMax(0,fatol);
7406552cf8aSJason Sarich       tao->fatol_changed=PETSC_TRUE;
741a7e14dcfSSatish Balay     }
742a7e14dcfSSatish Balay   }
743a7e14dcfSSatish Balay   if (frtol != PETSC_DEFAULT) {
744a7e14dcfSSatish Balay     if (frtol<0) {
745955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative frtol -- ignored.\n");CHKERRQ(ierr);
746a7e14dcfSSatish Balay     } else {
747a7e14dcfSSatish Balay       tao->frtol = PetscMax(0,frtol);
7486552cf8aSJason Sarich       tao->frtol_changed=PETSC_TRUE;
749a7e14dcfSSatish Balay     }
750a7e14dcfSSatish Balay   }
751a7e14dcfSSatish Balay 
752a7e14dcfSSatish Balay   if (gatol != PETSC_DEFAULT) {
753a7e14dcfSSatish Balay     if (gatol<0) {
754955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative gatol -- ignored.\n");CHKERRQ(ierr);
755a7e14dcfSSatish Balay     } else {
756a7e14dcfSSatish Balay       tao->gatol = PetscMax(0,gatol);
7576552cf8aSJason Sarich       tao->gatol_changed=PETSC_TRUE;
758a7e14dcfSSatish Balay     }
759a7e14dcfSSatish Balay   }
760a7e14dcfSSatish Balay 
761a7e14dcfSSatish Balay   if (grtol != PETSC_DEFAULT) {
762a7e14dcfSSatish Balay     if (grtol<0) {
763955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative grtol -- ignored.\n");CHKERRQ(ierr);
764a7e14dcfSSatish Balay     } else {
765a7e14dcfSSatish Balay       tao->grtol = PetscMax(0,grtol);
7666552cf8aSJason Sarich       tao->grtol_changed=PETSC_TRUE;
767a7e14dcfSSatish Balay     }
768a7e14dcfSSatish Balay   }
769a7e14dcfSSatish Balay 
770a7e14dcfSSatish Balay   if (gttol != PETSC_DEFAULT) {
771a7e14dcfSSatish Balay     if (gttol<0) {
772955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative gttol -- ignored.\n");CHKERRQ(ierr);
773a7e14dcfSSatish Balay     } else {
774a7e14dcfSSatish Balay       tao->gttol = PetscMax(0,gttol);
7756552cf8aSJason Sarich       tao->gttol_changed=PETSC_TRUE;
776a7e14dcfSSatish Balay     }
777a7e14dcfSSatish Balay   }
778a7e14dcfSSatish Balay   PetscFunctionReturn(0);
779a7e14dcfSSatish Balay }
780a7e14dcfSSatish Balay 
781a7e14dcfSSatish Balay #undef __FUNCT__
782a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetConstraintTolerances"
783a7e14dcfSSatish Balay /*@
78458417fe7SBarry Smith   TaoSetConstraintTolerances - Sets constraint tolerance parameters used in TAO  convergence tests
785a7e14dcfSSatish Balay 
786441846f8SBarry Smith   Logically collective on Tao
787a7e14dcfSSatish Balay 
788a7e14dcfSSatish Balay   Input Parameters:
789441846f8SBarry Smith + tao - the Tao context
790a7e14dcfSSatish Balay . catol - absolute constraint tolerance, constraint norm must be less than catol for used for fatol, gatol convergence criteria
791a7e14dcfSSatish Balay - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for fatol, gatol, gttol convergence criteria
792a7e14dcfSSatish Balay 
793a7e14dcfSSatish Balay   Options Database Keys:
794a7e14dcfSSatish Balay + -tao_catol <catol> - Sets catol
795a7e14dcfSSatish Balay - -tao_crtol <crtol> - Sets crtol
796a7e14dcfSSatish Balay 
7976552cf8aSJason Sarich   Notes:
7986552cf8aSJason Sarich   Use PETSC_DEFAULT to leave any tolerance unchanged.
7996552cf8aSJason Sarich 
800a7e14dcfSSatish Balay   Level: intermediate
801a7e14dcfSSatish Balay 
80258417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoGetConstraintTolerances(), TaoSetTolerances()
803a7e14dcfSSatish Balay 
804a7e14dcfSSatish Balay @*/
805441846f8SBarry Smith PetscErrorCode TaoSetConstraintTolerances(Tao tao, PetscReal catol, PetscReal crtol)
806a7e14dcfSSatish Balay {
807a7e14dcfSSatish Balay   PetscErrorCode ierr;
80847a47007SBarry Smith 
809a7e14dcfSSatish Balay   PetscFunctionBegin;
810441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
811a7e14dcfSSatish Balay 
812a7e14dcfSSatish Balay   if (catol != PETSC_DEFAULT) {
813a7e14dcfSSatish Balay     if (catol<0) {
814955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative catol -- ignored.\n");CHKERRQ(ierr);
815a7e14dcfSSatish Balay     } else {
816a7e14dcfSSatish Balay       tao->catol = PetscMax(0,catol);
8176552cf8aSJason Sarich       tao->catol_changed=PETSC_TRUE;
818a7e14dcfSSatish Balay     }
819a7e14dcfSSatish Balay   }
820a7e14dcfSSatish Balay 
821a7e14dcfSSatish Balay   if (crtol != PETSC_DEFAULT) {
822a7e14dcfSSatish Balay     if (crtol<0) {
823955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative crtol -- ignored.\n");CHKERRQ(ierr);
824a7e14dcfSSatish Balay     } else {
825a7e14dcfSSatish Balay       tao->crtol = PetscMax(0,crtol);
8266552cf8aSJason Sarich       tao->crtol_changed=PETSC_TRUE;
827a7e14dcfSSatish Balay     }
828a7e14dcfSSatish Balay   }
829a7e14dcfSSatish Balay   PetscFunctionReturn(0);
830a7e14dcfSSatish Balay }
831a7e14dcfSSatish Balay 
832a7e14dcfSSatish Balay #undef __FUNCT__
83358417fe7SBarry Smith #define __FUNCT__ "TaoGetConstraintTolerances"
83458417fe7SBarry Smith /*@
83558417fe7SBarry Smith   TaoGetConstraintTolerances - Gets constraint tolerance parameters used in TAO  convergence tests
83658417fe7SBarry Smith 
83758417fe7SBarry Smith   Not ollective
83858417fe7SBarry Smith 
83958417fe7SBarry Smith   Input Parameter:
84058417fe7SBarry Smith . tao - the Tao context
84158417fe7SBarry Smith 
84258417fe7SBarry Smith   Output Parameter:
84358417fe7SBarry Smith + catol - absolute constraint tolerance, constraint norm must be less than catol for used for fatol, gatol convergence criteria
84458417fe7SBarry Smith - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for fatol, gatol, gttol convergence criteria
84558417fe7SBarry Smith 
84658417fe7SBarry Smith   Level: intermediate
84758417fe7SBarry Smith 
84858417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoSetTolerances(), TaoSetConstraintTolerances()
84958417fe7SBarry Smith 
85058417fe7SBarry Smith @*/
85158417fe7SBarry Smith PetscErrorCode TaoGetConstraintTolerances(Tao tao, PetscReal *catol, PetscReal *crtol)
85258417fe7SBarry Smith {
85358417fe7SBarry Smith   PetscFunctionBegin;
85458417fe7SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
85558417fe7SBarry Smith   if (catol) *catol = tao->catol;
85658417fe7SBarry Smith   if (crtol) *crtol = tao->crtol;
85758417fe7SBarry Smith   PetscFunctionReturn(0);
85858417fe7SBarry Smith }
85958417fe7SBarry Smith 
86058417fe7SBarry Smith #undef __FUNCT__
861a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetFunctionLowerBound"
862a7e14dcfSSatish Balay /*@
863a7e14dcfSSatish Balay    TaoSetFunctionLowerBound - Sets a bound on the solution objective value.
864a7e14dcfSSatish Balay    When an approximate solution with an objective value below this number
865a7e14dcfSSatish Balay    has been found, the solver will terminate.
866a7e14dcfSSatish Balay 
867441846f8SBarry Smith    Logically Collective on Tao
868a7e14dcfSSatish Balay 
869a7e14dcfSSatish Balay    Input Parameters:
870441846f8SBarry Smith +  tao - the Tao solver context
871a7e14dcfSSatish Balay -  fmin - the tolerance
872a7e14dcfSSatish Balay 
873a7e14dcfSSatish Balay    Options Database Keys:
874a7e14dcfSSatish Balay .    -tao_fmin <fmin> - sets the minimum function value
875a7e14dcfSSatish Balay 
876a7e14dcfSSatish Balay    Level: intermediate
877a7e14dcfSSatish Balay 
878a7e14dcfSSatish Balay .seealso: TaoSetTolerances()
879a7e14dcfSSatish Balay @*/
880441846f8SBarry Smith PetscErrorCode TaoSetFunctionLowerBound(Tao tao,PetscReal fmin)
881a7e14dcfSSatish Balay {
882a7e14dcfSSatish Balay   PetscFunctionBegin;
883441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
884a7e14dcfSSatish Balay   tao->fmin = fmin;
8856552cf8aSJason Sarich   tao->fmin_changed=PETSC_TRUE;
886a7e14dcfSSatish Balay   PetscFunctionReturn(0);
887a7e14dcfSSatish Balay }
888a7e14dcfSSatish Balay 
889a7e14dcfSSatish Balay #undef __FUNCT__
890a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetFunctionLowerBound"
891a7e14dcfSSatish Balay /*@
892a7e14dcfSSatish Balay    TaoGetFunctionLowerBound - Sets a bound on the solution objective value.
893a7e14dcfSSatish Balay    When an approximate solution with an objective value below this number
894a7e14dcfSSatish Balay    has been found, the solver will terminate.
895a7e14dcfSSatish Balay 
896441846f8SBarry Smith    Not collective on Tao
897a7e14dcfSSatish Balay 
898a7e14dcfSSatish Balay    Input Parameters:
899441846f8SBarry Smith .  tao - the Tao solver context
900a7e14dcfSSatish Balay 
901a7e14dcfSSatish Balay    OutputParameters:
902a7e14dcfSSatish Balay .  fmin - the minimum function value
903a7e14dcfSSatish Balay 
904a7e14dcfSSatish Balay    Level: intermediate
905a7e14dcfSSatish Balay 
906a7e14dcfSSatish Balay .seealso: TaoSetFunctionLowerBound()
907a7e14dcfSSatish Balay @*/
908441846f8SBarry Smith PetscErrorCode TaoGetFunctionLowerBound(Tao tao,PetscReal *fmin)
909a7e14dcfSSatish Balay {
910a7e14dcfSSatish Balay   PetscFunctionBegin;
911441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
912a7e14dcfSSatish Balay   *fmin = tao->fmin;
913a7e14dcfSSatish Balay   PetscFunctionReturn(0);
914a7e14dcfSSatish Balay }
915a7e14dcfSSatish Balay 
916a7e14dcfSSatish Balay #undef __FUNCT__
917a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMaximumFunctionEvaluations"
918a7e14dcfSSatish Balay /*@
919a7e14dcfSSatish Balay    TaoSetMaximumFunctionEvaluations - Sets a maximum number of
920a7e14dcfSSatish Balay    function evaluations.
921a7e14dcfSSatish Balay 
922441846f8SBarry Smith    Logically Collective on Tao
923a7e14dcfSSatish Balay 
924a7e14dcfSSatish Balay    Input Parameters:
925441846f8SBarry Smith +  tao - the Tao solver context
926a7e14dcfSSatish Balay -  nfcn - the maximum number of function evaluations (>=0)
927a7e14dcfSSatish Balay 
928a7e14dcfSSatish Balay    Options Database Keys:
929a7e14dcfSSatish Balay .    -tao_max_funcs <nfcn> - sets the maximum number of function evaluations
930a7e14dcfSSatish Balay 
931a7e14dcfSSatish Balay    Level: intermediate
932a7e14dcfSSatish Balay 
933a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumIterations()
934a7e14dcfSSatish Balay @*/
935a7e14dcfSSatish Balay 
936441846f8SBarry Smith PetscErrorCode TaoSetMaximumFunctionEvaluations(Tao tao,PetscInt nfcn)
937a7e14dcfSSatish Balay {
938a7e14dcfSSatish Balay   PetscFunctionBegin;
939441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
94047a47007SBarry Smith   tao->max_funcs = PetscMax(0,nfcn);
9416552cf8aSJason Sarich   tao->max_funcs_changed=PETSC_TRUE;
942a7e14dcfSSatish Balay   PetscFunctionReturn(0);
943a7e14dcfSSatish Balay }
944a7e14dcfSSatish Balay 
945a7e14dcfSSatish Balay #undef __FUNCT__
946a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetMaximumFunctionEvaluations"
947a7e14dcfSSatish Balay /*@
948a7e14dcfSSatish Balay    TaoGetMaximumFunctionEvaluations - Sets a maximum number of
949a7e14dcfSSatish Balay    function evaluations.
950a7e14dcfSSatish Balay 
951a7e14dcfSSatish Balay    Not Collective
952a7e14dcfSSatish Balay 
953a7e14dcfSSatish Balay    Input Parameters:
954441846f8SBarry Smith .  tao - the Tao solver context
955a7e14dcfSSatish Balay 
956a7e14dcfSSatish Balay    Output Parameters:
957a7e14dcfSSatish Balay .  nfcn - the maximum number of function evaluations
958a7e14dcfSSatish Balay 
959a7e14dcfSSatish Balay    Level: intermediate
960a7e14dcfSSatish Balay 
961a7e14dcfSSatish Balay .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumIterations()
962a7e14dcfSSatish Balay @*/
963a7e14dcfSSatish Balay 
964441846f8SBarry Smith PetscErrorCode TaoGetMaximumFunctionEvaluations(Tao tao,PetscInt *nfcn)
965a7e14dcfSSatish Balay {
966a7e14dcfSSatish Balay   PetscFunctionBegin;
967441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
968a7e14dcfSSatish Balay   *nfcn = tao->max_funcs;
969a7e14dcfSSatish Balay   PetscFunctionReturn(0);
970a7e14dcfSSatish Balay }
971a7e14dcfSSatish Balay 
972a7e14dcfSSatish Balay #undef __FUNCT__
973770232b9SCe Qin #define __FUNCT__ "TaoGetCurrentFunctionEvaluations"
974770232b9SCe Qin /*@
975770232b9SCe Qin    TaoGetCurrentFunctionEvaluations - Get current number of
976770232b9SCe Qin    function evaluations.
977770232b9SCe Qin 
978770232b9SCe Qin    Not Collective
979770232b9SCe Qin 
980770232b9SCe Qin    Input Parameters:
981770232b9SCe Qin .  tao - the Tao solver context
982770232b9SCe Qin 
983770232b9SCe Qin    Output Parameters:
984770232b9SCe Qin .  nfuncs - the current number of function evaluations
985770232b9SCe Qin 
986770232b9SCe Qin    Level: intermediate
987770232b9SCe Qin 
988770232b9SCe Qin .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumFunctionEvaluations(), TaoGetMaximumIterations()
989770232b9SCe Qin @*/
990770232b9SCe Qin 
991770232b9SCe Qin PetscErrorCode TaoGetCurrentFunctionEvaluations(Tao tao,PetscInt *nfuncs)
992770232b9SCe Qin {
993770232b9SCe Qin   PetscFunctionBegin;
994770232b9SCe Qin   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
995770232b9SCe Qin   *nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads);
996770232b9SCe Qin   PetscFunctionReturn(0);
997770232b9SCe Qin }
998770232b9SCe Qin 
999770232b9SCe Qin #undef __FUNCT__
1000a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMaximumIterations"
1001a7e14dcfSSatish Balay /*@
1002a7e14dcfSSatish Balay    TaoSetMaximumIterations - Sets a maximum number of iterates.
1003a7e14dcfSSatish Balay 
1004441846f8SBarry Smith    Logically Collective on Tao
1005a7e14dcfSSatish Balay 
1006a7e14dcfSSatish Balay    Input Parameters:
1007441846f8SBarry Smith +  tao - the Tao solver context
1008a7e14dcfSSatish Balay -  maxits - the maximum number of iterates (>=0)
1009a7e14dcfSSatish Balay 
1010a7e14dcfSSatish Balay    Options Database Keys:
1011a7e14dcfSSatish Balay .    -tao_max_it <its> - sets the maximum number of iterations
1012a7e14dcfSSatish Balay 
1013a7e14dcfSSatish Balay    Level: intermediate
1014a7e14dcfSSatish Balay 
1015a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumFunctionEvaluations()
1016a7e14dcfSSatish Balay @*/
1017441846f8SBarry Smith PetscErrorCode TaoSetMaximumIterations(Tao tao,PetscInt maxits)
1018a7e14dcfSSatish Balay {
1019a7e14dcfSSatish Balay   PetscFunctionBegin;
1020441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
102147a47007SBarry Smith   tao->max_it = PetscMax(0,maxits);
10226552cf8aSJason Sarich   tao->max_it_changed=PETSC_TRUE;
1023a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1024a7e14dcfSSatish Balay }
1025a7e14dcfSSatish Balay 
1026a7e14dcfSSatish Balay #undef __FUNCT__
1027a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetMaximumIterations"
1028a7e14dcfSSatish Balay /*@
1029a7e14dcfSSatish Balay    TaoGetMaximumIterations - Sets a maximum number of iterates.
1030a7e14dcfSSatish Balay 
1031a7e14dcfSSatish Balay    Not Collective
1032a7e14dcfSSatish Balay 
1033a7e14dcfSSatish Balay    Input Parameters:
1034441846f8SBarry Smith .  tao - the Tao solver context
1035a7e14dcfSSatish Balay 
1036a7e14dcfSSatish Balay    Output Parameters:
1037a7e14dcfSSatish Balay .  maxits - the maximum number of iterates
1038a7e14dcfSSatish Balay 
1039a7e14dcfSSatish Balay    Level: intermediate
1040a7e14dcfSSatish Balay 
1041a7e14dcfSSatish Balay .seealso: TaoSetMaximumIterations(), TaoGetMaximumFunctionEvaluations()
1042a7e14dcfSSatish Balay @*/
1043441846f8SBarry Smith PetscErrorCode TaoGetMaximumIterations(Tao tao,PetscInt *maxits)
1044a7e14dcfSSatish Balay {
1045a7e14dcfSSatish Balay   PetscFunctionBegin;
1046441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1047a7e14dcfSSatish Balay   *maxits = tao->max_it;
1048a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1049a7e14dcfSSatish Balay }
1050a7e14dcfSSatish Balay 
1051a7e14dcfSSatish Balay #undef __FUNCT__
1052a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetInitialTrustRegionRadius"
1053a7e14dcfSSatish Balay /*@
1054a7e14dcfSSatish Balay    TaoSetInitialTrustRegionRadius - Sets the initial trust region radius.
1055a7e14dcfSSatish Balay 
1056441846f8SBarry Smith    Logically collective on Tao
1057a7e14dcfSSatish Balay 
1058a7e14dcfSSatish Balay    Input Parameter:
1059a7e14dcfSSatish Balay +  tao - a TAO optimization solver
1060a7e14dcfSSatish Balay -  radius - the trust region radius
1061a7e14dcfSSatish Balay 
1062a7e14dcfSSatish Balay    Level: intermediate
1063a7e14dcfSSatish Balay 
1064a7e14dcfSSatish Balay    Options Database Key:
1065a7e14dcfSSatish Balay .  -tao_trust0 <t0> - sets initial trust region radius
1066a7e14dcfSSatish Balay 
1067a7e14dcfSSatish Balay .seealso: TaoGetTrustRegionRadius(), TaoSetTrustRegionTolerance()
1068a7e14dcfSSatish Balay @*/
1069441846f8SBarry Smith PetscErrorCode TaoSetInitialTrustRegionRadius(Tao tao, PetscReal radius)
1070a7e14dcfSSatish Balay {
1071a7e14dcfSSatish Balay   PetscFunctionBegin;
1072441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1073a7e14dcfSSatish Balay   tao->trust0 = PetscMax(0.0,radius);
10746552cf8aSJason Sarich   tao->trust0_changed=PETSC_TRUE;
1075a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1076a7e14dcfSSatish Balay }
1077a7e14dcfSSatish Balay 
1078a7e14dcfSSatish Balay #undef __FUNCT__
1079a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetInitialTrustRegionRadius"
1080a7e14dcfSSatish Balay /*@
1081a7e14dcfSSatish Balay    TaoGetInitialTrustRegionRadius - Sets the initial trust region radius.
1082a7e14dcfSSatish Balay 
1083a7e14dcfSSatish Balay    Not Collective
1084a7e14dcfSSatish Balay 
1085a7e14dcfSSatish Balay    Input Parameter:
1086a7e14dcfSSatish Balay .  tao - a TAO optimization solver
1087a7e14dcfSSatish Balay 
1088a7e14dcfSSatish Balay    Output Parameter:
1089a7e14dcfSSatish Balay .  radius - the trust region radius
1090a7e14dcfSSatish Balay 
1091a7e14dcfSSatish Balay    Level: intermediate
1092a7e14dcfSSatish Balay 
1093a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetCurrentTrustRegionRadius()
1094a7e14dcfSSatish Balay @*/
1095441846f8SBarry Smith PetscErrorCode TaoGetInitialTrustRegionRadius(Tao tao, PetscReal *radius)
1096a7e14dcfSSatish Balay {
1097a7e14dcfSSatish Balay   PetscFunctionBegin;
1098441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1099a7e14dcfSSatish Balay   *radius = tao->trust0;
1100a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1101a7e14dcfSSatish Balay }
1102a7e14dcfSSatish Balay 
1103a7e14dcfSSatish Balay #undef __FUNCT__
1104a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetCurrentTrustRegionRadius"
1105a7e14dcfSSatish Balay /*@
1106a7e14dcfSSatish Balay    TaoGetCurrentTrustRegionRadius - Gets the current trust region radius.
1107a7e14dcfSSatish Balay 
1108a7e14dcfSSatish Balay    Not Collective
1109a7e14dcfSSatish Balay 
1110a7e14dcfSSatish Balay    Input Parameter:
1111a7e14dcfSSatish Balay .  tao - a TAO optimization solver
1112a7e14dcfSSatish Balay 
1113a7e14dcfSSatish Balay    Output Parameter:
1114a7e14dcfSSatish Balay .  radius - the trust region radius
1115a7e14dcfSSatish Balay 
1116a7e14dcfSSatish Balay    Level: intermediate
1117a7e14dcfSSatish Balay 
1118a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetInitialTrustRegionRadius()
1119a7e14dcfSSatish Balay @*/
1120441846f8SBarry Smith PetscErrorCode TaoGetCurrentTrustRegionRadius(Tao tao, PetscReal *radius)
1121a7e14dcfSSatish Balay {
1122a7e14dcfSSatish Balay   PetscFunctionBegin;
1123441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1124a7e14dcfSSatish Balay   *radius = tao->trust;
1125a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1126a7e14dcfSSatish Balay }
1127a7e14dcfSSatish Balay 
1128a7e14dcfSSatish Balay #undef __FUNCT__
1129a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetTolerances"
1130a7e14dcfSSatish Balay /*@
1131a7e14dcfSSatish Balay   TaoGetTolerances - gets the current values of tolerances
1132a7e14dcfSSatish Balay 
1133a7e14dcfSSatish Balay   Not Collective
1134a7e14dcfSSatish Balay 
1135a7e14dcfSSatish Balay   Input Parameters:
1136441846f8SBarry Smith . tao - the Tao context
1137a7e14dcfSSatish Balay 
1138a7e14dcfSSatish Balay   Output Parameters:
1139a7e14dcfSSatish Balay + fatol - absolute convergence tolerance
1140a7e14dcfSSatish Balay . frtol - relative convergence tolerance
1141a7e14dcfSSatish Balay . gatol - stop if norm of gradient is less than this
1142a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this
1143a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by a this factor
1144a7e14dcfSSatish Balay 
114547a47007SBarry Smith   Note: NULL can be used as an argument if not all tolerances values are needed
1146a7e14dcfSSatish Balay 
1147a7e14dcfSSatish Balay .seealso TaoSetTolerances()
1148a7e14dcfSSatish Balay 
1149a7e14dcfSSatish Balay   Level: intermediate
1150a7e14dcfSSatish Balay @*/
1151441846f8SBarry Smith PetscErrorCode TaoGetTolerances(Tao tao, PetscReal *fatol, PetscReal *frtol, PetscReal *gatol, PetscReal *grtol, PetscReal *gttol)
1152a7e14dcfSSatish Balay {
1153a7e14dcfSSatish Balay   PetscFunctionBegin;
1154441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1155a7e14dcfSSatish Balay   if (fatol) *fatol=tao->fatol;
1156a7e14dcfSSatish Balay   if (frtol) *frtol=tao->frtol;
1157a7e14dcfSSatish Balay   if (gatol) *gatol=tao->gatol;
1158a7e14dcfSSatish Balay   if (grtol) *grtol=tao->grtol;
1159a7e14dcfSSatish Balay   if (gttol) *gttol=tao->gttol;
1160a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1161a7e14dcfSSatish Balay }
1162a7e14dcfSSatish Balay 
1163a7e14dcfSSatish Balay #undef __FUNCT__
1164a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetKSP"
1165a7e14dcfSSatish Balay /*@
1166a7e14dcfSSatish Balay   TaoGetKSP - Gets the linear solver used by the optimization solver.
1167a7e14dcfSSatish Balay   Application writers should use TaoGetKSP if they need direct access
1168a7e14dcfSSatish Balay   to the PETSc KSP object.
1169a7e14dcfSSatish Balay 
1170a7e14dcfSSatish Balay   Not Collective
1171a7e14dcfSSatish Balay 
1172a7e14dcfSSatish Balay    Input Parameters:
1173a7e14dcfSSatish Balay .  tao - the TAO solver
1174a7e14dcfSSatish Balay 
1175a7e14dcfSSatish Balay    Output Parameters:
1176a7e14dcfSSatish Balay .  ksp - the KSP linear solver used in the optimization solver
1177a7e14dcfSSatish Balay 
1178a7e14dcfSSatish Balay    Level: intermediate
1179a7e14dcfSSatish Balay 
1180a7e14dcfSSatish Balay @*/
1181441846f8SBarry Smith PetscErrorCode TaoGetKSP(Tao tao, KSP *ksp)
118247a47007SBarry Smith {
1183a7e14dcfSSatish Balay   PetscFunctionBegin;
1184a7e14dcfSSatish Balay   *ksp = tao->ksp;
1185a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1186a7e14dcfSSatish Balay }
1187a7e14dcfSSatish Balay 
1188a7e14dcfSSatish Balay #undef __FUNCT__
1189025e9500SJason Sarich #define __FUNCT__ "TaoGetLinearSolveIterations"
1190025e9500SJason Sarich /*@
1191025e9500SJason Sarich    TaoGetLinearSolveIterations - Gets the total number of linear iterations
1192025e9500SJason Sarich    used by the TAO solver
1193025e9500SJason Sarich 
1194025e9500SJason Sarich    Not Collective
1195025e9500SJason Sarich 
1196025e9500SJason Sarich    Input Parameter:
1197025e9500SJason Sarich .  tao - TAO context
1198025e9500SJason Sarich 
1199025e9500SJason Sarich    Output Parameter:
1200025e9500SJason Sarich .  lits - number of linear iterations
1201025e9500SJason Sarich 
1202025e9500SJason Sarich    Notes:
1203025e9500SJason Sarich    This counter is reset to zero for each successive call to TaoSolve()
1204025e9500SJason Sarich 
1205025e9500SJason Sarich    Level: intermediate
1206025e9500SJason Sarich 
1207025e9500SJason Sarich .keywords: TAO
1208025e9500SJason Sarich 
1209025e9500SJason Sarich .seealso:  TaoGetKSP()
1210025e9500SJason Sarich @*/
1211025e9500SJason Sarich PetscErrorCode  TaoGetLinearSolveIterations(Tao tao,PetscInt *lits)
1212025e9500SJason Sarich {
1213025e9500SJason Sarich   PetscFunctionBegin;
1214025e9500SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1215025e9500SJason Sarich   PetscValidIntPointer(lits,2);
12162d9aa51bSJason Sarich   *lits = tao->ksp_tot_its;
1217025e9500SJason Sarich   PetscFunctionReturn(0);
1218025e9500SJason Sarich }
1219025e9500SJason Sarich 
1220025e9500SJason Sarich #undef __FUNCT__
1221a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetLineSearch"
1222a7e14dcfSSatish Balay /*@
1223a7e14dcfSSatish Balay   TaoGetLineSearch - Gets the line search used by the optimization solver.
1224a7e14dcfSSatish Balay   Application writers should use TaoGetLineSearch if they need direct access
1225a7e14dcfSSatish Balay   to the TaoLineSearch object.
1226a7e14dcfSSatish Balay 
1227a7e14dcfSSatish Balay   Not Collective
1228a7e14dcfSSatish Balay 
1229a7e14dcfSSatish Balay    Input Parameters:
1230a7e14dcfSSatish Balay .  tao - the TAO solver
1231a7e14dcfSSatish Balay 
1232a7e14dcfSSatish Balay    Output Parameters:
1233a7e14dcfSSatish Balay .  ls - the line search used in the optimization solver
1234a7e14dcfSSatish Balay 
1235a7e14dcfSSatish Balay    Level: intermediate
1236a7e14dcfSSatish Balay 
1237a7e14dcfSSatish Balay @*/
1238441846f8SBarry Smith PetscErrorCode TaoGetLineSearch(Tao tao, TaoLineSearch *ls)
123947a47007SBarry Smith {
1240a7e14dcfSSatish Balay   PetscFunctionBegin;
1241a7e14dcfSSatish Balay   *ls = tao->linesearch;
1242a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1243a7e14dcfSSatish Balay }
1244a7e14dcfSSatish Balay 
1245a7e14dcfSSatish Balay #undef __FUNCT__
1246a7e14dcfSSatish Balay #define __FUNCT__ "TaoAddLineSearchCounts"
1247a7e14dcfSSatish Balay /*@
1248a7e14dcfSSatish Balay   TaoAddLineSearchCounts - Adds the number of function evaluations spent
1249a7e14dcfSSatish Balay   in the line search to the running total.
1250a7e14dcfSSatish Balay 
1251a7e14dcfSSatish Balay    Input Parameters:
1252a7e14dcfSSatish Balay +  tao - the TAO solver
1253a7e14dcfSSatish Balay -  ls - the line search used in the optimization solver
1254a7e14dcfSSatish Balay 
1255a7e14dcfSSatish Balay    Level: developer
1256a7e14dcfSSatish Balay 
1257a7e14dcfSSatish Balay .seealso: TaoLineSearchApply()
1258a7e14dcfSSatish Balay @*/
1259441846f8SBarry Smith PetscErrorCode TaoAddLineSearchCounts(Tao tao)
126047a47007SBarry Smith {
1261a7e14dcfSSatish Balay   PetscErrorCode ierr;
1262a7e14dcfSSatish Balay   PetscBool      flg;
1263a7e14dcfSSatish Balay   PetscInt       nfeval,ngeval,nfgeval;
126447a47007SBarry Smith 
1265a7e14dcfSSatish Balay   PetscFunctionBegin;
1266441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1267a7e14dcfSSatish Balay   if (tao->linesearch) {
1268302440fdSBarry Smith     ierr = TaoLineSearchIsUsingTaoRoutines(tao->linesearch,&flg);CHKERRQ(ierr);
126994ae4db5SBarry Smith     if (!flg) {
127047a47007SBarry Smith       ierr = TaoLineSearchGetNumberFunctionEvaluations(tao->linesearch,&nfeval,&ngeval,&nfgeval);CHKERRQ(ierr);
1271a7e14dcfSSatish Balay       tao->nfuncs+=nfeval;
1272a7e14dcfSSatish Balay       tao->ngrads+=ngeval;
1273a7e14dcfSSatish Balay       tao->nfuncgrads+=nfgeval;
1274a7e14dcfSSatish Balay     }
1275a7e14dcfSSatish Balay   }
1276a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1277a7e14dcfSSatish Balay }
1278a7e14dcfSSatish Balay 
1279a7e14dcfSSatish Balay #undef __FUNCT__
1280a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetSolutionVector"
1281a7e14dcfSSatish Balay /*@
1282a7e14dcfSSatish Balay   TaoGetSolutionVector - Returns the vector with the current TAO solution
1283a7e14dcfSSatish Balay 
1284a7e14dcfSSatish Balay   Not Collective
1285a7e14dcfSSatish Balay 
1286a7e14dcfSSatish Balay   Input Parameter:
1287441846f8SBarry Smith . tao - the Tao context
1288a7e14dcfSSatish Balay 
1289a7e14dcfSSatish Balay   Output Parameter:
1290a7e14dcfSSatish Balay . X - the current solution
1291a7e14dcfSSatish Balay 
1292a7e14dcfSSatish Balay   Level: intermediate
1293a7e14dcfSSatish Balay 
1294a7e14dcfSSatish Balay   Note:  The returned vector will be the same object that was passed into TaoSetInitialVector()
1295a7e14dcfSSatish Balay @*/
1296441846f8SBarry Smith PetscErrorCode TaoGetSolutionVector(Tao tao, Vec *X)
1297a7e14dcfSSatish Balay {
1298a7e14dcfSSatish Balay   PetscFunctionBegin;
1299441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1300a7e14dcfSSatish Balay   *X = tao->solution;
1301a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1302a7e14dcfSSatish Balay }
1303a7e14dcfSSatish Balay 
1304a7e14dcfSSatish Balay #undef __FUNCT__
1305a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetGradientVector"
1306a7e14dcfSSatish Balay /*@
1307a7e14dcfSSatish Balay   TaoGetGradientVector - Returns the vector with the current TAO gradient
1308a7e14dcfSSatish Balay 
1309a7e14dcfSSatish Balay   Not Collective
1310a7e14dcfSSatish Balay 
1311a7e14dcfSSatish Balay   Input Parameter:
1312441846f8SBarry Smith . tao - the Tao context
1313a7e14dcfSSatish Balay 
1314a7e14dcfSSatish Balay   Output Parameter:
1315a7e14dcfSSatish Balay . G - the current solution
1316a7e14dcfSSatish Balay 
1317a7e14dcfSSatish Balay   Level: intermediate
1318a7e14dcfSSatish Balay @*/
1319441846f8SBarry Smith PetscErrorCode TaoGetGradientVector(Tao tao, Vec *G)
1320a7e14dcfSSatish Balay {
1321a7e14dcfSSatish Balay   PetscFunctionBegin;
1322441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1323a7e14dcfSSatish Balay   *G = tao->gradient;
1324a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1325a7e14dcfSSatish Balay }
1326a7e14dcfSSatish Balay 
1327a7e14dcfSSatish Balay #undef __FUNCT__
1328a7e14dcfSSatish Balay #define __FUNCT__ "TaoResetStatistics"
1329a7e14dcfSSatish Balay /*@
1330a7e14dcfSSatish Balay    TaoResetStatistics - Initialize the statistics used by TAO for all of the solvers.
1331a7e14dcfSSatish Balay    These statistics include the iteration number, residual norms, and convergence status.
1332a7e14dcfSSatish Balay    This routine gets called before solving each optimization problem.
1333a7e14dcfSSatish Balay 
1334441846f8SBarry Smith    Collective on Tao
1335a7e14dcfSSatish Balay 
1336a7e14dcfSSatish Balay    Input Parameters:
1337441846f8SBarry Smith .  solver - the Tao context
1338a7e14dcfSSatish Balay 
1339a7e14dcfSSatish Balay    Level: developer
1340a7e14dcfSSatish Balay 
1341a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
1342a7e14dcfSSatish Balay @*/
1343441846f8SBarry Smith PetscErrorCode TaoResetStatistics(Tao tao)
1344a7e14dcfSSatish Balay {
1345a7e14dcfSSatish Balay   PetscFunctionBegin;
1346441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1347a7e14dcfSSatish Balay   tao->niter        = 0;
1348a7e14dcfSSatish Balay   tao->nfuncs       = 0;
1349a7e14dcfSSatish Balay   tao->nfuncgrads   = 0;
1350a7e14dcfSSatish Balay   tao->ngrads       = 0;
1351a7e14dcfSSatish Balay   tao->nhess        = 0;
1352a7e14dcfSSatish Balay   tao->njac         = 0;
1353a7e14dcfSSatish Balay   tao->nconstraints = 0;
1354a7e14dcfSSatish Balay   tao->ksp_its      = 0;
1355ae93cb3cSJason Sarich   tao->ksp_tot_its      = 0;
1356a7e14dcfSSatish Balay   tao->reason       = TAO_CONTINUE_ITERATING;
1357a7e14dcfSSatish Balay   tao->residual     = 0.0;
1358a7e14dcfSSatish Balay   tao->cnorm        = 0.0;
1359a7e14dcfSSatish Balay   tao->step         = 0.0;
1360a7e14dcfSSatish Balay   tao->lsflag       = PETSC_FALSE;
1361a7e14dcfSSatish Balay   if (tao->hist_reset) tao->hist_len=0;
1362a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1363a7e14dcfSSatish Balay }
1364a7e14dcfSSatish Balay 
1365a7e14dcfSSatish Balay #undef __FUNCT__
1366a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetConvergenceTest"
1367a7e14dcfSSatish Balay /*@C
1368a7e14dcfSSatish Balay   TaoSetConvergenceTest - Sets the function that is to be used to test
1369a7e14dcfSSatish Balay   for convergence o fthe iterative minimization solution.  The new convergence
1370a7e14dcfSSatish Balay   testing routine will replace TAO's default convergence test.
1371a7e14dcfSSatish Balay 
1372441846f8SBarry Smith   Logically Collective on Tao
1373a7e14dcfSSatish Balay 
1374a7e14dcfSSatish Balay   Input Parameters:
1375441846f8SBarry Smith + tao - the Tao object
1376a7e14dcfSSatish Balay . conv - the routine to test for convergence
1377a7e14dcfSSatish Balay - ctx - [optional] context for private data for the convergence routine
137847a47007SBarry Smith         (may be NULL)
1379a7e14dcfSSatish Balay 
1380a7e14dcfSSatish Balay   Calling sequence of conv:
1381441846f8SBarry Smith $   PetscErrorCode conv(Tao tao, void *ctx)
1382a7e14dcfSSatish Balay 
1383441846f8SBarry Smith + tao - the Tao object
1384a7e14dcfSSatish Balay - ctx - [optional] convergence context
1385a7e14dcfSSatish Balay 
1386e4cb33bbSBarry Smith   Note: The new convergence testing routine should call TaoSetConvergedReason().
1387a7e14dcfSSatish Balay 
1388a7e14dcfSSatish Balay   Level: advanced
1389a7e14dcfSSatish Balay 
1390e4cb33bbSBarry Smith .seealso: TaoSetConvergedReason(), TaoGetSolutionStatus(), TaoGetTolerances(), TaoSetMonitor
1391a7e14dcfSSatish Balay 
1392a7e14dcfSSatish Balay @*/
1393441846f8SBarry Smith PetscErrorCode TaoSetConvergenceTest(Tao tao, PetscErrorCode (*conv)(Tao,void*), void *ctx)
1394a7e14dcfSSatish Balay {
1395a7e14dcfSSatish Balay   PetscFunctionBegin;
1396441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1397a7e14dcfSSatish Balay   (tao)->ops->convergencetest = conv;
1398a7e14dcfSSatish Balay   (tao)->cnvP = ctx;
1399a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1400a7e14dcfSSatish Balay }
1401a7e14dcfSSatish Balay 
1402a7e14dcfSSatish Balay #undef __FUNCT__
1403a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMonitor"
1404a7e14dcfSSatish Balay /*@C
1405a7e14dcfSSatish Balay    TaoSetMonitor - Sets an ADDITIONAL function that is to be used at every
1406a7e14dcfSSatish Balay    iteration of the solver to display the iteration's
1407a7e14dcfSSatish Balay    progress.
1408a7e14dcfSSatish Balay 
1409441846f8SBarry Smith    Logically Collective on Tao
1410a7e14dcfSSatish Balay 
1411a7e14dcfSSatish Balay    Input Parameters:
1412441846f8SBarry Smith +  tao - the Tao solver context
1413a7e14dcfSSatish Balay .  mymonitor - monitoring routine
1414a7e14dcfSSatish Balay -  mctx - [optional] user-defined context for private data for the
141547a47007SBarry Smith           monitor routine (may be NULL)
1416a7e14dcfSSatish Balay 
1417a7e14dcfSSatish Balay    Calling sequence of mymonitor:
1418441846f8SBarry Smith $     int mymonitor(Tao tao,void *mctx)
1419a7e14dcfSSatish Balay 
1420441846f8SBarry Smith +    tao - the Tao solver context
1421a7e14dcfSSatish Balay -    mctx - [optional] monitoring context
1422a7e14dcfSSatish Balay 
1423a7e14dcfSSatish Balay 
1424a7e14dcfSSatish Balay    Options Database Keys:
1425a7e14dcfSSatish Balay +    -tao_monitor        - sets TaoDefaultMonitor()
1426a7e14dcfSSatish Balay .    -tao_smonitor       - sets short monitor
1427a7e14dcfSSatish Balay .    -tao_cmonitor       - same as smonitor plus constraint norm
1428a7e14dcfSSatish Balay .    -tao_view_solution   - view solution at each iteration
1429a7e14dcfSSatish Balay .    -tao_view_gradient   - view gradient at each iteration
1430a7e14dcfSSatish Balay .    -tao_view_separableobjective - view separable objective function at each iteration
1431a7e14dcfSSatish 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.
1432a7e14dcfSSatish Balay 
1433a7e14dcfSSatish Balay 
1434a7e14dcfSSatish Balay    Notes:
1435a7e14dcfSSatish Balay    Several different monitoring routines may be set by calling
1436a7e14dcfSSatish Balay    TaoSetMonitor() multiple times; all will be called in the
1437a7e14dcfSSatish Balay    order in which they were set.
1438a7e14dcfSSatish Balay 
1439a7e14dcfSSatish Balay    Fortran Notes: Only one monitor function may be set
1440a7e14dcfSSatish Balay 
1441a7e14dcfSSatish Balay    Level: intermediate
1442a7e14dcfSSatish Balay 
1443a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoCancelMonitors(),  TaoSetDestroyRoutine()
1444a7e14dcfSSatish Balay @*/
1445441846f8SBarry Smith PetscErrorCode TaoSetMonitor(Tao tao, PetscErrorCode (*func)(Tao, void*), void *ctx,PetscErrorCode (*dest)(void**))
1446a7e14dcfSSatish Balay {
144708d19d1fSJason Sarich   PetscErrorCode ierr;
144808d19d1fSJason Sarich   PetscInt       i;
144908d19d1fSJason Sarich 
1450a7e14dcfSSatish Balay   PetscFunctionBegin;
1451441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
145247a47007SBarry Smith   if (tao->numbermonitors >= MAXTAOMONITORS) SETERRQ1(PETSC_COMM_SELF,1,"Cannot attach another monitor -- max=",MAXTAOMONITORS);
145308d19d1fSJason Sarich 
145408d19d1fSJason Sarich   for (i=0; i<tao->numbermonitors;i++) {
145508d19d1fSJason Sarich     if (func == tao->monitor[i] && dest == tao->monitordestroy[i] && ctx == tao->monitorcontext[i]) {
145608d19d1fSJason Sarich       if (dest) {
145708d19d1fSJason Sarich         ierr = (*dest)(&ctx);CHKERRQ(ierr);
145808d19d1fSJason Sarich       }
145908d19d1fSJason Sarich       PetscFunctionReturn(0);
146008d19d1fSJason Sarich     }
146108d19d1fSJason Sarich   }
1462a7e14dcfSSatish Balay   tao->monitor[tao->numbermonitors] = func;
1463a7e14dcfSSatish Balay   tao->monitorcontext[tao->numbermonitors] = ctx;
1464a7e14dcfSSatish Balay   tao->monitordestroy[tao->numbermonitors] = dest;
1465a7e14dcfSSatish Balay   ++tao->numbermonitors;
1466a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1467a7e14dcfSSatish Balay }
1468a7e14dcfSSatish Balay 
1469a7e14dcfSSatish Balay #undef __FUNCT__
1470a7e14dcfSSatish Balay #define __FUNCT__ "TaoCancelMonitors"
1471a7e14dcfSSatish Balay /*@
1472441846f8SBarry Smith    TaoCancelMonitors - Clears all the monitor functions for a Tao object.
1473a7e14dcfSSatish Balay 
1474441846f8SBarry Smith    Logically Collective on Tao
1475a7e14dcfSSatish Balay 
1476a7e14dcfSSatish Balay    Input Parameters:
1477441846f8SBarry Smith .  tao - the Tao solver context
1478a7e14dcfSSatish Balay 
1479a7e14dcfSSatish Balay    Options Database:
1480a7e14dcfSSatish Balay .  -tao_cancelmonitors - cancels all monitors that have been hardwired
1481a7e14dcfSSatish Balay     into a code by calls to TaoSetMonitor(), but does not cancel those
1482a7e14dcfSSatish Balay     set via the options database
1483a7e14dcfSSatish Balay 
1484a7e14dcfSSatish Balay    Notes:
1485441846f8SBarry Smith    There is no way to clear one specific monitor from a Tao object.
1486a7e14dcfSSatish Balay 
1487a7e14dcfSSatish Balay    Level: advanced
1488a7e14dcfSSatish Balay 
1489a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1490a7e14dcfSSatish Balay @*/
1491441846f8SBarry Smith PetscErrorCode TaoCancelMonitors(Tao tao)
1492a7e14dcfSSatish Balay {
1493a7e14dcfSSatish Balay   PetscInt       i;
1494a7e14dcfSSatish Balay   PetscErrorCode ierr;
149547a47007SBarry Smith 
1496a7e14dcfSSatish Balay   PetscFunctionBegin;
1497441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1498a7e14dcfSSatish Balay   for (i=0;i<tao->numbermonitors;i++) {
1499a7e14dcfSSatish Balay     if (tao->monitordestroy[i]) {
1500a7e14dcfSSatish Balay       ierr = (*tao->monitordestroy[i])(&tao->monitorcontext[i]);CHKERRQ(ierr);
1501a7e14dcfSSatish Balay     }
1502a7e14dcfSSatish Balay   }
1503a7e14dcfSSatish Balay   tao->numbermonitors=0;
1504a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1505a7e14dcfSSatish Balay }
1506a7e14dcfSSatish Balay 
1507a7e14dcfSSatish Balay #undef __FUNCT__
1508a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultMonitor"
15097fab98ebSJason Sarich /*@
1510a7e14dcfSSatish Balay    TaoDefaultMonitor - Default routine for monitoring progress of the
1511441846f8SBarry Smith    Tao solvers (default).  This monitor prints the function value and gradient
1512a7e14dcfSSatish Balay    norm at each iteration.  It can be turned on from the command line using the
1513a7e14dcfSSatish Balay    -tao_monitor option
1514a7e14dcfSSatish Balay 
1515441846f8SBarry Smith    Collective on Tao
1516a7e14dcfSSatish Balay 
1517a7e14dcfSSatish Balay    Input Parameters:
1518441846f8SBarry Smith +  tao - the Tao context
151947a47007SBarry Smith -  ctx - PetscViewer context or NULL
1520a7e14dcfSSatish Balay 
1521a7e14dcfSSatish Balay    Options Database Keys:
1522a7e14dcfSSatish Balay .  -tao_monitor
1523a7e14dcfSSatish Balay 
1524a7e14dcfSSatish Balay    Level: advanced
1525a7e14dcfSSatish Balay 
1526a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1527a7e14dcfSSatish Balay @*/
1528441846f8SBarry Smith PetscErrorCode TaoDefaultMonitor(Tao tao, void *ctx)
1529a7e14dcfSSatish Balay {
1530a7e14dcfSSatish Balay   PetscErrorCode ierr;
1531a7e14dcfSSatish Balay   PetscInt       its;
1532a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1533a7e14dcfSSatish Balay   PetscViewer    viewer;
153447a47007SBarry Smith 
1535a7e14dcfSSatish Balay   PetscFunctionBegin;
1536a7e14dcfSSatish Balay   if (ctx) {
1537a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1538a7e14dcfSSatish Balay   } else {
1539a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1540a7e14dcfSSatish Balay   }
1541a7e14dcfSSatish Balay   its=tao->niter;
1542a7e14dcfSSatish Balay   fct=tao->fc;
1543a7e14dcfSSatish Balay   gnorm=tao->residual;
1544a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr);
154547a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr);
154608d19d1fSJason Sarich   if (gnorm >= PETSC_INFINITY) {
154708d19d1fSJason Sarich     ierr=PetscViewerASCIIPrintf(viewer,"  Residual: Inf \n");CHKERRQ(ierr);
154808d19d1fSJason Sarich   } else {
154947a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer,"  Residual: %g \n",(double)gnorm);CHKERRQ(ierr);
155008d19d1fSJason Sarich   }
1551a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1552a7e14dcfSSatish Balay }
1553a7e14dcfSSatish Balay 
1554a7e14dcfSSatish Balay #undef __FUNCT__
1555a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultSMonitor"
15567fab98ebSJason Sarich /*@
1557a7e14dcfSSatish Balay    TaoDefaultSMonitor - Default routine for monitoring progress of the
1558a7e14dcfSSatish Balay    solver. Same as TaoDefaultMonitor() except
1559a7e14dcfSSatish Balay    it prints fewer digits of the residual as the residual gets smaller.
1560a7e14dcfSSatish Balay    This is because the later digits are meaningless and are often
1561a7e14dcfSSatish Balay    different on different machines; by using this routine different
1562a7e14dcfSSatish Balay    machines will usually generate the same output. It can be turned on
1563a7e14dcfSSatish Balay    by using the -tao_smonitor option
1564a7e14dcfSSatish Balay 
1565441846f8SBarry Smith    Collective on Tao
1566a7e14dcfSSatish Balay 
1567a7e14dcfSSatish Balay    Input Parameters:
1568441846f8SBarry Smith +  tao - the Tao context
156947a47007SBarry Smith -  ctx - PetscViewer context or NULL
1570a7e14dcfSSatish Balay 
1571a7e14dcfSSatish Balay    Options Database Keys:
1572a7e14dcfSSatish Balay .  -tao_smonitor
1573a7e14dcfSSatish Balay 
1574a7e14dcfSSatish Balay    Level: advanced
1575a7e14dcfSSatish Balay 
1576a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1577a7e14dcfSSatish Balay @*/
1578441846f8SBarry Smith PetscErrorCode TaoDefaultSMonitor(Tao tao, void *ctx)
1579a7e14dcfSSatish Balay {
1580a7e14dcfSSatish Balay   PetscErrorCode ierr;
1581a7e14dcfSSatish Balay   PetscInt       its;
1582a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1583a7e14dcfSSatish Balay   PetscViewer    viewer;
158447a47007SBarry Smith 
1585a7e14dcfSSatish Balay   PetscFunctionBegin;
1586a7e14dcfSSatish Balay   if (ctx) {
1587a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1588a7e14dcfSSatish Balay   } else {
1589a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1590a7e14dcfSSatish Balay   }
1591a7e14dcfSSatish Balay   its=tao->niter;
1592a7e14dcfSSatish Balay   fct=tao->fc;
1593a7e14dcfSSatish Balay   gnorm=tao->residual;
1594a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr);
159547a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value %g,",(double)fct);CHKERRQ(ierr);
159608d19d1fSJason Sarich   if (gnorm >= PETSC_INFINITY/2) {
159708d19d1fSJason Sarich     ierr=PetscViewerASCIIPrintf(viewer," Residual: Inf \n");CHKERRQ(ierr);
159808d19d1fSJason Sarich   } else if (gnorm > 1.e-6) {
159947a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr);
1600a7e14dcfSSatish Balay   } else if (gnorm > 1.e-11) {
1601a7e14dcfSSatish Balay     ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-6 \n");CHKERRQ(ierr);
1602a7e14dcfSSatish Balay   } else {
1603a7e14dcfSSatish Balay     ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-11 \n");CHKERRQ(ierr);
1604a7e14dcfSSatish Balay   }
1605a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1606a7e14dcfSSatish Balay }
1607a7e14dcfSSatish Balay 
1608a7e14dcfSSatish Balay #undef __FUNCT__
1609a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultCMonitor"
16107fab98ebSJason Sarich /*@
1611a7e14dcfSSatish Balay    TaoDefaultCMonitor - same as TaoDefaultMonitor() except
1612a7e14dcfSSatish Balay    it prints the norm of the constraints function. It can be turned on
1613a7e14dcfSSatish Balay    from the command line using the -tao_cmonitor 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_cmonitor
1623a7e14dcfSSatish Balay 
1624a7e14dcfSSatish Balay    Level: advanced
1625a7e14dcfSSatish Balay 
1626a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1627a7e14dcfSSatish Balay @*/
1628441846f8SBarry Smith PetscErrorCode TaoDefaultCMonitor(Tao tao, void *ctx)
1629a7e14dcfSSatish Balay {
1630a7e14dcfSSatish Balay   PetscErrorCode ierr;
1631a7e14dcfSSatish Balay   PetscInt       its;
1632a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1633a7e14dcfSSatish Balay   PetscViewer    viewer;
1634a7e14dcfSSatish Balay 
1635a7e14dcfSSatish Balay   PetscFunctionBegin;
1636a7e14dcfSSatish Balay   if (ctx) {
1637a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1638a7e14dcfSSatish Balay   } else {
1639a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1640a7e14dcfSSatish Balay   }
1641a7e14dcfSSatish Balay   its=tao->niter;
1642a7e14dcfSSatish Balay   fct=tao->fc;
1643a7e14dcfSSatish Balay   gnorm=tao->residual;
1644a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %D,",its);CHKERRQ(ierr);
164547a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr);
164647a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer,"  Residual: %g ",(double)gnorm);CHKERRQ(ierr);
164747a47007SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"  Constraint: %g \n",(double)tao->cnorm);CHKERRQ(ierr);
1648a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1649a7e14dcfSSatish Balay }
1650a7e14dcfSSatish Balay 
1651a7e14dcfSSatish Balay #undef __FUNCT__
1652a7e14dcfSSatish Balay #define __FUNCT__ "TaoSolutionMonitor"
1653a7e14dcfSSatish Balay /*@C
1654a7e14dcfSSatish Balay    TaoSolutionMonitor - Views the solution at each iteration
1655a7e14dcfSSatish Balay    It can be turned on from the command line using the
1656a7e14dcfSSatish Balay    -tao_view_solution option
1657a7e14dcfSSatish Balay 
1658441846f8SBarry Smith    Collective on Tao
1659a7e14dcfSSatish Balay 
1660a7e14dcfSSatish Balay    Input Parameters:
1661441846f8SBarry Smith +  tao - the Tao context
166247a47007SBarry Smith -  ctx - PetscViewer context or NULL
1663a7e14dcfSSatish Balay 
1664a7e14dcfSSatish Balay    Options Database Keys:
1665a7e14dcfSSatish Balay .  -tao_view_solution
1666a7e14dcfSSatish Balay 
1667a7e14dcfSSatish Balay    Level: advanced
1668a7e14dcfSSatish Balay 
1669a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1670a7e14dcfSSatish Balay @*/
1671441846f8SBarry Smith PetscErrorCode TaoSolutionMonitor(Tao tao, void *ctx)
1672a7e14dcfSSatish Balay {
1673a7e14dcfSSatish Balay   PetscErrorCode ierr;
1674a7e14dcfSSatish Balay   PetscViewer viewer;
167547a47007SBarry Smith 
1676a7e14dcfSSatish Balay   PetscFunctionBegin;
1677a7e14dcfSSatish Balay   if (ctx) {
1678a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1679a7e14dcfSSatish Balay   } else {
1680a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1681a7e14dcfSSatish Balay   }
1682a7e14dcfSSatish Balay   ierr = VecView(tao->solution, viewer);CHKERRQ(ierr);
1683a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1684a7e14dcfSSatish Balay }
1685a7e14dcfSSatish Balay 
1686a7e14dcfSSatish Balay #undef __FUNCT__
1687a7e14dcfSSatish Balay #define __FUNCT__ "TaoGradientMonitor"
1688a7e14dcfSSatish Balay /*@C
1689a7e14dcfSSatish Balay    TaoGradientMonitor - Views the gradient at each iteration
1690a7e14dcfSSatish Balay    It can be turned on from the command line using the
1691a7e14dcfSSatish Balay    -tao_view_gradient option
1692a7e14dcfSSatish Balay 
1693441846f8SBarry Smith    Collective on Tao
1694a7e14dcfSSatish Balay 
1695a7e14dcfSSatish Balay    Input Parameters:
1696441846f8SBarry Smith +  tao - the Tao context
169747a47007SBarry Smith -  ctx - PetscViewer context or NULL
1698a7e14dcfSSatish Balay 
1699a7e14dcfSSatish Balay    Options Database Keys:
1700a7e14dcfSSatish Balay .  -tao_view_gradient
1701a7e14dcfSSatish Balay 
1702a7e14dcfSSatish Balay    Level: advanced
1703a7e14dcfSSatish Balay 
1704a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1705a7e14dcfSSatish Balay @*/
1706441846f8SBarry Smith PetscErrorCode TaoGradientMonitor(Tao tao, void *ctx)
1707a7e14dcfSSatish Balay {
1708a7e14dcfSSatish Balay   PetscErrorCode ierr;
1709a7e14dcfSSatish Balay   PetscViewer viewer;
171047a47007SBarry Smith 
1711a7e14dcfSSatish Balay   PetscFunctionBegin;
1712a7e14dcfSSatish Balay   if (ctx) {
1713a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1714a7e14dcfSSatish Balay   } else {
1715a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1716a7e14dcfSSatish Balay   }
1717a7e14dcfSSatish Balay   ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr);
1718a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1719a7e14dcfSSatish Balay }
1720a7e14dcfSSatish Balay 
1721a7e14dcfSSatish Balay #undef __FUNCT__
1722a7e14dcfSSatish Balay #define __FUNCT__ "TaoStepDirectionMonitor"
1723a7e14dcfSSatish Balay /*@C
1724a7e14dcfSSatish Balay    TaoStepDirectionMonitor - Views the gradient at each iteration
1725a7e14dcfSSatish Balay    It can be turned on from the command line using the
1726a7e14dcfSSatish Balay    -tao_view_gradient option
1727a7e14dcfSSatish Balay 
1728441846f8SBarry Smith    Collective on Tao
1729a7e14dcfSSatish Balay 
1730a7e14dcfSSatish Balay    Input Parameters:
1731441846f8SBarry Smith +  tao - the Tao context
173247a47007SBarry Smith -  ctx - PetscViewer context or NULL
1733a7e14dcfSSatish Balay 
1734a7e14dcfSSatish Balay    Options Database Keys:
1735a7e14dcfSSatish Balay .  -tao_view_gradient
1736a7e14dcfSSatish Balay 
1737a7e14dcfSSatish Balay    Level: advanced
1738a7e14dcfSSatish Balay 
1739a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1740a7e14dcfSSatish Balay @*/
1741441846f8SBarry Smith PetscErrorCode TaoStepDirectionMonitor(Tao tao, void *ctx)
1742a7e14dcfSSatish Balay {
1743a7e14dcfSSatish Balay   PetscErrorCode ierr;
1744a7e14dcfSSatish Balay   PetscViewer viewer;
1745a7e14dcfSSatish Balay   PetscFunctionBegin;
1746a7e14dcfSSatish Balay   if (ctx) {
1747a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1748a7e14dcfSSatish Balay   } else {
1749a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1750a7e14dcfSSatish Balay   }
1751a7e14dcfSSatish Balay   ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr);
1752a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1753a7e14dcfSSatish Balay }
1754a7e14dcfSSatish Balay 
1755a7e14dcfSSatish Balay #undef __FUNCT__
1756a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawSolutionMonitor"
1757a7e14dcfSSatish Balay /*@C
1758a7e14dcfSSatish Balay    TaoDrawSolutionMonitor - Plots the solution at each iteration
1759a7e14dcfSSatish Balay    It can be turned on from the command line using the
1760a7e14dcfSSatish Balay    -tao_draw_solution option
1761a7e14dcfSSatish Balay 
1762441846f8SBarry Smith    Collective on Tao
1763a7e14dcfSSatish Balay 
1764a7e14dcfSSatish Balay    Input Parameters:
1765441846f8SBarry Smith +  tao - the Tao context
1766*f55353a2SBarry Smith -  ctx - PetscViewer context
1767a7e14dcfSSatish Balay 
1768a7e14dcfSSatish Balay    Options Database Keys:
1769a7e14dcfSSatish Balay .  -tao_draw_solution
1770a7e14dcfSSatish Balay 
1771a7e14dcfSSatish Balay    Level: advanced
1772a7e14dcfSSatish Balay 
1773a7e14dcfSSatish Balay .seealso: TaoSolutionMonitor(), TaoSetMonitor(), TaoDrawGradientMonitor
1774a7e14dcfSSatish Balay @*/
1775441846f8SBarry Smith PetscErrorCode TaoDrawSolutionMonitor(Tao tao, void *ctx)
1776a7e14dcfSSatish Balay {
1777a7e14dcfSSatish Balay   PetscErrorCode ierr;
1778a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer) ctx;
177947a47007SBarry Smith 
1780a7e14dcfSSatish Balay   PetscFunctionBegin;
1781a7e14dcfSSatish Balay   ierr = VecView(tao->solution, viewer);CHKERRQ(ierr);
1782a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1783a7e14dcfSSatish Balay }
1784a7e14dcfSSatish Balay 
1785a7e14dcfSSatish Balay #undef __FUNCT__
1786a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawGradientMonitor"
1787a7e14dcfSSatish Balay /*@C
1788a7e14dcfSSatish Balay    TaoDrawGradientMonitor - Plots the gradient at each iteration
1789a7e14dcfSSatish Balay    It can be turned on from the command line using the
1790a7e14dcfSSatish Balay    -tao_draw_gradient option
1791a7e14dcfSSatish Balay 
1792441846f8SBarry Smith    Collective on Tao
1793a7e14dcfSSatish Balay 
1794a7e14dcfSSatish Balay    Input Parameters:
1795441846f8SBarry Smith +  tao - the Tao context
1796*f55353a2SBarry Smith -  ctx - PetscViewer context
1797a7e14dcfSSatish Balay 
1798a7e14dcfSSatish Balay    Options Database Keys:
1799a7e14dcfSSatish Balay .  -tao_draw_gradient
1800a7e14dcfSSatish Balay 
1801a7e14dcfSSatish Balay    Level: advanced
1802a7e14dcfSSatish Balay 
1803a7e14dcfSSatish Balay .seealso: TaoGradientMonitor(), TaoSetMonitor(), TaoDrawSolutionMonitor
1804a7e14dcfSSatish Balay @*/
1805441846f8SBarry Smith PetscErrorCode TaoDrawGradientMonitor(Tao tao, void *ctx)
1806a7e14dcfSSatish Balay {
1807a7e14dcfSSatish Balay   PetscErrorCode ierr;
1808a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer)ctx;
180947a47007SBarry Smith 
1810a7e14dcfSSatish Balay   PetscFunctionBegin;
1811a7e14dcfSSatish Balay   ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr);
1812a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1813a7e14dcfSSatish Balay }
1814a7e14dcfSSatish Balay 
1815a7e14dcfSSatish Balay #undef __FUNCT__
1816a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawStepMonitor"
1817a7e14dcfSSatish Balay /*@C
1818a7e14dcfSSatish Balay    TaoDrawStepMonitor - Plots the step direction at each iteration
1819a7e14dcfSSatish Balay    It can be turned on from the command line using the
1820a7e14dcfSSatish Balay    -tao_draw_step option
1821a7e14dcfSSatish Balay 
1822441846f8SBarry Smith    Collective on Tao
1823a7e14dcfSSatish Balay 
1824a7e14dcfSSatish Balay    Input Parameters:
1825441846f8SBarry Smith +  tao - the Tao context
1826*f55353a2SBarry Smith -  ctx - PetscViewer context
1827a7e14dcfSSatish Balay 
1828a7e14dcfSSatish Balay    Options Database Keys:
1829a7e14dcfSSatish Balay .  -tao_draw_step
1830a7e14dcfSSatish Balay 
1831a7e14dcfSSatish Balay    Level: advanced
1832a7e14dcfSSatish Balay 
1833a7e14dcfSSatish Balay .seealso: TaoSetMonitor(), TaoDrawSolutionMonitor
1834a7e14dcfSSatish Balay @*/
1835441846f8SBarry Smith PetscErrorCode TaoDrawStepMonitor(Tao tao, void *ctx)
1836a7e14dcfSSatish Balay {
1837a7e14dcfSSatish Balay   PetscErrorCode ierr;
1838a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer)(ctx);
183947a47007SBarry Smith 
1840a7e14dcfSSatish Balay   PetscFunctionBegin;
1841a7e14dcfSSatish Balay   ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr);
1842a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1843a7e14dcfSSatish Balay }
1844a7e14dcfSSatish Balay 
1845a7e14dcfSSatish Balay #undef __FUNCT__
1846a7e14dcfSSatish Balay #define __FUNCT__ "TaoSeparableObjectiveMonitor"
1847a7e14dcfSSatish Balay /*@C
1848a7e14dcfSSatish Balay    TaoSeparableObjectiveMonitor - Views the separable objective function at each iteration
1849a7e14dcfSSatish Balay    It can be turned on from the command line using the
1850a7e14dcfSSatish Balay    -tao_view_separableobjective option
1851a7e14dcfSSatish Balay 
1852441846f8SBarry Smith    Collective on Tao
1853a7e14dcfSSatish Balay 
1854a7e14dcfSSatish Balay    Input Parameters:
1855441846f8SBarry Smith +  tao - the Tao context
185647a47007SBarry Smith -  ctx - PetscViewer context or NULL
1857a7e14dcfSSatish Balay 
1858a7e14dcfSSatish Balay    Options Database Keys:
1859a7e14dcfSSatish Balay .  -tao_view_separableobjective
1860a7e14dcfSSatish Balay 
1861a7e14dcfSSatish Balay    Level: advanced
1862a7e14dcfSSatish Balay 
1863a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1864a7e14dcfSSatish Balay @*/
1865441846f8SBarry Smith PetscErrorCode TaoSeparableObjectiveMonitor(Tao tao, void *ctx)
1866a7e14dcfSSatish Balay {
1867a7e14dcfSSatish Balay   PetscErrorCode ierr;
1868a7e14dcfSSatish Balay   PetscViewer    viewer;
186947a47007SBarry Smith 
1870a7e14dcfSSatish Balay   PetscFunctionBegin;
1871a7e14dcfSSatish Balay   if (ctx) {
1872a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1873a7e14dcfSSatish Balay   } else {
1874a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1875a7e14dcfSSatish Balay   }
1876a7e14dcfSSatish Balay   ierr = VecView(tao->sep_objective,viewer);CHKERRQ(ierr);
1877a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1878a7e14dcfSSatish Balay }
1879a7e14dcfSSatish Balay 
1880a7e14dcfSSatish Balay #undef __FUNCT__
1881a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultConvergenceTest"
18827fab98ebSJason Sarich /*@
1883a7e14dcfSSatish Balay    TaoDefaultConvergenceTest - Determines whether the solver should continue iterating
1884a7e14dcfSSatish Balay    or terminate.
1885a7e14dcfSSatish Balay 
1886441846f8SBarry Smith    Collective on Tao
1887a7e14dcfSSatish Balay 
1888a7e14dcfSSatish Balay    Input Parameters:
1889441846f8SBarry Smith +  tao - the Tao context
1890a7e14dcfSSatish Balay -  dummy - unused dummy context
1891a7e14dcfSSatish Balay 
1892a7e14dcfSSatish Balay    Output Parameter:
1893a7e14dcfSSatish Balay .  reason - for terminating
1894a7e14dcfSSatish Balay 
1895a7e14dcfSSatish Balay    Notes:
1896a7e14dcfSSatish Balay    This routine checks the residual in the optimality conditions, the
1897a7e14dcfSSatish Balay    relative residual in the optimity conditions, the number of function
1898a7e14dcfSSatish Balay    evaluations, and the function value to test convergence.  Some
1899a7e14dcfSSatish Balay    solvers may use different convergence routines.
1900a7e14dcfSSatish Balay 
1901a7e14dcfSSatish Balay    Level: developer
1902a7e14dcfSSatish Balay 
1903e4cb33bbSBarry Smith .seealso: TaoSetTolerances(),TaoGetConvergedReason(),TaoSetConvergedReason()
1904a7e14dcfSSatish Balay @*/
1905a7e14dcfSSatish Balay 
1906441846f8SBarry Smith PetscErrorCode TaoDefaultConvergenceTest(Tao tao,void *dummy)
1907a7e14dcfSSatish Balay {
1908a7e14dcfSSatish Balay   PetscInt           niter=tao->niter, nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads);
1909a7e14dcfSSatish Balay   PetscInt           max_funcs=tao->max_funcs;
1910a7e14dcfSSatish Balay   PetscReal          gnorm=tao->residual, gnorm0=tao->gnorm0;
1911a7e14dcfSSatish Balay   PetscReal          f=tao->fc, steptol=tao->steptol,trradius=tao->step;
1912a7e14dcfSSatish Balay   PetscReal          gatol=tao->gatol,grtol=tao->grtol,gttol=tao->gttol;
1913a7e14dcfSSatish Balay   PetscReal          fatol=tao->fatol,frtol=tao->frtol,catol=tao->catol,crtol=tao->crtol;
1914a7e14dcfSSatish Balay   PetscReal          fmin=tao->fmin, cnorm=tao->cnorm, cnorm0=tao->cnorm0;
1915a7e14dcfSSatish Balay   PetscReal          gnorm2;
1916e4cb33bbSBarry Smith   TaoConvergedReason reason=tao->reason;
1917a7e14dcfSSatish Balay   PetscErrorCode     ierr;
1918a7e14dcfSSatish Balay 
1919a7e14dcfSSatish Balay   PetscFunctionBegin;
1920441846f8SBarry Smith   PetscValidHeaderSpecific(tao, TAO_CLASSID,1);
1921a7e14dcfSSatish Balay   if (reason != TAO_CONTINUE_ITERATING) {
1922a7e14dcfSSatish Balay     PetscFunctionReturn(0);
1923a7e14dcfSSatish Balay   }
1924a7e14dcfSSatish Balay   gnorm2=gnorm*gnorm;
1925a7e14dcfSSatish Balay 
1926a7e14dcfSSatish Balay   if (PetscIsInfOrNanReal(f)) {
1927a7e14dcfSSatish Balay     ierr = PetscInfo(tao,"Failed to converged, function value is Inf or NaN\n");CHKERRQ(ierr);
1928a7e14dcfSSatish Balay     reason = TAO_DIVERGED_NAN;
1929a7e14dcfSSatish Balay   } else if (f <= fmin && cnorm <=catol) {
193047a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to function value %g < minimum function value %g\n", (double)f,(double)fmin);CHKERRQ(ierr);
1931a7e14dcfSSatish Balay     reason = TAO_CONVERGED_MINF;
1932a7e14dcfSSatish Balay   } else if (gnorm2 <= fatol && cnorm <=catol) {
193347a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to estimated f(X) - f(X*) = %g < %g\n",(double)gnorm2,(double)fatol);CHKERRQ(ierr);
1934a7e14dcfSSatish Balay     reason = TAO_CONVERGED_FATOL;
1935a7e14dcfSSatish Balay   } else if (f != 0 && gnorm2 / PetscAbsReal(f)<= frtol && cnorm/PetscMax(cnorm0,1.0) <= crtol) {
193647a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to estimated |f(X)-f(X*)|/f(X) = %g < %g\n",(double)(gnorm2/PetscAbsReal(f)),(double)frtol);CHKERRQ(ierr);
1937a7e14dcfSSatish Balay     reason = TAO_CONVERGED_FRTOL;
1938a7e14dcfSSatish Balay   } else if (gnorm<= gatol && cnorm <=catol) {
193947a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to residual norm ||g(X)||=%g < %g\n",(double)gnorm,(double)gatol);CHKERRQ(ierr);
1940a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GATOL;
1941a7e14dcfSSatish Balay   } else if ( f!=0 && PetscAbsReal(gnorm/f) <= grtol && cnorm <= crtol) {
194247a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to residual ||g(X)||/|f(X)| =%g < %g\n",(double)(gnorm/f),(double)grtol);CHKERRQ(ierr);
1943a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GRTOL;
1944a7e14dcfSSatish Balay   } else if (gnorm0 != 0 && gnorm/gnorm0 <= gttol && cnorm <= crtol) {
194547a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to relative residual norm ||g(X)||/||g(X0)|| = %g < %g\n",(double)(gnorm/gnorm0),(double)gttol);CHKERRQ(ierr);
1946a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GTTOL;
1947a7e14dcfSSatish Balay   } else if (nfuncs > max_funcs){
1948a7e14dcfSSatish Balay     ierr = PetscInfo2(tao,"Exceeded maximum number of function evaluations: %D > %D\n", nfuncs,max_funcs);CHKERRQ(ierr);
1949a7e14dcfSSatish Balay     reason = TAO_DIVERGED_MAXFCN;
1950a7e14dcfSSatish Balay   } else if ( tao->lsflag != 0 ){
1951a7e14dcfSSatish Balay     ierr = PetscInfo(tao,"Tao Line Search failure.\n");CHKERRQ(ierr);
1952a7e14dcfSSatish Balay     reason = TAO_DIVERGED_LS_FAILURE;
1953a7e14dcfSSatish Balay   } else if (trradius < steptol && niter > 0){
195447a47007SBarry Smith     ierr = PetscInfo2(tao,"Trust region/step size too small: %g < %g\n", (double)trradius,(double)steptol);CHKERRQ(ierr);
1955a7e14dcfSSatish Balay     reason = TAO_CONVERGED_STEPTOL;
1956a7e14dcfSSatish Balay   } else if (niter > tao->max_it) {
1957a7e14dcfSSatish Balay     ierr = PetscInfo2(tao,"Exceeded maximum number of iterations: %D > %D\n",niter,tao->max_it);CHKERRQ(ierr);
1958a7e14dcfSSatish Balay     reason = TAO_DIVERGED_MAXITS;
1959a7e14dcfSSatish Balay   } else {
1960a7e14dcfSSatish Balay     reason = TAO_CONTINUE_ITERATING;
1961a7e14dcfSSatish Balay   }
1962a7e14dcfSSatish Balay   tao->reason = reason;
1963a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1964a7e14dcfSSatish Balay }
1965a7e14dcfSSatish Balay 
1966a7e14dcfSSatish Balay #undef __FUNCT__
1967a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetOptionsPrefix"
1968a7e14dcfSSatish Balay /*@C
1969a7e14dcfSSatish Balay    TaoSetOptionsPrefix - Sets the prefix used for searching for all
1970a7e14dcfSSatish Balay    TAO options in the database.
1971a7e14dcfSSatish Balay 
1972a7e14dcfSSatish Balay 
1973441846f8SBarry Smith    Logically Collective on Tao
1974a7e14dcfSSatish Balay 
1975a7e14dcfSSatish Balay    Input Parameters:
1976441846f8SBarry Smith +  tao - the Tao context
1977a7e14dcfSSatish Balay -  prefix - the prefix string to prepend to all TAO option requests
1978a7e14dcfSSatish Balay 
1979a7e14dcfSSatish Balay    Notes:
1980a7e14dcfSSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
1981a7e14dcfSSatish Balay    The first character of all runtime options is AUTOMATICALLY the hyphen.
1982a7e14dcfSSatish Balay 
1983a7e14dcfSSatish Balay    For example, to distinguish between the runtime options for two
1984a7e14dcfSSatish Balay    different TAO solvers, one could call
1985a7e14dcfSSatish Balay .vb
1986a7e14dcfSSatish Balay       TaoSetOptionsPrefix(tao1,"sys1_")
1987a7e14dcfSSatish Balay       TaoSetOptionsPrefix(tao2,"sys2_")
1988a7e14dcfSSatish Balay .ve
1989a7e14dcfSSatish Balay 
1990a7e14dcfSSatish Balay    This would enable use of different options for each system, such as
1991a7e14dcfSSatish Balay .vb
1992a7e14dcfSSatish Balay       -sys1_tao_method blmvm -sys1_tao_gtol 1.e-3
1993a7e14dcfSSatish Balay       -sys2_tao_method lmvm  -sys2_tao_gtol 1.e-4
1994a7e14dcfSSatish Balay .ve
1995a7e14dcfSSatish Balay 
1996a7e14dcfSSatish Balay 
1997a7e14dcfSSatish Balay    Level: advanced
1998a7e14dcfSSatish Balay 
1999a7e14dcfSSatish Balay .seealso: TaoAppendOptionsPrefix(), TaoGetOptionsPrefix()
2000a7e14dcfSSatish Balay @*/
2001a7e14dcfSSatish Balay 
2002441846f8SBarry Smith PetscErrorCode TaoSetOptionsPrefix(Tao tao, const char p[])
2003a7e14dcfSSatish Balay {
2004a7e14dcfSSatish Balay   PetscErrorCode ierr;
200547a47007SBarry Smith 
2006a7e14dcfSSatish Balay   PetscFunctionBegin;
2007a7e14dcfSSatish Balay   ierr = PetscObjectSetOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr);
2008a7e14dcfSSatish Balay   if (tao->linesearch) {
2009a7e14dcfSSatish Balay     ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr);
2010a7e14dcfSSatish Balay   }
2011a7e14dcfSSatish Balay   if (tao->ksp) {
2012a7e14dcfSSatish Balay     ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr);
2013a7e14dcfSSatish Balay   }
2014a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2015a7e14dcfSSatish Balay }
2016a7e14dcfSSatish Balay 
2017a7e14dcfSSatish Balay #undef __FUNCT__
2018a7e14dcfSSatish Balay #define __FUNCT__ "TaoAppendOptionsPrefix"
2019a7e14dcfSSatish Balay /*@C
2020a7e14dcfSSatish Balay    TaoAppendOptionsPrefix - Appends to the prefix used for searching for all
2021a7e14dcfSSatish Balay    TAO options in the database.
2022a7e14dcfSSatish Balay 
2023a7e14dcfSSatish Balay 
2024441846f8SBarry Smith    Logically Collective on Tao
2025a7e14dcfSSatish Balay 
2026a7e14dcfSSatish Balay    Input Parameters:
2027441846f8SBarry Smith +  tao - the Tao solver context
2028a7e14dcfSSatish Balay -  prefix - the prefix string to prepend to all TAO option requests
2029a7e14dcfSSatish Balay 
2030a7e14dcfSSatish Balay    Notes:
2031a7e14dcfSSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
2032a7e14dcfSSatish Balay    The first character of all runtime options is AUTOMATICALLY the hyphen.
2033a7e14dcfSSatish Balay 
2034a7e14dcfSSatish Balay 
2035a7e14dcfSSatish Balay    Level: advanced
2036a7e14dcfSSatish Balay 
2037a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoGetOptionsPrefix()
2038a7e14dcfSSatish Balay @*/
2039441846f8SBarry Smith PetscErrorCode TaoAppendOptionsPrefix(Tao tao, const char p[])
2040a7e14dcfSSatish Balay {
2041a7e14dcfSSatish Balay   PetscErrorCode ierr;
204247a47007SBarry Smith 
2043a7e14dcfSSatish Balay   PetscFunctionBegin;
2044a7e14dcfSSatish Balay   ierr = PetscObjectAppendOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr);
2045a7e14dcfSSatish Balay   if (tao->linesearch) {
2046a7e14dcfSSatish Balay     ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr);
2047a7e14dcfSSatish Balay   }
2048a7e14dcfSSatish Balay   if (tao->ksp) {
2049a7e14dcfSSatish Balay     ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr);
2050a7e14dcfSSatish Balay   }
2051a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2052a7e14dcfSSatish Balay }
2053a7e14dcfSSatish Balay 
2054a7e14dcfSSatish Balay #undef __FUNCT__
2055a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetOptionsPrefix"
2056a7e14dcfSSatish Balay /*@C
2057a7e14dcfSSatish Balay   TaoGetOptionsPrefix - Gets the prefix used for searching for all
2058a7e14dcfSSatish Balay   TAO options in the database
2059a7e14dcfSSatish Balay 
2060a7e14dcfSSatish Balay   Not Collective
2061a7e14dcfSSatish Balay 
2062a7e14dcfSSatish Balay   Input Parameters:
2063441846f8SBarry Smith . tao - the Tao context
2064a7e14dcfSSatish Balay 
2065a7e14dcfSSatish Balay   Output Parameters:
2066a7e14dcfSSatish Balay . prefix - pointer to the prefix string used is returned
2067a7e14dcfSSatish Balay 
2068a7e14dcfSSatish Balay   Notes: On the fortran side, the user should pass in a string 'prefix' of
2069a7e14dcfSSatish Balay   sufficient length to hold the prefix.
2070a7e14dcfSSatish Balay 
2071a7e14dcfSSatish Balay   Level: advanced
2072a7e14dcfSSatish Balay 
2073a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoAppendOptionsPrefix()
2074a7e14dcfSSatish Balay @*/
2075441846f8SBarry Smith PetscErrorCode TaoGetOptionsPrefix(Tao tao, const char *p[])
2076a7e14dcfSSatish Balay {
207747a47007SBarry Smith    return PetscObjectGetOptionsPrefix((PetscObject)tao,p);
2078a7e14dcfSSatish Balay }
2079a7e14dcfSSatish Balay 
2080a7e14dcfSSatish Balay #undef __FUNCT__
2081a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetType"
2082a7e14dcfSSatish Balay /*@C
2083a7e14dcfSSatish Balay    TaoSetType - Sets the method for the unconstrained minimization solver.
2084a7e14dcfSSatish Balay 
2085441846f8SBarry Smith    Collective on Tao
2086a7e14dcfSSatish Balay 
2087a7e14dcfSSatish Balay    Input Parameters:
2088441846f8SBarry Smith +  solver - the Tao solver context
2089a7e14dcfSSatish Balay -  type - a known method
2090a7e14dcfSSatish Balay 
2091a7e14dcfSSatish Balay    Options Database Key:
209258417fe7SBarry Smith .  -tao_type <type> - Sets the method; use -help for a list
209358417fe7SBarry Smith    of available methods (for instance, "-tao_type lmvm" or "-tao_type tron")
2094a7e14dcfSSatish Balay 
2095a7e14dcfSSatish Balay    Available methods include:
209658417fe7SBarry Smith +    nls - Newton's method with line search for unconstrained minimization
209758417fe7SBarry Smith .    ntr - Newton's method with trust region for unconstrained minimization
209858417fe7SBarry Smith .    ntl - Newton's method with trust region, line search for unconstrained minimization
209958417fe7SBarry Smith .    lmvm - Limited memory variable metric method for unconstrained minimization
210058417fe7SBarry Smith .    cg - Nonlinear conjugate gradient method for unconstrained minimization
210158417fe7SBarry Smith .    nm - Nelder-Mead algorithm for derivate-free unconstrained minimization
210258417fe7SBarry Smith .    tron - Newton Trust Region method for bound constrained minimization
210358417fe7SBarry Smith .    gpcg - Newton Trust Region method for quadratic bound constrained minimization
210458417fe7SBarry Smith .    blmvm - Limited memory variable metric method for bound constrained minimization
21051eb8069cSJason Sarich -    pounders - Model-based algorithm pounder extended for nonlinear least squares
2106a7e14dcfSSatish Balay 
2107a7e14dcfSSatish Balay   Level: intermediate
2108a7e14dcfSSatish Balay 
21091eb8069cSJason Sarich .seealso: TaoCreate(), TaoGetType(), TaoType
2110a7e14dcfSSatish Balay 
2111a7e14dcfSSatish Balay @*/
2112441846f8SBarry Smith PetscErrorCode TaoSetType(Tao tao, const TaoType type)
2113a7e14dcfSSatish Balay {
2114a7e14dcfSSatish Balay   PetscErrorCode ierr;
2115441846f8SBarry Smith   PetscErrorCode (*create_xxx)(Tao);
2116a7e14dcfSSatish Balay   PetscBool      issame;
2117a7e14dcfSSatish Balay 
2118a7e14dcfSSatish Balay   PetscFunctionBegin;
2119441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2120a7e14dcfSSatish Balay 
2121a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)tao,type,&issame);CHKERRQ(ierr);
2122a7e14dcfSSatish Balay   if (issame) PetscFunctionReturn(0);
2123a7e14dcfSSatish Balay 
2124441846f8SBarry Smith   ierr = PetscFunctionListFind(TaoList, type, (void(**)(void))&create_xxx);CHKERRQ(ierr);
2125441846f8SBarry Smith   if (!create_xxx) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested Tao type %s",type);
2126a7e14dcfSSatish Balay 
2127a7e14dcfSSatish Balay   /* Destroy the existing solver information */
2128a7e14dcfSSatish Balay   if (tao->ops->destroy) {
2129a7e14dcfSSatish Balay     ierr = (*tao->ops->destroy)(tao);CHKERRQ(ierr);
2130a7e14dcfSSatish Balay   }
2131a7e14dcfSSatish Balay   ierr = KSPDestroy(&tao->ksp);CHKERRQ(ierr);
2132a7e14dcfSSatish Balay   ierr = TaoLineSearchDestroy(&tao->linesearch);CHKERRQ(ierr);
2133a7e14dcfSSatish Balay   ierr = VecDestroy(&tao->gradient);CHKERRQ(ierr);
2134a7e14dcfSSatish Balay   ierr = VecDestroy(&tao->stepdirection);CHKERRQ(ierr);
2135a7e14dcfSSatish Balay 
2136a7e14dcfSSatish Balay   tao->ops->setup = 0;
2137a7e14dcfSSatish Balay   tao->ops->solve = 0;
2138a7e14dcfSSatish Balay   tao->ops->view  = 0;
2139a7e14dcfSSatish Balay   tao->ops->setfromoptions = 0;
2140a7e14dcfSSatish Balay   tao->ops->destroy = 0;
2141a7e14dcfSSatish Balay 
2142a7e14dcfSSatish Balay   tao->setupcalled = PETSC_FALSE;
2143a7e14dcfSSatish Balay 
2144a7e14dcfSSatish Balay   ierr = (*create_xxx)(tao);CHKERRQ(ierr);
2145a7e14dcfSSatish Balay   ierr = PetscObjectChangeTypeName((PetscObject)tao,type);CHKERRQ(ierr);
2146a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2147a7e14dcfSSatish Balay }
214847a47007SBarry Smith 
2149a7e14dcfSSatish Balay #undef __FUNCT__
2150441846f8SBarry Smith #define __FUNCT__ "TaoRegister"
2151a7e14dcfSSatish Balay /*MC
2152441846f8SBarry Smith    TaoRegister - Adds a method to the TAO package for unconstrained minimization.
2153a7e14dcfSSatish Balay 
2154a7e14dcfSSatish Balay    Synopsis:
2155441846f8SBarry Smith    TaoRegister(char *name_solver,char *path,char *name_Create,int (*routine_Create)(Tao))
2156a7e14dcfSSatish Balay 
2157a7e14dcfSSatish Balay    Not collective
2158a7e14dcfSSatish Balay 
2159a7e14dcfSSatish Balay    Input Parameters:
2160a7e14dcfSSatish Balay +  sname - name of a new user-defined solver
2161a7e14dcfSSatish Balay -  func - routine to Create method context
2162a7e14dcfSSatish Balay 
2163a7e14dcfSSatish Balay    Notes:
2164441846f8SBarry Smith    TaoRegister() may be called multiple times to add several user-defined solvers.
2165a7e14dcfSSatish Balay 
2166a7e14dcfSSatish Balay    Sample usage:
2167a7e14dcfSSatish Balay .vb
2168441846f8SBarry Smith    TaoRegister("my_solver",MySolverCreate);
2169a7e14dcfSSatish Balay .ve
2170a7e14dcfSSatish Balay 
2171a7e14dcfSSatish Balay    Then, your solver can be chosen with the procedural interface via
2172a7e14dcfSSatish Balay $     TaoSetType(tao,"my_solver")
2173a7e14dcfSSatish Balay    or at runtime via the option
217458417fe7SBarry Smith $     -tao_type my_solver
2175a7e14dcfSSatish Balay 
2176a7e14dcfSSatish Balay    Level: advanced
2177a7e14dcfSSatish Balay 
2178441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegisterDestroy()
2179a7e14dcfSSatish Balay M*/
2180441846f8SBarry Smith PetscErrorCode TaoRegister(const char sname[], PetscErrorCode (*func)(Tao))
2181a7e14dcfSSatish Balay {
2182a7e14dcfSSatish Balay   PetscErrorCode ierr;
2183a7e14dcfSSatish Balay 
2184a7e14dcfSSatish Balay   PetscFunctionBegin;
2185441846f8SBarry Smith   ierr = PetscFunctionListAdd(&TaoList,sname, (void (*)(void))func);CHKERRQ(ierr);
2186a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2187a7e14dcfSSatish Balay }
2188a7e14dcfSSatish Balay 
2189a7e14dcfSSatish Balay #undef __FUNCT__
2190441846f8SBarry Smith #define __FUNCT__ "TaoRegisterDestroy"
2191a7e14dcfSSatish Balay /*@C
2192441846f8SBarry Smith    TaoRegisterDestroy - Frees the list of minimization solvers that were
2193441846f8SBarry Smith    registered by TaoRegisterDynamic().
2194a7e14dcfSSatish Balay 
2195a7e14dcfSSatish Balay    Not Collective
2196a7e14dcfSSatish Balay 
2197a7e14dcfSSatish Balay    Level: advanced
2198a7e14dcfSSatish Balay 
2199441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegister()
2200a7e14dcfSSatish Balay @*/
2201441846f8SBarry Smith PetscErrorCode TaoRegisterDestroy(void)
2202a7e14dcfSSatish Balay {
2203a7e14dcfSSatish Balay   PetscErrorCode ierr;
2204a7e14dcfSSatish Balay   PetscFunctionBegin;
2205441846f8SBarry Smith   ierr = PetscFunctionListDestroy(&TaoList);CHKERRQ(ierr);
2206441846f8SBarry Smith   TaoRegisterAllCalled = PETSC_FALSE;
2207a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2208a7e14dcfSSatish Balay }
220947a47007SBarry Smith 
2210a7e14dcfSSatish Balay #undef __FUNCT__
22118931d482SJason Sarich #define __FUNCT__ "TaoGetIterationNumber"
22128931d482SJason Sarich /*@
22138931d482SJason Sarich    TaoGetIterationNumber - Gets the number of Tao iterations completed
22148931d482SJason Sarich    at this time.
22158931d482SJason Sarich 
22168931d482SJason Sarich    Not Collective
22178931d482SJason Sarich 
22188931d482SJason Sarich    Input Parameter:
22198931d482SJason Sarich .  tao - Tao context
22208931d482SJason Sarich 
22218931d482SJason Sarich    Output Parameter:
22228931d482SJason Sarich .  iter - iteration number
22238931d482SJason Sarich 
22248931d482SJason Sarich    Notes:
22258931d482SJason Sarich    For example, during the computation of iteration 2 this would return 1.
22268931d482SJason Sarich 
22278931d482SJason Sarich 
22288931d482SJason Sarich    Level: intermediate
22298931d482SJason Sarich 
22308931d482SJason Sarich .keywords: Tao, nonlinear, get, iteration, number,
22318931d482SJason Sarich 
22328931d482SJason Sarich .seealso:   TaoGetLinearSolveIterations()
22338931d482SJason Sarich @*/
22348931d482SJason Sarich PetscErrorCode  TaoGetIterationNumber(Tao tao,PetscInt *iter)
22358931d482SJason Sarich {
22368931d482SJason Sarich   PetscFunctionBegin;
22378931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
22388931d482SJason Sarich   PetscValidIntPointer(iter,2);
22398931d482SJason Sarich   *iter = tao->niter;
22408931d482SJason Sarich   PetscFunctionReturn(0);
22418931d482SJason Sarich }
22428931d482SJason Sarich 
22438931d482SJason Sarich #undef __FUNCT__
22448931d482SJason Sarich #define __FUNCT__ "TaoSetIterationNumber"
22458931d482SJason Sarich /*@
22468931d482SJason Sarich    TaoSetIterationNumber - Sets the current iteration number.
22478931d482SJason Sarich 
22488931d482SJason Sarich    Not Collective
22498931d482SJason Sarich 
22508931d482SJason Sarich    Input Parameter:
22518931d482SJason Sarich .  tao - Tao context
22528931d482SJason Sarich .  iter - iteration number
22538931d482SJason Sarich 
22548931d482SJason Sarich    Level: developer
22558931d482SJason Sarich 
22568931d482SJason Sarich .keywords: Tao, nonlinear, set, iteration, number,
22578931d482SJason Sarich 
22588931d482SJason Sarich .seealso:   TaoGetLinearSolveIterations()
22598931d482SJason Sarich @*/
22608931d482SJason Sarich PetscErrorCode  TaoSetIterationNumber(Tao tao,PetscInt iter)
22618931d482SJason Sarich {
22628931d482SJason Sarich   PetscErrorCode ierr;
22638931d482SJason Sarich 
22648931d482SJason Sarich   PetscFunctionBegin;
22658931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
22668931d482SJason Sarich   ierr       = PetscObjectSAWsTakeAccess((PetscObject)tao);CHKERRQ(ierr);
22678931d482SJason Sarich   tao->niter = iter;
22688931d482SJason Sarich   ierr       = PetscObjectSAWsGrantAccess((PetscObject)tao);CHKERRQ(ierr);
22698931d482SJason Sarich   PetscFunctionReturn(0);
22708931d482SJason Sarich }
22718931d482SJason Sarich 
22728931d482SJason Sarich #undef __FUNCT__
22738931d482SJason Sarich #define __FUNCT__ "TaoGetTotalIterationNumber"
22748931d482SJason Sarich /*@
22758931d482SJason Sarich    TaoGetTotalIterationNumber - Gets the total number of Tao iterations
22768931d482SJason Sarich    completed. This number keeps accumulating if multiple solves
22778931d482SJason Sarich    are called with the Tao object.
22788931d482SJason Sarich 
22798931d482SJason Sarich    Not Collective
22808931d482SJason Sarich 
22818931d482SJason Sarich    Input Parameter:
22828931d482SJason Sarich .  tao - Tao context
22838931d482SJason Sarich 
22848931d482SJason Sarich    Output Parameter:
22858931d482SJason Sarich .  iter - iteration number
22868931d482SJason Sarich 
22878931d482SJason Sarich    Notes:
22888931d482SJason Sarich    The total iteration count is updated after each solve, if there is a current
22898931d482SJason Sarich    TaoSolve() in progress then those iterations are not yet counted.
22908931d482SJason Sarich 
22918931d482SJason Sarich    Level: intermediate
22928931d482SJason Sarich 
22938931d482SJason Sarich .keywords: Tao, nonlinear, get, iteration, number,
22948931d482SJason Sarich 
22958931d482SJason Sarich .seealso:   TaoGetLinearSolveIterations()
22968931d482SJason Sarich @*/
22978931d482SJason Sarich PetscErrorCode  TaoGetTotalIterationNumber(Tao tao,PetscInt *iter)
22988931d482SJason Sarich {
22998931d482SJason Sarich   PetscFunctionBegin;
23008931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
23018931d482SJason Sarich   PetscValidIntPointer(iter,2);
23028931d482SJason Sarich   *iter = tao->ntotalits;
23038931d482SJason Sarich   PetscFunctionReturn(0);
23048931d482SJason Sarich }
23058931d482SJason Sarich 
23068931d482SJason Sarich #undef __FUNCT__
23078931d482SJason Sarich #define __FUNCT__ "TaoSetTotalIterationNumber"
23088931d482SJason Sarich /*@
23098931d482SJason Sarich    TaoSetTotalIterationNumber - Sets the current total iteration number.
23108931d482SJason Sarich 
23118931d482SJason Sarich    Not Collective
23128931d482SJason Sarich 
23138931d482SJason Sarich    Input Parameter:
23148931d482SJason Sarich .  tao - Tao context
23158931d482SJason Sarich .  iter - iteration number
23168931d482SJason Sarich 
23178931d482SJason Sarich    Level: developer
23188931d482SJason Sarich 
23198931d482SJason Sarich .keywords: Tao, nonlinear, set, iteration, number,
23208931d482SJason Sarich 
23218931d482SJason Sarich .seealso:   TaoGetLinearSolveIterations()
23228931d482SJason Sarich @*/
23238931d482SJason Sarich PetscErrorCode  TaoSetTotalIterationNumber(Tao tao,PetscInt iter)
23248931d482SJason Sarich {
23258931d482SJason Sarich   PetscErrorCode ierr;
23268931d482SJason Sarich 
23278931d482SJason Sarich   PetscFunctionBegin;
23288931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
23298931d482SJason Sarich   ierr       = PetscObjectSAWsTakeAccess((PetscObject)tao);CHKERRQ(ierr);
23308931d482SJason Sarich   tao->ntotalits = iter;
23318931d482SJason Sarich   ierr       = PetscObjectSAWsGrantAccess((PetscObject)tao);CHKERRQ(ierr);
23328931d482SJason Sarich   PetscFunctionReturn(0);
23338931d482SJason Sarich }
23348931d482SJason Sarich 
23358931d482SJason Sarich #undef __FUNCT__
2336e4cb33bbSBarry Smith #define __FUNCT__ "TaoSetConvergedReason"
2337a7e14dcfSSatish Balay /*@
2338e4cb33bbSBarry Smith   TaoSetConvergedReason - Sets the termination flag on a Tao object
2339a7e14dcfSSatish Balay 
2340441846f8SBarry Smith   Logically Collective on Tao
2341a7e14dcfSSatish Balay 
2342a7e14dcfSSatish Balay   Input Parameters:
2343441846f8SBarry Smith + tao - the Tao context
2344a7e14dcfSSatish Balay - reason - one of
2345a7e14dcfSSatish Balay $     TAO_CONVERGED_ATOL (2),
2346a7e14dcfSSatish Balay $     TAO_CONVERGED_RTOL (3),
2347a7e14dcfSSatish Balay $     TAO_CONVERGED_STEPTOL (4),
2348a7e14dcfSSatish Balay $     TAO_CONVERGED_MINF (5),
2349a7e14dcfSSatish Balay $     TAO_CONVERGED_USER (6),
2350a7e14dcfSSatish Balay $     TAO_DIVERGED_MAXITS (-2),
2351a7e14dcfSSatish Balay $     TAO_DIVERGED_NAN (-4),
2352a7e14dcfSSatish Balay $     TAO_DIVERGED_MAXFCN (-5),
2353a7e14dcfSSatish Balay $     TAO_DIVERGED_LS_FAILURE (-6),
2354a7e14dcfSSatish Balay $     TAO_DIVERGED_TR_REDUCTION (-7),
2355a7e14dcfSSatish Balay $     TAO_DIVERGED_USER (-8),
2356a7e14dcfSSatish Balay $     TAO_CONTINUE_ITERATING (0)
2357a7e14dcfSSatish Balay 
2358a7e14dcfSSatish Balay    Level: intermediate
2359a7e14dcfSSatish Balay 
2360a7e14dcfSSatish Balay @*/
2361e4cb33bbSBarry Smith PetscErrorCode TaoSetConvergedReason(Tao tao, TaoConvergedReason reason)
2362a7e14dcfSSatish Balay {
2363441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2364a7e14dcfSSatish Balay   PetscFunctionBegin;
2365a7e14dcfSSatish Balay   tao->reason = reason;
2366a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2367a7e14dcfSSatish Balay }
2368a7e14dcfSSatish Balay 
2369a7e14dcfSSatish Balay #undef __FUNCT__
2370e4cb33bbSBarry Smith #define __FUNCT__ "TaoGetConvergedReason"
2371a7e14dcfSSatish Balay /*@
2372e4cb33bbSBarry Smith    TaoGetConvergedReason - Gets the reason the Tao iteration was stopped.
2373a7e14dcfSSatish Balay 
2374a7e14dcfSSatish Balay    Not Collective
2375a7e14dcfSSatish Balay 
2376a7e14dcfSSatish Balay    Input Parameter:
2377441846f8SBarry Smith .  tao - the Tao solver context
2378a7e14dcfSSatish Balay 
2379a7e14dcfSSatish Balay    Output Parameter:
2380a7e14dcfSSatish Balay .  reason - one of
2381a7e14dcfSSatish Balay $  TAO_CONVERGED_FATOL (1)           f(X)-f(X*) <= fatol
2382a7e14dcfSSatish Balay $  TAO_CONVERGED_FRTOL (2)           |f(X) - f(X*)|/|f(X)| < frtol
2383a7e14dcfSSatish Balay $  TAO_CONVERGED_GATOL (3)           ||g(X)|| < gatol
2384a7e14dcfSSatish Balay $  TAO_CONVERGED_GRTOL (4)           ||g(X)|| / f(X)  < grtol
2385a7e14dcfSSatish Balay $  TAO_CONVERGED_GTTOL (5)           ||g(X)|| / ||g(X0)|| < gttol
2386a7e14dcfSSatish Balay $  TAO_CONVERGED_STEPTOL (6)         step size small
2387a7e14dcfSSatish Balay $  TAO_CONVERGED_MINF (7)            F < F_min
2388a7e14dcfSSatish Balay $  TAO_CONVERGED_USER (8)            User defined
2389a7e14dcfSSatish Balay $  TAO_DIVERGED_MAXITS (-2)          its > maxits
2390a7e14dcfSSatish Balay $  TAO_DIVERGED_NAN (-4)             Numerical problems
2391a7e14dcfSSatish Balay $  TAO_DIVERGED_MAXFCN (-5)          fevals > max_funcsals
2392a7e14dcfSSatish Balay $  TAO_DIVERGED_LS_FAILURE (-6)      line search failure
2393a7e14dcfSSatish Balay $  TAO_DIVERGED_TR_REDUCTION (-7)    trust region failure
2394a7e14dcfSSatish Balay $  TAO_DIVERGED_USER(-8)             (user defined)
2395a7e14dcfSSatish Balay  $  TAO_CONTINUE_ITERATING (0)
2396a7e14dcfSSatish Balay 
2397a7e14dcfSSatish Balay    where
2398a7e14dcfSSatish Balay +  X - current solution
2399a7e14dcfSSatish Balay .  X0 - initial guess
2400a7e14dcfSSatish Balay .  f(X) - current function value
2401a7e14dcfSSatish Balay .  f(X*) - true solution (estimated)
2402a7e14dcfSSatish Balay .  g(X) - current gradient
2403a7e14dcfSSatish Balay .  its - current iterate number
2404a7e14dcfSSatish Balay .  maxits - maximum number of iterates
2405a7e14dcfSSatish Balay .  fevals - number of function evaluations
2406a7e14dcfSSatish Balay -  max_funcsals - maximum number of function evaluations
2407a7e14dcfSSatish Balay 
2408a7e14dcfSSatish Balay    Level: intermediate
2409a7e14dcfSSatish Balay 
2410a7e14dcfSSatish Balay .seealso: TaoSetConvergenceTest(), TaoSetTolerances()
2411a7e14dcfSSatish Balay 
2412a7e14dcfSSatish Balay @*/
2413e4cb33bbSBarry Smith PetscErrorCode TaoGetConvergedReason(Tao tao, TaoConvergedReason *reason)
2414a7e14dcfSSatish Balay {
2415a7e14dcfSSatish Balay   PetscFunctionBegin;
2416441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2417a7e14dcfSSatish Balay   PetscValidPointer(reason,2);
2418a7e14dcfSSatish Balay   *reason = tao->reason;
2419a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2420a7e14dcfSSatish Balay }
2421a7e14dcfSSatish Balay 
2422a7e14dcfSSatish Balay #undef __FUNCT__
2423a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetSolutionStatus"
2424a7e14dcfSSatish Balay /*@
2425a7e14dcfSSatish Balay   TaoGetSolutionStatus - Get the current iterate, objective value,
2426a7e14dcfSSatish Balay   residual, infeasibility, and termination
2427a7e14dcfSSatish Balay 
2428a7e14dcfSSatish Balay   Not Collective
2429a7e14dcfSSatish Balay 
2430a7e14dcfSSatish Balay    Input Parameters:
2431441846f8SBarry Smith .  tao - the Tao context
2432a7e14dcfSSatish Balay 
2433a7e14dcfSSatish Balay    Output Parameters:
2434a7e14dcfSSatish Balay +  iterate - the current iterate number (>=0)
2435a7e14dcfSSatish Balay .  f - the current function value
243658417fe7SBarry Smith .  gnorm - the square of the gradient norm, duality gap, or other measure indicating distance from optimality.
2437a7e14dcfSSatish Balay .  cnorm - the infeasibility of the current solution with regard to the constraints.
2438a7e14dcfSSatish Balay .  xdiff - the step length or trust region radius of the most recent iterate.
2439a7e14dcfSSatish Balay -  reason - The termination reason, which can equal TAO_CONTINUE_ITERATING
2440a7e14dcfSSatish Balay 
2441a7e14dcfSSatish Balay    Level: intermediate
2442a7e14dcfSSatish Balay 
2443a7e14dcfSSatish Balay    Note:
2444a7e14dcfSSatish Balay    TAO returns the values set by the solvers in the routine TaoMonitor().
2445a7e14dcfSSatish Balay 
2446a7e14dcfSSatish Balay    Note:
244747a47007SBarry Smith    If any of the output arguments are set to NULL, no corresponding value will be returned.
2448a7e14dcfSSatish Balay 
2449e4cb33bbSBarry Smith .seealso: TaoMonitor(), TaoGetConvergedReason()
2450a7e14dcfSSatish Balay @*/
2451e4cb33bbSBarry Smith PetscErrorCode TaoGetSolutionStatus(Tao tao, PetscInt *its, PetscReal *f, PetscReal *gnorm, PetscReal *cnorm, PetscReal *xdiff, TaoConvergedReason *reason)
2452a7e14dcfSSatish Balay {
2453a7e14dcfSSatish Balay   PetscFunctionBegin;
2454a7e14dcfSSatish Balay   if (its) *its=tao->niter;
2455a7e14dcfSSatish Balay   if (f) *f=tao->fc;
2456a7e14dcfSSatish Balay   if (gnorm) *gnorm=tao->residual;
2457a7e14dcfSSatish Balay   if (cnorm) *cnorm=tao->cnorm;
2458a7e14dcfSSatish Balay   if (reason) *reason=tao->reason;
2459a7e14dcfSSatish Balay   if (xdiff) *xdiff=tao->step;
2460a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2461a7e14dcfSSatish Balay }
2462a7e14dcfSSatish Balay 
2463a7e14dcfSSatish Balay #undef __FUNCT__
2464a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetType"
2465a7e14dcfSSatish Balay /*@C
2466441846f8SBarry Smith    TaoGetType - Gets the current Tao algorithm.
2467a7e14dcfSSatish Balay 
2468a7e14dcfSSatish Balay    Not Collective
2469a7e14dcfSSatish Balay 
2470a7e14dcfSSatish Balay    Input Parameter:
2471441846f8SBarry Smith .  tao - the Tao solver context
2472a7e14dcfSSatish Balay 
2473a7e14dcfSSatish Balay    Output Parameter:
2474441846f8SBarry Smith .  type - Tao method
2475a7e14dcfSSatish Balay 
2476a7e14dcfSSatish Balay    Level: intermediate
2477a7e14dcfSSatish Balay 
2478a7e14dcfSSatish Balay @*/
2479441846f8SBarry Smith PetscErrorCode TaoGetType(Tao tao, const TaoType *type)
2480a7e14dcfSSatish Balay {
2481a7e14dcfSSatish Balay   PetscFunctionBegin;
2482441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2483a7e14dcfSSatish Balay   PetscValidPointer(type,2);
2484a7e14dcfSSatish Balay   *type=((PetscObject)tao)->type_name;
2485a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2486a7e14dcfSSatish Balay }
2487a7e14dcfSSatish Balay 
2488a7e14dcfSSatish Balay #undef __FUNCT__
2489a7e14dcfSSatish Balay #define __FUNCT__ "TaoMonitor"
2490a7e14dcfSSatish Balay /*@C
2491a7e14dcfSSatish Balay   TaoMonitor - Monitor the solver and the current solution.  This
2492a7e14dcfSSatish Balay   routine will record the iteration number and residual statistics,
2493a7e14dcfSSatish Balay   call any monitors specified by the user, and calls the convergence-check routine.
2494a7e14dcfSSatish Balay 
2495a7e14dcfSSatish Balay    Input Parameters:
2496441846f8SBarry Smith +  tao - the Tao context
2497a7e14dcfSSatish Balay .  its - the current iterate number (>=0)
2498a7e14dcfSSatish Balay .  f - the current objective function value
249958417fe7SBarry Smith .  res - the gradient norm, square root of the duality gap, or other measure indicating distince from optimality.  This measure will be recorded and
2500a7e14dcfSSatish Balay           used for some termination tests.
2501a7e14dcfSSatish Balay .  cnorm - the infeasibility of the current solution with regard to the constraints.
2502a7e14dcfSSatish Balay -  steplength - multiple of the step direction added to the previous iterate.
2503a7e14dcfSSatish Balay 
2504a7e14dcfSSatish Balay    Output Parameters:
2505a7e14dcfSSatish Balay .  reason - The termination reason, which can equal TAO_CONTINUE_ITERATING
2506a7e14dcfSSatish Balay 
2507a7e14dcfSSatish Balay    Options Database Key:
2508a7e14dcfSSatish Balay .  -tao_monitor - Use the default monitor, which prints statistics to standard output
2509a7e14dcfSSatish Balay 
2510e4cb33bbSBarry Smith .seealso TaoGetConvergedReason(), TaoDefaultMonitor(), TaoSetMonitor()
2511a7e14dcfSSatish Balay 
2512a7e14dcfSSatish Balay    Level: developer
2513a7e14dcfSSatish Balay 
2514a7e14dcfSSatish Balay @*/
2515e4cb33bbSBarry Smith PetscErrorCode TaoMonitor(Tao tao, PetscInt its, PetscReal f, PetscReal res, PetscReal cnorm, PetscReal steplength, TaoConvergedReason *reason)
2516a7e14dcfSSatish Balay {
2517a7e14dcfSSatish Balay   PetscErrorCode ierr;
251847a47007SBarry Smith   PetscInt       i;
251947a47007SBarry Smith 
2520a7e14dcfSSatish Balay   PetscFunctionBegin;
2521441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2522a7e14dcfSSatish Balay   tao->fc = f;
2523a7e14dcfSSatish Balay   tao->residual = res;
2524a7e14dcfSSatish Balay   tao->cnorm = cnorm;
2525a7e14dcfSSatish Balay   tao->step = steplength;
2526a7e14dcfSSatish Balay   if (its == 0) {
2527a7e14dcfSSatish Balay     tao->cnorm0 = cnorm; tao->gnorm0 = res;
2528a7e14dcfSSatish Balay   }
2529ae93cb3cSJason Sarich   TaoLogConvergenceHistory(tao,f,res,cnorm,tao->ksp_its);
253047a47007SBarry Smith   if (PetscIsInfOrNanReal(f) || PetscIsInfOrNanReal(res)) SETERRQ(PETSC_COMM_SELF,1, "User provided compute function generated Inf or NaN");
2531a7e14dcfSSatish Balay   if (tao->ops->convergencetest) {
2532a7e14dcfSSatish Balay     ierr = (*tao->ops->convergencetest)(tao,tao->cnvP);CHKERRQ(ierr);
2533a7e14dcfSSatish Balay   }
2534a7e14dcfSSatish Balay   for (i=0;i<tao->numbermonitors;i++) {
2535a7e14dcfSSatish Balay     ierr = (*tao->monitor[i])(tao,tao->monitorcontext[i]);CHKERRQ(ierr);
2536a7e14dcfSSatish Balay   }
2537a7e14dcfSSatish Balay   *reason = tao->reason;
2538a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2539a7e14dcfSSatish Balay }
2540a7e14dcfSSatish Balay 
2541a7e14dcfSSatish Balay #undef __FUNCT__
2542ae93cb3cSJason Sarich #define __FUNCT__ "TaoSetConvergenceHistory"
2543a7e14dcfSSatish Balay /*@
2544ae93cb3cSJason Sarich    TaoSetConvergenceHistory - Sets the array used to hold the convergence history.
2545a7e14dcfSSatish Balay 
2546441846f8SBarry Smith    Logically Collective on Tao
2547a7e14dcfSSatish Balay 
2548a7e14dcfSSatish Balay    Input Parameters:
2549441846f8SBarry Smith +  tao - the Tao solver context
2550a7e14dcfSSatish Balay .  obj   - array to hold objective value history
2551a7e14dcfSSatish Balay .  resid - array to hold residual history
2552a7e14dcfSSatish Balay .  cnorm - array to hold constraint violation history
2553be1558d8SJason Sarich .  lits - integer array holds the number of linear iterations for each Tao iteration
2554a7e14dcfSSatish Balay .  na  - size of obj, resid, and cnorm
2555a7e14dcfSSatish Balay -  reset - PetscTrue indicates each new minimization resets the history counter to zero,
2556a7e14dcfSSatish Balay            else it continues storing new values for new minimizations after the old ones
2557a7e14dcfSSatish Balay 
2558a7e14dcfSSatish Balay    Notes:
2559a7e14dcfSSatish Balay    If set, TAO will fill the given arrays with the indicated
2560ae93cb3cSJason Sarich    information at each iteration.  If 'obj','resid','cnorm','lits' are
2561ae93cb3cSJason Sarich    *all* NULL then space (using size na, or 1000 if na is PETSC_DECIDE or
2562ae93cb3cSJason Sarich    PETSC_DEFAULT) is allocated for the history.
2563be1558d8SJason Sarich    If not all are NULL, then only the non-NULL information categories
2564ae93cb3cSJason Sarich    will be stored, the others will be ignored.
2565ae93cb3cSJason Sarich 
2566ae93cb3cSJason Sarich    Any convergence information after iteration number 'na' will not be stored.
2567a7e14dcfSSatish Balay 
2568a7e14dcfSSatish Balay    This routine is useful, e.g., when running a code for purposes
2569a7e14dcfSSatish Balay    of accurate performance monitoring, when no I/O should be done
2570a7e14dcfSSatish Balay    during the section of code that is being timed.
2571a7e14dcfSSatish Balay 
2572a7e14dcfSSatish Balay    Level: intermediate
2573a7e14dcfSSatish Balay 
2574ae93cb3cSJason Sarich .seealso: TaoGetConvergenceHistory()
2575a7e14dcfSSatish Balay 
2576a7e14dcfSSatish Balay @*/
2577ae93cb3cSJason Sarich PetscErrorCode TaoSetConvergenceHistory(Tao tao, PetscReal *obj, PetscReal *resid, PetscReal *cnorm, PetscInt *lits, PetscInt na,PetscBool reset)
2578a7e14dcfSSatish Balay {
2579ae93cb3cSJason Sarich   PetscErrorCode ierr;
2580ae93cb3cSJason Sarich 
2581a7e14dcfSSatish Balay   PetscFunctionBegin;
2582441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2583ae93cb3cSJason Sarich   if (obj) PetscValidScalarPointer(obj,2);
2584ae93cb3cSJason Sarich   if (resid) PetscValidScalarPointer(resid,3);
2585ae93cb3cSJason Sarich   if (cnorm) PetscValidScalarPointer(cnorm,4);
2586ae93cb3cSJason Sarich   if (lits) PetscValidIntPointer(lits,5);
2587ae93cb3cSJason Sarich 
2588ae93cb3cSJason Sarich   if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000;
2589ae93cb3cSJason Sarich   if (!obj && !resid && !cnorm && !lits) {
2590ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&obj);CHKERRQ(ierr);
2591ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&resid);CHKERRQ(ierr);
2592ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&cnorm);CHKERRQ(ierr);
2593ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&lits);CHKERRQ(ierr);
2594ae93cb3cSJason Sarich     tao->hist_malloc=PETSC_TRUE;
2595ae93cb3cSJason Sarich   }
2596ae93cb3cSJason Sarich 
2597a7e14dcfSSatish Balay   tao->hist_obj = obj;
2598a7e14dcfSSatish Balay   tao->hist_resid = resid;
2599a7e14dcfSSatish Balay   tao->hist_cnorm = cnorm;
2600ae93cb3cSJason Sarich   tao->hist_lits = lits;
2601a7e14dcfSSatish Balay   tao->hist_max   = na;
2602a7e14dcfSSatish Balay   tao->hist_reset = reset;
2603ae93cb3cSJason Sarich   tao->hist_len = 0;
2604a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2605a7e14dcfSSatish Balay }
2606a7e14dcfSSatish Balay 
2607a7e14dcfSSatish Balay #undef __FUNCT__
2608ae93cb3cSJason Sarich #define __FUNCT__ "TaoGetConvergenceHistory"
2609a7e14dcfSSatish Balay /*@C
2610ae93cb3cSJason Sarich    TaoGetConvergenceHistory - Gets the arrays used to hold the convergence history.
2611a7e14dcfSSatish Balay 
2612441846f8SBarry Smith    Collective on Tao
2613a7e14dcfSSatish Balay 
2614a7e14dcfSSatish Balay    Input Parameter:
2615441846f8SBarry Smith .  tao - the Tao context
2616a7e14dcfSSatish Balay 
2617a7e14dcfSSatish Balay    Output Parameters:
2618a7e14dcfSSatish Balay +  obj   - array used to hold objective value history
2619a7e14dcfSSatish Balay .  resid - array used to hold residual history
2620a7e14dcfSSatish Balay .  cnorm - array used to hold constraint violation history
2621ae93cb3cSJason Sarich .  lits  - integer array used to hold linear solver iteration count
2622ae93cb3cSJason Sarich -  nhist  - size of obj, resid, cnorm, and lits (will be less than or equal to na given in TaoSetHistory)
2623a7e14dcfSSatish Balay 
2624a7e14dcfSSatish Balay    Notes:
2625ae93cb3cSJason Sarich     This routine must be preceded by calls to TaoSetConvergenceHistory()
2626ae93cb3cSJason Sarich     and TaoSolve(), otherwise it returns useless information.
2627ae93cb3cSJason Sarich 
2628a7e14dcfSSatish Balay     The calling sequence for this routine in Fortran is
2629ae93cb3cSJason Sarich $   call TaoGetConvergenceHistory(Tao tao, PetscInt nhist, PetscErrorCode ierr)
2630a7e14dcfSSatish Balay 
2631a7e14dcfSSatish Balay    This routine is useful, e.g., when running a code for purposes
2632a7e14dcfSSatish Balay    of accurate performance monitoring, when no I/O should be done
2633a7e14dcfSSatish Balay    during the section of code that is being timed.
2634a7e14dcfSSatish Balay 
2635a7e14dcfSSatish Balay    Level: advanced
2636a7e14dcfSSatish Balay 
2637ae93cb3cSJason Sarich .seealso: TaoSetConvergenceHistory()
2638a7e14dcfSSatish Balay 
2639a7e14dcfSSatish Balay @*/
2640ae93cb3cSJason Sarich PetscErrorCode TaoGetConvergenceHistory(Tao tao, PetscReal **obj, PetscReal **resid, PetscReal **cnorm, PetscInt **lits, PetscInt *nhist)
2641a7e14dcfSSatish Balay {
2642a7e14dcfSSatish Balay   PetscFunctionBegin;
2643441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2644a7e14dcfSSatish Balay   if (obj)   *obj   = tao->hist_obj;
2645a7e14dcfSSatish Balay   if (cnorm) *cnorm = tao->hist_cnorm;
2646a7e14dcfSSatish Balay   if (resid) *resid = tao->hist_resid;
2647a7e14dcfSSatish Balay   if (nhist) *nhist   = tao->hist_len;
2648a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2649a7e14dcfSSatish Balay }
2650a7e14dcfSSatish Balay 
2651a7e14dcfSSatish Balay #undef __FUNCT__
2652a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetApplicationContext"
2653a7e14dcfSSatish Balay /*@
2654a7e14dcfSSatish Balay    TaoSetApplicationContext - Sets the optional user-defined context for
2655a7e14dcfSSatish Balay    a solver.
2656a7e14dcfSSatish Balay 
2657441846f8SBarry Smith    Logically Collective on Tao
2658a7e14dcfSSatish Balay 
2659a7e14dcfSSatish Balay    Input Parameters:
2660441846f8SBarry Smith +  tao  - the Tao context
2661a7e14dcfSSatish Balay -  usrP - optional user context
2662a7e14dcfSSatish Balay 
2663a7e14dcfSSatish Balay    Level: intermediate
2664a7e14dcfSSatish Balay 
2665a7e14dcfSSatish Balay .seealso: TaoGetApplicationContext(), TaoSetApplicationContext()
2666a7e14dcfSSatish Balay @*/
2667441846f8SBarry Smith PetscErrorCode  TaoSetApplicationContext(Tao tao,void *usrP)
2668a7e14dcfSSatish Balay {
2669a7e14dcfSSatish Balay   PetscFunctionBegin;
2670441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2671a7e14dcfSSatish Balay   tao->user = usrP;
2672a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2673a7e14dcfSSatish Balay }
2674a7e14dcfSSatish Balay 
2675a7e14dcfSSatish Balay #undef __FUNCT__
2676a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetApplicationContext"
2677a7e14dcfSSatish Balay /*@
2678a7e14dcfSSatish Balay    TaoGetApplicationContext - Gets the user-defined context for a
2679a7e14dcfSSatish Balay    TAO solvers.
2680a7e14dcfSSatish Balay 
2681a7e14dcfSSatish Balay    Not Collective
2682a7e14dcfSSatish Balay 
2683a7e14dcfSSatish Balay    Input Parameter:
2684441846f8SBarry Smith .  tao  - Tao context
2685a7e14dcfSSatish Balay 
2686a7e14dcfSSatish Balay    Output Parameter:
2687a7e14dcfSSatish Balay .  usrP - user context
2688a7e14dcfSSatish Balay 
2689a7e14dcfSSatish Balay    Level: intermediate
2690a7e14dcfSSatish Balay 
2691a7e14dcfSSatish Balay .seealso: TaoSetApplicationContext()
2692a7e14dcfSSatish Balay @*/
2693441846f8SBarry Smith PetscErrorCode  TaoGetApplicationContext(Tao tao,void *usrP)
2694a7e14dcfSSatish Balay {
2695a7e14dcfSSatish Balay   PetscFunctionBegin;
2696441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2697a7e14dcfSSatish Balay   *(void**)usrP = tao->user;
2698a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2699a7e14dcfSSatish Balay }
2700