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; 9*0ebee16dSLisandro Dalcin 10*0ebee16dSLisandro Dalcin PetscLogEvent TAO_Solve; 11*0ebee16dSLisandro Dalcin PetscLogEvent TAO_ObjectiveEval; 12*0ebee16dSLisandro Dalcin PetscLogEvent TAO_GradientEval; 13*0ebee16dSLisandro Dalcin PetscLogEvent TAO_ObjGradEval; 14*0ebee16dSLisandro Dalcin PetscLogEvent TAO_HessianEval; 15*0ebee16dSLisandro Dalcin PetscLogEvent TAO_JacobianEval; 16*0ebee16dSLisandro Dalcin PetscLogEvent TAO_ConstraintsEval; 17a7e14dcfSSatish Balay 185b0d99aeSBarry Smith const char *TaoSubSetTypes[] = {"subvec","mask","matrixfree","TaoSubSetType","TAO_SUBSET_",0}; 19a7e14dcfSSatish Balay 20e882e171SHong Zhang struct _n_TaoMonitorDrawCtx { 21e882e171SHong Zhang PetscViewer viewer; 22e882e171SHong Zhang PetscInt howoften; /* when > 0 uses iteration % howoften, when negative only final solution plotted */ 23e882e171SHong Zhang }; 24e882e171SHong Zhang 25a7e14dcfSSatish Balay /*@ 26a7e14dcfSSatish Balay TaoCreate - Creates a TAO solver 27a7e14dcfSSatish Balay 28a7e14dcfSSatish Balay Collective on MPI_Comm 29a7e14dcfSSatish Balay 30a7e14dcfSSatish Balay Input Parameter: 31a7e14dcfSSatish Balay . comm - MPI communicator 32a7e14dcfSSatish Balay 33a7e14dcfSSatish Balay Output Parameter: 34441846f8SBarry Smith . newtao - the new Tao context 35a7e14dcfSSatish Balay 36a7e14dcfSSatish Balay Available methods include: 3758417fe7SBarry Smith + nls - Newton's method with line search for unconstrained minimization 3858417fe7SBarry Smith . ntr - Newton's method with trust region for unconstrained minimization 3958417fe7SBarry Smith . ntl - Newton's method with trust region, line search for unconstrained minimization 4058417fe7SBarry Smith . lmvm - Limited memory variable metric method for unconstrained minimization 4158417fe7SBarry Smith . cg - Nonlinear conjugate gradient method for unconstrained minimization 4258417fe7SBarry Smith . nm - Nelder-Mead algorithm for derivate-free unconstrained minimization 4358417fe7SBarry Smith . tron - Newton Trust Region method for bound constrained minimization 4458417fe7SBarry Smith . gpcg - Newton Trust Region method for quadratic bound constrained minimization 4558417fe7SBarry Smith . blmvm - Limited memory variable metric method for bound constrained minimization 4658417fe7SBarry Smith . lcl - Linearly constrained Lagrangian method for pde-constrained minimization 4758417fe7SBarry Smith - pounders - Model-based algorithm for nonlinear least squares 48a7e14dcfSSatish Balay 49a7e14dcfSSatish Balay Options Database Keys: 5058417fe7SBarry Smith . -tao_type - select which method TAO should use 51a7e14dcfSSatish Balay 52a7e14dcfSSatish Balay Level: beginner 53a7e14dcfSSatish Balay 54a7e14dcfSSatish Balay .seealso: TaoSolve(), TaoDestroy() 55a7e14dcfSSatish Balay @*/ 56441846f8SBarry Smith PetscErrorCode TaoCreate(MPI_Comm comm, Tao *newtao) 57a7e14dcfSSatish Balay { 58a7e14dcfSSatish Balay PetscErrorCode ierr; 59441846f8SBarry Smith Tao tao; 60a7e14dcfSSatish Balay 61a7e14dcfSSatish Balay PetscFunctionBegin; 62a7e14dcfSSatish Balay PetscValidPointer(newtao,2); 6347a47007SBarry Smith *newtao = NULL; 64a7e14dcfSSatish Balay 65a7e14dcfSSatish Balay ierr = TaoInitializePackage();CHKERRQ(ierr); 66a7e14dcfSSatish Balay ierr = TaoLineSearchInitializePackage();CHKERRQ(ierr); 67a7e14dcfSSatish Balay 6873107ff1SLisandro Dalcin ierr = PetscHeaderCreate(tao,TAO_CLASSID,"Tao","Optimization solver","Tao",comm,TaoDestroy,TaoView);CHKERRQ(ierr); 69a7e14dcfSSatish Balay tao->ops->computeobjective=0; 70a7e14dcfSSatish Balay tao->ops->computeobjectiveandgradient=0; 71a7e14dcfSSatish Balay tao->ops->computegradient=0; 72a7e14dcfSSatish Balay tao->ops->computehessian=0; 73a7e14dcfSSatish Balay tao->ops->computeseparableobjective=0; 74a7e14dcfSSatish Balay tao->ops->computeconstraints=0; 75a7e14dcfSSatish Balay tao->ops->computejacobian=0; 76a7e14dcfSSatish Balay tao->ops->computejacobianequality=0; 77a7e14dcfSSatish Balay tao->ops->computejacobianinequality=0; 78a7e14dcfSSatish Balay tao->ops->computeequalityconstraints=0; 79a7e14dcfSSatish Balay tao->ops->computeinequalityconstraints=0; 80a7e14dcfSSatish Balay tao->ops->convergencetest=TaoDefaultConvergenceTest; 81a7e14dcfSSatish Balay tao->ops->convergencedestroy=0; 82a7e14dcfSSatish Balay tao->ops->computedual=0; 83a7e14dcfSSatish Balay tao->ops->setup=0; 84a7e14dcfSSatish Balay tao->ops->solve=0; 85a7e14dcfSSatish Balay tao->ops->view=0; 86a7e14dcfSSatish Balay tao->ops->setfromoptions=0; 87a7e14dcfSSatish Balay tao->ops->destroy=0; 88a7e14dcfSSatish Balay 8947a47007SBarry Smith tao->solution=NULL; 9047a47007SBarry Smith tao->gradient=NULL; 9147a47007SBarry Smith tao->sep_objective = NULL; 9247a47007SBarry Smith tao->constraints=NULL; 9347a47007SBarry Smith tao->constraints_equality=NULL; 9447a47007SBarry Smith tao->constraints_inequality=NULL; 95125ddc8aSJason Sarich tao->sep_weights_v=NULL; 96125ddc8aSJason Sarich tao->sep_weights_w=NULL; 9747a47007SBarry Smith tao->stepdirection=NULL; 988931d482SJason Sarich tao->niter=0; 998931d482SJason Sarich tao->ntotalits=0; 10047a47007SBarry Smith tao->XL = NULL; 10147a47007SBarry Smith tao->XU = NULL; 10247a47007SBarry Smith tao->IL = NULL; 10347a47007SBarry Smith tao->IU = NULL; 10447a47007SBarry Smith tao->DI = NULL; 10547a47007SBarry Smith tao->DE = NULL; 106a9603a14SPatrick Farrell tao->gradient_norm = NULL; 107a9603a14SPatrick Farrell tao->gradient_norm_tmp = NULL; 10847a47007SBarry Smith tao->hessian = NULL; 10947a47007SBarry Smith tao->hessian_pre = NULL; 11047a47007SBarry Smith tao->jacobian = NULL; 11147a47007SBarry Smith tao->jacobian_pre = NULL; 11247a47007SBarry Smith tao->jacobian_state = NULL; 11347a47007SBarry Smith tao->jacobian_state_pre = NULL; 11447a47007SBarry Smith tao->jacobian_state_inv = NULL; 11547a47007SBarry Smith tao->jacobian_design = NULL; 11647a47007SBarry Smith tao->jacobian_design_pre = NULL; 11747a47007SBarry Smith tao->jacobian_equality = NULL; 11847a47007SBarry Smith tao->jacobian_equality_pre = NULL; 11947a47007SBarry Smith tao->jacobian_inequality = NULL; 12047a47007SBarry Smith tao->jacobian_inequality_pre = NULL; 12147a47007SBarry Smith tao->state_is = NULL; 12247a47007SBarry Smith tao->design_is = NULL; 123a7e14dcfSSatish Balay 124a7e14dcfSSatish Balay tao->max_it = 10000; 125a7e14dcfSSatish Balay tao->max_funcs = 10000; 1266f4723b1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 1276f4723b1SBarry Smith tao->gatol = 1e-5; 1286f4723b1SBarry Smith tao->grtol = 1e-5; 1296f4723b1SBarry Smith #else 130a7e14dcfSSatish Balay tao->gatol = 1e-8; 131a7e14dcfSSatish Balay tao->grtol = 1e-8; 1326f4723b1SBarry Smith #endif 133a7e14dcfSSatish Balay tao->crtol = 0.0; 1346552cf8aSJason Sarich tao->catol = 0.0; 1356552cf8aSJason Sarich tao->gttol = 0.0; 1364f1535bcSTodd Munson tao->steptol = 0.0; 137e270355aSBarry Smith tao->trust0 = PETSC_INFINITY; 1386f4723b1SBarry Smith tao->fmin = PETSC_NINFINITY; 139ae93cb3cSJason Sarich tao->hist_malloc = PETSC_FALSE; 140a7e14dcfSSatish Balay tao->hist_reset = PETSC_TRUE; 141a7e14dcfSSatish Balay tao->hist_max = 0; 142a7e14dcfSSatish Balay tao->hist_len = 0; 14347a47007SBarry Smith tao->hist_obj = NULL; 14447a47007SBarry Smith tao->hist_resid = NULL; 14547a47007SBarry Smith tao->hist_cnorm = NULL; 146ae93cb3cSJason Sarich tao->hist_lits = NULL; 147a7e14dcfSSatish Balay 148a7e14dcfSSatish Balay tao->numbermonitors=0; 149a7e14dcfSSatish Balay tao->viewsolution=PETSC_FALSE; 150a7e14dcfSSatish Balay tao->viewhessian=PETSC_FALSE; 151a7e14dcfSSatish Balay tao->viewgradient=PETSC_FALSE; 152a7e14dcfSSatish Balay tao->viewjacobian=PETSC_FALSE; 153a7e14dcfSSatish Balay tao->viewconstraints = PETSC_FALSE; 154a7e14dcfSSatish Balay 1556552cf8aSJason Sarich /* These flags prevents algorithms from overriding user options */ 1566552cf8aSJason Sarich tao->max_it_changed =PETSC_FALSE; 1576552cf8aSJason Sarich tao->max_funcs_changed=PETSC_FALSE; 1586552cf8aSJason Sarich tao->gatol_changed =PETSC_FALSE; 1596552cf8aSJason Sarich tao->grtol_changed =PETSC_FALSE; 1606552cf8aSJason Sarich tao->gttol_changed =PETSC_FALSE; 1616552cf8aSJason Sarich tao->steptol_changed =PETSC_FALSE; 1626552cf8aSJason Sarich tao->trust0_changed =PETSC_FALSE; 1636552cf8aSJason Sarich tao->fmin_changed =PETSC_FALSE; 1646552cf8aSJason Sarich tao->catol_changed =PETSC_FALSE; 1656552cf8aSJason Sarich tao->crtol_changed =PETSC_FALSE; 166a7e14dcfSSatish Balay ierr = TaoResetStatistics(tao);CHKERRQ(ierr); 167a7e14dcfSSatish Balay *newtao = tao; 168a7e14dcfSSatish Balay PetscFunctionReturn(0); 169a7e14dcfSSatish Balay } 170a7e14dcfSSatish Balay 171a7e14dcfSSatish Balay /*@ 172a7e14dcfSSatish Balay TaoSolve - Solves an optimization problem min F(x) s.t. l <= x <= u 173a7e14dcfSSatish Balay 174441846f8SBarry Smith Collective on Tao 175a7e14dcfSSatish Balay 176a7e14dcfSSatish Balay Input Parameters: 177441846f8SBarry Smith . tao - the Tao context 178a7e14dcfSSatish Balay 179a7e14dcfSSatish Balay Notes: 180441846f8SBarry Smith The user must set up the Tao with calls to TaoSetInitialVector(), 181a7e14dcfSSatish Balay TaoSetObjectiveRoutine(), 182a7e14dcfSSatish Balay TaoSetGradientRoutine(), and (if using 2nd order method) TaoSetHessianRoutine(). 183a7e14dcfSSatish Balay 184a35d58b8SBarry Smith You should call TaoGetConvergedReason() or run with -tao_converged_reason to determine if the optimization algorithm actually succeeded or 185a35d58b8SBarry Smith why it failed. 186a35d58b8SBarry Smith 187a7e14dcfSSatish Balay Level: beginner 188a7e14dcfSSatish Balay 189a35d58b8SBarry Smith .seealso: TaoCreate(), TaoSetObjectiveRoutine(), TaoSetGradientRoutine(), TaoSetHessianRoutine(), TaoGetConvergedReason() 190a7e14dcfSSatish Balay @*/ 191441846f8SBarry Smith PetscErrorCode TaoSolve(Tao tao) 192a7e14dcfSSatish Balay { 193a7e14dcfSSatish Balay PetscErrorCode ierr; 194e2379f4fSBarry Smith static PetscBool set = PETSC_FALSE; 19547a47007SBarry Smith 196a7e14dcfSSatish Balay PetscFunctionBegin; 197441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 198e2379f4fSBarry Smith ierr = PetscCitationsRegister("@TechReport{tao-user-ref,\n" 199e2379f4fSBarry Smith "title = {Toolkit for Advanced Optimization (TAO) Users Manual},\n" 200e2379f4fSBarry Smith "author = {Todd Munson and Jason Sarich and Stefan Wild and Steve Benson and Lois Curfman McInnes},\n" 201e2379f4fSBarry Smith "Institution = {Argonne National Laboratory},\n" 202e2379f4fSBarry Smith "Year = 2014,\n" 203e2379f4fSBarry Smith "Number = {ANL/MCS-TM-322 - Revision 3.5},\n" 204302440fdSBarry Smith "url = {http://www.mcs.anl.gov/tao}\n}\n",&set);CHKERRQ(ierr); 205e2379f4fSBarry Smith 206a7e14dcfSSatish Balay ierr = TaoSetUp(tao);CHKERRQ(ierr); 207a7e14dcfSSatish Balay ierr = TaoResetStatistics(tao);CHKERRQ(ierr); 208a7e14dcfSSatish Balay if (tao->linesearch) { 209a7e14dcfSSatish Balay ierr = TaoLineSearchReset(tao->linesearch);CHKERRQ(ierr); 210a7e14dcfSSatish Balay } 211a7e14dcfSSatish Balay 212*0ebee16dSLisandro Dalcin ierr = PetscLogEventBegin(TAO_Solve,tao,0,0,0);CHKERRQ(ierr); 213a7e14dcfSSatish Balay if (tao->ops->solve){ ierr = (*tao->ops->solve)(tao);CHKERRQ(ierr); } 214*0ebee16dSLisandro Dalcin ierr = PetscLogEventEnd(TAO_Solve,tao,0,0,0);CHKERRQ(ierr); 215a7e14dcfSSatish Balay 2167cf37e64SBarry Smith ierr = VecViewFromOptions(tao->solution,(PetscObject)tao,"-tao_view_solution");CHKERRQ(ierr); 2177cf37e64SBarry Smith 2188931d482SJason Sarich tao->ntotalits += tao->niter; 219fbe0838dSJason Sarich ierr = TaoViewFromOptions(tao,NULL,"-tao_view");CHKERRQ(ierr); 220a7e14dcfSSatish Balay 221a7e14dcfSSatish Balay if (tao->printreason) { 222a7e14dcfSSatish Balay if (tao->reason > 0) { 2238931d482SJason Sarich ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve converged due to %s iterations %D\n",TaoConvergedReasons[tao->reason],tao->niter);CHKERRQ(ierr); 224a7e14dcfSSatish Balay } else { 2258931d482SJason Sarich ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve did not converge due to %s iteration %D\n",TaoConvergedReasons[tao->reason],tao->niter);CHKERRQ(ierr); 226a7e14dcfSSatish Balay } 227a7e14dcfSSatish Balay } 228a7e14dcfSSatish Balay PetscFunctionReturn(0); 229a7e14dcfSSatish Balay } 230a7e14dcfSSatish Balay 231a7e14dcfSSatish Balay /*@ 232a7e14dcfSSatish Balay TaoSetUp - Sets up the internal data structures for the later use 233a7e14dcfSSatish Balay of a Tao solver 234a7e14dcfSSatish Balay 235a7e14dcfSSatish Balay Collective on tao 236a7e14dcfSSatish Balay 237a7e14dcfSSatish Balay Input Parameters: 238a7e14dcfSSatish Balay . tao - the TAO context 239a7e14dcfSSatish Balay 240a7e14dcfSSatish Balay Notes: 241a7e14dcfSSatish Balay The user will not need to explicitly call TaoSetUp(), as it will 242a7e14dcfSSatish Balay automatically be called in TaoSolve(). However, if the user 243a7e14dcfSSatish Balay desires to call it explicitly, it should come after TaoCreate() 244a7e14dcfSSatish Balay and any TaoSetSomething() routines, but before TaoSolve(). 245a7e14dcfSSatish Balay 246a7e14dcfSSatish Balay Level: advanced 247a7e14dcfSSatish Balay 248a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve() 249a7e14dcfSSatish Balay @*/ 250441846f8SBarry Smith PetscErrorCode TaoSetUp(Tao tao) 251a7e14dcfSSatish Balay { 252a7e14dcfSSatish Balay PetscErrorCode ierr; 25347a47007SBarry Smith 254a7e14dcfSSatish Balay PetscFunctionBegin; 255441846f8SBarry Smith PetscValidHeaderSpecific(tao, TAO_CLASSID,1); 256a7e14dcfSSatish Balay if (tao->setupcalled) PetscFunctionReturn(0); 257a7e14dcfSSatish Balay 25847a47007SBarry Smith if (!tao->solution) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TaoSetInitialVector"); 259a7e14dcfSSatish Balay if (tao->ops->setup) { 260a7e14dcfSSatish Balay ierr = (*tao->ops->setup)(tao);CHKERRQ(ierr); 261a7e14dcfSSatish Balay } 262a7e14dcfSSatish Balay tao->setupcalled = PETSC_TRUE; 263a7e14dcfSSatish Balay PetscFunctionReturn(0); 264a7e14dcfSSatish Balay } 265a7e14dcfSSatish Balay 266a7e14dcfSSatish Balay /*@ 267a7e14dcfSSatish Balay TaoDestroy - Destroys the TAO context that was created with 268a7e14dcfSSatish Balay TaoCreate() 269a7e14dcfSSatish Balay 270441846f8SBarry Smith Collective on Tao 271a7e14dcfSSatish Balay 272a7e14dcfSSatish Balay Input Parameter: 273441846f8SBarry Smith . tao - the Tao context 274a7e14dcfSSatish Balay 275a7e14dcfSSatish Balay Level: beginner 276a7e14dcfSSatish Balay 277a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve() 278a7e14dcfSSatish Balay @*/ 279441846f8SBarry Smith PetscErrorCode TaoDestroy(Tao *tao) 280a7e14dcfSSatish Balay { 281a7e14dcfSSatish Balay PetscErrorCode ierr; 28247a47007SBarry Smith 283a7e14dcfSSatish Balay PetscFunctionBegin; 284a7e14dcfSSatish Balay if (!*tao) PetscFunctionReturn(0); 285441846f8SBarry Smith PetscValidHeaderSpecific(*tao,TAO_CLASSID,1); 286a7e14dcfSSatish Balay if (--((PetscObject)*tao)->refct > 0) {*tao=0;PetscFunctionReturn(0);} 287a7e14dcfSSatish Balay 288a7e14dcfSSatish Balay if ((*tao)->ops->destroy) { 289a7e14dcfSSatish Balay ierr = (*((*tao))->ops->destroy)(*tao);CHKERRQ(ierr); 290a7e14dcfSSatish Balay } 291a7e14dcfSSatish Balay ierr = KSPDestroy(&(*tao)->ksp);CHKERRQ(ierr); 292a7e14dcfSSatish Balay ierr = TaoLineSearchDestroy(&(*tao)->linesearch);CHKERRQ(ierr); 293a7e14dcfSSatish Balay 294a7e14dcfSSatish Balay if ((*tao)->ops->convergencedestroy) { 295a7e14dcfSSatish Balay ierr = (*(*tao)->ops->convergencedestroy)((*tao)->cnvP);CHKERRQ(ierr); 296a7e14dcfSSatish Balay if ((*tao)->jacobian_state_inv) { 297a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr); 298a7e14dcfSSatish Balay } 299a7e14dcfSSatish Balay } 300a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->solution);CHKERRQ(ierr); 301a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->gradient);CHKERRQ(ierr); 302a7e14dcfSSatish Balay 303a9603a14SPatrick Farrell if ((*tao)->gradient_norm) { 304a9603a14SPatrick Farrell ierr = PetscObjectDereference((PetscObject)(*tao)->gradient_norm);CHKERRQ(ierr); 305a9603a14SPatrick Farrell ierr = VecDestroy(&(*tao)->gradient_norm_tmp);CHKERRQ(ierr); 306a9603a14SPatrick Farrell } 307a9603a14SPatrick Farrell 308a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->XL);CHKERRQ(ierr); 309a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->XU);CHKERRQ(ierr); 310a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->IL);CHKERRQ(ierr); 311a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->IU);CHKERRQ(ierr); 312a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->DE);CHKERRQ(ierr); 313a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->DI);CHKERRQ(ierr); 314a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->constraints_equality);CHKERRQ(ierr); 315a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->constraints_inequality);CHKERRQ(ierr); 316a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->stepdirection);CHKERRQ(ierr); 317a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->hessian_pre);CHKERRQ(ierr); 318a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->hessian);CHKERRQ(ierr); 319a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_pre);CHKERRQ(ierr); 320a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian);CHKERRQ(ierr); 321a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state_pre);CHKERRQ(ierr); 322a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state);CHKERRQ(ierr); 323a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr); 324067f330cSJason Sarich ierr = MatDestroy(&(*tao)->jacobian_design);CHKERRQ(ierr); 325a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_equality);CHKERRQ(ierr); 326a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_equality_pre);CHKERRQ(ierr); 327a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_inequality);CHKERRQ(ierr); 328a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_inequality_pre);CHKERRQ(ierr); 329a7e14dcfSSatish Balay ierr = ISDestroy(&(*tao)->state_is);CHKERRQ(ierr); 330a7e14dcfSSatish Balay ierr = ISDestroy(&(*tao)->design_is);CHKERRQ(ierr); 331125ddc8aSJason Sarich ierr = VecDestroy(&(*tao)->sep_weights_v);CHKERRQ(ierr); 332a7e14dcfSSatish Balay ierr = TaoCancelMonitors(*tao);CHKERRQ(ierr); 333ae93cb3cSJason Sarich if ((*tao)->hist_malloc) { 334ae93cb3cSJason Sarich ierr = PetscFree((*tao)->hist_obj);CHKERRQ(ierr); 335ae93cb3cSJason Sarich ierr = PetscFree((*tao)->hist_resid);CHKERRQ(ierr); 336ae93cb3cSJason Sarich ierr = PetscFree((*tao)->hist_cnorm);CHKERRQ(ierr); 337ae93cb3cSJason Sarich ierr = PetscFree((*tao)->hist_lits);CHKERRQ(ierr); 338ae93cb3cSJason Sarich } 339125ddc8aSJason Sarich if ((*tao)->sep_weights_n) { 340125ddc8aSJason Sarich ierr = PetscFree((*tao)->sep_weights_rows);CHKERRQ(ierr); 341125ddc8aSJason Sarich ierr = PetscFree((*tao)->sep_weights_cols);CHKERRQ(ierr); 342125ddc8aSJason Sarich ierr = PetscFree((*tao)->sep_weights_w);CHKERRQ(ierr); 343125ddc8aSJason Sarich } 344a7e14dcfSSatish Balay ierr = PetscHeaderDestroy(tao);CHKERRQ(ierr); 345a7e14dcfSSatish Balay PetscFunctionReturn(0); 346a7e14dcfSSatish Balay } 347a7e14dcfSSatish Balay 348a7e14dcfSSatish Balay /*@ 349441846f8SBarry Smith TaoSetFromOptions - Sets various Tao parameters from user 350a7e14dcfSSatish Balay options. 351a7e14dcfSSatish Balay 352441846f8SBarry Smith Collective on Tao 353a7e14dcfSSatish Balay 354a7e14dcfSSatish Balay Input Paremeter: 355441846f8SBarry Smith . tao - the Tao solver context 356a7e14dcfSSatish Balay 357a7e14dcfSSatish Balay options Database Keys: 35858417fe7SBarry Smith + -tao_type <type> - The algorithm that TAO uses (lmvm, nls, etc.) 359a7e14dcfSSatish Balay . -tao_gatol <gatol> - absolute error tolerance for ||gradient|| 360a7e14dcfSSatish Balay . -tao_grtol <grtol> - relative error tolerance for ||gradient|| 361a7e14dcfSSatish Balay . -tao_gttol <gttol> - reduction of ||gradient|| relative to initial gradient 362a7e14dcfSSatish Balay . -tao_max_it <max> - sets maximum number of iterations 363a7e14dcfSSatish Balay . -tao_max_funcs <max> - sets maximum number of function evaluations 364a7e14dcfSSatish Balay . -tao_fmin <fmin> - stop if function value reaches fmin 365a7e14dcfSSatish Balay . -tao_steptol <tol> - stop if trust region radius less than <tol> 366a7e14dcfSSatish Balay . -tao_trust0 <t> - initial trust region radius 367a7e14dcfSSatish Balay . -tao_monitor - prints function value and residual at each iteration 368a7e14dcfSSatish Balay . -tao_smonitor - same as tao_monitor, but truncates very small values 369a7e14dcfSSatish Balay . -tao_cmonitor - prints function value, residual, and constraint norm at each iteration 370a7e14dcfSSatish Balay . -tao_view_solution - prints solution vector at each iteration 371a7e14dcfSSatish Balay . -tao_view_separableobjective - prints separable objective vector at each iteration 372a7e14dcfSSatish Balay . -tao_view_step - prints step direction vector at each iteration 373a7e14dcfSSatish Balay . -tao_view_gradient - prints gradient vector at each iteration 374a7e14dcfSSatish Balay . -tao_draw_solution - graphically view solution vector at each iteration 375a7e14dcfSSatish Balay . -tao_draw_step - graphically view step vector at each iteration 376a7e14dcfSSatish Balay . -tao_draw_gradient - graphically view gradient at each iteration 377a7e14dcfSSatish Balay . -tao_fd_gradient - use gradient computed with finite differences 378f4c1ad5cSStefano Zampini . -tao_fd_hessian - use hessian computed with finite differences 379f4c1ad5cSStefano Zampini . -tao_mf_hessian - use matrix-free hessian computed with finite differences 380a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors (except those set with command line) 381441846f8SBarry Smith . -tao_view - prints information about the Tao after solving 382a7e14dcfSSatish Balay - -tao_converged_reason - prints the reason TAO stopped iterating 383a7e14dcfSSatish Balay 384a7e14dcfSSatish Balay Notes: 385a7e14dcfSSatish Balay To see all options, run your program with the -help option or consult the 386a7e14dcfSSatish Balay user's manual. Should be called after TaoCreate() but before TaoSolve() 387a7e14dcfSSatish Balay 388a7e14dcfSSatish Balay Level: beginner 389a7e14dcfSSatish Balay @*/ 390441846f8SBarry Smith PetscErrorCode TaoSetFromOptions(Tao tao) 391a7e14dcfSSatish Balay { 392a7e14dcfSSatish Balay PetscErrorCode ierr; 393b625d6c7SJed Brown TaoType default_type = TAOLMVM; 394a7e14dcfSSatish Balay char type[256], monfilename[PETSC_MAX_PATH_LEN]; 395a7e14dcfSSatish Balay PetscViewer monviewer; 396a7e14dcfSSatish Balay PetscBool flg; 397a7e14dcfSSatish Balay MPI_Comm comm; 398a7e14dcfSSatish Balay 399a7e14dcfSSatish Balay PetscFunctionBegin; 400441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 401a7e14dcfSSatish Balay ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr); 402125ddc8aSJason Sarich 403a7e14dcfSSatish Balay /* So no warnings are given about unused options */ 404c5929fdfSBarry Smith ierr = PetscOptionsHasName(((PetscObject)tao)->options,((PetscObject)tao)->prefix,"-tao_ls_type",&flg);CHKERRQ(ierr); 405a7e14dcfSSatish Balay 406a7e14dcfSSatish Balay ierr = PetscObjectOptionsBegin((PetscObject)tao);CHKERRQ(ierr); 407a7e14dcfSSatish Balay { 408441846f8SBarry Smith ierr = TaoRegisterAll();CHKERRQ(ierr); 409a7e14dcfSSatish Balay if (((PetscObject)tao)->type_name) { 410a7e14dcfSSatish Balay default_type = ((PetscObject)tao)->type_name; 411a7e14dcfSSatish Balay } 412a7e14dcfSSatish Balay /* Check for type from options */ 413441846f8SBarry Smith ierr = PetscOptionsFList("-tao_type","Tao Solver type","TaoSetType",TaoList,default_type,type,256,&flg);CHKERRQ(ierr); 414a7e14dcfSSatish Balay if (flg) { 415a7e14dcfSSatish Balay ierr = TaoSetType(tao,type);CHKERRQ(ierr); 416a7e14dcfSSatish Balay } else if (!((PetscObject)tao)->type_name) { 417302440fdSBarry Smith ierr = TaoSetType(tao,default_type);CHKERRQ(ierr); 418a7e14dcfSSatish Balay } 419a7e14dcfSSatish Balay 4206552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_catol","Stop if constraints violations within","TaoSetConstraintTolerances",tao->catol,&tao->catol,&flg);CHKERRQ(ierr); 4216552cf8aSJason Sarich if (flg) tao->catol_changed=PETSC_TRUE; 4226552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_crtol","Stop if relative contraint violations within","TaoSetConstraintTolerances",tao->crtol,&tao->crtol,&flg);CHKERRQ(ierr); 4236552cf8aSJason Sarich if (flg) tao->crtol_changed=PETSC_TRUE; 4246552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_gatol","Stop if norm of gradient less than","TaoSetTolerances",tao->gatol,&tao->gatol,&flg);CHKERRQ(ierr); 4256552cf8aSJason Sarich if (flg) tao->gatol_changed=PETSC_TRUE; 4266552cf8aSJason 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); 4276552cf8aSJason Sarich if (flg) tao->grtol_changed=PETSC_TRUE; 4286552cf8aSJason 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); 4296552cf8aSJason Sarich if (flg) tao->gttol_changed=PETSC_TRUE; 4306552cf8aSJason Sarich ierr = PetscOptionsInt("-tao_max_it","Stop if iteration number exceeds","TaoSetMaximumIterations",tao->max_it,&tao->max_it,&flg);CHKERRQ(ierr); 4316552cf8aSJason Sarich if (flg) tao->max_it_changed=PETSC_TRUE; 4326552cf8aSJason Sarich ierr = PetscOptionsInt("-tao_max_funcs","Stop if number of function evaluations exceeds","TaoSetMaximumFunctionEvaluations",tao->max_funcs,&tao->max_funcs,&flg);CHKERRQ(ierr); 4336552cf8aSJason Sarich if (flg) tao->max_funcs_changed=PETSC_TRUE; 4346552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_fmin","Stop if function less than","TaoSetFunctionLowerBound",tao->fmin,&tao->fmin,&flg);CHKERRQ(ierr); 4356552cf8aSJason Sarich if (flg) tao->fmin_changed=PETSC_TRUE; 4366552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_steptol","Stop if step size or trust region radius less than","",tao->steptol,&tao->steptol,&flg);CHKERRQ(ierr); 4376552cf8aSJason Sarich if (flg) tao->steptol_changed=PETSC_TRUE; 4386552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_trust0","Initial trust region radius","TaoSetTrustRegionRadius",tao->trust0,&tao->trust0,&flg);CHKERRQ(ierr); 4396552cf8aSJason Sarich if (flg) tao->trust0_changed=PETSC_TRUE; 440a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_solution","view solution vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 441a7e14dcfSSatish Balay if (flg) { 442a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 443a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoSolutionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 444a7e14dcfSSatish Balay } 445a7e14dcfSSatish Balay 4468afaa268SBarry Smith ierr = PetscOptionsBool("-tao_converged_reason","Print reason for TAO converged","TaoSolve",tao->printreason,&tao->printreason,NULL);CHKERRQ(ierr); 447a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_gradient","view gradient vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 448a7e14dcfSSatish Balay if (flg) { 449a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 450a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoGradientMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 451a7e14dcfSSatish Balay } 452a7e14dcfSSatish Balay 453a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_stepdirection","view step direction vector after each iteration","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 454a7e14dcfSSatish Balay if (flg) { 455a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 456a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoStepDirectionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 457a7e14dcfSSatish Balay } 458a7e14dcfSSatish Balay 459a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_separableobjective","view separable objective vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 460a7e14dcfSSatish Balay if (flg) { 461a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 462a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoSeparableObjectiveMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 463a7e14dcfSSatish Balay } 464a7e14dcfSSatish Balay 465a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_monitor","Use the default convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 466a7e14dcfSSatish Balay if (flg) { 467a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 46898ea980cSBarry Smith ierr = TaoSetMonitor(tao,TaoMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 469a7e14dcfSSatish Balay } 470a7e14dcfSSatish Balay 4718d5ead36SAlp Dener ierr = PetscOptionsString("-tao_gmonitor","Use the convergence monitor with extra globalization info","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 4728d5ead36SAlp Dener if (flg) { 4738d5ead36SAlp Dener ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 4748d5ead36SAlp Dener ierr = TaoSetMonitor(tao,TaoDefaultGMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 4758d5ead36SAlp Dener } 4768d5ead36SAlp Dener 477a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_smonitor","Use the short convergence monitor","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 478a7e14dcfSSatish Balay if (flg) { 479a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 480a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoDefaultSMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 481a7e14dcfSSatish Balay } 482a7e14dcfSSatish Balay 483a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_cmonitor","Use the default convergence monitor with constraint norm","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 484a7e14dcfSSatish Balay if (flg) { 485a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 486a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoDefaultCMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 487a7e14dcfSSatish Balay } 488a7e14dcfSSatish Balay 489a7e14dcfSSatish Balay 4908afaa268SBarry Smith flg = PETSC_FALSE; 4918afaa268SBarry Smith ierr = PetscOptionsBool("-tao_cancelmonitors","cancel all monitors and call any registered destroy routines","TaoCancelMonitors",flg,&flg,NULL);CHKERRQ(ierr); 492a7e14dcfSSatish Balay if (flg) {ierr = TaoCancelMonitors(tao);CHKERRQ(ierr);} 493a7e14dcfSSatish Balay 4948afaa268SBarry Smith flg = PETSC_FALSE; 4958afaa268SBarry Smith ierr = PetscOptionsBool("-tao_draw_solution","Plot solution vector at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr); 496a7e14dcfSSatish Balay if (flg) { 497e882e171SHong Zhang TaoMonitorDrawCtx drawctx; 498e882e171SHong Zhang PetscInt howoften = 1; 499e882e171SHong Zhang ierr = TaoMonitorDrawCtxCreate(PetscObjectComm((PetscObject)tao),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&drawctx);CHKERRQ(ierr); 500e882e171SHong Zhang ierr = TaoSetMonitor(tao,TaoDrawSolutionMonitor,drawctx,(PetscErrorCode (*)(void**))TaoMonitorDrawCtxDestroy);CHKERRQ(ierr); 501a7e14dcfSSatish Balay } 502a7e14dcfSSatish Balay 5038afaa268SBarry Smith flg = PETSC_FALSE; 5048afaa268SBarry Smith ierr = PetscOptionsBool("-tao_draw_step","plots step direction at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr); 505a7e14dcfSSatish Balay if (flg) { 50647a47007SBarry Smith ierr = TaoSetMonitor(tao,TaoDrawStepMonitor,NULL,NULL);CHKERRQ(ierr); 507a7e14dcfSSatish Balay } 508a7e14dcfSSatish Balay 5098afaa268SBarry Smith flg = PETSC_FALSE; 5108afaa268SBarry Smith ierr = PetscOptionsBool("-tao_draw_gradient","plots gradient at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr); 511a7e14dcfSSatish Balay if (flg) { 512e882e171SHong Zhang TaoMonitorDrawCtx drawctx; 513e882e171SHong Zhang PetscInt howoften = 1; 514e882e171SHong Zhang ierr = TaoMonitorDrawCtxCreate(PetscObjectComm((PetscObject)tao),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&drawctx);CHKERRQ(ierr); 515e882e171SHong Zhang ierr = TaoSetMonitor(tao,TaoDrawGradientMonitor,drawctx,(PetscErrorCode (*)(void**))TaoMonitorDrawCtxDestroy);CHKERRQ(ierr); 516a7e14dcfSSatish Balay } 5178afaa268SBarry Smith flg = PETSC_FALSE; 5188afaa268SBarry Smith ierr = PetscOptionsBool("-tao_fd_gradient","compute gradient using finite differences","TaoDefaultComputeGradient",flg,&flg,NULL);CHKERRQ(ierr); 519a7e14dcfSSatish Balay if (flg) { 52047a47007SBarry Smith ierr = TaoSetGradientRoutine(tao,TaoDefaultComputeGradient,NULL);CHKERRQ(ierr); 521a7e14dcfSSatish Balay } 522f4c1ad5cSStefano Zampini flg = PETSC_FALSE; 523f4c1ad5cSStefano Zampini ierr = PetscOptionsBool("-tao_fd_hessian","compute hessian using finite differences","TaoDefaultComputeHessian",flg,&flg,NULL);CHKERRQ(ierr); 524f4c1ad5cSStefano Zampini if (flg) { 525f4c1ad5cSStefano Zampini Mat H; 526f4c1ad5cSStefano Zampini 527f4c1ad5cSStefano Zampini ierr = MatCreate(PetscObjectComm((PetscObject)tao),&H);CHKERRQ(ierr); 528f4c1ad5cSStefano Zampini ierr = MatSetType(H,MATAIJ);CHKERRQ(ierr); 529f4c1ad5cSStefano Zampini ierr = TaoSetHessianRoutine(tao,H,H,TaoDefaultComputeHessian,NULL);CHKERRQ(ierr); 530f4c1ad5cSStefano Zampini ierr = MatDestroy(&H);CHKERRQ(ierr); 531f4c1ad5cSStefano Zampini } 532f4c1ad5cSStefano Zampini flg = PETSC_FALSE; 533f4c1ad5cSStefano Zampini ierr = PetscOptionsBool("-tao_mf_hessian","compute matrix-free hessian using finite differences","TaoDefaultComputeHessianMFFD",flg,&flg,NULL);CHKERRQ(ierr); 534f4c1ad5cSStefano Zampini if (flg) { 535f4c1ad5cSStefano Zampini Mat H; 536f4c1ad5cSStefano Zampini 537f4c1ad5cSStefano Zampini ierr = MatCreate(PetscObjectComm((PetscObject)tao),&H);CHKERRQ(ierr); 538f4c1ad5cSStefano Zampini ierr = TaoSetHessianRoutine(tao,H,H,TaoDefaultComputeHessianMFFD,NULL);CHKERRQ(ierr); 539f4c1ad5cSStefano Zampini ierr = MatDestroy(&H);CHKERRQ(ierr); 540f4c1ad5cSStefano Zampini } 541f4c1ad5cSStefano Zampini ierr = PetscOptionsEnum("-tao_subset_type","subset type","",TaoSubSetTypes,(PetscEnum)tao->subset_type,(PetscEnum*)&tao->subset_type,NULL);CHKERRQ(ierr); 542a7e14dcfSSatish Balay 543a7e14dcfSSatish Balay if (tao->ops->setfromoptions) { 5441a1499c8SBarry Smith ierr = (*tao->ops->setfromoptions)(PetscOptionsObject,tao);CHKERRQ(ierr); 545a7e14dcfSSatish Balay } 546a7e14dcfSSatish Balay } 547a7e14dcfSSatish Balay ierr = PetscOptionsEnd();CHKERRQ(ierr); 548a7e14dcfSSatish Balay PetscFunctionReturn(0); 549a7e14dcfSSatish Balay } 550a7e14dcfSSatish Balay 551a7e14dcfSSatish Balay /*@C 552441846f8SBarry Smith TaoView - Prints information about the Tao 553a7e14dcfSSatish Balay 554441846f8SBarry Smith Collective on Tao 555a7e14dcfSSatish Balay 556a7e14dcfSSatish Balay InputParameters: 557441846f8SBarry Smith + tao - the Tao context 558a7e14dcfSSatish Balay - viewer - visualization context 559a7e14dcfSSatish Balay 560a7e14dcfSSatish Balay Options Database Key: 561a7e14dcfSSatish Balay . -tao_view - Calls TaoView() at the end of TaoSolve() 562a7e14dcfSSatish Balay 563a7e14dcfSSatish Balay Notes: 564a7e14dcfSSatish Balay The available visualization contexts include 565a7e14dcfSSatish Balay + PETSC_VIEWER_STDOUT_SELF - standard output (default) 566a7e14dcfSSatish Balay - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 567a7e14dcfSSatish Balay output where only the first processor opens 568a7e14dcfSSatish Balay the file. All other processors send their 569a7e14dcfSSatish Balay data to the first processor to print. 570a7e14dcfSSatish Balay 571a7e14dcfSSatish Balay Level: beginner 572a7e14dcfSSatish Balay 573a7e14dcfSSatish Balay .seealso: PetscViewerASCIIOpen() 574a7e14dcfSSatish Balay @*/ 575441846f8SBarry Smith PetscErrorCode TaoView(Tao tao, PetscViewer viewer) 576a7e14dcfSSatish Balay { 577a7e14dcfSSatish Balay PetscErrorCode ierr; 578a7e14dcfSSatish Balay PetscBool isascii,isstring; 579b625d6c7SJed Brown TaoType type; 58047a47007SBarry Smith 581a7e14dcfSSatish Balay PetscFunctionBegin; 582441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 583a7e14dcfSSatish Balay if (!viewer) { 584a7e14dcfSSatish Balay ierr = PetscViewerASCIIGetStdout(((PetscObject)tao)->comm,&viewer);CHKERRQ(ierr); 585a7e14dcfSSatish Balay } 586a7e14dcfSSatish Balay PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 587a7e14dcfSSatish Balay PetscCheckSameComm(tao,1,viewer,2); 588a7e14dcfSSatish Balay 589a7e14dcfSSatish Balay ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 590a7e14dcfSSatish Balay ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 591a7e14dcfSSatish Balay if (isascii) { 59263b15415SAlp Dener PetscInt tabs; 59363b15415SAlp Dener ierr = PetscViewerASCIIGetTab(viewer, &tabs);CHKERRQ(ierr); 59463b15415SAlp Dener ierr = PetscViewerASCIISetTab(viewer, ((PetscObject)tao)->tablevel);CHKERRQ(ierr); 595a7e14dcfSSatish Balay ierr = PetscObjectPrintClassNamePrefixType((PetscObject)tao,viewer);CHKERRQ(ierr); 596a7e14dcfSSatish Balay 597a7e14dcfSSatish Balay if (tao->ops->view) { 598a7e14dcfSSatish Balay ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 599a7e14dcfSSatish Balay ierr = (*tao->ops->view)(tao,viewer);CHKERRQ(ierr); 600a7e14dcfSSatish Balay ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 601a7e14dcfSSatish Balay } 6028d3f3ddaSAlp Dener if (tao->linesearch) { 6038d3f3ddaSAlp Dener ierr = TaoLineSearchView(tao->linesearch,viewer);CHKERRQ(ierr); 6048d3f3ddaSAlp Dener } 605a7e14dcfSSatish Balay if (tao->ksp) { 60619b5c101SAlp Dener ierr = KSPView(tao->ksp,viewer);CHKERRQ(ierr); 60719b5c101SAlp Dener ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 608ae93cb3cSJason Sarich ierr = PetscViewerASCIIPrintf(viewer,"total KSP iterations: %D\n",tao->ksp_tot_its);CHKERRQ(ierr); 60919b5c101SAlp Dener ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 610a7e14dcfSSatish Balay } 61119b5c101SAlp Dener 61219b5c101SAlp Dener ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 61319b5c101SAlp Dener 614a7e14dcfSSatish Balay if (tao->XL || tao->XU) { 615302440fdSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Active Set subset type: %s\n",TaoSubSetTypes[tao->subset_type]);CHKERRQ(ierr); 616a7e14dcfSSatish Balay } 617a7e14dcfSSatish Balay 61847a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"convergence tolerances: gatol=%g,",(double)tao->gatol);CHKERRQ(ierr); 61947a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," steptol=%g,",(double)tao->steptol);CHKERRQ(ierr); 62047a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," gttol=%g\n",(double)tao->gttol);CHKERRQ(ierr); 62147a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Residual in Function/Gradient:=%g\n",(double)tao->residual);CHKERRQ(ierr); 622a7e14dcfSSatish Balay 623a7e14dcfSSatish Balay if (tao->cnorm>0 || tao->catol>0 || tao->crtol>0){ 624a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances:");CHKERRQ(ierr); 62547a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," catol=%g,",(double)tao->catol);CHKERRQ(ierr); 62647a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," crtol=%g\n",(double)tao->crtol);CHKERRQ(ierr); 62747a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Residual in Constraints:=%g\n",(double)tao->cnorm);CHKERRQ(ierr); 628a7e14dcfSSatish Balay } 629a7e14dcfSSatish Balay 630a7e14dcfSSatish Balay if (tao->trust < tao->steptol){ 63147a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: steptol=%g\n",(double)tao->steptol);CHKERRQ(ierr); 63247a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"Final trust region radius:=%g\n",(double)tao->trust);CHKERRQ(ierr); 633a7e14dcfSSatish Balay } 634a7e14dcfSSatish Balay 635a7e14dcfSSatish Balay if (tao->fmin>-1.e25){ 63647a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: function minimum=%g\n",(double)tao->fmin);CHKERRQ(ierr); 637a7e14dcfSSatish Balay } 63847a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Objective value=%g\n",(double)tao->fc);CHKERRQ(ierr); 639a7e14dcfSSatish Balay 64047a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of iterations=%D, ",tao->niter);CHKERRQ(ierr); 641a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," (max: %D)\n",tao->max_it);CHKERRQ(ierr); 642a7e14dcfSSatish Balay 643a7e14dcfSSatish Balay if (tao->nfuncs>0){ 64447a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of function evaluations=%D,",tao->nfuncs);CHKERRQ(ierr); 64547a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," max: %D\n",tao->max_funcs);CHKERRQ(ierr); 646a7e14dcfSSatish Balay } 647a7e14dcfSSatish Balay if (tao->ngrads>0){ 64847a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of gradient evaluations=%D,",tao->ngrads);CHKERRQ(ierr); 64947a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," max: %D\n",tao->max_funcs);CHKERRQ(ierr); 650a7e14dcfSSatish Balay } 651a7e14dcfSSatish Balay if (tao->nfuncgrads>0){ 65247a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of function/gradient evaluations=%D,",tao->nfuncgrads);CHKERRQ(ierr); 65347a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," (max: %D)\n",tao->max_funcs);CHKERRQ(ierr); 654a7e14dcfSSatish Balay } 655a7e14dcfSSatish Balay if (tao->nhess>0){ 65647a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of Hessian evaluations=%D\n",tao->nhess);CHKERRQ(ierr); 657a7e14dcfSSatish Balay } 658a7e14dcfSSatish Balay /* if (tao->linear_its>0){ 65947a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total Krylov method iterations=%D\n",tao->linear_its);CHKERRQ(ierr); 660a7e14dcfSSatish Balay }*/ 661a7e14dcfSSatish Balay if (tao->nconstraints>0){ 66247a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of constraint function evaluations=%D\n",tao->nconstraints);CHKERRQ(ierr); 663a7e14dcfSSatish Balay } 664a7e14dcfSSatish Balay if (tao->njac>0){ 66547a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of Jacobian evaluations=%D\n",tao->njac);CHKERRQ(ierr); 666a7e14dcfSSatish Balay } 667a7e14dcfSSatish Balay 668a7e14dcfSSatish Balay if (tao->reason>0){ 669a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer, "Solution converged: ");CHKERRQ(ierr); 670a7e14dcfSSatish Balay switch (tao->reason) { 671a7e14dcfSSatish Balay case TAO_CONVERGED_GATOL: 672a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," ||g(X)|| <= gatol\n");CHKERRQ(ierr); 673a7e14dcfSSatish Balay break; 674a7e14dcfSSatish Balay case TAO_CONVERGED_GRTOL: 675a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/|f(X)| <= grtol\n");CHKERRQ(ierr); 676a7e14dcfSSatish Balay break; 677a7e14dcfSSatish Balay case TAO_CONVERGED_GTTOL: 678a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/||g(X0)|| <= gttol\n");CHKERRQ(ierr); 679a7e14dcfSSatish Balay break; 680a7e14dcfSSatish Balay case TAO_CONVERGED_STEPTOL: 681a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," Steptol -- step size small\n");CHKERRQ(ierr); 682a7e14dcfSSatish Balay break; 683a7e14dcfSSatish Balay case TAO_CONVERGED_MINF: 684a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," Minf -- f < fmin\n");CHKERRQ(ierr); 685a7e14dcfSSatish Balay break; 686a7e14dcfSSatish Balay case TAO_CONVERGED_USER: 687a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr); 688a7e14dcfSSatish Balay break; 689a7e14dcfSSatish Balay default: 690a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 691a7e14dcfSSatish Balay break; 692a7e14dcfSSatish Balay } 693a7e14dcfSSatish Balay 694a7e14dcfSSatish Balay } else { 69547cfc4faSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Solver terminated: %d",tao->reason);CHKERRQ(ierr); 696a7e14dcfSSatish Balay switch (tao->reason) { 697a7e14dcfSSatish Balay case TAO_DIVERGED_MAXITS: 69847a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Maximum Iterations\n");CHKERRQ(ierr); 699a7e14dcfSSatish Balay break; 700a7e14dcfSSatish Balay case TAO_DIVERGED_NAN: 70147a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," NAN or Inf encountered\n");CHKERRQ(ierr); 702a7e14dcfSSatish Balay break; 703a7e14dcfSSatish Balay case TAO_DIVERGED_MAXFCN: 70447a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Maximum Function Evaluations\n");CHKERRQ(ierr); 705a7e14dcfSSatish Balay break; 706a7e14dcfSSatish Balay case TAO_DIVERGED_LS_FAILURE: 70747a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Line Search Failure\n");CHKERRQ(ierr); 708a7e14dcfSSatish Balay break; 709a7e14dcfSSatish Balay case TAO_DIVERGED_TR_REDUCTION: 71047a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Trust Region too small\n");CHKERRQ(ierr); 711a7e14dcfSSatish Balay break; 712a7e14dcfSSatish Balay case TAO_DIVERGED_USER: 71347a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr); 714a7e14dcfSSatish Balay break; 715a7e14dcfSSatish Balay default: 716a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 717a7e14dcfSSatish Balay break; 718a7e14dcfSSatish Balay } 719a7e14dcfSSatish Balay } 720a7e14dcfSSatish Balay ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 72163b15415SAlp Dener ierr = PetscViewerASCIISetTab(viewer, tabs); CHKERRQ(ierr); 722a7e14dcfSSatish Balay } else if (isstring) { 723a7e14dcfSSatish Balay ierr = TaoGetType(tao,&type);CHKERRQ(ierr); 724a7e14dcfSSatish Balay ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr); 725a7e14dcfSSatish Balay } 726a7e14dcfSSatish Balay PetscFunctionReturn(0); 727a7e14dcfSSatish Balay } 728a7e14dcfSSatish Balay 729a7e14dcfSSatish Balay /*@ 730a7e14dcfSSatish Balay TaoSetTolerances - Sets parameters used in TAO convergence tests 731a7e14dcfSSatish Balay 732441846f8SBarry Smith Logically collective on Tao 733a7e14dcfSSatish Balay 734a7e14dcfSSatish Balay Input Parameters: 735441846f8SBarry Smith + tao - the Tao context 736a7e14dcfSSatish Balay . gatol - stop if norm of gradient is less than this 737a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this 738a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by this factor 739a7e14dcfSSatish Balay 740a7e14dcfSSatish Balay Options Database Keys: 741e52336cbSBarry Smith + -tao_gatol <gatol> - Sets gatol 742a7e14dcfSSatish Balay . -tao_grtol <grtol> - Sets grtol 743a7e14dcfSSatish Balay - -tao_gttol <gttol> - Sets gttol 744a7e14dcfSSatish Balay 745a7e14dcfSSatish Balay Stopping Criteria: 746a7e14dcfSSatish Balay $ ||g(X)|| <= gatol 747a7e14dcfSSatish Balay $ ||g(X)|| / |f(X)| <= grtol 748a7e14dcfSSatish Balay $ ||g(X)|| / ||g(X0)|| <= gttol 749a7e14dcfSSatish Balay 750a7e14dcfSSatish Balay Notes: 751a7e14dcfSSatish Balay Use PETSC_DEFAULT to leave one or more tolerances unchanged. 752a7e14dcfSSatish Balay 753a7e14dcfSSatish Balay Level: beginner 754a7e14dcfSSatish Balay 755a7e14dcfSSatish Balay .seealso: TaoGetTolerances() 756a7e14dcfSSatish Balay 757a7e14dcfSSatish Balay @*/ 758e52336cbSBarry Smith PetscErrorCode TaoSetTolerances(Tao tao, PetscReal gatol, PetscReal grtol, PetscReal gttol) 759a7e14dcfSSatish Balay { 760a7e14dcfSSatish Balay PetscErrorCode ierr; 76147a47007SBarry Smith 762a7e14dcfSSatish Balay PetscFunctionBegin; 763441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 764a7e14dcfSSatish Balay 765a7e14dcfSSatish Balay if (gatol != PETSC_DEFAULT) { 766a7e14dcfSSatish Balay if (gatol<0) { 767955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative gatol -- ignored.\n");CHKERRQ(ierr); 768a7e14dcfSSatish Balay } else { 769a7e14dcfSSatish Balay tao->gatol = PetscMax(0,gatol); 7706552cf8aSJason Sarich tao->gatol_changed=PETSC_TRUE; 771a7e14dcfSSatish Balay } 772a7e14dcfSSatish Balay } 773a7e14dcfSSatish Balay 774a7e14dcfSSatish Balay if (grtol != PETSC_DEFAULT) { 775a7e14dcfSSatish Balay if (grtol<0) { 776955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative grtol -- ignored.\n");CHKERRQ(ierr); 777a7e14dcfSSatish Balay } else { 778a7e14dcfSSatish Balay tao->grtol = PetscMax(0,grtol); 7796552cf8aSJason Sarich tao->grtol_changed=PETSC_TRUE; 780a7e14dcfSSatish Balay } 781a7e14dcfSSatish Balay } 782a7e14dcfSSatish Balay 783a7e14dcfSSatish Balay if (gttol != PETSC_DEFAULT) { 784a7e14dcfSSatish Balay if (gttol<0) { 785955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative gttol -- ignored.\n");CHKERRQ(ierr); 786a7e14dcfSSatish Balay } else { 787a7e14dcfSSatish Balay tao->gttol = PetscMax(0,gttol); 7886552cf8aSJason Sarich tao->gttol_changed=PETSC_TRUE; 789a7e14dcfSSatish Balay } 790a7e14dcfSSatish Balay } 791a7e14dcfSSatish Balay PetscFunctionReturn(0); 792a7e14dcfSSatish Balay } 793a7e14dcfSSatish Balay 794a7e14dcfSSatish Balay /*@ 79558417fe7SBarry Smith TaoSetConstraintTolerances - Sets constraint tolerance parameters used in TAO convergence tests 796a7e14dcfSSatish Balay 797441846f8SBarry Smith Logically collective on Tao 798a7e14dcfSSatish Balay 799a7e14dcfSSatish Balay Input Parameters: 800441846f8SBarry Smith + tao - the Tao context 801e52336cbSBarry Smith . catol - absolute constraint tolerance, constraint norm must be less than catol for used for gatol convergence criteria 802e52336cbSBarry Smith - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for gatol, gttol convergence criteria 803a7e14dcfSSatish Balay 804a7e14dcfSSatish Balay Options Database Keys: 805a7e14dcfSSatish Balay + -tao_catol <catol> - Sets catol 806a7e14dcfSSatish Balay - -tao_crtol <crtol> - Sets crtol 807a7e14dcfSSatish Balay 8086552cf8aSJason Sarich Notes: 8096552cf8aSJason Sarich Use PETSC_DEFAULT to leave any tolerance unchanged. 8106552cf8aSJason Sarich 811a7e14dcfSSatish Balay Level: intermediate 812a7e14dcfSSatish Balay 81358417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoGetConstraintTolerances(), TaoSetTolerances() 814a7e14dcfSSatish Balay 815a7e14dcfSSatish Balay @*/ 816441846f8SBarry Smith PetscErrorCode TaoSetConstraintTolerances(Tao tao, PetscReal catol, PetscReal crtol) 817a7e14dcfSSatish Balay { 818a7e14dcfSSatish Balay PetscErrorCode ierr; 81947a47007SBarry Smith 820a7e14dcfSSatish Balay PetscFunctionBegin; 821441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 822a7e14dcfSSatish Balay 823a7e14dcfSSatish Balay if (catol != PETSC_DEFAULT) { 824a7e14dcfSSatish Balay if (catol<0) { 825955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative catol -- ignored.\n");CHKERRQ(ierr); 826a7e14dcfSSatish Balay } else { 827a7e14dcfSSatish Balay tao->catol = PetscMax(0,catol); 8286552cf8aSJason Sarich tao->catol_changed=PETSC_TRUE; 829a7e14dcfSSatish Balay } 830a7e14dcfSSatish Balay } 831a7e14dcfSSatish Balay 832a7e14dcfSSatish Balay if (crtol != PETSC_DEFAULT) { 833a7e14dcfSSatish Balay if (crtol<0) { 834955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative crtol -- ignored.\n");CHKERRQ(ierr); 835a7e14dcfSSatish Balay } else { 836a7e14dcfSSatish Balay tao->crtol = PetscMax(0,crtol); 8376552cf8aSJason Sarich tao->crtol_changed=PETSC_TRUE; 838a7e14dcfSSatish Balay } 839a7e14dcfSSatish Balay } 840a7e14dcfSSatish Balay PetscFunctionReturn(0); 841a7e14dcfSSatish Balay } 842a7e14dcfSSatish Balay 84358417fe7SBarry Smith /*@ 84458417fe7SBarry Smith TaoGetConstraintTolerances - Gets constraint tolerance parameters used in TAO convergence tests 84558417fe7SBarry Smith 84658417fe7SBarry Smith Not ollective 84758417fe7SBarry Smith 84858417fe7SBarry Smith Input Parameter: 84958417fe7SBarry Smith . tao - the Tao context 85058417fe7SBarry Smith 85158417fe7SBarry Smith Output Parameter: 852e52336cbSBarry Smith + catol - absolute constraint tolerance, constraint norm must be less than catol for used for gatol convergence criteria 853e52336cbSBarry Smith - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for gatol, gttol convergence criteria 85458417fe7SBarry Smith 85558417fe7SBarry Smith Level: intermediate 85658417fe7SBarry Smith 85758417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoSetTolerances(), TaoSetConstraintTolerances() 85858417fe7SBarry Smith 85958417fe7SBarry Smith @*/ 86058417fe7SBarry Smith PetscErrorCode TaoGetConstraintTolerances(Tao tao, PetscReal *catol, PetscReal *crtol) 86158417fe7SBarry Smith { 86258417fe7SBarry Smith PetscFunctionBegin; 86358417fe7SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 86458417fe7SBarry Smith if (catol) *catol = tao->catol; 86558417fe7SBarry Smith if (crtol) *crtol = tao->crtol; 86658417fe7SBarry Smith PetscFunctionReturn(0); 86758417fe7SBarry Smith } 86858417fe7SBarry Smith 869a7e14dcfSSatish Balay /*@ 870a7e14dcfSSatish Balay TaoSetFunctionLowerBound - Sets a bound on the solution objective value. 871a7e14dcfSSatish Balay When an approximate solution with an objective value below this number 872a7e14dcfSSatish Balay has been found, the solver will terminate. 873a7e14dcfSSatish Balay 874441846f8SBarry Smith Logically Collective on Tao 875a7e14dcfSSatish Balay 876a7e14dcfSSatish Balay Input Parameters: 877441846f8SBarry Smith + tao - the Tao solver context 878a7e14dcfSSatish Balay - fmin - the tolerance 879a7e14dcfSSatish Balay 880a7e14dcfSSatish Balay Options Database Keys: 881a7e14dcfSSatish Balay . -tao_fmin <fmin> - sets the minimum function value 882a7e14dcfSSatish Balay 883a7e14dcfSSatish Balay Level: intermediate 884a7e14dcfSSatish Balay 885a7e14dcfSSatish Balay .seealso: TaoSetTolerances() 886a7e14dcfSSatish Balay @*/ 887441846f8SBarry Smith PetscErrorCode TaoSetFunctionLowerBound(Tao tao,PetscReal fmin) 888a7e14dcfSSatish Balay { 889a7e14dcfSSatish Balay PetscFunctionBegin; 890441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 891a7e14dcfSSatish Balay tao->fmin = fmin; 8926552cf8aSJason Sarich tao->fmin_changed=PETSC_TRUE; 893a7e14dcfSSatish Balay PetscFunctionReturn(0); 894a7e14dcfSSatish Balay } 895a7e14dcfSSatish Balay 896a7e14dcfSSatish Balay /*@ 8978e96d397SJason Sarich TaoGetFunctionLowerBound - Gets the bound on the solution objective value. 898a7e14dcfSSatish Balay When an approximate solution with an objective value below this number 899a7e14dcfSSatish Balay has been found, the solver will terminate. 900a7e14dcfSSatish Balay 901441846f8SBarry Smith Not collective on Tao 902a7e14dcfSSatish Balay 903a7e14dcfSSatish Balay Input Parameters: 904441846f8SBarry Smith . tao - the Tao solver context 905a7e14dcfSSatish Balay 906a7e14dcfSSatish Balay OutputParameters: 907a7e14dcfSSatish Balay . fmin - the minimum function value 908a7e14dcfSSatish Balay 909a7e14dcfSSatish Balay Level: intermediate 910a7e14dcfSSatish Balay 911a7e14dcfSSatish Balay .seealso: TaoSetFunctionLowerBound() 912a7e14dcfSSatish Balay @*/ 913441846f8SBarry Smith PetscErrorCode TaoGetFunctionLowerBound(Tao tao,PetscReal *fmin) 914a7e14dcfSSatish Balay { 915a7e14dcfSSatish Balay PetscFunctionBegin; 916441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 917a7e14dcfSSatish Balay *fmin = tao->fmin; 918a7e14dcfSSatish Balay PetscFunctionReturn(0); 919a7e14dcfSSatish Balay } 920a7e14dcfSSatish Balay 921a7e14dcfSSatish Balay /*@ 922a7e14dcfSSatish Balay TaoSetMaximumFunctionEvaluations - Sets a maximum number of 923a7e14dcfSSatish Balay function evaluations. 924a7e14dcfSSatish Balay 925441846f8SBarry Smith Logically Collective on Tao 926a7e14dcfSSatish Balay 927a7e14dcfSSatish Balay Input Parameters: 928441846f8SBarry Smith + tao - the Tao solver context 929a7e14dcfSSatish Balay - nfcn - the maximum number of function evaluations (>=0) 930a7e14dcfSSatish Balay 931a7e14dcfSSatish Balay Options Database Keys: 932a7e14dcfSSatish Balay . -tao_max_funcs <nfcn> - sets the maximum number of function evaluations 933a7e14dcfSSatish Balay 934a7e14dcfSSatish Balay Level: intermediate 935a7e14dcfSSatish Balay 936a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumIterations() 937a7e14dcfSSatish Balay @*/ 938a7e14dcfSSatish Balay 939441846f8SBarry Smith PetscErrorCode TaoSetMaximumFunctionEvaluations(Tao tao,PetscInt nfcn) 940a7e14dcfSSatish Balay { 941a7e14dcfSSatish Balay PetscFunctionBegin; 942441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 94347a47007SBarry Smith tao->max_funcs = PetscMax(0,nfcn); 9446552cf8aSJason Sarich tao->max_funcs_changed=PETSC_TRUE; 945a7e14dcfSSatish Balay PetscFunctionReturn(0); 946a7e14dcfSSatish Balay } 947a7e14dcfSSatish Balay 948a7e14dcfSSatish Balay /*@ 949a7e14dcfSSatish Balay TaoGetMaximumFunctionEvaluations - Sets a maximum number of 950a7e14dcfSSatish Balay function evaluations. 951a7e14dcfSSatish Balay 952a7e14dcfSSatish Balay Not Collective 953a7e14dcfSSatish Balay 954a7e14dcfSSatish Balay Input Parameters: 955441846f8SBarry Smith . tao - the Tao solver context 956a7e14dcfSSatish Balay 957a7e14dcfSSatish Balay Output Parameters: 958a7e14dcfSSatish Balay . nfcn - the maximum number of function evaluations 959a7e14dcfSSatish Balay 960a7e14dcfSSatish Balay Level: intermediate 961a7e14dcfSSatish Balay 962a7e14dcfSSatish Balay .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumIterations() 963a7e14dcfSSatish Balay @*/ 964a7e14dcfSSatish Balay 965441846f8SBarry Smith PetscErrorCode TaoGetMaximumFunctionEvaluations(Tao tao,PetscInt *nfcn) 966a7e14dcfSSatish Balay { 967a7e14dcfSSatish Balay PetscFunctionBegin; 968441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 969a7e14dcfSSatish Balay *nfcn = tao->max_funcs; 970a7e14dcfSSatish Balay PetscFunctionReturn(0); 971a7e14dcfSSatish Balay } 972a7e14dcfSSatish Balay 973770232b9SCe Qin /*@ 974770232b9SCe Qin TaoGetCurrentFunctionEvaluations - Get current number of 975770232b9SCe Qin function evaluations. 976770232b9SCe Qin 977770232b9SCe Qin Not Collective 978770232b9SCe Qin 979770232b9SCe Qin Input Parameters: 980770232b9SCe Qin . tao - the Tao solver context 981770232b9SCe Qin 982770232b9SCe Qin Output Parameters: 983770232b9SCe Qin . nfuncs - the current number of function evaluations 984770232b9SCe Qin 985770232b9SCe Qin Level: intermediate 986770232b9SCe Qin 987770232b9SCe Qin .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumFunctionEvaluations(), TaoGetMaximumIterations() 988770232b9SCe Qin @*/ 989770232b9SCe Qin 990770232b9SCe Qin PetscErrorCode TaoGetCurrentFunctionEvaluations(Tao tao,PetscInt *nfuncs) 991770232b9SCe Qin { 992770232b9SCe Qin PetscFunctionBegin; 993770232b9SCe Qin PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 994770232b9SCe Qin *nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads); 995770232b9SCe Qin PetscFunctionReturn(0); 996770232b9SCe Qin } 997770232b9SCe Qin 998a7e14dcfSSatish Balay /*@ 999a7e14dcfSSatish Balay TaoSetMaximumIterations - Sets a maximum number of iterates. 1000a7e14dcfSSatish Balay 1001441846f8SBarry Smith Logically Collective on Tao 1002a7e14dcfSSatish Balay 1003a7e14dcfSSatish Balay Input Parameters: 1004441846f8SBarry Smith + tao - the Tao solver context 1005a7e14dcfSSatish Balay - maxits - the maximum number of iterates (>=0) 1006a7e14dcfSSatish Balay 1007a7e14dcfSSatish Balay Options Database Keys: 1008a7e14dcfSSatish Balay . -tao_max_it <its> - sets the maximum number of iterations 1009a7e14dcfSSatish Balay 1010a7e14dcfSSatish Balay Level: intermediate 1011a7e14dcfSSatish Balay 1012a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumFunctionEvaluations() 1013a7e14dcfSSatish Balay @*/ 1014441846f8SBarry Smith PetscErrorCode TaoSetMaximumIterations(Tao tao,PetscInt maxits) 1015a7e14dcfSSatish Balay { 1016a7e14dcfSSatish Balay PetscFunctionBegin; 1017441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 101847a47007SBarry Smith tao->max_it = PetscMax(0,maxits); 10196552cf8aSJason Sarich tao->max_it_changed=PETSC_TRUE; 1020a7e14dcfSSatish Balay PetscFunctionReturn(0); 1021a7e14dcfSSatish Balay } 1022a7e14dcfSSatish Balay 1023a7e14dcfSSatish Balay /*@ 1024a7e14dcfSSatish Balay TaoGetMaximumIterations - Sets a maximum number of iterates. 1025a7e14dcfSSatish Balay 1026a7e14dcfSSatish Balay Not Collective 1027a7e14dcfSSatish Balay 1028a7e14dcfSSatish Balay Input Parameters: 1029441846f8SBarry Smith . tao - the Tao solver context 1030a7e14dcfSSatish Balay 1031a7e14dcfSSatish Balay Output Parameters: 1032a7e14dcfSSatish Balay . maxits - the maximum number of iterates 1033a7e14dcfSSatish Balay 1034a7e14dcfSSatish Balay Level: intermediate 1035a7e14dcfSSatish Balay 1036a7e14dcfSSatish Balay .seealso: TaoSetMaximumIterations(), TaoGetMaximumFunctionEvaluations() 1037a7e14dcfSSatish Balay @*/ 1038441846f8SBarry Smith PetscErrorCode TaoGetMaximumIterations(Tao tao,PetscInt *maxits) 1039a7e14dcfSSatish Balay { 1040a7e14dcfSSatish Balay PetscFunctionBegin; 1041441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1042a7e14dcfSSatish Balay *maxits = tao->max_it; 1043a7e14dcfSSatish Balay PetscFunctionReturn(0); 1044a7e14dcfSSatish Balay } 1045a7e14dcfSSatish Balay 1046a7e14dcfSSatish Balay /*@ 1047a7e14dcfSSatish Balay TaoSetInitialTrustRegionRadius - Sets the initial trust region radius. 1048a7e14dcfSSatish Balay 1049441846f8SBarry Smith Logically collective on Tao 1050a7e14dcfSSatish Balay 1051a7e14dcfSSatish Balay Input Parameter: 1052a7e14dcfSSatish Balay + tao - a TAO optimization solver 1053a7e14dcfSSatish Balay - radius - the trust region radius 1054a7e14dcfSSatish Balay 1055a7e14dcfSSatish Balay Level: intermediate 1056a7e14dcfSSatish Balay 1057a7e14dcfSSatish Balay Options Database Key: 1058a7e14dcfSSatish Balay . -tao_trust0 <t0> - sets initial trust region radius 1059a7e14dcfSSatish Balay 1060a7e14dcfSSatish Balay .seealso: TaoGetTrustRegionRadius(), TaoSetTrustRegionTolerance() 1061a7e14dcfSSatish Balay @*/ 1062441846f8SBarry Smith PetscErrorCode TaoSetInitialTrustRegionRadius(Tao tao, PetscReal radius) 1063a7e14dcfSSatish Balay { 1064a7e14dcfSSatish Balay PetscFunctionBegin; 1065441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1066a7e14dcfSSatish Balay tao->trust0 = PetscMax(0.0,radius); 10676552cf8aSJason Sarich tao->trust0_changed=PETSC_TRUE; 1068a7e14dcfSSatish Balay PetscFunctionReturn(0); 1069a7e14dcfSSatish Balay } 1070a7e14dcfSSatish Balay 1071a7e14dcfSSatish Balay /*@ 1072a7e14dcfSSatish Balay TaoGetInitialTrustRegionRadius - Sets the initial trust region radius. 1073a7e14dcfSSatish Balay 1074a7e14dcfSSatish Balay Not Collective 1075a7e14dcfSSatish Balay 1076a7e14dcfSSatish Balay Input Parameter: 1077a7e14dcfSSatish Balay . tao - a TAO optimization solver 1078a7e14dcfSSatish Balay 1079a7e14dcfSSatish Balay Output Parameter: 1080a7e14dcfSSatish Balay . radius - the trust region radius 1081a7e14dcfSSatish Balay 1082a7e14dcfSSatish Balay Level: intermediate 1083a7e14dcfSSatish Balay 1084a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetCurrentTrustRegionRadius() 1085a7e14dcfSSatish Balay @*/ 1086441846f8SBarry Smith PetscErrorCode TaoGetInitialTrustRegionRadius(Tao tao, PetscReal *radius) 1087a7e14dcfSSatish Balay { 1088a7e14dcfSSatish Balay PetscFunctionBegin; 1089441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1090a7e14dcfSSatish Balay *radius = tao->trust0; 1091a7e14dcfSSatish Balay PetscFunctionReturn(0); 1092a7e14dcfSSatish Balay } 1093a7e14dcfSSatish Balay 1094a7e14dcfSSatish Balay /*@ 1095a7e14dcfSSatish Balay TaoGetCurrentTrustRegionRadius - Gets the current trust region radius. 1096a7e14dcfSSatish Balay 1097a7e14dcfSSatish Balay Not Collective 1098a7e14dcfSSatish Balay 1099a7e14dcfSSatish Balay Input Parameter: 1100a7e14dcfSSatish Balay . tao - a TAO optimization solver 1101a7e14dcfSSatish Balay 1102a7e14dcfSSatish Balay Output Parameter: 1103a7e14dcfSSatish Balay . radius - the trust region radius 1104a7e14dcfSSatish Balay 1105a7e14dcfSSatish Balay Level: intermediate 1106a7e14dcfSSatish Balay 1107a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetInitialTrustRegionRadius() 1108a7e14dcfSSatish Balay @*/ 1109441846f8SBarry Smith PetscErrorCode TaoGetCurrentTrustRegionRadius(Tao tao, PetscReal *radius) 1110a7e14dcfSSatish Balay { 1111a7e14dcfSSatish Balay PetscFunctionBegin; 1112441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1113a7e14dcfSSatish Balay *radius = tao->trust; 1114a7e14dcfSSatish Balay PetscFunctionReturn(0); 1115a7e14dcfSSatish Balay } 1116a7e14dcfSSatish Balay 1117a7e14dcfSSatish Balay /*@ 1118a7e14dcfSSatish Balay TaoGetTolerances - gets the current values of tolerances 1119a7e14dcfSSatish Balay 1120a7e14dcfSSatish Balay Not Collective 1121a7e14dcfSSatish Balay 1122a7e14dcfSSatish Balay Input Parameters: 1123441846f8SBarry Smith . tao - the Tao context 1124a7e14dcfSSatish Balay 1125a7e14dcfSSatish Balay Output Parameters: 1126e52336cbSBarry Smith + gatol - stop if norm of gradient is less than this 1127a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this 1128a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by a this factor 1129a7e14dcfSSatish Balay 113047a47007SBarry Smith Note: NULL can be used as an argument if not all tolerances values are needed 1131a7e14dcfSSatish Balay 1132a7e14dcfSSatish Balay .seealso TaoSetTolerances() 1133a7e14dcfSSatish Balay 1134a7e14dcfSSatish Balay Level: intermediate 1135a7e14dcfSSatish Balay @*/ 1136e52336cbSBarry Smith PetscErrorCode TaoGetTolerances(Tao tao, PetscReal *gatol, PetscReal *grtol, PetscReal *gttol) 1137a7e14dcfSSatish Balay { 1138a7e14dcfSSatish Balay PetscFunctionBegin; 1139441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1140a7e14dcfSSatish Balay if (gatol) *gatol=tao->gatol; 1141a7e14dcfSSatish Balay if (grtol) *grtol=tao->grtol; 1142a7e14dcfSSatish Balay if (gttol) *gttol=tao->gttol; 1143a7e14dcfSSatish Balay PetscFunctionReturn(0); 1144a7e14dcfSSatish Balay } 1145a7e14dcfSSatish Balay 1146a7e14dcfSSatish Balay /*@ 1147a7e14dcfSSatish Balay TaoGetKSP - Gets the linear solver used by the optimization solver. 1148a7e14dcfSSatish Balay Application writers should use TaoGetKSP if they need direct access 1149a7e14dcfSSatish Balay to the PETSc KSP object. 1150a7e14dcfSSatish Balay 1151a7e14dcfSSatish Balay Not Collective 1152a7e14dcfSSatish Balay 1153a7e14dcfSSatish Balay Input Parameters: 1154a7e14dcfSSatish Balay . tao - the TAO solver 1155a7e14dcfSSatish Balay 1156a7e14dcfSSatish Balay Output Parameters: 1157a7e14dcfSSatish Balay . ksp - the KSP linear solver used in the optimization solver 1158a7e14dcfSSatish Balay 1159a7e14dcfSSatish Balay Level: intermediate 1160a7e14dcfSSatish Balay 1161a7e14dcfSSatish Balay @*/ 1162441846f8SBarry Smith PetscErrorCode TaoGetKSP(Tao tao, KSP *ksp) 116347a47007SBarry Smith { 1164a7e14dcfSSatish Balay PetscFunctionBegin; 1165a7e14dcfSSatish Balay *ksp = tao->ksp; 1166a7e14dcfSSatish Balay PetscFunctionReturn(0); 1167a7e14dcfSSatish Balay } 1168a7e14dcfSSatish Balay 1169025e9500SJason Sarich /*@ 1170025e9500SJason Sarich TaoGetLinearSolveIterations - Gets the total number of linear iterations 1171025e9500SJason Sarich used by the TAO solver 1172025e9500SJason Sarich 1173025e9500SJason Sarich Not Collective 1174025e9500SJason Sarich 1175025e9500SJason Sarich Input Parameter: 1176025e9500SJason Sarich . tao - TAO context 1177025e9500SJason Sarich 1178025e9500SJason Sarich Output Parameter: 1179025e9500SJason Sarich . lits - number of linear iterations 1180025e9500SJason Sarich 1181025e9500SJason Sarich Notes: 1182025e9500SJason Sarich This counter is reset to zero for each successive call to TaoSolve() 1183025e9500SJason Sarich 1184025e9500SJason Sarich Level: intermediate 1185025e9500SJason Sarich 1186025e9500SJason Sarich .keywords: TAO 1187025e9500SJason Sarich 1188025e9500SJason Sarich .seealso: TaoGetKSP() 1189025e9500SJason Sarich @*/ 1190025e9500SJason Sarich PetscErrorCode TaoGetLinearSolveIterations(Tao tao,PetscInt *lits) 1191025e9500SJason Sarich { 1192025e9500SJason Sarich PetscFunctionBegin; 1193025e9500SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1194025e9500SJason Sarich PetscValidIntPointer(lits,2); 11952d9aa51bSJason Sarich *lits = tao->ksp_tot_its; 1196025e9500SJason Sarich PetscFunctionReturn(0); 1197025e9500SJason Sarich } 1198025e9500SJason Sarich 1199a7e14dcfSSatish Balay /*@ 1200a7e14dcfSSatish Balay TaoGetLineSearch - Gets the line search used by the optimization solver. 1201a7e14dcfSSatish Balay Application writers should use TaoGetLineSearch if they need direct access 1202a7e14dcfSSatish Balay to the TaoLineSearch object. 1203a7e14dcfSSatish Balay 1204a7e14dcfSSatish Balay Not Collective 1205a7e14dcfSSatish Balay 1206a7e14dcfSSatish Balay Input Parameters: 1207a7e14dcfSSatish Balay . tao - the TAO solver 1208a7e14dcfSSatish Balay 1209a7e14dcfSSatish Balay Output Parameters: 1210a7e14dcfSSatish Balay . ls - the line search used in the optimization solver 1211a7e14dcfSSatish Balay 1212a7e14dcfSSatish Balay Level: intermediate 1213a7e14dcfSSatish Balay 1214a7e14dcfSSatish Balay @*/ 1215441846f8SBarry Smith PetscErrorCode TaoGetLineSearch(Tao tao, TaoLineSearch *ls) 121647a47007SBarry Smith { 1217a7e14dcfSSatish Balay PetscFunctionBegin; 1218a7e14dcfSSatish Balay *ls = tao->linesearch; 1219a7e14dcfSSatish Balay PetscFunctionReturn(0); 1220a7e14dcfSSatish Balay } 1221a7e14dcfSSatish Balay 1222a7e14dcfSSatish Balay /*@ 1223a7e14dcfSSatish Balay TaoAddLineSearchCounts - Adds the number of function evaluations spent 1224a7e14dcfSSatish Balay in the line search to the running total. 1225a7e14dcfSSatish Balay 1226a7e14dcfSSatish Balay Input Parameters: 1227a7e14dcfSSatish Balay + tao - the TAO solver 1228a7e14dcfSSatish Balay - ls - the line search used in the optimization solver 1229a7e14dcfSSatish Balay 1230a7e14dcfSSatish Balay Level: developer 1231a7e14dcfSSatish Balay 1232a7e14dcfSSatish Balay .seealso: TaoLineSearchApply() 1233a7e14dcfSSatish Balay @*/ 1234441846f8SBarry Smith PetscErrorCode TaoAddLineSearchCounts(Tao tao) 123547a47007SBarry Smith { 1236a7e14dcfSSatish Balay PetscErrorCode ierr; 1237a7e14dcfSSatish Balay PetscBool flg; 1238a7e14dcfSSatish Balay PetscInt nfeval,ngeval,nfgeval; 123947a47007SBarry Smith 1240a7e14dcfSSatish Balay PetscFunctionBegin; 1241441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1242a7e14dcfSSatish Balay if (tao->linesearch) { 1243302440fdSBarry Smith ierr = TaoLineSearchIsUsingTaoRoutines(tao->linesearch,&flg);CHKERRQ(ierr); 124494ae4db5SBarry Smith if (!flg) { 124547a47007SBarry Smith ierr = TaoLineSearchGetNumberFunctionEvaluations(tao->linesearch,&nfeval,&ngeval,&nfgeval);CHKERRQ(ierr); 1246a7e14dcfSSatish Balay tao->nfuncs+=nfeval; 1247a7e14dcfSSatish Balay tao->ngrads+=ngeval; 1248a7e14dcfSSatish Balay tao->nfuncgrads+=nfgeval; 1249a7e14dcfSSatish Balay } 1250a7e14dcfSSatish Balay } 1251a7e14dcfSSatish Balay PetscFunctionReturn(0); 1252a7e14dcfSSatish Balay } 1253a7e14dcfSSatish Balay 1254a7e14dcfSSatish Balay /*@ 1255a7e14dcfSSatish Balay TaoGetSolutionVector - Returns the vector with the current TAO solution 1256a7e14dcfSSatish Balay 1257a7e14dcfSSatish Balay Not Collective 1258a7e14dcfSSatish Balay 1259a7e14dcfSSatish Balay Input Parameter: 1260441846f8SBarry Smith . tao - the Tao context 1261a7e14dcfSSatish Balay 1262a7e14dcfSSatish Balay Output Parameter: 1263a7e14dcfSSatish Balay . X - the current solution 1264a7e14dcfSSatish Balay 1265a7e14dcfSSatish Balay Level: intermediate 1266a7e14dcfSSatish Balay 1267a7e14dcfSSatish Balay Note: The returned vector will be the same object that was passed into TaoSetInitialVector() 1268a7e14dcfSSatish Balay @*/ 1269441846f8SBarry Smith PetscErrorCode TaoGetSolutionVector(Tao tao, Vec *X) 1270a7e14dcfSSatish Balay { 1271a7e14dcfSSatish Balay PetscFunctionBegin; 1272441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1273a7e14dcfSSatish Balay *X = tao->solution; 1274a7e14dcfSSatish Balay PetscFunctionReturn(0); 1275a7e14dcfSSatish Balay } 1276a7e14dcfSSatish Balay 1277a7e14dcfSSatish Balay /*@ 1278a7e14dcfSSatish Balay TaoGetGradientVector - Returns the vector with the current TAO gradient 1279a7e14dcfSSatish Balay 1280a7e14dcfSSatish Balay Not Collective 1281a7e14dcfSSatish Balay 1282a7e14dcfSSatish Balay Input Parameter: 1283441846f8SBarry Smith . tao - the Tao context 1284a7e14dcfSSatish Balay 1285a7e14dcfSSatish Balay Output Parameter: 1286a7e14dcfSSatish Balay . G - the current solution 1287a7e14dcfSSatish Balay 1288a7e14dcfSSatish Balay Level: intermediate 1289a7e14dcfSSatish Balay @*/ 1290441846f8SBarry Smith PetscErrorCode TaoGetGradientVector(Tao tao, Vec *G) 1291a7e14dcfSSatish Balay { 1292a7e14dcfSSatish Balay PetscFunctionBegin; 1293441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1294a7e14dcfSSatish Balay *G = tao->gradient; 1295a7e14dcfSSatish Balay PetscFunctionReturn(0); 1296a7e14dcfSSatish Balay } 1297a7e14dcfSSatish Balay 1298a7e14dcfSSatish Balay /*@ 1299a7e14dcfSSatish Balay TaoResetStatistics - Initialize the statistics used by TAO for all of the solvers. 1300a7e14dcfSSatish Balay These statistics include the iteration number, residual norms, and convergence status. 1301a7e14dcfSSatish Balay This routine gets called before solving each optimization problem. 1302a7e14dcfSSatish Balay 1303441846f8SBarry Smith Collective on Tao 1304a7e14dcfSSatish Balay 1305a7e14dcfSSatish Balay Input Parameters: 1306441846f8SBarry Smith . solver - the Tao context 1307a7e14dcfSSatish Balay 1308a7e14dcfSSatish Balay Level: developer 1309a7e14dcfSSatish Balay 1310a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve() 1311a7e14dcfSSatish Balay @*/ 1312441846f8SBarry Smith PetscErrorCode TaoResetStatistics(Tao tao) 1313a7e14dcfSSatish Balay { 1314a7e14dcfSSatish Balay PetscFunctionBegin; 1315441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1316a7e14dcfSSatish Balay tao->niter = 0; 1317a7e14dcfSSatish Balay tao->nfuncs = 0; 1318a7e14dcfSSatish Balay tao->nfuncgrads = 0; 1319a7e14dcfSSatish Balay tao->ngrads = 0; 1320a7e14dcfSSatish Balay tao->nhess = 0; 1321a7e14dcfSSatish Balay tao->njac = 0; 1322a7e14dcfSSatish Balay tao->nconstraints = 0; 1323a7e14dcfSSatish Balay tao->ksp_its = 0; 1324ae93cb3cSJason Sarich tao->ksp_tot_its = 0; 1325a7e14dcfSSatish Balay tao->reason = TAO_CONTINUE_ITERATING; 1326a7e14dcfSSatish Balay tao->residual = 0.0; 1327a7e14dcfSSatish Balay tao->cnorm = 0.0; 1328a7e14dcfSSatish Balay tao->step = 0.0; 1329a7e14dcfSSatish Balay tao->lsflag = PETSC_FALSE; 1330a7e14dcfSSatish Balay if (tao->hist_reset) tao->hist_len=0; 1331a7e14dcfSSatish Balay PetscFunctionReturn(0); 1332a7e14dcfSSatish Balay } 1333a7e14dcfSSatish Balay 1334a7e14dcfSSatish Balay /*@C 1335a7e14dcfSSatish Balay TaoSetConvergenceTest - Sets the function that is to be used to test 1336a7e14dcfSSatish Balay for convergence o fthe iterative minimization solution. The new convergence 1337a7e14dcfSSatish Balay testing routine will replace TAO's default convergence test. 1338a7e14dcfSSatish Balay 1339441846f8SBarry Smith Logically Collective on Tao 1340a7e14dcfSSatish Balay 1341a7e14dcfSSatish Balay Input Parameters: 1342441846f8SBarry Smith + tao - the Tao object 1343a7e14dcfSSatish Balay . conv - the routine to test for convergence 1344a7e14dcfSSatish Balay - ctx - [optional] context for private data for the convergence routine 134547a47007SBarry Smith (may be NULL) 1346a7e14dcfSSatish Balay 1347a7e14dcfSSatish Balay Calling sequence of conv: 1348441846f8SBarry Smith $ PetscErrorCode conv(Tao tao, void *ctx) 1349a7e14dcfSSatish Balay 1350441846f8SBarry Smith + tao - the Tao object 1351a7e14dcfSSatish Balay - ctx - [optional] convergence context 1352a7e14dcfSSatish Balay 1353e4cb33bbSBarry Smith Note: The new convergence testing routine should call TaoSetConvergedReason(). 1354a7e14dcfSSatish Balay 1355a7e14dcfSSatish Balay Level: advanced 1356a7e14dcfSSatish Balay 1357e4cb33bbSBarry Smith .seealso: TaoSetConvergedReason(), TaoGetSolutionStatus(), TaoGetTolerances(), TaoSetMonitor 1358a7e14dcfSSatish Balay 1359a7e14dcfSSatish Balay @*/ 1360441846f8SBarry Smith PetscErrorCode TaoSetConvergenceTest(Tao tao, PetscErrorCode (*conv)(Tao,void*), void *ctx) 1361a7e14dcfSSatish Balay { 1362a7e14dcfSSatish Balay PetscFunctionBegin; 1363441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1364a7e14dcfSSatish Balay (tao)->ops->convergencetest = conv; 1365a7e14dcfSSatish Balay (tao)->cnvP = ctx; 1366a7e14dcfSSatish Balay PetscFunctionReturn(0); 1367a7e14dcfSSatish Balay } 1368a7e14dcfSSatish Balay 1369a7e14dcfSSatish Balay /*@C 1370a7e14dcfSSatish Balay TaoSetMonitor - Sets an ADDITIONAL function that is to be used at every 1371a7e14dcfSSatish Balay iteration of the solver to display the iteration's 1372a7e14dcfSSatish Balay progress. 1373a7e14dcfSSatish Balay 1374441846f8SBarry Smith Logically Collective on Tao 1375a7e14dcfSSatish Balay 1376a7e14dcfSSatish Balay Input Parameters: 1377441846f8SBarry Smith + tao - the Tao solver context 1378a7e14dcfSSatish Balay . mymonitor - monitoring routine 1379a7e14dcfSSatish Balay - mctx - [optional] user-defined context for private data for the 138047a47007SBarry Smith monitor routine (may be NULL) 1381a7e14dcfSSatish Balay 1382a7e14dcfSSatish Balay Calling sequence of mymonitor: 1383441846f8SBarry Smith $ int mymonitor(Tao tao,void *mctx) 1384a7e14dcfSSatish Balay 1385441846f8SBarry Smith + tao - the Tao solver context 1386a7e14dcfSSatish Balay - mctx - [optional] monitoring context 1387a7e14dcfSSatish Balay 1388a7e14dcfSSatish Balay 1389a7e14dcfSSatish Balay Options Database Keys: 139098ea980cSBarry Smith + -tao_monitor - sets TaoMonitorDefault() 1391a7e14dcfSSatish Balay . -tao_smonitor - sets short monitor 1392a7e14dcfSSatish Balay . -tao_cmonitor - same as smonitor plus constraint norm 1393a7e14dcfSSatish Balay . -tao_view_solution - view solution at each iteration 1394a7e14dcfSSatish Balay . -tao_view_gradient - view gradient at each iteration 1395a7e14dcfSSatish Balay . -tao_view_separableobjective - view separable objective function at each iteration 1396a7e14dcfSSatish 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. 1397a7e14dcfSSatish Balay 1398a7e14dcfSSatish Balay 1399a7e14dcfSSatish Balay Notes: 1400a7e14dcfSSatish Balay Several different monitoring routines may be set by calling 1401a7e14dcfSSatish Balay TaoSetMonitor() multiple times; all will be called in the 1402a7e14dcfSSatish Balay order in which they were set. 1403a7e14dcfSSatish Balay 140495452b02SPatrick Sanan Fortran Notes: 140595452b02SPatrick Sanan Only one monitor function may be set 1406a7e14dcfSSatish Balay 1407a7e14dcfSSatish Balay Level: intermediate 1408a7e14dcfSSatish Balay 140998ea980cSBarry Smith .seealso: TaoMonitorDefault(), TaoCancelMonitors(), TaoSetDestroyRoutine() 1410a7e14dcfSSatish Balay @*/ 1411441846f8SBarry Smith PetscErrorCode TaoSetMonitor(Tao tao, PetscErrorCode (*func)(Tao, void*), void *ctx,PetscErrorCode (*dest)(void**)) 1412a7e14dcfSSatish Balay { 141308d19d1fSJason Sarich PetscErrorCode ierr; 141408d19d1fSJason Sarich PetscInt i; 141508d19d1fSJason Sarich 1416a7e14dcfSSatish Balay PetscFunctionBegin; 1417441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 141847a47007SBarry Smith if (tao->numbermonitors >= MAXTAOMONITORS) SETERRQ1(PETSC_COMM_SELF,1,"Cannot attach another monitor -- max=",MAXTAOMONITORS); 141908d19d1fSJason Sarich 142008d19d1fSJason Sarich for (i=0; i<tao->numbermonitors;i++) { 142108d19d1fSJason Sarich if (func == tao->monitor[i] && dest == tao->monitordestroy[i] && ctx == tao->monitorcontext[i]) { 142208d19d1fSJason Sarich if (dest) { 142308d19d1fSJason Sarich ierr = (*dest)(&ctx);CHKERRQ(ierr); 142408d19d1fSJason Sarich } 142508d19d1fSJason Sarich PetscFunctionReturn(0); 142608d19d1fSJason Sarich } 142708d19d1fSJason Sarich } 1428a7e14dcfSSatish Balay tao->monitor[tao->numbermonitors] = func; 1429a7e14dcfSSatish Balay tao->monitorcontext[tao->numbermonitors] = ctx; 1430a7e14dcfSSatish Balay tao->monitordestroy[tao->numbermonitors] = dest; 1431a7e14dcfSSatish Balay ++tao->numbermonitors; 1432a7e14dcfSSatish Balay PetscFunctionReturn(0); 1433a7e14dcfSSatish Balay } 1434a7e14dcfSSatish Balay 1435a7e14dcfSSatish Balay /*@ 1436441846f8SBarry Smith TaoCancelMonitors - Clears all the monitor functions for a Tao object. 1437a7e14dcfSSatish Balay 1438441846f8SBarry Smith Logically Collective on Tao 1439a7e14dcfSSatish Balay 1440a7e14dcfSSatish Balay Input Parameters: 1441441846f8SBarry Smith . tao - the Tao solver context 1442a7e14dcfSSatish Balay 1443a7e14dcfSSatish Balay Options Database: 1444a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors that have been hardwired 1445a7e14dcfSSatish Balay into a code by calls to TaoSetMonitor(), but does not cancel those 1446a7e14dcfSSatish Balay set via the options database 1447a7e14dcfSSatish Balay 1448a7e14dcfSSatish Balay Notes: 1449441846f8SBarry Smith There is no way to clear one specific monitor from a Tao object. 1450a7e14dcfSSatish Balay 1451a7e14dcfSSatish Balay Level: advanced 1452a7e14dcfSSatish Balay 145398ea980cSBarry Smith .seealso: TaoMonitorDefault(), TaoSetMonitor() 1454a7e14dcfSSatish Balay @*/ 1455441846f8SBarry Smith PetscErrorCode TaoCancelMonitors(Tao tao) 1456a7e14dcfSSatish Balay { 1457a7e14dcfSSatish Balay PetscInt i; 1458a7e14dcfSSatish Balay PetscErrorCode ierr; 145947a47007SBarry Smith 1460a7e14dcfSSatish Balay PetscFunctionBegin; 1461441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1462a7e14dcfSSatish Balay for (i=0;i<tao->numbermonitors;i++) { 1463a7e14dcfSSatish Balay if (tao->monitordestroy[i]) { 1464a7e14dcfSSatish Balay ierr = (*tao->monitordestroy[i])(&tao->monitorcontext[i]);CHKERRQ(ierr); 1465a7e14dcfSSatish Balay } 1466a7e14dcfSSatish Balay } 1467a7e14dcfSSatish Balay tao->numbermonitors=0; 1468a7e14dcfSSatish Balay PetscFunctionReturn(0); 1469a7e14dcfSSatish Balay } 1470a7e14dcfSSatish Balay 14717fab98ebSJason Sarich /*@ 147298ea980cSBarry Smith TaoMonitorDefault - Default routine for monitoring progress of the 1473441846f8SBarry Smith Tao solvers (default). This monitor prints the function value and gradient 1474a7e14dcfSSatish Balay norm at each iteration. It can be turned on from the command line using the 1475a7e14dcfSSatish Balay -tao_monitor option 1476a7e14dcfSSatish Balay 1477441846f8SBarry Smith Collective on Tao 1478a7e14dcfSSatish Balay 1479a7e14dcfSSatish Balay Input Parameters: 1480441846f8SBarry Smith + tao - the Tao context 148147a47007SBarry Smith - ctx - PetscViewer context or NULL 1482a7e14dcfSSatish Balay 1483a7e14dcfSSatish Balay Options Database Keys: 1484a7e14dcfSSatish Balay . -tao_monitor 1485a7e14dcfSSatish Balay 1486a7e14dcfSSatish Balay Level: advanced 1487a7e14dcfSSatish Balay 1488a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1489a7e14dcfSSatish Balay @*/ 149098ea980cSBarry Smith PetscErrorCode TaoMonitorDefault(Tao tao, void *ctx) 1491a7e14dcfSSatish Balay { 1492a7e14dcfSSatish Balay PetscErrorCode ierr; 149363b15415SAlp Dener PetscInt its, tabs; 1494a7e14dcfSSatish Balay PetscReal fct,gnorm; 14958163d661SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 149647a47007SBarry Smith 1497a7e14dcfSSatish Balay PetscFunctionBegin; 14988163d661SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1499a7e14dcfSSatish Balay its=tao->niter; 1500a7e14dcfSSatish Balay fct=tao->fc; 1501a7e14dcfSSatish Balay gnorm=tao->residual; 150263b15415SAlp Dener ierr = PetscViewerASCIIGetTab(viewer, &tabs);CHKERRQ(ierr); 150363b15415SAlp Dener ierr = PetscViewerASCIISetTab(viewer, ((PetscObject)tao)->tablevel);CHKERRQ(ierr); 150463b15415SAlp Dener if (its == 0 && ((PetscObject)tao)->prefix) { 150563b15415SAlp Dener ierr = PetscViewerASCIIPrintf(viewer," Iteration information for %s solve.\n",((PetscObject)tao)->prefix);CHKERRQ(ierr); 150663b15415SAlp Dener } 150798ea980cSBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"%3D TAO,",its);CHKERRQ(ierr); 150847a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr); 150908d19d1fSJason Sarich if (gnorm >= PETSC_INFINITY) { 151008d19d1fSJason Sarich ierr=PetscViewerASCIIPrintf(viewer," Residual: Inf \n");CHKERRQ(ierr); 151108d19d1fSJason Sarich } else { 151247a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr); 151308d19d1fSJason Sarich } 151463b15415SAlp Dener ierr = PetscViewerASCIISetTab(viewer, tabs);CHKERRQ(ierr); 1515a7e14dcfSSatish Balay PetscFunctionReturn(0); 1516a7e14dcfSSatish Balay } 1517a7e14dcfSSatish Balay 15187fab98ebSJason Sarich /*@ 15198d5ead36SAlp Dener TaoDefaultGMonitor - Default routine for monitoring progress of the 15208d5ead36SAlp Dener Tao solvers (default) with extra detail on the globalization method. 15218d5ead36SAlp Dener This monitor prints the function value and gradient norm at each 15228d5ead36SAlp Dener iteration, as well as the step size and trust radius. Note that the 15238d5ead36SAlp Dener step size and trust radius may be the same for some algorithms. 15248d5ead36SAlp Dener It can be turned on from the command line using the 15258d5ead36SAlp Dener -tao_gmonitor option 15268d5ead36SAlp Dener 15278d5ead36SAlp Dener Collective on Tao 15288d5ead36SAlp Dener 15298d5ead36SAlp Dener Input Parameters: 15308d5ead36SAlp Dener + tao - the Tao context 15318d5ead36SAlp Dener - ctx - PetscViewer context or NULL 15328d5ead36SAlp Dener 15338d5ead36SAlp Dener Options Database Keys: 15348d5ead36SAlp Dener . -tao_monitor 15358d5ead36SAlp Dener 15368d5ead36SAlp Dener Level: advanced 15378d5ead36SAlp Dener 15388d5ead36SAlp Dener .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 15398d5ead36SAlp Dener @*/ 15408d5ead36SAlp Dener PetscErrorCode TaoDefaultGMonitor(Tao tao, void *ctx) 15418d5ead36SAlp Dener { 15428d5ead36SAlp Dener PetscErrorCode ierr; 15438d5ead36SAlp Dener PetscInt its, tabs; 15448d5ead36SAlp Dener PetscReal fct,gnorm,stp,tr; 15458d5ead36SAlp Dener PetscViewer viewer = (PetscViewer)ctx; 15468d5ead36SAlp Dener 15478d5ead36SAlp Dener PetscFunctionBegin; 15488d5ead36SAlp Dener PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 15498d5ead36SAlp Dener its=tao->niter; 15508d5ead36SAlp Dener fct=tao->fc; 15518d5ead36SAlp Dener gnorm=tao->residual; 15528d5ead36SAlp Dener stp=tao->step; 15538d5ead36SAlp Dener tr=tao->trust; 15548d5ead36SAlp Dener ierr = PetscViewerASCIIGetTab(viewer, &tabs);CHKERRQ(ierr); 15558d5ead36SAlp Dener ierr = PetscViewerASCIISetTab(viewer, ((PetscObject)tao)->tablevel);CHKERRQ(ierr); 15568d5ead36SAlp Dener if (its == 0 && ((PetscObject)tao)->prefix) { 15578d5ead36SAlp Dener ierr = PetscViewerASCIIPrintf(viewer," Iteration information for %s solve.\n",((PetscObject)tao)->prefix);CHKERRQ(ierr); 15588d5ead36SAlp Dener } 15598d5ead36SAlp Dener ierr=PetscViewerASCIIPrintf(viewer,"%3D TAO,",its);CHKERRQ(ierr); 15608d5ead36SAlp Dener ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr); 15618d5ead36SAlp Dener if (gnorm >= PETSC_INFINITY) { 15628d5ead36SAlp Dener ierr=PetscViewerASCIIPrintf(viewer," Residual: Inf,");CHKERRQ(ierr); 15638d5ead36SAlp Dener } else { 15648d5ead36SAlp Dener ierr=PetscViewerASCIIPrintf(viewer," Residual: %g,",(double)gnorm);CHKERRQ(ierr); 15658d5ead36SAlp Dener } 15668d5ead36SAlp Dener ierr = PetscViewerASCIIPrintf(viewer," Step: %g, Trust: %g\n",(double)stp,(double)tr);CHKERRQ(ierr); 15678d5ead36SAlp Dener ierr = PetscViewerASCIISetTab(viewer, tabs);CHKERRQ(ierr); 15688d5ead36SAlp Dener PetscFunctionReturn(0); 15698d5ead36SAlp Dener } 15708d5ead36SAlp Dener 15718d5ead36SAlp Dener /*@ 1572a7e14dcfSSatish Balay TaoDefaultSMonitor - Default routine for monitoring progress of the 157398ea980cSBarry Smith solver. Same as TaoMonitorDefault() except 1574a7e14dcfSSatish Balay it prints fewer digits of the residual as the residual gets smaller. 1575a7e14dcfSSatish Balay This is because the later digits are meaningless and are often 1576a7e14dcfSSatish Balay different on different machines; by using this routine different 1577a7e14dcfSSatish Balay machines will usually generate the same output. It can be turned on 1578a7e14dcfSSatish Balay by using the -tao_smonitor option 1579a7e14dcfSSatish Balay 1580441846f8SBarry Smith Collective on Tao 1581a7e14dcfSSatish Balay 1582a7e14dcfSSatish Balay Input Parameters: 1583441846f8SBarry Smith + tao - the Tao context 15844d4332d5SBarry Smith - ctx - PetscViewer context of type ASCII 1585a7e14dcfSSatish Balay 1586a7e14dcfSSatish Balay Options Database Keys: 1587a7e14dcfSSatish Balay . -tao_smonitor 1588a7e14dcfSSatish Balay 1589a7e14dcfSSatish Balay Level: advanced 1590a7e14dcfSSatish Balay 159198ea980cSBarry Smith .seealso: TaoMonitorDefault(), TaoSetMonitor() 1592a7e14dcfSSatish Balay @*/ 1593441846f8SBarry Smith PetscErrorCode TaoDefaultSMonitor(Tao tao, void *ctx) 1594a7e14dcfSSatish Balay { 1595a7e14dcfSSatish Balay PetscErrorCode ierr; 15962c9b8b83SAlp Dener PetscInt its, tabs; 1597a7e14dcfSSatish Balay PetscReal fct,gnorm; 15984d4332d5SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 159947a47007SBarry Smith 1600a7e14dcfSSatish Balay PetscFunctionBegin; 16014d4332d5SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1602a7e14dcfSSatish Balay its=tao->niter; 1603a7e14dcfSSatish Balay fct=tao->fc; 1604a7e14dcfSSatish Balay gnorm=tao->residual; 16052c9b8b83SAlp Dener ierr = PetscViewerASCIIGetTab(viewer, &tabs);CHKERRQ(ierr); 16062c9b8b83SAlp Dener ierr = PetscViewerASCIISetTab(viewer, ((PetscObject)tao)->tablevel);CHKERRQ(ierr); 1607a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr); 160847a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Function value %g,",(double)fct);CHKERRQ(ierr); 1609d393f493SBarry Smith if (gnorm >= PETSC_INFINITY) { 161008d19d1fSJason Sarich ierr=PetscViewerASCIIPrintf(viewer," Residual: Inf \n");CHKERRQ(ierr); 161108d19d1fSJason Sarich } else if (gnorm > 1.e-6) { 161247a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr); 1613a7e14dcfSSatish Balay } else if (gnorm > 1.e-11) { 1614a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-6 \n");CHKERRQ(ierr); 1615a7e14dcfSSatish Balay } else { 1616a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-11 \n");CHKERRQ(ierr); 1617a7e14dcfSSatish Balay } 16182c9b8b83SAlp Dener ierr = PetscViewerASCIISetTab(viewer, tabs);CHKERRQ(ierr); 1619a7e14dcfSSatish Balay PetscFunctionReturn(0); 1620a7e14dcfSSatish Balay } 1621a7e14dcfSSatish Balay 16227fab98ebSJason Sarich /*@ 162398ea980cSBarry Smith TaoDefaultCMonitor - same as TaoMonitorDefault() except 1624a7e14dcfSSatish Balay it prints the norm of the constraints function. It can be turned on 1625a7e14dcfSSatish Balay from the command line using the -tao_cmonitor option 1626a7e14dcfSSatish Balay 1627441846f8SBarry Smith Collective on Tao 1628a7e14dcfSSatish Balay 1629a7e14dcfSSatish Balay Input Parameters: 1630441846f8SBarry Smith + tao - the Tao context 163147a47007SBarry Smith - ctx - PetscViewer context or NULL 1632a7e14dcfSSatish Balay 1633a7e14dcfSSatish Balay Options Database Keys: 1634a7e14dcfSSatish Balay . -tao_cmonitor 1635a7e14dcfSSatish Balay 1636a7e14dcfSSatish Balay Level: advanced 1637a7e14dcfSSatish Balay 163898ea980cSBarry Smith .seealso: TaoMonitorDefault(), TaoSetMonitor() 1639a7e14dcfSSatish Balay @*/ 1640441846f8SBarry Smith PetscErrorCode TaoDefaultCMonitor(Tao tao, void *ctx) 1641a7e14dcfSSatish Balay { 1642a7e14dcfSSatish Balay PetscErrorCode ierr; 16432c9b8b83SAlp Dener PetscInt its, tabs; 1644a7e14dcfSSatish Balay PetscReal fct,gnorm; 1645d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 1646a7e14dcfSSatish Balay 1647a7e14dcfSSatish Balay PetscFunctionBegin; 1648d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1649a7e14dcfSSatish Balay its=tao->niter; 1650a7e14dcfSSatish Balay fct=tao->fc; 1651a7e14dcfSSatish Balay gnorm=tao->residual; 16522c9b8b83SAlp Dener ierr = PetscViewerASCIIGetTab(viewer, &tabs);CHKERRQ(ierr); 16532c9b8b83SAlp Dener ierr = PetscViewerASCIISetTab(viewer, ((PetscObject)tao)->tablevel);CHKERRQ(ierr); 1654a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"iter = %D,",its);CHKERRQ(ierr); 165547a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr); 165647a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Residual: %g ",(double)gnorm);CHKERRQ(ierr); 165747a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Constraint: %g \n",(double)tao->cnorm);CHKERRQ(ierr); 16582c9b8b83SAlp Dener ierr = PetscViewerASCIISetTab(viewer, tabs);CHKERRQ(ierr); 1659a7e14dcfSSatish Balay PetscFunctionReturn(0); 1660a7e14dcfSSatish Balay } 1661a7e14dcfSSatish Balay 1662a7e14dcfSSatish Balay /*@C 1663a7e14dcfSSatish Balay TaoSolutionMonitor - Views the solution at each iteration 1664a7e14dcfSSatish Balay It can be turned on from the command line using the 1665a7e14dcfSSatish Balay -tao_view_solution option 1666a7e14dcfSSatish Balay 1667441846f8SBarry Smith Collective on Tao 1668a7e14dcfSSatish Balay 1669a7e14dcfSSatish Balay Input Parameters: 1670441846f8SBarry Smith + tao - the Tao context 167147a47007SBarry Smith - ctx - PetscViewer context or NULL 1672a7e14dcfSSatish Balay 1673a7e14dcfSSatish Balay Options Database Keys: 1674a7e14dcfSSatish Balay . -tao_view_solution 1675a7e14dcfSSatish Balay 1676a7e14dcfSSatish Balay Level: advanced 1677a7e14dcfSSatish Balay 1678a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1679a7e14dcfSSatish Balay @*/ 1680441846f8SBarry Smith PetscErrorCode TaoSolutionMonitor(Tao tao, void *ctx) 1681a7e14dcfSSatish Balay { 1682a7e14dcfSSatish Balay PetscErrorCode ierr; 1683d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx;; 168447a47007SBarry Smith 1685a7e14dcfSSatish Balay PetscFunctionBegin; 1686d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1687a7e14dcfSSatish Balay ierr = VecView(tao->solution, viewer);CHKERRQ(ierr); 1688a7e14dcfSSatish Balay PetscFunctionReturn(0); 1689a7e14dcfSSatish Balay } 1690a7e14dcfSSatish Balay 1691a7e14dcfSSatish Balay /*@C 1692a7e14dcfSSatish Balay TaoGradientMonitor - Views the gradient at each iteration 1693a7e14dcfSSatish Balay It can be turned on from the command line using the 1694a7e14dcfSSatish Balay -tao_view_gradient option 1695a7e14dcfSSatish Balay 1696441846f8SBarry Smith Collective on Tao 1697a7e14dcfSSatish Balay 1698a7e14dcfSSatish Balay Input Parameters: 1699441846f8SBarry Smith + tao - the Tao context 170047a47007SBarry Smith - ctx - PetscViewer context or NULL 1701a7e14dcfSSatish Balay 1702a7e14dcfSSatish Balay Options Database Keys: 1703a7e14dcfSSatish Balay . -tao_view_gradient 1704a7e14dcfSSatish Balay 1705a7e14dcfSSatish Balay Level: advanced 1706a7e14dcfSSatish Balay 1707a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1708a7e14dcfSSatish Balay @*/ 1709441846f8SBarry Smith PetscErrorCode TaoGradientMonitor(Tao tao, void *ctx) 1710a7e14dcfSSatish Balay { 1711a7e14dcfSSatish Balay PetscErrorCode ierr; 1712d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 171347a47007SBarry Smith 1714a7e14dcfSSatish Balay PetscFunctionBegin; 1715d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1716a7e14dcfSSatish Balay ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr); 1717a7e14dcfSSatish Balay PetscFunctionReturn(0); 1718a7e14dcfSSatish Balay } 1719a7e14dcfSSatish Balay 1720a7e14dcfSSatish Balay /*@C 1721a7e14dcfSSatish Balay TaoStepDirectionMonitor - Views the gradient at each iteration 1722a7e14dcfSSatish Balay It can be turned on from the command line using the 1723a7e14dcfSSatish Balay -tao_view_gradient option 1724a7e14dcfSSatish Balay 1725441846f8SBarry Smith Collective on Tao 1726a7e14dcfSSatish Balay 1727a7e14dcfSSatish Balay Input Parameters: 1728441846f8SBarry Smith + tao - the Tao context 172947a47007SBarry Smith - ctx - PetscViewer context or NULL 1730a7e14dcfSSatish Balay 1731a7e14dcfSSatish Balay Options Database Keys: 1732a7e14dcfSSatish Balay . -tao_view_gradient 1733a7e14dcfSSatish Balay 1734a7e14dcfSSatish Balay Level: advanced 1735a7e14dcfSSatish Balay 1736a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1737a7e14dcfSSatish Balay @*/ 1738441846f8SBarry Smith PetscErrorCode TaoStepDirectionMonitor(Tao tao, void *ctx) 1739a7e14dcfSSatish Balay { 1740a7e14dcfSSatish Balay PetscErrorCode ierr; 1741d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 1742d393f493SBarry Smith 1743a7e14dcfSSatish Balay PetscFunctionBegin; 1744d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1745a7e14dcfSSatish Balay ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr); 1746a7e14dcfSSatish Balay PetscFunctionReturn(0); 1747a7e14dcfSSatish Balay } 1748a7e14dcfSSatish Balay 1749a7e14dcfSSatish Balay /*@C 1750a7e14dcfSSatish Balay TaoDrawSolutionMonitor - Plots the solution at each iteration 1751a7e14dcfSSatish Balay It can be turned on from the command line using the 1752a7e14dcfSSatish Balay -tao_draw_solution option 1753a7e14dcfSSatish Balay 1754441846f8SBarry Smith Collective on Tao 1755a7e14dcfSSatish Balay 1756a7e14dcfSSatish Balay Input Parameters: 1757441846f8SBarry Smith + tao - the Tao context 1758e882e171SHong Zhang - ctx - TaoMonitorDraw context 1759a7e14dcfSSatish Balay 1760a7e14dcfSSatish Balay Options Database Keys: 1761a7e14dcfSSatish Balay . -tao_draw_solution 1762a7e14dcfSSatish Balay 1763a7e14dcfSSatish Balay Level: advanced 1764a7e14dcfSSatish Balay 1765a7e14dcfSSatish Balay .seealso: TaoSolutionMonitor(), TaoSetMonitor(), TaoDrawGradientMonitor 1766a7e14dcfSSatish Balay @*/ 1767441846f8SBarry Smith PetscErrorCode TaoDrawSolutionMonitor(Tao tao, void *ctx) 1768a7e14dcfSSatish Balay { 1769a7e14dcfSSatish Balay PetscErrorCode ierr; 1770e882e171SHong Zhang TaoMonitorDrawCtx ictx = (TaoMonitorDrawCtx)ctx; 177147a47007SBarry Smith 1772a7e14dcfSSatish Balay PetscFunctionBegin; 1773e882e171SHong Zhang if (!(((ictx->howoften > 0) && (!(tao->niter % ictx->howoften))) || ((ictx->howoften == -1) && tao->reason))) PetscFunctionReturn(0); 1774e882e171SHong Zhang ierr = VecView(tao->solution,ictx->viewer);CHKERRQ(ierr); 1775a7e14dcfSSatish Balay PetscFunctionReturn(0); 1776a7e14dcfSSatish Balay } 1777a7e14dcfSSatish Balay 1778a7e14dcfSSatish Balay /*@C 1779a7e14dcfSSatish Balay TaoDrawGradientMonitor - Plots the gradient at each iteration 1780a7e14dcfSSatish Balay It can be turned on from the command line using the 1781a7e14dcfSSatish Balay -tao_draw_gradient option 1782a7e14dcfSSatish Balay 1783441846f8SBarry Smith Collective on Tao 1784a7e14dcfSSatish Balay 1785a7e14dcfSSatish Balay Input Parameters: 1786441846f8SBarry Smith + tao - the Tao context 1787f55353a2SBarry Smith - ctx - PetscViewer context 1788a7e14dcfSSatish Balay 1789a7e14dcfSSatish Balay Options Database Keys: 1790a7e14dcfSSatish Balay . -tao_draw_gradient 1791a7e14dcfSSatish Balay 1792a7e14dcfSSatish Balay Level: advanced 1793a7e14dcfSSatish Balay 1794a7e14dcfSSatish Balay .seealso: TaoGradientMonitor(), TaoSetMonitor(), TaoDrawSolutionMonitor 1795a7e14dcfSSatish Balay @*/ 1796441846f8SBarry Smith PetscErrorCode TaoDrawGradientMonitor(Tao tao, void *ctx) 1797a7e14dcfSSatish Balay { 1798a7e14dcfSSatish Balay PetscErrorCode ierr; 1799e882e171SHong Zhang TaoMonitorDrawCtx ictx = (TaoMonitorDrawCtx)ctx; 180047a47007SBarry Smith 1801a7e14dcfSSatish Balay PetscFunctionBegin; 1802e882e171SHong Zhang if (!(((ictx->howoften > 0) && (!(tao->niter % ictx->howoften))) || ((ictx->howoften == -1) && tao->reason))) PetscFunctionReturn(0); 1803e882e171SHong Zhang ierr = VecView(tao->gradient,ictx->viewer);CHKERRQ(ierr); 1804a7e14dcfSSatish Balay PetscFunctionReturn(0); 1805a7e14dcfSSatish Balay } 1806a7e14dcfSSatish Balay 1807a7e14dcfSSatish Balay /*@C 1808a7e14dcfSSatish Balay TaoDrawStepMonitor - Plots the step direction at each iteration 1809a7e14dcfSSatish Balay It can be turned on from the command line using the 1810a7e14dcfSSatish Balay -tao_draw_step option 1811a7e14dcfSSatish Balay 1812441846f8SBarry Smith Collective on Tao 1813a7e14dcfSSatish Balay 1814a7e14dcfSSatish Balay Input Parameters: 1815441846f8SBarry Smith + tao - the Tao context 1816f55353a2SBarry Smith - ctx - PetscViewer context 1817a7e14dcfSSatish Balay 1818a7e14dcfSSatish Balay Options Database Keys: 1819a7e14dcfSSatish Balay . -tao_draw_step 1820a7e14dcfSSatish Balay 1821a7e14dcfSSatish Balay Level: advanced 1822a7e14dcfSSatish Balay 1823a7e14dcfSSatish Balay .seealso: TaoSetMonitor(), TaoDrawSolutionMonitor 1824a7e14dcfSSatish Balay @*/ 1825441846f8SBarry Smith PetscErrorCode TaoDrawStepMonitor(Tao tao, void *ctx) 1826a7e14dcfSSatish Balay { 1827a7e14dcfSSatish Balay PetscErrorCode ierr; 1828a7e14dcfSSatish Balay PetscViewer viewer = (PetscViewer)(ctx); 182947a47007SBarry Smith 1830a7e14dcfSSatish Balay PetscFunctionBegin; 1831a7e14dcfSSatish Balay ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr); 1832a7e14dcfSSatish Balay PetscFunctionReturn(0); 1833a7e14dcfSSatish Balay } 1834a7e14dcfSSatish Balay 1835a7e14dcfSSatish Balay /*@C 1836a7e14dcfSSatish Balay TaoSeparableObjectiveMonitor - Views the separable objective function at each iteration 1837a7e14dcfSSatish Balay It can be turned on from the command line using the 1838a7e14dcfSSatish Balay -tao_view_separableobjective option 1839a7e14dcfSSatish Balay 1840441846f8SBarry Smith Collective on Tao 1841a7e14dcfSSatish Balay 1842a7e14dcfSSatish Balay Input Parameters: 1843441846f8SBarry Smith + tao - the Tao context 184447a47007SBarry Smith - ctx - PetscViewer context or NULL 1845a7e14dcfSSatish Balay 1846a7e14dcfSSatish Balay Options Database Keys: 1847a7e14dcfSSatish Balay . -tao_view_separableobjective 1848a7e14dcfSSatish Balay 1849a7e14dcfSSatish Balay Level: advanced 1850a7e14dcfSSatish Balay 1851a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1852a7e14dcfSSatish Balay @*/ 1853441846f8SBarry Smith PetscErrorCode TaoSeparableObjectiveMonitor(Tao tao, void *ctx) 1854a7e14dcfSSatish Balay { 1855a7e14dcfSSatish Balay PetscErrorCode ierr; 1856d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 185747a47007SBarry Smith 1858a7e14dcfSSatish Balay PetscFunctionBegin; 1859d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1860a7e14dcfSSatish Balay ierr = VecView(tao->sep_objective,viewer);CHKERRQ(ierr); 1861a7e14dcfSSatish Balay PetscFunctionReturn(0); 1862a7e14dcfSSatish Balay } 1863a7e14dcfSSatish Balay 18647fab98ebSJason Sarich /*@ 1865a7e14dcfSSatish Balay TaoDefaultConvergenceTest - Determines whether the solver should continue iterating 1866a7e14dcfSSatish Balay or terminate. 1867a7e14dcfSSatish Balay 1868441846f8SBarry Smith Collective on Tao 1869a7e14dcfSSatish Balay 1870a7e14dcfSSatish Balay Input Parameters: 1871441846f8SBarry Smith + tao - the Tao context 1872a7e14dcfSSatish Balay - dummy - unused dummy context 1873a7e14dcfSSatish Balay 1874a7e14dcfSSatish Balay Output Parameter: 1875a7e14dcfSSatish Balay . reason - for terminating 1876a7e14dcfSSatish Balay 1877a7e14dcfSSatish Balay Notes: 1878a7e14dcfSSatish Balay This routine checks the residual in the optimality conditions, the 1879a7e14dcfSSatish Balay relative residual in the optimity conditions, the number of function 1880a7e14dcfSSatish Balay evaluations, and the function value to test convergence. Some 1881a7e14dcfSSatish Balay solvers may use different convergence routines. 1882a7e14dcfSSatish Balay 1883a7e14dcfSSatish Balay Level: developer 1884a7e14dcfSSatish Balay 1885e4cb33bbSBarry Smith .seealso: TaoSetTolerances(),TaoGetConvergedReason(),TaoSetConvergedReason() 1886a7e14dcfSSatish Balay @*/ 1887a7e14dcfSSatish Balay 1888441846f8SBarry Smith PetscErrorCode TaoDefaultConvergenceTest(Tao tao,void *dummy) 1889a7e14dcfSSatish Balay { 1890a7e14dcfSSatish Balay PetscInt niter=tao->niter, nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads); 1891a7e14dcfSSatish Balay PetscInt max_funcs=tao->max_funcs; 1892a7e14dcfSSatish Balay PetscReal gnorm=tao->residual, gnorm0=tao->gnorm0; 1893a7e14dcfSSatish Balay PetscReal f=tao->fc, steptol=tao->steptol,trradius=tao->step; 1894a7e14dcfSSatish Balay PetscReal gatol=tao->gatol,grtol=tao->grtol,gttol=tao->gttol; 1895e52336cbSBarry Smith PetscReal catol=tao->catol,crtol=tao->crtol; 1896e52336cbSBarry Smith PetscReal fmin=tao->fmin, cnorm=tao->cnorm; 1897e4cb33bbSBarry Smith TaoConvergedReason reason=tao->reason; 1898a7e14dcfSSatish Balay PetscErrorCode ierr; 1899a7e14dcfSSatish Balay 1900a7e14dcfSSatish Balay PetscFunctionBegin; 1901441846f8SBarry Smith PetscValidHeaderSpecific(tao, TAO_CLASSID,1); 1902a7e14dcfSSatish Balay if (reason != TAO_CONTINUE_ITERATING) { 1903a7e14dcfSSatish Balay PetscFunctionReturn(0); 1904a7e14dcfSSatish Balay } 1905a7e14dcfSSatish Balay 1906a7e14dcfSSatish Balay if (PetscIsInfOrNanReal(f)) { 1907a7e14dcfSSatish Balay ierr = PetscInfo(tao,"Failed to converged, function value is Inf or NaN\n");CHKERRQ(ierr); 1908a7e14dcfSSatish Balay reason = TAO_DIVERGED_NAN; 1909a7e14dcfSSatish Balay } else if (f <= fmin && cnorm <=catol) { 191047a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to function value %g < minimum function value %g\n", (double)f,(double)fmin);CHKERRQ(ierr); 1911a7e14dcfSSatish Balay reason = TAO_CONVERGED_MINF; 1912a7e14dcfSSatish Balay } else if (gnorm<= gatol && cnorm <=catol) { 191347a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to residual norm ||g(X)||=%g < %g\n",(double)gnorm,(double)gatol);CHKERRQ(ierr); 1914a7e14dcfSSatish Balay reason = TAO_CONVERGED_GATOL; 1915a7e14dcfSSatish Balay } else if ( f!=0 && PetscAbsReal(gnorm/f) <= grtol && cnorm <= crtol) { 191647a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to residual ||g(X)||/|f(X)| =%g < %g\n",(double)(gnorm/f),(double)grtol);CHKERRQ(ierr); 1917a7e14dcfSSatish Balay reason = TAO_CONVERGED_GRTOL; 1918e1d16bb9SBarry Smith } else if (gnorm0 != 0 && ((gttol == 0 && gnorm == 0) || gnorm/gnorm0 < gttol) && cnorm <= crtol) { 191947a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to relative residual norm ||g(X)||/||g(X0)|| = %g < %g\n",(double)(gnorm/gnorm0),(double)gttol);CHKERRQ(ierr); 1920a7e14dcfSSatish Balay reason = TAO_CONVERGED_GTTOL; 1921a7e14dcfSSatish Balay } else if (nfuncs > max_funcs){ 1922a7e14dcfSSatish Balay ierr = PetscInfo2(tao,"Exceeded maximum number of function evaluations: %D > %D\n", nfuncs,max_funcs);CHKERRQ(ierr); 1923a7e14dcfSSatish Balay reason = TAO_DIVERGED_MAXFCN; 1924a7e14dcfSSatish Balay } else if ( tao->lsflag != 0 ){ 1925a7e14dcfSSatish Balay ierr = PetscInfo(tao,"Tao Line Search failure.\n");CHKERRQ(ierr); 1926a7e14dcfSSatish Balay reason = TAO_DIVERGED_LS_FAILURE; 1927a7e14dcfSSatish Balay } else if (trradius < steptol && niter > 0){ 192847a47007SBarry Smith ierr = PetscInfo2(tao,"Trust region/step size too small: %g < %g\n", (double)trradius,(double)steptol);CHKERRQ(ierr); 1929a7e14dcfSSatish Balay reason = TAO_CONVERGED_STEPTOL; 1930e031d6f5SAlp Dener } else if (niter >= tao->max_it) { 1931a7e14dcfSSatish Balay ierr = PetscInfo2(tao,"Exceeded maximum number of iterations: %D > %D\n",niter,tao->max_it);CHKERRQ(ierr); 1932a7e14dcfSSatish Balay reason = TAO_DIVERGED_MAXITS; 1933a7e14dcfSSatish Balay } else { 1934a7e14dcfSSatish Balay reason = TAO_CONTINUE_ITERATING; 1935a7e14dcfSSatish Balay } 1936a7e14dcfSSatish Balay tao->reason = reason; 1937a7e14dcfSSatish Balay PetscFunctionReturn(0); 1938a7e14dcfSSatish Balay } 1939a7e14dcfSSatish Balay 1940a7e14dcfSSatish Balay /*@C 1941a7e14dcfSSatish Balay TaoSetOptionsPrefix - Sets the prefix used for searching for all 1942a7e14dcfSSatish Balay TAO options in the database. 1943a7e14dcfSSatish Balay 1944a7e14dcfSSatish Balay 1945441846f8SBarry Smith Logically Collective on Tao 1946a7e14dcfSSatish Balay 1947a7e14dcfSSatish Balay Input Parameters: 1948441846f8SBarry Smith + tao - the Tao context 1949a7e14dcfSSatish Balay - prefix - the prefix string to prepend to all TAO option requests 1950a7e14dcfSSatish Balay 1951a7e14dcfSSatish Balay Notes: 1952a7e14dcfSSatish Balay A hyphen (-) must NOT be given at the beginning of the prefix name. 1953a7e14dcfSSatish Balay The first character of all runtime options is AUTOMATICALLY the hyphen. 1954a7e14dcfSSatish Balay 1955a7e14dcfSSatish Balay For example, to distinguish between the runtime options for two 1956a7e14dcfSSatish Balay different TAO solvers, one could call 1957a7e14dcfSSatish Balay .vb 1958a7e14dcfSSatish Balay TaoSetOptionsPrefix(tao1,"sys1_") 1959a7e14dcfSSatish Balay TaoSetOptionsPrefix(tao2,"sys2_") 1960a7e14dcfSSatish Balay .ve 1961a7e14dcfSSatish Balay 1962a7e14dcfSSatish Balay This would enable use of different options for each system, such as 1963a7e14dcfSSatish Balay .vb 1964a7e14dcfSSatish Balay -sys1_tao_method blmvm -sys1_tao_gtol 1.e-3 1965a7e14dcfSSatish Balay -sys2_tao_method lmvm -sys2_tao_gtol 1.e-4 1966a7e14dcfSSatish Balay .ve 1967a7e14dcfSSatish Balay 1968a7e14dcfSSatish Balay 1969a7e14dcfSSatish Balay Level: advanced 1970a7e14dcfSSatish Balay 1971a7e14dcfSSatish Balay .seealso: TaoAppendOptionsPrefix(), TaoGetOptionsPrefix() 1972a7e14dcfSSatish Balay @*/ 1973a7e14dcfSSatish Balay 1974441846f8SBarry Smith PetscErrorCode TaoSetOptionsPrefix(Tao tao, const char p[]) 1975a7e14dcfSSatish Balay { 1976a7e14dcfSSatish Balay PetscErrorCode ierr; 197747a47007SBarry Smith 1978a7e14dcfSSatish Balay PetscFunctionBegin; 1979a7e14dcfSSatish Balay ierr = PetscObjectSetOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr); 1980a7e14dcfSSatish Balay if (tao->linesearch) { 1981a7e14dcfSSatish Balay ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr); 1982a7e14dcfSSatish Balay } 1983a7e14dcfSSatish Balay if (tao->ksp) { 1984a7e14dcfSSatish Balay ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr); 1985a7e14dcfSSatish Balay } 1986a7e14dcfSSatish Balay PetscFunctionReturn(0); 1987a7e14dcfSSatish Balay } 1988a7e14dcfSSatish Balay 1989a7e14dcfSSatish Balay /*@C 1990a7e14dcfSSatish Balay TaoAppendOptionsPrefix - Appends to the prefix used for searching for all 1991a7e14dcfSSatish Balay TAO options in the database. 1992a7e14dcfSSatish Balay 1993a7e14dcfSSatish Balay 1994441846f8SBarry Smith Logically Collective on Tao 1995a7e14dcfSSatish Balay 1996a7e14dcfSSatish Balay Input Parameters: 1997441846f8SBarry Smith + tao - the Tao solver context 1998a7e14dcfSSatish Balay - prefix - the prefix string to prepend to all TAO option requests 1999a7e14dcfSSatish Balay 2000a7e14dcfSSatish Balay Notes: 2001a7e14dcfSSatish Balay A hyphen (-) must NOT be given at the beginning of the prefix name. 2002a7e14dcfSSatish Balay The first character of all runtime options is AUTOMATICALLY the hyphen. 2003a7e14dcfSSatish Balay 2004a7e14dcfSSatish Balay 2005a7e14dcfSSatish Balay Level: advanced 2006a7e14dcfSSatish Balay 2007a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoGetOptionsPrefix() 2008a7e14dcfSSatish Balay @*/ 2009441846f8SBarry Smith PetscErrorCode TaoAppendOptionsPrefix(Tao tao, const char p[]) 2010a7e14dcfSSatish Balay { 2011a7e14dcfSSatish Balay PetscErrorCode ierr; 201247a47007SBarry Smith 2013a7e14dcfSSatish Balay PetscFunctionBegin; 2014a7e14dcfSSatish Balay ierr = PetscObjectAppendOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr); 2015a7e14dcfSSatish Balay if (tao->linesearch) { 2016a7e14dcfSSatish Balay ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr); 2017a7e14dcfSSatish Balay } 2018a7e14dcfSSatish Balay if (tao->ksp) { 2019a7e14dcfSSatish Balay ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr); 2020a7e14dcfSSatish Balay } 2021a7e14dcfSSatish Balay PetscFunctionReturn(0); 2022a7e14dcfSSatish Balay } 2023a7e14dcfSSatish Balay 2024a7e14dcfSSatish Balay /*@C 2025a7e14dcfSSatish Balay TaoGetOptionsPrefix - Gets the prefix used for searching for all 2026a7e14dcfSSatish Balay TAO options in the database 2027a7e14dcfSSatish Balay 2028a7e14dcfSSatish Balay Not Collective 2029a7e14dcfSSatish Balay 2030a7e14dcfSSatish Balay Input Parameters: 2031441846f8SBarry Smith . tao - the Tao context 2032a7e14dcfSSatish Balay 2033a7e14dcfSSatish Balay Output Parameters: 2034a7e14dcfSSatish Balay . prefix - pointer to the prefix string used is returned 2035a7e14dcfSSatish Balay 203695452b02SPatrick Sanan Notes: 203795452b02SPatrick Sanan On the fortran side, the user should pass in a string 'prefix' of 2038a7e14dcfSSatish Balay sufficient length to hold the prefix. 2039a7e14dcfSSatish Balay 2040a7e14dcfSSatish Balay Level: advanced 2041a7e14dcfSSatish Balay 2042a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoAppendOptionsPrefix() 2043a7e14dcfSSatish Balay @*/ 2044441846f8SBarry Smith PetscErrorCode TaoGetOptionsPrefix(Tao tao, const char *p[]) 2045a7e14dcfSSatish Balay { 204647a47007SBarry Smith return PetscObjectGetOptionsPrefix((PetscObject)tao,p); 2047a7e14dcfSSatish Balay } 2048a7e14dcfSSatish Balay 2049a7e14dcfSSatish Balay /*@C 2050a7e14dcfSSatish Balay TaoSetType - Sets the method for the unconstrained minimization solver. 2051a7e14dcfSSatish Balay 2052441846f8SBarry Smith Collective on Tao 2053a7e14dcfSSatish Balay 2054a7e14dcfSSatish Balay Input Parameters: 2055441846f8SBarry Smith + solver - the Tao solver context 2056a7e14dcfSSatish Balay - type - a known method 2057a7e14dcfSSatish Balay 2058a7e14dcfSSatish Balay Options Database Key: 205958417fe7SBarry Smith . -tao_type <type> - Sets the method; use -help for a list 206058417fe7SBarry Smith of available methods (for instance, "-tao_type lmvm" or "-tao_type tron") 2061a7e14dcfSSatish Balay 2062a7e14dcfSSatish Balay Available methods include: 206358417fe7SBarry Smith + nls - Newton's method with line search for unconstrained minimization 206458417fe7SBarry Smith . ntr - Newton's method with trust region for unconstrained minimization 206558417fe7SBarry Smith . ntl - Newton's method with trust region, line search for unconstrained minimization 206658417fe7SBarry Smith . lmvm - Limited memory variable metric method for unconstrained minimization 206758417fe7SBarry Smith . cg - Nonlinear conjugate gradient method for unconstrained minimization 206858417fe7SBarry Smith . nm - Nelder-Mead algorithm for derivate-free unconstrained minimization 206958417fe7SBarry Smith . tron - Newton Trust Region method for bound constrained minimization 207058417fe7SBarry Smith . gpcg - Newton Trust Region method for quadratic bound constrained minimization 207158417fe7SBarry Smith . blmvm - Limited memory variable metric method for bound constrained minimization 20721eb8069cSJason Sarich - pounders - Model-based algorithm pounder extended for nonlinear least squares 2073a7e14dcfSSatish Balay 2074a7e14dcfSSatish Balay Level: intermediate 2075a7e14dcfSSatish Balay 20761eb8069cSJason Sarich .seealso: TaoCreate(), TaoGetType(), TaoType 2077a7e14dcfSSatish Balay 2078a7e14dcfSSatish Balay @*/ 2079b625d6c7SJed Brown PetscErrorCode TaoSetType(Tao tao, TaoType type) 2080a7e14dcfSSatish Balay { 2081a7e14dcfSSatish Balay PetscErrorCode ierr; 2082441846f8SBarry Smith PetscErrorCode (*create_xxx)(Tao); 2083a7e14dcfSSatish Balay PetscBool issame; 2084a7e14dcfSSatish Balay 2085a7e14dcfSSatish Balay PetscFunctionBegin; 2086441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2087a7e14dcfSSatish Balay 2088a7e14dcfSSatish Balay ierr = PetscObjectTypeCompare((PetscObject)tao,type,&issame);CHKERRQ(ierr); 2089a7e14dcfSSatish Balay if (issame) PetscFunctionReturn(0); 2090a7e14dcfSSatish Balay 2091441846f8SBarry Smith ierr = PetscFunctionListFind(TaoList, type, (void(**)(void))&create_xxx);CHKERRQ(ierr); 2092441846f8SBarry Smith if (!create_xxx) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested Tao type %s",type); 2093a7e14dcfSSatish Balay 2094a7e14dcfSSatish Balay /* Destroy the existing solver information */ 2095a7e14dcfSSatish Balay if (tao->ops->destroy) { 2096a7e14dcfSSatish Balay ierr = (*tao->ops->destroy)(tao);CHKERRQ(ierr); 2097a7e14dcfSSatish Balay } 2098a7e14dcfSSatish Balay ierr = KSPDestroy(&tao->ksp);CHKERRQ(ierr); 2099a7e14dcfSSatish Balay ierr = TaoLineSearchDestroy(&tao->linesearch);CHKERRQ(ierr); 2100a7e14dcfSSatish Balay ierr = VecDestroy(&tao->gradient);CHKERRQ(ierr); 2101a7e14dcfSSatish Balay ierr = VecDestroy(&tao->stepdirection);CHKERRQ(ierr); 2102a7e14dcfSSatish Balay 2103a7e14dcfSSatish Balay tao->ops->setup = 0; 2104a7e14dcfSSatish Balay tao->ops->solve = 0; 2105a7e14dcfSSatish Balay tao->ops->view = 0; 2106a7e14dcfSSatish Balay tao->ops->setfromoptions = 0; 2107a7e14dcfSSatish Balay tao->ops->destroy = 0; 2108a7e14dcfSSatish Balay 2109a7e14dcfSSatish Balay tao->setupcalled = PETSC_FALSE; 2110a7e14dcfSSatish Balay 2111a7e14dcfSSatish Balay ierr = (*create_xxx)(tao);CHKERRQ(ierr); 2112a7e14dcfSSatish Balay ierr = PetscObjectChangeTypeName((PetscObject)tao,type);CHKERRQ(ierr); 2113a7e14dcfSSatish Balay PetscFunctionReturn(0); 2114a7e14dcfSSatish Balay } 211547a47007SBarry Smith 2116a7e14dcfSSatish Balay /*MC 2117441846f8SBarry Smith TaoRegister - Adds a method to the TAO package for unconstrained minimization. 2118a7e14dcfSSatish Balay 2119a7e14dcfSSatish Balay Synopsis: 2120441846f8SBarry Smith TaoRegister(char *name_solver,char *path,char *name_Create,int (*routine_Create)(Tao)) 2121a7e14dcfSSatish Balay 2122a7e14dcfSSatish Balay Not collective 2123a7e14dcfSSatish Balay 2124a7e14dcfSSatish Balay Input Parameters: 2125a7e14dcfSSatish Balay + sname - name of a new user-defined solver 2126a7e14dcfSSatish Balay - func - routine to Create method context 2127a7e14dcfSSatish Balay 2128a7e14dcfSSatish Balay Notes: 2129441846f8SBarry Smith TaoRegister() may be called multiple times to add several user-defined solvers. 2130a7e14dcfSSatish Balay 2131a7e14dcfSSatish Balay Sample usage: 2132a7e14dcfSSatish Balay .vb 2133441846f8SBarry Smith TaoRegister("my_solver",MySolverCreate); 2134a7e14dcfSSatish Balay .ve 2135a7e14dcfSSatish Balay 2136a7e14dcfSSatish Balay Then, your solver can be chosen with the procedural interface via 2137a7e14dcfSSatish Balay $ TaoSetType(tao,"my_solver") 2138a7e14dcfSSatish Balay or at runtime via the option 213958417fe7SBarry Smith $ -tao_type my_solver 2140a7e14dcfSSatish Balay 2141a7e14dcfSSatish Balay Level: advanced 2142a7e14dcfSSatish Balay 2143441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegisterDestroy() 2144a7e14dcfSSatish Balay M*/ 2145441846f8SBarry Smith PetscErrorCode TaoRegister(const char sname[], PetscErrorCode (*func)(Tao)) 2146a7e14dcfSSatish Balay { 2147a7e14dcfSSatish Balay PetscErrorCode ierr; 2148a7e14dcfSSatish Balay 2149a7e14dcfSSatish Balay PetscFunctionBegin; 2150441846f8SBarry Smith ierr = PetscFunctionListAdd(&TaoList,sname, (void (*)(void))func);CHKERRQ(ierr); 2151a7e14dcfSSatish Balay PetscFunctionReturn(0); 2152a7e14dcfSSatish Balay } 2153a7e14dcfSSatish Balay 2154a7e14dcfSSatish Balay /*@C 2155441846f8SBarry Smith TaoRegisterDestroy - Frees the list of minimization solvers that were 2156441846f8SBarry Smith registered by TaoRegisterDynamic(). 2157a7e14dcfSSatish Balay 2158a7e14dcfSSatish Balay Not Collective 2159a7e14dcfSSatish Balay 2160a7e14dcfSSatish Balay Level: advanced 2161a7e14dcfSSatish Balay 2162441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegister() 2163a7e14dcfSSatish Balay @*/ 2164441846f8SBarry Smith PetscErrorCode TaoRegisterDestroy(void) 2165a7e14dcfSSatish Balay { 2166a7e14dcfSSatish Balay PetscErrorCode ierr; 2167a7e14dcfSSatish Balay PetscFunctionBegin; 2168441846f8SBarry Smith ierr = PetscFunctionListDestroy(&TaoList);CHKERRQ(ierr); 2169441846f8SBarry Smith TaoRegisterAllCalled = PETSC_FALSE; 2170a7e14dcfSSatish Balay PetscFunctionReturn(0); 2171a7e14dcfSSatish Balay } 217247a47007SBarry Smith 21738931d482SJason Sarich /*@ 21748931d482SJason Sarich TaoGetIterationNumber - Gets the number of Tao iterations completed 21758931d482SJason Sarich at this time. 21768931d482SJason Sarich 21778931d482SJason Sarich Not Collective 21788931d482SJason Sarich 21798931d482SJason Sarich Input Parameter: 21808931d482SJason Sarich . tao - Tao context 21818931d482SJason Sarich 21828931d482SJason Sarich Output Parameter: 21838931d482SJason Sarich . iter - iteration number 21848931d482SJason Sarich 21858931d482SJason Sarich Notes: 21868931d482SJason Sarich For example, during the computation of iteration 2 this would return 1. 21878931d482SJason Sarich 21888931d482SJason Sarich 21898931d482SJason Sarich Level: intermediate 21908931d482SJason Sarich 21918931d482SJason Sarich .keywords: Tao, nonlinear, get, iteration, number, 21928931d482SJason Sarich 219379f5d8caSBarry Smith .seealso: TaoGetLinearSolveIterations(), TaoGetResidualNorm(), TaoGetObjective() 21948931d482SJason Sarich @*/ 21958931d482SJason Sarich PetscErrorCode TaoGetIterationNumber(Tao tao,PetscInt *iter) 21968931d482SJason Sarich { 21978931d482SJason Sarich PetscFunctionBegin; 21988931d482SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 21998931d482SJason Sarich PetscValidIntPointer(iter,2); 22008931d482SJason Sarich *iter = tao->niter; 22018931d482SJason Sarich PetscFunctionReturn(0); 22028931d482SJason Sarich } 22038931d482SJason Sarich 22048931d482SJason Sarich /*@ 220579f5d8caSBarry Smith TaoGetObjective - Gets the current value of the objective function 220679f5d8caSBarry Smith at this time. 220779f5d8caSBarry Smith 220879f5d8caSBarry Smith Not Collective 220979f5d8caSBarry Smith 221079f5d8caSBarry Smith Input Parameter: 221179f5d8caSBarry Smith . tao - Tao context 221279f5d8caSBarry Smith 221379f5d8caSBarry Smith Output Parameter: 221479f5d8caSBarry Smith . value - the current value 221579f5d8caSBarry Smith 221679f5d8caSBarry Smith Level: intermediate 221779f5d8caSBarry Smith 221879f5d8caSBarry Smith .keywords: Tao, nonlinear, get, iteration, number, 221979f5d8caSBarry Smith 222079f5d8caSBarry Smith .seealso: TaoGetLinearSolveIterations(), TaoGetIterationNumber(), TaoGetResidualNorm() 222179f5d8caSBarry Smith @*/ 222279f5d8caSBarry Smith PetscErrorCode TaoGetObjective(Tao tao,PetscReal *value) 222379f5d8caSBarry Smith { 222479f5d8caSBarry Smith PetscFunctionBegin; 222579f5d8caSBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 222679f5d8caSBarry Smith PetscValidRealPointer(value,2); 222779f5d8caSBarry Smith *value = tao->fc; 222879f5d8caSBarry Smith PetscFunctionReturn(0); 222979f5d8caSBarry Smith } 223079f5d8caSBarry Smith 223179f5d8caSBarry Smith /*@ 223279f5d8caSBarry Smith TaoGetResidualNorm - Gets the current value of the norm of the residual 223379f5d8caSBarry Smith at this time. 223479f5d8caSBarry Smith 223579f5d8caSBarry Smith Not Collective 223679f5d8caSBarry Smith 223779f5d8caSBarry Smith Input Parameter: 223879f5d8caSBarry Smith . tao - Tao context 223979f5d8caSBarry Smith 224079f5d8caSBarry Smith Output Parameter: 224179f5d8caSBarry Smith . value - the current value 224279f5d8caSBarry Smith 224379f5d8caSBarry Smith Level: intermediate 224479f5d8caSBarry Smith 224579f5d8caSBarry Smith Developer Note: This is the 2-norm of the residual, we cannot use TaoGetGradientNorm() because that has 224679f5d8caSBarry Smith a different meaning. For some reason Tao sometimes calls the gradient the residual. 224779f5d8caSBarry Smith 224879f5d8caSBarry Smith .keywords: Tao, nonlinear, get, iteration, number, 224979f5d8caSBarry Smith 225079f5d8caSBarry Smith .seealso: TaoGetLinearSolveIterations(), TaoGetIterationNumber(), TaoGetObjective() 225179f5d8caSBarry Smith @*/ 225279f5d8caSBarry Smith PetscErrorCode TaoGetResidualNorm(Tao tao,PetscReal *value) 225379f5d8caSBarry Smith { 225479f5d8caSBarry Smith PetscFunctionBegin; 225579f5d8caSBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 225679f5d8caSBarry Smith PetscValidRealPointer(value,2); 225779f5d8caSBarry Smith *value = tao->residual; 225879f5d8caSBarry Smith PetscFunctionReturn(0); 225979f5d8caSBarry Smith } 226079f5d8caSBarry Smith 226179f5d8caSBarry Smith /*@ 22628931d482SJason Sarich TaoSetIterationNumber - Sets the current iteration number. 22638931d482SJason Sarich 22648931d482SJason Sarich Not Collective 22658931d482SJason Sarich 22668931d482SJason Sarich Input Parameter: 22678931d482SJason Sarich . tao - Tao context 22688931d482SJason Sarich . iter - iteration number 22698931d482SJason Sarich 22708931d482SJason Sarich Level: developer 22718931d482SJason Sarich 22728931d482SJason Sarich .keywords: Tao, nonlinear, set, iteration, number, 22738931d482SJason Sarich 22748931d482SJason Sarich .seealso: TaoGetLinearSolveIterations() 22758931d482SJason Sarich @*/ 22768931d482SJason Sarich PetscErrorCode TaoSetIterationNumber(Tao tao,PetscInt iter) 22778931d482SJason Sarich { 22788931d482SJason Sarich PetscErrorCode ierr; 22798931d482SJason Sarich 22808931d482SJason Sarich PetscFunctionBegin; 22818931d482SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 22828931d482SJason Sarich ierr = PetscObjectSAWsTakeAccess((PetscObject)tao);CHKERRQ(ierr); 22838931d482SJason Sarich tao->niter = iter; 22848931d482SJason Sarich ierr = PetscObjectSAWsGrantAccess((PetscObject)tao);CHKERRQ(ierr); 22858931d482SJason Sarich PetscFunctionReturn(0); 22868931d482SJason Sarich } 22878931d482SJason Sarich 22888931d482SJason Sarich /*@ 22898931d482SJason Sarich TaoGetTotalIterationNumber - Gets the total number of Tao iterations 22908931d482SJason Sarich completed. This number keeps accumulating if multiple solves 22918931d482SJason Sarich are called with the Tao object. 22928931d482SJason Sarich 22938931d482SJason Sarich Not Collective 22948931d482SJason Sarich 22958931d482SJason Sarich Input Parameter: 22968931d482SJason Sarich . tao - Tao context 22978931d482SJason Sarich 22988931d482SJason Sarich Output Parameter: 22998931d482SJason Sarich . iter - iteration number 23008931d482SJason Sarich 23018931d482SJason Sarich Notes: 23028931d482SJason Sarich The total iteration count is updated after each solve, if there is a current 23038931d482SJason Sarich TaoSolve() in progress then those iterations are not yet counted. 23048931d482SJason Sarich 23058931d482SJason Sarich Level: intermediate 23068931d482SJason Sarich 23078931d482SJason Sarich .keywords: Tao, nonlinear, get, iteration, number, 23088931d482SJason Sarich 23098931d482SJason Sarich .seealso: TaoGetLinearSolveIterations() 23108931d482SJason Sarich @*/ 23118931d482SJason Sarich PetscErrorCode TaoGetTotalIterationNumber(Tao tao,PetscInt *iter) 23128931d482SJason Sarich { 23138931d482SJason Sarich PetscFunctionBegin; 23148931d482SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 23158931d482SJason Sarich PetscValidIntPointer(iter,2); 23168931d482SJason Sarich *iter = tao->ntotalits; 23178931d482SJason Sarich PetscFunctionReturn(0); 23188931d482SJason Sarich } 23198931d482SJason Sarich 23208931d482SJason Sarich /*@ 23218931d482SJason Sarich TaoSetTotalIterationNumber - Sets the current total iteration number. 23228931d482SJason Sarich 23238931d482SJason Sarich Not Collective 23248931d482SJason Sarich 23258931d482SJason Sarich Input Parameter: 23268931d482SJason Sarich . tao - Tao context 23278931d482SJason Sarich . iter - iteration number 23288931d482SJason Sarich 23298931d482SJason Sarich Level: developer 23308931d482SJason Sarich 23318931d482SJason Sarich .keywords: Tao, nonlinear, set, iteration, number, 23328931d482SJason Sarich 23338931d482SJason Sarich .seealso: TaoGetLinearSolveIterations() 23348931d482SJason Sarich @*/ 23358931d482SJason Sarich PetscErrorCode TaoSetTotalIterationNumber(Tao tao,PetscInt iter) 23368931d482SJason Sarich { 23378931d482SJason Sarich PetscErrorCode ierr; 23388931d482SJason Sarich 23398931d482SJason Sarich PetscFunctionBegin; 23408931d482SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 23418931d482SJason Sarich ierr = PetscObjectSAWsTakeAccess((PetscObject)tao);CHKERRQ(ierr); 23428931d482SJason Sarich tao->ntotalits = iter; 23438931d482SJason Sarich ierr = PetscObjectSAWsGrantAccess((PetscObject)tao);CHKERRQ(ierr); 23448931d482SJason Sarich PetscFunctionReturn(0); 23458931d482SJason Sarich } 23468931d482SJason Sarich 2347a7e14dcfSSatish Balay /*@ 2348e4cb33bbSBarry Smith TaoSetConvergedReason - Sets the termination flag on a Tao object 2349a7e14dcfSSatish Balay 2350441846f8SBarry Smith Logically Collective on Tao 2351a7e14dcfSSatish Balay 2352a7e14dcfSSatish Balay Input Parameters: 2353441846f8SBarry Smith + tao - the Tao context 2354a7e14dcfSSatish Balay - reason - one of 2355a7e14dcfSSatish Balay $ TAO_CONVERGED_ATOL (2), 2356a7e14dcfSSatish Balay $ TAO_CONVERGED_RTOL (3), 2357a7e14dcfSSatish Balay $ TAO_CONVERGED_STEPTOL (4), 2358a7e14dcfSSatish Balay $ TAO_CONVERGED_MINF (5), 2359a7e14dcfSSatish Balay $ TAO_CONVERGED_USER (6), 2360a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXITS (-2), 2361a7e14dcfSSatish Balay $ TAO_DIVERGED_NAN (-4), 2362a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXFCN (-5), 2363a7e14dcfSSatish Balay $ TAO_DIVERGED_LS_FAILURE (-6), 2364a7e14dcfSSatish Balay $ TAO_DIVERGED_TR_REDUCTION (-7), 2365a7e14dcfSSatish Balay $ TAO_DIVERGED_USER (-8), 2366a7e14dcfSSatish Balay $ TAO_CONTINUE_ITERATING (0) 2367a7e14dcfSSatish Balay 2368a7e14dcfSSatish Balay Level: intermediate 2369a7e14dcfSSatish Balay 2370a7e14dcfSSatish Balay @*/ 2371e4cb33bbSBarry Smith PetscErrorCode TaoSetConvergedReason(Tao tao, TaoConvergedReason reason) 2372a7e14dcfSSatish Balay { 2373441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2374a7e14dcfSSatish Balay PetscFunctionBegin; 2375a7e14dcfSSatish Balay tao->reason = reason; 2376a7e14dcfSSatish Balay PetscFunctionReturn(0); 2377a7e14dcfSSatish Balay } 2378a7e14dcfSSatish Balay 2379a7e14dcfSSatish Balay /*@ 2380e4cb33bbSBarry Smith TaoGetConvergedReason - Gets the reason the Tao iteration was stopped. 2381a7e14dcfSSatish Balay 2382a7e14dcfSSatish Balay Not Collective 2383a7e14dcfSSatish Balay 2384a7e14dcfSSatish Balay Input Parameter: 2385441846f8SBarry Smith . tao - the Tao solver context 2386a7e14dcfSSatish Balay 2387a7e14dcfSSatish Balay Output Parameter: 2388a7e14dcfSSatish Balay . reason - one of 2389a7e14dcfSSatish Balay $ TAO_CONVERGED_GATOL (3) ||g(X)|| < gatol 2390a7e14dcfSSatish Balay $ TAO_CONVERGED_GRTOL (4) ||g(X)|| / f(X) < grtol 2391a7e14dcfSSatish Balay $ TAO_CONVERGED_GTTOL (5) ||g(X)|| / ||g(X0)|| < gttol 2392a7e14dcfSSatish Balay $ TAO_CONVERGED_STEPTOL (6) step size small 2393a7e14dcfSSatish Balay $ TAO_CONVERGED_MINF (7) F < F_min 2394a7e14dcfSSatish Balay $ TAO_CONVERGED_USER (8) User defined 2395a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXITS (-2) its > maxits 2396a7e14dcfSSatish Balay $ TAO_DIVERGED_NAN (-4) Numerical problems 2397a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXFCN (-5) fevals > max_funcsals 2398a7e14dcfSSatish Balay $ TAO_DIVERGED_LS_FAILURE (-6) line search failure 2399a7e14dcfSSatish Balay $ TAO_DIVERGED_TR_REDUCTION (-7) trust region failure 2400a7e14dcfSSatish Balay $ TAO_DIVERGED_USER(-8) (user defined) 2401a7e14dcfSSatish Balay $ TAO_CONTINUE_ITERATING (0) 2402a7e14dcfSSatish Balay 2403a7e14dcfSSatish Balay where 2404a7e14dcfSSatish Balay + X - current solution 2405a7e14dcfSSatish Balay . X0 - initial guess 2406a7e14dcfSSatish Balay . f(X) - current function value 2407a7e14dcfSSatish Balay . f(X*) - true solution (estimated) 2408a7e14dcfSSatish Balay . g(X) - current gradient 2409a7e14dcfSSatish Balay . its - current iterate number 2410a7e14dcfSSatish Balay . maxits - maximum number of iterates 2411a7e14dcfSSatish Balay . fevals - number of function evaluations 2412a7e14dcfSSatish Balay - max_funcsals - maximum number of function evaluations 2413a7e14dcfSSatish Balay 2414a7e14dcfSSatish Balay Level: intermediate 2415a7e14dcfSSatish Balay 2416a7e14dcfSSatish Balay .seealso: TaoSetConvergenceTest(), TaoSetTolerances() 2417a7e14dcfSSatish Balay 2418a7e14dcfSSatish Balay @*/ 2419e4cb33bbSBarry Smith PetscErrorCode TaoGetConvergedReason(Tao tao, TaoConvergedReason *reason) 2420a7e14dcfSSatish Balay { 2421a7e14dcfSSatish Balay PetscFunctionBegin; 2422441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2423a7e14dcfSSatish Balay PetscValidPointer(reason,2); 2424a7e14dcfSSatish Balay *reason = tao->reason; 2425a7e14dcfSSatish Balay PetscFunctionReturn(0); 2426a7e14dcfSSatish Balay } 2427a7e14dcfSSatish Balay 2428a7e14dcfSSatish Balay /*@ 2429a7e14dcfSSatish Balay TaoGetSolutionStatus - Get the current iterate, objective value, 2430a7e14dcfSSatish Balay residual, infeasibility, and termination 2431a7e14dcfSSatish Balay 2432a7e14dcfSSatish Balay Not Collective 2433a7e14dcfSSatish Balay 2434a7e14dcfSSatish Balay Input Parameters: 2435441846f8SBarry Smith . tao - the Tao context 2436a7e14dcfSSatish Balay 2437a7e14dcfSSatish Balay Output Parameters: 2438a7e14dcfSSatish Balay + iterate - the current iterate number (>=0) 2439a7e14dcfSSatish Balay . f - the current function value 244058417fe7SBarry Smith . gnorm - the square of the gradient norm, duality gap, or other measure indicating distance from optimality. 2441a7e14dcfSSatish Balay . cnorm - the infeasibility of the current solution with regard to the constraints. 2442a7e14dcfSSatish Balay . xdiff - the step length or trust region radius of the most recent iterate. 2443a7e14dcfSSatish Balay - reason - The termination reason, which can equal TAO_CONTINUE_ITERATING 2444a7e14dcfSSatish Balay 2445a7e14dcfSSatish Balay Level: intermediate 2446a7e14dcfSSatish Balay 2447a7e14dcfSSatish Balay Note: 2448a7e14dcfSSatish Balay TAO returns the values set by the solvers in the routine TaoMonitor(). 2449a7e14dcfSSatish Balay 2450a7e14dcfSSatish Balay Note: 245147a47007SBarry Smith If any of the output arguments are set to NULL, no corresponding value will be returned. 2452a7e14dcfSSatish Balay 2453e4cb33bbSBarry Smith .seealso: TaoMonitor(), TaoGetConvergedReason() 2454a7e14dcfSSatish Balay @*/ 2455e4cb33bbSBarry Smith PetscErrorCode TaoGetSolutionStatus(Tao tao, PetscInt *its, PetscReal *f, PetscReal *gnorm, PetscReal *cnorm, PetscReal *xdiff, TaoConvergedReason *reason) 2456a7e14dcfSSatish Balay { 2457a7e14dcfSSatish Balay PetscFunctionBegin; 2458a7e14dcfSSatish Balay if (its) *its=tao->niter; 2459a7e14dcfSSatish Balay if (f) *f=tao->fc; 2460a7e14dcfSSatish Balay if (gnorm) *gnorm=tao->residual; 2461a7e14dcfSSatish Balay if (cnorm) *cnorm=tao->cnorm; 2462a7e14dcfSSatish Balay if (reason) *reason=tao->reason; 2463a7e14dcfSSatish Balay if (xdiff) *xdiff=tao->step; 2464a7e14dcfSSatish Balay PetscFunctionReturn(0); 2465a7e14dcfSSatish Balay } 2466a7e14dcfSSatish Balay 2467a7e14dcfSSatish Balay /*@C 2468441846f8SBarry Smith TaoGetType - Gets the current Tao algorithm. 2469a7e14dcfSSatish Balay 2470a7e14dcfSSatish Balay Not Collective 2471a7e14dcfSSatish Balay 2472a7e14dcfSSatish Balay Input Parameter: 2473441846f8SBarry Smith . tao - the Tao solver context 2474a7e14dcfSSatish Balay 2475a7e14dcfSSatish Balay Output Parameter: 2476441846f8SBarry Smith . type - Tao method 2477a7e14dcfSSatish Balay 2478a7e14dcfSSatish Balay Level: intermediate 2479a7e14dcfSSatish Balay 2480a7e14dcfSSatish Balay @*/ 2481b625d6c7SJed Brown PetscErrorCode TaoGetType(Tao tao,TaoType *type) 2482a7e14dcfSSatish Balay { 2483a7e14dcfSSatish Balay PetscFunctionBegin; 2484441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2485a7e14dcfSSatish Balay PetscValidPointer(type,2); 2486a7e14dcfSSatish Balay *type=((PetscObject)tao)->type_name; 2487a7e14dcfSSatish Balay PetscFunctionReturn(0); 2488a7e14dcfSSatish Balay } 2489a7e14dcfSSatish Balay 2490a7e14dcfSSatish Balay /*@C 2491a7e14dcfSSatish Balay TaoMonitor - Monitor the solver and the current solution. This 2492a7e14dcfSSatish Balay routine will record the iteration number and residual statistics, 2493a7e14dcfSSatish Balay call any monitors specified by the user, and calls the convergence-check routine. 2494a7e14dcfSSatish Balay 2495a7e14dcfSSatish Balay Input Parameters: 2496441846f8SBarry Smith + tao - the Tao context 2497a7e14dcfSSatish Balay . its - the current iterate number (>=0) 2498a7e14dcfSSatish Balay . f - the current objective function value 249958417fe7SBarry Smith . res - the gradient norm, square root of the duality gap, or other measure indicating distince from optimality. This measure will be recorded and 2500a7e14dcfSSatish Balay used for some termination tests. 2501a7e14dcfSSatish Balay . cnorm - the infeasibility of the current solution with regard to the constraints. 2502a7e14dcfSSatish Balay - steplength - multiple of the step direction added to the previous iterate. 2503a7e14dcfSSatish Balay 2504a7e14dcfSSatish Balay Output Parameters: 2505a7e14dcfSSatish Balay . reason - The termination reason, which can equal TAO_CONTINUE_ITERATING 2506a7e14dcfSSatish Balay 2507a7e14dcfSSatish Balay Options Database Key: 2508a7e14dcfSSatish Balay . -tao_monitor - Use the default monitor, which prints statistics to standard output 2509a7e14dcfSSatish Balay 251098ea980cSBarry Smith .seealso TaoGetConvergedReason(), TaoMonitorDefault(), TaoSetMonitor() 2511a7e14dcfSSatish Balay 2512a7e14dcfSSatish Balay Level: developer 2513a7e14dcfSSatish Balay 2514a7e14dcfSSatish Balay @*/ 25153ecd9318SAlp Dener PetscErrorCode TaoMonitor(Tao tao, PetscInt its, PetscReal f, PetscReal res, PetscReal cnorm, PetscReal steplength) 2516a7e14dcfSSatish Balay { 2517a7e14dcfSSatish Balay PetscErrorCode ierr; 251847a47007SBarry Smith PetscInt i; 251947a47007SBarry Smith 2520a7e14dcfSSatish Balay PetscFunctionBegin; 2521441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2522a7e14dcfSSatish Balay tao->fc = f; 2523a7e14dcfSSatish Balay tao->residual = res; 2524a7e14dcfSSatish Balay tao->cnorm = cnorm; 2525a7e14dcfSSatish Balay tao->step = steplength; 2526e52336cbSBarry Smith if (!its) { 2527a7e14dcfSSatish Balay tao->cnorm0 = cnorm; tao->gnorm0 = res; 2528a7e14dcfSSatish Balay } 252947a47007SBarry Smith if (PetscIsInfOrNanReal(f) || PetscIsInfOrNanReal(res)) SETERRQ(PETSC_COMM_SELF,1, "User provided compute function generated Inf or NaN"); 2530a7e14dcfSSatish Balay for (i=0;i<tao->numbermonitors;i++) { 2531a7e14dcfSSatish Balay ierr = (*tao->monitor[i])(tao,tao->monitorcontext[i]);CHKERRQ(ierr); 2532a7e14dcfSSatish Balay } 2533a7e14dcfSSatish Balay PetscFunctionReturn(0); 2534a7e14dcfSSatish Balay } 2535a7e14dcfSSatish Balay 2536a7e14dcfSSatish Balay /*@ 2537ae93cb3cSJason Sarich TaoSetConvergenceHistory - Sets the array used to hold the convergence history. 2538a7e14dcfSSatish Balay 2539441846f8SBarry Smith Logically Collective on Tao 2540a7e14dcfSSatish Balay 2541a7e14dcfSSatish Balay Input Parameters: 2542441846f8SBarry Smith + tao - the Tao solver context 2543a7e14dcfSSatish Balay . obj - array to hold objective value history 2544a7e14dcfSSatish Balay . resid - array to hold residual history 2545a7e14dcfSSatish Balay . cnorm - array to hold constraint violation history 2546be1558d8SJason Sarich . lits - integer array holds the number of linear iterations for each Tao iteration 2547a7e14dcfSSatish Balay . na - size of obj, resid, and cnorm 2548a7e14dcfSSatish Balay - reset - PetscTrue indicates each new minimization resets the history counter to zero, 2549a7e14dcfSSatish Balay else it continues storing new values for new minimizations after the old ones 2550a7e14dcfSSatish Balay 2551a7e14dcfSSatish Balay Notes: 2552a7e14dcfSSatish Balay If set, TAO will fill the given arrays with the indicated 2553ae93cb3cSJason Sarich information at each iteration. If 'obj','resid','cnorm','lits' are 2554ae93cb3cSJason Sarich *all* NULL then space (using size na, or 1000 if na is PETSC_DECIDE or 2555ae93cb3cSJason Sarich PETSC_DEFAULT) is allocated for the history. 2556be1558d8SJason Sarich If not all are NULL, then only the non-NULL information categories 2557ae93cb3cSJason Sarich will be stored, the others will be ignored. 2558ae93cb3cSJason Sarich 2559ae93cb3cSJason Sarich Any convergence information after iteration number 'na' will not be stored. 2560a7e14dcfSSatish Balay 2561a7e14dcfSSatish Balay This routine is useful, e.g., when running a code for purposes 2562a7e14dcfSSatish Balay of accurate performance monitoring, when no I/O should be done 2563a7e14dcfSSatish Balay during the section of code that is being timed. 2564a7e14dcfSSatish Balay 2565a7e14dcfSSatish Balay Level: intermediate 2566a7e14dcfSSatish Balay 2567ae93cb3cSJason Sarich .seealso: TaoGetConvergenceHistory() 2568a7e14dcfSSatish Balay 2569a7e14dcfSSatish Balay @*/ 25701b266c99SBarry Smith PetscErrorCode TaoSetConvergenceHistory(Tao tao, PetscReal obj[], PetscReal resid[], PetscReal cnorm[], PetscInt lits[], PetscInt na,PetscBool reset) 2571a7e14dcfSSatish Balay { 2572ae93cb3cSJason Sarich PetscErrorCode ierr; 2573ae93cb3cSJason Sarich 2574a7e14dcfSSatish Balay PetscFunctionBegin; 2575441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2576ae93cb3cSJason Sarich if (obj) PetscValidScalarPointer(obj,2); 2577ae93cb3cSJason Sarich if (resid) PetscValidScalarPointer(resid,3); 2578ae93cb3cSJason Sarich if (cnorm) PetscValidScalarPointer(cnorm,4); 2579ae93cb3cSJason Sarich if (lits) PetscValidIntPointer(lits,5); 2580ae93cb3cSJason Sarich 2581ae93cb3cSJason Sarich if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000; 2582ae93cb3cSJason Sarich if (!obj && !resid && !cnorm && !lits) { 2583ae93cb3cSJason Sarich ierr = PetscCalloc1(na,&obj);CHKERRQ(ierr); 2584ae93cb3cSJason Sarich ierr = PetscCalloc1(na,&resid);CHKERRQ(ierr); 2585ae93cb3cSJason Sarich ierr = PetscCalloc1(na,&cnorm);CHKERRQ(ierr); 2586ae93cb3cSJason Sarich ierr = PetscCalloc1(na,&lits);CHKERRQ(ierr); 2587ae93cb3cSJason Sarich tao->hist_malloc=PETSC_TRUE; 2588ae93cb3cSJason Sarich } 2589ae93cb3cSJason Sarich 2590a7e14dcfSSatish Balay tao->hist_obj = obj; 2591a7e14dcfSSatish Balay tao->hist_resid = resid; 2592a7e14dcfSSatish Balay tao->hist_cnorm = cnorm; 2593ae93cb3cSJason Sarich tao->hist_lits = lits; 2594a7e14dcfSSatish Balay tao->hist_max = na; 2595a7e14dcfSSatish Balay tao->hist_reset = reset; 2596ae93cb3cSJason Sarich tao->hist_len = 0; 2597a7e14dcfSSatish Balay PetscFunctionReturn(0); 2598a7e14dcfSSatish Balay } 2599a7e14dcfSSatish Balay 2600a7e14dcfSSatish Balay /*@C 2601ae93cb3cSJason Sarich TaoGetConvergenceHistory - Gets the arrays used to hold the convergence history. 2602a7e14dcfSSatish Balay 2603441846f8SBarry Smith Collective on Tao 2604a7e14dcfSSatish Balay 2605a7e14dcfSSatish Balay Input Parameter: 2606441846f8SBarry Smith . tao - the Tao context 2607a7e14dcfSSatish Balay 2608a7e14dcfSSatish Balay Output Parameters: 2609a7e14dcfSSatish Balay + obj - array used to hold objective value history 2610a7e14dcfSSatish Balay . resid - array used to hold residual history 2611a7e14dcfSSatish Balay . cnorm - array used to hold constraint violation history 2612ae93cb3cSJason Sarich . lits - integer array used to hold linear solver iteration count 2613ae93cb3cSJason Sarich - nhist - size of obj, resid, cnorm, and lits (will be less than or equal to na given in TaoSetHistory) 2614a7e14dcfSSatish Balay 2615a7e14dcfSSatish Balay Notes: 2616ae93cb3cSJason Sarich This routine must be preceded by calls to TaoSetConvergenceHistory() 2617ae93cb3cSJason Sarich and TaoSolve(), otherwise it returns useless information. 2618ae93cb3cSJason Sarich 2619a7e14dcfSSatish Balay The calling sequence for this routine in Fortran is 2620ae93cb3cSJason Sarich $ call TaoGetConvergenceHistory(Tao tao, PetscInt nhist, PetscErrorCode ierr) 2621a7e14dcfSSatish Balay 2622a7e14dcfSSatish Balay This routine is useful, e.g., when running a code for purposes 2623a7e14dcfSSatish Balay of accurate performance monitoring, when no I/O should be done 2624a7e14dcfSSatish Balay during the section of code that is being timed. 2625a7e14dcfSSatish Balay 2626a7e14dcfSSatish Balay Level: advanced 2627a7e14dcfSSatish Balay 2628ae93cb3cSJason Sarich .seealso: TaoSetConvergenceHistory() 2629a7e14dcfSSatish Balay 2630a7e14dcfSSatish Balay @*/ 2631ae93cb3cSJason Sarich PetscErrorCode TaoGetConvergenceHistory(Tao tao, PetscReal **obj, PetscReal **resid, PetscReal **cnorm, PetscInt **lits, PetscInt *nhist) 2632a7e14dcfSSatish Balay { 2633a7e14dcfSSatish Balay PetscFunctionBegin; 2634441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2635a7e14dcfSSatish Balay if (obj) *obj = tao->hist_obj; 2636a7e14dcfSSatish Balay if (cnorm) *cnorm = tao->hist_cnorm; 2637a7e14dcfSSatish Balay if (resid) *resid = tao->hist_resid; 2638a7e14dcfSSatish Balay if (nhist) *nhist = tao->hist_len; 2639a7e14dcfSSatish Balay PetscFunctionReturn(0); 2640a7e14dcfSSatish Balay } 2641a7e14dcfSSatish Balay 2642a7e14dcfSSatish Balay /*@ 2643a7e14dcfSSatish Balay TaoSetApplicationContext - Sets the optional user-defined context for 2644a7e14dcfSSatish Balay a solver. 2645a7e14dcfSSatish Balay 2646441846f8SBarry Smith Logically Collective on Tao 2647a7e14dcfSSatish Balay 2648a7e14dcfSSatish Balay Input Parameters: 2649441846f8SBarry Smith + tao - the Tao context 2650a7e14dcfSSatish Balay - usrP - optional user context 2651a7e14dcfSSatish Balay 2652a7e14dcfSSatish Balay Level: intermediate 2653a7e14dcfSSatish Balay 2654a7e14dcfSSatish Balay .seealso: TaoGetApplicationContext(), TaoSetApplicationContext() 2655a7e14dcfSSatish Balay @*/ 2656441846f8SBarry Smith PetscErrorCode TaoSetApplicationContext(Tao tao,void *usrP) 2657a7e14dcfSSatish Balay { 2658a7e14dcfSSatish Balay PetscFunctionBegin; 2659441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2660a7e14dcfSSatish Balay tao->user = usrP; 2661a7e14dcfSSatish Balay PetscFunctionReturn(0); 2662a7e14dcfSSatish Balay } 2663a7e14dcfSSatish Balay 2664a7e14dcfSSatish Balay /*@ 2665a7e14dcfSSatish Balay TaoGetApplicationContext - Gets the user-defined context for a 2666a7e14dcfSSatish Balay TAO solvers. 2667a7e14dcfSSatish Balay 2668a7e14dcfSSatish Balay Not Collective 2669a7e14dcfSSatish Balay 2670a7e14dcfSSatish Balay Input Parameter: 2671441846f8SBarry Smith . tao - Tao context 2672a7e14dcfSSatish Balay 2673a7e14dcfSSatish Balay Output Parameter: 2674a7e14dcfSSatish Balay . usrP - user context 2675a7e14dcfSSatish Balay 2676a7e14dcfSSatish Balay Level: intermediate 2677a7e14dcfSSatish Balay 2678a7e14dcfSSatish Balay .seealso: TaoSetApplicationContext() 2679a7e14dcfSSatish Balay @*/ 2680441846f8SBarry Smith PetscErrorCode TaoGetApplicationContext(Tao tao,void *usrP) 2681a7e14dcfSSatish Balay { 2682a7e14dcfSSatish Balay PetscFunctionBegin; 2683441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2684a7e14dcfSSatish Balay *(void**)usrP = tao->user; 2685a7e14dcfSSatish Balay PetscFunctionReturn(0); 2686a7e14dcfSSatish Balay } 2687a9603a14SPatrick Farrell 2688a9603a14SPatrick Farrell /*@ 2689a9603a14SPatrick Farrell TaoSetGradientNorm - Sets the matrix used to define the inner product that measures the size of the gradient. 2690a9603a14SPatrick Farrell 2691a9603a14SPatrick Farrell Collective on tao 2692a9603a14SPatrick Farrell 2693a9603a14SPatrick Farrell Input Parameters: 2694a9603a14SPatrick Farrell + tao - the Tao context 2695a9603a14SPatrick Farrell - M - gradient norm 2696a9603a14SPatrick Farrell 2697a9603a14SPatrick Farrell Level: beginner 2698a9603a14SPatrick Farrell 2699a9603a14SPatrick Farrell .seealso: TaoGetGradientNorm(), TaoGradientNorm() 2700a9603a14SPatrick Farrell @*/ 2701a9603a14SPatrick Farrell PetscErrorCode TaoSetGradientNorm(Tao tao, Mat M) 2702a9603a14SPatrick Farrell { 2703a9603a14SPatrick Farrell PetscErrorCode ierr; 2704a9603a14SPatrick Farrell 2705a9603a14SPatrick Farrell PetscFunctionBegin; 2706a9603a14SPatrick Farrell PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2707a9603a14SPatrick Farrell 2708a9603a14SPatrick Farrell if (tao->gradient_norm) { 2709a9603a14SPatrick Farrell ierr = PetscObjectDereference((PetscObject)tao->gradient_norm);CHKERRQ(ierr); 2710a9603a14SPatrick Farrell ierr = VecDestroy(&tao->gradient_norm_tmp);CHKERRQ(ierr); 2711a9603a14SPatrick Farrell } 2712a9603a14SPatrick Farrell 2713a9603a14SPatrick Farrell ierr = PetscObjectReference((PetscObject)M);CHKERRQ(ierr); 2714a9603a14SPatrick Farrell tao->gradient_norm = M; 2715a9603a14SPatrick Farrell ierr = MatCreateVecs(M, NULL, &tao->gradient_norm_tmp);CHKERRQ(ierr); 2716a9603a14SPatrick Farrell PetscFunctionReturn(0); 2717a9603a14SPatrick Farrell } 2718a9603a14SPatrick Farrell 2719a9603a14SPatrick Farrell /*@ 2720a9603a14SPatrick Farrell TaoGetGradientNorm - Returns the matrix used to define the inner product for measuring the size of the gradient. 2721a9603a14SPatrick Farrell 2722a9603a14SPatrick Farrell Not Collective 2723a9603a14SPatrick Farrell 2724a9603a14SPatrick Farrell Input Parameter: 2725a9603a14SPatrick Farrell . tao - Tao context 2726a9603a14SPatrick Farrell 2727a9603a14SPatrick Farrell Output Parameter: 2728a9603a14SPatrick Farrell . M - gradient norm 2729a9603a14SPatrick Farrell 2730a9603a14SPatrick Farrell Level: beginner 2731a9603a14SPatrick Farrell 2732a9603a14SPatrick Farrell .seealso: TaoSetGradientNorm(), TaoGradientNorm() 2733a9603a14SPatrick Farrell @*/ 2734a9603a14SPatrick Farrell PetscErrorCode TaoGetGradientNorm(Tao tao, Mat *M) 2735a9603a14SPatrick Farrell { 2736a9603a14SPatrick Farrell PetscFunctionBegin; 2737a9603a14SPatrick Farrell PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2738a9603a14SPatrick Farrell *M = tao->gradient_norm; 2739a9603a14SPatrick Farrell PetscFunctionReturn(0); 2740a9603a14SPatrick Farrell } 2741a9603a14SPatrick Farrell 2742a9603a14SPatrick Farrell /*c 2743a9603a14SPatrick Farrell TaoGradientNorm - Compute the norm with respect to the inner product the user has set. 2744a9603a14SPatrick Farrell 2745a9603a14SPatrick Farrell Collective on tao 2746a9603a14SPatrick Farrell 2747a9603a14SPatrick Farrell Input Parameter: 2748a9603a14SPatrick Farrell . tao - the Tao context 2749a9603a14SPatrick Farrell . gradient - the gradient to be computed 2750a9603a14SPatrick Farrell . norm - the norm type 2751a9603a14SPatrick Farrell 2752a9603a14SPatrick Farrell Output Parameter: 2753a9603a14SPatrick Farrell . gnorm - the gradient norm 2754a9603a14SPatrick Farrell 2755a9603a14SPatrick Farrell Level: developer 2756a9603a14SPatrick Farrell 2757a9603a14SPatrick Farrell .seealso: TaoSetGradientNorm(), TaoGetGradientNorm() 2758a9603a14SPatrick Farrell @*/ 2759a9603a14SPatrick Farrell PetscErrorCode TaoGradientNorm(Tao tao, Vec gradient, NormType type, PetscReal *gnorm) 2760a9603a14SPatrick Farrell { 2761a9603a14SPatrick Farrell PetscErrorCode ierr; 2762a9603a14SPatrick Farrell 2763a9603a14SPatrick Farrell PetscFunctionBegin; 2764a9603a14SPatrick Farrell PetscValidHeaderSpecific(gradient,VEC_CLASSID,1); 2765a9603a14SPatrick Farrell 2766a9603a14SPatrick Farrell if (tao->gradient_norm) { 2767680e2bc7SPatrick Farrell PetscScalar gnorms; 2768680e2bc7SPatrick Farrell 2769a9603a14SPatrick 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."); 2770a9603a14SPatrick Farrell ierr = MatMult(tao->gradient_norm, gradient, tao->gradient_norm_tmp);CHKERRQ(ierr); 2771680e2bc7SPatrick Farrell ierr = VecDot(gradient, tao->gradient_norm_tmp, &gnorms);CHKERRQ(ierr); 27727bb79937SPatrick Farrell *gnorm = PetscRealPart(PetscSqrtScalar(gnorms)); 2773a9603a14SPatrick Farrell } else { 2774a9603a14SPatrick Farrell ierr = VecNorm(gradient, type, gnorm);CHKERRQ(ierr); 2775a9603a14SPatrick Farrell } 2776a9603a14SPatrick Farrell PetscFunctionReturn(0); 2777a9603a14SPatrick Farrell } 2778a9603a14SPatrick Farrell 2779e882e171SHong Zhang /*@C 2780e882e171SHong Zhang TaoMonitorDrawCtxCreate - Creates the monitor context for TaoMonitorDrawCtx 2781a9603a14SPatrick Farrell 2782e882e171SHong Zhang Collective on Tao 2783e882e171SHong Zhang 2784e882e171SHong Zhang Output Patameter: 2785e882e171SHong Zhang . ctx - the monitor context 2786e882e171SHong Zhang 2787e882e171SHong Zhang Options Database: 2788e882e171SHong Zhang . -tao_draw_solution_initial - show initial guess as well as current solution 2789e882e171SHong Zhang 2790e882e171SHong Zhang Level: intermediate 2791e882e171SHong Zhang 2792e882e171SHong Zhang .keywords: Tao, vector, monitor, view 2793e882e171SHong Zhang 2794e882e171SHong Zhang .seealso: TaoMonitorSet(), TaoMonitorDefault(), VecView(), TaoMonitorDrawCtx() 2795e882e171SHong Zhang @*/ 2796e882e171SHong Zhang PetscErrorCode TaoMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TaoMonitorDrawCtx *ctx) 2797e882e171SHong Zhang { 2798e882e171SHong Zhang PetscErrorCode ierr; 2799e882e171SHong Zhang 2800e882e171SHong Zhang PetscFunctionBegin; 2801e882e171SHong Zhang ierr = PetscNew(ctx);CHKERRQ(ierr); 2802e882e171SHong Zhang ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr); 2803e882e171SHong Zhang ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr); 2804e882e171SHong Zhang (*ctx)->howoften = howoften; 2805e882e171SHong Zhang PetscFunctionReturn(0); 2806e882e171SHong Zhang } 2807e882e171SHong Zhang 2808e882e171SHong Zhang /*@C 2809e882e171SHong Zhang TaoMonitorDrawCtxDestroy - Destroys the monitor context for TaoMonitorDrawSolution() 2810e882e171SHong Zhang 2811e882e171SHong Zhang Collective on Tao 2812e882e171SHong Zhang 2813e882e171SHong Zhang Input Parameters: 2814e882e171SHong Zhang . ctx - the monitor context 2815e882e171SHong Zhang 2816e882e171SHong Zhang Level: intermediate 2817e882e171SHong Zhang 2818e882e171SHong Zhang .keywords: Tao, vector, monitor, view 2819e882e171SHong Zhang 2820e882e171SHong Zhang .seealso: TaoMonitorSet(), TaoMonitorDefault(), VecView(), TaoMonitorDrawSolution() 2821e882e171SHong Zhang @*/ 2822e882e171SHong Zhang PetscErrorCode TaoMonitorDrawCtxDestroy(TaoMonitorDrawCtx *ictx) 2823e882e171SHong Zhang { 2824e882e171SHong Zhang PetscErrorCode ierr; 2825e882e171SHong Zhang 2826e882e171SHong Zhang PetscFunctionBegin; 2827e882e171SHong Zhang ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr); 2828e882e171SHong Zhang ierr = PetscFree(*ictx);CHKERRQ(ierr); 2829e882e171SHong Zhang PetscFunctionReturn(0); 2830e882e171SHong Zhang } 2831