xref: /petsc/src/tao/interface/taosolver.c (revision 6f4723b1819e116ea158ff0b45e943b7957b1d13)
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:
27a7e14dcfSSatish Balay +    tao_nls - Newton's method with line search for unconstrained minimization
28a7e14dcfSSatish Balay .    tao_ntr - Newton's method with trust region for unconstrained minimization
29a7e14dcfSSatish Balay .    tao_ntl - Newton's method with trust region, line search for unconstrained minimization
30a7e14dcfSSatish Balay .    tao_lmvm - Limited memory variable metric method for unconstrained minimization
31a7e14dcfSSatish Balay .    tao_cg - Nonlinear conjugate gradient method for unconstrained minimization
32a7e14dcfSSatish Balay .    tao_nm - Nelder-Mead algorithm for derivate-free unconstrained minimization
33a7e14dcfSSatish Balay .    tao_tron - Newton Trust Region method for bound constrained minimization
34a7e14dcfSSatish Balay .    tao_gpcg - Newton Trust Region method for quadratic bound constrained minimization
35a7e14dcfSSatish Balay .    tao_blmvm - Limited memory variable metric method for bound constrained minimization
36a7e14dcfSSatish Balay .    tao_lcl - Linearly constrained Lagrangian method for pde-constrained minimization
37a7e14dcfSSatish Balay -    tao_pounders - Model-based algorithm for nonlinear least squares
38a7e14dcfSSatish Balay 
39a7e14dcfSSatish Balay    Options Database Keys:
40a7e14dcfSSatish Balay +   -tao_method - select which method TAO should use
41a7e14dcfSSatish Balay -   -tao_type - identical to -tao_method
42a7e14dcfSSatish Balay 
43a7e14dcfSSatish Balay    Level: beginner
44a7e14dcfSSatish Balay 
45a7e14dcfSSatish Balay .seealso: TaoSolve(), TaoDestroy()
46a7e14dcfSSatish Balay @*/
47441846f8SBarry Smith PetscErrorCode TaoCreate(MPI_Comm comm, Tao *newtao)
48a7e14dcfSSatish Balay {
49a7e14dcfSSatish Balay   PetscErrorCode ierr;
50441846f8SBarry Smith   Tao            tao;
51a7e14dcfSSatish Balay 
52a7e14dcfSSatish Balay   PetscFunctionBegin;
53a7e14dcfSSatish Balay   PetscValidPointer(newtao,2);
5447a47007SBarry Smith   *newtao = NULL;
55a7e14dcfSSatish Balay 
56a7e14dcfSSatish Balay   ierr = TaoInitializePackage();CHKERRQ(ierr);
57a7e14dcfSSatish Balay   ierr = TaoLineSearchInitializePackage();CHKERRQ(ierr);
58a7e14dcfSSatish Balay 
59441846f8SBarry Smith   ierr = PetscHeaderCreate(tao,_p_Tao, struct _TaoOps, TAO_CLASSID,"Tao",0,0,comm,TaoDestroy,TaoView);CHKERRQ(ierr);
60a7e14dcfSSatish Balay   tao->ops->computeobjective=0;
61a7e14dcfSSatish Balay   tao->ops->computeobjectiveandgradient=0;
62a7e14dcfSSatish Balay   tao->ops->computegradient=0;
63a7e14dcfSSatish Balay   tao->ops->computehessian=0;
64a7e14dcfSSatish Balay   tao->ops->computeseparableobjective=0;
65a7e14dcfSSatish Balay   tao->ops->computeconstraints=0;
66a7e14dcfSSatish Balay   tao->ops->computejacobian=0;
67a7e14dcfSSatish Balay   tao->ops->computejacobianequality=0;
68a7e14dcfSSatish Balay   tao->ops->computejacobianinequality=0;
69a7e14dcfSSatish Balay   tao->ops->computeequalityconstraints=0;
70a7e14dcfSSatish Balay   tao->ops->computeinequalityconstraints=0;
71a7e14dcfSSatish Balay   tao->ops->convergencetest=TaoDefaultConvergenceTest;
72a7e14dcfSSatish Balay   tao->ops->convergencedestroy=0;
73a7e14dcfSSatish Balay   tao->ops->computedual=0;
74a7e14dcfSSatish Balay   tao->ops->setup=0;
75a7e14dcfSSatish Balay   tao->ops->solve=0;
76a7e14dcfSSatish Balay   tao->ops->view=0;
77a7e14dcfSSatish Balay   tao->ops->setfromoptions=0;
78a7e14dcfSSatish Balay   tao->ops->destroy=0;
79a7e14dcfSSatish Balay 
8047a47007SBarry Smith   tao->solution=NULL;
8147a47007SBarry Smith   tao->gradient=NULL;
8247a47007SBarry Smith   tao->sep_objective = NULL;
8347a47007SBarry Smith   tao->constraints=NULL;
8447a47007SBarry Smith   tao->constraints_equality=NULL;
8547a47007SBarry Smith   tao->constraints_inequality=NULL;
8647a47007SBarry Smith   tao->stepdirection=NULL;
8747a47007SBarry Smith   tao->XL = NULL;
8847a47007SBarry Smith   tao->XU = NULL;
8947a47007SBarry Smith   tao->IL = NULL;
9047a47007SBarry Smith   tao->IU = NULL;
9147a47007SBarry Smith   tao->DI = NULL;
9247a47007SBarry Smith   tao->DE = NULL;
9347a47007SBarry Smith   tao->hessian = NULL;
9447a47007SBarry Smith   tao->hessian_pre = NULL;
9547a47007SBarry Smith   tao->jacobian = NULL;
9647a47007SBarry Smith   tao->jacobian_pre = NULL;
9747a47007SBarry Smith   tao->jacobian_state = NULL;
9847a47007SBarry Smith   tao->jacobian_state_pre = NULL;
9947a47007SBarry Smith   tao->jacobian_state_inv = NULL;
10047a47007SBarry Smith   tao->jacobian_design = NULL;
10147a47007SBarry Smith   tao->jacobian_design_pre = NULL;
10247a47007SBarry Smith   tao->jacobian_equality = NULL;
10347a47007SBarry Smith   tao->jacobian_equality_pre = NULL;
10447a47007SBarry Smith   tao->jacobian_inequality = NULL;
10547a47007SBarry Smith   tao->jacobian_inequality_pre = NULL;
10647a47007SBarry Smith   tao->state_is = NULL;
10747a47007SBarry Smith   tao->design_is = NULL;
108a7e14dcfSSatish Balay 
109a7e14dcfSSatish Balay   tao->max_it     = 10000;
110a7e14dcfSSatish Balay   tao->max_funcs   = 10000;
111*6f4723b1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
112*6f4723b1SBarry Smith   tao->fatol       = 1e-5;
113*6f4723b1SBarry Smith   tao->frtol       = 1e-5;
114*6f4723b1SBarry Smith   tao->gatol       = 1e-5;
115*6f4723b1SBarry Smith   tao->grtol       = 1e-5;
116*6f4723b1SBarry Smith #else
117a7e14dcfSSatish Balay   tao->fatol       = 1e-8;
118a7e14dcfSSatish Balay   tao->frtol       = 1e-8;
119a7e14dcfSSatish Balay   tao->gatol       = 1e-8;
120a7e14dcfSSatish Balay   tao->grtol       = 1e-8;
121*6f4723b1SBarry Smith #endif
122a7e14dcfSSatish Balay   tao->gttol       = 0.0;
123a7e14dcfSSatish Balay   tao->catol       = 0.0;
124a7e14dcfSSatish Balay   tao->crtol       = 0.0;
125a7e14dcfSSatish Balay   tao->xtol        = 0.0;
126a7e14dcfSSatish Balay   tao->steptol     = 0.0;
127e270355aSBarry Smith   tao->trust0      = PETSC_INFINITY;
128*6f4723b1SBarry Smith   tao->fmin        = PETSC_NINFINITY;
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;
135a7e14dcfSSatish Balay 
136a7e14dcfSSatish Balay   tao->numbermonitors=0;
137a7e14dcfSSatish Balay   tao->viewsolution=PETSC_FALSE;
138a7e14dcfSSatish Balay   tao->viewhessian=PETSC_FALSE;
139a7e14dcfSSatish Balay   tao->viewgradient=PETSC_FALSE;
140a7e14dcfSSatish Balay   tao->viewjacobian=PETSC_FALSE;
141a7e14dcfSSatish Balay   tao->viewconstraints = PETSC_FALSE;
142a7e14dcfSSatish Balay   tao->viewtao = 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;
171a7e14dcfSSatish Balay   char           filename[PETSC_MAX_PATH_LEN];
172a7e14dcfSSatish Balay   PetscBool      flg;
173a7e14dcfSSatish Balay   PetscViewer    viewer;
17447a47007SBarry Smith 
175a7e14dcfSSatish Balay   PetscFunctionBegin;
176441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
177a7e14dcfSSatish Balay   ierr = TaoSetUp(tao);CHKERRQ(ierr);
178a7e14dcfSSatish Balay   ierr = TaoResetStatistics(tao);CHKERRQ(ierr);
179a7e14dcfSSatish Balay   if (tao->linesearch) {
180a7e14dcfSSatish Balay     ierr = TaoLineSearchReset(tao->linesearch);CHKERRQ(ierr);
181a7e14dcfSSatish Balay   }
182a7e14dcfSSatish Balay 
183441846f8SBarry Smith   ierr = PetscLogEventBegin(Tao_Solve,tao,0,0,0);CHKERRQ(ierr);
184a7e14dcfSSatish Balay   if (tao->ops->solve){ ierr = (*tao->ops->solve)(tao);CHKERRQ(ierr); }
185441846f8SBarry Smith   ierr = PetscLogEventEnd(Tao_Solve,tao,0,0,0);CHKERRQ(ierr);
186a7e14dcfSSatish Balay 
187a7e14dcfSSatish Balay   ierr = PetscOptionsGetString(((PetscObject)tao)->prefix,"-tao_view",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
188a7e14dcfSSatish Balay   if (flg && !PetscPreLoadingOn) {
189a7e14dcfSSatish Balay     ierr = PetscViewerASCIIOpen(((PetscObject)tao)->comm,filename,&viewer);CHKERRQ(ierr);
190a7e14dcfSSatish Balay     ierr = TaoView(tao,viewer);CHKERRQ(ierr);
191a7e14dcfSSatish Balay     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
192a7e14dcfSSatish Balay   }
193a7e14dcfSSatish Balay 
194a7e14dcfSSatish Balay   if (tao->printreason) {
195a7e14dcfSSatish Balay     if (tao->reason > 0) {
196441846f8SBarry Smith       ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve converged due to %s\n",TaoTerminationReasons[tao->reason]);CHKERRQ(ierr);
197a7e14dcfSSatish Balay     } else {
198441846f8SBarry Smith       ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve did not converge due to %s\n",TaoTerminationReasons[tao->reason]);CHKERRQ(ierr);
199a7e14dcfSSatish Balay     }
200a7e14dcfSSatish Balay   }
201a7e14dcfSSatish Balay   PetscFunctionReturn(0);
202a7e14dcfSSatish Balay }
203a7e14dcfSSatish Balay 
204a7e14dcfSSatish Balay #undef __FUNCT__
205a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetUp"
206a7e14dcfSSatish Balay /*@
207a7e14dcfSSatish Balay   TaoSetUp - Sets up the internal data structures for the later use
208a7e14dcfSSatish Balay   of a Tao solver
209a7e14dcfSSatish Balay 
210a7e14dcfSSatish Balay   Collective on tao
211a7e14dcfSSatish Balay 
212a7e14dcfSSatish Balay   Input Parameters:
213a7e14dcfSSatish Balay . tao - the TAO context
214a7e14dcfSSatish Balay 
215a7e14dcfSSatish Balay   Notes:
216a7e14dcfSSatish Balay   The user will not need to explicitly call TaoSetUp(), as it will
217a7e14dcfSSatish Balay   automatically be called in TaoSolve().  However, if the user
218a7e14dcfSSatish Balay   desires to call it explicitly, it should come after TaoCreate()
219a7e14dcfSSatish Balay   and any TaoSetSomething() routines, but before TaoSolve().
220a7e14dcfSSatish Balay 
221a7e14dcfSSatish Balay   Level: advanced
222a7e14dcfSSatish Balay 
223a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
224a7e14dcfSSatish Balay @*/
225441846f8SBarry Smith PetscErrorCode TaoSetUp(Tao tao)
226a7e14dcfSSatish Balay {
227a7e14dcfSSatish Balay   PetscErrorCode ierr;
22847a47007SBarry Smith 
229a7e14dcfSSatish Balay   PetscFunctionBegin;
230441846f8SBarry Smith   PetscValidHeaderSpecific(tao, TAO_CLASSID,1);
231a7e14dcfSSatish Balay   if (tao->setupcalled) PetscFunctionReturn(0);
232a7e14dcfSSatish Balay 
23347a47007SBarry Smith   if (!tao->solution) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TaoSetInitialVector");
234a7e14dcfSSatish Balay   if (tao->ops->setup) {
235a7e14dcfSSatish Balay     ierr = (*tao->ops->setup)(tao);CHKERRQ(ierr);
236a7e14dcfSSatish Balay   }
237a7e14dcfSSatish Balay   tao->setupcalled = PETSC_TRUE;
238a7e14dcfSSatish Balay   PetscFunctionReturn(0);
239a7e14dcfSSatish Balay }
240a7e14dcfSSatish Balay 
241a7e14dcfSSatish Balay #undef __FUNCT__
242a7e14dcfSSatish Balay #define __FUNCT__ "TaoDestroy"
243a7e14dcfSSatish Balay /*@
244a7e14dcfSSatish Balay   TaoDestroy - Destroys the TAO context that was created with
245a7e14dcfSSatish Balay   TaoCreate()
246a7e14dcfSSatish Balay 
247441846f8SBarry Smith   Collective on Tao
248a7e14dcfSSatish Balay 
249a7e14dcfSSatish Balay   Input Parameter:
250441846f8SBarry Smith . tao - the Tao context
251a7e14dcfSSatish Balay 
252a7e14dcfSSatish Balay   Level: beginner
253a7e14dcfSSatish Balay 
254a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
255a7e14dcfSSatish Balay @*/
256441846f8SBarry Smith PetscErrorCode TaoDestroy(Tao *tao)
257a7e14dcfSSatish Balay {
258a7e14dcfSSatish Balay   PetscErrorCode ierr;
25947a47007SBarry Smith 
260a7e14dcfSSatish Balay   PetscFunctionBegin;
261a7e14dcfSSatish Balay   if (!*tao) PetscFunctionReturn(0);
262441846f8SBarry Smith   PetscValidHeaderSpecific(*tao,TAO_CLASSID,1);
263a7e14dcfSSatish Balay   if (--((PetscObject)*tao)->refct > 0) {*tao=0;PetscFunctionReturn(0);}
264a7e14dcfSSatish Balay 
265a7e14dcfSSatish Balay   if ((*tao)->ops->destroy) {
266a7e14dcfSSatish Balay     ierr = (*((*tao))->ops->destroy)(*tao);CHKERRQ(ierr);
267a7e14dcfSSatish Balay   }
268a7e14dcfSSatish Balay   ierr = KSPDestroy(&(*tao)->ksp);CHKERRQ(ierr);
269a7e14dcfSSatish Balay   ierr = TaoLineSearchDestroy(&(*tao)->linesearch);CHKERRQ(ierr);
270a7e14dcfSSatish Balay 
271a7e14dcfSSatish Balay   if ((*tao)->ops->convergencedestroy) {
272a7e14dcfSSatish Balay     ierr = (*(*tao)->ops->convergencedestroy)((*tao)->cnvP);CHKERRQ(ierr);
273a7e14dcfSSatish Balay     if ((*tao)->jacobian_state_inv) {
274a7e14dcfSSatish Balay       ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr);
275a7e14dcfSSatish Balay     }
276a7e14dcfSSatish Balay   }
277a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->solution);CHKERRQ(ierr);
278a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->gradient);CHKERRQ(ierr);
279a7e14dcfSSatish Balay 
280a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->XL);CHKERRQ(ierr);
281a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->XU);CHKERRQ(ierr);
282a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->IL);CHKERRQ(ierr);
283a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->IU);CHKERRQ(ierr);
284a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->DE);CHKERRQ(ierr);
285a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->DI);CHKERRQ(ierr);
286a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->constraints_equality);CHKERRQ(ierr);
287a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->constraints_inequality);CHKERRQ(ierr);
288a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->stepdirection);CHKERRQ(ierr);
289a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->hessian_pre);CHKERRQ(ierr);
290a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->hessian);CHKERRQ(ierr);
291a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_pre);CHKERRQ(ierr);
292a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian);CHKERRQ(ierr);
293a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state_pre);CHKERRQ(ierr);
294a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state);CHKERRQ(ierr);
295a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr);
296067f330cSJason Sarich   ierr = MatDestroy(&(*tao)->jacobian_design);CHKERRQ(ierr);
297a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_equality);CHKERRQ(ierr);
298a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_equality_pre);CHKERRQ(ierr);
299a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_inequality);CHKERRQ(ierr);
300a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_inequality_pre);CHKERRQ(ierr);
301a7e14dcfSSatish Balay   ierr = ISDestroy(&(*tao)->state_is);CHKERRQ(ierr);
302a7e14dcfSSatish Balay   ierr = ISDestroy(&(*tao)->design_is);CHKERRQ(ierr);
303a7e14dcfSSatish Balay   ierr = TaoCancelMonitors(*tao);CHKERRQ(ierr);
304a7e14dcfSSatish Balay   ierr = PetscHeaderDestroy(tao);CHKERRQ(ierr);
305a7e14dcfSSatish Balay   PetscFunctionReturn(0);
306a7e14dcfSSatish Balay }
307a7e14dcfSSatish Balay 
308a7e14dcfSSatish Balay #undef __FUNCT__
309a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetFromOptions"
310a7e14dcfSSatish Balay /*@
311441846f8SBarry Smith   TaoSetFromOptions - Sets various Tao parameters from user
312a7e14dcfSSatish Balay   options.
313a7e14dcfSSatish Balay 
314441846f8SBarry Smith   Collective on Tao
315a7e14dcfSSatish Balay 
316a7e14dcfSSatish Balay   Input Paremeter:
317441846f8SBarry Smith . tao - the Tao solver context
318a7e14dcfSSatish Balay 
319a7e14dcfSSatish Balay   options Database Keys:
320a7e14dcfSSatish Balay + -tao_method <type> - The algorithm that TAO uses (tao_lmvm, tao_nls, etc.)
321a7e14dcfSSatish Balay . -tao_fatol <fatol> - absolute error tolerance in function value
322a7e14dcfSSatish Balay . -tao_frtol <frtol> - relative error tolerance in function value
323a7e14dcfSSatish Balay . -tao_gatol <gatol> - absolute error tolerance for ||gradient||
324a7e14dcfSSatish Balay . -tao_grtol <grtol> - relative error tolerance for ||gradient||
325a7e14dcfSSatish Balay . -tao_gttol <gttol> - reduction of ||gradient|| relative to initial gradient
326a7e14dcfSSatish Balay . -tao_max_it <max> - sets maximum number of iterations
327a7e14dcfSSatish Balay . -tao_max_funcs <max> - sets maximum number of function evaluations
328a7e14dcfSSatish Balay . -tao_fmin <fmin> - stop if function value reaches fmin
329a7e14dcfSSatish Balay . -tao_steptol <tol> - stop if trust region radius less than <tol>
330a7e14dcfSSatish Balay . -tao_trust0 <t> - initial trust region radius
331a7e14dcfSSatish Balay . -tao_monitor - prints function value and residual at each iteration
332a7e14dcfSSatish Balay . -tao_smonitor - same as tao_monitor, but truncates very small values
333a7e14dcfSSatish Balay . -tao_cmonitor - prints function value, residual, and constraint norm at each iteration
334a7e14dcfSSatish Balay . -tao_view_solution - prints solution vector at each iteration
335a7e14dcfSSatish Balay . -tao_view_separableobjective - prints separable objective vector at each iteration
336a7e14dcfSSatish Balay . -tao_view_step - prints step direction vector at each iteration
337a7e14dcfSSatish Balay . -tao_view_gradient - prints gradient vector at each iteration
338a7e14dcfSSatish Balay . -tao_draw_solution - graphically view solution vector at each iteration
339a7e14dcfSSatish Balay . -tao_draw_step - graphically view step vector at each iteration
340a7e14dcfSSatish Balay . -tao_draw_gradient - graphically view gradient at each iteration
341a7e14dcfSSatish Balay . -tao_fd_gradient - use gradient computed with finite differences
342a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors (except those set with command line)
343441846f8SBarry Smith . -tao_view - prints information about the Tao after solving
344a7e14dcfSSatish Balay - -tao_converged_reason - prints the reason TAO stopped iterating
345a7e14dcfSSatish Balay 
346a7e14dcfSSatish Balay   Notes:
347a7e14dcfSSatish Balay   To see all options, run your program with the -help option or consult the
348a7e14dcfSSatish Balay   user's manual. Should be called after TaoCreate() but before TaoSolve()
349a7e14dcfSSatish Balay 
350a7e14dcfSSatish Balay   Level: beginner
351a7e14dcfSSatish Balay @*/
352441846f8SBarry Smith PetscErrorCode TaoSetFromOptions(Tao tao)
353a7e14dcfSSatish Balay {
354a7e14dcfSSatish Balay   PetscErrorCode ierr;
355441846f8SBarry Smith   const TaoType  default_type = "tao_lmvm";
356a7e14dcfSSatish Balay   const char     *prefix;
357a7e14dcfSSatish Balay   char           type[256], monfilename[PETSC_MAX_PATH_LEN];
358a7e14dcfSSatish Balay   PetscViewer    monviewer;
359a7e14dcfSSatish Balay   PetscBool      flg;
360a7e14dcfSSatish Balay   MPI_Comm       comm;
361a7e14dcfSSatish Balay 
362a7e14dcfSSatish Balay   PetscFunctionBegin;
363441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
364a7e14dcfSSatish Balay   ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
365a7e14dcfSSatish Balay   ierr = TaoGetOptionsPrefix(tao,&prefix);
366a7e14dcfSSatish Balay   /* So no warnings are given about unused options */
367a7e14dcfSSatish Balay   ierr = PetscOptionsHasName(prefix,"-tao_ksp_type",&flg);
368a7e14dcfSSatish Balay   ierr = PetscOptionsHasName(prefix,"-tao_pc_type",&flg);
369a7e14dcfSSatish Balay   ierr = PetscOptionsHasName(prefix,"-tao_ls_type",&flg);
370a7e14dcfSSatish Balay 
371a7e14dcfSSatish Balay   ierr = PetscObjectOptionsBegin((PetscObject)tao);CHKERRQ(ierr);
372a7e14dcfSSatish Balay   {
373441846f8SBarry Smith     if (!TaoRegisterAllCalled) {
374441846f8SBarry Smith       ierr = TaoRegisterAll();CHKERRQ(ierr);
375a7e14dcfSSatish Balay     }
376a7e14dcfSSatish Balay     if (((PetscObject)tao)->type_name) {
377a7e14dcfSSatish Balay       default_type = ((PetscObject)tao)->type_name;
378a7e14dcfSSatish Balay     }
379a7e14dcfSSatish Balay     /* Check for type from options */
380441846f8SBarry Smith     ierr = PetscOptionsFList("-tao_type","Tao Solver type","TaoSetType",TaoList,default_type,type,256,&flg);CHKERRQ(ierr);
381a7e14dcfSSatish Balay     if (flg) {
382a7e14dcfSSatish Balay       ierr = TaoSetType(tao,type);CHKERRQ(ierr);
383a7e14dcfSSatish Balay     } else {
384441846f8SBarry Smith       ierr = PetscOptionsFList("-tao_method","Tao Solver type","TaoSetType",TaoList,default_type,type,256,&flg);CHKERRQ(ierr);
385a7e14dcfSSatish Balay       if (flg) {
386a7e14dcfSSatish Balay         ierr = TaoSetType(tao,type);CHKERRQ(ierr);
387a7e14dcfSSatish Balay       } else if (!((PetscObject)tao)->type_name) {
388a7e14dcfSSatish Balay         ierr = TaoSetType(tao,default_type);
389a7e14dcfSSatish Balay       }
390a7e14dcfSSatish Balay     }
391a7e14dcfSSatish Balay 
392441846f8SBarry Smith     ierr = PetscOptionsBool("-tao_view","view Tao info after each minimization has completed","TaoView",PETSC_FALSE,&tao->viewtao,&flg);CHKERRQ(ierr);
393a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_fatol","Stop if solution within","TaoSetTolerances",tao->fatol,&tao->fatol,&flg);CHKERRQ(ierr);
394a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_frtol","Stop if relative solution within","TaoSetTolerances",tao->frtol,&tao->frtol,&flg);CHKERRQ(ierr);
395a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_catol","Stop if constraints violations within","TaoSetConstraintTolerances",tao->catol,&tao->catol,&flg);CHKERRQ(ierr);
396a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_crtol","Stop if relative contraint violations within","TaoSetConstraintTolerances",tao->crtol,&tao->crtol,&flg);CHKERRQ(ierr);
397a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_gatol","Stop if norm of gradient less than","TaoSetTolerances",tao->gatol,&tao->gatol,&flg);CHKERRQ(ierr);
398a7e14dcfSSatish 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);
399a7e14dcfSSatish 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);
400*6f4723b1SBarry Smith     ierr = PetscOptionsInt("-tao_max_it","Stop if iteration number exceeds","TaoSetMaximumIterations",tao->max_it,&tao->max_it,&flg);CHKERRQ(ierr);
401a7e14dcfSSatish Balay     ierr = PetscOptionsInt("-tao_max_funcs","Stop if number of function evaluations exceeds","TaoSetMaximumFunctionEvaluations",tao->max_funcs,&tao->max_funcs,&flg);CHKERRQ(ierr);
402a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_fmin","Stop if function less than","TaoSetFunctionLowerBound",tao->fmin,&tao->fmin,&flg);CHKERRQ(ierr);
403a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_steptol","Stop if step size or trust region radius less than","",tao->steptol,&tao->steptol,&flg);CHKERRQ(ierr);
404a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_trust0","Initial trust region radius","TaoSetTrustRegionRadius",tao->trust0,&tao->trust0,&flg);CHKERRQ(ierr);
405a7e14dcfSSatish Balay 
406a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_solution","view solution vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
407a7e14dcfSSatish Balay     if (flg) {
408a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
409a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoSolutionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
410a7e14dcfSSatish Balay     }
411a7e14dcfSSatish Balay 
41247a47007SBarry Smith     ierr = PetscOptionsBool("-tao_converged_reason","Print reason for TAO termination","TaoSolve",flg,&flg,NULL);CHKERRQ(ierr);
413a7e14dcfSSatish Balay     if (flg) {
414a7e14dcfSSatish Balay       tao->printreason = PETSC_TRUE;
415a7e14dcfSSatish Balay     }
416a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_gradient","view gradient vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
417a7e14dcfSSatish Balay     if (flg) {
418a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
419a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoGradientMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
420a7e14dcfSSatish Balay     }
421a7e14dcfSSatish Balay 
422a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_stepdirection","view step direction vector after each iteration","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
423a7e14dcfSSatish Balay     if (flg) {
424a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
425a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoStepDirectionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
426a7e14dcfSSatish Balay     }
427a7e14dcfSSatish Balay 
428a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_view_separableobjective","view separable objective vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
429a7e14dcfSSatish Balay     if (flg) {
430a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
431a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoSeparableObjectiveMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
432a7e14dcfSSatish Balay     }
433a7e14dcfSSatish Balay 
434a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_monitor","Use the default convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
435a7e14dcfSSatish Balay     if (flg) {
436a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
437a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
438a7e14dcfSSatish Balay     }
439a7e14dcfSSatish Balay 
440a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_smonitor","Use the short convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
441a7e14dcfSSatish Balay     if (flg) {
442a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
443a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultSMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
444a7e14dcfSSatish Balay     }
445a7e14dcfSSatish Balay 
446a7e14dcfSSatish Balay     ierr = PetscOptionsString("-tao_cmonitor","Use the default convergence monitor with constraint norm","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
447a7e14dcfSSatish Balay     if (flg) {
448a7e14dcfSSatish Balay       ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr);
449a7e14dcfSSatish Balay       ierr = TaoSetMonitor(tao,TaoDefaultCMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
450a7e14dcfSSatish Balay     }
451a7e14dcfSSatish Balay 
452a7e14dcfSSatish Balay 
45347a47007SBarry Smith     ierr = PetscOptionsBool("-tao_cancelmonitors","cancel all monitors and call any registered destroy routines","TaoCancelMonitors",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr);
454a7e14dcfSSatish Balay     if (flg) {ierr = TaoCancelMonitors(tao);CHKERRQ(ierr);}
455a7e14dcfSSatish Balay 
45647a47007SBarry Smith     ierr = PetscOptionsBool("-tao_draw_solution","Plot solution vector at each iteration","TaoSetMonitor",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr);
457a7e14dcfSSatish Balay     if (flg) {
45847a47007SBarry Smith       ierr = TaoSetMonitor(tao,TaoDrawSolutionMonitor,NULL,NULL);CHKERRQ(ierr);
459a7e14dcfSSatish Balay     }
460a7e14dcfSSatish Balay 
46147a47007SBarry Smith     ierr = PetscOptionsBool("-tao_draw_step","plots step direction at each iteration","TaoSetMonitor",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr);
462a7e14dcfSSatish Balay     if (flg) {
46347a47007SBarry Smith       ierr = TaoSetMonitor(tao,TaoDrawStepMonitor,NULL,NULL);CHKERRQ(ierr);
464a7e14dcfSSatish Balay     }
465a7e14dcfSSatish Balay 
46647a47007SBarry Smith     ierr = PetscOptionsBool("-tao_draw_gradient","plots gradient at each iteration","TaoSetMonitor",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr);
467a7e14dcfSSatish Balay     if (flg) {
46847a47007SBarry Smith       ierr = TaoSetMonitor(tao,TaoDrawGradientMonitor,NULL,NULL);CHKERRQ(ierr);
469a7e14dcfSSatish Balay     }
47047a47007SBarry Smith     ierr = PetscOptionsBool("-tao_fd_gradient","compute gradient using finite differences","TaoDefaultComputeGradient",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr);
471a7e14dcfSSatish Balay     if (flg) {
47247a47007SBarry Smith       ierr = TaoSetGradientRoutine(tao,TaoDefaultComputeGradient,NULL);CHKERRQ(ierr);
473a7e14dcfSSatish Balay     }
474e1cc520bSBarry Smith     ierr = PetscOptionsEnum("-tao_subset_type","subset type", "", TaoSubSetTypes,(PetscEnum)tao->subset_type, (PetscEnum*)&tao->subset_type, 0);CHKERRQ(ierr);
475a7e14dcfSSatish Balay 
476a7e14dcfSSatish Balay     if (tao->ops->setfromoptions) {
477a7e14dcfSSatish Balay       ierr = (*tao->ops->setfromoptions)(tao);CHKERRQ(ierr);
478a7e14dcfSSatish Balay     }
479a7e14dcfSSatish Balay   }
480a7e14dcfSSatish Balay   ierr = PetscOptionsEnd();CHKERRQ(ierr);
481a7e14dcfSSatish Balay   PetscFunctionReturn(0);
482a7e14dcfSSatish Balay }
483a7e14dcfSSatish Balay 
484a7e14dcfSSatish Balay #undef __FUNCT__
485a7e14dcfSSatish Balay #define __FUNCT__ "TaoView"
486a7e14dcfSSatish Balay /*@C
487441846f8SBarry Smith   TaoView - Prints information about the Tao
488a7e14dcfSSatish Balay 
489441846f8SBarry Smith   Collective on Tao
490a7e14dcfSSatish Balay 
491a7e14dcfSSatish Balay   InputParameters:
492441846f8SBarry Smith + tao - the Tao context
493a7e14dcfSSatish Balay - viewer - visualization context
494a7e14dcfSSatish Balay 
495a7e14dcfSSatish Balay   Options Database Key:
496a7e14dcfSSatish Balay . -tao_view - Calls TaoView() at the end of TaoSolve()
497a7e14dcfSSatish Balay 
498a7e14dcfSSatish Balay   Notes:
499a7e14dcfSSatish Balay   The available visualization contexts include
500a7e14dcfSSatish Balay +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
501a7e14dcfSSatish Balay -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
502a7e14dcfSSatish Balay          output where only the first processor opens
503a7e14dcfSSatish Balay          the file.  All other processors send their
504a7e14dcfSSatish Balay          data to the first processor to print.
505a7e14dcfSSatish Balay 
506a7e14dcfSSatish Balay   Level: beginner
507a7e14dcfSSatish Balay 
508a7e14dcfSSatish Balay .seealso: PetscViewerASCIIOpen()
509a7e14dcfSSatish Balay @*/
510441846f8SBarry Smith PetscErrorCode TaoView(Tao tao, PetscViewer viewer)
511a7e14dcfSSatish Balay {
512a7e14dcfSSatish Balay   PetscErrorCode      ierr;
513a7e14dcfSSatish Balay   PetscBool           isascii,isstring;
514441846f8SBarry Smith   const TaoType type;
51547a47007SBarry Smith 
516a7e14dcfSSatish Balay   PetscFunctionBegin;
517441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
518a7e14dcfSSatish Balay   if (!viewer) {
519a7e14dcfSSatish Balay     ierr = PetscViewerASCIIGetStdout(((PetscObject)tao)->comm,&viewer);CHKERRQ(ierr);
520a7e14dcfSSatish Balay   }
521a7e14dcfSSatish Balay   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
522a7e14dcfSSatish Balay   PetscCheckSameComm(tao,1,viewer,2);
523a7e14dcfSSatish Balay 
524a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
525a7e14dcfSSatish Balay   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
526a7e14dcfSSatish Balay   if (isascii) {
527a7e14dcfSSatish Balay     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)tao,viewer);CHKERRQ(ierr);
528a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
529a7e14dcfSSatish Balay 
530a7e14dcfSSatish Balay     if (tao->ops->view) {
531a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
532a7e14dcfSSatish Balay       ierr = (*tao->ops->view)(tao,viewer);CHKERRQ(ierr);
533a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
534a7e14dcfSSatish Balay     }
535a7e14dcfSSatish Balay     if (tao->linesearch) {
536a7e14dcfSSatish Balay       ierr = PetscObjectPrintClassNamePrefixType((PetscObject)(tao->linesearch),viewer);CHKERRQ(ierr);
537a7e14dcfSSatish Balay     }
538a7e14dcfSSatish Balay     if (tao->ksp) {
539a7e14dcfSSatish Balay       ierr = PetscObjectPrintClassNamePrefixType((PetscObject)(tao->ksp),viewer);CHKERRQ(ierr);
540a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer,"total KSP iterations: %D\n",tao->ksp_its);CHKERRQ(ierr);
541a7e14dcfSSatish Balay     }
542a7e14dcfSSatish Balay     if (tao->XL || tao->XU) {
543e1cc520bSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Active Set subset type: %s\n",TaoSubSetTypes[tao->subset_type]);
544a7e14dcfSSatish Balay     }
545a7e14dcfSSatish Balay 
54647a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: fatol=%g,",(double)tao->fatol);CHKERRQ(ierr);
54747a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," frtol=%g\n",(double)tao->frtol);CHKERRQ(ierr);
548a7e14dcfSSatish Balay 
54947a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: gatol=%g,",(double)tao->gatol);CHKERRQ(ierr);
55047a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," steptol=%g,",(double)tao->steptol);CHKERRQ(ierr);
55147a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," gttol=%g\n",(double)tao->gttol);CHKERRQ(ierr);
552a7e14dcfSSatish Balay 
55347a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Residual in Function/Gradient:=%g\n",(double)tao->residual);CHKERRQ(ierr);
554a7e14dcfSSatish Balay 
555a7e14dcfSSatish Balay     if (tao->cnorm>0 || tao->catol>0 || tao->crtol>0){
556a7e14dcfSSatish Balay       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances:");CHKERRQ(ierr);
55747a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer," catol=%g,",(double)tao->catol);CHKERRQ(ierr);
55847a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer," crtol=%g\n",(double)tao->crtol);CHKERRQ(ierr);
55947a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Residual in Constraints:=%g\n",(double)tao->cnorm);CHKERRQ(ierr);
560a7e14dcfSSatish Balay     }
561a7e14dcfSSatish Balay 
562a7e14dcfSSatish Balay     if (tao->trust < tao->steptol){
56347a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: steptol=%g\n",(double)tao->steptol);CHKERRQ(ierr);
56447a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"Final trust region radius:=%g\n",(double)tao->trust);CHKERRQ(ierr);
565a7e14dcfSSatish Balay     }
566a7e14dcfSSatish Balay 
567a7e14dcfSSatish Balay     if (tao->fmin>-1.e25){
56847a47007SBarry Smith       ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: function minimum=%g\n",(double)tao->fmin);CHKERRQ(ierr);
569a7e14dcfSSatish Balay     }
57047a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Objective value=%g\n",(double)tao->fc);CHKERRQ(ierr);
571a7e14dcfSSatish Balay 
57247a47007SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"total number of iterations=%D,          ",tao->niter);CHKERRQ(ierr);
573a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPrintf(viewer,"              (max: %D)\n",tao->max_it);CHKERRQ(ierr);
574a7e14dcfSSatish Balay 
575a7e14dcfSSatish Balay     if (tao->nfuncs>0){
57647a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of function evaluations=%D,",tao->nfuncs);CHKERRQ(ierr);
57747a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"                max: %D\n",tao->max_funcs);CHKERRQ(ierr);
578a7e14dcfSSatish Balay     }
579a7e14dcfSSatish Balay     if (tao->ngrads>0){
58047a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of gradient evaluations=%D,",tao->ngrads);CHKERRQ(ierr);
58147a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"                max: %D\n",tao->max_funcs);CHKERRQ(ierr);
582a7e14dcfSSatish Balay     }
583a7e14dcfSSatish Balay     if (tao->nfuncgrads>0){
58447a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of function/gradient evaluations=%D,",tao->nfuncgrads);CHKERRQ(ierr);
58547a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"    (max: %D)\n",tao->max_funcs);CHKERRQ(ierr);
586a7e14dcfSSatish Balay     }
587a7e14dcfSSatish Balay     if (tao->nhess>0){
58847a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of Hessian evaluations=%D\n",tao->nhess);CHKERRQ(ierr);
589a7e14dcfSSatish Balay     }
590a7e14dcfSSatish Balay     /*  if (tao->linear_its>0){
59147a47007SBarry Smith      ierr = PetscViewerASCIIPrintf(viewer,"  total Krylov method iterations=%D\n",tao->linear_its);CHKERRQ(ierr);
592a7e14dcfSSatish Balay      }*/
593a7e14dcfSSatish Balay     if (tao->nconstraints>0){
59447a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of constraint function evaluations=%D\n",tao->nconstraints);CHKERRQ(ierr);
595a7e14dcfSSatish Balay     }
596a7e14dcfSSatish Balay     if (tao->njac>0){
59747a47007SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"total number of Jacobian evaluations=%D\n",tao->njac);CHKERRQ(ierr);
598a7e14dcfSSatish Balay     }
599a7e14dcfSSatish Balay 
600a7e14dcfSSatish Balay     if (tao->reason>0){
601a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer,    "Solution converged: ");CHKERRQ(ierr);
602a7e14dcfSSatish Balay       switch (tao->reason) {
603a7e14dcfSSatish Balay       case TAO_CONVERGED_FATOL:
604a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"estimated f(x)-f(X*) <= fatol\n");CHKERRQ(ierr);
605a7e14dcfSSatish Balay         break;
606a7e14dcfSSatish Balay       case TAO_CONVERGED_FRTOL:
607a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"estimated |f(x)-f(X*)|/|f(X*)| <= frtol\n");CHKERRQ(ierr);
608a7e14dcfSSatish Balay         break;
609a7e14dcfSSatish Balay       case TAO_CONVERGED_GATOL:
610a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)|| <= gatol\n");CHKERRQ(ierr);
611a7e14dcfSSatish Balay         break;
612a7e14dcfSSatish Balay       case TAO_CONVERGED_GRTOL:
613a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/|f(X)| <= grtol\n");CHKERRQ(ierr);
614a7e14dcfSSatish Balay         break;
615a7e14dcfSSatish Balay       case TAO_CONVERGED_GTTOL:
616a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/||g(X0)|| <= gttol\n");CHKERRQ(ierr);
617a7e14dcfSSatish Balay         break;
618a7e14dcfSSatish Balay       case TAO_CONVERGED_STEPTOL:
619a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," Steptol -- step size small\n");CHKERRQ(ierr);
620a7e14dcfSSatish Balay         break;
621a7e14dcfSSatish Balay       case TAO_CONVERGED_MINF:
622a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," Minf --  f < fmin\n");CHKERRQ(ierr);
623a7e14dcfSSatish Balay         break;
624a7e14dcfSSatish Balay       case TAO_CONVERGED_USER:
625a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr);
626a7e14dcfSSatish Balay         break;
627a7e14dcfSSatish Balay       default:
628a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
629a7e14dcfSSatish Balay         break;
630a7e14dcfSSatish Balay       }
631a7e14dcfSSatish Balay 
632a7e14dcfSSatish Balay     } else {
633a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer,"Solver terminated: %D",tao->reason);CHKERRQ(ierr);
634a7e14dcfSSatish Balay       switch (tao->reason) {
635a7e14dcfSSatish Balay       case TAO_DIVERGED_MAXITS:
63647a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Maximum Iterations\n");CHKERRQ(ierr);
637a7e14dcfSSatish Balay         break;
638a7e14dcfSSatish Balay       case TAO_DIVERGED_NAN:
63947a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," NAN or Inf encountered\n");CHKERRQ(ierr);
640a7e14dcfSSatish Balay         break;
641a7e14dcfSSatish Balay       case TAO_DIVERGED_MAXFCN:
64247a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Maximum Function Evaluations\n");CHKERRQ(ierr);
643a7e14dcfSSatish Balay         break;
644a7e14dcfSSatish Balay       case TAO_DIVERGED_LS_FAILURE:
64547a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Line Search Failure\n");CHKERRQ(ierr);
646a7e14dcfSSatish Balay         break;
647a7e14dcfSSatish Balay       case TAO_DIVERGED_TR_REDUCTION:
64847a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," Trust Region too small\n");CHKERRQ(ierr);
649a7e14dcfSSatish Balay         break;
650a7e14dcfSSatish Balay       case TAO_DIVERGED_USER:
65147a47007SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr);
652a7e14dcfSSatish Balay         break;
653a7e14dcfSSatish Balay       default:
654a7e14dcfSSatish Balay         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
655a7e14dcfSSatish Balay         break;
656a7e14dcfSSatish Balay       }
657a7e14dcfSSatish Balay     }
658a7e14dcfSSatish Balay     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
659a7e14dcfSSatish Balay   } else if (isstring) {
660a7e14dcfSSatish Balay     ierr = TaoGetType(tao,&type);CHKERRQ(ierr);
661a7e14dcfSSatish Balay     ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr);
662a7e14dcfSSatish Balay   }
663a7e14dcfSSatish Balay   PetscFunctionReturn(0);
664a7e14dcfSSatish Balay }
665a7e14dcfSSatish Balay 
666a7e14dcfSSatish Balay #undef __FUNCT__
667a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetTolerances"
668a7e14dcfSSatish Balay /*@
669a7e14dcfSSatish Balay   TaoSetTolerances - Sets parameters used in TAO convergence tests
670a7e14dcfSSatish Balay 
671441846f8SBarry Smith   Logically collective on Tao
672a7e14dcfSSatish Balay 
673a7e14dcfSSatish Balay   Input Parameters:
674441846f8SBarry Smith + tao - the Tao context
675a7e14dcfSSatish Balay . fatol - absolute convergence tolerance
676a7e14dcfSSatish Balay . frtol - relative convergence tolerance
677a7e14dcfSSatish Balay . gatol - stop if norm of gradient is less than this
678a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this
679a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by this factor
680a7e14dcfSSatish Balay 
681a7e14dcfSSatish Balay   Options Database Keys:
682a7e14dcfSSatish Balay + -tao_fatol <fatol> - Sets fatol
683a7e14dcfSSatish Balay . -tao_frtol <frtol> - Sets frtol
684a7e14dcfSSatish Balay . -tao_gatol <gatol> - Sets gatol
685a7e14dcfSSatish Balay . -tao_grtol <grtol> - Sets grtol
686a7e14dcfSSatish Balay - -tao_gttol <gttol> - Sets gttol
687a7e14dcfSSatish Balay 
688a7e14dcfSSatish Balay   Stopping Criteria:
689a7e14dcfSSatish Balay $ f(X) - f(X*) (estimated)            <= fatol
690a7e14dcfSSatish Balay $ |f(X) - f(X*)| (estimated) / |f(X)| <= frtol
691a7e14dcfSSatish Balay $ ||g(X)||                            <= gatol
692a7e14dcfSSatish Balay $ ||g(X)|| / |f(X)|                   <= grtol
693a7e14dcfSSatish Balay $ ||g(X)|| / ||g(X0)||                <= gttol
694a7e14dcfSSatish Balay 
695a7e14dcfSSatish Balay   Notes:
696a7e14dcfSSatish Balay   Use PETSC_DEFAULT to leave one or more tolerances unchanged.
697a7e14dcfSSatish Balay 
698a7e14dcfSSatish Balay   Level: beginner
699a7e14dcfSSatish Balay 
700a7e14dcfSSatish Balay .seealso: TaoGetTolerances()
701a7e14dcfSSatish Balay 
702a7e14dcfSSatish Balay @*/
703441846f8SBarry Smith PetscErrorCode TaoSetTolerances(Tao tao, PetscReal fatol, PetscReal frtol, PetscReal gatol, PetscReal grtol, PetscReal gttol)
704a7e14dcfSSatish Balay {
705a7e14dcfSSatish Balay   PetscErrorCode ierr;
70647a47007SBarry Smith 
707a7e14dcfSSatish Balay   PetscFunctionBegin;
708441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
709a7e14dcfSSatish Balay 
710a7e14dcfSSatish Balay   if (fatol != PETSC_DEFAULT) {
711a7e14dcfSSatish Balay     if (fatol<0) {
71247a47007SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative fatol -- ignored.");CHKERRQ(ierr);
713a7e14dcfSSatish Balay     } else {
714a7e14dcfSSatish Balay       tao->fatol = PetscMax(0,fatol);
715a7e14dcfSSatish Balay     }
716a7e14dcfSSatish Balay   }
717a7e14dcfSSatish Balay   if (frtol != PETSC_DEFAULT) {
718a7e14dcfSSatish Balay     if (frtol<0) {
71947a47007SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative frtol -- ignored.");CHKERRQ(ierr);
720a7e14dcfSSatish Balay     } else {
721a7e14dcfSSatish Balay       tao->frtol = PetscMax(0,frtol);
722a7e14dcfSSatish Balay     }
723a7e14dcfSSatish Balay   }
724a7e14dcfSSatish Balay 
725a7e14dcfSSatish Balay   if (gatol != PETSC_DEFAULT) {
726a7e14dcfSSatish Balay     if (gatol<0) {
72747a47007SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative gatol -- ignored.");CHKERRQ(ierr);
728a7e14dcfSSatish Balay     } else {
729a7e14dcfSSatish Balay       tao->gatol = PetscMax(0,gatol);
730a7e14dcfSSatish Balay     }
731a7e14dcfSSatish Balay   }
732a7e14dcfSSatish Balay 
733a7e14dcfSSatish Balay   if (grtol != PETSC_DEFAULT) {
734a7e14dcfSSatish Balay     if (grtol<0) {
73547a47007SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative grtol -- ignored.");CHKERRQ(ierr);
736a7e14dcfSSatish Balay     } else {
737a7e14dcfSSatish Balay       tao->grtol = PetscMax(0,grtol);
738a7e14dcfSSatish Balay     }
739a7e14dcfSSatish Balay   }
740a7e14dcfSSatish Balay 
741a7e14dcfSSatish Balay   if (gttol != PETSC_DEFAULT) {
742a7e14dcfSSatish Balay     if (gttol<0) {
74347a47007SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative gttol -- ignored.");CHKERRQ(ierr);
744a7e14dcfSSatish Balay     } else {
745a7e14dcfSSatish Balay       tao->gttol = PetscMax(0,gttol);
746a7e14dcfSSatish Balay     }
747a7e14dcfSSatish Balay   }
748a7e14dcfSSatish Balay   PetscFunctionReturn(0);
749a7e14dcfSSatish Balay }
750a7e14dcfSSatish Balay 
751a7e14dcfSSatish Balay #undef __FUNCT__
752a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetConstraintTolerances"
753a7e14dcfSSatish Balay /*@
754a7e14dcfSSatish Balay   TaoSetConstraintTolerances - Sets contraint tolerance parameters used in TAO
755a7e14dcfSSatish Balay   convergence tests
756a7e14dcfSSatish Balay 
757441846f8SBarry Smith   Logically collective on Tao
758a7e14dcfSSatish Balay 
759a7e14dcfSSatish Balay   Input Parameters:
760441846f8SBarry Smith + tao - the Tao context
761a7e14dcfSSatish Balay . catol - absolute constraint tolerance, constraint norm must be less than catol for used for fatol, gatol convergence criteria
762a7e14dcfSSatish Balay - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for fatol, gatol, gttol convergence criteria
763a7e14dcfSSatish Balay 
764a7e14dcfSSatish Balay   Options Database Keys:
765a7e14dcfSSatish Balay + -tao_catol <catol> - Sets catol
766a7e14dcfSSatish Balay - -tao_crtol <crtol> - Sets crtol
767a7e14dcfSSatish Balay 
768a7e14dcfSSatish Balay   Level: intermediate
769a7e14dcfSSatish Balay 
770a7e14dcfSSatish Balay .seealso: TaoGetTolerances()
771a7e14dcfSSatish Balay 
772a7e14dcfSSatish Balay @*/
773441846f8SBarry Smith PetscErrorCode TaoSetConstraintTolerances(Tao tao, PetscReal catol, PetscReal crtol)
774a7e14dcfSSatish Balay {
775a7e14dcfSSatish Balay   PetscErrorCode ierr;
77647a47007SBarry Smith 
777a7e14dcfSSatish Balay   PetscFunctionBegin;
778441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
779a7e14dcfSSatish Balay 
780a7e14dcfSSatish Balay   if (catol != PETSC_DEFAULT) {
781a7e14dcfSSatish Balay     if (catol<0) {
78247a47007SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative catol -- ignored.");CHKERRQ(ierr);
783a7e14dcfSSatish Balay     } else {
784a7e14dcfSSatish Balay       tao->catol = PetscMax(0,catol);
785a7e14dcfSSatish Balay     }
786a7e14dcfSSatish Balay   }
787a7e14dcfSSatish Balay 
788a7e14dcfSSatish Balay   if (crtol != PETSC_DEFAULT) {
789a7e14dcfSSatish Balay     if (crtol<0) {
79047a47007SBarry Smith       ierr = PetscInfo(tao,"Tried to set negative crtol -- ignored.");CHKERRQ(ierr);
791a7e14dcfSSatish Balay     } else {
792a7e14dcfSSatish Balay       tao->crtol = PetscMax(0,crtol);
793a7e14dcfSSatish Balay     }
794a7e14dcfSSatish Balay   }
795a7e14dcfSSatish Balay   PetscFunctionReturn(0);
796a7e14dcfSSatish Balay }
797a7e14dcfSSatish Balay 
798a7e14dcfSSatish Balay #undef __FUNCT__
799a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetFunctionLowerBound"
800a7e14dcfSSatish Balay /*@
801a7e14dcfSSatish Balay    TaoSetFunctionLowerBound - Sets a bound on the solution objective value.
802a7e14dcfSSatish Balay    When an approximate solution with an objective value below this number
803a7e14dcfSSatish Balay    has been found, the solver will terminate.
804a7e14dcfSSatish Balay 
805441846f8SBarry Smith    Logically Collective on Tao
806a7e14dcfSSatish Balay 
807a7e14dcfSSatish Balay    Input Parameters:
808441846f8SBarry Smith +  tao - the Tao solver context
809a7e14dcfSSatish Balay -  fmin - the tolerance
810a7e14dcfSSatish Balay 
811a7e14dcfSSatish Balay    Options Database Keys:
812a7e14dcfSSatish Balay .    -tao_fmin <fmin> - sets the minimum function value
813a7e14dcfSSatish Balay 
814a7e14dcfSSatish Balay    Level: intermediate
815a7e14dcfSSatish Balay 
816a7e14dcfSSatish Balay .seealso: TaoSetTolerances()
817a7e14dcfSSatish Balay @*/
818441846f8SBarry Smith PetscErrorCode TaoSetFunctionLowerBound(Tao tao,PetscReal fmin)
819a7e14dcfSSatish Balay {
820a7e14dcfSSatish Balay   PetscFunctionBegin;
821441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
822a7e14dcfSSatish Balay   tao->fmin = fmin;
823a7e14dcfSSatish Balay   PetscFunctionReturn(0);
824a7e14dcfSSatish Balay }
825a7e14dcfSSatish Balay 
826a7e14dcfSSatish Balay #undef __FUNCT__
827a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetFunctionLowerBound"
828a7e14dcfSSatish Balay /*@
829a7e14dcfSSatish Balay    TaoGetFunctionLowerBound - Sets a bound on the solution objective value.
830a7e14dcfSSatish Balay    When an approximate solution with an objective value below this number
831a7e14dcfSSatish Balay    has been found, the solver will terminate.
832a7e14dcfSSatish Balay 
833441846f8SBarry Smith    Not collective on Tao
834a7e14dcfSSatish Balay 
835a7e14dcfSSatish Balay    Input Parameters:
836441846f8SBarry Smith .  tao - the Tao solver context
837a7e14dcfSSatish Balay 
838a7e14dcfSSatish Balay    OutputParameters:
839a7e14dcfSSatish Balay .  fmin - the minimum function value
840a7e14dcfSSatish Balay 
841a7e14dcfSSatish Balay    Level: intermediate
842a7e14dcfSSatish Balay 
843a7e14dcfSSatish Balay .seealso: TaoSetFunctionLowerBound()
844a7e14dcfSSatish Balay @*/
845441846f8SBarry Smith PetscErrorCode TaoGetFunctionLowerBound(Tao tao,PetscReal *fmin)
846a7e14dcfSSatish Balay {
847a7e14dcfSSatish Balay   PetscFunctionBegin;
848441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
849a7e14dcfSSatish Balay   *fmin = tao->fmin;
850a7e14dcfSSatish Balay   PetscFunctionReturn(0);
851a7e14dcfSSatish Balay }
852a7e14dcfSSatish Balay 
853a7e14dcfSSatish Balay #undef __FUNCT__
854a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMaximumFunctionEvaluations"
855a7e14dcfSSatish Balay /*@
856a7e14dcfSSatish Balay    TaoSetMaximumFunctionEvaluations - Sets a maximum number of
857a7e14dcfSSatish Balay    function evaluations.
858a7e14dcfSSatish Balay 
859441846f8SBarry Smith    Logically Collective on Tao
860a7e14dcfSSatish Balay 
861a7e14dcfSSatish Balay    Input Parameters:
862441846f8SBarry Smith +  tao - the Tao solver context
863a7e14dcfSSatish Balay -  nfcn - the maximum number of function evaluations (>=0)
864a7e14dcfSSatish Balay 
865a7e14dcfSSatish Balay    Options Database Keys:
866a7e14dcfSSatish Balay .    -tao_max_funcs <nfcn> - sets the maximum number of function evaluations
867a7e14dcfSSatish Balay 
868a7e14dcfSSatish Balay    Level: intermediate
869a7e14dcfSSatish Balay 
870a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumIterations()
871a7e14dcfSSatish Balay @*/
872a7e14dcfSSatish Balay 
873441846f8SBarry Smith PetscErrorCode TaoSetMaximumFunctionEvaluations(Tao tao,PetscInt nfcn)
874a7e14dcfSSatish Balay {
875a7e14dcfSSatish Balay   PetscFunctionBegin;
876441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
87747a47007SBarry Smith   tao->max_funcs = PetscMax(0,nfcn);
878a7e14dcfSSatish Balay   PetscFunctionReturn(0);
879a7e14dcfSSatish Balay }
880a7e14dcfSSatish Balay 
881a7e14dcfSSatish Balay #undef __FUNCT__
882a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetMaximumFunctionEvaluations"
883a7e14dcfSSatish Balay /*@
884a7e14dcfSSatish Balay    TaoGetMaximumFunctionEvaluations - Sets a maximum number of
885a7e14dcfSSatish Balay    function evaluations.
886a7e14dcfSSatish Balay 
887a7e14dcfSSatish Balay    Not Collective
888a7e14dcfSSatish Balay 
889a7e14dcfSSatish Balay    Input Parameters:
890441846f8SBarry Smith .  tao - the Tao solver context
891a7e14dcfSSatish Balay 
892a7e14dcfSSatish Balay    Output Parameters:
893a7e14dcfSSatish Balay .  nfcn - the maximum number of function evaluations
894a7e14dcfSSatish Balay 
895a7e14dcfSSatish Balay    Level: intermediate
896a7e14dcfSSatish Balay 
897a7e14dcfSSatish Balay .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumIterations()
898a7e14dcfSSatish Balay @*/
899a7e14dcfSSatish Balay 
900441846f8SBarry Smith PetscErrorCode TaoGetMaximumFunctionEvaluations(Tao tao,PetscInt *nfcn)
901a7e14dcfSSatish Balay {
902a7e14dcfSSatish Balay   PetscFunctionBegin;
903441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
904a7e14dcfSSatish Balay   *nfcn = tao->max_funcs;
905a7e14dcfSSatish Balay   PetscFunctionReturn(0);
906a7e14dcfSSatish Balay }
907a7e14dcfSSatish Balay 
908a7e14dcfSSatish Balay #undef __FUNCT__
909a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMaximumIterations"
910a7e14dcfSSatish Balay /*@
911a7e14dcfSSatish Balay    TaoSetMaximumIterations - Sets a maximum number of iterates.
912a7e14dcfSSatish Balay 
913441846f8SBarry Smith    Logically Collective on Tao
914a7e14dcfSSatish Balay 
915a7e14dcfSSatish Balay    Input Parameters:
916441846f8SBarry Smith +  tao - the Tao solver context
917a7e14dcfSSatish Balay -  maxits - the maximum number of iterates (>=0)
918a7e14dcfSSatish Balay 
919a7e14dcfSSatish Balay    Options Database Keys:
920a7e14dcfSSatish Balay .    -tao_max_it <its> - sets the maximum number of iterations
921a7e14dcfSSatish Balay 
922a7e14dcfSSatish Balay    Level: intermediate
923a7e14dcfSSatish Balay 
924a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumFunctionEvaluations()
925a7e14dcfSSatish Balay @*/
926441846f8SBarry Smith PetscErrorCode TaoSetMaximumIterations(Tao tao,PetscInt maxits)
927a7e14dcfSSatish Balay {
928a7e14dcfSSatish Balay   PetscFunctionBegin;
929441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
93047a47007SBarry Smith   tao->max_it = PetscMax(0,maxits);
931a7e14dcfSSatish Balay   PetscFunctionReturn(0);
932a7e14dcfSSatish Balay }
933a7e14dcfSSatish Balay 
934a7e14dcfSSatish Balay #undef __FUNCT__
935a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetMaximumIterations"
936a7e14dcfSSatish Balay /*@
937a7e14dcfSSatish Balay    TaoGetMaximumIterations - Sets a maximum number of iterates.
938a7e14dcfSSatish Balay 
939a7e14dcfSSatish Balay    Not Collective
940a7e14dcfSSatish Balay 
941a7e14dcfSSatish Balay    Input Parameters:
942441846f8SBarry Smith .  tao - the Tao solver context
943a7e14dcfSSatish Balay 
944a7e14dcfSSatish Balay    Output Parameters:
945a7e14dcfSSatish Balay .  maxits - the maximum number of iterates
946a7e14dcfSSatish Balay 
947a7e14dcfSSatish Balay    Level: intermediate
948a7e14dcfSSatish Balay 
949a7e14dcfSSatish Balay .seealso: TaoSetMaximumIterations(), TaoGetMaximumFunctionEvaluations()
950a7e14dcfSSatish Balay @*/
951441846f8SBarry Smith PetscErrorCode TaoGetMaximumIterations(Tao tao,PetscInt *maxits)
952a7e14dcfSSatish Balay {
953a7e14dcfSSatish Balay   PetscFunctionBegin;
954441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
955a7e14dcfSSatish Balay   *maxits = tao->max_it;
956a7e14dcfSSatish Balay   PetscFunctionReturn(0);
957a7e14dcfSSatish Balay }
958a7e14dcfSSatish Balay 
959a7e14dcfSSatish Balay #undef __FUNCT__
960a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetInitialTrustRegionRadius"
961a7e14dcfSSatish Balay /*@
962a7e14dcfSSatish Balay    TaoSetInitialTrustRegionRadius - Sets the initial trust region radius.
963a7e14dcfSSatish Balay 
964441846f8SBarry Smith    Logically collective on Tao
965a7e14dcfSSatish Balay 
966a7e14dcfSSatish Balay    Input Parameter:
967a7e14dcfSSatish Balay +  tao - a TAO optimization solver
968a7e14dcfSSatish Balay -  radius - the trust region radius
969a7e14dcfSSatish Balay 
970a7e14dcfSSatish Balay    Level: intermediate
971a7e14dcfSSatish Balay 
972a7e14dcfSSatish Balay    Options Database Key:
973a7e14dcfSSatish Balay .  -tao_trust0 <t0> - sets initial trust region radius
974a7e14dcfSSatish Balay 
975a7e14dcfSSatish Balay .seealso: TaoGetTrustRegionRadius(), TaoSetTrustRegionTolerance()
976a7e14dcfSSatish Balay @*/
977441846f8SBarry Smith PetscErrorCode TaoSetInitialTrustRegionRadius(Tao tao, PetscReal radius)
978a7e14dcfSSatish Balay {
979a7e14dcfSSatish Balay   PetscFunctionBegin;
980441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
981a7e14dcfSSatish Balay   tao->trust0 = PetscMax(0.0,radius);
982a7e14dcfSSatish Balay   PetscFunctionReturn(0);
983a7e14dcfSSatish Balay }
984a7e14dcfSSatish Balay 
985a7e14dcfSSatish Balay #undef __FUNCT__
986a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetInitialTrustRegionRadius"
987a7e14dcfSSatish Balay /*@
988a7e14dcfSSatish Balay    TaoGetInitialTrustRegionRadius - Sets the initial trust region radius.
989a7e14dcfSSatish Balay 
990a7e14dcfSSatish Balay    Not Collective
991a7e14dcfSSatish Balay 
992a7e14dcfSSatish Balay    Input Parameter:
993a7e14dcfSSatish Balay .  tao - a TAO optimization solver
994a7e14dcfSSatish Balay 
995a7e14dcfSSatish Balay    Output Parameter:
996a7e14dcfSSatish Balay .  radius - the trust region radius
997a7e14dcfSSatish Balay 
998a7e14dcfSSatish Balay    Level: intermediate
999a7e14dcfSSatish Balay 
1000a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetCurrentTrustRegionRadius()
1001a7e14dcfSSatish Balay @*/
1002441846f8SBarry Smith PetscErrorCode TaoGetInitialTrustRegionRadius(Tao tao, PetscReal *radius)
1003a7e14dcfSSatish Balay {
1004a7e14dcfSSatish Balay   PetscFunctionBegin;
1005441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1006a7e14dcfSSatish Balay   *radius = tao->trust0;
1007a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1008a7e14dcfSSatish Balay }
1009a7e14dcfSSatish Balay 
1010a7e14dcfSSatish Balay #undef __FUNCT__
1011a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetCurrentTrustRegionRadius"
1012a7e14dcfSSatish Balay /*@
1013a7e14dcfSSatish Balay    TaoGetCurrentTrustRegionRadius - Gets the current trust region radius.
1014a7e14dcfSSatish Balay 
1015a7e14dcfSSatish Balay    Not Collective
1016a7e14dcfSSatish Balay 
1017a7e14dcfSSatish Balay    Input Parameter:
1018a7e14dcfSSatish Balay .  tao - a TAO optimization solver
1019a7e14dcfSSatish Balay 
1020a7e14dcfSSatish Balay    Output Parameter:
1021a7e14dcfSSatish Balay .  radius - the trust region radius
1022a7e14dcfSSatish Balay 
1023a7e14dcfSSatish Balay    Level: intermediate
1024a7e14dcfSSatish Balay 
1025a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetInitialTrustRegionRadius()
1026a7e14dcfSSatish Balay @*/
1027441846f8SBarry Smith PetscErrorCode TaoGetCurrentTrustRegionRadius(Tao tao, PetscReal *radius)
1028a7e14dcfSSatish Balay {
1029a7e14dcfSSatish Balay   PetscFunctionBegin;
1030441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1031a7e14dcfSSatish Balay   *radius = tao->trust;
1032a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1033a7e14dcfSSatish Balay }
1034a7e14dcfSSatish Balay 
1035a7e14dcfSSatish Balay #undef __FUNCT__
1036a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetTolerances"
1037a7e14dcfSSatish Balay /*@
1038a7e14dcfSSatish Balay   TaoGetTolerances - gets the current values of tolerances
1039a7e14dcfSSatish Balay 
1040a7e14dcfSSatish Balay   Not Collective
1041a7e14dcfSSatish Balay 
1042a7e14dcfSSatish Balay   Input Parameters:
1043441846f8SBarry Smith . tao - the Tao context
1044a7e14dcfSSatish Balay 
1045a7e14dcfSSatish Balay   Output Parameters:
1046a7e14dcfSSatish Balay + fatol - absolute convergence tolerance
1047a7e14dcfSSatish Balay . frtol - relative convergence tolerance
1048a7e14dcfSSatish Balay . gatol - stop if norm of gradient is less than this
1049a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this
1050a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by a this factor
1051a7e14dcfSSatish Balay 
105247a47007SBarry Smith   Note: NULL can be used as an argument if not all tolerances values are needed
1053a7e14dcfSSatish Balay 
1054a7e14dcfSSatish Balay .seealso TaoSetTolerances()
1055a7e14dcfSSatish Balay 
1056a7e14dcfSSatish Balay   Level: intermediate
1057a7e14dcfSSatish Balay @*/
1058441846f8SBarry Smith PetscErrorCode TaoGetTolerances(Tao tao, PetscReal *fatol, PetscReal *frtol, PetscReal *gatol, PetscReal *grtol, PetscReal *gttol)
1059a7e14dcfSSatish Balay {
1060a7e14dcfSSatish Balay   PetscFunctionBegin;
1061441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1062a7e14dcfSSatish Balay   if (fatol) *fatol=tao->fatol;
1063a7e14dcfSSatish Balay   if (frtol) *frtol=tao->frtol;
1064a7e14dcfSSatish Balay   if (gatol) *gatol=tao->gatol;
1065a7e14dcfSSatish Balay   if (grtol) *grtol=tao->grtol;
1066a7e14dcfSSatish Balay   if (gttol) *gttol=tao->gttol;
1067a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1068a7e14dcfSSatish Balay }
1069a7e14dcfSSatish Balay 
1070a7e14dcfSSatish Balay #undef __FUNCT__
1071a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetKSP"
1072a7e14dcfSSatish Balay /*@
1073a7e14dcfSSatish Balay   TaoGetKSP - Gets the linear solver used by the optimization solver.
1074a7e14dcfSSatish Balay   Application writers should use TaoGetKSP if they need direct access
1075a7e14dcfSSatish Balay   to the PETSc KSP object.
1076a7e14dcfSSatish Balay 
1077a7e14dcfSSatish Balay   Not Collective
1078a7e14dcfSSatish Balay 
1079a7e14dcfSSatish Balay    Input Parameters:
1080a7e14dcfSSatish Balay .  tao - the TAO solver
1081a7e14dcfSSatish Balay 
1082a7e14dcfSSatish Balay    Output Parameters:
1083a7e14dcfSSatish Balay .  ksp - the KSP linear solver used in the optimization solver
1084a7e14dcfSSatish Balay 
1085a7e14dcfSSatish Balay    Level: intermediate
1086a7e14dcfSSatish Balay 
1087a7e14dcfSSatish Balay @*/
1088441846f8SBarry Smith PetscErrorCode TaoGetKSP(Tao tao, KSP *ksp)
108947a47007SBarry Smith {
1090a7e14dcfSSatish Balay   PetscFunctionBegin;
1091a7e14dcfSSatish Balay   *ksp = tao->ksp;
1092a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1093a7e14dcfSSatish Balay }
1094a7e14dcfSSatish Balay 
1095a7e14dcfSSatish Balay #undef __FUNCT__
1096a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetLineSearch"
1097a7e14dcfSSatish Balay /*@
1098a7e14dcfSSatish Balay   TaoGetLineSearch - Gets the line search used by the optimization solver.
1099a7e14dcfSSatish Balay   Application writers should use TaoGetLineSearch if they need direct access
1100a7e14dcfSSatish Balay   to the TaoLineSearch object.
1101a7e14dcfSSatish Balay 
1102a7e14dcfSSatish Balay   Not Collective
1103a7e14dcfSSatish Balay 
1104a7e14dcfSSatish Balay    Input Parameters:
1105a7e14dcfSSatish Balay .  tao - the TAO solver
1106a7e14dcfSSatish Balay 
1107a7e14dcfSSatish Balay    Output Parameters:
1108a7e14dcfSSatish Balay .  ls - the line search used in the optimization solver
1109a7e14dcfSSatish Balay 
1110a7e14dcfSSatish Balay    Level: intermediate
1111a7e14dcfSSatish Balay 
1112a7e14dcfSSatish Balay @*/
1113441846f8SBarry Smith PetscErrorCode TaoGetLineSearch(Tao tao, TaoLineSearch *ls)
111447a47007SBarry Smith {
1115a7e14dcfSSatish Balay   PetscFunctionBegin;
1116a7e14dcfSSatish Balay   *ls = tao->linesearch;
1117a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1118a7e14dcfSSatish Balay }
1119a7e14dcfSSatish Balay 
1120a7e14dcfSSatish Balay #undef __FUNCT__
1121a7e14dcfSSatish Balay #define __FUNCT__ "TaoAddLineSearchCounts"
1122a7e14dcfSSatish Balay /*@
1123a7e14dcfSSatish Balay   TaoAddLineSearchCounts - Adds the number of function evaluations spent
1124a7e14dcfSSatish Balay   in the line search to the running total.
1125a7e14dcfSSatish Balay 
1126a7e14dcfSSatish Balay    Input Parameters:
1127a7e14dcfSSatish Balay +  tao - the TAO solver
1128a7e14dcfSSatish Balay -  ls - the line search used in the optimization solver
1129a7e14dcfSSatish Balay 
1130a7e14dcfSSatish Balay    Level: developer
1131a7e14dcfSSatish Balay 
1132a7e14dcfSSatish Balay .seealso: TaoLineSearchApply()
1133a7e14dcfSSatish Balay @*/
1134441846f8SBarry Smith PetscErrorCode TaoAddLineSearchCounts(Tao tao)
113547a47007SBarry Smith {
1136a7e14dcfSSatish Balay   PetscErrorCode ierr;
1137a7e14dcfSSatish Balay   PetscBool      flg;
1138a7e14dcfSSatish Balay   PetscInt       nfeval,ngeval,nfgeval;
113947a47007SBarry Smith 
1140a7e14dcfSSatish Balay   PetscFunctionBegin;
1141441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1142a7e14dcfSSatish Balay   if (tao->linesearch) {
1143441846f8SBarry Smith     ierr = TaoLineSearchIsUsingTaoRoutines(tao->linesearch,&flg);
1144a7e14dcfSSatish Balay     if (flg == PETSC_FALSE) {
114547a47007SBarry Smith       ierr = TaoLineSearchGetNumberFunctionEvaluations(tao->linesearch,&nfeval,&ngeval,&nfgeval);CHKERRQ(ierr);
1146a7e14dcfSSatish Balay       tao->nfuncs+=nfeval;
1147a7e14dcfSSatish Balay       tao->ngrads+=ngeval;
1148a7e14dcfSSatish Balay       tao->nfuncgrads+=nfgeval;
1149a7e14dcfSSatish Balay     }
1150a7e14dcfSSatish Balay   }
1151a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1152a7e14dcfSSatish Balay }
1153a7e14dcfSSatish Balay 
1154a7e14dcfSSatish Balay #undef __FUNCT__
1155a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetSolutionVector"
1156a7e14dcfSSatish Balay /*@
1157a7e14dcfSSatish Balay   TaoGetSolutionVector - Returns the vector with the current TAO solution
1158a7e14dcfSSatish Balay 
1159a7e14dcfSSatish Balay   Not Collective
1160a7e14dcfSSatish Balay 
1161a7e14dcfSSatish Balay   Input Parameter:
1162441846f8SBarry Smith . tao - the Tao context
1163a7e14dcfSSatish Balay 
1164a7e14dcfSSatish Balay   Output Parameter:
1165a7e14dcfSSatish Balay . X - the current solution
1166a7e14dcfSSatish Balay 
1167a7e14dcfSSatish Balay   Level: intermediate
1168a7e14dcfSSatish Balay 
1169a7e14dcfSSatish Balay   Note:  The returned vector will be the same object that was passed into TaoSetInitialVector()
1170a7e14dcfSSatish Balay @*/
1171441846f8SBarry Smith PetscErrorCode TaoGetSolutionVector(Tao tao, Vec *X)
1172a7e14dcfSSatish Balay {
1173a7e14dcfSSatish Balay   PetscFunctionBegin;
1174441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1175a7e14dcfSSatish Balay   *X = tao->solution;
1176a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1177a7e14dcfSSatish Balay }
1178a7e14dcfSSatish Balay 
1179a7e14dcfSSatish Balay #undef __FUNCT__
1180a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetGradientVector"
1181a7e14dcfSSatish Balay /*@
1182a7e14dcfSSatish Balay   TaoGetGradientVector - Returns the vector with the current TAO gradient
1183a7e14dcfSSatish Balay 
1184a7e14dcfSSatish Balay   Not Collective
1185a7e14dcfSSatish Balay 
1186a7e14dcfSSatish Balay   Input Parameter:
1187441846f8SBarry Smith . tao - the Tao context
1188a7e14dcfSSatish Balay 
1189a7e14dcfSSatish Balay   Output Parameter:
1190a7e14dcfSSatish Balay . G - the current solution
1191a7e14dcfSSatish Balay 
1192a7e14dcfSSatish Balay   Level: intermediate
1193a7e14dcfSSatish Balay @*/
1194441846f8SBarry Smith PetscErrorCode TaoGetGradientVector(Tao tao, Vec *G)
1195a7e14dcfSSatish Balay {
1196a7e14dcfSSatish Balay   PetscFunctionBegin;
1197441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1198a7e14dcfSSatish Balay   *G = tao->gradient;
1199a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1200a7e14dcfSSatish Balay }
1201a7e14dcfSSatish Balay 
1202a7e14dcfSSatish Balay #undef __FUNCT__
1203a7e14dcfSSatish Balay #define __FUNCT__ "TaoResetStatistics"
1204a7e14dcfSSatish Balay /*@
1205a7e14dcfSSatish Balay    TaoResetStatistics - Initialize the statistics used by TAO for all of the solvers.
1206a7e14dcfSSatish Balay    These statistics include the iteration number, residual norms, and convergence status.
1207a7e14dcfSSatish Balay    This routine gets called before solving each optimization problem.
1208a7e14dcfSSatish Balay 
1209441846f8SBarry Smith    Collective on Tao
1210a7e14dcfSSatish Balay 
1211a7e14dcfSSatish Balay    Input Parameters:
1212441846f8SBarry Smith .  solver - the Tao context
1213a7e14dcfSSatish Balay 
1214a7e14dcfSSatish Balay    Level: developer
1215a7e14dcfSSatish Balay 
1216a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
1217a7e14dcfSSatish Balay @*/
1218441846f8SBarry Smith PetscErrorCode TaoResetStatistics(Tao tao)
1219a7e14dcfSSatish Balay {
1220a7e14dcfSSatish Balay   PetscFunctionBegin;
1221441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1222a7e14dcfSSatish Balay   tao->niter        = 0;
1223a7e14dcfSSatish Balay   tao->nfuncs       = 0;
1224a7e14dcfSSatish Balay   tao->nfuncgrads   = 0;
1225a7e14dcfSSatish Balay   tao->ngrads       = 0;
1226a7e14dcfSSatish Balay   tao->nhess        = 0;
1227a7e14dcfSSatish Balay   tao->njac         = 0;
1228a7e14dcfSSatish Balay   tao->nconstraints = 0;
1229a7e14dcfSSatish Balay   tao->ksp_its      = 0;
1230a7e14dcfSSatish Balay   tao->reason       = TAO_CONTINUE_ITERATING;
1231a7e14dcfSSatish Balay   tao->residual     = 0.0;
1232a7e14dcfSSatish Balay   tao->cnorm        = 0.0;
1233a7e14dcfSSatish Balay   tao->step         = 0.0;
1234a7e14dcfSSatish Balay   tao->lsflag       = PETSC_FALSE;
1235a7e14dcfSSatish Balay   if (tao->hist_reset) tao->hist_len=0;
1236a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1237a7e14dcfSSatish Balay }
1238a7e14dcfSSatish Balay 
1239a7e14dcfSSatish Balay #undef __FUNCT__
1240a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetConvergenceTest"
1241a7e14dcfSSatish Balay /*@C
1242a7e14dcfSSatish Balay   TaoSetConvergenceTest - Sets the function that is to be used to test
1243a7e14dcfSSatish Balay   for convergence o fthe iterative minimization solution.  The new convergence
1244a7e14dcfSSatish Balay   testing routine will replace TAO's default convergence test.
1245a7e14dcfSSatish Balay 
1246441846f8SBarry Smith   Logically Collective on Tao
1247a7e14dcfSSatish Balay 
1248a7e14dcfSSatish Balay   Input Parameters:
1249441846f8SBarry Smith + tao - the Tao object
1250a7e14dcfSSatish Balay . conv - the routine to test for convergence
1251a7e14dcfSSatish Balay - ctx - [optional] context for private data for the convergence routine
125247a47007SBarry Smith         (may be NULL)
1253a7e14dcfSSatish Balay 
1254a7e14dcfSSatish Balay   Calling sequence of conv:
1255441846f8SBarry Smith $   PetscErrorCode conv(Tao tao, void *ctx)
1256a7e14dcfSSatish Balay 
1257441846f8SBarry Smith + tao - the Tao object
1258a7e14dcfSSatish Balay - ctx - [optional] convergence context
1259a7e14dcfSSatish Balay 
1260a7e14dcfSSatish Balay   Note: The new convergence testing routine should call TaoSetTerminationReason().
1261a7e14dcfSSatish Balay 
1262a7e14dcfSSatish Balay   Level: advanced
1263a7e14dcfSSatish Balay 
1264a7e14dcfSSatish Balay .seealso: TaoSetTerminationReason(), TaoGetSolutionStatus(), TaoGetTolerances(), TaoSetMonitor
1265a7e14dcfSSatish Balay 
1266a7e14dcfSSatish Balay @*/
1267441846f8SBarry Smith PetscErrorCode TaoSetConvergenceTest(Tao tao, PetscErrorCode (*conv)(Tao,void*), void *ctx)
1268a7e14dcfSSatish Balay {
1269a7e14dcfSSatish Balay   PetscFunctionBegin;
1270441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1271a7e14dcfSSatish Balay   (tao)->ops->convergencetest = conv;
1272a7e14dcfSSatish Balay   (tao)->cnvP = ctx;
1273a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1274a7e14dcfSSatish Balay }
1275a7e14dcfSSatish Balay 
1276a7e14dcfSSatish Balay #undef __FUNCT__
1277a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMonitor"
1278a7e14dcfSSatish Balay /*@C
1279a7e14dcfSSatish Balay    TaoSetMonitor - Sets an ADDITIONAL function that is to be used at every
1280a7e14dcfSSatish Balay    iteration of the solver to display the iteration's
1281a7e14dcfSSatish Balay    progress.
1282a7e14dcfSSatish Balay 
1283441846f8SBarry Smith    Logically Collective on Tao
1284a7e14dcfSSatish Balay 
1285a7e14dcfSSatish Balay    Input Parameters:
1286441846f8SBarry Smith +  tao - the Tao solver context
1287a7e14dcfSSatish Balay .  mymonitor - monitoring routine
1288a7e14dcfSSatish Balay -  mctx - [optional] user-defined context for private data for the
128947a47007SBarry Smith           monitor routine (may be NULL)
1290a7e14dcfSSatish Balay 
1291a7e14dcfSSatish Balay    Calling sequence of mymonitor:
1292441846f8SBarry Smith $     int mymonitor(Tao tao,void *mctx)
1293a7e14dcfSSatish Balay 
1294441846f8SBarry Smith +    tao - the Tao solver context
1295a7e14dcfSSatish Balay -    mctx - [optional] monitoring context
1296a7e14dcfSSatish Balay 
1297a7e14dcfSSatish Balay 
1298a7e14dcfSSatish Balay    Options Database Keys:
1299a7e14dcfSSatish Balay +    -tao_monitor        - sets TaoDefaultMonitor()
1300a7e14dcfSSatish Balay .    -tao_smonitor       - sets short monitor
1301a7e14dcfSSatish Balay .    -tao_cmonitor       - same as smonitor plus constraint norm
1302a7e14dcfSSatish Balay .    -tao_view_solution   - view solution at each iteration
1303a7e14dcfSSatish Balay .    -tao_view_gradient   - view gradient at each iteration
1304a7e14dcfSSatish Balay .    -tao_view_separableobjective - view separable objective function at each iteration
1305a7e14dcfSSatish 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.
1306a7e14dcfSSatish Balay 
1307a7e14dcfSSatish Balay 
1308a7e14dcfSSatish Balay    Notes:
1309a7e14dcfSSatish Balay    Several different monitoring routines may be set by calling
1310a7e14dcfSSatish Balay    TaoSetMonitor() multiple times; all will be called in the
1311a7e14dcfSSatish Balay    order in which they were set.
1312a7e14dcfSSatish Balay 
1313a7e14dcfSSatish Balay    Fortran Notes: Only one monitor function may be set
1314a7e14dcfSSatish Balay 
1315a7e14dcfSSatish Balay    Level: intermediate
1316a7e14dcfSSatish Balay 
1317a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoCancelMonitors(),  TaoSetDestroyRoutine()
1318a7e14dcfSSatish Balay @*/
1319441846f8SBarry Smith PetscErrorCode TaoSetMonitor(Tao tao, PetscErrorCode (*func)(Tao, void*), void *ctx,PetscErrorCode (*dest)(void**))
1320a7e14dcfSSatish Balay {
1321a7e14dcfSSatish Balay   PetscFunctionBegin;
1322441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
132347a47007SBarry Smith   if (tao->numbermonitors >= MAXTAOMONITORS) SETERRQ1(PETSC_COMM_SELF,1,"Cannot attach another monitor -- max=",MAXTAOMONITORS);
1324a7e14dcfSSatish Balay   tao->monitor[tao->numbermonitors] = func;
1325a7e14dcfSSatish Balay   tao->monitorcontext[tao->numbermonitors] = ctx;
1326a7e14dcfSSatish Balay   tao->monitordestroy[tao->numbermonitors] = dest;
1327a7e14dcfSSatish Balay   ++tao->numbermonitors;
1328a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1329a7e14dcfSSatish Balay }
1330a7e14dcfSSatish Balay 
1331a7e14dcfSSatish Balay #undef __FUNCT__
1332a7e14dcfSSatish Balay #define __FUNCT__ "TaoCancelMonitors"
1333a7e14dcfSSatish Balay /*@
1334441846f8SBarry Smith    TaoCancelMonitors - Clears all the monitor functions for a Tao object.
1335a7e14dcfSSatish Balay 
1336441846f8SBarry Smith    Logically Collective on Tao
1337a7e14dcfSSatish Balay 
1338a7e14dcfSSatish Balay    Input Parameters:
1339441846f8SBarry Smith .  tao - the Tao solver context
1340a7e14dcfSSatish Balay 
1341a7e14dcfSSatish Balay    Options Database:
1342a7e14dcfSSatish Balay .  -tao_cancelmonitors - cancels all monitors that have been hardwired
1343a7e14dcfSSatish Balay     into a code by calls to TaoSetMonitor(), but does not cancel those
1344a7e14dcfSSatish Balay     set via the options database
1345a7e14dcfSSatish Balay 
1346a7e14dcfSSatish Balay    Notes:
1347441846f8SBarry Smith    There is no way to clear one specific monitor from a Tao object.
1348a7e14dcfSSatish Balay 
1349a7e14dcfSSatish Balay    Level: advanced
1350a7e14dcfSSatish Balay 
1351a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1352a7e14dcfSSatish Balay @*/
1353441846f8SBarry Smith PetscErrorCode TaoCancelMonitors(Tao tao)
1354a7e14dcfSSatish Balay {
1355a7e14dcfSSatish Balay   PetscInt       i;
1356a7e14dcfSSatish Balay   PetscErrorCode ierr;
135747a47007SBarry Smith 
1358a7e14dcfSSatish Balay   PetscFunctionBegin;
1359441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1360a7e14dcfSSatish Balay   for (i=0;i<tao->numbermonitors;i++) {
1361a7e14dcfSSatish Balay     if (tao->monitordestroy[i]) {
1362a7e14dcfSSatish Balay       ierr = (*tao->monitordestroy[i])(&tao->monitorcontext[i]);CHKERRQ(ierr);
1363a7e14dcfSSatish Balay     }
1364a7e14dcfSSatish Balay   }
1365a7e14dcfSSatish Balay   tao->numbermonitors=0;
1366a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1367a7e14dcfSSatish Balay }
1368a7e14dcfSSatish Balay 
1369a7e14dcfSSatish Balay #undef __FUNCT__
1370a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultMonitor"
1371a7e14dcfSSatish Balay /*@C
1372a7e14dcfSSatish Balay    TaoDefaultMonitor - Default routine for monitoring progress of the
1373441846f8SBarry Smith    Tao solvers (default).  This monitor prints the function value and gradient
1374a7e14dcfSSatish Balay    norm at each iteration.  It can be turned on from the command line using the
1375a7e14dcfSSatish Balay    -tao_monitor option
1376a7e14dcfSSatish Balay 
1377441846f8SBarry Smith    Collective on Tao
1378a7e14dcfSSatish Balay 
1379a7e14dcfSSatish Balay    Input Parameters:
1380441846f8SBarry Smith +  tao - the Tao context
138147a47007SBarry Smith -  ctx - PetscViewer context or NULL
1382a7e14dcfSSatish Balay 
1383a7e14dcfSSatish Balay    Options Database Keys:
1384a7e14dcfSSatish Balay .  -tao_monitor
1385a7e14dcfSSatish Balay 
1386a7e14dcfSSatish Balay    Level: advanced
1387a7e14dcfSSatish Balay 
1388a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1389a7e14dcfSSatish Balay @*/
1390441846f8SBarry Smith PetscErrorCode TaoDefaultMonitor(Tao tao, void *ctx)
1391a7e14dcfSSatish Balay {
1392a7e14dcfSSatish Balay   PetscErrorCode ierr;
1393a7e14dcfSSatish Balay   PetscInt       its;
1394a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1395a7e14dcfSSatish Balay   PetscViewer    viewer;
139647a47007SBarry Smith 
1397a7e14dcfSSatish Balay   PetscFunctionBegin;
1398a7e14dcfSSatish Balay   if (ctx) {
1399a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1400a7e14dcfSSatish Balay   } else {
1401a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1402a7e14dcfSSatish Balay   }
1403a7e14dcfSSatish Balay   its=tao->niter;
1404a7e14dcfSSatish Balay   fct=tao->fc;
1405a7e14dcfSSatish Balay   gnorm=tao->residual;
1406a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr);
140747a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr);
140847a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer,"  Residual: %g \n",(double)gnorm);CHKERRQ(ierr);
1409a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1410a7e14dcfSSatish Balay }
1411a7e14dcfSSatish Balay 
1412a7e14dcfSSatish Balay #undef __FUNCT__
1413a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultSMonitor"
1414a7e14dcfSSatish Balay /*@C
1415a7e14dcfSSatish Balay    TaoDefaultSMonitor - Default routine for monitoring progress of the
1416a7e14dcfSSatish Balay    solver. Same as TaoDefaultMonitor() except
1417a7e14dcfSSatish Balay    it prints fewer digits of the residual as the residual gets smaller.
1418a7e14dcfSSatish Balay    This is because the later digits are meaningless and are often
1419a7e14dcfSSatish Balay    different on different machines; by using this routine different
1420a7e14dcfSSatish Balay    machines will usually generate the same output. It can be turned on
1421a7e14dcfSSatish Balay    by using the -tao_smonitor option
1422a7e14dcfSSatish Balay 
1423441846f8SBarry Smith    Collective on Tao
1424a7e14dcfSSatish Balay 
1425a7e14dcfSSatish Balay    Input Parameters:
1426441846f8SBarry Smith +  tao - the Tao context
142747a47007SBarry Smith -  ctx - PetscViewer context or NULL
1428a7e14dcfSSatish Balay 
1429a7e14dcfSSatish Balay    Options Database Keys:
1430a7e14dcfSSatish Balay .  -tao_smonitor
1431a7e14dcfSSatish Balay 
1432a7e14dcfSSatish Balay    Level: advanced
1433a7e14dcfSSatish Balay 
1434a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1435a7e14dcfSSatish Balay @*/
1436441846f8SBarry Smith PetscErrorCode TaoDefaultSMonitor(Tao tao, void *ctx)
1437a7e14dcfSSatish Balay {
1438a7e14dcfSSatish Balay   PetscErrorCode ierr;
1439a7e14dcfSSatish Balay   PetscInt       its;
1440a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1441a7e14dcfSSatish Balay   PetscViewer    viewer;
144247a47007SBarry Smith 
1443a7e14dcfSSatish Balay   PetscFunctionBegin;
1444a7e14dcfSSatish Balay   if (ctx) {
1445a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1446a7e14dcfSSatish Balay   } else {
1447a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1448a7e14dcfSSatish Balay   }
1449a7e14dcfSSatish Balay   its=tao->niter;
1450a7e14dcfSSatish Balay   fct=tao->fc;
1451a7e14dcfSSatish Balay   gnorm=tao->residual;
1452a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr);
145347a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value %g,",(double)fct);CHKERRQ(ierr);
1454a7e14dcfSSatish Balay   if (gnorm > 1.e-6) {
145547a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr);
1456a7e14dcfSSatish Balay   } else if (gnorm > 1.e-11) {
1457a7e14dcfSSatish Balay     ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-6 \n");CHKERRQ(ierr);
1458a7e14dcfSSatish Balay   } else {
1459a7e14dcfSSatish Balay     ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-11 \n");CHKERRQ(ierr);
1460a7e14dcfSSatish Balay   }
1461a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1462a7e14dcfSSatish Balay }
1463a7e14dcfSSatish Balay 
1464a7e14dcfSSatish Balay #undef __FUNCT__
1465a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultCMonitor"
1466a7e14dcfSSatish Balay /*@C
1467a7e14dcfSSatish Balay    TaoDefaultCMonitor - same as TaoDefaultMonitor() except
1468a7e14dcfSSatish Balay    it prints the norm of the constraints function. It can be turned on
1469a7e14dcfSSatish Balay    from the command line using the -tao_cmonitor option
1470a7e14dcfSSatish Balay 
1471441846f8SBarry Smith    Collective on Tao
1472a7e14dcfSSatish Balay 
1473a7e14dcfSSatish Balay    Input Parameters:
1474441846f8SBarry Smith +  tao - the Tao context
147547a47007SBarry Smith -  ctx - PetscViewer context or NULL
1476a7e14dcfSSatish Balay 
1477a7e14dcfSSatish Balay    Options Database Keys:
1478a7e14dcfSSatish Balay .  -tao_cmonitor
1479a7e14dcfSSatish Balay 
1480a7e14dcfSSatish Balay    Level: advanced
1481a7e14dcfSSatish Balay 
1482a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1483a7e14dcfSSatish Balay @*/
1484441846f8SBarry Smith PetscErrorCode TaoDefaultCMonitor(Tao tao, void *ctx)
1485a7e14dcfSSatish Balay {
1486a7e14dcfSSatish Balay   PetscErrorCode ierr;
1487a7e14dcfSSatish Balay   PetscInt       its;
1488a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1489a7e14dcfSSatish Balay   PetscViewer    viewer;
1490a7e14dcfSSatish Balay 
1491a7e14dcfSSatish Balay   PetscFunctionBegin;
1492a7e14dcfSSatish Balay   if (ctx) {
1493a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1494a7e14dcfSSatish Balay   } else {
1495a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1496a7e14dcfSSatish Balay   }
1497a7e14dcfSSatish Balay   its=tao->niter;
1498a7e14dcfSSatish Balay   fct=tao->fc;
1499a7e14dcfSSatish Balay   gnorm=tao->residual;
1500a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %D,",its);CHKERRQ(ierr);
150147a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr);
150247a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer,"  Residual: %g ",(double)gnorm);CHKERRQ(ierr);
150347a47007SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"  Constraint: %g \n",(double)tao->cnorm);CHKERRQ(ierr);
1504a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1505a7e14dcfSSatish Balay }
1506a7e14dcfSSatish Balay 
1507a7e14dcfSSatish Balay #undef __FUNCT__
1508a7e14dcfSSatish Balay #define __FUNCT__ "TaoSolutionMonitor"
1509a7e14dcfSSatish Balay /*@C
1510a7e14dcfSSatish Balay    TaoSolutionMonitor - Views the solution at each iteration
1511a7e14dcfSSatish Balay    It can be turned on from the command line using the
1512a7e14dcfSSatish Balay    -tao_view_solution option
1513a7e14dcfSSatish Balay 
1514441846f8SBarry Smith    Collective on Tao
1515a7e14dcfSSatish Balay 
1516a7e14dcfSSatish Balay    Input Parameters:
1517441846f8SBarry Smith +  tao - the Tao context
151847a47007SBarry Smith -  ctx - PetscViewer context or NULL
1519a7e14dcfSSatish Balay 
1520a7e14dcfSSatish Balay    Options Database Keys:
1521a7e14dcfSSatish Balay .  -tao_view_solution
1522a7e14dcfSSatish Balay 
1523a7e14dcfSSatish Balay    Level: advanced
1524a7e14dcfSSatish Balay 
1525a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1526a7e14dcfSSatish Balay @*/
1527441846f8SBarry Smith PetscErrorCode TaoSolutionMonitor(Tao tao, void *ctx)
1528a7e14dcfSSatish Balay {
1529a7e14dcfSSatish Balay   PetscErrorCode ierr;
1530a7e14dcfSSatish Balay   PetscViewer viewer;
153147a47007SBarry Smith 
1532a7e14dcfSSatish Balay   PetscFunctionBegin;
1533a7e14dcfSSatish Balay   if (ctx) {
1534a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1535a7e14dcfSSatish Balay   } else {
1536a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1537a7e14dcfSSatish Balay   }
1538a7e14dcfSSatish Balay   ierr = VecView(tao->solution, viewer);CHKERRQ(ierr);
1539a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1540a7e14dcfSSatish Balay }
1541a7e14dcfSSatish Balay 
1542a7e14dcfSSatish Balay #undef __FUNCT__
1543a7e14dcfSSatish Balay #define __FUNCT__ "TaoGradientMonitor"
1544a7e14dcfSSatish Balay /*@C
1545a7e14dcfSSatish Balay    TaoGradientMonitor - Views the gradient at each iteration
1546a7e14dcfSSatish Balay    It can be turned on from the command line using the
1547a7e14dcfSSatish Balay    -tao_view_gradient option
1548a7e14dcfSSatish Balay 
1549441846f8SBarry Smith    Collective on Tao
1550a7e14dcfSSatish Balay 
1551a7e14dcfSSatish Balay    Input Parameters:
1552441846f8SBarry Smith +  tao - the Tao context
155347a47007SBarry Smith -  ctx - PetscViewer context or NULL
1554a7e14dcfSSatish Balay 
1555a7e14dcfSSatish Balay    Options Database Keys:
1556a7e14dcfSSatish Balay .  -tao_view_gradient
1557a7e14dcfSSatish Balay 
1558a7e14dcfSSatish Balay    Level: advanced
1559a7e14dcfSSatish Balay 
1560a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1561a7e14dcfSSatish Balay @*/
1562441846f8SBarry Smith PetscErrorCode TaoGradientMonitor(Tao tao, void *ctx)
1563a7e14dcfSSatish Balay {
1564a7e14dcfSSatish Balay   PetscErrorCode ierr;
1565a7e14dcfSSatish Balay   PetscViewer viewer;
156647a47007SBarry Smith 
1567a7e14dcfSSatish Balay   PetscFunctionBegin;
1568a7e14dcfSSatish Balay   if (ctx) {
1569a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1570a7e14dcfSSatish Balay   } else {
1571a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1572a7e14dcfSSatish Balay   }
1573a7e14dcfSSatish Balay   ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr);
1574a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1575a7e14dcfSSatish Balay }
1576a7e14dcfSSatish Balay 
1577a7e14dcfSSatish Balay #undef __FUNCT__
1578a7e14dcfSSatish Balay #define __FUNCT__ "TaoStepDirectionMonitor"
1579a7e14dcfSSatish Balay /*@C
1580a7e14dcfSSatish Balay    TaoStepDirectionMonitor - Views the gradient at each iteration
1581a7e14dcfSSatish Balay    It can be turned on from the command line using the
1582a7e14dcfSSatish Balay    -tao_view_gradient option
1583a7e14dcfSSatish Balay 
1584441846f8SBarry Smith    Collective on Tao
1585a7e14dcfSSatish Balay 
1586a7e14dcfSSatish Balay    Input Parameters:
1587441846f8SBarry Smith +  tao - the Tao context
158847a47007SBarry Smith -  ctx - PetscViewer context or NULL
1589a7e14dcfSSatish Balay 
1590a7e14dcfSSatish Balay    Options Database Keys:
1591a7e14dcfSSatish Balay .  -tao_view_gradient
1592a7e14dcfSSatish Balay 
1593a7e14dcfSSatish Balay    Level: advanced
1594a7e14dcfSSatish Balay 
1595a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1596a7e14dcfSSatish Balay @*/
1597441846f8SBarry Smith PetscErrorCode TaoStepDirectionMonitor(Tao tao, void *ctx)
1598a7e14dcfSSatish Balay {
1599a7e14dcfSSatish Balay   PetscErrorCode ierr;
1600a7e14dcfSSatish Balay   PetscViewer viewer;
1601a7e14dcfSSatish Balay   PetscFunctionBegin;
1602a7e14dcfSSatish Balay   if (ctx) {
1603a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1604a7e14dcfSSatish Balay   } else {
1605a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1606a7e14dcfSSatish Balay   }
1607a7e14dcfSSatish Balay   ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr);
1608a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1609a7e14dcfSSatish Balay }
1610a7e14dcfSSatish Balay 
1611a7e14dcfSSatish Balay #undef __FUNCT__
1612a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawSolutionMonitor"
1613a7e14dcfSSatish Balay /*@C
1614a7e14dcfSSatish Balay    TaoDrawSolutionMonitor - Plots the solution at each iteration
1615a7e14dcfSSatish Balay    It can be turned on from the command line using the
1616a7e14dcfSSatish Balay    -tao_draw_solution option
1617a7e14dcfSSatish Balay 
1618441846f8SBarry Smith    Collective on Tao
1619a7e14dcfSSatish Balay 
1620a7e14dcfSSatish Balay    Input Parameters:
1621441846f8SBarry Smith +  tao - the Tao context
162247a47007SBarry Smith -  ctx - PetscViewer context or NULL
1623a7e14dcfSSatish Balay 
1624a7e14dcfSSatish Balay    Options Database Keys:
1625a7e14dcfSSatish Balay .  -tao_draw_solution
1626a7e14dcfSSatish Balay 
1627a7e14dcfSSatish Balay    Level: advanced
1628a7e14dcfSSatish Balay 
1629a7e14dcfSSatish Balay .seealso: TaoSolutionMonitor(), TaoSetMonitor(), TaoDrawGradientMonitor
1630a7e14dcfSSatish Balay @*/
1631441846f8SBarry Smith PetscErrorCode TaoDrawSolutionMonitor(Tao tao, void *ctx)
1632a7e14dcfSSatish Balay {
1633a7e14dcfSSatish Balay   PetscErrorCode ierr;
1634a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer) ctx;
1635a7e14dcfSSatish Balay   MPI_Comm       comm;
163647a47007SBarry Smith 
1637a7e14dcfSSatish Balay   PetscFunctionBegin;
1638a7e14dcfSSatish Balay   if (!viewer) {
1639a7e14dcfSSatish Balay     ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
1640a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_DRAW_(comm);
1641a7e14dcfSSatish Balay   }
1642a7e14dcfSSatish Balay   ierr = VecView(tao->solution, viewer);CHKERRQ(ierr);
1643a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1644a7e14dcfSSatish Balay }
1645a7e14dcfSSatish Balay 
1646a7e14dcfSSatish Balay #undef __FUNCT__
1647a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawGradientMonitor"
1648a7e14dcfSSatish Balay /*@C
1649a7e14dcfSSatish Balay    TaoDrawGradientMonitor - Plots the gradient at each iteration
1650a7e14dcfSSatish Balay    It can be turned on from the command line using the
1651a7e14dcfSSatish Balay    -tao_draw_gradient option
1652a7e14dcfSSatish Balay 
1653441846f8SBarry Smith    Collective on Tao
1654a7e14dcfSSatish Balay 
1655a7e14dcfSSatish Balay    Input Parameters:
1656441846f8SBarry Smith +  tao - the Tao context
165747a47007SBarry Smith -  ctx - PetscViewer context or NULL
1658a7e14dcfSSatish Balay 
1659a7e14dcfSSatish Balay    Options Database Keys:
1660a7e14dcfSSatish Balay .  -tao_draw_gradient
1661a7e14dcfSSatish Balay 
1662a7e14dcfSSatish Balay    Level: advanced
1663a7e14dcfSSatish Balay 
1664a7e14dcfSSatish Balay .seealso: TaoGradientMonitor(), TaoSetMonitor(), TaoDrawSolutionMonitor
1665a7e14dcfSSatish Balay @*/
1666441846f8SBarry Smith PetscErrorCode TaoDrawGradientMonitor(Tao tao, void *ctx)
1667a7e14dcfSSatish Balay {
1668a7e14dcfSSatish Balay   PetscErrorCode ierr;
1669a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer)ctx;
1670a7e14dcfSSatish Balay   MPI_Comm       comm;
167147a47007SBarry Smith 
1672a7e14dcfSSatish Balay   PetscFunctionBegin;
1673a7e14dcfSSatish Balay   if (!viewer) {
1674a7e14dcfSSatish Balay     ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
1675a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_DRAW_(comm);
1676a7e14dcfSSatish Balay   }
1677a7e14dcfSSatish Balay   ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr);
1678a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1679a7e14dcfSSatish Balay }
1680a7e14dcfSSatish Balay 
1681a7e14dcfSSatish Balay #undef __FUNCT__
1682a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawStepMonitor"
1683a7e14dcfSSatish Balay /*@C
1684a7e14dcfSSatish Balay    TaoDrawStepMonitor - Plots the step direction at each iteration
1685a7e14dcfSSatish Balay    It can be turned on from the command line using the
1686a7e14dcfSSatish Balay    -tao_draw_step option
1687a7e14dcfSSatish Balay 
1688441846f8SBarry Smith    Collective on Tao
1689a7e14dcfSSatish Balay 
1690a7e14dcfSSatish Balay    Input Parameters:
1691441846f8SBarry Smith +  tao - the Tao context
169247a47007SBarry Smith -  ctx - PetscViewer context or NULL
1693a7e14dcfSSatish Balay 
1694a7e14dcfSSatish Balay    Options Database Keys:
1695a7e14dcfSSatish Balay .  -tao_draw_step
1696a7e14dcfSSatish Balay 
1697a7e14dcfSSatish Balay    Level: advanced
1698a7e14dcfSSatish Balay 
1699a7e14dcfSSatish Balay .seealso: TaoSetMonitor(), TaoDrawSolutionMonitor
1700a7e14dcfSSatish Balay @*/
1701441846f8SBarry Smith PetscErrorCode TaoDrawStepMonitor(Tao tao, void *ctx)
1702a7e14dcfSSatish Balay {
1703a7e14dcfSSatish Balay   PetscErrorCode ierr;
1704a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer)(ctx);
1705a7e14dcfSSatish Balay   MPI_Comm       comm;
170647a47007SBarry Smith 
1707a7e14dcfSSatish Balay   PetscFunctionBegin;
1708a7e14dcfSSatish Balay   if (!viewer) {
1709a7e14dcfSSatish Balay     ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
1710a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_DRAW_(comm);
1711a7e14dcfSSatish Balay   }
1712a7e14dcfSSatish Balay   ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr);
1713a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1714a7e14dcfSSatish Balay }
1715a7e14dcfSSatish Balay 
1716a7e14dcfSSatish Balay #undef __FUNCT__
1717a7e14dcfSSatish Balay #define __FUNCT__ "TaoSeparableObjectiveMonitor"
1718a7e14dcfSSatish Balay /*@C
1719a7e14dcfSSatish Balay    TaoSeparableObjectiveMonitor - Views the separable objective function at each iteration
1720a7e14dcfSSatish Balay    It can be turned on from the command line using the
1721a7e14dcfSSatish Balay    -tao_view_separableobjective option
1722a7e14dcfSSatish Balay 
1723441846f8SBarry Smith    Collective on Tao
1724a7e14dcfSSatish Balay 
1725a7e14dcfSSatish Balay    Input Parameters:
1726441846f8SBarry Smith +  tao - the Tao context
172747a47007SBarry Smith -  ctx - PetscViewer context or NULL
1728a7e14dcfSSatish Balay 
1729a7e14dcfSSatish Balay    Options Database Keys:
1730a7e14dcfSSatish Balay .  -tao_view_separableobjective
1731a7e14dcfSSatish Balay 
1732a7e14dcfSSatish Balay    Level: advanced
1733a7e14dcfSSatish Balay 
1734a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1735a7e14dcfSSatish Balay @*/
1736441846f8SBarry Smith PetscErrorCode TaoSeparableObjectiveMonitor(Tao tao, void *ctx)
1737a7e14dcfSSatish Balay {
1738a7e14dcfSSatish Balay   PetscErrorCode ierr;
1739a7e14dcfSSatish Balay   PetscViewer    viewer;
174047a47007SBarry Smith 
1741a7e14dcfSSatish Balay   PetscFunctionBegin;
1742a7e14dcfSSatish Balay   if (ctx) {
1743a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1744a7e14dcfSSatish Balay   } else {
1745a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1746a7e14dcfSSatish Balay   }
1747a7e14dcfSSatish Balay   ierr = VecView(tao->sep_objective,viewer);CHKERRQ(ierr);
1748a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1749a7e14dcfSSatish Balay }
1750a7e14dcfSSatish Balay 
1751a7e14dcfSSatish Balay #undef __FUNCT__
1752a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultConvergenceTest"
1753a7e14dcfSSatish Balay /*@C
1754a7e14dcfSSatish Balay    TaoDefaultConvergenceTest - Determines whether the solver should continue iterating
1755a7e14dcfSSatish Balay    or terminate.
1756a7e14dcfSSatish Balay 
1757441846f8SBarry Smith    Collective on Tao
1758a7e14dcfSSatish Balay 
1759a7e14dcfSSatish Balay    Input Parameters:
1760441846f8SBarry Smith +  tao - the Tao context
1761a7e14dcfSSatish Balay -  dummy - unused dummy context
1762a7e14dcfSSatish Balay 
1763a7e14dcfSSatish Balay    Output Parameter:
1764a7e14dcfSSatish Balay .  reason - for terminating
1765a7e14dcfSSatish Balay 
1766a7e14dcfSSatish Balay    Notes:
1767a7e14dcfSSatish Balay    This routine checks the residual in the optimality conditions, the
1768a7e14dcfSSatish Balay    relative residual in the optimity conditions, the number of function
1769a7e14dcfSSatish Balay    evaluations, and the function value to test convergence.  Some
1770a7e14dcfSSatish Balay    solvers may use different convergence routines.
1771a7e14dcfSSatish Balay 
1772a7e14dcfSSatish Balay    Level: developer
1773a7e14dcfSSatish Balay 
1774a7e14dcfSSatish Balay .seealso: TaoSetTolerances(),TaoGetTerminationReason(),TaoSetTerminationReason()
1775a7e14dcfSSatish Balay @*/
1776a7e14dcfSSatish Balay 
1777441846f8SBarry Smith PetscErrorCode TaoDefaultConvergenceTest(Tao tao,void *dummy)
1778a7e14dcfSSatish Balay {
1779a7e14dcfSSatish Balay   PetscInt             niter=tao->niter, nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads);
1780a7e14dcfSSatish Balay   PetscInt             max_funcs=tao->max_funcs;
1781a7e14dcfSSatish Balay   PetscReal            gnorm=tao->residual, gnorm0=tao->gnorm0;
1782a7e14dcfSSatish Balay   PetscReal            f=tao->fc, steptol=tao->steptol,trradius=tao->step;
1783a7e14dcfSSatish Balay   PetscReal            gatol=tao->gatol,grtol=tao->grtol,gttol=tao->gttol;
1784a7e14dcfSSatish Balay   PetscReal            fatol=tao->fatol,frtol=tao->frtol,catol=tao->catol,crtol=tao->crtol;
1785a7e14dcfSSatish Balay   PetscReal            fmin=tao->fmin, cnorm=tao->cnorm, cnorm0=tao->cnorm0;
1786a7e14dcfSSatish Balay   PetscReal            gnorm2;
1787441846f8SBarry Smith   TaoTerminationReason reason=tao->reason;
1788a7e14dcfSSatish Balay   PetscErrorCode       ierr;
1789a7e14dcfSSatish Balay 
1790a7e14dcfSSatish Balay   PetscFunctionBegin;
1791441846f8SBarry Smith   PetscValidHeaderSpecific(tao, TAO_CLASSID,1);
1792a7e14dcfSSatish Balay   if (reason != TAO_CONTINUE_ITERATING) {
1793a7e14dcfSSatish Balay     PetscFunctionReturn(0);
1794a7e14dcfSSatish Balay   }
1795a7e14dcfSSatish Balay   gnorm2=gnorm*gnorm;
1796a7e14dcfSSatish Balay 
1797a7e14dcfSSatish Balay   if (PetscIsInfOrNanReal(f)) {
1798a7e14dcfSSatish Balay     ierr = PetscInfo(tao,"Failed to converged, function value is Inf or NaN\n");CHKERRQ(ierr);
1799a7e14dcfSSatish Balay     reason = TAO_DIVERGED_NAN;
1800a7e14dcfSSatish Balay   } else if (f <= fmin && cnorm <=catol) {
180147a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to function value %g < minimum function value %g\n", (double)f,(double)fmin);CHKERRQ(ierr);
1802a7e14dcfSSatish Balay     reason = TAO_CONVERGED_MINF;
1803a7e14dcfSSatish Balay   } else if (gnorm2 <= fatol && cnorm <=catol) {
180447a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to estimated f(X) - f(X*) = %g < %g\n",(double)gnorm2,(double)fatol);CHKERRQ(ierr);
1805a7e14dcfSSatish Balay     reason = TAO_CONVERGED_FATOL;
1806a7e14dcfSSatish Balay   } else if (f != 0 && gnorm2 / PetscAbsReal(f)<= frtol && cnorm/PetscMax(cnorm0,1.0) <= crtol) {
180747a47007SBarry 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);
1808a7e14dcfSSatish Balay     reason = TAO_CONVERGED_FRTOL;
1809a7e14dcfSSatish Balay   } else if (gnorm<= gatol && cnorm <=catol) {
181047a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to residual norm ||g(X)||=%g < %g\n",(double)gnorm,(double)gatol);CHKERRQ(ierr);
1811a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GATOL;
1812a7e14dcfSSatish Balay   } else if ( f!=0 && PetscAbsReal(gnorm/f) <= grtol && cnorm <= crtol) {
181347a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to residual ||g(X)||/|f(X)| =%g < %g\n",(double)(gnorm/f),(double)grtol);CHKERRQ(ierr);
1814a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GRTOL;
1815a7e14dcfSSatish Balay   } else if (gnorm0 != 0 && gnorm/gnorm0 <= gttol && cnorm <= crtol) {
181647a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to relative residual norm ||g(X)||/||g(X0)|| = %g < %g\n",(double)(gnorm/gnorm0),(double)gttol);CHKERRQ(ierr);
1817a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GTTOL;
1818a7e14dcfSSatish Balay   } else if (nfuncs > max_funcs){
1819a7e14dcfSSatish Balay     ierr = PetscInfo2(tao,"Exceeded maximum number of function evaluations: %D > %D\n", nfuncs,max_funcs);CHKERRQ(ierr);
1820a7e14dcfSSatish Balay     reason = TAO_DIVERGED_MAXFCN;
1821a7e14dcfSSatish Balay   } else if ( tao->lsflag != 0 ){
1822a7e14dcfSSatish Balay     ierr = PetscInfo(tao,"Tao Line Search failure.\n");CHKERRQ(ierr);
1823a7e14dcfSSatish Balay     reason = TAO_DIVERGED_LS_FAILURE;
1824a7e14dcfSSatish Balay   } else if (trradius < steptol && niter > 0){
182547a47007SBarry Smith     ierr = PetscInfo2(tao,"Trust region/step size too small: %g < %g\n", (double)trradius,(double)steptol);CHKERRQ(ierr);
1826a7e14dcfSSatish Balay     reason = TAO_CONVERGED_STEPTOL;
1827a7e14dcfSSatish Balay   } else if (niter > tao->max_it) {
1828a7e14dcfSSatish Balay     ierr = PetscInfo2(tao,"Exceeded maximum number of iterations: %D > %D\n",niter,tao->max_it);CHKERRQ(ierr);
1829a7e14dcfSSatish Balay     reason = TAO_DIVERGED_MAXITS;
1830a7e14dcfSSatish Balay   } else {
1831a7e14dcfSSatish Balay     reason = TAO_CONTINUE_ITERATING;
1832a7e14dcfSSatish Balay   }
1833a7e14dcfSSatish Balay   tao->reason = reason;
1834a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1835a7e14dcfSSatish Balay }
1836a7e14dcfSSatish Balay 
1837a7e14dcfSSatish Balay #undef __FUNCT__
1838a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetOptionsPrefix"
1839a7e14dcfSSatish Balay /*@C
1840a7e14dcfSSatish Balay    TaoSetOptionsPrefix - Sets the prefix used for searching for all
1841a7e14dcfSSatish Balay    TAO options in the database.
1842a7e14dcfSSatish Balay 
1843a7e14dcfSSatish Balay 
1844441846f8SBarry Smith    Logically Collective on Tao
1845a7e14dcfSSatish Balay 
1846a7e14dcfSSatish Balay    Input Parameters:
1847441846f8SBarry Smith +  tao - the Tao context
1848a7e14dcfSSatish Balay -  prefix - the prefix string to prepend to all TAO option requests
1849a7e14dcfSSatish Balay 
1850a7e14dcfSSatish Balay    Notes:
1851a7e14dcfSSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
1852a7e14dcfSSatish Balay    The first character of all runtime options is AUTOMATICALLY the hyphen.
1853a7e14dcfSSatish Balay 
1854a7e14dcfSSatish Balay    For example, to distinguish between the runtime options for two
1855a7e14dcfSSatish Balay    different TAO solvers, one could call
1856a7e14dcfSSatish Balay .vb
1857a7e14dcfSSatish Balay       TaoSetOptionsPrefix(tao1,"sys1_")
1858a7e14dcfSSatish Balay       TaoSetOptionsPrefix(tao2,"sys2_")
1859a7e14dcfSSatish Balay .ve
1860a7e14dcfSSatish Balay 
1861a7e14dcfSSatish Balay    This would enable use of different options for each system, such as
1862a7e14dcfSSatish Balay .vb
1863a7e14dcfSSatish Balay       -sys1_tao_method blmvm -sys1_tao_gtol 1.e-3
1864a7e14dcfSSatish Balay       -sys2_tao_method lmvm  -sys2_tao_gtol 1.e-4
1865a7e14dcfSSatish Balay .ve
1866a7e14dcfSSatish Balay 
1867a7e14dcfSSatish Balay 
1868a7e14dcfSSatish Balay    Level: advanced
1869a7e14dcfSSatish Balay 
1870a7e14dcfSSatish Balay .seealso: TaoAppendOptionsPrefix(), TaoGetOptionsPrefix()
1871a7e14dcfSSatish Balay @*/
1872a7e14dcfSSatish Balay 
1873441846f8SBarry Smith PetscErrorCode TaoSetOptionsPrefix(Tao tao, const char p[])
1874a7e14dcfSSatish Balay {
1875a7e14dcfSSatish Balay   PetscErrorCode ierr;
187647a47007SBarry Smith 
1877a7e14dcfSSatish Balay   PetscFunctionBegin;
1878a7e14dcfSSatish Balay   ierr = PetscObjectSetOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr);
1879a7e14dcfSSatish Balay   if (tao->linesearch) {
1880a7e14dcfSSatish Balay     ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr);
1881a7e14dcfSSatish Balay   }
1882a7e14dcfSSatish Balay   if (tao->ksp) {
1883a7e14dcfSSatish Balay     ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr);
1884a7e14dcfSSatish Balay   }
1885a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1886a7e14dcfSSatish Balay }
1887a7e14dcfSSatish Balay 
1888a7e14dcfSSatish Balay #undef __FUNCT__
1889a7e14dcfSSatish Balay #define __FUNCT__ "TaoAppendOptionsPrefix"
1890a7e14dcfSSatish Balay /*@C
1891a7e14dcfSSatish Balay    TaoAppendOptionsPrefix - Appends to the prefix used for searching for all
1892a7e14dcfSSatish Balay    TAO options in the database.
1893a7e14dcfSSatish Balay 
1894a7e14dcfSSatish Balay 
1895441846f8SBarry Smith    Logically Collective on Tao
1896a7e14dcfSSatish Balay 
1897a7e14dcfSSatish Balay    Input Parameters:
1898441846f8SBarry Smith +  tao - the Tao solver context
1899a7e14dcfSSatish Balay -  prefix - the prefix string to prepend to all TAO option requests
1900a7e14dcfSSatish Balay 
1901a7e14dcfSSatish Balay    Notes:
1902a7e14dcfSSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
1903a7e14dcfSSatish Balay    The first character of all runtime options is AUTOMATICALLY the hyphen.
1904a7e14dcfSSatish Balay 
1905a7e14dcfSSatish Balay 
1906a7e14dcfSSatish Balay    Level: advanced
1907a7e14dcfSSatish Balay 
1908a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoGetOptionsPrefix()
1909a7e14dcfSSatish Balay @*/
1910441846f8SBarry Smith PetscErrorCode TaoAppendOptionsPrefix(Tao tao, const char p[])
1911a7e14dcfSSatish Balay {
1912a7e14dcfSSatish Balay   PetscErrorCode ierr;
191347a47007SBarry Smith 
1914a7e14dcfSSatish Balay   PetscFunctionBegin;
1915a7e14dcfSSatish Balay   ierr = PetscObjectAppendOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr);
1916a7e14dcfSSatish Balay   if (tao->linesearch) {
1917a7e14dcfSSatish Balay     ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr);
1918a7e14dcfSSatish Balay   }
1919a7e14dcfSSatish Balay   if (tao->ksp) {
1920a7e14dcfSSatish Balay     ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr);
1921a7e14dcfSSatish Balay   }
1922a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1923a7e14dcfSSatish Balay }
1924a7e14dcfSSatish Balay 
1925a7e14dcfSSatish Balay #undef __FUNCT__
1926a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetOptionsPrefix"
1927a7e14dcfSSatish Balay /*@C
1928a7e14dcfSSatish Balay   TaoGetOptionsPrefix - Gets the prefix used for searching for all
1929a7e14dcfSSatish Balay   TAO options in the database
1930a7e14dcfSSatish Balay 
1931a7e14dcfSSatish Balay   Not Collective
1932a7e14dcfSSatish Balay 
1933a7e14dcfSSatish Balay   Input Parameters:
1934441846f8SBarry Smith . tao - the Tao context
1935a7e14dcfSSatish Balay 
1936a7e14dcfSSatish Balay   Output Parameters:
1937a7e14dcfSSatish Balay . prefix - pointer to the prefix string used is returned
1938a7e14dcfSSatish Balay 
1939a7e14dcfSSatish Balay   Notes: On the fortran side, the user should pass in a string 'prefix' of
1940a7e14dcfSSatish Balay   sufficient length to hold the prefix.
1941a7e14dcfSSatish Balay 
1942a7e14dcfSSatish Balay   Level: advanced
1943a7e14dcfSSatish Balay 
1944a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoAppendOptionsPrefix()
1945a7e14dcfSSatish Balay @*/
1946441846f8SBarry Smith PetscErrorCode TaoGetOptionsPrefix(Tao tao, const char *p[])
1947a7e14dcfSSatish Balay {
194847a47007SBarry Smith    return PetscObjectGetOptionsPrefix((PetscObject)tao,p);
1949a7e14dcfSSatish Balay }
1950a7e14dcfSSatish Balay 
1951a7e14dcfSSatish Balay #undef __FUNCT__
1952a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetDefaultKSPType"
1953a7e14dcfSSatish Balay /*@
1954a7e14dcfSSatish Balay   TaoSetDefaultKSPType - Sets the default KSP type if a KSP object
1955a7e14dcfSSatish Balay   is created.
1956a7e14dcfSSatish Balay 
1957441846f8SBarry Smith   Logically Collective on Tao
1958a7e14dcfSSatish Balay 
1959a7e14dcfSSatish Balay   InputParameters:
1960441846f8SBarry Smith + tao - the Tao context
1961a7e14dcfSSatish Balay - ktype - the KSP type TAO will use by default
1962a7e14dcfSSatish Balay 
1963a7e14dcfSSatish Balay   Note: Some solvers may require a particular KSP type and will not work
1964a7e14dcfSSatish Balay   correctly if the default value is changed
1965a7e14dcfSSatish Balay 
1966a7e14dcfSSatish Balay   Options Database Key:
1967a7e14dcfSSatish Balay - tao_ksp_type
1968a7e14dcfSSatish Balay 
1969a7e14dcfSSatish Balay   Level: advanced
1970a7e14dcfSSatish Balay @*/
1971441846f8SBarry Smith PetscErrorCode TaoSetDefaultKSPType(Tao tao, KSPType ktype)
1972a7e14dcfSSatish Balay {
1973a7e14dcfSSatish Balay   const char     *prefix=0;
1974a7e14dcfSSatish Balay   char           *option=0;
1975a7e14dcfSSatish Balay   size_t         n1,n2;
1976a7e14dcfSSatish Balay   PetscErrorCode ierr;
1977a7e14dcfSSatish Balay 
197847a47007SBarry Smith   PetscFunctionBegin;
1979441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
1980a7e14dcfSSatish Balay   ierr = TaoGetOptionsPrefix(tao,&prefix);CHKERRQ(ierr);
1981a7e14dcfSSatish Balay   ierr = PetscStrlen(prefix,&n1);
1982a7e14dcfSSatish Balay   ierr = PetscStrlen("_ksp_type",&n2);
19830e660641SBarry Smith   ierr = PetscMalloc1(n1+n2+1,&option);
1984a7e14dcfSSatish Balay   ierr = PetscStrncpy(option,prefix,n1+1);
1985a7e14dcfSSatish Balay   ierr = PetscStrncat(option,"_ksp_type",n2+1);
1986a7e14dcfSSatish Balay   ierr = PetscOptionsSetValue(option,ktype);CHKERRQ(ierr);
1987a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1988a7e14dcfSSatish Balay }
1989a7e14dcfSSatish Balay 
1990a7e14dcfSSatish Balay #undef __FUNCT__
1991a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetDefaulLineSearchType"
1992a7e14dcfSSatish Balay /*@
1993a7e14dcfSSatish Balay   TaoSetDefaultLineSearchType - Sets the default LineSearch type if a LineSearch object
1994a7e14dcfSSatish Balay   is created.
1995a7e14dcfSSatish Balay 
1996441846f8SBarry Smith   Logically Collective on Tao
1997a7e14dcfSSatish Balay 
1998a7e14dcfSSatish Balay   InputParameters:
1999441846f8SBarry Smith + tao - the Tao context
2000a7e14dcfSSatish Balay - lstype - the line search type TAO will use by default
2001a7e14dcfSSatish Balay 
2002a7e14dcfSSatish Balay   Note: Some solvers may require a particular line search type and will not work
2003a7e14dcfSSatish Balay   correctly if the default value is changed
2004a7e14dcfSSatish Balay 
2005a7e14dcfSSatish Balay   Options Database Key:
2006a7e14dcfSSatish Balay - tao_ls_type
2007a7e14dcfSSatish Balay 
2008a7e14dcfSSatish Balay   Level: advanced
2009a7e14dcfSSatish Balay @*/
2010441846f8SBarry Smith PetscErrorCode TaoSetDefaultLineSearchType(Tao tao, TaoLineSearchType lstype)
2011a7e14dcfSSatish Balay {
2012a7e14dcfSSatish Balay   const char     *prefix=0;
2013a7e14dcfSSatish Balay   char           *option=0;
2014a7e14dcfSSatish Balay   size_t         n1,n2;
2015a7e14dcfSSatish Balay   PetscErrorCode ierr;
2016a7e14dcfSSatish Balay 
201747a47007SBarry Smith   PetscFunctionBegin;
2018441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2019a7e14dcfSSatish Balay   ierr = TaoGetOptionsPrefix(tao,&prefix);CHKERRQ(ierr);
2020a7e14dcfSSatish Balay   ierr = PetscStrlen(prefix,&n1);
2021a7e14dcfSSatish Balay   ierr = PetscStrlen("_ls_type",&n2);
20220e660641SBarry Smith   ierr = PetscMalloc1(n1+n2+1,&option);
2023a7e14dcfSSatish Balay   ierr = PetscStrncpy(option,prefix,n1+1);
2024a7e14dcfSSatish Balay   ierr = PetscStrncat(option,"_ls_type",n2+1);
2025a7e14dcfSSatish Balay   ierr = PetscOptionsSetValue(option,lstype);CHKERRQ(ierr);
2026a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2027a7e14dcfSSatish Balay }
2028a7e14dcfSSatish Balay 
2029a7e14dcfSSatish Balay #undef __FUNCT__
2030a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetDefaultPCType"
2031a7e14dcfSSatish Balay /*@
2032a7e14dcfSSatish Balay   TaoSetDefaultPCType - Sets the default PC type if a PC object
2033a7e14dcfSSatish Balay   is created.
2034a7e14dcfSSatish Balay 
2035441846f8SBarry Smith   Logically Collective on Tao
2036a7e14dcfSSatish Balay 
2037a7e14dcfSSatish Balay   InputParameters:
2038441846f8SBarry Smith + tao - the Tao context
2039a7e14dcfSSatish Balay - pctype - the preconditioner type TAO will use by default
2040a7e14dcfSSatish Balay 
2041a7e14dcfSSatish Balay   Note: Some solvers may require a particular PC type and will not work
2042a7e14dcfSSatish Balay   correctly if the default value is changed
2043a7e14dcfSSatish Balay 
2044a7e14dcfSSatish Balay   Options Database Key:
2045a7e14dcfSSatish Balay - tao_pc_type
2046a7e14dcfSSatish Balay 
2047a7e14dcfSSatish Balay   Level: advanced
2048a7e14dcfSSatish Balay @*/
2049441846f8SBarry Smith PetscErrorCode TaoSetDefaultPCType(Tao tao, PCType pctype)
2050a7e14dcfSSatish Balay {
2051a7e14dcfSSatish Balay   const char     *prefix=0;
2052a7e14dcfSSatish Balay   char           *option=0;
2053a7e14dcfSSatish Balay   size_t         n1,n2;
2054a7e14dcfSSatish Balay   PetscErrorCode ierr;
2055a7e14dcfSSatish Balay 
205647a47007SBarry Smith   PetscFunctionBegin;
2057441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2058a7e14dcfSSatish Balay   ierr = TaoGetOptionsPrefix(tao,&prefix);CHKERRQ(ierr);
2059a7e14dcfSSatish Balay   ierr = PetscStrlen(prefix,&n1);
2060a7e14dcfSSatish Balay   ierr = PetscStrlen("_pc_type",&n2);
20610e660641SBarry Smith   ierr = PetscMalloc1(n1+n2+1,&option);
2062a7e14dcfSSatish Balay   ierr = PetscStrncpy(option,prefix,n1+1);
2063a7e14dcfSSatish Balay   ierr = PetscStrncat(option,"_pc_type",n2+1);
2064a7e14dcfSSatish Balay   ierr = PetscOptionsSetValue(option,pctype);CHKERRQ(ierr);
2065a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2066a7e14dcfSSatish Balay }
2067a7e14dcfSSatish Balay 
2068a7e14dcfSSatish Balay #undef __FUNCT__
2069a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetType"
2070a7e14dcfSSatish Balay /*@C
2071a7e14dcfSSatish Balay    TaoSetType - Sets the method for the unconstrained minimization solver.
2072a7e14dcfSSatish Balay 
2073441846f8SBarry Smith    Collective on Tao
2074a7e14dcfSSatish Balay 
2075a7e14dcfSSatish Balay    Input Parameters:
2076441846f8SBarry Smith +  solver - the Tao solver context
2077a7e14dcfSSatish Balay -  type - a known method
2078a7e14dcfSSatish Balay 
2079a7e14dcfSSatish Balay    Options Database Key:
2080a7e14dcfSSatish Balay +  -tao_method <type> - Sets the method; use -help for a list
2081a7e14dcfSSatish Balay    of available methods (for instance, "-tao_method tao_lmvm" or
2082a7e14dcfSSatish Balay    "-tao_method tao_tron")
2083a7e14dcfSSatish Balay -  -tao_type <type> - identical to -tao_method
2084a7e14dcfSSatish Balay 
2085a7e14dcfSSatish Balay    Available methods include:
2086a7e14dcfSSatish Balay +    tao_nls - Newton's method with line search for unconstrained minimization
2087a7e14dcfSSatish Balay .    tao_ntr - Newton's method with trust region for unconstrained minimization
2088a7e14dcfSSatish Balay .    tao_ntl - Newton's method with trust region, line search for unconstrained minimization
2089a7e14dcfSSatish Balay .    tao_lmvm - Limited memory variable metric method for unconstrained minimization
2090a7e14dcfSSatish Balay .    tao_cg - Nonlinear conjugate gradient method for unconstrained minimization
2091a7e14dcfSSatish Balay .    tao_nm - Nelder-Mead algorithm for derivate-free unconstrained minimization
2092a7e14dcfSSatish Balay .    tao_tron - Newton Trust Region method for bound constrained minimization
2093a7e14dcfSSatish Balay .    tao_gpcg - Newton Trust Region method for quadratic bound constrained minimization
2094a7e14dcfSSatish Balay .    tao_blmvm - Limited memory variable metric method for bound constrained minimization
2095a7e14dcfSSatish Balay +    tao_pounders - Model-based algorithm pounder extended for nonlinear least squares
2096a7e14dcfSSatish Balay 
2097a7e14dcfSSatish Balay   Level: intermediate
2098a7e14dcfSSatish Balay 
2099a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoGetType()
2100a7e14dcfSSatish Balay 
2101a7e14dcfSSatish Balay @*/
2102441846f8SBarry Smith PetscErrorCode TaoSetType(Tao tao, const TaoType type)
2103a7e14dcfSSatish Balay {
2104a7e14dcfSSatish Balay     PetscErrorCode ierr;
2105441846f8SBarry Smith     PetscErrorCode (*create_xxx)(Tao);
2106a7e14dcfSSatish Balay     PetscBool      issame;
2107a7e14dcfSSatish Balay 
2108a7e14dcfSSatish Balay     PetscFunctionBegin;
2109441846f8SBarry Smith     PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2110a7e14dcfSSatish Balay 
2111a7e14dcfSSatish Balay     ierr = PetscObjectTypeCompare((PetscObject)tao,type,&issame);CHKERRQ(ierr);
2112a7e14dcfSSatish Balay     if (issame) PetscFunctionReturn(0);
2113a7e14dcfSSatish Balay 
2114441846f8SBarry Smith     ierr = PetscFunctionListFind(TaoList, type, (void(**)(void))&create_xxx);CHKERRQ(ierr);
2115441846f8SBarry Smith     if (!create_xxx) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested Tao type %s",type);
2116a7e14dcfSSatish Balay 
2117a7e14dcfSSatish Balay     /* Destroy the existing solver information */
2118a7e14dcfSSatish Balay     if (tao->ops->destroy) {
2119a7e14dcfSSatish Balay         ierr = (*tao->ops->destroy)(tao);CHKERRQ(ierr);
2120a7e14dcfSSatish Balay     }
2121a7e14dcfSSatish Balay     ierr = KSPDestroy(&tao->ksp);CHKERRQ(ierr);
2122a7e14dcfSSatish Balay     ierr = TaoLineSearchDestroy(&tao->linesearch);CHKERRQ(ierr);
2123a7e14dcfSSatish Balay     ierr = VecDestroy(&tao->gradient);CHKERRQ(ierr);
2124a7e14dcfSSatish Balay     ierr = VecDestroy(&tao->stepdirection);CHKERRQ(ierr);
2125a7e14dcfSSatish Balay 
2126a7e14dcfSSatish Balay     tao->ops->setup = 0;
2127a7e14dcfSSatish Balay     tao->ops->solve = 0;
2128a7e14dcfSSatish Balay     tao->ops->view  = 0;
2129a7e14dcfSSatish Balay     tao->ops->setfromoptions = 0;
2130a7e14dcfSSatish Balay     tao->ops->destroy = 0;
2131a7e14dcfSSatish Balay 
2132a7e14dcfSSatish Balay     tao->setupcalled = PETSC_FALSE;
2133a7e14dcfSSatish Balay 
2134a7e14dcfSSatish Balay     ierr = (*create_xxx)(tao);CHKERRQ(ierr);
2135a7e14dcfSSatish Balay     ierr = PetscObjectChangeTypeName((PetscObject)tao,type);CHKERRQ(ierr);
2136a7e14dcfSSatish Balay     PetscFunctionReturn(0);
2137a7e14dcfSSatish Balay }
213847a47007SBarry Smith 
2139a7e14dcfSSatish Balay #undef __FUNCT__
2140441846f8SBarry Smith #define __FUNCT__ "TaoRegister"
2141a7e14dcfSSatish Balay /*MC
2142441846f8SBarry Smith    TaoRegister - Adds a method to the TAO package for unconstrained minimization.
2143a7e14dcfSSatish Balay 
2144a7e14dcfSSatish Balay    Synopsis:
2145441846f8SBarry Smith    TaoRegister(char *name_solver,char *path,char *name_Create,int (*routine_Create)(Tao))
2146a7e14dcfSSatish Balay 
2147a7e14dcfSSatish Balay    Not collective
2148a7e14dcfSSatish Balay 
2149a7e14dcfSSatish Balay    Input Parameters:
2150a7e14dcfSSatish Balay +  sname - name of a new user-defined solver
2151a7e14dcfSSatish Balay -  func - routine to Create method context
2152a7e14dcfSSatish Balay 
2153a7e14dcfSSatish Balay    Notes:
2154441846f8SBarry Smith    TaoRegister() may be called multiple times to add several user-defined solvers.
2155a7e14dcfSSatish Balay 
2156a7e14dcfSSatish Balay    Sample usage:
2157a7e14dcfSSatish Balay .vb
2158441846f8SBarry Smith    TaoRegister("my_solver",MySolverCreate);
2159a7e14dcfSSatish Balay .ve
2160a7e14dcfSSatish Balay 
2161a7e14dcfSSatish Balay    Then, your solver can be chosen with the procedural interface via
2162a7e14dcfSSatish Balay $     TaoSetType(tao,"my_solver")
2163a7e14dcfSSatish Balay    or at runtime via the option
2164a7e14dcfSSatish Balay $     -tao_method my_solver
2165a7e14dcfSSatish Balay 
2166a7e14dcfSSatish Balay    Level: advanced
2167a7e14dcfSSatish Balay 
2168441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegisterDestroy()
2169a7e14dcfSSatish Balay M*/
2170441846f8SBarry Smith PetscErrorCode TaoRegister(const char sname[], PetscErrorCode (*func)(Tao))
2171a7e14dcfSSatish Balay {
2172a7e14dcfSSatish Balay   PetscErrorCode ierr;
2173a7e14dcfSSatish Balay 
2174a7e14dcfSSatish Balay   PetscFunctionBegin;
2175441846f8SBarry Smith   ierr = PetscFunctionListAdd(&TaoList,sname, (void (*)(void))func);CHKERRQ(ierr);
2176a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2177a7e14dcfSSatish Balay }
2178a7e14dcfSSatish Balay 
2179a7e14dcfSSatish Balay #undef __FUNCT__
2180441846f8SBarry Smith #define __FUNCT__ "TaoRegisterDestroy"
2181a7e14dcfSSatish Balay /*@C
2182441846f8SBarry Smith    TaoRegisterDestroy - Frees the list of minimization solvers that were
2183441846f8SBarry Smith    registered by TaoRegisterDynamic().
2184a7e14dcfSSatish Balay 
2185a7e14dcfSSatish Balay    Not Collective
2186a7e14dcfSSatish Balay 
2187a7e14dcfSSatish Balay    Level: advanced
2188a7e14dcfSSatish Balay 
2189441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegister()
2190a7e14dcfSSatish Balay @*/
2191441846f8SBarry Smith PetscErrorCode TaoRegisterDestroy(void)
2192a7e14dcfSSatish Balay {
2193a7e14dcfSSatish Balay   PetscErrorCode ierr;
2194a7e14dcfSSatish Balay   PetscFunctionBegin;
2195441846f8SBarry Smith   ierr = PetscFunctionListDestroy(&TaoList);CHKERRQ(ierr);
2196441846f8SBarry Smith   TaoRegisterAllCalled = PETSC_FALSE;
2197a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2198a7e14dcfSSatish Balay }
219947a47007SBarry Smith 
2200a7e14dcfSSatish Balay #undef __FUNCT__
2201a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetTerminationReason"
2202a7e14dcfSSatish Balay /*@
2203441846f8SBarry Smith   TaoSetTerminationReason - Sets the termination flag on a Tao object
2204a7e14dcfSSatish Balay 
2205441846f8SBarry Smith   Logically Collective on Tao
2206a7e14dcfSSatish Balay 
2207a7e14dcfSSatish Balay   Input Parameters:
2208441846f8SBarry Smith + tao - the Tao context
2209a7e14dcfSSatish Balay - reason - one of
2210a7e14dcfSSatish Balay $     TAO_CONVERGED_ATOL (2),
2211a7e14dcfSSatish Balay $     TAO_CONVERGED_RTOL (3),
2212a7e14dcfSSatish Balay $     TAO_CONVERGED_STEPTOL (4),
2213a7e14dcfSSatish Balay $     TAO_CONVERGED_MINF (5),
2214a7e14dcfSSatish Balay $     TAO_CONVERGED_USER (6),
2215a7e14dcfSSatish Balay $     TAO_DIVERGED_MAXITS (-2),
2216a7e14dcfSSatish Balay $     TAO_DIVERGED_NAN (-4),
2217a7e14dcfSSatish Balay $     TAO_DIVERGED_MAXFCN (-5),
2218a7e14dcfSSatish Balay $     TAO_DIVERGED_LS_FAILURE (-6),
2219a7e14dcfSSatish Balay $     TAO_DIVERGED_TR_REDUCTION (-7),
2220a7e14dcfSSatish Balay $     TAO_DIVERGED_USER (-8),
2221a7e14dcfSSatish Balay $     TAO_CONTINUE_ITERATING (0)
2222a7e14dcfSSatish Balay 
2223a7e14dcfSSatish Balay    Level: intermediate
2224a7e14dcfSSatish Balay 
2225a7e14dcfSSatish Balay @*/
2226441846f8SBarry Smith PetscErrorCode TaoSetTerminationReason(Tao tao, TaoTerminationReason reason)
2227a7e14dcfSSatish Balay {
2228441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2229a7e14dcfSSatish Balay   PetscFunctionBegin;
2230a7e14dcfSSatish Balay   tao->reason = reason;
2231a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2232a7e14dcfSSatish Balay }
2233a7e14dcfSSatish Balay 
2234a7e14dcfSSatish Balay #undef __FUNCT__
2235a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetTerminationReason"
2236a7e14dcfSSatish Balay /*@
2237441846f8SBarry Smith    TaoGetTerminationReason - Gets the reason the Tao iteration was stopped.
2238a7e14dcfSSatish Balay 
2239a7e14dcfSSatish Balay    Not Collective
2240a7e14dcfSSatish Balay 
2241a7e14dcfSSatish Balay    Input Parameter:
2242441846f8SBarry Smith .  tao - the Tao solver context
2243a7e14dcfSSatish Balay 
2244a7e14dcfSSatish Balay    Output Parameter:
2245a7e14dcfSSatish Balay .  reason - one of
2246a7e14dcfSSatish Balay 
2247a7e14dcfSSatish Balay 
2248a7e14dcfSSatish Balay $  TAO_CONVERGED_FATOL (1)           f(X)-f(X*) <= fatol
2249a7e14dcfSSatish Balay $  TAO_CONVERGED_FRTOL (2)           |f(X) - f(X*)|/|f(X)| < frtol
2250a7e14dcfSSatish Balay $  TAO_CONVERGED_GATOL (3)           ||g(X)|| < gatol
2251a7e14dcfSSatish Balay $  TAO_CONVERGED_GRTOL (4)           ||g(X)|| / f(X)  < grtol
2252a7e14dcfSSatish Balay $  TAO_CONVERGED_GTTOL (5)           ||g(X)|| / ||g(X0)|| < gttol
2253a7e14dcfSSatish Balay $  TAO_CONVERGED_STEPTOL (6)         step size small
2254a7e14dcfSSatish Balay $  TAO_CONVERGED_MINF (7)            F < F_min
2255a7e14dcfSSatish Balay $  TAO_CONVERGED_USER (8)            User defined
2256a7e14dcfSSatish Balay 
2257a7e14dcfSSatish Balay $  TAO_DIVERGED_MAXITS (-2)          its > maxits
2258a7e14dcfSSatish Balay $  TAO_DIVERGED_NAN (-4)             Numerical problems
2259a7e14dcfSSatish Balay $  TAO_DIVERGED_MAXFCN (-5)          fevals > max_funcsals
2260a7e14dcfSSatish Balay $  TAO_DIVERGED_LS_FAILURE (-6)      line search failure
2261a7e14dcfSSatish Balay $  TAO_DIVERGED_TR_REDUCTION (-7)    trust region failure
2262a7e14dcfSSatish Balay $  TAO_DIVERGED_USER(-8)             (user defined)
2263a7e14dcfSSatish Balay 
2264a7e14dcfSSatish Balay $  TAO_CONTINUE_ITERATING (0)
2265a7e14dcfSSatish Balay 
2266a7e14dcfSSatish Balay    where
2267a7e14dcfSSatish Balay +  X - current solution
2268a7e14dcfSSatish Balay .  X0 - initial guess
2269a7e14dcfSSatish Balay .  f(X) - current function value
2270a7e14dcfSSatish Balay .  f(X*) - true solution (estimated)
2271a7e14dcfSSatish Balay .  g(X) - current gradient
2272a7e14dcfSSatish Balay .  its - current iterate number
2273a7e14dcfSSatish Balay .  maxits - maximum number of iterates
2274a7e14dcfSSatish Balay .  fevals - number of function evaluations
2275a7e14dcfSSatish Balay -  max_funcsals - maximum number of function evaluations
2276a7e14dcfSSatish Balay 
2277a7e14dcfSSatish Balay    Level: intermediate
2278a7e14dcfSSatish Balay 
2279a7e14dcfSSatish Balay .seealso: TaoSetConvergenceTest(), TaoSetTolerances()
2280a7e14dcfSSatish Balay 
2281a7e14dcfSSatish Balay @*/
2282441846f8SBarry Smith PetscErrorCode TaoGetTerminationReason(Tao tao, TaoTerminationReason *reason)
2283a7e14dcfSSatish Balay {
2284a7e14dcfSSatish Balay   PetscFunctionBegin;
2285441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2286a7e14dcfSSatish Balay   PetscValidPointer(reason,2);
2287a7e14dcfSSatish Balay   *reason = tao->reason;
2288a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2289a7e14dcfSSatish Balay }
2290a7e14dcfSSatish Balay 
2291a7e14dcfSSatish Balay #undef __FUNCT__
2292a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetSolutionStatus"
2293a7e14dcfSSatish Balay /*@
2294a7e14dcfSSatish Balay   TaoGetSolutionStatus - Get the current iterate, objective value,
2295a7e14dcfSSatish Balay   residual, infeasibility, and termination
2296a7e14dcfSSatish Balay 
2297a7e14dcfSSatish Balay   Not Collective
2298a7e14dcfSSatish Balay 
2299a7e14dcfSSatish Balay    Input Parameters:
2300441846f8SBarry Smith .  tao - the Tao context
2301a7e14dcfSSatish Balay 
2302a7e14dcfSSatish Balay    Output Parameters:
2303a7e14dcfSSatish Balay +  iterate - the current iterate number (>=0)
2304a7e14dcfSSatish Balay .  f - the current function value
2305a7e14dcfSSatish Balay .  gnorm - the square of the gradient norm, duality gap, or other measure
2306a7e14dcfSSatish Balay indicating distance from optimality.
2307a7e14dcfSSatish Balay .  cnorm - the infeasibility of the current solution with regard to the constraints.
2308a7e14dcfSSatish Balay .  xdiff - the step length or trust region radius of the most recent iterate.
2309a7e14dcfSSatish Balay -  reason - The termination reason, which can equal TAO_CONTINUE_ITERATING
2310a7e14dcfSSatish Balay 
2311a7e14dcfSSatish Balay    Level: intermediate
2312a7e14dcfSSatish Balay 
2313a7e14dcfSSatish Balay    Note:
2314a7e14dcfSSatish Balay    TAO returns the values set by the solvers in the routine TaoMonitor().
2315a7e14dcfSSatish Balay 
2316a7e14dcfSSatish Balay    Note:
231747a47007SBarry Smith    If any of the output arguments are set to NULL, no corresponding value will be returned.
2318a7e14dcfSSatish Balay 
2319a7e14dcfSSatish Balay 
2320a7e14dcfSSatish Balay .seealso: TaoMonitor(), TaoGetTerminationReason()
2321a7e14dcfSSatish Balay @*/
2322441846f8SBarry Smith PetscErrorCode TaoGetSolutionStatus(Tao tao, PetscInt *its, PetscReal *f, PetscReal *gnorm, PetscReal *cnorm, PetscReal *xdiff, TaoTerminationReason *reason)
2323a7e14dcfSSatish Balay {
2324a7e14dcfSSatish Balay   PetscFunctionBegin;
2325a7e14dcfSSatish Balay   if (its) *its=tao->niter;
2326a7e14dcfSSatish Balay   if (f) *f=tao->fc;
2327a7e14dcfSSatish Balay   if (gnorm) *gnorm=tao->residual;
2328a7e14dcfSSatish Balay   if (cnorm) *cnorm=tao->cnorm;
2329a7e14dcfSSatish Balay   if (reason) *reason=tao->reason;
2330a7e14dcfSSatish Balay   if (xdiff) *xdiff=tao->step;
2331a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2332a7e14dcfSSatish Balay }
2333a7e14dcfSSatish Balay 
2334a7e14dcfSSatish Balay 
2335a7e14dcfSSatish Balay #undef __FUNCT__
2336a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetType"
2337a7e14dcfSSatish Balay /*@C
2338441846f8SBarry Smith    TaoGetType - Gets the current Tao algorithm.
2339a7e14dcfSSatish Balay 
2340a7e14dcfSSatish Balay    Not Collective
2341a7e14dcfSSatish Balay 
2342a7e14dcfSSatish Balay    Input Parameter:
2343441846f8SBarry Smith .  tao - the Tao solver context
2344a7e14dcfSSatish Balay 
2345a7e14dcfSSatish Balay    Output Parameter:
2346441846f8SBarry Smith .  type - Tao method
2347a7e14dcfSSatish Balay 
2348a7e14dcfSSatish Balay    Level: intermediate
2349a7e14dcfSSatish Balay 
2350a7e14dcfSSatish Balay @*/
2351441846f8SBarry Smith PetscErrorCode TaoGetType(Tao tao, const TaoType *type)
2352a7e14dcfSSatish Balay {
2353a7e14dcfSSatish Balay   PetscFunctionBegin;
2354441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2355a7e14dcfSSatish Balay   PetscValidPointer(type,2);
2356a7e14dcfSSatish Balay   *type=((PetscObject)tao)->type_name;
2357a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2358a7e14dcfSSatish Balay }
2359a7e14dcfSSatish Balay 
2360a7e14dcfSSatish Balay #undef __FUNCT__
2361a7e14dcfSSatish Balay #define __FUNCT__ "TaoMonitor"
2362a7e14dcfSSatish Balay /*@C
2363a7e14dcfSSatish Balay   TaoMonitor - Monitor the solver and the current solution.  This
2364a7e14dcfSSatish Balay   routine will record the iteration number and residual statistics,
2365a7e14dcfSSatish Balay   call any monitors specified by the user, and calls the convergence-check routine.
2366a7e14dcfSSatish Balay 
2367a7e14dcfSSatish Balay    Input Parameters:
2368441846f8SBarry Smith +  tao - the Tao context
2369a7e14dcfSSatish Balay .  its - the current iterate number (>=0)
2370a7e14dcfSSatish Balay .  f - the current objective function value
2371a7e14dcfSSatish Balay .  res - the gradient norm, square root of the duality gap, or other measure
2372a7e14dcfSSatish Balay indicating distince from optimality.  This measure will be recorded and
2373a7e14dcfSSatish Balay used for some termination tests.
2374a7e14dcfSSatish Balay .  cnorm - the infeasibility of the current solution with regard to the constraints.
2375a7e14dcfSSatish Balay -  steplength - multiple of the step direction added to the previous iterate.
2376a7e14dcfSSatish Balay 
2377a7e14dcfSSatish Balay    Output Parameters:
2378a7e14dcfSSatish Balay .  reason - The termination reason, which can equal TAO_CONTINUE_ITERATING
2379a7e14dcfSSatish Balay 
2380a7e14dcfSSatish Balay    Options Database Key:
2381a7e14dcfSSatish Balay .  -tao_monitor - Use the default monitor, which prints statistics to standard output
2382a7e14dcfSSatish Balay 
2383a7e14dcfSSatish Balay .seealso TaoGetTerminationReason(), TaoDefaultMonitor(), TaoSetMonitor()
2384a7e14dcfSSatish Balay 
2385a7e14dcfSSatish Balay    Level: developer
2386a7e14dcfSSatish Balay 
2387a7e14dcfSSatish Balay @*/
2388441846f8SBarry Smith PetscErrorCode TaoMonitor(Tao tao, PetscInt its, PetscReal f, PetscReal res, PetscReal cnorm, PetscReal steplength, TaoTerminationReason *reason)
2389a7e14dcfSSatish Balay {
2390a7e14dcfSSatish Balay   PetscErrorCode ierr;
239147a47007SBarry Smith   PetscInt       i;
239247a47007SBarry Smith 
2393a7e14dcfSSatish Balay   PetscFunctionBegin;
2394441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2395a7e14dcfSSatish Balay   tao->fc = f;
2396a7e14dcfSSatish Balay   tao->residual = res;
2397a7e14dcfSSatish Balay   tao->cnorm = cnorm;
2398a7e14dcfSSatish Balay   tao->step = steplength;
2399a7e14dcfSSatish Balay   tao->niter=its;
2400a7e14dcfSSatish Balay   if (its == 0) {
2401a7e14dcfSSatish Balay     tao->cnorm0 = cnorm; tao->gnorm0 = res;
2402a7e14dcfSSatish Balay   }
2403a7e14dcfSSatish Balay   TaoLogHistory(tao,f,res,cnorm);
240447a47007SBarry Smith   if (PetscIsInfOrNanReal(f) || PetscIsInfOrNanReal(res)) SETERRQ(PETSC_COMM_SELF,1, "User provided compute function generated Inf or NaN");
2405a7e14dcfSSatish Balay   if (tao->ops->convergencetest) {
2406a7e14dcfSSatish Balay     ierr = (*tao->ops->convergencetest)(tao,tao->cnvP);CHKERRQ(ierr);
2407a7e14dcfSSatish Balay   }
2408a7e14dcfSSatish Balay   for (i=0;i<tao->numbermonitors;i++) {
2409a7e14dcfSSatish Balay     ierr = (*tao->monitor[i])(tao,tao->monitorcontext[i]);CHKERRQ(ierr);
2410a7e14dcfSSatish Balay   }
2411a7e14dcfSSatish Balay   *reason = tao->reason;
2412a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2413a7e14dcfSSatish Balay }
2414a7e14dcfSSatish Balay 
2415a7e14dcfSSatish Balay #undef __FUNCT__
2416a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetHistory"
2417a7e14dcfSSatish Balay /*@
2418a7e14dcfSSatish Balay    TaoSetHistory - Sets the array used to hold the convergence history.
2419a7e14dcfSSatish Balay 
2420441846f8SBarry Smith    Logically Collective on Tao
2421a7e14dcfSSatish Balay 
2422a7e14dcfSSatish Balay    Input Parameters:
2423441846f8SBarry Smith +  tao - the Tao solver context
2424a7e14dcfSSatish Balay .  obj   - array to hold objective value history
2425a7e14dcfSSatish Balay .  resid - array to hold residual history
2426a7e14dcfSSatish Balay .  cnorm - array to hold constraint violation history
2427a7e14dcfSSatish Balay .  na  - size of obj, resid, and cnorm
2428a7e14dcfSSatish Balay -  reset - PetscTrue indicates each new minimization resets the history counter to zero,
2429a7e14dcfSSatish Balay            else it continues storing new values for new minimizations after the old ones
2430a7e14dcfSSatish Balay 
2431a7e14dcfSSatish Balay    Notes:
2432a7e14dcfSSatish Balay    If set, TAO will fill the given arrays with the indicated
2433a7e14dcfSSatish Balay    information at each iteration.  If no information is desired
243447a47007SBarry Smith    for a given array, then NULL may be used.
2435a7e14dcfSSatish Balay 
2436a7e14dcfSSatish Balay    This routine is useful, e.g., when running a code for purposes
2437a7e14dcfSSatish Balay    of accurate performance monitoring, when no I/O should be done
2438a7e14dcfSSatish Balay    during the section of code that is being timed.
2439a7e14dcfSSatish Balay 
2440a7e14dcfSSatish Balay    Level: intermediate
2441a7e14dcfSSatish Balay 
2442a7e14dcfSSatish Balay .seealso: TaoGetHistory()
2443a7e14dcfSSatish Balay 
2444a7e14dcfSSatish Balay @*/
2445441846f8SBarry Smith PetscErrorCode TaoSetHistory(Tao tao, PetscReal *obj, PetscReal *resid, PetscReal *cnorm, PetscInt na,PetscBool reset)
2446a7e14dcfSSatish Balay {
2447a7e14dcfSSatish Balay   PetscFunctionBegin;
2448441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2449a7e14dcfSSatish Balay   tao->hist_obj = obj;
2450a7e14dcfSSatish Balay   tao->hist_resid = resid;
2451a7e14dcfSSatish Balay   tao->hist_cnorm = cnorm;
2452a7e14dcfSSatish Balay   tao->hist_max   = na;
2453a7e14dcfSSatish Balay   tao->hist_reset = reset;
2454a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2455a7e14dcfSSatish Balay }
2456a7e14dcfSSatish Balay 
2457a7e14dcfSSatish Balay #undef __FUNCT__
2458a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetHistory"
2459a7e14dcfSSatish Balay /*@C
2460a7e14dcfSSatish Balay    TaoGetHistory - Gets the array used to hold the convergence history.
2461a7e14dcfSSatish Balay 
2462441846f8SBarry Smith    Collective on Tao
2463a7e14dcfSSatish Balay 
2464a7e14dcfSSatish Balay    Input Parameter:
2465441846f8SBarry Smith .  tao - the Tao context
2466a7e14dcfSSatish Balay 
2467a7e14dcfSSatish Balay    Output Parameters:
2468a7e14dcfSSatish Balay +  obj   - array used to hold objective value history
2469a7e14dcfSSatish Balay .  resid - array used to hold residual history
2470a7e14dcfSSatish Balay .  cnorm - array used to hold constraint violation history
2471a7e14dcfSSatish Balay -  nhist  - size of obj, resid, and cnorm (will be less than or equal to na given in TaoSetHistory)
2472a7e14dcfSSatish Balay 
2473a7e14dcfSSatish Balay 
2474a7e14dcfSSatish Balay    Notes:
2475a7e14dcfSSatish Balay     The calling sequence for this routine in Fortran is
2476441846f8SBarry Smith $   call TaoGetHistory(Tao tao, integer nhist, integer info)
2477a7e14dcfSSatish Balay 
2478a7e14dcfSSatish Balay    This routine is useful, e.g., when running a code for purposes
2479a7e14dcfSSatish Balay    of accurate performance monitoring, when no I/O should be done
2480a7e14dcfSSatish Balay    during the section of code that is being timed.
2481a7e14dcfSSatish Balay 
2482a7e14dcfSSatish Balay    Level: advanced
2483a7e14dcfSSatish Balay 
2484a7e14dcfSSatish Balay .seealso: TaoSetHistory()
2485a7e14dcfSSatish Balay 
2486a7e14dcfSSatish Balay @*/
2487441846f8SBarry Smith PetscErrorCode TaoGetHistory(Tao tao, PetscReal **obj, PetscReal **resid, PetscReal **cnorm, PetscInt *nhist)
2488a7e14dcfSSatish Balay {
2489a7e14dcfSSatish Balay   PetscFunctionBegin;
2490441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2491a7e14dcfSSatish Balay   if (obj)   *obj   = tao->hist_obj;
2492a7e14dcfSSatish Balay   if (cnorm) *cnorm = tao->hist_cnorm;
2493a7e14dcfSSatish Balay   if (resid) *resid = tao->hist_resid;
2494a7e14dcfSSatish Balay   if (nhist) *nhist   = tao->hist_len;
2495a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2496a7e14dcfSSatish Balay }
2497a7e14dcfSSatish Balay 
2498a7e14dcfSSatish Balay #undef __FUNCT__
2499a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetApplicationContext"
2500a7e14dcfSSatish Balay /*@
2501a7e14dcfSSatish Balay    TaoSetApplicationContext - Sets the optional user-defined context for
2502a7e14dcfSSatish Balay    a solver.
2503a7e14dcfSSatish Balay 
2504441846f8SBarry Smith    Logically Collective on Tao
2505a7e14dcfSSatish Balay 
2506a7e14dcfSSatish Balay    Input Parameters:
2507441846f8SBarry Smith +  tao  - the Tao context
2508a7e14dcfSSatish Balay -  usrP - optional user context
2509a7e14dcfSSatish Balay 
2510a7e14dcfSSatish Balay    Level: intermediate
2511a7e14dcfSSatish Balay 
2512a7e14dcfSSatish Balay .seealso: TaoGetApplicationContext(), TaoSetApplicationContext()
2513a7e14dcfSSatish Balay @*/
2514441846f8SBarry Smith PetscErrorCode  TaoSetApplicationContext(Tao tao,void *usrP)
2515a7e14dcfSSatish Balay {
2516a7e14dcfSSatish Balay   PetscFunctionBegin;
2517441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2518a7e14dcfSSatish Balay   tao->user = usrP;
2519a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2520a7e14dcfSSatish Balay }
2521a7e14dcfSSatish Balay 
2522a7e14dcfSSatish Balay #undef __FUNCT__
2523a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetApplicationContext"
2524a7e14dcfSSatish Balay /*@
2525a7e14dcfSSatish Balay    TaoGetApplicationContext - Gets the user-defined context for a
2526a7e14dcfSSatish Balay    TAO solvers.
2527a7e14dcfSSatish Balay 
2528a7e14dcfSSatish Balay    Not Collective
2529a7e14dcfSSatish Balay 
2530a7e14dcfSSatish Balay    Input Parameter:
2531441846f8SBarry Smith .  tao  - Tao context
2532a7e14dcfSSatish Balay 
2533a7e14dcfSSatish Balay    Output Parameter:
2534a7e14dcfSSatish Balay .  usrP - user context
2535a7e14dcfSSatish Balay 
2536a7e14dcfSSatish Balay    Level: intermediate
2537a7e14dcfSSatish Balay 
2538a7e14dcfSSatish Balay .seealso: TaoSetApplicationContext()
2539a7e14dcfSSatish Balay @*/
2540441846f8SBarry Smith PetscErrorCode  TaoGetApplicationContext(Tao tao,void *usrP)
2541a7e14dcfSSatish Balay {
2542a7e14dcfSSatish Balay   PetscFunctionBegin;
2543441846f8SBarry Smith   PetscValidHeaderSpecific(tao,TAO_CLASSID,1);
2544a7e14dcfSSatish Balay   *(void**)usrP = tao->user;
2545a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2546a7e14dcfSSatish Balay }
2547