xref: /petsc/src/tao/interface/taosolver.c (revision 0e6606419405417ae11ca0744afbced7b5e3372a)
1a7e14dcfSSatish Balay #define TAOSOLVER_DLL
2a7e14dcfSSatish Balay 
3a7e14dcfSSatish Balay #include "tao-private/taosolver_impl.h" /*I "taosolver.h" I*/
4a7e14dcfSSatish Balay 
5a7e14dcfSSatish Balay PetscBool TaoSolverRegisterAllCalled = PETSC_FALSE;
647a47007SBarry Smith PetscFunctionList TaoSolverList = NULL;
7a7e14dcfSSatish Balay 
8a7e14dcfSSatish Balay PetscClassId TAOSOLVER_CLASSID;
9a7e14dcfSSatish Balay PetscLogEvent TaoSolver_Solve, TaoSolver_ObjectiveEval, TaoSolver_GradientEval, TaoSolver_ObjGradientEval, TaoSolver_HessianEval, TaoSolver_ConstraintsEval, TaoSolver_JacobianEval;
10a7e14dcfSSatish Balay 
11a7e14dcfSSatish Balay 
12a7e14dcfSSatish Balay 
13a7e14dcfSSatish Balay static const char *TAO_SUBSET[64] = {
14a7e14dcfSSatish Balay   "subvec","mask","matrixfree"
15a7e14dcfSSatish Balay };
16a7e14dcfSSatish Balay 
17a7e14dcfSSatish Balay #undef __FUNCT__
18a7e14dcfSSatish Balay #define __FUNCT__ "TaoCreate"
19a7e14dcfSSatish Balay /*@
20a7e14dcfSSatish Balay   TaoCreate - Creates a TAO solver
21a7e14dcfSSatish Balay 
22a7e14dcfSSatish Balay   Collective on MPI_Comm
23a7e14dcfSSatish Balay 
24a7e14dcfSSatish Balay   Input Parameter:
25a7e14dcfSSatish Balay . comm - MPI communicator
26a7e14dcfSSatish Balay 
27a7e14dcfSSatish Balay   Output Parameter:
28a7e14dcfSSatish Balay . newtao - the new TaoSolver context
29a7e14dcfSSatish Balay 
30a7e14dcfSSatish Balay   Available methods include:
31a7e14dcfSSatish Balay +    tao_nls - Newton's method with line search for unconstrained minimization
32a7e14dcfSSatish Balay .    tao_ntr - Newton's method with trust region for unconstrained minimization
33a7e14dcfSSatish Balay .    tao_ntl - Newton's method with trust region, line search for unconstrained minimization
34a7e14dcfSSatish Balay .    tao_lmvm - Limited memory variable metric method for unconstrained minimization
35a7e14dcfSSatish Balay .    tao_cg - Nonlinear conjugate gradient method for unconstrained minimization
36a7e14dcfSSatish Balay .    tao_nm - Nelder-Mead algorithm for derivate-free unconstrained minimization
37a7e14dcfSSatish Balay .    tao_tron - Newton Trust Region method for bound constrained minimization
38a7e14dcfSSatish Balay .    tao_gpcg - Newton Trust Region method for quadratic bound constrained minimization
39a7e14dcfSSatish Balay .    tao_blmvm - Limited memory variable metric method for bound constrained minimization
40a7e14dcfSSatish Balay .    tao_lcl - Linearly constrained Lagrangian method for pde-constrained minimization
41a7e14dcfSSatish Balay -    tao_pounders - Model-based algorithm for nonlinear least squares
42a7e14dcfSSatish Balay 
43a7e14dcfSSatish Balay    Options Database Keys:
44a7e14dcfSSatish Balay +   -tao_method - select which method TAO should use
45a7e14dcfSSatish Balay -   -tao_type - identical to -tao_method
46a7e14dcfSSatish Balay 
47a7e14dcfSSatish Balay    Level: beginner
48a7e14dcfSSatish Balay 
49a7e14dcfSSatish Balay .seealso: TaoSolve(), TaoDestroy()
50a7e14dcfSSatish Balay @*/
51a7e14dcfSSatish Balay PetscErrorCode TaoCreate(MPI_Comm comm, TaoSolver *newtao)
52a7e14dcfSSatish Balay {
53a7e14dcfSSatish Balay   PetscErrorCode ierr;
54a7e14dcfSSatish Balay   TaoSolver      tao;
55a7e14dcfSSatish Balay 
56a7e14dcfSSatish Balay   PetscFunctionBegin;
57a7e14dcfSSatish Balay   PetscValidPointer(newtao,2);
5847a47007SBarry Smith   *newtao = NULL;
59a7e14dcfSSatish Balay 
60a7e14dcfSSatish Balay   ierr = TaoInitializePackage();CHKERRQ(ierr);
61a7e14dcfSSatish Balay   ierr = TaoLineSearchInitializePackage();CHKERRQ(ierr);
62a7e14dcfSSatish Balay 
63a7e14dcfSSatish Balay   ierr = PetscHeaderCreate(tao,_p_TaoSolver, struct _TaoSolverOps, TAOSOLVER_CLASSID,"TaoSolver",0,0,comm,TaoDestroy,TaoView);CHKERRQ(ierr);
64a7e14dcfSSatish Balay   tao->ops->computeobjective=0;
65a7e14dcfSSatish Balay   tao->ops->computeobjectiveandgradient=0;
66a7e14dcfSSatish Balay   tao->ops->computegradient=0;
67a7e14dcfSSatish Balay   tao->ops->computehessian=0;
68a7e14dcfSSatish Balay   tao->ops->computeseparableobjective=0;
69a7e14dcfSSatish Balay   tao->ops->computeconstraints=0;
70a7e14dcfSSatish Balay   tao->ops->computejacobian=0;
71a7e14dcfSSatish Balay   tao->ops->computejacobianequality=0;
72a7e14dcfSSatish Balay   tao->ops->computejacobianinequality=0;
73a7e14dcfSSatish Balay   tao->ops->computeequalityconstraints=0;
74a7e14dcfSSatish Balay   tao->ops->computeinequalityconstraints=0;
75a7e14dcfSSatish Balay   tao->ops->convergencetest=TaoDefaultConvergenceTest;
76a7e14dcfSSatish Balay   tao->ops->convergencedestroy=0;
77a7e14dcfSSatish Balay   tao->ops->computedual=0;
78a7e14dcfSSatish Balay   tao->ops->setup=0;
79a7e14dcfSSatish Balay   tao->ops->solve=0;
80a7e14dcfSSatish Balay   tao->ops->view=0;
81a7e14dcfSSatish Balay   tao->ops->setfromoptions=0;
82a7e14dcfSSatish Balay   tao->ops->destroy=0;
83a7e14dcfSSatish Balay 
8447a47007SBarry Smith   tao->solution=NULL;
8547a47007SBarry Smith   tao->gradient=NULL;
8647a47007SBarry Smith   tao->sep_objective = NULL;
8747a47007SBarry Smith   tao->constraints=NULL;
8847a47007SBarry Smith   tao->constraints_equality=NULL;
8947a47007SBarry Smith   tao->constraints_inequality=NULL;
9047a47007SBarry Smith   tao->stepdirection=NULL;
9147a47007SBarry Smith   tao->XL = NULL;
9247a47007SBarry Smith   tao->XU = NULL;
9347a47007SBarry Smith   tao->IL = NULL;
9447a47007SBarry Smith   tao->IU = NULL;
9547a47007SBarry Smith   tao->DI = NULL;
9647a47007SBarry Smith   tao->DE = NULL;
9747a47007SBarry Smith   tao->hessian = NULL;
9847a47007SBarry Smith   tao->hessian_pre = NULL;
9947a47007SBarry Smith   tao->jacobian = NULL;
10047a47007SBarry Smith   tao->jacobian_pre = NULL;
10147a47007SBarry Smith   tao->jacobian_state = NULL;
10247a47007SBarry Smith   tao->jacobian_state_pre = NULL;
10347a47007SBarry Smith   tao->jacobian_state_inv = NULL;
10447a47007SBarry Smith   tao->jacobian_design = NULL;
10547a47007SBarry Smith   tao->jacobian_design_pre = NULL;
10647a47007SBarry Smith   tao->jacobian_equality = NULL;
10747a47007SBarry Smith   tao->jacobian_equality_pre = NULL;
10847a47007SBarry Smith   tao->jacobian_inequality = NULL;
10947a47007SBarry Smith   tao->jacobian_inequality_pre = NULL;
11047a47007SBarry Smith   tao->state_is = NULL;
11147a47007SBarry Smith   tao->design_is = NULL;
112a7e14dcfSSatish Balay 
113a7e14dcfSSatish Balay   tao->max_it     = 10000;
114a7e14dcfSSatish Balay   tao->max_funcs   = 10000;
115a7e14dcfSSatish Balay   tao->fatol       = 1e-8;
116a7e14dcfSSatish Balay   tao->frtol       = 1e-8;
117a7e14dcfSSatish Balay   tao->gatol       = 1e-8;
118a7e14dcfSSatish Balay   tao->grtol       = 1e-8;
119a7e14dcfSSatish Balay   tao->gttol       = 0.0;
120a7e14dcfSSatish Balay   tao->catol       = 0.0;
121a7e14dcfSSatish Balay   tao->crtol       = 0.0;
122a7e14dcfSSatish Balay   tao->xtol        = 0.0;
123a7e14dcfSSatish Balay   tao->steptol       = 0.0;
124a7e14dcfSSatish Balay   tao->trust0      = TAO_INFINITY;
125a7e14dcfSSatish Balay   tao->fmin        = -1e100;
126a7e14dcfSSatish Balay   tao->hist_reset = PETSC_TRUE;
127a7e14dcfSSatish Balay   tao->hist_max = 0;
128a7e14dcfSSatish Balay   tao->hist_len = 0;
12947a47007SBarry Smith   tao->hist_obj = NULL;
13047a47007SBarry Smith   tao->hist_resid = NULL;
13147a47007SBarry Smith   tao->hist_cnorm = NULL;
132a7e14dcfSSatish Balay 
133a7e14dcfSSatish Balay   tao->numbermonitors=0;
134a7e14dcfSSatish Balay   tao->viewsolution=PETSC_FALSE;
135a7e14dcfSSatish Balay   tao->viewhessian=PETSC_FALSE;
136a7e14dcfSSatish Balay   tao->viewgradient=PETSC_FALSE;
137a7e14dcfSSatish Balay   tao->viewjacobian=PETSC_FALSE;
138a7e14dcfSSatish Balay   tao->viewconstraints = PETSC_FALSE;
139a7e14dcfSSatish Balay   tao->viewtao = PETSC_FALSE;
140a7e14dcfSSatish Balay 
141a7e14dcfSSatish Balay   ierr = TaoResetStatistics(tao);CHKERRQ(ierr);
142a7e14dcfSSatish Balay   *newtao = tao;
143a7e14dcfSSatish Balay   PetscFunctionReturn(0);
144a7e14dcfSSatish Balay }
145a7e14dcfSSatish Balay 
146a7e14dcfSSatish Balay #undef __FUNCT__
147a7e14dcfSSatish Balay #define __FUNCT__ "TaoSolve"
148a7e14dcfSSatish Balay /*@
149a7e14dcfSSatish Balay   TaoSolve - Solves an optimization problem min F(x) s.t. l <= x <= u
150a7e14dcfSSatish Balay 
151a7e14dcfSSatish Balay   Collective on TaoSolver
152a7e14dcfSSatish Balay 
153a7e14dcfSSatish Balay   Input Parameters:
154a7e14dcfSSatish Balay . tao - the TaoSolver context
155a7e14dcfSSatish Balay 
156a7e14dcfSSatish Balay   Notes:
157a7e14dcfSSatish Balay   The user must set up the TaoSolver with calls to TaoSetInitialVector(),
158a7e14dcfSSatish Balay   TaoSetObjectiveRoutine(),
159a7e14dcfSSatish Balay   TaoSetGradientRoutine(), and (if using 2nd order method) TaoSetHessianRoutine().
160a7e14dcfSSatish Balay 
161a7e14dcfSSatish Balay   Level: beginner
162a7e14dcfSSatish Balay 
163a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSetObjectiveRoutine(), TaoSetGradientRoutine(), TaoSetHessianRoutine()
164a7e14dcfSSatish Balay  @*/
165a7e14dcfSSatish Balay PetscErrorCode TaoSolve(TaoSolver tao)
166a7e14dcfSSatish Balay {
167a7e14dcfSSatish Balay   PetscErrorCode ierr;
168a7e14dcfSSatish Balay   char           filename[PETSC_MAX_PATH_LEN];
169a7e14dcfSSatish Balay   PetscBool      flg;
170a7e14dcfSSatish Balay   PetscViewer    viewer;
17147a47007SBarry Smith 
172a7e14dcfSSatish Balay   PetscFunctionBegin;
173a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
174a7e14dcfSSatish Balay   ierr = TaoSetUp(tao);CHKERRQ(ierr);
175a7e14dcfSSatish Balay   ierr = TaoResetStatistics(tao);CHKERRQ(ierr);
176a7e14dcfSSatish Balay   if (tao->linesearch) {
177a7e14dcfSSatish Balay     ierr = TaoLineSearchReset(tao->linesearch);CHKERRQ(ierr);
178a7e14dcfSSatish Balay   }
179a7e14dcfSSatish Balay 
180a7e14dcfSSatish Balay   ierr = PetscLogEventBegin(TaoSolver_Solve,tao,0,0,0);CHKERRQ(ierr);
181a7e14dcfSSatish Balay   if (tao->ops->solve){ ierr = (*tao->ops->solve)(tao);CHKERRQ(ierr); }
182a7e14dcfSSatish Balay   ierr = PetscLogEventEnd(TaoSolver_Solve,tao,0,0,0);CHKERRQ(ierr);
183a7e14dcfSSatish Balay 
184a7e14dcfSSatish Balay   ierr = PetscOptionsGetString(((PetscObject)tao)->prefix,"-tao_view",filename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
185a7e14dcfSSatish Balay   if (flg && !PetscPreLoadingOn) {
186a7e14dcfSSatish Balay     ierr = PetscViewerASCIIOpen(((PetscObject)tao)->comm,filename,&viewer);CHKERRQ(ierr);
187a7e14dcfSSatish Balay     ierr = TaoView(tao,viewer);CHKERRQ(ierr);
188a7e14dcfSSatish Balay     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
189a7e14dcfSSatish Balay   }
190a7e14dcfSSatish Balay 
191a7e14dcfSSatish Balay   if (tao->printreason) {
192a7e14dcfSSatish Balay       if (tao->reason > 0) {
193a7e14dcfSSatish Balay           ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve converged due to %s\n",TaoSolverTerminationReasons[tao->reason]);CHKERRQ(ierr);
194a7e14dcfSSatish Balay       } else {
195a7e14dcfSSatish Balay           ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve did not converge due to %s\n",TaoSolverTerminationReasons[tao->reason]);CHKERRQ(ierr);
196a7e14dcfSSatish Balay       }
197a7e14dcfSSatish Balay   }
198a7e14dcfSSatish Balay   PetscFunctionReturn(0);
199a7e14dcfSSatish Balay }
200a7e14dcfSSatish Balay 
201a7e14dcfSSatish Balay 
202a7e14dcfSSatish Balay #undef __FUNCT__
203a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetUp"
204a7e14dcfSSatish Balay /*@
205a7e14dcfSSatish Balay   TaoSetUp - Sets up the internal data structures for the later use
206a7e14dcfSSatish Balay   of a Tao solver
207a7e14dcfSSatish Balay 
208a7e14dcfSSatish Balay   Collective on tao
209a7e14dcfSSatish Balay 
210a7e14dcfSSatish Balay   Input Parameters:
211a7e14dcfSSatish Balay . tao - the TAO context
212a7e14dcfSSatish Balay 
213a7e14dcfSSatish Balay   Notes:
214a7e14dcfSSatish Balay   The user will not need to explicitly call TaoSetUp(), as it will
215a7e14dcfSSatish Balay   automatically be called in TaoSolve().  However, if the user
216a7e14dcfSSatish Balay   desires to call it explicitly, it should come after TaoCreate()
217a7e14dcfSSatish Balay   and any TaoSetSomething() routines, but before TaoSolve().
218a7e14dcfSSatish Balay 
219a7e14dcfSSatish Balay   Level: advanced
220a7e14dcfSSatish Balay 
221a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
222a7e14dcfSSatish Balay @*/
223a7e14dcfSSatish Balay PetscErrorCode TaoSetUp(TaoSolver tao)
224a7e14dcfSSatish Balay {
225a7e14dcfSSatish Balay   PetscErrorCode ierr;
22647a47007SBarry Smith 
227a7e14dcfSSatish Balay   PetscFunctionBegin;
228a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao, TAOSOLVER_CLASSID,1);
229a7e14dcfSSatish Balay   if (tao->setupcalled) PetscFunctionReturn(0);
230a7e14dcfSSatish Balay 
23147a47007SBarry Smith   if (!tao->solution) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TaoSetInitialVector");
232a7e14dcfSSatish Balay   if (tao->ops->setup) {
233a7e14dcfSSatish Balay     ierr = (*tao->ops->setup)(tao);CHKERRQ(ierr);
234a7e14dcfSSatish Balay   }
235a7e14dcfSSatish Balay   tao->setupcalled = PETSC_TRUE;
236a7e14dcfSSatish Balay   PetscFunctionReturn(0);
237a7e14dcfSSatish Balay }
238a7e14dcfSSatish Balay 
239a7e14dcfSSatish Balay #undef __FUNCT__
240a7e14dcfSSatish Balay #define __FUNCT__ "TaoDestroy"
241a7e14dcfSSatish Balay /*@
242a7e14dcfSSatish Balay   TaoDestroy - Destroys the TAO context that was created with
243a7e14dcfSSatish Balay   TaoCreate()
244a7e14dcfSSatish Balay 
245a7e14dcfSSatish Balay   Collective on TaoSolver
246a7e14dcfSSatish Balay 
247a7e14dcfSSatish Balay   Input Parameter:
248a7e14dcfSSatish Balay . tao - the TaoSolver context
249a7e14dcfSSatish Balay 
250a7e14dcfSSatish Balay   Level: beginner
251a7e14dcfSSatish Balay 
252a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
253a7e14dcfSSatish Balay @*/
254a7e14dcfSSatish Balay PetscErrorCode TaoDestroy(TaoSolver *tao)
255a7e14dcfSSatish Balay {
256a7e14dcfSSatish Balay   PetscErrorCode ierr;
25747a47007SBarry Smith 
258a7e14dcfSSatish Balay   PetscFunctionBegin;
259a7e14dcfSSatish Balay   if (!*tao) PetscFunctionReturn(0);
260a7e14dcfSSatish Balay   PetscValidHeaderSpecific(*tao,TAOSOLVER_CLASSID,1);
261a7e14dcfSSatish Balay   if (--((PetscObject)*tao)->refct > 0) {*tao=0;PetscFunctionReturn(0);}
262a7e14dcfSSatish Balay 
263a7e14dcfSSatish Balay   if ((*tao)->ops->destroy) {
264a7e14dcfSSatish Balay     ierr = (*((*tao))->ops->destroy)(*tao);CHKERRQ(ierr);
265a7e14dcfSSatish Balay   }
266a7e14dcfSSatish Balay   ierr = KSPDestroy(&(*tao)->ksp);CHKERRQ(ierr);
267a7e14dcfSSatish Balay   ierr = TaoLineSearchDestroy(&(*tao)->linesearch);CHKERRQ(ierr);
268a7e14dcfSSatish Balay 
269a7e14dcfSSatish Balay   if ((*tao)->ops->convergencedestroy) {
270a7e14dcfSSatish Balay     ierr = (*(*tao)->ops->convergencedestroy)((*tao)->cnvP);CHKERRQ(ierr);
271a7e14dcfSSatish Balay     if ((*tao)->jacobian_state_inv) {
272a7e14dcfSSatish Balay       ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr);
273a7e14dcfSSatish Balay     }
274a7e14dcfSSatish Balay   }
275a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->solution);CHKERRQ(ierr);
276a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->gradient);CHKERRQ(ierr);
277a7e14dcfSSatish Balay 
278a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->XL);CHKERRQ(ierr);
279a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->XU);CHKERRQ(ierr);
280a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->IL);CHKERRQ(ierr);
281a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->IU);CHKERRQ(ierr);
282a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->DE);CHKERRQ(ierr);
283a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->DI);CHKERRQ(ierr);
284a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->constraints_equality);CHKERRQ(ierr);
285a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->constraints_inequality);CHKERRQ(ierr);
286a7e14dcfSSatish Balay   ierr = VecDestroy(&(*tao)->stepdirection);CHKERRQ(ierr);
287a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->hessian_pre);CHKERRQ(ierr);
288a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->hessian);CHKERRQ(ierr);
289a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_pre);CHKERRQ(ierr);
290a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian);CHKERRQ(ierr);
291a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state_pre);CHKERRQ(ierr);
292a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state);CHKERRQ(ierr);
293a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr);
294067f330cSJason Sarich   ierr = MatDestroy(&(*tao)->jacobian_design);CHKERRQ(ierr);
295a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_equality);CHKERRQ(ierr);
296a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_equality_pre);CHKERRQ(ierr);
297a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_inequality);CHKERRQ(ierr);
298a7e14dcfSSatish Balay   ierr = MatDestroy(&(*tao)->jacobian_inequality_pre);CHKERRQ(ierr);
299a7e14dcfSSatish Balay   ierr = ISDestroy(&(*tao)->state_is);CHKERRQ(ierr);
300a7e14dcfSSatish Balay   ierr = ISDestroy(&(*tao)->design_is);CHKERRQ(ierr);
301a7e14dcfSSatish Balay   ierr = TaoCancelMonitors(*tao);CHKERRQ(ierr);
302a7e14dcfSSatish Balay   ierr = PetscHeaderDestroy(tao);CHKERRQ(ierr);
303a7e14dcfSSatish Balay   PetscFunctionReturn(0);
304a7e14dcfSSatish Balay }
305a7e14dcfSSatish Balay 
306a7e14dcfSSatish Balay #undef __FUNCT__
307a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetFromOptions"
308a7e14dcfSSatish Balay /*@
309a7e14dcfSSatish Balay   TaoSetFromOptions - Sets various TaoSolver parameters from user
310a7e14dcfSSatish Balay   options.
311a7e14dcfSSatish Balay 
312a7e14dcfSSatish Balay   Collective on TaoSolver
313a7e14dcfSSatish Balay 
314a7e14dcfSSatish Balay   Input Paremeter:
315a7e14dcfSSatish Balay . tao - the TaoSolver solver context
316a7e14dcfSSatish Balay 
317a7e14dcfSSatish Balay   options Database Keys:
318a7e14dcfSSatish Balay + -tao_method <type> - The algorithm that TAO uses (tao_lmvm, tao_nls, etc.)
319a7e14dcfSSatish Balay . -tao_fatol <fatol> - absolute error tolerance in function value
320a7e14dcfSSatish Balay . -tao_frtol <frtol> - relative error tolerance in function value
321a7e14dcfSSatish Balay . -tao_gatol <gatol> - absolute error tolerance for ||gradient||
322a7e14dcfSSatish Balay . -tao_grtol <grtol> - relative error tolerance for ||gradient||
323a7e14dcfSSatish Balay . -tao_gttol <gttol> - reduction of ||gradient|| relative to initial gradient
324a7e14dcfSSatish Balay . -tao_max_it <max> - sets maximum number of iterations
325a7e14dcfSSatish Balay . -tao_max_funcs <max> - sets maximum number of function evaluations
326a7e14dcfSSatish Balay . -tao_fmin <fmin> - stop if function value reaches fmin
327a7e14dcfSSatish Balay . -tao_steptol <tol> - stop if trust region radius less than <tol>
328a7e14dcfSSatish Balay . -tao_trust0 <t> - initial trust region radius
329a7e14dcfSSatish Balay . -tao_monitor - prints function value and residual at each iteration
330a7e14dcfSSatish Balay . -tao_smonitor - same as tao_monitor, but truncates very small values
331a7e14dcfSSatish Balay . -tao_cmonitor - prints function value, residual, and constraint norm at each iteration
332a7e14dcfSSatish Balay . -tao_view_solution - prints solution vector at each iteration
333a7e14dcfSSatish Balay . -tao_view_separableobjective - prints separable objective vector at each iteration
334a7e14dcfSSatish Balay . -tao_view_step - prints step direction vector at each iteration
335a7e14dcfSSatish Balay . -tao_view_gradient - prints gradient vector at each iteration
336a7e14dcfSSatish Balay . -tao_draw_solution - graphically view solution vector at each iteration
337a7e14dcfSSatish Balay . -tao_draw_step - graphically view step vector at each iteration
338a7e14dcfSSatish Balay . -tao_draw_gradient - graphically view gradient at each iteration
339a7e14dcfSSatish Balay . -tao_fd_gradient - use gradient computed with finite differences
340a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors (except those set with command line)
341a7e14dcfSSatish Balay . -tao_view - prints information about the TaoSolver after solving
342a7e14dcfSSatish Balay - -tao_converged_reason - prints the reason TAO stopped iterating
343a7e14dcfSSatish Balay 
344a7e14dcfSSatish Balay   Notes:
345a7e14dcfSSatish Balay   To see all options, run your program with the -help option or consult the
346a7e14dcfSSatish Balay   user's manual. Should be called after TaoCreate() but before TaoSolve()
347a7e14dcfSSatish Balay 
348a7e14dcfSSatish Balay   Level: beginner
349a7e14dcfSSatish Balay @*/
350a7e14dcfSSatish Balay PetscErrorCode TaoSetFromOptions(TaoSolver tao)
351a7e14dcfSSatish Balay {
352a7e14dcfSSatish Balay   PetscErrorCode      ierr;
353a7e14dcfSSatish Balay   const TaoSolverType default_type = "tao_lmvm";
354a7e14dcfSSatish Balay   const char          *prefix;
355a7e14dcfSSatish Balay   char                type[256], monfilename[PETSC_MAX_PATH_LEN];
356a7e14dcfSSatish Balay   PetscViewer         monviewer;
357a7e14dcfSSatish Balay   PetscBool           flg;
358a7e14dcfSSatish Balay   MPI_Comm            comm;
359a7e14dcfSSatish Balay 
360a7e14dcfSSatish Balay   PetscFunctionBegin;
361a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
362a7e14dcfSSatish Balay   ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
363a7e14dcfSSatish Balay   ierr = TaoGetOptionsPrefix(tao,&prefix);
364a7e14dcfSSatish Balay   /* So no warnings are given about unused options */
365a7e14dcfSSatish Balay   ierr = PetscOptionsHasName(prefix,"-tao_ksp_type",&flg);
366a7e14dcfSSatish Balay   ierr = PetscOptionsHasName(prefix,"-tao_pc_type",&flg);
367a7e14dcfSSatish Balay   ierr = PetscOptionsHasName(prefix,"-tao_ls_type",&flg);
368a7e14dcfSSatish Balay 
369a7e14dcfSSatish Balay   ierr = PetscObjectOptionsBegin((PetscObject)tao);CHKERRQ(ierr);
370a7e14dcfSSatish Balay   {
371a7e14dcfSSatish Balay     if (!TaoSolverRegisterAllCalled) {
372a7e14dcfSSatish Balay       ierr = TaoSolverRegisterAll();CHKERRQ(ierr);
373a7e14dcfSSatish Balay     }
374a7e14dcfSSatish Balay     if (((PetscObject)tao)->type_name) {
375a7e14dcfSSatish Balay       default_type = ((PetscObject)tao)->type_name;
376a7e14dcfSSatish Balay     }
377a7e14dcfSSatish Balay     /* Check for type from options */
3787a3a6978SSatish Balay     ierr = PetscOptionsFList("-tao_type","Tao Solver type","TaoSetType",TaoSolverList,default_type,type,256,&flg);CHKERRQ(ierr);
379a7e14dcfSSatish Balay     if (flg) {
380a7e14dcfSSatish Balay       ierr = TaoSetType(tao,type);CHKERRQ(ierr);
381a7e14dcfSSatish Balay     } else {
3827a3a6978SSatish Balay       ierr = PetscOptionsFList("-tao_method","Tao Solver type","TaoSetType",TaoSolverList,default_type,type,256,&flg);CHKERRQ(ierr);
383a7e14dcfSSatish Balay       if (flg) {
384a7e14dcfSSatish Balay         ierr = TaoSetType(tao,type);CHKERRQ(ierr);
385a7e14dcfSSatish Balay       } else if (!((PetscObject)tao)->type_name) {
386a7e14dcfSSatish Balay         ierr = TaoSetType(tao,default_type);
387a7e14dcfSSatish Balay       }
388a7e14dcfSSatish Balay     }
389a7e14dcfSSatish Balay 
390a7e14dcfSSatish Balay     ierr = PetscOptionsBool("-tao_view","view TaoSolver info after each minimization has completed","TaoView",PETSC_FALSE,&tao->viewtao,&flg);CHKERRQ(ierr);
391a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_fatol","Stop if solution within","TaoSetTolerances",tao->fatol,&tao->fatol,&flg);CHKERRQ(ierr);
392a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_frtol","Stop if relative solution within","TaoSetTolerances",tao->frtol,&tao->frtol,&flg);CHKERRQ(ierr);
393a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_catol","Stop if constraints violations within","TaoSetConstraintTolerances",tao->catol,&tao->catol,&flg);CHKERRQ(ierr);
394a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_crtol","Stop if relative contraint violations within","TaoSetConstraintTolerances",tao->crtol,&tao->crtol,&flg);CHKERRQ(ierr);
395a7e14dcfSSatish Balay     ierr = PetscOptionsReal("-tao_gatol","Stop if norm of gradient less than","TaoSetTolerances",tao->gatol,&tao->gatol,&flg);CHKERRQ(ierr);
396a7e14dcfSSatish 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);
397a7e14dcfSSatish 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);
398a7e14dcfSSatish Balay     ierr = PetscOptionsInt("-tao_max_it","Stop if iteration number exceeds",
399a7e14dcfSSatish Balay                            "TaoSetMaximumIterations",tao->max_it,&tao->max_it,
400a7e14dcfSSatish Balay                            &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     }
474a7e14dcfSSatish Balay     ierr = PetscOptionsEList("-tao_subset_type","subset type", "", TAO_SUBSET, TAO_SUBSET_TYPES,TAO_SUBSET[tao->subset_type], &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
487a7e14dcfSSatish Balay   TaoView - Prints information about the TaoSolver
488a7e14dcfSSatish Balay 
489a7e14dcfSSatish Balay   Collective on TaoSolver
490a7e14dcfSSatish Balay 
491a7e14dcfSSatish Balay   InputParameters:
492a7e14dcfSSatish Balay + tao - the TaoSolver 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 @*/
510a7e14dcfSSatish Balay PetscErrorCode TaoView(TaoSolver tao, PetscViewer viewer)
511a7e14dcfSSatish Balay {
512a7e14dcfSSatish Balay   PetscErrorCode      ierr;
513a7e14dcfSSatish Balay   PetscBool           isascii,isstring;
514a7e14dcfSSatish Balay   const TaoSolverType type;
51547a47007SBarry Smith 
516a7e14dcfSSatish Balay   PetscFunctionBegin;
517a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_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) {
543a7e14dcfSSatish Balay       ierr = PetscViewerASCIIPrintf(viewer,"Active Set subset type: %s\n",TAO_SUBSET[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 
671a7e14dcfSSatish Balay   Logically collective on TaoSolver
672a7e14dcfSSatish Balay 
673a7e14dcfSSatish Balay   Input Parameters:
674a7e14dcfSSatish Balay + tao - the TaoSolver 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 @*/
703a7e14dcfSSatish Balay PetscErrorCode TaoSetTolerances(TaoSolver tao, PetscReal fatol, PetscReal frtol, PetscReal gatol, PetscReal grtol, PetscReal gttol)
704a7e14dcfSSatish Balay {
705a7e14dcfSSatish Balay   PetscErrorCode ierr;
70647a47007SBarry Smith 
707a7e14dcfSSatish Balay   PetscFunctionBegin;
708a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_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 
757a7e14dcfSSatish Balay   Logically collective on TaoSolver
758a7e14dcfSSatish Balay 
759a7e14dcfSSatish Balay   Input Parameters:
760a7e14dcfSSatish Balay + tao - the TaoSolver 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 @*/
773a7e14dcfSSatish Balay PetscErrorCode TaoSetConstraintTolerances(TaoSolver tao, PetscReal catol, PetscReal crtol)
774a7e14dcfSSatish Balay {
775a7e14dcfSSatish Balay   PetscErrorCode ierr;
77647a47007SBarry Smith 
777a7e14dcfSSatish Balay   PetscFunctionBegin;
778a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_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 
805a7e14dcfSSatish Balay    Logically Collective on TaoSolver
806a7e14dcfSSatish Balay 
807a7e14dcfSSatish Balay    Input Parameters:
808a7e14dcfSSatish Balay +  tao - the TaoSolver 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 @*/
818a7e14dcfSSatish Balay PetscErrorCode TaoSetFunctionLowerBound(TaoSolver tao,PetscReal fmin)
819a7e14dcfSSatish Balay {
820a7e14dcfSSatish Balay   PetscFunctionBegin;
821a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_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 
833a7e14dcfSSatish Balay    Not collective on TaoSolver
834a7e14dcfSSatish Balay 
835a7e14dcfSSatish Balay    Input Parameters:
836a7e14dcfSSatish Balay .  tao - the TaoSolver 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 @*/
845a7e14dcfSSatish Balay PetscErrorCode TaoGetFunctionLowerBound(TaoSolver tao,PetscReal *fmin)
846a7e14dcfSSatish Balay {
847a7e14dcfSSatish Balay   PetscFunctionBegin;
848a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_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 
859a7e14dcfSSatish Balay    Logically Collective on TaoSolver
860a7e14dcfSSatish Balay 
861a7e14dcfSSatish Balay    Input Parameters:
862a7e14dcfSSatish Balay +  tao - the TaoSolver 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 
873a7e14dcfSSatish Balay PetscErrorCode TaoSetMaximumFunctionEvaluations(TaoSolver tao,PetscInt nfcn)
874a7e14dcfSSatish Balay {
875a7e14dcfSSatish Balay   PetscFunctionBegin;
876a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_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:
890a7e14dcfSSatish Balay .  tao - the TaoSolver 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 
900a7e14dcfSSatish Balay PetscErrorCode TaoGetMaximumFunctionEvaluations(TaoSolver tao,PetscInt *nfcn)
901a7e14dcfSSatish Balay {
902a7e14dcfSSatish Balay   PetscFunctionBegin;
903a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_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 
913a7e14dcfSSatish Balay    Logically Collective on TaoSolver
914a7e14dcfSSatish Balay 
915a7e14dcfSSatish Balay    Input Parameters:
916a7e14dcfSSatish Balay +  tao - the TaoSolver 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 @*/
926a7e14dcfSSatish Balay PetscErrorCode TaoSetMaximumIterations(TaoSolver tao,PetscInt maxits)
927a7e14dcfSSatish Balay {
928a7e14dcfSSatish Balay   PetscFunctionBegin;
929a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_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:
942a7e14dcfSSatish Balay .  tao - the TaoSolver 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 @*/
951a7e14dcfSSatish Balay PetscErrorCode TaoGetMaximumIterations(TaoSolver tao,PetscInt *maxits)
952a7e14dcfSSatish Balay {
953a7e14dcfSSatish Balay   PetscFunctionBegin;
954a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_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 
964a7e14dcfSSatish Balay    Logically collective on TaoSolver
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 @*/
977a7e14dcfSSatish Balay PetscErrorCode TaoSetInitialTrustRegionRadius(TaoSolver tao, PetscReal radius)
978a7e14dcfSSatish Balay {
979a7e14dcfSSatish Balay   PetscFunctionBegin;
980a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_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 @*/
1002a7e14dcfSSatish Balay PetscErrorCode TaoGetInitialTrustRegionRadius(TaoSolver tao, PetscReal *radius)
1003a7e14dcfSSatish Balay {
1004a7e14dcfSSatish Balay   PetscFunctionBegin;
1005a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_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 @*/
1027a7e14dcfSSatish Balay PetscErrorCode TaoGetCurrentTrustRegionRadius(TaoSolver tao, PetscReal *radius)
1028a7e14dcfSSatish Balay {
1029a7e14dcfSSatish Balay   PetscFunctionBegin;
1030a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_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:
1043a7e14dcfSSatish Balay . tao - the TaoSolver 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 @*/
1058a7e14dcfSSatish Balay PetscErrorCode TaoGetTolerances(TaoSolver tao, PetscReal *fatol, PetscReal *frtol, PetscReal *gatol, PetscReal *grtol, PetscReal *gttol)
1059a7e14dcfSSatish Balay {
1060a7e14dcfSSatish Balay   PetscFunctionBegin;
1061a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_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 
1071a7e14dcfSSatish Balay #undef __FUNCT__
1072a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetKSP"
1073a7e14dcfSSatish Balay /*@
1074a7e14dcfSSatish Balay   TaoGetKSP - Gets the linear solver used by the optimization solver.
1075a7e14dcfSSatish Balay   Application writers should use TaoGetKSP if they need direct access
1076a7e14dcfSSatish Balay   to the PETSc KSP object.
1077a7e14dcfSSatish Balay 
1078a7e14dcfSSatish Balay   Not Collective
1079a7e14dcfSSatish Balay 
1080a7e14dcfSSatish Balay    Input Parameters:
1081a7e14dcfSSatish Balay .  tao - the TAO solver
1082a7e14dcfSSatish Balay 
1083a7e14dcfSSatish Balay    Output Parameters:
1084a7e14dcfSSatish Balay .  ksp - the KSP linear solver used in the optimization solver
1085a7e14dcfSSatish Balay 
1086a7e14dcfSSatish Balay    Level: intermediate
1087a7e14dcfSSatish Balay 
1088a7e14dcfSSatish Balay @*/
108947a47007SBarry Smith PetscErrorCode TaoGetKSP(TaoSolver tao, KSP *ksp)
109047a47007SBarry Smith {
1091a7e14dcfSSatish Balay   PetscFunctionBegin;
1092a7e14dcfSSatish Balay   *ksp = tao->ksp;
1093a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1094a7e14dcfSSatish Balay }
1095a7e14dcfSSatish Balay 
1096a7e14dcfSSatish Balay #undef __FUNCT__
1097a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetLineSearch"
1098a7e14dcfSSatish Balay /*@
1099a7e14dcfSSatish Balay   TaoGetLineSearch - Gets the line search used by the optimization solver.
1100a7e14dcfSSatish Balay   Application writers should use TaoGetLineSearch if they need direct access
1101a7e14dcfSSatish Balay   to the TaoLineSearch object.
1102a7e14dcfSSatish Balay 
1103a7e14dcfSSatish Balay   Not Collective
1104a7e14dcfSSatish Balay 
1105a7e14dcfSSatish Balay    Input Parameters:
1106a7e14dcfSSatish Balay .  tao - the TAO solver
1107a7e14dcfSSatish Balay 
1108a7e14dcfSSatish Balay    Output Parameters:
1109a7e14dcfSSatish Balay .  ls - the line search used in the optimization solver
1110a7e14dcfSSatish Balay 
1111a7e14dcfSSatish Balay    Level: intermediate
1112a7e14dcfSSatish Balay 
1113a7e14dcfSSatish Balay @*/
111447a47007SBarry Smith PetscErrorCode TaoGetLineSearch(TaoSolver tao, TaoLineSearch *ls)
111547a47007SBarry Smith {
1116a7e14dcfSSatish Balay   PetscFunctionBegin;
1117a7e14dcfSSatish Balay   *ls = tao->linesearch;
1118a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1119a7e14dcfSSatish Balay }
1120a7e14dcfSSatish Balay 
1121a7e14dcfSSatish Balay #undef __FUNCT__
1122a7e14dcfSSatish Balay #define __FUNCT__ "TaoAddLineSearchCounts"
1123a7e14dcfSSatish Balay /*@
1124a7e14dcfSSatish Balay   TaoAddLineSearchCounts - Adds the number of function evaluations spent
1125a7e14dcfSSatish Balay   in the line search to the running total.
1126a7e14dcfSSatish Balay 
1127a7e14dcfSSatish Balay    Input Parameters:
1128a7e14dcfSSatish Balay +  tao - the TAO solver
1129a7e14dcfSSatish Balay -  ls - the line search used in the optimization solver
1130a7e14dcfSSatish Balay 
1131a7e14dcfSSatish Balay    Level: developer
1132a7e14dcfSSatish Balay 
1133a7e14dcfSSatish Balay .seealso: TaoLineSearchApply()
1134a7e14dcfSSatish Balay @*/
113547a47007SBarry Smith PetscErrorCode TaoAddLineSearchCounts(TaoSolver tao)
113647a47007SBarry Smith {
1137a7e14dcfSSatish Balay   PetscErrorCode ierr;
1138a7e14dcfSSatish Balay   PetscBool      flg;
1139a7e14dcfSSatish Balay   PetscInt       nfeval,ngeval,nfgeval;
114047a47007SBarry Smith 
1141a7e14dcfSSatish Balay   PetscFunctionBegin;
1142a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
1143a7e14dcfSSatish Balay   if (tao->linesearch) {
1144a7e14dcfSSatish Balay     ierr = TaoLineSearchIsUsingTaoSolverRoutines(tao->linesearch,&flg);
1145a7e14dcfSSatish Balay     if (flg == PETSC_FALSE) {
114647a47007SBarry Smith       ierr = TaoLineSearchGetNumberFunctionEvaluations(tao->linesearch,&nfeval,&ngeval,&nfgeval);CHKERRQ(ierr);
1147a7e14dcfSSatish Balay       tao->nfuncs+=nfeval;
1148a7e14dcfSSatish Balay       tao->ngrads+=ngeval;
1149a7e14dcfSSatish Balay       tao->nfuncgrads+=nfgeval;
1150a7e14dcfSSatish Balay     }
1151a7e14dcfSSatish Balay   }
1152a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1153a7e14dcfSSatish Balay }
1154a7e14dcfSSatish Balay 
1155a7e14dcfSSatish Balay 
1156a7e14dcfSSatish Balay #undef __FUNCT__
1157a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetSolutionVector"
1158a7e14dcfSSatish Balay /*@
1159a7e14dcfSSatish Balay   TaoGetSolutionVector - Returns the vector with the current TAO solution
1160a7e14dcfSSatish Balay 
1161a7e14dcfSSatish Balay   Not Collective
1162a7e14dcfSSatish Balay 
1163a7e14dcfSSatish Balay   Input Parameter:
1164a7e14dcfSSatish Balay . tao - the TaoSolver context
1165a7e14dcfSSatish Balay 
1166a7e14dcfSSatish Balay   Output Parameter:
1167a7e14dcfSSatish Balay . X - the current solution
1168a7e14dcfSSatish Balay 
1169a7e14dcfSSatish Balay   Level: intermediate
1170a7e14dcfSSatish Balay 
1171a7e14dcfSSatish Balay   Note:  The returned vector will be the same object that was passed into TaoSetInitialVector()
1172a7e14dcfSSatish Balay @*/
1173a7e14dcfSSatish Balay PetscErrorCode TaoGetSolutionVector(TaoSolver tao, Vec *X)
1174a7e14dcfSSatish Balay {
1175a7e14dcfSSatish Balay   PetscFunctionBegin;
1176a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
1177a7e14dcfSSatish Balay   *X = tao->solution;
1178a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1179a7e14dcfSSatish Balay }
1180a7e14dcfSSatish Balay 
1181a7e14dcfSSatish Balay #undef __FUNCT__
1182a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetGradientVector"
1183a7e14dcfSSatish Balay /*@
1184a7e14dcfSSatish Balay   TaoGetGradientVector - Returns the vector with the current TAO gradient
1185a7e14dcfSSatish Balay 
1186a7e14dcfSSatish Balay   Not Collective
1187a7e14dcfSSatish Balay 
1188a7e14dcfSSatish Balay   Input Parameter:
1189a7e14dcfSSatish Balay . tao - the TaoSolver context
1190a7e14dcfSSatish Balay 
1191a7e14dcfSSatish Balay   Output Parameter:
1192a7e14dcfSSatish Balay . G - the current solution
1193a7e14dcfSSatish Balay 
1194a7e14dcfSSatish Balay   Level: intermediate
1195a7e14dcfSSatish Balay @*/
1196a7e14dcfSSatish Balay PetscErrorCode TaoGetGradientVector(TaoSolver tao, Vec *G)
1197a7e14dcfSSatish Balay {
1198a7e14dcfSSatish Balay   PetscFunctionBegin;
1199a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
1200a7e14dcfSSatish Balay   *G = tao->gradient;
1201a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1202a7e14dcfSSatish Balay }
1203a7e14dcfSSatish Balay 
1204a7e14dcfSSatish Balay #undef __FUNCT__
1205a7e14dcfSSatish Balay #define __FUNCT__ "TaoResetStatistics"
1206a7e14dcfSSatish Balay /*@
1207a7e14dcfSSatish Balay    TaoResetStatistics - Initialize the statistics used by TAO for all of the solvers.
1208a7e14dcfSSatish Balay    These statistics include the iteration number, residual norms, and convergence status.
1209a7e14dcfSSatish Balay    This routine gets called before solving each optimization problem.
1210a7e14dcfSSatish Balay 
1211a7e14dcfSSatish Balay    Collective on TaoSolver
1212a7e14dcfSSatish Balay 
1213a7e14dcfSSatish Balay    Input Parameters:
1214a7e14dcfSSatish Balay .  solver - the TaoSolver context
1215a7e14dcfSSatish Balay 
1216a7e14dcfSSatish Balay    Level: developer
1217a7e14dcfSSatish Balay 
1218a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve()
1219a7e14dcfSSatish Balay @*/
1220a7e14dcfSSatish Balay PetscErrorCode TaoResetStatistics(TaoSolver tao)
1221a7e14dcfSSatish Balay {
1222a7e14dcfSSatish Balay   PetscFunctionBegin;
1223a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
1224a7e14dcfSSatish Balay   tao->niter        = 0;
1225a7e14dcfSSatish Balay   tao->nfuncs       = 0;
1226a7e14dcfSSatish Balay   tao->nfuncgrads   = 0;
1227a7e14dcfSSatish Balay   tao->ngrads       = 0;
1228a7e14dcfSSatish Balay   tao->nhess        = 0;
1229a7e14dcfSSatish Balay   tao->njac         = 0;
1230a7e14dcfSSatish Balay   tao->nconstraints = 0;
1231a7e14dcfSSatish Balay   tao->ksp_its      = 0;
1232a7e14dcfSSatish Balay   tao->reason       = TAO_CONTINUE_ITERATING;
1233a7e14dcfSSatish Balay   tao->residual     = 0.0;
1234a7e14dcfSSatish Balay   tao->cnorm        = 0.0;
1235a7e14dcfSSatish Balay   tao->step         = 0.0;
1236a7e14dcfSSatish Balay   tao->lsflag       = PETSC_FALSE;
1237a7e14dcfSSatish Balay   if (tao->hist_reset) tao->hist_len=0;
1238a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1239a7e14dcfSSatish Balay }
1240a7e14dcfSSatish Balay 
1241a7e14dcfSSatish Balay #undef __FUNCT__
1242a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetConvergenceTest"
1243a7e14dcfSSatish Balay /*@C
1244a7e14dcfSSatish Balay   TaoSetConvergenceTest - Sets the function that is to be used to test
1245a7e14dcfSSatish Balay   for convergence o fthe iterative minimization solution.  The new convergence
1246a7e14dcfSSatish Balay   testing routine will replace TAO's default convergence test.
1247a7e14dcfSSatish Balay 
1248a7e14dcfSSatish Balay   Logically Collective on TaoSolver
1249a7e14dcfSSatish Balay 
1250a7e14dcfSSatish Balay   Input Parameters:
1251a7e14dcfSSatish Balay + tao - the TaoSolver object
1252a7e14dcfSSatish Balay . conv - the routine to test for convergence
1253a7e14dcfSSatish Balay - ctx - [optional] context for private data for the convergence routine
125447a47007SBarry Smith         (may be NULL)
1255a7e14dcfSSatish Balay 
1256a7e14dcfSSatish Balay   Calling sequence of conv:
1257a7e14dcfSSatish Balay $   PetscErrorCode conv(TaoSolver tao, void *ctx)
1258a7e14dcfSSatish Balay 
1259a7e14dcfSSatish Balay + tao - the TaoSolver object
1260a7e14dcfSSatish Balay - ctx - [optional] convergence context
1261a7e14dcfSSatish Balay 
1262a7e14dcfSSatish Balay   Note: The new convergence testing routine should call TaoSetTerminationReason().
1263a7e14dcfSSatish Balay 
1264a7e14dcfSSatish Balay   Level: advanced
1265a7e14dcfSSatish Balay 
1266a7e14dcfSSatish Balay .seealso: TaoSetTerminationReason(), TaoGetSolutionStatus(), TaoGetTolerances(), TaoSetMonitor
1267a7e14dcfSSatish Balay 
1268a7e14dcfSSatish Balay @*/
1269a7e14dcfSSatish Balay PetscErrorCode TaoSetConvergenceTest(TaoSolver tao, PetscErrorCode (*conv)(TaoSolver,void*), void *ctx)
1270a7e14dcfSSatish Balay {
1271a7e14dcfSSatish Balay   PetscFunctionBegin;
1272a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
1273a7e14dcfSSatish Balay   (tao)->ops->convergencetest = conv;
1274a7e14dcfSSatish Balay   (tao)->cnvP = ctx;
1275a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1276a7e14dcfSSatish Balay }
1277a7e14dcfSSatish Balay 
1278a7e14dcfSSatish Balay #undef __FUNCT__
1279a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMonitor"
1280a7e14dcfSSatish Balay /*@C
1281a7e14dcfSSatish Balay    TaoSetMonitor - Sets an ADDITIONAL function that is to be used at every
1282a7e14dcfSSatish Balay    iteration of the solver to display the iteration's
1283a7e14dcfSSatish Balay    progress.
1284a7e14dcfSSatish Balay 
1285a7e14dcfSSatish Balay    Logically Collective on TaoSolver
1286a7e14dcfSSatish Balay 
1287a7e14dcfSSatish Balay    Input Parameters:
1288a7e14dcfSSatish Balay +  tao - the TaoSolver solver context
1289a7e14dcfSSatish Balay .  mymonitor - monitoring routine
1290a7e14dcfSSatish Balay -  mctx - [optional] user-defined context for private data for the
129147a47007SBarry Smith           monitor routine (may be NULL)
1292a7e14dcfSSatish Balay 
1293a7e14dcfSSatish Balay    Calling sequence of mymonitor:
1294a7e14dcfSSatish Balay $     int mymonitor(TaoSolver tao,void *mctx)
1295a7e14dcfSSatish Balay 
1296a7e14dcfSSatish Balay +    tao - the TaoSolver solver context
1297a7e14dcfSSatish Balay -    mctx - [optional] monitoring context
1298a7e14dcfSSatish Balay 
1299a7e14dcfSSatish Balay 
1300a7e14dcfSSatish Balay    Options Database Keys:
1301a7e14dcfSSatish Balay +    -tao_monitor        - sets TaoDefaultMonitor()
1302a7e14dcfSSatish Balay .    -tao_smonitor       - sets short monitor
1303a7e14dcfSSatish Balay .    -tao_cmonitor       - same as smonitor plus constraint norm
1304a7e14dcfSSatish Balay .    -tao_view_solution   - view solution at each iteration
1305a7e14dcfSSatish Balay .    -tao_view_gradient   - view gradient at each iteration
1306a7e14dcfSSatish Balay .    -tao_view_separableobjective - view separable objective function at each iteration
1307a7e14dcfSSatish 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.
1308a7e14dcfSSatish Balay 
1309a7e14dcfSSatish Balay 
1310a7e14dcfSSatish Balay    Notes:
1311a7e14dcfSSatish Balay    Several different monitoring routines may be set by calling
1312a7e14dcfSSatish Balay    TaoSetMonitor() multiple times; all will be called in the
1313a7e14dcfSSatish Balay    order in which they were set.
1314a7e14dcfSSatish Balay 
1315a7e14dcfSSatish Balay    Fortran Notes: Only one monitor function may be set
1316a7e14dcfSSatish Balay 
1317a7e14dcfSSatish Balay    Level: intermediate
1318a7e14dcfSSatish Balay 
1319a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoCancelMonitors(),  TaoSetDestroyRoutine()
1320a7e14dcfSSatish Balay @*/
1321a7e14dcfSSatish Balay PetscErrorCode TaoSetMonitor(TaoSolver tao, PetscErrorCode (*func)(TaoSolver, void*), void *ctx,PetscErrorCode (*dest)(void**))
1322a7e14dcfSSatish Balay {
1323a7e14dcfSSatish Balay   PetscFunctionBegin;
1324a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
132547a47007SBarry Smith   if (tao->numbermonitors >= MAXTAOMONITORS) SETERRQ1(PETSC_COMM_SELF,1,"Cannot attach another monitor -- max=",MAXTAOMONITORS);
1326a7e14dcfSSatish Balay   tao->monitor[tao->numbermonitors] = func;
1327a7e14dcfSSatish Balay   tao->monitorcontext[tao->numbermonitors] = ctx;
1328a7e14dcfSSatish Balay   tao->monitordestroy[tao->numbermonitors] = dest;
1329a7e14dcfSSatish Balay   ++tao->numbermonitors;
1330a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1331a7e14dcfSSatish Balay }
1332a7e14dcfSSatish Balay 
1333a7e14dcfSSatish Balay #undef __FUNCT__
1334a7e14dcfSSatish Balay #define __FUNCT__ "TaoCancelMonitors"
1335a7e14dcfSSatish Balay /*@
1336a7e14dcfSSatish Balay    TaoCancelMonitors - Clears all the monitor functions for a TaoSolver object.
1337a7e14dcfSSatish Balay 
1338a7e14dcfSSatish Balay    Logically Collective on TaoSolver
1339a7e14dcfSSatish Balay 
1340a7e14dcfSSatish Balay    Input Parameters:
1341a7e14dcfSSatish Balay .  tao - the TaoSolver solver context
1342a7e14dcfSSatish Balay 
1343a7e14dcfSSatish Balay    Options Database:
1344a7e14dcfSSatish Balay .  -tao_cancelmonitors - cancels all monitors that have been hardwired
1345a7e14dcfSSatish Balay     into a code by calls to TaoSetMonitor(), but does not cancel those
1346a7e14dcfSSatish Balay     set via the options database
1347a7e14dcfSSatish Balay 
1348a7e14dcfSSatish Balay    Notes:
1349a7e14dcfSSatish Balay    There is no way to clear one specific monitor from a TaoSolver object.
1350a7e14dcfSSatish Balay 
1351a7e14dcfSSatish Balay    Level: advanced
1352a7e14dcfSSatish Balay 
1353a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1354a7e14dcfSSatish Balay @*/
1355a7e14dcfSSatish Balay PetscErrorCode TaoCancelMonitors(TaoSolver tao)
1356a7e14dcfSSatish Balay {
1357a7e14dcfSSatish Balay   PetscInt       i;
1358a7e14dcfSSatish Balay   PetscErrorCode ierr;
135947a47007SBarry Smith 
1360a7e14dcfSSatish Balay   PetscFunctionBegin;
1361a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
1362a7e14dcfSSatish Balay   for (i=0;i<tao->numbermonitors;i++) {
1363a7e14dcfSSatish Balay     if (tao->monitordestroy[i]) {
1364a7e14dcfSSatish Balay       ierr = (*tao->monitordestroy[i])(&tao->monitorcontext[i]);CHKERRQ(ierr);
1365a7e14dcfSSatish Balay     }
1366a7e14dcfSSatish Balay   }
1367a7e14dcfSSatish Balay   tao->numbermonitors=0;
1368a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1369a7e14dcfSSatish Balay }
1370a7e14dcfSSatish Balay 
1371a7e14dcfSSatish Balay #undef __FUNCT__
1372a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultMonitor"
1373a7e14dcfSSatish Balay /*@C
1374a7e14dcfSSatish Balay    TaoDefaultMonitor - Default routine for monitoring progress of the
1375a7e14dcfSSatish Balay    TaoSolver solvers (default).  This monitor prints the function value and gradient
1376a7e14dcfSSatish Balay    norm at each iteration.  It can be turned on from the command line using the
1377a7e14dcfSSatish Balay    -tao_monitor option
1378a7e14dcfSSatish Balay 
1379a7e14dcfSSatish Balay    Collective on TaoSolver
1380a7e14dcfSSatish Balay 
1381a7e14dcfSSatish Balay    Input Parameters:
1382a7e14dcfSSatish Balay +  tao - the TaoSolver context
138347a47007SBarry Smith -  ctx - PetscViewer context or NULL
1384a7e14dcfSSatish Balay 
1385a7e14dcfSSatish Balay    Options Database Keys:
1386a7e14dcfSSatish Balay .  -tao_monitor
1387a7e14dcfSSatish Balay 
1388a7e14dcfSSatish Balay    Level: advanced
1389a7e14dcfSSatish Balay 
1390a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1391a7e14dcfSSatish Balay @*/
1392a7e14dcfSSatish Balay PetscErrorCode TaoDefaultMonitor(TaoSolver tao, void *ctx)
1393a7e14dcfSSatish Balay {
1394a7e14dcfSSatish Balay   PetscErrorCode ierr;
1395a7e14dcfSSatish Balay   PetscInt       its;
1396a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1397a7e14dcfSSatish Balay   PetscViewer    viewer;
139847a47007SBarry Smith 
1399a7e14dcfSSatish Balay   PetscFunctionBegin;
1400a7e14dcfSSatish Balay   if (ctx) {
1401a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1402a7e14dcfSSatish Balay   } else {
1403a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1404a7e14dcfSSatish Balay   }
1405a7e14dcfSSatish Balay   its=tao->niter;
1406a7e14dcfSSatish Balay   fct=tao->fc;
1407a7e14dcfSSatish Balay   gnorm=tao->residual;
1408a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr);
140947a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr);
141047a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer,"  Residual: %g \n",(double)gnorm);CHKERRQ(ierr);
1411a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1412a7e14dcfSSatish Balay }
1413a7e14dcfSSatish Balay 
1414a7e14dcfSSatish Balay #undef __FUNCT__
1415a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultSMonitor"
1416a7e14dcfSSatish Balay /*@C
1417a7e14dcfSSatish Balay    TaoDefaultSMonitor - Default routine for monitoring progress of the
1418a7e14dcfSSatish Balay    solver. Same as TaoDefaultMonitor() except
1419a7e14dcfSSatish Balay    it prints fewer digits of the residual as the residual gets smaller.
1420a7e14dcfSSatish Balay    This is because the later digits are meaningless and are often
1421a7e14dcfSSatish Balay    different on different machines; by using this routine different
1422a7e14dcfSSatish Balay    machines will usually generate the same output. It can be turned on
1423a7e14dcfSSatish Balay    by using the -tao_smonitor option
1424a7e14dcfSSatish Balay 
1425a7e14dcfSSatish Balay    Collective on TaoSolver
1426a7e14dcfSSatish Balay 
1427a7e14dcfSSatish Balay    Input Parameters:
1428a7e14dcfSSatish Balay +  tao - the TaoSolver context
142947a47007SBarry Smith -  ctx - PetscViewer context or NULL
1430a7e14dcfSSatish Balay 
1431a7e14dcfSSatish Balay    Options Database Keys:
1432a7e14dcfSSatish Balay .  -tao_smonitor
1433a7e14dcfSSatish Balay 
1434a7e14dcfSSatish Balay    Level: advanced
1435a7e14dcfSSatish Balay 
1436a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1437a7e14dcfSSatish Balay @*/
1438a7e14dcfSSatish Balay PetscErrorCode TaoDefaultSMonitor(TaoSolver tao, void *ctx)
1439a7e14dcfSSatish Balay {
1440a7e14dcfSSatish Balay   PetscErrorCode ierr;
1441a7e14dcfSSatish Balay   PetscInt       its;
1442a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1443a7e14dcfSSatish Balay   PetscViewer    viewer;
144447a47007SBarry Smith 
1445a7e14dcfSSatish Balay   PetscFunctionBegin;
1446a7e14dcfSSatish Balay   if (ctx) {
1447a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1448a7e14dcfSSatish Balay   } else {
1449a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1450a7e14dcfSSatish Balay   }
1451a7e14dcfSSatish Balay   its=tao->niter;
1452a7e14dcfSSatish Balay   fct=tao->fc;
1453a7e14dcfSSatish Balay   gnorm=tao->residual;
1454a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr);
145547a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value %g,",(double)fct);CHKERRQ(ierr);
1456a7e14dcfSSatish Balay   if (gnorm > 1.e-6) {
145747a47007SBarry Smith     ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr);
1458a7e14dcfSSatish Balay   } else if (gnorm > 1.e-11) {
1459a7e14dcfSSatish Balay     ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-6 \n");CHKERRQ(ierr);
1460a7e14dcfSSatish Balay   } else {
1461a7e14dcfSSatish Balay     ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-11 \n");CHKERRQ(ierr);
1462a7e14dcfSSatish Balay   }
1463a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1464a7e14dcfSSatish Balay }
1465a7e14dcfSSatish Balay 
1466a7e14dcfSSatish Balay #undef __FUNCT__
1467a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultCMonitor"
1468a7e14dcfSSatish Balay /*@C
1469a7e14dcfSSatish Balay    TaoDefaultCMonitor - same as TaoDefaultMonitor() except
1470a7e14dcfSSatish Balay    it prints the norm of the constraints function. It can be turned on
1471a7e14dcfSSatish Balay    from the command line using the -tao_cmonitor option
1472a7e14dcfSSatish Balay 
1473a7e14dcfSSatish Balay    Collective on TaoSolver
1474a7e14dcfSSatish Balay 
1475a7e14dcfSSatish Balay    Input Parameters:
1476a7e14dcfSSatish Balay +  tao - the TaoSolver context
147747a47007SBarry Smith -  ctx - PetscViewer context or NULL
1478a7e14dcfSSatish Balay 
1479a7e14dcfSSatish Balay    Options Database Keys:
1480a7e14dcfSSatish Balay .  -tao_cmonitor
1481a7e14dcfSSatish Balay 
1482a7e14dcfSSatish Balay    Level: advanced
1483a7e14dcfSSatish Balay 
1484a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor()
1485a7e14dcfSSatish Balay @*/
1486a7e14dcfSSatish Balay PetscErrorCode TaoDefaultCMonitor(TaoSolver tao, void *ctx)
1487a7e14dcfSSatish Balay {
1488a7e14dcfSSatish Balay   PetscErrorCode ierr;
1489a7e14dcfSSatish Balay   PetscInt       its;
1490a7e14dcfSSatish Balay   PetscReal      fct,gnorm;
1491a7e14dcfSSatish Balay   PetscViewer    viewer;
1492a7e14dcfSSatish Balay 
1493a7e14dcfSSatish Balay   PetscFunctionBegin;
1494a7e14dcfSSatish Balay   if (ctx) {
1495a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1496a7e14dcfSSatish Balay   } else {
1497a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1498a7e14dcfSSatish Balay   }
1499a7e14dcfSSatish Balay   its=tao->niter;
1500a7e14dcfSSatish Balay   fct=tao->fc;
1501a7e14dcfSSatish Balay   gnorm=tao->residual;
1502a7e14dcfSSatish Balay   ierr=PetscViewerASCIIPrintf(viewer,"iter = %D,",its);CHKERRQ(ierr);
150347a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr);
150447a47007SBarry Smith   ierr=PetscViewerASCIIPrintf(viewer,"  Residual: %g ",(double)gnorm);CHKERRQ(ierr);
150547a47007SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"  Constraint: %g \n",(double)tao->cnorm);CHKERRQ(ierr);
1506a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1507a7e14dcfSSatish Balay }
1508a7e14dcfSSatish Balay 
1509a7e14dcfSSatish Balay #undef __FUNCT__
1510a7e14dcfSSatish Balay #define __FUNCT__ "TaoSolutionMonitor"
1511a7e14dcfSSatish Balay /*@C
1512a7e14dcfSSatish Balay    TaoSolutionMonitor - Views the solution at each iteration
1513a7e14dcfSSatish Balay    It can be turned on from the command line using the
1514a7e14dcfSSatish Balay    -tao_view_solution option
1515a7e14dcfSSatish Balay 
1516a7e14dcfSSatish Balay    Collective on TaoSolver
1517a7e14dcfSSatish Balay 
1518a7e14dcfSSatish Balay    Input Parameters:
1519a7e14dcfSSatish Balay +  tao - the TaoSolver context
152047a47007SBarry Smith -  ctx - PetscViewer context or NULL
1521a7e14dcfSSatish Balay 
1522a7e14dcfSSatish Balay    Options Database Keys:
1523a7e14dcfSSatish Balay .  -tao_view_solution
1524a7e14dcfSSatish Balay 
1525a7e14dcfSSatish Balay    Level: advanced
1526a7e14dcfSSatish Balay 
1527a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1528a7e14dcfSSatish Balay @*/
1529a7e14dcfSSatish Balay PetscErrorCode TaoSolutionMonitor(TaoSolver tao, void *ctx)
1530a7e14dcfSSatish Balay {
1531a7e14dcfSSatish Balay   PetscErrorCode ierr;
1532a7e14dcfSSatish Balay   PetscViewer viewer;
153347a47007SBarry Smith 
1534a7e14dcfSSatish Balay   PetscFunctionBegin;
1535a7e14dcfSSatish Balay   if (ctx) {
1536a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1537a7e14dcfSSatish Balay   } else {
1538a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1539a7e14dcfSSatish Balay   }
1540a7e14dcfSSatish Balay   ierr = VecView(tao->solution, viewer);CHKERRQ(ierr);
1541a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1542a7e14dcfSSatish Balay }
1543a7e14dcfSSatish Balay 
1544a7e14dcfSSatish Balay #undef __FUNCT__
1545a7e14dcfSSatish Balay #define __FUNCT__ "TaoGradientMonitor"
1546a7e14dcfSSatish Balay /*@C
1547a7e14dcfSSatish Balay    TaoGradientMonitor - Views the gradient at each iteration
1548a7e14dcfSSatish Balay    It can be turned on from the command line using the
1549a7e14dcfSSatish Balay    -tao_view_gradient option
1550a7e14dcfSSatish Balay 
1551a7e14dcfSSatish Balay    Collective on TaoSolver
1552a7e14dcfSSatish Balay 
1553a7e14dcfSSatish Balay    Input Parameters:
1554a7e14dcfSSatish Balay +  tao - the TaoSolver context
155547a47007SBarry Smith -  ctx - PetscViewer context or NULL
1556a7e14dcfSSatish Balay 
1557a7e14dcfSSatish Balay    Options Database Keys:
1558a7e14dcfSSatish Balay .  -tao_view_gradient
1559a7e14dcfSSatish Balay 
1560a7e14dcfSSatish Balay    Level: advanced
1561a7e14dcfSSatish Balay 
1562a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1563a7e14dcfSSatish Balay @*/
1564a7e14dcfSSatish Balay PetscErrorCode TaoGradientMonitor(TaoSolver tao, void *ctx)
1565a7e14dcfSSatish Balay {
1566a7e14dcfSSatish Balay   PetscErrorCode ierr;
1567a7e14dcfSSatish Balay   PetscViewer viewer;
156847a47007SBarry Smith 
1569a7e14dcfSSatish Balay   PetscFunctionBegin;
1570a7e14dcfSSatish Balay   if (ctx) {
1571a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1572a7e14dcfSSatish Balay   } else {
1573a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1574a7e14dcfSSatish Balay   }
1575a7e14dcfSSatish Balay   ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr);
1576a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1577a7e14dcfSSatish Balay }
1578a7e14dcfSSatish Balay 
1579a7e14dcfSSatish Balay #undef __FUNCT__
1580a7e14dcfSSatish Balay #define __FUNCT__ "TaoStepDirectionMonitor"
1581a7e14dcfSSatish Balay /*@C
1582a7e14dcfSSatish Balay    TaoStepDirectionMonitor - Views the gradient at each iteration
1583a7e14dcfSSatish Balay    It can be turned on from the command line using the
1584a7e14dcfSSatish Balay    -tao_view_gradient option
1585a7e14dcfSSatish Balay 
1586a7e14dcfSSatish Balay    Collective on TaoSolver
1587a7e14dcfSSatish Balay 
1588a7e14dcfSSatish Balay    Input Parameters:
1589a7e14dcfSSatish Balay +  tao - the TaoSolver context
159047a47007SBarry Smith -  ctx - PetscViewer context or NULL
1591a7e14dcfSSatish Balay 
1592a7e14dcfSSatish Balay    Options Database Keys:
1593a7e14dcfSSatish Balay .  -tao_view_gradient
1594a7e14dcfSSatish Balay 
1595a7e14dcfSSatish Balay    Level: advanced
1596a7e14dcfSSatish Balay 
1597a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1598a7e14dcfSSatish Balay @*/
1599a7e14dcfSSatish Balay PetscErrorCode TaoStepDirectionMonitor(TaoSolver tao, void *ctx)
1600a7e14dcfSSatish Balay {
1601a7e14dcfSSatish Balay   PetscErrorCode ierr;
1602a7e14dcfSSatish Balay   PetscViewer viewer;
1603a7e14dcfSSatish Balay   PetscFunctionBegin;
1604a7e14dcfSSatish Balay   if (ctx) {
1605a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1606a7e14dcfSSatish Balay   } else {
1607a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1608a7e14dcfSSatish Balay   }
1609a7e14dcfSSatish Balay   ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr);
1610a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1611a7e14dcfSSatish Balay }
1612a7e14dcfSSatish Balay 
1613a7e14dcfSSatish Balay #undef __FUNCT__
1614a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawSolutionMonitor"
1615a7e14dcfSSatish Balay /*@C
1616a7e14dcfSSatish Balay    TaoDrawSolutionMonitor - Plots the solution at each iteration
1617a7e14dcfSSatish Balay    It can be turned on from the command line using the
1618a7e14dcfSSatish Balay    -tao_draw_solution option
1619a7e14dcfSSatish Balay 
1620a7e14dcfSSatish Balay    Collective on TaoSolver
1621a7e14dcfSSatish Balay 
1622a7e14dcfSSatish Balay    Input Parameters:
1623a7e14dcfSSatish Balay +  tao - the TaoSolver context
162447a47007SBarry Smith -  ctx - PetscViewer context or NULL
1625a7e14dcfSSatish Balay 
1626a7e14dcfSSatish Balay    Options Database Keys:
1627a7e14dcfSSatish Balay .  -tao_draw_solution
1628a7e14dcfSSatish Balay 
1629a7e14dcfSSatish Balay    Level: advanced
1630a7e14dcfSSatish Balay 
1631a7e14dcfSSatish Balay .seealso: TaoSolutionMonitor(), TaoSetMonitor(), TaoDrawGradientMonitor
1632a7e14dcfSSatish Balay @*/
1633a7e14dcfSSatish Balay PetscErrorCode TaoDrawSolutionMonitor(TaoSolver tao, void *ctx)
1634a7e14dcfSSatish Balay {
1635a7e14dcfSSatish Balay   PetscErrorCode ierr;
1636a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer) ctx;
1637a7e14dcfSSatish Balay   MPI_Comm       comm;
163847a47007SBarry Smith 
1639a7e14dcfSSatish Balay   PetscFunctionBegin;
1640a7e14dcfSSatish Balay   if (!viewer) {
1641a7e14dcfSSatish Balay     ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
1642a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_DRAW_(comm);
1643a7e14dcfSSatish Balay   }
1644a7e14dcfSSatish Balay   ierr = VecView(tao->solution, viewer);CHKERRQ(ierr);
1645a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1646a7e14dcfSSatish Balay }
1647a7e14dcfSSatish Balay 
1648a7e14dcfSSatish Balay #undef __FUNCT__
1649a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawGradientMonitor"
1650a7e14dcfSSatish Balay /*@C
1651a7e14dcfSSatish Balay    TaoDrawGradientMonitor - Plots the gradient at each iteration
1652a7e14dcfSSatish Balay    It can be turned on from the command line using the
1653a7e14dcfSSatish Balay    -tao_draw_gradient option
1654a7e14dcfSSatish Balay 
1655a7e14dcfSSatish Balay    Collective on TaoSolver
1656a7e14dcfSSatish Balay 
1657a7e14dcfSSatish Balay    Input Parameters:
1658a7e14dcfSSatish Balay +  tao - the TaoSolver context
165947a47007SBarry Smith -  ctx - PetscViewer context or NULL
1660a7e14dcfSSatish Balay 
1661a7e14dcfSSatish Balay    Options Database Keys:
1662a7e14dcfSSatish Balay .  -tao_draw_gradient
1663a7e14dcfSSatish Balay 
1664a7e14dcfSSatish Balay    Level: advanced
1665a7e14dcfSSatish Balay 
1666a7e14dcfSSatish Balay .seealso: TaoGradientMonitor(), TaoSetMonitor(), TaoDrawSolutionMonitor
1667a7e14dcfSSatish Balay @*/
1668a7e14dcfSSatish Balay PetscErrorCode TaoDrawGradientMonitor(TaoSolver tao, void *ctx)
1669a7e14dcfSSatish Balay {
1670a7e14dcfSSatish Balay   PetscErrorCode ierr;
1671a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer)ctx;
1672a7e14dcfSSatish Balay   MPI_Comm       comm;
167347a47007SBarry Smith 
1674a7e14dcfSSatish Balay   PetscFunctionBegin;
1675a7e14dcfSSatish Balay   if (!viewer) {
1676a7e14dcfSSatish Balay     ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
1677a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_DRAW_(comm);
1678a7e14dcfSSatish Balay   }
1679a7e14dcfSSatish Balay   ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr);
1680a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1681a7e14dcfSSatish Balay }
1682a7e14dcfSSatish Balay 
1683a7e14dcfSSatish Balay #undef __FUNCT__
1684a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawStepMonitor"
1685a7e14dcfSSatish Balay /*@C
1686a7e14dcfSSatish Balay    TaoDrawStepMonitor - Plots the step direction at each iteration
1687a7e14dcfSSatish Balay    It can be turned on from the command line using the
1688a7e14dcfSSatish Balay    -tao_draw_step option
1689a7e14dcfSSatish Balay 
1690a7e14dcfSSatish Balay    Collective on TaoSolver
1691a7e14dcfSSatish Balay 
1692a7e14dcfSSatish Balay    Input Parameters:
1693a7e14dcfSSatish Balay +  tao - the TaoSolver context
169447a47007SBarry Smith -  ctx - PetscViewer context or NULL
1695a7e14dcfSSatish Balay 
1696a7e14dcfSSatish Balay    Options Database Keys:
1697a7e14dcfSSatish Balay .  -tao_draw_step
1698a7e14dcfSSatish Balay 
1699a7e14dcfSSatish Balay    Level: advanced
1700a7e14dcfSSatish Balay 
1701a7e14dcfSSatish Balay .seealso: TaoSetMonitor(), TaoDrawSolutionMonitor
1702a7e14dcfSSatish Balay @*/
1703a7e14dcfSSatish Balay PetscErrorCode TaoDrawStepMonitor(TaoSolver tao, void *ctx)
1704a7e14dcfSSatish Balay {
1705a7e14dcfSSatish Balay   PetscErrorCode ierr;
1706a7e14dcfSSatish Balay   PetscViewer    viewer = (PetscViewer)(ctx);
1707a7e14dcfSSatish Balay   MPI_Comm       comm;
170847a47007SBarry Smith 
1709a7e14dcfSSatish Balay   PetscFunctionBegin;
1710a7e14dcfSSatish Balay   if (!viewer) {
1711a7e14dcfSSatish Balay     ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr);
1712a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_DRAW_(comm);
1713a7e14dcfSSatish Balay   }
1714a7e14dcfSSatish Balay   ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr);
1715a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1716a7e14dcfSSatish Balay }
1717a7e14dcfSSatish Balay 
1718a7e14dcfSSatish Balay #undef __FUNCT__
1719a7e14dcfSSatish Balay #define __FUNCT__ "TaoSeparableObjectiveMonitor"
1720a7e14dcfSSatish Balay /*@C
1721a7e14dcfSSatish Balay    TaoSeparableObjectiveMonitor - Views the separable objective function at each iteration
1722a7e14dcfSSatish Balay    It can be turned on from the command line using the
1723a7e14dcfSSatish Balay    -tao_view_separableobjective option
1724a7e14dcfSSatish Balay 
1725a7e14dcfSSatish Balay    Collective on TaoSolver
1726a7e14dcfSSatish Balay 
1727a7e14dcfSSatish Balay    Input Parameters:
1728a7e14dcfSSatish Balay +  tao - the TaoSolver context
172947a47007SBarry Smith -  ctx - PetscViewer context or NULL
1730a7e14dcfSSatish Balay 
1731a7e14dcfSSatish Balay    Options Database Keys:
1732a7e14dcfSSatish Balay .  -tao_view_separableobjective
1733a7e14dcfSSatish Balay 
1734a7e14dcfSSatish Balay    Level: advanced
1735a7e14dcfSSatish Balay 
1736a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor()
1737a7e14dcfSSatish Balay @*/
1738a7e14dcfSSatish Balay PetscErrorCode TaoSeparableObjectiveMonitor(TaoSolver tao, void *ctx)
1739a7e14dcfSSatish Balay {
1740a7e14dcfSSatish Balay   PetscErrorCode ierr;
1741a7e14dcfSSatish Balay   PetscViewer    viewer;
174247a47007SBarry Smith 
1743a7e14dcfSSatish Balay   PetscFunctionBegin;
1744a7e14dcfSSatish Balay   if (ctx) {
1745a7e14dcfSSatish Balay     viewer = (PetscViewer)ctx;
1746a7e14dcfSSatish Balay   } else {
1747a7e14dcfSSatish Balay     viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm);
1748a7e14dcfSSatish Balay   }
1749a7e14dcfSSatish Balay   ierr = VecView(tao->sep_objective,viewer);CHKERRQ(ierr);
1750a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1751a7e14dcfSSatish Balay }
1752a7e14dcfSSatish Balay 
1753a7e14dcfSSatish Balay #undef __FUNCT__
1754a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultConvergenceTest"
1755a7e14dcfSSatish Balay /*@C
1756a7e14dcfSSatish Balay    TaoDefaultConvergenceTest - Determines whether the solver should continue iterating
1757a7e14dcfSSatish Balay    or terminate.
1758a7e14dcfSSatish Balay 
1759a7e14dcfSSatish Balay    Collective on TaoSolver
1760a7e14dcfSSatish Balay 
1761a7e14dcfSSatish Balay    Input Parameters:
1762a7e14dcfSSatish Balay +  tao - the TaoSolver context
1763a7e14dcfSSatish Balay -  dummy - unused dummy context
1764a7e14dcfSSatish Balay 
1765a7e14dcfSSatish Balay    Output Parameter:
1766a7e14dcfSSatish Balay .  reason - for terminating
1767a7e14dcfSSatish Balay 
1768a7e14dcfSSatish Balay    Notes:
1769a7e14dcfSSatish Balay    This routine checks the residual in the optimality conditions, the
1770a7e14dcfSSatish Balay    relative residual in the optimity conditions, the number of function
1771a7e14dcfSSatish Balay    evaluations, and the function value to test convergence.  Some
1772a7e14dcfSSatish Balay    solvers may use different convergence routines.
1773a7e14dcfSSatish Balay 
1774a7e14dcfSSatish Balay    Level: developer
1775a7e14dcfSSatish Balay 
1776a7e14dcfSSatish Balay .seealso: TaoSetTolerances(),TaoGetTerminationReason(),TaoSetTerminationReason()
1777a7e14dcfSSatish Balay @*/
1778a7e14dcfSSatish Balay 
1779a7e14dcfSSatish Balay PetscErrorCode TaoDefaultConvergenceTest(TaoSolver tao,void *dummy)
1780a7e14dcfSSatish Balay {
1781a7e14dcfSSatish Balay   PetscInt                   niter=tao->niter, nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads);
1782a7e14dcfSSatish Balay   PetscInt                   max_funcs=tao->max_funcs;
1783a7e14dcfSSatish Balay   PetscReal                  gnorm=tao->residual, gnorm0=tao->gnorm0;
1784a7e14dcfSSatish Balay   PetscReal                  f=tao->fc, steptol=tao->steptol,trradius=tao->step;
1785a7e14dcfSSatish Balay   PetscReal                  gatol=tao->gatol,grtol=tao->grtol,gttol=tao->gttol;
1786a7e14dcfSSatish Balay   PetscReal                  fatol=tao->fatol,frtol=tao->frtol,catol=tao->catol,crtol=tao->crtol;
1787a7e14dcfSSatish Balay   PetscReal                  fmin=tao->fmin, cnorm=tao->cnorm, cnorm0=tao->cnorm0;
1788a7e14dcfSSatish Balay   PetscReal                  gnorm2;
1789a7e14dcfSSatish Balay   TaoSolverTerminationReason reason=tao->reason;
1790a7e14dcfSSatish Balay   PetscErrorCode             ierr;
1791a7e14dcfSSatish Balay 
1792a7e14dcfSSatish Balay   PetscFunctionBegin;
1793a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao, TAOSOLVER_CLASSID,1);
1794a7e14dcfSSatish Balay   if (reason != TAO_CONTINUE_ITERATING) {
1795a7e14dcfSSatish Balay     PetscFunctionReturn(0);
1796a7e14dcfSSatish Balay   }
1797a7e14dcfSSatish Balay   gnorm2=gnorm*gnorm;
1798a7e14dcfSSatish Balay 
1799a7e14dcfSSatish Balay   if (PetscIsInfOrNanReal(f)) {
1800a7e14dcfSSatish Balay     ierr = PetscInfo(tao,"Failed to converged, function value is Inf or NaN\n");CHKERRQ(ierr);
1801a7e14dcfSSatish Balay     reason = TAO_DIVERGED_NAN;
1802a7e14dcfSSatish Balay   } else if (f <= fmin && cnorm <=catol) {
180347a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to function value %g < minimum function value %g\n", (double)f,(double)fmin);CHKERRQ(ierr);
1804a7e14dcfSSatish Balay     reason = TAO_CONVERGED_MINF;
1805a7e14dcfSSatish Balay   } else if (gnorm2 <= fatol && cnorm <=catol) {
180647a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to estimated f(X) - f(X*) = %g < %g\n",(double)gnorm2,(double)fatol);CHKERRQ(ierr);
1807a7e14dcfSSatish Balay     reason = TAO_CONVERGED_FATOL;
1808a7e14dcfSSatish Balay   } else if (f != 0 && gnorm2 / PetscAbsReal(f)<= frtol && cnorm/PetscMax(cnorm0,1.0) <= crtol) {
180947a47007SBarry 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);
1810a7e14dcfSSatish Balay     reason = TAO_CONVERGED_FRTOL;
1811a7e14dcfSSatish Balay   } else if (gnorm<= gatol && cnorm <=catol) {
181247a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to residual norm ||g(X)||=%g < %g\n",(double)gnorm,(double)gatol);CHKERRQ(ierr);
1813a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GATOL;
1814a7e14dcfSSatish Balay   } else if ( f!=0 && PetscAbsReal(gnorm/f) <= grtol && cnorm <= crtol) {
181547a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to residual ||g(X)||/|f(X)| =%g < %g\n",(double)(gnorm/f),(double)grtol);CHKERRQ(ierr);
1816a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GRTOL;
1817a7e14dcfSSatish Balay   } else if (gnorm0 != 0 && gnorm/gnorm0 <= gttol && cnorm <= crtol) {
181847a47007SBarry Smith     ierr = PetscInfo2(tao,"Converged due to relative residual norm ||g(X)||/||g(X0)|| = %g < %g\n",(double)(gnorm/gnorm0),(double)gttol);CHKERRQ(ierr);
1819a7e14dcfSSatish Balay     reason = TAO_CONVERGED_GTTOL;
1820a7e14dcfSSatish Balay   } else if (nfuncs > max_funcs){
1821a7e14dcfSSatish Balay     ierr = PetscInfo2(tao,"Exceeded maximum number of function evaluations: %D > %D\n", nfuncs,max_funcs);CHKERRQ(ierr);
1822a7e14dcfSSatish Balay     reason = TAO_DIVERGED_MAXFCN;
1823a7e14dcfSSatish Balay   } else if ( tao->lsflag != 0 ){
1824a7e14dcfSSatish Balay     ierr = PetscInfo(tao,"Tao Line Search failure.\n");CHKERRQ(ierr);
1825a7e14dcfSSatish Balay     reason = TAO_DIVERGED_LS_FAILURE;
1826a7e14dcfSSatish Balay   } else if (trradius < steptol && niter > 0){
182747a47007SBarry Smith     ierr = PetscInfo2(tao,"Trust region/step size too small: %g < %g\n", (double)trradius,(double)steptol);CHKERRQ(ierr);
1828a7e14dcfSSatish Balay     reason = TAO_CONVERGED_STEPTOL;
1829a7e14dcfSSatish Balay   } else if (niter > tao->max_it) {
1830a7e14dcfSSatish Balay     ierr = PetscInfo2(tao,"Exceeded maximum number of iterations: %D > %D\n",niter,tao->max_it);CHKERRQ(ierr);
1831a7e14dcfSSatish Balay     reason = TAO_DIVERGED_MAXITS;
1832a7e14dcfSSatish Balay   } else {
1833a7e14dcfSSatish Balay     reason = TAO_CONTINUE_ITERATING;
1834a7e14dcfSSatish Balay   }
1835a7e14dcfSSatish Balay   tao->reason = reason;
1836a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1837a7e14dcfSSatish Balay }
1838a7e14dcfSSatish Balay 
1839a7e14dcfSSatish Balay #undef __FUNCT__
1840a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetOptionsPrefix"
1841a7e14dcfSSatish Balay /*@C
1842a7e14dcfSSatish Balay    TaoSetOptionsPrefix - Sets the prefix used for searching for all
1843a7e14dcfSSatish Balay    TAO options in the database.
1844a7e14dcfSSatish Balay 
1845a7e14dcfSSatish Balay 
1846a7e14dcfSSatish Balay    Logically Collective on TaoSolver
1847a7e14dcfSSatish Balay 
1848a7e14dcfSSatish Balay    Input Parameters:
1849a7e14dcfSSatish Balay +  tao - the TaoSolver context
1850a7e14dcfSSatish Balay -  prefix - the prefix string to prepend to all TAO option requests
1851a7e14dcfSSatish Balay 
1852a7e14dcfSSatish Balay    Notes:
1853a7e14dcfSSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
1854a7e14dcfSSatish Balay    The first character of all runtime options is AUTOMATICALLY the hyphen.
1855a7e14dcfSSatish Balay 
1856a7e14dcfSSatish Balay    For example, to distinguish between the runtime options for two
1857a7e14dcfSSatish Balay    different TAO solvers, one could call
1858a7e14dcfSSatish Balay .vb
1859a7e14dcfSSatish Balay       TaoSetOptionsPrefix(tao1,"sys1_")
1860a7e14dcfSSatish Balay       TaoSetOptionsPrefix(tao2,"sys2_")
1861a7e14dcfSSatish Balay .ve
1862a7e14dcfSSatish Balay 
1863a7e14dcfSSatish Balay    This would enable use of different options for each system, such as
1864a7e14dcfSSatish Balay .vb
1865a7e14dcfSSatish Balay       -sys1_tao_method blmvm -sys1_tao_gtol 1.e-3
1866a7e14dcfSSatish Balay       -sys2_tao_method lmvm  -sys2_tao_gtol 1.e-4
1867a7e14dcfSSatish Balay .ve
1868a7e14dcfSSatish Balay 
1869a7e14dcfSSatish Balay 
1870a7e14dcfSSatish Balay    Level: advanced
1871a7e14dcfSSatish Balay 
1872a7e14dcfSSatish Balay .seealso: TaoAppendOptionsPrefix(), TaoGetOptionsPrefix()
1873a7e14dcfSSatish Balay @*/
1874a7e14dcfSSatish Balay 
1875a7e14dcfSSatish Balay PetscErrorCode TaoSetOptionsPrefix(TaoSolver tao, const char p[])
1876a7e14dcfSSatish Balay {
1877a7e14dcfSSatish Balay   PetscErrorCode ierr;
187847a47007SBarry Smith 
1879a7e14dcfSSatish Balay   PetscFunctionBegin;
1880a7e14dcfSSatish Balay   ierr = PetscObjectSetOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr);
1881a7e14dcfSSatish Balay   if (tao->linesearch) {
1882a7e14dcfSSatish Balay     ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr);
1883a7e14dcfSSatish Balay   }
1884a7e14dcfSSatish Balay   if (tao->ksp) {
1885a7e14dcfSSatish Balay     ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr);
1886a7e14dcfSSatish Balay   }
1887a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1888a7e14dcfSSatish Balay }
1889a7e14dcfSSatish Balay 
1890a7e14dcfSSatish Balay #undef __FUNCT__
1891a7e14dcfSSatish Balay #define __FUNCT__ "TaoAppendOptionsPrefix"
1892a7e14dcfSSatish Balay /*@C
1893a7e14dcfSSatish Balay    TaoAppendOptionsPrefix - Appends to the prefix used for searching for all
1894a7e14dcfSSatish Balay    TAO options in the database.
1895a7e14dcfSSatish Balay 
1896a7e14dcfSSatish Balay 
1897a7e14dcfSSatish Balay    Logically Collective on TaoSolver
1898a7e14dcfSSatish Balay 
1899a7e14dcfSSatish Balay    Input Parameters:
1900a7e14dcfSSatish Balay +  tao - the TaoSolver solver context
1901a7e14dcfSSatish Balay -  prefix - the prefix string to prepend to all TAO option requests
1902a7e14dcfSSatish Balay 
1903a7e14dcfSSatish Balay    Notes:
1904a7e14dcfSSatish Balay    A hyphen (-) must NOT be given at the beginning of the prefix name.
1905a7e14dcfSSatish Balay    The first character of all runtime options is AUTOMATICALLY the hyphen.
1906a7e14dcfSSatish Balay 
1907a7e14dcfSSatish Balay 
1908a7e14dcfSSatish Balay    Level: advanced
1909a7e14dcfSSatish Balay 
1910a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoGetOptionsPrefix()
1911a7e14dcfSSatish Balay @*/
1912a7e14dcfSSatish Balay PetscErrorCode TaoAppendOptionsPrefix(TaoSolver tao, const char p[])
1913a7e14dcfSSatish Balay {
1914a7e14dcfSSatish Balay   PetscErrorCode ierr;
191547a47007SBarry Smith 
1916a7e14dcfSSatish Balay   PetscFunctionBegin;
1917a7e14dcfSSatish Balay   ierr = PetscObjectAppendOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr);
1918a7e14dcfSSatish Balay   if (tao->linesearch) {
1919a7e14dcfSSatish Balay     ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr);
1920a7e14dcfSSatish Balay   }
1921a7e14dcfSSatish Balay   if (tao->ksp) {
1922a7e14dcfSSatish Balay     ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr);
1923a7e14dcfSSatish Balay   }
1924a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1925a7e14dcfSSatish Balay }
1926a7e14dcfSSatish Balay 
1927a7e14dcfSSatish Balay #undef __FUNCT__
1928a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetOptionsPrefix"
1929a7e14dcfSSatish Balay /*@C
1930a7e14dcfSSatish Balay   TaoGetOptionsPrefix - Gets the prefix used for searching for all
1931a7e14dcfSSatish Balay   TAO options in the database
1932a7e14dcfSSatish Balay 
1933a7e14dcfSSatish Balay   Not Collective
1934a7e14dcfSSatish Balay 
1935a7e14dcfSSatish Balay   Input Parameters:
1936a7e14dcfSSatish Balay . tao - the TaoSolver context
1937a7e14dcfSSatish Balay 
1938a7e14dcfSSatish Balay   Output Parameters:
1939a7e14dcfSSatish Balay . prefix - pointer to the prefix string used is returned
1940a7e14dcfSSatish Balay 
1941a7e14dcfSSatish Balay   Notes: On the fortran side, the user should pass in a string 'prefix' of
1942a7e14dcfSSatish Balay   sufficient length to hold the prefix.
1943a7e14dcfSSatish Balay 
1944a7e14dcfSSatish Balay   Level: advanced
1945a7e14dcfSSatish Balay 
1946a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoAppendOptionsPrefix()
1947a7e14dcfSSatish Balay @*/
1948a7e14dcfSSatish Balay PetscErrorCode TaoGetOptionsPrefix(TaoSolver tao, const char *p[])
1949a7e14dcfSSatish Balay {
195047a47007SBarry Smith    return PetscObjectGetOptionsPrefix((PetscObject)tao,p);
1951a7e14dcfSSatish Balay }
1952a7e14dcfSSatish Balay 
1953a7e14dcfSSatish Balay #undef __FUNCT__
1954a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetDefaultKSPType"
1955a7e14dcfSSatish Balay /*@
1956a7e14dcfSSatish Balay   TaoSetDefaultKSPType - Sets the default KSP type if a KSP object
1957a7e14dcfSSatish Balay   is created.
1958a7e14dcfSSatish Balay 
1959a7e14dcfSSatish Balay   Logically Collective on TaoSolver
1960a7e14dcfSSatish Balay 
1961a7e14dcfSSatish Balay   InputParameters:
1962a7e14dcfSSatish Balay + tao - the TaoSolver context
1963a7e14dcfSSatish Balay - ktype - the KSP type TAO will use by default
1964a7e14dcfSSatish Balay 
1965a7e14dcfSSatish Balay   Note: Some solvers may require a particular KSP type and will not work
1966a7e14dcfSSatish Balay   correctly if the default value is changed
1967a7e14dcfSSatish Balay 
1968a7e14dcfSSatish Balay   Options Database Key:
1969a7e14dcfSSatish Balay - tao_ksp_type
1970a7e14dcfSSatish Balay 
1971a7e14dcfSSatish Balay   Level: advanced
1972a7e14dcfSSatish Balay @*/
1973a7e14dcfSSatish Balay PetscErrorCode TaoSetDefaultKSPType(TaoSolver tao, KSPType ktype)
1974a7e14dcfSSatish Balay {
1975a7e14dcfSSatish Balay   const char     *prefix=0;
1976a7e14dcfSSatish Balay   char           *option=0;
1977a7e14dcfSSatish Balay   size_t         n1,n2;
1978a7e14dcfSSatish Balay   PetscErrorCode ierr;
1979a7e14dcfSSatish Balay 
198047a47007SBarry Smith   PetscFunctionBegin;
1981a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
1982a7e14dcfSSatish Balay   ierr = TaoGetOptionsPrefix(tao,&prefix);CHKERRQ(ierr);
1983a7e14dcfSSatish Balay   ierr = PetscStrlen(prefix,&n1);
1984a7e14dcfSSatish Balay   ierr = PetscStrlen("_ksp_type",&n2);
1985*0e660641SBarry Smith   ierr = PetscMalloc1(n1+n2+1,&option);
1986a7e14dcfSSatish Balay   ierr = PetscStrncpy(option,prefix,n1+1);
1987a7e14dcfSSatish Balay   ierr = PetscStrncat(option,"_ksp_type",n2+1);
1988a7e14dcfSSatish Balay   ierr = PetscOptionsSetValue(option,ktype);CHKERRQ(ierr);
1989a7e14dcfSSatish Balay   PetscFunctionReturn(0);
1990a7e14dcfSSatish Balay }
1991a7e14dcfSSatish Balay 
1992a7e14dcfSSatish Balay #undef __FUNCT__
1993a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetDefaulLineSearchType"
1994a7e14dcfSSatish Balay /*@
1995a7e14dcfSSatish Balay   TaoSetDefaultLineSearchType - Sets the default LineSearch type if a LineSearch object
1996a7e14dcfSSatish Balay   is created.
1997a7e14dcfSSatish Balay 
1998a7e14dcfSSatish Balay   Logically Collective on TaoSolver
1999a7e14dcfSSatish Balay 
2000a7e14dcfSSatish Balay   InputParameters:
2001a7e14dcfSSatish Balay + tao - the TaoSolver context
2002a7e14dcfSSatish Balay - lstype - the line search type TAO will use by default
2003a7e14dcfSSatish Balay 
2004a7e14dcfSSatish Balay   Note: Some solvers may require a particular line search type and will not work
2005a7e14dcfSSatish Balay   correctly if the default value is changed
2006a7e14dcfSSatish Balay 
2007a7e14dcfSSatish Balay   Options Database Key:
2008a7e14dcfSSatish Balay - tao_ls_type
2009a7e14dcfSSatish Balay 
2010a7e14dcfSSatish Balay   Level: advanced
2011a7e14dcfSSatish Balay @*/
2012a7e14dcfSSatish Balay PetscErrorCode TaoSetDefaultLineSearchType(TaoSolver tao, TaoLineSearchType lstype)
2013a7e14dcfSSatish Balay {
2014a7e14dcfSSatish Balay   const char     *prefix=0;
2015a7e14dcfSSatish Balay   char           *option=0;
2016a7e14dcfSSatish Balay   size_t         n1,n2;
2017a7e14dcfSSatish Balay   PetscErrorCode ierr;
2018a7e14dcfSSatish Balay 
201947a47007SBarry Smith   PetscFunctionBegin;
2020a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
2021a7e14dcfSSatish Balay   ierr = TaoGetOptionsPrefix(tao,&prefix);CHKERRQ(ierr);
2022a7e14dcfSSatish Balay   ierr = PetscStrlen(prefix,&n1);
2023a7e14dcfSSatish Balay   ierr = PetscStrlen("_ls_type",&n2);
2024*0e660641SBarry Smith   ierr = PetscMalloc1(n1+n2+1,&option);
2025a7e14dcfSSatish Balay   ierr = PetscStrncpy(option,prefix,n1+1);
2026a7e14dcfSSatish Balay   ierr = PetscStrncat(option,"_ls_type",n2+1);
2027a7e14dcfSSatish Balay   ierr = PetscOptionsSetValue(option,lstype);CHKERRQ(ierr);
2028a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2029a7e14dcfSSatish Balay }
2030a7e14dcfSSatish Balay 
2031a7e14dcfSSatish Balay #undef __FUNCT__
2032a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetDefaultPCType"
2033a7e14dcfSSatish Balay /*@
2034a7e14dcfSSatish Balay   TaoSetDefaultPCType - Sets the default PC type if a PC object
2035a7e14dcfSSatish Balay   is created.
2036a7e14dcfSSatish Balay 
2037a7e14dcfSSatish Balay   Logically Collective on TaoSolver
2038a7e14dcfSSatish Balay 
2039a7e14dcfSSatish Balay   InputParameters:
2040a7e14dcfSSatish Balay + tao - the TaoSolver context
2041a7e14dcfSSatish Balay - pctype - the preconditioner type TAO will use by default
2042a7e14dcfSSatish Balay 
2043a7e14dcfSSatish Balay   Note: Some solvers may require a particular PC type and will not work
2044a7e14dcfSSatish Balay   correctly if the default value is changed
2045a7e14dcfSSatish Balay 
2046a7e14dcfSSatish Balay   Options Database Key:
2047a7e14dcfSSatish Balay - tao_pc_type
2048a7e14dcfSSatish Balay 
2049a7e14dcfSSatish Balay   Level: advanced
2050a7e14dcfSSatish Balay @*/
2051a7e14dcfSSatish Balay PetscErrorCode TaoSetDefaultPCType(TaoSolver tao, PCType pctype)
2052a7e14dcfSSatish Balay {
2053a7e14dcfSSatish Balay   const char     *prefix=0;
2054a7e14dcfSSatish Balay   char           *option=0;
2055a7e14dcfSSatish Balay   size_t         n1,n2;
2056a7e14dcfSSatish Balay   PetscErrorCode ierr;
2057a7e14dcfSSatish Balay 
205847a47007SBarry Smith   PetscFunctionBegin;
2059a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
2060a7e14dcfSSatish Balay   ierr = TaoGetOptionsPrefix(tao,&prefix);CHKERRQ(ierr);
2061a7e14dcfSSatish Balay   ierr = PetscStrlen(prefix,&n1);
2062a7e14dcfSSatish Balay   ierr = PetscStrlen("_pc_type",&n2);
2063*0e660641SBarry Smith   ierr = PetscMalloc1(n1+n2+1,&option);
2064a7e14dcfSSatish Balay   ierr = PetscStrncpy(option,prefix,n1+1);
2065a7e14dcfSSatish Balay   ierr = PetscStrncat(option,"_pc_type",n2+1);
2066a7e14dcfSSatish Balay   ierr = PetscOptionsSetValue(option,pctype);CHKERRQ(ierr);
2067a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2068a7e14dcfSSatish Balay }
2069a7e14dcfSSatish Balay 
2070a7e14dcfSSatish Balay #undef __FUNCT__
2071a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetType"
2072a7e14dcfSSatish Balay /*@C
2073a7e14dcfSSatish Balay    TaoSetType - Sets the method for the unconstrained minimization solver.
2074a7e14dcfSSatish Balay 
2075a7e14dcfSSatish Balay    Collective on TaoSolver
2076a7e14dcfSSatish Balay 
2077a7e14dcfSSatish Balay    Input Parameters:
2078a7e14dcfSSatish Balay +  solver - the TaoSolver solver context
2079a7e14dcfSSatish Balay -  type - a known method
2080a7e14dcfSSatish Balay 
2081a7e14dcfSSatish Balay    Options Database Key:
2082a7e14dcfSSatish Balay +  -tao_method <type> - Sets the method; use -help for a list
2083a7e14dcfSSatish Balay    of available methods (for instance, "-tao_method tao_lmvm" or
2084a7e14dcfSSatish Balay    "-tao_method tao_tron")
2085a7e14dcfSSatish Balay -  -tao_type <type> - identical to -tao_method
2086a7e14dcfSSatish Balay 
2087a7e14dcfSSatish Balay    Available methods include:
2088a7e14dcfSSatish Balay +    tao_nls - Newton's method with line search for unconstrained minimization
2089a7e14dcfSSatish Balay .    tao_ntr - Newton's method with trust region for unconstrained minimization
2090a7e14dcfSSatish Balay .    tao_ntl - Newton's method with trust region, line search for unconstrained minimization
2091a7e14dcfSSatish Balay .    tao_lmvm - Limited memory variable metric method for unconstrained minimization
2092a7e14dcfSSatish Balay .    tao_cg - Nonlinear conjugate gradient method for unconstrained minimization
2093a7e14dcfSSatish Balay .    tao_nm - Nelder-Mead algorithm for derivate-free unconstrained minimization
2094a7e14dcfSSatish Balay .    tao_tron - Newton Trust Region method for bound constrained minimization
2095a7e14dcfSSatish Balay .    tao_gpcg - Newton Trust Region method for quadratic bound constrained minimization
2096a7e14dcfSSatish Balay .    tao_blmvm - Limited memory variable metric method for bound constrained minimization
2097a7e14dcfSSatish Balay +    tao_pounders - Model-based algorithm pounder extended for nonlinear least squares
2098a7e14dcfSSatish Balay 
2099a7e14dcfSSatish Balay   Level: intermediate
2100a7e14dcfSSatish Balay 
2101a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoGetType()
2102a7e14dcfSSatish Balay 
2103a7e14dcfSSatish Balay @*/
2104a7e14dcfSSatish Balay PetscErrorCode TaoSetType(TaoSolver tao, const TaoSolverType type)
2105a7e14dcfSSatish Balay {
2106a7e14dcfSSatish Balay     PetscErrorCode ierr;
2107a7e14dcfSSatish Balay     PetscErrorCode (*create_xxx)(TaoSolver);
2108a7e14dcfSSatish Balay     PetscBool      issame;
2109a7e14dcfSSatish Balay 
2110a7e14dcfSSatish Balay     PetscFunctionBegin;
2111a7e14dcfSSatish Balay     PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
2112a7e14dcfSSatish Balay 
2113a7e14dcfSSatish Balay     ierr = PetscObjectTypeCompare((PetscObject)tao,type,&issame);CHKERRQ(ierr);
2114a7e14dcfSSatish Balay     if (issame) PetscFunctionReturn(0);
2115a7e14dcfSSatish Balay 
2116a7e14dcfSSatish Balay     ierr = PetscFunctionListFind(TaoSolverList, type, (void(**)(void))&create_xxx);CHKERRQ(ierr);
211747a47007SBarry Smith     if (!create_xxx) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested TaoSolver type %s",type);
2118a7e14dcfSSatish Balay 
2119a7e14dcfSSatish Balay     /* Destroy the existing solver information */
2120a7e14dcfSSatish Balay     if (tao->ops->destroy) {
2121a7e14dcfSSatish Balay         ierr = (*tao->ops->destroy)(tao);CHKERRQ(ierr);
2122a7e14dcfSSatish Balay     }
2123a7e14dcfSSatish Balay     ierr = KSPDestroy(&tao->ksp);CHKERRQ(ierr);
2124a7e14dcfSSatish Balay     ierr = TaoLineSearchDestroy(&tao->linesearch);CHKERRQ(ierr);
2125a7e14dcfSSatish Balay     ierr = VecDestroy(&tao->gradient);CHKERRQ(ierr);
2126a7e14dcfSSatish Balay     ierr = VecDestroy(&tao->stepdirection);CHKERRQ(ierr);
2127a7e14dcfSSatish Balay 
2128a7e14dcfSSatish Balay     tao->ops->setup = 0;
2129a7e14dcfSSatish Balay     tao->ops->solve = 0;
2130a7e14dcfSSatish Balay     tao->ops->view  = 0;
2131a7e14dcfSSatish Balay     tao->ops->setfromoptions = 0;
2132a7e14dcfSSatish Balay     tao->ops->destroy = 0;
2133a7e14dcfSSatish Balay 
2134a7e14dcfSSatish Balay     tao->setupcalled = PETSC_FALSE;
2135a7e14dcfSSatish Balay 
2136a7e14dcfSSatish Balay     ierr = (*create_xxx)(tao);CHKERRQ(ierr);
2137a7e14dcfSSatish Balay     ierr = PetscObjectChangeTypeName((PetscObject)tao,type);CHKERRQ(ierr);
2138a7e14dcfSSatish Balay     PetscFunctionReturn(0);
2139a7e14dcfSSatish Balay }
214047a47007SBarry Smith 
2141a7e14dcfSSatish Balay #undef __FUNCT__
2142a7e14dcfSSatish Balay #define __FUNCT__ "TaoSolverRegister"
2143a7e14dcfSSatish Balay /*MC
2144a7e14dcfSSatish Balay    TaoSolverRegister - Adds a method to the TAO package for unconstrained minimization.
2145a7e14dcfSSatish Balay 
2146a7e14dcfSSatish Balay    Synopsis:
2147a7e14dcfSSatish Balay    TaoSolverRegister(char *name_solver,char *path,char *name_Create,int (*routine_Create)(TaoSolver))
2148a7e14dcfSSatish Balay 
2149a7e14dcfSSatish Balay    Not collective
2150a7e14dcfSSatish Balay 
2151a7e14dcfSSatish Balay    Input Parameters:
2152a7e14dcfSSatish Balay +  sname - name of a new user-defined solver
2153a7e14dcfSSatish Balay -  func - routine to Create method context
2154a7e14dcfSSatish Balay 
2155a7e14dcfSSatish Balay    Notes:
2156a7e14dcfSSatish Balay    TaoSolverRegister() may be called multiple times to add several user-defined solvers.
2157a7e14dcfSSatish Balay 
2158a7e14dcfSSatish Balay    Sample usage:
2159a7e14dcfSSatish Balay .vb
2160a7e14dcfSSatish Balay    TaoSolverRegister("my_solver",MySolverCreate);
2161a7e14dcfSSatish Balay .ve
2162a7e14dcfSSatish Balay 
2163a7e14dcfSSatish Balay    Then, your solver can be chosen with the procedural interface via
2164a7e14dcfSSatish Balay $     TaoSetType(tao,"my_solver")
2165a7e14dcfSSatish Balay    or at runtime via the option
2166a7e14dcfSSatish Balay $     -tao_method my_solver
2167a7e14dcfSSatish Balay 
2168a7e14dcfSSatish Balay    Level: advanced
2169a7e14dcfSSatish Balay 
2170a7e14dcfSSatish Balay .seealso: TaoSolverRegisterAll(), TaoSolverRegisterDestroy()
2171a7e14dcfSSatish Balay M*/
2172a7e14dcfSSatish Balay PetscErrorCode TaoSolverRegister(const char sname[], PetscErrorCode (*func)(TaoSolver))
2173a7e14dcfSSatish Balay {
2174a7e14dcfSSatish Balay   PetscErrorCode ierr;
2175a7e14dcfSSatish Balay 
2176a7e14dcfSSatish Balay   PetscFunctionBegin;
2177a7e14dcfSSatish Balay   ierr = PetscFunctionListAdd(&TaoSolverList,sname, (void (*)(void))func);CHKERRQ(ierr);
2178a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2179a7e14dcfSSatish Balay }
2180a7e14dcfSSatish Balay 
2181a7e14dcfSSatish Balay #undef __FUNCT__
2182a7e14dcfSSatish Balay #define __FUNCT__ "TaoSolverRegisterDestroy"
2183a7e14dcfSSatish Balay /*@C
2184a7e14dcfSSatish Balay    TaoSolverRegisterDestroy - Frees the list of minimization solvers that were
2185a7e14dcfSSatish Balay    registered by TaoSolverRegisterDynamic().
2186a7e14dcfSSatish Balay 
2187a7e14dcfSSatish Balay    Not Collective
2188a7e14dcfSSatish Balay 
2189a7e14dcfSSatish Balay    Level: advanced
2190a7e14dcfSSatish Balay 
2191a7e14dcfSSatish Balay .seealso: TaoSolverRegisterAll(), TaoSolverRegister()
2192a7e14dcfSSatish Balay @*/
2193a7e14dcfSSatish Balay PetscErrorCode TaoSolverRegisterDestroy(void)
2194a7e14dcfSSatish Balay {
2195a7e14dcfSSatish Balay   PetscErrorCode ierr;
2196a7e14dcfSSatish Balay   PetscFunctionBegin;
2197a7e14dcfSSatish Balay   ierr = PetscFunctionListDestroy(&TaoSolverList);CHKERRQ(ierr);
2198a7e14dcfSSatish Balay   TaoSolverRegisterAllCalled = PETSC_FALSE;
2199a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2200a7e14dcfSSatish Balay }
220147a47007SBarry Smith 
2202a7e14dcfSSatish Balay #undef __FUNCT__
2203a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetTerminationReason"
2204a7e14dcfSSatish Balay /*@
2205a7e14dcfSSatish Balay   TaoSetTerminationReason - Sets the termination flag on a TaoSolver object
2206a7e14dcfSSatish Balay 
2207a7e14dcfSSatish Balay   Logically Collective on TaoSolver
2208a7e14dcfSSatish Balay 
2209a7e14dcfSSatish Balay   Input Parameters:
2210a7e14dcfSSatish Balay + tao - the TaoSolver context
2211a7e14dcfSSatish Balay - reason - one of
2212a7e14dcfSSatish Balay $     TAO_CONVERGED_ATOL (2),
2213a7e14dcfSSatish Balay $     TAO_CONVERGED_RTOL (3),
2214a7e14dcfSSatish Balay $     TAO_CONVERGED_STEPTOL (4),
2215a7e14dcfSSatish Balay $     TAO_CONVERGED_MINF (5),
2216a7e14dcfSSatish Balay $     TAO_CONVERGED_USER (6),
2217a7e14dcfSSatish Balay $     TAO_DIVERGED_MAXITS (-2),
2218a7e14dcfSSatish Balay $     TAO_DIVERGED_NAN (-4),
2219a7e14dcfSSatish Balay $     TAO_DIVERGED_MAXFCN (-5),
2220a7e14dcfSSatish Balay $     TAO_DIVERGED_LS_FAILURE (-6),
2221a7e14dcfSSatish Balay $     TAO_DIVERGED_TR_REDUCTION (-7),
2222a7e14dcfSSatish Balay $     TAO_DIVERGED_USER (-8),
2223a7e14dcfSSatish Balay $     TAO_CONTINUE_ITERATING (0)
2224a7e14dcfSSatish Balay 
2225a7e14dcfSSatish Balay    Level: intermediate
2226a7e14dcfSSatish Balay 
2227a7e14dcfSSatish Balay @*/
2228a7e14dcfSSatish Balay PetscErrorCode TaoSetTerminationReason(TaoSolver tao, TaoSolverTerminationReason reason)
2229a7e14dcfSSatish Balay {
2230a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
2231a7e14dcfSSatish Balay   PetscFunctionBegin;
2232a7e14dcfSSatish Balay   tao->reason = reason;
2233a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2234a7e14dcfSSatish Balay }
2235a7e14dcfSSatish Balay 
2236a7e14dcfSSatish Balay #undef __FUNCT__
2237a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetTerminationReason"
2238a7e14dcfSSatish Balay /*@
2239a7e14dcfSSatish Balay    TaoGetTerminationReason - Gets the reason the TaoSolver iteration was stopped.
2240a7e14dcfSSatish Balay 
2241a7e14dcfSSatish Balay    Not Collective
2242a7e14dcfSSatish Balay 
2243a7e14dcfSSatish Balay    Input Parameter:
2244a7e14dcfSSatish Balay .  tao - the TaoSolver solver context
2245a7e14dcfSSatish Balay 
2246a7e14dcfSSatish Balay    Output Parameter:
2247a7e14dcfSSatish Balay .  reason - one of
2248a7e14dcfSSatish Balay 
2249a7e14dcfSSatish Balay 
2250a7e14dcfSSatish Balay $  TAO_CONVERGED_FATOL (1)           f(X)-f(X*) <= fatol
2251a7e14dcfSSatish Balay $  TAO_CONVERGED_FRTOL (2)           |f(X) - f(X*)|/|f(X)| < frtol
2252a7e14dcfSSatish Balay $  TAO_CONVERGED_GATOL (3)           ||g(X)|| < gatol
2253a7e14dcfSSatish Balay $  TAO_CONVERGED_GRTOL (4)           ||g(X)|| / f(X)  < grtol
2254a7e14dcfSSatish Balay $  TAO_CONVERGED_GTTOL (5)           ||g(X)|| / ||g(X0)|| < gttol
2255a7e14dcfSSatish Balay $  TAO_CONVERGED_STEPTOL (6)         step size small
2256a7e14dcfSSatish Balay $  TAO_CONVERGED_MINF (7)            F < F_min
2257a7e14dcfSSatish Balay $  TAO_CONVERGED_USER (8)            User defined
2258a7e14dcfSSatish Balay 
2259a7e14dcfSSatish Balay $  TAO_DIVERGED_MAXITS (-2)          its > maxits
2260a7e14dcfSSatish Balay $  TAO_DIVERGED_NAN (-4)             Numerical problems
2261a7e14dcfSSatish Balay $  TAO_DIVERGED_MAXFCN (-5)          fevals > max_funcsals
2262a7e14dcfSSatish Balay $  TAO_DIVERGED_LS_FAILURE (-6)      line search failure
2263a7e14dcfSSatish Balay $  TAO_DIVERGED_TR_REDUCTION (-7)    trust region failure
2264a7e14dcfSSatish Balay $  TAO_DIVERGED_USER(-8)             (user defined)
2265a7e14dcfSSatish Balay 
2266a7e14dcfSSatish Balay $  TAO_CONTINUE_ITERATING (0)
2267a7e14dcfSSatish Balay 
2268a7e14dcfSSatish Balay    where
2269a7e14dcfSSatish Balay +  X - current solution
2270a7e14dcfSSatish Balay .  X0 - initial guess
2271a7e14dcfSSatish Balay .  f(X) - current function value
2272a7e14dcfSSatish Balay .  f(X*) - true solution (estimated)
2273a7e14dcfSSatish Balay .  g(X) - current gradient
2274a7e14dcfSSatish Balay .  its - current iterate number
2275a7e14dcfSSatish Balay .  maxits - maximum number of iterates
2276a7e14dcfSSatish Balay .  fevals - number of function evaluations
2277a7e14dcfSSatish Balay -  max_funcsals - maximum number of function evaluations
2278a7e14dcfSSatish Balay 
2279a7e14dcfSSatish Balay    Level: intermediate
2280a7e14dcfSSatish Balay 
2281a7e14dcfSSatish Balay .seealso: TaoSetConvergenceTest(), TaoSetTolerances()
2282a7e14dcfSSatish Balay 
2283a7e14dcfSSatish Balay @*/
2284a7e14dcfSSatish Balay PetscErrorCode TaoGetTerminationReason(TaoSolver tao, TaoSolverTerminationReason *reason)
2285a7e14dcfSSatish Balay {
2286a7e14dcfSSatish Balay   PetscFunctionBegin;
2287a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
2288a7e14dcfSSatish Balay   PetscValidPointer(reason,2);
2289a7e14dcfSSatish Balay   *reason = tao->reason;
2290a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2291a7e14dcfSSatish Balay }
2292a7e14dcfSSatish Balay 
2293a7e14dcfSSatish Balay #undef __FUNCT__
2294a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetSolutionStatus"
2295a7e14dcfSSatish Balay /*@
2296a7e14dcfSSatish Balay   TaoGetSolutionStatus - Get the current iterate, objective value,
2297a7e14dcfSSatish Balay   residual, infeasibility, and termination
2298a7e14dcfSSatish Balay 
2299a7e14dcfSSatish Balay   Not Collective
2300a7e14dcfSSatish Balay 
2301a7e14dcfSSatish Balay    Input Parameters:
2302a7e14dcfSSatish Balay .  tao - the TaoSolver context
2303a7e14dcfSSatish Balay 
2304a7e14dcfSSatish Balay    Output Parameters:
2305a7e14dcfSSatish Balay +  iterate - the current iterate number (>=0)
2306a7e14dcfSSatish Balay .  f - the current function value
2307a7e14dcfSSatish Balay .  gnorm - the square of the gradient norm, duality gap, or other measure
2308a7e14dcfSSatish Balay indicating distance from optimality.
2309a7e14dcfSSatish Balay .  cnorm - the infeasibility of the current solution with regard to the constraints.
2310a7e14dcfSSatish Balay .  xdiff - the step length or trust region radius of the most recent iterate.
2311a7e14dcfSSatish Balay -  reason - The termination reason, which can equal TAO_CONTINUE_ITERATING
2312a7e14dcfSSatish Balay 
2313a7e14dcfSSatish Balay    Level: intermediate
2314a7e14dcfSSatish Balay 
2315a7e14dcfSSatish Balay    Note:
2316a7e14dcfSSatish Balay    TAO returns the values set by the solvers in the routine TaoMonitor().
2317a7e14dcfSSatish Balay 
2318a7e14dcfSSatish Balay    Note:
231947a47007SBarry Smith    If any of the output arguments are set to NULL, no corresponding value will be returned.
2320a7e14dcfSSatish Balay 
2321a7e14dcfSSatish Balay 
2322a7e14dcfSSatish Balay .seealso: TaoMonitor(), TaoGetTerminationReason()
2323a7e14dcfSSatish Balay @*/
2324a7e14dcfSSatish Balay PetscErrorCode TaoGetSolutionStatus(TaoSolver tao, PetscInt *its, PetscReal *f, PetscReal *gnorm, PetscReal *cnorm, PetscReal *xdiff, TaoSolverTerminationReason *reason)
2325a7e14dcfSSatish Balay {
2326a7e14dcfSSatish Balay   PetscFunctionBegin;
2327a7e14dcfSSatish Balay   if (its) *its=tao->niter;
2328a7e14dcfSSatish Balay   if (f) *f=tao->fc;
2329a7e14dcfSSatish Balay   if (gnorm) *gnorm=tao->residual;
2330a7e14dcfSSatish Balay   if (cnorm) *cnorm=tao->cnorm;
2331a7e14dcfSSatish Balay   if (reason) *reason=tao->reason;
2332a7e14dcfSSatish Balay   if (xdiff) *xdiff=tao->step;
2333a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2334a7e14dcfSSatish Balay }
2335a7e14dcfSSatish Balay 
2336a7e14dcfSSatish Balay 
2337a7e14dcfSSatish Balay #undef __FUNCT__
2338a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetType"
2339a7e14dcfSSatish Balay /*@C
2340a7e14dcfSSatish Balay    TaoGetType - Gets the current TaoSolver algorithm.
2341a7e14dcfSSatish Balay 
2342a7e14dcfSSatish Balay    Not Collective
2343a7e14dcfSSatish Balay 
2344a7e14dcfSSatish Balay    Input Parameter:
2345a7e14dcfSSatish Balay .  tao - the TaoSolver solver context
2346a7e14dcfSSatish Balay 
2347a7e14dcfSSatish Balay    Output Parameter:
2348a7e14dcfSSatish Balay .  type - TaoSolver method
2349a7e14dcfSSatish Balay 
2350a7e14dcfSSatish Balay    Level: intermediate
2351a7e14dcfSSatish Balay 
2352a7e14dcfSSatish Balay @*/
2353a7e14dcfSSatish Balay PetscErrorCode TaoGetType(TaoSolver tao, const TaoSolverType *type)
2354a7e14dcfSSatish Balay {
2355a7e14dcfSSatish Balay   PetscFunctionBegin;
2356a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
2357a7e14dcfSSatish Balay   PetscValidPointer(type,2);
2358a7e14dcfSSatish Balay   *type=((PetscObject)tao)->type_name;
2359a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2360a7e14dcfSSatish Balay }
2361a7e14dcfSSatish Balay 
2362a7e14dcfSSatish Balay #undef __FUNCT__
2363a7e14dcfSSatish Balay #define __FUNCT__ "TaoMonitor"
2364a7e14dcfSSatish Balay /*@C
2365a7e14dcfSSatish Balay   TaoMonitor - Monitor the solver and the current solution.  This
2366a7e14dcfSSatish Balay   routine will record the iteration number and residual statistics,
2367a7e14dcfSSatish Balay   call any monitors specified by the user, and calls the convergence-check routine.
2368a7e14dcfSSatish Balay 
2369a7e14dcfSSatish Balay    Input Parameters:
2370a7e14dcfSSatish Balay +  tao - the TaoSolver context
2371a7e14dcfSSatish Balay .  its - the current iterate number (>=0)
2372a7e14dcfSSatish Balay .  f - the current objective function value
2373a7e14dcfSSatish Balay .  res - the gradient norm, square root of the duality gap, or other measure
2374a7e14dcfSSatish Balay indicating distince from optimality.  This measure will be recorded and
2375a7e14dcfSSatish Balay used for some termination tests.
2376a7e14dcfSSatish Balay .  cnorm - the infeasibility of the current solution with regard to the constraints.
2377a7e14dcfSSatish Balay -  steplength - multiple of the step direction added to the previous iterate.
2378a7e14dcfSSatish Balay 
2379a7e14dcfSSatish Balay    Output Parameters:
2380a7e14dcfSSatish Balay .  reason - The termination reason, which can equal TAO_CONTINUE_ITERATING
2381a7e14dcfSSatish Balay 
2382a7e14dcfSSatish Balay    Options Database Key:
2383a7e14dcfSSatish Balay .  -tao_monitor - Use the default monitor, which prints statistics to standard output
2384a7e14dcfSSatish Balay 
2385a7e14dcfSSatish Balay .seealso TaoGetTerminationReason(), TaoDefaultMonitor(), TaoSetMonitor()
2386a7e14dcfSSatish Balay 
2387a7e14dcfSSatish Balay    Level: developer
2388a7e14dcfSSatish Balay 
2389a7e14dcfSSatish Balay @*/
2390a7e14dcfSSatish Balay PetscErrorCode TaoMonitor(TaoSolver tao, PetscInt its, PetscReal f, PetscReal res, PetscReal cnorm, PetscReal steplength, TaoSolverTerminationReason *reason)
2391a7e14dcfSSatish Balay {
2392a7e14dcfSSatish Balay   PetscErrorCode ierr;
239347a47007SBarry Smith   PetscInt       i;
239447a47007SBarry Smith 
2395a7e14dcfSSatish Balay   PetscFunctionBegin;
2396a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
2397a7e14dcfSSatish Balay   tao->fc = f;
2398a7e14dcfSSatish Balay   tao->residual = res;
2399a7e14dcfSSatish Balay   tao->cnorm = cnorm;
2400a7e14dcfSSatish Balay   tao->step = steplength;
2401a7e14dcfSSatish Balay   tao->niter=its;
2402a7e14dcfSSatish Balay   if (its == 0) {
2403a7e14dcfSSatish Balay     tao->cnorm0 = cnorm; tao->gnorm0 = res;
2404a7e14dcfSSatish Balay   }
2405a7e14dcfSSatish Balay   TaoLogHistory(tao,f,res,cnorm);
240647a47007SBarry Smith   if (PetscIsInfOrNanReal(f) || PetscIsInfOrNanReal(res)) SETERRQ(PETSC_COMM_SELF,1, "User provided compute function generated Inf or NaN");
2407a7e14dcfSSatish Balay   if (tao->ops->convergencetest) {
2408a7e14dcfSSatish Balay     ierr = (*tao->ops->convergencetest)(tao,tao->cnvP);CHKERRQ(ierr);
2409a7e14dcfSSatish Balay   }
2410a7e14dcfSSatish Balay   for (i=0;i<tao->numbermonitors;i++) {
2411a7e14dcfSSatish Balay     ierr = (*tao->monitor[i])(tao,tao->monitorcontext[i]);CHKERRQ(ierr);
2412a7e14dcfSSatish Balay   }
2413a7e14dcfSSatish Balay   *reason = tao->reason;
2414a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2415a7e14dcfSSatish Balay }
2416a7e14dcfSSatish Balay 
2417a7e14dcfSSatish Balay #undef __FUNCT__
2418a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetHistory"
2419a7e14dcfSSatish Balay /*@
2420a7e14dcfSSatish Balay    TaoSetHistory - Sets the array used to hold the convergence history.
2421a7e14dcfSSatish Balay 
2422a7e14dcfSSatish Balay    Logically Collective on TaoSolver
2423a7e14dcfSSatish Balay 
2424a7e14dcfSSatish Balay    Input Parameters:
2425a7e14dcfSSatish Balay +  tao - the TaoSolver solver context
2426a7e14dcfSSatish Balay .  obj   - array to hold objective value history
2427a7e14dcfSSatish Balay .  resid - array to hold residual history
2428a7e14dcfSSatish Balay .  cnorm - array to hold constraint violation history
2429a7e14dcfSSatish Balay .  na  - size of obj, resid, and cnorm
2430a7e14dcfSSatish Balay -  reset - PetscTrue indicates each new minimization resets the history counter to zero,
2431a7e14dcfSSatish Balay            else it continues storing new values for new minimizations after the old ones
2432a7e14dcfSSatish Balay 
2433a7e14dcfSSatish Balay    Notes:
2434a7e14dcfSSatish Balay    If set, TAO will fill the given arrays with the indicated
2435a7e14dcfSSatish Balay    information at each iteration.  If no information is desired
243647a47007SBarry Smith    for a given array, then NULL may be used.
2437a7e14dcfSSatish Balay 
2438a7e14dcfSSatish Balay    This routine is useful, e.g., when running a code for purposes
2439a7e14dcfSSatish Balay    of accurate performance monitoring, when no I/O should be done
2440a7e14dcfSSatish Balay    during the section of code that is being timed.
2441a7e14dcfSSatish Balay 
2442a7e14dcfSSatish Balay    Level: intermediate
2443a7e14dcfSSatish Balay 
2444a7e14dcfSSatish Balay .seealso: TaoGetHistory()
2445a7e14dcfSSatish Balay 
2446a7e14dcfSSatish Balay @*/
2447a7e14dcfSSatish Balay PetscErrorCode TaoSetHistory(TaoSolver tao, PetscReal *obj, PetscReal *resid, PetscReal *cnorm, PetscInt na,PetscBool reset)
2448a7e14dcfSSatish Balay {
2449a7e14dcfSSatish Balay   PetscFunctionBegin;
2450a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
2451a7e14dcfSSatish Balay   tao->hist_obj = obj;
2452a7e14dcfSSatish Balay   tao->hist_resid = resid;
2453a7e14dcfSSatish Balay   tao->hist_cnorm = cnorm;
2454a7e14dcfSSatish Balay   tao->hist_max   = na;
2455a7e14dcfSSatish Balay   tao->hist_reset = reset;
2456a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2457a7e14dcfSSatish Balay }
2458a7e14dcfSSatish Balay 
2459a7e14dcfSSatish Balay #undef __FUNCT__
2460a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetHistory"
2461a7e14dcfSSatish Balay /*@C
2462a7e14dcfSSatish Balay    TaoGetHistory - Gets the array used to hold the convergence history.
2463a7e14dcfSSatish Balay 
2464a7e14dcfSSatish Balay    Collective on TaoSolver
2465a7e14dcfSSatish Balay 
2466a7e14dcfSSatish Balay    Input Parameter:
2467a7e14dcfSSatish Balay .  tao - the TaoSolver context
2468a7e14dcfSSatish Balay 
2469a7e14dcfSSatish Balay    Output Parameters:
2470a7e14dcfSSatish Balay +  obj   - array used to hold objective value history
2471a7e14dcfSSatish Balay .  resid - array used to hold residual history
2472a7e14dcfSSatish Balay .  cnorm - array used to hold constraint violation history
2473a7e14dcfSSatish Balay -  nhist  - size of obj, resid, and cnorm (will be less than or equal to na given in TaoSetHistory)
2474a7e14dcfSSatish Balay 
2475a7e14dcfSSatish Balay 
2476a7e14dcfSSatish Balay    Notes:
2477a7e14dcfSSatish Balay     The calling sequence for this routine in Fortran is
2478a7e14dcfSSatish Balay $   call TaoGetHistory(TaoSolver tao, integer nhist, integer info)
2479a7e14dcfSSatish Balay 
2480a7e14dcfSSatish Balay    This routine is useful, e.g., when running a code for purposes
2481a7e14dcfSSatish Balay    of accurate performance monitoring, when no I/O should be done
2482a7e14dcfSSatish Balay    during the section of code that is being timed.
2483a7e14dcfSSatish Balay 
2484a7e14dcfSSatish Balay    Level: advanced
2485a7e14dcfSSatish Balay 
2486a7e14dcfSSatish Balay .seealso: TaoSetHistory()
2487a7e14dcfSSatish Balay 
2488a7e14dcfSSatish Balay @*/
2489a7e14dcfSSatish Balay PetscErrorCode TaoGetHistory(TaoSolver tao, PetscReal **obj, PetscReal **resid, PetscReal **cnorm, PetscInt *nhist)
2490a7e14dcfSSatish Balay {
2491a7e14dcfSSatish Balay   PetscFunctionBegin;
2492a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
2493a7e14dcfSSatish Balay   if (obj)   *obj   = tao->hist_obj;
2494a7e14dcfSSatish Balay   if (cnorm) *cnorm = tao->hist_cnorm;
2495a7e14dcfSSatish Balay   if (resid) *resid = tao->hist_resid;
2496a7e14dcfSSatish Balay   if (nhist) *nhist   = tao->hist_len;
2497a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2498a7e14dcfSSatish Balay }
2499a7e14dcfSSatish Balay 
2500a7e14dcfSSatish Balay #undef __FUNCT__
2501a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetApplicationContext"
2502a7e14dcfSSatish Balay /*@
2503a7e14dcfSSatish Balay    TaoSetApplicationContext - Sets the optional user-defined context for
2504a7e14dcfSSatish Balay    a solver.
2505a7e14dcfSSatish Balay 
2506a7e14dcfSSatish Balay    Logically Collective on TaoSolver
2507a7e14dcfSSatish Balay 
2508a7e14dcfSSatish Balay    Input Parameters:
2509a7e14dcfSSatish Balay +  tao  - the TaoSolver context
2510a7e14dcfSSatish Balay -  usrP - optional user context
2511a7e14dcfSSatish Balay 
2512a7e14dcfSSatish Balay    Level: intermediate
2513a7e14dcfSSatish Balay 
2514a7e14dcfSSatish Balay .seealso: TaoGetApplicationContext(), TaoSetApplicationContext()
2515a7e14dcfSSatish Balay @*/
2516a7e14dcfSSatish Balay PetscErrorCode  TaoSetApplicationContext(TaoSolver tao,void *usrP)
2517a7e14dcfSSatish Balay {
2518a7e14dcfSSatish Balay   PetscFunctionBegin;
2519a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
2520a7e14dcfSSatish Balay   tao->user = usrP;
2521a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2522a7e14dcfSSatish Balay }
2523a7e14dcfSSatish Balay 
2524a7e14dcfSSatish Balay #undef __FUNCT__
2525a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetApplicationContext"
2526a7e14dcfSSatish Balay /*@
2527a7e14dcfSSatish Balay    TaoGetApplicationContext - Gets the user-defined context for a
2528a7e14dcfSSatish Balay    TAO solvers.
2529a7e14dcfSSatish Balay 
2530a7e14dcfSSatish Balay    Not Collective
2531a7e14dcfSSatish Balay 
2532a7e14dcfSSatish Balay    Input Parameter:
2533a7e14dcfSSatish Balay .  tao  - TaoSolver context
2534a7e14dcfSSatish Balay 
2535a7e14dcfSSatish Balay    Output Parameter:
2536a7e14dcfSSatish Balay .  usrP - user context
2537a7e14dcfSSatish Balay 
2538a7e14dcfSSatish Balay    Level: intermediate
2539a7e14dcfSSatish Balay 
2540a7e14dcfSSatish Balay .seealso: TaoSetApplicationContext()
2541a7e14dcfSSatish Balay @*/
2542a7e14dcfSSatish Balay PetscErrorCode  TaoGetApplicationContext(TaoSolver tao,void *usrP)
2543a7e14dcfSSatish Balay {
2544a7e14dcfSSatish Balay   PetscFunctionBegin;
2545a7e14dcfSSatish Balay   PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1);
2546a7e14dcfSSatish Balay   *(void**)usrP = tao->user;
2547a7e14dcfSSatish Balay   PetscFunctionReturn(0);
2548a7e14dcfSSatish Balay }
2549