1441846f8SBarry Smith #define TAO_DLL 2a7e14dcfSSatish Balay 3af0996ceSBarry Smith #include <petsc/private/taoimpl.h> /*I "petsctao.h" I*/ 4a7e14dcfSSatish Balay 5441846f8SBarry Smith PetscBool TaoRegisterAllCalled = PETSC_FALSE; 6441846f8SBarry Smith PetscFunctionList TaoList = NULL; 7a7e14dcfSSatish Balay 8441846f8SBarry Smith PetscClassId TAO_CLASSID; 9441846f8SBarry Smith PetscLogEvent Tao_Solve, Tao_ObjectiveEval, Tao_GradientEval, Tao_ObjGradientEval, Tao_HessianEval, Tao_ConstraintsEval, Tao_JacobianEval; 10a7e14dcfSSatish Balay 115b0d99aeSBarry Smith const char *TaoSubSetTypes[] = { "subvec","mask","matrixfree","TaoSubSetType","TAO_SUBSET_",0}; 12a7e14dcfSSatish Balay 13*e882e171SHong Zhang struct _n_TaoMonitorDrawCtx { 14*e882e171SHong Zhang PetscViewer viewer; 15*e882e171SHong Zhang PetscInt howoften; /* when > 0 uses iteration % howoften, when negative only final solution plotted */ 16*e882e171SHong Zhang }; 17*e882e171SHong Zhang 18a7e14dcfSSatish Balay /*@ 19a7e14dcfSSatish Balay TaoCreate - Creates a TAO solver 20a7e14dcfSSatish Balay 21a7e14dcfSSatish Balay Collective on MPI_Comm 22a7e14dcfSSatish Balay 23a7e14dcfSSatish Balay Input Parameter: 24a7e14dcfSSatish Balay . comm - MPI communicator 25a7e14dcfSSatish Balay 26a7e14dcfSSatish Balay Output Parameter: 27441846f8SBarry Smith . newtao - the new Tao context 28a7e14dcfSSatish Balay 29a7e14dcfSSatish Balay Available methods include: 3058417fe7SBarry Smith + nls - Newton's method with line search for unconstrained minimization 3158417fe7SBarry Smith . ntr - Newton's method with trust region for unconstrained minimization 3258417fe7SBarry Smith . ntl - Newton's method with trust region, line search for unconstrained minimization 3358417fe7SBarry Smith . lmvm - Limited memory variable metric method for unconstrained minimization 3458417fe7SBarry Smith . cg - Nonlinear conjugate gradient method for unconstrained minimization 3558417fe7SBarry Smith . nm - Nelder-Mead algorithm for derivate-free unconstrained minimization 3658417fe7SBarry Smith . tron - Newton Trust Region method for bound constrained minimization 3758417fe7SBarry Smith . gpcg - Newton Trust Region method for quadratic bound constrained minimization 3858417fe7SBarry Smith . blmvm - Limited memory variable metric method for bound constrained minimization 3958417fe7SBarry Smith . lcl - Linearly constrained Lagrangian method for pde-constrained minimization 4058417fe7SBarry Smith - pounders - Model-based algorithm for nonlinear least squares 41a7e14dcfSSatish Balay 42a7e14dcfSSatish Balay Options Database Keys: 4358417fe7SBarry Smith . -tao_type - select which method TAO should use 44a7e14dcfSSatish Balay 45a7e14dcfSSatish Balay Level: beginner 46a7e14dcfSSatish Balay 47a7e14dcfSSatish Balay .seealso: TaoSolve(), TaoDestroy() 48a7e14dcfSSatish Balay @*/ 49441846f8SBarry Smith PetscErrorCode TaoCreate(MPI_Comm comm, Tao *newtao) 50a7e14dcfSSatish Balay { 51a7e14dcfSSatish Balay PetscErrorCode ierr; 52441846f8SBarry Smith Tao tao; 53a7e14dcfSSatish Balay 54a7e14dcfSSatish Balay PetscFunctionBegin; 55a7e14dcfSSatish Balay PetscValidPointer(newtao,2); 5647a47007SBarry Smith *newtao = NULL; 57a7e14dcfSSatish Balay 58a7e14dcfSSatish Balay ierr = TaoInitializePackage();CHKERRQ(ierr); 59a7e14dcfSSatish Balay ierr = TaoLineSearchInitializePackage();CHKERRQ(ierr); 60a7e14dcfSSatish Balay 6173107ff1SLisandro Dalcin ierr = PetscHeaderCreate(tao,TAO_CLASSID,"Tao","Optimization solver","Tao",comm,TaoDestroy,TaoView);CHKERRQ(ierr); 62a7e14dcfSSatish Balay tao->ops->computeobjective=0; 63a7e14dcfSSatish Balay tao->ops->computeobjectiveandgradient=0; 64a7e14dcfSSatish Balay tao->ops->computegradient=0; 65a7e14dcfSSatish Balay tao->ops->computehessian=0; 66a7e14dcfSSatish Balay tao->ops->computeseparableobjective=0; 67a7e14dcfSSatish Balay tao->ops->computeconstraints=0; 68a7e14dcfSSatish Balay tao->ops->computejacobian=0; 69a7e14dcfSSatish Balay tao->ops->computejacobianequality=0; 70a7e14dcfSSatish Balay tao->ops->computejacobianinequality=0; 71a7e14dcfSSatish Balay tao->ops->computeequalityconstraints=0; 72a7e14dcfSSatish Balay tao->ops->computeinequalityconstraints=0; 73a7e14dcfSSatish Balay tao->ops->convergencetest=TaoDefaultConvergenceTest; 74a7e14dcfSSatish Balay tao->ops->convergencedestroy=0; 75a7e14dcfSSatish Balay tao->ops->computedual=0; 76a7e14dcfSSatish Balay tao->ops->setup=0; 77a7e14dcfSSatish Balay tao->ops->solve=0; 78a7e14dcfSSatish Balay tao->ops->view=0; 79a7e14dcfSSatish Balay tao->ops->setfromoptions=0; 80a7e14dcfSSatish Balay tao->ops->destroy=0; 81a7e14dcfSSatish Balay 8247a47007SBarry Smith tao->solution=NULL; 8347a47007SBarry Smith tao->gradient=NULL; 8447a47007SBarry Smith tao->sep_objective = NULL; 8547a47007SBarry Smith tao->constraints=NULL; 8647a47007SBarry Smith tao->constraints_equality=NULL; 8747a47007SBarry Smith tao->constraints_inequality=NULL; 88125ddc8aSJason Sarich tao->sep_weights_v=NULL; 89125ddc8aSJason Sarich tao->sep_weights_w=NULL; 9047a47007SBarry Smith tao->stepdirection=NULL; 918931d482SJason Sarich tao->niter=0; 928931d482SJason Sarich tao->ntotalits=0; 9347a47007SBarry Smith tao->XL = NULL; 9447a47007SBarry Smith tao->XU = NULL; 9547a47007SBarry Smith tao->IL = NULL; 9647a47007SBarry Smith tao->IU = NULL; 9747a47007SBarry Smith tao->DI = NULL; 9847a47007SBarry Smith tao->DE = NULL; 99a9603a14SPatrick Farrell tao->gradient_norm = NULL; 100a9603a14SPatrick Farrell tao->gradient_norm_tmp = NULL; 10147a47007SBarry Smith tao->hessian = NULL; 10247a47007SBarry Smith tao->hessian_pre = NULL; 10347a47007SBarry Smith tao->jacobian = NULL; 10447a47007SBarry Smith tao->jacobian_pre = NULL; 10547a47007SBarry Smith tao->jacobian_state = NULL; 10647a47007SBarry Smith tao->jacobian_state_pre = NULL; 10747a47007SBarry Smith tao->jacobian_state_inv = NULL; 10847a47007SBarry Smith tao->jacobian_design = NULL; 10947a47007SBarry Smith tao->jacobian_design_pre = NULL; 11047a47007SBarry Smith tao->jacobian_equality = NULL; 11147a47007SBarry Smith tao->jacobian_equality_pre = NULL; 11247a47007SBarry Smith tao->jacobian_inequality = NULL; 11347a47007SBarry Smith tao->jacobian_inequality_pre = NULL; 11447a47007SBarry Smith tao->state_is = NULL; 11547a47007SBarry Smith tao->design_is = NULL; 116a7e14dcfSSatish Balay 117a7e14dcfSSatish Balay tao->max_it = 10000; 118a7e14dcfSSatish Balay tao->max_funcs = 10000; 1196f4723b1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 1206f4723b1SBarry Smith tao->gatol = 1e-5; 1216f4723b1SBarry Smith tao->grtol = 1e-5; 1226f4723b1SBarry Smith #else 123a7e14dcfSSatish Balay tao->gatol = 1e-8; 124a7e14dcfSSatish Balay tao->grtol = 1e-8; 1256f4723b1SBarry Smith #endif 126a7e14dcfSSatish Balay tao->crtol = 0.0; 1276552cf8aSJason Sarich tao->catol = 0.0; 1286552cf8aSJason Sarich tao->gttol = 0.0; 1294f1535bcSTodd Munson tao->steptol = 0.0; 130e270355aSBarry Smith tao->trust0 = PETSC_INFINITY; 1316f4723b1SBarry Smith tao->fmin = PETSC_NINFINITY; 132ae93cb3cSJason Sarich tao->hist_malloc = PETSC_FALSE; 133a7e14dcfSSatish Balay tao->hist_reset = PETSC_TRUE; 134a7e14dcfSSatish Balay tao->hist_max = 0; 135a7e14dcfSSatish Balay tao->hist_len = 0; 13647a47007SBarry Smith tao->hist_obj = NULL; 13747a47007SBarry Smith tao->hist_resid = NULL; 13847a47007SBarry Smith tao->hist_cnorm = NULL; 139ae93cb3cSJason Sarich tao->hist_lits = NULL; 140a7e14dcfSSatish Balay 141a7e14dcfSSatish Balay tao->numbermonitors=0; 142a7e14dcfSSatish Balay tao->viewsolution=PETSC_FALSE; 143a7e14dcfSSatish Balay tao->viewhessian=PETSC_FALSE; 144a7e14dcfSSatish Balay tao->viewgradient=PETSC_FALSE; 145a7e14dcfSSatish Balay tao->viewjacobian=PETSC_FALSE; 146a7e14dcfSSatish Balay tao->viewconstraints = PETSC_FALSE; 147a7e14dcfSSatish Balay 1486552cf8aSJason Sarich /* These flags prevents algorithms from overriding user options */ 1496552cf8aSJason Sarich tao->max_it_changed =PETSC_FALSE; 1506552cf8aSJason Sarich tao->max_funcs_changed=PETSC_FALSE; 1516552cf8aSJason Sarich tao->gatol_changed =PETSC_FALSE; 1526552cf8aSJason Sarich tao->grtol_changed =PETSC_FALSE; 1536552cf8aSJason Sarich tao->gttol_changed =PETSC_FALSE; 1546552cf8aSJason Sarich tao->steptol_changed =PETSC_FALSE; 1556552cf8aSJason Sarich tao->trust0_changed =PETSC_FALSE; 1566552cf8aSJason Sarich tao->fmin_changed =PETSC_FALSE; 1576552cf8aSJason Sarich tao->catol_changed =PETSC_FALSE; 1586552cf8aSJason Sarich tao->crtol_changed =PETSC_FALSE; 159a7e14dcfSSatish Balay ierr = TaoResetStatistics(tao);CHKERRQ(ierr); 160a7e14dcfSSatish Balay *newtao = tao; 161a7e14dcfSSatish Balay PetscFunctionReturn(0); 162a7e14dcfSSatish Balay } 163a7e14dcfSSatish Balay 164a7e14dcfSSatish Balay /*@ 165a7e14dcfSSatish Balay TaoSolve - Solves an optimization problem min F(x) s.t. l <= x <= u 166a7e14dcfSSatish Balay 167441846f8SBarry Smith Collective on Tao 168a7e14dcfSSatish Balay 169a7e14dcfSSatish Balay Input Parameters: 170441846f8SBarry Smith . tao - the Tao context 171a7e14dcfSSatish Balay 172a7e14dcfSSatish Balay Notes: 173441846f8SBarry Smith The user must set up the Tao with calls to TaoSetInitialVector(), 174a7e14dcfSSatish Balay TaoSetObjectiveRoutine(), 175a7e14dcfSSatish Balay TaoSetGradientRoutine(), and (if using 2nd order method) TaoSetHessianRoutine(). 176a7e14dcfSSatish Balay 177a35d58b8SBarry Smith You should call TaoGetConvergedReason() or run with -tao_converged_reason to determine if the optimization algorithm actually succeeded or 178a35d58b8SBarry Smith why it failed. 179a35d58b8SBarry Smith 180a7e14dcfSSatish Balay Level: beginner 181a7e14dcfSSatish Balay 182a35d58b8SBarry Smith .seealso: TaoCreate(), TaoSetObjectiveRoutine(), TaoSetGradientRoutine(), TaoSetHessianRoutine(), TaoGetConvergedReason() 183a7e14dcfSSatish Balay @*/ 184441846f8SBarry Smith PetscErrorCode TaoSolve(Tao tao) 185a7e14dcfSSatish Balay { 186a7e14dcfSSatish Balay PetscErrorCode ierr; 187e2379f4fSBarry Smith static PetscBool set = PETSC_FALSE; 18847a47007SBarry Smith 189a7e14dcfSSatish Balay PetscFunctionBegin; 190441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 191e2379f4fSBarry Smith ierr = PetscCitationsRegister("@TechReport{tao-user-ref,\n" 192e2379f4fSBarry Smith "title = {Toolkit for Advanced Optimization (TAO) Users Manual},\n" 193e2379f4fSBarry Smith "author = {Todd Munson and Jason Sarich and Stefan Wild and Steve Benson and Lois Curfman McInnes},\n" 194e2379f4fSBarry Smith "Institution = {Argonne National Laboratory},\n" 195e2379f4fSBarry Smith "Year = 2014,\n" 196e2379f4fSBarry Smith "Number = {ANL/MCS-TM-322 - Revision 3.5},\n" 197302440fdSBarry Smith "url = {http://www.mcs.anl.gov/tao}\n}\n",&set);CHKERRQ(ierr); 198e2379f4fSBarry Smith 199a7e14dcfSSatish Balay ierr = TaoSetUp(tao);CHKERRQ(ierr); 200a7e14dcfSSatish Balay ierr = TaoResetStatistics(tao);CHKERRQ(ierr); 201a7e14dcfSSatish Balay if (tao->linesearch) { 202a7e14dcfSSatish Balay ierr = TaoLineSearchReset(tao->linesearch);CHKERRQ(ierr); 203a7e14dcfSSatish Balay } 204a7e14dcfSSatish Balay 205441846f8SBarry Smith ierr = PetscLogEventBegin(Tao_Solve,tao,0,0,0);CHKERRQ(ierr); 206a7e14dcfSSatish Balay if (tao->ops->solve){ ierr = (*tao->ops->solve)(tao);CHKERRQ(ierr); } 207441846f8SBarry Smith ierr = PetscLogEventEnd(Tao_Solve,tao,0,0,0);CHKERRQ(ierr); 208a7e14dcfSSatish Balay 2098931d482SJason Sarich tao->ntotalits += tao->niter; 210fbe0838dSJason Sarich ierr = TaoViewFromOptions(tao,NULL,"-tao_view");CHKERRQ(ierr); 211a7e14dcfSSatish Balay 212a7e14dcfSSatish Balay if (tao->printreason) { 213a7e14dcfSSatish Balay if (tao->reason > 0) { 2148931d482SJason Sarich ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve converged due to %s iterations %D\n",TaoConvergedReasons[tao->reason],tao->niter);CHKERRQ(ierr); 215a7e14dcfSSatish Balay } else { 2168931d482SJason Sarich ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve did not converge due to %s iteration %D\n",TaoConvergedReasons[tao->reason],tao->niter);CHKERRQ(ierr); 217a7e14dcfSSatish Balay } 218a7e14dcfSSatish Balay } 219a7e14dcfSSatish Balay PetscFunctionReturn(0); 220a7e14dcfSSatish Balay } 221a7e14dcfSSatish Balay 222a7e14dcfSSatish Balay /*@ 223a7e14dcfSSatish Balay TaoSetUp - Sets up the internal data structures for the later use 224a7e14dcfSSatish Balay of a Tao solver 225a7e14dcfSSatish Balay 226a7e14dcfSSatish Balay Collective on tao 227a7e14dcfSSatish Balay 228a7e14dcfSSatish Balay Input Parameters: 229a7e14dcfSSatish Balay . tao - the TAO context 230a7e14dcfSSatish Balay 231a7e14dcfSSatish Balay Notes: 232a7e14dcfSSatish Balay The user will not need to explicitly call TaoSetUp(), as it will 233a7e14dcfSSatish Balay automatically be called in TaoSolve(). However, if the user 234a7e14dcfSSatish Balay desires to call it explicitly, it should come after TaoCreate() 235a7e14dcfSSatish Balay and any TaoSetSomething() routines, but before TaoSolve(). 236a7e14dcfSSatish Balay 237a7e14dcfSSatish Balay Level: advanced 238a7e14dcfSSatish Balay 239a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve() 240a7e14dcfSSatish Balay @*/ 241441846f8SBarry Smith PetscErrorCode TaoSetUp(Tao tao) 242a7e14dcfSSatish Balay { 243a7e14dcfSSatish Balay PetscErrorCode ierr; 24447a47007SBarry Smith 245a7e14dcfSSatish Balay PetscFunctionBegin; 246441846f8SBarry Smith PetscValidHeaderSpecific(tao, TAO_CLASSID,1); 247a7e14dcfSSatish Balay if (tao->setupcalled) PetscFunctionReturn(0); 248a7e14dcfSSatish Balay 24947a47007SBarry Smith if (!tao->solution) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TaoSetInitialVector"); 250a7e14dcfSSatish Balay if (tao->ops->setup) { 251a7e14dcfSSatish Balay ierr = (*tao->ops->setup)(tao);CHKERRQ(ierr); 252a7e14dcfSSatish Balay } 253a7e14dcfSSatish Balay tao->setupcalled = PETSC_TRUE; 254a7e14dcfSSatish Balay PetscFunctionReturn(0); 255a7e14dcfSSatish Balay } 256a7e14dcfSSatish Balay 257a7e14dcfSSatish Balay /*@ 258a7e14dcfSSatish Balay TaoDestroy - Destroys the TAO context that was created with 259a7e14dcfSSatish Balay TaoCreate() 260a7e14dcfSSatish Balay 261441846f8SBarry Smith Collective on Tao 262a7e14dcfSSatish Balay 263a7e14dcfSSatish Balay Input Parameter: 264441846f8SBarry Smith . tao - the Tao context 265a7e14dcfSSatish Balay 266a7e14dcfSSatish Balay Level: beginner 267a7e14dcfSSatish Balay 268a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve() 269a7e14dcfSSatish Balay @*/ 270441846f8SBarry Smith PetscErrorCode TaoDestroy(Tao *tao) 271a7e14dcfSSatish Balay { 272a7e14dcfSSatish Balay PetscErrorCode ierr; 27347a47007SBarry Smith 274a7e14dcfSSatish Balay PetscFunctionBegin; 275a7e14dcfSSatish Balay if (!*tao) PetscFunctionReturn(0); 276441846f8SBarry Smith PetscValidHeaderSpecific(*tao,TAO_CLASSID,1); 277a7e14dcfSSatish Balay if (--((PetscObject)*tao)->refct > 0) {*tao=0;PetscFunctionReturn(0);} 278a7e14dcfSSatish Balay 279a7e14dcfSSatish Balay if ((*tao)->ops->destroy) { 280a7e14dcfSSatish Balay ierr = (*((*tao))->ops->destroy)(*tao);CHKERRQ(ierr); 281a7e14dcfSSatish Balay } 282a7e14dcfSSatish Balay ierr = KSPDestroy(&(*tao)->ksp);CHKERRQ(ierr); 283a7e14dcfSSatish Balay ierr = TaoLineSearchDestroy(&(*tao)->linesearch);CHKERRQ(ierr); 284a7e14dcfSSatish Balay 285a7e14dcfSSatish Balay if ((*tao)->ops->convergencedestroy) { 286a7e14dcfSSatish Balay ierr = (*(*tao)->ops->convergencedestroy)((*tao)->cnvP);CHKERRQ(ierr); 287a7e14dcfSSatish Balay if ((*tao)->jacobian_state_inv) { 288a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr); 289a7e14dcfSSatish Balay } 290a7e14dcfSSatish Balay } 291a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->solution);CHKERRQ(ierr); 292a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->gradient);CHKERRQ(ierr); 293a7e14dcfSSatish Balay 294a9603a14SPatrick Farrell if ((*tao)->gradient_norm) { 295a9603a14SPatrick Farrell ierr = PetscObjectDereference((PetscObject)(*tao)->gradient_norm);CHKERRQ(ierr); 296a9603a14SPatrick Farrell ierr = VecDestroy(&(*tao)->gradient_norm_tmp);CHKERRQ(ierr); 297a9603a14SPatrick Farrell } 298a9603a14SPatrick Farrell 299a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->XL);CHKERRQ(ierr); 300a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->XU);CHKERRQ(ierr); 301a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->IL);CHKERRQ(ierr); 302a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->IU);CHKERRQ(ierr); 303a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->DE);CHKERRQ(ierr); 304a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->DI);CHKERRQ(ierr); 305a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->constraints_equality);CHKERRQ(ierr); 306a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->constraints_inequality);CHKERRQ(ierr); 307a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->stepdirection);CHKERRQ(ierr); 308a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->hessian_pre);CHKERRQ(ierr); 309a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->hessian);CHKERRQ(ierr); 310a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_pre);CHKERRQ(ierr); 311a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian);CHKERRQ(ierr); 312a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state_pre);CHKERRQ(ierr); 313a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state);CHKERRQ(ierr); 314a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr); 315067f330cSJason Sarich ierr = MatDestroy(&(*tao)->jacobian_design);CHKERRQ(ierr); 316a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_equality);CHKERRQ(ierr); 317a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_equality_pre);CHKERRQ(ierr); 318a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_inequality);CHKERRQ(ierr); 319a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_inequality_pre);CHKERRQ(ierr); 320a7e14dcfSSatish Balay ierr = ISDestroy(&(*tao)->state_is);CHKERRQ(ierr); 321a7e14dcfSSatish Balay ierr = ISDestroy(&(*tao)->design_is);CHKERRQ(ierr); 322125ddc8aSJason Sarich ierr = VecDestroy(&(*tao)->sep_weights_v);CHKERRQ(ierr); 323a7e14dcfSSatish Balay ierr = TaoCancelMonitors(*tao);CHKERRQ(ierr); 324ae93cb3cSJason Sarich if ((*tao)->hist_malloc) { 325ae93cb3cSJason Sarich ierr = PetscFree((*tao)->hist_obj);CHKERRQ(ierr); 326ae93cb3cSJason Sarich ierr = PetscFree((*tao)->hist_resid);CHKERRQ(ierr); 327ae93cb3cSJason Sarich ierr = PetscFree((*tao)->hist_cnorm);CHKERRQ(ierr); 328ae93cb3cSJason Sarich ierr = PetscFree((*tao)->hist_lits);CHKERRQ(ierr); 329ae93cb3cSJason Sarich } 330125ddc8aSJason Sarich if ((*tao)->sep_weights_n) { 331125ddc8aSJason Sarich ierr = PetscFree((*tao)->sep_weights_rows);CHKERRQ(ierr); 332125ddc8aSJason Sarich ierr = PetscFree((*tao)->sep_weights_cols);CHKERRQ(ierr); 333125ddc8aSJason Sarich ierr = PetscFree((*tao)->sep_weights_w);CHKERRQ(ierr); 334125ddc8aSJason Sarich } 335a7e14dcfSSatish Balay ierr = PetscHeaderDestroy(tao);CHKERRQ(ierr); 336a7e14dcfSSatish Balay PetscFunctionReturn(0); 337a7e14dcfSSatish Balay } 338a7e14dcfSSatish Balay 339a7e14dcfSSatish Balay /*@ 340441846f8SBarry Smith TaoSetFromOptions - Sets various Tao parameters from user 341a7e14dcfSSatish Balay options. 342a7e14dcfSSatish Balay 343441846f8SBarry Smith Collective on Tao 344a7e14dcfSSatish Balay 345a7e14dcfSSatish Balay Input Paremeter: 346441846f8SBarry Smith . tao - the Tao solver context 347a7e14dcfSSatish Balay 348a7e14dcfSSatish Balay options Database Keys: 34958417fe7SBarry Smith + -tao_type <type> - The algorithm that TAO uses (lmvm, nls, etc.) 350a7e14dcfSSatish Balay . -tao_gatol <gatol> - absolute error tolerance for ||gradient|| 351a7e14dcfSSatish Balay . -tao_grtol <grtol> - relative error tolerance for ||gradient|| 352a7e14dcfSSatish Balay . -tao_gttol <gttol> - reduction of ||gradient|| relative to initial gradient 353a7e14dcfSSatish Balay . -tao_max_it <max> - sets maximum number of iterations 354a7e14dcfSSatish Balay . -tao_max_funcs <max> - sets maximum number of function evaluations 355a7e14dcfSSatish Balay . -tao_fmin <fmin> - stop if function value reaches fmin 356a7e14dcfSSatish Balay . -tao_steptol <tol> - stop if trust region radius less than <tol> 357a7e14dcfSSatish Balay . -tao_trust0 <t> - initial trust region radius 358a7e14dcfSSatish Balay . -tao_monitor - prints function value and residual at each iteration 359a7e14dcfSSatish Balay . -tao_smonitor - same as tao_monitor, but truncates very small values 360a7e14dcfSSatish Balay . -tao_cmonitor - prints function value, residual, and constraint norm at each iteration 361a7e14dcfSSatish Balay . -tao_view_solution - prints solution vector at each iteration 362a7e14dcfSSatish Balay . -tao_view_separableobjective - prints separable objective vector at each iteration 363a7e14dcfSSatish Balay . -tao_view_step - prints step direction vector at each iteration 364a7e14dcfSSatish Balay . -tao_view_gradient - prints gradient vector at each iteration 365a7e14dcfSSatish Balay . -tao_draw_solution - graphically view solution vector at each iteration 366a7e14dcfSSatish Balay . -tao_draw_step - graphically view step vector at each iteration 367a7e14dcfSSatish Balay . -tao_draw_gradient - graphically view gradient at each iteration 368a7e14dcfSSatish Balay . -tao_fd_gradient - use gradient computed with finite differences 369a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors (except those set with command line) 370441846f8SBarry Smith . -tao_view - prints information about the Tao after solving 371a7e14dcfSSatish Balay - -tao_converged_reason - prints the reason TAO stopped iterating 372a7e14dcfSSatish Balay 373a7e14dcfSSatish Balay Notes: 374a7e14dcfSSatish Balay To see all options, run your program with the -help option or consult the 375a7e14dcfSSatish Balay user's manual. Should be called after TaoCreate() but before TaoSolve() 376a7e14dcfSSatish Balay 377a7e14dcfSSatish Balay Level: beginner 378a7e14dcfSSatish Balay @*/ 379441846f8SBarry Smith PetscErrorCode TaoSetFromOptions(Tao tao) 380a7e14dcfSSatish Balay { 381a7e14dcfSSatish Balay PetscErrorCode ierr; 38258417fe7SBarry Smith const TaoType default_type = TAOLMVM; 383a7e14dcfSSatish Balay char type[256], monfilename[PETSC_MAX_PATH_LEN]; 384a7e14dcfSSatish Balay PetscViewer monviewer; 385a7e14dcfSSatish Balay PetscBool flg; 386a7e14dcfSSatish Balay MPI_Comm comm; 387a7e14dcfSSatish Balay 388a7e14dcfSSatish Balay PetscFunctionBegin; 389441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 390a7e14dcfSSatish Balay ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr); 391125ddc8aSJason Sarich 392a7e14dcfSSatish Balay /* So no warnings are given about unused options */ 393c5929fdfSBarry Smith ierr = PetscOptionsHasName(((PetscObject)tao)->options,((PetscObject)tao)->prefix,"-tao_ls_type",&flg);CHKERRQ(ierr); 394a7e14dcfSSatish Balay 395a7e14dcfSSatish Balay ierr = PetscObjectOptionsBegin((PetscObject)tao);CHKERRQ(ierr); 396a7e14dcfSSatish Balay { 397441846f8SBarry Smith ierr = TaoRegisterAll();CHKERRQ(ierr); 398a7e14dcfSSatish Balay if (((PetscObject)tao)->type_name) { 399a7e14dcfSSatish Balay default_type = ((PetscObject)tao)->type_name; 400a7e14dcfSSatish Balay } 401a7e14dcfSSatish Balay /* Check for type from options */ 402441846f8SBarry Smith ierr = PetscOptionsFList("-tao_type","Tao Solver type","TaoSetType",TaoList,default_type,type,256,&flg);CHKERRQ(ierr); 403a7e14dcfSSatish Balay if (flg) { 404a7e14dcfSSatish Balay ierr = TaoSetType(tao,type);CHKERRQ(ierr); 405a7e14dcfSSatish Balay } else if (!((PetscObject)tao)->type_name) { 406302440fdSBarry Smith ierr = TaoSetType(tao,default_type);CHKERRQ(ierr); 407a7e14dcfSSatish Balay } 408a7e14dcfSSatish Balay 4096552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_catol","Stop if constraints violations within","TaoSetConstraintTolerances",tao->catol,&tao->catol,&flg);CHKERRQ(ierr); 4106552cf8aSJason Sarich if (flg) tao->catol_changed=PETSC_TRUE; 4116552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_crtol","Stop if relative contraint violations within","TaoSetConstraintTolerances",tao->crtol,&tao->crtol,&flg);CHKERRQ(ierr); 4126552cf8aSJason Sarich if (flg) tao->crtol_changed=PETSC_TRUE; 4136552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_gatol","Stop if norm of gradient less than","TaoSetTolerances",tao->gatol,&tao->gatol,&flg);CHKERRQ(ierr); 4146552cf8aSJason Sarich if (flg) tao->gatol_changed=PETSC_TRUE; 4156552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_grtol","Stop if norm of gradient divided by the function value is less than","TaoSetTolerances",tao->grtol,&tao->grtol,&flg);CHKERRQ(ierr); 4166552cf8aSJason Sarich if (flg) tao->grtol_changed=PETSC_TRUE; 4176552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_gttol","Stop if the norm of the gradient is less than the norm of the initial gradient times tol","TaoSetTolerances",tao->gttol,&tao->gttol,&flg);CHKERRQ(ierr); 4186552cf8aSJason Sarich if (flg) tao->gttol_changed=PETSC_TRUE; 4196552cf8aSJason Sarich ierr = PetscOptionsInt("-tao_max_it","Stop if iteration number exceeds","TaoSetMaximumIterations",tao->max_it,&tao->max_it,&flg);CHKERRQ(ierr); 4206552cf8aSJason Sarich if (flg) tao->max_it_changed=PETSC_TRUE; 4216552cf8aSJason Sarich ierr = PetscOptionsInt("-tao_max_funcs","Stop if number of function evaluations exceeds","TaoSetMaximumFunctionEvaluations",tao->max_funcs,&tao->max_funcs,&flg);CHKERRQ(ierr); 4226552cf8aSJason Sarich if (flg) tao->max_funcs_changed=PETSC_TRUE; 4236552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_fmin","Stop if function less than","TaoSetFunctionLowerBound",tao->fmin,&tao->fmin,&flg);CHKERRQ(ierr); 4246552cf8aSJason Sarich if (flg) tao->fmin_changed=PETSC_TRUE; 4256552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_steptol","Stop if step size or trust region radius less than","",tao->steptol,&tao->steptol,&flg);CHKERRQ(ierr); 4266552cf8aSJason Sarich if (flg) tao->steptol_changed=PETSC_TRUE; 4276552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_trust0","Initial trust region radius","TaoSetTrustRegionRadius",tao->trust0,&tao->trust0,&flg);CHKERRQ(ierr); 4286552cf8aSJason Sarich if (flg) tao->trust0_changed=PETSC_TRUE; 429a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_solution","view solution 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,TaoSolutionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 433a7e14dcfSSatish Balay } 434a7e14dcfSSatish Balay 4358afaa268SBarry Smith ierr = PetscOptionsBool("-tao_converged_reason","Print reason for TAO converged","TaoSolve",tao->printreason,&tao->printreason,NULL);CHKERRQ(ierr); 436a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_gradient","view gradient vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 437a7e14dcfSSatish Balay if (flg) { 438a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 439a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoGradientMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 440a7e14dcfSSatish Balay } 441a7e14dcfSSatish Balay 442a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_stepdirection","view step direction vector after each iteration","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 443a7e14dcfSSatish Balay if (flg) { 444a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 445a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoStepDirectionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 446a7e14dcfSSatish Balay } 447a7e14dcfSSatish Balay 448a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_separableobjective","view separable objective vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 449a7e14dcfSSatish Balay if (flg) { 450a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 451a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoSeparableObjectiveMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 452a7e14dcfSSatish Balay } 453a7e14dcfSSatish Balay 454a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_monitor","Use the default convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 455a7e14dcfSSatish Balay if (flg) { 456a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 457a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoDefaultMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 458a7e14dcfSSatish Balay } 459a7e14dcfSSatish Balay 460a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_smonitor","Use the short convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 461a7e14dcfSSatish Balay if (flg) { 462a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 463a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoDefaultSMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 464a7e14dcfSSatish Balay } 465a7e14dcfSSatish Balay 466a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_cmonitor","Use the default convergence monitor with constraint norm","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 467a7e14dcfSSatish Balay if (flg) { 468a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 469a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoDefaultCMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 470a7e14dcfSSatish Balay } 471a7e14dcfSSatish Balay 472a7e14dcfSSatish Balay 4738afaa268SBarry Smith flg = PETSC_FALSE; 4748afaa268SBarry Smith ierr = PetscOptionsBool("-tao_cancelmonitors","cancel all monitors and call any registered destroy routines","TaoCancelMonitors",flg,&flg,NULL);CHKERRQ(ierr); 475a7e14dcfSSatish Balay if (flg) {ierr = TaoCancelMonitors(tao);CHKERRQ(ierr);} 476a7e14dcfSSatish Balay 4778afaa268SBarry Smith flg = PETSC_FALSE; 4788afaa268SBarry Smith ierr = PetscOptionsBool("-tao_draw_solution","Plot solution vector at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr); 479a7e14dcfSSatish Balay if (flg) { 480*e882e171SHong Zhang TaoMonitorDrawCtx drawctx; 481*e882e171SHong Zhang PetscInt howoften = 1; 482*e882e171SHong Zhang ierr = TaoMonitorDrawCtxCreate(PetscObjectComm((PetscObject)tao),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&drawctx);CHKERRQ(ierr); 483*e882e171SHong Zhang ierr = TaoSetMonitor(tao,TaoDrawSolutionMonitor,drawctx,(PetscErrorCode (*)(void**))TaoMonitorDrawCtxDestroy);CHKERRQ(ierr); 484a7e14dcfSSatish Balay } 485a7e14dcfSSatish Balay 4868afaa268SBarry Smith flg = PETSC_FALSE; 4878afaa268SBarry Smith ierr = PetscOptionsBool("-tao_draw_step","plots step direction at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr); 488a7e14dcfSSatish Balay if (flg) { 48947a47007SBarry Smith ierr = TaoSetMonitor(tao,TaoDrawStepMonitor,NULL,NULL);CHKERRQ(ierr); 490a7e14dcfSSatish Balay } 491a7e14dcfSSatish Balay 4928afaa268SBarry Smith flg = PETSC_FALSE; 4938afaa268SBarry Smith ierr = PetscOptionsBool("-tao_draw_gradient","plots gradient at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr); 494a7e14dcfSSatish Balay if (flg) { 495*e882e171SHong Zhang TaoMonitorDrawCtx drawctx; 496*e882e171SHong Zhang PetscInt howoften = 1; 497*e882e171SHong Zhang ierr = TaoMonitorDrawCtxCreate(PetscObjectComm((PetscObject)tao),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&drawctx);CHKERRQ(ierr); 498*e882e171SHong Zhang ierr = TaoSetMonitor(tao,TaoDrawGradientMonitor,drawctx,(PetscErrorCode (*)(void**))TaoMonitorDrawCtxDestroy);CHKERRQ(ierr); 499a7e14dcfSSatish Balay } 5008afaa268SBarry Smith flg = PETSC_FALSE; 5018afaa268SBarry Smith ierr = PetscOptionsBool("-tao_fd_gradient","compute gradient using finite differences","TaoDefaultComputeGradient",flg,&flg,NULL);CHKERRQ(ierr); 502a7e14dcfSSatish Balay if (flg) { 50347a47007SBarry Smith ierr = TaoSetGradientRoutine(tao,TaoDefaultComputeGradient,NULL);CHKERRQ(ierr); 504a7e14dcfSSatish Balay } 505e1cc520bSBarry Smith ierr = PetscOptionsEnum("-tao_subset_type","subset type", "", TaoSubSetTypes,(PetscEnum)tao->subset_type, (PetscEnum*)&tao->subset_type, 0);CHKERRQ(ierr); 506a7e14dcfSSatish Balay 507a7e14dcfSSatish Balay if (tao->ops->setfromoptions) { 5081a1499c8SBarry Smith ierr = (*tao->ops->setfromoptions)(PetscOptionsObject,tao);CHKERRQ(ierr); 509a7e14dcfSSatish Balay } 510a7e14dcfSSatish Balay } 511a7e14dcfSSatish Balay ierr = PetscOptionsEnd();CHKERRQ(ierr); 512a7e14dcfSSatish Balay PetscFunctionReturn(0); 513a7e14dcfSSatish Balay } 514a7e14dcfSSatish Balay 515a7e14dcfSSatish Balay /*@C 516441846f8SBarry Smith TaoView - Prints information about the Tao 517a7e14dcfSSatish Balay 518441846f8SBarry Smith Collective on Tao 519a7e14dcfSSatish Balay 520a7e14dcfSSatish Balay InputParameters: 521441846f8SBarry Smith + tao - the Tao context 522a7e14dcfSSatish Balay - viewer - visualization context 523a7e14dcfSSatish Balay 524a7e14dcfSSatish Balay Options Database Key: 525a7e14dcfSSatish Balay . -tao_view - Calls TaoView() at the end of TaoSolve() 526a7e14dcfSSatish Balay 527a7e14dcfSSatish Balay Notes: 528a7e14dcfSSatish Balay The available visualization contexts include 529a7e14dcfSSatish Balay + PETSC_VIEWER_STDOUT_SELF - standard output (default) 530a7e14dcfSSatish Balay - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 531a7e14dcfSSatish Balay output where only the first processor opens 532a7e14dcfSSatish Balay the file. All other processors send their 533a7e14dcfSSatish Balay data to the first processor to print. 534a7e14dcfSSatish Balay 535a7e14dcfSSatish Balay Level: beginner 536a7e14dcfSSatish Balay 537a7e14dcfSSatish Balay .seealso: PetscViewerASCIIOpen() 538a7e14dcfSSatish Balay @*/ 539441846f8SBarry Smith PetscErrorCode TaoView(Tao tao, PetscViewer viewer) 540a7e14dcfSSatish Balay { 541a7e14dcfSSatish Balay PetscErrorCode ierr; 542a7e14dcfSSatish Balay PetscBool isascii,isstring; 543441846f8SBarry Smith const TaoType type; 54447a47007SBarry Smith 545a7e14dcfSSatish Balay PetscFunctionBegin; 546441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 547a7e14dcfSSatish Balay if (!viewer) { 548a7e14dcfSSatish Balay ierr = PetscViewerASCIIGetStdout(((PetscObject)tao)->comm,&viewer);CHKERRQ(ierr); 549a7e14dcfSSatish Balay } 550a7e14dcfSSatish Balay PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 551a7e14dcfSSatish Balay PetscCheckSameComm(tao,1,viewer,2); 552a7e14dcfSSatish Balay 553a7e14dcfSSatish Balay ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 554a7e14dcfSSatish Balay ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 555a7e14dcfSSatish Balay if (isascii) { 556a7e14dcfSSatish Balay ierr = PetscObjectPrintClassNamePrefixType((PetscObject)tao,viewer);CHKERRQ(ierr); 557a7e14dcfSSatish Balay ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 558a7e14dcfSSatish Balay 559a7e14dcfSSatish Balay if (tao->ops->view) { 560a7e14dcfSSatish Balay ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 561a7e14dcfSSatish Balay ierr = (*tao->ops->view)(tao,viewer);CHKERRQ(ierr); 562a7e14dcfSSatish Balay ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 563a7e14dcfSSatish Balay } 564a7e14dcfSSatish Balay if (tao->linesearch) { 565a7e14dcfSSatish Balay ierr = PetscObjectPrintClassNamePrefixType((PetscObject)(tao->linesearch),viewer);CHKERRQ(ierr); 566a7e14dcfSSatish Balay } 567a7e14dcfSSatish Balay if (tao->ksp) { 568a7e14dcfSSatish Balay ierr = PetscObjectPrintClassNamePrefixType((PetscObject)(tao->ksp),viewer);CHKERRQ(ierr); 569ae93cb3cSJason Sarich ierr = PetscViewerASCIIPrintf(viewer,"total KSP iterations: %D\n",tao->ksp_tot_its);CHKERRQ(ierr); 570a7e14dcfSSatish Balay } 571a7e14dcfSSatish Balay if (tao->XL || tao->XU) { 572302440fdSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Active Set subset type: %s\n",TaoSubSetTypes[tao->subset_type]);CHKERRQ(ierr); 573a7e14dcfSSatish Balay } 574a7e14dcfSSatish Balay 57547a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: gatol=%g,",(double)tao->gatol);CHKERRQ(ierr); 57647a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," steptol=%g,",(double)tao->steptol);CHKERRQ(ierr); 57747a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," gttol=%g\n",(double)tao->gttol);CHKERRQ(ierr); 578a7e14dcfSSatish Balay 57947a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Residual in Function/Gradient:=%g\n",(double)tao->residual);CHKERRQ(ierr); 580a7e14dcfSSatish Balay 581a7e14dcfSSatish Balay if (tao->cnorm>0 || tao->catol>0 || tao->crtol>0){ 582a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances:");CHKERRQ(ierr); 58347a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," catol=%g,",(double)tao->catol);CHKERRQ(ierr); 58447a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," crtol=%g\n",(double)tao->crtol);CHKERRQ(ierr); 58547a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Residual in Constraints:=%g\n",(double)tao->cnorm);CHKERRQ(ierr); 586a7e14dcfSSatish Balay } 587a7e14dcfSSatish Balay 588a7e14dcfSSatish Balay if (tao->trust < tao->steptol){ 58947a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: steptol=%g\n",(double)tao->steptol);CHKERRQ(ierr); 59047a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"Final trust region radius:=%g\n",(double)tao->trust);CHKERRQ(ierr); 591a7e14dcfSSatish Balay } 592a7e14dcfSSatish Balay 593a7e14dcfSSatish Balay if (tao->fmin>-1.e25){ 59447a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: function minimum=%g\n",(double)tao->fmin);CHKERRQ(ierr); 595a7e14dcfSSatish Balay } 59647a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Objective value=%g\n",(double)tao->fc);CHKERRQ(ierr); 597a7e14dcfSSatish Balay 59847a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of iterations=%D, ",tao->niter);CHKERRQ(ierr); 599a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," (max: %D)\n",tao->max_it);CHKERRQ(ierr); 600a7e14dcfSSatish Balay 601a7e14dcfSSatish Balay if (tao->nfuncs>0){ 60247a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of function evaluations=%D,",tao->nfuncs);CHKERRQ(ierr); 60347a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," max: %D\n",tao->max_funcs);CHKERRQ(ierr); 604a7e14dcfSSatish Balay } 605a7e14dcfSSatish Balay if (tao->ngrads>0){ 60647a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of gradient evaluations=%D,",tao->ngrads);CHKERRQ(ierr); 60747a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," max: %D\n",tao->max_funcs);CHKERRQ(ierr); 608a7e14dcfSSatish Balay } 609a7e14dcfSSatish Balay if (tao->nfuncgrads>0){ 61047a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of function/gradient evaluations=%D,",tao->nfuncgrads);CHKERRQ(ierr); 61147a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," (max: %D)\n",tao->max_funcs);CHKERRQ(ierr); 612a7e14dcfSSatish Balay } 613a7e14dcfSSatish Balay if (tao->nhess>0){ 61447a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of Hessian evaluations=%D\n",tao->nhess);CHKERRQ(ierr); 615a7e14dcfSSatish Balay } 616a7e14dcfSSatish Balay /* if (tao->linear_its>0){ 61747a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total Krylov method iterations=%D\n",tao->linear_its);CHKERRQ(ierr); 618a7e14dcfSSatish Balay }*/ 619a7e14dcfSSatish Balay if (tao->nconstraints>0){ 62047a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of constraint function evaluations=%D\n",tao->nconstraints);CHKERRQ(ierr); 621a7e14dcfSSatish Balay } 622a7e14dcfSSatish Balay if (tao->njac>0){ 62347a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of Jacobian evaluations=%D\n",tao->njac);CHKERRQ(ierr); 624a7e14dcfSSatish Balay } 625a7e14dcfSSatish Balay 626a7e14dcfSSatish Balay if (tao->reason>0){ 627a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer, "Solution converged: ");CHKERRQ(ierr); 628a7e14dcfSSatish Balay switch (tao->reason) { 629a7e14dcfSSatish Balay case TAO_CONVERGED_GATOL: 630a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," ||g(X)|| <= gatol\n");CHKERRQ(ierr); 631a7e14dcfSSatish Balay break; 632a7e14dcfSSatish Balay case TAO_CONVERGED_GRTOL: 633a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/|f(X)| <= grtol\n");CHKERRQ(ierr); 634a7e14dcfSSatish Balay break; 635a7e14dcfSSatish Balay case TAO_CONVERGED_GTTOL: 636a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/||g(X0)|| <= gttol\n");CHKERRQ(ierr); 637a7e14dcfSSatish Balay break; 638a7e14dcfSSatish Balay case TAO_CONVERGED_STEPTOL: 639a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," Steptol -- step size small\n");CHKERRQ(ierr); 640a7e14dcfSSatish Balay break; 641a7e14dcfSSatish Balay case TAO_CONVERGED_MINF: 642a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," Minf -- f < fmin\n");CHKERRQ(ierr); 643a7e14dcfSSatish Balay break; 644a7e14dcfSSatish Balay case TAO_CONVERGED_USER: 645a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr); 646a7e14dcfSSatish Balay break; 647a7e14dcfSSatish Balay default: 648a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 649a7e14dcfSSatish Balay break; 650a7e14dcfSSatish Balay } 651a7e14dcfSSatish Balay 652a7e14dcfSSatish Balay } else { 65347cfc4faSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Solver terminated: %d",tao->reason);CHKERRQ(ierr); 654a7e14dcfSSatish Balay switch (tao->reason) { 655a7e14dcfSSatish Balay case TAO_DIVERGED_MAXITS: 65647a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Maximum Iterations\n");CHKERRQ(ierr); 657a7e14dcfSSatish Balay break; 658a7e14dcfSSatish Balay case TAO_DIVERGED_NAN: 65947a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," NAN or Inf encountered\n");CHKERRQ(ierr); 660a7e14dcfSSatish Balay break; 661a7e14dcfSSatish Balay case TAO_DIVERGED_MAXFCN: 66247a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Maximum Function Evaluations\n");CHKERRQ(ierr); 663a7e14dcfSSatish Balay break; 664a7e14dcfSSatish Balay case TAO_DIVERGED_LS_FAILURE: 66547a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Line Search Failure\n");CHKERRQ(ierr); 666a7e14dcfSSatish Balay break; 667a7e14dcfSSatish Balay case TAO_DIVERGED_TR_REDUCTION: 66847a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Trust Region too small\n");CHKERRQ(ierr); 669a7e14dcfSSatish Balay break; 670a7e14dcfSSatish Balay case TAO_DIVERGED_USER: 67147a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr); 672a7e14dcfSSatish Balay break; 673a7e14dcfSSatish Balay default: 674a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 675a7e14dcfSSatish Balay break; 676a7e14dcfSSatish Balay } 677a7e14dcfSSatish Balay } 678a7e14dcfSSatish Balay ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 679a7e14dcfSSatish Balay } else if (isstring) { 680a7e14dcfSSatish Balay ierr = TaoGetType(tao,&type);CHKERRQ(ierr); 681a7e14dcfSSatish Balay ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr); 682a7e14dcfSSatish Balay } 683a7e14dcfSSatish Balay PetscFunctionReturn(0); 684a7e14dcfSSatish Balay } 685a7e14dcfSSatish Balay 686a7e14dcfSSatish Balay /*@ 687a7e14dcfSSatish Balay TaoSetTolerances - Sets parameters used in TAO convergence tests 688a7e14dcfSSatish Balay 689441846f8SBarry Smith Logically collective on Tao 690a7e14dcfSSatish Balay 691a7e14dcfSSatish Balay Input Parameters: 692441846f8SBarry Smith + tao - the Tao context 693a7e14dcfSSatish Balay . gatol - stop if norm of gradient is less than this 694a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this 695a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by this factor 696a7e14dcfSSatish Balay 697a7e14dcfSSatish Balay Options Database Keys: 698e52336cbSBarry Smith + -tao_gatol <gatol> - Sets gatol 699a7e14dcfSSatish Balay . -tao_grtol <grtol> - Sets grtol 700a7e14dcfSSatish Balay - -tao_gttol <gttol> - Sets gttol 701a7e14dcfSSatish Balay 702a7e14dcfSSatish Balay Stopping Criteria: 703a7e14dcfSSatish Balay $ ||g(X)|| <= gatol 704a7e14dcfSSatish Balay $ ||g(X)|| / |f(X)| <= grtol 705a7e14dcfSSatish Balay $ ||g(X)|| / ||g(X0)|| <= gttol 706a7e14dcfSSatish Balay 707a7e14dcfSSatish Balay Notes: 708a7e14dcfSSatish Balay Use PETSC_DEFAULT to leave one or more tolerances unchanged. 709a7e14dcfSSatish Balay 710a7e14dcfSSatish Balay Level: beginner 711a7e14dcfSSatish Balay 712a7e14dcfSSatish Balay .seealso: TaoGetTolerances() 713a7e14dcfSSatish Balay 714a7e14dcfSSatish Balay @*/ 715e52336cbSBarry Smith PetscErrorCode TaoSetTolerances(Tao tao, PetscReal gatol, PetscReal grtol, PetscReal gttol) 716a7e14dcfSSatish Balay { 717a7e14dcfSSatish Balay PetscErrorCode ierr; 71847a47007SBarry Smith 719a7e14dcfSSatish Balay PetscFunctionBegin; 720441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 721a7e14dcfSSatish Balay 722a7e14dcfSSatish Balay if (gatol != PETSC_DEFAULT) { 723a7e14dcfSSatish Balay if (gatol<0) { 724955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative gatol -- ignored.\n");CHKERRQ(ierr); 725a7e14dcfSSatish Balay } else { 726a7e14dcfSSatish Balay tao->gatol = PetscMax(0,gatol); 7276552cf8aSJason Sarich tao->gatol_changed=PETSC_TRUE; 728a7e14dcfSSatish Balay } 729a7e14dcfSSatish Balay } 730a7e14dcfSSatish Balay 731a7e14dcfSSatish Balay if (grtol != PETSC_DEFAULT) { 732a7e14dcfSSatish Balay if (grtol<0) { 733955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative grtol -- ignored.\n");CHKERRQ(ierr); 734a7e14dcfSSatish Balay } else { 735a7e14dcfSSatish Balay tao->grtol = PetscMax(0,grtol); 7366552cf8aSJason Sarich tao->grtol_changed=PETSC_TRUE; 737a7e14dcfSSatish Balay } 738a7e14dcfSSatish Balay } 739a7e14dcfSSatish Balay 740a7e14dcfSSatish Balay if (gttol != PETSC_DEFAULT) { 741a7e14dcfSSatish Balay if (gttol<0) { 742955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative gttol -- ignored.\n");CHKERRQ(ierr); 743a7e14dcfSSatish Balay } else { 744a7e14dcfSSatish Balay tao->gttol = PetscMax(0,gttol); 7456552cf8aSJason Sarich tao->gttol_changed=PETSC_TRUE; 746a7e14dcfSSatish Balay } 747a7e14dcfSSatish Balay } 748a7e14dcfSSatish Balay PetscFunctionReturn(0); 749a7e14dcfSSatish Balay } 750a7e14dcfSSatish Balay 751a7e14dcfSSatish Balay /*@ 75258417fe7SBarry Smith TaoSetConstraintTolerances - Sets constraint tolerance parameters used in TAO convergence tests 753a7e14dcfSSatish Balay 754441846f8SBarry Smith Logically collective on Tao 755a7e14dcfSSatish Balay 756a7e14dcfSSatish Balay Input Parameters: 757441846f8SBarry Smith + tao - the Tao context 758e52336cbSBarry Smith . catol - absolute constraint tolerance, constraint norm must be less than catol for used for gatol convergence criteria 759e52336cbSBarry Smith - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for gatol, gttol convergence criteria 760a7e14dcfSSatish Balay 761a7e14dcfSSatish Balay Options Database Keys: 762a7e14dcfSSatish Balay + -tao_catol <catol> - Sets catol 763a7e14dcfSSatish Balay - -tao_crtol <crtol> - Sets crtol 764a7e14dcfSSatish Balay 7656552cf8aSJason Sarich Notes: 7666552cf8aSJason Sarich Use PETSC_DEFAULT to leave any tolerance unchanged. 7676552cf8aSJason Sarich 768a7e14dcfSSatish Balay Level: intermediate 769a7e14dcfSSatish Balay 77058417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoGetConstraintTolerances(), TaoSetTolerances() 771a7e14dcfSSatish Balay 772a7e14dcfSSatish Balay @*/ 773441846f8SBarry Smith PetscErrorCode TaoSetConstraintTolerances(Tao tao, PetscReal catol, PetscReal crtol) 774a7e14dcfSSatish Balay { 775a7e14dcfSSatish Balay PetscErrorCode ierr; 77647a47007SBarry Smith 777a7e14dcfSSatish Balay PetscFunctionBegin; 778441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 779a7e14dcfSSatish Balay 780a7e14dcfSSatish Balay if (catol != PETSC_DEFAULT) { 781a7e14dcfSSatish Balay if (catol<0) { 782955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative catol -- ignored.\n");CHKERRQ(ierr); 783a7e14dcfSSatish Balay } else { 784a7e14dcfSSatish Balay tao->catol = PetscMax(0,catol); 7856552cf8aSJason Sarich tao->catol_changed=PETSC_TRUE; 786a7e14dcfSSatish Balay } 787a7e14dcfSSatish Balay } 788a7e14dcfSSatish Balay 789a7e14dcfSSatish Balay if (crtol != PETSC_DEFAULT) { 790a7e14dcfSSatish Balay if (crtol<0) { 791955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative crtol -- ignored.\n");CHKERRQ(ierr); 792a7e14dcfSSatish Balay } else { 793a7e14dcfSSatish Balay tao->crtol = PetscMax(0,crtol); 7946552cf8aSJason Sarich tao->crtol_changed=PETSC_TRUE; 795a7e14dcfSSatish Balay } 796a7e14dcfSSatish Balay } 797a7e14dcfSSatish Balay PetscFunctionReturn(0); 798a7e14dcfSSatish Balay } 799a7e14dcfSSatish Balay 80058417fe7SBarry Smith /*@ 80158417fe7SBarry Smith TaoGetConstraintTolerances - Gets constraint tolerance parameters used in TAO convergence tests 80258417fe7SBarry Smith 80358417fe7SBarry Smith Not ollective 80458417fe7SBarry Smith 80558417fe7SBarry Smith Input Parameter: 80658417fe7SBarry Smith . tao - the Tao context 80758417fe7SBarry Smith 80858417fe7SBarry Smith Output Parameter: 809e52336cbSBarry Smith + catol - absolute constraint tolerance, constraint norm must be less than catol for used for gatol convergence criteria 810e52336cbSBarry Smith - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for gatol, gttol convergence criteria 81158417fe7SBarry Smith 81258417fe7SBarry Smith Level: intermediate 81358417fe7SBarry Smith 81458417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoSetTolerances(), TaoSetConstraintTolerances() 81558417fe7SBarry Smith 81658417fe7SBarry Smith @*/ 81758417fe7SBarry Smith PetscErrorCode TaoGetConstraintTolerances(Tao tao, PetscReal *catol, PetscReal *crtol) 81858417fe7SBarry Smith { 81958417fe7SBarry Smith PetscFunctionBegin; 82058417fe7SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 82158417fe7SBarry Smith if (catol) *catol = tao->catol; 82258417fe7SBarry Smith if (crtol) *crtol = tao->crtol; 82358417fe7SBarry Smith PetscFunctionReturn(0); 82458417fe7SBarry Smith } 82558417fe7SBarry Smith 826a7e14dcfSSatish Balay /*@ 827a7e14dcfSSatish Balay TaoSetFunctionLowerBound - Sets a bound on the solution objective value. 828a7e14dcfSSatish Balay When an approximate solution with an objective value below this number 829a7e14dcfSSatish Balay has been found, the solver will terminate. 830a7e14dcfSSatish Balay 831441846f8SBarry Smith Logically Collective on Tao 832a7e14dcfSSatish Balay 833a7e14dcfSSatish Balay Input Parameters: 834441846f8SBarry Smith + tao - the Tao solver context 835a7e14dcfSSatish Balay - fmin - the tolerance 836a7e14dcfSSatish Balay 837a7e14dcfSSatish Balay Options Database Keys: 838a7e14dcfSSatish Balay . -tao_fmin <fmin> - sets the minimum function value 839a7e14dcfSSatish Balay 840a7e14dcfSSatish Balay Level: intermediate 841a7e14dcfSSatish Balay 842a7e14dcfSSatish Balay .seealso: TaoSetTolerances() 843a7e14dcfSSatish Balay @*/ 844441846f8SBarry Smith PetscErrorCode TaoSetFunctionLowerBound(Tao tao,PetscReal fmin) 845a7e14dcfSSatish Balay { 846a7e14dcfSSatish Balay PetscFunctionBegin; 847441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 848a7e14dcfSSatish Balay tao->fmin = fmin; 8496552cf8aSJason Sarich tao->fmin_changed=PETSC_TRUE; 850a7e14dcfSSatish Balay PetscFunctionReturn(0); 851a7e14dcfSSatish Balay } 852a7e14dcfSSatish Balay 853a7e14dcfSSatish Balay /*@ 8548e96d397SJason Sarich TaoGetFunctionLowerBound - Gets the bound on the solution objective value. 855a7e14dcfSSatish Balay When an approximate solution with an objective value below this number 856a7e14dcfSSatish Balay has been found, the solver will terminate. 857a7e14dcfSSatish Balay 858441846f8SBarry Smith Not collective on Tao 859a7e14dcfSSatish Balay 860a7e14dcfSSatish Balay Input Parameters: 861441846f8SBarry Smith . tao - the Tao solver context 862a7e14dcfSSatish Balay 863a7e14dcfSSatish Balay OutputParameters: 864a7e14dcfSSatish Balay . fmin - the minimum function value 865a7e14dcfSSatish Balay 866a7e14dcfSSatish Balay Level: intermediate 867a7e14dcfSSatish Balay 868a7e14dcfSSatish Balay .seealso: TaoSetFunctionLowerBound() 869a7e14dcfSSatish Balay @*/ 870441846f8SBarry Smith PetscErrorCode TaoGetFunctionLowerBound(Tao tao,PetscReal *fmin) 871a7e14dcfSSatish Balay { 872a7e14dcfSSatish Balay PetscFunctionBegin; 873441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 874a7e14dcfSSatish Balay *fmin = tao->fmin; 875a7e14dcfSSatish Balay PetscFunctionReturn(0); 876a7e14dcfSSatish Balay } 877a7e14dcfSSatish Balay 878a7e14dcfSSatish Balay /*@ 879a7e14dcfSSatish Balay TaoSetMaximumFunctionEvaluations - Sets a maximum number of 880a7e14dcfSSatish Balay function evaluations. 881a7e14dcfSSatish Balay 882441846f8SBarry Smith Logically Collective on Tao 883a7e14dcfSSatish Balay 884a7e14dcfSSatish Balay Input Parameters: 885441846f8SBarry Smith + tao - the Tao solver context 886a7e14dcfSSatish Balay - nfcn - the maximum number of function evaluations (>=0) 887a7e14dcfSSatish Balay 888a7e14dcfSSatish Balay Options Database Keys: 889a7e14dcfSSatish Balay . -tao_max_funcs <nfcn> - sets the maximum number of function evaluations 890a7e14dcfSSatish Balay 891a7e14dcfSSatish Balay Level: intermediate 892a7e14dcfSSatish Balay 893a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumIterations() 894a7e14dcfSSatish Balay @*/ 895a7e14dcfSSatish Balay 896441846f8SBarry Smith PetscErrorCode TaoSetMaximumFunctionEvaluations(Tao tao,PetscInt nfcn) 897a7e14dcfSSatish Balay { 898a7e14dcfSSatish Balay PetscFunctionBegin; 899441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 90047a47007SBarry Smith tao->max_funcs = PetscMax(0,nfcn); 9016552cf8aSJason Sarich tao->max_funcs_changed=PETSC_TRUE; 902a7e14dcfSSatish Balay PetscFunctionReturn(0); 903a7e14dcfSSatish Balay } 904a7e14dcfSSatish Balay 905a7e14dcfSSatish Balay /*@ 906a7e14dcfSSatish Balay TaoGetMaximumFunctionEvaluations - Sets a maximum number of 907a7e14dcfSSatish Balay function evaluations. 908a7e14dcfSSatish Balay 909a7e14dcfSSatish Balay Not Collective 910a7e14dcfSSatish Balay 911a7e14dcfSSatish Balay Input Parameters: 912441846f8SBarry Smith . tao - the Tao solver context 913a7e14dcfSSatish Balay 914a7e14dcfSSatish Balay Output Parameters: 915a7e14dcfSSatish Balay . nfcn - the maximum number of function evaluations 916a7e14dcfSSatish Balay 917a7e14dcfSSatish Balay Level: intermediate 918a7e14dcfSSatish Balay 919a7e14dcfSSatish Balay .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumIterations() 920a7e14dcfSSatish Balay @*/ 921a7e14dcfSSatish Balay 922441846f8SBarry Smith PetscErrorCode TaoGetMaximumFunctionEvaluations(Tao tao,PetscInt *nfcn) 923a7e14dcfSSatish Balay { 924a7e14dcfSSatish Balay PetscFunctionBegin; 925441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 926a7e14dcfSSatish Balay *nfcn = tao->max_funcs; 927a7e14dcfSSatish Balay PetscFunctionReturn(0); 928a7e14dcfSSatish Balay } 929a7e14dcfSSatish Balay 930770232b9SCe Qin /*@ 931770232b9SCe Qin TaoGetCurrentFunctionEvaluations - Get current number of 932770232b9SCe Qin function evaluations. 933770232b9SCe Qin 934770232b9SCe Qin Not Collective 935770232b9SCe Qin 936770232b9SCe Qin Input Parameters: 937770232b9SCe Qin . tao - the Tao solver context 938770232b9SCe Qin 939770232b9SCe Qin Output Parameters: 940770232b9SCe Qin . nfuncs - the current number of function evaluations 941770232b9SCe Qin 942770232b9SCe Qin Level: intermediate 943770232b9SCe Qin 944770232b9SCe Qin .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumFunctionEvaluations(), TaoGetMaximumIterations() 945770232b9SCe Qin @*/ 946770232b9SCe Qin 947770232b9SCe Qin PetscErrorCode TaoGetCurrentFunctionEvaluations(Tao tao,PetscInt *nfuncs) 948770232b9SCe Qin { 949770232b9SCe Qin PetscFunctionBegin; 950770232b9SCe Qin PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 951770232b9SCe Qin *nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads); 952770232b9SCe Qin PetscFunctionReturn(0); 953770232b9SCe Qin } 954770232b9SCe Qin 955a7e14dcfSSatish Balay /*@ 956a7e14dcfSSatish Balay TaoSetMaximumIterations - Sets a maximum number of iterates. 957a7e14dcfSSatish Balay 958441846f8SBarry Smith Logically Collective on Tao 959a7e14dcfSSatish Balay 960a7e14dcfSSatish Balay Input Parameters: 961441846f8SBarry Smith + tao - the Tao solver context 962a7e14dcfSSatish Balay - maxits - the maximum number of iterates (>=0) 963a7e14dcfSSatish Balay 964a7e14dcfSSatish Balay Options Database Keys: 965a7e14dcfSSatish Balay . -tao_max_it <its> - sets the maximum number of iterations 966a7e14dcfSSatish Balay 967a7e14dcfSSatish Balay Level: intermediate 968a7e14dcfSSatish Balay 969a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumFunctionEvaluations() 970a7e14dcfSSatish Balay @*/ 971441846f8SBarry Smith PetscErrorCode TaoSetMaximumIterations(Tao tao,PetscInt maxits) 972a7e14dcfSSatish Balay { 973a7e14dcfSSatish Balay PetscFunctionBegin; 974441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 97547a47007SBarry Smith tao->max_it = PetscMax(0,maxits); 9766552cf8aSJason Sarich tao->max_it_changed=PETSC_TRUE; 977a7e14dcfSSatish Balay PetscFunctionReturn(0); 978a7e14dcfSSatish Balay } 979a7e14dcfSSatish Balay 980a7e14dcfSSatish Balay /*@ 981a7e14dcfSSatish Balay TaoGetMaximumIterations - Sets a maximum number of iterates. 982a7e14dcfSSatish Balay 983a7e14dcfSSatish Balay Not Collective 984a7e14dcfSSatish Balay 985a7e14dcfSSatish Balay Input Parameters: 986441846f8SBarry Smith . tao - the Tao solver context 987a7e14dcfSSatish Balay 988a7e14dcfSSatish Balay Output Parameters: 989a7e14dcfSSatish Balay . maxits - the maximum number of iterates 990a7e14dcfSSatish Balay 991a7e14dcfSSatish Balay Level: intermediate 992a7e14dcfSSatish Balay 993a7e14dcfSSatish Balay .seealso: TaoSetMaximumIterations(), TaoGetMaximumFunctionEvaluations() 994a7e14dcfSSatish Balay @*/ 995441846f8SBarry Smith PetscErrorCode TaoGetMaximumIterations(Tao tao,PetscInt *maxits) 996a7e14dcfSSatish Balay { 997a7e14dcfSSatish Balay PetscFunctionBegin; 998441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 999a7e14dcfSSatish Balay *maxits = tao->max_it; 1000a7e14dcfSSatish Balay PetscFunctionReturn(0); 1001a7e14dcfSSatish Balay } 1002a7e14dcfSSatish Balay 1003a7e14dcfSSatish Balay /*@ 1004a7e14dcfSSatish Balay TaoSetInitialTrustRegionRadius - Sets the initial trust region radius. 1005a7e14dcfSSatish Balay 1006441846f8SBarry Smith Logically collective on Tao 1007a7e14dcfSSatish Balay 1008a7e14dcfSSatish Balay Input Parameter: 1009a7e14dcfSSatish Balay + tao - a TAO optimization solver 1010a7e14dcfSSatish Balay - radius - the trust region radius 1011a7e14dcfSSatish Balay 1012a7e14dcfSSatish Balay Level: intermediate 1013a7e14dcfSSatish Balay 1014a7e14dcfSSatish Balay Options Database Key: 1015a7e14dcfSSatish Balay . -tao_trust0 <t0> - sets initial trust region radius 1016a7e14dcfSSatish Balay 1017a7e14dcfSSatish Balay .seealso: TaoGetTrustRegionRadius(), TaoSetTrustRegionTolerance() 1018a7e14dcfSSatish Balay @*/ 1019441846f8SBarry Smith PetscErrorCode TaoSetInitialTrustRegionRadius(Tao tao, PetscReal radius) 1020a7e14dcfSSatish Balay { 1021a7e14dcfSSatish Balay PetscFunctionBegin; 1022441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1023a7e14dcfSSatish Balay tao->trust0 = PetscMax(0.0,radius); 10246552cf8aSJason Sarich tao->trust0_changed=PETSC_TRUE; 1025a7e14dcfSSatish Balay PetscFunctionReturn(0); 1026a7e14dcfSSatish Balay } 1027a7e14dcfSSatish Balay 1028a7e14dcfSSatish Balay /*@ 1029a7e14dcfSSatish Balay TaoGetInitialTrustRegionRadius - Sets the initial trust region radius. 1030a7e14dcfSSatish Balay 1031a7e14dcfSSatish Balay Not Collective 1032a7e14dcfSSatish Balay 1033a7e14dcfSSatish Balay Input Parameter: 1034a7e14dcfSSatish Balay . tao - a TAO optimization solver 1035a7e14dcfSSatish Balay 1036a7e14dcfSSatish Balay Output Parameter: 1037a7e14dcfSSatish Balay . radius - the trust region radius 1038a7e14dcfSSatish Balay 1039a7e14dcfSSatish Balay Level: intermediate 1040a7e14dcfSSatish Balay 1041a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetCurrentTrustRegionRadius() 1042a7e14dcfSSatish Balay @*/ 1043441846f8SBarry Smith PetscErrorCode TaoGetInitialTrustRegionRadius(Tao tao, PetscReal *radius) 1044a7e14dcfSSatish Balay { 1045a7e14dcfSSatish Balay PetscFunctionBegin; 1046441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1047a7e14dcfSSatish Balay *radius = tao->trust0; 1048a7e14dcfSSatish Balay PetscFunctionReturn(0); 1049a7e14dcfSSatish Balay } 1050a7e14dcfSSatish Balay 1051a7e14dcfSSatish Balay /*@ 1052a7e14dcfSSatish Balay TaoGetCurrentTrustRegionRadius - Gets the current trust region radius. 1053a7e14dcfSSatish Balay 1054a7e14dcfSSatish Balay Not Collective 1055a7e14dcfSSatish Balay 1056a7e14dcfSSatish Balay Input Parameter: 1057a7e14dcfSSatish Balay . tao - a TAO optimization solver 1058a7e14dcfSSatish Balay 1059a7e14dcfSSatish Balay Output Parameter: 1060a7e14dcfSSatish Balay . radius - the trust region radius 1061a7e14dcfSSatish Balay 1062a7e14dcfSSatish Balay Level: intermediate 1063a7e14dcfSSatish Balay 1064a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetInitialTrustRegionRadius() 1065a7e14dcfSSatish Balay @*/ 1066441846f8SBarry Smith PetscErrorCode TaoGetCurrentTrustRegionRadius(Tao tao, PetscReal *radius) 1067a7e14dcfSSatish Balay { 1068a7e14dcfSSatish Balay PetscFunctionBegin; 1069441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1070a7e14dcfSSatish Balay *radius = tao->trust; 1071a7e14dcfSSatish Balay PetscFunctionReturn(0); 1072a7e14dcfSSatish Balay } 1073a7e14dcfSSatish Balay 1074a7e14dcfSSatish Balay /*@ 1075a7e14dcfSSatish Balay TaoGetTolerances - gets the current values of tolerances 1076a7e14dcfSSatish Balay 1077a7e14dcfSSatish Balay Not Collective 1078a7e14dcfSSatish Balay 1079a7e14dcfSSatish Balay Input Parameters: 1080441846f8SBarry Smith . tao - the Tao context 1081a7e14dcfSSatish Balay 1082a7e14dcfSSatish Balay Output Parameters: 1083e52336cbSBarry Smith + gatol - stop if norm of gradient is less than this 1084a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this 1085a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by a this factor 1086a7e14dcfSSatish Balay 108747a47007SBarry Smith Note: NULL can be used as an argument if not all tolerances values are needed 1088a7e14dcfSSatish Balay 1089a7e14dcfSSatish Balay .seealso TaoSetTolerances() 1090a7e14dcfSSatish Balay 1091a7e14dcfSSatish Balay Level: intermediate 1092a7e14dcfSSatish Balay @*/ 1093e52336cbSBarry Smith PetscErrorCode TaoGetTolerances(Tao tao, PetscReal *gatol, PetscReal *grtol, PetscReal *gttol) 1094a7e14dcfSSatish Balay { 1095a7e14dcfSSatish Balay PetscFunctionBegin; 1096441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1097a7e14dcfSSatish Balay if (gatol) *gatol=tao->gatol; 1098a7e14dcfSSatish Balay if (grtol) *grtol=tao->grtol; 1099a7e14dcfSSatish Balay if (gttol) *gttol=tao->gttol; 1100a7e14dcfSSatish Balay PetscFunctionReturn(0); 1101a7e14dcfSSatish Balay } 1102a7e14dcfSSatish Balay 1103a7e14dcfSSatish Balay /*@ 1104a7e14dcfSSatish Balay TaoGetKSP - Gets the linear solver used by the optimization solver. 1105a7e14dcfSSatish Balay Application writers should use TaoGetKSP if they need direct access 1106a7e14dcfSSatish Balay to the PETSc KSP object. 1107a7e14dcfSSatish Balay 1108a7e14dcfSSatish Balay Not Collective 1109a7e14dcfSSatish Balay 1110a7e14dcfSSatish Balay Input Parameters: 1111a7e14dcfSSatish Balay . tao - the TAO solver 1112a7e14dcfSSatish Balay 1113a7e14dcfSSatish Balay Output Parameters: 1114a7e14dcfSSatish Balay . ksp - the KSP linear solver used in the optimization solver 1115a7e14dcfSSatish Balay 1116a7e14dcfSSatish Balay Level: intermediate 1117a7e14dcfSSatish Balay 1118a7e14dcfSSatish Balay @*/ 1119441846f8SBarry Smith PetscErrorCode TaoGetKSP(Tao tao, KSP *ksp) 112047a47007SBarry Smith { 1121a7e14dcfSSatish Balay PetscFunctionBegin; 1122a7e14dcfSSatish Balay *ksp = tao->ksp; 1123a7e14dcfSSatish Balay PetscFunctionReturn(0); 1124a7e14dcfSSatish Balay } 1125a7e14dcfSSatish Balay 1126025e9500SJason Sarich /*@ 1127025e9500SJason Sarich TaoGetLinearSolveIterations - Gets the total number of linear iterations 1128025e9500SJason Sarich used by the TAO solver 1129025e9500SJason Sarich 1130025e9500SJason Sarich Not Collective 1131025e9500SJason Sarich 1132025e9500SJason Sarich Input Parameter: 1133025e9500SJason Sarich . tao - TAO context 1134025e9500SJason Sarich 1135025e9500SJason Sarich Output Parameter: 1136025e9500SJason Sarich . lits - number of linear iterations 1137025e9500SJason Sarich 1138025e9500SJason Sarich Notes: 1139025e9500SJason Sarich This counter is reset to zero for each successive call to TaoSolve() 1140025e9500SJason Sarich 1141025e9500SJason Sarich Level: intermediate 1142025e9500SJason Sarich 1143025e9500SJason Sarich .keywords: TAO 1144025e9500SJason Sarich 1145025e9500SJason Sarich .seealso: TaoGetKSP() 1146025e9500SJason Sarich @*/ 1147025e9500SJason Sarich PetscErrorCode TaoGetLinearSolveIterations(Tao tao,PetscInt *lits) 1148025e9500SJason Sarich { 1149025e9500SJason Sarich PetscFunctionBegin; 1150025e9500SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1151025e9500SJason Sarich PetscValidIntPointer(lits,2); 11522d9aa51bSJason Sarich *lits = tao->ksp_tot_its; 1153025e9500SJason Sarich PetscFunctionReturn(0); 1154025e9500SJason Sarich } 1155025e9500SJason Sarich 1156a7e14dcfSSatish Balay /*@ 1157a7e14dcfSSatish Balay TaoGetLineSearch - Gets the line search used by the optimization solver. 1158a7e14dcfSSatish Balay Application writers should use TaoGetLineSearch if they need direct access 1159a7e14dcfSSatish Balay to the TaoLineSearch object. 1160a7e14dcfSSatish Balay 1161a7e14dcfSSatish Balay Not Collective 1162a7e14dcfSSatish Balay 1163a7e14dcfSSatish Balay Input Parameters: 1164a7e14dcfSSatish Balay . tao - the TAO solver 1165a7e14dcfSSatish Balay 1166a7e14dcfSSatish Balay Output Parameters: 1167a7e14dcfSSatish Balay . ls - the line search used in the optimization solver 1168a7e14dcfSSatish Balay 1169a7e14dcfSSatish Balay Level: intermediate 1170a7e14dcfSSatish Balay 1171a7e14dcfSSatish Balay @*/ 1172441846f8SBarry Smith PetscErrorCode TaoGetLineSearch(Tao tao, TaoLineSearch *ls) 117347a47007SBarry Smith { 1174a7e14dcfSSatish Balay PetscFunctionBegin; 1175a7e14dcfSSatish Balay *ls = tao->linesearch; 1176a7e14dcfSSatish Balay PetscFunctionReturn(0); 1177a7e14dcfSSatish Balay } 1178a7e14dcfSSatish Balay 1179a7e14dcfSSatish Balay /*@ 1180a7e14dcfSSatish Balay TaoAddLineSearchCounts - Adds the number of function evaluations spent 1181a7e14dcfSSatish Balay in the line search to the running total. 1182a7e14dcfSSatish Balay 1183a7e14dcfSSatish Balay Input Parameters: 1184a7e14dcfSSatish Balay + tao - the TAO solver 1185a7e14dcfSSatish Balay - ls - the line search used in the optimization solver 1186a7e14dcfSSatish Balay 1187a7e14dcfSSatish Balay Level: developer 1188a7e14dcfSSatish Balay 1189a7e14dcfSSatish Balay .seealso: TaoLineSearchApply() 1190a7e14dcfSSatish Balay @*/ 1191441846f8SBarry Smith PetscErrorCode TaoAddLineSearchCounts(Tao tao) 119247a47007SBarry Smith { 1193a7e14dcfSSatish Balay PetscErrorCode ierr; 1194a7e14dcfSSatish Balay PetscBool flg; 1195a7e14dcfSSatish Balay PetscInt nfeval,ngeval,nfgeval; 119647a47007SBarry Smith 1197a7e14dcfSSatish Balay PetscFunctionBegin; 1198441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1199a7e14dcfSSatish Balay if (tao->linesearch) { 1200302440fdSBarry Smith ierr = TaoLineSearchIsUsingTaoRoutines(tao->linesearch,&flg);CHKERRQ(ierr); 120194ae4db5SBarry Smith if (!flg) { 120247a47007SBarry Smith ierr = TaoLineSearchGetNumberFunctionEvaluations(tao->linesearch,&nfeval,&ngeval,&nfgeval);CHKERRQ(ierr); 1203a7e14dcfSSatish Balay tao->nfuncs+=nfeval; 1204a7e14dcfSSatish Balay tao->ngrads+=ngeval; 1205a7e14dcfSSatish Balay tao->nfuncgrads+=nfgeval; 1206a7e14dcfSSatish Balay } 1207a7e14dcfSSatish Balay } 1208a7e14dcfSSatish Balay PetscFunctionReturn(0); 1209a7e14dcfSSatish Balay } 1210a7e14dcfSSatish Balay 1211a7e14dcfSSatish Balay /*@ 1212a7e14dcfSSatish Balay TaoGetSolutionVector - Returns the vector with the current TAO solution 1213a7e14dcfSSatish Balay 1214a7e14dcfSSatish Balay Not Collective 1215a7e14dcfSSatish Balay 1216a7e14dcfSSatish Balay Input Parameter: 1217441846f8SBarry Smith . tao - the Tao context 1218a7e14dcfSSatish Balay 1219a7e14dcfSSatish Balay Output Parameter: 1220a7e14dcfSSatish Balay . X - the current solution 1221a7e14dcfSSatish Balay 1222a7e14dcfSSatish Balay Level: intermediate 1223a7e14dcfSSatish Balay 1224a7e14dcfSSatish Balay Note: The returned vector will be the same object that was passed into TaoSetInitialVector() 1225a7e14dcfSSatish Balay @*/ 1226441846f8SBarry Smith PetscErrorCode TaoGetSolutionVector(Tao tao, Vec *X) 1227a7e14dcfSSatish Balay { 1228a7e14dcfSSatish Balay PetscFunctionBegin; 1229441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1230a7e14dcfSSatish Balay *X = tao->solution; 1231a7e14dcfSSatish Balay PetscFunctionReturn(0); 1232a7e14dcfSSatish Balay } 1233a7e14dcfSSatish Balay 1234a7e14dcfSSatish Balay /*@ 1235a7e14dcfSSatish Balay TaoGetGradientVector - Returns the vector with the current TAO gradient 1236a7e14dcfSSatish Balay 1237a7e14dcfSSatish Balay Not Collective 1238a7e14dcfSSatish Balay 1239a7e14dcfSSatish Balay Input Parameter: 1240441846f8SBarry Smith . tao - the Tao context 1241a7e14dcfSSatish Balay 1242a7e14dcfSSatish Balay Output Parameter: 1243a7e14dcfSSatish Balay . G - the current solution 1244a7e14dcfSSatish Balay 1245a7e14dcfSSatish Balay Level: intermediate 1246a7e14dcfSSatish Balay @*/ 1247441846f8SBarry Smith PetscErrorCode TaoGetGradientVector(Tao tao, Vec *G) 1248a7e14dcfSSatish Balay { 1249a7e14dcfSSatish Balay PetscFunctionBegin; 1250441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1251a7e14dcfSSatish Balay *G = tao->gradient; 1252a7e14dcfSSatish Balay PetscFunctionReturn(0); 1253a7e14dcfSSatish Balay } 1254a7e14dcfSSatish Balay 1255a7e14dcfSSatish Balay /*@ 1256a7e14dcfSSatish Balay TaoResetStatistics - Initialize the statistics used by TAO for all of the solvers. 1257a7e14dcfSSatish Balay These statistics include the iteration number, residual norms, and convergence status. 1258a7e14dcfSSatish Balay This routine gets called before solving each optimization problem. 1259a7e14dcfSSatish Balay 1260441846f8SBarry Smith Collective on Tao 1261a7e14dcfSSatish Balay 1262a7e14dcfSSatish Balay Input Parameters: 1263441846f8SBarry Smith . solver - the Tao context 1264a7e14dcfSSatish Balay 1265a7e14dcfSSatish Balay Level: developer 1266a7e14dcfSSatish Balay 1267a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve() 1268a7e14dcfSSatish Balay @*/ 1269441846f8SBarry Smith PetscErrorCode TaoResetStatistics(Tao tao) 1270a7e14dcfSSatish Balay { 1271a7e14dcfSSatish Balay PetscFunctionBegin; 1272441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1273a7e14dcfSSatish Balay tao->niter = 0; 1274a7e14dcfSSatish Balay tao->nfuncs = 0; 1275a7e14dcfSSatish Balay tao->nfuncgrads = 0; 1276a7e14dcfSSatish Balay tao->ngrads = 0; 1277a7e14dcfSSatish Balay tao->nhess = 0; 1278a7e14dcfSSatish Balay tao->njac = 0; 1279a7e14dcfSSatish Balay tao->nconstraints = 0; 1280a7e14dcfSSatish Balay tao->ksp_its = 0; 1281ae93cb3cSJason Sarich tao->ksp_tot_its = 0; 1282a7e14dcfSSatish Balay tao->reason = TAO_CONTINUE_ITERATING; 1283a7e14dcfSSatish Balay tao->residual = 0.0; 1284a7e14dcfSSatish Balay tao->cnorm = 0.0; 1285a7e14dcfSSatish Balay tao->step = 0.0; 1286a7e14dcfSSatish Balay tao->lsflag = PETSC_FALSE; 1287a7e14dcfSSatish Balay if (tao->hist_reset) tao->hist_len=0; 1288a7e14dcfSSatish Balay PetscFunctionReturn(0); 1289a7e14dcfSSatish Balay } 1290a7e14dcfSSatish Balay 1291a7e14dcfSSatish Balay /*@C 1292a7e14dcfSSatish Balay TaoSetConvergenceTest - Sets the function that is to be used to test 1293a7e14dcfSSatish Balay for convergence o fthe iterative minimization solution. The new convergence 1294a7e14dcfSSatish Balay testing routine will replace TAO's default convergence test. 1295a7e14dcfSSatish Balay 1296441846f8SBarry Smith Logically Collective on Tao 1297a7e14dcfSSatish Balay 1298a7e14dcfSSatish Balay Input Parameters: 1299441846f8SBarry Smith + tao - the Tao object 1300a7e14dcfSSatish Balay . conv - the routine to test for convergence 1301a7e14dcfSSatish Balay - ctx - [optional] context for private data for the convergence routine 130247a47007SBarry Smith (may be NULL) 1303a7e14dcfSSatish Balay 1304a7e14dcfSSatish Balay Calling sequence of conv: 1305441846f8SBarry Smith $ PetscErrorCode conv(Tao tao, void *ctx) 1306a7e14dcfSSatish Balay 1307441846f8SBarry Smith + tao - the Tao object 1308a7e14dcfSSatish Balay - ctx - [optional] convergence context 1309a7e14dcfSSatish Balay 1310e4cb33bbSBarry Smith Note: The new convergence testing routine should call TaoSetConvergedReason(). 1311a7e14dcfSSatish Balay 1312a7e14dcfSSatish Balay Level: advanced 1313a7e14dcfSSatish Balay 1314e4cb33bbSBarry Smith .seealso: TaoSetConvergedReason(), TaoGetSolutionStatus(), TaoGetTolerances(), TaoSetMonitor 1315a7e14dcfSSatish Balay 1316a7e14dcfSSatish Balay @*/ 1317441846f8SBarry Smith PetscErrorCode TaoSetConvergenceTest(Tao tao, PetscErrorCode (*conv)(Tao,void*), void *ctx) 1318a7e14dcfSSatish Balay { 1319a7e14dcfSSatish Balay PetscFunctionBegin; 1320441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1321a7e14dcfSSatish Balay (tao)->ops->convergencetest = conv; 1322a7e14dcfSSatish Balay (tao)->cnvP = ctx; 1323a7e14dcfSSatish Balay PetscFunctionReturn(0); 1324a7e14dcfSSatish Balay } 1325a7e14dcfSSatish Balay 1326a7e14dcfSSatish Balay /*@C 1327a7e14dcfSSatish Balay TaoSetMonitor - Sets an ADDITIONAL function that is to be used at every 1328a7e14dcfSSatish Balay iteration of the solver to display the iteration's 1329a7e14dcfSSatish Balay progress. 1330a7e14dcfSSatish Balay 1331441846f8SBarry Smith Logically Collective on Tao 1332a7e14dcfSSatish Balay 1333a7e14dcfSSatish Balay Input Parameters: 1334441846f8SBarry Smith + tao - the Tao solver context 1335a7e14dcfSSatish Balay . mymonitor - monitoring routine 1336a7e14dcfSSatish Balay - mctx - [optional] user-defined context for private data for the 133747a47007SBarry Smith monitor routine (may be NULL) 1338a7e14dcfSSatish Balay 1339a7e14dcfSSatish Balay Calling sequence of mymonitor: 1340441846f8SBarry Smith $ int mymonitor(Tao tao,void *mctx) 1341a7e14dcfSSatish Balay 1342441846f8SBarry Smith + tao - the Tao solver context 1343a7e14dcfSSatish Balay - mctx - [optional] monitoring context 1344a7e14dcfSSatish Balay 1345a7e14dcfSSatish Balay 1346a7e14dcfSSatish Balay Options Database Keys: 1347a7e14dcfSSatish Balay + -tao_monitor - sets TaoDefaultMonitor() 1348a7e14dcfSSatish Balay . -tao_smonitor - sets short monitor 1349a7e14dcfSSatish Balay . -tao_cmonitor - same as smonitor plus constraint norm 1350a7e14dcfSSatish Balay . -tao_view_solution - view solution at each iteration 1351a7e14dcfSSatish Balay . -tao_view_gradient - view gradient at each iteration 1352a7e14dcfSSatish Balay . -tao_view_separableobjective - view separable objective function at each iteration 1353a7e14dcfSSatish 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. 1354a7e14dcfSSatish Balay 1355a7e14dcfSSatish Balay 1356a7e14dcfSSatish Balay Notes: 1357a7e14dcfSSatish Balay Several different monitoring routines may be set by calling 1358a7e14dcfSSatish Balay TaoSetMonitor() multiple times; all will be called in the 1359a7e14dcfSSatish Balay order in which they were set. 1360a7e14dcfSSatish Balay 1361a7e14dcfSSatish Balay Fortran Notes: Only one monitor function may be set 1362a7e14dcfSSatish Balay 1363a7e14dcfSSatish Balay Level: intermediate 1364a7e14dcfSSatish Balay 1365a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoCancelMonitors(), TaoSetDestroyRoutine() 1366a7e14dcfSSatish Balay @*/ 1367441846f8SBarry Smith PetscErrorCode TaoSetMonitor(Tao tao, PetscErrorCode (*func)(Tao, void*), void *ctx,PetscErrorCode (*dest)(void**)) 1368a7e14dcfSSatish Balay { 136908d19d1fSJason Sarich PetscErrorCode ierr; 137008d19d1fSJason Sarich PetscInt i; 137108d19d1fSJason Sarich 1372a7e14dcfSSatish Balay PetscFunctionBegin; 1373441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 137447a47007SBarry Smith if (tao->numbermonitors >= MAXTAOMONITORS) SETERRQ1(PETSC_COMM_SELF,1,"Cannot attach another monitor -- max=",MAXTAOMONITORS); 137508d19d1fSJason Sarich 137608d19d1fSJason Sarich for (i=0; i<tao->numbermonitors;i++) { 137708d19d1fSJason Sarich if (func == tao->monitor[i] && dest == tao->monitordestroy[i] && ctx == tao->monitorcontext[i]) { 137808d19d1fSJason Sarich if (dest) { 137908d19d1fSJason Sarich ierr = (*dest)(&ctx);CHKERRQ(ierr); 138008d19d1fSJason Sarich } 138108d19d1fSJason Sarich PetscFunctionReturn(0); 138208d19d1fSJason Sarich } 138308d19d1fSJason Sarich } 1384a7e14dcfSSatish Balay tao->monitor[tao->numbermonitors] = func; 1385a7e14dcfSSatish Balay tao->monitorcontext[tao->numbermonitors] = ctx; 1386a7e14dcfSSatish Balay tao->monitordestroy[tao->numbermonitors] = dest; 1387a7e14dcfSSatish Balay ++tao->numbermonitors; 1388a7e14dcfSSatish Balay PetscFunctionReturn(0); 1389a7e14dcfSSatish Balay } 1390a7e14dcfSSatish Balay 1391a7e14dcfSSatish Balay /*@ 1392441846f8SBarry Smith TaoCancelMonitors - Clears all the monitor functions for a Tao object. 1393a7e14dcfSSatish Balay 1394441846f8SBarry Smith Logically Collective on Tao 1395a7e14dcfSSatish Balay 1396a7e14dcfSSatish Balay Input Parameters: 1397441846f8SBarry Smith . tao - the Tao solver context 1398a7e14dcfSSatish Balay 1399a7e14dcfSSatish Balay Options Database: 1400a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors that have been hardwired 1401a7e14dcfSSatish Balay into a code by calls to TaoSetMonitor(), but does not cancel those 1402a7e14dcfSSatish Balay set via the options database 1403a7e14dcfSSatish Balay 1404a7e14dcfSSatish Balay Notes: 1405441846f8SBarry Smith There is no way to clear one specific monitor from a Tao object. 1406a7e14dcfSSatish Balay 1407a7e14dcfSSatish Balay Level: advanced 1408a7e14dcfSSatish Balay 1409a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor() 1410a7e14dcfSSatish Balay @*/ 1411441846f8SBarry Smith PetscErrorCode TaoCancelMonitors(Tao tao) 1412a7e14dcfSSatish Balay { 1413a7e14dcfSSatish Balay PetscInt i; 1414a7e14dcfSSatish Balay PetscErrorCode ierr; 141547a47007SBarry Smith 1416a7e14dcfSSatish Balay PetscFunctionBegin; 1417441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1418a7e14dcfSSatish Balay for (i=0;i<tao->numbermonitors;i++) { 1419a7e14dcfSSatish Balay if (tao->monitordestroy[i]) { 1420a7e14dcfSSatish Balay ierr = (*tao->monitordestroy[i])(&tao->monitorcontext[i]);CHKERRQ(ierr); 1421a7e14dcfSSatish Balay } 1422a7e14dcfSSatish Balay } 1423a7e14dcfSSatish Balay tao->numbermonitors=0; 1424a7e14dcfSSatish Balay PetscFunctionReturn(0); 1425a7e14dcfSSatish Balay } 1426a7e14dcfSSatish Balay 14277fab98ebSJason Sarich /*@ 1428a7e14dcfSSatish Balay TaoDefaultMonitor - Default routine for monitoring progress of the 1429441846f8SBarry Smith Tao solvers (default). This monitor prints the function value and gradient 1430a7e14dcfSSatish Balay norm at each iteration. It can be turned on from the command line using the 1431a7e14dcfSSatish Balay -tao_monitor option 1432a7e14dcfSSatish Balay 1433441846f8SBarry Smith Collective on Tao 1434a7e14dcfSSatish Balay 1435a7e14dcfSSatish Balay Input Parameters: 1436441846f8SBarry Smith + tao - the Tao context 143747a47007SBarry Smith - ctx - PetscViewer context or NULL 1438a7e14dcfSSatish Balay 1439a7e14dcfSSatish Balay Options Database Keys: 1440a7e14dcfSSatish Balay . -tao_monitor 1441a7e14dcfSSatish Balay 1442a7e14dcfSSatish Balay Level: advanced 1443a7e14dcfSSatish Balay 1444a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1445a7e14dcfSSatish Balay @*/ 1446441846f8SBarry Smith PetscErrorCode TaoDefaultMonitor(Tao tao, void *ctx) 1447a7e14dcfSSatish Balay { 1448a7e14dcfSSatish Balay PetscErrorCode ierr; 1449a7e14dcfSSatish Balay PetscInt its; 1450a7e14dcfSSatish Balay PetscReal fct,gnorm; 14518163d661SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 145247a47007SBarry Smith 1453a7e14dcfSSatish Balay PetscFunctionBegin; 14548163d661SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1455a7e14dcfSSatish Balay its=tao->niter; 1456a7e14dcfSSatish Balay fct=tao->fc; 1457a7e14dcfSSatish Balay gnorm=tao->residual; 1458a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr); 145947a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr); 146008d19d1fSJason Sarich if (gnorm >= PETSC_INFINITY) { 146108d19d1fSJason Sarich ierr=PetscViewerASCIIPrintf(viewer," Residual: Inf \n");CHKERRQ(ierr); 146208d19d1fSJason Sarich } else { 146347a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr); 146408d19d1fSJason Sarich } 1465a7e14dcfSSatish Balay PetscFunctionReturn(0); 1466a7e14dcfSSatish Balay } 1467a7e14dcfSSatish Balay 14687fab98ebSJason Sarich /*@ 1469a7e14dcfSSatish Balay TaoDefaultSMonitor - Default routine for monitoring progress of the 1470a7e14dcfSSatish Balay solver. Same as TaoDefaultMonitor() except 1471a7e14dcfSSatish Balay it prints fewer digits of the residual as the residual gets smaller. 1472a7e14dcfSSatish Balay This is because the later digits are meaningless and are often 1473a7e14dcfSSatish Balay different on different machines; by using this routine different 1474a7e14dcfSSatish Balay machines will usually generate the same output. It can be turned on 1475a7e14dcfSSatish Balay by using the -tao_smonitor option 1476a7e14dcfSSatish Balay 1477441846f8SBarry Smith Collective on Tao 1478a7e14dcfSSatish Balay 1479a7e14dcfSSatish Balay Input Parameters: 1480441846f8SBarry Smith + tao - the Tao context 14814d4332d5SBarry Smith - ctx - PetscViewer context of type ASCII 1482a7e14dcfSSatish Balay 1483a7e14dcfSSatish Balay Options Database Keys: 1484a7e14dcfSSatish Balay . -tao_smonitor 1485a7e14dcfSSatish Balay 1486a7e14dcfSSatish Balay Level: advanced 1487a7e14dcfSSatish Balay 1488a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor() 1489a7e14dcfSSatish Balay @*/ 1490441846f8SBarry Smith PetscErrorCode TaoDefaultSMonitor(Tao tao, void *ctx) 1491a7e14dcfSSatish Balay { 1492a7e14dcfSSatish Balay PetscErrorCode ierr; 1493a7e14dcfSSatish Balay PetscInt its; 1494a7e14dcfSSatish Balay PetscReal fct,gnorm; 14954d4332d5SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 149647a47007SBarry Smith 1497a7e14dcfSSatish Balay PetscFunctionBegin; 14984d4332d5SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1499a7e14dcfSSatish Balay its=tao->niter; 1500a7e14dcfSSatish Balay fct=tao->fc; 1501a7e14dcfSSatish Balay gnorm=tao->residual; 1502a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr); 150347a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Function value %g,",(double)fct);CHKERRQ(ierr); 1504d393f493SBarry Smith if (gnorm >= PETSC_INFINITY) { 150508d19d1fSJason Sarich ierr=PetscViewerASCIIPrintf(viewer," Residual: Inf \n");CHKERRQ(ierr); 150608d19d1fSJason Sarich } else if (gnorm > 1.e-6) { 150747a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr); 1508a7e14dcfSSatish Balay } else if (gnorm > 1.e-11) { 1509a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-6 \n");CHKERRQ(ierr); 1510a7e14dcfSSatish Balay } else { 1511a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-11 \n");CHKERRQ(ierr); 1512a7e14dcfSSatish Balay } 1513a7e14dcfSSatish Balay PetscFunctionReturn(0); 1514a7e14dcfSSatish Balay } 1515a7e14dcfSSatish Balay 15167fab98ebSJason Sarich /*@ 1517a7e14dcfSSatish Balay TaoDefaultCMonitor - same as TaoDefaultMonitor() except 1518a7e14dcfSSatish Balay it prints the norm of the constraints function. It can be turned on 1519a7e14dcfSSatish Balay from the command line using the -tao_cmonitor option 1520a7e14dcfSSatish Balay 1521441846f8SBarry Smith Collective on Tao 1522a7e14dcfSSatish Balay 1523a7e14dcfSSatish Balay Input Parameters: 1524441846f8SBarry Smith + tao - the Tao context 152547a47007SBarry Smith - ctx - PetscViewer context or NULL 1526a7e14dcfSSatish Balay 1527a7e14dcfSSatish Balay Options Database Keys: 1528a7e14dcfSSatish Balay . -tao_cmonitor 1529a7e14dcfSSatish Balay 1530a7e14dcfSSatish Balay Level: advanced 1531a7e14dcfSSatish Balay 1532a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor() 1533a7e14dcfSSatish Balay @*/ 1534441846f8SBarry Smith PetscErrorCode TaoDefaultCMonitor(Tao tao, void *ctx) 1535a7e14dcfSSatish Balay { 1536a7e14dcfSSatish Balay PetscErrorCode ierr; 1537a7e14dcfSSatish Balay PetscInt its; 1538a7e14dcfSSatish Balay PetscReal fct,gnorm; 1539d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 1540a7e14dcfSSatish Balay 1541a7e14dcfSSatish Balay PetscFunctionBegin; 1542d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1543a7e14dcfSSatish Balay its=tao->niter; 1544a7e14dcfSSatish Balay fct=tao->fc; 1545a7e14dcfSSatish Balay gnorm=tao->residual; 1546a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"iter = %D,",its);CHKERRQ(ierr); 154747a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr); 154847a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Residual: %g ",(double)gnorm);CHKERRQ(ierr); 154947a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Constraint: %g \n",(double)tao->cnorm);CHKERRQ(ierr); 1550a7e14dcfSSatish Balay PetscFunctionReturn(0); 1551a7e14dcfSSatish Balay } 1552a7e14dcfSSatish Balay 1553a7e14dcfSSatish Balay /*@C 1554a7e14dcfSSatish Balay TaoSolutionMonitor - Views the solution at each iteration 1555a7e14dcfSSatish Balay It can be turned on from the command line using the 1556a7e14dcfSSatish Balay -tao_view_solution option 1557a7e14dcfSSatish Balay 1558441846f8SBarry Smith Collective on Tao 1559a7e14dcfSSatish Balay 1560a7e14dcfSSatish Balay Input Parameters: 1561441846f8SBarry Smith + tao - the Tao context 156247a47007SBarry Smith - ctx - PetscViewer context or NULL 1563a7e14dcfSSatish Balay 1564a7e14dcfSSatish Balay Options Database Keys: 1565a7e14dcfSSatish Balay . -tao_view_solution 1566a7e14dcfSSatish Balay 1567a7e14dcfSSatish Balay Level: advanced 1568a7e14dcfSSatish Balay 1569a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1570a7e14dcfSSatish Balay @*/ 1571441846f8SBarry Smith PetscErrorCode TaoSolutionMonitor(Tao tao, void *ctx) 1572a7e14dcfSSatish Balay { 1573a7e14dcfSSatish Balay PetscErrorCode ierr; 1574d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx;; 157547a47007SBarry Smith 1576a7e14dcfSSatish Balay PetscFunctionBegin; 1577d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1578a7e14dcfSSatish Balay ierr = VecView(tao->solution, viewer);CHKERRQ(ierr); 1579a7e14dcfSSatish Balay PetscFunctionReturn(0); 1580a7e14dcfSSatish Balay } 1581a7e14dcfSSatish Balay 1582a7e14dcfSSatish Balay /*@C 1583a7e14dcfSSatish Balay TaoGradientMonitor - 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 1587441846f8SBarry Smith Collective on Tao 1588a7e14dcfSSatish Balay 1589a7e14dcfSSatish Balay Input Parameters: 1590441846f8SBarry Smith + tao - the Tao context 159147a47007SBarry 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 @*/ 1600441846f8SBarry Smith PetscErrorCode TaoGradientMonitor(Tao tao, void *ctx) 1601a7e14dcfSSatish Balay { 1602a7e14dcfSSatish Balay PetscErrorCode ierr; 1603d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 160447a47007SBarry Smith 1605a7e14dcfSSatish Balay PetscFunctionBegin; 1606d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1607a7e14dcfSSatish Balay ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr); 1608a7e14dcfSSatish Balay PetscFunctionReturn(0); 1609a7e14dcfSSatish Balay } 1610a7e14dcfSSatish Balay 1611a7e14dcfSSatish Balay /*@C 1612a7e14dcfSSatish Balay TaoStepDirectionMonitor - Views the gradient at each iteration 1613a7e14dcfSSatish Balay It can be turned on from the command line using the 1614a7e14dcfSSatish Balay -tao_view_gradient option 1615a7e14dcfSSatish Balay 1616441846f8SBarry Smith Collective on Tao 1617a7e14dcfSSatish Balay 1618a7e14dcfSSatish Balay Input Parameters: 1619441846f8SBarry Smith + tao - the Tao context 162047a47007SBarry Smith - ctx - PetscViewer context or NULL 1621a7e14dcfSSatish Balay 1622a7e14dcfSSatish Balay Options Database Keys: 1623a7e14dcfSSatish Balay . -tao_view_gradient 1624a7e14dcfSSatish Balay 1625a7e14dcfSSatish Balay Level: advanced 1626a7e14dcfSSatish Balay 1627a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1628a7e14dcfSSatish Balay @*/ 1629441846f8SBarry Smith PetscErrorCode TaoStepDirectionMonitor(Tao tao, void *ctx) 1630a7e14dcfSSatish Balay { 1631a7e14dcfSSatish Balay PetscErrorCode ierr; 1632d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 1633d393f493SBarry Smith 1634a7e14dcfSSatish Balay PetscFunctionBegin; 1635d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1636a7e14dcfSSatish Balay ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr); 1637a7e14dcfSSatish Balay PetscFunctionReturn(0); 1638a7e14dcfSSatish Balay } 1639a7e14dcfSSatish Balay 1640a7e14dcfSSatish Balay /*@C 1641a7e14dcfSSatish Balay TaoDrawSolutionMonitor - Plots the solution at each iteration 1642a7e14dcfSSatish Balay It can be turned on from the command line using the 1643a7e14dcfSSatish Balay -tao_draw_solution option 1644a7e14dcfSSatish Balay 1645441846f8SBarry Smith Collective on Tao 1646a7e14dcfSSatish Balay 1647a7e14dcfSSatish Balay Input Parameters: 1648441846f8SBarry Smith + tao - the Tao context 1649*e882e171SHong Zhang - ctx - TaoMonitorDraw context 1650a7e14dcfSSatish Balay 1651a7e14dcfSSatish Balay Options Database Keys: 1652a7e14dcfSSatish Balay . -tao_draw_solution 1653a7e14dcfSSatish Balay 1654a7e14dcfSSatish Balay Level: advanced 1655a7e14dcfSSatish Balay 1656a7e14dcfSSatish Balay .seealso: TaoSolutionMonitor(), TaoSetMonitor(), TaoDrawGradientMonitor 1657a7e14dcfSSatish Balay @*/ 1658441846f8SBarry Smith PetscErrorCode TaoDrawSolutionMonitor(Tao tao, void *ctx) 1659a7e14dcfSSatish Balay { 1660a7e14dcfSSatish Balay PetscErrorCode ierr; 1661*e882e171SHong Zhang TaoMonitorDrawCtx ictx = (TaoMonitorDrawCtx)ctx; 166247a47007SBarry Smith 1663a7e14dcfSSatish Balay PetscFunctionBegin; 1664*e882e171SHong Zhang if (!(((ictx->howoften > 0) && (!(tao->niter % ictx->howoften))) || ((ictx->howoften == -1) && tao->reason))) PetscFunctionReturn(0); 1665*e882e171SHong Zhang ierr = VecView(tao->solution,ictx->viewer);CHKERRQ(ierr); 1666a7e14dcfSSatish Balay PetscFunctionReturn(0); 1667a7e14dcfSSatish Balay } 1668a7e14dcfSSatish Balay 1669a7e14dcfSSatish Balay /*@C 1670a7e14dcfSSatish Balay TaoDrawGradientMonitor - Plots the gradient at each iteration 1671a7e14dcfSSatish Balay It can be turned on from the command line using the 1672a7e14dcfSSatish Balay -tao_draw_gradient option 1673a7e14dcfSSatish Balay 1674441846f8SBarry Smith Collective on Tao 1675a7e14dcfSSatish Balay 1676a7e14dcfSSatish Balay Input Parameters: 1677441846f8SBarry Smith + tao - the Tao context 1678f55353a2SBarry Smith - ctx - PetscViewer context 1679a7e14dcfSSatish Balay 1680a7e14dcfSSatish Balay Options Database Keys: 1681a7e14dcfSSatish Balay . -tao_draw_gradient 1682a7e14dcfSSatish Balay 1683a7e14dcfSSatish Balay Level: advanced 1684a7e14dcfSSatish Balay 1685a7e14dcfSSatish Balay .seealso: TaoGradientMonitor(), TaoSetMonitor(), TaoDrawSolutionMonitor 1686a7e14dcfSSatish Balay @*/ 1687441846f8SBarry Smith PetscErrorCode TaoDrawGradientMonitor(Tao tao, void *ctx) 1688a7e14dcfSSatish Balay { 1689a7e14dcfSSatish Balay PetscErrorCode ierr; 1690*e882e171SHong Zhang TaoMonitorDrawCtx ictx = (TaoMonitorDrawCtx)ctx; 169147a47007SBarry Smith 1692a7e14dcfSSatish Balay PetscFunctionBegin; 1693*e882e171SHong Zhang if (!(((ictx->howoften > 0) && (!(tao->niter % ictx->howoften))) || ((ictx->howoften == -1) && tao->reason))) PetscFunctionReturn(0); 1694*e882e171SHong Zhang ierr = VecView(tao->gradient,ictx->viewer);CHKERRQ(ierr); 1695a7e14dcfSSatish Balay PetscFunctionReturn(0); 1696a7e14dcfSSatish Balay } 1697a7e14dcfSSatish Balay 1698a7e14dcfSSatish Balay /*@C 1699a7e14dcfSSatish Balay TaoDrawStepMonitor - Plots the step direction at each iteration 1700a7e14dcfSSatish Balay It can be turned on from the command line using the 1701a7e14dcfSSatish Balay -tao_draw_step option 1702a7e14dcfSSatish Balay 1703441846f8SBarry Smith Collective on Tao 1704a7e14dcfSSatish Balay 1705a7e14dcfSSatish Balay Input Parameters: 1706441846f8SBarry Smith + tao - the Tao context 1707f55353a2SBarry Smith - ctx - PetscViewer context 1708a7e14dcfSSatish Balay 1709a7e14dcfSSatish Balay Options Database Keys: 1710a7e14dcfSSatish Balay . -tao_draw_step 1711a7e14dcfSSatish Balay 1712a7e14dcfSSatish Balay Level: advanced 1713a7e14dcfSSatish Balay 1714a7e14dcfSSatish Balay .seealso: TaoSetMonitor(), TaoDrawSolutionMonitor 1715a7e14dcfSSatish Balay @*/ 1716441846f8SBarry Smith PetscErrorCode TaoDrawStepMonitor(Tao tao, void *ctx) 1717a7e14dcfSSatish Balay { 1718a7e14dcfSSatish Balay PetscErrorCode ierr; 1719a7e14dcfSSatish Balay PetscViewer viewer = (PetscViewer)(ctx); 172047a47007SBarry Smith 1721a7e14dcfSSatish Balay PetscFunctionBegin; 1722a7e14dcfSSatish Balay ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr); 1723a7e14dcfSSatish Balay PetscFunctionReturn(0); 1724a7e14dcfSSatish Balay } 1725a7e14dcfSSatish Balay 1726a7e14dcfSSatish Balay /*@C 1727a7e14dcfSSatish Balay TaoSeparableObjectiveMonitor - Views the separable objective function at each iteration 1728a7e14dcfSSatish Balay It can be turned on from the command line using the 1729a7e14dcfSSatish Balay -tao_view_separableobjective option 1730a7e14dcfSSatish Balay 1731441846f8SBarry Smith Collective on Tao 1732a7e14dcfSSatish Balay 1733a7e14dcfSSatish Balay Input Parameters: 1734441846f8SBarry Smith + tao - the Tao context 173547a47007SBarry Smith - ctx - PetscViewer context or NULL 1736a7e14dcfSSatish Balay 1737a7e14dcfSSatish Balay Options Database Keys: 1738a7e14dcfSSatish Balay . -tao_view_separableobjective 1739a7e14dcfSSatish Balay 1740a7e14dcfSSatish Balay Level: advanced 1741a7e14dcfSSatish Balay 1742a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1743a7e14dcfSSatish Balay @*/ 1744441846f8SBarry Smith PetscErrorCode TaoSeparableObjectiveMonitor(Tao tao, void *ctx) 1745a7e14dcfSSatish Balay { 1746a7e14dcfSSatish Balay PetscErrorCode ierr; 1747d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 174847a47007SBarry Smith 1749a7e14dcfSSatish Balay PetscFunctionBegin; 1750d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1751a7e14dcfSSatish Balay ierr = VecView(tao->sep_objective,viewer);CHKERRQ(ierr); 1752a7e14dcfSSatish Balay PetscFunctionReturn(0); 1753a7e14dcfSSatish Balay } 1754a7e14dcfSSatish Balay 17557fab98ebSJason Sarich /*@ 1756a7e14dcfSSatish Balay TaoDefaultConvergenceTest - Determines whether the solver should continue iterating 1757a7e14dcfSSatish Balay or terminate. 1758a7e14dcfSSatish Balay 1759441846f8SBarry Smith Collective on Tao 1760a7e14dcfSSatish Balay 1761a7e14dcfSSatish Balay Input Parameters: 1762441846f8SBarry Smith + tao - the Tao context 1763a7e14dcfSSatish Balay - dummy - unused dummy context 1764a7e14dcfSSatish Balay 1765a7e14dcfSSatish Balay Output Parameter: 1766a7e14dcfSSatish Balay . reason - for terminating 1767a7e14dcfSSatish Balay 1768a7e14dcfSSatish Balay Notes: 1769a7e14dcfSSatish Balay This routine checks the residual in the optimality conditions, the 1770a7e14dcfSSatish Balay relative residual in the optimity conditions, the number of function 1771a7e14dcfSSatish Balay evaluations, and the function value to test convergence. Some 1772a7e14dcfSSatish Balay solvers may use different convergence routines. 1773a7e14dcfSSatish Balay 1774a7e14dcfSSatish Balay Level: developer 1775a7e14dcfSSatish Balay 1776e4cb33bbSBarry Smith .seealso: TaoSetTolerances(),TaoGetConvergedReason(),TaoSetConvergedReason() 1777a7e14dcfSSatish Balay @*/ 1778a7e14dcfSSatish Balay 1779441846f8SBarry Smith PetscErrorCode TaoDefaultConvergenceTest(Tao tao,void *dummy) 1780a7e14dcfSSatish Balay { 1781a7e14dcfSSatish Balay PetscInt niter=tao->niter, nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads); 1782a7e14dcfSSatish Balay PetscInt max_funcs=tao->max_funcs; 1783a7e14dcfSSatish Balay PetscReal gnorm=tao->residual, gnorm0=tao->gnorm0; 1784a7e14dcfSSatish Balay PetscReal f=tao->fc, steptol=tao->steptol,trradius=tao->step; 1785a7e14dcfSSatish Balay PetscReal gatol=tao->gatol,grtol=tao->grtol,gttol=tao->gttol; 1786e52336cbSBarry Smith PetscReal catol=tao->catol,crtol=tao->crtol; 1787e52336cbSBarry Smith PetscReal fmin=tao->fmin, cnorm=tao->cnorm; 1788e4cb33bbSBarry Smith TaoConvergedReason reason=tao->reason; 1789a7e14dcfSSatish Balay PetscErrorCode ierr; 1790a7e14dcfSSatish Balay 1791a7e14dcfSSatish Balay PetscFunctionBegin; 1792441846f8SBarry Smith PetscValidHeaderSpecific(tao, TAO_CLASSID,1); 1793a7e14dcfSSatish Balay if (reason != TAO_CONTINUE_ITERATING) { 1794a7e14dcfSSatish Balay PetscFunctionReturn(0); 1795a7e14dcfSSatish Balay } 1796a7e14dcfSSatish Balay 1797a7e14dcfSSatish Balay if (PetscIsInfOrNanReal(f)) { 1798a7e14dcfSSatish Balay ierr = PetscInfo(tao,"Failed to converged, function value is Inf or NaN\n");CHKERRQ(ierr); 1799a7e14dcfSSatish Balay reason = TAO_DIVERGED_NAN; 1800a7e14dcfSSatish Balay } else if (f <= fmin && cnorm <=catol) { 180147a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to function value %g < minimum function value %g\n", (double)f,(double)fmin);CHKERRQ(ierr); 1802a7e14dcfSSatish Balay reason = TAO_CONVERGED_MINF; 1803a7e14dcfSSatish Balay } else if (gnorm<= gatol && cnorm <=catol) { 180447a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to residual norm ||g(X)||=%g < %g\n",(double)gnorm,(double)gatol);CHKERRQ(ierr); 1805a7e14dcfSSatish Balay reason = TAO_CONVERGED_GATOL; 1806a7e14dcfSSatish Balay } else if ( f!=0 && PetscAbsReal(gnorm/f) <= grtol && cnorm <= crtol) { 180747a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to residual ||g(X)||/|f(X)| =%g < %g\n",(double)(gnorm/f),(double)grtol);CHKERRQ(ierr); 1808a7e14dcfSSatish Balay reason = TAO_CONVERGED_GRTOL; 1809e1d16bb9SBarry Smith } else if (gnorm0 != 0 && ((gttol == 0 && gnorm == 0) || gnorm/gnorm0 < gttol) && cnorm <= crtol) { 181047a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to relative residual norm ||g(X)||/||g(X0)|| = %g < %g\n",(double)(gnorm/gnorm0),(double)gttol);CHKERRQ(ierr); 1811a7e14dcfSSatish Balay reason = TAO_CONVERGED_GTTOL; 1812a7e14dcfSSatish Balay } else if (nfuncs > max_funcs){ 1813a7e14dcfSSatish Balay ierr = PetscInfo2(tao,"Exceeded maximum number of function evaluations: %D > %D\n", nfuncs,max_funcs);CHKERRQ(ierr); 1814a7e14dcfSSatish Balay reason = TAO_DIVERGED_MAXFCN; 1815a7e14dcfSSatish Balay } else if ( tao->lsflag != 0 ){ 1816a7e14dcfSSatish Balay ierr = PetscInfo(tao,"Tao Line Search failure.\n");CHKERRQ(ierr); 1817a7e14dcfSSatish Balay reason = TAO_DIVERGED_LS_FAILURE; 1818a7e14dcfSSatish Balay } else if (trradius < steptol && niter > 0){ 181947a47007SBarry Smith ierr = PetscInfo2(tao,"Trust region/step size too small: %g < %g\n", (double)trradius,(double)steptol);CHKERRQ(ierr); 1820a7e14dcfSSatish Balay reason = TAO_CONVERGED_STEPTOL; 1821a7e14dcfSSatish Balay } else if (niter > tao->max_it) { 1822a7e14dcfSSatish Balay ierr = PetscInfo2(tao,"Exceeded maximum number of iterations: %D > %D\n",niter,tao->max_it);CHKERRQ(ierr); 1823a7e14dcfSSatish Balay reason = TAO_DIVERGED_MAXITS; 1824a7e14dcfSSatish Balay } else { 1825a7e14dcfSSatish Balay reason = TAO_CONTINUE_ITERATING; 1826a7e14dcfSSatish Balay } 1827a7e14dcfSSatish Balay tao->reason = reason; 1828a7e14dcfSSatish Balay PetscFunctionReturn(0); 1829a7e14dcfSSatish Balay } 1830a7e14dcfSSatish Balay 1831a7e14dcfSSatish Balay /*@C 1832a7e14dcfSSatish Balay TaoSetOptionsPrefix - Sets the prefix used for searching for all 1833a7e14dcfSSatish Balay TAO options in the database. 1834a7e14dcfSSatish Balay 1835a7e14dcfSSatish Balay 1836441846f8SBarry Smith Logically Collective on Tao 1837a7e14dcfSSatish Balay 1838a7e14dcfSSatish Balay Input Parameters: 1839441846f8SBarry Smith + tao - the Tao context 1840a7e14dcfSSatish Balay - prefix - the prefix string to prepend to all TAO option requests 1841a7e14dcfSSatish Balay 1842a7e14dcfSSatish Balay Notes: 1843a7e14dcfSSatish Balay A hyphen (-) must NOT be given at the beginning of the prefix name. 1844a7e14dcfSSatish Balay The first character of all runtime options is AUTOMATICALLY the hyphen. 1845a7e14dcfSSatish Balay 1846a7e14dcfSSatish Balay For example, to distinguish between the runtime options for two 1847a7e14dcfSSatish Balay different TAO solvers, one could call 1848a7e14dcfSSatish Balay .vb 1849a7e14dcfSSatish Balay TaoSetOptionsPrefix(tao1,"sys1_") 1850a7e14dcfSSatish Balay TaoSetOptionsPrefix(tao2,"sys2_") 1851a7e14dcfSSatish Balay .ve 1852a7e14dcfSSatish Balay 1853a7e14dcfSSatish Balay This would enable use of different options for each system, such as 1854a7e14dcfSSatish Balay .vb 1855a7e14dcfSSatish Balay -sys1_tao_method blmvm -sys1_tao_gtol 1.e-3 1856a7e14dcfSSatish Balay -sys2_tao_method lmvm -sys2_tao_gtol 1.e-4 1857a7e14dcfSSatish Balay .ve 1858a7e14dcfSSatish Balay 1859a7e14dcfSSatish Balay 1860a7e14dcfSSatish Balay Level: advanced 1861a7e14dcfSSatish Balay 1862a7e14dcfSSatish Balay .seealso: TaoAppendOptionsPrefix(), TaoGetOptionsPrefix() 1863a7e14dcfSSatish Balay @*/ 1864a7e14dcfSSatish Balay 1865441846f8SBarry Smith PetscErrorCode TaoSetOptionsPrefix(Tao tao, const char p[]) 1866a7e14dcfSSatish Balay { 1867a7e14dcfSSatish Balay PetscErrorCode ierr; 186847a47007SBarry Smith 1869a7e14dcfSSatish Balay PetscFunctionBegin; 1870a7e14dcfSSatish Balay ierr = PetscObjectSetOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr); 1871a7e14dcfSSatish Balay if (tao->linesearch) { 1872a7e14dcfSSatish Balay ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr); 1873a7e14dcfSSatish Balay } 1874a7e14dcfSSatish Balay if (tao->ksp) { 1875a7e14dcfSSatish Balay ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr); 1876a7e14dcfSSatish Balay } 1877a7e14dcfSSatish Balay PetscFunctionReturn(0); 1878a7e14dcfSSatish Balay } 1879a7e14dcfSSatish Balay 1880a7e14dcfSSatish Balay /*@C 1881a7e14dcfSSatish Balay TaoAppendOptionsPrefix - Appends to the prefix used for searching for all 1882a7e14dcfSSatish Balay TAO options in the database. 1883a7e14dcfSSatish Balay 1884a7e14dcfSSatish Balay 1885441846f8SBarry Smith Logically Collective on Tao 1886a7e14dcfSSatish Balay 1887a7e14dcfSSatish Balay Input Parameters: 1888441846f8SBarry Smith + tao - the Tao solver context 1889a7e14dcfSSatish Balay - prefix - the prefix string to prepend to all TAO option requests 1890a7e14dcfSSatish Balay 1891a7e14dcfSSatish Balay Notes: 1892a7e14dcfSSatish Balay A hyphen (-) must NOT be given at the beginning of the prefix name. 1893a7e14dcfSSatish Balay The first character of all runtime options is AUTOMATICALLY the hyphen. 1894a7e14dcfSSatish Balay 1895a7e14dcfSSatish Balay 1896a7e14dcfSSatish Balay Level: advanced 1897a7e14dcfSSatish Balay 1898a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoGetOptionsPrefix() 1899a7e14dcfSSatish Balay @*/ 1900441846f8SBarry Smith PetscErrorCode TaoAppendOptionsPrefix(Tao tao, const char p[]) 1901a7e14dcfSSatish Balay { 1902a7e14dcfSSatish Balay PetscErrorCode ierr; 190347a47007SBarry Smith 1904a7e14dcfSSatish Balay PetscFunctionBegin; 1905a7e14dcfSSatish Balay ierr = PetscObjectAppendOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr); 1906a7e14dcfSSatish Balay if (tao->linesearch) { 1907a7e14dcfSSatish Balay ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr); 1908a7e14dcfSSatish Balay } 1909a7e14dcfSSatish Balay if (tao->ksp) { 1910a7e14dcfSSatish Balay ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr); 1911a7e14dcfSSatish Balay } 1912a7e14dcfSSatish Balay PetscFunctionReturn(0); 1913a7e14dcfSSatish Balay } 1914a7e14dcfSSatish Balay 1915a7e14dcfSSatish Balay /*@C 1916a7e14dcfSSatish Balay TaoGetOptionsPrefix - Gets the prefix used for searching for all 1917a7e14dcfSSatish Balay TAO options in the database 1918a7e14dcfSSatish Balay 1919a7e14dcfSSatish Balay Not Collective 1920a7e14dcfSSatish Balay 1921a7e14dcfSSatish Balay Input Parameters: 1922441846f8SBarry Smith . tao - the Tao context 1923a7e14dcfSSatish Balay 1924a7e14dcfSSatish Balay Output Parameters: 1925a7e14dcfSSatish Balay . prefix - pointer to the prefix string used is returned 1926a7e14dcfSSatish Balay 1927a7e14dcfSSatish Balay Notes: On the fortran side, the user should pass in a string 'prefix' of 1928a7e14dcfSSatish Balay sufficient length to hold the prefix. 1929a7e14dcfSSatish Balay 1930a7e14dcfSSatish Balay Level: advanced 1931a7e14dcfSSatish Balay 1932a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoAppendOptionsPrefix() 1933a7e14dcfSSatish Balay @*/ 1934441846f8SBarry Smith PetscErrorCode TaoGetOptionsPrefix(Tao tao, const char *p[]) 1935a7e14dcfSSatish Balay { 193647a47007SBarry Smith return PetscObjectGetOptionsPrefix((PetscObject)tao,p); 1937a7e14dcfSSatish Balay } 1938a7e14dcfSSatish Balay 1939a7e14dcfSSatish Balay /*@C 1940a7e14dcfSSatish Balay TaoSetType - Sets the method for the unconstrained minimization solver. 1941a7e14dcfSSatish Balay 1942441846f8SBarry Smith Collective on Tao 1943a7e14dcfSSatish Balay 1944a7e14dcfSSatish Balay Input Parameters: 1945441846f8SBarry Smith + solver - the Tao solver context 1946a7e14dcfSSatish Balay - type - a known method 1947a7e14dcfSSatish Balay 1948a7e14dcfSSatish Balay Options Database Key: 194958417fe7SBarry Smith . -tao_type <type> - Sets the method; use -help for a list 195058417fe7SBarry Smith of available methods (for instance, "-tao_type lmvm" or "-tao_type tron") 1951a7e14dcfSSatish Balay 1952a7e14dcfSSatish Balay Available methods include: 195358417fe7SBarry Smith + nls - Newton's method with line search for unconstrained minimization 195458417fe7SBarry Smith . ntr - Newton's method with trust region for unconstrained minimization 195558417fe7SBarry Smith . ntl - Newton's method with trust region, line search for unconstrained minimization 195658417fe7SBarry Smith . lmvm - Limited memory variable metric method for unconstrained minimization 195758417fe7SBarry Smith . cg - Nonlinear conjugate gradient method for unconstrained minimization 195858417fe7SBarry Smith . nm - Nelder-Mead algorithm for derivate-free unconstrained minimization 195958417fe7SBarry Smith . tron - Newton Trust Region method for bound constrained minimization 196058417fe7SBarry Smith . gpcg - Newton Trust Region method for quadratic bound constrained minimization 196158417fe7SBarry Smith . blmvm - Limited memory variable metric method for bound constrained minimization 19621eb8069cSJason Sarich - pounders - Model-based algorithm pounder extended for nonlinear least squares 1963a7e14dcfSSatish Balay 1964a7e14dcfSSatish Balay Level: intermediate 1965a7e14dcfSSatish Balay 19661eb8069cSJason Sarich .seealso: TaoCreate(), TaoGetType(), TaoType 1967a7e14dcfSSatish Balay 1968a7e14dcfSSatish Balay @*/ 1969441846f8SBarry Smith PetscErrorCode TaoSetType(Tao tao, const TaoType type) 1970a7e14dcfSSatish Balay { 1971a7e14dcfSSatish Balay PetscErrorCode ierr; 1972441846f8SBarry Smith PetscErrorCode (*create_xxx)(Tao); 1973a7e14dcfSSatish Balay PetscBool issame; 1974a7e14dcfSSatish Balay 1975a7e14dcfSSatish Balay PetscFunctionBegin; 1976441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1977a7e14dcfSSatish Balay 1978a7e14dcfSSatish Balay ierr = PetscObjectTypeCompare((PetscObject)tao,type,&issame);CHKERRQ(ierr); 1979a7e14dcfSSatish Balay if (issame) PetscFunctionReturn(0); 1980a7e14dcfSSatish Balay 1981441846f8SBarry Smith ierr = PetscFunctionListFind(TaoList, type, (void(**)(void))&create_xxx);CHKERRQ(ierr); 1982441846f8SBarry Smith if (!create_xxx) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested Tao type %s",type); 1983a7e14dcfSSatish Balay 1984a7e14dcfSSatish Balay /* Destroy the existing solver information */ 1985a7e14dcfSSatish Balay if (tao->ops->destroy) { 1986a7e14dcfSSatish Balay ierr = (*tao->ops->destroy)(tao);CHKERRQ(ierr); 1987a7e14dcfSSatish Balay } 1988a7e14dcfSSatish Balay ierr = KSPDestroy(&tao->ksp);CHKERRQ(ierr); 1989a7e14dcfSSatish Balay ierr = TaoLineSearchDestroy(&tao->linesearch);CHKERRQ(ierr); 1990a7e14dcfSSatish Balay ierr = VecDestroy(&tao->gradient);CHKERRQ(ierr); 1991a7e14dcfSSatish Balay ierr = VecDestroy(&tao->stepdirection);CHKERRQ(ierr); 1992a7e14dcfSSatish Balay 1993a7e14dcfSSatish Balay tao->ops->setup = 0; 1994a7e14dcfSSatish Balay tao->ops->solve = 0; 1995a7e14dcfSSatish Balay tao->ops->view = 0; 1996a7e14dcfSSatish Balay tao->ops->setfromoptions = 0; 1997a7e14dcfSSatish Balay tao->ops->destroy = 0; 1998a7e14dcfSSatish Balay 1999a7e14dcfSSatish Balay tao->setupcalled = PETSC_FALSE; 2000a7e14dcfSSatish Balay 2001a7e14dcfSSatish Balay ierr = (*create_xxx)(tao);CHKERRQ(ierr); 2002a7e14dcfSSatish Balay ierr = PetscObjectChangeTypeName((PetscObject)tao,type);CHKERRQ(ierr); 2003a7e14dcfSSatish Balay PetscFunctionReturn(0); 2004a7e14dcfSSatish Balay } 200547a47007SBarry Smith 2006a7e14dcfSSatish Balay /*MC 2007441846f8SBarry Smith TaoRegister - Adds a method to the TAO package for unconstrained minimization. 2008a7e14dcfSSatish Balay 2009a7e14dcfSSatish Balay Synopsis: 2010441846f8SBarry Smith TaoRegister(char *name_solver,char *path,char *name_Create,int (*routine_Create)(Tao)) 2011a7e14dcfSSatish Balay 2012a7e14dcfSSatish Balay Not collective 2013a7e14dcfSSatish Balay 2014a7e14dcfSSatish Balay Input Parameters: 2015a7e14dcfSSatish Balay + sname - name of a new user-defined solver 2016a7e14dcfSSatish Balay - func - routine to Create method context 2017a7e14dcfSSatish Balay 2018a7e14dcfSSatish Balay Notes: 2019441846f8SBarry Smith TaoRegister() may be called multiple times to add several user-defined solvers. 2020a7e14dcfSSatish Balay 2021a7e14dcfSSatish Balay Sample usage: 2022a7e14dcfSSatish Balay .vb 2023441846f8SBarry Smith TaoRegister("my_solver",MySolverCreate); 2024a7e14dcfSSatish Balay .ve 2025a7e14dcfSSatish Balay 2026a7e14dcfSSatish Balay Then, your solver can be chosen with the procedural interface via 2027a7e14dcfSSatish Balay $ TaoSetType(tao,"my_solver") 2028a7e14dcfSSatish Balay or at runtime via the option 202958417fe7SBarry Smith $ -tao_type my_solver 2030a7e14dcfSSatish Balay 2031a7e14dcfSSatish Balay Level: advanced 2032a7e14dcfSSatish Balay 2033441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegisterDestroy() 2034a7e14dcfSSatish Balay M*/ 2035441846f8SBarry Smith PetscErrorCode TaoRegister(const char sname[], PetscErrorCode (*func)(Tao)) 2036a7e14dcfSSatish Balay { 2037a7e14dcfSSatish Balay PetscErrorCode ierr; 2038a7e14dcfSSatish Balay 2039a7e14dcfSSatish Balay PetscFunctionBegin; 2040441846f8SBarry Smith ierr = PetscFunctionListAdd(&TaoList,sname, (void (*)(void))func);CHKERRQ(ierr); 2041a7e14dcfSSatish Balay PetscFunctionReturn(0); 2042a7e14dcfSSatish Balay } 2043a7e14dcfSSatish Balay 2044a7e14dcfSSatish Balay /*@C 2045441846f8SBarry Smith TaoRegisterDestroy - Frees the list of minimization solvers that were 2046441846f8SBarry Smith registered by TaoRegisterDynamic(). 2047a7e14dcfSSatish Balay 2048a7e14dcfSSatish Balay Not Collective 2049a7e14dcfSSatish Balay 2050a7e14dcfSSatish Balay Level: advanced 2051a7e14dcfSSatish Balay 2052441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegister() 2053a7e14dcfSSatish Balay @*/ 2054441846f8SBarry Smith PetscErrorCode TaoRegisterDestroy(void) 2055a7e14dcfSSatish Balay { 2056a7e14dcfSSatish Balay PetscErrorCode ierr; 2057a7e14dcfSSatish Balay PetscFunctionBegin; 2058441846f8SBarry Smith ierr = PetscFunctionListDestroy(&TaoList);CHKERRQ(ierr); 2059441846f8SBarry Smith TaoRegisterAllCalled = PETSC_FALSE; 2060a7e14dcfSSatish Balay PetscFunctionReturn(0); 2061a7e14dcfSSatish Balay } 206247a47007SBarry Smith 20638931d482SJason Sarich /*@ 20648931d482SJason Sarich TaoGetIterationNumber - Gets the number of Tao iterations completed 20658931d482SJason Sarich at this time. 20668931d482SJason Sarich 20678931d482SJason Sarich Not Collective 20688931d482SJason Sarich 20698931d482SJason Sarich Input Parameter: 20708931d482SJason Sarich . tao - Tao context 20718931d482SJason Sarich 20728931d482SJason Sarich Output Parameter: 20738931d482SJason Sarich . iter - iteration number 20748931d482SJason Sarich 20758931d482SJason Sarich Notes: 20768931d482SJason Sarich For example, during the computation of iteration 2 this would return 1. 20778931d482SJason Sarich 20788931d482SJason Sarich 20798931d482SJason Sarich Level: intermediate 20808931d482SJason Sarich 20818931d482SJason Sarich .keywords: Tao, nonlinear, get, iteration, number, 20828931d482SJason Sarich 20838931d482SJason Sarich .seealso: TaoGetLinearSolveIterations() 20848931d482SJason Sarich @*/ 20858931d482SJason Sarich PetscErrorCode TaoGetIterationNumber(Tao tao,PetscInt *iter) 20868931d482SJason Sarich { 20878931d482SJason Sarich PetscFunctionBegin; 20888931d482SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 20898931d482SJason Sarich PetscValidIntPointer(iter,2); 20908931d482SJason Sarich *iter = tao->niter; 20918931d482SJason Sarich PetscFunctionReturn(0); 20928931d482SJason Sarich } 20938931d482SJason Sarich 20948931d482SJason Sarich /*@ 20958931d482SJason Sarich TaoSetIterationNumber - Sets the current iteration number. 20968931d482SJason Sarich 20978931d482SJason Sarich Not Collective 20988931d482SJason Sarich 20998931d482SJason Sarich Input Parameter: 21008931d482SJason Sarich . tao - Tao context 21018931d482SJason Sarich . iter - iteration number 21028931d482SJason Sarich 21038931d482SJason Sarich Level: developer 21048931d482SJason Sarich 21058931d482SJason Sarich .keywords: Tao, nonlinear, set, iteration, number, 21068931d482SJason Sarich 21078931d482SJason Sarich .seealso: TaoGetLinearSolveIterations() 21088931d482SJason Sarich @*/ 21098931d482SJason Sarich PetscErrorCode TaoSetIterationNumber(Tao tao,PetscInt iter) 21108931d482SJason Sarich { 21118931d482SJason Sarich PetscErrorCode ierr; 21128931d482SJason Sarich 21138931d482SJason Sarich PetscFunctionBegin; 21148931d482SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 21158931d482SJason Sarich ierr = PetscObjectSAWsTakeAccess((PetscObject)tao);CHKERRQ(ierr); 21168931d482SJason Sarich tao->niter = iter; 21178931d482SJason Sarich ierr = PetscObjectSAWsGrantAccess((PetscObject)tao);CHKERRQ(ierr); 21188931d482SJason Sarich PetscFunctionReturn(0); 21198931d482SJason Sarich } 21208931d482SJason Sarich 21218931d482SJason Sarich /*@ 21228931d482SJason Sarich TaoGetTotalIterationNumber - Gets the total number of Tao iterations 21238931d482SJason Sarich completed. This number keeps accumulating if multiple solves 21248931d482SJason Sarich are called with the Tao object. 21258931d482SJason Sarich 21268931d482SJason Sarich Not Collective 21278931d482SJason Sarich 21288931d482SJason Sarich Input Parameter: 21298931d482SJason Sarich . tao - Tao context 21308931d482SJason Sarich 21318931d482SJason Sarich Output Parameter: 21328931d482SJason Sarich . iter - iteration number 21338931d482SJason Sarich 21348931d482SJason Sarich Notes: 21358931d482SJason Sarich The total iteration count is updated after each solve, if there is a current 21368931d482SJason Sarich TaoSolve() in progress then those iterations are not yet counted. 21378931d482SJason Sarich 21388931d482SJason Sarich Level: intermediate 21398931d482SJason Sarich 21408931d482SJason Sarich .keywords: Tao, nonlinear, get, iteration, number, 21418931d482SJason Sarich 21428931d482SJason Sarich .seealso: TaoGetLinearSolveIterations() 21438931d482SJason Sarich @*/ 21448931d482SJason Sarich PetscErrorCode TaoGetTotalIterationNumber(Tao tao,PetscInt *iter) 21458931d482SJason Sarich { 21468931d482SJason Sarich PetscFunctionBegin; 21478931d482SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 21488931d482SJason Sarich PetscValidIntPointer(iter,2); 21498931d482SJason Sarich *iter = tao->ntotalits; 21508931d482SJason Sarich PetscFunctionReturn(0); 21518931d482SJason Sarich } 21528931d482SJason Sarich 21538931d482SJason Sarich /*@ 21548931d482SJason Sarich TaoSetTotalIterationNumber - Sets the current total iteration number. 21558931d482SJason Sarich 21568931d482SJason Sarich Not Collective 21578931d482SJason Sarich 21588931d482SJason Sarich Input Parameter: 21598931d482SJason Sarich . tao - Tao context 21608931d482SJason Sarich . iter - iteration number 21618931d482SJason Sarich 21628931d482SJason Sarich Level: developer 21638931d482SJason Sarich 21648931d482SJason Sarich .keywords: Tao, nonlinear, set, iteration, number, 21658931d482SJason Sarich 21668931d482SJason Sarich .seealso: TaoGetLinearSolveIterations() 21678931d482SJason Sarich @*/ 21688931d482SJason Sarich PetscErrorCode TaoSetTotalIterationNumber(Tao tao,PetscInt iter) 21698931d482SJason Sarich { 21708931d482SJason Sarich PetscErrorCode ierr; 21718931d482SJason Sarich 21728931d482SJason Sarich PetscFunctionBegin; 21738931d482SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 21748931d482SJason Sarich ierr = PetscObjectSAWsTakeAccess((PetscObject)tao);CHKERRQ(ierr); 21758931d482SJason Sarich tao->ntotalits = iter; 21768931d482SJason Sarich ierr = PetscObjectSAWsGrantAccess((PetscObject)tao);CHKERRQ(ierr); 21778931d482SJason Sarich PetscFunctionReturn(0); 21788931d482SJason Sarich } 21798931d482SJason Sarich 2180a7e14dcfSSatish Balay /*@ 2181e4cb33bbSBarry Smith TaoSetConvergedReason - Sets the termination flag on a Tao object 2182a7e14dcfSSatish Balay 2183441846f8SBarry Smith Logically Collective on Tao 2184a7e14dcfSSatish Balay 2185a7e14dcfSSatish Balay Input Parameters: 2186441846f8SBarry Smith + tao - the Tao context 2187a7e14dcfSSatish Balay - reason - one of 2188a7e14dcfSSatish Balay $ TAO_CONVERGED_ATOL (2), 2189a7e14dcfSSatish Balay $ TAO_CONVERGED_RTOL (3), 2190a7e14dcfSSatish Balay $ TAO_CONVERGED_STEPTOL (4), 2191a7e14dcfSSatish Balay $ TAO_CONVERGED_MINF (5), 2192a7e14dcfSSatish Balay $ TAO_CONVERGED_USER (6), 2193a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXITS (-2), 2194a7e14dcfSSatish Balay $ TAO_DIVERGED_NAN (-4), 2195a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXFCN (-5), 2196a7e14dcfSSatish Balay $ TAO_DIVERGED_LS_FAILURE (-6), 2197a7e14dcfSSatish Balay $ TAO_DIVERGED_TR_REDUCTION (-7), 2198a7e14dcfSSatish Balay $ TAO_DIVERGED_USER (-8), 2199a7e14dcfSSatish Balay $ TAO_CONTINUE_ITERATING (0) 2200a7e14dcfSSatish Balay 2201a7e14dcfSSatish Balay Level: intermediate 2202a7e14dcfSSatish Balay 2203a7e14dcfSSatish Balay @*/ 2204e4cb33bbSBarry Smith PetscErrorCode TaoSetConvergedReason(Tao tao, TaoConvergedReason reason) 2205a7e14dcfSSatish Balay { 2206441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2207a7e14dcfSSatish Balay PetscFunctionBegin; 2208a7e14dcfSSatish Balay tao->reason = reason; 2209a7e14dcfSSatish Balay PetscFunctionReturn(0); 2210a7e14dcfSSatish Balay } 2211a7e14dcfSSatish Balay 2212a7e14dcfSSatish Balay /*@ 2213e4cb33bbSBarry Smith TaoGetConvergedReason - Gets the reason the Tao iteration was stopped. 2214a7e14dcfSSatish Balay 2215a7e14dcfSSatish Balay Not Collective 2216a7e14dcfSSatish Balay 2217a7e14dcfSSatish Balay Input Parameter: 2218441846f8SBarry Smith . tao - the Tao solver context 2219a7e14dcfSSatish Balay 2220a7e14dcfSSatish Balay Output Parameter: 2221a7e14dcfSSatish Balay . reason - one of 2222a7e14dcfSSatish Balay $ TAO_CONVERGED_GATOL (3) ||g(X)|| < gatol 2223a7e14dcfSSatish Balay $ TAO_CONVERGED_GRTOL (4) ||g(X)|| / f(X) < grtol 2224a7e14dcfSSatish Balay $ TAO_CONVERGED_GTTOL (5) ||g(X)|| / ||g(X0)|| < gttol 2225a7e14dcfSSatish Balay $ TAO_CONVERGED_STEPTOL (6) step size small 2226a7e14dcfSSatish Balay $ TAO_CONVERGED_MINF (7) F < F_min 2227a7e14dcfSSatish Balay $ TAO_CONVERGED_USER (8) User defined 2228a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXITS (-2) its > maxits 2229a7e14dcfSSatish Balay $ TAO_DIVERGED_NAN (-4) Numerical problems 2230a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXFCN (-5) fevals > max_funcsals 2231a7e14dcfSSatish Balay $ TAO_DIVERGED_LS_FAILURE (-6) line search failure 2232a7e14dcfSSatish Balay $ TAO_DIVERGED_TR_REDUCTION (-7) trust region failure 2233a7e14dcfSSatish Balay $ TAO_DIVERGED_USER(-8) (user defined) 2234a7e14dcfSSatish Balay $ TAO_CONTINUE_ITERATING (0) 2235a7e14dcfSSatish Balay 2236a7e14dcfSSatish Balay where 2237a7e14dcfSSatish Balay + X - current solution 2238a7e14dcfSSatish Balay . X0 - initial guess 2239a7e14dcfSSatish Balay . f(X) - current function value 2240a7e14dcfSSatish Balay . f(X*) - true solution (estimated) 2241a7e14dcfSSatish Balay . g(X) - current gradient 2242a7e14dcfSSatish Balay . its - current iterate number 2243a7e14dcfSSatish Balay . maxits - maximum number of iterates 2244a7e14dcfSSatish Balay . fevals - number of function evaluations 2245a7e14dcfSSatish Balay - max_funcsals - maximum number of function evaluations 2246a7e14dcfSSatish Balay 2247a7e14dcfSSatish Balay Level: intermediate 2248a7e14dcfSSatish Balay 2249a7e14dcfSSatish Balay .seealso: TaoSetConvergenceTest(), TaoSetTolerances() 2250a7e14dcfSSatish Balay 2251a7e14dcfSSatish Balay @*/ 2252e4cb33bbSBarry Smith PetscErrorCode TaoGetConvergedReason(Tao tao, TaoConvergedReason *reason) 2253a7e14dcfSSatish Balay { 2254a7e14dcfSSatish Balay PetscFunctionBegin; 2255441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2256a7e14dcfSSatish Balay PetscValidPointer(reason,2); 2257a7e14dcfSSatish Balay *reason = tao->reason; 2258a7e14dcfSSatish Balay PetscFunctionReturn(0); 2259a7e14dcfSSatish Balay } 2260a7e14dcfSSatish Balay 2261a7e14dcfSSatish Balay /*@ 2262a7e14dcfSSatish Balay TaoGetSolutionStatus - Get the current iterate, objective value, 2263a7e14dcfSSatish Balay residual, infeasibility, and termination 2264a7e14dcfSSatish Balay 2265a7e14dcfSSatish Balay Not Collective 2266a7e14dcfSSatish Balay 2267a7e14dcfSSatish Balay Input Parameters: 2268441846f8SBarry Smith . tao - the Tao context 2269a7e14dcfSSatish Balay 2270a7e14dcfSSatish Balay Output Parameters: 2271a7e14dcfSSatish Balay + iterate - the current iterate number (>=0) 2272a7e14dcfSSatish Balay . f - the current function value 227358417fe7SBarry Smith . gnorm - the square of the gradient norm, duality gap, or other measure indicating distance from optimality. 2274a7e14dcfSSatish Balay . cnorm - the infeasibility of the current solution with regard to the constraints. 2275a7e14dcfSSatish Balay . xdiff - the step length or trust region radius of the most recent iterate. 2276a7e14dcfSSatish Balay - reason - The termination reason, which can equal TAO_CONTINUE_ITERATING 2277a7e14dcfSSatish Balay 2278a7e14dcfSSatish Balay Level: intermediate 2279a7e14dcfSSatish Balay 2280a7e14dcfSSatish Balay Note: 2281a7e14dcfSSatish Balay TAO returns the values set by the solvers in the routine TaoMonitor(). 2282a7e14dcfSSatish Balay 2283a7e14dcfSSatish Balay Note: 228447a47007SBarry Smith If any of the output arguments are set to NULL, no corresponding value will be returned. 2285a7e14dcfSSatish Balay 2286e4cb33bbSBarry Smith .seealso: TaoMonitor(), TaoGetConvergedReason() 2287a7e14dcfSSatish Balay @*/ 2288e4cb33bbSBarry Smith PetscErrorCode TaoGetSolutionStatus(Tao tao, PetscInt *its, PetscReal *f, PetscReal *gnorm, PetscReal *cnorm, PetscReal *xdiff, TaoConvergedReason *reason) 2289a7e14dcfSSatish Balay { 2290a7e14dcfSSatish Balay PetscFunctionBegin; 2291a7e14dcfSSatish Balay if (its) *its=tao->niter; 2292a7e14dcfSSatish Balay if (f) *f=tao->fc; 2293a7e14dcfSSatish Balay if (gnorm) *gnorm=tao->residual; 2294a7e14dcfSSatish Balay if (cnorm) *cnorm=tao->cnorm; 2295a7e14dcfSSatish Balay if (reason) *reason=tao->reason; 2296a7e14dcfSSatish Balay if (xdiff) *xdiff=tao->step; 2297a7e14dcfSSatish Balay PetscFunctionReturn(0); 2298a7e14dcfSSatish Balay } 2299a7e14dcfSSatish Balay 2300a7e14dcfSSatish Balay /*@C 2301441846f8SBarry Smith TaoGetType - Gets the current Tao algorithm. 2302a7e14dcfSSatish Balay 2303a7e14dcfSSatish Balay Not Collective 2304a7e14dcfSSatish Balay 2305a7e14dcfSSatish Balay Input Parameter: 2306441846f8SBarry Smith . tao - the Tao solver context 2307a7e14dcfSSatish Balay 2308a7e14dcfSSatish Balay Output Parameter: 2309441846f8SBarry Smith . type - Tao method 2310a7e14dcfSSatish Balay 2311a7e14dcfSSatish Balay Level: intermediate 2312a7e14dcfSSatish Balay 2313a7e14dcfSSatish Balay @*/ 2314441846f8SBarry Smith PetscErrorCode TaoGetType(Tao tao, const TaoType *type) 2315a7e14dcfSSatish Balay { 2316a7e14dcfSSatish Balay PetscFunctionBegin; 2317441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2318a7e14dcfSSatish Balay PetscValidPointer(type,2); 2319a7e14dcfSSatish Balay *type=((PetscObject)tao)->type_name; 2320a7e14dcfSSatish Balay PetscFunctionReturn(0); 2321a7e14dcfSSatish Balay } 2322a7e14dcfSSatish Balay 2323a7e14dcfSSatish Balay /*@C 2324a7e14dcfSSatish Balay TaoMonitor - Monitor the solver and the current solution. This 2325a7e14dcfSSatish Balay routine will record the iteration number and residual statistics, 2326a7e14dcfSSatish Balay call any monitors specified by the user, and calls the convergence-check routine. 2327a7e14dcfSSatish Balay 2328a7e14dcfSSatish Balay Input Parameters: 2329441846f8SBarry Smith + tao - the Tao context 2330a7e14dcfSSatish Balay . its - the current iterate number (>=0) 2331a7e14dcfSSatish Balay . f - the current objective function value 233258417fe7SBarry Smith . res - the gradient norm, square root of the duality gap, or other measure indicating distince from optimality. This measure will be recorded and 2333a7e14dcfSSatish Balay used for some termination tests. 2334a7e14dcfSSatish Balay . cnorm - the infeasibility of the current solution with regard to the constraints. 2335a7e14dcfSSatish Balay - steplength - multiple of the step direction added to the previous iterate. 2336a7e14dcfSSatish Balay 2337a7e14dcfSSatish Balay Output Parameters: 2338a7e14dcfSSatish Balay . reason - The termination reason, which can equal TAO_CONTINUE_ITERATING 2339a7e14dcfSSatish Balay 2340a7e14dcfSSatish Balay Options Database Key: 2341a7e14dcfSSatish Balay . -tao_monitor - Use the default monitor, which prints statistics to standard output 2342a7e14dcfSSatish Balay 2343e4cb33bbSBarry Smith .seealso TaoGetConvergedReason(), TaoDefaultMonitor(), TaoSetMonitor() 2344a7e14dcfSSatish Balay 2345a7e14dcfSSatish Balay Level: developer 2346a7e14dcfSSatish Balay 2347a7e14dcfSSatish Balay @*/ 2348e4cb33bbSBarry Smith PetscErrorCode TaoMonitor(Tao tao, PetscInt its, PetscReal f, PetscReal res, PetscReal cnorm, PetscReal steplength, TaoConvergedReason *reason) 2349a7e14dcfSSatish Balay { 2350a7e14dcfSSatish Balay PetscErrorCode ierr; 235147a47007SBarry Smith PetscInt i; 235247a47007SBarry Smith 2353a7e14dcfSSatish Balay PetscFunctionBegin; 2354441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2355a7e14dcfSSatish Balay tao->fc = f; 2356a7e14dcfSSatish Balay tao->residual = res; 2357a7e14dcfSSatish Balay tao->cnorm = cnorm; 2358a7e14dcfSSatish Balay tao->step = steplength; 2359e52336cbSBarry Smith if (!its) { 2360a7e14dcfSSatish Balay tao->cnorm0 = cnorm; tao->gnorm0 = res; 2361a7e14dcfSSatish Balay } 2362ae93cb3cSJason Sarich TaoLogConvergenceHistory(tao,f,res,cnorm,tao->ksp_its); 236347a47007SBarry Smith if (PetscIsInfOrNanReal(f) || PetscIsInfOrNanReal(res)) SETERRQ(PETSC_COMM_SELF,1, "User provided compute function generated Inf or NaN"); 2364a7e14dcfSSatish Balay if (tao->ops->convergencetest) { 2365a7e14dcfSSatish Balay ierr = (*tao->ops->convergencetest)(tao,tao->cnvP);CHKERRQ(ierr); 2366a7e14dcfSSatish Balay } 2367a7e14dcfSSatish Balay for (i=0;i<tao->numbermonitors;i++) { 2368a7e14dcfSSatish Balay ierr = (*tao->monitor[i])(tao,tao->monitorcontext[i]);CHKERRQ(ierr); 2369a7e14dcfSSatish Balay } 2370a7e14dcfSSatish Balay *reason = tao->reason; 2371a7e14dcfSSatish Balay PetscFunctionReturn(0); 2372a7e14dcfSSatish Balay } 2373a7e14dcfSSatish Balay 2374a7e14dcfSSatish Balay /*@ 2375ae93cb3cSJason Sarich TaoSetConvergenceHistory - Sets the array used to hold the convergence history. 2376a7e14dcfSSatish Balay 2377441846f8SBarry Smith Logically Collective on Tao 2378a7e14dcfSSatish Balay 2379a7e14dcfSSatish Balay Input Parameters: 2380441846f8SBarry Smith + tao - the Tao solver context 2381a7e14dcfSSatish Balay . obj - array to hold objective value history 2382a7e14dcfSSatish Balay . resid - array to hold residual history 2383a7e14dcfSSatish Balay . cnorm - array to hold constraint violation history 2384be1558d8SJason Sarich . lits - integer array holds the number of linear iterations for each Tao iteration 2385a7e14dcfSSatish Balay . na - size of obj, resid, and cnorm 2386a7e14dcfSSatish Balay - reset - PetscTrue indicates each new minimization resets the history counter to zero, 2387a7e14dcfSSatish Balay else it continues storing new values for new minimizations after the old ones 2388a7e14dcfSSatish Balay 2389a7e14dcfSSatish Balay Notes: 2390a7e14dcfSSatish Balay If set, TAO will fill the given arrays with the indicated 2391ae93cb3cSJason Sarich information at each iteration. If 'obj','resid','cnorm','lits' are 2392ae93cb3cSJason Sarich *all* NULL then space (using size na, or 1000 if na is PETSC_DECIDE or 2393ae93cb3cSJason Sarich PETSC_DEFAULT) is allocated for the history. 2394be1558d8SJason Sarich If not all are NULL, then only the non-NULL information categories 2395ae93cb3cSJason Sarich will be stored, the others will be ignored. 2396ae93cb3cSJason Sarich 2397ae93cb3cSJason Sarich Any convergence information after iteration number 'na' will not be stored. 2398a7e14dcfSSatish Balay 2399a7e14dcfSSatish Balay This routine is useful, e.g., when running a code for purposes 2400a7e14dcfSSatish Balay of accurate performance monitoring, when no I/O should be done 2401a7e14dcfSSatish Balay during the section of code that is being timed. 2402a7e14dcfSSatish Balay 2403a7e14dcfSSatish Balay Level: intermediate 2404a7e14dcfSSatish Balay 2405ae93cb3cSJason Sarich .seealso: TaoGetConvergenceHistory() 2406a7e14dcfSSatish Balay 2407a7e14dcfSSatish Balay @*/ 24081b266c99SBarry Smith PetscErrorCode TaoSetConvergenceHistory(Tao tao, PetscReal obj[], PetscReal resid[], PetscReal cnorm[], PetscInt lits[], PetscInt na,PetscBool reset) 2409a7e14dcfSSatish Balay { 2410ae93cb3cSJason Sarich PetscErrorCode ierr; 2411ae93cb3cSJason Sarich 2412a7e14dcfSSatish Balay PetscFunctionBegin; 2413441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2414ae93cb3cSJason Sarich if (obj) PetscValidScalarPointer(obj,2); 2415ae93cb3cSJason Sarich if (resid) PetscValidScalarPointer(resid,3); 2416ae93cb3cSJason Sarich if (cnorm) PetscValidScalarPointer(cnorm,4); 2417ae93cb3cSJason Sarich if (lits) PetscValidIntPointer(lits,5); 2418ae93cb3cSJason Sarich 2419ae93cb3cSJason Sarich if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000; 2420ae93cb3cSJason Sarich if (!obj && !resid && !cnorm && !lits) { 2421ae93cb3cSJason Sarich ierr = PetscCalloc1(na,&obj);CHKERRQ(ierr); 2422ae93cb3cSJason Sarich ierr = PetscCalloc1(na,&resid);CHKERRQ(ierr); 2423ae93cb3cSJason Sarich ierr = PetscCalloc1(na,&cnorm);CHKERRQ(ierr); 2424ae93cb3cSJason Sarich ierr = PetscCalloc1(na,&lits);CHKERRQ(ierr); 2425ae93cb3cSJason Sarich tao->hist_malloc=PETSC_TRUE; 2426ae93cb3cSJason Sarich } 2427ae93cb3cSJason Sarich 2428a7e14dcfSSatish Balay tao->hist_obj = obj; 2429a7e14dcfSSatish Balay tao->hist_resid = resid; 2430a7e14dcfSSatish Balay tao->hist_cnorm = cnorm; 2431ae93cb3cSJason Sarich tao->hist_lits = lits; 2432a7e14dcfSSatish Balay tao->hist_max = na; 2433a7e14dcfSSatish Balay tao->hist_reset = reset; 2434ae93cb3cSJason Sarich tao->hist_len = 0; 2435a7e14dcfSSatish Balay PetscFunctionReturn(0); 2436a7e14dcfSSatish Balay } 2437a7e14dcfSSatish Balay 2438a7e14dcfSSatish Balay /*@C 2439ae93cb3cSJason Sarich TaoGetConvergenceHistory - Gets the arrays used to hold the convergence history. 2440a7e14dcfSSatish Balay 2441441846f8SBarry Smith Collective on Tao 2442a7e14dcfSSatish Balay 2443a7e14dcfSSatish Balay Input Parameter: 2444441846f8SBarry Smith . tao - the Tao context 2445a7e14dcfSSatish Balay 2446a7e14dcfSSatish Balay Output Parameters: 2447a7e14dcfSSatish Balay + obj - array used to hold objective value history 2448a7e14dcfSSatish Balay . resid - array used to hold residual history 2449a7e14dcfSSatish Balay . cnorm - array used to hold constraint violation history 2450ae93cb3cSJason Sarich . lits - integer array used to hold linear solver iteration count 2451ae93cb3cSJason Sarich - nhist - size of obj, resid, cnorm, and lits (will be less than or equal to na given in TaoSetHistory) 2452a7e14dcfSSatish Balay 2453a7e14dcfSSatish Balay Notes: 2454ae93cb3cSJason Sarich This routine must be preceded by calls to TaoSetConvergenceHistory() 2455ae93cb3cSJason Sarich and TaoSolve(), otherwise it returns useless information. 2456ae93cb3cSJason Sarich 2457a7e14dcfSSatish Balay The calling sequence for this routine in Fortran is 2458ae93cb3cSJason Sarich $ call TaoGetConvergenceHistory(Tao tao, PetscInt nhist, PetscErrorCode ierr) 2459a7e14dcfSSatish Balay 2460a7e14dcfSSatish Balay This routine is useful, e.g., when running a code for purposes 2461a7e14dcfSSatish Balay of accurate performance monitoring, when no I/O should be done 2462a7e14dcfSSatish Balay during the section of code that is being timed. 2463a7e14dcfSSatish Balay 2464a7e14dcfSSatish Balay Level: advanced 2465a7e14dcfSSatish Balay 2466ae93cb3cSJason Sarich .seealso: TaoSetConvergenceHistory() 2467a7e14dcfSSatish Balay 2468a7e14dcfSSatish Balay @*/ 2469ae93cb3cSJason Sarich PetscErrorCode TaoGetConvergenceHistory(Tao tao, PetscReal **obj, PetscReal **resid, PetscReal **cnorm, PetscInt **lits, PetscInt *nhist) 2470a7e14dcfSSatish Balay { 2471a7e14dcfSSatish Balay PetscFunctionBegin; 2472441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2473a7e14dcfSSatish Balay if (obj) *obj = tao->hist_obj; 2474a7e14dcfSSatish Balay if (cnorm) *cnorm = tao->hist_cnorm; 2475a7e14dcfSSatish Balay if (resid) *resid = tao->hist_resid; 2476a7e14dcfSSatish Balay if (nhist) *nhist = tao->hist_len; 2477a7e14dcfSSatish Balay PetscFunctionReturn(0); 2478a7e14dcfSSatish Balay } 2479a7e14dcfSSatish Balay 2480a7e14dcfSSatish Balay /*@ 2481a7e14dcfSSatish Balay TaoSetApplicationContext - Sets the optional user-defined context for 2482a7e14dcfSSatish Balay a solver. 2483a7e14dcfSSatish Balay 2484441846f8SBarry Smith Logically Collective on Tao 2485a7e14dcfSSatish Balay 2486a7e14dcfSSatish Balay Input Parameters: 2487441846f8SBarry Smith + tao - the Tao context 2488a7e14dcfSSatish Balay - usrP - optional user context 2489a7e14dcfSSatish Balay 2490a7e14dcfSSatish Balay Level: intermediate 2491a7e14dcfSSatish Balay 2492a7e14dcfSSatish Balay .seealso: TaoGetApplicationContext(), TaoSetApplicationContext() 2493a7e14dcfSSatish Balay @*/ 2494441846f8SBarry Smith PetscErrorCode TaoSetApplicationContext(Tao tao,void *usrP) 2495a7e14dcfSSatish Balay { 2496a7e14dcfSSatish Balay PetscFunctionBegin; 2497441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2498a7e14dcfSSatish Balay tao->user = usrP; 2499a7e14dcfSSatish Balay PetscFunctionReturn(0); 2500a7e14dcfSSatish Balay } 2501a7e14dcfSSatish Balay 2502a7e14dcfSSatish Balay /*@ 2503a7e14dcfSSatish Balay TaoGetApplicationContext - Gets the user-defined context for a 2504a7e14dcfSSatish Balay TAO solvers. 2505a7e14dcfSSatish Balay 2506a7e14dcfSSatish Balay Not Collective 2507a7e14dcfSSatish Balay 2508a7e14dcfSSatish Balay Input Parameter: 2509441846f8SBarry Smith . tao - Tao context 2510a7e14dcfSSatish Balay 2511a7e14dcfSSatish Balay Output Parameter: 2512a7e14dcfSSatish Balay . usrP - user context 2513a7e14dcfSSatish Balay 2514a7e14dcfSSatish Balay Level: intermediate 2515a7e14dcfSSatish Balay 2516a7e14dcfSSatish Balay .seealso: TaoSetApplicationContext() 2517a7e14dcfSSatish Balay @*/ 2518441846f8SBarry Smith PetscErrorCode TaoGetApplicationContext(Tao tao,void *usrP) 2519a7e14dcfSSatish Balay { 2520a7e14dcfSSatish Balay PetscFunctionBegin; 2521441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2522a7e14dcfSSatish Balay *(void**)usrP = tao->user; 2523a7e14dcfSSatish Balay PetscFunctionReturn(0); 2524a7e14dcfSSatish Balay } 2525a9603a14SPatrick Farrell 2526a9603a14SPatrick Farrell /*@ 2527a9603a14SPatrick Farrell TaoSetGradientNorm - Sets the matrix used to define the inner product that measures the size of the gradient. 2528a9603a14SPatrick Farrell 2529a9603a14SPatrick Farrell Collective on tao 2530a9603a14SPatrick Farrell 2531a9603a14SPatrick Farrell Input Parameters: 2532a9603a14SPatrick Farrell + tao - the Tao context 2533a9603a14SPatrick Farrell - M - gradient norm 2534a9603a14SPatrick Farrell 2535a9603a14SPatrick Farrell Level: beginner 2536a9603a14SPatrick Farrell 2537a9603a14SPatrick Farrell .seealso: TaoGetGradientNorm(), TaoGradientNorm() 2538a9603a14SPatrick Farrell @*/ 2539a9603a14SPatrick Farrell PetscErrorCode TaoSetGradientNorm(Tao tao, Mat M) 2540a9603a14SPatrick Farrell { 2541a9603a14SPatrick Farrell PetscErrorCode ierr; 2542a9603a14SPatrick Farrell 2543a9603a14SPatrick Farrell PetscFunctionBegin; 2544a9603a14SPatrick Farrell PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2545a9603a14SPatrick Farrell 2546a9603a14SPatrick Farrell if (tao->gradient_norm) { 2547a9603a14SPatrick Farrell ierr = PetscObjectDereference((PetscObject)tao->gradient_norm);CHKERRQ(ierr); 2548a9603a14SPatrick Farrell ierr = VecDestroy(&tao->gradient_norm_tmp);CHKERRQ(ierr); 2549a9603a14SPatrick Farrell } 2550a9603a14SPatrick Farrell 2551a9603a14SPatrick Farrell ierr = PetscObjectReference((PetscObject)M);CHKERRQ(ierr); 2552a9603a14SPatrick Farrell tao->gradient_norm = M; 2553a9603a14SPatrick Farrell ierr = MatCreateVecs(M, NULL, &tao->gradient_norm_tmp);CHKERRQ(ierr); 2554a9603a14SPatrick Farrell PetscFunctionReturn(0); 2555a9603a14SPatrick Farrell } 2556a9603a14SPatrick Farrell 2557a9603a14SPatrick Farrell /*@ 2558a9603a14SPatrick Farrell TaoGetGradientNorm - Returns the matrix used to define the inner product for measuring the size of the gradient. 2559a9603a14SPatrick Farrell 2560a9603a14SPatrick Farrell Not Collective 2561a9603a14SPatrick Farrell 2562a9603a14SPatrick Farrell Input Parameter: 2563a9603a14SPatrick Farrell . tao - Tao context 2564a9603a14SPatrick Farrell 2565a9603a14SPatrick Farrell Output Parameter: 2566a9603a14SPatrick Farrell . M - gradient norm 2567a9603a14SPatrick Farrell 2568a9603a14SPatrick Farrell Level: beginner 2569a9603a14SPatrick Farrell 2570a9603a14SPatrick Farrell .seealso: TaoSetGradientNorm(), TaoGradientNorm() 2571a9603a14SPatrick Farrell @*/ 2572a9603a14SPatrick Farrell PetscErrorCode TaoGetGradientNorm(Tao tao, Mat *M) 2573a9603a14SPatrick Farrell { 2574a9603a14SPatrick Farrell PetscFunctionBegin; 2575a9603a14SPatrick Farrell PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2576a9603a14SPatrick Farrell *M = tao->gradient_norm; 2577a9603a14SPatrick Farrell PetscFunctionReturn(0); 2578a9603a14SPatrick Farrell } 2579a9603a14SPatrick Farrell 2580a9603a14SPatrick Farrell /*c 2581a9603a14SPatrick Farrell TaoGradientNorm - Compute the norm with respect to the inner product the user has set. 2582a9603a14SPatrick Farrell 2583a9603a14SPatrick Farrell Collective on tao 2584a9603a14SPatrick Farrell 2585a9603a14SPatrick Farrell Input Parameter: 2586a9603a14SPatrick Farrell . tao - the Tao context 2587a9603a14SPatrick Farrell . gradient - the gradient to be computed 2588a9603a14SPatrick Farrell . norm - the norm type 2589a9603a14SPatrick Farrell 2590a9603a14SPatrick Farrell Output Parameter: 2591a9603a14SPatrick Farrell . gnorm - the gradient norm 2592a9603a14SPatrick Farrell 2593a9603a14SPatrick Farrell Level: developer 2594a9603a14SPatrick Farrell 2595a9603a14SPatrick Farrell .seealso: TaoSetGradientNorm(), TaoGetGradientNorm() 2596a9603a14SPatrick Farrell @*/ 2597a9603a14SPatrick Farrell PetscErrorCode TaoGradientNorm(Tao tao, Vec gradient, NormType type, PetscReal *gnorm) 2598a9603a14SPatrick Farrell { 2599a9603a14SPatrick Farrell PetscErrorCode ierr; 2600a9603a14SPatrick Farrell 2601a9603a14SPatrick Farrell PetscFunctionBegin; 2602a9603a14SPatrick Farrell PetscValidHeaderSpecific(gradient,VEC_CLASSID,1); 2603a9603a14SPatrick Farrell 2604a9603a14SPatrick Farrell if (tao->gradient_norm) { 2605680e2bc7SPatrick Farrell PetscScalar gnorms; 2606680e2bc7SPatrick Farrell 2607a9603a14SPatrick Farrell if (type != NORM_2) SETERRQ(PetscObjectComm((PetscObject)gradient), PETSC_ERR_ARG_WRONGSTATE, "Norm type must be NORM_2 if an inner product for the gradient norm is set."); 2608a9603a14SPatrick Farrell ierr = MatMult(tao->gradient_norm, gradient, tao->gradient_norm_tmp);CHKERRQ(ierr); 2609680e2bc7SPatrick Farrell ierr = VecDot(gradient, tao->gradient_norm_tmp, &gnorms);CHKERRQ(ierr); 26107bb79937SPatrick Farrell *gnorm = PetscRealPart(PetscSqrtScalar(gnorms)); 2611a9603a14SPatrick Farrell } else { 2612a9603a14SPatrick Farrell ierr = VecNorm(gradient, type, gnorm);CHKERRQ(ierr); 2613a9603a14SPatrick Farrell } 2614a9603a14SPatrick Farrell PetscFunctionReturn(0); 2615a9603a14SPatrick Farrell } 2616a9603a14SPatrick Farrell 2617*e882e171SHong Zhang /*@C 2618*e882e171SHong Zhang TaoMonitorDrawCtxCreate - Creates the monitor context for TaoMonitorDrawCtx 2619a9603a14SPatrick Farrell 2620*e882e171SHong Zhang Collective on Tao 2621*e882e171SHong Zhang 2622*e882e171SHong Zhang Output Patameter: 2623*e882e171SHong Zhang . ctx - the monitor context 2624*e882e171SHong Zhang 2625*e882e171SHong Zhang Options Database: 2626*e882e171SHong Zhang . -tao_draw_solution_initial - show initial guess as well as current solution 2627*e882e171SHong Zhang 2628*e882e171SHong Zhang Level: intermediate 2629*e882e171SHong Zhang 2630*e882e171SHong Zhang .keywords: Tao, vector, monitor, view 2631*e882e171SHong Zhang 2632*e882e171SHong Zhang .seealso: TaoMonitorSet(), TaoMonitorDefault(), VecView(), TaoMonitorDrawCtx() 2633*e882e171SHong Zhang @*/ 2634*e882e171SHong Zhang PetscErrorCode TaoMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TaoMonitorDrawCtx *ctx) 2635*e882e171SHong Zhang { 2636*e882e171SHong Zhang PetscErrorCode ierr; 2637*e882e171SHong Zhang 2638*e882e171SHong Zhang PetscFunctionBegin; 2639*e882e171SHong Zhang ierr = PetscNew(ctx);CHKERRQ(ierr); 2640*e882e171SHong Zhang ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 2641*e882e171SHong Zhang ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 2642*e882e171SHong Zhang (*ctx)->howoften = howoften; 2643*e882e171SHong Zhang PetscFunctionReturn(0); 2644*e882e171SHong Zhang } 2645*e882e171SHong Zhang 2646*e882e171SHong Zhang /*@C 2647*e882e171SHong Zhang TaoMonitorDrawCtxDestroy - Destroys the monitor context for TaoMonitorDrawSolution() 2648*e882e171SHong Zhang 2649*e882e171SHong Zhang Collective on Tao 2650*e882e171SHong Zhang 2651*e882e171SHong Zhang Input Parameters: 2652*e882e171SHong Zhang . ctx - the monitor context 2653*e882e171SHong Zhang 2654*e882e171SHong Zhang Level: intermediate 2655*e882e171SHong Zhang 2656*e882e171SHong Zhang .keywords: Tao, vector, monitor, view 2657*e882e171SHong Zhang 2658*e882e171SHong Zhang .seealso: TaoMonitorSet(), TaoMonitorDefault(), VecView(), TaoMonitorDrawSolution() 2659*e882e171SHong Zhang @*/ 2660*e882e171SHong Zhang PetscErrorCode TaoMonitorDrawCtxDestroy(TaoMonitorDrawCtx *ictx) 2661*e882e171SHong Zhang { 2662*e882e171SHong Zhang PetscErrorCode ierr; 2663*e882e171SHong Zhang 2664*e882e171SHong Zhang PetscFunctionBegin; 2665*e882e171SHong Zhang ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 2666*e882e171SHong Zhang ierr = PetscFree(*ictx);CHKERRQ(ierr); 2667*e882e171SHong Zhang PetscFunctionReturn(0); 2668*e882e171SHong Zhang } 2669