xref: /petsc/src/tao/interface/taosolver.c (revision 2c9b8b830199b5bab9ba75a7aeed593ba39a1e6b)
1441846f8SBarry Smith #define TAO_DLL
2a7e14dcfSSatish Balay 
3af0996ceSBarry Smith #include <petsc/private/taoimpl.h> /*I "petsctao.h" I*/
4a7e14dcfSSatish Balay 
5441846f8SBarry Smith PetscBool TaoRegisterAllCalled = PETSC_FALSE;
6441846f8SBarry Smith PetscFunctionList TaoList = NULL;
7a7e14dcfSSatish Balay 
8441846f8SBarry Smith PetscClassId TAO_CLASSID;
9441846f8SBarry Smith PetscLogEvent Tao_Solve, Tao_ObjectiveEval, Tao_GradientEval, Tao_ObjGradientEval, Tao_HessianEval, Tao_ConstraintsEval, Tao_JacobianEval;
10a7e14dcfSSatish Balay 
115b0d99aeSBarry Smith const char *TaoSubSetTypes[] = {  "subvec","mask","matrixfree","TaoSubSetType","TAO_SUBSET_",0};
12a7e14dcfSSatish Balay 
13e882e171SHong Zhang struct _n_TaoMonitorDrawCtx {
14e882e171SHong Zhang   PetscViewer viewer;
15e882e171SHong Zhang   PetscInt    howoften;  /* when > 0 uses iteration % howoften, when negative only final solution plotted */
16e882e171SHong Zhang };
17e882e171SHong Zhang 
18a7e14dcfSSatish Balay /*@
19a7e14dcfSSatish Balay   TaoCreate - Creates a TAO solver
20a7e14dcfSSatish Balay 
21a7e14dcfSSatish Balay   Collective on MPI_Comm
22a7e14dcfSSatish Balay 
23a7e14dcfSSatish Balay   Input Parameter:
24a7e14dcfSSatish Balay . comm - MPI communicator
25a7e14dcfSSatish Balay 
26a7e14dcfSSatish Balay   Output Parameter:
27441846f8SBarry Smith . newtao - the new Tao context
28a7e14dcfSSatish Balay 
29a7e14dcfSSatish Balay   Available methods include:
3058417fe7SBarry Smith +    nls - Newton's method with line search for unconstrained minimization
3158417fe7SBarry Smith .    ntr - Newton's method with trust region for unconstrained minimization
3258417fe7SBarry Smith .    ntl - Newton's method with trust region, line search for unconstrained minimization
3358417fe7SBarry Smith .    lmvm - Limited memory variable metric method for unconstrained minimization
3458417fe7SBarry Smith .    cg - Nonlinear conjugate gradient method for unconstrained minimization
3558417fe7SBarry Smith .    nm - Nelder-Mead algorithm for derivate-free unconstrained minimization
3658417fe7SBarry Smith .    tron - Newton Trust Region method for bound constrained minimization
3758417fe7SBarry Smith .    gpcg - Newton Trust Region method for quadratic bound constrained minimization
3858417fe7SBarry Smith .    blmvm - Limited memory variable metric method for bound constrained minimization
3958417fe7SBarry Smith .    lcl - Linearly constrained Lagrangian method for pde-constrained minimization
4058417fe7SBarry Smith -    pounders - Model-based algorithm for nonlinear least squares
41a7e14dcfSSatish Balay 
42a7e14dcfSSatish Balay    Options Database Keys:
4358417fe7SBarry Smith .   -tao_type - select which method TAO should use
44a7e14dcfSSatish Balay 
45a7e14dcfSSatish Balay    Level: beginner
46a7e14dcfSSatish Balay 
47a7e14dcfSSatish Balay .seealso: TaoSolve(), TaoDestroy()
48a7e14dcfSSatish Balay @*/
49441846f8SBarry Smith PetscErrorCode TaoCreate(MPI_Comm comm, Tao *newtao)
50a7e14dcfSSatish Balay {
51a7e14dcfSSatish Balay   PetscErrorCode ierr;
52441846f8SBarry Smith   Tao            tao;
53a7e14dcfSSatish Balay 
54a7e14dcfSSatish Balay   PetscFunctionBegin;
55a7e14dcfSSatish Balay   PetscValidPointer(newtao,2);
5647a47007SBarry Smith   *newtao = NULL;
57a7e14dcfSSatish Balay 
58a7e14dcfSSatish Balay   ierr = TaoInitializePackage();CHKERRQ(ierr);
59a7e14dcfSSatish Balay   ierr = TaoLineSearchInitializePackage();CHKERRQ(ierr);
60a7e14dcfSSatish Balay 
6173107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(tao,TAO_CLASSID,"Tao","Optimization solver","Tao",comm,TaoDestroy,TaoView);CHKERRQ(ierr);
62a7e14dcfSSatish Balay   tao->ops->computeobjective=0;
63a7e14dcfSSatish Balay   tao->ops->computeobjectiveandgradient=0;
64a7e14dcfSSatish Balay   tao->ops->computegradient=0;
65a7e14dcfSSatish Balay   tao->ops->computehessian=0;
66a7e14dcfSSatish Balay   tao->ops->computeseparableobjective=0;
67a7e14dcfSSatish Balay   tao->ops->computeconstraints=0;
68a7e14dcfSSatish Balay   tao->ops->computejacobian=0;
69a7e14dcfSSatish Balay   tao->ops->computejacobianequality=0;
70a7e14dcfSSatish Balay   tao->ops->computejacobianinequality=0;
71a7e14dcfSSatish Balay   tao->ops->computeequalityconstraints=0;
72a7e14dcfSSatish Balay   tao->ops->computeinequalityconstraints=0;
73a7e14dcfSSatish Balay   tao->ops->convergencetest=TaoDefaultConvergenceTest;
74a7e14dcfSSatish Balay   tao->ops->convergencedestroy=0;
75a7e14dcfSSatish Balay   tao->ops->computedual=0;
76a7e14dcfSSatish Balay   tao->ops->setup=0;
77a7e14dcfSSatish Balay   tao->ops->solve=0;
78a7e14dcfSSatish Balay   tao->ops->view=0;
79a7e14dcfSSatish Balay   tao->ops->setfromoptions=0;
80a7e14dcfSSatish Balay   tao->ops->destroy=0;
81a7e14dcfSSatish Balay 
8247a47007SBarry Smith   tao->solution=NULL;
8347a47007SBarry Smith   tao->gradient=NULL;
8447a47007SBarry Smith   tao->sep_objective = NULL;
8547a47007SBarry Smith   tao->constraints=NULL;
8647a47007SBarry Smith   tao->constraints_equality=NULL;
8747a47007SBarry Smith   tao->constraints_inequality=NULL;
88125ddc8aSJason Sarich   tao->sep_weights_v=NULL;
89125ddc8aSJason Sarich   tao->sep_weights_w=NULL;
9047a47007SBarry Smith   tao->stepdirection=NULL;
918931d482SJason Sarich   tao->niter=0;
928931d482SJason Sarich   tao->ntotalits=0;
9347a47007SBarry Smith   tao->XL = NULL;
9447a47007SBarry Smith   tao->XU = NULL;
9547a47007SBarry Smith   tao->IL = NULL;
9647a47007SBarry Smith   tao->IU = NULL;
9747a47007SBarry Smith   tao->DI = NULL;
9847a47007SBarry Smith   tao->DE = NULL;
99a9603a14SPatrick Farrell   tao->gradient_norm = NULL;
100a9603a14SPatrick Farrell   tao->gradient_norm_tmp = NULL;
10147a47007SBarry Smith   tao->hessian = NULL;
10247a47007SBarry Smith   tao->hessian_pre = NULL;
10347a47007SBarry Smith   tao->jacobian = NULL;
10447a47007SBarry Smith   tao->jacobian_pre = NULL;
10547a47007SBarry Smith   tao->jacobian_state = NULL;
10647a47007SBarry Smith   tao->jacobian_state_pre = NULL;
10747a47007SBarry Smith   tao->jacobian_state_inv = NULL;
10847a47007SBarry Smith   tao->jacobian_design = NULL;
10947a47007SBarry Smith   tao->jacobian_design_pre = NULL;
11047a47007SBarry Smith   tao->jacobian_equality = NULL;
11147a47007SBarry Smith   tao->jacobian_equality_pre = NULL;
11247a47007SBarry Smith   tao->jacobian_inequality = NULL;
11347a47007SBarry Smith   tao->jacobian_inequality_pre = NULL;
11447a47007SBarry Smith   tao->state_is = NULL;
11547a47007SBarry Smith   tao->design_is = NULL;
116a7e14dcfSSatish Balay 
117a7e14dcfSSatish Balay   tao->max_it     = 10000;
118a7e14dcfSSatish Balay   tao->max_funcs   = 10000;
1196f4723b1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
1206f4723b1SBarry Smith   tao->gatol       = 1e-5;
1216f4723b1SBarry Smith   tao->grtol       = 1e-5;
1226f4723b1SBarry Smith #else
123a7e14dcfSSatish Balay   tao->gatol       = 1e-8;
124a7e14dcfSSatish Balay   tao->grtol       = 1e-8;
1256f4723b1SBarry Smith #endif
126a7e14dcfSSatish Balay   tao->crtol       = 0.0;
1276552cf8aSJason Sarich   tao->catol       = 0.0;
1286552cf8aSJason Sarich   tao->gttol       = 0.0;
1294f1535bcSTodd Munson   tao->steptol     = 0.0;
130e270355aSBarry Smith   tao->trust0      = PETSC_INFINITY;
1316f4723b1SBarry Smith   tao->fmin        = PETSC_NINFINITY;
132ae93cb3cSJason Sarich   tao->hist_malloc = PETSC_FALSE;
133a7e14dcfSSatish Balay   tao->hist_reset = PETSC_TRUE;
134a7e14dcfSSatish Balay   tao->hist_max = 0;
135a7e14dcfSSatish Balay   tao->hist_len = 0;
13647a47007SBarry Smith   tao->hist_obj = NULL;
13747a47007SBarry Smith   tao->hist_resid = NULL;
13847a47007SBarry Smith   tao->hist_cnorm = NULL;
139ae93cb3cSJason Sarich   tao->hist_lits = NULL;
140a7e14dcfSSatish Balay 
141a7e14dcfSSatish Balay   tao->numbermonitors=0;
142a7e14dcfSSatish Balay   tao->viewsolution=PETSC_FALSE;
143a7e14dcfSSatish Balay   tao->viewhessian=PETSC_FALSE;
144a7e14dcfSSatish Balay   tao->viewgradient=PETSC_FALSE;
145a7e14dcfSSatish Balay   tao->viewjacobian=PETSC_FALSE;
146a7e14dcfSSatish Balay   tao->viewconstraints = PETSC_FALSE;
147a7e14dcfSSatish Balay 
1486552cf8aSJason Sarich   /* These flags prevents algorithms from overriding user options */
1496552cf8aSJason Sarich   tao->max_it_changed   =PETSC_FALSE;
1506552cf8aSJason Sarich   tao->max_funcs_changed=PETSC_FALSE;
1516552cf8aSJason Sarich   tao->gatol_changed    =PETSC_FALSE;
1526552cf8aSJason Sarich   tao->grtol_changed    =PETSC_FALSE;
1536552cf8aSJason Sarich   tao->gttol_changed    =PETSC_FALSE;
1546552cf8aSJason Sarich   tao->steptol_changed  =PETSC_FALSE;
1556552cf8aSJason Sarich   tao->trust0_changed   =PETSC_FALSE;
1566552cf8aSJason Sarich   tao->fmin_changed     =PETSC_FALSE;
1576552cf8aSJason Sarich   tao->catol_changed    =PETSC_FALSE;
1586552cf8aSJason Sarich   tao->crtol_changed    =PETSC_FALSE;
159a7e14dcfSSatish Balay   ierr = TaoResetStatistics(tao);CHKERRQ(ierr);
160a7e14dcfSSatish Balay   *newtao = tao;
161a7e14dcfSSatish Balay   PetscFunctionReturn(0);
162a7e14dcfSSatish Balay }
163a7e14dcfSSatish Balay 
164a7e14dcfSSatish Balay /*@
165a7e14dcfSSatish Balay   TaoSolve - Solves an optimization problem min F(x) s.t. l <= x <= u
166a7e14dcfSSatish Balay 
167441846f8SBarry Smith   Collective on Tao
168a7e14dcfSSatish Balay 
169a7e14dcfSSatish Balay   Input Parameters:
170441846f8SBarry Smith . tao - the Tao context
171a7e14dcfSSatish Balay 
172a7e14dcfSSatish Balay   Notes:
173441846f8SBarry Smith   The user must set up the Tao with calls to TaoSetInitialVector(),
174a7e14dcfSSatish Balay   TaoSetObjectiveRoutine(),
175a7e14dcfSSatish Balay   TaoSetGradientRoutine(), and (if using 2nd order method) TaoSetHessianRoutine().
176a7e14dcfSSatish Balay 
177a35d58b8SBarry Smith   You should call TaoGetConvergedReason() or run with -tao_converged_reason to determine if the optimization algorithm actually succeeded or
178a35d58b8SBarry Smith   why it failed.
179a35d58b8SBarry Smith 
180a7e14dcfSSatish Balay   Level: beginner
181a7e14dcfSSatish Balay 
182a35d58b8SBarry Smith .seealso: TaoCreate(), TaoSetObjectiveRoutine(), TaoSetGradientRoutine(), TaoSetHessianRoutine(), TaoGetConvergedReason()
183a7e14dcfSSatish Balay  @*/
184441846f8SBarry Smith PetscErrorCode TaoSolve(Tao tao)
185a7e14dcfSSatish Balay {
186a7e14dcfSSatish Balay   PetscErrorCode   ierr;
187e2379f4fSBarry Smith   static PetscBool set = PETSC_FALSE;
18847a47007SBarry Smith 
189a7e14dcfSSatish Balay   PetscFunctionBegin;
190441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
191e2379f4fSBarry Smith   ierr = PetscCitationsRegister("@TechReport{tao-user-ref,\n"
192e2379f4fSBarry Smith                                 "title   = {Toolkit for Advanced Optimization (TAO) Users Manual},\n"
193e2379f4fSBarry Smith                                 "author  = {Todd Munson and Jason Sarich and Stefan Wild and Steve Benson and Lois Curfman McInnes},\n"
194e2379f4fSBarry Smith                                 "Institution = {Argonne National Laboratory},\n"
195e2379f4fSBarry Smith                                 "Year   = 2014,\n"
196e2379f4fSBarry Smith                                 "Number = {ANL/MCS-TM-322 - Revision 3.5},\n"
197302440fdSBarry Smith                                 "url    = {http://www.mcs.anl.gov/tao}\n}\n",&set);CHKERRQ(ierr);
198e2379f4fSBarry Smith 
199a7e14dcfSSatish Balay   ierr = TaoSetUp(tao);CHKERRQ(ierr);
200a7e14dcfSSatish Balay   ierr = TaoResetStatistics(tao);CHKERRQ(ierr);
201a7e14dcfSSatish Balay   if (tao->linesearch) {
202a7e14dcfSSatish Balay     ierr = TaoLineSearchReset(tao->linesearch);CHKERRQ(ierr);
203a7e14dcfSSatish Balay   }
204a7e14dcfSSatish Balay 
205441846f8SBarry Smith   ierr = PetscLogEventBegin(Tao_Solve,tao,0,0,0);CHKERRQ(ierr);
206a7e14dcfSSatish Balay   if (tao->ops->solve){ ierr = (*tao->ops->solve)(tao);CHKERRQ(ierr); }
207441846f8SBarry Smith   ierr = PetscLogEventEnd(Tao_Solve,tao,0,0,0);CHKERRQ(ierr);
208a7e14dcfSSatish Balay 
2097cf37e64SBarry Smith   ierr = VecViewFromOptions(tao->solution,(PetscObject)tao,"-tao_view_solution");CHKERRQ(ierr);
2107cf37e64SBarry Smith 
2118931d482SJason Sarich   tao->ntotalits += tao->niter;
212fbe0838dSJason Sarich   ierr = TaoViewFromOptions(tao,NULL,"-tao_view");CHKERRQ(ierr);
213a7e14dcfSSatish Balay 
214a7e14dcfSSatish Balay   if (tao->printreason) {
215a7e14dcfSSatish Balay     if (tao->reason > 0) {
2168931d482SJason Sarich       ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve converged due to %s iterations %D\n",TaoConvergedReasons[tao->reason],tao->niter);CHKERRQ(ierr);
217a7e14dcfSSatish Balay     } else {
2188931d482SJason Sarich       ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve did not converge due to %s iteration %D\n",TaoConvergedReasons[tao->reason],tao->niter);CHKERRQ(ierr);
219a7e14dcfSSatish Balay     }
220a7e14dcfSSatish Balay   }
221a7e14dcfSSatish Balay   PetscFunctionReturn(0);
222a7e14dcfSSatish Balay }
223a7e14dcfSSatish Balay 
224a7e14dcfSSatish Balay /*@
225a7e14dcfSSatish Balay   TaoSetUp - Sets up the internal data structures for the later use
226a7e14dcfSSatish Balay   of a Tao solver
227a7e14dcfSSatish Balay 
228a7e14dcfSSatish Balay   Collective on tao
229a7e14dcfSSatish Balay 
230a7e14dcfSSatish Balay   Input Parameters:
231a7e14dcfSSatish Balay . tao - the TAO context
232a7e14dcfSSatish Balay 
233a7e14dcfSSatish Balay   Notes:
234a7e14dcfSSatish Balay   The user will not need to explicitly call TaoSetUp(), as it will
235a7e14dcfSSatish Balay   automatically be called in TaoSolve().  However, if the user
236a7e14dcfSSatish Balay   desires to call it explicitly, it should come after TaoCreate()
237a7e14dcfSSatish Balay   and any TaoSetSomething() routines, but before TaoSolve().
238a7e14dcfSSatish Balay 
239a7e14dcfSSatish Balay   Level: advanced
240a7e14dcfSSatish Balay 
241a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
242a7e14dcfSSatish Balay @*/
243441846f8SBarry Smith PetscErrorCode TaoSetUp(Tao tao)
244a7e14dcfSSatish Balay {
245a7e14dcfSSatish Balay   PetscErrorCode ierr;
24647a47007SBarry Smith 
247a7e14dcfSSatish Balay   PetscFunctionBegin;
248441846f8SBarry Smith   PetscValidHeaderSpecific(tao, TAO_CLASSID,1);
249a7e14dcfSSatish Balay   if (tao->setupcalled) PetscFunctionReturn(0);
250a7e14dcfSSatish Balay 
25147a47007SBarry Smith   if (!tao->solution) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TaoSetInitialVector");
252a7e14dcfSSatish Balay   if (tao->ops->setup) {
253a7e14dcfSSatish Balay     ierr = (*tao->ops->setup)(tao);CHKERRQ(ierr);
254a7e14dcfSSatish Balay   }
255a7e14dcfSSatish Balay   tao->setupcalled = PETSC_TRUE;
256a7e14dcfSSatish Balay   PetscFunctionReturn(0);
257a7e14dcfSSatish Balay }
258a7e14dcfSSatish Balay 
259a7e14dcfSSatish Balay /*@
260a7e14dcfSSatish Balay   TaoDestroy - Destroys the TAO context that was created with
261a7e14dcfSSatish Balay   TaoCreate()
262a7e14dcfSSatish Balay 
263441846f8SBarry Smith   Collective on Tao
264a7e14dcfSSatish Balay 
265a7e14dcfSSatish Balay   Input Parameter:
266441846f8SBarry Smith . tao - the Tao context
267a7e14dcfSSatish Balay 
268a7e14dcfSSatish Balay   Level: beginner
269a7e14dcfSSatish Balay 
270a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
271a7e14dcfSSatish Balay @*/
272441846f8SBarry Smith PetscErrorCode TaoDestroy(Tao *tao)
273a7e14dcfSSatish Balay {
274a7e14dcfSSatish Balay   PetscErrorCode ierr;
27547a47007SBarry Smith 
276a7e14dcfSSatish Balay   PetscFunctionBegin;
277a7e14dcfSSatish Balay   if (!*tao) PetscFunctionReturn(0);
278441846f8SBarry Smith   PetscValidHeaderSpecific(*tao,TAO_CLASSID,1);
279a7e14dcfSSatish Balay   if (--((PetscObject)*tao)->refct > 0) {*tao=0;PetscFunctionReturn(0);}
280a7e14dcfSSatish Balay 
281a7e14dcfSSatish Balay   if ((*tao)->ops->destroy) {
282a7e14dcfSSatish Balay     ierr = (*((*tao))->ops->destroy)(*tao);CHKERRQ(ierr);
283a7e14dcfSSatish Balay   }
284a7e14dcfSSatish Balay   ierr = KSPDestroy(&(*tao)->ksp);CHKERRQ(ierr);
285a7e14dcfSSatish Balay   ierr = TaoLineSearchDestroy(&(*tao)->linesearch);CHKERRQ(ierr);
286a7e14dcfSSatish Balay 
287a7e14dcfSSatish Balay   if ((*tao)->ops->convergencedestroy) {
288a7e14dcfSSatish Balay     ierr = (*(*tao)->ops->convergencedestroy)((*tao)->cnvP);CHKERRQ(ierr);
289a7e14dcfSSatish Balay     if ((*tao)->jacobian_state_inv) {
290a7e14dcfSSatish Balay       ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr);
291a7e14dcfSSatish Balay     }
292a7e14dcfSSatish Balay   }
293a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->solution);CHKERRQ(ierr);
294a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->gradient);CHKERRQ(ierr);
295a7e14dcfSSatish Balay 
296a9603a14SPatrick Farrell   if ((*tao)->gradient_norm) {
297a9603a14SPatrick Farrell     ierr = PetscObjectDereference((PetscObject)(*tao)->gradient_norm);CHKERRQ(ierr);
298a9603a14SPatrick Farrell     ierr = VecDestroy(&(*tao)->gradient_norm_tmp);CHKERRQ(ierr);
299a9603a14SPatrick Farrell   }
300a9603a14SPatrick Farrell 
301a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->XL);CHKERRQ(ierr);
302a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->XU);CHKERRQ(ierr);
303a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->IL);CHKERRQ(ierr);
304a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->IU);CHKERRQ(ierr);
305a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->DE);CHKERRQ(ierr);
306a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->DI);CHKERRQ(ierr);
307a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->constraints_equality);CHKERRQ(ierr);
308a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->constraints_inequality);CHKERRQ(ierr);
309a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->stepdirection);CHKERRQ(ierr);
310a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->hessian_pre);CHKERRQ(ierr);
311a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->hessian);CHKERRQ(ierr);
312a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_pre);CHKERRQ(ierr);
313a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian);CHKERRQ(ierr);
314a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state_pre);CHKERRQ(ierr);
315a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state);CHKERRQ(ierr);
316a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr);
317067f330cSJason Sarich   ierr = MatDestroy(&(*tao)->jacobian_design);CHKERRQ(ierr);
318a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_equality);CHKERRQ(ierr);
319a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_equality_pre);CHKERRQ(ierr);
320a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_inequality);CHKERRQ(ierr);
321a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_inequality_pre);CHKERRQ(ierr);
322a7e14dcfSSatish Balay   ierr = ISDestroy(&(*tao)->state_is);CHKERRQ(ierr);
323a7e14dcfSSatish Balay   ierr = ISDestroy(&(*tao)->design_is);CHKERRQ(ierr);
324125ddc8aSJason Sarich   ierr = VecDestroy(&(*tao)->sep_weights_v);CHKERRQ(ierr);
325a7e14dcfSSatish Balay   ierr = TaoCancelMonitors(*tao);CHKERRQ(ierr);
326ae93cb3cSJason Sarich   if ((*tao)->hist_malloc) {
327ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_obj);CHKERRQ(ierr);
328ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_resid);CHKERRQ(ierr);
329ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_cnorm);CHKERRQ(ierr);
330ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_lits);CHKERRQ(ierr);
331ae93cb3cSJason Sarich   }
332125ddc8aSJason Sarich   if ((*tao)->sep_weights_n) {
333125ddc8aSJason Sarich     ierr = PetscFree((*tao)->sep_weights_rows);CHKERRQ(ierr);
334125ddc8aSJason Sarich     ierr = PetscFree((*tao)->sep_weights_cols);CHKERRQ(ierr);
335125ddc8aSJason Sarich     ierr = PetscFree((*tao)->sep_weights_w);CHKERRQ(ierr);
336125ddc8aSJason Sarich   }
337a7e14dcfSSatish Balay   ierr = PetscHeaderDestroy(tao);CHKERRQ(ierr);
338a7e14dcfSSatish Balay   PetscFunctionReturn(0);
339a7e14dcfSSatish Balay }
340a7e14dcfSSatish Balay 
341a7e14dcfSSatish Balay /*@
342441846f8SBarry Smith   TaoSetFromOptions - Sets various Tao parameters from user
343a7e14dcfSSatish Balay   options.
344a7e14dcfSSatish Balay 
345441846f8SBarry Smith   Collective on Tao
346a7e14dcfSSatish Balay 
347a7e14dcfSSatish Balay   Input Paremeter:
348441846f8SBarry Smith . tao - the Tao solver context
349a7e14dcfSSatish Balay 
350a7e14dcfSSatish Balay   options Database Keys:
35158417fe7SBarry Smith + -tao_type <type> - The algorithm that TAO uses (lmvm, nls, etc.)
352a7e14dcfSSatish Balay . -tao_gatol <gatol> - absolute error tolerance for ||gradient||
353a7e14dcfSSatish Balay . -tao_grtol <grtol> - relative error tolerance for ||gradient||
354a7e14dcfSSatish Balay . -tao_gttol <gttol> - reduction of ||gradient|| relative to initial gradient
355a7e14dcfSSatish Balay . -tao_max_it <max> - sets maximum number of iterations
356a7e14dcfSSatish Balay . -tao_max_funcs <max> - sets maximum number of function evaluations
357a7e14dcfSSatish Balay . -tao_fmin <fmin> - stop if function value reaches fmin
358a7e14dcfSSatish Balay . -tao_steptol <tol> - stop if trust region radius less than <tol>
359a7e14dcfSSatish Balay . -tao_trust0 <t> - initial trust region radius
360a7e14dcfSSatish Balay . -tao_monitor - prints function value and residual at each iteration
361a7e14dcfSSatish Balay . -tao_smonitor - same as tao_monitor, but truncates very small values
362a7e14dcfSSatish Balay . -tao_cmonitor - prints function value, residual, and constraint norm at each iteration
363a7e14dcfSSatish Balay . -tao_view_solution - prints solution vector at each iteration
364a7e14dcfSSatish Balay . -tao_view_separableobjective - prints separable objective vector at each iteration
365a7e14dcfSSatish Balay . -tao_view_step - prints step direction vector at each iteration
366a7e14dcfSSatish Balay . -tao_view_gradient - prints gradient vector at each iteration
367a7e14dcfSSatish Balay . -tao_draw_solution - graphically view solution vector at each iteration
368a7e14dcfSSatish Balay . -tao_draw_step - graphically view step vector at each iteration
369a7e14dcfSSatish Balay . -tao_draw_gradient - graphically view gradient at each iteration
370a7e14dcfSSatish Balay . -tao_fd_gradient - use gradient computed with finite differences
371f4c1ad5cSStefano Zampini . -tao_fd_hessian - use hessian computed with finite differences
372f4c1ad5cSStefano Zampini . -tao_mf_hessian - use matrix-free hessian computed with finite differences
373a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors (except those set with command line)
374441846f8SBarry Smith . -tao_view - prints information about the Tao after solving
375a7e14dcfSSatish Balay - -tao_converged_reason - prints the reason TAO stopped iterating
376a7e14dcfSSatish Balay 
377a7e14dcfSSatish Balay   Notes:
378a7e14dcfSSatish Balay   To see all options, run your program with the -help option or consult the
379a7e14dcfSSatish Balay   user's manual. Should be called after TaoCreate() but before TaoSolve()
380a7e14dcfSSatish Balay 
381a7e14dcfSSatish Balay   Level: beginner
382a7e14dcfSSatish Balay @*/
383441846f8SBarry Smith PetscErrorCode TaoSetFromOptions(Tao tao)
384a7e14dcfSSatish Balay {
385a7e14dcfSSatish Balay   PetscErrorCode ierr;
38658417fe7SBarry Smith   const TaoType  default_type = TAOLMVM;
387a7e14dcfSSatish Balay   char           type[256], monfilename[PETSC_MAX_PATH_LEN];
388a7e14dcfSSatish Balay   PetscViewer    monviewer;
389a7e14dcfSSatish Balay   PetscBool      flg;
390a7e14dcfSSatish Balay   MPI_Comm       comm;
391a7e14dcfSSatish Balay 
392a7e14dcfSSatish Balay   PetscFunctionBegin;
393441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
394a7e14dcfSSatish Balay   ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
395125ddc8aSJason Sarich 
396a7e14dcfSSatish Balay   /* So no warnings are given about unused options */
397c5929fdfSBarry Smith   ierr = PetscOptionsHasName(((PetscObject)tao)->options,((PetscObject)tao)->prefix,"-tao_ls_type",&flg);CHKERRQ(ierr);
398a7e14dcfSSatish Balay 
399a7e14dcfSSatish Balay   ierr = PetscObjectOptionsBegin((PetscObject)tao);CHKERRQ(ierr);
400a7e14dcfSSatish Balay   {
401441846f8SBarry Smith     ierr = TaoRegisterAll();CHKERRQ(ierr);
402a7e14dcfSSatish Balay     if (((PetscObject)tao)->type_name) {
403a7e14dcfSSatish Balay       default_type = ((PetscObject)tao)->type_name;
404a7e14dcfSSatish Balay     }
405a7e14dcfSSatish Balay     /* Check for type from options */
406441846f8SBarry Smith     ierr = PetscOptionsFList("-tao_type","Tao Solver type","TaoSetType",TaoList,default_type,type,256,&flg);CHKERRQ(ierr);
407a7e14dcfSSatish Balay     if (flg) {
408a7e14dcfSSatish Balay       ierr = TaoSetType(tao,type);CHKERRQ(ierr);
409a7e14dcfSSatish Balay     } else if (!((PetscObject)tao)->type_name) {
410302440fdSBarry Smith       ierr = TaoSetType(tao,default_type);CHKERRQ(ierr);
411a7e14dcfSSatish Balay     }
412a7e14dcfSSatish Balay 
4136552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_catol","Stop if constraints violations within","TaoSetConstraintTolerances",tao->catol,&tao->catol,&flg);CHKERRQ(ierr);
4146552cf8aSJason Sarich     if (flg) tao->catol_changed=PETSC_TRUE;
4156552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_crtol","Stop if relative contraint violations within","TaoSetConstraintTolerances",tao->crtol,&tao->crtol,&flg);CHKERRQ(ierr);
4166552cf8aSJason Sarich     if (flg) tao->crtol_changed=PETSC_TRUE;
4176552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_gatol","Stop if norm of gradient less than","TaoSetTolerances",tao->gatol,&tao->gatol,&flg);CHKERRQ(ierr);
4186552cf8aSJason Sarich     if (flg) tao->gatol_changed=PETSC_TRUE;
4196552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_grtol","Stop if norm of gradient divided by the function value is less than","TaoSetTolerances",tao->grtol,&tao->grtol,&flg);CHKERRQ(ierr);
4206552cf8aSJason Sarich     if (flg) tao->grtol_changed=PETSC_TRUE;
4216552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_gttol","Stop if the norm of the gradient is less than the norm of the initial gradient times tol","TaoSetTolerances",tao->gttol,&tao->gttol,&flg);CHKERRQ(ierr);
4226552cf8aSJason Sarich     if (flg) tao->gttol_changed=PETSC_TRUE;
4236552cf8aSJason Sarich     ierr = PetscOptionsInt("-tao_max_it","Stop if iteration number exceeds","TaoSetMaximumIterations",tao->max_it,&tao->max_it,&flg);CHKERRQ(ierr);
4246552cf8aSJason Sarich     if (flg) tao->max_it_changed=PETSC_TRUE;
4256552cf8aSJason Sarich     ierr = PetscOptionsInt("-tao_max_funcs","Stop if number of function evaluations exceeds","TaoSetMaximumFunctionEvaluations",tao->max_funcs,&tao->max_funcs,&flg);CHKERRQ(ierr);
4266552cf8aSJason Sarich     if (flg) tao->max_funcs_changed=PETSC_TRUE;
4276552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_fmin","Stop if function less than","TaoSetFunctionLowerBound",tao->fmin,&tao->fmin,&flg);CHKERRQ(ierr);
4286552cf8aSJason Sarich     if (flg) tao->fmin_changed=PETSC_TRUE;
4296552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_steptol","Stop if step size or trust region radius less than","",tao->steptol,&tao->steptol,&flg);CHKERRQ(ierr);
4306552cf8aSJason Sarich     if (flg) tao->steptol_changed=PETSC_TRUE;
4316552cf8aSJason Sarich     ierr = PetscOptionsReal("-tao_trust0","Initial trust region radius","TaoSetTrustRegionRadius",tao->trust0,&tao->trust0,&flg);CHKERRQ(ierr);
4326552cf8aSJason Sarich     if (flg) tao->trust0_changed=PETSC_TRUE;
433a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_solution","view solution vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
434a7e14dcfSSatish Balay     if (flg) {
435a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
436a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoSolutionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
437a7e14dcfSSatish Balay     }
438a7e14dcfSSatish Balay 
4398afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_converged_reason","Print reason for TAO converged","TaoSolve",tao->printreason,&tao->printreason,NULL);CHKERRQ(ierr);
440a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_gradient","view gradient vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
441a7e14dcfSSatish Balay     if (flg) {
442a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
443a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoGradientMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
444a7e14dcfSSatish Balay     }
445a7e14dcfSSatish Balay 
446a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_stepdirection","view step direction vector after each iteration","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
447a7e14dcfSSatish Balay     if (flg) {
448a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
449a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoStepDirectionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
450a7e14dcfSSatish Balay     }
451a7e14dcfSSatish Balay 
452a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_separableobjective","view separable objective vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
453a7e14dcfSSatish Balay     if (flg) {
454a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
455a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoSeparableObjectiveMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
456a7e14dcfSSatish Balay     }
457a7e14dcfSSatish Balay 
458a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_monitor","Use the default convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
459a7e14dcfSSatish Balay     if (flg) {
460a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
46198ea980cSBarry Smith       ierr = TaoSetMonitor(tao,TaoMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
462a7e14dcfSSatish Balay     }
463a7e14dcfSSatish Balay 
464a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_smonitor","Use the short convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
465a7e14dcfSSatish Balay     if (flg) {
466a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
467a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultSMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
468a7e14dcfSSatish Balay     }
469a7e14dcfSSatish Balay 
470a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_cmonitor","Use the default convergence monitor with constraint norm","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
471a7e14dcfSSatish Balay     if (flg) {
472a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
473a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultCMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
474a7e14dcfSSatish Balay     }
475a7e14dcfSSatish Balay 
476a7e14dcfSSatish Balay 
4778afaa268SBarry Smith     flg = PETSC_FALSE;
4788afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_cancelmonitors","cancel all monitors and call any registered destroy routines","TaoCancelMonitors",flg,&flg,NULL);CHKERRQ(ierr);
479a7e14dcfSSatish Balay     if (flg) {ierr = TaoCancelMonitors(tao);CHKERRQ(ierr);}
480a7e14dcfSSatish Balay 
4818afaa268SBarry Smith     flg = PETSC_FALSE;
4828afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_draw_solution","Plot solution vector at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr);
483a7e14dcfSSatish Balay     if (flg) {
484e882e171SHong Zhang       TaoMonitorDrawCtx drawctx;
485e882e171SHong Zhang       PetscInt          howoften = 1;
486e882e171SHong Zhang       ierr = TaoMonitorDrawCtxCreate(PetscObjectComm((PetscObject)tao),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&drawctx);CHKERRQ(ierr);
487e882e171SHong Zhang       ierr = TaoSetMonitor(tao,TaoDrawSolutionMonitor,drawctx,(PetscErrorCode (*)(void**))TaoMonitorDrawCtxDestroy);CHKERRQ(ierr);
488a7e14dcfSSatish Balay     }
489a7e14dcfSSatish Balay 
4908afaa268SBarry Smith     flg = PETSC_FALSE;
4918afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_draw_step","plots step direction at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr);
492a7e14dcfSSatish Balay     if (flg) {
49347a47007SBarry Smith       ierr = TaoSetMonitor(tao,TaoDrawStepMonitor,NULL,NULL);CHKERRQ(ierr);
494a7e14dcfSSatish Balay     }
495a7e14dcfSSatish Balay 
4968afaa268SBarry Smith     flg = PETSC_FALSE;
4978afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_draw_gradient","plots gradient at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr);
498a7e14dcfSSatish Balay     if (flg) {
499e882e171SHong Zhang       TaoMonitorDrawCtx drawctx;
500e882e171SHong Zhang       PetscInt          howoften = 1;
501e882e171SHong Zhang       ierr = TaoMonitorDrawCtxCreate(PetscObjectComm((PetscObject)tao),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&drawctx);CHKERRQ(ierr);
502e882e171SHong Zhang       ierr = TaoSetMonitor(tao,TaoDrawGradientMonitor,drawctx,(PetscErrorCode (*)(void**))TaoMonitorDrawCtxDestroy);CHKERRQ(ierr);
503a7e14dcfSSatish Balay     }
5048afaa268SBarry Smith     flg = PETSC_FALSE;
5058afaa268SBarry Smith     ierr = PetscOptionsBool("-tao_fd_gradient","compute gradient using finite differences","TaoDefaultComputeGradient",flg,&flg,NULL);CHKERRQ(ierr);
506a7e14dcfSSatish Balay     if (flg) {
50747a47007SBarry Smith       ierr = TaoSetGradientRoutine(tao,TaoDefaultComputeGradient,NULL);CHKERRQ(ierr);
508a7e14dcfSSatish Balay     }
509f4c1ad5cSStefano Zampini     flg = PETSC_FALSE;
510f4c1ad5cSStefano Zampini     ierr = PetscOptionsBool("-tao_fd_hessian","compute hessian using finite differences","TaoDefaultComputeHessian",flg,&flg,NULL);CHKERRQ(ierr);
511f4c1ad5cSStefano Zampini     if (flg) {
512f4c1ad5cSStefano Zampini       Mat H;
513f4c1ad5cSStefano Zampini 
514f4c1ad5cSStefano Zampini       ierr = MatCreate(PetscObjectComm((PetscObject)tao),&H);CHKERRQ(ierr);
515f4c1ad5cSStefano Zampini       ierr = MatSetType(H,MATAIJ);CHKERRQ(ierr);
516f4c1ad5cSStefano Zampini       ierr = TaoSetHessianRoutine(tao,H,H,TaoDefaultComputeHessian,NULL);CHKERRQ(ierr);
517f4c1ad5cSStefano Zampini       ierr = MatDestroy(&H);CHKERRQ(ierr);
518f4c1ad5cSStefano Zampini     }
519f4c1ad5cSStefano Zampini     flg = PETSC_FALSE;
520f4c1ad5cSStefano Zampini     ierr = PetscOptionsBool("-tao_mf_hessian","compute matrix-free hessian using finite differences","TaoDefaultComputeHessianMFFD",flg,&flg,NULL);CHKERRQ(ierr);
521f4c1ad5cSStefano Zampini     if (flg) {
522f4c1ad5cSStefano Zampini       Mat H;
523f4c1ad5cSStefano Zampini 
524f4c1ad5cSStefano Zampini       ierr = MatCreate(PetscObjectComm((PetscObject)tao),&H);CHKERRQ(ierr);
525f4c1ad5cSStefano Zampini       ierr = TaoSetHessianRoutine(tao,H,H,TaoDefaultComputeHessianMFFD,NULL);CHKERRQ(ierr);
526f4c1ad5cSStefano Zampini       ierr = MatDestroy(&H);CHKERRQ(ierr);
527f4c1ad5cSStefano Zampini     }
528f4c1ad5cSStefano Zampini     ierr = PetscOptionsEnum("-tao_subset_type","subset type","",TaoSubSetTypes,(PetscEnum)tao->subset_type,(PetscEnum*)&tao->subset_type,NULL);CHKERRQ(ierr);
529a7e14dcfSSatish Balay 
530a7e14dcfSSatish Balay     if (tao->ops->setfromoptions) {
5311a1499c8SBarry Smith       ierr = (*tao->ops->setfromoptions)(PetscOptionsObject,tao);CHKERRQ(ierr);
532a7e14dcfSSatish Balay     }
533a7e14dcfSSatish Balay   }
534a7e14dcfSSatish Balay   ierr = PetscOptionsEnd();CHKERRQ(ierr);
535a7e14dcfSSatish Balay   PetscFunctionReturn(0);
536a7e14dcfSSatish Balay }
537a7e14dcfSSatish Balay 
538a7e14dcfSSatish Balay /*@C
539441846f8SBarry Smith   TaoView - Prints information about the Tao
540a7e14dcfSSatish Balay 
541441846f8SBarry Smith   Collective on Tao
542a7e14dcfSSatish Balay 
543a7e14dcfSSatish Balay   InputParameters:
544441846f8SBarry Smith + tao - the Tao context
545a7e14dcfSSatish Balay - viewer - visualization context
546a7e14dcfSSatish Balay 
547a7e14dcfSSatish Balay   Options Database Key:
548a7e14dcfSSatish Balay . -tao_view - Calls TaoView() at the end of TaoSolve()
549a7e14dcfSSatish Balay 
550a7e14dcfSSatish Balay   Notes:
551a7e14dcfSSatish Balay   The available visualization contexts include
552a7e14dcfSSatish Balay +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
553a7e14dcfSSatish Balay -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
554a7e14dcfSSatish Balay          output where only the first processor opens
555a7e14dcfSSatish Balay          the file.  All other processors send their
556a7e14dcfSSatish Balay          data to the first processor to print.
557a7e14dcfSSatish Balay 
558a7e14dcfSSatish Balay   Level: beginner
559a7e14dcfSSatish Balay 
560a7e14dcfSSatish Balay .seealso: PetscViewerASCIIOpen()
561a7e14dcfSSatish Balay @*/
562441846f8SBarry Smith PetscErrorCode TaoView(Tao tao, PetscViewer viewer)
563a7e14dcfSSatish Balay {
564a7e14dcfSSatish Balay   PetscErrorCode      ierr;
565a7e14dcfSSatish Balay   PetscBool           isascii,isstring;
566441846f8SBarry Smith   const TaoType type;
56747a47007SBarry Smith 
568a7e14dcfSSatish Balay   PetscFunctionBegin;
569441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
570a7e14dcfSSatish Balay   if (!viewer) {
571a7e14dcfSSatish Balay     ierr = PetscViewerASCIIGetStdout(((PetscObject)tao)->comm,&viewer);CHKERRQ(ierr);
572a7e14dcfSSatish Balay   }
573a7e14dcfSSatish Balay   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
574a7e14dcfSSatish Balay   PetscCheckSameComm(tao,1,viewer,2);
575a7e14dcfSSatish Balay 
576a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
577a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
578a7e14dcfSSatish Balay   if (isascii) {
57963b15415SAlp Dener     PetscInt        tabs;
58063b15415SAlp Dener     ierr = PetscViewerASCIIGetTab(viewer, &tabs);CHKERRQ(ierr);
58163b15415SAlp Dener     ierr = PetscViewerASCIISetTab(viewer, ((PetscObject)tao)->tablevel);CHKERRQ(ierr);
582a7e14dcfSSatish Balay     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)tao,viewer);CHKERRQ(ierr);
583a7e14dcfSSatish Balay 
584a7e14dcfSSatish Balay     if (tao->ops->view) {
585a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
586a7e14dcfSSatish Balay       ierr = (*tao->ops->view)(tao,viewer);CHKERRQ(ierr);
587a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
588a7e14dcfSSatish Balay     }
5898d3f3ddaSAlp Dener     if (tao->linesearch) {
5908d3f3ddaSAlp Dener       ierr = TaoLineSearchView(tao->linesearch,viewer);CHKERRQ(ierr);
5918d3f3ddaSAlp Dener     }
592a7e14dcfSSatish Balay     if (tao->ksp) {
59319b5c101SAlp Dener       ierr = KSPView(tao->ksp,viewer);CHKERRQ(ierr);
59419b5c101SAlp Dener       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
595ae93cb3cSJason Sarich       ierr = PetscViewerASCIIPrintf(viewer,"total KSP iterations: %D\n",tao->ksp_tot_its);CHKERRQ(ierr);
59619b5c101SAlp Dener       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
597a7e14dcfSSatish Balay     }
59819b5c101SAlp Dener 
59919b5c101SAlp Dener     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
60019b5c101SAlp Dener 
601a7e14dcfSSatish Balay     if (tao->XL || tao->XU) {
602302440fdSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Active Set subset type: %s\n",TaoSubSetTypes[tao->subset_type]);CHKERRQ(ierr);
603a7e14dcfSSatish Balay     }
604a7e14dcfSSatish Balay 
60547a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"convergence tolerances: gatol=%g,",(double)tao->gatol);CHKERRQ(ierr);
60647a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer," steptol=%g,",(double)tao->steptol);CHKERRQ(ierr);
60747a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer," gttol=%g\n",(double)tao->gttol);CHKERRQ(ierr);
60847a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Residual in Function/Gradient:=%g\n",(double)tao->residual);CHKERRQ(ierr);
609a7e14dcfSSatish Balay 
610a7e14dcfSSatish Balay     if (tao->cnorm>0 || tao->catol>0 || tao->crtol>0){
611a7e14dcfSSatish Balay       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances:");CHKERRQ(ierr);
61247a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer," catol=%g,",(double)tao->catol);CHKERRQ(ierr);
61347a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer," crtol=%g\n",(double)tao->crtol);CHKERRQ(ierr);
61447a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Residual in Constraints:=%g\n",(double)tao->cnorm);CHKERRQ(ierr);
615a7e14dcfSSatish Balay     }
616a7e14dcfSSatish Balay 
617a7e14dcfSSatish Balay     if (tao->trust < tao->steptol){
61847a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: steptol=%g\n",(double)tao->steptol);CHKERRQ(ierr);
61947a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"Final trust region radius:=%g\n",(double)tao->trust);CHKERRQ(ierr);
620a7e14dcfSSatish Balay     }
621a7e14dcfSSatish Balay 
622a7e14dcfSSatish Balay     if (tao->fmin>-1.e25){
62347a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: function minimum=%g\n",(double)tao->fmin);CHKERRQ(ierr);
624a7e14dcfSSatish Balay     }
62547a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Objective value=%g\n",(double)tao->fc);CHKERRQ(ierr);
626a7e14dcfSSatish Balay 
62747a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"total number of iterations=%D,          ",tao->niter);CHKERRQ(ierr);
628a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPrintf(viewer,"              (max: %D)\n",tao->max_it);CHKERRQ(ierr);
629a7e14dcfSSatish Balay 
630a7e14dcfSSatish Balay     if (tao->nfuncs>0){
63147a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of function evaluations=%D,",tao->nfuncs);CHKERRQ(ierr);
63247a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"                max: %D\n",tao->max_funcs);CHKERRQ(ierr);
633a7e14dcfSSatish Balay     }
634a7e14dcfSSatish Balay     if (tao->ngrads>0){
63547a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of gradient evaluations=%D,",tao->ngrads);CHKERRQ(ierr);
63647a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"                max: %D\n",tao->max_funcs);CHKERRQ(ierr);
637a7e14dcfSSatish Balay     }
638a7e14dcfSSatish Balay     if (tao->nfuncgrads>0){
63947a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of function/gradient evaluations=%D,",tao->nfuncgrads);CHKERRQ(ierr);
64047a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    (max: %D)\n",tao->max_funcs);CHKERRQ(ierr);
641a7e14dcfSSatish Balay     }
642a7e14dcfSSatish Balay     if (tao->nhess>0){
64347a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of Hessian evaluations=%D\n",tao->nhess);CHKERRQ(ierr);
644a7e14dcfSSatish Balay     }
645a7e14dcfSSatish Balay     /*  if (tao->linear_its>0){
64647a47007SBarry Smith      ierr = PetscViewerASCIIPrintf(viewer,"  total Krylov method iterations=%D\n",tao->linear_its);CHKERRQ(ierr);
647a7e14dcfSSatish Balay      }*/
648a7e14dcfSSatish Balay     if (tao->nconstraints>0){
64947a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of constraint function evaluations=%D\n",tao->nconstraints);CHKERRQ(ierr);
650a7e14dcfSSatish Balay     }
651a7e14dcfSSatish Balay     if (tao->njac>0){
65247a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of Jacobian evaluations=%D\n",tao->njac);CHKERRQ(ierr);
653a7e14dcfSSatish Balay     }
654a7e14dcfSSatish Balay 
655a7e14dcfSSatish Balay     if (tao->reason>0){
656a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer,    "Solution converged: ");CHKERRQ(ierr);
657a7e14dcfSSatish Balay       switch (tao->reason) {
658a7e14dcfSSatish Balay       case TAO_CONVERGED_GATOL:
659a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)|| <= gatol\n");CHKERRQ(ierr);
660a7e14dcfSSatish Balay         break;
661a7e14dcfSSatish Balay       case TAO_CONVERGED_GRTOL:
662a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/|f(X)| <= grtol\n");CHKERRQ(ierr);
663a7e14dcfSSatish Balay         break;
664a7e14dcfSSatish Balay       case TAO_CONVERGED_GTTOL:
665a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/||g(X0)|| <= gttol\n");CHKERRQ(ierr);
666a7e14dcfSSatish Balay         break;
667a7e14dcfSSatish Balay       case TAO_CONVERGED_STEPTOL:
668a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," Steptol -- step size small\n");CHKERRQ(ierr);
669a7e14dcfSSatish Balay         break;
670a7e14dcfSSatish Balay       case TAO_CONVERGED_MINF:
671a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," Minf --  f < fmin\n");CHKERRQ(ierr);
672a7e14dcfSSatish Balay         break;
673a7e14dcfSSatish Balay       case TAO_CONVERGED_USER:
674a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr);
675a7e14dcfSSatish Balay         break;
676a7e14dcfSSatish Balay       default:
677a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
678a7e14dcfSSatish Balay         break;
679a7e14dcfSSatish Balay       }
680a7e14dcfSSatish Balay 
681a7e14dcfSSatish Balay     } else {
68247cfc4faSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Solver terminated: %d",tao->reason);CHKERRQ(ierr);
683a7e14dcfSSatish Balay       switch (tao->reason) {
684a7e14dcfSSatish Balay       case TAO_DIVERGED_MAXITS:
68547a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Maximum Iterations\n");CHKERRQ(ierr);
686a7e14dcfSSatish Balay         break;
687a7e14dcfSSatish Balay       case TAO_DIVERGED_NAN:
68847a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," NAN or Inf encountered\n");CHKERRQ(ierr);
689a7e14dcfSSatish Balay         break;
690a7e14dcfSSatish Balay       case TAO_DIVERGED_MAXFCN:
69147a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Maximum Function Evaluations\n");CHKERRQ(ierr);
692a7e14dcfSSatish Balay         break;
693a7e14dcfSSatish Balay       case TAO_DIVERGED_LS_FAILURE:
69447a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Line Search Failure\n");CHKERRQ(ierr);
695a7e14dcfSSatish Balay         break;
696a7e14dcfSSatish Balay       case TAO_DIVERGED_TR_REDUCTION:
69747a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Trust Region too small\n");CHKERRQ(ierr);
698a7e14dcfSSatish Balay         break;
699a7e14dcfSSatish Balay       case TAO_DIVERGED_USER:
70047a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr);
701a7e14dcfSSatish Balay         break;
702a7e14dcfSSatish Balay       default:
703a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
704a7e14dcfSSatish Balay         break;
705a7e14dcfSSatish Balay       }
706a7e14dcfSSatish Balay     }
707a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
70863b15415SAlp Dener     ierr = PetscViewerASCIISetTab(viewer, tabs); CHKERRQ(ierr);
709a7e14dcfSSatish Balay   } else if (isstring) {
710a7e14dcfSSatish Balay     ierr = TaoGetType(tao,&type);CHKERRQ(ierr);
711a7e14dcfSSatish Balay     ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr);
712a7e14dcfSSatish Balay   }
713a7e14dcfSSatish Balay   PetscFunctionReturn(0);
714a7e14dcfSSatish Balay }
715a7e14dcfSSatish Balay 
716a7e14dcfSSatish Balay /*@
717a7e14dcfSSatish Balay   TaoSetTolerances - Sets parameters used in TAO convergence tests
718a7e14dcfSSatish Balay 
719441846f8SBarry Smith   Logically collective on Tao
720a7e14dcfSSatish Balay 
721a7e14dcfSSatish Balay   Input Parameters:
722441846f8SBarry Smith + tao - the Tao context
723a7e14dcfSSatish Balay . gatol - stop if norm of gradient is less than this
724a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this
725a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by this factor
726a7e14dcfSSatish Balay 
727a7e14dcfSSatish Balay   Options Database Keys:
728e52336cbSBarry Smith + -tao_gatol <gatol> - Sets gatol
729a7e14dcfSSatish Balay . -tao_grtol <grtol> - Sets grtol
730a7e14dcfSSatish Balay - -tao_gttol <gttol> - Sets gttol
731a7e14dcfSSatish Balay 
732a7e14dcfSSatish Balay   Stopping Criteria:
733a7e14dcfSSatish Balay $ ||g(X)||                            <= gatol
734a7e14dcfSSatish Balay $ ||g(X)|| / |f(X)|                   <= grtol
735a7e14dcfSSatish Balay $ ||g(X)|| / ||g(X0)||                <= gttol
736a7e14dcfSSatish Balay 
737a7e14dcfSSatish Balay   Notes:
738a7e14dcfSSatish Balay   Use PETSC_DEFAULT to leave one or more tolerances unchanged.
739a7e14dcfSSatish Balay 
740a7e14dcfSSatish Balay   Level: beginner
741a7e14dcfSSatish Balay 
742a7e14dcfSSatish Balay .seealso: TaoGetTolerances()
743a7e14dcfSSatish Balay 
744a7e14dcfSSatish Balay @*/
745e52336cbSBarry Smith PetscErrorCode TaoSetTolerances(Tao tao, PetscReal gatol, PetscReal grtol, PetscReal gttol)
746a7e14dcfSSatish Balay {
747a7e14dcfSSatish Balay   PetscErrorCode ierr;
74847a47007SBarry Smith 
749a7e14dcfSSatish Balay   PetscFunctionBegin;
750441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
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 /*@
78258417fe7SBarry Smith   TaoSetConstraintTolerances - Sets constraint tolerance parameters used in TAO  convergence tests
783a7e14dcfSSatish Balay 
784441846f8SBarry Smith   Logically collective on Tao
785a7e14dcfSSatish Balay 
786a7e14dcfSSatish Balay   Input Parameters:
787441846f8SBarry Smith + tao - the Tao context
788e52336cbSBarry Smith . catol - absolute constraint tolerance, constraint norm must be less than catol for used for gatol convergence criteria
789e52336cbSBarry Smith - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for gatol, gttol convergence criteria
790a7e14dcfSSatish Balay 
791a7e14dcfSSatish Balay   Options Database Keys:
792a7e14dcfSSatish Balay + -tao_catol <catol> - Sets catol
793a7e14dcfSSatish Balay - -tao_crtol <crtol> - Sets crtol
794a7e14dcfSSatish Balay 
7956552cf8aSJason Sarich   Notes:
7966552cf8aSJason Sarich   Use PETSC_DEFAULT to leave any tolerance unchanged.
7976552cf8aSJason Sarich 
798a7e14dcfSSatish Balay   Level: intermediate
799a7e14dcfSSatish Balay 
80058417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoGetConstraintTolerances(), TaoSetTolerances()
801a7e14dcfSSatish Balay 
802a7e14dcfSSatish Balay @*/
803441846f8SBarry Smith PetscErrorCode TaoSetConstraintTolerances(Tao tao, PetscReal catol, PetscReal crtol)
804a7e14dcfSSatish Balay {
805a7e14dcfSSatish Balay   PetscErrorCode ierr;
80647a47007SBarry Smith 
807a7e14dcfSSatish Balay   PetscFunctionBegin;
808441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
809a7e14dcfSSatish Balay 
810a7e14dcfSSatish Balay   if (catol != PETSC_DEFAULT) {
811a7e14dcfSSatish Balay     if (catol<0) {
812955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative catol -- ignored.\n");CHKERRQ(ierr);
813a7e14dcfSSatish Balay     } else {
814a7e14dcfSSatish Balay       tao->catol = PetscMax(0,catol);
8156552cf8aSJason Sarich       tao->catol_changed=PETSC_TRUE;
816a7e14dcfSSatish Balay     }
817a7e14dcfSSatish Balay   }
818a7e14dcfSSatish Balay 
819a7e14dcfSSatish Balay   if (crtol != PETSC_DEFAULT) {
820a7e14dcfSSatish Balay     if (crtol<0) {
821955c1f14SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative crtol -- ignored.\n");CHKERRQ(ierr);
822a7e14dcfSSatish Balay     } else {
823a7e14dcfSSatish Balay       tao->crtol = PetscMax(0,crtol);
8246552cf8aSJason Sarich       tao->crtol_changed=PETSC_TRUE;
825a7e14dcfSSatish Balay     }
826a7e14dcfSSatish Balay   }
827a7e14dcfSSatish Balay   PetscFunctionReturn(0);
828a7e14dcfSSatish Balay }
829a7e14dcfSSatish Balay 
83058417fe7SBarry Smith /*@
83158417fe7SBarry Smith   TaoGetConstraintTolerances - Gets constraint tolerance parameters used in TAO  convergence tests
83258417fe7SBarry Smith 
83358417fe7SBarry Smith   Not ollective
83458417fe7SBarry Smith 
83558417fe7SBarry Smith   Input Parameter:
83658417fe7SBarry Smith . tao - the Tao context
83758417fe7SBarry Smith 
83858417fe7SBarry Smith   Output Parameter:
839e52336cbSBarry Smith + catol - absolute constraint tolerance, constraint norm must be less than catol for used for gatol convergence criteria
840e52336cbSBarry Smith - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for gatol, gttol convergence criteria
84158417fe7SBarry Smith 
84258417fe7SBarry Smith   Level: intermediate
84358417fe7SBarry Smith 
84458417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoSetTolerances(), TaoSetConstraintTolerances()
84558417fe7SBarry Smith 
84658417fe7SBarry Smith @*/
84758417fe7SBarry Smith PetscErrorCode TaoGetConstraintTolerances(Tao tao, PetscReal *catol, PetscReal *crtol)
84858417fe7SBarry Smith {
84958417fe7SBarry Smith   PetscFunctionBegin;
85058417fe7SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
85158417fe7SBarry Smith   if (catol) *catol = tao->catol;
85258417fe7SBarry Smith   if (crtol) *crtol = tao->crtol;
85358417fe7SBarry Smith   PetscFunctionReturn(0);
85458417fe7SBarry Smith }
85558417fe7SBarry Smith 
856a7e14dcfSSatish Balay /*@
857a7e14dcfSSatish Balay    TaoSetFunctionLowerBound - Sets a bound on the solution objective value.
858a7e14dcfSSatish Balay    When an approximate solution with an objective value below this number
859a7e14dcfSSatish Balay    has been found, the solver will terminate.
860a7e14dcfSSatish Balay 
861441846f8SBarry Smith    Logically Collective on Tao
862a7e14dcfSSatish Balay 
863a7e14dcfSSatish Balay    Input Parameters:
864441846f8SBarry Smith +  tao - the Tao solver context
865a7e14dcfSSatish Balay -  fmin - the tolerance
866a7e14dcfSSatish Balay 
867a7e14dcfSSatish Balay    Options Database Keys:
868a7e14dcfSSatish Balay .    -tao_fmin <fmin> - sets the minimum function value
869a7e14dcfSSatish Balay 
870a7e14dcfSSatish Balay    Level: intermediate
871a7e14dcfSSatish Balay 
872a7e14dcfSSatish Balay .seealso: TaoSetTolerances()
873a7e14dcfSSatish Balay @*/
874441846f8SBarry Smith PetscErrorCode TaoSetFunctionLowerBound(Tao tao,PetscReal fmin)
875a7e14dcfSSatish Balay {
876a7e14dcfSSatish Balay   PetscFunctionBegin;
877441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
878a7e14dcfSSatish Balay   tao->fmin = fmin;
8796552cf8aSJason Sarich   tao->fmin_changed=PETSC_TRUE;
880a7e14dcfSSatish Balay   PetscFunctionReturn(0);
881a7e14dcfSSatish Balay }
882a7e14dcfSSatish Balay 
883a7e14dcfSSatish Balay /*@
8848e96d397SJason Sarich    TaoGetFunctionLowerBound - Gets the bound on the solution objective value.
885a7e14dcfSSatish Balay    When an approximate solution with an objective value below this number
886a7e14dcfSSatish Balay    has been found, the solver will terminate.
887a7e14dcfSSatish Balay 
888441846f8SBarry Smith    Not collective on Tao
889a7e14dcfSSatish Balay 
890a7e14dcfSSatish Balay    Input Parameters:
891441846f8SBarry Smith .  tao - the Tao solver context
892a7e14dcfSSatish Balay 
893a7e14dcfSSatish Balay    OutputParameters:
894a7e14dcfSSatish Balay .  fmin - the minimum function value
895a7e14dcfSSatish Balay 
896a7e14dcfSSatish Balay    Level: intermediate
897a7e14dcfSSatish Balay 
898a7e14dcfSSatish Balay .seealso: TaoSetFunctionLowerBound()
899a7e14dcfSSatish Balay @*/
900441846f8SBarry Smith PetscErrorCode TaoGetFunctionLowerBound(Tao tao,PetscReal *fmin)
901a7e14dcfSSatish Balay {
902a7e14dcfSSatish Balay   PetscFunctionBegin;
903441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
904a7e14dcfSSatish Balay   *fmin = tao->fmin;
905a7e14dcfSSatish Balay   PetscFunctionReturn(0);
906a7e14dcfSSatish Balay }
907a7e14dcfSSatish Balay 
908a7e14dcfSSatish Balay /*@
909a7e14dcfSSatish Balay    TaoSetMaximumFunctionEvaluations - Sets a maximum number of
910a7e14dcfSSatish Balay    function evaluations.
911a7e14dcfSSatish Balay 
912441846f8SBarry Smith    Logically Collective on Tao
913a7e14dcfSSatish Balay 
914a7e14dcfSSatish Balay    Input Parameters:
915441846f8SBarry Smith +  tao - the Tao solver context
916a7e14dcfSSatish Balay -  nfcn - the maximum number of function evaluations (>=0)
917a7e14dcfSSatish Balay 
918a7e14dcfSSatish Balay    Options Database Keys:
919a7e14dcfSSatish Balay .    -tao_max_funcs <nfcn> - sets the maximum number of function evaluations
920a7e14dcfSSatish Balay 
921a7e14dcfSSatish Balay    Level: intermediate
922a7e14dcfSSatish Balay 
923a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumIterations()
924a7e14dcfSSatish Balay @*/
925a7e14dcfSSatish Balay 
926441846f8SBarry Smith PetscErrorCode TaoSetMaximumFunctionEvaluations(Tao tao,PetscInt nfcn)
927a7e14dcfSSatish Balay {
928a7e14dcfSSatish Balay   PetscFunctionBegin;
929441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
93047a47007SBarry Smith   tao->max_funcs = PetscMax(0,nfcn);
9316552cf8aSJason Sarich   tao->max_funcs_changed=PETSC_TRUE;
932a7e14dcfSSatish Balay   PetscFunctionReturn(0);
933a7e14dcfSSatish Balay }
934a7e14dcfSSatish Balay 
935a7e14dcfSSatish Balay /*@
936a7e14dcfSSatish Balay    TaoGetMaximumFunctionEvaluations - Sets a maximum number of
937a7e14dcfSSatish Balay    function evaluations.
938a7e14dcfSSatish Balay 
939a7e14dcfSSatish Balay    Not Collective
940a7e14dcfSSatish Balay 
941a7e14dcfSSatish Balay    Input Parameters:
942441846f8SBarry Smith .  tao - the Tao solver context
943a7e14dcfSSatish Balay 
944a7e14dcfSSatish Balay    Output Parameters:
945a7e14dcfSSatish Balay .  nfcn - the maximum number of function evaluations
946a7e14dcfSSatish Balay 
947a7e14dcfSSatish Balay    Level: intermediate
948a7e14dcfSSatish Balay 
949a7e14dcfSSatish Balay .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumIterations()
950a7e14dcfSSatish Balay @*/
951a7e14dcfSSatish Balay 
952441846f8SBarry Smith PetscErrorCode TaoGetMaximumFunctionEvaluations(Tao tao,PetscInt *nfcn)
953a7e14dcfSSatish Balay {
954a7e14dcfSSatish Balay   PetscFunctionBegin;
955441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
956a7e14dcfSSatish Balay   *nfcn = tao->max_funcs;
957a7e14dcfSSatish Balay   PetscFunctionReturn(0);
958a7e14dcfSSatish Balay }
959a7e14dcfSSatish Balay 
960770232b9SCe Qin /*@
961770232b9SCe Qin    TaoGetCurrentFunctionEvaluations - Get current number of
962770232b9SCe Qin    function evaluations.
963770232b9SCe Qin 
964770232b9SCe Qin    Not Collective
965770232b9SCe Qin 
966770232b9SCe Qin    Input Parameters:
967770232b9SCe Qin .  tao - the Tao solver context
968770232b9SCe Qin 
969770232b9SCe Qin    Output Parameters:
970770232b9SCe Qin .  nfuncs - the current number of function evaluations
971770232b9SCe Qin 
972770232b9SCe Qin    Level: intermediate
973770232b9SCe Qin 
974770232b9SCe Qin .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumFunctionEvaluations(), TaoGetMaximumIterations()
975770232b9SCe Qin @*/
976770232b9SCe Qin 
977770232b9SCe Qin PetscErrorCode TaoGetCurrentFunctionEvaluations(Tao tao,PetscInt *nfuncs)
978770232b9SCe Qin {
979770232b9SCe Qin   PetscFunctionBegin;
980770232b9SCe Qin   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
981770232b9SCe Qin   *nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads);
982770232b9SCe Qin   PetscFunctionReturn(0);
983770232b9SCe Qin }
984770232b9SCe Qin 
985a7e14dcfSSatish Balay /*@
986a7e14dcfSSatish Balay    TaoSetMaximumIterations - Sets a maximum number of iterates.
987a7e14dcfSSatish Balay 
988441846f8SBarry Smith    Logically Collective on Tao
989a7e14dcfSSatish Balay 
990a7e14dcfSSatish Balay    Input Parameters:
991441846f8SBarry Smith +  tao - the Tao solver context
992a7e14dcfSSatish Balay -  maxits - the maximum number of iterates (>=0)
993a7e14dcfSSatish Balay 
994a7e14dcfSSatish Balay    Options Database Keys:
995a7e14dcfSSatish Balay .    -tao_max_it <its> - sets the maximum number of iterations
996a7e14dcfSSatish Balay 
997a7e14dcfSSatish Balay    Level: intermediate
998a7e14dcfSSatish Balay 
999a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumFunctionEvaluations()
1000a7e14dcfSSatish Balay @*/
1001441846f8SBarry Smith PetscErrorCode TaoSetMaximumIterations(Tao tao,PetscInt maxits)
1002a7e14dcfSSatish Balay {
1003a7e14dcfSSatish Balay   PetscFunctionBegin;
1004441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
100547a47007SBarry Smith   tao->max_it = PetscMax(0,maxits);
10066552cf8aSJason Sarich   tao->max_it_changed=PETSC_TRUE;
1007a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1008a7e14dcfSSatish Balay }
1009a7e14dcfSSatish Balay 
1010a7e14dcfSSatish Balay /*@
1011a7e14dcfSSatish Balay    TaoGetMaximumIterations - Sets a maximum number of iterates.
1012a7e14dcfSSatish Balay 
1013a7e14dcfSSatish Balay    Not Collective
1014a7e14dcfSSatish Balay 
1015a7e14dcfSSatish Balay    Input Parameters:
1016441846f8SBarry Smith .  tao - the Tao solver context
1017a7e14dcfSSatish Balay 
1018a7e14dcfSSatish Balay    Output Parameters:
1019a7e14dcfSSatish Balay .  maxits - the maximum number of iterates
1020a7e14dcfSSatish Balay 
1021a7e14dcfSSatish Balay    Level: intermediate
1022a7e14dcfSSatish Balay 
1023a7e14dcfSSatish Balay .seealso: TaoSetMaximumIterations(), TaoGetMaximumFunctionEvaluations()
1024a7e14dcfSSatish Balay @*/
1025441846f8SBarry Smith PetscErrorCode TaoGetMaximumIterations(Tao tao,PetscInt *maxits)
1026a7e14dcfSSatish Balay {
1027a7e14dcfSSatish Balay   PetscFunctionBegin;
1028441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1029a7e14dcfSSatish Balay   *maxits = tao->max_it;
1030a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1031a7e14dcfSSatish Balay }
1032a7e14dcfSSatish Balay 
1033a7e14dcfSSatish Balay /*@
1034a7e14dcfSSatish Balay    TaoSetInitialTrustRegionRadius - Sets the initial trust region radius.
1035a7e14dcfSSatish Balay 
1036441846f8SBarry Smith    Logically collective on Tao
1037a7e14dcfSSatish Balay 
1038a7e14dcfSSatish Balay    Input Parameter:
1039a7e14dcfSSatish Balay +  tao - a TAO optimization solver
1040a7e14dcfSSatish Balay -  radius - the trust region radius
1041a7e14dcfSSatish Balay 
1042a7e14dcfSSatish Balay    Level: intermediate
1043a7e14dcfSSatish Balay 
1044a7e14dcfSSatish Balay    Options Database Key:
1045a7e14dcfSSatish Balay .  -tao_trust0 <t0> - sets initial trust region radius
1046a7e14dcfSSatish Balay 
1047a7e14dcfSSatish Balay .seealso: TaoGetTrustRegionRadius(), TaoSetTrustRegionTolerance()
1048a7e14dcfSSatish Balay @*/
1049441846f8SBarry Smith PetscErrorCode TaoSetInitialTrustRegionRadius(Tao tao, PetscReal radius)
1050a7e14dcfSSatish Balay {
1051a7e14dcfSSatish Balay   PetscFunctionBegin;
1052441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1053a7e14dcfSSatish Balay   tao->trust0 = PetscMax(0.0,radius);
10546552cf8aSJason Sarich   tao->trust0_changed=PETSC_TRUE;
1055a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1056a7e14dcfSSatish Balay }
1057a7e14dcfSSatish Balay 
1058a7e14dcfSSatish Balay /*@
1059a7e14dcfSSatish Balay    TaoGetInitialTrustRegionRadius - Sets the initial trust region radius.
1060a7e14dcfSSatish Balay 
1061a7e14dcfSSatish Balay    Not Collective
1062a7e14dcfSSatish Balay 
1063a7e14dcfSSatish Balay    Input Parameter:
1064a7e14dcfSSatish Balay .  tao - a TAO optimization solver
1065a7e14dcfSSatish Balay 
1066a7e14dcfSSatish Balay    Output Parameter:
1067a7e14dcfSSatish Balay .  radius - the trust region radius
1068a7e14dcfSSatish Balay 
1069a7e14dcfSSatish Balay    Level: intermediate
1070a7e14dcfSSatish Balay 
1071a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetCurrentTrustRegionRadius()
1072a7e14dcfSSatish Balay @*/
1073441846f8SBarry Smith PetscErrorCode TaoGetInitialTrustRegionRadius(Tao tao, PetscReal *radius)
1074a7e14dcfSSatish Balay {
1075a7e14dcfSSatish Balay   PetscFunctionBegin;
1076441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1077a7e14dcfSSatish Balay   *radius = tao->trust0;
1078a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1079a7e14dcfSSatish Balay }
1080a7e14dcfSSatish Balay 
1081a7e14dcfSSatish Balay /*@
1082a7e14dcfSSatish Balay    TaoGetCurrentTrustRegionRadius - Gets the current trust region radius.
1083a7e14dcfSSatish Balay 
1084a7e14dcfSSatish Balay    Not Collective
1085a7e14dcfSSatish Balay 
1086a7e14dcfSSatish Balay    Input Parameter:
1087a7e14dcfSSatish Balay .  tao - a TAO optimization solver
1088a7e14dcfSSatish Balay 
1089a7e14dcfSSatish Balay    Output Parameter:
1090a7e14dcfSSatish Balay .  radius - the trust region radius
1091a7e14dcfSSatish Balay 
1092a7e14dcfSSatish Balay    Level: intermediate
1093a7e14dcfSSatish Balay 
1094a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetInitialTrustRegionRadius()
1095a7e14dcfSSatish Balay @*/
1096441846f8SBarry Smith PetscErrorCode TaoGetCurrentTrustRegionRadius(Tao tao, PetscReal *radius)
1097a7e14dcfSSatish Balay {
1098a7e14dcfSSatish Balay   PetscFunctionBegin;
1099441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1100a7e14dcfSSatish Balay   *radius = tao->trust;
1101a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1102a7e14dcfSSatish Balay }
1103a7e14dcfSSatish Balay 
1104a7e14dcfSSatish Balay /*@
1105a7e14dcfSSatish Balay   TaoGetTolerances - gets the current values of tolerances
1106a7e14dcfSSatish Balay 
1107a7e14dcfSSatish Balay   Not Collective
1108a7e14dcfSSatish Balay 
1109a7e14dcfSSatish Balay   Input Parameters:
1110441846f8SBarry Smith . tao - the Tao context
1111a7e14dcfSSatish Balay 
1112a7e14dcfSSatish Balay   Output Parameters:
1113e52336cbSBarry Smith + gatol - stop if norm of gradient is less than this
1114a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this
1115a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by a this factor
1116a7e14dcfSSatish Balay 
111747a47007SBarry Smith   Note: NULL can be used as an argument if not all tolerances values are needed
1118a7e14dcfSSatish Balay 
1119a7e14dcfSSatish Balay .seealso TaoSetTolerances()
1120a7e14dcfSSatish Balay 
1121a7e14dcfSSatish Balay   Level: intermediate
1122a7e14dcfSSatish Balay @*/
1123e52336cbSBarry Smith PetscErrorCode TaoGetTolerances(Tao tao, PetscReal *gatol, PetscReal *grtol, PetscReal *gttol)
1124a7e14dcfSSatish Balay {
1125a7e14dcfSSatish Balay   PetscFunctionBegin;
1126441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1127a7e14dcfSSatish Balay   if (gatol) *gatol=tao->gatol;
1128a7e14dcfSSatish Balay   if (grtol) *grtol=tao->grtol;
1129a7e14dcfSSatish Balay   if (gttol) *gttol=tao->gttol;
1130a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1131a7e14dcfSSatish Balay }
1132a7e14dcfSSatish Balay 
1133a7e14dcfSSatish Balay /*@
1134a7e14dcfSSatish Balay   TaoGetKSP - Gets the linear solver used by the optimization solver.
1135a7e14dcfSSatish Balay   Application writers should use TaoGetKSP if they need direct access
1136a7e14dcfSSatish Balay   to the PETSc KSP object.
1137a7e14dcfSSatish Balay 
1138a7e14dcfSSatish Balay   Not Collective
1139a7e14dcfSSatish Balay 
1140a7e14dcfSSatish Balay    Input Parameters:
1141a7e14dcfSSatish Balay .  tao - the TAO solver
1142a7e14dcfSSatish Balay 
1143a7e14dcfSSatish Balay    Output Parameters:
1144a7e14dcfSSatish Balay .  ksp - the KSP linear solver used in the optimization solver
1145a7e14dcfSSatish Balay 
1146a7e14dcfSSatish Balay    Level: intermediate
1147a7e14dcfSSatish Balay 
1148a7e14dcfSSatish Balay @*/
1149441846f8SBarry Smith PetscErrorCode TaoGetKSP(Tao tao, KSP *ksp)
115047a47007SBarry Smith {
1151a7e14dcfSSatish Balay   PetscFunctionBegin;
1152a7e14dcfSSatish Balay   *ksp = tao->ksp;
1153a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1154a7e14dcfSSatish Balay }
1155a7e14dcfSSatish Balay 
1156025e9500SJason Sarich /*@
1157025e9500SJason Sarich    TaoGetLinearSolveIterations - Gets the total number of linear iterations
1158025e9500SJason Sarich    used by the TAO solver
1159025e9500SJason Sarich 
1160025e9500SJason Sarich    Not Collective
1161025e9500SJason Sarich 
1162025e9500SJason Sarich    Input Parameter:
1163025e9500SJason Sarich .  tao - TAO context
1164025e9500SJason Sarich 
1165025e9500SJason Sarich    Output Parameter:
1166025e9500SJason Sarich .  lits - number of linear iterations
1167025e9500SJason Sarich 
1168025e9500SJason Sarich    Notes:
1169025e9500SJason Sarich    This counter is reset to zero for each successive call to TaoSolve()
1170025e9500SJason Sarich 
1171025e9500SJason Sarich    Level: intermediate
1172025e9500SJason Sarich 
1173025e9500SJason Sarich .keywords: TAO
1174025e9500SJason Sarich 
1175025e9500SJason Sarich .seealso:  TaoGetKSP()
1176025e9500SJason Sarich @*/
1177025e9500SJason Sarich PetscErrorCode  TaoGetLinearSolveIterations(Tao tao,PetscInt *lits)
1178025e9500SJason Sarich {
1179025e9500SJason Sarich   PetscFunctionBegin;
1180025e9500SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1181025e9500SJason Sarich   PetscValidIntPointer(lits,2);
11822d9aa51bSJason Sarich   *lits = tao->ksp_tot_its;
1183025e9500SJason Sarich   PetscFunctionReturn(0);
1184025e9500SJason Sarich }
1185025e9500SJason Sarich 
1186a7e14dcfSSatish Balay /*@
1187a7e14dcfSSatish Balay   TaoGetLineSearch - Gets the line search used by the optimization solver.
1188a7e14dcfSSatish Balay   Application writers should use TaoGetLineSearch if they need direct access
1189a7e14dcfSSatish Balay   to the TaoLineSearch object.
1190a7e14dcfSSatish Balay 
1191a7e14dcfSSatish Balay   Not Collective
1192a7e14dcfSSatish Balay 
1193a7e14dcfSSatish Balay    Input Parameters:
1194a7e14dcfSSatish Balay .  tao - the TAO solver
1195a7e14dcfSSatish Balay 
1196a7e14dcfSSatish Balay    Output Parameters:
1197a7e14dcfSSatish Balay .  ls - the line search used in the optimization solver
1198a7e14dcfSSatish Balay 
1199a7e14dcfSSatish Balay    Level: intermediate
1200a7e14dcfSSatish Balay 
1201a7e14dcfSSatish Balay @*/
1202441846f8SBarry Smith PetscErrorCode TaoGetLineSearch(Tao tao, TaoLineSearch *ls)
120347a47007SBarry Smith {
1204a7e14dcfSSatish Balay   PetscFunctionBegin;
1205a7e14dcfSSatish Balay   *ls = tao->linesearch;
1206a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1207a7e14dcfSSatish Balay }
1208a7e14dcfSSatish Balay 
1209a7e14dcfSSatish Balay /*@
1210a7e14dcfSSatish Balay   TaoAddLineSearchCounts - Adds the number of function evaluations spent
1211a7e14dcfSSatish Balay   in the line search to the running total.
1212a7e14dcfSSatish Balay 
1213a7e14dcfSSatish Balay    Input Parameters:
1214a7e14dcfSSatish Balay +  tao - the TAO solver
1215a7e14dcfSSatish Balay -  ls - the line search used in the optimization solver
1216a7e14dcfSSatish Balay 
1217a7e14dcfSSatish Balay    Level: developer
1218a7e14dcfSSatish Balay 
1219a7e14dcfSSatish Balay .seealso: TaoLineSearchApply()
1220a7e14dcfSSatish Balay @*/
1221441846f8SBarry Smith PetscErrorCode TaoAddLineSearchCounts(Tao tao)
122247a47007SBarry Smith {
1223a7e14dcfSSatish Balay   PetscErrorCode ierr;
1224a7e14dcfSSatish Balay   PetscBool      flg;
1225a7e14dcfSSatish Balay   PetscInt       nfeval,ngeval,nfgeval;
122647a47007SBarry Smith 
1227a7e14dcfSSatish Balay   PetscFunctionBegin;
1228441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1229a7e14dcfSSatish Balay   if (tao->linesearch) {
1230302440fdSBarry Smith     ierr = TaoLineSearchIsUsingTaoRoutines(tao->linesearch,&flg);CHKERRQ(ierr);
123194ae4db5SBarry Smith     if (!flg) {
123247a47007SBarry Smith       ierr = TaoLineSearchGetNumberFunctionEvaluations(tao->linesearch,&nfeval,&ngeval,&nfgeval);CHKERRQ(ierr);
1233a7e14dcfSSatish Balay       tao->nfuncs+=nfeval;
1234a7e14dcfSSatish Balay       tao->ngrads+=ngeval;
1235a7e14dcfSSatish Balay       tao->nfuncgrads+=nfgeval;
1236a7e14dcfSSatish Balay     }
1237a7e14dcfSSatish Balay   }
1238a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1239a7e14dcfSSatish Balay }
1240a7e14dcfSSatish Balay 
1241a7e14dcfSSatish Balay /*@
1242a7e14dcfSSatish Balay   TaoGetSolutionVector - Returns the vector with the current TAO solution
1243a7e14dcfSSatish Balay 
1244a7e14dcfSSatish Balay   Not Collective
1245a7e14dcfSSatish Balay 
1246a7e14dcfSSatish Balay   Input Parameter:
1247441846f8SBarry Smith . tao - the Tao context
1248a7e14dcfSSatish Balay 
1249a7e14dcfSSatish Balay   Output Parameter:
1250a7e14dcfSSatish Balay . X - the current solution
1251a7e14dcfSSatish Balay 
1252a7e14dcfSSatish Balay   Level: intermediate
1253a7e14dcfSSatish Balay 
1254a7e14dcfSSatish Balay   Note:  The returned vector will be the same object that was passed into TaoSetInitialVector()
1255a7e14dcfSSatish Balay @*/
1256441846f8SBarry Smith PetscErrorCode TaoGetSolutionVector(Tao tao, Vec *X)
1257a7e14dcfSSatish Balay {
1258a7e14dcfSSatish Balay   PetscFunctionBegin;
1259441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1260a7e14dcfSSatish Balay   *X = tao->solution;
1261a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1262a7e14dcfSSatish Balay }
1263a7e14dcfSSatish Balay 
1264a7e14dcfSSatish Balay /*@
1265a7e14dcfSSatish Balay   TaoGetGradientVector - Returns the vector with the current TAO gradient
1266a7e14dcfSSatish Balay 
1267a7e14dcfSSatish Balay   Not Collective
1268a7e14dcfSSatish Balay 
1269a7e14dcfSSatish Balay   Input Parameter:
1270441846f8SBarry Smith . tao - the Tao context
1271a7e14dcfSSatish Balay 
1272a7e14dcfSSatish Balay   Output Parameter:
1273a7e14dcfSSatish Balay . G - the current solution
1274a7e14dcfSSatish Balay 
1275a7e14dcfSSatish Balay   Level: intermediate
1276a7e14dcfSSatish Balay @*/
1277441846f8SBarry Smith PetscErrorCode TaoGetGradientVector(Tao tao, Vec *G)
1278a7e14dcfSSatish Balay {
1279a7e14dcfSSatish Balay   PetscFunctionBegin;
1280441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1281a7e14dcfSSatish Balay   *G = tao->gradient;
1282a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1283a7e14dcfSSatish Balay }
1284a7e14dcfSSatish Balay 
1285a7e14dcfSSatish Balay /*@
1286a7e14dcfSSatish Balay    TaoResetStatistics - Initialize the statistics used by TAO for all of the solvers.
1287a7e14dcfSSatish Balay    These statistics include the iteration number, residual norms, and convergence status.
1288a7e14dcfSSatish Balay    This routine gets called before solving each optimization problem.
1289a7e14dcfSSatish Balay 
1290441846f8SBarry Smith    Collective on Tao
1291a7e14dcfSSatish Balay 
1292a7e14dcfSSatish Balay    Input Parameters:
1293441846f8SBarry Smith .  solver - the Tao context
1294a7e14dcfSSatish Balay 
1295a7e14dcfSSatish Balay    Level: developer
1296a7e14dcfSSatish Balay 
1297a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
1298a7e14dcfSSatish Balay @*/
1299441846f8SBarry Smith PetscErrorCode TaoResetStatistics(Tao tao)
1300a7e14dcfSSatish Balay {
1301a7e14dcfSSatish Balay   PetscFunctionBegin;
1302441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1303a7e14dcfSSatish Balay   tao->niter        = 0;
1304a7e14dcfSSatish Balay   tao->nfuncs       = 0;
1305a7e14dcfSSatish Balay   tao->nfuncgrads   = 0;
1306a7e14dcfSSatish Balay   tao->ngrads       = 0;
1307a7e14dcfSSatish Balay   tao->nhess        = 0;
1308a7e14dcfSSatish Balay   tao->njac         = 0;
1309a7e14dcfSSatish Balay   tao->nconstraints = 0;
1310a7e14dcfSSatish Balay   tao->ksp_its      = 0;
1311ae93cb3cSJason Sarich   tao->ksp_tot_its  = 0;
1312a7e14dcfSSatish Balay   tao->reason       = TAO_CONTINUE_ITERATING;
1313a7e14dcfSSatish Balay   tao->residual     = 0.0;
1314a7e14dcfSSatish Balay   tao->cnorm        = 0.0;
1315a7e14dcfSSatish Balay   tao->step         = 0.0;
1316a7e14dcfSSatish Balay   tao->lsflag       = PETSC_FALSE;
1317a7e14dcfSSatish Balay   if (tao->hist_reset) tao->hist_len=0;
1318a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1319a7e14dcfSSatish Balay }
1320a7e14dcfSSatish Balay 
1321a7e14dcfSSatish Balay /*@C
1322a7e14dcfSSatish Balay   TaoSetConvergenceTest - Sets the function that is to be used to test
1323a7e14dcfSSatish Balay   for convergence o fthe iterative minimization solution.  The new convergence
1324a7e14dcfSSatish Balay   testing routine will replace TAO's default convergence test.
1325a7e14dcfSSatish Balay 
1326441846f8SBarry Smith   Logically Collective on Tao
1327a7e14dcfSSatish Balay 
1328a7e14dcfSSatish Balay   Input Parameters:
1329441846f8SBarry Smith + tao - the Tao object
1330a7e14dcfSSatish Balay . conv - the routine to test for convergence
1331a7e14dcfSSatish Balay - ctx - [optional] context for private data for the convergence routine
133247a47007SBarry Smith         (may be NULL)
1333a7e14dcfSSatish Balay 
1334a7e14dcfSSatish Balay   Calling sequence of conv:
1335441846f8SBarry Smith $   PetscErrorCode conv(Tao tao, void *ctx)
1336a7e14dcfSSatish Balay 
1337441846f8SBarry Smith + tao - the Tao object
1338a7e14dcfSSatish Balay - ctx - [optional] convergence context
1339a7e14dcfSSatish Balay 
1340e4cb33bbSBarry Smith   Note: The new convergence testing routine should call TaoSetConvergedReason().
1341a7e14dcfSSatish Balay 
1342a7e14dcfSSatish Balay   Level: advanced
1343a7e14dcfSSatish Balay 
1344e4cb33bbSBarry Smith .seealso: TaoSetConvergedReason(), TaoGetSolutionStatus(), TaoGetTolerances(), TaoSetMonitor
1345a7e14dcfSSatish Balay 
1346a7e14dcfSSatish Balay @*/
1347441846f8SBarry Smith PetscErrorCode TaoSetConvergenceTest(Tao tao, PetscErrorCode (*conv)(Tao,void*), void *ctx)
1348a7e14dcfSSatish Balay {
1349a7e14dcfSSatish Balay   PetscFunctionBegin;
1350441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1351a7e14dcfSSatish Balay   (tao)->ops->convergencetest = conv;
1352a7e14dcfSSatish Balay   (tao)->cnvP = ctx;
1353a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1354a7e14dcfSSatish Balay }
1355a7e14dcfSSatish Balay 
1356a7e14dcfSSatish Balay /*@C
1357a7e14dcfSSatish Balay    TaoSetMonitor - Sets an ADDITIONAL function that is to be used at every
1358a7e14dcfSSatish Balay    iteration of the solver to display the iteration's
1359a7e14dcfSSatish Balay    progress.
1360a7e14dcfSSatish Balay 
1361441846f8SBarry Smith    Logically Collective on Tao
1362a7e14dcfSSatish Balay 
1363a7e14dcfSSatish Balay    Input Parameters:
1364441846f8SBarry Smith +  tao - the Tao solver context
1365a7e14dcfSSatish Balay .  mymonitor - monitoring routine
1366a7e14dcfSSatish Balay -  mctx - [optional] user-defined context for private data for the
136747a47007SBarry Smith           monitor routine (may be NULL)
1368a7e14dcfSSatish Balay 
1369a7e14dcfSSatish Balay    Calling sequence of mymonitor:
1370441846f8SBarry Smith $     int mymonitor(Tao tao,void *mctx)
1371a7e14dcfSSatish Balay 
1372441846f8SBarry Smith +    tao - the Tao solver context
1373a7e14dcfSSatish Balay -    mctx - [optional] monitoring context
1374a7e14dcfSSatish Balay 
1375a7e14dcfSSatish Balay 
1376a7e14dcfSSatish Balay    Options Database Keys:
137798ea980cSBarry Smith +    -tao_monitor        - sets TaoMonitorDefault()
1378a7e14dcfSSatish Balay .    -tao_smonitor       - sets short monitor
1379a7e14dcfSSatish Balay .    -tao_cmonitor       - same as smonitor plus constraint norm
1380a7e14dcfSSatish Balay .    -tao_view_solution   - view solution at each iteration
1381a7e14dcfSSatish Balay .    -tao_view_gradient   - view gradient at each iteration
1382a7e14dcfSSatish Balay .    -tao_view_separableobjective - view separable objective function at each iteration
1383a7e14dcfSSatish 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.
1384a7e14dcfSSatish Balay 
1385a7e14dcfSSatish Balay 
1386a7e14dcfSSatish Balay    Notes:
1387a7e14dcfSSatish Balay    Several different monitoring routines may be set by calling
1388a7e14dcfSSatish Balay    TaoSetMonitor() multiple times; all will be called in the
1389a7e14dcfSSatish Balay    order in which they were set.
1390a7e14dcfSSatish Balay 
139195452b02SPatrick Sanan    Fortran Notes:
139295452b02SPatrick Sanan     Only one monitor function may be set
1393a7e14dcfSSatish Balay 
1394a7e14dcfSSatish Balay    Level: intermediate
1395a7e14dcfSSatish Balay 
139698ea980cSBarry Smith .seealso: TaoMonitorDefault(), TaoCancelMonitors(),  TaoSetDestroyRoutine()
1397a7e14dcfSSatish Balay @*/
1398441846f8SBarry Smith PetscErrorCode TaoSetMonitor(Tao tao, PetscErrorCode (*func)(Tao, void*), void *ctx,PetscErrorCode (*dest)(void**))
1399a7e14dcfSSatish Balay {
140008d19d1fSJason Sarich   PetscErrorCode ierr;
140108d19d1fSJason Sarich   PetscInt       i;
140208d19d1fSJason Sarich 
1403a7e14dcfSSatish Balay   PetscFunctionBegin;
1404441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
140547a47007SBarry Smith   if (tao->numbermonitors >= MAXTAOMONITORS) SETERRQ1(PETSC_COMM_SELF,1,"Cannot attach another monitor -- max=",MAXTAOMONITORS);
140608d19d1fSJason Sarich 
140708d19d1fSJason Sarich   for (i=0; i<tao->numbermonitors;i++) {
140808d19d1fSJason Sarich     if (func == tao->monitor[i] && dest == tao->monitordestroy[i] && ctx == tao->monitorcontext[i]) {
140908d19d1fSJason Sarich       if (dest) {
141008d19d1fSJason Sarich         ierr = (*dest)(&ctx);CHKERRQ(ierr);
141108d19d1fSJason Sarich       }
141208d19d1fSJason Sarich       PetscFunctionReturn(0);
141308d19d1fSJason Sarich     }
141408d19d1fSJason Sarich   }
1415a7e14dcfSSatish Balay   tao->monitor[tao->numbermonitors] = func;
1416a7e14dcfSSatish Balay   tao->monitorcontext[tao->numbermonitors] = ctx;
1417a7e14dcfSSatish Balay   tao->monitordestroy[tao->numbermonitors] = dest;
1418a7e14dcfSSatish Balay   ++tao->numbermonitors;
1419a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1420a7e14dcfSSatish Balay }
1421a7e14dcfSSatish Balay 
1422a7e14dcfSSatish Balay /*@
1423441846f8SBarry Smith    TaoCancelMonitors - Clears all the monitor functions for a Tao object.
1424a7e14dcfSSatish Balay 
1425441846f8SBarry Smith    Logically Collective on Tao
1426a7e14dcfSSatish Balay 
1427a7e14dcfSSatish Balay    Input Parameters:
1428441846f8SBarry Smith .  tao - the Tao solver context
1429a7e14dcfSSatish Balay 
1430a7e14dcfSSatish Balay    Options Database:
1431a7e14dcfSSatish Balay .  -tao_cancelmonitors - cancels all monitors that have been hardwired
1432a7e14dcfSSatish Balay     into a code by calls to TaoSetMonitor(), but does not cancel those
1433a7e14dcfSSatish Balay     set via the options database
1434a7e14dcfSSatish Balay 
1435a7e14dcfSSatish Balay    Notes:
1436441846f8SBarry Smith    There is no way to clear one specific monitor from a Tao object.
1437a7e14dcfSSatish Balay 
1438a7e14dcfSSatish Balay    Level: advanced
1439a7e14dcfSSatish Balay 
144098ea980cSBarry Smith .seealso: TaoMonitorDefault(), TaoSetMonitor()
1441a7e14dcfSSatish Balay @*/
1442441846f8SBarry Smith PetscErrorCode TaoCancelMonitors(Tao tao)
1443a7e14dcfSSatish Balay {
1444a7e14dcfSSatish Balay   PetscInt       i;
1445a7e14dcfSSatish Balay   PetscErrorCode ierr;
144647a47007SBarry Smith 
1447a7e14dcfSSatish Balay   PetscFunctionBegin;
1448441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1449a7e14dcfSSatish Balay   for (i=0;i<tao->numbermonitors;i++) {
1450a7e14dcfSSatish Balay     if (tao->monitordestroy[i]) {
1451a7e14dcfSSatish Balay       ierr = (*tao->monitordestroy[i])(&tao->monitorcontext[i]);CHKERRQ(ierr);
1452a7e14dcfSSatish Balay     }
1453a7e14dcfSSatish Balay   }
1454a7e14dcfSSatish Balay   tao->numbermonitors=0;
1455a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1456a7e14dcfSSatish Balay }
1457a7e14dcfSSatish Balay 
14587fab98ebSJason Sarich /*@
145998ea980cSBarry Smith    TaoMonitorDefault - Default routine for monitoring progress of the
1460441846f8SBarry Smith    Tao solvers (default).  This monitor prints the function value and gradient
1461a7e14dcfSSatish Balay    norm at each iteration.  It can be turned on from the command line using the
1462a7e14dcfSSatish Balay    -tao_monitor option
1463a7e14dcfSSatish Balay 
1464441846f8SBarry Smith    Collective on Tao
1465a7e14dcfSSatish Balay 
1466a7e14dcfSSatish Balay    Input Parameters:
1467441846f8SBarry Smith +  tao - the Tao context
146847a47007SBarry Smith -  ctx - PetscViewer context or NULL
1469a7e14dcfSSatish Balay 
1470a7e14dcfSSatish Balay    Options Database Keys:
1471a7e14dcfSSatish Balay .  -tao_monitor
1472a7e14dcfSSatish Balay 
1473a7e14dcfSSatish Balay    Level: advanced
1474a7e14dcfSSatish Balay 
1475a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1476a7e14dcfSSatish Balay @*/
147798ea980cSBarry Smith PetscErrorCode TaoMonitorDefault(Tao tao, void *ctx)
1478a7e14dcfSSatish Balay {
1479a7e14dcfSSatish Balay   PetscErrorCode ierr;
148063b15415SAlp Dener   PetscInt       its, tabs;
1481a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
14828163d661SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
148347a47007SBarry Smith 
1484a7e14dcfSSatish Balay   PetscFunctionBegin;
14858163d661SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1486a7e14dcfSSatish Balay   its=tao->niter;
1487a7e14dcfSSatish Balay   fct=tao->fc;
1488a7e14dcfSSatish Balay   gnorm=tao->residual;
148963b15415SAlp Dener   ierr = PetscViewerASCIIGetTab(viewer, &tabs);CHKERRQ(ierr);
149063b15415SAlp Dener   ierr = PetscViewerASCIISetTab(viewer, ((PetscObject)tao)->tablevel);CHKERRQ(ierr);
149163b15415SAlp Dener   if (its == 0 && ((PetscObject)tao)->prefix) {
149263b15415SAlp Dener      ierr = PetscViewerASCIIPrintf(viewer,"  Iteration information for %s solve.\n",((PetscObject)tao)->prefix);CHKERRQ(ierr);
149363b15415SAlp Dener    }
149498ea980cSBarry Smith   ierr=PetscViewerASCIIPrintf(viewer,"%3D TAO,",its);CHKERRQ(ierr);
149547a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer,"  Function value: %g,",(double)fct);CHKERRQ(ierr);
149608d19d1fSJason Sarich   if (gnorm >= PETSC_INFINITY) {
149708d19d1fSJason Sarich     ierr=PetscViewerASCIIPrintf(viewer,"  Residual: Inf \n");CHKERRQ(ierr);
149808d19d1fSJason Sarich   } else {
149947a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer,"  Residual: %g \n",(double)gnorm);CHKERRQ(ierr);
150008d19d1fSJason Sarich   }
150163b15415SAlp Dener   ierr = PetscViewerASCIISetTab(viewer, tabs);CHKERRQ(ierr);
1502a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1503a7e14dcfSSatish Balay }
1504a7e14dcfSSatish Balay 
15057fab98ebSJason Sarich /*@
1506a7e14dcfSSatish Balay    TaoDefaultSMonitor - Default routine for monitoring progress of the
150798ea980cSBarry Smith    solver. Same as TaoMonitorDefault() except
1508a7e14dcfSSatish Balay    it prints fewer digits of the residual as the residual gets smaller.
1509a7e14dcfSSatish Balay    This is because the later digits are meaningless and are often
1510a7e14dcfSSatish Balay    different on different machines; by using this routine different
1511a7e14dcfSSatish Balay    machines will usually generate the same output. It can be turned on
1512a7e14dcfSSatish Balay    by using the -tao_smonitor option
1513a7e14dcfSSatish Balay 
1514441846f8SBarry Smith    Collective on Tao
1515a7e14dcfSSatish Balay 
1516a7e14dcfSSatish Balay    Input Parameters:
1517441846f8SBarry Smith +  tao - the Tao context
15184d4332d5SBarry Smith -  ctx - PetscViewer context of type ASCII
1519a7e14dcfSSatish Balay 
1520a7e14dcfSSatish Balay    Options Database Keys:
1521a7e14dcfSSatish Balay .  -tao_smonitor
1522a7e14dcfSSatish Balay 
1523a7e14dcfSSatish Balay    Level: advanced
1524a7e14dcfSSatish Balay 
152598ea980cSBarry Smith .seealso: TaoMonitorDefault(), TaoSetMonitor()
1526a7e14dcfSSatish Balay @*/
1527441846f8SBarry Smith PetscErrorCode TaoDefaultSMonitor(Tao tao, void *ctx)
1528a7e14dcfSSatish Balay {
1529a7e14dcfSSatish Balay   PetscErrorCode ierr;
1530*2c9b8b83SAlp Dener   PetscInt       its, tabs;
1531a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
15324d4332d5SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
153347a47007SBarry Smith 
1534a7e14dcfSSatish Balay   PetscFunctionBegin;
15354d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1536a7e14dcfSSatish Balay   its=tao->niter;
1537a7e14dcfSSatish Balay   fct=tao->fc;
1538a7e14dcfSSatish Balay   gnorm=tao->residual;
1539*2c9b8b83SAlp Dener   ierr = PetscViewerASCIIGetTab(viewer, &tabs);CHKERRQ(ierr);
1540*2c9b8b83SAlp Dener   ierr = PetscViewerASCIISetTab(viewer, ((PetscObject)tao)->tablevel);CHKERRQ(ierr);
1541a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr);
154247a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value %g,",(double)fct);CHKERRQ(ierr);
1543d393f493SBarry Smith   if (gnorm >= PETSC_INFINITY) {
154408d19d1fSJason Sarich     ierr=PetscViewerASCIIPrintf(viewer," Residual: Inf \n");CHKERRQ(ierr);
154508d19d1fSJason Sarich   } else if (gnorm > 1.e-6) {
154647a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr);
1547a7e14dcfSSatish Balay   } else if (gnorm > 1.e-11) {
1548a7e14dcfSSatish Balay     ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-6 \n");CHKERRQ(ierr);
1549a7e14dcfSSatish Balay   } else {
1550a7e14dcfSSatish Balay     ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-11 \n");CHKERRQ(ierr);
1551a7e14dcfSSatish Balay   }
1552*2c9b8b83SAlp Dener   ierr = PetscViewerASCIISetTab(viewer, tabs);CHKERRQ(ierr);
1553a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1554a7e14dcfSSatish Balay }
1555a7e14dcfSSatish Balay 
15567fab98ebSJason Sarich /*@
155798ea980cSBarry Smith    TaoDefaultCMonitor - same as TaoMonitorDefault() except
1558a7e14dcfSSatish Balay    it prints the norm of the constraints function. It can be turned on
1559a7e14dcfSSatish Balay    from the command line using the -tao_cmonitor option
1560a7e14dcfSSatish Balay 
1561441846f8SBarry Smith    Collective on Tao
1562a7e14dcfSSatish Balay 
1563a7e14dcfSSatish Balay    Input Parameters:
1564441846f8SBarry Smith +  tao - the Tao context
156547a47007SBarry Smith -  ctx - PetscViewer context or NULL
1566a7e14dcfSSatish Balay 
1567a7e14dcfSSatish Balay    Options Database Keys:
1568a7e14dcfSSatish Balay .  -tao_cmonitor
1569a7e14dcfSSatish Balay 
1570a7e14dcfSSatish Balay    Level: advanced
1571a7e14dcfSSatish Balay 
157298ea980cSBarry Smith .seealso: TaoMonitorDefault(), TaoSetMonitor()
1573a7e14dcfSSatish Balay @*/
1574441846f8SBarry Smith PetscErrorCode TaoDefaultCMonitor(Tao tao, void *ctx)
1575a7e14dcfSSatish Balay {
1576a7e14dcfSSatish Balay   PetscErrorCode ierr;
1577*2c9b8b83SAlp Dener   PetscInt       its, tabs;
1578a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1579d393f493SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
1580a7e14dcfSSatish Balay 
1581a7e14dcfSSatish Balay   PetscFunctionBegin;
1582d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1583a7e14dcfSSatish Balay   its=tao->niter;
1584a7e14dcfSSatish Balay   fct=tao->fc;
1585a7e14dcfSSatish Balay   gnorm=tao->residual;
1586*2c9b8b83SAlp Dener   ierr = PetscViewerASCIIGetTab(viewer, &tabs);CHKERRQ(ierr);
1587*2c9b8b83SAlp Dener   ierr = PetscViewerASCIISetTab(viewer, ((PetscObject)tao)->tablevel);CHKERRQ(ierr);
1588a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %D,",its);CHKERRQ(ierr);
158947a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr);
159047a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer,"  Residual: %g ",(double)gnorm);CHKERRQ(ierr);
159147a47007SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"  Constraint: %g \n",(double)tao->cnorm);CHKERRQ(ierr);
1592*2c9b8b83SAlp Dener   ierr = PetscViewerASCIISetTab(viewer, tabs);CHKERRQ(ierr);
1593a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1594a7e14dcfSSatish Balay }
1595a7e14dcfSSatish Balay 
1596a7e14dcfSSatish Balay /*@C
1597a7e14dcfSSatish Balay    TaoSolutionMonitor - Views the solution at each iteration
1598a7e14dcfSSatish Balay    It can be turned on from the command line using the
1599a7e14dcfSSatish Balay    -tao_view_solution option
1600a7e14dcfSSatish Balay 
1601441846f8SBarry Smith    Collective on Tao
1602a7e14dcfSSatish Balay 
1603a7e14dcfSSatish Balay    Input Parameters:
1604441846f8SBarry Smith +  tao - the Tao context
160547a47007SBarry Smith -  ctx - PetscViewer context or NULL
1606a7e14dcfSSatish Balay 
1607a7e14dcfSSatish Balay    Options Database Keys:
1608a7e14dcfSSatish Balay .  -tao_view_solution
1609a7e14dcfSSatish Balay 
1610a7e14dcfSSatish Balay    Level: advanced
1611a7e14dcfSSatish Balay 
1612a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1613a7e14dcfSSatish Balay @*/
1614441846f8SBarry Smith PetscErrorCode TaoSolutionMonitor(Tao tao, void *ctx)
1615a7e14dcfSSatish Balay {
1616a7e14dcfSSatish Balay   PetscErrorCode ierr;
1617d393f493SBarry Smith   PetscViewer    viewer  = (PetscViewer)ctx;;
161847a47007SBarry Smith 
1619a7e14dcfSSatish Balay   PetscFunctionBegin;
1620d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1621a7e14dcfSSatish Balay   ierr = VecView(tao->solution, viewer);CHKERRQ(ierr);
1622a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1623a7e14dcfSSatish Balay }
1624a7e14dcfSSatish Balay 
1625a7e14dcfSSatish Balay /*@C
1626a7e14dcfSSatish Balay    TaoGradientMonitor - Views the gradient at each iteration
1627a7e14dcfSSatish Balay    It can be turned on from the command line using the
1628a7e14dcfSSatish Balay    -tao_view_gradient option
1629a7e14dcfSSatish Balay 
1630441846f8SBarry Smith    Collective on Tao
1631a7e14dcfSSatish Balay 
1632a7e14dcfSSatish Balay    Input Parameters:
1633441846f8SBarry Smith +  tao - the Tao context
163447a47007SBarry Smith -  ctx - PetscViewer context or NULL
1635a7e14dcfSSatish Balay 
1636a7e14dcfSSatish Balay    Options Database Keys:
1637a7e14dcfSSatish Balay .  -tao_view_gradient
1638a7e14dcfSSatish Balay 
1639a7e14dcfSSatish Balay    Level: advanced
1640a7e14dcfSSatish Balay 
1641a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1642a7e14dcfSSatish Balay @*/
1643441846f8SBarry Smith PetscErrorCode TaoGradientMonitor(Tao tao, void *ctx)
1644a7e14dcfSSatish Balay {
1645a7e14dcfSSatish Balay   PetscErrorCode ierr;
1646d393f493SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
164747a47007SBarry Smith 
1648a7e14dcfSSatish Balay   PetscFunctionBegin;
1649d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1650a7e14dcfSSatish Balay   ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr);
1651a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1652a7e14dcfSSatish Balay }
1653a7e14dcfSSatish Balay 
1654a7e14dcfSSatish Balay /*@C
1655a7e14dcfSSatish Balay    TaoStepDirectionMonitor - Views the gradient at each iteration
1656a7e14dcfSSatish Balay    It can be turned on from the command line using the
1657a7e14dcfSSatish Balay    -tao_view_gradient option
1658a7e14dcfSSatish Balay 
1659441846f8SBarry Smith    Collective on Tao
1660a7e14dcfSSatish Balay 
1661a7e14dcfSSatish Balay    Input Parameters:
1662441846f8SBarry Smith +  tao - the Tao context
166347a47007SBarry Smith -  ctx - PetscViewer context or NULL
1664a7e14dcfSSatish Balay 
1665a7e14dcfSSatish Balay    Options Database Keys:
1666a7e14dcfSSatish Balay .  -tao_view_gradient
1667a7e14dcfSSatish Balay 
1668a7e14dcfSSatish Balay    Level: advanced
1669a7e14dcfSSatish Balay 
1670a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1671a7e14dcfSSatish Balay @*/
1672441846f8SBarry Smith PetscErrorCode TaoStepDirectionMonitor(Tao tao, void *ctx)
1673a7e14dcfSSatish Balay {
1674a7e14dcfSSatish Balay   PetscErrorCode ierr;
1675d393f493SBarry Smith   PetscViewer    viewer = (PetscViewer)ctx;
1676d393f493SBarry Smith 
1677a7e14dcfSSatish Balay   PetscFunctionBegin;
1678d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1679a7e14dcfSSatish Balay   ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr);
1680a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1681a7e14dcfSSatish Balay }
1682a7e14dcfSSatish Balay 
1683a7e14dcfSSatish Balay /*@C
1684a7e14dcfSSatish Balay    TaoDrawSolutionMonitor - Plots the solution at each iteration
1685a7e14dcfSSatish Balay    It can be turned on from the command line using the
1686a7e14dcfSSatish Balay    -tao_draw_solution option
1687a7e14dcfSSatish Balay 
1688441846f8SBarry Smith    Collective on Tao
1689a7e14dcfSSatish Balay 
1690a7e14dcfSSatish Balay    Input Parameters:
1691441846f8SBarry Smith +  tao - the Tao context
1692e882e171SHong Zhang -  ctx - TaoMonitorDraw context
1693a7e14dcfSSatish Balay 
1694a7e14dcfSSatish Balay    Options Database Keys:
1695a7e14dcfSSatish Balay .  -tao_draw_solution
1696a7e14dcfSSatish Balay 
1697a7e14dcfSSatish Balay    Level: advanced
1698a7e14dcfSSatish Balay 
1699a7e14dcfSSatish Balay .seealso: TaoSolutionMonitor(), TaoSetMonitor(), TaoDrawGradientMonitor
1700a7e14dcfSSatish Balay @*/
1701441846f8SBarry Smith PetscErrorCode TaoDrawSolutionMonitor(Tao tao, void *ctx)
1702a7e14dcfSSatish Balay {
1703a7e14dcfSSatish Balay   PetscErrorCode    ierr;
1704e882e171SHong Zhang   TaoMonitorDrawCtx ictx = (TaoMonitorDrawCtx)ctx;
170547a47007SBarry Smith 
1706a7e14dcfSSatish Balay   PetscFunctionBegin;
1707e882e171SHong Zhang   if (!(((ictx->howoften > 0) && (!(tao->niter % ictx->howoften))) || ((ictx->howoften == -1) && tao->reason))) PetscFunctionReturn(0);
1708e882e171SHong Zhang   ierr = VecView(tao->solution,ictx->viewer);CHKERRQ(ierr);
1709a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1710a7e14dcfSSatish Balay }
1711a7e14dcfSSatish Balay 
1712a7e14dcfSSatish Balay /*@C
1713a7e14dcfSSatish Balay    TaoDrawGradientMonitor - Plots the gradient at each iteration
1714a7e14dcfSSatish Balay    It can be turned on from the command line using the
1715a7e14dcfSSatish Balay    -tao_draw_gradient option
1716a7e14dcfSSatish Balay 
1717441846f8SBarry Smith    Collective on Tao
1718a7e14dcfSSatish Balay 
1719a7e14dcfSSatish Balay    Input Parameters:
1720441846f8SBarry Smith +  tao - the Tao context
1721f55353a2SBarry Smith -  ctx - PetscViewer context
1722a7e14dcfSSatish Balay 
1723a7e14dcfSSatish Balay    Options Database Keys:
1724a7e14dcfSSatish Balay .  -tao_draw_gradient
1725a7e14dcfSSatish Balay 
1726a7e14dcfSSatish Balay    Level: advanced
1727a7e14dcfSSatish Balay 
1728a7e14dcfSSatish Balay .seealso: TaoGradientMonitor(), TaoSetMonitor(), TaoDrawSolutionMonitor
1729a7e14dcfSSatish Balay @*/
1730441846f8SBarry Smith PetscErrorCode TaoDrawGradientMonitor(Tao tao, void *ctx)
1731a7e14dcfSSatish Balay {
1732a7e14dcfSSatish Balay   PetscErrorCode    ierr;
1733e882e171SHong Zhang   TaoMonitorDrawCtx ictx = (TaoMonitorDrawCtx)ctx;
173447a47007SBarry Smith 
1735a7e14dcfSSatish Balay   PetscFunctionBegin;
1736e882e171SHong Zhang   if (!(((ictx->howoften > 0) && (!(tao->niter % ictx->howoften))) || ((ictx->howoften == -1) && tao->reason))) PetscFunctionReturn(0);
1737e882e171SHong Zhang   ierr = VecView(tao->gradient,ictx->viewer);CHKERRQ(ierr);
1738a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1739a7e14dcfSSatish Balay }
1740a7e14dcfSSatish Balay 
1741a7e14dcfSSatish Balay /*@C
1742a7e14dcfSSatish Balay    TaoDrawStepMonitor - Plots the step direction at each iteration
1743a7e14dcfSSatish Balay    It can be turned on from the command line using the
1744a7e14dcfSSatish Balay    -tao_draw_step option
1745a7e14dcfSSatish Balay 
1746441846f8SBarry Smith    Collective on Tao
1747a7e14dcfSSatish Balay 
1748a7e14dcfSSatish Balay    Input Parameters:
1749441846f8SBarry Smith +  tao - the Tao context
1750f55353a2SBarry Smith -  ctx - PetscViewer context
1751a7e14dcfSSatish Balay 
1752a7e14dcfSSatish Balay    Options Database Keys:
1753a7e14dcfSSatish Balay .  -tao_draw_step
1754a7e14dcfSSatish Balay 
1755a7e14dcfSSatish Balay    Level: advanced
1756a7e14dcfSSatish Balay 
1757a7e14dcfSSatish Balay .seealso: TaoSetMonitor(), TaoDrawSolutionMonitor
1758a7e14dcfSSatish Balay @*/
1759441846f8SBarry Smith PetscErrorCode TaoDrawStepMonitor(Tao tao, void *ctx)
1760a7e14dcfSSatish Balay {
1761a7e14dcfSSatish Balay   PetscErrorCode ierr;
1762a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer)(ctx);
176347a47007SBarry Smith 
1764a7e14dcfSSatish Balay   PetscFunctionBegin;
1765a7e14dcfSSatish Balay   ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr);
1766a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1767a7e14dcfSSatish Balay }
1768a7e14dcfSSatish Balay 
1769a7e14dcfSSatish Balay /*@C
1770a7e14dcfSSatish Balay    TaoSeparableObjectiveMonitor - Views the separable objective function at each iteration
1771a7e14dcfSSatish Balay    It can be turned on from the command line using the
1772a7e14dcfSSatish Balay    -tao_view_separableobjective option
1773a7e14dcfSSatish Balay 
1774441846f8SBarry Smith    Collective on Tao
1775a7e14dcfSSatish Balay 
1776a7e14dcfSSatish Balay    Input Parameters:
1777441846f8SBarry Smith +  tao - the Tao context
177847a47007SBarry Smith -  ctx - PetscViewer context or NULL
1779a7e14dcfSSatish Balay 
1780a7e14dcfSSatish Balay    Options Database Keys:
1781a7e14dcfSSatish Balay .  -tao_view_separableobjective
1782a7e14dcfSSatish Balay 
1783a7e14dcfSSatish Balay    Level: advanced
1784a7e14dcfSSatish Balay 
1785a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1786a7e14dcfSSatish Balay @*/
1787441846f8SBarry Smith PetscErrorCode TaoSeparableObjectiveMonitor(Tao tao, void *ctx)
1788a7e14dcfSSatish Balay {
1789a7e14dcfSSatish Balay   PetscErrorCode ierr;
1790d393f493SBarry Smith   PetscViewer    viewer  = (PetscViewer)ctx;
179147a47007SBarry Smith 
1792a7e14dcfSSatish Balay   PetscFunctionBegin;
1793d393f493SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1794a7e14dcfSSatish Balay   ierr = VecView(tao->sep_objective,viewer);CHKERRQ(ierr);
1795a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1796a7e14dcfSSatish Balay }
1797a7e14dcfSSatish Balay 
17987fab98ebSJason Sarich /*@
1799a7e14dcfSSatish Balay    TaoDefaultConvergenceTest - Determines whether the solver should continue iterating
1800a7e14dcfSSatish Balay    or terminate.
1801a7e14dcfSSatish Balay 
1802441846f8SBarry Smith    Collective on Tao
1803a7e14dcfSSatish Balay 
1804a7e14dcfSSatish Balay    Input Parameters:
1805441846f8SBarry Smith +  tao - the Tao context
1806a7e14dcfSSatish Balay -  dummy - unused dummy context
1807a7e14dcfSSatish Balay 
1808a7e14dcfSSatish Balay    Output Parameter:
1809a7e14dcfSSatish Balay .  reason - for terminating
1810a7e14dcfSSatish Balay 
1811a7e14dcfSSatish Balay    Notes:
1812a7e14dcfSSatish Balay    This routine checks the residual in the optimality conditions, the
1813a7e14dcfSSatish Balay    relative residual in the optimity conditions, the number of function
1814a7e14dcfSSatish Balay    evaluations, and the function value to test convergence.  Some
1815a7e14dcfSSatish Balay    solvers may use different convergence routines.
1816a7e14dcfSSatish Balay 
1817a7e14dcfSSatish Balay    Level: developer
1818a7e14dcfSSatish Balay 
1819e4cb33bbSBarry Smith .seealso: TaoSetTolerances(),TaoGetConvergedReason(),TaoSetConvergedReason()
1820a7e14dcfSSatish Balay @*/
1821a7e14dcfSSatish Balay 
1822441846f8SBarry Smith PetscErrorCode TaoDefaultConvergenceTest(Tao tao,void *dummy)
1823a7e14dcfSSatish Balay {
1824a7e14dcfSSatish Balay   PetscInt           niter=tao->niter, nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads);
1825a7e14dcfSSatish Balay   PetscInt           max_funcs=tao->max_funcs;
1826a7e14dcfSSatish Balay   PetscReal          gnorm=tao->residual, gnorm0=tao->gnorm0;
1827a7e14dcfSSatish Balay   PetscReal          f=tao->fc, steptol=tao->steptol,trradius=tao->step;
1828a7e14dcfSSatish Balay   PetscReal          gatol=tao->gatol,grtol=tao->grtol,gttol=tao->gttol;
1829e52336cbSBarry Smith   PetscReal          catol=tao->catol,crtol=tao->crtol;
1830e52336cbSBarry Smith   PetscReal          fmin=tao->fmin, cnorm=tao->cnorm;
1831e4cb33bbSBarry Smith   TaoConvergedReason reason=tao->reason;
1832a7e14dcfSSatish Balay   PetscErrorCode     ierr;
1833a7e14dcfSSatish Balay 
1834a7e14dcfSSatish Balay   PetscFunctionBegin;
1835441846f8SBarry Smith   PetscValidHeaderSpecific(tao, TAO_CLASSID,1);
1836a7e14dcfSSatish Balay   if (reason != TAO_CONTINUE_ITERATING) {
1837a7e14dcfSSatish Balay     PetscFunctionReturn(0);
1838a7e14dcfSSatish Balay   }
1839a7e14dcfSSatish Balay 
1840a7e14dcfSSatish Balay   if (PetscIsInfOrNanReal(f)) {
1841a7e14dcfSSatish Balay     ierr = PetscInfo(tao,"Failed to converged, function value is Inf or NaN\n");CHKERRQ(ierr);
1842a7e14dcfSSatish Balay     reason = TAO_DIVERGED_NAN;
1843a7e14dcfSSatish Balay   } else if (f <= fmin && cnorm <=catol) {
184447a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to function value %g < minimum function value %g\n", (double)f,(double)fmin);CHKERRQ(ierr);
1845a7e14dcfSSatish Balay     reason = TAO_CONVERGED_MINF;
1846a7e14dcfSSatish Balay   } else if (gnorm<= gatol && cnorm <=catol) {
184747a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to residual norm ||g(X)||=%g < %g\n",(double)gnorm,(double)gatol);CHKERRQ(ierr);
1848a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GATOL;
1849a7e14dcfSSatish Balay   } else if ( f!=0 && PetscAbsReal(gnorm/f) <= grtol && cnorm <= crtol) {
185047a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to residual ||g(X)||/|f(X)| =%g < %g\n",(double)(gnorm/f),(double)grtol);CHKERRQ(ierr);
1851a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GRTOL;
1852e1d16bb9SBarry Smith   } else if (gnorm0 != 0 && ((gttol == 0 && gnorm == 0) || gnorm/gnorm0 < gttol) && cnorm <= crtol) {
185347a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to relative residual norm ||g(X)||/||g(X0)|| = %g < %g\n",(double)(gnorm/gnorm0),(double)gttol);CHKERRQ(ierr);
1854a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GTTOL;
1855a7e14dcfSSatish Balay   } else if (nfuncs > max_funcs){
1856a7e14dcfSSatish Balay     ierr = PetscInfo2(tao,"Exceeded maximum number of function evaluations: %D > %D\n", nfuncs,max_funcs);CHKERRQ(ierr);
1857a7e14dcfSSatish Balay     reason = TAO_DIVERGED_MAXFCN;
1858a7e14dcfSSatish Balay   } else if ( tao->lsflag != 0 ){
1859a7e14dcfSSatish Balay     ierr = PetscInfo(tao,"Tao Line Search failure.\n");CHKERRQ(ierr);
1860a7e14dcfSSatish Balay     reason = TAO_DIVERGED_LS_FAILURE;
1861a7e14dcfSSatish Balay   } else if (trradius < steptol && niter > 0){
186247a47007SBarry Smith     ierr = PetscInfo2(tao,"Trust region/step size too small: %g < %g\n", (double)trradius,(double)steptol);CHKERRQ(ierr);
1863a7e14dcfSSatish Balay     reason = TAO_CONVERGED_STEPTOL;
1864a7e14dcfSSatish Balay   } else if (niter > tao->max_it) {
1865a7e14dcfSSatish Balay     ierr = PetscInfo2(tao,"Exceeded maximum number of iterations: %D > %D\n",niter,tao->max_it);CHKERRQ(ierr);
1866a7e14dcfSSatish Balay     reason = TAO_DIVERGED_MAXITS;
1867a7e14dcfSSatish Balay   } else {
1868a7e14dcfSSatish Balay     reason = TAO_CONTINUE_ITERATING;
1869a7e14dcfSSatish Balay   }
1870a7e14dcfSSatish Balay   tao->reason = reason;
1871a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1872a7e14dcfSSatish Balay }
1873a7e14dcfSSatish Balay 
1874a7e14dcfSSatish Balay /*@C
1875a7e14dcfSSatish Balay    TaoSetOptionsPrefix - Sets the prefix used for searching for all
1876a7e14dcfSSatish Balay    TAO options in the database.
1877a7e14dcfSSatish Balay 
1878a7e14dcfSSatish Balay 
1879441846f8SBarry Smith    Logically Collective on Tao
1880a7e14dcfSSatish Balay 
1881a7e14dcfSSatish Balay    Input Parameters:
1882441846f8SBarry Smith +  tao - the Tao context
1883a7e14dcfSSatish Balay -  prefix - the prefix string to prepend to all TAO option requests
1884a7e14dcfSSatish Balay 
1885a7e14dcfSSatish Balay    Notes:
1886a7e14dcfSSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
1887a7e14dcfSSatish Balay    The first character of all runtime options is AUTOMATICALLY the hyphen.
1888a7e14dcfSSatish Balay 
1889a7e14dcfSSatish Balay    For example, to distinguish between the runtime options for two
1890a7e14dcfSSatish Balay    different TAO solvers, one could call
1891a7e14dcfSSatish Balay .vb
1892a7e14dcfSSatish Balay       TaoSetOptionsPrefix(tao1,"sys1_")
1893a7e14dcfSSatish Balay       TaoSetOptionsPrefix(tao2,"sys2_")
1894a7e14dcfSSatish Balay .ve
1895a7e14dcfSSatish Balay 
1896a7e14dcfSSatish Balay    This would enable use of different options for each system, such as
1897a7e14dcfSSatish Balay .vb
1898a7e14dcfSSatish Balay       -sys1_tao_method blmvm -sys1_tao_gtol 1.e-3
1899a7e14dcfSSatish Balay       -sys2_tao_method lmvm  -sys2_tao_gtol 1.e-4
1900a7e14dcfSSatish Balay .ve
1901a7e14dcfSSatish Balay 
1902a7e14dcfSSatish Balay 
1903a7e14dcfSSatish Balay    Level: advanced
1904a7e14dcfSSatish Balay 
1905a7e14dcfSSatish Balay .seealso: TaoAppendOptionsPrefix(), TaoGetOptionsPrefix()
1906a7e14dcfSSatish Balay @*/
1907a7e14dcfSSatish Balay 
1908441846f8SBarry Smith PetscErrorCode TaoSetOptionsPrefix(Tao tao, const char p[])
1909a7e14dcfSSatish Balay {
1910a7e14dcfSSatish Balay   PetscErrorCode ierr;
191147a47007SBarry Smith 
1912a7e14dcfSSatish Balay   PetscFunctionBegin;
1913a7e14dcfSSatish Balay   ierr = PetscObjectSetOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr);
1914a7e14dcfSSatish Balay   if (tao->linesearch) {
1915a7e14dcfSSatish Balay     ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr);
1916a7e14dcfSSatish Balay   }
1917a7e14dcfSSatish Balay   if (tao->ksp) {
1918a7e14dcfSSatish Balay     ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr);
1919a7e14dcfSSatish Balay   }
1920a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1921a7e14dcfSSatish Balay }
1922a7e14dcfSSatish Balay 
1923a7e14dcfSSatish Balay /*@C
1924a7e14dcfSSatish Balay    TaoAppendOptionsPrefix - Appends to the prefix used for searching for all
1925a7e14dcfSSatish Balay    TAO options in the database.
1926a7e14dcfSSatish Balay 
1927a7e14dcfSSatish Balay 
1928441846f8SBarry Smith    Logically Collective on Tao
1929a7e14dcfSSatish Balay 
1930a7e14dcfSSatish Balay    Input Parameters:
1931441846f8SBarry Smith +  tao - the Tao solver context
1932a7e14dcfSSatish Balay -  prefix - the prefix string to prepend to all TAO option requests
1933a7e14dcfSSatish Balay 
1934a7e14dcfSSatish Balay    Notes:
1935a7e14dcfSSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
1936a7e14dcfSSatish Balay    The first character of all runtime options is AUTOMATICALLY the hyphen.
1937a7e14dcfSSatish Balay 
1938a7e14dcfSSatish Balay 
1939a7e14dcfSSatish Balay    Level: advanced
1940a7e14dcfSSatish Balay 
1941a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoGetOptionsPrefix()
1942a7e14dcfSSatish Balay @*/
1943441846f8SBarry Smith PetscErrorCode TaoAppendOptionsPrefix(Tao tao, const char p[])
1944a7e14dcfSSatish Balay {
1945a7e14dcfSSatish Balay   PetscErrorCode ierr;
194647a47007SBarry Smith 
1947a7e14dcfSSatish Balay   PetscFunctionBegin;
1948a7e14dcfSSatish Balay   ierr = PetscObjectAppendOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr);
1949a7e14dcfSSatish Balay   if (tao->linesearch) {
1950a7e14dcfSSatish Balay     ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr);
1951a7e14dcfSSatish Balay   }
1952a7e14dcfSSatish Balay   if (tao->ksp) {
1953a7e14dcfSSatish Balay     ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr);
1954a7e14dcfSSatish Balay   }
1955a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1956a7e14dcfSSatish Balay }
1957a7e14dcfSSatish Balay 
1958a7e14dcfSSatish Balay /*@C
1959a7e14dcfSSatish Balay   TaoGetOptionsPrefix - Gets the prefix used for searching for all
1960a7e14dcfSSatish Balay   TAO options in the database
1961a7e14dcfSSatish Balay 
1962a7e14dcfSSatish Balay   Not Collective
1963a7e14dcfSSatish Balay 
1964a7e14dcfSSatish Balay   Input Parameters:
1965441846f8SBarry Smith . tao - the Tao context
1966a7e14dcfSSatish Balay 
1967a7e14dcfSSatish Balay   Output Parameters:
1968a7e14dcfSSatish Balay . prefix - pointer to the prefix string used is returned
1969a7e14dcfSSatish Balay 
197095452b02SPatrick Sanan   Notes:
197195452b02SPatrick Sanan     On the fortran side, the user should pass in a string 'prefix' of
1972a7e14dcfSSatish Balay   sufficient length to hold the prefix.
1973a7e14dcfSSatish Balay 
1974a7e14dcfSSatish Balay   Level: advanced
1975a7e14dcfSSatish Balay 
1976a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoAppendOptionsPrefix()
1977a7e14dcfSSatish Balay @*/
1978441846f8SBarry Smith PetscErrorCode TaoGetOptionsPrefix(Tao tao, const char *p[])
1979a7e14dcfSSatish Balay {
198047a47007SBarry Smith    return PetscObjectGetOptionsPrefix((PetscObject)tao,p);
1981a7e14dcfSSatish Balay }
1982a7e14dcfSSatish Balay 
1983a7e14dcfSSatish Balay /*@C
1984a7e14dcfSSatish Balay    TaoSetType - Sets the method for the unconstrained minimization solver.
1985a7e14dcfSSatish Balay 
1986441846f8SBarry Smith    Collective on Tao
1987a7e14dcfSSatish Balay 
1988a7e14dcfSSatish Balay    Input Parameters:
1989441846f8SBarry Smith +  solver - the Tao solver context
1990a7e14dcfSSatish Balay -  type - a known method
1991a7e14dcfSSatish Balay 
1992a7e14dcfSSatish Balay    Options Database Key:
199358417fe7SBarry Smith .  -tao_type <type> - Sets the method; use -help for a list
199458417fe7SBarry Smith    of available methods (for instance, "-tao_type lmvm" or "-tao_type tron")
1995a7e14dcfSSatish Balay 
1996a7e14dcfSSatish Balay    Available methods include:
199758417fe7SBarry Smith +    nls - Newton's method with line search for unconstrained minimization
199858417fe7SBarry Smith .    ntr - Newton's method with trust region for unconstrained minimization
199958417fe7SBarry Smith .    ntl - Newton's method with trust region, line search for unconstrained minimization
200058417fe7SBarry Smith .    lmvm - Limited memory variable metric method for unconstrained minimization
200158417fe7SBarry Smith .    cg - Nonlinear conjugate gradient method for unconstrained minimization
200258417fe7SBarry Smith .    nm - Nelder-Mead algorithm for derivate-free unconstrained minimization
200358417fe7SBarry Smith .    tron - Newton Trust Region method for bound constrained minimization
200458417fe7SBarry Smith .    gpcg - Newton Trust Region method for quadratic bound constrained minimization
200558417fe7SBarry Smith .    blmvm - Limited memory variable metric method for bound constrained minimization
20061eb8069cSJason Sarich -    pounders - Model-based algorithm pounder extended for nonlinear least squares
2007a7e14dcfSSatish Balay 
2008a7e14dcfSSatish Balay   Level: intermediate
2009a7e14dcfSSatish Balay 
20101eb8069cSJason Sarich .seealso: TaoCreate(), TaoGetType(), TaoType
2011a7e14dcfSSatish Balay 
2012a7e14dcfSSatish Balay @*/
2013441846f8SBarry Smith PetscErrorCode TaoSetType(Tao tao, const TaoType type)
2014a7e14dcfSSatish Balay {
2015a7e14dcfSSatish Balay   PetscErrorCode ierr;
2016441846f8SBarry Smith   PetscErrorCode (*create_xxx)(Tao);
2017a7e14dcfSSatish Balay   PetscBool      issame;
2018a7e14dcfSSatish Balay 
2019a7e14dcfSSatish Balay   PetscFunctionBegin;
2020441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2021a7e14dcfSSatish Balay 
2022a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)tao,type,&issame);CHKERRQ(ierr);
2023a7e14dcfSSatish Balay   if (issame) PetscFunctionReturn(0);
2024a7e14dcfSSatish Balay 
2025441846f8SBarry Smith   ierr = PetscFunctionListFind(TaoList, type, (void(**)(void))&create_xxx);CHKERRQ(ierr);
2026441846f8SBarry Smith   if (!create_xxx) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested Tao type %s",type);
2027a7e14dcfSSatish Balay 
2028a7e14dcfSSatish Balay   /* Destroy the existing solver information */
2029a7e14dcfSSatish Balay   if (tao->ops->destroy) {
2030a7e14dcfSSatish Balay     ierr = (*tao->ops->destroy)(tao);CHKERRQ(ierr);
2031a7e14dcfSSatish Balay   }
2032a7e14dcfSSatish Balay   ierr = KSPDestroy(&tao->ksp);CHKERRQ(ierr);
2033a7e14dcfSSatish Balay   ierr = TaoLineSearchDestroy(&tao->linesearch);CHKERRQ(ierr);
2034a7e14dcfSSatish Balay   ierr = VecDestroy(&tao->gradient);CHKERRQ(ierr);
2035a7e14dcfSSatish Balay   ierr = VecDestroy(&tao->stepdirection);CHKERRQ(ierr);
2036a7e14dcfSSatish Balay 
2037a7e14dcfSSatish Balay   tao->ops->setup = 0;
2038a7e14dcfSSatish Balay   tao->ops->solve = 0;
2039a7e14dcfSSatish Balay   tao->ops->view  = 0;
2040a7e14dcfSSatish Balay   tao->ops->setfromoptions = 0;
2041a7e14dcfSSatish Balay   tao->ops->destroy = 0;
2042a7e14dcfSSatish Balay 
2043a7e14dcfSSatish Balay   tao->setupcalled = PETSC_FALSE;
2044a7e14dcfSSatish Balay 
2045a7e14dcfSSatish Balay   ierr = (*create_xxx)(tao);CHKERRQ(ierr);
2046a7e14dcfSSatish Balay   ierr = PetscObjectChangeTypeName((PetscObject)tao,type);CHKERRQ(ierr);
2047a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2048a7e14dcfSSatish Balay }
204947a47007SBarry Smith 
2050a7e14dcfSSatish Balay /*MC
2051441846f8SBarry Smith    TaoRegister - Adds a method to the TAO package for unconstrained minimization.
2052a7e14dcfSSatish Balay 
2053a7e14dcfSSatish Balay    Synopsis:
2054441846f8SBarry Smith    TaoRegister(char *name_solver,char *path,char *name_Create,int (*routine_Create)(Tao))
2055a7e14dcfSSatish Balay 
2056a7e14dcfSSatish Balay    Not collective
2057a7e14dcfSSatish Balay 
2058a7e14dcfSSatish Balay    Input Parameters:
2059a7e14dcfSSatish Balay +  sname - name of a new user-defined solver
2060a7e14dcfSSatish Balay -  func - routine to Create method context
2061a7e14dcfSSatish Balay 
2062a7e14dcfSSatish Balay    Notes:
2063441846f8SBarry Smith    TaoRegister() may be called multiple times to add several user-defined solvers.
2064a7e14dcfSSatish Balay 
2065a7e14dcfSSatish Balay    Sample usage:
2066a7e14dcfSSatish Balay .vb
2067441846f8SBarry Smith    TaoRegister("my_solver",MySolverCreate);
2068a7e14dcfSSatish Balay .ve
2069a7e14dcfSSatish Balay 
2070a7e14dcfSSatish Balay    Then, your solver can be chosen with the procedural interface via
2071a7e14dcfSSatish Balay $     TaoSetType(tao,"my_solver")
2072a7e14dcfSSatish Balay    or at runtime via the option
207358417fe7SBarry Smith $     -tao_type my_solver
2074a7e14dcfSSatish Balay 
2075a7e14dcfSSatish Balay    Level: advanced
2076a7e14dcfSSatish Balay 
2077441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegisterDestroy()
2078a7e14dcfSSatish Balay M*/
2079441846f8SBarry Smith PetscErrorCode TaoRegister(const char sname[], PetscErrorCode (*func)(Tao))
2080a7e14dcfSSatish Balay {
2081a7e14dcfSSatish Balay   PetscErrorCode ierr;
2082a7e14dcfSSatish Balay 
2083a7e14dcfSSatish Balay   PetscFunctionBegin;
2084441846f8SBarry Smith   ierr = PetscFunctionListAdd(&TaoList,sname, (void (*)(void))func);CHKERRQ(ierr);
2085a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2086a7e14dcfSSatish Balay }
2087a7e14dcfSSatish Balay 
2088a7e14dcfSSatish Balay /*@C
2089441846f8SBarry Smith    TaoRegisterDestroy - Frees the list of minimization solvers that were
2090441846f8SBarry Smith    registered by TaoRegisterDynamic().
2091a7e14dcfSSatish Balay 
2092a7e14dcfSSatish Balay    Not Collective
2093a7e14dcfSSatish Balay 
2094a7e14dcfSSatish Balay    Level: advanced
2095a7e14dcfSSatish Balay 
2096441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegister()
2097a7e14dcfSSatish Balay @*/
2098441846f8SBarry Smith PetscErrorCode TaoRegisterDestroy(void)
2099a7e14dcfSSatish Balay {
2100a7e14dcfSSatish Balay   PetscErrorCode ierr;
2101a7e14dcfSSatish Balay   PetscFunctionBegin;
2102441846f8SBarry Smith   ierr = PetscFunctionListDestroy(&TaoList);CHKERRQ(ierr);
2103441846f8SBarry Smith   TaoRegisterAllCalled = PETSC_FALSE;
2104a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2105a7e14dcfSSatish Balay }
210647a47007SBarry Smith 
21078931d482SJason Sarich /*@
21088931d482SJason Sarich    TaoGetIterationNumber - Gets the number of Tao iterations completed
21098931d482SJason Sarich    at this time.
21108931d482SJason Sarich 
21118931d482SJason Sarich    Not Collective
21128931d482SJason Sarich 
21138931d482SJason Sarich    Input Parameter:
21148931d482SJason Sarich .  tao - Tao context
21158931d482SJason Sarich 
21168931d482SJason Sarich    Output Parameter:
21178931d482SJason Sarich .  iter - iteration number
21188931d482SJason Sarich 
21198931d482SJason Sarich    Notes:
21208931d482SJason Sarich    For example, during the computation of iteration 2 this would return 1.
21218931d482SJason Sarich 
21228931d482SJason Sarich 
21238931d482SJason Sarich    Level: intermediate
21248931d482SJason Sarich 
21258931d482SJason Sarich .keywords: Tao, nonlinear, get, iteration, number,
21268931d482SJason Sarich 
212779f5d8caSBarry Smith .seealso:   TaoGetLinearSolveIterations(), TaoGetResidualNorm(), TaoGetObjective()
21288931d482SJason Sarich @*/
21298931d482SJason Sarich PetscErrorCode  TaoGetIterationNumber(Tao tao,PetscInt *iter)
21308931d482SJason Sarich {
21318931d482SJason Sarich   PetscFunctionBegin;
21328931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
21338931d482SJason Sarich   PetscValidIntPointer(iter,2);
21348931d482SJason Sarich   *iter = tao->niter;
21358931d482SJason Sarich   PetscFunctionReturn(0);
21368931d482SJason Sarich }
21378931d482SJason Sarich 
21388931d482SJason Sarich /*@
213979f5d8caSBarry Smith    TaoGetObjective - Gets the current value of the objective function
214079f5d8caSBarry Smith    at this time.
214179f5d8caSBarry Smith 
214279f5d8caSBarry Smith    Not Collective
214379f5d8caSBarry Smith 
214479f5d8caSBarry Smith    Input Parameter:
214579f5d8caSBarry Smith .  tao - Tao context
214679f5d8caSBarry Smith 
214779f5d8caSBarry Smith    Output Parameter:
214879f5d8caSBarry Smith .  value - the current value
214979f5d8caSBarry Smith 
215079f5d8caSBarry Smith    Level: intermediate
215179f5d8caSBarry Smith 
215279f5d8caSBarry Smith .keywords: Tao, nonlinear, get, iteration, number,
215379f5d8caSBarry Smith 
215479f5d8caSBarry Smith .seealso:   TaoGetLinearSolveIterations(), TaoGetIterationNumber(), TaoGetResidualNorm()
215579f5d8caSBarry Smith @*/
215679f5d8caSBarry Smith PetscErrorCode  TaoGetObjective(Tao tao,PetscReal *value)
215779f5d8caSBarry Smith {
215879f5d8caSBarry Smith   PetscFunctionBegin;
215979f5d8caSBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
216079f5d8caSBarry Smith   PetscValidRealPointer(value,2);
216179f5d8caSBarry Smith   *value = tao->fc;
216279f5d8caSBarry Smith   PetscFunctionReturn(0);
216379f5d8caSBarry Smith }
216479f5d8caSBarry Smith 
216579f5d8caSBarry Smith /*@
216679f5d8caSBarry Smith    TaoGetResidualNorm - Gets the current value of the norm of the residual
216779f5d8caSBarry Smith    at this time.
216879f5d8caSBarry Smith 
216979f5d8caSBarry Smith    Not Collective
217079f5d8caSBarry Smith 
217179f5d8caSBarry Smith    Input Parameter:
217279f5d8caSBarry Smith .  tao - Tao context
217379f5d8caSBarry Smith 
217479f5d8caSBarry Smith    Output Parameter:
217579f5d8caSBarry Smith .  value - the current value
217679f5d8caSBarry Smith 
217779f5d8caSBarry Smith    Level: intermediate
217879f5d8caSBarry Smith 
217979f5d8caSBarry Smith    Developer Note: This is the 2-norm of the residual, we cannot use TaoGetGradientNorm() because that has
218079f5d8caSBarry Smith                    a different meaning. For some reason Tao sometimes calls the gradient the residual.
218179f5d8caSBarry Smith 
218279f5d8caSBarry Smith .keywords: Tao, nonlinear, get, iteration, number,
218379f5d8caSBarry Smith 
218479f5d8caSBarry Smith .seealso:   TaoGetLinearSolveIterations(), TaoGetIterationNumber(), TaoGetObjective()
218579f5d8caSBarry Smith @*/
218679f5d8caSBarry Smith PetscErrorCode  TaoGetResidualNorm(Tao tao,PetscReal *value)
218779f5d8caSBarry Smith {
218879f5d8caSBarry Smith   PetscFunctionBegin;
218979f5d8caSBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
219079f5d8caSBarry Smith   PetscValidRealPointer(value,2);
219179f5d8caSBarry Smith   *value = tao->residual;
219279f5d8caSBarry Smith   PetscFunctionReturn(0);
219379f5d8caSBarry Smith }
219479f5d8caSBarry Smith 
219579f5d8caSBarry Smith /*@
21968931d482SJason Sarich    TaoSetIterationNumber - Sets the current iteration number.
21978931d482SJason Sarich 
21988931d482SJason Sarich    Not Collective
21998931d482SJason Sarich 
22008931d482SJason Sarich    Input Parameter:
22018931d482SJason Sarich .  tao - Tao context
22028931d482SJason Sarich .  iter - iteration number
22038931d482SJason Sarich 
22048931d482SJason Sarich    Level: developer
22058931d482SJason Sarich 
22068931d482SJason Sarich .keywords: Tao, nonlinear, set, iteration, number,
22078931d482SJason Sarich 
22088931d482SJason Sarich .seealso:   TaoGetLinearSolveIterations()
22098931d482SJason Sarich @*/
22108931d482SJason Sarich PetscErrorCode  TaoSetIterationNumber(Tao tao,PetscInt iter)
22118931d482SJason Sarich {
22128931d482SJason Sarich   PetscErrorCode ierr;
22138931d482SJason Sarich 
22148931d482SJason Sarich   PetscFunctionBegin;
22158931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
22168931d482SJason Sarich   ierr       = PetscObjectSAWsTakeAccess((PetscObject)tao);CHKERRQ(ierr);
22178931d482SJason Sarich   tao->niter = iter;
22188931d482SJason Sarich   ierr       = PetscObjectSAWsGrantAccess((PetscObject)tao);CHKERRQ(ierr);
22198931d482SJason Sarich   PetscFunctionReturn(0);
22208931d482SJason Sarich }
22218931d482SJason Sarich 
22228931d482SJason Sarich /*@
22238931d482SJason Sarich    TaoGetTotalIterationNumber - Gets the total number of Tao iterations
22248931d482SJason Sarich    completed. This number keeps accumulating if multiple solves
22258931d482SJason Sarich    are called with the Tao object.
22268931d482SJason Sarich 
22278931d482SJason Sarich    Not Collective
22288931d482SJason Sarich 
22298931d482SJason Sarich    Input Parameter:
22308931d482SJason Sarich .  tao - Tao context
22318931d482SJason Sarich 
22328931d482SJason Sarich    Output Parameter:
22338931d482SJason Sarich .  iter - iteration number
22348931d482SJason Sarich 
22358931d482SJason Sarich    Notes:
22368931d482SJason Sarich    The total iteration count is updated after each solve, if there is a current
22378931d482SJason Sarich    TaoSolve() in progress then those iterations are not yet counted.
22388931d482SJason Sarich 
22398931d482SJason Sarich    Level: intermediate
22408931d482SJason Sarich 
22418931d482SJason Sarich .keywords: Tao, nonlinear, get, iteration, number,
22428931d482SJason Sarich 
22438931d482SJason Sarich .seealso:   TaoGetLinearSolveIterations()
22448931d482SJason Sarich @*/
22458931d482SJason Sarich PetscErrorCode  TaoGetTotalIterationNumber(Tao tao,PetscInt *iter)
22468931d482SJason Sarich {
22478931d482SJason Sarich   PetscFunctionBegin;
22488931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
22498931d482SJason Sarich   PetscValidIntPointer(iter,2);
22508931d482SJason Sarich   *iter = tao->ntotalits;
22518931d482SJason Sarich   PetscFunctionReturn(0);
22528931d482SJason Sarich }
22538931d482SJason Sarich 
22548931d482SJason Sarich /*@
22558931d482SJason Sarich    TaoSetTotalIterationNumber - Sets the current total iteration number.
22568931d482SJason Sarich 
22578931d482SJason Sarich    Not Collective
22588931d482SJason Sarich 
22598931d482SJason Sarich    Input Parameter:
22608931d482SJason Sarich .  tao - Tao context
22618931d482SJason Sarich .  iter - iteration number
22628931d482SJason Sarich 
22638931d482SJason Sarich    Level: developer
22648931d482SJason Sarich 
22658931d482SJason Sarich .keywords: Tao, nonlinear, set, iteration, number,
22668931d482SJason Sarich 
22678931d482SJason Sarich .seealso:   TaoGetLinearSolveIterations()
22688931d482SJason Sarich @*/
22698931d482SJason Sarich PetscErrorCode  TaoSetTotalIterationNumber(Tao tao,PetscInt iter)
22708931d482SJason Sarich {
22718931d482SJason Sarich   PetscErrorCode ierr;
22728931d482SJason Sarich 
22738931d482SJason Sarich   PetscFunctionBegin;
22748931d482SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
22758931d482SJason Sarich   ierr       = PetscObjectSAWsTakeAccess((PetscObject)tao);CHKERRQ(ierr);
22768931d482SJason Sarich   tao->ntotalits = iter;
22778931d482SJason Sarich   ierr       = PetscObjectSAWsGrantAccess((PetscObject)tao);CHKERRQ(ierr);
22788931d482SJason Sarich   PetscFunctionReturn(0);
22798931d482SJason Sarich }
22808931d482SJason Sarich 
2281a7e14dcfSSatish Balay /*@
2282e4cb33bbSBarry Smith   TaoSetConvergedReason - Sets the termination flag on a Tao object
2283a7e14dcfSSatish Balay 
2284441846f8SBarry Smith   Logically Collective on Tao
2285a7e14dcfSSatish Balay 
2286a7e14dcfSSatish Balay   Input Parameters:
2287441846f8SBarry Smith + tao - the Tao context
2288a7e14dcfSSatish Balay - reason - one of
2289a7e14dcfSSatish Balay $     TAO_CONVERGED_ATOL (2),
2290a7e14dcfSSatish Balay $     TAO_CONVERGED_RTOL (3),
2291a7e14dcfSSatish Balay $     TAO_CONVERGED_STEPTOL (4),
2292a7e14dcfSSatish Balay $     TAO_CONVERGED_MINF (5),
2293a7e14dcfSSatish Balay $     TAO_CONVERGED_USER (6),
2294a7e14dcfSSatish Balay $     TAO_DIVERGED_MAXITS (-2),
2295a7e14dcfSSatish Balay $     TAO_DIVERGED_NAN (-4),
2296a7e14dcfSSatish Balay $     TAO_DIVERGED_MAXFCN (-5),
2297a7e14dcfSSatish Balay $     TAO_DIVERGED_LS_FAILURE (-6),
2298a7e14dcfSSatish Balay $     TAO_DIVERGED_TR_REDUCTION (-7),
2299a7e14dcfSSatish Balay $     TAO_DIVERGED_USER (-8),
2300a7e14dcfSSatish Balay $     TAO_CONTINUE_ITERATING (0)
2301a7e14dcfSSatish Balay 
2302a7e14dcfSSatish Balay    Level: intermediate
2303a7e14dcfSSatish Balay 
2304a7e14dcfSSatish Balay @*/
2305e4cb33bbSBarry Smith PetscErrorCode TaoSetConvergedReason(Tao tao, TaoConvergedReason reason)
2306a7e14dcfSSatish Balay {
2307441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2308a7e14dcfSSatish Balay   PetscFunctionBegin;
2309a7e14dcfSSatish Balay   tao->reason = reason;
2310a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2311a7e14dcfSSatish Balay }
2312a7e14dcfSSatish Balay 
2313a7e14dcfSSatish Balay /*@
2314e4cb33bbSBarry Smith    TaoGetConvergedReason - Gets the reason the Tao iteration was stopped.
2315a7e14dcfSSatish Balay 
2316a7e14dcfSSatish Balay    Not Collective
2317a7e14dcfSSatish Balay 
2318a7e14dcfSSatish Balay    Input Parameter:
2319441846f8SBarry Smith .  tao - the Tao solver context
2320a7e14dcfSSatish Balay 
2321a7e14dcfSSatish Balay    Output Parameter:
2322a7e14dcfSSatish Balay .  reason - one of
2323a7e14dcfSSatish Balay $  TAO_CONVERGED_GATOL (3)           ||g(X)|| < gatol
2324a7e14dcfSSatish Balay $  TAO_CONVERGED_GRTOL (4)           ||g(X)|| / f(X)  < grtol
2325a7e14dcfSSatish Balay $  TAO_CONVERGED_GTTOL (5)           ||g(X)|| / ||g(X0)|| < gttol
2326a7e14dcfSSatish Balay $  TAO_CONVERGED_STEPTOL (6)         step size small
2327a7e14dcfSSatish Balay $  TAO_CONVERGED_MINF (7)            F < F_min
2328a7e14dcfSSatish Balay $  TAO_CONVERGED_USER (8)            User defined
2329a7e14dcfSSatish Balay $  TAO_DIVERGED_MAXITS (-2)          its > maxits
2330a7e14dcfSSatish Balay $  TAO_DIVERGED_NAN (-4)             Numerical problems
2331a7e14dcfSSatish Balay $  TAO_DIVERGED_MAXFCN (-5)          fevals > max_funcsals
2332a7e14dcfSSatish Balay $  TAO_DIVERGED_LS_FAILURE (-6)      line search failure
2333a7e14dcfSSatish Balay $  TAO_DIVERGED_TR_REDUCTION (-7)    trust region failure
2334a7e14dcfSSatish Balay $  TAO_DIVERGED_USER(-8)             (user defined)
2335a7e14dcfSSatish Balay  $  TAO_CONTINUE_ITERATING (0)
2336a7e14dcfSSatish Balay 
2337a7e14dcfSSatish Balay    where
2338a7e14dcfSSatish Balay +  X - current solution
2339a7e14dcfSSatish Balay .  X0 - initial guess
2340a7e14dcfSSatish Balay .  f(X) - current function value
2341a7e14dcfSSatish Balay .  f(X*) - true solution (estimated)
2342a7e14dcfSSatish Balay .  g(X) - current gradient
2343a7e14dcfSSatish Balay .  its - current iterate number
2344a7e14dcfSSatish Balay .  maxits - maximum number of iterates
2345a7e14dcfSSatish Balay .  fevals - number of function evaluations
2346a7e14dcfSSatish Balay -  max_funcsals - maximum number of function evaluations
2347a7e14dcfSSatish Balay 
2348a7e14dcfSSatish Balay    Level: intermediate
2349a7e14dcfSSatish Balay 
2350a7e14dcfSSatish Balay .seealso: TaoSetConvergenceTest(), TaoSetTolerances()
2351a7e14dcfSSatish Balay 
2352a7e14dcfSSatish Balay @*/
2353e4cb33bbSBarry Smith PetscErrorCode TaoGetConvergedReason(Tao tao, TaoConvergedReason *reason)
2354a7e14dcfSSatish Balay {
2355a7e14dcfSSatish Balay   PetscFunctionBegin;
2356441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2357a7e14dcfSSatish Balay   PetscValidPointer(reason,2);
2358a7e14dcfSSatish Balay   *reason = tao->reason;
2359a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2360a7e14dcfSSatish Balay }
2361a7e14dcfSSatish Balay 
2362a7e14dcfSSatish Balay /*@
2363a7e14dcfSSatish Balay   TaoGetSolutionStatus - Get the current iterate, objective value,
2364a7e14dcfSSatish Balay   residual, infeasibility, and termination
2365a7e14dcfSSatish Balay 
2366a7e14dcfSSatish Balay   Not Collective
2367a7e14dcfSSatish Balay 
2368a7e14dcfSSatish Balay    Input Parameters:
2369441846f8SBarry Smith .  tao - the Tao context
2370a7e14dcfSSatish Balay 
2371a7e14dcfSSatish Balay    Output Parameters:
2372a7e14dcfSSatish Balay +  iterate - the current iterate number (>=0)
2373a7e14dcfSSatish Balay .  f - the current function value
237458417fe7SBarry Smith .  gnorm - the square of the gradient norm, duality gap, or other measure indicating distance from optimality.
2375a7e14dcfSSatish Balay .  cnorm - the infeasibility of the current solution with regard to the constraints.
2376a7e14dcfSSatish Balay .  xdiff - the step length or trust region radius of the most recent iterate.
2377a7e14dcfSSatish Balay -  reason - The termination reason, which can equal TAO_CONTINUE_ITERATING
2378a7e14dcfSSatish Balay 
2379a7e14dcfSSatish Balay    Level: intermediate
2380a7e14dcfSSatish Balay 
2381a7e14dcfSSatish Balay    Note:
2382a7e14dcfSSatish Balay    TAO returns the values set by the solvers in the routine TaoMonitor().
2383a7e14dcfSSatish Balay 
2384a7e14dcfSSatish Balay    Note:
238547a47007SBarry Smith    If any of the output arguments are set to NULL, no corresponding value will be returned.
2386a7e14dcfSSatish Balay 
2387e4cb33bbSBarry Smith .seealso: TaoMonitor(), TaoGetConvergedReason()
2388a7e14dcfSSatish Balay @*/
2389e4cb33bbSBarry Smith PetscErrorCode TaoGetSolutionStatus(Tao tao, PetscInt *its, PetscReal *f, PetscReal *gnorm, PetscReal *cnorm, PetscReal *xdiff, TaoConvergedReason *reason)
2390a7e14dcfSSatish Balay {
2391a7e14dcfSSatish Balay   PetscFunctionBegin;
2392a7e14dcfSSatish Balay   if (its) *its=tao->niter;
2393a7e14dcfSSatish Balay   if (f) *f=tao->fc;
2394a7e14dcfSSatish Balay   if (gnorm) *gnorm=tao->residual;
2395a7e14dcfSSatish Balay   if (cnorm) *cnorm=tao->cnorm;
2396a7e14dcfSSatish Balay   if (reason) *reason=tao->reason;
2397a7e14dcfSSatish Balay   if (xdiff) *xdiff=tao->step;
2398a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2399a7e14dcfSSatish Balay }
2400a7e14dcfSSatish Balay 
2401a7e14dcfSSatish Balay /*@C
2402441846f8SBarry Smith    TaoGetType - Gets the current Tao algorithm.
2403a7e14dcfSSatish Balay 
2404a7e14dcfSSatish Balay    Not Collective
2405a7e14dcfSSatish Balay 
2406a7e14dcfSSatish Balay    Input Parameter:
2407441846f8SBarry Smith .  tao - the Tao solver context
2408a7e14dcfSSatish Balay 
2409a7e14dcfSSatish Balay    Output Parameter:
2410441846f8SBarry Smith .  type - Tao method
2411a7e14dcfSSatish Balay 
2412a7e14dcfSSatish Balay    Level: intermediate
2413a7e14dcfSSatish Balay 
2414a7e14dcfSSatish Balay @*/
2415441846f8SBarry Smith PetscErrorCode TaoGetType(Tao tao, const TaoType *type)
2416a7e14dcfSSatish Balay {
2417a7e14dcfSSatish Balay   PetscFunctionBegin;
2418441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2419a7e14dcfSSatish Balay   PetscValidPointer(type,2);
2420a7e14dcfSSatish Balay   *type=((PetscObject)tao)->type_name;
2421a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2422a7e14dcfSSatish Balay }
2423a7e14dcfSSatish Balay 
2424a7e14dcfSSatish Balay /*@C
2425a7e14dcfSSatish Balay   TaoMonitor - Monitor the solver and the current solution.  This
2426a7e14dcfSSatish Balay   routine will record the iteration number and residual statistics,
2427a7e14dcfSSatish Balay   call any monitors specified by the user, and calls the convergence-check routine.
2428a7e14dcfSSatish Balay 
2429a7e14dcfSSatish Balay    Input Parameters:
2430441846f8SBarry Smith +  tao - the Tao context
2431a7e14dcfSSatish Balay .  its - the current iterate number (>=0)
2432a7e14dcfSSatish Balay .  f - the current objective function value
243358417fe7SBarry Smith .  res - the gradient norm, square root of the duality gap, or other measure indicating distince from optimality.  This measure will be recorded and
2434a7e14dcfSSatish Balay           used for some termination tests.
2435a7e14dcfSSatish Balay .  cnorm - the infeasibility of the current solution with regard to the constraints.
2436a7e14dcfSSatish Balay -  steplength - multiple of the step direction added to the previous iterate.
2437a7e14dcfSSatish Balay 
2438a7e14dcfSSatish Balay    Output Parameters:
2439a7e14dcfSSatish Balay .  reason - The termination reason, which can equal TAO_CONTINUE_ITERATING
2440a7e14dcfSSatish Balay 
2441a7e14dcfSSatish Balay    Options Database Key:
2442a7e14dcfSSatish Balay .  -tao_monitor - Use the default monitor, which prints statistics to standard output
2443a7e14dcfSSatish Balay 
244498ea980cSBarry Smith .seealso TaoGetConvergedReason(), TaoMonitorDefault(), TaoSetMonitor()
2445a7e14dcfSSatish Balay 
2446a7e14dcfSSatish Balay    Level: developer
2447a7e14dcfSSatish Balay 
2448a7e14dcfSSatish Balay @*/
24493ecd9318SAlp Dener PetscErrorCode TaoMonitor(Tao tao, PetscInt its, PetscReal f, PetscReal res, PetscReal cnorm, PetscReal steplength)
2450a7e14dcfSSatish Balay {
2451a7e14dcfSSatish Balay   PetscErrorCode ierr;
245247a47007SBarry Smith   PetscInt       i;
245347a47007SBarry Smith 
2454a7e14dcfSSatish Balay   PetscFunctionBegin;
2455441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2456a7e14dcfSSatish Balay   tao->fc = f;
2457a7e14dcfSSatish Balay   tao->residual = res;
2458a7e14dcfSSatish Balay   tao->cnorm = cnorm;
2459a7e14dcfSSatish Balay   tao->step = steplength;
2460e52336cbSBarry Smith   if (!its) {
2461a7e14dcfSSatish Balay     tao->cnorm0 = cnorm; tao->gnorm0 = res;
2462a7e14dcfSSatish Balay   }
246347a47007SBarry Smith   if (PetscIsInfOrNanReal(f) || PetscIsInfOrNanReal(res)) SETERRQ(PETSC_COMM_SELF,1, "User provided compute function generated Inf or NaN");
2464a7e14dcfSSatish Balay   for (i=0;i<tao->numbermonitors;i++) {
2465a7e14dcfSSatish Balay     ierr = (*tao->monitor[i])(tao,tao->monitorcontext[i]);CHKERRQ(ierr);
2466a7e14dcfSSatish Balay   }
2467a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2468a7e14dcfSSatish Balay }
2469a7e14dcfSSatish Balay 
2470a7e14dcfSSatish Balay /*@
2471ae93cb3cSJason Sarich    TaoSetConvergenceHistory - Sets the array used to hold the convergence history.
2472a7e14dcfSSatish Balay 
2473441846f8SBarry Smith    Logically Collective on Tao
2474a7e14dcfSSatish Balay 
2475a7e14dcfSSatish Balay    Input Parameters:
2476441846f8SBarry Smith +  tao - the Tao solver context
2477a7e14dcfSSatish Balay .  obj   - array to hold objective value history
2478a7e14dcfSSatish Balay .  resid - array to hold residual history
2479a7e14dcfSSatish Balay .  cnorm - array to hold constraint violation history
2480be1558d8SJason Sarich .  lits - integer array holds the number of linear iterations for each Tao iteration
2481a7e14dcfSSatish Balay .  na  - size of obj, resid, and cnorm
2482a7e14dcfSSatish Balay -  reset - PetscTrue indicates each new minimization resets the history counter to zero,
2483a7e14dcfSSatish Balay            else it continues storing new values for new minimizations after the old ones
2484a7e14dcfSSatish Balay 
2485a7e14dcfSSatish Balay    Notes:
2486a7e14dcfSSatish Balay    If set, TAO will fill the given arrays with the indicated
2487ae93cb3cSJason Sarich    information at each iteration.  If 'obj','resid','cnorm','lits' are
2488ae93cb3cSJason Sarich    *all* NULL then space (using size na, or 1000 if na is PETSC_DECIDE or
2489ae93cb3cSJason Sarich    PETSC_DEFAULT) is allocated for the history.
2490be1558d8SJason Sarich    If not all are NULL, then only the non-NULL information categories
2491ae93cb3cSJason Sarich    will be stored, the others will be ignored.
2492ae93cb3cSJason Sarich 
2493ae93cb3cSJason Sarich    Any convergence information after iteration number 'na' will not be stored.
2494a7e14dcfSSatish Balay 
2495a7e14dcfSSatish Balay    This routine is useful, e.g., when running a code for purposes
2496a7e14dcfSSatish Balay    of accurate performance monitoring, when no I/O should be done
2497a7e14dcfSSatish Balay    during the section of code that is being timed.
2498a7e14dcfSSatish Balay 
2499a7e14dcfSSatish Balay    Level: intermediate
2500a7e14dcfSSatish Balay 
2501ae93cb3cSJason Sarich .seealso: TaoGetConvergenceHistory()
2502a7e14dcfSSatish Balay 
2503a7e14dcfSSatish Balay @*/
25041b266c99SBarry Smith PetscErrorCode TaoSetConvergenceHistory(Tao tao, PetscReal obj[], PetscReal resid[], PetscReal cnorm[], PetscInt lits[], PetscInt na,PetscBool reset)
2505a7e14dcfSSatish Balay {
2506ae93cb3cSJason Sarich   PetscErrorCode ierr;
2507ae93cb3cSJason Sarich 
2508a7e14dcfSSatish Balay   PetscFunctionBegin;
2509441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2510ae93cb3cSJason Sarich   if (obj) PetscValidScalarPointer(obj,2);
2511ae93cb3cSJason Sarich   if (resid) PetscValidScalarPointer(resid,3);
2512ae93cb3cSJason Sarich   if (cnorm) PetscValidScalarPointer(cnorm,4);
2513ae93cb3cSJason Sarich   if (lits) PetscValidIntPointer(lits,5);
2514ae93cb3cSJason Sarich 
2515ae93cb3cSJason Sarich   if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000;
2516ae93cb3cSJason Sarich   if (!obj && !resid && !cnorm && !lits) {
2517ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&obj);CHKERRQ(ierr);
2518ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&resid);CHKERRQ(ierr);
2519ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&cnorm);CHKERRQ(ierr);
2520ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&lits);CHKERRQ(ierr);
2521ae93cb3cSJason Sarich     tao->hist_malloc=PETSC_TRUE;
2522ae93cb3cSJason Sarich   }
2523ae93cb3cSJason Sarich 
2524a7e14dcfSSatish Balay   tao->hist_obj = obj;
2525a7e14dcfSSatish Balay   tao->hist_resid = resid;
2526a7e14dcfSSatish Balay   tao->hist_cnorm = cnorm;
2527ae93cb3cSJason Sarich   tao->hist_lits = lits;
2528a7e14dcfSSatish Balay   tao->hist_max   = na;
2529a7e14dcfSSatish Balay   tao->hist_reset = reset;
2530ae93cb3cSJason Sarich   tao->hist_len = 0;
2531a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2532a7e14dcfSSatish Balay }
2533a7e14dcfSSatish Balay 
2534a7e14dcfSSatish Balay /*@C
2535ae93cb3cSJason Sarich    TaoGetConvergenceHistory - Gets the arrays used to hold the convergence history.
2536a7e14dcfSSatish Balay 
2537441846f8SBarry Smith    Collective on Tao
2538a7e14dcfSSatish Balay 
2539a7e14dcfSSatish Balay    Input Parameter:
2540441846f8SBarry Smith .  tao - the Tao context
2541a7e14dcfSSatish Balay 
2542a7e14dcfSSatish Balay    Output Parameters:
2543a7e14dcfSSatish Balay +  obj   - array used to hold objective value history
2544a7e14dcfSSatish Balay .  resid - array used to hold residual history
2545a7e14dcfSSatish Balay .  cnorm - array used to hold constraint violation history
2546ae93cb3cSJason Sarich .  lits  - integer array used to hold linear solver iteration count
2547ae93cb3cSJason Sarich -  nhist  - size of obj, resid, cnorm, and lits (will be less than or equal to na given in TaoSetHistory)
2548a7e14dcfSSatish Balay 
2549a7e14dcfSSatish Balay    Notes:
2550ae93cb3cSJason Sarich     This routine must be preceded by calls to TaoSetConvergenceHistory()
2551ae93cb3cSJason Sarich     and TaoSolve(), otherwise it returns useless information.
2552ae93cb3cSJason Sarich 
2553a7e14dcfSSatish Balay     The calling sequence for this routine in Fortran is
2554ae93cb3cSJason Sarich $   call TaoGetConvergenceHistory(Tao tao, PetscInt nhist, PetscErrorCode ierr)
2555a7e14dcfSSatish Balay 
2556a7e14dcfSSatish Balay    This routine is useful, e.g., when running a code for purposes
2557a7e14dcfSSatish Balay    of accurate performance monitoring, when no I/O should be done
2558a7e14dcfSSatish Balay    during the section of code that is being timed.
2559a7e14dcfSSatish Balay 
2560a7e14dcfSSatish Balay    Level: advanced
2561a7e14dcfSSatish Balay 
2562ae93cb3cSJason Sarich .seealso: TaoSetConvergenceHistory()
2563a7e14dcfSSatish Balay 
2564a7e14dcfSSatish Balay @*/
2565ae93cb3cSJason Sarich PetscErrorCode TaoGetConvergenceHistory(Tao tao, PetscReal **obj, PetscReal **resid, PetscReal **cnorm, PetscInt **lits, PetscInt *nhist)
2566a7e14dcfSSatish Balay {
2567a7e14dcfSSatish Balay   PetscFunctionBegin;
2568441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2569a7e14dcfSSatish Balay   if (obj)   *obj   = tao->hist_obj;
2570a7e14dcfSSatish Balay   if (cnorm) *cnorm = tao->hist_cnorm;
2571a7e14dcfSSatish Balay   if (resid) *resid = tao->hist_resid;
2572a7e14dcfSSatish Balay   if (nhist) *nhist   = tao->hist_len;
2573a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2574a7e14dcfSSatish Balay }
2575a7e14dcfSSatish Balay 
2576a7e14dcfSSatish Balay /*@
2577a7e14dcfSSatish Balay    TaoSetApplicationContext - Sets the optional user-defined context for
2578a7e14dcfSSatish Balay    a solver.
2579a7e14dcfSSatish Balay 
2580441846f8SBarry Smith    Logically Collective on Tao
2581a7e14dcfSSatish Balay 
2582a7e14dcfSSatish Balay    Input Parameters:
2583441846f8SBarry Smith +  tao  - the Tao context
2584a7e14dcfSSatish Balay -  usrP - optional user context
2585a7e14dcfSSatish Balay 
2586a7e14dcfSSatish Balay    Level: intermediate
2587a7e14dcfSSatish Balay 
2588a7e14dcfSSatish Balay .seealso: TaoGetApplicationContext(), TaoSetApplicationContext()
2589a7e14dcfSSatish Balay @*/
2590441846f8SBarry Smith PetscErrorCode  TaoSetApplicationContext(Tao tao,void *usrP)
2591a7e14dcfSSatish Balay {
2592a7e14dcfSSatish Balay   PetscFunctionBegin;
2593441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2594a7e14dcfSSatish Balay   tao->user = usrP;
2595a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2596a7e14dcfSSatish Balay }
2597a7e14dcfSSatish Balay 
2598a7e14dcfSSatish Balay /*@
2599a7e14dcfSSatish Balay    TaoGetApplicationContext - Gets the user-defined context for a
2600a7e14dcfSSatish Balay    TAO solvers.
2601a7e14dcfSSatish Balay 
2602a7e14dcfSSatish Balay    Not Collective
2603a7e14dcfSSatish Balay 
2604a7e14dcfSSatish Balay    Input Parameter:
2605441846f8SBarry Smith .  tao  - Tao context
2606a7e14dcfSSatish Balay 
2607a7e14dcfSSatish Balay    Output Parameter:
2608a7e14dcfSSatish Balay .  usrP - user context
2609a7e14dcfSSatish Balay 
2610a7e14dcfSSatish Balay    Level: intermediate
2611a7e14dcfSSatish Balay 
2612a7e14dcfSSatish Balay .seealso: TaoSetApplicationContext()
2613a7e14dcfSSatish Balay @*/
2614441846f8SBarry Smith PetscErrorCode  TaoGetApplicationContext(Tao tao,void *usrP)
2615a7e14dcfSSatish Balay {
2616a7e14dcfSSatish Balay   PetscFunctionBegin;
2617441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2618a7e14dcfSSatish Balay   *(void**)usrP = tao->user;
2619a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2620a7e14dcfSSatish Balay }
2621a9603a14SPatrick Farrell 
2622a9603a14SPatrick Farrell /*@
2623a9603a14SPatrick Farrell    TaoSetGradientNorm - Sets the matrix used to define the inner product that measures the size of the gradient.
2624a9603a14SPatrick Farrell 
2625a9603a14SPatrick Farrell    Collective on tao
2626a9603a14SPatrick Farrell 
2627a9603a14SPatrick Farrell    Input Parameters:
2628a9603a14SPatrick Farrell +  tao  - the Tao context
2629a9603a14SPatrick Farrell -  M    - gradient norm
2630a9603a14SPatrick Farrell 
2631a9603a14SPatrick Farrell    Level: beginner
2632a9603a14SPatrick Farrell 
2633a9603a14SPatrick Farrell .seealso: TaoGetGradientNorm(), TaoGradientNorm()
2634a9603a14SPatrick Farrell @*/
2635a9603a14SPatrick Farrell PetscErrorCode  TaoSetGradientNorm(Tao tao, Mat M)
2636a9603a14SPatrick Farrell {
2637a9603a14SPatrick Farrell   PetscErrorCode ierr;
2638a9603a14SPatrick Farrell 
2639a9603a14SPatrick Farrell   PetscFunctionBegin;
2640a9603a14SPatrick Farrell   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2641a9603a14SPatrick Farrell 
2642a9603a14SPatrick Farrell   if (tao->gradient_norm) {
2643a9603a14SPatrick Farrell     ierr = PetscObjectDereference((PetscObject)tao->gradient_norm);CHKERRQ(ierr);
2644a9603a14SPatrick Farrell     ierr = VecDestroy(&tao->gradient_norm_tmp);CHKERRQ(ierr);
2645a9603a14SPatrick Farrell   }
2646a9603a14SPatrick Farrell 
2647a9603a14SPatrick Farrell   ierr = PetscObjectReference((PetscObject)M);CHKERRQ(ierr);
2648a9603a14SPatrick Farrell   tao->gradient_norm = M;
2649a9603a14SPatrick Farrell   ierr = MatCreateVecs(M, NULL, &tao->gradient_norm_tmp);CHKERRQ(ierr);
2650a9603a14SPatrick Farrell   PetscFunctionReturn(0);
2651a9603a14SPatrick Farrell }
2652a9603a14SPatrick Farrell 
2653a9603a14SPatrick Farrell /*@
2654a9603a14SPatrick Farrell    TaoGetGradientNorm - Returns the matrix used to define the inner product for measuring the size of the gradient.
2655a9603a14SPatrick Farrell 
2656a9603a14SPatrick Farrell    Not Collective
2657a9603a14SPatrick Farrell 
2658a9603a14SPatrick Farrell    Input Parameter:
2659a9603a14SPatrick Farrell .  tao  - Tao context
2660a9603a14SPatrick Farrell 
2661a9603a14SPatrick Farrell    Output Parameter:
2662a9603a14SPatrick Farrell .  M - gradient norm
2663a9603a14SPatrick Farrell 
2664a9603a14SPatrick Farrell    Level: beginner
2665a9603a14SPatrick Farrell 
2666a9603a14SPatrick Farrell .seealso: TaoSetGradientNorm(), TaoGradientNorm()
2667a9603a14SPatrick Farrell @*/
2668a9603a14SPatrick Farrell PetscErrorCode  TaoGetGradientNorm(Tao tao, Mat *M)
2669a9603a14SPatrick Farrell {
2670a9603a14SPatrick Farrell   PetscFunctionBegin;
2671a9603a14SPatrick Farrell   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2672a9603a14SPatrick Farrell   *M = tao->gradient_norm;
2673a9603a14SPatrick Farrell   PetscFunctionReturn(0);
2674a9603a14SPatrick Farrell }
2675a9603a14SPatrick Farrell 
2676a9603a14SPatrick Farrell /*c
2677a9603a14SPatrick Farrell    TaoGradientNorm - Compute the norm with respect to the inner product the user has set.
2678a9603a14SPatrick Farrell 
2679a9603a14SPatrick Farrell    Collective on tao
2680a9603a14SPatrick Farrell 
2681a9603a14SPatrick Farrell    Input Parameter:
2682a9603a14SPatrick Farrell .  tao      - the Tao context
2683a9603a14SPatrick Farrell .  gradient - the gradient to be computed
2684a9603a14SPatrick Farrell .  norm     - the norm type
2685a9603a14SPatrick Farrell 
2686a9603a14SPatrick Farrell    Output Parameter:
2687a9603a14SPatrick Farrell .  gnorm    - the gradient norm
2688a9603a14SPatrick Farrell 
2689a9603a14SPatrick Farrell    Level: developer
2690a9603a14SPatrick Farrell 
2691a9603a14SPatrick Farrell .seealso: TaoSetGradientNorm(), TaoGetGradientNorm()
2692a9603a14SPatrick Farrell @*/
2693a9603a14SPatrick Farrell PetscErrorCode  TaoGradientNorm(Tao tao, Vec gradient, NormType type, PetscReal *gnorm)
2694a9603a14SPatrick Farrell {
2695a9603a14SPatrick Farrell   PetscErrorCode ierr;
2696a9603a14SPatrick Farrell 
2697a9603a14SPatrick Farrell   PetscFunctionBegin;
2698a9603a14SPatrick Farrell   PetscValidHeaderSpecific(gradient,VEC_CLASSID,1);
2699a9603a14SPatrick Farrell 
2700a9603a14SPatrick Farrell   if (tao->gradient_norm) {
2701680e2bc7SPatrick Farrell     PetscScalar gnorms;
2702680e2bc7SPatrick Farrell 
2703a9603a14SPatrick Farrell     if (type != NORM_2) SETERRQ(PetscObjectComm((PetscObject)gradient), PETSC_ERR_ARG_WRONGSTATE, "Norm type must be NORM_2 if an inner product for the gradient norm is set.");
2704a9603a14SPatrick Farrell     ierr = MatMult(tao->gradient_norm, gradient, tao->gradient_norm_tmp);CHKERRQ(ierr);
2705680e2bc7SPatrick Farrell     ierr = VecDot(gradient, tao->gradient_norm_tmp, &gnorms);CHKERRQ(ierr);
27067bb79937SPatrick Farrell     *gnorm = PetscRealPart(PetscSqrtScalar(gnorms));
2707a9603a14SPatrick Farrell   } else {
2708a9603a14SPatrick Farrell     ierr = VecNorm(gradient, type, gnorm);CHKERRQ(ierr);
2709a9603a14SPatrick Farrell   }
2710a9603a14SPatrick Farrell   PetscFunctionReturn(0);
2711a9603a14SPatrick Farrell }
2712a9603a14SPatrick Farrell 
2713e882e171SHong Zhang /*@C
2714e882e171SHong Zhang    TaoMonitorDrawCtxCreate - Creates the monitor context for TaoMonitorDrawCtx
2715a9603a14SPatrick Farrell 
2716e882e171SHong Zhang    Collective on Tao
2717e882e171SHong Zhang 
2718e882e171SHong Zhang    Output Patameter:
2719e882e171SHong Zhang .    ctx - the monitor context
2720e882e171SHong Zhang 
2721e882e171SHong Zhang    Options Database:
2722e882e171SHong Zhang .   -tao_draw_solution_initial - show initial guess as well as current solution
2723e882e171SHong Zhang 
2724e882e171SHong Zhang    Level: intermediate
2725e882e171SHong Zhang 
2726e882e171SHong Zhang .keywords: Tao,  vector, monitor, view
2727e882e171SHong Zhang 
2728e882e171SHong Zhang .seealso: TaoMonitorSet(), TaoMonitorDefault(), VecView(), TaoMonitorDrawCtx()
2729e882e171SHong Zhang @*/
2730e882e171SHong Zhang PetscErrorCode  TaoMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TaoMonitorDrawCtx *ctx)
2731e882e171SHong Zhang {
2732e882e171SHong Zhang   PetscErrorCode   ierr;
2733e882e171SHong Zhang 
2734e882e171SHong Zhang   PetscFunctionBegin;
2735e882e171SHong Zhang   ierr = PetscNew(ctx);CHKERRQ(ierr);
2736e882e171SHong Zhang   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
2737e882e171SHong Zhang   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
2738e882e171SHong Zhang   (*ctx)->howoften = howoften;
2739e882e171SHong Zhang   PetscFunctionReturn(0);
2740e882e171SHong Zhang }
2741e882e171SHong Zhang 
2742e882e171SHong Zhang /*@C
2743e882e171SHong Zhang    TaoMonitorDrawCtxDestroy - Destroys the monitor context for TaoMonitorDrawSolution()
2744e882e171SHong Zhang 
2745e882e171SHong Zhang    Collective on Tao
2746e882e171SHong Zhang 
2747e882e171SHong Zhang    Input Parameters:
2748e882e171SHong Zhang .    ctx - the monitor context
2749e882e171SHong Zhang 
2750e882e171SHong Zhang    Level: intermediate
2751e882e171SHong Zhang 
2752e882e171SHong Zhang .keywords: Tao,  vector, monitor, view
2753e882e171SHong Zhang 
2754e882e171SHong Zhang .seealso: TaoMonitorSet(), TaoMonitorDefault(), VecView(), TaoMonitorDrawSolution()
2755e882e171SHong Zhang @*/
2756e882e171SHong Zhang PetscErrorCode  TaoMonitorDrawCtxDestroy(TaoMonitorDrawCtx *ictx)
2757e882e171SHong Zhang {
2758e882e171SHong Zhang   PetscErrorCode ierr;
2759e882e171SHong Zhang 
2760e882e171SHong Zhang   PetscFunctionBegin;
2761e882e171SHong Zhang   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
2762e882e171SHong Zhang   ierr = PetscFree(*ictx);CHKERRQ(ierr);
2763e882e171SHong Zhang   PetscFunctionReturn(0);
2764e882e171SHong Zhang }
2765