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; 6*47a47007SBarry 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); 58*47a47007SBarry 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 84*47a47007SBarry Smith tao->solution=NULL; 85*47a47007SBarry Smith tao->gradient=NULL; 86*47a47007SBarry Smith tao->sep_objective = NULL; 87*47a47007SBarry Smith tao->constraints=NULL; 88*47a47007SBarry Smith tao->constraints_equality=NULL; 89*47a47007SBarry Smith tao->constraints_inequality=NULL; 90*47a47007SBarry Smith tao->stepdirection=NULL; 91*47a47007SBarry Smith tao->XL = NULL; 92*47a47007SBarry Smith tao->XU = NULL; 93*47a47007SBarry Smith tao->IL = NULL; 94*47a47007SBarry Smith tao->IU = NULL; 95*47a47007SBarry Smith tao->DI = NULL; 96*47a47007SBarry Smith tao->DE = NULL; 97*47a47007SBarry Smith tao->hessian = NULL; 98*47a47007SBarry Smith tao->hessian_pre = NULL; 99*47a47007SBarry Smith tao->jacobian = NULL; 100*47a47007SBarry Smith tao->jacobian_pre = NULL; 101*47a47007SBarry Smith tao->jacobian_state = NULL; 102*47a47007SBarry Smith tao->jacobian_state_pre = NULL; 103*47a47007SBarry Smith tao->jacobian_state_inv = NULL; 104*47a47007SBarry Smith tao->jacobian_design = NULL; 105*47a47007SBarry Smith tao->jacobian_design_pre = NULL; 106*47a47007SBarry Smith tao->jacobian_equality = NULL; 107*47a47007SBarry Smith tao->jacobian_equality_pre = NULL; 108*47a47007SBarry Smith tao->jacobian_inequality = NULL; 109*47a47007SBarry Smith tao->jacobian_inequality_pre = NULL; 110*47a47007SBarry Smith tao->state_is = NULL; 111*47a47007SBarry 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; 129*47a47007SBarry Smith tao->hist_obj = NULL; 130*47a47007SBarry Smith tao->hist_resid = NULL; 131*47a47007SBarry 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; 171*47a47007SBarry 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; 226*47a47007SBarry Smith 227a7e14dcfSSatish Balay PetscFunctionBegin; 228a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao, TAOSOLVER_CLASSID,1); 229a7e14dcfSSatish Balay if (tao->setupcalled) PetscFunctionReturn(0); 230a7e14dcfSSatish Balay 231*47a47007SBarry 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; 257*47a47007SBarry 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); 273*47a47007SBarry Smith (*tao)->jacobian_state_inv = NULL; 274a7e14dcfSSatish Balay } 275a7e14dcfSSatish Balay } 276a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->solution);CHKERRQ(ierr); 277a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->gradient);CHKERRQ(ierr); 278a7e14dcfSSatish Balay 279a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->XL);CHKERRQ(ierr); 280a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->XU);CHKERRQ(ierr); 281a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->IL);CHKERRQ(ierr); 282a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->IU);CHKERRQ(ierr); 283a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->DE);CHKERRQ(ierr); 284a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->DI);CHKERRQ(ierr); 285a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->constraints_equality);CHKERRQ(ierr); 286a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->constraints_inequality);CHKERRQ(ierr); 287a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->stepdirection);CHKERRQ(ierr); 288a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->hessian_pre);CHKERRQ(ierr); 289a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->hessian);CHKERRQ(ierr); 290a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_pre);CHKERRQ(ierr); 291a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian);CHKERRQ(ierr); 292a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state_pre);CHKERRQ(ierr); 293a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state);CHKERRQ(ierr); 294a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr); 295067f330cSJason Sarich ierr = MatDestroy(&(*tao)->jacobian_design);CHKERRQ(ierr); 296a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_equality);CHKERRQ(ierr); 297a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_equality_pre);CHKERRQ(ierr); 298a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_inequality);CHKERRQ(ierr); 299a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_inequality_pre);CHKERRQ(ierr); 300a7e14dcfSSatish Balay ierr = ISDestroy(&(*tao)->state_is);CHKERRQ(ierr); 301a7e14dcfSSatish Balay ierr = ISDestroy(&(*tao)->design_is);CHKERRQ(ierr); 302a7e14dcfSSatish Balay ierr = TaoCancelMonitors(*tao);CHKERRQ(ierr); 303a7e14dcfSSatish Balay ierr = PetscHeaderDestroy(tao);CHKERRQ(ierr); 304a7e14dcfSSatish Balay PetscFunctionReturn(0); 305a7e14dcfSSatish Balay } 306a7e14dcfSSatish Balay 307a7e14dcfSSatish Balay #undef __FUNCT__ 308a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetFromOptions" 309a7e14dcfSSatish Balay /*@ 310a7e14dcfSSatish Balay TaoSetFromOptions - Sets various TaoSolver parameters from user 311a7e14dcfSSatish Balay options. 312a7e14dcfSSatish Balay 313a7e14dcfSSatish Balay Collective on TaoSolver 314a7e14dcfSSatish Balay 315a7e14dcfSSatish Balay Input Paremeter: 316a7e14dcfSSatish Balay . tao - the TaoSolver solver context 317a7e14dcfSSatish Balay 318a7e14dcfSSatish Balay options Database Keys: 319a7e14dcfSSatish Balay + -tao_method <type> - The algorithm that TAO uses (tao_lmvm, tao_nls, etc.) 320a7e14dcfSSatish Balay . -tao_fatol <fatol> - absolute error tolerance in function value 321a7e14dcfSSatish Balay . -tao_frtol <frtol> - relative error tolerance in function value 322a7e14dcfSSatish Balay . -tao_gatol <gatol> - absolute error tolerance for ||gradient|| 323a7e14dcfSSatish Balay . -tao_grtol <grtol> - relative error tolerance for ||gradient|| 324a7e14dcfSSatish Balay . -tao_gttol <gttol> - reduction of ||gradient|| relative to initial gradient 325a7e14dcfSSatish Balay . -tao_max_it <max> - sets maximum number of iterations 326a7e14dcfSSatish Balay . -tao_max_funcs <max> - sets maximum number of function evaluations 327a7e14dcfSSatish Balay . -tao_fmin <fmin> - stop if function value reaches fmin 328a7e14dcfSSatish Balay . -tao_steptol <tol> - stop if trust region radius less than <tol> 329a7e14dcfSSatish Balay . -tao_trust0 <t> - initial trust region radius 330a7e14dcfSSatish Balay . -tao_monitor - prints function value and residual at each iteration 331a7e14dcfSSatish Balay . -tao_smonitor - same as tao_monitor, but truncates very small values 332a7e14dcfSSatish Balay . -tao_cmonitor - prints function value, residual, and constraint norm at each iteration 333a7e14dcfSSatish Balay . -tao_view_solution - prints solution vector at each iteration 334a7e14dcfSSatish Balay . -tao_view_separableobjective - prints separable objective vector at each iteration 335a7e14dcfSSatish Balay . -tao_view_step - prints step direction vector at each iteration 336a7e14dcfSSatish Balay . -tao_view_gradient - prints gradient vector at each iteration 337a7e14dcfSSatish Balay . -tao_draw_solution - graphically view solution vector at each iteration 338a7e14dcfSSatish Balay . -tao_draw_step - graphically view step vector at each iteration 339a7e14dcfSSatish Balay . -tao_draw_gradient - graphically view gradient at each iteration 340a7e14dcfSSatish Balay . -tao_fd_gradient - use gradient computed with finite differences 341a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors (except those set with command line) 342a7e14dcfSSatish Balay . -tao_view - prints information about the TaoSolver after solving 343a7e14dcfSSatish Balay - -tao_converged_reason - prints the reason TAO stopped iterating 344a7e14dcfSSatish Balay 345a7e14dcfSSatish Balay Notes: 346a7e14dcfSSatish Balay To see all options, run your program with the -help option or consult the 347a7e14dcfSSatish Balay user's manual. Should be called after TaoCreate() but before TaoSolve() 348a7e14dcfSSatish Balay 349a7e14dcfSSatish Balay Level: beginner 350a7e14dcfSSatish Balay @*/ 351a7e14dcfSSatish Balay PetscErrorCode TaoSetFromOptions(TaoSolver tao) 352a7e14dcfSSatish Balay { 353a7e14dcfSSatish Balay PetscErrorCode ierr; 354a7e14dcfSSatish Balay const TaoSolverType default_type = "tao_lmvm"; 355a7e14dcfSSatish Balay const char *prefix; 356a7e14dcfSSatish Balay char type[256], monfilename[PETSC_MAX_PATH_LEN]; 357a7e14dcfSSatish Balay PetscViewer monviewer; 358a7e14dcfSSatish Balay PetscBool flg; 359a7e14dcfSSatish Balay MPI_Comm comm; 360a7e14dcfSSatish Balay 361a7e14dcfSSatish Balay PetscFunctionBegin; 362a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 363a7e14dcfSSatish Balay ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr); 364a7e14dcfSSatish Balay ierr = TaoGetOptionsPrefix(tao,&prefix); 365a7e14dcfSSatish Balay /* So no warnings are given about unused options */ 366a7e14dcfSSatish Balay ierr = PetscOptionsHasName(prefix,"-tao_ksp_type",&flg); 367a7e14dcfSSatish Balay ierr = PetscOptionsHasName(prefix,"-tao_pc_type",&flg); 368a7e14dcfSSatish Balay ierr = PetscOptionsHasName(prefix,"-tao_ls_type",&flg); 369a7e14dcfSSatish Balay 370a7e14dcfSSatish Balay ierr = PetscObjectOptionsBegin((PetscObject)tao);CHKERRQ(ierr); 371a7e14dcfSSatish Balay { 372a7e14dcfSSatish Balay if (!TaoSolverRegisterAllCalled) { 373a7e14dcfSSatish Balay ierr = TaoSolverRegisterAll();CHKERRQ(ierr); 374a7e14dcfSSatish Balay } 375a7e14dcfSSatish Balay if (((PetscObject)tao)->type_name) { 376a7e14dcfSSatish Balay default_type = ((PetscObject)tao)->type_name; 377a7e14dcfSSatish Balay } 378a7e14dcfSSatish Balay /* Check for type from options */ 3797a3a6978SSatish Balay ierr = PetscOptionsFList("-tao_type","Tao Solver type","TaoSetType",TaoSolverList,default_type,type,256,&flg);CHKERRQ(ierr); 380a7e14dcfSSatish Balay if (flg) { 381a7e14dcfSSatish Balay ierr = TaoSetType(tao,type);CHKERRQ(ierr); 382a7e14dcfSSatish Balay } else { 3837a3a6978SSatish Balay ierr = PetscOptionsFList("-tao_method","Tao Solver type","TaoSetType",TaoSolverList,default_type,type,256,&flg);CHKERRQ(ierr); 384a7e14dcfSSatish Balay if (flg) { 385a7e14dcfSSatish Balay ierr = TaoSetType(tao,type);CHKERRQ(ierr); 386a7e14dcfSSatish Balay } else if (!((PetscObject)tao)->type_name) { 387a7e14dcfSSatish Balay ierr = TaoSetType(tao,default_type); 388a7e14dcfSSatish Balay } 389a7e14dcfSSatish Balay } 390a7e14dcfSSatish Balay 391a7e14dcfSSatish Balay ierr = PetscOptionsBool("-tao_view","view TaoSolver info after each minimization has completed","TaoView",PETSC_FALSE,&tao->viewtao,&flg);CHKERRQ(ierr); 392a7e14dcfSSatish Balay ierr = PetscOptionsReal("-tao_fatol","Stop if solution within","TaoSetTolerances",tao->fatol,&tao->fatol,&flg);CHKERRQ(ierr); 393a7e14dcfSSatish Balay ierr = PetscOptionsReal("-tao_frtol","Stop if relative solution within","TaoSetTolerances",tao->frtol,&tao->frtol,&flg);CHKERRQ(ierr); 394a7e14dcfSSatish Balay ierr = PetscOptionsReal("-tao_catol","Stop if constraints violations within","TaoSetConstraintTolerances",tao->catol,&tao->catol,&flg);CHKERRQ(ierr); 395a7e14dcfSSatish Balay ierr = PetscOptionsReal("-tao_crtol","Stop if relative contraint violations within","TaoSetConstraintTolerances",tao->crtol,&tao->crtol,&flg);CHKERRQ(ierr); 396a7e14dcfSSatish Balay ierr = PetscOptionsReal("-tao_gatol","Stop if norm of gradient less than","TaoSetTolerances",tao->gatol,&tao->gatol,&flg);CHKERRQ(ierr); 397a7e14dcfSSatish Balay ierr = PetscOptionsReal("-tao_grtol","Stop if norm of gradient divided by the function value is less than","TaoSetTolerances",tao->grtol,&tao->grtol,&flg);CHKERRQ(ierr); 398a7e14dcfSSatish Balay ierr = PetscOptionsReal("-tao_gttol","Stop if the norm of the gradient is less than the norm of the initial gradient times tol","TaoSetTolerances",tao->gttol,&tao->gttol,&flg);CHKERRQ(ierr); 399a7e14dcfSSatish Balay ierr = PetscOptionsInt("-tao_max_it","Stop if iteration number exceeds", 400a7e14dcfSSatish Balay "TaoSetMaximumIterations",tao->max_it,&tao->max_it, 401a7e14dcfSSatish Balay &flg);CHKERRQ(ierr); 402a7e14dcfSSatish Balay ierr = PetscOptionsInt("-tao_max_funcs","Stop if number of function evaluations exceeds","TaoSetMaximumFunctionEvaluations",tao->max_funcs,&tao->max_funcs,&flg);CHKERRQ(ierr); 403a7e14dcfSSatish Balay ierr = PetscOptionsReal("-tao_fmin","Stop if function less than","TaoSetFunctionLowerBound",tao->fmin,&tao->fmin,&flg);CHKERRQ(ierr); 404a7e14dcfSSatish Balay ierr = PetscOptionsReal("-tao_steptol","Stop if step size or trust region radius less than","",tao->steptol,&tao->steptol,&flg);CHKERRQ(ierr); 405a7e14dcfSSatish Balay ierr = PetscOptionsReal("-tao_trust0","Initial trust region radius","TaoSetTrustRegionRadius",tao->trust0,&tao->trust0,&flg);CHKERRQ(ierr); 406a7e14dcfSSatish Balay 407a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_solution","view solution vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 408a7e14dcfSSatish Balay if (flg) { 409a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 410a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoSolutionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 411a7e14dcfSSatish Balay } 412a7e14dcfSSatish Balay 413*47a47007SBarry Smith ierr = PetscOptionsBool("-tao_converged_reason","Print reason for TAO termination","TaoSolve",flg,&flg,NULL);CHKERRQ(ierr); 414a7e14dcfSSatish Balay if (flg) { 415a7e14dcfSSatish Balay tao->printreason = PETSC_TRUE; 416a7e14dcfSSatish Balay } 417a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_gradient","view gradient vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 418a7e14dcfSSatish Balay if (flg) { 419a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 420a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoGradientMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 421a7e14dcfSSatish Balay } 422a7e14dcfSSatish Balay 423a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_stepdirection","view step direction vector after each iteration","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 424a7e14dcfSSatish Balay if (flg) { 425a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 426a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoStepDirectionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 427a7e14dcfSSatish Balay } 428a7e14dcfSSatish Balay 429a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_separableobjective","view separable objective vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 430a7e14dcfSSatish Balay if (flg) { 431a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 432a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoSeparableObjectiveMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 433a7e14dcfSSatish Balay } 434a7e14dcfSSatish Balay 435a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_monitor","Use the default convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 436a7e14dcfSSatish Balay if (flg) { 437a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 438a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoDefaultMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 439a7e14dcfSSatish Balay } 440a7e14dcfSSatish Balay 441a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_smonitor","Use the short convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 442a7e14dcfSSatish Balay if (flg) { 443a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 444a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoDefaultSMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 445a7e14dcfSSatish Balay } 446a7e14dcfSSatish Balay 447a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_cmonitor","Use the default convergence monitor with constraint norm","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 448a7e14dcfSSatish Balay if (flg) { 449a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 450a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoDefaultCMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 451a7e14dcfSSatish Balay } 452a7e14dcfSSatish Balay 453a7e14dcfSSatish Balay 454*47a47007SBarry Smith ierr = PetscOptionsBool("-tao_cancelmonitors","cancel all monitors and call any registered destroy routines","TaoCancelMonitors",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr); 455a7e14dcfSSatish Balay if (flg) {ierr = TaoCancelMonitors(tao);CHKERRQ(ierr);} 456a7e14dcfSSatish Balay 457*47a47007SBarry Smith ierr = PetscOptionsBool("-tao_draw_solution","Plot solution vector at each iteration","TaoSetMonitor",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr); 458a7e14dcfSSatish Balay if (flg) { 459*47a47007SBarry Smith ierr = TaoSetMonitor(tao,TaoDrawSolutionMonitor,NULL,NULL);CHKERRQ(ierr); 460a7e14dcfSSatish Balay } 461a7e14dcfSSatish Balay 462*47a47007SBarry Smith ierr = PetscOptionsBool("-tao_draw_step","plots step direction at each iteration","TaoSetMonitor",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr); 463a7e14dcfSSatish Balay if (flg) { 464*47a47007SBarry Smith ierr = TaoSetMonitor(tao,TaoDrawStepMonitor,NULL,NULL);CHKERRQ(ierr); 465a7e14dcfSSatish Balay } 466a7e14dcfSSatish Balay 467*47a47007SBarry Smith ierr = PetscOptionsBool("-tao_draw_gradient","plots gradient at each iteration","TaoSetMonitor",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr); 468a7e14dcfSSatish Balay if (flg) { 469*47a47007SBarry Smith ierr = TaoSetMonitor(tao,TaoDrawGradientMonitor,NULL,NULL);CHKERRQ(ierr); 470a7e14dcfSSatish Balay } 471*47a47007SBarry Smith ierr = PetscOptionsBool("-tao_fd_gradient","compute gradient using finite differences","TaoDefaultComputeGradient",PETSC_FALSE,&flg,NULL);CHKERRQ(ierr); 472a7e14dcfSSatish Balay if (flg) { 473*47a47007SBarry Smith ierr = TaoSetGradientRoutine(tao,TaoDefaultComputeGradient,NULL);CHKERRQ(ierr); 474a7e14dcfSSatish Balay } 475a7e14dcfSSatish Balay ierr = PetscOptionsEList("-tao_subset_type","subset type", "", TAO_SUBSET, TAO_SUBSET_TYPES,TAO_SUBSET[tao->subset_type], &tao->subset_type, 0);CHKERRQ(ierr); 476a7e14dcfSSatish Balay 477a7e14dcfSSatish Balay if (tao->ops->setfromoptions) { 478a7e14dcfSSatish Balay ierr = (*tao->ops->setfromoptions)(tao);CHKERRQ(ierr); 479a7e14dcfSSatish Balay } 480a7e14dcfSSatish Balay } 481a7e14dcfSSatish Balay ierr = PetscOptionsEnd();CHKERRQ(ierr); 482a7e14dcfSSatish Balay PetscFunctionReturn(0); 483a7e14dcfSSatish Balay } 484a7e14dcfSSatish Balay 485a7e14dcfSSatish Balay #undef __FUNCT__ 486a7e14dcfSSatish Balay #define __FUNCT__ "TaoView" 487a7e14dcfSSatish Balay /*@C 488a7e14dcfSSatish Balay TaoView - Prints information about the TaoSolver 489a7e14dcfSSatish Balay 490a7e14dcfSSatish Balay Collective on TaoSolver 491a7e14dcfSSatish Balay 492a7e14dcfSSatish Balay InputParameters: 493a7e14dcfSSatish Balay + tao - the TaoSolver context 494a7e14dcfSSatish Balay - viewer - visualization context 495a7e14dcfSSatish Balay 496a7e14dcfSSatish Balay Options Database Key: 497a7e14dcfSSatish Balay . -tao_view - Calls TaoView() at the end of TaoSolve() 498a7e14dcfSSatish Balay 499a7e14dcfSSatish Balay Notes: 500a7e14dcfSSatish Balay The available visualization contexts include 501a7e14dcfSSatish Balay + PETSC_VIEWER_STDOUT_SELF - standard output (default) 502a7e14dcfSSatish Balay - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 503a7e14dcfSSatish Balay output where only the first processor opens 504a7e14dcfSSatish Balay the file. All other processors send their 505a7e14dcfSSatish Balay data to the first processor to print. 506a7e14dcfSSatish Balay 507a7e14dcfSSatish Balay Level: beginner 508a7e14dcfSSatish Balay 509a7e14dcfSSatish Balay .seealso: PetscViewerASCIIOpen() 510a7e14dcfSSatish Balay @*/ 511a7e14dcfSSatish Balay PetscErrorCode TaoView(TaoSolver tao, PetscViewer viewer) 512a7e14dcfSSatish Balay { 513a7e14dcfSSatish Balay PetscErrorCode ierr; 514a7e14dcfSSatish Balay PetscBool isascii,isstring; 515a7e14dcfSSatish Balay const TaoSolverType type; 516*47a47007SBarry Smith 517a7e14dcfSSatish Balay PetscFunctionBegin; 518a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 519a7e14dcfSSatish Balay if (!viewer) { 520a7e14dcfSSatish Balay ierr = PetscViewerASCIIGetStdout(((PetscObject)tao)->comm,&viewer);CHKERRQ(ierr); 521a7e14dcfSSatish Balay } 522a7e14dcfSSatish Balay PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 523a7e14dcfSSatish Balay PetscCheckSameComm(tao,1,viewer,2); 524a7e14dcfSSatish Balay 525a7e14dcfSSatish Balay ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 526a7e14dcfSSatish Balay ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 527a7e14dcfSSatish Balay if (isascii) { 528a7e14dcfSSatish Balay ierr = PetscObjectPrintClassNamePrefixType((PetscObject)tao,viewer);CHKERRQ(ierr); 529a7e14dcfSSatish Balay ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 530a7e14dcfSSatish Balay 531a7e14dcfSSatish Balay if (tao->ops->view) { 532a7e14dcfSSatish Balay ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 533a7e14dcfSSatish Balay ierr = (*tao->ops->view)(tao,viewer);CHKERRQ(ierr); 534a7e14dcfSSatish Balay ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 535a7e14dcfSSatish Balay } 536a7e14dcfSSatish Balay if (tao->linesearch) { 537a7e14dcfSSatish Balay ierr = PetscObjectPrintClassNamePrefixType((PetscObject)(tao->linesearch),viewer);CHKERRQ(ierr); 538a7e14dcfSSatish Balay } 539a7e14dcfSSatish Balay if (tao->ksp) { 540a7e14dcfSSatish Balay ierr = PetscObjectPrintClassNamePrefixType((PetscObject)(tao->ksp),viewer);CHKERRQ(ierr); 541a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer,"total KSP iterations: %D\n",tao->ksp_its);CHKERRQ(ierr); 542a7e14dcfSSatish Balay } 543a7e14dcfSSatish Balay if (tao->XL || tao->XU) { 544a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer,"Active Set subset type: %s\n",TAO_SUBSET[tao->subset_type]); 545a7e14dcfSSatish Balay } 546a7e14dcfSSatish Balay 547*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: fatol=%g,",(double)tao->fatol);CHKERRQ(ierr); 548*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," frtol=%g\n",(double)tao->frtol);CHKERRQ(ierr); 549a7e14dcfSSatish Balay 550*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: gatol=%g,",(double)tao->gatol);CHKERRQ(ierr); 551*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," steptol=%g,",(double)tao->steptol);CHKERRQ(ierr); 552*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," gttol=%g\n",(double)tao->gttol);CHKERRQ(ierr); 553a7e14dcfSSatish Balay 554*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Residual in Function/Gradient:=%g\n",(double)tao->residual);CHKERRQ(ierr); 555a7e14dcfSSatish Balay 556a7e14dcfSSatish Balay if (tao->cnorm>0 || tao->catol>0 || tao->crtol>0){ 557a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances:");CHKERRQ(ierr); 558*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," catol=%g,",(double)tao->catol);CHKERRQ(ierr); 559*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," crtol=%g\n",(double)tao->crtol);CHKERRQ(ierr); 560*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Residual in Constraints:=%g\n",(double)tao->cnorm);CHKERRQ(ierr); 561a7e14dcfSSatish Balay } 562a7e14dcfSSatish Balay 563a7e14dcfSSatish Balay if (tao->trust < tao->steptol){ 564*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: steptol=%g\n",(double)tao->steptol);CHKERRQ(ierr); 565*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"Final trust region radius:=%g\n",(double)tao->trust);CHKERRQ(ierr); 566a7e14dcfSSatish Balay } 567a7e14dcfSSatish Balay 568a7e14dcfSSatish Balay if (tao->fmin>-1.e25){ 569*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: function minimum=%g\n",(double)tao->fmin);CHKERRQ(ierr); 570a7e14dcfSSatish Balay } 571*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Objective value=%g\n",(double)tao->fc);CHKERRQ(ierr); 572a7e14dcfSSatish Balay 573*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of iterations=%D, ",tao->niter);CHKERRQ(ierr); 574a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," (max: %D)\n",tao->max_it);CHKERRQ(ierr); 575a7e14dcfSSatish Balay 576a7e14dcfSSatish Balay if (tao->nfuncs>0){ 577*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of function evaluations=%D,",tao->nfuncs);CHKERRQ(ierr); 578*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," max: %D\n",tao->max_funcs);CHKERRQ(ierr); 579a7e14dcfSSatish Balay } 580a7e14dcfSSatish Balay if (tao->ngrads>0){ 581*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of gradient evaluations=%D,",tao->ngrads);CHKERRQ(ierr); 582*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," max: %D\n",tao->max_funcs);CHKERRQ(ierr); 583a7e14dcfSSatish Balay } 584a7e14dcfSSatish Balay if (tao->nfuncgrads>0){ 585*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of function/gradient evaluations=%D,",tao->nfuncgrads);CHKERRQ(ierr); 586*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," (max: %D)\n",tao->max_funcs);CHKERRQ(ierr); 587a7e14dcfSSatish Balay } 588a7e14dcfSSatish Balay if (tao->nhess>0){ 589*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of Hessian evaluations=%D\n",tao->nhess);CHKERRQ(ierr); 590a7e14dcfSSatish Balay } 591a7e14dcfSSatish Balay /* if (tao->linear_its>0){ 592*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total Krylov method iterations=%D\n",tao->linear_its);CHKERRQ(ierr); 593a7e14dcfSSatish Balay }*/ 594a7e14dcfSSatish Balay if (tao->nconstraints>0){ 595*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of constraint function evaluations=%D\n",tao->nconstraints);CHKERRQ(ierr); 596a7e14dcfSSatish Balay } 597a7e14dcfSSatish Balay if (tao->njac>0){ 598*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of Jacobian evaluations=%D\n",tao->njac);CHKERRQ(ierr); 599a7e14dcfSSatish Balay } 600a7e14dcfSSatish Balay 601a7e14dcfSSatish Balay if (tao->reason>0){ 602a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer, "Solution converged: ");CHKERRQ(ierr); 603a7e14dcfSSatish Balay switch (tao->reason) { 604a7e14dcfSSatish Balay case TAO_CONVERGED_FATOL: 605a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer,"estimated f(x)-f(X*) <= fatol\n");CHKERRQ(ierr); 606a7e14dcfSSatish Balay break; 607a7e14dcfSSatish Balay case TAO_CONVERGED_FRTOL: 608a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer,"estimated |f(x)-f(X*)|/|f(X*)| <= frtol\n");CHKERRQ(ierr); 609a7e14dcfSSatish Balay break; 610a7e14dcfSSatish Balay case TAO_CONVERGED_GATOL: 611a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," ||g(X)|| <= gatol\n");CHKERRQ(ierr); 612a7e14dcfSSatish Balay break; 613a7e14dcfSSatish Balay case TAO_CONVERGED_GRTOL: 614a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/|f(X)| <= grtol\n");CHKERRQ(ierr); 615a7e14dcfSSatish Balay break; 616a7e14dcfSSatish Balay case TAO_CONVERGED_GTTOL: 617a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/||g(X0)|| <= gttol\n");CHKERRQ(ierr); 618a7e14dcfSSatish Balay break; 619a7e14dcfSSatish Balay case TAO_CONVERGED_STEPTOL: 620a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," Steptol -- step size small\n");CHKERRQ(ierr); 621a7e14dcfSSatish Balay break; 622a7e14dcfSSatish Balay case TAO_CONVERGED_MINF: 623a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," Minf -- f < fmin\n");CHKERRQ(ierr); 624a7e14dcfSSatish Balay break; 625a7e14dcfSSatish Balay case TAO_CONVERGED_USER: 626a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr); 627a7e14dcfSSatish Balay break; 628a7e14dcfSSatish Balay default: 629a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 630a7e14dcfSSatish Balay break; 631a7e14dcfSSatish Balay } 632a7e14dcfSSatish Balay 633a7e14dcfSSatish Balay } else { 634a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer,"Solver terminated: %D",tao->reason);CHKERRQ(ierr); 635a7e14dcfSSatish Balay switch (tao->reason) { 636a7e14dcfSSatish Balay case TAO_DIVERGED_MAXITS: 637*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Maximum Iterations\n");CHKERRQ(ierr); 638a7e14dcfSSatish Balay break; 639a7e14dcfSSatish Balay case TAO_DIVERGED_NAN: 640*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," NAN or Inf encountered\n");CHKERRQ(ierr); 641a7e14dcfSSatish Balay break; 642a7e14dcfSSatish Balay case TAO_DIVERGED_MAXFCN: 643*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Maximum Function Evaluations\n");CHKERRQ(ierr); 644a7e14dcfSSatish Balay break; 645a7e14dcfSSatish Balay case TAO_DIVERGED_LS_FAILURE: 646*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Line Search Failure\n");CHKERRQ(ierr); 647a7e14dcfSSatish Balay break; 648a7e14dcfSSatish Balay case TAO_DIVERGED_TR_REDUCTION: 649*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Trust Region too small\n");CHKERRQ(ierr); 650a7e14dcfSSatish Balay break; 651a7e14dcfSSatish Balay case TAO_DIVERGED_USER: 652*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr); 653a7e14dcfSSatish Balay break; 654a7e14dcfSSatish Balay default: 655a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 656a7e14dcfSSatish Balay break; 657a7e14dcfSSatish Balay } 658a7e14dcfSSatish Balay } 659a7e14dcfSSatish Balay ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 660a7e14dcfSSatish Balay } else if (isstring) { 661a7e14dcfSSatish Balay ierr = TaoGetType(tao,&type);CHKERRQ(ierr); 662a7e14dcfSSatish Balay ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr); 663a7e14dcfSSatish Balay } 664a7e14dcfSSatish Balay PetscFunctionReturn(0); 665a7e14dcfSSatish Balay } 666a7e14dcfSSatish Balay 667a7e14dcfSSatish Balay #undef __FUNCT__ 668a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetTolerances" 669a7e14dcfSSatish Balay /*@ 670a7e14dcfSSatish Balay TaoSetTolerances - Sets parameters used in TAO convergence tests 671a7e14dcfSSatish Balay 672a7e14dcfSSatish Balay Logically collective on TaoSolver 673a7e14dcfSSatish Balay 674a7e14dcfSSatish Balay Input Parameters: 675a7e14dcfSSatish Balay + tao - the TaoSolver context 676a7e14dcfSSatish Balay . fatol - absolute convergence tolerance 677a7e14dcfSSatish Balay . frtol - relative convergence tolerance 678a7e14dcfSSatish Balay . gatol - stop if norm of gradient is less than this 679a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this 680a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by this factor 681a7e14dcfSSatish Balay 682a7e14dcfSSatish Balay Options Database Keys: 683a7e14dcfSSatish Balay + -tao_fatol <fatol> - Sets fatol 684a7e14dcfSSatish Balay . -tao_frtol <frtol> - Sets frtol 685a7e14dcfSSatish Balay . -tao_gatol <gatol> - Sets gatol 686a7e14dcfSSatish Balay . -tao_grtol <grtol> - Sets grtol 687a7e14dcfSSatish Balay - -tao_gttol <gttol> - Sets gttol 688a7e14dcfSSatish Balay 689a7e14dcfSSatish Balay Stopping Criteria: 690a7e14dcfSSatish Balay $ f(X) - f(X*) (estimated) <= fatol 691a7e14dcfSSatish Balay $ |f(X) - f(X*)| (estimated) / |f(X)| <= frtol 692a7e14dcfSSatish Balay $ ||g(X)|| <= gatol 693a7e14dcfSSatish Balay $ ||g(X)|| / |f(X)| <= grtol 694a7e14dcfSSatish Balay $ ||g(X)|| / ||g(X0)|| <= gttol 695a7e14dcfSSatish Balay 696a7e14dcfSSatish Balay Notes: 697a7e14dcfSSatish Balay Use PETSC_DEFAULT to leave one or more tolerances unchanged. 698a7e14dcfSSatish Balay 699a7e14dcfSSatish Balay Level: beginner 700a7e14dcfSSatish Balay 701a7e14dcfSSatish Balay .seealso: TaoGetTolerances() 702a7e14dcfSSatish Balay 703a7e14dcfSSatish Balay @*/ 704a7e14dcfSSatish Balay PetscErrorCode TaoSetTolerances(TaoSolver tao, PetscReal fatol, PetscReal frtol, PetscReal gatol, PetscReal grtol, PetscReal gttol) 705a7e14dcfSSatish Balay { 706a7e14dcfSSatish Balay PetscErrorCode ierr; 707*47a47007SBarry Smith 708a7e14dcfSSatish Balay PetscFunctionBegin; 709a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 710a7e14dcfSSatish Balay 711a7e14dcfSSatish Balay if (fatol != PETSC_DEFAULT) { 712a7e14dcfSSatish Balay if (fatol<0) { 713*47a47007SBarry Smith ierr = PetscInfo(tao,"Tried to set negative fatol -- ignored.");CHKERRQ(ierr); 714a7e14dcfSSatish Balay } else { 715a7e14dcfSSatish Balay tao->fatol = PetscMax(0,fatol); 716a7e14dcfSSatish Balay } 717a7e14dcfSSatish Balay } 718a7e14dcfSSatish Balay if (frtol != PETSC_DEFAULT) { 719a7e14dcfSSatish Balay if (frtol<0) { 720*47a47007SBarry Smith ierr = PetscInfo(tao,"Tried to set negative frtol -- ignored.");CHKERRQ(ierr); 721a7e14dcfSSatish Balay } else { 722a7e14dcfSSatish Balay tao->frtol = PetscMax(0,frtol); 723a7e14dcfSSatish Balay } 724a7e14dcfSSatish Balay } 725a7e14dcfSSatish Balay 726a7e14dcfSSatish Balay if (gatol != PETSC_DEFAULT) { 727a7e14dcfSSatish Balay if (gatol<0) { 728*47a47007SBarry Smith ierr = PetscInfo(tao,"Tried to set negative gatol -- ignored.");CHKERRQ(ierr); 729a7e14dcfSSatish Balay } else { 730a7e14dcfSSatish Balay tao->gatol = PetscMax(0,gatol); 731a7e14dcfSSatish Balay } 732a7e14dcfSSatish Balay } 733a7e14dcfSSatish Balay 734a7e14dcfSSatish Balay if (grtol != PETSC_DEFAULT) { 735a7e14dcfSSatish Balay if (grtol<0) { 736*47a47007SBarry Smith ierr = PetscInfo(tao,"Tried to set negative grtol -- ignored.");CHKERRQ(ierr); 737a7e14dcfSSatish Balay } else { 738a7e14dcfSSatish Balay tao->grtol = PetscMax(0,grtol); 739a7e14dcfSSatish Balay } 740a7e14dcfSSatish Balay } 741a7e14dcfSSatish Balay 742a7e14dcfSSatish Balay if (gttol != PETSC_DEFAULT) { 743a7e14dcfSSatish Balay if (gttol<0) { 744*47a47007SBarry Smith ierr = PetscInfo(tao,"Tried to set negative gttol -- ignored.");CHKERRQ(ierr); 745a7e14dcfSSatish Balay } else { 746a7e14dcfSSatish Balay tao->gttol = PetscMax(0,gttol); 747a7e14dcfSSatish Balay } 748a7e14dcfSSatish Balay } 749a7e14dcfSSatish Balay PetscFunctionReturn(0); 750a7e14dcfSSatish Balay } 751a7e14dcfSSatish Balay 752a7e14dcfSSatish Balay #undef __FUNCT__ 753a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetConstraintTolerances" 754a7e14dcfSSatish Balay /*@ 755a7e14dcfSSatish Balay TaoSetConstraintTolerances - Sets contraint tolerance parameters used in TAO 756a7e14dcfSSatish Balay convergence tests 757a7e14dcfSSatish Balay 758a7e14dcfSSatish Balay Logically collective on TaoSolver 759a7e14dcfSSatish Balay 760a7e14dcfSSatish Balay Input Parameters: 761a7e14dcfSSatish Balay + tao - the TaoSolver context 762a7e14dcfSSatish Balay . catol - absolute constraint tolerance, constraint norm must be less than catol for used for fatol, gatol convergence criteria 763a7e14dcfSSatish Balay - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for fatol, gatol, gttol convergence criteria 764a7e14dcfSSatish Balay 765a7e14dcfSSatish Balay Options Database Keys: 766a7e14dcfSSatish Balay + -tao_catol <catol> - Sets catol 767a7e14dcfSSatish Balay - -tao_crtol <crtol> - Sets crtol 768a7e14dcfSSatish Balay 769a7e14dcfSSatish Balay Level: intermediate 770a7e14dcfSSatish Balay 771a7e14dcfSSatish Balay .seealso: TaoGetTolerances() 772a7e14dcfSSatish Balay 773a7e14dcfSSatish Balay @*/ 774a7e14dcfSSatish Balay PetscErrorCode TaoSetConstraintTolerances(TaoSolver tao, PetscReal catol, PetscReal crtol) 775a7e14dcfSSatish Balay { 776a7e14dcfSSatish Balay PetscErrorCode ierr; 777*47a47007SBarry Smith 778a7e14dcfSSatish Balay PetscFunctionBegin; 779a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 780a7e14dcfSSatish Balay 781a7e14dcfSSatish Balay if (catol != PETSC_DEFAULT) { 782a7e14dcfSSatish Balay if (catol<0) { 783*47a47007SBarry Smith ierr = PetscInfo(tao,"Tried to set negative catol -- ignored.");CHKERRQ(ierr); 784a7e14dcfSSatish Balay } else { 785a7e14dcfSSatish Balay tao->catol = PetscMax(0,catol); 786a7e14dcfSSatish Balay } 787a7e14dcfSSatish Balay } 788a7e14dcfSSatish Balay 789a7e14dcfSSatish Balay if (crtol != PETSC_DEFAULT) { 790a7e14dcfSSatish Balay if (crtol<0) { 791*47a47007SBarry Smith ierr = PetscInfo(tao,"Tried to set negative crtol -- ignored.");CHKERRQ(ierr); 792a7e14dcfSSatish Balay } else { 793a7e14dcfSSatish Balay tao->crtol = PetscMax(0,crtol); 794a7e14dcfSSatish Balay } 795a7e14dcfSSatish Balay } 796a7e14dcfSSatish Balay PetscFunctionReturn(0); 797a7e14dcfSSatish Balay } 798a7e14dcfSSatish Balay 799a7e14dcfSSatish Balay #undef __FUNCT__ 800a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetFunctionLowerBound" 801a7e14dcfSSatish Balay /*@ 802a7e14dcfSSatish Balay TaoSetFunctionLowerBound - Sets a bound on the solution objective value. 803a7e14dcfSSatish Balay When an approximate solution with an objective value below this number 804a7e14dcfSSatish Balay has been found, the solver will terminate. 805a7e14dcfSSatish Balay 806a7e14dcfSSatish Balay Logically Collective on TaoSolver 807a7e14dcfSSatish Balay 808a7e14dcfSSatish Balay Input Parameters: 809a7e14dcfSSatish Balay + tao - the TaoSolver solver context 810a7e14dcfSSatish Balay - fmin - the tolerance 811a7e14dcfSSatish Balay 812a7e14dcfSSatish Balay Options Database Keys: 813a7e14dcfSSatish Balay . -tao_fmin <fmin> - sets the minimum function value 814a7e14dcfSSatish Balay 815a7e14dcfSSatish Balay Level: intermediate 816a7e14dcfSSatish Balay 817a7e14dcfSSatish Balay .seealso: TaoSetTolerances() 818a7e14dcfSSatish Balay @*/ 819a7e14dcfSSatish Balay PetscErrorCode TaoSetFunctionLowerBound(TaoSolver tao,PetscReal fmin) 820a7e14dcfSSatish Balay { 821a7e14dcfSSatish Balay PetscFunctionBegin; 822a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 823a7e14dcfSSatish Balay tao->fmin = fmin; 824a7e14dcfSSatish Balay PetscFunctionReturn(0); 825a7e14dcfSSatish Balay } 826a7e14dcfSSatish Balay 827a7e14dcfSSatish Balay #undef __FUNCT__ 828a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetFunctionLowerBound" 829a7e14dcfSSatish Balay /*@ 830a7e14dcfSSatish Balay TaoGetFunctionLowerBound - Sets a bound on the solution objective value. 831a7e14dcfSSatish Balay When an approximate solution with an objective value below this number 832a7e14dcfSSatish Balay has been found, the solver will terminate. 833a7e14dcfSSatish Balay 834a7e14dcfSSatish Balay Not collective on TaoSolver 835a7e14dcfSSatish Balay 836a7e14dcfSSatish Balay Input Parameters: 837a7e14dcfSSatish Balay . tao - the TaoSolver solver context 838a7e14dcfSSatish Balay 839a7e14dcfSSatish Balay OutputParameters: 840a7e14dcfSSatish Balay . fmin - the minimum function value 841a7e14dcfSSatish Balay 842a7e14dcfSSatish Balay Level: intermediate 843a7e14dcfSSatish Balay 844a7e14dcfSSatish Balay .seealso: TaoSetFunctionLowerBound() 845a7e14dcfSSatish Balay @*/ 846a7e14dcfSSatish Balay PetscErrorCode TaoGetFunctionLowerBound(TaoSolver tao,PetscReal *fmin) 847a7e14dcfSSatish Balay { 848a7e14dcfSSatish Balay PetscFunctionBegin; 849a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 850a7e14dcfSSatish Balay *fmin = tao->fmin; 851a7e14dcfSSatish Balay PetscFunctionReturn(0); 852a7e14dcfSSatish Balay } 853a7e14dcfSSatish Balay 854a7e14dcfSSatish Balay #undef __FUNCT__ 855a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMaximumFunctionEvaluations" 856a7e14dcfSSatish Balay /*@ 857a7e14dcfSSatish Balay TaoSetMaximumFunctionEvaluations - Sets a maximum number of 858a7e14dcfSSatish Balay function evaluations. 859a7e14dcfSSatish Balay 860a7e14dcfSSatish Balay Logically Collective on TaoSolver 861a7e14dcfSSatish Balay 862a7e14dcfSSatish Balay Input Parameters: 863a7e14dcfSSatish Balay + tao - the TaoSolver solver context 864a7e14dcfSSatish Balay - nfcn - the maximum number of function evaluations (>=0) 865a7e14dcfSSatish Balay 866a7e14dcfSSatish Balay Options Database Keys: 867a7e14dcfSSatish Balay . -tao_max_funcs <nfcn> - sets the maximum number of function evaluations 868a7e14dcfSSatish Balay 869a7e14dcfSSatish Balay Level: intermediate 870a7e14dcfSSatish Balay 871a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumIterations() 872a7e14dcfSSatish Balay @*/ 873a7e14dcfSSatish Balay 874a7e14dcfSSatish Balay PetscErrorCode TaoSetMaximumFunctionEvaluations(TaoSolver tao,PetscInt nfcn) 875a7e14dcfSSatish Balay { 876a7e14dcfSSatish Balay PetscFunctionBegin; 877a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 878*47a47007SBarry Smith tao->max_funcs = PetscMax(0,nfcn); 879a7e14dcfSSatish Balay PetscFunctionReturn(0); 880a7e14dcfSSatish Balay } 881a7e14dcfSSatish Balay 882a7e14dcfSSatish Balay #undef __FUNCT__ 883a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetMaximumFunctionEvaluations" 884a7e14dcfSSatish Balay /*@ 885a7e14dcfSSatish Balay TaoGetMaximumFunctionEvaluations - Sets a maximum number of 886a7e14dcfSSatish Balay function evaluations. 887a7e14dcfSSatish Balay 888a7e14dcfSSatish Balay Not Collective 889a7e14dcfSSatish Balay 890a7e14dcfSSatish Balay Input Parameters: 891a7e14dcfSSatish Balay . tao - the TaoSolver solver context 892a7e14dcfSSatish Balay 893a7e14dcfSSatish Balay Output Parameters: 894a7e14dcfSSatish Balay . nfcn - the maximum number of function evaluations 895a7e14dcfSSatish Balay 896a7e14dcfSSatish Balay Level: intermediate 897a7e14dcfSSatish Balay 898a7e14dcfSSatish Balay .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumIterations() 899a7e14dcfSSatish Balay @*/ 900a7e14dcfSSatish Balay 901a7e14dcfSSatish Balay PetscErrorCode TaoGetMaximumFunctionEvaluations(TaoSolver tao,PetscInt *nfcn) 902a7e14dcfSSatish Balay { 903a7e14dcfSSatish Balay PetscFunctionBegin; 904a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 905a7e14dcfSSatish Balay *nfcn = tao->max_funcs; 906a7e14dcfSSatish Balay PetscFunctionReturn(0); 907a7e14dcfSSatish Balay } 908a7e14dcfSSatish Balay 909a7e14dcfSSatish Balay #undef __FUNCT__ 910a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMaximumIterations" 911a7e14dcfSSatish Balay /*@ 912a7e14dcfSSatish Balay TaoSetMaximumIterations - Sets a maximum number of iterates. 913a7e14dcfSSatish Balay 914a7e14dcfSSatish Balay Logically Collective on TaoSolver 915a7e14dcfSSatish Balay 916a7e14dcfSSatish Balay Input Parameters: 917a7e14dcfSSatish Balay + tao - the TaoSolver solver context 918a7e14dcfSSatish Balay - maxits - the maximum number of iterates (>=0) 919a7e14dcfSSatish Balay 920a7e14dcfSSatish Balay Options Database Keys: 921a7e14dcfSSatish Balay . -tao_max_it <its> - sets the maximum number of iterations 922a7e14dcfSSatish Balay 923a7e14dcfSSatish Balay Level: intermediate 924a7e14dcfSSatish Balay 925a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumFunctionEvaluations() 926a7e14dcfSSatish Balay @*/ 927a7e14dcfSSatish Balay PetscErrorCode TaoSetMaximumIterations(TaoSolver tao,PetscInt maxits) 928a7e14dcfSSatish Balay { 929a7e14dcfSSatish Balay PetscFunctionBegin; 930a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 931*47a47007SBarry Smith tao->max_it = PetscMax(0,maxits); 932a7e14dcfSSatish Balay PetscFunctionReturn(0); 933a7e14dcfSSatish Balay } 934a7e14dcfSSatish Balay 935a7e14dcfSSatish Balay #undef __FUNCT__ 936a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetMaximumIterations" 937a7e14dcfSSatish Balay /*@ 938a7e14dcfSSatish Balay TaoGetMaximumIterations - Sets a maximum number of iterates. 939a7e14dcfSSatish Balay 940a7e14dcfSSatish Balay Not Collective 941a7e14dcfSSatish Balay 942a7e14dcfSSatish Balay Input Parameters: 943a7e14dcfSSatish Balay . tao - the TaoSolver solver context 944a7e14dcfSSatish Balay 945a7e14dcfSSatish Balay Output Parameters: 946a7e14dcfSSatish Balay . maxits - the maximum number of iterates 947a7e14dcfSSatish Balay 948a7e14dcfSSatish Balay Level: intermediate 949a7e14dcfSSatish Balay 950a7e14dcfSSatish Balay .seealso: TaoSetMaximumIterations(), TaoGetMaximumFunctionEvaluations() 951a7e14dcfSSatish Balay @*/ 952a7e14dcfSSatish Balay PetscErrorCode TaoGetMaximumIterations(TaoSolver tao,PetscInt *maxits) 953a7e14dcfSSatish Balay { 954a7e14dcfSSatish Balay PetscFunctionBegin; 955a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 956a7e14dcfSSatish Balay *maxits = tao->max_it; 957a7e14dcfSSatish Balay PetscFunctionReturn(0); 958a7e14dcfSSatish Balay } 959a7e14dcfSSatish Balay 960a7e14dcfSSatish Balay #undef __FUNCT__ 961a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetInitialTrustRegionRadius" 962a7e14dcfSSatish Balay /*@ 963a7e14dcfSSatish Balay TaoSetInitialTrustRegionRadius - Sets the initial trust region radius. 964a7e14dcfSSatish Balay 965a7e14dcfSSatish Balay Logically collective on TaoSolver 966a7e14dcfSSatish Balay 967a7e14dcfSSatish Balay Input Parameter: 968a7e14dcfSSatish Balay + tao - a TAO optimization solver 969a7e14dcfSSatish Balay - radius - the trust region radius 970a7e14dcfSSatish Balay 971a7e14dcfSSatish Balay Level: intermediate 972a7e14dcfSSatish Balay 973a7e14dcfSSatish Balay Options Database Key: 974a7e14dcfSSatish Balay . -tao_trust0 <t0> - sets initial trust region radius 975a7e14dcfSSatish Balay 976a7e14dcfSSatish Balay .seealso: TaoGetTrustRegionRadius(), TaoSetTrustRegionTolerance() 977a7e14dcfSSatish Balay @*/ 978a7e14dcfSSatish Balay PetscErrorCode TaoSetInitialTrustRegionRadius(TaoSolver tao, PetscReal radius) 979a7e14dcfSSatish Balay { 980a7e14dcfSSatish Balay PetscFunctionBegin; 981a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 982a7e14dcfSSatish Balay tao->trust0 = PetscMax(0.0,radius); 983a7e14dcfSSatish Balay PetscFunctionReturn(0); 984a7e14dcfSSatish Balay } 985a7e14dcfSSatish Balay 986a7e14dcfSSatish Balay #undef __FUNCT__ 987a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetInitialTrustRegionRadius" 988a7e14dcfSSatish Balay /*@ 989a7e14dcfSSatish Balay TaoGetInitialTrustRegionRadius - Sets the initial trust region radius. 990a7e14dcfSSatish Balay 991a7e14dcfSSatish Balay Not Collective 992a7e14dcfSSatish Balay 993a7e14dcfSSatish Balay Input Parameter: 994a7e14dcfSSatish Balay . tao - a TAO optimization solver 995a7e14dcfSSatish Balay 996a7e14dcfSSatish Balay Output Parameter: 997a7e14dcfSSatish Balay . radius - the trust region radius 998a7e14dcfSSatish Balay 999a7e14dcfSSatish Balay Level: intermediate 1000a7e14dcfSSatish Balay 1001a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetCurrentTrustRegionRadius() 1002a7e14dcfSSatish Balay @*/ 1003a7e14dcfSSatish Balay PetscErrorCode TaoGetInitialTrustRegionRadius(TaoSolver tao, PetscReal *radius) 1004a7e14dcfSSatish Balay { 1005a7e14dcfSSatish Balay PetscFunctionBegin; 1006a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 1007a7e14dcfSSatish Balay *radius = tao->trust0; 1008a7e14dcfSSatish Balay PetscFunctionReturn(0); 1009a7e14dcfSSatish Balay } 1010a7e14dcfSSatish Balay 1011a7e14dcfSSatish Balay #undef __FUNCT__ 1012a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetCurrentTrustRegionRadius" 1013a7e14dcfSSatish Balay /*@ 1014a7e14dcfSSatish Balay TaoGetCurrentTrustRegionRadius - Gets the current trust region radius. 1015a7e14dcfSSatish Balay 1016a7e14dcfSSatish Balay Not Collective 1017a7e14dcfSSatish Balay 1018a7e14dcfSSatish Balay Input Parameter: 1019a7e14dcfSSatish Balay . tao - a TAO optimization solver 1020a7e14dcfSSatish Balay 1021a7e14dcfSSatish Balay Output Parameter: 1022a7e14dcfSSatish Balay . radius - the trust region radius 1023a7e14dcfSSatish Balay 1024a7e14dcfSSatish Balay Level: intermediate 1025a7e14dcfSSatish Balay 1026a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetInitialTrustRegionRadius() 1027a7e14dcfSSatish Balay @*/ 1028a7e14dcfSSatish Balay PetscErrorCode TaoGetCurrentTrustRegionRadius(TaoSolver tao, PetscReal *radius) 1029a7e14dcfSSatish Balay { 1030a7e14dcfSSatish Balay PetscFunctionBegin; 1031a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 1032a7e14dcfSSatish Balay *radius = tao->trust; 1033a7e14dcfSSatish Balay PetscFunctionReturn(0); 1034a7e14dcfSSatish Balay } 1035a7e14dcfSSatish Balay 1036a7e14dcfSSatish Balay #undef __FUNCT__ 1037a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetTolerances" 1038a7e14dcfSSatish Balay /*@ 1039a7e14dcfSSatish Balay TaoGetTolerances - gets the current values of tolerances 1040a7e14dcfSSatish Balay 1041a7e14dcfSSatish Balay Not Collective 1042a7e14dcfSSatish Balay 1043a7e14dcfSSatish Balay Input Parameters: 1044a7e14dcfSSatish Balay . tao - the TaoSolver context 1045a7e14dcfSSatish Balay 1046a7e14dcfSSatish Balay Output Parameters: 1047a7e14dcfSSatish Balay + fatol - absolute convergence tolerance 1048a7e14dcfSSatish Balay . frtol - relative convergence tolerance 1049a7e14dcfSSatish Balay . gatol - stop if norm of gradient is less than this 1050a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this 1051a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by a this factor 1052a7e14dcfSSatish Balay 1053*47a47007SBarry Smith Note: NULL can be used as an argument if not all tolerances values are needed 1054a7e14dcfSSatish Balay 1055a7e14dcfSSatish Balay .seealso TaoSetTolerances() 1056a7e14dcfSSatish Balay 1057a7e14dcfSSatish Balay Level: intermediate 1058a7e14dcfSSatish Balay @*/ 1059a7e14dcfSSatish Balay PetscErrorCode TaoGetTolerances(TaoSolver tao, PetscReal *fatol, PetscReal *frtol, PetscReal *gatol, PetscReal *grtol, PetscReal *gttol) 1060a7e14dcfSSatish Balay { 1061a7e14dcfSSatish Balay PetscFunctionBegin; 1062a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 1063a7e14dcfSSatish Balay if (fatol) *fatol=tao->fatol; 1064a7e14dcfSSatish Balay if (frtol) *frtol=tao->frtol; 1065a7e14dcfSSatish Balay if (gatol) *gatol=tao->gatol; 1066a7e14dcfSSatish Balay if (grtol) *grtol=tao->grtol; 1067a7e14dcfSSatish Balay if (gttol) *gttol=tao->gttol; 1068a7e14dcfSSatish Balay PetscFunctionReturn(0); 1069a7e14dcfSSatish Balay } 1070a7e14dcfSSatish Balay 1071a7e14dcfSSatish Balay 1072a7e14dcfSSatish Balay #undef __FUNCT__ 1073a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetKSP" 1074a7e14dcfSSatish Balay /*@ 1075a7e14dcfSSatish Balay TaoGetKSP - Gets the linear solver used by the optimization solver. 1076a7e14dcfSSatish Balay Application writers should use TaoGetKSP if they need direct access 1077a7e14dcfSSatish Balay to the PETSc KSP object. 1078a7e14dcfSSatish Balay 1079a7e14dcfSSatish Balay Not Collective 1080a7e14dcfSSatish Balay 1081a7e14dcfSSatish Balay Input Parameters: 1082a7e14dcfSSatish Balay . tao - the TAO solver 1083a7e14dcfSSatish Balay 1084a7e14dcfSSatish Balay Output Parameters: 1085a7e14dcfSSatish Balay . ksp - the KSP linear solver used in the optimization solver 1086a7e14dcfSSatish Balay 1087a7e14dcfSSatish Balay Level: intermediate 1088a7e14dcfSSatish Balay 1089a7e14dcfSSatish Balay @*/ 1090*47a47007SBarry Smith PetscErrorCode TaoGetKSP(TaoSolver tao, KSP *ksp) 1091*47a47007SBarry Smith { 1092a7e14dcfSSatish Balay PetscFunctionBegin; 1093a7e14dcfSSatish Balay *ksp = tao->ksp; 1094a7e14dcfSSatish Balay PetscFunctionReturn(0); 1095a7e14dcfSSatish Balay } 1096a7e14dcfSSatish Balay 1097a7e14dcfSSatish Balay #undef __FUNCT__ 1098a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetLineSearch" 1099a7e14dcfSSatish Balay /*@ 1100a7e14dcfSSatish Balay TaoGetLineSearch - Gets the line search used by the optimization solver. 1101a7e14dcfSSatish Balay Application writers should use TaoGetLineSearch if they need direct access 1102a7e14dcfSSatish Balay to the TaoLineSearch object. 1103a7e14dcfSSatish Balay 1104a7e14dcfSSatish Balay Not Collective 1105a7e14dcfSSatish Balay 1106a7e14dcfSSatish Balay Input Parameters: 1107a7e14dcfSSatish Balay . tao - the TAO solver 1108a7e14dcfSSatish Balay 1109a7e14dcfSSatish Balay Output Parameters: 1110a7e14dcfSSatish Balay . ls - the line search used in the optimization solver 1111a7e14dcfSSatish Balay 1112a7e14dcfSSatish Balay Level: intermediate 1113a7e14dcfSSatish Balay 1114a7e14dcfSSatish Balay @*/ 1115*47a47007SBarry Smith PetscErrorCode TaoGetLineSearch(TaoSolver tao, TaoLineSearch *ls) 1116*47a47007SBarry Smith { 1117a7e14dcfSSatish Balay PetscFunctionBegin; 1118a7e14dcfSSatish Balay *ls = tao->linesearch; 1119a7e14dcfSSatish Balay PetscFunctionReturn(0); 1120a7e14dcfSSatish Balay } 1121a7e14dcfSSatish Balay 1122a7e14dcfSSatish Balay #undef __FUNCT__ 1123a7e14dcfSSatish Balay #define __FUNCT__ "TaoAddLineSearchCounts" 1124a7e14dcfSSatish Balay /*@ 1125a7e14dcfSSatish Balay TaoAddLineSearchCounts - Adds the number of function evaluations spent 1126a7e14dcfSSatish Balay in the line search to the running total. 1127a7e14dcfSSatish Balay 1128a7e14dcfSSatish Balay Input Parameters: 1129a7e14dcfSSatish Balay + tao - the TAO solver 1130a7e14dcfSSatish Balay - ls - the line search used in the optimization solver 1131a7e14dcfSSatish Balay 1132a7e14dcfSSatish Balay Level: developer 1133a7e14dcfSSatish Balay 1134a7e14dcfSSatish Balay .seealso: TaoLineSearchApply() 1135a7e14dcfSSatish Balay @*/ 1136*47a47007SBarry Smith PetscErrorCode TaoAddLineSearchCounts(TaoSolver tao) 1137*47a47007SBarry Smith { 1138a7e14dcfSSatish Balay PetscErrorCode ierr; 1139a7e14dcfSSatish Balay PetscBool flg; 1140a7e14dcfSSatish Balay PetscInt nfeval,ngeval,nfgeval; 1141*47a47007SBarry Smith 1142a7e14dcfSSatish Balay PetscFunctionBegin; 1143a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 1144a7e14dcfSSatish Balay if (tao->linesearch) { 1145a7e14dcfSSatish Balay ierr = TaoLineSearchIsUsingTaoSolverRoutines(tao->linesearch,&flg); 1146a7e14dcfSSatish Balay if (flg == PETSC_FALSE) { 1147*47a47007SBarry Smith ierr = TaoLineSearchGetNumberFunctionEvaluations(tao->linesearch,&nfeval,&ngeval,&nfgeval);CHKERRQ(ierr); 1148a7e14dcfSSatish Balay tao->nfuncs+=nfeval; 1149a7e14dcfSSatish Balay tao->ngrads+=ngeval; 1150a7e14dcfSSatish Balay tao->nfuncgrads+=nfgeval; 1151a7e14dcfSSatish Balay } 1152a7e14dcfSSatish Balay } 1153a7e14dcfSSatish Balay PetscFunctionReturn(0); 1154a7e14dcfSSatish Balay } 1155a7e14dcfSSatish Balay 1156a7e14dcfSSatish Balay 1157a7e14dcfSSatish Balay #undef __FUNCT__ 1158a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetSolutionVector" 1159a7e14dcfSSatish Balay /*@ 1160a7e14dcfSSatish Balay TaoGetSolutionVector - Returns the vector with the current TAO solution 1161a7e14dcfSSatish Balay 1162a7e14dcfSSatish Balay Not Collective 1163a7e14dcfSSatish Balay 1164a7e14dcfSSatish Balay Input Parameter: 1165a7e14dcfSSatish Balay . tao - the TaoSolver context 1166a7e14dcfSSatish Balay 1167a7e14dcfSSatish Balay Output Parameter: 1168a7e14dcfSSatish Balay . X - the current solution 1169a7e14dcfSSatish Balay 1170a7e14dcfSSatish Balay Level: intermediate 1171a7e14dcfSSatish Balay 1172a7e14dcfSSatish Balay Note: The returned vector will be the same object that was passed into TaoSetInitialVector() 1173a7e14dcfSSatish Balay @*/ 1174a7e14dcfSSatish Balay PetscErrorCode TaoGetSolutionVector(TaoSolver tao, Vec *X) 1175a7e14dcfSSatish Balay { 1176a7e14dcfSSatish Balay PetscFunctionBegin; 1177a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 1178a7e14dcfSSatish Balay *X = tao->solution; 1179a7e14dcfSSatish Balay PetscFunctionReturn(0); 1180a7e14dcfSSatish Balay } 1181a7e14dcfSSatish Balay 1182a7e14dcfSSatish Balay #undef __FUNCT__ 1183a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetGradientVector" 1184a7e14dcfSSatish Balay /*@ 1185a7e14dcfSSatish Balay TaoGetGradientVector - Returns the vector with the current TAO gradient 1186a7e14dcfSSatish Balay 1187a7e14dcfSSatish Balay Not Collective 1188a7e14dcfSSatish Balay 1189a7e14dcfSSatish Balay Input Parameter: 1190a7e14dcfSSatish Balay . tao - the TaoSolver context 1191a7e14dcfSSatish Balay 1192a7e14dcfSSatish Balay Output Parameter: 1193a7e14dcfSSatish Balay . G - the current solution 1194a7e14dcfSSatish Balay 1195a7e14dcfSSatish Balay Level: intermediate 1196a7e14dcfSSatish Balay @*/ 1197a7e14dcfSSatish Balay PetscErrorCode TaoGetGradientVector(TaoSolver tao, Vec *G) 1198a7e14dcfSSatish Balay { 1199a7e14dcfSSatish Balay PetscFunctionBegin; 1200a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 1201a7e14dcfSSatish Balay *G = tao->gradient; 1202a7e14dcfSSatish Balay PetscFunctionReturn(0); 1203a7e14dcfSSatish Balay } 1204a7e14dcfSSatish Balay 1205a7e14dcfSSatish Balay #undef __FUNCT__ 1206a7e14dcfSSatish Balay #define __FUNCT__ "TaoResetStatistics" 1207a7e14dcfSSatish Balay /*@ 1208a7e14dcfSSatish Balay TaoResetStatistics - Initialize the statistics used by TAO for all of the solvers. 1209a7e14dcfSSatish Balay These statistics include the iteration number, residual norms, and convergence status. 1210a7e14dcfSSatish Balay This routine gets called before solving each optimization problem. 1211a7e14dcfSSatish Balay 1212a7e14dcfSSatish Balay Collective on TaoSolver 1213a7e14dcfSSatish Balay 1214a7e14dcfSSatish Balay Input Parameters: 1215a7e14dcfSSatish Balay . solver - the TaoSolver context 1216a7e14dcfSSatish Balay 1217a7e14dcfSSatish Balay Level: developer 1218a7e14dcfSSatish Balay 1219a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve() 1220a7e14dcfSSatish Balay @*/ 1221a7e14dcfSSatish Balay PetscErrorCode TaoResetStatistics(TaoSolver tao) 1222a7e14dcfSSatish Balay { 1223a7e14dcfSSatish Balay PetscFunctionBegin; 1224a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 1225a7e14dcfSSatish Balay tao->niter = 0; 1226a7e14dcfSSatish Balay tao->nfuncs = 0; 1227a7e14dcfSSatish Balay tao->nfuncgrads = 0; 1228a7e14dcfSSatish Balay tao->ngrads = 0; 1229a7e14dcfSSatish Balay tao->nhess = 0; 1230a7e14dcfSSatish Balay tao->njac = 0; 1231a7e14dcfSSatish Balay tao->nconstraints = 0; 1232a7e14dcfSSatish Balay tao->ksp_its = 0; 1233a7e14dcfSSatish Balay tao->reason = TAO_CONTINUE_ITERATING; 1234a7e14dcfSSatish Balay tao->residual = 0.0; 1235a7e14dcfSSatish Balay tao->cnorm = 0.0; 1236a7e14dcfSSatish Balay tao->step = 0.0; 1237a7e14dcfSSatish Balay tao->lsflag = PETSC_FALSE; 1238a7e14dcfSSatish Balay if (tao->hist_reset) tao->hist_len=0; 1239a7e14dcfSSatish Balay PetscFunctionReturn(0); 1240a7e14dcfSSatish Balay } 1241a7e14dcfSSatish Balay 1242a7e14dcfSSatish Balay #undef __FUNCT__ 1243a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetConvergenceTest" 1244a7e14dcfSSatish Balay /*@C 1245a7e14dcfSSatish Balay TaoSetConvergenceTest - Sets the function that is to be used to test 1246a7e14dcfSSatish Balay for convergence o fthe iterative minimization solution. The new convergence 1247a7e14dcfSSatish Balay testing routine will replace TAO's default convergence test. 1248a7e14dcfSSatish Balay 1249a7e14dcfSSatish Balay Logically Collective on TaoSolver 1250a7e14dcfSSatish Balay 1251a7e14dcfSSatish Balay Input Parameters: 1252a7e14dcfSSatish Balay + tao - the TaoSolver object 1253a7e14dcfSSatish Balay . conv - the routine to test for convergence 1254a7e14dcfSSatish Balay - ctx - [optional] context for private data for the convergence routine 1255*47a47007SBarry Smith (may be NULL) 1256a7e14dcfSSatish Balay 1257a7e14dcfSSatish Balay Calling sequence of conv: 1258a7e14dcfSSatish Balay $ PetscErrorCode conv(TaoSolver tao, void *ctx) 1259a7e14dcfSSatish Balay 1260a7e14dcfSSatish Balay + tao - the TaoSolver object 1261a7e14dcfSSatish Balay - ctx - [optional] convergence context 1262a7e14dcfSSatish Balay 1263a7e14dcfSSatish Balay Note: The new convergence testing routine should call TaoSetTerminationReason(). 1264a7e14dcfSSatish Balay 1265a7e14dcfSSatish Balay Level: advanced 1266a7e14dcfSSatish Balay 1267a7e14dcfSSatish Balay .seealso: TaoSetTerminationReason(), TaoGetSolutionStatus(), TaoGetTolerances(), TaoSetMonitor 1268a7e14dcfSSatish Balay 1269a7e14dcfSSatish Balay @*/ 1270a7e14dcfSSatish Balay PetscErrorCode TaoSetConvergenceTest(TaoSolver tao, PetscErrorCode (*conv)(TaoSolver,void*), void *ctx) 1271a7e14dcfSSatish Balay { 1272a7e14dcfSSatish Balay PetscFunctionBegin; 1273a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 1274a7e14dcfSSatish Balay (tao)->ops->convergencetest = conv; 1275a7e14dcfSSatish Balay (tao)->cnvP = ctx; 1276a7e14dcfSSatish Balay PetscFunctionReturn(0); 1277a7e14dcfSSatish Balay } 1278a7e14dcfSSatish Balay 1279a7e14dcfSSatish Balay #undef __FUNCT__ 1280a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMonitor" 1281a7e14dcfSSatish Balay /*@C 1282a7e14dcfSSatish Balay TaoSetMonitor - Sets an ADDITIONAL function that is to be used at every 1283a7e14dcfSSatish Balay iteration of the solver to display the iteration's 1284a7e14dcfSSatish Balay progress. 1285a7e14dcfSSatish Balay 1286a7e14dcfSSatish Balay Logically Collective on TaoSolver 1287a7e14dcfSSatish Balay 1288a7e14dcfSSatish Balay Input Parameters: 1289a7e14dcfSSatish Balay + tao - the TaoSolver solver context 1290a7e14dcfSSatish Balay . mymonitor - monitoring routine 1291a7e14dcfSSatish Balay - mctx - [optional] user-defined context for private data for the 1292*47a47007SBarry Smith monitor routine (may be NULL) 1293a7e14dcfSSatish Balay 1294a7e14dcfSSatish Balay Calling sequence of mymonitor: 1295a7e14dcfSSatish Balay $ int mymonitor(TaoSolver tao,void *mctx) 1296a7e14dcfSSatish Balay 1297a7e14dcfSSatish Balay + tao - the TaoSolver solver context 1298a7e14dcfSSatish Balay - mctx - [optional] monitoring context 1299a7e14dcfSSatish Balay 1300a7e14dcfSSatish Balay 1301a7e14dcfSSatish Balay Options Database Keys: 1302a7e14dcfSSatish Balay + -tao_monitor - sets TaoDefaultMonitor() 1303a7e14dcfSSatish Balay . -tao_smonitor - sets short monitor 1304a7e14dcfSSatish Balay . -tao_cmonitor - same as smonitor plus constraint norm 1305a7e14dcfSSatish Balay . -tao_view_solution - view solution at each iteration 1306a7e14dcfSSatish Balay . -tao_view_gradient - view gradient at each iteration 1307a7e14dcfSSatish Balay . -tao_view_separableobjective - view separable objective function at each iteration 1308a7e14dcfSSatish 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. 1309a7e14dcfSSatish Balay 1310a7e14dcfSSatish Balay 1311a7e14dcfSSatish Balay Notes: 1312a7e14dcfSSatish Balay Several different monitoring routines may be set by calling 1313a7e14dcfSSatish Balay TaoSetMonitor() multiple times; all will be called in the 1314a7e14dcfSSatish Balay order in which they were set. 1315a7e14dcfSSatish Balay 1316a7e14dcfSSatish Balay Fortran Notes: Only one monitor function may be set 1317a7e14dcfSSatish Balay 1318a7e14dcfSSatish Balay Level: intermediate 1319a7e14dcfSSatish Balay 1320a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoCancelMonitors(), TaoSetDestroyRoutine() 1321a7e14dcfSSatish Balay @*/ 1322a7e14dcfSSatish Balay PetscErrorCode TaoSetMonitor(TaoSolver tao, PetscErrorCode (*func)(TaoSolver, void*), void *ctx,PetscErrorCode (*dest)(void**)) 1323a7e14dcfSSatish Balay { 1324a7e14dcfSSatish Balay PetscFunctionBegin; 1325a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 1326*47a47007SBarry Smith if (tao->numbermonitors >= MAXTAOMONITORS) SETERRQ1(PETSC_COMM_SELF,1,"Cannot attach another monitor -- max=",MAXTAOMONITORS); 1327a7e14dcfSSatish Balay tao->monitor[tao->numbermonitors] = func; 1328a7e14dcfSSatish Balay tao->monitorcontext[tao->numbermonitors] = ctx; 1329a7e14dcfSSatish Balay tao->monitordestroy[tao->numbermonitors] = dest; 1330a7e14dcfSSatish Balay ++tao->numbermonitors; 1331a7e14dcfSSatish Balay PetscFunctionReturn(0); 1332a7e14dcfSSatish Balay } 1333a7e14dcfSSatish Balay 1334a7e14dcfSSatish Balay #undef __FUNCT__ 1335a7e14dcfSSatish Balay #define __FUNCT__ "TaoCancelMonitors" 1336a7e14dcfSSatish Balay /*@ 1337a7e14dcfSSatish Balay TaoCancelMonitors - Clears all the monitor functions for a TaoSolver object. 1338a7e14dcfSSatish Balay 1339a7e14dcfSSatish Balay Logically Collective on TaoSolver 1340a7e14dcfSSatish Balay 1341a7e14dcfSSatish Balay Input Parameters: 1342a7e14dcfSSatish Balay . tao - the TaoSolver solver context 1343a7e14dcfSSatish Balay 1344a7e14dcfSSatish Balay Options Database: 1345a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors that have been hardwired 1346a7e14dcfSSatish Balay into a code by calls to TaoSetMonitor(), but does not cancel those 1347a7e14dcfSSatish Balay set via the options database 1348a7e14dcfSSatish Balay 1349a7e14dcfSSatish Balay Notes: 1350a7e14dcfSSatish Balay There is no way to clear one specific monitor from a TaoSolver object. 1351a7e14dcfSSatish Balay 1352a7e14dcfSSatish Balay Level: advanced 1353a7e14dcfSSatish Balay 1354a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor() 1355a7e14dcfSSatish Balay @*/ 1356a7e14dcfSSatish Balay PetscErrorCode TaoCancelMonitors(TaoSolver tao) 1357a7e14dcfSSatish Balay { 1358a7e14dcfSSatish Balay PetscInt i; 1359a7e14dcfSSatish Balay PetscErrorCode ierr; 1360*47a47007SBarry Smith 1361a7e14dcfSSatish Balay PetscFunctionBegin; 1362a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 1363a7e14dcfSSatish Balay for (i=0;i<tao->numbermonitors;i++) { 1364a7e14dcfSSatish Balay if (tao->monitordestroy[i]) { 1365a7e14dcfSSatish Balay ierr = (*tao->monitordestroy[i])(&tao->monitorcontext[i]);CHKERRQ(ierr); 1366a7e14dcfSSatish Balay } 1367a7e14dcfSSatish Balay } 1368a7e14dcfSSatish Balay tao->numbermonitors=0; 1369a7e14dcfSSatish Balay PetscFunctionReturn(0); 1370a7e14dcfSSatish Balay } 1371a7e14dcfSSatish Balay 1372a7e14dcfSSatish Balay #undef __FUNCT__ 1373a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultMonitor" 1374a7e14dcfSSatish Balay /*@C 1375a7e14dcfSSatish Balay TaoDefaultMonitor - Default routine for monitoring progress of the 1376a7e14dcfSSatish Balay TaoSolver solvers (default). This monitor prints the function value and gradient 1377a7e14dcfSSatish Balay norm at each iteration. It can be turned on from the command line using the 1378a7e14dcfSSatish Balay -tao_monitor option 1379a7e14dcfSSatish Balay 1380a7e14dcfSSatish Balay Collective on TaoSolver 1381a7e14dcfSSatish Balay 1382a7e14dcfSSatish Balay Input Parameters: 1383a7e14dcfSSatish Balay + tao - the TaoSolver context 1384*47a47007SBarry Smith - ctx - PetscViewer context or NULL 1385a7e14dcfSSatish Balay 1386a7e14dcfSSatish Balay Options Database Keys: 1387a7e14dcfSSatish Balay . -tao_monitor 1388a7e14dcfSSatish Balay 1389a7e14dcfSSatish Balay Level: advanced 1390a7e14dcfSSatish Balay 1391a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1392a7e14dcfSSatish Balay @*/ 1393a7e14dcfSSatish Balay PetscErrorCode TaoDefaultMonitor(TaoSolver tao, void *ctx) 1394a7e14dcfSSatish Balay { 1395a7e14dcfSSatish Balay PetscErrorCode ierr; 1396a7e14dcfSSatish Balay PetscInt its; 1397a7e14dcfSSatish Balay PetscReal fct,gnorm; 1398a7e14dcfSSatish Balay PetscViewer viewer; 1399*47a47007SBarry Smith 1400a7e14dcfSSatish Balay PetscFunctionBegin; 1401a7e14dcfSSatish Balay if (ctx) { 1402a7e14dcfSSatish Balay viewer = (PetscViewer)ctx; 1403a7e14dcfSSatish Balay } else { 1404a7e14dcfSSatish Balay viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm); 1405a7e14dcfSSatish Balay } 1406a7e14dcfSSatish Balay its=tao->niter; 1407a7e14dcfSSatish Balay fct=tao->fc; 1408a7e14dcfSSatish Balay gnorm=tao->residual; 1409a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr); 1410*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr); 1411*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr); 1412a7e14dcfSSatish Balay PetscFunctionReturn(0); 1413a7e14dcfSSatish Balay } 1414a7e14dcfSSatish Balay 1415a7e14dcfSSatish Balay #undef __FUNCT__ 1416a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultSMonitor" 1417a7e14dcfSSatish Balay /*@C 1418a7e14dcfSSatish Balay TaoDefaultSMonitor - Default routine for monitoring progress of the 1419a7e14dcfSSatish Balay solver. Same as TaoDefaultMonitor() except 1420a7e14dcfSSatish Balay it prints fewer digits of the residual as the residual gets smaller. 1421a7e14dcfSSatish Balay This is because the later digits are meaningless and are often 1422a7e14dcfSSatish Balay different on different machines; by using this routine different 1423a7e14dcfSSatish Balay machines will usually generate the same output. It can be turned on 1424a7e14dcfSSatish Balay by using the -tao_smonitor option 1425a7e14dcfSSatish Balay 1426a7e14dcfSSatish Balay Collective on TaoSolver 1427a7e14dcfSSatish Balay 1428a7e14dcfSSatish Balay Input Parameters: 1429a7e14dcfSSatish Balay + tao - the TaoSolver context 1430*47a47007SBarry Smith - ctx - PetscViewer context or NULL 1431a7e14dcfSSatish Balay 1432a7e14dcfSSatish Balay Options Database Keys: 1433a7e14dcfSSatish Balay . -tao_smonitor 1434a7e14dcfSSatish Balay 1435a7e14dcfSSatish Balay Level: advanced 1436a7e14dcfSSatish Balay 1437a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor() 1438a7e14dcfSSatish Balay @*/ 1439a7e14dcfSSatish Balay PetscErrorCode TaoDefaultSMonitor(TaoSolver tao, void *ctx) 1440a7e14dcfSSatish Balay { 1441a7e14dcfSSatish Balay PetscErrorCode ierr; 1442a7e14dcfSSatish Balay PetscInt its; 1443a7e14dcfSSatish Balay PetscReal fct,gnorm; 1444a7e14dcfSSatish Balay PetscViewer viewer; 1445*47a47007SBarry Smith 1446a7e14dcfSSatish Balay PetscFunctionBegin; 1447a7e14dcfSSatish Balay if (ctx) { 1448a7e14dcfSSatish Balay viewer = (PetscViewer)ctx; 1449a7e14dcfSSatish Balay } else { 1450a7e14dcfSSatish Balay viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm); 1451a7e14dcfSSatish Balay } 1452a7e14dcfSSatish Balay its=tao->niter; 1453a7e14dcfSSatish Balay fct=tao->fc; 1454a7e14dcfSSatish Balay gnorm=tao->residual; 1455a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr); 1456*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Function value %g,",(double)fct);CHKERRQ(ierr); 1457a7e14dcfSSatish Balay if (gnorm > 1.e-6) { 1458*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr); 1459a7e14dcfSSatish Balay } else if (gnorm > 1.e-11) { 1460a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-6 \n");CHKERRQ(ierr); 1461a7e14dcfSSatish Balay } else { 1462a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-11 \n");CHKERRQ(ierr); 1463a7e14dcfSSatish Balay } 1464a7e14dcfSSatish Balay PetscFunctionReturn(0); 1465a7e14dcfSSatish Balay } 1466a7e14dcfSSatish Balay 1467a7e14dcfSSatish Balay #undef __FUNCT__ 1468a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultCMonitor" 1469a7e14dcfSSatish Balay /*@C 1470a7e14dcfSSatish Balay TaoDefaultCMonitor - same as TaoDefaultMonitor() except 1471a7e14dcfSSatish Balay it prints the norm of the constraints function. It can be turned on 1472a7e14dcfSSatish Balay from the command line using the -tao_cmonitor option 1473a7e14dcfSSatish Balay 1474a7e14dcfSSatish Balay Collective on TaoSolver 1475a7e14dcfSSatish Balay 1476a7e14dcfSSatish Balay Input Parameters: 1477a7e14dcfSSatish Balay + tao - the TaoSolver context 1478*47a47007SBarry Smith - ctx - PetscViewer context or NULL 1479a7e14dcfSSatish Balay 1480a7e14dcfSSatish Balay Options Database Keys: 1481a7e14dcfSSatish Balay . -tao_cmonitor 1482a7e14dcfSSatish Balay 1483a7e14dcfSSatish Balay Level: advanced 1484a7e14dcfSSatish Balay 1485a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor() 1486a7e14dcfSSatish Balay @*/ 1487a7e14dcfSSatish Balay PetscErrorCode TaoDefaultCMonitor(TaoSolver tao, void *ctx) 1488a7e14dcfSSatish Balay { 1489a7e14dcfSSatish Balay PetscErrorCode ierr; 1490a7e14dcfSSatish Balay PetscInt its; 1491a7e14dcfSSatish Balay PetscReal fct,gnorm; 1492a7e14dcfSSatish Balay PetscViewer viewer; 1493a7e14dcfSSatish Balay 1494a7e14dcfSSatish Balay PetscFunctionBegin; 1495a7e14dcfSSatish Balay if (ctx) { 1496a7e14dcfSSatish Balay viewer = (PetscViewer)ctx; 1497a7e14dcfSSatish Balay } else { 1498a7e14dcfSSatish Balay viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm); 1499a7e14dcfSSatish Balay } 1500a7e14dcfSSatish Balay its=tao->niter; 1501a7e14dcfSSatish Balay fct=tao->fc; 1502a7e14dcfSSatish Balay gnorm=tao->residual; 1503a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"iter = %D,",its);CHKERRQ(ierr); 1504*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr); 1505*47a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Residual: %g ",(double)gnorm);CHKERRQ(ierr); 1506*47a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Constraint: %g \n",(double)tao->cnorm);CHKERRQ(ierr); 1507a7e14dcfSSatish Balay PetscFunctionReturn(0); 1508a7e14dcfSSatish Balay } 1509a7e14dcfSSatish Balay 1510a7e14dcfSSatish Balay #undef __FUNCT__ 1511a7e14dcfSSatish Balay #define __FUNCT__ "TaoSolutionMonitor" 1512a7e14dcfSSatish Balay /*@C 1513a7e14dcfSSatish Balay TaoSolutionMonitor - Views the solution at each iteration 1514a7e14dcfSSatish Balay It can be turned on from the command line using the 1515a7e14dcfSSatish Balay -tao_view_solution option 1516a7e14dcfSSatish Balay 1517a7e14dcfSSatish Balay Collective on TaoSolver 1518a7e14dcfSSatish Balay 1519a7e14dcfSSatish Balay Input Parameters: 1520a7e14dcfSSatish Balay + tao - the TaoSolver context 1521*47a47007SBarry Smith - ctx - PetscViewer context or NULL 1522a7e14dcfSSatish Balay 1523a7e14dcfSSatish Balay Options Database Keys: 1524a7e14dcfSSatish Balay . -tao_view_solution 1525a7e14dcfSSatish Balay 1526a7e14dcfSSatish Balay Level: advanced 1527a7e14dcfSSatish Balay 1528a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1529a7e14dcfSSatish Balay @*/ 1530a7e14dcfSSatish Balay PetscErrorCode TaoSolutionMonitor(TaoSolver tao, void *ctx) 1531a7e14dcfSSatish Balay { 1532a7e14dcfSSatish Balay PetscErrorCode ierr; 1533a7e14dcfSSatish Balay PetscViewer viewer; 1534*47a47007SBarry Smith 1535a7e14dcfSSatish Balay PetscFunctionBegin; 1536a7e14dcfSSatish Balay if (ctx) { 1537a7e14dcfSSatish Balay viewer = (PetscViewer)ctx; 1538a7e14dcfSSatish Balay } else { 1539a7e14dcfSSatish Balay viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm); 1540a7e14dcfSSatish Balay } 1541a7e14dcfSSatish Balay ierr = VecView(tao->solution, viewer);CHKERRQ(ierr); 1542a7e14dcfSSatish Balay PetscFunctionReturn(0); 1543a7e14dcfSSatish Balay } 1544a7e14dcfSSatish Balay 1545a7e14dcfSSatish Balay #undef __FUNCT__ 1546a7e14dcfSSatish Balay #define __FUNCT__ "TaoGradientMonitor" 1547a7e14dcfSSatish Balay /*@C 1548a7e14dcfSSatish Balay TaoGradientMonitor - Views the gradient at each iteration 1549a7e14dcfSSatish Balay It can be turned on from the command line using the 1550a7e14dcfSSatish Balay -tao_view_gradient option 1551a7e14dcfSSatish Balay 1552a7e14dcfSSatish Balay Collective on TaoSolver 1553a7e14dcfSSatish Balay 1554a7e14dcfSSatish Balay Input Parameters: 1555a7e14dcfSSatish Balay + tao - the TaoSolver context 1556*47a47007SBarry Smith - ctx - PetscViewer context or NULL 1557a7e14dcfSSatish Balay 1558a7e14dcfSSatish Balay Options Database Keys: 1559a7e14dcfSSatish Balay . -tao_view_gradient 1560a7e14dcfSSatish Balay 1561a7e14dcfSSatish Balay Level: advanced 1562a7e14dcfSSatish Balay 1563a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1564a7e14dcfSSatish Balay @*/ 1565a7e14dcfSSatish Balay PetscErrorCode TaoGradientMonitor(TaoSolver tao, void *ctx) 1566a7e14dcfSSatish Balay { 1567a7e14dcfSSatish Balay PetscErrorCode ierr; 1568a7e14dcfSSatish Balay PetscViewer viewer; 1569*47a47007SBarry Smith 1570a7e14dcfSSatish Balay PetscFunctionBegin; 1571a7e14dcfSSatish Balay if (ctx) { 1572a7e14dcfSSatish Balay viewer = (PetscViewer)ctx; 1573a7e14dcfSSatish Balay } else { 1574a7e14dcfSSatish Balay viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm); 1575a7e14dcfSSatish Balay } 1576a7e14dcfSSatish Balay ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr); 1577a7e14dcfSSatish Balay PetscFunctionReturn(0); 1578a7e14dcfSSatish Balay } 1579a7e14dcfSSatish Balay 1580a7e14dcfSSatish Balay #undef __FUNCT__ 1581a7e14dcfSSatish Balay #define __FUNCT__ "TaoStepDirectionMonitor" 1582a7e14dcfSSatish Balay /*@C 1583a7e14dcfSSatish Balay TaoStepDirectionMonitor - Views the gradient at each iteration 1584a7e14dcfSSatish Balay It can be turned on from the command line using the 1585a7e14dcfSSatish Balay -tao_view_gradient option 1586a7e14dcfSSatish Balay 1587a7e14dcfSSatish Balay Collective on TaoSolver 1588a7e14dcfSSatish Balay 1589a7e14dcfSSatish Balay Input Parameters: 1590a7e14dcfSSatish Balay + tao - the TaoSolver context 1591*47a47007SBarry Smith - ctx - PetscViewer context or NULL 1592a7e14dcfSSatish Balay 1593a7e14dcfSSatish Balay Options Database Keys: 1594a7e14dcfSSatish Balay . -tao_view_gradient 1595a7e14dcfSSatish Balay 1596a7e14dcfSSatish Balay Level: advanced 1597a7e14dcfSSatish Balay 1598a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1599a7e14dcfSSatish Balay @*/ 1600a7e14dcfSSatish Balay PetscErrorCode TaoStepDirectionMonitor(TaoSolver tao, void *ctx) 1601a7e14dcfSSatish Balay { 1602a7e14dcfSSatish Balay PetscErrorCode ierr; 1603a7e14dcfSSatish Balay PetscViewer viewer; 1604a7e14dcfSSatish Balay PetscFunctionBegin; 1605a7e14dcfSSatish Balay if (ctx) { 1606a7e14dcfSSatish Balay viewer = (PetscViewer)ctx; 1607a7e14dcfSSatish Balay } else { 1608a7e14dcfSSatish Balay viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm); 1609a7e14dcfSSatish Balay } 1610a7e14dcfSSatish Balay ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr); 1611a7e14dcfSSatish Balay PetscFunctionReturn(0); 1612a7e14dcfSSatish Balay } 1613a7e14dcfSSatish Balay 1614a7e14dcfSSatish Balay #undef __FUNCT__ 1615a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawSolutionMonitor" 1616a7e14dcfSSatish Balay /*@C 1617a7e14dcfSSatish Balay TaoDrawSolutionMonitor - Plots the solution at each iteration 1618a7e14dcfSSatish Balay It can be turned on from the command line using the 1619a7e14dcfSSatish Balay -tao_draw_solution option 1620a7e14dcfSSatish Balay 1621a7e14dcfSSatish Balay Collective on TaoSolver 1622a7e14dcfSSatish Balay 1623a7e14dcfSSatish Balay Input Parameters: 1624a7e14dcfSSatish Balay + tao - the TaoSolver context 1625*47a47007SBarry Smith - ctx - PetscViewer context or NULL 1626a7e14dcfSSatish Balay 1627a7e14dcfSSatish Balay Options Database Keys: 1628a7e14dcfSSatish Balay . -tao_draw_solution 1629a7e14dcfSSatish Balay 1630a7e14dcfSSatish Balay Level: advanced 1631a7e14dcfSSatish Balay 1632a7e14dcfSSatish Balay .seealso: TaoSolutionMonitor(), TaoSetMonitor(), TaoDrawGradientMonitor 1633a7e14dcfSSatish Balay @*/ 1634a7e14dcfSSatish Balay PetscErrorCode TaoDrawSolutionMonitor(TaoSolver tao, void *ctx) 1635a7e14dcfSSatish Balay { 1636a7e14dcfSSatish Balay PetscErrorCode ierr; 1637a7e14dcfSSatish Balay PetscViewer viewer = (PetscViewer) ctx; 1638a7e14dcfSSatish Balay MPI_Comm comm; 1639*47a47007SBarry Smith 1640a7e14dcfSSatish Balay PetscFunctionBegin; 1641a7e14dcfSSatish Balay if (!viewer) { 1642a7e14dcfSSatish Balay ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr); 1643a7e14dcfSSatish Balay viewer = PETSC_VIEWER_DRAW_(comm); 1644a7e14dcfSSatish Balay } 1645a7e14dcfSSatish Balay ierr = VecView(tao->solution, viewer);CHKERRQ(ierr); 1646a7e14dcfSSatish Balay PetscFunctionReturn(0); 1647a7e14dcfSSatish Balay } 1648a7e14dcfSSatish Balay 1649a7e14dcfSSatish Balay #undef __FUNCT__ 1650a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawGradientMonitor" 1651a7e14dcfSSatish Balay /*@C 1652a7e14dcfSSatish Balay TaoDrawGradientMonitor - Plots the gradient at each iteration 1653a7e14dcfSSatish Balay It can be turned on from the command line using the 1654a7e14dcfSSatish Balay -tao_draw_gradient option 1655a7e14dcfSSatish Balay 1656a7e14dcfSSatish Balay Collective on TaoSolver 1657a7e14dcfSSatish Balay 1658a7e14dcfSSatish Balay Input Parameters: 1659a7e14dcfSSatish Balay + tao - the TaoSolver context 1660*47a47007SBarry Smith - ctx - PetscViewer context or NULL 1661a7e14dcfSSatish Balay 1662a7e14dcfSSatish Balay Options Database Keys: 1663a7e14dcfSSatish Balay . -tao_draw_gradient 1664a7e14dcfSSatish Balay 1665a7e14dcfSSatish Balay Level: advanced 1666a7e14dcfSSatish Balay 1667a7e14dcfSSatish Balay .seealso: TaoGradientMonitor(), TaoSetMonitor(), TaoDrawSolutionMonitor 1668a7e14dcfSSatish Balay @*/ 1669a7e14dcfSSatish Balay PetscErrorCode TaoDrawGradientMonitor(TaoSolver tao, void *ctx) 1670a7e14dcfSSatish Balay { 1671a7e14dcfSSatish Balay PetscErrorCode ierr; 1672a7e14dcfSSatish Balay PetscViewer viewer = (PetscViewer)ctx; 1673a7e14dcfSSatish Balay MPI_Comm comm; 1674*47a47007SBarry Smith 1675a7e14dcfSSatish Balay PetscFunctionBegin; 1676a7e14dcfSSatish Balay if (!viewer) { 1677a7e14dcfSSatish Balay ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr); 1678a7e14dcfSSatish Balay viewer = PETSC_VIEWER_DRAW_(comm); 1679a7e14dcfSSatish Balay } 1680a7e14dcfSSatish Balay ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr); 1681a7e14dcfSSatish Balay PetscFunctionReturn(0); 1682a7e14dcfSSatish Balay } 1683a7e14dcfSSatish Balay 1684a7e14dcfSSatish Balay #undef __FUNCT__ 1685a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawStepMonitor" 1686a7e14dcfSSatish Balay /*@C 1687a7e14dcfSSatish Balay TaoDrawStepMonitor - Plots the step direction at each iteration 1688a7e14dcfSSatish Balay It can be turned on from the command line using the 1689a7e14dcfSSatish Balay -tao_draw_step option 1690a7e14dcfSSatish Balay 1691a7e14dcfSSatish Balay Collective on TaoSolver 1692a7e14dcfSSatish Balay 1693a7e14dcfSSatish Balay Input Parameters: 1694a7e14dcfSSatish Balay + tao - the TaoSolver context 1695*47a47007SBarry Smith - ctx - PetscViewer context or NULL 1696a7e14dcfSSatish Balay 1697a7e14dcfSSatish Balay Options Database Keys: 1698a7e14dcfSSatish Balay . -tao_draw_step 1699a7e14dcfSSatish Balay 1700a7e14dcfSSatish Balay Level: advanced 1701a7e14dcfSSatish Balay 1702a7e14dcfSSatish Balay .seealso: TaoSetMonitor(), TaoDrawSolutionMonitor 1703a7e14dcfSSatish Balay @*/ 1704a7e14dcfSSatish Balay PetscErrorCode TaoDrawStepMonitor(TaoSolver tao, void *ctx) 1705a7e14dcfSSatish Balay { 1706a7e14dcfSSatish Balay PetscErrorCode ierr; 1707a7e14dcfSSatish Balay PetscViewer viewer = (PetscViewer)(ctx); 1708a7e14dcfSSatish Balay MPI_Comm comm; 1709*47a47007SBarry Smith 1710a7e14dcfSSatish Balay PetscFunctionBegin; 1711a7e14dcfSSatish Balay if (!viewer) { 1712a7e14dcfSSatish Balay ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr); 1713a7e14dcfSSatish Balay viewer = PETSC_VIEWER_DRAW_(comm); 1714a7e14dcfSSatish Balay } 1715a7e14dcfSSatish Balay ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr); 1716a7e14dcfSSatish Balay PetscFunctionReturn(0); 1717a7e14dcfSSatish Balay } 1718a7e14dcfSSatish Balay 1719a7e14dcfSSatish Balay #undef __FUNCT__ 1720a7e14dcfSSatish Balay #define __FUNCT__ "TaoSeparableObjectiveMonitor" 1721a7e14dcfSSatish Balay /*@C 1722a7e14dcfSSatish Balay TaoSeparableObjectiveMonitor - Views the separable objective function at each iteration 1723a7e14dcfSSatish Balay It can be turned on from the command line using the 1724a7e14dcfSSatish Balay -tao_view_separableobjective option 1725a7e14dcfSSatish Balay 1726a7e14dcfSSatish Balay Collective on TaoSolver 1727a7e14dcfSSatish Balay 1728a7e14dcfSSatish Balay Input Parameters: 1729a7e14dcfSSatish Balay + tao - the TaoSolver context 1730*47a47007SBarry Smith - ctx - PetscViewer context or NULL 1731a7e14dcfSSatish Balay 1732a7e14dcfSSatish Balay Options Database Keys: 1733a7e14dcfSSatish Balay . -tao_view_separableobjective 1734a7e14dcfSSatish Balay 1735a7e14dcfSSatish Balay Level: advanced 1736a7e14dcfSSatish Balay 1737a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1738a7e14dcfSSatish Balay @*/ 1739a7e14dcfSSatish Balay PetscErrorCode TaoSeparableObjectiveMonitor(TaoSolver tao, void *ctx) 1740a7e14dcfSSatish Balay { 1741a7e14dcfSSatish Balay PetscErrorCode ierr; 1742a7e14dcfSSatish Balay PetscViewer viewer; 1743*47a47007SBarry Smith 1744a7e14dcfSSatish Balay PetscFunctionBegin; 1745a7e14dcfSSatish Balay if (ctx) { 1746a7e14dcfSSatish Balay viewer = (PetscViewer)ctx; 1747a7e14dcfSSatish Balay } else { 1748a7e14dcfSSatish Balay viewer = PETSC_VIEWER_STDOUT_(((PetscObject)tao)->comm); 1749a7e14dcfSSatish Balay } 1750a7e14dcfSSatish Balay ierr = VecView(tao->sep_objective,viewer);CHKERRQ(ierr); 1751a7e14dcfSSatish Balay PetscFunctionReturn(0); 1752a7e14dcfSSatish Balay } 1753a7e14dcfSSatish Balay 1754a7e14dcfSSatish Balay #undef __FUNCT__ 1755a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultConvergenceTest" 1756a7e14dcfSSatish Balay /*@C 1757a7e14dcfSSatish Balay TaoDefaultConvergenceTest - Determines whether the solver should continue iterating 1758a7e14dcfSSatish Balay or terminate. 1759a7e14dcfSSatish Balay 1760a7e14dcfSSatish Balay Collective on TaoSolver 1761a7e14dcfSSatish Balay 1762a7e14dcfSSatish Balay Input Parameters: 1763a7e14dcfSSatish Balay + tao - the TaoSolver context 1764a7e14dcfSSatish Balay - dummy - unused dummy context 1765a7e14dcfSSatish Balay 1766a7e14dcfSSatish Balay Output Parameter: 1767a7e14dcfSSatish Balay . reason - for terminating 1768a7e14dcfSSatish Balay 1769a7e14dcfSSatish Balay Notes: 1770a7e14dcfSSatish Balay This routine checks the residual in the optimality conditions, the 1771a7e14dcfSSatish Balay relative residual in the optimity conditions, the number of function 1772a7e14dcfSSatish Balay evaluations, and the function value to test convergence. Some 1773a7e14dcfSSatish Balay solvers may use different convergence routines. 1774a7e14dcfSSatish Balay 1775a7e14dcfSSatish Balay Level: developer 1776a7e14dcfSSatish Balay 1777a7e14dcfSSatish Balay .seealso: TaoSetTolerances(),TaoGetTerminationReason(),TaoSetTerminationReason() 1778a7e14dcfSSatish Balay @*/ 1779a7e14dcfSSatish Balay 1780a7e14dcfSSatish Balay PetscErrorCode TaoDefaultConvergenceTest(TaoSolver tao,void *dummy) 1781a7e14dcfSSatish Balay { 1782a7e14dcfSSatish Balay PetscInt niter=tao->niter, nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads); 1783a7e14dcfSSatish Balay PetscInt max_funcs=tao->max_funcs; 1784a7e14dcfSSatish Balay PetscReal gnorm=tao->residual, gnorm0=tao->gnorm0; 1785a7e14dcfSSatish Balay PetscReal f=tao->fc, steptol=tao->steptol,trradius=tao->step; 1786a7e14dcfSSatish Balay PetscReal gatol=tao->gatol,grtol=tao->grtol,gttol=tao->gttol; 1787a7e14dcfSSatish Balay PetscReal fatol=tao->fatol,frtol=tao->frtol,catol=tao->catol,crtol=tao->crtol; 1788a7e14dcfSSatish Balay PetscReal fmin=tao->fmin, cnorm=tao->cnorm, cnorm0=tao->cnorm0; 1789a7e14dcfSSatish Balay PetscReal gnorm2; 1790a7e14dcfSSatish Balay TaoSolverTerminationReason reason=tao->reason; 1791a7e14dcfSSatish Balay PetscErrorCode ierr; 1792a7e14dcfSSatish Balay 1793a7e14dcfSSatish Balay PetscFunctionBegin; 1794a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao, TAOSOLVER_CLASSID,1); 1795a7e14dcfSSatish Balay if (reason != TAO_CONTINUE_ITERATING) { 1796a7e14dcfSSatish Balay PetscFunctionReturn(0); 1797a7e14dcfSSatish Balay } 1798a7e14dcfSSatish Balay gnorm2=gnorm*gnorm; 1799a7e14dcfSSatish Balay 1800a7e14dcfSSatish Balay if (PetscIsInfOrNanReal(f)) { 1801a7e14dcfSSatish Balay ierr = PetscInfo(tao,"Failed to converged, function value is Inf or NaN\n");CHKERRQ(ierr); 1802a7e14dcfSSatish Balay reason = TAO_DIVERGED_NAN; 1803a7e14dcfSSatish Balay } else if (f <= fmin && cnorm <=catol) { 1804*47a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to function value %g < minimum function value %g\n", (double)f,(double)fmin);CHKERRQ(ierr); 1805a7e14dcfSSatish Balay reason = TAO_CONVERGED_MINF; 1806a7e14dcfSSatish Balay } else if (gnorm2 <= fatol && cnorm <=catol) { 1807*47a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to estimated f(X) - f(X*) = %g < %g\n",(double)gnorm2,(double)fatol);CHKERRQ(ierr); 1808a7e14dcfSSatish Balay reason = TAO_CONVERGED_FATOL; 1809a7e14dcfSSatish Balay } else if (f != 0 && gnorm2 / PetscAbsReal(f)<= frtol && cnorm/PetscMax(cnorm0,1.0) <= crtol) { 1810*47a47007SBarry 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); 1811a7e14dcfSSatish Balay reason = TAO_CONVERGED_FRTOL; 1812a7e14dcfSSatish Balay } else if (gnorm<= gatol && cnorm <=catol) { 1813*47a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to residual norm ||g(X)||=%g < %g\n",(double)gnorm,(double)gatol);CHKERRQ(ierr); 1814a7e14dcfSSatish Balay reason = TAO_CONVERGED_GATOL; 1815a7e14dcfSSatish Balay } else if ( f!=0 && PetscAbsReal(gnorm/f) <= grtol && cnorm <= crtol) { 1816*47a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to residual ||g(X)||/|f(X)| =%g < %g\n",(double)(gnorm/f),(double)grtol);CHKERRQ(ierr); 1817a7e14dcfSSatish Balay reason = TAO_CONVERGED_GRTOL; 1818a7e14dcfSSatish Balay } else if (gnorm0 != 0 && gnorm/gnorm0 <= gttol && cnorm <= crtol) { 1819*47a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to relative residual norm ||g(X)||/||g(X0)|| = %g < %g\n",(double)(gnorm/gnorm0),(double)gttol);CHKERRQ(ierr); 1820a7e14dcfSSatish Balay reason = TAO_CONVERGED_GTTOL; 1821a7e14dcfSSatish Balay } else if (nfuncs > max_funcs){ 1822a7e14dcfSSatish Balay ierr = PetscInfo2(tao,"Exceeded maximum number of function evaluations: %D > %D\n", nfuncs,max_funcs);CHKERRQ(ierr); 1823a7e14dcfSSatish Balay reason = TAO_DIVERGED_MAXFCN; 1824a7e14dcfSSatish Balay } else if ( tao->lsflag != 0 ){ 1825a7e14dcfSSatish Balay ierr = PetscInfo(tao,"Tao Line Search failure.\n");CHKERRQ(ierr); 1826a7e14dcfSSatish Balay reason = TAO_DIVERGED_LS_FAILURE; 1827a7e14dcfSSatish Balay } else if (trradius < steptol && niter > 0){ 1828*47a47007SBarry Smith ierr = PetscInfo2(tao,"Trust region/step size too small: %g < %g\n", (double)trradius,(double)steptol);CHKERRQ(ierr); 1829a7e14dcfSSatish Balay reason = TAO_CONVERGED_STEPTOL; 1830a7e14dcfSSatish Balay } else if (niter > tao->max_it) { 1831a7e14dcfSSatish Balay ierr = PetscInfo2(tao,"Exceeded maximum number of iterations: %D > %D\n",niter,tao->max_it);CHKERRQ(ierr); 1832a7e14dcfSSatish Balay reason = TAO_DIVERGED_MAXITS; 1833a7e14dcfSSatish Balay } else { 1834a7e14dcfSSatish Balay reason = TAO_CONTINUE_ITERATING; 1835a7e14dcfSSatish Balay } 1836a7e14dcfSSatish Balay tao->reason = reason; 1837a7e14dcfSSatish Balay PetscFunctionReturn(0); 1838a7e14dcfSSatish Balay } 1839a7e14dcfSSatish Balay 1840a7e14dcfSSatish Balay #undef __FUNCT__ 1841a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetOptionsPrefix" 1842a7e14dcfSSatish Balay /*@C 1843a7e14dcfSSatish Balay TaoSetOptionsPrefix - Sets the prefix used for searching for all 1844a7e14dcfSSatish Balay TAO options in the database. 1845a7e14dcfSSatish Balay 1846a7e14dcfSSatish Balay 1847a7e14dcfSSatish Balay Logically Collective on TaoSolver 1848a7e14dcfSSatish Balay 1849a7e14dcfSSatish Balay Input Parameters: 1850a7e14dcfSSatish Balay + tao - the TaoSolver context 1851a7e14dcfSSatish Balay - prefix - the prefix string to prepend to all TAO option requests 1852a7e14dcfSSatish Balay 1853a7e14dcfSSatish Balay Notes: 1854a7e14dcfSSatish Balay A hyphen (-) must NOT be given at the beginning of the prefix name. 1855a7e14dcfSSatish Balay The first character of all runtime options is AUTOMATICALLY the hyphen. 1856a7e14dcfSSatish Balay 1857a7e14dcfSSatish Balay For example, to distinguish between the runtime options for two 1858a7e14dcfSSatish Balay different TAO solvers, one could call 1859a7e14dcfSSatish Balay .vb 1860a7e14dcfSSatish Balay TaoSetOptionsPrefix(tao1,"sys1_") 1861a7e14dcfSSatish Balay TaoSetOptionsPrefix(tao2,"sys2_") 1862a7e14dcfSSatish Balay .ve 1863a7e14dcfSSatish Balay 1864a7e14dcfSSatish Balay This would enable use of different options for each system, such as 1865a7e14dcfSSatish Balay .vb 1866a7e14dcfSSatish Balay -sys1_tao_method blmvm -sys1_tao_gtol 1.e-3 1867a7e14dcfSSatish Balay -sys2_tao_method lmvm -sys2_tao_gtol 1.e-4 1868a7e14dcfSSatish Balay .ve 1869a7e14dcfSSatish Balay 1870a7e14dcfSSatish Balay 1871a7e14dcfSSatish Balay Level: advanced 1872a7e14dcfSSatish Balay 1873a7e14dcfSSatish Balay .seealso: TaoAppendOptionsPrefix(), TaoGetOptionsPrefix() 1874a7e14dcfSSatish Balay @*/ 1875a7e14dcfSSatish Balay 1876a7e14dcfSSatish Balay PetscErrorCode TaoSetOptionsPrefix(TaoSolver tao, const char p[]) 1877a7e14dcfSSatish Balay { 1878a7e14dcfSSatish Balay PetscErrorCode ierr; 1879*47a47007SBarry Smith 1880a7e14dcfSSatish Balay PetscFunctionBegin; 1881a7e14dcfSSatish Balay ierr = PetscObjectSetOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr); 1882a7e14dcfSSatish Balay if (tao->linesearch) { 1883a7e14dcfSSatish Balay ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr); 1884a7e14dcfSSatish Balay } 1885a7e14dcfSSatish Balay if (tao->ksp) { 1886a7e14dcfSSatish Balay ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr); 1887a7e14dcfSSatish Balay } 1888a7e14dcfSSatish Balay PetscFunctionReturn(0); 1889a7e14dcfSSatish Balay } 1890a7e14dcfSSatish Balay 1891a7e14dcfSSatish Balay #undef __FUNCT__ 1892a7e14dcfSSatish Balay #define __FUNCT__ "TaoAppendOptionsPrefix" 1893a7e14dcfSSatish Balay /*@C 1894a7e14dcfSSatish Balay TaoAppendOptionsPrefix - Appends to the prefix used for searching for all 1895a7e14dcfSSatish Balay TAO options in the database. 1896a7e14dcfSSatish Balay 1897a7e14dcfSSatish Balay 1898a7e14dcfSSatish Balay Logically Collective on TaoSolver 1899a7e14dcfSSatish Balay 1900a7e14dcfSSatish Balay Input Parameters: 1901a7e14dcfSSatish Balay + tao - the TaoSolver solver context 1902a7e14dcfSSatish Balay - prefix - the prefix string to prepend to all TAO option requests 1903a7e14dcfSSatish Balay 1904a7e14dcfSSatish Balay Notes: 1905a7e14dcfSSatish Balay A hyphen (-) must NOT be given at the beginning of the prefix name. 1906a7e14dcfSSatish Balay The first character of all runtime options is AUTOMATICALLY the hyphen. 1907a7e14dcfSSatish Balay 1908a7e14dcfSSatish Balay 1909a7e14dcfSSatish Balay Level: advanced 1910a7e14dcfSSatish Balay 1911a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoGetOptionsPrefix() 1912a7e14dcfSSatish Balay @*/ 1913a7e14dcfSSatish Balay PetscErrorCode TaoAppendOptionsPrefix(TaoSolver tao, const char p[]) 1914a7e14dcfSSatish Balay { 1915a7e14dcfSSatish Balay PetscErrorCode ierr; 1916*47a47007SBarry Smith 1917a7e14dcfSSatish Balay PetscFunctionBegin; 1918a7e14dcfSSatish Balay ierr = PetscObjectAppendOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr); 1919a7e14dcfSSatish Balay if (tao->linesearch) { 1920a7e14dcfSSatish Balay ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr); 1921a7e14dcfSSatish Balay } 1922a7e14dcfSSatish Balay if (tao->ksp) { 1923a7e14dcfSSatish Balay ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr); 1924a7e14dcfSSatish Balay } 1925a7e14dcfSSatish Balay PetscFunctionReturn(0); 1926a7e14dcfSSatish Balay } 1927a7e14dcfSSatish Balay 1928a7e14dcfSSatish Balay #undef __FUNCT__ 1929a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetOptionsPrefix" 1930a7e14dcfSSatish Balay /*@C 1931a7e14dcfSSatish Balay TaoGetOptionsPrefix - Gets the prefix used for searching for all 1932a7e14dcfSSatish Balay TAO options in the database 1933a7e14dcfSSatish Balay 1934a7e14dcfSSatish Balay Not Collective 1935a7e14dcfSSatish Balay 1936a7e14dcfSSatish Balay Input Parameters: 1937a7e14dcfSSatish Balay . tao - the TaoSolver context 1938a7e14dcfSSatish Balay 1939a7e14dcfSSatish Balay Output Parameters: 1940a7e14dcfSSatish Balay . prefix - pointer to the prefix string used is returned 1941a7e14dcfSSatish Balay 1942a7e14dcfSSatish Balay Notes: On the fortran side, the user should pass in a string 'prefix' of 1943a7e14dcfSSatish Balay sufficient length to hold the prefix. 1944a7e14dcfSSatish Balay 1945a7e14dcfSSatish Balay Level: advanced 1946a7e14dcfSSatish Balay 1947a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoAppendOptionsPrefix() 1948a7e14dcfSSatish Balay @*/ 1949a7e14dcfSSatish Balay PetscErrorCode TaoGetOptionsPrefix(TaoSolver tao, const char *p[]) 1950a7e14dcfSSatish Balay { 1951*47a47007SBarry Smith return PetscObjectGetOptionsPrefix((PetscObject)tao,p); 1952a7e14dcfSSatish Balay } 1953a7e14dcfSSatish Balay 1954a7e14dcfSSatish Balay #undef __FUNCT__ 1955a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetDefaultKSPType" 1956a7e14dcfSSatish Balay /*@ 1957a7e14dcfSSatish Balay TaoSetDefaultKSPType - Sets the default KSP type if a KSP object 1958a7e14dcfSSatish Balay is created. 1959a7e14dcfSSatish Balay 1960a7e14dcfSSatish Balay Logically Collective on TaoSolver 1961a7e14dcfSSatish Balay 1962a7e14dcfSSatish Balay InputParameters: 1963a7e14dcfSSatish Balay + tao - the TaoSolver context 1964a7e14dcfSSatish Balay - ktype - the KSP type TAO will use by default 1965a7e14dcfSSatish Balay 1966a7e14dcfSSatish Balay Note: Some solvers may require a particular KSP type and will not work 1967a7e14dcfSSatish Balay correctly if the default value is changed 1968a7e14dcfSSatish Balay 1969a7e14dcfSSatish Balay Options Database Key: 1970a7e14dcfSSatish Balay - tao_ksp_type 1971a7e14dcfSSatish Balay 1972a7e14dcfSSatish Balay Level: advanced 1973a7e14dcfSSatish Balay @*/ 1974a7e14dcfSSatish Balay PetscErrorCode TaoSetDefaultKSPType(TaoSolver tao, KSPType ktype) 1975a7e14dcfSSatish Balay { 1976a7e14dcfSSatish Balay const char *prefix=0; 1977a7e14dcfSSatish Balay char *option=0; 1978a7e14dcfSSatish Balay size_t n1,n2; 1979a7e14dcfSSatish Balay PetscErrorCode ierr; 1980a7e14dcfSSatish Balay 1981*47a47007SBarry Smith PetscFunctionBegin; 1982a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 1983a7e14dcfSSatish Balay ierr = TaoGetOptionsPrefix(tao,&prefix);CHKERRQ(ierr); 1984a7e14dcfSSatish Balay ierr = PetscStrlen(prefix,&n1); 1985a7e14dcfSSatish Balay ierr = PetscStrlen("_ksp_type",&n2); 1986a7e14dcfSSatish Balay ierr = PetscMalloc(n1+n2+1,&option); 1987a7e14dcfSSatish Balay ierr = PetscStrncpy(option,prefix,n1+1); 1988a7e14dcfSSatish Balay ierr = PetscStrncat(option,"_ksp_type",n2+1); 1989a7e14dcfSSatish Balay ierr = PetscOptionsSetValue(option,ktype);CHKERRQ(ierr); 1990a7e14dcfSSatish Balay PetscFunctionReturn(0); 1991a7e14dcfSSatish Balay } 1992a7e14dcfSSatish Balay 1993a7e14dcfSSatish Balay #undef __FUNCT__ 1994a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetDefaulLineSearchType" 1995a7e14dcfSSatish Balay /*@ 1996a7e14dcfSSatish Balay TaoSetDefaultLineSearchType - Sets the default LineSearch type if a LineSearch object 1997a7e14dcfSSatish Balay is created. 1998a7e14dcfSSatish Balay 1999a7e14dcfSSatish Balay Logically Collective on TaoSolver 2000a7e14dcfSSatish Balay 2001a7e14dcfSSatish Balay InputParameters: 2002a7e14dcfSSatish Balay + tao - the TaoSolver context 2003a7e14dcfSSatish Balay - lstype - the line search type TAO will use by default 2004a7e14dcfSSatish Balay 2005a7e14dcfSSatish Balay Note: Some solvers may require a particular line search type and will not work 2006a7e14dcfSSatish Balay correctly if the default value is changed 2007a7e14dcfSSatish Balay 2008a7e14dcfSSatish Balay Options Database Key: 2009a7e14dcfSSatish Balay - tao_ls_type 2010a7e14dcfSSatish Balay 2011a7e14dcfSSatish Balay Level: advanced 2012a7e14dcfSSatish Balay @*/ 2013a7e14dcfSSatish Balay PetscErrorCode TaoSetDefaultLineSearchType(TaoSolver tao, TaoLineSearchType lstype) 2014a7e14dcfSSatish Balay { 2015a7e14dcfSSatish Balay const char *prefix=0; 2016a7e14dcfSSatish Balay char *option=0; 2017a7e14dcfSSatish Balay size_t n1,n2; 2018a7e14dcfSSatish Balay PetscErrorCode ierr; 2019a7e14dcfSSatish Balay 2020*47a47007SBarry Smith PetscFunctionBegin; 2021a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 2022a7e14dcfSSatish Balay ierr = TaoGetOptionsPrefix(tao,&prefix);CHKERRQ(ierr); 2023a7e14dcfSSatish Balay ierr = PetscStrlen(prefix,&n1); 2024a7e14dcfSSatish Balay ierr = PetscStrlen("_ls_type",&n2); 2025a7e14dcfSSatish Balay ierr = PetscMalloc(n1+n2+1,&option); 2026a7e14dcfSSatish Balay ierr = PetscStrncpy(option,prefix,n1+1); 2027a7e14dcfSSatish Balay ierr = PetscStrncat(option,"_ls_type",n2+1); 2028a7e14dcfSSatish Balay ierr = PetscOptionsSetValue(option,lstype);CHKERRQ(ierr); 2029a7e14dcfSSatish Balay PetscFunctionReturn(0); 2030a7e14dcfSSatish Balay } 2031a7e14dcfSSatish Balay 2032a7e14dcfSSatish Balay #undef __FUNCT__ 2033a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetDefaultPCType" 2034a7e14dcfSSatish Balay /*@ 2035a7e14dcfSSatish Balay TaoSetDefaultPCType - Sets the default PC type if a PC object 2036a7e14dcfSSatish Balay is created. 2037a7e14dcfSSatish Balay 2038a7e14dcfSSatish Balay Logically Collective on TaoSolver 2039a7e14dcfSSatish Balay 2040a7e14dcfSSatish Balay InputParameters: 2041a7e14dcfSSatish Balay + tao - the TaoSolver context 2042a7e14dcfSSatish Balay - pctype - the preconditioner type TAO will use by default 2043a7e14dcfSSatish Balay 2044a7e14dcfSSatish Balay Note: Some solvers may require a particular PC type and will not work 2045a7e14dcfSSatish Balay correctly if the default value is changed 2046a7e14dcfSSatish Balay 2047a7e14dcfSSatish Balay Options Database Key: 2048a7e14dcfSSatish Balay - tao_pc_type 2049a7e14dcfSSatish Balay 2050a7e14dcfSSatish Balay Level: advanced 2051a7e14dcfSSatish Balay @*/ 2052a7e14dcfSSatish Balay PetscErrorCode TaoSetDefaultPCType(TaoSolver tao, PCType pctype) 2053a7e14dcfSSatish Balay { 2054a7e14dcfSSatish Balay const char *prefix=0; 2055a7e14dcfSSatish Balay char *option=0; 2056a7e14dcfSSatish Balay size_t n1,n2; 2057a7e14dcfSSatish Balay PetscErrorCode ierr; 2058a7e14dcfSSatish Balay 2059*47a47007SBarry Smith PetscFunctionBegin; 2060a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 2061a7e14dcfSSatish Balay ierr = TaoGetOptionsPrefix(tao,&prefix);CHKERRQ(ierr); 2062a7e14dcfSSatish Balay ierr = PetscStrlen(prefix,&n1); 2063a7e14dcfSSatish Balay ierr = PetscStrlen("_pc_type",&n2); 2064a7e14dcfSSatish Balay ierr = PetscMalloc(n1+n2+1,&option); 2065a7e14dcfSSatish Balay ierr = PetscStrncpy(option,prefix,n1+1); 2066a7e14dcfSSatish Balay ierr = PetscStrncat(option,"_pc_type",n2+1); 2067a7e14dcfSSatish Balay ierr = PetscOptionsSetValue(option,pctype);CHKERRQ(ierr); 2068a7e14dcfSSatish Balay PetscFunctionReturn(0); 2069a7e14dcfSSatish Balay } 2070a7e14dcfSSatish Balay 2071a7e14dcfSSatish Balay #undef __FUNCT__ 2072a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetType" 2073a7e14dcfSSatish Balay /*@C 2074a7e14dcfSSatish Balay TaoSetType - Sets the method for the unconstrained minimization solver. 2075a7e14dcfSSatish Balay 2076a7e14dcfSSatish Balay Collective on TaoSolver 2077a7e14dcfSSatish Balay 2078a7e14dcfSSatish Balay Input Parameters: 2079a7e14dcfSSatish Balay + solver - the TaoSolver solver context 2080a7e14dcfSSatish Balay - type - a known method 2081a7e14dcfSSatish Balay 2082a7e14dcfSSatish Balay Options Database Key: 2083a7e14dcfSSatish Balay + -tao_method <type> - Sets the method; use -help for a list 2084a7e14dcfSSatish Balay of available methods (for instance, "-tao_method tao_lmvm" or 2085a7e14dcfSSatish Balay "-tao_method tao_tron") 2086a7e14dcfSSatish Balay - -tao_type <type> - identical to -tao_method 2087a7e14dcfSSatish Balay 2088a7e14dcfSSatish Balay Available methods include: 2089a7e14dcfSSatish Balay + tao_nls - Newton's method with line search for unconstrained minimization 2090a7e14dcfSSatish Balay . tao_ntr - Newton's method with trust region for unconstrained minimization 2091a7e14dcfSSatish Balay . tao_ntl - Newton's method with trust region, line search for unconstrained minimization 2092a7e14dcfSSatish Balay . tao_lmvm - Limited memory variable metric method for unconstrained minimization 2093a7e14dcfSSatish Balay . tao_cg - Nonlinear conjugate gradient method for unconstrained minimization 2094a7e14dcfSSatish Balay . tao_nm - Nelder-Mead algorithm for derivate-free unconstrained minimization 2095a7e14dcfSSatish Balay . tao_tron - Newton Trust Region method for bound constrained minimization 2096a7e14dcfSSatish Balay . tao_gpcg - Newton Trust Region method for quadratic bound constrained minimization 2097a7e14dcfSSatish Balay . tao_blmvm - Limited memory variable metric method for bound constrained minimization 2098a7e14dcfSSatish Balay + tao_pounders - Model-based algorithm pounder extended for nonlinear least squares 2099a7e14dcfSSatish Balay 2100a7e14dcfSSatish Balay Level: intermediate 2101a7e14dcfSSatish Balay 2102a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoGetType() 2103a7e14dcfSSatish Balay 2104a7e14dcfSSatish Balay @*/ 2105a7e14dcfSSatish Balay PetscErrorCode TaoSetType(TaoSolver tao, const TaoSolverType type) 2106a7e14dcfSSatish Balay { 2107a7e14dcfSSatish Balay PetscErrorCode ierr; 2108a7e14dcfSSatish Balay PetscErrorCode (*create_xxx)(TaoSolver); 2109a7e14dcfSSatish Balay PetscBool issame; 2110a7e14dcfSSatish Balay 2111a7e14dcfSSatish Balay PetscFunctionBegin; 2112a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 2113a7e14dcfSSatish Balay 2114a7e14dcfSSatish Balay ierr = PetscObjectTypeCompare((PetscObject)tao,type,&issame);CHKERRQ(ierr); 2115a7e14dcfSSatish Balay if (issame) PetscFunctionReturn(0); 2116a7e14dcfSSatish Balay 2117a7e14dcfSSatish Balay ierr = PetscFunctionListFind(TaoSolverList, type, (void(**)(void))&create_xxx);CHKERRQ(ierr); 2118*47a47007SBarry Smith if (!create_xxx) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested TaoSolver type %s",type); 2119a7e14dcfSSatish Balay 2120a7e14dcfSSatish Balay /* Destroy the existing solver information */ 2121a7e14dcfSSatish Balay if (tao->ops->destroy) { 2122a7e14dcfSSatish Balay ierr = (*tao->ops->destroy)(tao);CHKERRQ(ierr); 2123a7e14dcfSSatish Balay } 2124a7e14dcfSSatish Balay ierr = KSPDestroy(&tao->ksp);CHKERRQ(ierr); 2125a7e14dcfSSatish Balay ierr = TaoLineSearchDestroy(&tao->linesearch);CHKERRQ(ierr); 2126a7e14dcfSSatish Balay ierr = VecDestroy(&tao->gradient);CHKERRQ(ierr); 2127a7e14dcfSSatish Balay ierr = VecDestroy(&tao->stepdirection);CHKERRQ(ierr); 2128a7e14dcfSSatish Balay 2129a7e14dcfSSatish Balay tao->ops->setup = 0; 2130a7e14dcfSSatish Balay tao->ops->solve = 0; 2131a7e14dcfSSatish Balay tao->ops->view = 0; 2132a7e14dcfSSatish Balay tao->ops->setfromoptions = 0; 2133a7e14dcfSSatish Balay tao->ops->destroy = 0; 2134a7e14dcfSSatish Balay 2135a7e14dcfSSatish Balay tao->setupcalled = PETSC_FALSE; 2136a7e14dcfSSatish Balay 2137a7e14dcfSSatish Balay ierr = (*create_xxx)(tao);CHKERRQ(ierr); 2138a7e14dcfSSatish Balay ierr = PetscObjectChangeTypeName((PetscObject)tao,type);CHKERRQ(ierr); 2139a7e14dcfSSatish Balay PetscFunctionReturn(0); 2140a7e14dcfSSatish Balay } 2141*47a47007SBarry Smith 2142a7e14dcfSSatish Balay #undef __FUNCT__ 2143a7e14dcfSSatish Balay #define __FUNCT__ "TaoSolverRegister" 2144a7e14dcfSSatish Balay /*MC 2145a7e14dcfSSatish Balay TaoSolverRegister - Adds a method to the TAO package for unconstrained minimization. 2146a7e14dcfSSatish Balay 2147a7e14dcfSSatish Balay Synopsis: 2148a7e14dcfSSatish Balay TaoSolverRegister(char *name_solver,char *path,char *name_Create,int (*routine_Create)(TaoSolver)) 2149a7e14dcfSSatish Balay 2150a7e14dcfSSatish Balay Not collective 2151a7e14dcfSSatish Balay 2152a7e14dcfSSatish Balay Input Parameters: 2153a7e14dcfSSatish Balay + sname - name of a new user-defined solver 2154a7e14dcfSSatish Balay - func - routine to Create method context 2155a7e14dcfSSatish Balay 2156a7e14dcfSSatish Balay Notes: 2157a7e14dcfSSatish Balay TaoSolverRegister() may be called multiple times to add several user-defined solvers. 2158a7e14dcfSSatish Balay 2159a7e14dcfSSatish Balay Sample usage: 2160a7e14dcfSSatish Balay .vb 2161a7e14dcfSSatish Balay TaoSolverRegister("my_solver",MySolverCreate); 2162a7e14dcfSSatish Balay .ve 2163a7e14dcfSSatish Balay 2164a7e14dcfSSatish Balay Then, your solver can be chosen with the procedural interface via 2165a7e14dcfSSatish Balay $ TaoSetType(tao,"my_solver") 2166a7e14dcfSSatish Balay or at runtime via the option 2167a7e14dcfSSatish Balay $ -tao_method my_solver 2168a7e14dcfSSatish Balay 2169a7e14dcfSSatish Balay Level: advanced 2170a7e14dcfSSatish Balay 2171a7e14dcfSSatish Balay .seealso: TaoSolverRegisterAll(), TaoSolverRegisterDestroy() 2172a7e14dcfSSatish Balay M*/ 2173a7e14dcfSSatish Balay PetscErrorCode TaoSolverRegister(const char sname[], PetscErrorCode (*func)(TaoSolver)) 2174a7e14dcfSSatish Balay { 2175a7e14dcfSSatish Balay PetscErrorCode ierr; 2176a7e14dcfSSatish Balay 2177a7e14dcfSSatish Balay PetscFunctionBegin; 2178a7e14dcfSSatish Balay ierr = PetscFunctionListAdd(&TaoSolverList,sname, (void (*)(void))func);CHKERRQ(ierr); 2179a7e14dcfSSatish Balay PetscFunctionReturn(0); 2180a7e14dcfSSatish Balay } 2181a7e14dcfSSatish Balay 2182a7e14dcfSSatish Balay #undef __FUNCT__ 2183a7e14dcfSSatish Balay #define __FUNCT__ "TaoSolverRegisterDestroy" 2184a7e14dcfSSatish Balay /*@C 2185a7e14dcfSSatish Balay TaoSolverRegisterDestroy - Frees the list of minimization solvers that were 2186a7e14dcfSSatish Balay registered by TaoSolverRegisterDynamic(). 2187a7e14dcfSSatish Balay 2188a7e14dcfSSatish Balay Not Collective 2189a7e14dcfSSatish Balay 2190a7e14dcfSSatish Balay Level: advanced 2191a7e14dcfSSatish Balay 2192a7e14dcfSSatish Balay .seealso: TaoSolverRegisterAll(), TaoSolverRegister() 2193a7e14dcfSSatish Balay @*/ 2194a7e14dcfSSatish Balay PetscErrorCode TaoSolverRegisterDestroy(void) 2195a7e14dcfSSatish Balay { 2196a7e14dcfSSatish Balay PetscErrorCode ierr; 2197a7e14dcfSSatish Balay PetscFunctionBegin; 2198a7e14dcfSSatish Balay ierr = PetscFunctionListDestroy(&TaoSolverList);CHKERRQ(ierr); 2199a7e14dcfSSatish Balay TaoSolverRegisterAllCalled = PETSC_FALSE; 2200a7e14dcfSSatish Balay PetscFunctionReturn(0); 2201a7e14dcfSSatish Balay } 2202*47a47007SBarry Smith 2203a7e14dcfSSatish Balay #undef __FUNCT__ 2204a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetTerminationReason" 2205a7e14dcfSSatish Balay /*@ 2206a7e14dcfSSatish Balay TaoSetTerminationReason - Sets the termination flag on a TaoSolver object 2207a7e14dcfSSatish Balay 2208a7e14dcfSSatish Balay Logically Collective on TaoSolver 2209a7e14dcfSSatish Balay 2210a7e14dcfSSatish Balay Input Parameters: 2211a7e14dcfSSatish Balay + tao - the TaoSolver context 2212a7e14dcfSSatish Balay - reason - one of 2213a7e14dcfSSatish Balay $ TAO_CONVERGED_ATOL (2), 2214a7e14dcfSSatish Balay $ TAO_CONVERGED_RTOL (3), 2215a7e14dcfSSatish Balay $ TAO_CONVERGED_STEPTOL (4), 2216a7e14dcfSSatish Balay $ TAO_CONVERGED_MINF (5), 2217a7e14dcfSSatish Balay $ TAO_CONVERGED_USER (6), 2218a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXITS (-2), 2219a7e14dcfSSatish Balay $ TAO_DIVERGED_NAN (-4), 2220a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXFCN (-5), 2221a7e14dcfSSatish Balay $ TAO_DIVERGED_LS_FAILURE (-6), 2222a7e14dcfSSatish Balay $ TAO_DIVERGED_TR_REDUCTION (-7), 2223a7e14dcfSSatish Balay $ TAO_DIVERGED_USER (-8), 2224a7e14dcfSSatish Balay $ TAO_CONTINUE_ITERATING (0) 2225a7e14dcfSSatish Balay 2226a7e14dcfSSatish Balay Level: intermediate 2227a7e14dcfSSatish Balay 2228a7e14dcfSSatish Balay @*/ 2229a7e14dcfSSatish Balay PetscErrorCode TaoSetTerminationReason(TaoSolver tao, TaoSolverTerminationReason reason) 2230a7e14dcfSSatish Balay { 2231a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 2232a7e14dcfSSatish Balay PetscFunctionBegin; 2233a7e14dcfSSatish Balay tao->reason = reason; 2234a7e14dcfSSatish Balay PetscFunctionReturn(0); 2235a7e14dcfSSatish Balay } 2236a7e14dcfSSatish Balay 2237a7e14dcfSSatish Balay #undef __FUNCT__ 2238a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetTerminationReason" 2239a7e14dcfSSatish Balay /*@ 2240a7e14dcfSSatish Balay TaoGetTerminationReason - Gets the reason the TaoSolver iteration was stopped. 2241a7e14dcfSSatish Balay 2242a7e14dcfSSatish Balay Not Collective 2243a7e14dcfSSatish Balay 2244a7e14dcfSSatish Balay Input Parameter: 2245a7e14dcfSSatish Balay . tao - the TaoSolver solver context 2246a7e14dcfSSatish Balay 2247a7e14dcfSSatish Balay Output Parameter: 2248a7e14dcfSSatish Balay . reason - one of 2249a7e14dcfSSatish Balay 2250a7e14dcfSSatish Balay 2251a7e14dcfSSatish Balay $ TAO_CONVERGED_FATOL (1) f(X)-f(X*) <= fatol 2252a7e14dcfSSatish Balay $ TAO_CONVERGED_FRTOL (2) |f(X) - f(X*)|/|f(X)| < frtol 2253a7e14dcfSSatish Balay $ TAO_CONVERGED_GATOL (3) ||g(X)|| < gatol 2254a7e14dcfSSatish Balay $ TAO_CONVERGED_GRTOL (4) ||g(X)|| / f(X) < grtol 2255a7e14dcfSSatish Balay $ TAO_CONVERGED_GTTOL (5) ||g(X)|| / ||g(X0)|| < gttol 2256a7e14dcfSSatish Balay $ TAO_CONVERGED_STEPTOL (6) step size small 2257a7e14dcfSSatish Balay $ TAO_CONVERGED_MINF (7) F < F_min 2258a7e14dcfSSatish Balay $ TAO_CONVERGED_USER (8) User defined 2259a7e14dcfSSatish Balay 2260a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXITS (-2) its > maxits 2261a7e14dcfSSatish Balay $ TAO_DIVERGED_NAN (-4) Numerical problems 2262a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXFCN (-5) fevals > max_funcsals 2263a7e14dcfSSatish Balay $ TAO_DIVERGED_LS_FAILURE (-6) line search failure 2264a7e14dcfSSatish Balay $ TAO_DIVERGED_TR_REDUCTION (-7) trust region failure 2265a7e14dcfSSatish Balay $ TAO_DIVERGED_USER(-8) (user defined) 2266a7e14dcfSSatish Balay 2267a7e14dcfSSatish Balay $ TAO_CONTINUE_ITERATING (0) 2268a7e14dcfSSatish Balay 2269a7e14dcfSSatish Balay where 2270a7e14dcfSSatish Balay + X - current solution 2271a7e14dcfSSatish Balay . X0 - initial guess 2272a7e14dcfSSatish Balay . f(X) - current function value 2273a7e14dcfSSatish Balay . f(X*) - true solution (estimated) 2274a7e14dcfSSatish Balay . g(X) - current gradient 2275a7e14dcfSSatish Balay . its - current iterate number 2276a7e14dcfSSatish Balay . maxits - maximum number of iterates 2277a7e14dcfSSatish Balay . fevals - number of function evaluations 2278a7e14dcfSSatish Balay - max_funcsals - maximum number of function evaluations 2279a7e14dcfSSatish Balay 2280a7e14dcfSSatish Balay Level: intermediate 2281a7e14dcfSSatish Balay 2282a7e14dcfSSatish Balay .seealso: TaoSetConvergenceTest(), TaoSetTolerances() 2283a7e14dcfSSatish Balay 2284a7e14dcfSSatish Balay @*/ 2285a7e14dcfSSatish Balay PetscErrorCode TaoGetTerminationReason(TaoSolver tao, TaoSolverTerminationReason *reason) 2286a7e14dcfSSatish Balay { 2287a7e14dcfSSatish Balay PetscFunctionBegin; 2288a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 2289a7e14dcfSSatish Balay PetscValidPointer(reason,2); 2290a7e14dcfSSatish Balay *reason = tao->reason; 2291a7e14dcfSSatish Balay PetscFunctionReturn(0); 2292a7e14dcfSSatish Balay } 2293a7e14dcfSSatish Balay 2294a7e14dcfSSatish Balay #undef __FUNCT__ 2295a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetSolutionStatus" 2296a7e14dcfSSatish Balay /*@ 2297a7e14dcfSSatish Balay TaoGetSolutionStatus - Get the current iterate, objective value, 2298a7e14dcfSSatish Balay residual, infeasibility, and termination 2299a7e14dcfSSatish Balay 2300a7e14dcfSSatish Balay Not Collective 2301a7e14dcfSSatish Balay 2302a7e14dcfSSatish Balay Input Parameters: 2303a7e14dcfSSatish Balay . tao - the TaoSolver context 2304a7e14dcfSSatish Balay 2305a7e14dcfSSatish Balay Output Parameters: 2306a7e14dcfSSatish Balay + iterate - the current iterate number (>=0) 2307a7e14dcfSSatish Balay . f - the current function value 2308a7e14dcfSSatish Balay . gnorm - the square of the gradient norm, duality gap, or other measure 2309a7e14dcfSSatish Balay indicating distance from optimality. 2310a7e14dcfSSatish Balay . cnorm - the infeasibility of the current solution with regard to the constraints. 2311a7e14dcfSSatish Balay . xdiff - the step length or trust region radius of the most recent iterate. 2312a7e14dcfSSatish Balay - reason - The termination reason, which can equal TAO_CONTINUE_ITERATING 2313a7e14dcfSSatish Balay 2314a7e14dcfSSatish Balay Level: intermediate 2315a7e14dcfSSatish Balay 2316a7e14dcfSSatish Balay Note: 2317a7e14dcfSSatish Balay TAO returns the values set by the solvers in the routine TaoMonitor(). 2318a7e14dcfSSatish Balay 2319a7e14dcfSSatish Balay Note: 2320*47a47007SBarry Smith If any of the output arguments are set to NULL, no corresponding value will be returned. 2321a7e14dcfSSatish Balay 2322a7e14dcfSSatish Balay 2323a7e14dcfSSatish Balay .seealso: TaoMonitor(), TaoGetTerminationReason() 2324a7e14dcfSSatish Balay @*/ 2325a7e14dcfSSatish Balay PetscErrorCode TaoGetSolutionStatus(TaoSolver tao, PetscInt *its, PetscReal *f, PetscReal *gnorm, PetscReal *cnorm, PetscReal *xdiff, TaoSolverTerminationReason *reason) 2326a7e14dcfSSatish Balay { 2327a7e14dcfSSatish Balay PetscFunctionBegin; 2328a7e14dcfSSatish Balay if (its) *its=tao->niter; 2329a7e14dcfSSatish Balay if (f) *f=tao->fc; 2330a7e14dcfSSatish Balay if (gnorm) *gnorm=tao->residual; 2331a7e14dcfSSatish Balay if (cnorm) *cnorm=tao->cnorm; 2332a7e14dcfSSatish Balay if (reason) *reason=tao->reason; 2333a7e14dcfSSatish Balay if (xdiff) *xdiff=tao->step; 2334a7e14dcfSSatish Balay PetscFunctionReturn(0); 2335a7e14dcfSSatish Balay } 2336a7e14dcfSSatish Balay 2337a7e14dcfSSatish Balay 2338a7e14dcfSSatish Balay #undef __FUNCT__ 2339a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetType" 2340a7e14dcfSSatish Balay /*@C 2341a7e14dcfSSatish Balay TaoGetType - Gets the current TaoSolver algorithm. 2342a7e14dcfSSatish Balay 2343a7e14dcfSSatish Balay Not Collective 2344a7e14dcfSSatish Balay 2345a7e14dcfSSatish Balay Input Parameter: 2346a7e14dcfSSatish Balay . tao - the TaoSolver solver context 2347a7e14dcfSSatish Balay 2348a7e14dcfSSatish Balay Output Parameter: 2349a7e14dcfSSatish Balay . type - TaoSolver method 2350a7e14dcfSSatish Balay 2351a7e14dcfSSatish Balay Level: intermediate 2352a7e14dcfSSatish Balay 2353a7e14dcfSSatish Balay @*/ 2354a7e14dcfSSatish Balay PetscErrorCode TaoGetType(TaoSolver tao, const TaoSolverType *type) 2355a7e14dcfSSatish Balay { 2356a7e14dcfSSatish Balay PetscFunctionBegin; 2357a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 2358a7e14dcfSSatish Balay PetscValidPointer(type,2); 2359a7e14dcfSSatish Balay *type=((PetscObject)tao)->type_name; 2360a7e14dcfSSatish Balay PetscFunctionReturn(0); 2361a7e14dcfSSatish Balay } 2362a7e14dcfSSatish Balay 2363a7e14dcfSSatish Balay #undef __FUNCT__ 2364a7e14dcfSSatish Balay #define __FUNCT__ "TaoMonitor" 2365a7e14dcfSSatish Balay /*@C 2366a7e14dcfSSatish Balay TaoMonitor - Monitor the solver and the current solution. This 2367a7e14dcfSSatish Balay routine will record the iteration number and residual statistics, 2368a7e14dcfSSatish Balay call any monitors specified by the user, and calls the convergence-check routine. 2369a7e14dcfSSatish Balay 2370a7e14dcfSSatish Balay Input Parameters: 2371a7e14dcfSSatish Balay + tao - the TaoSolver context 2372a7e14dcfSSatish Balay . its - the current iterate number (>=0) 2373a7e14dcfSSatish Balay . f - the current objective function value 2374a7e14dcfSSatish Balay . res - the gradient norm, square root of the duality gap, or other measure 2375a7e14dcfSSatish Balay indicating distince from optimality. This measure will be recorded and 2376a7e14dcfSSatish Balay used for some termination tests. 2377a7e14dcfSSatish Balay . cnorm - the infeasibility of the current solution with regard to the constraints. 2378a7e14dcfSSatish Balay - steplength - multiple of the step direction added to the previous iterate. 2379a7e14dcfSSatish Balay 2380a7e14dcfSSatish Balay Output Parameters: 2381a7e14dcfSSatish Balay . reason - The termination reason, which can equal TAO_CONTINUE_ITERATING 2382a7e14dcfSSatish Balay 2383a7e14dcfSSatish Balay Options Database Key: 2384a7e14dcfSSatish Balay . -tao_monitor - Use the default monitor, which prints statistics to standard output 2385a7e14dcfSSatish Balay 2386a7e14dcfSSatish Balay .seealso TaoGetTerminationReason(), TaoDefaultMonitor(), TaoSetMonitor() 2387a7e14dcfSSatish Balay 2388a7e14dcfSSatish Balay Level: developer 2389a7e14dcfSSatish Balay 2390a7e14dcfSSatish Balay @*/ 2391a7e14dcfSSatish Balay PetscErrorCode TaoMonitor(TaoSolver tao, PetscInt its, PetscReal f, PetscReal res, PetscReal cnorm, PetscReal steplength, TaoSolverTerminationReason *reason) 2392a7e14dcfSSatish Balay { 2393a7e14dcfSSatish Balay PetscErrorCode ierr; 2394*47a47007SBarry Smith PetscInt i; 2395*47a47007SBarry Smith 2396a7e14dcfSSatish Balay PetscFunctionBegin; 2397a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 2398a7e14dcfSSatish Balay tao->fc = f; 2399a7e14dcfSSatish Balay tao->residual = res; 2400a7e14dcfSSatish Balay tao->cnorm = cnorm; 2401a7e14dcfSSatish Balay tao->step = steplength; 2402a7e14dcfSSatish Balay tao->niter=its; 2403a7e14dcfSSatish Balay if (its == 0) { 2404a7e14dcfSSatish Balay tao->cnorm0 = cnorm; tao->gnorm0 = res; 2405a7e14dcfSSatish Balay } 2406a7e14dcfSSatish Balay TaoLogHistory(tao,f,res,cnorm); 2407*47a47007SBarry Smith if (PetscIsInfOrNanReal(f) || PetscIsInfOrNanReal(res)) SETERRQ(PETSC_COMM_SELF,1, "User provided compute function generated Inf or NaN"); 2408a7e14dcfSSatish Balay if (tao->ops->convergencetest) { 2409a7e14dcfSSatish Balay ierr = (*tao->ops->convergencetest)(tao,tao->cnvP);CHKERRQ(ierr); 2410a7e14dcfSSatish Balay } 2411a7e14dcfSSatish Balay for (i=0;i<tao->numbermonitors;i++) { 2412a7e14dcfSSatish Balay ierr = (*tao->monitor[i])(tao,tao->monitorcontext[i]);CHKERRQ(ierr); 2413a7e14dcfSSatish Balay } 2414a7e14dcfSSatish Balay *reason = tao->reason; 2415a7e14dcfSSatish Balay PetscFunctionReturn(0); 2416a7e14dcfSSatish Balay } 2417a7e14dcfSSatish Balay 2418a7e14dcfSSatish Balay #undef __FUNCT__ 2419a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetHistory" 2420a7e14dcfSSatish Balay /*@ 2421a7e14dcfSSatish Balay TaoSetHistory - Sets the array used to hold the convergence history. 2422a7e14dcfSSatish Balay 2423a7e14dcfSSatish Balay Logically Collective on TaoSolver 2424a7e14dcfSSatish Balay 2425a7e14dcfSSatish Balay Input Parameters: 2426a7e14dcfSSatish Balay + tao - the TaoSolver solver context 2427a7e14dcfSSatish Balay . obj - array to hold objective value history 2428a7e14dcfSSatish Balay . resid - array to hold residual history 2429a7e14dcfSSatish Balay . cnorm - array to hold constraint violation history 2430a7e14dcfSSatish Balay . na - size of obj, resid, and cnorm 2431a7e14dcfSSatish Balay - reset - PetscTrue indicates each new minimization resets the history counter to zero, 2432a7e14dcfSSatish Balay else it continues storing new values for new minimizations after the old ones 2433a7e14dcfSSatish Balay 2434a7e14dcfSSatish Balay Notes: 2435a7e14dcfSSatish Balay If set, TAO will fill the given arrays with the indicated 2436a7e14dcfSSatish Balay information at each iteration. If no information is desired 2437*47a47007SBarry Smith for a given array, then NULL may be used. 2438a7e14dcfSSatish Balay 2439a7e14dcfSSatish Balay This routine is useful, e.g., when running a code for purposes 2440a7e14dcfSSatish Balay of accurate performance monitoring, when no I/O should be done 2441a7e14dcfSSatish Balay during the section of code that is being timed. 2442a7e14dcfSSatish Balay 2443a7e14dcfSSatish Balay Level: intermediate 2444a7e14dcfSSatish Balay 2445a7e14dcfSSatish Balay .seealso: TaoGetHistory() 2446a7e14dcfSSatish Balay 2447a7e14dcfSSatish Balay @*/ 2448a7e14dcfSSatish Balay PetscErrorCode TaoSetHistory(TaoSolver tao, PetscReal *obj, PetscReal *resid, PetscReal *cnorm, PetscInt na,PetscBool reset) 2449a7e14dcfSSatish Balay { 2450a7e14dcfSSatish Balay PetscFunctionBegin; 2451a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 2452a7e14dcfSSatish Balay tao->hist_obj = obj; 2453a7e14dcfSSatish Balay tao->hist_resid = resid; 2454a7e14dcfSSatish Balay tao->hist_cnorm = cnorm; 2455a7e14dcfSSatish Balay tao->hist_max = na; 2456a7e14dcfSSatish Balay tao->hist_reset = reset; 2457a7e14dcfSSatish Balay PetscFunctionReturn(0); 2458a7e14dcfSSatish Balay } 2459a7e14dcfSSatish Balay 2460a7e14dcfSSatish Balay #undef __FUNCT__ 2461a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetHistory" 2462a7e14dcfSSatish Balay /*@C 2463a7e14dcfSSatish Balay TaoGetHistory - Gets the array used to hold the convergence history. 2464a7e14dcfSSatish Balay 2465a7e14dcfSSatish Balay Collective on TaoSolver 2466a7e14dcfSSatish Balay 2467a7e14dcfSSatish Balay Input Parameter: 2468a7e14dcfSSatish Balay . tao - the TaoSolver context 2469a7e14dcfSSatish Balay 2470a7e14dcfSSatish Balay Output Parameters: 2471a7e14dcfSSatish Balay + obj - array used to hold objective value history 2472a7e14dcfSSatish Balay . resid - array used to hold residual history 2473a7e14dcfSSatish Balay . cnorm - array used to hold constraint violation history 2474a7e14dcfSSatish Balay - nhist - size of obj, resid, and cnorm (will be less than or equal to na given in TaoSetHistory) 2475a7e14dcfSSatish Balay 2476a7e14dcfSSatish Balay 2477a7e14dcfSSatish Balay Notes: 2478a7e14dcfSSatish Balay The calling sequence for this routine in Fortran is 2479a7e14dcfSSatish Balay $ call TaoGetHistory(TaoSolver tao, integer nhist, integer info) 2480a7e14dcfSSatish Balay 2481a7e14dcfSSatish Balay This routine is useful, e.g., when running a code for purposes 2482a7e14dcfSSatish Balay of accurate performance monitoring, when no I/O should be done 2483a7e14dcfSSatish Balay during the section of code that is being timed. 2484a7e14dcfSSatish Balay 2485a7e14dcfSSatish Balay Level: advanced 2486a7e14dcfSSatish Balay 2487a7e14dcfSSatish Balay .seealso: TaoSetHistory() 2488a7e14dcfSSatish Balay 2489a7e14dcfSSatish Balay @*/ 2490a7e14dcfSSatish Balay PetscErrorCode TaoGetHistory(TaoSolver tao, PetscReal **obj, PetscReal **resid, PetscReal **cnorm, PetscInt *nhist) 2491a7e14dcfSSatish Balay { 2492a7e14dcfSSatish Balay PetscFunctionBegin; 2493a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 2494a7e14dcfSSatish Balay if (obj) *obj = tao->hist_obj; 2495a7e14dcfSSatish Balay if (cnorm) *cnorm = tao->hist_cnorm; 2496a7e14dcfSSatish Balay if (resid) *resid = tao->hist_resid; 2497a7e14dcfSSatish Balay if (nhist) *nhist = tao->hist_len; 2498a7e14dcfSSatish Balay PetscFunctionReturn(0); 2499a7e14dcfSSatish Balay } 2500a7e14dcfSSatish Balay 2501a7e14dcfSSatish Balay #undef __FUNCT__ 2502a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetApplicationContext" 2503a7e14dcfSSatish Balay /*@ 2504a7e14dcfSSatish Balay TaoSetApplicationContext - Sets the optional user-defined context for 2505a7e14dcfSSatish Balay a solver. 2506a7e14dcfSSatish Balay 2507a7e14dcfSSatish Balay Logically Collective on TaoSolver 2508a7e14dcfSSatish Balay 2509a7e14dcfSSatish Balay Input Parameters: 2510a7e14dcfSSatish Balay + tao - the TaoSolver context 2511a7e14dcfSSatish Balay - usrP - optional user context 2512a7e14dcfSSatish Balay 2513a7e14dcfSSatish Balay Level: intermediate 2514a7e14dcfSSatish Balay 2515a7e14dcfSSatish Balay .seealso: TaoGetApplicationContext(), TaoSetApplicationContext() 2516a7e14dcfSSatish Balay @*/ 2517a7e14dcfSSatish Balay PetscErrorCode TaoSetApplicationContext(TaoSolver tao,void *usrP) 2518a7e14dcfSSatish Balay { 2519a7e14dcfSSatish Balay PetscFunctionBegin; 2520a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 2521a7e14dcfSSatish Balay tao->user = usrP; 2522a7e14dcfSSatish Balay PetscFunctionReturn(0); 2523a7e14dcfSSatish Balay } 2524a7e14dcfSSatish Balay 2525a7e14dcfSSatish Balay #undef __FUNCT__ 2526a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetApplicationContext" 2527a7e14dcfSSatish Balay /*@ 2528a7e14dcfSSatish Balay TaoGetApplicationContext - Gets the user-defined context for a 2529a7e14dcfSSatish Balay TAO solvers. 2530a7e14dcfSSatish Balay 2531a7e14dcfSSatish Balay Not Collective 2532a7e14dcfSSatish Balay 2533a7e14dcfSSatish Balay Input Parameter: 2534a7e14dcfSSatish Balay . tao - TaoSolver context 2535a7e14dcfSSatish Balay 2536a7e14dcfSSatish Balay Output Parameter: 2537a7e14dcfSSatish Balay . usrP - user context 2538a7e14dcfSSatish Balay 2539a7e14dcfSSatish Balay Level: intermediate 2540a7e14dcfSSatish Balay 2541a7e14dcfSSatish Balay .seealso: TaoSetApplicationContext() 2542a7e14dcfSSatish Balay @*/ 2543a7e14dcfSSatish Balay PetscErrorCode TaoGetApplicationContext(TaoSolver tao,void *usrP) 2544a7e14dcfSSatish Balay { 2545a7e14dcfSSatish Balay PetscFunctionBegin; 2546a7e14dcfSSatish Balay PetscValidHeaderSpecific(tao,TAOSOLVER_CLASSID,1); 2547a7e14dcfSSatish Balay *(void**)usrP = tao->user; 2548a7e14dcfSSatish Balay PetscFunctionReturn(0); 2549a7e14dcfSSatish Balay } 2550