xref: /petsc/src/tao/interface/taosolver.c (revision 2d9aa51bd4e54bdb7dc3042b9d4a676eba5efc58)
1441846f8SBarry Smith #define TAO_DLL
2a7e14dcfSSatish Balay 
3ba92ff59SBarry Smith #include <petsc-private/taoimpl.h> /*I "petsctao.h" I*/
4a7e14dcfSSatish Balay 
5441846f8SBarry Smith PetscBool TaoRegisterAllCalled = PETSC_FALSE;
6441846f8SBarry Smith PetscFunctionList TaoList = NULL;
7a7e14dcfSSatish Balay 
8441846f8SBarry Smith PetscClassId TAO_CLASSID;
9441846f8SBarry Smith PetscLogEvent Tao_Solve, Tao_ObjectiveEval, Tao_GradientEval, Tao_ObjGradientEval, Tao_HessianEval, Tao_ConstraintsEval, Tao_JacobianEval;
10a7e14dcfSSatish Balay 
115b0d99aeSBarry Smith const char *TaoSubSetTypes[] = {  "subvec","mask","matrixfree","TaoSubSetType","TAO_SUBSET_",0};
12a7e14dcfSSatish Balay 
13a7e14dcfSSatish Balay #undef __FUNCT__
14a7e14dcfSSatish Balay #define __FUNCT__ "TaoCreate"
15a7e14dcfSSatish Balay /*@
16a7e14dcfSSatish Balay   TaoCreate - Creates a TAO solver
17a7e14dcfSSatish Balay 
18a7e14dcfSSatish Balay   Collective on MPI_Comm
19a7e14dcfSSatish Balay 
20a7e14dcfSSatish Balay   Input Parameter:
21a7e14dcfSSatish Balay . comm - MPI communicator
22a7e14dcfSSatish Balay 
23a7e14dcfSSatish Balay   Output Parameter:
24441846f8SBarry Smith . newtao - the new Tao context
25a7e14dcfSSatish Balay 
26a7e14dcfSSatish Balay   Available methods include:
2758417fe7SBarry Smith +    nls - Newton's method with line search for unconstrained minimization
2858417fe7SBarry Smith .    ntr - Newton's method with trust region for unconstrained minimization
2958417fe7SBarry Smith .    ntl - Newton's method with trust region, line search for unconstrained minimization
3058417fe7SBarry Smith .    lmvm - Limited memory variable metric method for unconstrained minimization
3158417fe7SBarry Smith .    cg - Nonlinear conjugate gradient method for unconstrained minimization
3258417fe7SBarry Smith .    nm - Nelder-Mead algorithm for derivate-free unconstrained minimization
3358417fe7SBarry Smith .    tron - Newton Trust Region method for bound constrained minimization
3458417fe7SBarry Smith .    gpcg - Newton Trust Region method for quadratic bound constrained minimization
3558417fe7SBarry Smith .    blmvm - Limited memory variable metric method for bound constrained minimization
3658417fe7SBarry Smith .    lcl - Linearly constrained Lagrangian method for pde-constrained minimization
3758417fe7SBarry Smith -    pounders - Model-based algorithm for nonlinear least squares
38a7e14dcfSSatish Balay 
39a7e14dcfSSatish Balay    Options Database Keys:
4058417fe7SBarry Smith .   -tao_type - select which method TAO should use
41a7e14dcfSSatish Balay 
42a7e14dcfSSatish Balay    Level: beginner
43a7e14dcfSSatish Balay 
44a7e14dcfSSatish Balay .seealso: TaoSolve(), TaoDestroy()
45a7e14dcfSSatish Balay @*/
46441846f8SBarry Smith PetscErrorCode TaoCreate(MPI_Comm comm, Tao *newtao)
47a7e14dcfSSatish Balay {
48a7e14dcfSSatish Balay   PetscErrorCode ierr;
49441846f8SBarry Smith   Tao            tao;
50a7e14dcfSSatish Balay 
51a7e14dcfSSatish Balay   PetscFunctionBegin;
52a7e14dcfSSatish Balay   PetscValidPointer(newtao,2);
5347a47007SBarry Smith   *newtao = NULL;
54a7e14dcfSSatish Balay 
55a7e14dcfSSatish Balay   ierr = TaoInitializePackage();CHKERRQ(ierr);
56a7e14dcfSSatish Balay   ierr = TaoLineSearchInitializePackage();CHKERRQ(ierr);
57a7e14dcfSSatish Balay 
58441846f8SBarry Smith   ierr = PetscHeaderCreate(tao,_p_Tao, struct _TaoOps, TAO_CLASSID,"Tao",0,0,comm,TaoDestroy,TaoView);CHKERRQ(ierr);
59a7e14dcfSSatish Balay   tao->ops->computeobjective=0;
60a7e14dcfSSatish Balay   tao->ops->computeobjectiveandgradient=0;
61a7e14dcfSSatish Balay   tao->ops->computegradient=0;
62a7e14dcfSSatish Balay   tao->ops->computehessian=0;
63a7e14dcfSSatish Balay   tao->ops->computeseparableobjective=0;
64a7e14dcfSSatish Balay   tao->ops->computeconstraints=0;
65a7e14dcfSSatish Balay   tao->ops->computejacobian=0;
66a7e14dcfSSatish Balay   tao->ops->computejacobianequality=0;
67a7e14dcfSSatish Balay   tao->ops->computejacobianinequality=0;
68a7e14dcfSSatish Balay   tao->ops->computeequalityconstraints=0;
69a7e14dcfSSatish Balay   tao->ops->computeinequalityconstraints=0;
70a7e14dcfSSatish Balay   tao->ops->convergencetest=TaoDefaultConvergenceTest;
71a7e14dcfSSatish Balay   tao->ops->convergencedestroy=0;
72a7e14dcfSSatish Balay   tao->ops->computedual=0;
73a7e14dcfSSatish Balay   tao->ops->setup=0;
74a7e14dcfSSatish Balay   tao->ops->solve=0;
75a7e14dcfSSatish Balay   tao->ops->view=0;
76a7e14dcfSSatish Balay   tao->ops->setfromoptions=0;
77a7e14dcfSSatish Balay   tao->ops->destroy=0;
78a7e14dcfSSatish Balay 
7947a47007SBarry Smith   tao->solution=NULL;
8047a47007SBarry Smith   tao->gradient=NULL;
8147a47007SBarry Smith   tao->sep_objective = NULL;
8247a47007SBarry Smith   tao->constraints=NULL;
8347a47007SBarry Smith   tao->constraints_equality=NULL;
8447a47007SBarry Smith   tao->constraints_inequality=NULL;
8547a47007SBarry Smith   tao->stepdirection=NULL;
8647a47007SBarry Smith   tao->XL = NULL;
8747a47007SBarry Smith   tao->XU = NULL;
8847a47007SBarry Smith   tao->IL = NULL;
8947a47007SBarry Smith   tao->IU = NULL;
9047a47007SBarry Smith   tao->DI = NULL;
9147a47007SBarry Smith   tao->DE = NULL;
9247a47007SBarry Smith   tao->hessian = NULL;
9347a47007SBarry Smith   tao->hessian_pre = NULL;
9447a47007SBarry Smith   tao->jacobian = NULL;
9547a47007SBarry Smith   tao->jacobian_pre = NULL;
9647a47007SBarry Smith   tao->jacobian_state = NULL;
9747a47007SBarry Smith   tao->jacobian_state_pre = NULL;
9847a47007SBarry Smith   tao->jacobian_state_inv = NULL;
9947a47007SBarry Smith   tao->jacobian_design = NULL;
10047a47007SBarry Smith   tao->jacobian_design_pre = NULL;
10147a47007SBarry Smith   tao->jacobian_equality = NULL;
10247a47007SBarry Smith   tao->jacobian_equality_pre = NULL;
10347a47007SBarry Smith   tao->jacobian_inequality = NULL;
10447a47007SBarry Smith   tao->jacobian_inequality_pre = NULL;
10547a47007SBarry Smith   tao->state_is = NULL;
10647a47007SBarry Smith   tao->design_is = NULL;
107a7e14dcfSSatish Balay 
108a7e14dcfSSatish Balay   tao->max_it     = 10000;
109a7e14dcfSSatish Balay   tao->max_funcs   = 10000;
1106f4723b1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
1116f4723b1SBarry Smith   tao->fatol       = 1e-5;
1126f4723b1SBarry Smith   tao->frtol       = 1e-5;
1136f4723b1SBarry Smith   tao->gatol       = 1e-5;
1146f4723b1SBarry Smith   tao->grtol       = 1e-5;
1156f4723b1SBarry Smith #else
116a7e14dcfSSatish Balay   tao->fatol       = 1e-8;
117a7e14dcfSSatish Balay   tao->frtol       = 1e-8;
118a7e14dcfSSatish Balay   tao->gatol       = 1e-8;
119a7e14dcfSSatish Balay   tao->grtol       = 1e-8;
1206f4723b1SBarry Smith #endif
121a7e14dcfSSatish Balay   tao->gttol       = 0.0;
122a7e14dcfSSatish Balay   tao->catol       = 0.0;
123a7e14dcfSSatish Balay   tao->crtol       = 0.0;
124a7e14dcfSSatish Balay   tao->xtol        = 0.0;
125a7e14dcfSSatish Balay   tao->steptol     = 0.0;
126e270355aSBarry Smith   tao->trust0      = PETSC_INFINITY;
1276f4723b1SBarry Smith   tao->fmin        = PETSC_NINFINITY;
128ae93cb3cSJason Sarich   tao->hist_malloc = PETSC_FALSE;
129a7e14dcfSSatish Balay   tao->hist_reset = PETSC_TRUE;
130a7e14dcfSSatish Balay   tao->hist_max = 0;
131a7e14dcfSSatish Balay   tao->hist_len = 0;
13247a47007SBarry Smith   tao->hist_obj = NULL;
13347a47007SBarry Smith   tao->hist_resid = NULL;
13447a47007SBarry Smith   tao->hist_cnorm = NULL;
135ae93cb3cSJason Sarich   tao->hist_lits = NULL;
136a7e14dcfSSatish Balay 
137a7e14dcfSSatish Balay   tao->numbermonitors=0;
138a7e14dcfSSatish Balay   tao->viewsolution=PETSC_FALSE;
139a7e14dcfSSatish Balay   tao->viewhessian=PETSC_FALSE;
140a7e14dcfSSatish Balay   tao->viewgradient=PETSC_FALSE;
141a7e14dcfSSatish Balay   tao->viewjacobian=PETSC_FALSE;
142a7e14dcfSSatish Balay   tao->viewconstraints = PETSC_FALSE;
143a7e14dcfSSatish Balay 
144a7e14dcfSSatish Balay   ierr = TaoResetStatistics(tao);CHKERRQ(ierr);
145a7e14dcfSSatish Balay   *newtao = tao;
146a7e14dcfSSatish Balay   PetscFunctionReturn(0);
147a7e14dcfSSatish Balay }
148a7e14dcfSSatish Balay 
149a7e14dcfSSatish Balay #undef __FUNCT__
150a7e14dcfSSatish Balay #define __FUNCT__ "TaoSolve"
151a7e14dcfSSatish Balay /*@
152a7e14dcfSSatish Balay   TaoSolve - Solves an optimization problem min F(x) s.t. l <= x <= u
153a7e14dcfSSatish Balay 
154441846f8SBarry Smith   Collective on Tao
155a7e14dcfSSatish Balay 
156a7e14dcfSSatish Balay   Input Parameters:
157441846f8SBarry Smith . tao - the Tao context
158a7e14dcfSSatish Balay 
159a7e14dcfSSatish Balay   Notes:
160441846f8SBarry Smith   The user must set up the Tao with calls to TaoSetInitialVector(),
161a7e14dcfSSatish Balay   TaoSetObjectiveRoutine(),
162a7e14dcfSSatish Balay   TaoSetGradientRoutine(), and (if using 2nd order method) TaoSetHessianRoutine().
163a7e14dcfSSatish Balay 
164a7e14dcfSSatish Balay   Level: beginner
165a7e14dcfSSatish Balay 
166a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSetObjectiveRoutine(), TaoSetGradientRoutine(), TaoSetHessianRoutine()
167a7e14dcfSSatish Balay  @*/
168441846f8SBarry Smith PetscErrorCode TaoSolve(Tao tao)
169a7e14dcfSSatish Balay {
170a7e14dcfSSatish Balay   PetscErrorCode   ierr;
171e2379f4fSBarry Smith   static PetscBool set = PETSC_FALSE;
17247a47007SBarry Smith 
173a7e14dcfSSatish Balay   PetscFunctionBegin;
174441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
175e2379f4fSBarry Smith   ierr = PetscCitationsRegister("@TechReport{tao-user-ref,\n"
176e2379f4fSBarry Smith                                 "title   = {Toolkit for Advanced Optimization (TAO) Users Manual},\n"
177e2379f4fSBarry Smith                                 "author  = {Todd Munson and Jason Sarich and Stefan Wild and Steve Benson and Lois Curfman McInnes},\n"
178e2379f4fSBarry Smith                                 "Institution = {Argonne National Laboratory},\n"
179e2379f4fSBarry Smith                                 "Year   = 2014,\n"
180e2379f4fSBarry Smith                                 "Number = {ANL/MCS-TM-322 - Revision 3.5},\n"
181e2379f4fSBarry Smith                                 "url    = {http://www.mcs.anl.gov/tao}\n}\n",&set);
182e2379f4fSBarry Smith 
183a7e14dcfSSatish Balay   ierr = TaoSetUp(tao);CHKERRQ(ierr);
184a7e14dcfSSatish Balay   ierr = TaoResetStatistics(tao);CHKERRQ(ierr);
185a7e14dcfSSatish Balay   if (tao->linesearch) {
186a7e14dcfSSatish Balay     ierr = TaoLineSearchReset(tao->linesearch);CHKERRQ(ierr);
187a7e14dcfSSatish Balay   }
188a7e14dcfSSatish Balay 
189441846f8SBarry Smith   ierr = PetscLogEventBegin(Tao_Solve,tao,0,0,0);CHKERRQ(ierr);
190a7e14dcfSSatish Balay   if (tao->ops->solve){ ierr = (*tao->ops->solve)(tao);CHKERRQ(ierr); }
191441846f8SBarry Smith   ierr = PetscLogEventEnd(Tao_Solve,tao,0,0,0);CHKERRQ(ierr);
192a7e14dcfSSatish Balay 
193fbe0838dSJason Sarich   ierr = TaoViewFromOptions(tao,NULL,"-tao_view");CHKERRQ(ierr);
194a7e14dcfSSatish Balay 
195a7e14dcfSSatish Balay   if (tao->printreason) {
196a7e14dcfSSatish Balay     if (tao->reason > 0) {
197e4cb33bbSBarry Smith       ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve converged due to %s\n",TaoConvergedReasons[tao->reason]);CHKERRQ(ierr);
198a7e14dcfSSatish Balay     } else {
199e4cb33bbSBarry Smith       ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve did not converge due to %s\n",TaoConvergedReasons[tao->reason]);CHKERRQ(ierr);
200a7e14dcfSSatish Balay     }
201a7e14dcfSSatish Balay   }
202a7e14dcfSSatish Balay   PetscFunctionReturn(0);
203a7e14dcfSSatish Balay }
204a7e14dcfSSatish Balay 
205a7e14dcfSSatish Balay #undef __FUNCT__
206a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetUp"
207a7e14dcfSSatish Balay /*@
208a7e14dcfSSatish Balay   TaoSetUp - Sets up the internal data structures for the later use
209a7e14dcfSSatish Balay   of a Tao solver
210a7e14dcfSSatish Balay 
211a7e14dcfSSatish Balay   Collective on tao
212a7e14dcfSSatish Balay 
213a7e14dcfSSatish Balay   Input Parameters:
214a7e14dcfSSatish Balay . tao - the TAO context
215a7e14dcfSSatish Balay 
216a7e14dcfSSatish Balay   Notes:
217a7e14dcfSSatish Balay   The user will not need to explicitly call TaoSetUp(), as it will
218a7e14dcfSSatish Balay   automatically be called in TaoSolve().  However, if the user
219a7e14dcfSSatish Balay   desires to call it explicitly, it should come after TaoCreate()
220a7e14dcfSSatish Balay   and any TaoSetSomething() routines, but before TaoSolve().
221a7e14dcfSSatish Balay 
222a7e14dcfSSatish Balay   Level: advanced
223a7e14dcfSSatish Balay 
224a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
225a7e14dcfSSatish Balay @*/
226441846f8SBarry Smith PetscErrorCode TaoSetUp(Tao tao)
227a7e14dcfSSatish Balay {
228a7e14dcfSSatish Balay   PetscErrorCode ierr;
22947a47007SBarry Smith 
230a7e14dcfSSatish Balay   PetscFunctionBegin;
231441846f8SBarry Smith   PetscValidHeaderSpecific(tao, TAO_CLASSID,1);
232a7e14dcfSSatish Balay   if (tao->setupcalled) PetscFunctionReturn(0);
233a7e14dcfSSatish Balay 
23447a47007SBarry Smith   if (!tao->solution) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TaoSetInitialVector");
235a7e14dcfSSatish Balay   if (tao->ops->setup) {
236a7e14dcfSSatish Balay     ierr = (*tao->ops->setup)(tao);CHKERRQ(ierr);
237a7e14dcfSSatish Balay   }
238a7e14dcfSSatish Balay   tao->setupcalled = PETSC_TRUE;
239a7e14dcfSSatish Balay   PetscFunctionReturn(0);
240a7e14dcfSSatish Balay }
241a7e14dcfSSatish Balay 
242a7e14dcfSSatish Balay #undef __FUNCT__
243a7e14dcfSSatish Balay #define __FUNCT__ "TaoDestroy"
244a7e14dcfSSatish Balay /*@
245a7e14dcfSSatish Balay   TaoDestroy - Destroys the TAO context that was created with
246a7e14dcfSSatish Balay   TaoCreate()
247a7e14dcfSSatish Balay 
248441846f8SBarry Smith   Collective on Tao
249a7e14dcfSSatish Balay 
250a7e14dcfSSatish Balay   Input Parameter:
251441846f8SBarry Smith . tao - the Tao context
252a7e14dcfSSatish Balay 
253a7e14dcfSSatish Balay   Level: beginner
254a7e14dcfSSatish Balay 
255a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
256a7e14dcfSSatish Balay @*/
257441846f8SBarry Smith PetscErrorCode TaoDestroy(Tao *tao)
258a7e14dcfSSatish Balay {
259a7e14dcfSSatish Balay   PetscErrorCode ierr;
26047a47007SBarry Smith 
261a7e14dcfSSatish Balay   PetscFunctionBegin;
262a7e14dcfSSatish Balay   if (!*tao) PetscFunctionReturn(0);
263441846f8SBarry Smith   PetscValidHeaderSpecific(*tao,TAO_CLASSID,1);
264a7e14dcfSSatish Balay   if (--((PetscObject)*tao)->refct > 0) {*tao=0;PetscFunctionReturn(0);}
265a7e14dcfSSatish Balay 
266a7e14dcfSSatish Balay   if ((*tao)->ops->destroy) {
267a7e14dcfSSatish Balay     ierr = (*((*tao))->ops->destroy)(*tao);CHKERRQ(ierr);
268a7e14dcfSSatish Balay   }
269a7e14dcfSSatish Balay   ierr = KSPDestroy(&(*tao)->ksp);CHKERRQ(ierr);
270a7e14dcfSSatish Balay   ierr = TaoLineSearchDestroy(&(*tao)->linesearch);CHKERRQ(ierr);
271a7e14dcfSSatish Balay 
272a7e14dcfSSatish Balay   if ((*tao)->ops->convergencedestroy) {
273a7e14dcfSSatish Balay     ierr = (*(*tao)->ops->convergencedestroy)((*tao)->cnvP);CHKERRQ(ierr);
274a7e14dcfSSatish Balay     if ((*tao)->jacobian_state_inv) {
275a7e14dcfSSatish Balay       ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr);
276a7e14dcfSSatish Balay     }
277a7e14dcfSSatish Balay   }
278a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->solution);CHKERRQ(ierr);
279a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->gradient);CHKERRQ(ierr);
280a7e14dcfSSatish Balay 
281a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->XL);CHKERRQ(ierr);
282a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->XU);CHKERRQ(ierr);
283a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->IL);CHKERRQ(ierr);
284a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->IU);CHKERRQ(ierr);
285a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->DE);CHKERRQ(ierr);
286a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->DI);CHKERRQ(ierr);
287a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->constraints_equality);CHKERRQ(ierr);
288a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->constraints_inequality);CHKERRQ(ierr);
289a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->stepdirection);CHKERRQ(ierr);
290a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->hessian_pre);CHKERRQ(ierr);
291a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->hessian);CHKERRQ(ierr);
292a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_pre);CHKERRQ(ierr);
293a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian);CHKERRQ(ierr);
294a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state_pre);CHKERRQ(ierr);
295a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state);CHKERRQ(ierr);
296a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr);
297067f330cSJason Sarich   ierr = MatDestroy(&(*tao)->jacobian_design);CHKERRQ(ierr);
298a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_equality);CHKERRQ(ierr);
299a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_equality_pre);CHKERRQ(ierr);
300a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_inequality);CHKERRQ(ierr);
301a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_inequality_pre);CHKERRQ(ierr);
302a7e14dcfSSatish Balay   ierr = ISDestroy(&(*tao)->state_is);CHKERRQ(ierr);
303a7e14dcfSSatish Balay   ierr = ISDestroy(&(*tao)->design_is);CHKERRQ(ierr);
304a7e14dcfSSatish Balay   ierr = TaoCancelMonitors(*tao);CHKERRQ(ierr);
305ae93cb3cSJason Sarich   if ((*tao)->hist_malloc) {
306ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_obj);CHKERRQ(ierr);
307ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_resid);CHKERRQ(ierr);
308ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_cnorm);CHKERRQ(ierr);
309ae93cb3cSJason Sarich     ierr = PetscFree((*tao)->hist_lits);CHKERRQ(ierr);
310ae93cb3cSJason Sarich   }
311a7e14dcfSSatish Balay   ierr = PetscHeaderDestroy(tao);CHKERRQ(ierr);
312a7e14dcfSSatish Balay   PetscFunctionReturn(0);
313a7e14dcfSSatish Balay }
314a7e14dcfSSatish Balay 
315a7e14dcfSSatish Balay #undef __FUNCT__
316a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetFromOptions"
317a7e14dcfSSatish Balay /*@
318441846f8SBarry Smith   TaoSetFromOptions - Sets various Tao parameters from user
319a7e14dcfSSatish Balay   options.
320a7e14dcfSSatish Balay 
321441846f8SBarry Smith   Collective on Tao
322a7e14dcfSSatish Balay 
323a7e14dcfSSatish Balay   Input Paremeter:
324441846f8SBarry Smith . tao - the Tao solver context
325a7e14dcfSSatish Balay 
326a7e14dcfSSatish Balay   options Database Keys:
32758417fe7SBarry Smith + -tao_type <type> - The algorithm that TAO uses (lmvm, nls, etc.)
328a7e14dcfSSatish Balay . -tao_fatol <fatol> - absolute error tolerance in function value
329a7e14dcfSSatish Balay . -tao_frtol <frtol> - relative error tolerance in function value
330a7e14dcfSSatish Balay . -tao_gatol <gatol> - absolute error tolerance for ||gradient||
331a7e14dcfSSatish Balay . -tao_grtol <grtol> - relative error tolerance for ||gradient||
332a7e14dcfSSatish Balay . -tao_gttol <gttol> - reduction of ||gradient|| relative to initial gradient
333a7e14dcfSSatish Balay . -tao_max_it <max> - sets maximum number of iterations
334a7e14dcfSSatish Balay . -tao_max_funcs <max> - sets maximum number of function evaluations
335a7e14dcfSSatish Balay . -tao_fmin <fmin> - stop if function value reaches fmin
336a7e14dcfSSatish Balay . -tao_steptol <tol> - stop if trust region radius less than <tol>
337a7e14dcfSSatish Balay . -tao_trust0 <t> - initial trust region radius
338a7e14dcfSSatish Balay . -tao_monitor - prints function value and residual at each iteration
339a7e14dcfSSatish Balay . -tao_smonitor - same as tao_monitor, but truncates very small values
340a7e14dcfSSatish Balay . -tao_cmonitor - prints function value, residual, and constraint norm at each iteration
341a7e14dcfSSatish Balay . -tao_view_solution - prints solution vector at each iteration
342a7e14dcfSSatish Balay . -tao_view_separableobjective - prints separable objective vector at each iteration
343a7e14dcfSSatish Balay . -tao_view_step - prints step direction vector at each iteration
344a7e14dcfSSatish Balay . -tao_view_gradient - prints gradient vector at each iteration
345a7e14dcfSSatish Balay . -tao_draw_solution - graphically view solution vector at each iteration
346a7e14dcfSSatish Balay . -tao_draw_step - graphically view step vector at each iteration
347a7e14dcfSSatish Balay . -tao_draw_gradient - graphically view gradient at each iteration
348a7e14dcfSSatish Balay . -tao_fd_gradient - use gradient computed with finite differences
349a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors (except those set with command line)
350441846f8SBarry Smith . -tao_view - prints information about the Tao after solving
351a7e14dcfSSatish Balay - -tao_converged_reason - prints the reason TAO stopped iterating
352a7e14dcfSSatish Balay 
353a7e14dcfSSatish Balay   Notes:
354a7e14dcfSSatish Balay   To see all options, run your program with the -help option or consult the
355a7e14dcfSSatish Balay   user's manual. Should be called after TaoCreate() but before TaoSolve()
356a7e14dcfSSatish Balay 
357a7e14dcfSSatish Balay   Level: beginner
358a7e14dcfSSatish Balay @*/
359441846f8SBarry Smith PetscErrorCode TaoSetFromOptions(Tao tao)
360a7e14dcfSSatish Balay {
361a7e14dcfSSatish Balay   PetscErrorCode ierr;
36258417fe7SBarry Smith   const TaoType  default_type = TAOLMVM;
363a7e14dcfSSatish Balay   const char     *prefix;
364a7e14dcfSSatish Balay   char           type[256], monfilename[PETSC_MAX_PATH_LEN];
365a7e14dcfSSatish Balay   PetscViewer    monviewer;
366a7e14dcfSSatish Balay   PetscBool      flg;
367a7e14dcfSSatish Balay   MPI_Comm       comm;
368a7e14dcfSSatish Balay 
369a7e14dcfSSatish Balay   PetscFunctionBegin;
370441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
371a7e14dcfSSatish Balay   ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
372a7e14dcfSSatish Balay   ierr = TaoGetOptionsPrefix(tao,&prefix);
373a7e14dcfSSatish Balay   /* So no warnings are given about unused options */
374a7e14dcfSSatish Balay   ierr = PetscOptionsHasName(prefix,"-tao_ls_type",&flg);
375a7e14dcfSSatish Balay 
376a7e14dcfSSatish Balay   ierr = PetscObjectOptionsBegin((PetscObject)tao);CHKERRQ(ierr);
377a7e14dcfSSatish Balay   {
378441846f8SBarry Smith     if (!TaoRegisterAllCalled) {
379441846f8SBarry Smith       ierr = TaoRegisterAll();CHKERRQ(ierr);
380a7e14dcfSSatish Balay     }
381a7e14dcfSSatish Balay     if (((PetscObject)tao)->type_name) {
382a7e14dcfSSatish Balay       default_type = ((PetscObject)tao)->type_name;
383a7e14dcfSSatish Balay     }
384a7e14dcfSSatish Balay     /* Check for type from options */
385441846f8SBarry Smith     ierr = PetscOptionsFList("-tao_type","Tao Solver type","TaoSetType",TaoList,default_type,type,256,&flg);CHKERRQ(ierr);
386a7e14dcfSSatish Balay     if (flg) {
387a7e14dcfSSatish Balay       ierr = TaoSetType(tao,type);CHKERRQ(ierr);
388a7e14dcfSSatish Balay     } else if (!((PetscObject)tao)->type_name) {
389a7e14dcfSSatish Balay       ierr = TaoSetType(tao,default_type);
390a7e14dcfSSatish Balay     }
391a7e14dcfSSatish Balay 
392a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_fatol","Stop if solution within","TaoSetTolerances",tao->fatol,&tao->fatol,&flg);CHKERRQ(ierr);
393a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_frtol","Stop if relative solution within","TaoSetTolerances",tao->frtol,&tao->frtol,&flg);CHKERRQ(ierr);
394a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_catol","Stop if constraints violations within","TaoSetConstraintTolerances",tao->catol,&tao->catol,&flg);CHKERRQ(ierr);
395a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_crtol","Stop if relative contraint violations within","TaoSetConstraintTolerances",tao->crtol,&tao->crtol,&flg);CHKERRQ(ierr);
396a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_gatol","Stop if norm of gradient less than","TaoSetTolerances",tao->gatol,&tao->gatol,&flg);CHKERRQ(ierr);
397a7e14dcfSSatish Balay     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);
398a7e14dcfSSatish Balay     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);
3996f4723b1SBarry Smith     ierr = PetscOptionsInt("-tao_max_it","Stop if iteration number exceeds","TaoSetMaximumIterations",tao->max_it,&tao->max_it,&flg);CHKERRQ(ierr);
400a7e14dcfSSatish Balay     ierr = PetscOptionsInt("-tao_max_funcs","Stop if number of function evaluations exceeds","TaoSetMaximumFunctionEvaluations",tao->max_funcs,&tao->max_funcs,&flg);CHKERRQ(ierr);
401a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_fmin","Stop if function less than","TaoSetFunctionLowerBound",tao->fmin,&tao->fmin,&flg);CHKERRQ(ierr);
402a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_steptol","Stop if step size or trust region radius less than","",tao->steptol,&tao->steptol,&flg);CHKERRQ(ierr);
403a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_trust0","Initial trust region radius","TaoSetTrustRegionRadius",tao->trust0,&tao->trust0,&flg);CHKERRQ(ierr);
404a7e14dcfSSatish Balay 
405a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_solution","view solution vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
406a7e14dcfSSatish Balay     if (flg) {
407a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
408a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoSolutionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
409a7e14dcfSSatish Balay     }
410a7e14dcfSSatish Balay 
411e4cb33bbSBarry Smith     ierr = PetscOptionsBool("-tao_converged_reason","Print reason for TAO converged","TaoSolve",flg,&flg,NULL);CHKERRQ(ierr);
412a7e14dcfSSatish Balay     if (flg) {
413a7e14dcfSSatish Balay       tao->printreason = PETSC_TRUE;
414a7e14dcfSSatish Balay     }
415a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_gradient","view gradient vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
416a7e14dcfSSatish Balay     if (flg) {
417a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
418a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoGradientMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
419a7e14dcfSSatish Balay     }
420a7e14dcfSSatish Balay 
421a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_stepdirection","view step direction vector after each iteration","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
422a7e14dcfSSatish Balay     if (flg) {
423a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
424a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoStepDirectionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
425a7e14dcfSSatish Balay     }
426a7e14dcfSSatish Balay 
427a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_separableobjective","view separable objective vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
428a7e14dcfSSatish Balay     if (flg) {
429a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
430a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoSeparableObjectiveMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
431a7e14dcfSSatish Balay     }
432a7e14dcfSSatish Balay 
433a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_monitor","Use the default convergence monitor","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,TaoDefaultMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
437a7e14dcfSSatish Balay     }
438a7e14dcfSSatish Balay 
439a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_smonitor","Use the short convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
440a7e14dcfSSatish Balay     if (flg) {
441a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
442a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultSMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
443a7e14dcfSSatish Balay     }
444a7e14dcfSSatish Balay 
445a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_cmonitor","Use the default convergence monitor with constraint norm","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
446a7e14dcfSSatish Balay     if (flg) {
447a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
448a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultCMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
449a7e14dcfSSatish Balay     }
450a7e14dcfSSatish Balay 
451a7e14dcfSSatish Balay 
45247a47007SBarry Smith     ierr = PetscOptionsBool("-tao_cancelmonitors","cancel all monitors and call any registered destroy routines","TaoCancelMonitors",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr);
453a7e14dcfSSatish Balay     if (flg) {ierr = TaoCancelMonitors(tao);CHKERRQ(ierr);}
454a7e14dcfSSatish Balay 
45547a47007SBarry Smith     ierr = PetscOptionsBool("-tao_draw_solution","Plot solution vector at each iteration","TaoSetMonitor",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr);
456a7e14dcfSSatish Balay     if (flg) {
45747a47007SBarry Smith       ierr = TaoSetMonitor(tao,TaoDrawSolutionMonitor,NULL,NULL);CHKERRQ(ierr);
458a7e14dcfSSatish Balay     }
459a7e14dcfSSatish Balay 
46047a47007SBarry Smith     ierr = PetscOptionsBool("-tao_draw_step","plots step direction at each iteration","TaoSetMonitor",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr);
461a7e14dcfSSatish Balay     if (flg) {
46247a47007SBarry Smith       ierr = TaoSetMonitor(tao,TaoDrawStepMonitor,NULL,NULL);CHKERRQ(ierr);
463a7e14dcfSSatish Balay     }
464a7e14dcfSSatish Balay 
46547a47007SBarry Smith     ierr = PetscOptionsBool("-tao_draw_gradient","plots gradient at each iteration","TaoSetMonitor",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr);
466a7e14dcfSSatish Balay     if (flg) {
46747a47007SBarry Smith       ierr = TaoSetMonitor(tao,TaoDrawGradientMonitor,NULL,NULL);CHKERRQ(ierr);
468a7e14dcfSSatish Balay     }
46947a47007SBarry Smith     ierr = PetscOptionsBool("-tao_fd_gradient","compute gradient using finite differences","TaoDefaultComputeGradient",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr);
470a7e14dcfSSatish Balay     if (flg) {
47147a47007SBarry Smith       ierr = TaoSetGradientRoutine(tao,TaoDefaultComputeGradient,NULL);CHKERRQ(ierr);
472a7e14dcfSSatish Balay     }
473e1cc520bSBarry Smith     ierr = PetscOptionsEnum("-tao_subset_type","subset type", "", TaoSubSetTypes,(PetscEnum)tao->subset_type, (PetscEnum*)&tao->subset_type, 0);CHKERRQ(ierr);
474a7e14dcfSSatish Balay 
475a7e14dcfSSatish Balay     if (tao->ops->setfromoptions) {
476a7e14dcfSSatish Balay       ierr = (*tao->ops->setfromoptions)(tao);CHKERRQ(ierr);
477a7e14dcfSSatish Balay     }
478a7e14dcfSSatish Balay   }
479a7e14dcfSSatish Balay   ierr = PetscOptionsEnd();CHKERRQ(ierr);
480a7e14dcfSSatish Balay   PetscFunctionReturn(0);
481a7e14dcfSSatish Balay }
482a7e14dcfSSatish Balay 
483a7e14dcfSSatish Balay #undef __FUNCT__
484a7e14dcfSSatish Balay #define __FUNCT__ "TaoView"
485a7e14dcfSSatish Balay /*@C
486441846f8SBarry Smith   TaoView - Prints information about the Tao
487a7e14dcfSSatish Balay 
488441846f8SBarry Smith   Collective on Tao
489a7e14dcfSSatish Balay 
490a7e14dcfSSatish Balay   InputParameters:
491441846f8SBarry Smith + tao - the Tao context
492a7e14dcfSSatish Balay - viewer - visualization context
493a7e14dcfSSatish Balay 
494a7e14dcfSSatish Balay   Options Database Key:
495a7e14dcfSSatish Balay . -tao_view - Calls TaoView() at the end of TaoSolve()
496a7e14dcfSSatish Balay 
497a7e14dcfSSatish Balay   Notes:
498a7e14dcfSSatish Balay   The available visualization contexts include
499a7e14dcfSSatish Balay +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
500a7e14dcfSSatish Balay -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
501a7e14dcfSSatish Balay          output where only the first processor opens
502a7e14dcfSSatish Balay          the file.  All other processors send their
503a7e14dcfSSatish Balay          data to the first processor to print.
504a7e14dcfSSatish Balay 
505a7e14dcfSSatish Balay   Level: beginner
506a7e14dcfSSatish Balay 
507a7e14dcfSSatish Balay .seealso: PetscViewerASCIIOpen()
508a7e14dcfSSatish Balay @*/
509441846f8SBarry Smith PetscErrorCode TaoView(Tao tao, PetscViewer viewer)
510a7e14dcfSSatish Balay {
511a7e14dcfSSatish Balay   PetscErrorCode      ierr;
512a7e14dcfSSatish Balay   PetscBool           isascii,isstring;
513441846f8SBarry Smith   const TaoType type;
51447a47007SBarry Smith 
515a7e14dcfSSatish Balay   PetscFunctionBegin;
516441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
517a7e14dcfSSatish Balay   if (!viewer) {
518a7e14dcfSSatish Balay     ierr = PetscViewerASCIIGetStdout(((PetscObject)tao)->comm,&viewer);CHKERRQ(ierr);
519a7e14dcfSSatish Balay   }
520a7e14dcfSSatish Balay   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
521a7e14dcfSSatish Balay   PetscCheckSameComm(tao,1,viewer,2);
522a7e14dcfSSatish Balay 
523a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
524a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
525a7e14dcfSSatish Balay   if (isascii) {
526a7e14dcfSSatish Balay     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)tao,viewer);CHKERRQ(ierr);
527a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
528a7e14dcfSSatish Balay 
529a7e14dcfSSatish Balay     if (tao->ops->view) {
530a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
531a7e14dcfSSatish Balay       ierr = (*tao->ops->view)(tao,viewer);CHKERRQ(ierr);
532a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
533a7e14dcfSSatish Balay     }
534a7e14dcfSSatish Balay     if (tao->linesearch) {
535a7e14dcfSSatish Balay       ierr = PetscObjectPrintClassNamePrefixType((PetscObject)(tao->linesearch),viewer);CHKERRQ(ierr);
536a7e14dcfSSatish Balay     }
537a7e14dcfSSatish Balay     if (tao->ksp) {
538a7e14dcfSSatish Balay       ierr = PetscObjectPrintClassNamePrefixType((PetscObject)(tao->ksp),viewer);CHKERRQ(ierr);
539ae93cb3cSJason Sarich       ierr = PetscViewerASCIIPrintf(viewer,"total KSP iterations: %D\n",tao->ksp_tot_its);CHKERRQ(ierr);
540a7e14dcfSSatish Balay     }
541a7e14dcfSSatish Balay     if (tao->XL || tao->XU) {
542e1cc520bSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Active Set subset type: %s\n",TaoSubSetTypes[tao->subset_type]);
543a7e14dcfSSatish Balay     }
544a7e14dcfSSatish Balay 
54547a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: fatol=%g,",(double)tao->fatol);CHKERRQ(ierr);
54647a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," frtol=%g\n",(double)tao->frtol);CHKERRQ(ierr);
547a7e14dcfSSatish Balay 
54847a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: gatol=%g,",(double)tao->gatol);CHKERRQ(ierr);
54947a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," steptol=%g,",(double)tao->steptol);CHKERRQ(ierr);
55047a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," gttol=%g\n",(double)tao->gttol);CHKERRQ(ierr);
551a7e14dcfSSatish Balay 
55247a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Residual in Function/Gradient:=%g\n",(double)tao->residual);CHKERRQ(ierr);
553a7e14dcfSSatish Balay 
554a7e14dcfSSatish Balay     if (tao->cnorm>0 || tao->catol>0 || tao->crtol>0){
555a7e14dcfSSatish Balay       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances:");CHKERRQ(ierr);
55647a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer," catol=%g,",(double)tao->catol);CHKERRQ(ierr);
55747a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer," crtol=%g\n",(double)tao->crtol);CHKERRQ(ierr);
55847a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Residual in Constraints:=%g\n",(double)tao->cnorm);CHKERRQ(ierr);
559a7e14dcfSSatish Balay     }
560a7e14dcfSSatish Balay 
561a7e14dcfSSatish Balay     if (tao->trust < tao->steptol){
56247a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: steptol=%g\n",(double)tao->steptol);CHKERRQ(ierr);
56347a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"Final trust region radius:=%g\n",(double)tao->trust);CHKERRQ(ierr);
564a7e14dcfSSatish Balay     }
565a7e14dcfSSatish Balay 
566a7e14dcfSSatish Balay     if (tao->fmin>-1.e25){
56747a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: function minimum=%g\n",(double)tao->fmin);CHKERRQ(ierr);
568a7e14dcfSSatish Balay     }
56947a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Objective value=%g\n",(double)tao->fc);CHKERRQ(ierr);
570a7e14dcfSSatish Balay 
57147a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"total number of iterations=%D,          ",tao->niter);CHKERRQ(ierr);
572a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPrintf(viewer,"              (max: %D)\n",tao->max_it);CHKERRQ(ierr);
573a7e14dcfSSatish Balay 
574a7e14dcfSSatish Balay     if (tao->nfuncs>0){
57547a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of function evaluations=%D,",tao->nfuncs);CHKERRQ(ierr);
57647a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"                max: %D\n",tao->max_funcs);CHKERRQ(ierr);
577a7e14dcfSSatish Balay     }
578a7e14dcfSSatish Balay     if (tao->ngrads>0){
57947a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of gradient evaluations=%D,",tao->ngrads);CHKERRQ(ierr);
58047a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"                max: %D\n",tao->max_funcs);CHKERRQ(ierr);
581a7e14dcfSSatish Balay     }
582a7e14dcfSSatish Balay     if (tao->nfuncgrads>0){
58347a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of function/gradient evaluations=%D,",tao->nfuncgrads);CHKERRQ(ierr);
58447a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    (max: %D)\n",tao->max_funcs);CHKERRQ(ierr);
585a7e14dcfSSatish Balay     }
586a7e14dcfSSatish Balay     if (tao->nhess>0){
58747a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of Hessian evaluations=%D\n",tao->nhess);CHKERRQ(ierr);
588a7e14dcfSSatish Balay     }
589a7e14dcfSSatish Balay     /*  if (tao->linear_its>0){
59047a47007SBarry Smith      ierr = PetscViewerASCIIPrintf(viewer,"  total Krylov method iterations=%D\n",tao->linear_its);CHKERRQ(ierr);
591a7e14dcfSSatish Balay      }*/
592a7e14dcfSSatish Balay     if (tao->nconstraints>0){
59347a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of constraint function evaluations=%D\n",tao->nconstraints);CHKERRQ(ierr);
594a7e14dcfSSatish Balay     }
595a7e14dcfSSatish Balay     if (tao->njac>0){
59647a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of Jacobian evaluations=%D\n",tao->njac);CHKERRQ(ierr);
597a7e14dcfSSatish Balay     }
598a7e14dcfSSatish Balay 
599a7e14dcfSSatish Balay     if (tao->reason>0){
600a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer,    "Solution converged: ");CHKERRQ(ierr);
601a7e14dcfSSatish Balay       switch (tao->reason) {
602a7e14dcfSSatish Balay       case TAO_CONVERGED_FATOL:
603a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"estimated f(x)-f(X*) <= fatol\n");CHKERRQ(ierr);
604a7e14dcfSSatish Balay         break;
605a7e14dcfSSatish Balay       case TAO_CONVERGED_FRTOL:
606a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"estimated |f(x)-f(X*)|/|f(X*)| <= frtol\n");CHKERRQ(ierr);
607a7e14dcfSSatish Balay         break;
608a7e14dcfSSatish Balay       case TAO_CONVERGED_GATOL:
609a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)|| <= gatol\n");CHKERRQ(ierr);
610a7e14dcfSSatish Balay         break;
611a7e14dcfSSatish Balay       case TAO_CONVERGED_GRTOL:
612a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/|f(X)| <= grtol\n");CHKERRQ(ierr);
613a7e14dcfSSatish Balay         break;
614a7e14dcfSSatish Balay       case TAO_CONVERGED_GTTOL:
615a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/||g(X0)|| <= gttol\n");CHKERRQ(ierr);
616a7e14dcfSSatish Balay         break;
617a7e14dcfSSatish Balay       case TAO_CONVERGED_STEPTOL:
618a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," Steptol -- step size small\n");CHKERRQ(ierr);
619a7e14dcfSSatish Balay         break;
620a7e14dcfSSatish Balay       case TAO_CONVERGED_MINF:
621a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," Minf --  f < fmin\n");CHKERRQ(ierr);
622a7e14dcfSSatish Balay         break;
623a7e14dcfSSatish Balay       case TAO_CONVERGED_USER:
624a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr);
625a7e14dcfSSatish Balay         break;
626a7e14dcfSSatish Balay       default:
627a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
628a7e14dcfSSatish Balay         break;
629a7e14dcfSSatish Balay       }
630a7e14dcfSSatish Balay 
631a7e14dcfSSatish Balay     } else {
632a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer,"Solver terminated: %D",tao->reason);CHKERRQ(ierr);
633a7e14dcfSSatish Balay       switch (tao->reason) {
634a7e14dcfSSatish Balay       case TAO_DIVERGED_MAXITS:
63547a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Maximum Iterations\n");CHKERRQ(ierr);
636a7e14dcfSSatish Balay         break;
637a7e14dcfSSatish Balay       case TAO_DIVERGED_NAN:
63847a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," NAN or Inf encountered\n");CHKERRQ(ierr);
639a7e14dcfSSatish Balay         break;
640a7e14dcfSSatish Balay       case TAO_DIVERGED_MAXFCN:
64147a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Maximum Function Evaluations\n");CHKERRQ(ierr);
642a7e14dcfSSatish Balay         break;
643a7e14dcfSSatish Balay       case TAO_DIVERGED_LS_FAILURE:
64447a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Line Search Failure\n");CHKERRQ(ierr);
645a7e14dcfSSatish Balay         break;
646a7e14dcfSSatish Balay       case TAO_DIVERGED_TR_REDUCTION:
64747a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Trust Region too small\n");CHKERRQ(ierr);
648a7e14dcfSSatish Balay         break;
649a7e14dcfSSatish Balay       case TAO_DIVERGED_USER:
65047a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr);
651a7e14dcfSSatish Balay         break;
652a7e14dcfSSatish Balay       default:
653a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
654a7e14dcfSSatish Balay         break;
655a7e14dcfSSatish Balay       }
656a7e14dcfSSatish Balay     }
657a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
658a7e14dcfSSatish Balay   } else if (isstring) {
659a7e14dcfSSatish Balay     ierr = TaoGetType(tao,&type);CHKERRQ(ierr);
660a7e14dcfSSatish Balay     ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr);
661a7e14dcfSSatish Balay   }
662a7e14dcfSSatish Balay   PetscFunctionReturn(0);
663a7e14dcfSSatish Balay }
664a7e14dcfSSatish Balay 
665a7e14dcfSSatish Balay #undef __FUNCT__
666a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetTolerances"
667a7e14dcfSSatish Balay /*@
668a7e14dcfSSatish Balay   TaoSetTolerances - Sets parameters used in TAO convergence tests
669a7e14dcfSSatish Balay 
670441846f8SBarry Smith   Logically collective on Tao
671a7e14dcfSSatish Balay 
672a7e14dcfSSatish Balay   Input Parameters:
673441846f8SBarry Smith + tao - the Tao context
674a7e14dcfSSatish Balay . fatol - absolute convergence tolerance
675a7e14dcfSSatish Balay . frtol - relative convergence tolerance
676a7e14dcfSSatish Balay . gatol - stop if norm of gradient is less than this
677a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this
678a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by this factor
679a7e14dcfSSatish Balay 
680a7e14dcfSSatish Balay   Options Database Keys:
681a7e14dcfSSatish Balay + -tao_fatol <fatol> - Sets fatol
682a7e14dcfSSatish Balay . -tao_frtol <frtol> - Sets frtol
683a7e14dcfSSatish Balay . -tao_gatol <gatol> - Sets gatol
684a7e14dcfSSatish Balay . -tao_grtol <grtol> - Sets grtol
685a7e14dcfSSatish Balay - -tao_gttol <gttol> - Sets gttol
686a7e14dcfSSatish Balay 
687a7e14dcfSSatish Balay   Stopping Criteria:
688a7e14dcfSSatish Balay $ f(X) - f(X*) (estimated)            <= fatol
689a7e14dcfSSatish Balay $ |f(X) - f(X*)| (estimated) / |f(X)| <= frtol
690a7e14dcfSSatish Balay $ ||g(X)||                            <= gatol
691a7e14dcfSSatish Balay $ ||g(X)|| / |f(X)|                   <= grtol
692a7e14dcfSSatish Balay $ ||g(X)|| / ||g(X0)||                <= gttol
693a7e14dcfSSatish Balay 
694a7e14dcfSSatish Balay   Notes:
695a7e14dcfSSatish Balay   Use PETSC_DEFAULT to leave one or more tolerances unchanged.
696a7e14dcfSSatish Balay 
697a7e14dcfSSatish Balay   Level: beginner
698a7e14dcfSSatish Balay 
699a7e14dcfSSatish Balay .seealso: TaoGetTolerances()
700a7e14dcfSSatish Balay 
701a7e14dcfSSatish Balay @*/
702441846f8SBarry Smith PetscErrorCode TaoSetTolerances(Tao tao, PetscReal fatol, PetscReal frtol, PetscReal gatol, PetscReal grtol, PetscReal gttol)
703a7e14dcfSSatish Balay {
704a7e14dcfSSatish Balay   PetscErrorCode ierr;
70547a47007SBarry Smith 
706a7e14dcfSSatish Balay   PetscFunctionBegin;
707441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
708a7e14dcfSSatish Balay 
709a7e14dcfSSatish Balay   if (fatol != PETSC_DEFAULT) {
710a7e14dcfSSatish Balay     if (fatol<0) {
71147a47007SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative fatol -- ignored.");CHKERRQ(ierr);
712a7e14dcfSSatish Balay     } else {
713a7e14dcfSSatish Balay       tao->fatol = PetscMax(0,fatol);
714a7e14dcfSSatish Balay     }
715a7e14dcfSSatish Balay   }
716a7e14dcfSSatish Balay   if (frtol != PETSC_DEFAULT) {
717a7e14dcfSSatish Balay     if (frtol<0) {
71847a47007SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative frtol -- ignored.");CHKERRQ(ierr);
719a7e14dcfSSatish Balay     } else {
720a7e14dcfSSatish Balay       tao->frtol = PetscMax(0,frtol);
721a7e14dcfSSatish Balay     }
722a7e14dcfSSatish Balay   }
723a7e14dcfSSatish Balay 
724a7e14dcfSSatish Balay   if (gatol != PETSC_DEFAULT) {
725a7e14dcfSSatish Balay     if (gatol<0) {
72647a47007SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative gatol -- ignored.");CHKERRQ(ierr);
727a7e14dcfSSatish Balay     } else {
728a7e14dcfSSatish Balay       tao->gatol = PetscMax(0,gatol);
729a7e14dcfSSatish Balay     }
730a7e14dcfSSatish Balay   }
731a7e14dcfSSatish Balay 
732a7e14dcfSSatish Balay   if (grtol != PETSC_DEFAULT) {
733a7e14dcfSSatish Balay     if (grtol<0) {
73447a47007SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative grtol -- ignored.");CHKERRQ(ierr);
735a7e14dcfSSatish Balay     } else {
736a7e14dcfSSatish Balay       tao->grtol = PetscMax(0,grtol);
737a7e14dcfSSatish Balay     }
738a7e14dcfSSatish Balay   }
739a7e14dcfSSatish Balay 
740a7e14dcfSSatish Balay   if (gttol != PETSC_DEFAULT) {
741a7e14dcfSSatish Balay     if (gttol<0) {
74247a47007SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative gttol -- ignored.");CHKERRQ(ierr);
743a7e14dcfSSatish Balay     } else {
744a7e14dcfSSatish Balay       tao->gttol = PetscMax(0,gttol);
745a7e14dcfSSatish Balay     }
746a7e14dcfSSatish Balay   }
747a7e14dcfSSatish Balay   PetscFunctionReturn(0);
748a7e14dcfSSatish Balay }
749a7e14dcfSSatish Balay 
750a7e14dcfSSatish Balay #undef __FUNCT__
751a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetConstraintTolerances"
752a7e14dcfSSatish Balay /*@
75358417fe7SBarry Smith   TaoSetConstraintTolerances - Sets constraint tolerance parameters used in TAO  convergence tests
754a7e14dcfSSatish Balay 
755441846f8SBarry Smith   Logically collective on Tao
756a7e14dcfSSatish Balay 
757a7e14dcfSSatish Balay   Input Parameters:
758441846f8SBarry Smith + tao - the Tao context
759a7e14dcfSSatish Balay . catol - absolute constraint tolerance, constraint norm must be less than catol for used for fatol, gatol convergence criteria
760a7e14dcfSSatish Balay - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for fatol, gatol, gttol convergence criteria
761a7e14dcfSSatish Balay 
762a7e14dcfSSatish Balay   Options Database Keys:
763a7e14dcfSSatish Balay + -tao_catol <catol> - Sets catol
764a7e14dcfSSatish Balay - -tao_crtol <crtol> - Sets crtol
765a7e14dcfSSatish Balay 
766a7e14dcfSSatish Balay   Level: intermediate
767a7e14dcfSSatish Balay 
76858417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoGetConstraintTolerances(), TaoSetTolerances()
769a7e14dcfSSatish Balay 
770a7e14dcfSSatish Balay @*/
771441846f8SBarry Smith PetscErrorCode TaoSetConstraintTolerances(Tao tao, PetscReal catol, PetscReal crtol)
772a7e14dcfSSatish Balay {
773a7e14dcfSSatish Balay   PetscErrorCode ierr;
77447a47007SBarry Smith 
775a7e14dcfSSatish Balay   PetscFunctionBegin;
776441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
777a7e14dcfSSatish Balay 
778a7e14dcfSSatish Balay   if (catol != PETSC_DEFAULT) {
779a7e14dcfSSatish Balay     if (catol<0) {
78047a47007SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative catol -- ignored.");CHKERRQ(ierr);
781a7e14dcfSSatish Balay     } else {
782a7e14dcfSSatish Balay       tao->catol = PetscMax(0,catol);
783a7e14dcfSSatish Balay     }
784a7e14dcfSSatish Balay   }
785a7e14dcfSSatish Balay 
786a7e14dcfSSatish Balay   if (crtol != PETSC_DEFAULT) {
787a7e14dcfSSatish Balay     if (crtol<0) {
78847a47007SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative crtol -- ignored.");CHKERRQ(ierr);
789a7e14dcfSSatish Balay     } else {
790a7e14dcfSSatish Balay       tao->crtol = PetscMax(0,crtol);
791a7e14dcfSSatish Balay     }
792a7e14dcfSSatish Balay   }
793a7e14dcfSSatish Balay   PetscFunctionReturn(0);
794a7e14dcfSSatish Balay }
795a7e14dcfSSatish Balay 
796a7e14dcfSSatish Balay #undef __FUNCT__
79758417fe7SBarry Smith #define __FUNCT__ "TaoGetConstraintTolerances"
79858417fe7SBarry Smith /*@
79958417fe7SBarry Smith   TaoGetConstraintTolerances - Gets constraint tolerance parameters used in TAO  convergence tests
80058417fe7SBarry Smith 
80158417fe7SBarry Smith   Not ollective
80258417fe7SBarry Smith 
80358417fe7SBarry Smith   Input Parameter:
80458417fe7SBarry Smith . tao - the Tao context
80558417fe7SBarry Smith 
80658417fe7SBarry Smith   Output Parameter:
80758417fe7SBarry Smith + catol - absolute constraint tolerance, constraint norm must be less than catol for used for fatol, gatol convergence criteria
80858417fe7SBarry Smith - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for fatol, gatol, gttol convergence criteria
80958417fe7SBarry Smith 
81058417fe7SBarry Smith   Level: intermediate
81158417fe7SBarry Smith 
81258417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoSetTolerances(), TaoSetConstraintTolerances()
81358417fe7SBarry Smith 
81458417fe7SBarry Smith @*/
81558417fe7SBarry Smith PetscErrorCode TaoGetConstraintTolerances(Tao tao, PetscReal *catol, PetscReal *crtol)
81658417fe7SBarry Smith {
81758417fe7SBarry Smith   PetscFunctionBegin;
81858417fe7SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
81958417fe7SBarry Smith   if (catol) *catol = tao->catol;
82058417fe7SBarry Smith   if (crtol) *crtol = tao->crtol;
82158417fe7SBarry Smith   PetscFunctionReturn(0);
82258417fe7SBarry Smith }
82358417fe7SBarry Smith 
82458417fe7SBarry Smith #undef __FUNCT__
825a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetFunctionLowerBound"
826a7e14dcfSSatish Balay /*@
827a7e14dcfSSatish Balay    TaoSetFunctionLowerBound - Sets a bound on the solution objective value.
828a7e14dcfSSatish Balay    When an approximate solution with an objective value below this number
829a7e14dcfSSatish Balay    has been found, the solver will terminate.
830a7e14dcfSSatish Balay 
831441846f8SBarry Smith    Logically Collective on Tao
832a7e14dcfSSatish Balay 
833a7e14dcfSSatish Balay    Input Parameters:
834441846f8SBarry Smith +  tao - the Tao solver context
835a7e14dcfSSatish Balay -  fmin - the tolerance
836a7e14dcfSSatish Balay 
837a7e14dcfSSatish Balay    Options Database Keys:
838a7e14dcfSSatish Balay .    -tao_fmin <fmin> - sets the minimum function value
839a7e14dcfSSatish Balay 
840a7e14dcfSSatish Balay    Level: intermediate
841a7e14dcfSSatish Balay 
842a7e14dcfSSatish Balay .seealso: TaoSetTolerances()
843a7e14dcfSSatish Balay @*/
844441846f8SBarry Smith PetscErrorCode TaoSetFunctionLowerBound(Tao tao,PetscReal fmin)
845a7e14dcfSSatish Balay {
846a7e14dcfSSatish Balay   PetscFunctionBegin;
847441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
848a7e14dcfSSatish Balay   tao->fmin = fmin;
849a7e14dcfSSatish Balay   PetscFunctionReturn(0);
850a7e14dcfSSatish Balay }
851a7e14dcfSSatish Balay 
852a7e14dcfSSatish Balay #undef __FUNCT__
853a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetFunctionLowerBound"
854a7e14dcfSSatish Balay /*@
855a7e14dcfSSatish Balay    TaoGetFunctionLowerBound - Sets a bound on the solution objective value.
856a7e14dcfSSatish Balay    When an approximate solution with an objective value below this number
857a7e14dcfSSatish Balay    has been found, the solver will terminate.
858a7e14dcfSSatish Balay 
859441846f8SBarry Smith    Not collective on Tao
860a7e14dcfSSatish Balay 
861a7e14dcfSSatish Balay    Input Parameters:
862441846f8SBarry Smith .  tao - the Tao solver context
863a7e14dcfSSatish Balay 
864a7e14dcfSSatish Balay    OutputParameters:
865a7e14dcfSSatish Balay .  fmin - the minimum function value
866a7e14dcfSSatish Balay 
867a7e14dcfSSatish Balay    Level: intermediate
868a7e14dcfSSatish Balay 
869a7e14dcfSSatish Balay .seealso: TaoSetFunctionLowerBound()
870a7e14dcfSSatish Balay @*/
871441846f8SBarry Smith PetscErrorCode TaoGetFunctionLowerBound(Tao tao,PetscReal *fmin)
872a7e14dcfSSatish Balay {
873a7e14dcfSSatish Balay   PetscFunctionBegin;
874441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
875a7e14dcfSSatish Balay   *fmin = tao->fmin;
876a7e14dcfSSatish Balay   PetscFunctionReturn(0);
877a7e14dcfSSatish Balay }
878a7e14dcfSSatish Balay 
879a7e14dcfSSatish Balay #undef __FUNCT__
880a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMaximumFunctionEvaluations"
881a7e14dcfSSatish Balay /*@
882a7e14dcfSSatish Balay    TaoSetMaximumFunctionEvaluations - Sets a maximum number of
883a7e14dcfSSatish Balay    function evaluations.
884a7e14dcfSSatish Balay 
885441846f8SBarry Smith    Logically Collective on Tao
886a7e14dcfSSatish Balay 
887a7e14dcfSSatish Balay    Input Parameters:
888441846f8SBarry Smith +  tao - the Tao solver context
889a7e14dcfSSatish Balay -  nfcn - the maximum number of function evaluations (>=0)
890a7e14dcfSSatish Balay 
891a7e14dcfSSatish Balay    Options Database Keys:
892a7e14dcfSSatish Balay .    -tao_max_funcs <nfcn> - sets the maximum number of function evaluations
893a7e14dcfSSatish Balay 
894a7e14dcfSSatish Balay    Level: intermediate
895a7e14dcfSSatish Balay 
896a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumIterations()
897a7e14dcfSSatish Balay @*/
898a7e14dcfSSatish Balay 
899441846f8SBarry Smith PetscErrorCode TaoSetMaximumFunctionEvaluations(Tao tao,PetscInt nfcn)
900a7e14dcfSSatish Balay {
901a7e14dcfSSatish Balay   PetscFunctionBegin;
902441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
90347a47007SBarry Smith   tao->max_funcs = PetscMax(0,nfcn);
904a7e14dcfSSatish Balay   PetscFunctionReturn(0);
905a7e14dcfSSatish Balay }
906a7e14dcfSSatish Balay 
907a7e14dcfSSatish Balay #undef __FUNCT__
908a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetMaximumFunctionEvaluations"
909a7e14dcfSSatish Balay /*@
910a7e14dcfSSatish Balay    TaoGetMaximumFunctionEvaluations - Sets a maximum number of
911a7e14dcfSSatish Balay    function evaluations.
912a7e14dcfSSatish Balay 
913a7e14dcfSSatish Balay    Not Collective
914a7e14dcfSSatish Balay 
915a7e14dcfSSatish Balay    Input Parameters:
916441846f8SBarry Smith .  tao - the Tao solver context
917a7e14dcfSSatish Balay 
918a7e14dcfSSatish Balay    Output Parameters:
919a7e14dcfSSatish Balay .  nfcn - the maximum number of function evaluations
920a7e14dcfSSatish Balay 
921a7e14dcfSSatish Balay    Level: intermediate
922a7e14dcfSSatish Balay 
923a7e14dcfSSatish Balay .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumIterations()
924a7e14dcfSSatish Balay @*/
925a7e14dcfSSatish Balay 
926441846f8SBarry Smith PetscErrorCode TaoGetMaximumFunctionEvaluations(Tao tao,PetscInt *nfcn)
927a7e14dcfSSatish Balay {
928a7e14dcfSSatish Balay   PetscFunctionBegin;
929441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
930a7e14dcfSSatish Balay   *nfcn = tao->max_funcs;
931a7e14dcfSSatish Balay   PetscFunctionReturn(0);
932a7e14dcfSSatish Balay }
933a7e14dcfSSatish Balay 
934a7e14dcfSSatish Balay #undef __FUNCT__
935770232b9SCe Qin #define __FUNCT__ "TaoGetCurrentFunctionEvaluations"
936770232b9SCe Qin /*@
937770232b9SCe Qin    TaoGetCurrentFunctionEvaluations - Get current number of
938770232b9SCe Qin    function evaluations.
939770232b9SCe Qin 
940770232b9SCe Qin    Not Collective
941770232b9SCe Qin 
942770232b9SCe Qin    Input Parameters:
943770232b9SCe Qin .  tao - the Tao solver context
944770232b9SCe Qin 
945770232b9SCe Qin    Output Parameters:
946770232b9SCe Qin .  nfuncs - the current number of function evaluations
947770232b9SCe Qin 
948770232b9SCe Qin    Level: intermediate
949770232b9SCe Qin 
950770232b9SCe Qin .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumFunctionEvaluations(), TaoGetMaximumIterations()
951770232b9SCe Qin @*/
952770232b9SCe Qin 
953770232b9SCe Qin PetscErrorCode TaoGetCurrentFunctionEvaluations(Tao tao,PetscInt *nfuncs)
954770232b9SCe Qin {
955770232b9SCe Qin   PetscFunctionBegin;
956770232b9SCe Qin   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
957770232b9SCe Qin   *nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads);
958770232b9SCe Qin   PetscFunctionReturn(0);
959770232b9SCe Qin }
960770232b9SCe Qin 
961770232b9SCe Qin #undef __FUNCT__
962a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMaximumIterations"
963a7e14dcfSSatish Balay /*@
964a7e14dcfSSatish Balay    TaoSetMaximumIterations - Sets a maximum number of iterates.
965a7e14dcfSSatish Balay 
966441846f8SBarry Smith    Logically Collective on Tao
967a7e14dcfSSatish Balay 
968a7e14dcfSSatish Balay    Input Parameters:
969441846f8SBarry Smith +  tao - the Tao solver context
970a7e14dcfSSatish Balay -  maxits - the maximum number of iterates (>=0)
971a7e14dcfSSatish Balay 
972a7e14dcfSSatish Balay    Options Database Keys:
973a7e14dcfSSatish Balay .    -tao_max_it <its> - sets the maximum number of iterations
974a7e14dcfSSatish Balay 
975a7e14dcfSSatish Balay    Level: intermediate
976a7e14dcfSSatish Balay 
977a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumFunctionEvaluations()
978a7e14dcfSSatish Balay @*/
979441846f8SBarry Smith PetscErrorCode TaoSetMaximumIterations(Tao tao,PetscInt maxits)
980a7e14dcfSSatish Balay {
981a7e14dcfSSatish Balay   PetscFunctionBegin;
982441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
98347a47007SBarry Smith   tao->max_it = PetscMax(0,maxits);
984a7e14dcfSSatish Balay   PetscFunctionReturn(0);
985a7e14dcfSSatish Balay }
986a7e14dcfSSatish Balay 
987a7e14dcfSSatish Balay #undef __FUNCT__
988a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetMaximumIterations"
989a7e14dcfSSatish Balay /*@
990a7e14dcfSSatish Balay    TaoGetMaximumIterations - Sets a maximum number of iterates.
991a7e14dcfSSatish Balay 
992a7e14dcfSSatish Balay    Not Collective
993a7e14dcfSSatish Balay 
994a7e14dcfSSatish Balay    Input Parameters:
995441846f8SBarry Smith .  tao - the Tao solver context
996a7e14dcfSSatish Balay 
997a7e14dcfSSatish Balay    Output Parameters:
998a7e14dcfSSatish Balay .  maxits - the maximum number of iterates
999a7e14dcfSSatish Balay 
1000a7e14dcfSSatish Balay    Level: intermediate
1001a7e14dcfSSatish Balay 
1002a7e14dcfSSatish Balay .seealso: TaoSetMaximumIterations(), TaoGetMaximumFunctionEvaluations()
1003a7e14dcfSSatish Balay @*/
1004441846f8SBarry Smith PetscErrorCode TaoGetMaximumIterations(Tao tao,PetscInt *maxits)
1005a7e14dcfSSatish Balay {
1006a7e14dcfSSatish Balay   PetscFunctionBegin;
1007441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1008a7e14dcfSSatish Balay   *maxits = tao->max_it;
1009a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1010a7e14dcfSSatish Balay }
1011a7e14dcfSSatish Balay 
1012a7e14dcfSSatish Balay #undef __FUNCT__
1013a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetInitialTrustRegionRadius"
1014a7e14dcfSSatish Balay /*@
1015a7e14dcfSSatish Balay    TaoSetInitialTrustRegionRadius - Sets the initial trust region radius.
1016a7e14dcfSSatish Balay 
1017441846f8SBarry Smith    Logically collective on Tao
1018a7e14dcfSSatish Balay 
1019a7e14dcfSSatish Balay    Input Parameter:
1020a7e14dcfSSatish Balay +  tao - a TAO optimization solver
1021a7e14dcfSSatish Balay -  radius - the trust region radius
1022a7e14dcfSSatish Balay 
1023a7e14dcfSSatish Balay    Level: intermediate
1024a7e14dcfSSatish Balay 
1025a7e14dcfSSatish Balay    Options Database Key:
1026a7e14dcfSSatish Balay .  -tao_trust0 <t0> - sets initial trust region radius
1027a7e14dcfSSatish Balay 
1028a7e14dcfSSatish Balay .seealso: TaoGetTrustRegionRadius(), TaoSetTrustRegionTolerance()
1029a7e14dcfSSatish Balay @*/
1030441846f8SBarry Smith PetscErrorCode TaoSetInitialTrustRegionRadius(Tao tao, PetscReal radius)
1031a7e14dcfSSatish Balay {
1032a7e14dcfSSatish Balay   PetscFunctionBegin;
1033441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1034a7e14dcfSSatish Balay   tao->trust0 = PetscMax(0.0,radius);
1035a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1036a7e14dcfSSatish Balay }
1037a7e14dcfSSatish Balay 
1038a7e14dcfSSatish Balay #undef __FUNCT__
1039a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetInitialTrustRegionRadius"
1040a7e14dcfSSatish Balay /*@
1041a7e14dcfSSatish Balay    TaoGetInitialTrustRegionRadius - Sets the initial trust region radius.
1042a7e14dcfSSatish Balay 
1043a7e14dcfSSatish Balay    Not Collective
1044a7e14dcfSSatish Balay 
1045a7e14dcfSSatish Balay    Input Parameter:
1046a7e14dcfSSatish Balay .  tao - a TAO optimization solver
1047a7e14dcfSSatish Balay 
1048a7e14dcfSSatish Balay    Output Parameter:
1049a7e14dcfSSatish Balay .  radius - the trust region radius
1050a7e14dcfSSatish Balay 
1051a7e14dcfSSatish Balay    Level: intermediate
1052a7e14dcfSSatish Balay 
1053a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetCurrentTrustRegionRadius()
1054a7e14dcfSSatish Balay @*/
1055441846f8SBarry Smith PetscErrorCode TaoGetInitialTrustRegionRadius(Tao tao, PetscReal *radius)
1056a7e14dcfSSatish Balay {
1057a7e14dcfSSatish Balay   PetscFunctionBegin;
1058441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1059a7e14dcfSSatish Balay   *radius = tao->trust0;
1060a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1061a7e14dcfSSatish Balay }
1062a7e14dcfSSatish Balay 
1063a7e14dcfSSatish Balay #undef __FUNCT__
1064a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetCurrentTrustRegionRadius"
1065a7e14dcfSSatish Balay /*@
1066a7e14dcfSSatish Balay    TaoGetCurrentTrustRegionRadius - Gets the current trust region radius.
1067a7e14dcfSSatish Balay 
1068a7e14dcfSSatish Balay    Not Collective
1069a7e14dcfSSatish Balay 
1070a7e14dcfSSatish Balay    Input Parameter:
1071a7e14dcfSSatish Balay .  tao - a TAO optimization solver
1072a7e14dcfSSatish Balay 
1073a7e14dcfSSatish Balay    Output Parameter:
1074a7e14dcfSSatish Balay .  radius - the trust region radius
1075a7e14dcfSSatish Balay 
1076a7e14dcfSSatish Balay    Level: intermediate
1077a7e14dcfSSatish Balay 
1078a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetInitialTrustRegionRadius()
1079a7e14dcfSSatish Balay @*/
1080441846f8SBarry Smith PetscErrorCode TaoGetCurrentTrustRegionRadius(Tao tao, PetscReal *radius)
1081a7e14dcfSSatish Balay {
1082a7e14dcfSSatish Balay   PetscFunctionBegin;
1083441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1084a7e14dcfSSatish Balay   *radius = tao->trust;
1085a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1086a7e14dcfSSatish Balay }
1087a7e14dcfSSatish Balay 
1088a7e14dcfSSatish Balay #undef __FUNCT__
1089a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetTolerances"
1090a7e14dcfSSatish Balay /*@
1091a7e14dcfSSatish Balay   TaoGetTolerances - gets the current values of tolerances
1092a7e14dcfSSatish Balay 
1093a7e14dcfSSatish Balay   Not Collective
1094a7e14dcfSSatish Balay 
1095a7e14dcfSSatish Balay   Input Parameters:
1096441846f8SBarry Smith . tao - the Tao context
1097a7e14dcfSSatish Balay 
1098a7e14dcfSSatish Balay   Output Parameters:
1099a7e14dcfSSatish Balay + fatol - absolute convergence tolerance
1100a7e14dcfSSatish Balay . frtol - relative convergence tolerance
1101a7e14dcfSSatish Balay . gatol - stop if norm of gradient is less than this
1102a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this
1103a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by a this factor
1104a7e14dcfSSatish Balay 
110547a47007SBarry Smith   Note: NULL can be used as an argument if not all tolerances values are needed
1106a7e14dcfSSatish Balay 
1107a7e14dcfSSatish Balay .seealso TaoSetTolerances()
1108a7e14dcfSSatish Balay 
1109a7e14dcfSSatish Balay   Level: intermediate
1110a7e14dcfSSatish Balay @*/
1111441846f8SBarry Smith PetscErrorCode TaoGetTolerances(Tao tao, PetscReal *fatol, PetscReal *frtol, PetscReal *gatol, PetscReal *grtol, PetscReal *gttol)
1112a7e14dcfSSatish Balay {
1113a7e14dcfSSatish Balay   PetscFunctionBegin;
1114441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1115a7e14dcfSSatish Balay   if (fatol) *fatol=tao->fatol;
1116a7e14dcfSSatish Balay   if (frtol) *frtol=tao->frtol;
1117a7e14dcfSSatish Balay   if (gatol) *gatol=tao->gatol;
1118a7e14dcfSSatish Balay   if (grtol) *grtol=tao->grtol;
1119a7e14dcfSSatish Balay   if (gttol) *gttol=tao->gttol;
1120a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1121a7e14dcfSSatish Balay }
1122a7e14dcfSSatish Balay 
1123a7e14dcfSSatish Balay #undef __FUNCT__
1124a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetKSP"
1125a7e14dcfSSatish Balay /*@
1126a7e14dcfSSatish Balay   TaoGetKSP - Gets the linear solver used by the optimization solver.
1127a7e14dcfSSatish Balay   Application writers should use TaoGetKSP if they need direct access
1128a7e14dcfSSatish Balay   to the PETSc KSP object.
1129a7e14dcfSSatish Balay 
1130a7e14dcfSSatish Balay   Not Collective
1131a7e14dcfSSatish Balay 
1132a7e14dcfSSatish Balay    Input Parameters:
1133a7e14dcfSSatish Balay .  tao - the TAO solver
1134a7e14dcfSSatish Balay 
1135a7e14dcfSSatish Balay    Output Parameters:
1136a7e14dcfSSatish Balay .  ksp - the KSP linear solver used in the optimization solver
1137a7e14dcfSSatish Balay 
1138a7e14dcfSSatish Balay    Level: intermediate
1139a7e14dcfSSatish Balay 
1140a7e14dcfSSatish Balay @*/
1141441846f8SBarry Smith PetscErrorCode TaoGetKSP(Tao tao, KSP *ksp)
114247a47007SBarry Smith {
1143a7e14dcfSSatish Balay   PetscFunctionBegin;
1144a7e14dcfSSatish Balay   *ksp = tao->ksp;
1145a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1146a7e14dcfSSatish Balay }
1147a7e14dcfSSatish Balay 
1148a7e14dcfSSatish Balay #undef __FUNCT__
1149025e9500SJason Sarich #define __FUNCT__ "TaoGetLinearSolveIterations"
1150025e9500SJason Sarich /*@
1151025e9500SJason Sarich    TaoGetLinearSolveIterations - Gets the total number of linear iterations
1152025e9500SJason Sarich    used by the TAO solver
1153025e9500SJason Sarich 
1154025e9500SJason Sarich    Not Collective
1155025e9500SJason Sarich 
1156025e9500SJason Sarich    Input Parameter:
1157025e9500SJason Sarich .  tao - TAO context
1158025e9500SJason Sarich 
1159025e9500SJason Sarich    Output Parameter:
1160025e9500SJason Sarich .  lits - number of linear iterations
1161025e9500SJason Sarich 
1162025e9500SJason Sarich    Notes:
1163025e9500SJason Sarich    This counter is reset to zero for each successive call to TaoSolve()
1164025e9500SJason Sarich 
1165025e9500SJason Sarich    Level: intermediate
1166025e9500SJason Sarich 
1167025e9500SJason Sarich .keywords: TAO
1168025e9500SJason Sarich 
1169025e9500SJason Sarich .seealso:  TaoGetKSP()
1170025e9500SJason Sarich @*/
1171025e9500SJason Sarich PetscErrorCode  TaoGetLinearSolveIterations(Tao tao,PetscInt *lits)
1172025e9500SJason Sarich {
1173025e9500SJason Sarich   PetscFunctionBegin;
1174025e9500SJason Sarich   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1175025e9500SJason Sarich   PetscValidIntPointer(lits,2);
1176*2d9aa51bSJason Sarich   *lits = tao->ksp_tot_its;
1177025e9500SJason Sarich   PetscFunctionReturn(0);
1178025e9500SJason Sarich }
1179025e9500SJason Sarich 
1180025e9500SJason Sarich #undef __FUNCT__
1181a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetLineSearch"
1182a7e14dcfSSatish Balay /*@
1183a7e14dcfSSatish Balay   TaoGetLineSearch - Gets the line search used by the optimization solver.
1184a7e14dcfSSatish Balay   Application writers should use TaoGetLineSearch if they need direct access
1185a7e14dcfSSatish Balay   to the TaoLineSearch object.
1186a7e14dcfSSatish Balay 
1187a7e14dcfSSatish Balay   Not Collective
1188a7e14dcfSSatish Balay 
1189a7e14dcfSSatish Balay    Input Parameters:
1190a7e14dcfSSatish Balay .  tao - the TAO solver
1191a7e14dcfSSatish Balay 
1192a7e14dcfSSatish Balay    Output Parameters:
1193a7e14dcfSSatish Balay .  ls - the line search used in the optimization solver
1194a7e14dcfSSatish Balay 
1195a7e14dcfSSatish Balay    Level: intermediate
1196a7e14dcfSSatish Balay 
1197a7e14dcfSSatish Balay @*/
1198441846f8SBarry Smith PetscErrorCode TaoGetLineSearch(Tao tao, TaoLineSearch *ls)
119947a47007SBarry Smith {
1200a7e14dcfSSatish Balay   PetscFunctionBegin;
1201a7e14dcfSSatish Balay   *ls = tao->linesearch;
1202a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1203a7e14dcfSSatish Balay }
1204a7e14dcfSSatish Balay 
1205a7e14dcfSSatish Balay #undef __FUNCT__
1206a7e14dcfSSatish Balay #define __FUNCT__ "TaoAddLineSearchCounts"
1207a7e14dcfSSatish Balay /*@
1208a7e14dcfSSatish Balay   TaoAddLineSearchCounts - Adds the number of function evaluations spent
1209a7e14dcfSSatish Balay   in the line search to the running total.
1210a7e14dcfSSatish Balay 
1211a7e14dcfSSatish Balay    Input Parameters:
1212a7e14dcfSSatish Balay +  tao - the TAO solver
1213a7e14dcfSSatish Balay -  ls - the line search used in the optimization solver
1214a7e14dcfSSatish Balay 
1215a7e14dcfSSatish Balay    Level: developer
1216a7e14dcfSSatish Balay 
1217a7e14dcfSSatish Balay .seealso: TaoLineSearchApply()
1218a7e14dcfSSatish Balay @*/
1219441846f8SBarry Smith PetscErrorCode TaoAddLineSearchCounts(Tao tao)
122047a47007SBarry Smith {
1221a7e14dcfSSatish Balay   PetscErrorCode ierr;
1222a7e14dcfSSatish Balay   PetscBool      flg;
1223a7e14dcfSSatish Balay   PetscInt       nfeval,ngeval,nfgeval;
122447a47007SBarry Smith 
1225a7e14dcfSSatish Balay   PetscFunctionBegin;
1226441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1227a7e14dcfSSatish Balay   if (tao->linesearch) {
1228441846f8SBarry Smith     ierr = TaoLineSearchIsUsingTaoRoutines(tao->linesearch,&flg);
1229a7e14dcfSSatish Balay     if (flg == PETSC_FALSE) {
123047a47007SBarry Smith       ierr = TaoLineSearchGetNumberFunctionEvaluations(tao->linesearch,&nfeval,&ngeval,&nfgeval);CHKERRQ(ierr);
1231a7e14dcfSSatish Balay       tao->nfuncs+=nfeval;
1232a7e14dcfSSatish Balay       tao->ngrads+=ngeval;
1233a7e14dcfSSatish Balay       tao->nfuncgrads+=nfgeval;
1234a7e14dcfSSatish Balay     }
1235a7e14dcfSSatish Balay   }
1236a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1237a7e14dcfSSatish Balay }
1238a7e14dcfSSatish Balay 
1239a7e14dcfSSatish Balay #undef __FUNCT__
1240a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetSolutionVector"
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 #undef __FUNCT__
1265a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetGradientVector"
1266a7e14dcfSSatish Balay /*@
1267a7e14dcfSSatish Balay   TaoGetGradientVector - Returns the vector with the current TAO gradient
1268a7e14dcfSSatish Balay 
1269a7e14dcfSSatish Balay   Not Collective
1270a7e14dcfSSatish Balay 
1271a7e14dcfSSatish Balay   Input Parameter:
1272441846f8SBarry Smith . tao - the Tao context
1273a7e14dcfSSatish Balay 
1274a7e14dcfSSatish Balay   Output Parameter:
1275a7e14dcfSSatish Balay . G - the current solution
1276a7e14dcfSSatish Balay 
1277a7e14dcfSSatish Balay   Level: intermediate
1278a7e14dcfSSatish Balay @*/
1279441846f8SBarry Smith PetscErrorCode TaoGetGradientVector(Tao tao, Vec *G)
1280a7e14dcfSSatish Balay {
1281a7e14dcfSSatish Balay   PetscFunctionBegin;
1282441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1283a7e14dcfSSatish Balay   *G = tao->gradient;
1284a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1285a7e14dcfSSatish Balay }
1286a7e14dcfSSatish Balay 
1287a7e14dcfSSatish Balay #undef __FUNCT__
1288a7e14dcfSSatish Balay #define __FUNCT__ "TaoResetStatistics"
1289a7e14dcfSSatish Balay /*@
1290a7e14dcfSSatish Balay    TaoResetStatistics - Initialize the statistics used by TAO for all of the solvers.
1291a7e14dcfSSatish Balay    These statistics include the iteration number, residual norms, and convergence status.
1292a7e14dcfSSatish Balay    This routine gets called before solving each optimization problem.
1293a7e14dcfSSatish Balay 
1294441846f8SBarry Smith    Collective on Tao
1295a7e14dcfSSatish Balay 
1296a7e14dcfSSatish Balay    Input Parameters:
1297441846f8SBarry Smith .  solver - the Tao context
1298a7e14dcfSSatish Balay 
1299a7e14dcfSSatish Balay    Level: developer
1300a7e14dcfSSatish Balay 
1301a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
1302a7e14dcfSSatish Balay @*/
1303441846f8SBarry Smith PetscErrorCode TaoResetStatistics(Tao tao)
1304a7e14dcfSSatish Balay {
1305a7e14dcfSSatish Balay   PetscFunctionBegin;
1306441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1307a7e14dcfSSatish Balay   tao->niter        = 0;
1308a7e14dcfSSatish Balay   tao->nfuncs       = 0;
1309a7e14dcfSSatish Balay   tao->nfuncgrads   = 0;
1310a7e14dcfSSatish Balay   tao->ngrads       = 0;
1311a7e14dcfSSatish Balay   tao->nhess        = 0;
1312a7e14dcfSSatish Balay   tao->njac         = 0;
1313a7e14dcfSSatish Balay   tao->nconstraints = 0;
1314a7e14dcfSSatish Balay   tao->ksp_its      = 0;
1315ae93cb3cSJason Sarich   tao->ksp_tot_its      = 0;
1316a7e14dcfSSatish Balay   tao->reason       = TAO_CONTINUE_ITERATING;
1317a7e14dcfSSatish Balay   tao->residual     = 0.0;
1318a7e14dcfSSatish Balay   tao->cnorm        = 0.0;
1319a7e14dcfSSatish Balay   tao->step         = 0.0;
1320a7e14dcfSSatish Balay   tao->lsflag       = PETSC_FALSE;
1321a7e14dcfSSatish Balay   if (tao->hist_reset) tao->hist_len=0;
1322a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1323a7e14dcfSSatish Balay }
1324a7e14dcfSSatish Balay 
1325a7e14dcfSSatish Balay #undef __FUNCT__
1326a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetConvergenceTest"
1327a7e14dcfSSatish Balay /*@C
1328a7e14dcfSSatish Balay   TaoSetConvergenceTest - Sets the function that is to be used to test
1329a7e14dcfSSatish Balay   for convergence o fthe iterative minimization solution.  The new convergence
1330a7e14dcfSSatish Balay   testing routine will replace TAO's default convergence test.
1331a7e14dcfSSatish Balay 
1332441846f8SBarry Smith   Logically Collective on Tao
1333a7e14dcfSSatish Balay 
1334a7e14dcfSSatish Balay   Input Parameters:
1335441846f8SBarry Smith + tao - the Tao object
1336a7e14dcfSSatish Balay . conv - the routine to test for convergence
1337a7e14dcfSSatish Balay - ctx - [optional] context for private data for the convergence routine
133847a47007SBarry Smith         (may be NULL)
1339a7e14dcfSSatish Balay 
1340a7e14dcfSSatish Balay   Calling sequence of conv:
1341441846f8SBarry Smith $   PetscErrorCode conv(Tao tao, void *ctx)
1342a7e14dcfSSatish Balay 
1343441846f8SBarry Smith + tao - the Tao object
1344a7e14dcfSSatish Balay - ctx - [optional] convergence context
1345a7e14dcfSSatish Balay 
1346e4cb33bbSBarry Smith   Note: The new convergence testing routine should call TaoSetConvergedReason().
1347a7e14dcfSSatish Balay 
1348a7e14dcfSSatish Balay   Level: advanced
1349a7e14dcfSSatish Balay 
1350e4cb33bbSBarry Smith .seealso: TaoSetConvergedReason(), TaoGetSolutionStatus(), TaoGetTolerances(), TaoSetMonitor
1351a7e14dcfSSatish Balay 
1352a7e14dcfSSatish Balay @*/
1353441846f8SBarry Smith PetscErrorCode TaoSetConvergenceTest(Tao tao, PetscErrorCode (*conv)(Tao,void*), void *ctx)
1354a7e14dcfSSatish Balay {
1355a7e14dcfSSatish Balay   PetscFunctionBegin;
1356441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1357a7e14dcfSSatish Balay   (tao)->ops->convergencetest = conv;
1358a7e14dcfSSatish Balay   (tao)->cnvP = ctx;
1359a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1360a7e14dcfSSatish Balay }
1361a7e14dcfSSatish Balay 
1362a7e14dcfSSatish Balay #undef __FUNCT__
1363a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMonitor"
1364a7e14dcfSSatish Balay /*@C
1365a7e14dcfSSatish Balay    TaoSetMonitor - Sets an ADDITIONAL function that is to be used at every
1366a7e14dcfSSatish Balay    iteration of the solver to display the iteration's
1367a7e14dcfSSatish Balay    progress.
1368a7e14dcfSSatish Balay 
1369441846f8SBarry Smith    Logically Collective on Tao
1370a7e14dcfSSatish Balay 
1371a7e14dcfSSatish Balay    Input Parameters:
1372441846f8SBarry Smith +  tao - the Tao solver context
1373a7e14dcfSSatish Balay .  mymonitor - monitoring routine
1374a7e14dcfSSatish Balay -  mctx - [optional] user-defined context for private data for the
137547a47007SBarry Smith           monitor routine (may be NULL)
1376a7e14dcfSSatish Balay 
1377a7e14dcfSSatish Balay    Calling sequence of mymonitor:
1378441846f8SBarry Smith $     int mymonitor(Tao tao,void *mctx)
1379a7e14dcfSSatish Balay 
1380441846f8SBarry Smith +    tao - the Tao solver context
1381a7e14dcfSSatish Balay -    mctx - [optional] monitoring context
1382a7e14dcfSSatish Balay 
1383a7e14dcfSSatish Balay 
1384a7e14dcfSSatish Balay    Options Database Keys:
1385a7e14dcfSSatish Balay +    -tao_monitor        - sets TaoDefaultMonitor()
1386a7e14dcfSSatish Balay .    -tao_smonitor       - sets short monitor
1387a7e14dcfSSatish Balay .    -tao_cmonitor       - same as smonitor plus constraint norm
1388a7e14dcfSSatish Balay .    -tao_view_solution   - view solution at each iteration
1389a7e14dcfSSatish Balay .    -tao_view_gradient   - view gradient at each iteration
1390a7e14dcfSSatish Balay .    -tao_view_separableobjective - view separable objective function at each iteration
1391a7e14dcfSSatish 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.
1392a7e14dcfSSatish Balay 
1393a7e14dcfSSatish Balay 
1394a7e14dcfSSatish Balay    Notes:
1395a7e14dcfSSatish Balay    Several different monitoring routines may be set by calling
1396a7e14dcfSSatish Balay    TaoSetMonitor() multiple times; all will be called in the
1397a7e14dcfSSatish Balay    order in which they were set.
1398a7e14dcfSSatish Balay 
1399a7e14dcfSSatish Balay    Fortran Notes: Only one monitor function may be set
1400a7e14dcfSSatish Balay 
1401a7e14dcfSSatish Balay    Level: intermediate
1402a7e14dcfSSatish Balay 
1403a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoCancelMonitors(),  TaoSetDestroyRoutine()
1404a7e14dcfSSatish Balay @*/
1405441846f8SBarry Smith PetscErrorCode TaoSetMonitor(Tao tao, PetscErrorCode (*func)(Tao, void*), void *ctx,PetscErrorCode (*dest)(void**))
1406a7e14dcfSSatish Balay {
1407a7e14dcfSSatish Balay   PetscFunctionBegin;
1408441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
140947a47007SBarry Smith   if (tao->numbermonitors >= MAXTAOMONITORS) SETERRQ1(PETSC_COMM_SELF,1,"Cannot attach another monitor -- max=",MAXTAOMONITORS);
1410a7e14dcfSSatish Balay   tao->monitor[tao->numbermonitors] = func;
1411a7e14dcfSSatish Balay   tao->monitorcontext[tao->numbermonitors] = ctx;
1412a7e14dcfSSatish Balay   tao->monitordestroy[tao->numbermonitors] = dest;
1413a7e14dcfSSatish Balay   ++tao->numbermonitors;
1414a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1415a7e14dcfSSatish Balay }
1416a7e14dcfSSatish Balay 
1417a7e14dcfSSatish Balay #undef __FUNCT__
1418a7e14dcfSSatish Balay #define __FUNCT__ "TaoCancelMonitors"
1419a7e14dcfSSatish Balay /*@
1420441846f8SBarry Smith    TaoCancelMonitors - Clears all the monitor functions for a Tao object.
1421a7e14dcfSSatish Balay 
1422441846f8SBarry Smith    Logically Collective on Tao
1423a7e14dcfSSatish Balay 
1424a7e14dcfSSatish Balay    Input Parameters:
1425441846f8SBarry Smith .  tao - the Tao solver context
1426a7e14dcfSSatish Balay 
1427a7e14dcfSSatish Balay    Options Database:
1428a7e14dcfSSatish Balay .  -tao_cancelmonitors - cancels all monitors that have been hardwired
1429a7e14dcfSSatish Balay     into a code by calls to TaoSetMonitor(), but does not cancel those
1430a7e14dcfSSatish Balay     set via the options database
1431a7e14dcfSSatish Balay 
1432a7e14dcfSSatish Balay    Notes:
1433441846f8SBarry Smith    There is no way to clear one specific monitor from a Tao object.
1434a7e14dcfSSatish Balay 
1435a7e14dcfSSatish Balay    Level: advanced
1436a7e14dcfSSatish Balay 
1437a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1438a7e14dcfSSatish Balay @*/
1439441846f8SBarry Smith PetscErrorCode TaoCancelMonitors(Tao tao)
1440a7e14dcfSSatish Balay {
1441a7e14dcfSSatish Balay   PetscInt       i;
1442a7e14dcfSSatish Balay   PetscErrorCode ierr;
144347a47007SBarry Smith 
1444a7e14dcfSSatish Balay   PetscFunctionBegin;
1445441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1446a7e14dcfSSatish Balay   for (i=0;i<tao->numbermonitors;i++) {
1447a7e14dcfSSatish Balay     if (tao->monitordestroy[i]) {
1448a7e14dcfSSatish Balay       ierr = (*tao->monitordestroy[i])(&tao->monitorcontext[i]);CHKERRQ(ierr);
1449a7e14dcfSSatish Balay     }
1450a7e14dcfSSatish Balay   }
1451a7e14dcfSSatish Balay   tao->numbermonitors=0;
1452a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1453a7e14dcfSSatish Balay }
1454a7e14dcfSSatish Balay 
1455a7e14dcfSSatish Balay #undef __FUNCT__
1456a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultMonitor"
14577fab98ebSJason Sarich /*@
1458a7e14dcfSSatish Balay    TaoDefaultMonitor - Default routine for monitoring progress of the
1459441846f8SBarry Smith    Tao solvers (default).  This monitor prints the function value and gradient
1460a7e14dcfSSatish Balay    norm at each iteration.  It can be turned on from the command line using the
1461a7e14dcfSSatish Balay    -tao_monitor option
1462a7e14dcfSSatish Balay 
1463441846f8SBarry Smith    Collective on Tao
1464a7e14dcfSSatish Balay 
1465a7e14dcfSSatish Balay    Input Parameters:
1466441846f8SBarry Smith +  tao - the Tao context
146747a47007SBarry Smith -  ctx - PetscViewer context or NULL
1468a7e14dcfSSatish Balay 
1469a7e14dcfSSatish Balay    Options Database Keys:
1470a7e14dcfSSatish Balay .  -tao_monitor
1471a7e14dcfSSatish Balay 
1472a7e14dcfSSatish Balay    Level: advanced
1473a7e14dcfSSatish Balay 
1474a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1475a7e14dcfSSatish Balay @*/
1476441846f8SBarry Smith PetscErrorCode TaoDefaultMonitor(Tao tao, void *ctx)
1477a7e14dcfSSatish Balay {
1478a7e14dcfSSatish Balay   PetscErrorCode ierr;
1479a7e14dcfSSatish Balay   PetscInt       its;
1480a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1481a7e14dcfSSatish Balay   PetscViewer    viewer;
148247a47007SBarry Smith 
1483a7e14dcfSSatish Balay   PetscFunctionBegin;
1484a7e14dcfSSatish Balay   if (ctx) {
1485a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1486a7e14dcfSSatish Balay   } else {
1487a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1488a7e14dcfSSatish Balay   }
1489a7e14dcfSSatish Balay   its=tao->niter;
1490a7e14dcfSSatish Balay   fct=tao->fc;
1491a7e14dcfSSatish Balay   gnorm=tao->residual;
1492a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr);
149347a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr);
149447a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer,"  Residual: %g \n",(double)gnorm);CHKERRQ(ierr);
1495a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1496a7e14dcfSSatish Balay }
1497a7e14dcfSSatish Balay 
1498a7e14dcfSSatish Balay #undef __FUNCT__
1499a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultSMonitor"
15007fab98ebSJason Sarich /*@
1501a7e14dcfSSatish Balay    TaoDefaultSMonitor - Default routine for monitoring progress of the
1502a7e14dcfSSatish Balay    solver. Same as TaoDefaultMonitor() except
1503a7e14dcfSSatish Balay    it prints fewer digits of the residual as the residual gets smaller.
1504a7e14dcfSSatish Balay    This is because the later digits are meaningless and are often
1505a7e14dcfSSatish Balay    different on different machines; by using this routine different
1506a7e14dcfSSatish Balay    machines will usually generate the same output. It can be turned on
1507a7e14dcfSSatish Balay    by using the -tao_smonitor option
1508a7e14dcfSSatish Balay 
1509441846f8SBarry Smith    Collective on Tao
1510a7e14dcfSSatish Balay 
1511a7e14dcfSSatish Balay    Input Parameters:
1512441846f8SBarry Smith +  tao - the Tao context
151347a47007SBarry Smith -  ctx - PetscViewer context or NULL
1514a7e14dcfSSatish Balay 
1515a7e14dcfSSatish Balay    Options Database Keys:
1516a7e14dcfSSatish Balay .  -tao_smonitor
1517a7e14dcfSSatish Balay 
1518a7e14dcfSSatish Balay    Level: advanced
1519a7e14dcfSSatish Balay 
1520a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1521a7e14dcfSSatish Balay @*/
1522441846f8SBarry Smith PetscErrorCode TaoDefaultSMonitor(Tao tao, void *ctx)
1523a7e14dcfSSatish Balay {
1524a7e14dcfSSatish Balay   PetscErrorCode ierr;
1525a7e14dcfSSatish Balay   PetscInt       its;
1526a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1527a7e14dcfSSatish Balay   PetscViewer    viewer;
152847a47007SBarry Smith 
1529a7e14dcfSSatish Balay   PetscFunctionBegin;
1530a7e14dcfSSatish Balay   if (ctx) {
1531a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1532a7e14dcfSSatish Balay   } else {
1533a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1534a7e14dcfSSatish Balay   }
1535a7e14dcfSSatish Balay   its=tao->niter;
1536a7e14dcfSSatish Balay   fct=tao->fc;
1537a7e14dcfSSatish Balay   gnorm=tao->residual;
1538a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr);
153947a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value %g,",(double)fct);CHKERRQ(ierr);
1540a7e14dcfSSatish Balay   if (gnorm > 1.e-6) {
154147a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr);
1542a7e14dcfSSatish Balay   } else if (gnorm > 1.e-11) {
1543a7e14dcfSSatish Balay     ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-6 \n");CHKERRQ(ierr);
1544a7e14dcfSSatish Balay   } else {
1545a7e14dcfSSatish Balay     ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-11 \n");CHKERRQ(ierr);
1546a7e14dcfSSatish Balay   }
1547a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1548a7e14dcfSSatish Balay }
1549a7e14dcfSSatish Balay 
1550a7e14dcfSSatish Balay #undef __FUNCT__
1551a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultCMonitor"
15527fab98ebSJason Sarich /*@
1553a7e14dcfSSatish Balay    TaoDefaultCMonitor - same as TaoDefaultMonitor() except
1554a7e14dcfSSatish Balay    it prints the norm of the constraints function. It can be turned on
1555a7e14dcfSSatish Balay    from the command line using the -tao_cmonitor option
1556a7e14dcfSSatish Balay 
1557441846f8SBarry Smith    Collective on Tao
1558a7e14dcfSSatish Balay 
1559a7e14dcfSSatish Balay    Input Parameters:
1560441846f8SBarry Smith +  tao - the Tao context
156147a47007SBarry Smith -  ctx - PetscViewer context or NULL
1562a7e14dcfSSatish Balay 
1563a7e14dcfSSatish Balay    Options Database Keys:
1564a7e14dcfSSatish Balay .  -tao_cmonitor
1565a7e14dcfSSatish Balay 
1566a7e14dcfSSatish Balay    Level: advanced
1567a7e14dcfSSatish Balay 
1568a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1569a7e14dcfSSatish Balay @*/
1570441846f8SBarry Smith PetscErrorCode TaoDefaultCMonitor(Tao tao, void *ctx)
1571a7e14dcfSSatish Balay {
1572a7e14dcfSSatish Balay   PetscErrorCode ierr;
1573a7e14dcfSSatish Balay   PetscInt       its;
1574a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1575a7e14dcfSSatish Balay   PetscViewer    viewer;
1576a7e14dcfSSatish Balay 
1577a7e14dcfSSatish Balay   PetscFunctionBegin;
1578a7e14dcfSSatish Balay   if (ctx) {
1579a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1580a7e14dcfSSatish Balay   } else {
1581a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1582a7e14dcfSSatish Balay   }
1583a7e14dcfSSatish Balay   its=tao->niter;
1584a7e14dcfSSatish Balay   fct=tao->fc;
1585a7e14dcfSSatish Balay   gnorm=tao->residual;
1586a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %D,",its);CHKERRQ(ierr);
158747a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr);
158847a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer,"  Residual: %g ",(double)gnorm);CHKERRQ(ierr);
158947a47007SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"  Constraint: %g \n",(double)tao->cnorm);CHKERRQ(ierr);
1590a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1591a7e14dcfSSatish Balay }
1592a7e14dcfSSatish Balay 
1593a7e14dcfSSatish Balay #undef __FUNCT__
1594a7e14dcfSSatish Balay #define __FUNCT__ "TaoSolutionMonitor"
1595a7e14dcfSSatish Balay /*@C
1596a7e14dcfSSatish Balay    TaoSolutionMonitor - Views the solution at each iteration
1597a7e14dcfSSatish Balay    It can be turned on from the command line using the
1598a7e14dcfSSatish Balay    -tao_view_solution option
1599a7e14dcfSSatish Balay 
1600441846f8SBarry Smith    Collective on Tao
1601a7e14dcfSSatish Balay 
1602a7e14dcfSSatish Balay    Input Parameters:
1603441846f8SBarry Smith +  tao - the Tao context
160447a47007SBarry Smith -  ctx - PetscViewer context or NULL
1605a7e14dcfSSatish Balay 
1606a7e14dcfSSatish Balay    Options Database Keys:
1607a7e14dcfSSatish Balay .  -tao_view_solution
1608a7e14dcfSSatish Balay 
1609a7e14dcfSSatish Balay    Level: advanced
1610a7e14dcfSSatish Balay 
1611a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1612a7e14dcfSSatish Balay @*/
1613441846f8SBarry Smith PetscErrorCode TaoSolutionMonitor(Tao tao, void *ctx)
1614a7e14dcfSSatish Balay {
1615a7e14dcfSSatish Balay   PetscErrorCode ierr;
1616a7e14dcfSSatish Balay   PetscViewer viewer;
161747a47007SBarry Smith 
1618a7e14dcfSSatish Balay   PetscFunctionBegin;
1619a7e14dcfSSatish Balay   if (ctx) {
1620a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1621a7e14dcfSSatish Balay   } else {
1622a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1623a7e14dcfSSatish Balay   }
1624a7e14dcfSSatish Balay   ierr = VecView(tao->solution, viewer);CHKERRQ(ierr);
1625a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1626a7e14dcfSSatish Balay }
1627a7e14dcfSSatish Balay 
1628a7e14dcfSSatish Balay #undef __FUNCT__
1629a7e14dcfSSatish Balay #define __FUNCT__ "TaoGradientMonitor"
1630a7e14dcfSSatish Balay /*@C
1631a7e14dcfSSatish Balay    TaoGradientMonitor - Views the gradient at each iteration
1632a7e14dcfSSatish Balay    It can be turned on from the command line using the
1633a7e14dcfSSatish Balay    -tao_view_gradient option
1634a7e14dcfSSatish Balay 
1635441846f8SBarry Smith    Collective on Tao
1636a7e14dcfSSatish Balay 
1637a7e14dcfSSatish Balay    Input Parameters:
1638441846f8SBarry Smith +  tao - the Tao context
163947a47007SBarry Smith -  ctx - PetscViewer context or NULL
1640a7e14dcfSSatish Balay 
1641a7e14dcfSSatish Balay    Options Database Keys:
1642a7e14dcfSSatish Balay .  -tao_view_gradient
1643a7e14dcfSSatish Balay 
1644a7e14dcfSSatish Balay    Level: advanced
1645a7e14dcfSSatish Balay 
1646a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1647a7e14dcfSSatish Balay @*/
1648441846f8SBarry Smith PetscErrorCode TaoGradientMonitor(Tao tao, void *ctx)
1649a7e14dcfSSatish Balay {
1650a7e14dcfSSatish Balay   PetscErrorCode ierr;
1651a7e14dcfSSatish Balay   PetscViewer viewer;
165247a47007SBarry Smith 
1653a7e14dcfSSatish Balay   PetscFunctionBegin;
1654a7e14dcfSSatish Balay   if (ctx) {
1655a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1656a7e14dcfSSatish Balay   } else {
1657a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1658a7e14dcfSSatish Balay   }
1659a7e14dcfSSatish Balay   ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr);
1660a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1661a7e14dcfSSatish Balay }
1662a7e14dcfSSatish Balay 
1663a7e14dcfSSatish Balay #undef __FUNCT__
1664a7e14dcfSSatish Balay #define __FUNCT__ "TaoStepDirectionMonitor"
1665a7e14dcfSSatish Balay /*@C
1666a7e14dcfSSatish Balay    TaoStepDirectionMonitor - Views the gradient at each iteration
1667a7e14dcfSSatish Balay    It can be turned on from the command line using the
1668a7e14dcfSSatish Balay    -tao_view_gradient option
1669a7e14dcfSSatish Balay 
1670441846f8SBarry Smith    Collective on Tao
1671a7e14dcfSSatish Balay 
1672a7e14dcfSSatish Balay    Input Parameters:
1673441846f8SBarry Smith +  tao - the Tao context
167447a47007SBarry Smith -  ctx - PetscViewer context or NULL
1675a7e14dcfSSatish Balay 
1676a7e14dcfSSatish Balay    Options Database Keys:
1677a7e14dcfSSatish Balay .  -tao_view_gradient
1678a7e14dcfSSatish Balay 
1679a7e14dcfSSatish Balay    Level: advanced
1680a7e14dcfSSatish Balay 
1681a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1682a7e14dcfSSatish Balay @*/
1683441846f8SBarry Smith PetscErrorCode TaoStepDirectionMonitor(Tao tao, void *ctx)
1684a7e14dcfSSatish Balay {
1685a7e14dcfSSatish Balay   PetscErrorCode ierr;
1686a7e14dcfSSatish Balay   PetscViewer viewer;
1687a7e14dcfSSatish Balay   PetscFunctionBegin;
1688a7e14dcfSSatish Balay   if (ctx) {
1689a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1690a7e14dcfSSatish Balay   } else {
1691a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1692a7e14dcfSSatish Balay   }
1693a7e14dcfSSatish Balay   ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr);
1694a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1695a7e14dcfSSatish Balay }
1696a7e14dcfSSatish Balay 
1697a7e14dcfSSatish Balay #undef __FUNCT__
1698a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawSolutionMonitor"
1699a7e14dcfSSatish Balay /*@C
1700a7e14dcfSSatish Balay    TaoDrawSolutionMonitor - Plots the solution at each iteration
1701a7e14dcfSSatish Balay    It can be turned on from the command line using the
1702a7e14dcfSSatish Balay    -tao_draw_solution option
1703a7e14dcfSSatish Balay 
1704441846f8SBarry Smith    Collective on Tao
1705a7e14dcfSSatish Balay 
1706a7e14dcfSSatish Balay    Input Parameters:
1707441846f8SBarry Smith +  tao - the Tao context
170847a47007SBarry Smith -  ctx - PetscViewer context or NULL
1709a7e14dcfSSatish Balay 
1710a7e14dcfSSatish Balay    Options Database Keys:
1711a7e14dcfSSatish Balay .  -tao_draw_solution
1712a7e14dcfSSatish Balay 
1713a7e14dcfSSatish Balay    Level: advanced
1714a7e14dcfSSatish Balay 
1715a7e14dcfSSatish Balay .seealso: TaoSolutionMonitor(), TaoSetMonitor(), TaoDrawGradientMonitor
1716a7e14dcfSSatish Balay @*/
1717441846f8SBarry Smith PetscErrorCode TaoDrawSolutionMonitor(Tao tao, void *ctx)
1718a7e14dcfSSatish Balay {
1719a7e14dcfSSatish Balay   PetscErrorCode ierr;
1720a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer) ctx;
1721a7e14dcfSSatish Balay   MPI_Comm       comm;
172247a47007SBarry Smith 
1723a7e14dcfSSatish Balay   PetscFunctionBegin;
1724a7e14dcfSSatish Balay   if (!viewer) {
1725a7e14dcfSSatish Balay     ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
1726a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_DRAW_(comm);
1727a7e14dcfSSatish Balay   }
1728a7e14dcfSSatish Balay   ierr = VecView(tao->solution, viewer);CHKERRQ(ierr);
1729a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1730a7e14dcfSSatish Balay }
1731a7e14dcfSSatish Balay 
1732a7e14dcfSSatish Balay #undef __FUNCT__
1733a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawGradientMonitor"
1734a7e14dcfSSatish Balay /*@C
1735a7e14dcfSSatish Balay    TaoDrawGradientMonitor - Plots the gradient at each iteration
1736a7e14dcfSSatish Balay    It can be turned on from the command line using the
1737a7e14dcfSSatish Balay    -tao_draw_gradient option
1738a7e14dcfSSatish Balay 
1739441846f8SBarry Smith    Collective on Tao
1740a7e14dcfSSatish Balay 
1741a7e14dcfSSatish Balay    Input Parameters:
1742441846f8SBarry Smith +  tao - the Tao context
174347a47007SBarry Smith -  ctx - PetscViewer context or NULL
1744a7e14dcfSSatish Balay 
1745a7e14dcfSSatish Balay    Options Database Keys:
1746a7e14dcfSSatish Balay .  -tao_draw_gradient
1747a7e14dcfSSatish Balay 
1748a7e14dcfSSatish Balay    Level: advanced
1749a7e14dcfSSatish Balay 
1750a7e14dcfSSatish Balay .seealso: TaoGradientMonitor(), TaoSetMonitor(), TaoDrawSolutionMonitor
1751a7e14dcfSSatish Balay @*/
1752441846f8SBarry Smith PetscErrorCode TaoDrawGradientMonitor(Tao tao, void *ctx)
1753a7e14dcfSSatish Balay {
1754a7e14dcfSSatish Balay   PetscErrorCode ierr;
1755a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer)ctx;
1756a7e14dcfSSatish Balay   MPI_Comm       comm;
175747a47007SBarry Smith 
1758a7e14dcfSSatish Balay   PetscFunctionBegin;
1759a7e14dcfSSatish Balay   if (!viewer) {
1760a7e14dcfSSatish Balay     ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
1761a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_DRAW_(comm);
1762a7e14dcfSSatish Balay   }
1763a7e14dcfSSatish Balay   ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr);
1764a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1765a7e14dcfSSatish Balay }
1766a7e14dcfSSatish Balay 
1767a7e14dcfSSatish Balay #undef __FUNCT__
1768a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawStepMonitor"
1769a7e14dcfSSatish Balay /*@C
1770a7e14dcfSSatish Balay    TaoDrawStepMonitor - Plots the step direction at each iteration
1771a7e14dcfSSatish Balay    It can be turned on from the command line using the
1772a7e14dcfSSatish Balay    -tao_draw_step 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_draw_step
1782a7e14dcfSSatish Balay 
1783a7e14dcfSSatish Balay    Level: advanced
1784a7e14dcfSSatish Balay 
1785a7e14dcfSSatish Balay .seealso: TaoSetMonitor(), TaoDrawSolutionMonitor
1786a7e14dcfSSatish Balay @*/
1787441846f8SBarry Smith PetscErrorCode TaoDrawStepMonitor(Tao tao, void *ctx)
1788a7e14dcfSSatish Balay {
1789a7e14dcfSSatish Balay   PetscErrorCode ierr;
1790a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer)(ctx);
1791a7e14dcfSSatish Balay   MPI_Comm       comm;
179247a47007SBarry Smith 
1793a7e14dcfSSatish Balay   PetscFunctionBegin;
1794a7e14dcfSSatish Balay   if (!viewer) {
1795a7e14dcfSSatish Balay     ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
1796a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_DRAW_(comm);
1797a7e14dcfSSatish Balay   }
1798a7e14dcfSSatish Balay   ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr);
1799a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1800a7e14dcfSSatish Balay }
1801a7e14dcfSSatish Balay 
1802a7e14dcfSSatish Balay #undef __FUNCT__
1803a7e14dcfSSatish Balay #define __FUNCT__ "TaoSeparableObjectiveMonitor"
1804a7e14dcfSSatish Balay /*@C
1805a7e14dcfSSatish Balay    TaoSeparableObjectiveMonitor - Views the separable objective function at each iteration
1806a7e14dcfSSatish Balay    It can be turned on from the command line using the
1807a7e14dcfSSatish Balay    -tao_view_separableobjective option
1808a7e14dcfSSatish Balay 
1809441846f8SBarry Smith    Collective on Tao
1810a7e14dcfSSatish Balay 
1811a7e14dcfSSatish Balay    Input Parameters:
1812441846f8SBarry Smith +  tao - the Tao context
181347a47007SBarry Smith -  ctx - PetscViewer context or NULL
1814a7e14dcfSSatish Balay 
1815a7e14dcfSSatish Balay    Options Database Keys:
1816a7e14dcfSSatish Balay .  -tao_view_separableobjective
1817a7e14dcfSSatish Balay 
1818a7e14dcfSSatish Balay    Level: advanced
1819a7e14dcfSSatish Balay 
1820a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1821a7e14dcfSSatish Balay @*/
1822441846f8SBarry Smith PetscErrorCode TaoSeparableObjectiveMonitor(Tao tao, void *ctx)
1823a7e14dcfSSatish Balay {
1824a7e14dcfSSatish Balay   PetscErrorCode ierr;
1825a7e14dcfSSatish Balay   PetscViewer    viewer;
182647a47007SBarry Smith 
1827a7e14dcfSSatish Balay   PetscFunctionBegin;
1828a7e14dcfSSatish Balay   if (ctx) {
1829a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1830a7e14dcfSSatish Balay   } else {
1831a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1832a7e14dcfSSatish Balay   }
1833a7e14dcfSSatish Balay   ierr = VecView(tao->sep_objective,viewer);CHKERRQ(ierr);
1834a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1835a7e14dcfSSatish Balay }
1836a7e14dcfSSatish Balay 
1837a7e14dcfSSatish Balay #undef __FUNCT__
1838a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultConvergenceTest"
18397fab98ebSJason Sarich /*@
1840a7e14dcfSSatish Balay    TaoDefaultConvergenceTest - Determines whether the solver should continue iterating
1841a7e14dcfSSatish Balay    or terminate.
1842a7e14dcfSSatish Balay 
1843441846f8SBarry Smith    Collective on Tao
1844a7e14dcfSSatish Balay 
1845a7e14dcfSSatish Balay    Input Parameters:
1846441846f8SBarry Smith +  tao - the Tao context
1847a7e14dcfSSatish Balay -  dummy - unused dummy context
1848a7e14dcfSSatish Balay 
1849a7e14dcfSSatish Balay    Output Parameter:
1850a7e14dcfSSatish Balay .  reason - for terminating
1851a7e14dcfSSatish Balay 
1852a7e14dcfSSatish Balay    Notes:
1853a7e14dcfSSatish Balay    This routine checks the residual in the optimality conditions, the
1854a7e14dcfSSatish Balay    relative residual in the optimity conditions, the number of function
1855a7e14dcfSSatish Balay    evaluations, and the function value to test convergence.  Some
1856a7e14dcfSSatish Balay    solvers may use different convergence routines.
1857a7e14dcfSSatish Balay 
1858a7e14dcfSSatish Balay    Level: developer
1859a7e14dcfSSatish Balay 
1860e4cb33bbSBarry Smith .seealso: TaoSetTolerances(),TaoGetConvergedReason(),TaoSetConvergedReason()
1861a7e14dcfSSatish Balay @*/
1862a7e14dcfSSatish Balay 
1863441846f8SBarry Smith PetscErrorCode TaoDefaultConvergenceTest(Tao tao,void *dummy)
1864a7e14dcfSSatish Balay {
1865a7e14dcfSSatish Balay   PetscInt           niter=tao->niter, nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads);
1866a7e14dcfSSatish Balay   PetscInt           max_funcs=tao->max_funcs;
1867a7e14dcfSSatish Balay   PetscReal          gnorm=tao->residual, gnorm0=tao->gnorm0;
1868a7e14dcfSSatish Balay   PetscReal          f=tao->fc, steptol=tao->steptol,trradius=tao->step;
1869a7e14dcfSSatish Balay   PetscReal          gatol=tao->gatol,grtol=tao->grtol,gttol=tao->gttol;
1870a7e14dcfSSatish Balay   PetscReal          fatol=tao->fatol,frtol=tao->frtol,catol=tao->catol,crtol=tao->crtol;
1871a7e14dcfSSatish Balay   PetscReal          fmin=tao->fmin, cnorm=tao->cnorm, cnorm0=tao->cnorm0;
1872a7e14dcfSSatish Balay   PetscReal          gnorm2;
1873e4cb33bbSBarry Smith   TaoConvergedReason reason=tao->reason;
1874a7e14dcfSSatish Balay   PetscErrorCode     ierr;
1875a7e14dcfSSatish Balay 
1876a7e14dcfSSatish Balay   PetscFunctionBegin;
1877441846f8SBarry Smith   PetscValidHeaderSpecific(tao, TAO_CLASSID,1);
1878a7e14dcfSSatish Balay   if (reason != TAO_CONTINUE_ITERATING) {
1879a7e14dcfSSatish Balay     PetscFunctionReturn(0);
1880a7e14dcfSSatish Balay   }
1881a7e14dcfSSatish Balay   gnorm2=gnorm*gnorm;
1882a7e14dcfSSatish Balay 
1883a7e14dcfSSatish Balay   if (PetscIsInfOrNanReal(f)) {
1884a7e14dcfSSatish Balay     ierr = PetscInfo(tao,"Failed to converged, function value is Inf or NaN\n");CHKERRQ(ierr);
1885a7e14dcfSSatish Balay     reason = TAO_DIVERGED_NAN;
1886a7e14dcfSSatish Balay   } else if (f <= fmin && cnorm <=catol) {
188747a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to function value %g < minimum function value %g\n", (double)f,(double)fmin);CHKERRQ(ierr);
1888a7e14dcfSSatish Balay     reason = TAO_CONVERGED_MINF;
1889a7e14dcfSSatish Balay   } else if (gnorm2 <= fatol && cnorm <=catol) {
189047a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to estimated f(X) - f(X*) = %g < %g\n",(double)gnorm2,(double)fatol);CHKERRQ(ierr);
1891a7e14dcfSSatish Balay     reason = TAO_CONVERGED_FATOL;
1892a7e14dcfSSatish Balay   } else if (f != 0 && gnorm2 / PetscAbsReal(f)<= frtol && cnorm/PetscMax(cnorm0,1.0) <= crtol) {
189347a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to estimated |f(X)-f(X*)|/f(X) = %g < %g\n",(double)(gnorm2/PetscAbsReal(f)),(double)frtol);CHKERRQ(ierr);
1894a7e14dcfSSatish Balay     reason = TAO_CONVERGED_FRTOL;
1895a7e14dcfSSatish Balay   } else if (gnorm<= gatol && cnorm <=catol) {
189647a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to residual norm ||g(X)||=%g < %g\n",(double)gnorm,(double)gatol);CHKERRQ(ierr);
1897a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GATOL;
1898a7e14dcfSSatish Balay   } else if ( f!=0 && PetscAbsReal(gnorm/f) <= grtol && cnorm <= crtol) {
189947a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to residual ||g(X)||/|f(X)| =%g < %g\n",(double)(gnorm/f),(double)grtol);CHKERRQ(ierr);
1900a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GRTOL;
1901a7e14dcfSSatish Balay   } else if (gnorm0 != 0 && gnorm/gnorm0 <= gttol && cnorm <= crtol) {
190247a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to relative residual norm ||g(X)||/||g(X0)|| = %g < %g\n",(double)(gnorm/gnorm0),(double)gttol);CHKERRQ(ierr);
1903a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GTTOL;
1904a7e14dcfSSatish Balay   } else if (nfuncs > max_funcs){
1905a7e14dcfSSatish Balay     ierr = PetscInfo2(tao,"Exceeded maximum number of function evaluations: %D > %D\n", nfuncs,max_funcs);CHKERRQ(ierr);
1906a7e14dcfSSatish Balay     reason = TAO_DIVERGED_MAXFCN;
1907a7e14dcfSSatish Balay   } else if ( tao->lsflag != 0 ){
1908a7e14dcfSSatish Balay     ierr = PetscInfo(tao,"Tao Line Search failure.\n");CHKERRQ(ierr);
1909a7e14dcfSSatish Balay     reason = TAO_DIVERGED_LS_FAILURE;
1910a7e14dcfSSatish Balay   } else if (trradius < steptol && niter > 0){
191147a47007SBarry Smith     ierr = PetscInfo2(tao,"Trust region/step size too small: %g < %g\n", (double)trradius,(double)steptol);CHKERRQ(ierr);
1912a7e14dcfSSatish Balay     reason = TAO_CONVERGED_STEPTOL;
1913a7e14dcfSSatish Balay   } else if (niter > tao->max_it) {
1914a7e14dcfSSatish Balay     ierr = PetscInfo2(tao,"Exceeded maximum number of iterations: %D > %D\n",niter,tao->max_it);CHKERRQ(ierr);
1915a7e14dcfSSatish Balay     reason = TAO_DIVERGED_MAXITS;
1916a7e14dcfSSatish Balay   } else {
1917a7e14dcfSSatish Balay     reason = TAO_CONTINUE_ITERATING;
1918a7e14dcfSSatish Balay   }
1919a7e14dcfSSatish Balay   tao->reason = reason;
1920a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1921a7e14dcfSSatish Balay }
1922a7e14dcfSSatish Balay 
1923a7e14dcfSSatish Balay #undef __FUNCT__
1924a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetOptionsPrefix"
1925a7e14dcfSSatish Balay /*@C
1926a7e14dcfSSatish Balay    TaoSetOptionsPrefix - Sets the prefix used for searching for all
1927a7e14dcfSSatish Balay    TAO options in the database.
1928a7e14dcfSSatish Balay 
1929a7e14dcfSSatish Balay 
1930441846f8SBarry Smith    Logically Collective on Tao
1931a7e14dcfSSatish Balay 
1932a7e14dcfSSatish Balay    Input Parameters:
1933441846f8SBarry Smith +  tao - the Tao context
1934a7e14dcfSSatish Balay -  prefix - the prefix string to prepend to all TAO option requests
1935a7e14dcfSSatish Balay 
1936a7e14dcfSSatish Balay    Notes:
1937a7e14dcfSSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
1938a7e14dcfSSatish Balay    The first character of all runtime options is AUTOMATICALLY the hyphen.
1939a7e14dcfSSatish Balay 
1940a7e14dcfSSatish Balay    For example, to distinguish between the runtime options for two
1941a7e14dcfSSatish Balay    different TAO solvers, one could call
1942a7e14dcfSSatish Balay .vb
1943a7e14dcfSSatish Balay       TaoSetOptionsPrefix(tao1,"sys1_")
1944a7e14dcfSSatish Balay       TaoSetOptionsPrefix(tao2,"sys2_")
1945a7e14dcfSSatish Balay .ve
1946a7e14dcfSSatish Balay 
1947a7e14dcfSSatish Balay    This would enable use of different options for each system, such as
1948a7e14dcfSSatish Balay .vb
1949a7e14dcfSSatish Balay       -sys1_tao_method blmvm -sys1_tao_gtol 1.e-3
1950a7e14dcfSSatish Balay       -sys2_tao_method lmvm  -sys2_tao_gtol 1.e-4
1951a7e14dcfSSatish Balay .ve
1952a7e14dcfSSatish Balay 
1953a7e14dcfSSatish Balay 
1954a7e14dcfSSatish Balay    Level: advanced
1955a7e14dcfSSatish Balay 
1956a7e14dcfSSatish Balay .seealso: TaoAppendOptionsPrefix(), TaoGetOptionsPrefix()
1957a7e14dcfSSatish Balay @*/
1958a7e14dcfSSatish Balay 
1959441846f8SBarry Smith PetscErrorCode TaoSetOptionsPrefix(Tao tao, const char p[])
1960a7e14dcfSSatish Balay {
1961a7e14dcfSSatish Balay   PetscErrorCode ierr;
196247a47007SBarry Smith 
1963a7e14dcfSSatish Balay   PetscFunctionBegin;
1964a7e14dcfSSatish Balay   ierr = PetscObjectSetOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr);
1965a7e14dcfSSatish Balay   if (tao->linesearch) {
1966a7e14dcfSSatish Balay     ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr);
1967a7e14dcfSSatish Balay   }
1968a7e14dcfSSatish Balay   if (tao->ksp) {
1969a7e14dcfSSatish Balay     ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr);
1970a7e14dcfSSatish Balay   }
1971a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1972a7e14dcfSSatish Balay }
1973a7e14dcfSSatish Balay 
1974a7e14dcfSSatish Balay #undef __FUNCT__
1975a7e14dcfSSatish Balay #define __FUNCT__ "TaoAppendOptionsPrefix"
1976a7e14dcfSSatish Balay /*@C
1977a7e14dcfSSatish Balay    TaoAppendOptionsPrefix - Appends to the prefix used for searching for all
1978a7e14dcfSSatish Balay    TAO options in the database.
1979a7e14dcfSSatish Balay 
1980a7e14dcfSSatish Balay 
1981441846f8SBarry Smith    Logically Collective on Tao
1982a7e14dcfSSatish Balay 
1983a7e14dcfSSatish Balay    Input Parameters:
1984441846f8SBarry Smith +  tao - the Tao solver context
1985a7e14dcfSSatish Balay -  prefix - the prefix string to prepend to all TAO option requests
1986a7e14dcfSSatish Balay 
1987a7e14dcfSSatish Balay    Notes:
1988a7e14dcfSSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
1989a7e14dcfSSatish Balay    The first character of all runtime options is AUTOMATICALLY the hyphen.
1990a7e14dcfSSatish Balay 
1991a7e14dcfSSatish Balay 
1992a7e14dcfSSatish Balay    Level: advanced
1993a7e14dcfSSatish Balay 
1994a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoGetOptionsPrefix()
1995a7e14dcfSSatish Balay @*/
1996441846f8SBarry Smith PetscErrorCode TaoAppendOptionsPrefix(Tao tao, const char p[])
1997a7e14dcfSSatish Balay {
1998a7e14dcfSSatish Balay   PetscErrorCode ierr;
199947a47007SBarry Smith 
2000a7e14dcfSSatish Balay   PetscFunctionBegin;
2001a7e14dcfSSatish Balay   ierr = PetscObjectAppendOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr);
2002a7e14dcfSSatish Balay   if (tao->linesearch) {
2003a7e14dcfSSatish Balay     ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr);
2004a7e14dcfSSatish Balay   }
2005a7e14dcfSSatish Balay   if (tao->ksp) {
2006a7e14dcfSSatish Balay     ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr);
2007a7e14dcfSSatish Balay   }
2008a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2009a7e14dcfSSatish Balay }
2010a7e14dcfSSatish Balay 
2011a7e14dcfSSatish Balay #undef __FUNCT__
2012a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetOptionsPrefix"
2013a7e14dcfSSatish Balay /*@C
2014a7e14dcfSSatish Balay   TaoGetOptionsPrefix - Gets the prefix used for searching for all
2015a7e14dcfSSatish Balay   TAO options in the database
2016a7e14dcfSSatish Balay 
2017a7e14dcfSSatish Balay   Not Collective
2018a7e14dcfSSatish Balay 
2019a7e14dcfSSatish Balay   Input Parameters:
2020441846f8SBarry Smith . tao - the Tao context
2021a7e14dcfSSatish Balay 
2022a7e14dcfSSatish Balay   Output Parameters:
2023a7e14dcfSSatish Balay . prefix - pointer to the prefix string used is returned
2024a7e14dcfSSatish Balay 
2025a7e14dcfSSatish Balay   Notes: On the fortran side, the user should pass in a string 'prefix' of
2026a7e14dcfSSatish Balay   sufficient length to hold the prefix.
2027a7e14dcfSSatish Balay 
2028a7e14dcfSSatish Balay   Level: advanced
2029a7e14dcfSSatish Balay 
2030a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoAppendOptionsPrefix()
2031a7e14dcfSSatish Balay @*/
2032441846f8SBarry Smith PetscErrorCode TaoGetOptionsPrefix(Tao tao, const char *p[])
2033a7e14dcfSSatish Balay {
203447a47007SBarry Smith    return PetscObjectGetOptionsPrefix((PetscObject)tao,p);
2035a7e14dcfSSatish Balay }
2036a7e14dcfSSatish Balay 
2037a7e14dcfSSatish Balay #undef __FUNCT__
2038a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetType"
2039a7e14dcfSSatish Balay /*@C
2040a7e14dcfSSatish Balay    TaoSetType - Sets the method for the unconstrained minimization solver.
2041a7e14dcfSSatish Balay 
2042441846f8SBarry Smith    Collective on Tao
2043a7e14dcfSSatish Balay 
2044a7e14dcfSSatish Balay    Input Parameters:
2045441846f8SBarry Smith +  solver - the Tao solver context
2046a7e14dcfSSatish Balay -  type - a known method
2047a7e14dcfSSatish Balay 
2048a7e14dcfSSatish Balay    Options Database Key:
204958417fe7SBarry Smith .  -tao_type <type> - Sets the method; use -help for a list
205058417fe7SBarry Smith    of available methods (for instance, "-tao_type lmvm" or "-tao_type tron")
2051a7e14dcfSSatish Balay 
2052a7e14dcfSSatish Balay    Available methods include:
205358417fe7SBarry Smith +    nls - Newton's method with line search for unconstrained minimization
205458417fe7SBarry Smith .    ntr - Newton's method with trust region for unconstrained minimization
205558417fe7SBarry Smith .    ntl - Newton's method with trust region, line search for unconstrained minimization
205658417fe7SBarry Smith .    lmvm - Limited memory variable metric method for unconstrained minimization
205758417fe7SBarry Smith .    cg - Nonlinear conjugate gradient method for unconstrained minimization
205858417fe7SBarry Smith .    nm - Nelder-Mead algorithm for derivate-free unconstrained minimization
205958417fe7SBarry Smith .    tron - Newton Trust Region method for bound constrained minimization
206058417fe7SBarry Smith .    gpcg - Newton Trust Region method for quadratic bound constrained minimization
206158417fe7SBarry Smith .    blmvm - Limited memory variable metric method for bound constrained minimization
20621eb8069cSJason Sarich -    pounders - Model-based algorithm pounder extended for nonlinear least squares
2063a7e14dcfSSatish Balay 
2064a7e14dcfSSatish Balay   Level: intermediate
2065a7e14dcfSSatish Balay 
20661eb8069cSJason Sarich .seealso: TaoCreate(), TaoGetType(), TaoType
2067a7e14dcfSSatish Balay 
2068a7e14dcfSSatish Balay @*/
2069441846f8SBarry Smith PetscErrorCode TaoSetType(Tao tao, const TaoType type)
2070a7e14dcfSSatish Balay {
2071a7e14dcfSSatish Balay   PetscErrorCode ierr;
2072441846f8SBarry Smith   PetscErrorCode (*create_xxx)(Tao);
2073a7e14dcfSSatish Balay   PetscBool      issame;
2074a7e14dcfSSatish Balay 
2075a7e14dcfSSatish Balay   PetscFunctionBegin;
2076441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2077a7e14dcfSSatish Balay 
2078a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)tao,type,&issame);CHKERRQ(ierr);
2079a7e14dcfSSatish Balay   if (issame) PetscFunctionReturn(0);
2080a7e14dcfSSatish Balay 
2081441846f8SBarry Smith   ierr = PetscFunctionListFind(TaoList, type, (void(**)(void))&create_xxx);CHKERRQ(ierr);
2082441846f8SBarry Smith   if (!create_xxx) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested Tao type %s",type);
2083a7e14dcfSSatish Balay 
2084a7e14dcfSSatish Balay   /* Destroy the existing solver information */
2085a7e14dcfSSatish Balay   if (tao->ops->destroy) {
2086a7e14dcfSSatish Balay     ierr = (*tao->ops->destroy)(tao);CHKERRQ(ierr);
2087a7e14dcfSSatish Balay   }
2088a7e14dcfSSatish Balay   ierr = KSPDestroy(&tao->ksp);CHKERRQ(ierr);
2089a7e14dcfSSatish Balay   ierr = TaoLineSearchDestroy(&tao->linesearch);CHKERRQ(ierr);
2090a7e14dcfSSatish Balay   ierr = VecDestroy(&tao->gradient);CHKERRQ(ierr);
2091a7e14dcfSSatish Balay   ierr = VecDestroy(&tao->stepdirection);CHKERRQ(ierr);
2092a7e14dcfSSatish Balay 
2093a7e14dcfSSatish Balay   tao->ops->setup = 0;
2094a7e14dcfSSatish Balay   tao->ops->solve = 0;
2095a7e14dcfSSatish Balay   tao->ops->view  = 0;
2096a7e14dcfSSatish Balay   tao->ops->setfromoptions = 0;
2097a7e14dcfSSatish Balay   tao->ops->destroy = 0;
2098a7e14dcfSSatish Balay 
2099a7e14dcfSSatish Balay   tao->setupcalled = PETSC_FALSE;
2100a7e14dcfSSatish Balay 
2101a7e14dcfSSatish Balay   ierr = (*create_xxx)(tao);CHKERRQ(ierr);
2102a7e14dcfSSatish Balay   ierr = PetscObjectChangeTypeName((PetscObject)tao,type);CHKERRQ(ierr);
2103a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2104a7e14dcfSSatish Balay }
210547a47007SBarry Smith 
2106a7e14dcfSSatish Balay #undef __FUNCT__
2107441846f8SBarry Smith #define __FUNCT__ "TaoRegister"
2108a7e14dcfSSatish Balay /*MC
2109441846f8SBarry Smith    TaoRegister - Adds a method to the TAO package for unconstrained minimization.
2110a7e14dcfSSatish Balay 
2111a7e14dcfSSatish Balay    Synopsis:
2112441846f8SBarry Smith    TaoRegister(char *name_solver,char *path,char *name_Create,int (*routine_Create)(Tao))
2113a7e14dcfSSatish Balay 
2114a7e14dcfSSatish Balay    Not collective
2115a7e14dcfSSatish Balay 
2116a7e14dcfSSatish Balay    Input Parameters:
2117a7e14dcfSSatish Balay +  sname - name of a new user-defined solver
2118a7e14dcfSSatish Balay -  func - routine to Create method context
2119a7e14dcfSSatish Balay 
2120a7e14dcfSSatish Balay    Notes:
2121441846f8SBarry Smith    TaoRegister() may be called multiple times to add several user-defined solvers.
2122a7e14dcfSSatish Balay 
2123a7e14dcfSSatish Balay    Sample usage:
2124a7e14dcfSSatish Balay .vb
2125441846f8SBarry Smith    TaoRegister("my_solver",MySolverCreate);
2126a7e14dcfSSatish Balay .ve
2127a7e14dcfSSatish Balay 
2128a7e14dcfSSatish Balay    Then, your solver can be chosen with the procedural interface via
2129a7e14dcfSSatish Balay $     TaoSetType(tao,"my_solver")
2130a7e14dcfSSatish Balay    or at runtime via the option
213158417fe7SBarry Smith $     -tao_type my_solver
2132a7e14dcfSSatish Balay 
2133a7e14dcfSSatish Balay    Level: advanced
2134a7e14dcfSSatish Balay 
2135441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegisterDestroy()
2136a7e14dcfSSatish Balay M*/
2137441846f8SBarry Smith PetscErrorCode TaoRegister(const char sname[], PetscErrorCode (*func)(Tao))
2138a7e14dcfSSatish Balay {
2139a7e14dcfSSatish Balay   PetscErrorCode ierr;
2140a7e14dcfSSatish Balay 
2141a7e14dcfSSatish Balay   PetscFunctionBegin;
2142441846f8SBarry Smith   ierr = PetscFunctionListAdd(&TaoList,sname, (void (*)(void))func);CHKERRQ(ierr);
2143a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2144a7e14dcfSSatish Balay }
2145a7e14dcfSSatish Balay 
2146a7e14dcfSSatish Balay #undef __FUNCT__
2147441846f8SBarry Smith #define __FUNCT__ "TaoRegisterDestroy"
2148a7e14dcfSSatish Balay /*@C
2149441846f8SBarry Smith    TaoRegisterDestroy - Frees the list of minimization solvers that were
2150441846f8SBarry Smith    registered by TaoRegisterDynamic().
2151a7e14dcfSSatish Balay 
2152a7e14dcfSSatish Balay    Not Collective
2153a7e14dcfSSatish Balay 
2154a7e14dcfSSatish Balay    Level: advanced
2155a7e14dcfSSatish Balay 
2156441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegister()
2157a7e14dcfSSatish Balay @*/
2158441846f8SBarry Smith PetscErrorCode TaoRegisterDestroy(void)
2159a7e14dcfSSatish Balay {
2160a7e14dcfSSatish Balay   PetscErrorCode ierr;
2161a7e14dcfSSatish Balay   PetscFunctionBegin;
2162441846f8SBarry Smith   ierr = PetscFunctionListDestroy(&TaoList);CHKERRQ(ierr);
2163441846f8SBarry Smith   TaoRegisterAllCalled = PETSC_FALSE;
2164a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2165a7e14dcfSSatish Balay }
216647a47007SBarry Smith 
2167a7e14dcfSSatish Balay #undef __FUNCT__
2168e4cb33bbSBarry Smith #define __FUNCT__ "TaoSetConvergedReason"
2169a7e14dcfSSatish Balay /*@
2170e4cb33bbSBarry Smith   TaoSetConvergedReason - Sets the termination flag on a Tao object
2171a7e14dcfSSatish Balay 
2172441846f8SBarry Smith   Logically Collective on Tao
2173a7e14dcfSSatish Balay 
2174a7e14dcfSSatish Balay   Input Parameters:
2175441846f8SBarry Smith + tao - the Tao context
2176a7e14dcfSSatish Balay - reason - one of
2177a7e14dcfSSatish Balay $     TAO_CONVERGED_ATOL (2),
2178a7e14dcfSSatish Balay $     TAO_CONVERGED_RTOL (3),
2179a7e14dcfSSatish Balay $     TAO_CONVERGED_STEPTOL (4),
2180a7e14dcfSSatish Balay $     TAO_CONVERGED_MINF (5),
2181a7e14dcfSSatish Balay $     TAO_CONVERGED_USER (6),
2182a7e14dcfSSatish Balay $     TAO_DIVERGED_MAXITS (-2),
2183a7e14dcfSSatish Balay $     TAO_DIVERGED_NAN (-4),
2184a7e14dcfSSatish Balay $     TAO_DIVERGED_MAXFCN (-5),
2185a7e14dcfSSatish Balay $     TAO_DIVERGED_LS_FAILURE (-6),
2186a7e14dcfSSatish Balay $     TAO_DIVERGED_TR_REDUCTION (-7),
2187a7e14dcfSSatish Balay $     TAO_DIVERGED_USER (-8),
2188a7e14dcfSSatish Balay $     TAO_CONTINUE_ITERATING (0)
2189a7e14dcfSSatish Balay 
2190a7e14dcfSSatish Balay    Level: intermediate
2191a7e14dcfSSatish Balay 
2192a7e14dcfSSatish Balay @*/
2193e4cb33bbSBarry Smith PetscErrorCode TaoSetConvergedReason(Tao tao, TaoConvergedReason reason)
2194a7e14dcfSSatish Balay {
2195441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2196a7e14dcfSSatish Balay   PetscFunctionBegin;
2197a7e14dcfSSatish Balay   tao->reason = reason;
2198a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2199a7e14dcfSSatish Balay }
2200a7e14dcfSSatish Balay 
2201a7e14dcfSSatish Balay #undef __FUNCT__
2202e4cb33bbSBarry Smith #define __FUNCT__ "TaoGetConvergedReason"
2203a7e14dcfSSatish Balay /*@
2204e4cb33bbSBarry Smith    TaoGetConvergedReason - Gets the reason the Tao iteration was stopped.
2205a7e14dcfSSatish Balay 
2206a7e14dcfSSatish Balay    Not Collective
2207a7e14dcfSSatish Balay 
2208a7e14dcfSSatish Balay    Input Parameter:
2209441846f8SBarry Smith .  tao - the Tao solver context
2210a7e14dcfSSatish Balay 
2211a7e14dcfSSatish Balay    Output Parameter:
2212a7e14dcfSSatish Balay .  reason - one of
2213a7e14dcfSSatish Balay 
2214a7e14dcfSSatish Balay $  TAO_CONVERGED_FATOL (1)           f(X)-f(X*) <= fatol
2215a7e14dcfSSatish Balay $  TAO_CONVERGED_FRTOL (2)           |f(X) - f(X*)|/|f(X)| < frtol
2216a7e14dcfSSatish Balay $  TAO_CONVERGED_GATOL (3)           ||g(X)|| < gatol
2217a7e14dcfSSatish Balay $  TAO_CONVERGED_GRTOL (4)           ||g(X)|| / f(X)  < grtol
2218a7e14dcfSSatish Balay $  TAO_CONVERGED_GTTOL (5)           ||g(X)|| / ||g(X0)|| < gttol
2219a7e14dcfSSatish Balay $  TAO_CONVERGED_STEPTOL (6)         step size small
2220a7e14dcfSSatish Balay $  TAO_CONVERGED_MINF (7)            F < F_min
2221a7e14dcfSSatish Balay $  TAO_CONVERGED_USER (8)            User defined
2222a7e14dcfSSatish Balay 
2223a7e14dcfSSatish Balay $  TAO_DIVERGED_MAXITS (-2)          its > maxits
2224a7e14dcfSSatish Balay $  TAO_DIVERGED_NAN (-4)             Numerical problems
2225a7e14dcfSSatish Balay $  TAO_DIVERGED_MAXFCN (-5)          fevals > max_funcsals
2226a7e14dcfSSatish Balay $  TAO_DIVERGED_LS_FAILURE (-6)      line search failure
2227a7e14dcfSSatish Balay $  TAO_DIVERGED_TR_REDUCTION (-7)    trust region failure
2228a7e14dcfSSatish Balay $  TAO_DIVERGED_USER(-8)             (user defined)
2229a7e14dcfSSatish Balay 
2230a7e14dcfSSatish Balay $  TAO_CONTINUE_ITERATING (0)
2231a7e14dcfSSatish Balay 
2232a7e14dcfSSatish Balay    where
2233a7e14dcfSSatish Balay +  X - current solution
2234a7e14dcfSSatish Balay .  X0 - initial guess
2235a7e14dcfSSatish Balay .  f(X) - current function value
2236a7e14dcfSSatish Balay .  f(X*) - true solution (estimated)
2237a7e14dcfSSatish Balay .  g(X) - current gradient
2238a7e14dcfSSatish Balay .  its - current iterate number
2239a7e14dcfSSatish Balay .  maxits - maximum number of iterates
2240a7e14dcfSSatish Balay .  fevals - number of function evaluations
2241a7e14dcfSSatish Balay -  max_funcsals - maximum number of function evaluations
2242a7e14dcfSSatish Balay 
2243a7e14dcfSSatish Balay    Level: intermediate
2244a7e14dcfSSatish Balay 
2245a7e14dcfSSatish Balay .seealso: TaoSetConvergenceTest(), TaoSetTolerances()
2246a7e14dcfSSatish Balay 
2247a7e14dcfSSatish Balay @*/
2248e4cb33bbSBarry Smith PetscErrorCode TaoGetConvergedReason(Tao tao, TaoConvergedReason *reason)
2249a7e14dcfSSatish Balay {
2250a7e14dcfSSatish Balay   PetscFunctionBegin;
2251441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2252a7e14dcfSSatish Balay   PetscValidPointer(reason,2);
2253a7e14dcfSSatish Balay   *reason = tao->reason;
2254a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2255a7e14dcfSSatish Balay }
2256a7e14dcfSSatish Balay 
2257a7e14dcfSSatish Balay #undef __FUNCT__
2258a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetSolutionStatus"
2259a7e14dcfSSatish Balay /*@
2260a7e14dcfSSatish Balay   TaoGetSolutionStatus - Get the current iterate, objective value,
2261a7e14dcfSSatish Balay   residual, infeasibility, and termination
2262a7e14dcfSSatish Balay 
2263a7e14dcfSSatish Balay   Not Collective
2264a7e14dcfSSatish Balay 
2265a7e14dcfSSatish Balay    Input Parameters:
2266441846f8SBarry Smith .  tao - the Tao context
2267a7e14dcfSSatish Balay 
2268a7e14dcfSSatish Balay    Output Parameters:
2269a7e14dcfSSatish Balay +  iterate - the current iterate number (>=0)
2270a7e14dcfSSatish Balay .  f - the current function value
227158417fe7SBarry Smith .  gnorm - the square of the gradient norm, duality gap, or other measure indicating distance from optimality.
2272a7e14dcfSSatish Balay .  cnorm - the infeasibility of the current solution with regard to the constraints.
2273a7e14dcfSSatish Balay .  xdiff - the step length or trust region radius of the most recent iterate.
2274a7e14dcfSSatish Balay -  reason - The termination reason, which can equal TAO_CONTINUE_ITERATING
2275a7e14dcfSSatish Balay 
2276a7e14dcfSSatish Balay    Level: intermediate
2277a7e14dcfSSatish Balay 
2278a7e14dcfSSatish Balay    Note:
2279a7e14dcfSSatish Balay    TAO returns the values set by the solvers in the routine TaoMonitor().
2280a7e14dcfSSatish Balay 
2281a7e14dcfSSatish Balay    Note:
228247a47007SBarry Smith    If any of the output arguments are set to NULL, no corresponding value will be returned.
2283a7e14dcfSSatish Balay 
2284e4cb33bbSBarry Smith .seealso: TaoMonitor(), TaoGetConvergedReason()
2285a7e14dcfSSatish Balay @*/
2286e4cb33bbSBarry Smith PetscErrorCode TaoGetSolutionStatus(Tao tao, PetscInt *its, PetscReal *f, PetscReal *gnorm, PetscReal *cnorm, PetscReal *xdiff, TaoConvergedReason *reason)
2287a7e14dcfSSatish Balay {
2288a7e14dcfSSatish Balay   PetscFunctionBegin;
2289a7e14dcfSSatish Balay   if (its) *its=tao->niter;
2290a7e14dcfSSatish Balay   if (f) *f=tao->fc;
2291a7e14dcfSSatish Balay   if (gnorm) *gnorm=tao->residual;
2292a7e14dcfSSatish Balay   if (cnorm) *cnorm=tao->cnorm;
2293a7e14dcfSSatish Balay   if (reason) *reason=tao->reason;
2294a7e14dcfSSatish Balay   if (xdiff) *xdiff=tao->step;
2295a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2296a7e14dcfSSatish Balay }
2297a7e14dcfSSatish Balay 
2298a7e14dcfSSatish Balay #undef __FUNCT__
2299a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetType"
2300a7e14dcfSSatish Balay /*@C
2301441846f8SBarry Smith    TaoGetType - Gets the current Tao algorithm.
2302a7e14dcfSSatish Balay 
2303a7e14dcfSSatish Balay    Not Collective
2304a7e14dcfSSatish Balay 
2305a7e14dcfSSatish Balay    Input Parameter:
2306441846f8SBarry Smith .  tao - the Tao solver context
2307a7e14dcfSSatish Balay 
2308a7e14dcfSSatish Balay    Output Parameter:
2309441846f8SBarry Smith .  type - Tao method
2310a7e14dcfSSatish Balay 
2311a7e14dcfSSatish Balay    Level: intermediate
2312a7e14dcfSSatish Balay 
2313a7e14dcfSSatish Balay @*/
2314441846f8SBarry Smith PetscErrorCode TaoGetType(Tao tao, const TaoType *type)
2315a7e14dcfSSatish Balay {
2316a7e14dcfSSatish Balay   PetscFunctionBegin;
2317441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2318a7e14dcfSSatish Balay   PetscValidPointer(type,2);
2319a7e14dcfSSatish Balay   *type=((PetscObject)tao)->type_name;
2320a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2321a7e14dcfSSatish Balay }
2322a7e14dcfSSatish Balay 
2323a7e14dcfSSatish Balay #undef __FUNCT__
2324a7e14dcfSSatish Balay #define __FUNCT__ "TaoMonitor"
2325a7e14dcfSSatish Balay /*@C
2326a7e14dcfSSatish Balay   TaoMonitor - Monitor the solver and the current solution.  This
2327a7e14dcfSSatish Balay   routine will record the iteration number and residual statistics,
2328a7e14dcfSSatish Balay   call any monitors specified by the user, and calls the convergence-check routine.
2329a7e14dcfSSatish Balay 
2330a7e14dcfSSatish Balay    Input Parameters:
2331441846f8SBarry Smith +  tao - the Tao context
2332a7e14dcfSSatish Balay .  its - the current iterate number (>=0)
2333a7e14dcfSSatish Balay .  f - the current objective function value
233458417fe7SBarry Smith .  res - the gradient norm, square root of the duality gap, or other measure indicating distince from optimality.  This measure will be recorded and
2335a7e14dcfSSatish Balay           used for some termination tests.
2336a7e14dcfSSatish Balay .  cnorm - the infeasibility of the current solution with regard to the constraints.
2337a7e14dcfSSatish Balay -  steplength - multiple of the step direction added to the previous iterate.
2338a7e14dcfSSatish Balay 
2339a7e14dcfSSatish Balay    Output Parameters:
2340a7e14dcfSSatish Balay .  reason - The termination reason, which can equal TAO_CONTINUE_ITERATING
2341a7e14dcfSSatish Balay 
2342a7e14dcfSSatish Balay    Options Database Key:
2343a7e14dcfSSatish Balay .  -tao_monitor - Use the default monitor, which prints statistics to standard output
2344a7e14dcfSSatish Balay 
2345e4cb33bbSBarry Smith .seealso TaoGetConvergedReason(), TaoDefaultMonitor(), TaoSetMonitor()
2346a7e14dcfSSatish Balay 
2347a7e14dcfSSatish Balay    Level: developer
2348a7e14dcfSSatish Balay 
2349a7e14dcfSSatish Balay @*/
2350e4cb33bbSBarry Smith PetscErrorCode TaoMonitor(Tao tao, PetscInt its, PetscReal f, PetscReal res, PetscReal cnorm, PetscReal steplength, TaoConvergedReason *reason)
2351a7e14dcfSSatish Balay {
2352a7e14dcfSSatish Balay   PetscErrorCode ierr;
235347a47007SBarry Smith   PetscInt       i;
235447a47007SBarry Smith 
2355a7e14dcfSSatish Balay   PetscFunctionBegin;
2356441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2357a7e14dcfSSatish Balay   tao->fc = f;
2358a7e14dcfSSatish Balay   tao->residual = res;
2359a7e14dcfSSatish Balay   tao->cnorm = cnorm;
2360a7e14dcfSSatish Balay   tao->step = steplength;
2361a7e14dcfSSatish Balay   tao->niter=its;
2362a7e14dcfSSatish Balay   if (its == 0) {
2363a7e14dcfSSatish Balay     tao->cnorm0 = cnorm; tao->gnorm0 = res;
2364a7e14dcfSSatish Balay   }
2365ae93cb3cSJason Sarich   TaoLogConvergenceHistory(tao,f,res,cnorm,tao->ksp_its);
236647a47007SBarry Smith   if (PetscIsInfOrNanReal(f) || PetscIsInfOrNanReal(res)) SETERRQ(PETSC_COMM_SELF,1, "User provided compute function generated Inf or NaN");
2367a7e14dcfSSatish Balay   if (tao->ops->convergencetest) {
2368a7e14dcfSSatish Balay     ierr = (*tao->ops->convergencetest)(tao,tao->cnvP);CHKERRQ(ierr);
2369a7e14dcfSSatish Balay   }
2370a7e14dcfSSatish Balay   for (i=0;i<tao->numbermonitors;i++) {
2371a7e14dcfSSatish Balay     ierr = (*tao->monitor[i])(tao,tao->monitorcontext[i]);CHKERRQ(ierr);
2372a7e14dcfSSatish Balay   }
2373a7e14dcfSSatish Balay   *reason = tao->reason;
2374a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2375a7e14dcfSSatish Balay }
2376a7e14dcfSSatish Balay 
2377a7e14dcfSSatish Balay #undef __FUNCT__
2378ae93cb3cSJason Sarich #define __FUNCT__ "TaoSetConvergenceHistory"
2379a7e14dcfSSatish Balay /*@
2380ae93cb3cSJason Sarich    TaoSetConvergenceHistory - Sets the array used to hold the convergence history.
2381a7e14dcfSSatish Balay 
2382441846f8SBarry Smith    Logically Collective on Tao
2383a7e14dcfSSatish Balay 
2384a7e14dcfSSatish Balay    Input Parameters:
2385441846f8SBarry Smith +  tao - the Tao solver context
2386a7e14dcfSSatish Balay .  obj   - array to hold objective value history
2387a7e14dcfSSatish Balay .  resid - array to hold residual history
2388a7e14dcfSSatish Balay .  cnorm - array to hold constraint violation history
2389ae93cb3cSJason Sarich .  lits - integer array holds the number of linear iterations for each solve
2390a7e14dcfSSatish Balay .  na  - size of obj, resid, and cnorm
2391a7e14dcfSSatish Balay -  reset - PetscTrue indicates each new minimization resets the history counter to zero,
2392a7e14dcfSSatish Balay            else it continues storing new values for new minimizations after the old ones
2393a7e14dcfSSatish Balay 
2394a7e14dcfSSatish Balay    Notes:
2395a7e14dcfSSatish Balay    If set, TAO will fill the given arrays with the indicated
2396ae93cb3cSJason Sarich    information at each iteration.  If 'obj','resid','cnorm','lits' are
2397ae93cb3cSJason Sarich    *all* NULL then space (using size na, or 1000 if na is PETSC_DECIDE or
2398ae93cb3cSJason Sarich    PETSC_DEFAULT) is allocated for the history.
2399ae93cb3cSJason Sarich    If not all are NULL, then only the Non-NULL information categories
2400ae93cb3cSJason Sarich    will be stored, the others will be ignored.
2401ae93cb3cSJason Sarich 
2402ae93cb3cSJason Sarich    Any convergence information after iteration number 'na' will not be stored.
2403a7e14dcfSSatish Balay 
2404a7e14dcfSSatish Balay    This routine is useful, e.g., when running a code for purposes
2405a7e14dcfSSatish Balay    of accurate performance monitoring, when no I/O should be done
2406a7e14dcfSSatish Balay    during the section of code that is being timed.
2407a7e14dcfSSatish Balay 
2408a7e14dcfSSatish Balay    Level: intermediate
2409a7e14dcfSSatish Balay 
2410ae93cb3cSJason Sarich .seealso: TaoGetConvergenceHistory()
2411a7e14dcfSSatish Balay 
2412a7e14dcfSSatish Balay @*/
2413ae93cb3cSJason Sarich PetscErrorCode TaoSetConvergenceHistory(Tao tao, PetscReal *obj, PetscReal *resid, PetscReal *cnorm, PetscInt *lits, PetscInt na,PetscBool reset)
2414a7e14dcfSSatish Balay {
2415ae93cb3cSJason Sarich   PetscErrorCode ierr;
2416ae93cb3cSJason Sarich 
2417a7e14dcfSSatish Balay   PetscFunctionBegin;
2418441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2419ae93cb3cSJason Sarich   if (obj) PetscValidScalarPointer(obj,2);
2420ae93cb3cSJason Sarich   if (resid) PetscValidScalarPointer(resid,3);
2421ae93cb3cSJason Sarich   if (cnorm) PetscValidScalarPointer(cnorm,4);
2422ae93cb3cSJason Sarich   if (lits) PetscValidIntPointer(lits,5);
2423ae93cb3cSJason Sarich 
2424ae93cb3cSJason Sarich   if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000;
2425ae93cb3cSJason Sarich   if (!obj && !resid && !cnorm && !lits) {
2426ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&obj);CHKERRQ(ierr);
2427ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&resid);CHKERRQ(ierr);
2428ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&cnorm);CHKERRQ(ierr);
2429ae93cb3cSJason Sarich     ierr = PetscCalloc1(na,&lits);CHKERRQ(ierr);
2430ae93cb3cSJason Sarich     tao->hist_malloc=PETSC_TRUE;
2431ae93cb3cSJason Sarich   }
2432ae93cb3cSJason Sarich 
2433a7e14dcfSSatish Balay   tao->hist_obj = obj;
2434a7e14dcfSSatish Balay   tao->hist_resid = resid;
2435a7e14dcfSSatish Balay   tao->hist_cnorm = cnorm;
2436ae93cb3cSJason Sarich   tao->hist_lits = lits;
2437a7e14dcfSSatish Balay   tao->hist_max   = na;
2438a7e14dcfSSatish Balay   tao->hist_reset = reset;
2439ae93cb3cSJason Sarich   tao->hist_len = 0;
2440a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2441a7e14dcfSSatish Balay }
2442a7e14dcfSSatish Balay 
2443a7e14dcfSSatish Balay #undef __FUNCT__
2444ae93cb3cSJason Sarich #define __FUNCT__ "TaoGetConvergenceHistory"
2445a7e14dcfSSatish Balay /*@C
2446ae93cb3cSJason Sarich    TaoGetConvergenceHistory - Gets the arrays used to hold the convergence history.
2447a7e14dcfSSatish Balay 
2448441846f8SBarry Smith    Collective on Tao
2449a7e14dcfSSatish Balay 
2450a7e14dcfSSatish Balay    Input Parameter:
2451441846f8SBarry Smith .  tao - the Tao context
2452a7e14dcfSSatish Balay 
2453a7e14dcfSSatish Balay    Output Parameters:
2454a7e14dcfSSatish Balay +  obj   - array used to hold objective value history
2455a7e14dcfSSatish Balay .  resid - array used to hold residual history
2456a7e14dcfSSatish Balay .  cnorm - array used to hold constraint violation history
2457ae93cb3cSJason Sarich .  lits  - integer array used to hold linear solver iteration count
2458ae93cb3cSJason Sarich -  nhist  - size of obj, resid, cnorm, and lits (will be less than or equal to na given in TaoSetHistory)
2459a7e14dcfSSatish Balay 
2460a7e14dcfSSatish Balay    Notes:
2461ae93cb3cSJason Sarich     This routine must be preceded by calls to TaoSetConvergenceHistory()
2462ae93cb3cSJason Sarich     and TaoSolve(), otherwise it returns useless information.
2463ae93cb3cSJason Sarich 
2464a7e14dcfSSatish Balay     The calling sequence for this routine in Fortran is
2465ae93cb3cSJason Sarich $   call TaoGetConvergenceHistory(Tao tao, PetscInt nhist, PetscErrorCode ierr)
2466a7e14dcfSSatish Balay 
2467a7e14dcfSSatish Balay    This routine is useful, e.g., when running a code for purposes
2468a7e14dcfSSatish Balay    of accurate performance monitoring, when no I/O should be done
2469a7e14dcfSSatish Balay    during the section of code that is being timed.
2470a7e14dcfSSatish Balay 
2471a7e14dcfSSatish Balay    Level: advanced
2472a7e14dcfSSatish Balay 
2473ae93cb3cSJason Sarich .seealso: TaoSetConvergenceHistory()
2474a7e14dcfSSatish Balay 
2475a7e14dcfSSatish Balay @*/
2476ae93cb3cSJason Sarich PetscErrorCode TaoGetConvergenceHistory(Tao tao, PetscReal **obj, PetscReal **resid, PetscReal **cnorm, PetscInt **lits, PetscInt *nhist)
2477a7e14dcfSSatish Balay {
2478a7e14dcfSSatish Balay   PetscFunctionBegin;
2479441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2480a7e14dcfSSatish Balay   if (obj)   *obj   = tao->hist_obj;
2481a7e14dcfSSatish Balay   if (cnorm) *cnorm = tao->hist_cnorm;
2482a7e14dcfSSatish Balay   if (resid) *resid = tao->hist_resid;
2483a7e14dcfSSatish Balay   if (nhist) *nhist   = tao->hist_len;
2484a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2485a7e14dcfSSatish Balay }
2486a7e14dcfSSatish Balay 
2487a7e14dcfSSatish Balay #undef __FUNCT__
2488a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetApplicationContext"
2489a7e14dcfSSatish Balay /*@
2490a7e14dcfSSatish Balay    TaoSetApplicationContext - Sets the optional user-defined context for
2491a7e14dcfSSatish Balay    a solver.
2492a7e14dcfSSatish Balay 
2493441846f8SBarry Smith    Logically Collective on Tao
2494a7e14dcfSSatish Balay 
2495a7e14dcfSSatish Balay    Input Parameters:
2496441846f8SBarry Smith +  tao  - the Tao context
2497a7e14dcfSSatish Balay -  usrP - optional user context
2498a7e14dcfSSatish Balay 
2499a7e14dcfSSatish Balay    Level: intermediate
2500a7e14dcfSSatish Balay 
2501a7e14dcfSSatish Balay .seealso: TaoGetApplicationContext(), TaoSetApplicationContext()
2502a7e14dcfSSatish Balay @*/
2503441846f8SBarry Smith PetscErrorCode  TaoSetApplicationContext(Tao tao,void *usrP)
2504a7e14dcfSSatish Balay {
2505a7e14dcfSSatish Balay   PetscFunctionBegin;
2506441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2507a7e14dcfSSatish Balay   tao->user = usrP;
2508a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2509a7e14dcfSSatish Balay }
2510a7e14dcfSSatish Balay 
2511a7e14dcfSSatish Balay #undef __FUNCT__
2512a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetApplicationContext"
2513a7e14dcfSSatish Balay /*@
2514a7e14dcfSSatish Balay    TaoGetApplicationContext - Gets the user-defined context for a
2515a7e14dcfSSatish Balay    TAO solvers.
2516a7e14dcfSSatish Balay 
2517a7e14dcfSSatish Balay    Not Collective
2518a7e14dcfSSatish Balay 
2519a7e14dcfSSatish Balay    Input Parameter:
2520441846f8SBarry Smith .  tao  - Tao context
2521a7e14dcfSSatish Balay 
2522a7e14dcfSSatish Balay    Output Parameter:
2523a7e14dcfSSatish Balay .  usrP - user context
2524a7e14dcfSSatish Balay 
2525a7e14dcfSSatish Balay    Level: intermediate
2526a7e14dcfSSatish Balay 
2527a7e14dcfSSatish Balay .seealso: TaoSetApplicationContext()
2528a7e14dcfSSatish Balay @*/
2529441846f8SBarry Smith PetscErrorCode  TaoGetApplicationContext(Tao tao,void *usrP)
2530a7e14dcfSSatish Balay {
2531a7e14dcfSSatish Balay   PetscFunctionBegin;
2532441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2533a7e14dcfSSatish Balay   *(void**)usrP = tao->user;
2534a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2535a7e14dcfSSatish Balay }
2536