1441846f8SBarry Smith #define TAO_DLL 2a7e14dcfSSatish Balay 3af0996ceSBarry Smith #include <petsc/private/taoimpl.h> /*I "petsctao.h" I*/ 4a7e14dcfSSatish Balay 5441846f8SBarry Smith PetscBool TaoRegisterAllCalled = PETSC_FALSE; 6441846f8SBarry Smith PetscFunctionList TaoList = NULL; 7a7e14dcfSSatish Balay 8441846f8SBarry Smith PetscClassId TAO_CLASSID; 9441846f8SBarry Smith PetscLogEvent Tao_Solve, Tao_ObjectiveEval, Tao_GradientEval, Tao_ObjGradientEval, Tao_HessianEval, Tao_ConstraintsEval, Tao_JacobianEval; 10a7e14dcfSSatish Balay 115b0d99aeSBarry Smith const char *TaoSubSetTypes[] = { "subvec","mask","matrixfree","TaoSubSetType","TAO_SUBSET_",0}; 12a7e14dcfSSatish Balay 13a7e14dcfSSatish Balay #undef __FUNCT__ 14a7e14dcfSSatish Balay #define __FUNCT__ "TaoCreate" 15a7e14dcfSSatish Balay /*@ 16a7e14dcfSSatish Balay TaoCreate - Creates a TAO solver 17a7e14dcfSSatish Balay 18a7e14dcfSSatish Balay Collective on MPI_Comm 19a7e14dcfSSatish Balay 20a7e14dcfSSatish Balay Input Parameter: 21a7e14dcfSSatish Balay . comm - MPI communicator 22a7e14dcfSSatish Balay 23a7e14dcfSSatish Balay Output Parameter: 24441846f8SBarry Smith . newtao - the new Tao context 25a7e14dcfSSatish Balay 26a7e14dcfSSatish Balay Available methods include: 2758417fe7SBarry Smith + nls - Newton's method with line search for unconstrained minimization 2858417fe7SBarry Smith . ntr - Newton's method with trust region for unconstrained minimization 2958417fe7SBarry Smith . ntl - Newton's method with trust region, line search for unconstrained minimization 3058417fe7SBarry Smith . lmvm - Limited memory variable metric method for unconstrained minimization 3158417fe7SBarry Smith . cg - Nonlinear conjugate gradient method for unconstrained minimization 3258417fe7SBarry Smith . nm - Nelder-Mead algorithm for derivate-free unconstrained minimization 3358417fe7SBarry Smith . tron - Newton Trust Region method for bound constrained minimization 3458417fe7SBarry Smith . gpcg - Newton Trust Region method for quadratic bound constrained minimization 3558417fe7SBarry Smith . blmvm - Limited memory variable metric method for bound constrained minimization 3658417fe7SBarry Smith . lcl - Linearly constrained Lagrangian method for pde-constrained minimization 3758417fe7SBarry Smith - pounders - Model-based algorithm for nonlinear least squares 38a7e14dcfSSatish Balay 39a7e14dcfSSatish Balay Options Database Keys: 4058417fe7SBarry Smith . -tao_type - select which method TAO should use 41a7e14dcfSSatish Balay 42a7e14dcfSSatish Balay Level: beginner 43a7e14dcfSSatish Balay 44a7e14dcfSSatish Balay .seealso: TaoSolve(), TaoDestroy() 45a7e14dcfSSatish Balay @*/ 46441846f8SBarry Smith PetscErrorCode TaoCreate(MPI_Comm comm, Tao *newtao) 47a7e14dcfSSatish Balay { 48a7e14dcfSSatish Balay PetscErrorCode ierr; 49441846f8SBarry Smith Tao tao; 50a7e14dcfSSatish Balay 51a7e14dcfSSatish Balay PetscFunctionBegin; 52a7e14dcfSSatish Balay PetscValidPointer(newtao,2); 5347a47007SBarry Smith *newtao = NULL; 54a7e14dcfSSatish Balay 55a7e14dcfSSatish Balay ierr = TaoInitializePackage();CHKERRQ(ierr); 56a7e14dcfSSatish Balay ierr = TaoLineSearchInitializePackage();CHKERRQ(ierr); 57a7e14dcfSSatish Balay 5873107ff1SLisandro Dalcin ierr = PetscHeaderCreate(tao,TAO_CLASSID,"Tao","Optimization solver","Tao",comm,TaoDestroy,TaoView);CHKERRQ(ierr); 59a7e14dcfSSatish Balay tao->ops->computeobjective=0; 60a7e14dcfSSatish Balay tao->ops->computeobjectiveandgradient=0; 61a7e14dcfSSatish Balay tao->ops->computegradient=0; 62a7e14dcfSSatish Balay tao->ops->computehessian=0; 63a7e14dcfSSatish Balay tao->ops->computeseparableobjective=0; 64a7e14dcfSSatish Balay tao->ops->computeconstraints=0; 65a7e14dcfSSatish Balay tao->ops->computejacobian=0; 66a7e14dcfSSatish Balay tao->ops->computejacobianequality=0; 67a7e14dcfSSatish Balay tao->ops->computejacobianinequality=0; 68a7e14dcfSSatish Balay tao->ops->computeequalityconstraints=0; 69a7e14dcfSSatish Balay tao->ops->computeinequalityconstraints=0; 70a7e14dcfSSatish Balay tao->ops->convergencetest=TaoDefaultConvergenceTest; 71a7e14dcfSSatish Balay tao->ops->convergencedestroy=0; 72a7e14dcfSSatish Balay tao->ops->computedual=0; 73a7e14dcfSSatish Balay tao->ops->setup=0; 74a7e14dcfSSatish Balay tao->ops->solve=0; 75a7e14dcfSSatish Balay tao->ops->view=0; 76a7e14dcfSSatish Balay tao->ops->setfromoptions=0; 77a7e14dcfSSatish Balay tao->ops->destroy=0; 78a7e14dcfSSatish Balay 7947a47007SBarry Smith tao->solution=NULL; 8047a47007SBarry Smith tao->gradient=NULL; 8147a47007SBarry Smith tao->sep_objective = NULL; 8247a47007SBarry Smith tao->constraints=NULL; 8347a47007SBarry Smith tao->constraints_equality=NULL; 8447a47007SBarry Smith tao->constraints_inequality=NULL; 85125ddc8aSJason Sarich tao->sep_weights_v=NULL; 86125ddc8aSJason Sarich tao->sep_weights_w=NULL; 8747a47007SBarry Smith tao->stepdirection=NULL; 888931d482SJason Sarich tao->niter=0; 898931d482SJason Sarich tao->ntotalits=0; 9047a47007SBarry Smith tao->XL = NULL; 9147a47007SBarry Smith tao->XU = NULL; 9247a47007SBarry Smith tao->IL = NULL; 9347a47007SBarry Smith tao->IU = NULL; 9447a47007SBarry Smith tao->DI = NULL; 9547a47007SBarry Smith tao->DE = NULL; 96a9603a14SPatrick Farrell tao->gradient_norm = NULL; 97a9603a14SPatrick Farrell tao->gradient_norm_tmp = NULL; 9847a47007SBarry Smith tao->hessian = NULL; 9947a47007SBarry Smith tao->hessian_pre = NULL; 10047a47007SBarry Smith tao->jacobian = NULL; 10147a47007SBarry Smith tao->jacobian_pre = NULL; 10247a47007SBarry Smith tao->jacobian_state = NULL; 10347a47007SBarry Smith tao->jacobian_state_pre = NULL; 10447a47007SBarry Smith tao->jacobian_state_inv = NULL; 10547a47007SBarry Smith tao->jacobian_design = NULL; 10647a47007SBarry Smith tao->jacobian_design_pre = NULL; 10747a47007SBarry Smith tao->jacobian_equality = NULL; 10847a47007SBarry Smith tao->jacobian_equality_pre = NULL; 10947a47007SBarry Smith tao->jacobian_inequality = NULL; 11047a47007SBarry Smith tao->jacobian_inequality_pre = NULL; 11147a47007SBarry Smith tao->state_is = NULL; 11247a47007SBarry Smith tao->design_is = NULL; 113a7e14dcfSSatish Balay 114a7e14dcfSSatish Balay tao->max_it = 10000; 115a7e14dcfSSatish Balay tao->max_funcs = 10000; 1166f4723b1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 1176f4723b1SBarry Smith tao->gatol = 1e-5; 1186f4723b1SBarry Smith tao->grtol = 1e-5; 1196f4723b1SBarry Smith #else 120a7e14dcfSSatish Balay tao->gatol = 1e-8; 121a7e14dcfSSatish Balay tao->grtol = 1e-8; 1226f4723b1SBarry Smith #endif 123a7e14dcfSSatish Balay tao->crtol = 0.0; 1246552cf8aSJason Sarich tao->catol = 0.0; 125a7e14dcfSSatish Balay tao->steptol = 0.0; 1266552cf8aSJason Sarich tao->gttol = 0.0; 127e270355aSBarry Smith tao->trust0 = PETSC_INFINITY; 1286f4723b1SBarry Smith tao->fmin = PETSC_NINFINITY; 129ae93cb3cSJason Sarich tao->hist_malloc = PETSC_FALSE; 130a7e14dcfSSatish Balay tao->hist_reset = PETSC_TRUE; 131a7e14dcfSSatish Balay tao->hist_max = 0; 132a7e14dcfSSatish Balay tao->hist_len = 0; 13347a47007SBarry Smith tao->hist_obj = NULL; 13447a47007SBarry Smith tao->hist_resid = NULL; 13547a47007SBarry Smith tao->hist_cnorm = NULL; 136ae93cb3cSJason Sarich tao->hist_lits = NULL; 137a7e14dcfSSatish Balay 138a7e14dcfSSatish Balay tao->numbermonitors=0; 139a7e14dcfSSatish Balay tao->viewsolution=PETSC_FALSE; 140a7e14dcfSSatish Balay tao->viewhessian=PETSC_FALSE; 141a7e14dcfSSatish Balay tao->viewgradient=PETSC_FALSE; 142a7e14dcfSSatish Balay tao->viewjacobian=PETSC_FALSE; 143a7e14dcfSSatish Balay tao->viewconstraints = PETSC_FALSE; 144a7e14dcfSSatish Balay 1456552cf8aSJason Sarich /* These flags prevents algorithms from overriding user options */ 1466552cf8aSJason Sarich tao->max_it_changed =PETSC_FALSE; 1476552cf8aSJason Sarich tao->max_funcs_changed=PETSC_FALSE; 1486552cf8aSJason Sarich tao->gatol_changed =PETSC_FALSE; 1496552cf8aSJason Sarich tao->grtol_changed =PETSC_FALSE; 1506552cf8aSJason Sarich tao->gttol_changed =PETSC_FALSE; 1516552cf8aSJason Sarich tao->steptol_changed =PETSC_FALSE; 1526552cf8aSJason Sarich tao->trust0_changed =PETSC_FALSE; 1536552cf8aSJason Sarich tao->fmin_changed =PETSC_FALSE; 1546552cf8aSJason Sarich tao->catol_changed =PETSC_FALSE; 1556552cf8aSJason Sarich tao->crtol_changed =PETSC_FALSE; 156a7e14dcfSSatish Balay ierr = TaoResetStatistics(tao);CHKERRQ(ierr); 157a7e14dcfSSatish Balay *newtao = tao; 158a7e14dcfSSatish Balay PetscFunctionReturn(0); 159a7e14dcfSSatish Balay } 160a7e14dcfSSatish Balay 161a7e14dcfSSatish Balay #undef __FUNCT__ 162a7e14dcfSSatish Balay #define __FUNCT__ "TaoSolve" 163a7e14dcfSSatish Balay /*@ 164a7e14dcfSSatish Balay TaoSolve - Solves an optimization problem min F(x) s.t. l <= x <= u 165a7e14dcfSSatish Balay 166441846f8SBarry Smith Collective on Tao 167a7e14dcfSSatish Balay 168a7e14dcfSSatish Balay Input Parameters: 169441846f8SBarry Smith . tao - the Tao context 170a7e14dcfSSatish Balay 171a7e14dcfSSatish Balay Notes: 172441846f8SBarry Smith The user must set up the Tao with calls to TaoSetInitialVector(), 173a7e14dcfSSatish Balay TaoSetObjectiveRoutine(), 174a7e14dcfSSatish Balay TaoSetGradientRoutine(), and (if using 2nd order method) TaoSetHessianRoutine(). 175a7e14dcfSSatish Balay 176*a35d58b8SBarry Smith You should call TaoGetConvergedReason() or run with -tao_converged_reason to determine if the optimization algorithm actually succeeded or 177*a35d58b8SBarry Smith why it failed. 178*a35d58b8SBarry Smith 179a7e14dcfSSatish Balay Level: beginner 180a7e14dcfSSatish Balay 181*a35d58b8SBarry Smith .seealso: TaoCreate(), TaoSetObjectiveRoutine(), TaoSetGradientRoutine(), TaoSetHessianRoutine(), TaoGetConvergedReason() 182a7e14dcfSSatish Balay @*/ 183441846f8SBarry Smith PetscErrorCode TaoSolve(Tao tao) 184a7e14dcfSSatish Balay { 185a7e14dcfSSatish Balay PetscErrorCode ierr; 186e2379f4fSBarry Smith static PetscBool set = PETSC_FALSE; 18747a47007SBarry Smith 188a7e14dcfSSatish Balay PetscFunctionBegin; 189441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 190e2379f4fSBarry Smith ierr = PetscCitationsRegister("@TechReport{tao-user-ref,\n" 191e2379f4fSBarry Smith "title = {Toolkit for Advanced Optimization (TAO) Users Manual},\n" 192e2379f4fSBarry Smith "author = {Todd Munson and Jason Sarich and Stefan Wild and Steve Benson and Lois Curfman McInnes},\n" 193e2379f4fSBarry Smith "Institution = {Argonne National Laboratory},\n" 194e2379f4fSBarry Smith "Year = 2014,\n" 195e2379f4fSBarry Smith "Number = {ANL/MCS-TM-322 - Revision 3.5},\n" 196302440fdSBarry Smith "url = {http://www.mcs.anl.gov/tao}\n}\n",&set);CHKERRQ(ierr); 197e2379f4fSBarry Smith 198a7e14dcfSSatish Balay ierr = TaoSetUp(tao);CHKERRQ(ierr); 199a7e14dcfSSatish Balay ierr = TaoResetStatistics(tao);CHKERRQ(ierr); 200a7e14dcfSSatish Balay if (tao->linesearch) { 201a7e14dcfSSatish Balay ierr = TaoLineSearchReset(tao->linesearch);CHKERRQ(ierr); 202a7e14dcfSSatish Balay } 203a7e14dcfSSatish Balay 204441846f8SBarry Smith ierr = PetscLogEventBegin(Tao_Solve,tao,0,0,0);CHKERRQ(ierr); 205a7e14dcfSSatish Balay if (tao->ops->solve){ ierr = (*tao->ops->solve)(tao);CHKERRQ(ierr); } 206441846f8SBarry Smith ierr = PetscLogEventEnd(Tao_Solve,tao,0,0,0);CHKERRQ(ierr); 207a7e14dcfSSatish Balay 2088931d482SJason Sarich tao->ntotalits += tao->niter; 209fbe0838dSJason Sarich ierr = TaoViewFromOptions(tao,NULL,"-tao_view");CHKERRQ(ierr); 210a7e14dcfSSatish Balay 211a7e14dcfSSatish Balay if (tao->printreason) { 212a7e14dcfSSatish Balay if (tao->reason > 0) { 2138931d482SJason Sarich ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve converged due to %s iterations %D\n",TaoConvergedReasons[tao->reason],tao->niter);CHKERRQ(ierr); 214a7e14dcfSSatish Balay } else { 2158931d482SJason Sarich ierr = PetscPrintf(((PetscObject)tao)->comm,"TAO solve did not converge due to %s iteration %D\n",TaoConvergedReasons[tao->reason],tao->niter);CHKERRQ(ierr); 216a7e14dcfSSatish Balay } 217a7e14dcfSSatish Balay } 218a7e14dcfSSatish Balay PetscFunctionReturn(0); 219a7e14dcfSSatish Balay } 220a7e14dcfSSatish Balay 221a7e14dcfSSatish Balay #undef __FUNCT__ 222a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetUp" 223a7e14dcfSSatish Balay /*@ 224a7e14dcfSSatish Balay TaoSetUp - Sets up the internal data structures for the later use 225a7e14dcfSSatish Balay of a Tao solver 226a7e14dcfSSatish Balay 227a7e14dcfSSatish Balay Collective on tao 228a7e14dcfSSatish Balay 229a7e14dcfSSatish Balay Input Parameters: 230a7e14dcfSSatish Balay . tao - the TAO context 231a7e14dcfSSatish Balay 232a7e14dcfSSatish Balay Notes: 233a7e14dcfSSatish Balay The user will not need to explicitly call TaoSetUp(), as it will 234a7e14dcfSSatish Balay automatically be called in TaoSolve(). However, if the user 235a7e14dcfSSatish Balay desires to call it explicitly, it should come after TaoCreate() 236a7e14dcfSSatish Balay and any TaoSetSomething() routines, but before TaoSolve(). 237a7e14dcfSSatish Balay 238a7e14dcfSSatish Balay Level: advanced 239a7e14dcfSSatish Balay 240a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve() 241a7e14dcfSSatish Balay @*/ 242441846f8SBarry Smith PetscErrorCode TaoSetUp(Tao tao) 243a7e14dcfSSatish Balay { 244a7e14dcfSSatish Balay PetscErrorCode ierr; 24547a47007SBarry Smith 246a7e14dcfSSatish Balay PetscFunctionBegin; 247441846f8SBarry Smith PetscValidHeaderSpecific(tao, TAO_CLASSID,1); 248a7e14dcfSSatish Balay if (tao->setupcalled) PetscFunctionReturn(0); 249a7e14dcfSSatish Balay 25047a47007SBarry Smith if (!tao->solution) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TaoSetInitialVector"); 251a7e14dcfSSatish Balay if (tao->ops->setup) { 252a7e14dcfSSatish Balay ierr = (*tao->ops->setup)(tao);CHKERRQ(ierr); 253a7e14dcfSSatish Balay } 254a7e14dcfSSatish Balay tao->setupcalled = PETSC_TRUE; 255a7e14dcfSSatish Balay PetscFunctionReturn(0); 256a7e14dcfSSatish Balay } 257a7e14dcfSSatish Balay 258a7e14dcfSSatish Balay #undef __FUNCT__ 259a7e14dcfSSatish Balay #define __FUNCT__ "TaoDestroy" 260a7e14dcfSSatish Balay /*@ 261a7e14dcfSSatish Balay TaoDestroy - Destroys the TAO context that was created with 262a7e14dcfSSatish Balay TaoCreate() 263a7e14dcfSSatish Balay 264441846f8SBarry Smith Collective on Tao 265a7e14dcfSSatish Balay 266a7e14dcfSSatish Balay Input Parameter: 267441846f8SBarry Smith . tao - the Tao context 268a7e14dcfSSatish Balay 269a7e14dcfSSatish Balay Level: beginner 270a7e14dcfSSatish Balay 271a7e14dcfSSatish Balay .seealso: TaoCreate(), TaoSolve() 272a7e14dcfSSatish Balay @*/ 273441846f8SBarry Smith PetscErrorCode TaoDestroy(Tao *tao) 274a7e14dcfSSatish Balay { 275a7e14dcfSSatish Balay PetscErrorCode ierr; 27647a47007SBarry Smith 277a7e14dcfSSatish Balay PetscFunctionBegin; 278a7e14dcfSSatish Balay if (!*tao) PetscFunctionReturn(0); 279441846f8SBarry Smith PetscValidHeaderSpecific(*tao,TAO_CLASSID,1); 280a7e14dcfSSatish Balay if (--((PetscObject)*tao)->refct > 0) {*tao=0;PetscFunctionReturn(0);} 281a7e14dcfSSatish Balay 282a7e14dcfSSatish Balay if ((*tao)->ops->destroy) { 283a7e14dcfSSatish Balay ierr = (*((*tao))->ops->destroy)(*tao);CHKERRQ(ierr); 284a7e14dcfSSatish Balay } 285a7e14dcfSSatish Balay ierr = KSPDestroy(&(*tao)->ksp);CHKERRQ(ierr); 286a7e14dcfSSatish Balay ierr = TaoLineSearchDestroy(&(*tao)->linesearch);CHKERRQ(ierr); 287a7e14dcfSSatish Balay 288a7e14dcfSSatish Balay if ((*tao)->ops->convergencedestroy) { 289a7e14dcfSSatish Balay ierr = (*(*tao)->ops->convergencedestroy)((*tao)->cnvP);CHKERRQ(ierr); 290a7e14dcfSSatish Balay if ((*tao)->jacobian_state_inv) { 291a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr); 292a7e14dcfSSatish Balay } 293a7e14dcfSSatish Balay } 294a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->solution);CHKERRQ(ierr); 295a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->gradient);CHKERRQ(ierr); 296a7e14dcfSSatish Balay 297a9603a14SPatrick Farrell if ((*tao)->gradient_norm) { 298a9603a14SPatrick Farrell ierr = PetscObjectDereference((PetscObject)(*tao)->gradient_norm);CHKERRQ(ierr); 299a9603a14SPatrick Farrell ierr = VecDestroy(&(*tao)->gradient_norm_tmp);CHKERRQ(ierr); 300a9603a14SPatrick Farrell } 301a9603a14SPatrick Farrell 302a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->XL);CHKERRQ(ierr); 303a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->XU);CHKERRQ(ierr); 304a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->IL);CHKERRQ(ierr); 305a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->IU);CHKERRQ(ierr); 306a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->DE);CHKERRQ(ierr); 307a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->DI);CHKERRQ(ierr); 308a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->constraints_equality);CHKERRQ(ierr); 309a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->constraints_inequality);CHKERRQ(ierr); 310a7e14dcfSSatish Balay ierr = VecDestroy(&(*tao)->stepdirection);CHKERRQ(ierr); 311a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->hessian_pre);CHKERRQ(ierr); 312a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->hessian);CHKERRQ(ierr); 313a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_pre);CHKERRQ(ierr); 314a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian);CHKERRQ(ierr); 315a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state_pre);CHKERRQ(ierr); 316a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state);CHKERRQ(ierr); 317a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_state_inv);CHKERRQ(ierr); 318067f330cSJason Sarich ierr = MatDestroy(&(*tao)->jacobian_design);CHKERRQ(ierr); 319a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_equality);CHKERRQ(ierr); 320a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_equality_pre);CHKERRQ(ierr); 321a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_inequality);CHKERRQ(ierr); 322a7e14dcfSSatish Balay ierr = MatDestroy(&(*tao)->jacobian_inequality_pre);CHKERRQ(ierr); 323a7e14dcfSSatish Balay ierr = ISDestroy(&(*tao)->state_is);CHKERRQ(ierr); 324a7e14dcfSSatish Balay ierr = ISDestroy(&(*tao)->design_is);CHKERRQ(ierr); 325125ddc8aSJason Sarich ierr = VecDestroy(&(*tao)->sep_weights_v);CHKERRQ(ierr); 326a7e14dcfSSatish Balay ierr = TaoCancelMonitors(*tao);CHKERRQ(ierr); 327ae93cb3cSJason Sarich if ((*tao)->hist_malloc) { 328ae93cb3cSJason Sarich ierr = PetscFree((*tao)->hist_obj);CHKERRQ(ierr); 329ae93cb3cSJason Sarich ierr = PetscFree((*tao)->hist_resid);CHKERRQ(ierr); 330ae93cb3cSJason Sarich ierr = PetscFree((*tao)->hist_cnorm);CHKERRQ(ierr); 331ae93cb3cSJason Sarich ierr = PetscFree((*tao)->hist_lits);CHKERRQ(ierr); 332ae93cb3cSJason Sarich } 333125ddc8aSJason Sarich if ((*tao)->sep_weights_n) { 334125ddc8aSJason Sarich ierr = PetscFree((*tao)->sep_weights_rows);CHKERRQ(ierr); 335125ddc8aSJason Sarich ierr = PetscFree((*tao)->sep_weights_cols);CHKERRQ(ierr); 336125ddc8aSJason Sarich ierr = PetscFree((*tao)->sep_weights_w);CHKERRQ(ierr); 337125ddc8aSJason Sarich } 338a7e14dcfSSatish Balay ierr = PetscHeaderDestroy(tao);CHKERRQ(ierr); 339a7e14dcfSSatish Balay PetscFunctionReturn(0); 340a7e14dcfSSatish Balay } 341a7e14dcfSSatish Balay 342a7e14dcfSSatish Balay #undef __FUNCT__ 343a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetFromOptions" 344a7e14dcfSSatish Balay /*@ 345441846f8SBarry Smith TaoSetFromOptions - Sets various Tao parameters from user 346a7e14dcfSSatish Balay options. 347a7e14dcfSSatish Balay 348441846f8SBarry Smith Collective on Tao 349a7e14dcfSSatish Balay 350a7e14dcfSSatish Balay Input Paremeter: 351441846f8SBarry Smith . tao - the Tao solver context 352a7e14dcfSSatish Balay 353a7e14dcfSSatish Balay options Database Keys: 35458417fe7SBarry Smith + -tao_type <type> - The algorithm that TAO uses (lmvm, nls, etc.) 355a7e14dcfSSatish Balay . -tao_gatol <gatol> - absolute error tolerance for ||gradient|| 356a7e14dcfSSatish Balay . -tao_grtol <grtol> - relative error tolerance for ||gradient|| 357a7e14dcfSSatish Balay . -tao_gttol <gttol> - reduction of ||gradient|| relative to initial gradient 358a7e14dcfSSatish Balay . -tao_max_it <max> - sets maximum number of iterations 359a7e14dcfSSatish Balay . -tao_max_funcs <max> - sets maximum number of function evaluations 360a7e14dcfSSatish Balay . -tao_fmin <fmin> - stop if function value reaches fmin 361a7e14dcfSSatish Balay . -tao_steptol <tol> - stop if trust region radius less than <tol> 362a7e14dcfSSatish Balay . -tao_trust0 <t> - initial trust region radius 363a7e14dcfSSatish Balay . -tao_monitor - prints function value and residual at each iteration 364a7e14dcfSSatish Balay . -tao_smonitor - same as tao_monitor, but truncates very small values 365a7e14dcfSSatish Balay . -tao_cmonitor - prints function value, residual, and constraint norm at each iteration 366a7e14dcfSSatish Balay . -tao_view_solution - prints solution vector at each iteration 367a7e14dcfSSatish Balay . -tao_view_separableobjective - prints separable objective vector at each iteration 368a7e14dcfSSatish Balay . -tao_view_step - prints step direction vector at each iteration 369a7e14dcfSSatish Balay . -tao_view_gradient - prints gradient vector at each iteration 370a7e14dcfSSatish Balay . -tao_draw_solution - graphically view solution vector at each iteration 371a7e14dcfSSatish Balay . -tao_draw_step - graphically view step vector at each iteration 372a7e14dcfSSatish Balay . -tao_draw_gradient - graphically view gradient at each iteration 373a7e14dcfSSatish Balay . -tao_fd_gradient - use gradient computed with finite differences 374a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors (except those set with command line) 375441846f8SBarry Smith . -tao_view - prints information about the Tao after solving 376a7e14dcfSSatish Balay - -tao_converged_reason - prints the reason TAO stopped iterating 377a7e14dcfSSatish Balay 378a7e14dcfSSatish Balay Notes: 379a7e14dcfSSatish Balay To see all options, run your program with the -help option or consult the 380a7e14dcfSSatish Balay user's manual. Should be called after TaoCreate() but before TaoSolve() 381a7e14dcfSSatish Balay 382a7e14dcfSSatish Balay Level: beginner 383a7e14dcfSSatish Balay @*/ 384441846f8SBarry Smith PetscErrorCode TaoSetFromOptions(Tao tao) 385a7e14dcfSSatish Balay { 386a7e14dcfSSatish Balay PetscErrorCode ierr; 38758417fe7SBarry Smith const TaoType default_type = TAOLMVM; 388a7e14dcfSSatish Balay char type[256], monfilename[PETSC_MAX_PATH_LEN]; 389a7e14dcfSSatish Balay PetscViewer monviewer; 390a7e14dcfSSatish Balay PetscBool flg; 391a7e14dcfSSatish Balay MPI_Comm comm; 392a7e14dcfSSatish Balay 393a7e14dcfSSatish Balay PetscFunctionBegin; 394441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 395a7e14dcfSSatish Balay ierr = PetscObjectGetComm((PetscObject)tao,&comm);CHKERRQ(ierr); 396125ddc8aSJason Sarich 397a7e14dcfSSatish Balay /* So no warnings are given about unused options */ 398c5929fdfSBarry Smith ierr = PetscOptionsHasName(((PetscObject)tao)->options,((PetscObject)tao)->prefix,"-tao_ls_type",&flg);CHKERRQ(ierr); 399a7e14dcfSSatish Balay 400a7e14dcfSSatish Balay ierr = PetscObjectOptionsBegin((PetscObject)tao);CHKERRQ(ierr); 401a7e14dcfSSatish Balay { 402441846f8SBarry Smith ierr = TaoRegisterAll();CHKERRQ(ierr); 403a7e14dcfSSatish Balay if (((PetscObject)tao)->type_name) { 404a7e14dcfSSatish Balay default_type = ((PetscObject)tao)->type_name; 405a7e14dcfSSatish Balay } 406a7e14dcfSSatish Balay /* Check for type from options */ 407441846f8SBarry Smith ierr = PetscOptionsFList("-tao_type","Tao Solver type","TaoSetType",TaoList,default_type,type,256,&flg);CHKERRQ(ierr); 408a7e14dcfSSatish Balay if (flg) { 409a7e14dcfSSatish Balay ierr = TaoSetType(tao,type);CHKERRQ(ierr); 410a7e14dcfSSatish Balay } else if (!((PetscObject)tao)->type_name) { 411302440fdSBarry Smith ierr = TaoSetType(tao,default_type);CHKERRQ(ierr); 412a7e14dcfSSatish Balay } 413a7e14dcfSSatish Balay 4146552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_catol","Stop if constraints violations within","TaoSetConstraintTolerances",tao->catol,&tao->catol,&flg);CHKERRQ(ierr); 4156552cf8aSJason Sarich if (flg) tao->catol_changed=PETSC_TRUE; 4166552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_crtol","Stop if relative contraint violations within","TaoSetConstraintTolerances",tao->crtol,&tao->crtol,&flg);CHKERRQ(ierr); 4176552cf8aSJason Sarich if (flg) tao->crtol_changed=PETSC_TRUE; 4186552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_gatol","Stop if norm of gradient less than","TaoSetTolerances",tao->gatol,&tao->gatol,&flg);CHKERRQ(ierr); 4196552cf8aSJason Sarich if (flg) tao->gatol_changed=PETSC_TRUE; 4206552cf8aSJason 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); 4216552cf8aSJason Sarich if (flg) tao->grtol_changed=PETSC_TRUE; 4226552cf8aSJason 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); 4236552cf8aSJason Sarich if (flg) tao->gttol_changed=PETSC_TRUE; 4246552cf8aSJason Sarich ierr = PetscOptionsInt("-tao_max_it","Stop if iteration number exceeds","TaoSetMaximumIterations",tao->max_it,&tao->max_it,&flg);CHKERRQ(ierr); 4256552cf8aSJason Sarich if (flg) tao->max_it_changed=PETSC_TRUE; 4266552cf8aSJason Sarich ierr = PetscOptionsInt("-tao_max_funcs","Stop if number of function evaluations exceeds","TaoSetMaximumFunctionEvaluations",tao->max_funcs,&tao->max_funcs,&flg);CHKERRQ(ierr); 4276552cf8aSJason Sarich if (flg) tao->max_funcs_changed=PETSC_TRUE; 4286552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_fmin","Stop if function less than","TaoSetFunctionLowerBound",tao->fmin,&tao->fmin,&flg);CHKERRQ(ierr); 4296552cf8aSJason Sarich if (flg) tao->fmin_changed=PETSC_TRUE; 4306552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_steptol","Stop if step size or trust region radius less than","",tao->steptol,&tao->steptol,&flg);CHKERRQ(ierr); 4316552cf8aSJason Sarich if (flg) tao->steptol_changed=PETSC_TRUE; 4326552cf8aSJason Sarich ierr = PetscOptionsReal("-tao_trust0","Initial trust region radius","TaoSetTrustRegionRadius",tao->trust0,&tao->trust0,&flg);CHKERRQ(ierr); 4336552cf8aSJason Sarich if (flg) tao->trust0_changed=PETSC_TRUE; 434a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_solution","view solution vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 435a7e14dcfSSatish Balay if (flg) { 436a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 437a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoSolutionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 438a7e14dcfSSatish Balay } 439a7e14dcfSSatish Balay 4408afaa268SBarry Smith ierr = PetscOptionsBool("-tao_converged_reason","Print reason for TAO converged","TaoSolve",tao->printreason,&tao->printreason,NULL);CHKERRQ(ierr); 441a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_gradient","view gradient vector after each evaluation","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 442a7e14dcfSSatish Balay if (flg) { 443a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 444a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoGradientMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 445a7e14dcfSSatish Balay } 446a7e14dcfSSatish Balay 447a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_stepdirection","view step direction vector after each iteration","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,TaoStepDirectionMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 451a7e14dcfSSatish Balay } 452a7e14dcfSSatish Balay 453a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_view_separableobjective","view separable objective vector after each evaluation","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,TaoSeparableObjectiveMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 457a7e14dcfSSatish Balay } 458a7e14dcfSSatish Balay 459a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_monitor","Use the default convergence monitor","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,TaoDefaultMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 463a7e14dcfSSatish Balay } 464a7e14dcfSSatish Balay 465a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_smonitor","Use the short 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); 468a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoDefaultSMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 469a7e14dcfSSatish Balay } 470a7e14dcfSSatish Balay 471a7e14dcfSSatish Balay ierr = PetscOptionsString("-tao_cmonitor","Use the default convergence monitor with constraint norm","TaoSetMonitor","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 472a7e14dcfSSatish Balay if (flg) { 473a7e14dcfSSatish Balay ierr = PetscViewerASCIIOpen(comm,monfilename,&monviewer);CHKERRQ(ierr); 474a7e14dcfSSatish Balay ierr = TaoSetMonitor(tao,TaoDefaultCMonitor,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 475a7e14dcfSSatish Balay } 476a7e14dcfSSatish Balay 477a7e14dcfSSatish Balay 4788afaa268SBarry Smith flg = PETSC_FALSE; 4798afaa268SBarry Smith ierr = PetscOptionsBool("-tao_cancelmonitors","cancel all monitors and call any registered destroy routines","TaoCancelMonitors",flg,&flg,NULL);CHKERRQ(ierr); 480a7e14dcfSSatish Balay if (flg) {ierr = TaoCancelMonitors(tao);CHKERRQ(ierr);} 481a7e14dcfSSatish Balay 4828afaa268SBarry Smith flg = PETSC_FALSE; 4838afaa268SBarry Smith ierr = PetscOptionsBool("-tao_draw_solution","Plot solution vector at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr); 484a7e14dcfSSatish Balay if (flg) { 48547a47007SBarry Smith ierr = TaoSetMonitor(tao,TaoDrawSolutionMonitor,NULL,NULL);CHKERRQ(ierr); 486a7e14dcfSSatish Balay } 487a7e14dcfSSatish Balay 4888afaa268SBarry Smith flg = PETSC_FALSE; 4898afaa268SBarry Smith ierr = PetscOptionsBool("-tao_draw_step","plots step direction at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr); 490a7e14dcfSSatish Balay if (flg) { 49147a47007SBarry Smith ierr = TaoSetMonitor(tao,TaoDrawStepMonitor,NULL,NULL);CHKERRQ(ierr); 492a7e14dcfSSatish Balay } 493a7e14dcfSSatish Balay 4948afaa268SBarry Smith flg = PETSC_FALSE; 4958afaa268SBarry Smith ierr = PetscOptionsBool("-tao_draw_gradient","plots gradient at each iteration","TaoSetMonitor",flg,&flg,NULL);CHKERRQ(ierr); 496a7e14dcfSSatish Balay if (flg) { 49747a47007SBarry Smith ierr = TaoSetMonitor(tao,TaoDrawGradientMonitor,NULL,NULL);CHKERRQ(ierr); 498a7e14dcfSSatish Balay } 4998afaa268SBarry Smith flg = PETSC_FALSE; 5008afaa268SBarry Smith ierr = PetscOptionsBool("-tao_fd_gradient","compute gradient using finite differences","TaoDefaultComputeGradient",flg,&flg,NULL);CHKERRQ(ierr); 501a7e14dcfSSatish Balay if (flg) { 50247a47007SBarry Smith ierr = TaoSetGradientRoutine(tao,TaoDefaultComputeGradient,NULL);CHKERRQ(ierr); 503a7e14dcfSSatish Balay } 504e1cc520bSBarry Smith ierr = PetscOptionsEnum("-tao_subset_type","subset type", "", TaoSubSetTypes,(PetscEnum)tao->subset_type, (PetscEnum*)&tao->subset_type, 0);CHKERRQ(ierr); 505a7e14dcfSSatish Balay 506a7e14dcfSSatish Balay if (tao->ops->setfromoptions) { 5071a1499c8SBarry Smith ierr = (*tao->ops->setfromoptions)(PetscOptionsObject,tao);CHKERRQ(ierr); 508a7e14dcfSSatish Balay } 509a7e14dcfSSatish Balay } 510a7e14dcfSSatish Balay ierr = PetscOptionsEnd();CHKERRQ(ierr); 511a7e14dcfSSatish Balay PetscFunctionReturn(0); 512a7e14dcfSSatish Balay } 513a7e14dcfSSatish Balay 514a7e14dcfSSatish Balay #undef __FUNCT__ 515a7e14dcfSSatish Balay #define __FUNCT__ "TaoView" 516a7e14dcfSSatish Balay /*@C 517441846f8SBarry Smith TaoView - Prints information about the Tao 518a7e14dcfSSatish Balay 519441846f8SBarry Smith Collective on Tao 520a7e14dcfSSatish Balay 521a7e14dcfSSatish Balay InputParameters: 522441846f8SBarry Smith + tao - the Tao context 523a7e14dcfSSatish Balay - viewer - visualization context 524a7e14dcfSSatish Balay 525a7e14dcfSSatish Balay Options Database Key: 526a7e14dcfSSatish Balay . -tao_view - Calls TaoView() at the end of TaoSolve() 527a7e14dcfSSatish Balay 528a7e14dcfSSatish Balay Notes: 529a7e14dcfSSatish Balay The available visualization contexts include 530a7e14dcfSSatish Balay + PETSC_VIEWER_STDOUT_SELF - standard output (default) 531a7e14dcfSSatish Balay - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 532a7e14dcfSSatish Balay output where only the first processor opens 533a7e14dcfSSatish Balay the file. All other processors send their 534a7e14dcfSSatish Balay data to the first processor to print. 535a7e14dcfSSatish Balay 536a7e14dcfSSatish Balay Level: beginner 537a7e14dcfSSatish Balay 538a7e14dcfSSatish Balay .seealso: PetscViewerASCIIOpen() 539a7e14dcfSSatish Balay @*/ 540441846f8SBarry Smith PetscErrorCode TaoView(Tao tao, PetscViewer viewer) 541a7e14dcfSSatish Balay { 542a7e14dcfSSatish Balay PetscErrorCode ierr; 543a7e14dcfSSatish Balay PetscBool isascii,isstring; 544441846f8SBarry Smith const TaoType type; 54547a47007SBarry Smith 546a7e14dcfSSatish Balay PetscFunctionBegin; 547441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 548a7e14dcfSSatish Balay if (!viewer) { 549a7e14dcfSSatish Balay ierr = PetscViewerASCIIGetStdout(((PetscObject)tao)->comm,&viewer);CHKERRQ(ierr); 550a7e14dcfSSatish Balay } 551a7e14dcfSSatish Balay PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 552a7e14dcfSSatish Balay PetscCheckSameComm(tao,1,viewer,2); 553a7e14dcfSSatish Balay 554a7e14dcfSSatish Balay ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 555a7e14dcfSSatish Balay ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 556a7e14dcfSSatish Balay if (isascii) { 557a7e14dcfSSatish Balay ierr = PetscObjectPrintClassNamePrefixType((PetscObject)tao,viewer);CHKERRQ(ierr); 558a7e14dcfSSatish Balay ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 559a7e14dcfSSatish Balay 560a7e14dcfSSatish Balay if (tao->ops->view) { 561a7e14dcfSSatish Balay ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 562a7e14dcfSSatish Balay ierr = (*tao->ops->view)(tao,viewer);CHKERRQ(ierr); 563a7e14dcfSSatish Balay ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 564a7e14dcfSSatish Balay } 565a7e14dcfSSatish Balay if (tao->linesearch) { 566a7e14dcfSSatish Balay ierr = PetscObjectPrintClassNamePrefixType((PetscObject)(tao->linesearch),viewer);CHKERRQ(ierr); 567a7e14dcfSSatish Balay } 568a7e14dcfSSatish Balay if (tao->ksp) { 569a7e14dcfSSatish Balay ierr = PetscObjectPrintClassNamePrefixType((PetscObject)(tao->ksp),viewer);CHKERRQ(ierr); 570ae93cb3cSJason Sarich ierr = PetscViewerASCIIPrintf(viewer,"total KSP iterations: %D\n",tao->ksp_tot_its);CHKERRQ(ierr); 571a7e14dcfSSatish Balay } 572a7e14dcfSSatish Balay if (tao->XL || tao->XU) { 573302440fdSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Active Set subset type: %s\n",TaoSubSetTypes[tao->subset_type]);CHKERRQ(ierr); 574a7e14dcfSSatish Balay } 575a7e14dcfSSatish Balay 57647a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: gatol=%g,",(double)tao->gatol);CHKERRQ(ierr); 57747a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," steptol=%g,",(double)tao->steptol);CHKERRQ(ierr); 57847a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," gttol=%g\n",(double)tao->gttol);CHKERRQ(ierr); 579a7e14dcfSSatish Balay 58047a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Residual in Function/Gradient:=%g\n",(double)tao->residual);CHKERRQ(ierr); 581a7e14dcfSSatish Balay 582a7e14dcfSSatish Balay if (tao->cnorm>0 || tao->catol>0 || tao->crtol>0){ 583a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances:");CHKERRQ(ierr); 58447a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," catol=%g,",(double)tao->catol);CHKERRQ(ierr); 58547a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," crtol=%g\n",(double)tao->crtol);CHKERRQ(ierr); 58647a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Residual in Constraints:=%g\n",(double)tao->cnorm);CHKERRQ(ierr); 587a7e14dcfSSatish Balay } 588a7e14dcfSSatish Balay 589a7e14dcfSSatish Balay if (tao->trust < tao->steptol){ 59047a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: steptol=%g\n",(double)tao->steptol);CHKERRQ(ierr); 59147a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"Final trust region radius:=%g\n",(double)tao->trust);CHKERRQ(ierr); 592a7e14dcfSSatish Balay } 593a7e14dcfSSatish Balay 594a7e14dcfSSatish Balay if (tao->fmin>-1.e25){ 59547a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer,"convergence tolerances: function minimum=%g\n",(double)tao->fmin);CHKERRQ(ierr); 596a7e14dcfSSatish Balay } 59747a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Objective value=%g\n",(double)tao->fc);CHKERRQ(ierr); 598a7e14dcfSSatish Balay 59947a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of iterations=%D, ",tao->niter);CHKERRQ(ierr); 600a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," (max: %D)\n",tao->max_it);CHKERRQ(ierr); 601a7e14dcfSSatish Balay 602a7e14dcfSSatish Balay if (tao->nfuncs>0){ 60347a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of function evaluations=%D,",tao->nfuncs);CHKERRQ(ierr); 60447a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," max: %D\n",tao->max_funcs);CHKERRQ(ierr); 605a7e14dcfSSatish Balay } 606a7e14dcfSSatish Balay if (tao->ngrads>0){ 60747a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of gradient evaluations=%D,",tao->ngrads);CHKERRQ(ierr); 60847a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," max: %D\n",tao->max_funcs);CHKERRQ(ierr); 609a7e14dcfSSatish Balay } 610a7e14dcfSSatish Balay if (tao->nfuncgrads>0){ 61147a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of function/gradient evaluations=%D,",tao->nfuncgrads);CHKERRQ(ierr); 61247a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," (max: %D)\n",tao->max_funcs);CHKERRQ(ierr); 613a7e14dcfSSatish Balay } 614a7e14dcfSSatish Balay if (tao->nhess>0){ 61547a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of Hessian evaluations=%D\n",tao->nhess);CHKERRQ(ierr); 616a7e14dcfSSatish Balay } 617a7e14dcfSSatish Balay /* if (tao->linear_its>0){ 61847a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total Krylov method iterations=%D\n",tao->linear_its);CHKERRQ(ierr); 619a7e14dcfSSatish Balay }*/ 620a7e14dcfSSatish Balay if (tao->nconstraints>0){ 62147a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of constraint function evaluations=%D\n",tao->nconstraints);CHKERRQ(ierr); 622a7e14dcfSSatish Balay } 623a7e14dcfSSatish Balay if (tao->njac>0){ 62447a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"total number of Jacobian evaluations=%D\n",tao->njac);CHKERRQ(ierr); 625a7e14dcfSSatish Balay } 626a7e14dcfSSatish Balay 627a7e14dcfSSatish Balay if (tao->reason>0){ 628a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer, "Solution converged: ");CHKERRQ(ierr); 629a7e14dcfSSatish Balay switch (tao->reason) { 630a7e14dcfSSatish Balay case TAO_CONVERGED_GATOL: 631a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," ||g(X)|| <= gatol\n");CHKERRQ(ierr); 632a7e14dcfSSatish Balay break; 633a7e14dcfSSatish Balay case TAO_CONVERGED_GRTOL: 634a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/|f(X)| <= grtol\n");CHKERRQ(ierr); 635a7e14dcfSSatish Balay break; 636a7e14dcfSSatish Balay case TAO_CONVERGED_GTTOL: 637a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," ||g(X)||/||g(X0)|| <= gttol\n");CHKERRQ(ierr); 638a7e14dcfSSatish Balay break; 639a7e14dcfSSatish Balay case TAO_CONVERGED_STEPTOL: 640a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," Steptol -- step size small\n");CHKERRQ(ierr); 641a7e14dcfSSatish Balay break; 642a7e14dcfSSatish Balay case TAO_CONVERGED_MINF: 643a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," Minf -- f < fmin\n");CHKERRQ(ierr); 644a7e14dcfSSatish Balay break; 645a7e14dcfSSatish Balay case TAO_CONVERGED_USER: 646a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr); 647a7e14dcfSSatish Balay break; 648a7e14dcfSSatish Balay default: 649a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 650a7e14dcfSSatish Balay break; 651a7e14dcfSSatish Balay } 652a7e14dcfSSatish Balay 653a7e14dcfSSatish Balay } else { 65447cfc4faSBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Solver terminated: %d",tao->reason);CHKERRQ(ierr); 655a7e14dcfSSatish Balay switch (tao->reason) { 656a7e14dcfSSatish Balay case TAO_DIVERGED_MAXITS: 65747a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Maximum Iterations\n");CHKERRQ(ierr); 658a7e14dcfSSatish Balay break; 659a7e14dcfSSatish Balay case TAO_DIVERGED_NAN: 66047a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," NAN or Inf encountered\n");CHKERRQ(ierr); 661a7e14dcfSSatish Balay break; 662a7e14dcfSSatish Balay case TAO_DIVERGED_MAXFCN: 66347a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Maximum Function Evaluations\n");CHKERRQ(ierr); 664a7e14dcfSSatish Balay break; 665a7e14dcfSSatish Balay case TAO_DIVERGED_LS_FAILURE: 66647a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Line Search Failure\n");CHKERRQ(ierr); 667a7e14dcfSSatish Balay break; 668a7e14dcfSSatish Balay case TAO_DIVERGED_TR_REDUCTION: 66947a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Trust Region too small\n");CHKERRQ(ierr); 670a7e14dcfSSatish Balay break; 671a7e14dcfSSatish Balay case TAO_DIVERGED_USER: 67247a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," User Terminated\n");CHKERRQ(ierr); 673a7e14dcfSSatish Balay break; 674a7e14dcfSSatish Balay default: 675a7e14dcfSSatish Balay ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr); 676a7e14dcfSSatish Balay break; 677a7e14dcfSSatish Balay } 678a7e14dcfSSatish Balay } 679a7e14dcfSSatish Balay ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 680a7e14dcfSSatish Balay } else if (isstring) { 681a7e14dcfSSatish Balay ierr = TaoGetType(tao,&type);CHKERRQ(ierr); 682a7e14dcfSSatish Balay ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr); 683a7e14dcfSSatish Balay } 684a7e14dcfSSatish Balay PetscFunctionReturn(0); 685a7e14dcfSSatish Balay } 686a7e14dcfSSatish Balay 687a7e14dcfSSatish Balay #undef __FUNCT__ 688a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetTolerances" 689a7e14dcfSSatish Balay /*@ 690a7e14dcfSSatish Balay TaoSetTolerances - Sets parameters used in TAO convergence tests 691a7e14dcfSSatish Balay 692441846f8SBarry Smith Logically collective on Tao 693a7e14dcfSSatish Balay 694a7e14dcfSSatish Balay Input Parameters: 695441846f8SBarry Smith + tao - the Tao context 696a7e14dcfSSatish Balay . gatol - stop if norm of gradient is less than this 697a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this 698a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by this factor 699a7e14dcfSSatish Balay 700a7e14dcfSSatish Balay Options Database Keys: 701e52336cbSBarry Smith + -tao_gatol <gatol> - Sets gatol 702a7e14dcfSSatish Balay . -tao_grtol <grtol> - Sets grtol 703a7e14dcfSSatish Balay - -tao_gttol <gttol> - Sets gttol 704a7e14dcfSSatish Balay 705a7e14dcfSSatish Balay Stopping Criteria: 706a7e14dcfSSatish Balay $ ||g(X)|| <= gatol 707a7e14dcfSSatish Balay $ ||g(X)|| / |f(X)| <= grtol 708a7e14dcfSSatish Balay $ ||g(X)|| / ||g(X0)|| <= gttol 709a7e14dcfSSatish Balay 710a7e14dcfSSatish Balay Notes: 711a7e14dcfSSatish Balay Use PETSC_DEFAULT to leave one or more tolerances unchanged. 712a7e14dcfSSatish Balay 713a7e14dcfSSatish Balay Level: beginner 714a7e14dcfSSatish Balay 715a7e14dcfSSatish Balay .seealso: TaoGetTolerances() 716a7e14dcfSSatish Balay 717a7e14dcfSSatish Balay @*/ 718e52336cbSBarry Smith PetscErrorCode TaoSetTolerances(Tao tao, PetscReal gatol, PetscReal grtol, PetscReal gttol) 719a7e14dcfSSatish Balay { 720a7e14dcfSSatish Balay PetscErrorCode ierr; 72147a47007SBarry Smith 722a7e14dcfSSatish Balay PetscFunctionBegin; 723441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 724a7e14dcfSSatish Balay 725a7e14dcfSSatish Balay if (gatol != PETSC_DEFAULT) { 726a7e14dcfSSatish Balay if (gatol<0) { 727955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative gatol -- ignored.\n");CHKERRQ(ierr); 728a7e14dcfSSatish Balay } else { 729a7e14dcfSSatish Balay tao->gatol = PetscMax(0,gatol); 7306552cf8aSJason Sarich tao->gatol_changed=PETSC_TRUE; 731a7e14dcfSSatish Balay } 732a7e14dcfSSatish Balay } 733a7e14dcfSSatish Balay 734a7e14dcfSSatish Balay if (grtol != PETSC_DEFAULT) { 735a7e14dcfSSatish Balay if (grtol<0) { 736955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative grtol -- ignored.\n");CHKERRQ(ierr); 737a7e14dcfSSatish Balay } else { 738a7e14dcfSSatish Balay tao->grtol = PetscMax(0,grtol); 7396552cf8aSJason Sarich tao->grtol_changed=PETSC_TRUE; 740a7e14dcfSSatish Balay } 741a7e14dcfSSatish Balay } 742a7e14dcfSSatish Balay 743a7e14dcfSSatish Balay if (gttol != PETSC_DEFAULT) { 744a7e14dcfSSatish Balay if (gttol<0) { 745955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative gttol -- ignored.\n");CHKERRQ(ierr); 746a7e14dcfSSatish Balay } else { 747a7e14dcfSSatish Balay tao->gttol = PetscMax(0,gttol); 7486552cf8aSJason Sarich tao->gttol_changed=PETSC_TRUE; 749a7e14dcfSSatish Balay } 750a7e14dcfSSatish Balay } 751a7e14dcfSSatish Balay PetscFunctionReturn(0); 752a7e14dcfSSatish Balay } 753a7e14dcfSSatish Balay 754a7e14dcfSSatish Balay #undef __FUNCT__ 755a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetConstraintTolerances" 756a7e14dcfSSatish Balay /*@ 75758417fe7SBarry Smith TaoSetConstraintTolerances - Sets constraint tolerance parameters used in TAO convergence tests 758a7e14dcfSSatish Balay 759441846f8SBarry Smith Logically collective on Tao 760a7e14dcfSSatish Balay 761a7e14dcfSSatish Balay Input Parameters: 762441846f8SBarry Smith + tao - the Tao context 763e52336cbSBarry Smith . catol - absolute constraint tolerance, constraint norm must be less than catol for used for gatol convergence criteria 764e52336cbSBarry Smith - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for gatol, gttol convergence criteria 765a7e14dcfSSatish Balay 766a7e14dcfSSatish Balay Options Database Keys: 767a7e14dcfSSatish Balay + -tao_catol <catol> - Sets catol 768a7e14dcfSSatish Balay - -tao_crtol <crtol> - Sets crtol 769a7e14dcfSSatish Balay 7706552cf8aSJason Sarich Notes: 7716552cf8aSJason Sarich Use PETSC_DEFAULT to leave any tolerance unchanged. 7726552cf8aSJason Sarich 773a7e14dcfSSatish Balay Level: intermediate 774a7e14dcfSSatish Balay 77558417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoGetConstraintTolerances(), TaoSetTolerances() 776a7e14dcfSSatish Balay 777a7e14dcfSSatish Balay @*/ 778441846f8SBarry Smith PetscErrorCode TaoSetConstraintTolerances(Tao tao, PetscReal catol, PetscReal crtol) 779a7e14dcfSSatish Balay { 780a7e14dcfSSatish Balay PetscErrorCode ierr; 78147a47007SBarry Smith 782a7e14dcfSSatish Balay PetscFunctionBegin; 783441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 784a7e14dcfSSatish Balay 785a7e14dcfSSatish Balay if (catol != PETSC_DEFAULT) { 786a7e14dcfSSatish Balay if (catol<0) { 787955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative catol -- ignored.\n");CHKERRQ(ierr); 788a7e14dcfSSatish Balay } else { 789a7e14dcfSSatish Balay tao->catol = PetscMax(0,catol); 7906552cf8aSJason Sarich tao->catol_changed=PETSC_TRUE; 791a7e14dcfSSatish Balay } 792a7e14dcfSSatish Balay } 793a7e14dcfSSatish Balay 794a7e14dcfSSatish Balay if (crtol != PETSC_DEFAULT) { 795a7e14dcfSSatish Balay if (crtol<0) { 796955c1f14SBarry Smith ierr = PetscInfo(tao,"Tried to set negative crtol -- ignored.\n");CHKERRQ(ierr); 797a7e14dcfSSatish Balay } else { 798a7e14dcfSSatish Balay tao->crtol = PetscMax(0,crtol); 7996552cf8aSJason Sarich tao->crtol_changed=PETSC_TRUE; 800a7e14dcfSSatish Balay } 801a7e14dcfSSatish Balay } 802a7e14dcfSSatish Balay PetscFunctionReturn(0); 803a7e14dcfSSatish Balay } 804a7e14dcfSSatish Balay 805a7e14dcfSSatish Balay #undef __FUNCT__ 80658417fe7SBarry Smith #define __FUNCT__ "TaoGetConstraintTolerances" 80758417fe7SBarry Smith /*@ 80858417fe7SBarry Smith TaoGetConstraintTolerances - Gets constraint tolerance parameters used in TAO convergence tests 80958417fe7SBarry Smith 81058417fe7SBarry Smith Not ollective 81158417fe7SBarry Smith 81258417fe7SBarry Smith Input Parameter: 81358417fe7SBarry Smith . tao - the Tao context 81458417fe7SBarry Smith 81558417fe7SBarry Smith Output Parameter: 816e52336cbSBarry Smith + catol - absolute constraint tolerance, constraint norm must be less than catol for used for gatol convergence criteria 817e52336cbSBarry Smith - crtol - relative contraint tolerance, constraint norm must be less than crtol for used for gatol, gttol convergence criteria 81858417fe7SBarry Smith 81958417fe7SBarry Smith Level: intermediate 82058417fe7SBarry Smith 82158417fe7SBarry Smith .seealso: TaoGetTolerances(), TaoSetTolerances(), TaoSetConstraintTolerances() 82258417fe7SBarry Smith 82358417fe7SBarry Smith @*/ 82458417fe7SBarry Smith PetscErrorCode TaoGetConstraintTolerances(Tao tao, PetscReal *catol, PetscReal *crtol) 82558417fe7SBarry Smith { 82658417fe7SBarry Smith PetscFunctionBegin; 82758417fe7SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 82858417fe7SBarry Smith if (catol) *catol = tao->catol; 82958417fe7SBarry Smith if (crtol) *crtol = tao->crtol; 83058417fe7SBarry Smith PetscFunctionReturn(0); 83158417fe7SBarry Smith } 83258417fe7SBarry Smith 83358417fe7SBarry Smith #undef __FUNCT__ 834a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetFunctionLowerBound" 835a7e14dcfSSatish Balay /*@ 836a7e14dcfSSatish Balay TaoSetFunctionLowerBound - Sets a bound on the solution objective value. 837a7e14dcfSSatish Balay When an approximate solution with an objective value below this number 838a7e14dcfSSatish Balay has been found, the solver will terminate. 839a7e14dcfSSatish Balay 840441846f8SBarry Smith Logically Collective on Tao 841a7e14dcfSSatish Balay 842a7e14dcfSSatish Balay Input Parameters: 843441846f8SBarry Smith + tao - the Tao solver context 844a7e14dcfSSatish Balay - fmin - the tolerance 845a7e14dcfSSatish Balay 846a7e14dcfSSatish Balay Options Database Keys: 847a7e14dcfSSatish Balay . -tao_fmin <fmin> - sets the minimum function value 848a7e14dcfSSatish Balay 849a7e14dcfSSatish Balay Level: intermediate 850a7e14dcfSSatish Balay 851a7e14dcfSSatish Balay .seealso: TaoSetTolerances() 852a7e14dcfSSatish Balay @*/ 853441846f8SBarry Smith PetscErrorCode TaoSetFunctionLowerBound(Tao tao,PetscReal fmin) 854a7e14dcfSSatish Balay { 855a7e14dcfSSatish Balay PetscFunctionBegin; 856441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 857a7e14dcfSSatish Balay tao->fmin = fmin; 8586552cf8aSJason Sarich tao->fmin_changed=PETSC_TRUE; 859a7e14dcfSSatish Balay PetscFunctionReturn(0); 860a7e14dcfSSatish Balay } 861a7e14dcfSSatish Balay 862a7e14dcfSSatish Balay #undef __FUNCT__ 863a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetFunctionLowerBound" 864a7e14dcfSSatish Balay /*@ 8658e96d397SJason Sarich TaoGetFunctionLowerBound - Gets the bound on the solution objective value. 866a7e14dcfSSatish Balay When an approximate solution with an objective value below this number 867a7e14dcfSSatish Balay has been found, the solver will terminate. 868a7e14dcfSSatish Balay 869441846f8SBarry Smith Not collective on Tao 870a7e14dcfSSatish Balay 871a7e14dcfSSatish Balay Input Parameters: 872441846f8SBarry Smith . tao - the Tao solver context 873a7e14dcfSSatish Balay 874a7e14dcfSSatish Balay OutputParameters: 875a7e14dcfSSatish Balay . fmin - the minimum function value 876a7e14dcfSSatish Balay 877a7e14dcfSSatish Balay Level: intermediate 878a7e14dcfSSatish Balay 879a7e14dcfSSatish Balay .seealso: TaoSetFunctionLowerBound() 880a7e14dcfSSatish Balay @*/ 881441846f8SBarry Smith PetscErrorCode TaoGetFunctionLowerBound(Tao tao,PetscReal *fmin) 882a7e14dcfSSatish Balay { 883a7e14dcfSSatish Balay PetscFunctionBegin; 884441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 885a7e14dcfSSatish Balay *fmin = tao->fmin; 886a7e14dcfSSatish Balay PetscFunctionReturn(0); 887a7e14dcfSSatish Balay } 888a7e14dcfSSatish Balay 889a7e14dcfSSatish Balay #undef __FUNCT__ 890a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMaximumFunctionEvaluations" 891a7e14dcfSSatish Balay /*@ 892a7e14dcfSSatish Balay TaoSetMaximumFunctionEvaluations - Sets a maximum number of 893a7e14dcfSSatish Balay function evaluations. 894a7e14dcfSSatish Balay 895441846f8SBarry Smith Logically Collective on Tao 896a7e14dcfSSatish Balay 897a7e14dcfSSatish Balay Input Parameters: 898441846f8SBarry Smith + tao - the Tao solver context 899a7e14dcfSSatish Balay - nfcn - the maximum number of function evaluations (>=0) 900a7e14dcfSSatish Balay 901a7e14dcfSSatish Balay Options Database Keys: 902a7e14dcfSSatish Balay . -tao_max_funcs <nfcn> - sets the maximum number of function evaluations 903a7e14dcfSSatish Balay 904a7e14dcfSSatish Balay Level: intermediate 905a7e14dcfSSatish Balay 906a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumIterations() 907a7e14dcfSSatish Balay @*/ 908a7e14dcfSSatish Balay 909441846f8SBarry Smith PetscErrorCode TaoSetMaximumFunctionEvaluations(Tao tao,PetscInt nfcn) 910a7e14dcfSSatish Balay { 911a7e14dcfSSatish Balay PetscFunctionBegin; 912441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 91347a47007SBarry Smith tao->max_funcs = PetscMax(0,nfcn); 9146552cf8aSJason Sarich tao->max_funcs_changed=PETSC_TRUE; 915a7e14dcfSSatish Balay PetscFunctionReturn(0); 916a7e14dcfSSatish Balay } 917a7e14dcfSSatish Balay 918a7e14dcfSSatish Balay #undef __FUNCT__ 919a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetMaximumFunctionEvaluations" 920a7e14dcfSSatish Balay /*@ 921a7e14dcfSSatish Balay TaoGetMaximumFunctionEvaluations - Sets a maximum number of 922a7e14dcfSSatish Balay function evaluations. 923a7e14dcfSSatish Balay 924a7e14dcfSSatish Balay Not Collective 925a7e14dcfSSatish Balay 926a7e14dcfSSatish Balay Input Parameters: 927441846f8SBarry Smith . tao - the Tao solver context 928a7e14dcfSSatish Balay 929a7e14dcfSSatish Balay Output Parameters: 930a7e14dcfSSatish Balay . nfcn - the maximum number of function evaluations 931a7e14dcfSSatish Balay 932a7e14dcfSSatish Balay Level: intermediate 933a7e14dcfSSatish Balay 934a7e14dcfSSatish Balay .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumIterations() 935a7e14dcfSSatish Balay @*/ 936a7e14dcfSSatish Balay 937441846f8SBarry Smith PetscErrorCode TaoGetMaximumFunctionEvaluations(Tao tao,PetscInt *nfcn) 938a7e14dcfSSatish Balay { 939a7e14dcfSSatish Balay PetscFunctionBegin; 940441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 941a7e14dcfSSatish Balay *nfcn = tao->max_funcs; 942a7e14dcfSSatish Balay PetscFunctionReturn(0); 943a7e14dcfSSatish Balay } 944a7e14dcfSSatish Balay 945a7e14dcfSSatish Balay #undef __FUNCT__ 946770232b9SCe Qin #define __FUNCT__ "TaoGetCurrentFunctionEvaluations" 947770232b9SCe Qin /*@ 948770232b9SCe Qin TaoGetCurrentFunctionEvaluations - Get current number of 949770232b9SCe Qin function evaluations. 950770232b9SCe Qin 951770232b9SCe Qin Not Collective 952770232b9SCe Qin 953770232b9SCe Qin Input Parameters: 954770232b9SCe Qin . tao - the Tao solver context 955770232b9SCe Qin 956770232b9SCe Qin Output Parameters: 957770232b9SCe Qin . nfuncs - the current number of function evaluations 958770232b9SCe Qin 959770232b9SCe Qin Level: intermediate 960770232b9SCe Qin 961770232b9SCe Qin .seealso: TaoSetMaximumFunctionEvaluations(), TaoGetMaximumFunctionEvaluations(), TaoGetMaximumIterations() 962770232b9SCe Qin @*/ 963770232b9SCe Qin 964770232b9SCe Qin PetscErrorCode TaoGetCurrentFunctionEvaluations(Tao tao,PetscInt *nfuncs) 965770232b9SCe Qin { 966770232b9SCe Qin PetscFunctionBegin; 967770232b9SCe Qin PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 968770232b9SCe Qin *nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads); 969770232b9SCe Qin PetscFunctionReturn(0); 970770232b9SCe Qin } 971770232b9SCe Qin 972770232b9SCe Qin #undef __FUNCT__ 973a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMaximumIterations" 974a7e14dcfSSatish Balay /*@ 975a7e14dcfSSatish Balay TaoSetMaximumIterations - Sets a maximum number of iterates. 976a7e14dcfSSatish Balay 977441846f8SBarry Smith Logically Collective on Tao 978a7e14dcfSSatish Balay 979a7e14dcfSSatish Balay Input Parameters: 980441846f8SBarry Smith + tao - the Tao solver context 981a7e14dcfSSatish Balay - maxits - the maximum number of iterates (>=0) 982a7e14dcfSSatish Balay 983a7e14dcfSSatish Balay Options Database Keys: 984a7e14dcfSSatish Balay . -tao_max_it <its> - sets the maximum number of iterations 985a7e14dcfSSatish Balay 986a7e14dcfSSatish Balay Level: intermediate 987a7e14dcfSSatish Balay 988a7e14dcfSSatish Balay .seealso: TaoSetTolerances(), TaoSetMaximumFunctionEvaluations() 989a7e14dcfSSatish Balay @*/ 990441846f8SBarry Smith PetscErrorCode TaoSetMaximumIterations(Tao tao,PetscInt maxits) 991a7e14dcfSSatish Balay { 992a7e14dcfSSatish Balay PetscFunctionBegin; 993441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 99447a47007SBarry Smith tao->max_it = PetscMax(0,maxits); 9956552cf8aSJason Sarich tao->max_it_changed=PETSC_TRUE; 996a7e14dcfSSatish Balay PetscFunctionReturn(0); 997a7e14dcfSSatish Balay } 998a7e14dcfSSatish Balay 999a7e14dcfSSatish Balay #undef __FUNCT__ 1000a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetMaximumIterations" 1001a7e14dcfSSatish Balay /*@ 1002a7e14dcfSSatish Balay TaoGetMaximumIterations - Sets a maximum number of iterates. 1003a7e14dcfSSatish Balay 1004a7e14dcfSSatish Balay Not Collective 1005a7e14dcfSSatish Balay 1006a7e14dcfSSatish Balay Input Parameters: 1007441846f8SBarry Smith . tao - the Tao solver context 1008a7e14dcfSSatish Balay 1009a7e14dcfSSatish Balay Output Parameters: 1010a7e14dcfSSatish Balay . maxits - the maximum number of iterates 1011a7e14dcfSSatish Balay 1012a7e14dcfSSatish Balay Level: intermediate 1013a7e14dcfSSatish Balay 1014a7e14dcfSSatish Balay .seealso: TaoSetMaximumIterations(), TaoGetMaximumFunctionEvaluations() 1015a7e14dcfSSatish Balay @*/ 1016441846f8SBarry Smith PetscErrorCode TaoGetMaximumIterations(Tao tao,PetscInt *maxits) 1017a7e14dcfSSatish Balay { 1018a7e14dcfSSatish Balay PetscFunctionBegin; 1019441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1020a7e14dcfSSatish Balay *maxits = tao->max_it; 1021a7e14dcfSSatish Balay PetscFunctionReturn(0); 1022a7e14dcfSSatish Balay } 1023a7e14dcfSSatish Balay 1024a7e14dcfSSatish Balay #undef __FUNCT__ 1025a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetInitialTrustRegionRadius" 1026a7e14dcfSSatish Balay /*@ 1027a7e14dcfSSatish Balay TaoSetInitialTrustRegionRadius - Sets the initial trust region radius. 1028a7e14dcfSSatish Balay 1029441846f8SBarry Smith Logically collective on Tao 1030a7e14dcfSSatish Balay 1031a7e14dcfSSatish Balay Input Parameter: 1032a7e14dcfSSatish Balay + tao - a TAO optimization solver 1033a7e14dcfSSatish Balay - radius - the trust region radius 1034a7e14dcfSSatish Balay 1035a7e14dcfSSatish Balay Level: intermediate 1036a7e14dcfSSatish Balay 1037a7e14dcfSSatish Balay Options Database Key: 1038a7e14dcfSSatish Balay . -tao_trust0 <t0> - sets initial trust region radius 1039a7e14dcfSSatish Balay 1040a7e14dcfSSatish Balay .seealso: TaoGetTrustRegionRadius(), TaoSetTrustRegionTolerance() 1041a7e14dcfSSatish Balay @*/ 1042441846f8SBarry Smith PetscErrorCode TaoSetInitialTrustRegionRadius(Tao tao, PetscReal radius) 1043a7e14dcfSSatish Balay { 1044a7e14dcfSSatish Balay PetscFunctionBegin; 1045441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1046a7e14dcfSSatish Balay tao->trust0 = PetscMax(0.0,radius); 10476552cf8aSJason Sarich tao->trust0_changed=PETSC_TRUE; 1048a7e14dcfSSatish Balay PetscFunctionReturn(0); 1049a7e14dcfSSatish Balay } 1050a7e14dcfSSatish Balay 1051a7e14dcfSSatish Balay #undef __FUNCT__ 1052a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetInitialTrustRegionRadius" 1053a7e14dcfSSatish Balay /*@ 1054a7e14dcfSSatish Balay TaoGetInitialTrustRegionRadius - Sets the initial trust region radius. 1055a7e14dcfSSatish Balay 1056a7e14dcfSSatish Balay Not Collective 1057a7e14dcfSSatish Balay 1058a7e14dcfSSatish Balay Input Parameter: 1059a7e14dcfSSatish Balay . tao - a TAO optimization solver 1060a7e14dcfSSatish Balay 1061a7e14dcfSSatish Balay Output Parameter: 1062a7e14dcfSSatish Balay . radius - the trust region radius 1063a7e14dcfSSatish Balay 1064a7e14dcfSSatish Balay Level: intermediate 1065a7e14dcfSSatish Balay 1066a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetCurrentTrustRegionRadius() 1067a7e14dcfSSatish Balay @*/ 1068441846f8SBarry Smith PetscErrorCode TaoGetInitialTrustRegionRadius(Tao tao, PetscReal *radius) 1069a7e14dcfSSatish Balay { 1070a7e14dcfSSatish Balay PetscFunctionBegin; 1071441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1072a7e14dcfSSatish Balay *radius = tao->trust0; 1073a7e14dcfSSatish Balay PetscFunctionReturn(0); 1074a7e14dcfSSatish Balay } 1075a7e14dcfSSatish Balay 1076a7e14dcfSSatish Balay #undef __FUNCT__ 1077a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetCurrentTrustRegionRadius" 1078a7e14dcfSSatish Balay /*@ 1079a7e14dcfSSatish Balay TaoGetCurrentTrustRegionRadius - Gets the current trust region radius. 1080a7e14dcfSSatish Balay 1081a7e14dcfSSatish Balay Not Collective 1082a7e14dcfSSatish Balay 1083a7e14dcfSSatish Balay Input Parameter: 1084a7e14dcfSSatish Balay . tao - a TAO optimization solver 1085a7e14dcfSSatish Balay 1086a7e14dcfSSatish Balay Output Parameter: 1087a7e14dcfSSatish Balay . radius - the trust region radius 1088a7e14dcfSSatish Balay 1089a7e14dcfSSatish Balay Level: intermediate 1090a7e14dcfSSatish Balay 1091a7e14dcfSSatish Balay .seealso: TaoSetInitialTrustRegionRadius(), TaoGetInitialTrustRegionRadius() 1092a7e14dcfSSatish Balay @*/ 1093441846f8SBarry Smith PetscErrorCode TaoGetCurrentTrustRegionRadius(Tao tao, PetscReal *radius) 1094a7e14dcfSSatish Balay { 1095a7e14dcfSSatish Balay PetscFunctionBegin; 1096441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1097a7e14dcfSSatish Balay *radius = tao->trust; 1098a7e14dcfSSatish Balay PetscFunctionReturn(0); 1099a7e14dcfSSatish Balay } 1100a7e14dcfSSatish Balay 1101a7e14dcfSSatish Balay #undef __FUNCT__ 1102a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetTolerances" 1103a7e14dcfSSatish Balay /*@ 1104a7e14dcfSSatish Balay TaoGetTolerances - gets the current values of tolerances 1105a7e14dcfSSatish Balay 1106a7e14dcfSSatish Balay Not Collective 1107a7e14dcfSSatish Balay 1108a7e14dcfSSatish Balay Input Parameters: 1109441846f8SBarry Smith . tao - the Tao context 1110a7e14dcfSSatish Balay 1111a7e14dcfSSatish Balay Output Parameters: 1112e52336cbSBarry Smith + gatol - stop if norm of gradient is less than this 1113a7e14dcfSSatish Balay . grtol - stop if relative norm of gradient is less than this 1114a7e14dcfSSatish Balay - gttol - stop if norm of gradient is reduced by a this factor 1115a7e14dcfSSatish Balay 111647a47007SBarry Smith Note: NULL can be used as an argument if not all tolerances values are needed 1117a7e14dcfSSatish Balay 1118a7e14dcfSSatish Balay .seealso TaoSetTolerances() 1119a7e14dcfSSatish Balay 1120a7e14dcfSSatish Balay Level: intermediate 1121a7e14dcfSSatish Balay @*/ 1122e52336cbSBarry Smith PetscErrorCode TaoGetTolerances(Tao tao, PetscReal *gatol, PetscReal *grtol, PetscReal *gttol) 1123a7e14dcfSSatish Balay { 1124a7e14dcfSSatish Balay PetscFunctionBegin; 1125441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1126a7e14dcfSSatish Balay if (gatol) *gatol=tao->gatol; 1127a7e14dcfSSatish Balay if (grtol) *grtol=tao->grtol; 1128a7e14dcfSSatish Balay if (gttol) *gttol=tao->gttol; 1129a7e14dcfSSatish Balay PetscFunctionReturn(0); 1130a7e14dcfSSatish Balay } 1131a7e14dcfSSatish Balay 1132a7e14dcfSSatish Balay #undef __FUNCT__ 1133a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetKSP" 1134a7e14dcfSSatish Balay /*@ 1135a7e14dcfSSatish Balay TaoGetKSP - Gets the linear solver used by the optimization solver. 1136a7e14dcfSSatish Balay Application writers should use TaoGetKSP if they need direct access 1137a7e14dcfSSatish Balay to the PETSc KSP object. 1138a7e14dcfSSatish Balay 1139a7e14dcfSSatish Balay Not Collective 1140a7e14dcfSSatish Balay 1141a7e14dcfSSatish Balay Input Parameters: 1142a7e14dcfSSatish Balay . tao - the TAO solver 1143a7e14dcfSSatish Balay 1144a7e14dcfSSatish Balay Output Parameters: 1145a7e14dcfSSatish Balay . ksp - the KSP linear solver used in the optimization solver 1146a7e14dcfSSatish Balay 1147a7e14dcfSSatish Balay Level: intermediate 1148a7e14dcfSSatish Balay 1149a7e14dcfSSatish Balay @*/ 1150441846f8SBarry Smith PetscErrorCode TaoGetKSP(Tao tao, KSP *ksp) 115147a47007SBarry Smith { 1152a7e14dcfSSatish Balay PetscFunctionBegin; 1153a7e14dcfSSatish Balay *ksp = tao->ksp; 1154a7e14dcfSSatish Balay PetscFunctionReturn(0); 1155a7e14dcfSSatish Balay } 1156a7e14dcfSSatish Balay 1157a7e14dcfSSatish Balay #undef __FUNCT__ 1158025e9500SJason Sarich #define __FUNCT__ "TaoGetLinearSolveIterations" 1159025e9500SJason Sarich /*@ 1160025e9500SJason Sarich TaoGetLinearSolveIterations - Gets the total number of linear iterations 1161025e9500SJason Sarich used by the TAO solver 1162025e9500SJason Sarich 1163025e9500SJason Sarich Not Collective 1164025e9500SJason Sarich 1165025e9500SJason Sarich Input Parameter: 1166025e9500SJason Sarich . tao - TAO context 1167025e9500SJason Sarich 1168025e9500SJason Sarich Output Parameter: 1169025e9500SJason Sarich . lits - number of linear iterations 1170025e9500SJason Sarich 1171025e9500SJason Sarich Notes: 1172025e9500SJason Sarich This counter is reset to zero for each successive call to TaoSolve() 1173025e9500SJason Sarich 1174025e9500SJason Sarich Level: intermediate 1175025e9500SJason Sarich 1176025e9500SJason Sarich .keywords: TAO 1177025e9500SJason Sarich 1178025e9500SJason Sarich .seealso: TaoGetKSP() 1179025e9500SJason Sarich @*/ 1180025e9500SJason Sarich PetscErrorCode TaoGetLinearSolveIterations(Tao tao,PetscInt *lits) 1181025e9500SJason Sarich { 1182025e9500SJason Sarich PetscFunctionBegin; 1183025e9500SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1184025e9500SJason Sarich PetscValidIntPointer(lits,2); 11852d9aa51bSJason Sarich *lits = tao->ksp_tot_its; 1186025e9500SJason Sarich PetscFunctionReturn(0); 1187025e9500SJason Sarich } 1188025e9500SJason Sarich 1189025e9500SJason Sarich #undef __FUNCT__ 1190a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetLineSearch" 1191a7e14dcfSSatish Balay /*@ 1192a7e14dcfSSatish Balay TaoGetLineSearch - Gets the line search used by the optimization solver. 1193a7e14dcfSSatish Balay Application writers should use TaoGetLineSearch if they need direct access 1194a7e14dcfSSatish Balay to the TaoLineSearch object. 1195a7e14dcfSSatish Balay 1196a7e14dcfSSatish Balay Not Collective 1197a7e14dcfSSatish Balay 1198a7e14dcfSSatish Balay Input Parameters: 1199a7e14dcfSSatish Balay . tao - the TAO solver 1200a7e14dcfSSatish Balay 1201a7e14dcfSSatish Balay Output Parameters: 1202a7e14dcfSSatish Balay . ls - the line search used in the optimization solver 1203a7e14dcfSSatish Balay 1204a7e14dcfSSatish Balay Level: intermediate 1205a7e14dcfSSatish Balay 1206a7e14dcfSSatish Balay @*/ 1207441846f8SBarry Smith PetscErrorCode TaoGetLineSearch(Tao tao, TaoLineSearch *ls) 120847a47007SBarry Smith { 1209a7e14dcfSSatish Balay PetscFunctionBegin; 1210a7e14dcfSSatish Balay *ls = tao->linesearch; 1211a7e14dcfSSatish Balay PetscFunctionReturn(0); 1212a7e14dcfSSatish Balay } 1213a7e14dcfSSatish Balay 1214a7e14dcfSSatish Balay #undef __FUNCT__ 1215a7e14dcfSSatish Balay #define __FUNCT__ "TaoAddLineSearchCounts" 1216a7e14dcfSSatish Balay /*@ 1217a7e14dcfSSatish Balay TaoAddLineSearchCounts - Adds the number of function evaluations spent 1218a7e14dcfSSatish Balay in the line search to the running total. 1219a7e14dcfSSatish Balay 1220a7e14dcfSSatish Balay Input Parameters: 1221a7e14dcfSSatish Balay + tao - the TAO solver 1222a7e14dcfSSatish Balay - ls - the line search used in the optimization solver 1223a7e14dcfSSatish Balay 1224a7e14dcfSSatish Balay Level: developer 1225a7e14dcfSSatish Balay 1226a7e14dcfSSatish Balay .seealso: TaoLineSearchApply() 1227a7e14dcfSSatish Balay @*/ 1228441846f8SBarry Smith PetscErrorCode TaoAddLineSearchCounts(Tao tao) 122947a47007SBarry Smith { 1230a7e14dcfSSatish Balay PetscErrorCode ierr; 1231a7e14dcfSSatish Balay PetscBool flg; 1232a7e14dcfSSatish Balay PetscInt nfeval,ngeval,nfgeval; 123347a47007SBarry Smith 1234a7e14dcfSSatish Balay PetscFunctionBegin; 1235441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1236a7e14dcfSSatish Balay if (tao->linesearch) { 1237302440fdSBarry Smith ierr = TaoLineSearchIsUsingTaoRoutines(tao->linesearch,&flg);CHKERRQ(ierr); 123894ae4db5SBarry Smith if (!flg) { 123947a47007SBarry Smith ierr = TaoLineSearchGetNumberFunctionEvaluations(tao->linesearch,&nfeval,&ngeval,&nfgeval);CHKERRQ(ierr); 1240a7e14dcfSSatish Balay tao->nfuncs+=nfeval; 1241a7e14dcfSSatish Balay tao->ngrads+=ngeval; 1242a7e14dcfSSatish Balay tao->nfuncgrads+=nfgeval; 1243a7e14dcfSSatish Balay } 1244a7e14dcfSSatish Balay } 1245a7e14dcfSSatish Balay PetscFunctionReturn(0); 1246a7e14dcfSSatish Balay } 1247a7e14dcfSSatish Balay 1248a7e14dcfSSatish Balay #undef __FUNCT__ 1249a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetSolutionVector" 1250a7e14dcfSSatish Balay /*@ 1251a7e14dcfSSatish Balay TaoGetSolutionVector - Returns the vector with the current TAO solution 1252a7e14dcfSSatish Balay 1253a7e14dcfSSatish Balay Not Collective 1254a7e14dcfSSatish Balay 1255a7e14dcfSSatish Balay Input Parameter: 1256441846f8SBarry Smith . tao - the Tao context 1257a7e14dcfSSatish Balay 1258a7e14dcfSSatish Balay Output Parameter: 1259a7e14dcfSSatish Balay . X - the current solution 1260a7e14dcfSSatish Balay 1261a7e14dcfSSatish Balay Level: intermediate 1262a7e14dcfSSatish Balay 1263a7e14dcfSSatish Balay Note: The returned vector will be the same object that was passed into TaoSetInitialVector() 1264a7e14dcfSSatish Balay @*/ 1265441846f8SBarry Smith PetscErrorCode TaoGetSolutionVector(Tao tao, Vec *X) 1266a7e14dcfSSatish Balay { 1267a7e14dcfSSatish Balay PetscFunctionBegin; 1268441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1269a7e14dcfSSatish Balay *X = tao->solution; 1270a7e14dcfSSatish Balay PetscFunctionReturn(0); 1271a7e14dcfSSatish Balay } 1272a7e14dcfSSatish Balay 1273a7e14dcfSSatish Balay #undef __FUNCT__ 1274a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetGradientVector" 1275a7e14dcfSSatish Balay /*@ 1276a7e14dcfSSatish Balay TaoGetGradientVector - Returns the vector with the current TAO gradient 1277a7e14dcfSSatish Balay 1278a7e14dcfSSatish Balay Not Collective 1279a7e14dcfSSatish Balay 1280a7e14dcfSSatish Balay Input Parameter: 1281441846f8SBarry Smith . tao - the Tao context 1282a7e14dcfSSatish Balay 1283a7e14dcfSSatish Balay Output Parameter: 1284a7e14dcfSSatish Balay . G - the current solution 1285a7e14dcfSSatish Balay 1286a7e14dcfSSatish Balay Level: intermediate 1287a7e14dcfSSatish Balay @*/ 1288441846f8SBarry Smith PetscErrorCode TaoGetGradientVector(Tao tao, Vec *G) 1289a7e14dcfSSatish Balay { 1290a7e14dcfSSatish Balay PetscFunctionBegin; 1291441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1292a7e14dcfSSatish Balay *G = tao->gradient; 1293a7e14dcfSSatish Balay PetscFunctionReturn(0); 1294a7e14dcfSSatish Balay } 1295a7e14dcfSSatish Balay 1296a7e14dcfSSatish Balay #undef __FUNCT__ 1297a7e14dcfSSatish Balay #define __FUNCT__ "TaoResetStatistics" 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 #undef __FUNCT__ 1335a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetConvergenceTest" 1336a7e14dcfSSatish Balay /*@C 1337a7e14dcfSSatish Balay TaoSetConvergenceTest - Sets the function that is to be used to test 1338a7e14dcfSSatish Balay for convergence o fthe iterative minimization solution. The new convergence 1339a7e14dcfSSatish Balay testing routine will replace TAO's default convergence test. 1340a7e14dcfSSatish Balay 1341441846f8SBarry Smith Logically Collective on Tao 1342a7e14dcfSSatish Balay 1343a7e14dcfSSatish Balay Input Parameters: 1344441846f8SBarry Smith + tao - the Tao object 1345a7e14dcfSSatish Balay . conv - the routine to test for convergence 1346a7e14dcfSSatish Balay - ctx - [optional] context for private data for the convergence routine 134747a47007SBarry Smith (may be NULL) 1348a7e14dcfSSatish Balay 1349a7e14dcfSSatish Balay Calling sequence of conv: 1350441846f8SBarry Smith $ PetscErrorCode conv(Tao tao, void *ctx) 1351a7e14dcfSSatish Balay 1352441846f8SBarry Smith + tao - the Tao object 1353a7e14dcfSSatish Balay - ctx - [optional] convergence context 1354a7e14dcfSSatish Balay 1355e4cb33bbSBarry Smith Note: The new convergence testing routine should call TaoSetConvergedReason(). 1356a7e14dcfSSatish Balay 1357a7e14dcfSSatish Balay Level: advanced 1358a7e14dcfSSatish Balay 1359e4cb33bbSBarry Smith .seealso: TaoSetConvergedReason(), TaoGetSolutionStatus(), TaoGetTolerances(), TaoSetMonitor 1360a7e14dcfSSatish Balay 1361a7e14dcfSSatish Balay @*/ 1362441846f8SBarry Smith PetscErrorCode TaoSetConvergenceTest(Tao tao, PetscErrorCode (*conv)(Tao,void*), void *ctx) 1363a7e14dcfSSatish Balay { 1364a7e14dcfSSatish Balay PetscFunctionBegin; 1365441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1366a7e14dcfSSatish Balay (tao)->ops->convergencetest = conv; 1367a7e14dcfSSatish Balay (tao)->cnvP = ctx; 1368a7e14dcfSSatish Balay PetscFunctionReturn(0); 1369a7e14dcfSSatish Balay } 1370a7e14dcfSSatish Balay 1371a7e14dcfSSatish Balay #undef __FUNCT__ 1372a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetMonitor" 1373a7e14dcfSSatish Balay /*@C 1374a7e14dcfSSatish Balay TaoSetMonitor - Sets an ADDITIONAL function that is to be used at every 1375a7e14dcfSSatish Balay iteration of the solver to display the iteration's 1376a7e14dcfSSatish Balay progress. 1377a7e14dcfSSatish Balay 1378441846f8SBarry Smith Logically Collective on Tao 1379a7e14dcfSSatish Balay 1380a7e14dcfSSatish Balay Input Parameters: 1381441846f8SBarry Smith + tao - the Tao solver context 1382a7e14dcfSSatish Balay . mymonitor - monitoring routine 1383a7e14dcfSSatish Balay - mctx - [optional] user-defined context for private data for the 138447a47007SBarry Smith monitor routine (may be NULL) 1385a7e14dcfSSatish Balay 1386a7e14dcfSSatish Balay Calling sequence of mymonitor: 1387441846f8SBarry Smith $ int mymonitor(Tao tao,void *mctx) 1388a7e14dcfSSatish Balay 1389441846f8SBarry Smith + tao - the Tao solver context 1390a7e14dcfSSatish Balay - mctx - [optional] monitoring context 1391a7e14dcfSSatish Balay 1392a7e14dcfSSatish Balay 1393a7e14dcfSSatish Balay Options Database Keys: 1394a7e14dcfSSatish Balay + -tao_monitor - sets TaoDefaultMonitor() 1395a7e14dcfSSatish Balay . -tao_smonitor - sets short monitor 1396a7e14dcfSSatish Balay . -tao_cmonitor - same as smonitor plus constraint norm 1397a7e14dcfSSatish Balay . -tao_view_solution - view solution at each iteration 1398a7e14dcfSSatish Balay . -tao_view_gradient - view gradient at each iteration 1399a7e14dcfSSatish Balay . -tao_view_separableobjective - view separable objective function at each iteration 1400a7e14dcfSSatish 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. 1401a7e14dcfSSatish Balay 1402a7e14dcfSSatish Balay 1403a7e14dcfSSatish Balay Notes: 1404a7e14dcfSSatish Balay Several different monitoring routines may be set by calling 1405a7e14dcfSSatish Balay TaoSetMonitor() multiple times; all will be called in the 1406a7e14dcfSSatish Balay order in which they were set. 1407a7e14dcfSSatish Balay 1408a7e14dcfSSatish Balay Fortran Notes: Only one monitor function may be set 1409a7e14dcfSSatish Balay 1410a7e14dcfSSatish Balay Level: intermediate 1411a7e14dcfSSatish Balay 1412a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoCancelMonitors(), TaoSetDestroyRoutine() 1413a7e14dcfSSatish Balay @*/ 1414441846f8SBarry Smith PetscErrorCode TaoSetMonitor(Tao tao, PetscErrorCode (*func)(Tao, void*), void *ctx,PetscErrorCode (*dest)(void**)) 1415a7e14dcfSSatish Balay { 141608d19d1fSJason Sarich PetscErrorCode ierr; 141708d19d1fSJason Sarich PetscInt i; 141808d19d1fSJason Sarich 1419a7e14dcfSSatish Balay PetscFunctionBegin; 1420441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 142147a47007SBarry Smith if (tao->numbermonitors >= MAXTAOMONITORS) SETERRQ1(PETSC_COMM_SELF,1,"Cannot attach another monitor -- max=",MAXTAOMONITORS); 142208d19d1fSJason Sarich 142308d19d1fSJason Sarich for (i=0; i<tao->numbermonitors;i++) { 142408d19d1fSJason Sarich if (func == tao->monitor[i] && dest == tao->monitordestroy[i] && ctx == tao->monitorcontext[i]) { 142508d19d1fSJason Sarich if (dest) { 142608d19d1fSJason Sarich ierr = (*dest)(&ctx);CHKERRQ(ierr); 142708d19d1fSJason Sarich } 142808d19d1fSJason Sarich PetscFunctionReturn(0); 142908d19d1fSJason Sarich } 143008d19d1fSJason Sarich } 1431a7e14dcfSSatish Balay tao->monitor[tao->numbermonitors] = func; 1432a7e14dcfSSatish Balay tao->monitorcontext[tao->numbermonitors] = ctx; 1433a7e14dcfSSatish Balay tao->monitordestroy[tao->numbermonitors] = dest; 1434a7e14dcfSSatish Balay ++tao->numbermonitors; 1435a7e14dcfSSatish Balay PetscFunctionReturn(0); 1436a7e14dcfSSatish Balay } 1437a7e14dcfSSatish Balay 1438a7e14dcfSSatish Balay #undef __FUNCT__ 1439a7e14dcfSSatish Balay #define __FUNCT__ "TaoCancelMonitors" 1440a7e14dcfSSatish Balay /*@ 1441441846f8SBarry Smith TaoCancelMonitors - Clears all the monitor functions for a Tao object. 1442a7e14dcfSSatish Balay 1443441846f8SBarry Smith Logically Collective on Tao 1444a7e14dcfSSatish Balay 1445a7e14dcfSSatish Balay Input Parameters: 1446441846f8SBarry Smith . tao - the Tao solver context 1447a7e14dcfSSatish Balay 1448a7e14dcfSSatish Balay Options Database: 1449a7e14dcfSSatish Balay . -tao_cancelmonitors - cancels all monitors that have been hardwired 1450a7e14dcfSSatish Balay into a code by calls to TaoSetMonitor(), but does not cancel those 1451a7e14dcfSSatish Balay set via the options database 1452a7e14dcfSSatish Balay 1453a7e14dcfSSatish Balay Notes: 1454441846f8SBarry Smith There is no way to clear one specific monitor from a Tao object. 1455a7e14dcfSSatish Balay 1456a7e14dcfSSatish Balay Level: advanced 1457a7e14dcfSSatish Balay 1458a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor() 1459a7e14dcfSSatish Balay @*/ 1460441846f8SBarry Smith PetscErrorCode TaoCancelMonitors(Tao tao) 1461a7e14dcfSSatish Balay { 1462a7e14dcfSSatish Balay PetscInt i; 1463a7e14dcfSSatish Balay PetscErrorCode ierr; 146447a47007SBarry Smith 1465a7e14dcfSSatish Balay PetscFunctionBegin; 1466441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 1467a7e14dcfSSatish Balay for (i=0;i<tao->numbermonitors;i++) { 1468a7e14dcfSSatish Balay if (tao->monitordestroy[i]) { 1469a7e14dcfSSatish Balay ierr = (*tao->monitordestroy[i])(&tao->monitorcontext[i]);CHKERRQ(ierr); 1470a7e14dcfSSatish Balay } 1471a7e14dcfSSatish Balay } 1472a7e14dcfSSatish Balay tao->numbermonitors=0; 1473a7e14dcfSSatish Balay PetscFunctionReturn(0); 1474a7e14dcfSSatish Balay } 1475a7e14dcfSSatish Balay 1476a7e14dcfSSatish Balay #undef __FUNCT__ 1477a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultMonitor" 14787fab98ebSJason Sarich /*@ 1479a7e14dcfSSatish Balay TaoDefaultMonitor - Default routine for monitoring progress of the 1480441846f8SBarry Smith Tao solvers (default). This monitor prints the function value and gradient 1481a7e14dcfSSatish Balay norm at each iteration. It can be turned on from the command line using the 1482a7e14dcfSSatish Balay -tao_monitor option 1483a7e14dcfSSatish Balay 1484441846f8SBarry Smith Collective on Tao 1485a7e14dcfSSatish Balay 1486a7e14dcfSSatish Balay Input Parameters: 1487441846f8SBarry Smith + tao - the Tao context 148847a47007SBarry Smith - ctx - PetscViewer context or NULL 1489a7e14dcfSSatish Balay 1490a7e14dcfSSatish Balay Options Database Keys: 1491a7e14dcfSSatish Balay . -tao_monitor 1492a7e14dcfSSatish Balay 1493a7e14dcfSSatish Balay Level: advanced 1494a7e14dcfSSatish Balay 1495a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1496a7e14dcfSSatish Balay @*/ 1497441846f8SBarry Smith PetscErrorCode TaoDefaultMonitor(Tao tao, void *ctx) 1498a7e14dcfSSatish Balay { 1499a7e14dcfSSatish Balay PetscErrorCode ierr; 1500a7e14dcfSSatish Balay PetscInt its; 1501a7e14dcfSSatish Balay PetscReal fct,gnorm; 15028163d661SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 150347a47007SBarry Smith 1504a7e14dcfSSatish Balay PetscFunctionBegin; 15058163d661SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1506a7e14dcfSSatish Balay its=tao->niter; 1507a7e14dcfSSatish Balay fct=tao->fc; 1508a7e14dcfSSatish Balay gnorm=tao->residual; 1509a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr); 151047a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr); 151108d19d1fSJason Sarich if (gnorm >= PETSC_INFINITY) { 151208d19d1fSJason Sarich ierr=PetscViewerASCIIPrintf(viewer," Residual: Inf \n");CHKERRQ(ierr); 151308d19d1fSJason Sarich } else { 151447a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr); 151508d19d1fSJason Sarich } 1516a7e14dcfSSatish Balay PetscFunctionReturn(0); 1517a7e14dcfSSatish Balay } 1518a7e14dcfSSatish Balay 1519a7e14dcfSSatish Balay #undef __FUNCT__ 1520a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultSMonitor" 15217fab98ebSJason Sarich /*@ 1522a7e14dcfSSatish Balay TaoDefaultSMonitor - Default routine for monitoring progress of the 1523a7e14dcfSSatish Balay solver. Same as TaoDefaultMonitor() except 1524a7e14dcfSSatish Balay it prints fewer digits of the residual as the residual gets smaller. 1525a7e14dcfSSatish Balay This is because the later digits are meaningless and are often 1526a7e14dcfSSatish Balay different on different machines; by using this routine different 1527a7e14dcfSSatish Balay machines will usually generate the same output. It can be turned on 1528a7e14dcfSSatish Balay by using the -tao_smonitor option 1529a7e14dcfSSatish Balay 1530441846f8SBarry Smith Collective on Tao 1531a7e14dcfSSatish Balay 1532a7e14dcfSSatish Balay Input Parameters: 1533441846f8SBarry Smith + tao - the Tao context 15344d4332d5SBarry Smith - ctx - PetscViewer context of type ASCII 1535a7e14dcfSSatish Balay 1536a7e14dcfSSatish Balay Options Database Keys: 1537a7e14dcfSSatish Balay . -tao_smonitor 1538a7e14dcfSSatish Balay 1539a7e14dcfSSatish Balay Level: advanced 1540a7e14dcfSSatish Balay 1541a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor() 1542a7e14dcfSSatish Balay @*/ 1543441846f8SBarry Smith PetscErrorCode TaoDefaultSMonitor(Tao tao, void *ctx) 1544a7e14dcfSSatish Balay { 1545a7e14dcfSSatish Balay PetscErrorCode ierr; 1546a7e14dcfSSatish Balay PetscInt its; 1547a7e14dcfSSatish Balay PetscReal fct,gnorm; 15484d4332d5SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 154947a47007SBarry Smith 1550a7e14dcfSSatish Balay PetscFunctionBegin; 15514d4332d5SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1552a7e14dcfSSatish Balay its=tao->niter; 1553a7e14dcfSSatish Balay fct=tao->fc; 1554a7e14dcfSSatish Balay gnorm=tao->residual; 1555a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"iter = %3D,",its);CHKERRQ(ierr); 155647a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Function value %g,",(double)fct);CHKERRQ(ierr); 1557d393f493SBarry Smith if (gnorm >= PETSC_INFINITY) { 155808d19d1fSJason Sarich ierr=PetscViewerASCIIPrintf(viewer," Residual: Inf \n");CHKERRQ(ierr); 155908d19d1fSJason Sarich } else if (gnorm > 1.e-6) { 156047a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Residual: %g \n",(double)gnorm);CHKERRQ(ierr); 1561a7e14dcfSSatish Balay } else if (gnorm > 1.e-11) { 1562a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-6 \n");CHKERRQ(ierr); 1563a7e14dcfSSatish Balay } else { 1564a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer," Residual: < 1.0e-11 \n");CHKERRQ(ierr); 1565a7e14dcfSSatish Balay } 1566a7e14dcfSSatish Balay PetscFunctionReturn(0); 1567a7e14dcfSSatish Balay } 1568a7e14dcfSSatish Balay 1569a7e14dcfSSatish Balay #undef __FUNCT__ 1570a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultCMonitor" 15717fab98ebSJason Sarich /*@ 1572a7e14dcfSSatish Balay TaoDefaultCMonitor - same as TaoDefaultMonitor() except 1573a7e14dcfSSatish Balay it prints the norm of the constraints function. It can be turned on 1574a7e14dcfSSatish Balay from the command line using the -tao_cmonitor option 1575a7e14dcfSSatish Balay 1576441846f8SBarry Smith Collective on Tao 1577a7e14dcfSSatish Balay 1578a7e14dcfSSatish Balay Input Parameters: 1579441846f8SBarry Smith + tao - the Tao context 158047a47007SBarry Smith - ctx - PetscViewer context or NULL 1581a7e14dcfSSatish Balay 1582a7e14dcfSSatish Balay Options Database Keys: 1583a7e14dcfSSatish Balay . -tao_cmonitor 1584a7e14dcfSSatish Balay 1585a7e14dcfSSatish Balay Level: advanced 1586a7e14dcfSSatish Balay 1587a7e14dcfSSatish Balay .seealso: TaoDefaultMonitor(), TaoSetMonitor() 1588a7e14dcfSSatish Balay @*/ 1589441846f8SBarry Smith PetscErrorCode TaoDefaultCMonitor(Tao tao, void *ctx) 1590a7e14dcfSSatish Balay { 1591a7e14dcfSSatish Balay PetscErrorCode ierr; 1592a7e14dcfSSatish Balay PetscInt its; 1593a7e14dcfSSatish Balay PetscReal fct,gnorm; 1594d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 1595a7e14dcfSSatish Balay 1596a7e14dcfSSatish Balay PetscFunctionBegin; 1597d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1598a7e14dcfSSatish Balay its=tao->niter; 1599a7e14dcfSSatish Balay fct=tao->fc; 1600a7e14dcfSSatish Balay gnorm=tao->residual; 1601a7e14dcfSSatish Balay ierr=PetscViewerASCIIPrintf(viewer,"iter = %D,",its);CHKERRQ(ierr); 160247a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Function value: %g,",(double)fct);CHKERRQ(ierr); 160347a47007SBarry Smith ierr=PetscViewerASCIIPrintf(viewer," Residual: %g ",(double)gnorm);CHKERRQ(ierr); 160447a47007SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Constraint: %g \n",(double)tao->cnorm);CHKERRQ(ierr); 1605a7e14dcfSSatish Balay PetscFunctionReturn(0); 1606a7e14dcfSSatish Balay } 1607a7e14dcfSSatish Balay 1608a7e14dcfSSatish Balay #undef __FUNCT__ 1609a7e14dcfSSatish Balay #define __FUNCT__ "TaoSolutionMonitor" 1610a7e14dcfSSatish Balay /*@C 1611a7e14dcfSSatish Balay TaoSolutionMonitor - Views the solution at each iteration 1612a7e14dcfSSatish Balay It can be turned on from the command line using the 1613a7e14dcfSSatish Balay -tao_view_solution option 1614a7e14dcfSSatish Balay 1615441846f8SBarry Smith Collective on Tao 1616a7e14dcfSSatish Balay 1617a7e14dcfSSatish Balay Input Parameters: 1618441846f8SBarry Smith + tao - the Tao context 161947a47007SBarry Smith - ctx - PetscViewer context or NULL 1620a7e14dcfSSatish Balay 1621a7e14dcfSSatish Balay Options Database Keys: 1622a7e14dcfSSatish Balay . -tao_view_solution 1623a7e14dcfSSatish Balay 1624a7e14dcfSSatish Balay Level: advanced 1625a7e14dcfSSatish Balay 1626a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1627a7e14dcfSSatish Balay @*/ 1628441846f8SBarry Smith PetscErrorCode TaoSolutionMonitor(Tao tao, void *ctx) 1629a7e14dcfSSatish Balay { 1630a7e14dcfSSatish Balay PetscErrorCode ierr; 1631d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx;; 163247a47007SBarry Smith 1633a7e14dcfSSatish Balay PetscFunctionBegin; 1634d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1635a7e14dcfSSatish Balay ierr = VecView(tao->solution, viewer);CHKERRQ(ierr); 1636a7e14dcfSSatish Balay PetscFunctionReturn(0); 1637a7e14dcfSSatish Balay } 1638a7e14dcfSSatish Balay 1639a7e14dcfSSatish Balay #undef __FUNCT__ 1640a7e14dcfSSatish Balay #define __FUNCT__ "TaoGradientMonitor" 1641a7e14dcfSSatish Balay /*@C 1642a7e14dcfSSatish Balay TaoGradientMonitor - Views the gradient at each iteration 1643a7e14dcfSSatish Balay It can be turned on from the command line using the 1644a7e14dcfSSatish Balay -tao_view_gradient option 1645a7e14dcfSSatish Balay 1646441846f8SBarry Smith Collective on Tao 1647a7e14dcfSSatish Balay 1648a7e14dcfSSatish Balay Input Parameters: 1649441846f8SBarry Smith + tao - the Tao context 165047a47007SBarry Smith - ctx - PetscViewer context or NULL 1651a7e14dcfSSatish Balay 1652a7e14dcfSSatish Balay Options Database Keys: 1653a7e14dcfSSatish Balay . -tao_view_gradient 1654a7e14dcfSSatish Balay 1655a7e14dcfSSatish Balay Level: advanced 1656a7e14dcfSSatish Balay 1657a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1658a7e14dcfSSatish Balay @*/ 1659441846f8SBarry Smith PetscErrorCode TaoGradientMonitor(Tao tao, void *ctx) 1660a7e14dcfSSatish Balay { 1661a7e14dcfSSatish Balay PetscErrorCode ierr; 1662d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 166347a47007SBarry Smith 1664a7e14dcfSSatish Balay PetscFunctionBegin; 1665d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1666a7e14dcfSSatish Balay ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr); 1667a7e14dcfSSatish Balay PetscFunctionReturn(0); 1668a7e14dcfSSatish Balay } 1669a7e14dcfSSatish Balay 1670a7e14dcfSSatish Balay #undef __FUNCT__ 1671a7e14dcfSSatish Balay #define __FUNCT__ "TaoStepDirectionMonitor" 1672a7e14dcfSSatish Balay /*@C 1673a7e14dcfSSatish Balay TaoStepDirectionMonitor - Views the gradient at each iteration 1674a7e14dcfSSatish Balay It can be turned on from the command line using the 1675a7e14dcfSSatish Balay -tao_view_gradient option 1676a7e14dcfSSatish Balay 1677441846f8SBarry Smith Collective on Tao 1678a7e14dcfSSatish Balay 1679a7e14dcfSSatish Balay Input Parameters: 1680441846f8SBarry Smith + tao - the Tao context 168147a47007SBarry Smith - ctx - PetscViewer context or NULL 1682a7e14dcfSSatish Balay 1683a7e14dcfSSatish Balay Options Database Keys: 1684a7e14dcfSSatish Balay . -tao_view_gradient 1685a7e14dcfSSatish Balay 1686a7e14dcfSSatish Balay Level: advanced 1687a7e14dcfSSatish Balay 1688a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1689a7e14dcfSSatish Balay @*/ 1690441846f8SBarry Smith PetscErrorCode TaoStepDirectionMonitor(Tao tao, void *ctx) 1691a7e14dcfSSatish Balay { 1692a7e14dcfSSatish Balay PetscErrorCode ierr; 1693d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 1694d393f493SBarry Smith 1695a7e14dcfSSatish Balay PetscFunctionBegin; 1696d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1697a7e14dcfSSatish Balay ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr); 1698a7e14dcfSSatish Balay PetscFunctionReturn(0); 1699a7e14dcfSSatish Balay } 1700a7e14dcfSSatish Balay 1701a7e14dcfSSatish Balay #undef __FUNCT__ 1702a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawSolutionMonitor" 1703a7e14dcfSSatish Balay /*@C 1704a7e14dcfSSatish Balay TaoDrawSolutionMonitor - Plots the solution at each iteration 1705a7e14dcfSSatish Balay It can be turned on from the command line using the 1706a7e14dcfSSatish Balay -tao_draw_solution option 1707a7e14dcfSSatish Balay 1708441846f8SBarry Smith Collective on Tao 1709a7e14dcfSSatish Balay 1710a7e14dcfSSatish Balay Input Parameters: 1711441846f8SBarry Smith + tao - the Tao context 1712f55353a2SBarry Smith - ctx - PetscViewer context 1713a7e14dcfSSatish Balay 1714a7e14dcfSSatish Balay Options Database Keys: 1715a7e14dcfSSatish Balay . -tao_draw_solution 1716a7e14dcfSSatish Balay 1717a7e14dcfSSatish Balay Level: advanced 1718a7e14dcfSSatish Balay 1719a7e14dcfSSatish Balay .seealso: TaoSolutionMonitor(), TaoSetMonitor(), TaoDrawGradientMonitor 1720a7e14dcfSSatish Balay @*/ 1721441846f8SBarry Smith PetscErrorCode TaoDrawSolutionMonitor(Tao tao, void *ctx) 1722a7e14dcfSSatish Balay { 1723a7e14dcfSSatish Balay PetscErrorCode ierr; 1724a7e14dcfSSatish Balay PetscViewer viewer = (PetscViewer) ctx; 172547a47007SBarry Smith 1726a7e14dcfSSatish Balay PetscFunctionBegin; 1727d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1728a7e14dcfSSatish Balay ierr = VecView(tao->solution, viewer);CHKERRQ(ierr); 1729a7e14dcfSSatish Balay PetscFunctionReturn(0); 1730a7e14dcfSSatish Balay } 1731a7e14dcfSSatish Balay 1732a7e14dcfSSatish Balay #undef __FUNCT__ 1733a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawGradientMonitor" 1734a7e14dcfSSatish Balay /*@C 1735a7e14dcfSSatish Balay TaoDrawGradientMonitor - Plots the gradient at each iteration 1736a7e14dcfSSatish Balay It can be turned on from the command line using the 1737a7e14dcfSSatish Balay -tao_draw_gradient option 1738a7e14dcfSSatish Balay 1739441846f8SBarry Smith Collective on Tao 1740a7e14dcfSSatish Balay 1741a7e14dcfSSatish Balay Input Parameters: 1742441846f8SBarry Smith + tao - the Tao context 1743f55353a2SBarry Smith - ctx - PetscViewer context 1744a7e14dcfSSatish Balay 1745a7e14dcfSSatish Balay Options Database Keys: 1746a7e14dcfSSatish Balay . -tao_draw_gradient 1747a7e14dcfSSatish Balay 1748a7e14dcfSSatish Balay Level: advanced 1749a7e14dcfSSatish Balay 1750a7e14dcfSSatish Balay .seealso: TaoGradientMonitor(), TaoSetMonitor(), TaoDrawSolutionMonitor 1751a7e14dcfSSatish Balay @*/ 1752441846f8SBarry Smith PetscErrorCode TaoDrawGradientMonitor(Tao tao, void *ctx) 1753a7e14dcfSSatish Balay { 1754a7e14dcfSSatish Balay PetscErrorCode ierr; 1755a7e14dcfSSatish Balay PetscViewer viewer = (PetscViewer)ctx; 175647a47007SBarry Smith 1757a7e14dcfSSatish Balay PetscFunctionBegin; 1758d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1759a7e14dcfSSatish Balay ierr = VecView(tao->gradient, viewer);CHKERRQ(ierr); 1760a7e14dcfSSatish Balay PetscFunctionReturn(0); 1761a7e14dcfSSatish Balay } 1762a7e14dcfSSatish Balay 1763a7e14dcfSSatish Balay #undef __FUNCT__ 1764a7e14dcfSSatish Balay #define __FUNCT__ "TaoDrawStepMonitor" 1765a7e14dcfSSatish Balay /*@C 1766a7e14dcfSSatish Balay TaoDrawStepMonitor - Plots the step direction at each iteration 1767a7e14dcfSSatish Balay It can be turned on from the command line using the 1768a7e14dcfSSatish Balay -tao_draw_step option 1769a7e14dcfSSatish Balay 1770441846f8SBarry Smith Collective on Tao 1771a7e14dcfSSatish Balay 1772a7e14dcfSSatish Balay Input Parameters: 1773441846f8SBarry Smith + tao - the Tao context 1774f55353a2SBarry Smith - ctx - PetscViewer context 1775a7e14dcfSSatish Balay 1776a7e14dcfSSatish Balay Options Database Keys: 1777a7e14dcfSSatish Balay . -tao_draw_step 1778a7e14dcfSSatish Balay 1779a7e14dcfSSatish Balay Level: advanced 1780a7e14dcfSSatish Balay 1781a7e14dcfSSatish Balay .seealso: TaoSetMonitor(), TaoDrawSolutionMonitor 1782a7e14dcfSSatish Balay @*/ 1783441846f8SBarry Smith PetscErrorCode TaoDrawStepMonitor(Tao tao, void *ctx) 1784a7e14dcfSSatish Balay { 1785a7e14dcfSSatish Balay PetscErrorCode ierr; 1786a7e14dcfSSatish Balay PetscViewer viewer = (PetscViewer)(ctx); 178747a47007SBarry Smith 1788a7e14dcfSSatish Balay PetscFunctionBegin; 1789a7e14dcfSSatish Balay ierr = VecView(tao->stepdirection, viewer);CHKERRQ(ierr); 1790a7e14dcfSSatish Balay PetscFunctionReturn(0); 1791a7e14dcfSSatish Balay } 1792a7e14dcfSSatish Balay 1793a7e14dcfSSatish Balay #undef __FUNCT__ 1794a7e14dcfSSatish Balay #define __FUNCT__ "TaoSeparableObjectiveMonitor" 1795a7e14dcfSSatish Balay /*@C 1796a7e14dcfSSatish Balay TaoSeparableObjectiveMonitor - Views the separable objective function at each iteration 1797a7e14dcfSSatish Balay It can be turned on from the command line using the 1798a7e14dcfSSatish Balay -tao_view_separableobjective option 1799a7e14dcfSSatish Balay 1800441846f8SBarry Smith Collective on Tao 1801a7e14dcfSSatish Balay 1802a7e14dcfSSatish Balay Input Parameters: 1803441846f8SBarry Smith + tao - the Tao context 180447a47007SBarry Smith - ctx - PetscViewer context or NULL 1805a7e14dcfSSatish Balay 1806a7e14dcfSSatish Balay Options Database Keys: 1807a7e14dcfSSatish Balay . -tao_view_separableobjective 1808a7e14dcfSSatish Balay 1809a7e14dcfSSatish Balay Level: advanced 1810a7e14dcfSSatish Balay 1811a7e14dcfSSatish Balay .seealso: TaoDefaultSMonitor(), TaoSetMonitor() 1812a7e14dcfSSatish Balay @*/ 1813441846f8SBarry Smith PetscErrorCode TaoSeparableObjectiveMonitor(Tao tao, void *ctx) 1814a7e14dcfSSatish Balay { 1815a7e14dcfSSatish Balay PetscErrorCode ierr; 1816d393f493SBarry Smith PetscViewer viewer = (PetscViewer)ctx; 181747a47007SBarry Smith 1818a7e14dcfSSatish Balay PetscFunctionBegin; 1819d393f493SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 1820a7e14dcfSSatish Balay ierr = VecView(tao->sep_objective,viewer);CHKERRQ(ierr); 1821a7e14dcfSSatish Balay PetscFunctionReturn(0); 1822a7e14dcfSSatish Balay } 1823a7e14dcfSSatish Balay 1824a7e14dcfSSatish Balay #undef __FUNCT__ 1825a7e14dcfSSatish Balay #define __FUNCT__ "TaoDefaultConvergenceTest" 18267fab98ebSJason Sarich /*@ 1827a7e14dcfSSatish Balay TaoDefaultConvergenceTest - Determines whether the solver should continue iterating 1828a7e14dcfSSatish Balay or terminate. 1829a7e14dcfSSatish Balay 1830441846f8SBarry Smith Collective on Tao 1831a7e14dcfSSatish Balay 1832a7e14dcfSSatish Balay Input Parameters: 1833441846f8SBarry Smith + tao - the Tao context 1834a7e14dcfSSatish Balay - dummy - unused dummy context 1835a7e14dcfSSatish Balay 1836a7e14dcfSSatish Balay Output Parameter: 1837a7e14dcfSSatish Balay . reason - for terminating 1838a7e14dcfSSatish Balay 1839a7e14dcfSSatish Balay Notes: 1840a7e14dcfSSatish Balay This routine checks the residual in the optimality conditions, the 1841a7e14dcfSSatish Balay relative residual in the optimity conditions, the number of function 1842a7e14dcfSSatish Balay evaluations, and the function value to test convergence. Some 1843a7e14dcfSSatish Balay solvers may use different convergence routines. 1844a7e14dcfSSatish Balay 1845a7e14dcfSSatish Balay Level: developer 1846a7e14dcfSSatish Balay 1847e4cb33bbSBarry Smith .seealso: TaoSetTolerances(),TaoGetConvergedReason(),TaoSetConvergedReason() 1848a7e14dcfSSatish Balay @*/ 1849a7e14dcfSSatish Balay 1850441846f8SBarry Smith PetscErrorCode TaoDefaultConvergenceTest(Tao tao,void *dummy) 1851a7e14dcfSSatish Balay { 1852a7e14dcfSSatish Balay PetscInt niter=tao->niter, nfuncs=PetscMax(tao->nfuncs,tao->nfuncgrads); 1853a7e14dcfSSatish Balay PetscInt max_funcs=tao->max_funcs; 1854a7e14dcfSSatish Balay PetscReal gnorm=tao->residual, gnorm0=tao->gnorm0; 1855a7e14dcfSSatish Balay PetscReal f=tao->fc, steptol=tao->steptol,trradius=tao->step; 1856a7e14dcfSSatish Balay PetscReal gatol=tao->gatol,grtol=tao->grtol,gttol=tao->gttol; 1857e52336cbSBarry Smith PetscReal catol=tao->catol,crtol=tao->crtol; 1858e52336cbSBarry Smith PetscReal fmin=tao->fmin, cnorm=tao->cnorm; 1859e4cb33bbSBarry Smith TaoConvergedReason reason=tao->reason; 1860a7e14dcfSSatish Balay PetscErrorCode ierr; 1861a7e14dcfSSatish Balay 1862a7e14dcfSSatish Balay PetscFunctionBegin; 1863441846f8SBarry Smith PetscValidHeaderSpecific(tao, TAO_CLASSID,1); 1864a7e14dcfSSatish Balay if (reason != TAO_CONTINUE_ITERATING) { 1865a7e14dcfSSatish Balay PetscFunctionReturn(0); 1866a7e14dcfSSatish Balay } 1867a7e14dcfSSatish Balay 1868a7e14dcfSSatish Balay if (PetscIsInfOrNanReal(f)) { 1869a7e14dcfSSatish Balay ierr = PetscInfo(tao,"Failed to converged, function value is Inf or NaN\n");CHKERRQ(ierr); 1870a7e14dcfSSatish Balay reason = TAO_DIVERGED_NAN; 1871a7e14dcfSSatish Balay } else if (f <= fmin && cnorm <=catol) { 187247a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to function value %g < minimum function value %g\n", (double)f,(double)fmin);CHKERRQ(ierr); 1873a7e14dcfSSatish Balay reason = TAO_CONVERGED_MINF; 1874a7e14dcfSSatish Balay } else if (gnorm<= gatol && cnorm <=catol) { 187547a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to residual norm ||g(X)||=%g < %g\n",(double)gnorm,(double)gatol);CHKERRQ(ierr); 1876a7e14dcfSSatish Balay reason = TAO_CONVERGED_GATOL; 1877a7e14dcfSSatish Balay } else if ( f!=0 && PetscAbsReal(gnorm/f) <= grtol && cnorm <= crtol) { 187847a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to residual ||g(X)||/|f(X)| =%g < %g\n",(double)(gnorm/f),(double)grtol);CHKERRQ(ierr); 1879a7e14dcfSSatish Balay reason = TAO_CONVERGED_GRTOL; 1880e1d16bb9SBarry Smith } else if (gnorm0 != 0 && ((gttol == 0 && gnorm == 0) || gnorm/gnorm0 < gttol) && cnorm <= crtol) { 188147a47007SBarry Smith ierr = PetscInfo2(tao,"Converged due to relative residual norm ||g(X)||/||g(X0)|| = %g < %g\n",(double)(gnorm/gnorm0),(double)gttol);CHKERRQ(ierr); 1882a7e14dcfSSatish Balay reason = TAO_CONVERGED_GTTOL; 1883a7e14dcfSSatish Balay } else if (nfuncs > max_funcs){ 1884a7e14dcfSSatish Balay ierr = PetscInfo2(tao,"Exceeded maximum number of function evaluations: %D > %D\n", nfuncs,max_funcs);CHKERRQ(ierr); 1885a7e14dcfSSatish Balay reason = TAO_DIVERGED_MAXFCN; 1886a7e14dcfSSatish Balay } else if ( tao->lsflag != 0 ){ 1887a7e14dcfSSatish Balay ierr = PetscInfo(tao,"Tao Line Search failure.\n");CHKERRQ(ierr); 1888a7e14dcfSSatish Balay reason = TAO_DIVERGED_LS_FAILURE; 1889a7e14dcfSSatish Balay } else if (trradius < steptol && niter > 0){ 189047a47007SBarry Smith ierr = PetscInfo2(tao,"Trust region/step size too small: %g < %g\n", (double)trradius,(double)steptol);CHKERRQ(ierr); 1891a7e14dcfSSatish Balay reason = TAO_CONVERGED_STEPTOL; 1892a7e14dcfSSatish Balay } else if (niter > tao->max_it) { 1893a7e14dcfSSatish Balay ierr = PetscInfo2(tao,"Exceeded maximum number of iterations: %D > %D\n",niter,tao->max_it);CHKERRQ(ierr); 1894a7e14dcfSSatish Balay reason = TAO_DIVERGED_MAXITS; 1895a7e14dcfSSatish Balay } else { 1896a7e14dcfSSatish Balay reason = TAO_CONTINUE_ITERATING; 1897a7e14dcfSSatish Balay } 1898a7e14dcfSSatish Balay tao->reason = reason; 1899a7e14dcfSSatish Balay PetscFunctionReturn(0); 1900a7e14dcfSSatish Balay } 1901a7e14dcfSSatish Balay 1902a7e14dcfSSatish Balay #undef __FUNCT__ 1903a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetOptionsPrefix" 1904a7e14dcfSSatish Balay /*@C 1905a7e14dcfSSatish Balay TaoSetOptionsPrefix - Sets the prefix used for searching for all 1906a7e14dcfSSatish Balay TAO options in the database. 1907a7e14dcfSSatish Balay 1908a7e14dcfSSatish Balay 1909441846f8SBarry Smith Logically Collective on Tao 1910a7e14dcfSSatish Balay 1911a7e14dcfSSatish Balay Input Parameters: 1912441846f8SBarry Smith + tao - the Tao context 1913a7e14dcfSSatish Balay - prefix - the prefix string to prepend to all TAO option requests 1914a7e14dcfSSatish Balay 1915a7e14dcfSSatish Balay Notes: 1916a7e14dcfSSatish Balay A hyphen (-) must NOT be given at the beginning of the prefix name. 1917a7e14dcfSSatish Balay The first character of all runtime options is AUTOMATICALLY the hyphen. 1918a7e14dcfSSatish Balay 1919a7e14dcfSSatish Balay For example, to distinguish between the runtime options for two 1920a7e14dcfSSatish Balay different TAO solvers, one could call 1921a7e14dcfSSatish Balay .vb 1922a7e14dcfSSatish Balay TaoSetOptionsPrefix(tao1,"sys1_") 1923a7e14dcfSSatish Balay TaoSetOptionsPrefix(tao2,"sys2_") 1924a7e14dcfSSatish Balay .ve 1925a7e14dcfSSatish Balay 1926a7e14dcfSSatish Balay This would enable use of different options for each system, such as 1927a7e14dcfSSatish Balay .vb 1928a7e14dcfSSatish Balay -sys1_tao_method blmvm -sys1_tao_gtol 1.e-3 1929a7e14dcfSSatish Balay -sys2_tao_method lmvm -sys2_tao_gtol 1.e-4 1930a7e14dcfSSatish Balay .ve 1931a7e14dcfSSatish Balay 1932a7e14dcfSSatish Balay 1933a7e14dcfSSatish Balay Level: advanced 1934a7e14dcfSSatish Balay 1935a7e14dcfSSatish Balay .seealso: TaoAppendOptionsPrefix(), TaoGetOptionsPrefix() 1936a7e14dcfSSatish Balay @*/ 1937a7e14dcfSSatish Balay 1938441846f8SBarry Smith PetscErrorCode TaoSetOptionsPrefix(Tao tao, const char p[]) 1939a7e14dcfSSatish Balay { 1940a7e14dcfSSatish Balay PetscErrorCode ierr; 194147a47007SBarry Smith 1942a7e14dcfSSatish Balay PetscFunctionBegin; 1943a7e14dcfSSatish Balay ierr = PetscObjectSetOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr); 1944a7e14dcfSSatish Balay if (tao->linesearch) { 1945a7e14dcfSSatish Balay ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr); 1946a7e14dcfSSatish Balay } 1947a7e14dcfSSatish Balay if (tao->ksp) { 1948a7e14dcfSSatish Balay ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr); 1949a7e14dcfSSatish Balay } 1950a7e14dcfSSatish Balay PetscFunctionReturn(0); 1951a7e14dcfSSatish Balay } 1952a7e14dcfSSatish Balay 1953a7e14dcfSSatish Balay #undef __FUNCT__ 1954a7e14dcfSSatish Balay #define __FUNCT__ "TaoAppendOptionsPrefix" 1955a7e14dcfSSatish Balay /*@C 1956a7e14dcfSSatish Balay TaoAppendOptionsPrefix - Appends to the prefix used for searching for all 1957a7e14dcfSSatish Balay TAO options in the database. 1958a7e14dcfSSatish Balay 1959a7e14dcfSSatish Balay 1960441846f8SBarry Smith Logically Collective on Tao 1961a7e14dcfSSatish Balay 1962a7e14dcfSSatish Balay Input Parameters: 1963441846f8SBarry Smith + tao - the Tao solver context 1964a7e14dcfSSatish Balay - prefix - the prefix string to prepend to all TAO option requests 1965a7e14dcfSSatish Balay 1966a7e14dcfSSatish Balay Notes: 1967a7e14dcfSSatish Balay A hyphen (-) must NOT be given at the beginning of the prefix name. 1968a7e14dcfSSatish Balay The first character of all runtime options is AUTOMATICALLY the hyphen. 1969a7e14dcfSSatish Balay 1970a7e14dcfSSatish Balay 1971a7e14dcfSSatish Balay Level: advanced 1972a7e14dcfSSatish Balay 1973a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoGetOptionsPrefix() 1974a7e14dcfSSatish Balay @*/ 1975441846f8SBarry Smith PetscErrorCode TaoAppendOptionsPrefix(Tao tao, const char p[]) 1976a7e14dcfSSatish Balay { 1977a7e14dcfSSatish Balay PetscErrorCode ierr; 197847a47007SBarry Smith 1979a7e14dcfSSatish Balay PetscFunctionBegin; 1980a7e14dcfSSatish Balay ierr = PetscObjectAppendOptionsPrefix((PetscObject)tao,p);CHKERRQ(ierr); 1981a7e14dcfSSatish Balay if (tao->linesearch) { 1982a7e14dcfSSatish Balay ierr = TaoLineSearchSetOptionsPrefix(tao->linesearch,p);CHKERRQ(ierr); 1983a7e14dcfSSatish Balay } 1984a7e14dcfSSatish Balay if (tao->ksp) { 1985a7e14dcfSSatish Balay ierr = KSPSetOptionsPrefix(tao->ksp,p);CHKERRQ(ierr); 1986a7e14dcfSSatish Balay } 1987a7e14dcfSSatish Balay PetscFunctionReturn(0); 1988a7e14dcfSSatish Balay } 1989a7e14dcfSSatish Balay 1990a7e14dcfSSatish Balay #undef __FUNCT__ 1991a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetOptionsPrefix" 1992a7e14dcfSSatish Balay /*@C 1993a7e14dcfSSatish Balay TaoGetOptionsPrefix - Gets the prefix used for searching for all 1994a7e14dcfSSatish Balay TAO options in the database 1995a7e14dcfSSatish Balay 1996a7e14dcfSSatish Balay Not Collective 1997a7e14dcfSSatish Balay 1998a7e14dcfSSatish Balay Input Parameters: 1999441846f8SBarry Smith . tao - the Tao context 2000a7e14dcfSSatish Balay 2001a7e14dcfSSatish Balay Output Parameters: 2002a7e14dcfSSatish Balay . prefix - pointer to the prefix string used is returned 2003a7e14dcfSSatish Balay 2004a7e14dcfSSatish Balay Notes: On the fortran side, the user should pass in a string 'prefix' of 2005a7e14dcfSSatish Balay sufficient length to hold the prefix. 2006a7e14dcfSSatish Balay 2007a7e14dcfSSatish Balay Level: advanced 2008a7e14dcfSSatish Balay 2009a7e14dcfSSatish Balay .seealso: TaoSetOptionsPrefix(), TaoAppendOptionsPrefix() 2010a7e14dcfSSatish Balay @*/ 2011441846f8SBarry Smith PetscErrorCode TaoGetOptionsPrefix(Tao tao, const char *p[]) 2012a7e14dcfSSatish Balay { 201347a47007SBarry Smith return PetscObjectGetOptionsPrefix((PetscObject)tao,p); 2014a7e14dcfSSatish Balay } 2015a7e14dcfSSatish Balay 2016a7e14dcfSSatish Balay #undef __FUNCT__ 2017a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetType" 2018a7e14dcfSSatish Balay /*@C 2019a7e14dcfSSatish Balay TaoSetType - Sets the method for the unconstrained minimization solver. 2020a7e14dcfSSatish Balay 2021441846f8SBarry Smith Collective on Tao 2022a7e14dcfSSatish Balay 2023a7e14dcfSSatish Balay Input Parameters: 2024441846f8SBarry Smith + solver - the Tao solver context 2025a7e14dcfSSatish Balay - type - a known method 2026a7e14dcfSSatish Balay 2027a7e14dcfSSatish Balay Options Database Key: 202858417fe7SBarry Smith . -tao_type <type> - Sets the method; use -help for a list 202958417fe7SBarry Smith of available methods (for instance, "-tao_type lmvm" or "-tao_type tron") 2030a7e14dcfSSatish Balay 2031a7e14dcfSSatish Balay Available methods include: 203258417fe7SBarry Smith + nls - Newton's method with line search for unconstrained minimization 203358417fe7SBarry Smith . ntr - Newton's method with trust region for unconstrained minimization 203458417fe7SBarry Smith . ntl - Newton's method with trust region, line search for unconstrained minimization 203558417fe7SBarry Smith . lmvm - Limited memory variable metric method for unconstrained minimization 203658417fe7SBarry Smith . cg - Nonlinear conjugate gradient method for unconstrained minimization 203758417fe7SBarry Smith . nm - Nelder-Mead algorithm for derivate-free unconstrained minimization 203858417fe7SBarry Smith . tron - Newton Trust Region method for bound constrained minimization 203958417fe7SBarry Smith . gpcg - Newton Trust Region method for quadratic bound constrained minimization 204058417fe7SBarry Smith . blmvm - Limited memory variable metric method for bound constrained minimization 20411eb8069cSJason Sarich - pounders - Model-based algorithm pounder extended for nonlinear least squares 2042a7e14dcfSSatish Balay 2043a7e14dcfSSatish Balay Level: intermediate 2044a7e14dcfSSatish Balay 20451eb8069cSJason Sarich .seealso: TaoCreate(), TaoGetType(), TaoType 2046a7e14dcfSSatish Balay 2047a7e14dcfSSatish Balay @*/ 2048441846f8SBarry Smith PetscErrorCode TaoSetType(Tao tao, const TaoType type) 2049a7e14dcfSSatish Balay { 2050a7e14dcfSSatish Balay PetscErrorCode ierr; 2051441846f8SBarry Smith PetscErrorCode (*create_xxx)(Tao); 2052a7e14dcfSSatish Balay PetscBool issame; 2053a7e14dcfSSatish Balay 2054a7e14dcfSSatish Balay PetscFunctionBegin; 2055441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2056a7e14dcfSSatish Balay 2057a7e14dcfSSatish Balay ierr = PetscObjectTypeCompare((PetscObject)tao,type,&issame);CHKERRQ(ierr); 2058a7e14dcfSSatish Balay if (issame) PetscFunctionReturn(0); 2059a7e14dcfSSatish Balay 2060441846f8SBarry Smith ierr = PetscFunctionListFind(TaoList, type, (void(**)(void))&create_xxx);CHKERRQ(ierr); 2061441846f8SBarry Smith if (!create_xxx) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested Tao type %s",type); 2062a7e14dcfSSatish Balay 2063a7e14dcfSSatish Balay /* Destroy the existing solver information */ 2064a7e14dcfSSatish Balay if (tao->ops->destroy) { 2065a7e14dcfSSatish Balay ierr = (*tao->ops->destroy)(tao);CHKERRQ(ierr); 2066a7e14dcfSSatish Balay } 2067a7e14dcfSSatish Balay ierr = KSPDestroy(&tao->ksp);CHKERRQ(ierr); 2068a7e14dcfSSatish Balay ierr = TaoLineSearchDestroy(&tao->linesearch);CHKERRQ(ierr); 2069a7e14dcfSSatish Balay ierr = VecDestroy(&tao->gradient);CHKERRQ(ierr); 2070a7e14dcfSSatish Balay ierr = VecDestroy(&tao->stepdirection);CHKERRQ(ierr); 2071a7e14dcfSSatish Balay 2072a7e14dcfSSatish Balay tao->ops->setup = 0; 2073a7e14dcfSSatish Balay tao->ops->solve = 0; 2074a7e14dcfSSatish Balay tao->ops->view = 0; 2075a7e14dcfSSatish Balay tao->ops->setfromoptions = 0; 2076a7e14dcfSSatish Balay tao->ops->destroy = 0; 2077a7e14dcfSSatish Balay 2078a7e14dcfSSatish Balay tao->setupcalled = PETSC_FALSE; 2079a7e14dcfSSatish Balay 2080a7e14dcfSSatish Balay ierr = (*create_xxx)(tao);CHKERRQ(ierr); 2081a7e14dcfSSatish Balay ierr = PetscObjectChangeTypeName((PetscObject)tao,type);CHKERRQ(ierr); 2082a7e14dcfSSatish Balay PetscFunctionReturn(0); 2083a7e14dcfSSatish Balay } 208447a47007SBarry Smith 2085a7e14dcfSSatish Balay #undef __FUNCT__ 2086441846f8SBarry Smith #define __FUNCT__ "TaoRegister" 2087a7e14dcfSSatish Balay /*MC 2088441846f8SBarry Smith TaoRegister - Adds a method to the TAO package for unconstrained minimization. 2089a7e14dcfSSatish Balay 2090a7e14dcfSSatish Balay Synopsis: 2091441846f8SBarry Smith TaoRegister(char *name_solver,char *path,char *name_Create,int (*routine_Create)(Tao)) 2092a7e14dcfSSatish Balay 2093a7e14dcfSSatish Balay Not collective 2094a7e14dcfSSatish Balay 2095a7e14dcfSSatish Balay Input Parameters: 2096a7e14dcfSSatish Balay + sname - name of a new user-defined solver 2097a7e14dcfSSatish Balay - func - routine to Create method context 2098a7e14dcfSSatish Balay 2099a7e14dcfSSatish Balay Notes: 2100441846f8SBarry Smith TaoRegister() may be called multiple times to add several user-defined solvers. 2101a7e14dcfSSatish Balay 2102a7e14dcfSSatish Balay Sample usage: 2103a7e14dcfSSatish Balay .vb 2104441846f8SBarry Smith TaoRegister("my_solver",MySolverCreate); 2105a7e14dcfSSatish Balay .ve 2106a7e14dcfSSatish Balay 2107a7e14dcfSSatish Balay Then, your solver can be chosen with the procedural interface via 2108a7e14dcfSSatish Balay $ TaoSetType(tao,"my_solver") 2109a7e14dcfSSatish Balay or at runtime via the option 211058417fe7SBarry Smith $ -tao_type my_solver 2111a7e14dcfSSatish Balay 2112a7e14dcfSSatish Balay Level: advanced 2113a7e14dcfSSatish Balay 2114441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegisterDestroy() 2115a7e14dcfSSatish Balay M*/ 2116441846f8SBarry Smith PetscErrorCode TaoRegister(const char sname[], PetscErrorCode (*func)(Tao)) 2117a7e14dcfSSatish Balay { 2118a7e14dcfSSatish Balay PetscErrorCode ierr; 2119a7e14dcfSSatish Balay 2120a7e14dcfSSatish Balay PetscFunctionBegin; 2121441846f8SBarry Smith ierr = PetscFunctionListAdd(&TaoList,sname, (void (*)(void))func);CHKERRQ(ierr); 2122a7e14dcfSSatish Balay PetscFunctionReturn(0); 2123a7e14dcfSSatish Balay } 2124a7e14dcfSSatish Balay 2125a7e14dcfSSatish Balay #undef __FUNCT__ 2126441846f8SBarry Smith #define __FUNCT__ "TaoRegisterDestroy" 2127a7e14dcfSSatish Balay /*@C 2128441846f8SBarry Smith TaoRegisterDestroy - Frees the list of minimization solvers that were 2129441846f8SBarry Smith registered by TaoRegisterDynamic(). 2130a7e14dcfSSatish Balay 2131a7e14dcfSSatish Balay Not Collective 2132a7e14dcfSSatish Balay 2133a7e14dcfSSatish Balay Level: advanced 2134a7e14dcfSSatish Balay 2135441846f8SBarry Smith .seealso: TaoRegisterAll(), TaoRegister() 2136a7e14dcfSSatish Balay @*/ 2137441846f8SBarry Smith PetscErrorCode TaoRegisterDestroy(void) 2138a7e14dcfSSatish Balay { 2139a7e14dcfSSatish Balay PetscErrorCode ierr; 2140a7e14dcfSSatish Balay PetscFunctionBegin; 2141441846f8SBarry Smith ierr = PetscFunctionListDestroy(&TaoList);CHKERRQ(ierr); 2142441846f8SBarry Smith TaoRegisterAllCalled = PETSC_FALSE; 2143a7e14dcfSSatish Balay PetscFunctionReturn(0); 2144a7e14dcfSSatish Balay } 214547a47007SBarry Smith 2146a7e14dcfSSatish Balay #undef __FUNCT__ 21478931d482SJason Sarich #define __FUNCT__ "TaoGetIterationNumber" 21488931d482SJason Sarich /*@ 21498931d482SJason Sarich TaoGetIterationNumber - Gets the number of Tao iterations completed 21508931d482SJason Sarich at this time. 21518931d482SJason Sarich 21528931d482SJason Sarich Not Collective 21538931d482SJason Sarich 21548931d482SJason Sarich Input Parameter: 21558931d482SJason Sarich . tao - Tao context 21568931d482SJason Sarich 21578931d482SJason Sarich Output Parameter: 21588931d482SJason Sarich . iter - iteration number 21598931d482SJason Sarich 21608931d482SJason Sarich Notes: 21618931d482SJason Sarich For example, during the computation of iteration 2 this would return 1. 21628931d482SJason Sarich 21638931d482SJason Sarich 21648931d482SJason Sarich Level: intermediate 21658931d482SJason Sarich 21668931d482SJason Sarich .keywords: Tao, nonlinear, get, iteration, number, 21678931d482SJason Sarich 21688931d482SJason Sarich .seealso: TaoGetLinearSolveIterations() 21698931d482SJason Sarich @*/ 21708931d482SJason Sarich PetscErrorCode TaoGetIterationNumber(Tao tao,PetscInt *iter) 21718931d482SJason Sarich { 21728931d482SJason Sarich PetscFunctionBegin; 21738931d482SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 21748931d482SJason Sarich PetscValidIntPointer(iter,2); 21758931d482SJason Sarich *iter = tao->niter; 21768931d482SJason Sarich PetscFunctionReturn(0); 21778931d482SJason Sarich } 21788931d482SJason Sarich 21798931d482SJason Sarich #undef __FUNCT__ 21808931d482SJason Sarich #define __FUNCT__ "TaoSetIterationNumber" 21818931d482SJason Sarich /*@ 21828931d482SJason Sarich TaoSetIterationNumber - Sets the current iteration number. 21838931d482SJason Sarich 21848931d482SJason Sarich Not Collective 21858931d482SJason Sarich 21868931d482SJason Sarich Input Parameter: 21878931d482SJason Sarich . tao - Tao context 21888931d482SJason Sarich . iter - iteration number 21898931d482SJason Sarich 21908931d482SJason Sarich Level: developer 21918931d482SJason Sarich 21928931d482SJason Sarich .keywords: Tao, nonlinear, set, iteration, number, 21938931d482SJason Sarich 21948931d482SJason Sarich .seealso: TaoGetLinearSolveIterations() 21958931d482SJason Sarich @*/ 21968931d482SJason Sarich PetscErrorCode TaoSetIterationNumber(Tao tao,PetscInt iter) 21978931d482SJason Sarich { 21988931d482SJason Sarich PetscErrorCode ierr; 21998931d482SJason Sarich 22008931d482SJason Sarich PetscFunctionBegin; 22018931d482SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 22028931d482SJason Sarich ierr = PetscObjectSAWsTakeAccess((PetscObject)tao);CHKERRQ(ierr); 22038931d482SJason Sarich tao->niter = iter; 22048931d482SJason Sarich ierr = PetscObjectSAWsGrantAccess((PetscObject)tao);CHKERRQ(ierr); 22058931d482SJason Sarich PetscFunctionReturn(0); 22068931d482SJason Sarich } 22078931d482SJason Sarich 22088931d482SJason Sarich #undef __FUNCT__ 22098931d482SJason Sarich #define __FUNCT__ "TaoGetTotalIterationNumber" 22108931d482SJason Sarich /*@ 22118931d482SJason Sarich TaoGetTotalIterationNumber - Gets the total number of Tao iterations 22128931d482SJason Sarich completed. This number keeps accumulating if multiple solves 22138931d482SJason Sarich are called with the Tao object. 22148931d482SJason Sarich 22158931d482SJason Sarich Not Collective 22168931d482SJason Sarich 22178931d482SJason Sarich Input Parameter: 22188931d482SJason Sarich . tao - Tao context 22198931d482SJason Sarich 22208931d482SJason Sarich Output Parameter: 22218931d482SJason Sarich . iter - iteration number 22228931d482SJason Sarich 22238931d482SJason Sarich Notes: 22248931d482SJason Sarich The total iteration count is updated after each solve, if there is a current 22258931d482SJason Sarich TaoSolve() in progress then those iterations are not yet counted. 22268931d482SJason Sarich 22278931d482SJason Sarich Level: intermediate 22288931d482SJason Sarich 22298931d482SJason Sarich .keywords: Tao, nonlinear, get, iteration, number, 22308931d482SJason Sarich 22318931d482SJason Sarich .seealso: TaoGetLinearSolveIterations() 22328931d482SJason Sarich @*/ 22338931d482SJason Sarich PetscErrorCode TaoGetTotalIterationNumber(Tao tao,PetscInt *iter) 22348931d482SJason Sarich { 22358931d482SJason Sarich PetscFunctionBegin; 22368931d482SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 22378931d482SJason Sarich PetscValidIntPointer(iter,2); 22388931d482SJason Sarich *iter = tao->ntotalits; 22398931d482SJason Sarich PetscFunctionReturn(0); 22408931d482SJason Sarich } 22418931d482SJason Sarich 22428931d482SJason Sarich #undef __FUNCT__ 22438931d482SJason Sarich #define __FUNCT__ "TaoSetTotalIterationNumber" 22448931d482SJason Sarich /*@ 22458931d482SJason Sarich TaoSetTotalIterationNumber - Sets the current total iteration number. 22468931d482SJason Sarich 22478931d482SJason Sarich Not Collective 22488931d482SJason Sarich 22498931d482SJason Sarich Input Parameter: 22508931d482SJason Sarich . tao - Tao context 22518931d482SJason Sarich . iter - iteration number 22528931d482SJason Sarich 22538931d482SJason Sarich Level: developer 22548931d482SJason Sarich 22558931d482SJason Sarich .keywords: Tao, nonlinear, set, iteration, number, 22568931d482SJason Sarich 22578931d482SJason Sarich .seealso: TaoGetLinearSolveIterations() 22588931d482SJason Sarich @*/ 22598931d482SJason Sarich PetscErrorCode TaoSetTotalIterationNumber(Tao tao,PetscInt iter) 22608931d482SJason Sarich { 22618931d482SJason Sarich PetscErrorCode ierr; 22628931d482SJason Sarich 22638931d482SJason Sarich PetscFunctionBegin; 22648931d482SJason Sarich PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 22658931d482SJason Sarich ierr = PetscObjectSAWsTakeAccess((PetscObject)tao);CHKERRQ(ierr); 22668931d482SJason Sarich tao->ntotalits = iter; 22678931d482SJason Sarich ierr = PetscObjectSAWsGrantAccess((PetscObject)tao);CHKERRQ(ierr); 22688931d482SJason Sarich PetscFunctionReturn(0); 22698931d482SJason Sarich } 22708931d482SJason Sarich 22718931d482SJason Sarich #undef __FUNCT__ 2272e4cb33bbSBarry Smith #define __FUNCT__ "TaoSetConvergedReason" 2273a7e14dcfSSatish Balay /*@ 2274e4cb33bbSBarry Smith TaoSetConvergedReason - Sets the termination flag on a Tao object 2275a7e14dcfSSatish Balay 2276441846f8SBarry Smith Logically Collective on Tao 2277a7e14dcfSSatish Balay 2278a7e14dcfSSatish Balay Input Parameters: 2279441846f8SBarry Smith + tao - the Tao context 2280a7e14dcfSSatish Balay - reason - one of 2281a7e14dcfSSatish Balay $ TAO_CONVERGED_ATOL (2), 2282a7e14dcfSSatish Balay $ TAO_CONVERGED_RTOL (3), 2283a7e14dcfSSatish Balay $ TAO_CONVERGED_STEPTOL (4), 2284a7e14dcfSSatish Balay $ TAO_CONVERGED_MINF (5), 2285a7e14dcfSSatish Balay $ TAO_CONVERGED_USER (6), 2286a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXITS (-2), 2287a7e14dcfSSatish Balay $ TAO_DIVERGED_NAN (-4), 2288a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXFCN (-5), 2289a7e14dcfSSatish Balay $ TAO_DIVERGED_LS_FAILURE (-6), 2290a7e14dcfSSatish Balay $ TAO_DIVERGED_TR_REDUCTION (-7), 2291a7e14dcfSSatish Balay $ TAO_DIVERGED_USER (-8), 2292a7e14dcfSSatish Balay $ TAO_CONTINUE_ITERATING (0) 2293a7e14dcfSSatish Balay 2294a7e14dcfSSatish Balay Level: intermediate 2295a7e14dcfSSatish Balay 2296a7e14dcfSSatish Balay @*/ 2297e4cb33bbSBarry Smith PetscErrorCode TaoSetConvergedReason(Tao tao, TaoConvergedReason reason) 2298a7e14dcfSSatish Balay { 2299441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2300a7e14dcfSSatish Balay PetscFunctionBegin; 2301a7e14dcfSSatish Balay tao->reason = reason; 2302a7e14dcfSSatish Balay PetscFunctionReturn(0); 2303a7e14dcfSSatish Balay } 2304a7e14dcfSSatish Balay 2305a7e14dcfSSatish Balay #undef __FUNCT__ 2306e4cb33bbSBarry Smith #define __FUNCT__ "TaoGetConvergedReason" 2307a7e14dcfSSatish Balay /*@ 2308e4cb33bbSBarry Smith TaoGetConvergedReason - Gets the reason the Tao iteration was stopped. 2309a7e14dcfSSatish Balay 2310a7e14dcfSSatish Balay Not Collective 2311a7e14dcfSSatish Balay 2312a7e14dcfSSatish Balay Input Parameter: 2313441846f8SBarry Smith . tao - the Tao solver context 2314a7e14dcfSSatish Balay 2315a7e14dcfSSatish Balay Output Parameter: 2316a7e14dcfSSatish Balay . reason - one of 2317a7e14dcfSSatish Balay $ TAO_CONVERGED_GATOL (3) ||g(X)|| < gatol 2318a7e14dcfSSatish Balay $ TAO_CONVERGED_GRTOL (4) ||g(X)|| / f(X) < grtol 2319a7e14dcfSSatish Balay $ TAO_CONVERGED_GTTOL (5) ||g(X)|| / ||g(X0)|| < gttol 2320a7e14dcfSSatish Balay $ TAO_CONVERGED_STEPTOL (6) step size small 2321a7e14dcfSSatish Balay $ TAO_CONVERGED_MINF (7) F < F_min 2322a7e14dcfSSatish Balay $ TAO_CONVERGED_USER (8) User defined 2323a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXITS (-2) its > maxits 2324a7e14dcfSSatish Balay $ TAO_DIVERGED_NAN (-4) Numerical problems 2325a7e14dcfSSatish Balay $ TAO_DIVERGED_MAXFCN (-5) fevals > max_funcsals 2326a7e14dcfSSatish Balay $ TAO_DIVERGED_LS_FAILURE (-6) line search failure 2327a7e14dcfSSatish Balay $ TAO_DIVERGED_TR_REDUCTION (-7) trust region failure 2328a7e14dcfSSatish Balay $ TAO_DIVERGED_USER(-8) (user defined) 2329a7e14dcfSSatish Balay $ TAO_CONTINUE_ITERATING (0) 2330a7e14dcfSSatish Balay 2331a7e14dcfSSatish Balay where 2332a7e14dcfSSatish Balay + X - current solution 2333a7e14dcfSSatish Balay . X0 - initial guess 2334a7e14dcfSSatish Balay . f(X) - current function value 2335a7e14dcfSSatish Balay . f(X*) - true solution (estimated) 2336a7e14dcfSSatish Balay . g(X) - current gradient 2337a7e14dcfSSatish Balay . its - current iterate number 2338a7e14dcfSSatish Balay . maxits - maximum number of iterates 2339a7e14dcfSSatish Balay . fevals - number of function evaluations 2340a7e14dcfSSatish Balay - max_funcsals - maximum number of function evaluations 2341a7e14dcfSSatish Balay 2342a7e14dcfSSatish Balay Level: intermediate 2343a7e14dcfSSatish Balay 2344a7e14dcfSSatish Balay .seealso: TaoSetConvergenceTest(), TaoSetTolerances() 2345a7e14dcfSSatish Balay 2346a7e14dcfSSatish Balay @*/ 2347e4cb33bbSBarry Smith PetscErrorCode TaoGetConvergedReason(Tao tao, TaoConvergedReason *reason) 2348a7e14dcfSSatish Balay { 2349a7e14dcfSSatish Balay PetscFunctionBegin; 2350441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2351a7e14dcfSSatish Balay PetscValidPointer(reason,2); 2352a7e14dcfSSatish Balay *reason = tao->reason; 2353a7e14dcfSSatish Balay PetscFunctionReturn(0); 2354a7e14dcfSSatish Balay } 2355a7e14dcfSSatish Balay 2356a7e14dcfSSatish Balay #undef __FUNCT__ 2357a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetSolutionStatus" 2358a7e14dcfSSatish Balay /*@ 2359a7e14dcfSSatish Balay TaoGetSolutionStatus - Get the current iterate, objective value, 2360a7e14dcfSSatish Balay residual, infeasibility, and termination 2361a7e14dcfSSatish Balay 2362a7e14dcfSSatish Balay Not Collective 2363a7e14dcfSSatish Balay 2364a7e14dcfSSatish Balay Input Parameters: 2365441846f8SBarry Smith . tao - the Tao context 2366a7e14dcfSSatish Balay 2367a7e14dcfSSatish Balay Output Parameters: 2368a7e14dcfSSatish Balay + iterate - the current iterate number (>=0) 2369a7e14dcfSSatish Balay . f - the current function value 237058417fe7SBarry Smith . gnorm - the square of the gradient norm, duality gap, or other measure indicating distance from optimality. 2371a7e14dcfSSatish Balay . cnorm - the infeasibility of the current solution with regard to the constraints. 2372a7e14dcfSSatish Balay . xdiff - the step length or trust region radius of the most recent iterate. 2373a7e14dcfSSatish Balay - reason - The termination reason, which can equal TAO_CONTINUE_ITERATING 2374a7e14dcfSSatish Balay 2375a7e14dcfSSatish Balay Level: intermediate 2376a7e14dcfSSatish Balay 2377a7e14dcfSSatish Balay Note: 2378a7e14dcfSSatish Balay TAO returns the values set by the solvers in the routine TaoMonitor(). 2379a7e14dcfSSatish Balay 2380a7e14dcfSSatish Balay Note: 238147a47007SBarry Smith If any of the output arguments are set to NULL, no corresponding value will be returned. 2382a7e14dcfSSatish Balay 2383e4cb33bbSBarry Smith .seealso: TaoMonitor(), TaoGetConvergedReason() 2384a7e14dcfSSatish Balay @*/ 2385e4cb33bbSBarry Smith PetscErrorCode TaoGetSolutionStatus(Tao tao, PetscInt *its, PetscReal *f, PetscReal *gnorm, PetscReal *cnorm, PetscReal *xdiff, TaoConvergedReason *reason) 2386a7e14dcfSSatish Balay { 2387a7e14dcfSSatish Balay PetscFunctionBegin; 2388a7e14dcfSSatish Balay if (its) *its=tao->niter; 2389a7e14dcfSSatish Balay if (f) *f=tao->fc; 2390a7e14dcfSSatish Balay if (gnorm) *gnorm=tao->residual; 2391a7e14dcfSSatish Balay if (cnorm) *cnorm=tao->cnorm; 2392a7e14dcfSSatish Balay if (reason) *reason=tao->reason; 2393a7e14dcfSSatish Balay if (xdiff) *xdiff=tao->step; 2394a7e14dcfSSatish Balay PetscFunctionReturn(0); 2395a7e14dcfSSatish Balay } 2396a7e14dcfSSatish Balay 2397a7e14dcfSSatish Balay #undef __FUNCT__ 2398a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetType" 2399a7e14dcfSSatish Balay /*@C 2400441846f8SBarry Smith TaoGetType - Gets the current Tao algorithm. 2401a7e14dcfSSatish Balay 2402a7e14dcfSSatish Balay Not Collective 2403a7e14dcfSSatish Balay 2404a7e14dcfSSatish Balay Input Parameter: 2405441846f8SBarry Smith . tao - the Tao solver context 2406a7e14dcfSSatish Balay 2407a7e14dcfSSatish Balay Output Parameter: 2408441846f8SBarry Smith . type - Tao method 2409a7e14dcfSSatish Balay 2410a7e14dcfSSatish Balay Level: intermediate 2411a7e14dcfSSatish Balay 2412a7e14dcfSSatish Balay @*/ 2413441846f8SBarry Smith PetscErrorCode TaoGetType(Tao tao, const TaoType *type) 2414a7e14dcfSSatish Balay { 2415a7e14dcfSSatish Balay PetscFunctionBegin; 2416441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2417a7e14dcfSSatish Balay PetscValidPointer(type,2); 2418a7e14dcfSSatish Balay *type=((PetscObject)tao)->type_name; 2419a7e14dcfSSatish Balay PetscFunctionReturn(0); 2420a7e14dcfSSatish Balay } 2421a7e14dcfSSatish Balay 2422a7e14dcfSSatish Balay #undef __FUNCT__ 2423a7e14dcfSSatish Balay #define __FUNCT__ "TaoMonitor" 2424a7e14dcfSSatish Balay /*@C 2425a7e14dcfSSatish Balay TaoMonitor - Monitor the solver and the current solution. This 2426a7e14dcfSSatish Balay routine will record the iteration number and residual statistics, 2427a7e14dcfSSatish Balay call any monitors specified by the user, and calls the convergence-check routine. 2428a7e14dcfSSatish Balay 2429a7e14dcfSSatish Balay Input Parameters: 2430441846f8SBarry Smith + tao - the Tao context 2431a7e14dcfSSatish Balay . its - the current iterate number (>=0) 2432a7e14dcfSSatish Balay . f - the current objective function value 243358417fe7SBarry Smith . res - the gradient norm, square root of the duality gap, or other measure indicating distince from optimality. This measure will be recorded and 2434a7e14dcfSSatish Balay used for some termination tests. 2435a7e14dcfSSatish Balay . cnorm - the infeasibility of the current solution with regard to the constraints. 2436a7e14dcfSSatish Balay - steplength - multiple of the step direction added to the previous iterate. 2437a7e14dcfSSatish Balay 2438a7e14dcfSSatish Balay Output Parameters: 2439a7e14dcfSSatish Balay . reason - The termination reason, which can equal TAO_CONTINUE_ITERATING 2440a7e14dcfSSatish Balay 2441a7e14dcfSSatish Balay Options Database Key: 2442a7e14dcfSSatish Balay . -tao_monitor - Use the default monitor, which prints statistics to standard output 2443a7e14dcfSSatish Balay 2444e4cb33bbSBarry Smith .seealso TaoGetConvergedReason(), TaoDefaultMonitor(), TaoSetMonitor() 2445a7e14dcfSSatish Balay 2446a7e14dcfSSatish Balay Level: developer 2447a7e14dcfSSatish Balay 2448a7e14dcfSSatish Balay @*/ 2449e4cb33bbSBarry Smith PetscErrorCode TaoMonitor(Tao tao, PetscInt its, PetscReal f, PetscReal res, PetscReal cnorm, PetscReal steplength, TaoConvergedReason *reason) 2450a7e14dcfSSatish Balay { 2451a7e14dcfSSatish Balay PetscErrorCode ierr; 245247a47007SBarry Smith PetscInt i; 245347a47007SBarry Smith 2454a7e14dcfSSatish Balay PetscFunctionBegin; 2455441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2456a7e14dcfSSatish Balay tao->fc = f; 2457a7e14dcfSSatish Balay tao->residual = res; 2458a7e14dcfSSatish Balay tao->cnorm = cnorm; 2459a7e14dcfSSatish Balay tao->step = steplength; 2460e52336cbSBarry Smith if (!its) { 2461a7e14dcfSSatish Balay tao->cnorm0 = cnorm; tao->gnorm0 = res; 2462a7e14dcfSSatish Balay } 2463ae93cb3cSJason Sarich TaoLogConvergenceHistory(tao,f,res,cnorm,tao->ksp_its); 246447a47007SBarry Smith if (PetscIsInfOrNanReal(f) || PetscIsInfOrNanReal(res)) SETERRQ(PETSC_COMM_SELF,1, "User provided compute function generated Inf or NaN"); 2465a7e14dcfSSatish Balay if (tao->ops->convergencetest) { 2466a7e14dcfSSatish Balay ierr = (*tao->ops->convergencetest)(tao,tao->cnvP);CHKERRQ(ierr); 2467a7e14dcfSSatish Balay } 2468a7e14dcfSSatish Balay for (i=0;i<tao->numbermonitors;i++) { 2469a7e14dcfSSatish Balay ierr = (*tao->monitor[i])(tao,tao->monitorcontext[i]);CHKERRQ(ierr); 2470a7e14dcfSSatish Balay } 2471a7e14dcfSSatish Balay *reason = tao->reason; 2472a7e14dcfSSatish Balay PetscFunctionReturn(0); 2473a7e14dcfSSatish Balay } 2474a7e14dcfSSatish Balay 2475a7e14dcfSSatish Balay #undef __FUNCT__ 2476ae93cb3cSJason Sarich #define __FUNCT__ "TaoSetConvergenceHistory" 2477a7e14dcfSSatish Balay /*@ 2478ae93cb3cSJason Sarich TaoSetConvergenceHistory - Sets the array used to hold the convergence history. 2479a7e14dcfSSatish Balay 2480441846f8SBarry Smith Logically Collective on Tao 2481a7e14dcfSSatish Balay 2482a7e14dcfSSatish Balay Input Parameters: 2483441846f8SBarry Smith + tao - the Tao solver context 2484a7e14dcfSSatish Balay . obj - array to hold objective value history 2485a7e14dcfSSatish Balay . resid - array to hold residual history 2486a7e14dcfSSatish Balay . cnorm - array to hold constraint violation history 2487be1558d8SJason Sarich . lits - integer array holds the number of linear iterations for each Tao iteration 2488a7e14dcfSSatish Balay . na - size of obj, resid, and cnorm 2489a7e14dcfSSatish Balay - reset - PetscTrue indicates each new minimization resets the history counter to zero, 2490a7e14dcfSSatish Balay else it continues storing new values for new minimizations after the old ones 2491a7e14dcfSSatish Balay 2492a7e14dcfSSatish Balay Notes: 2493a7e14dcfSSatish Balay If set, TAO will fill the given arrays with the indicated 2494ae93cb3cSJason Sarich information at each iteration. If 'obj','resid','cnorm','lits' are 2495ae93cb3cSJason Sarich *all* NULL then space (using size na, or 1000 if na is PETSC_DECIDE or 2496ae93cb3cSJason Sarich PETSC_DEFAULT) is allocated for the history. 2497be1558d8SJason Sarich If not all are NULL, then only the non-NULL information categories 2498ae93cb3cSJason Sarich will be stored, the others will be ignored. 2499ae93cb3cSJason Sarich 2500ae93cb3cSJason Sarich Any convergence information after iteration number 'na' will not be stored. 2501a7e14dcfSSatish Balay 2502a7e14dcfSSatish Balay This routine is useful, e.g., when running a code for purposes 2503a7e14dcfSSatish Balay of accurate performance monitoring, when no I/O should be done 2504a7e14dcfSSatish Balay during the section of code that is being timed. 2505a7e14dcfSSatish Balay 2506a7e14dcfSSatish Balay Level: intermediate 2507a7e14dcfSSatish Balay 2508ae93cb3cSJason Sarich .seealso: TaoGetConvergenceHistory() 2509a7e14dcfSSatish Balay 2510a7e14dcfSSatish Balay @*/ 2511ae93cb3cSJason Sarich PetscErrorCode TaoSetConvergenceHistory(Tao tao, PetscReal *obj, PetscReal *resid, PetscReal *cnorm, PetscInt *lits, PetscInt na,PetscBool reset) 2512a7e14dcfSSatish Balay { 2513ae93cb3cSJason Sarich PetscErrorCode ierr; 2514ae93cb3cSJason Sarich 2515a7e14dcfSSatish Balay PetscFunctionBegin; 2516441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2517ae93cb3cSJason Sarich if (obj) PetscValidScalarPointer(obj,2); 2518ae93cb3cSJason Sarich if (resid) PetscValidScalarPointer(resid,3); 2519ae93cb3cSJason Sarich if (cnorm) PetscValidScalarPointer(cnorm,4); 2520ae93cb3cSJason Sarich if (lits) PetscValidIntPointer(lits,5); 2521ae93cb3cSJason Sarich 2522ae93cb3cSJason Sarich if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000; 2523ae93cb3cSJason Sarich if (!obj && !resid && !cnorm && !lits) { 2524ae93cb3cSJason Sarich ierr = PetscCalloc1(na,&obj);CHKERRQ(ierr); 2525ae93cb3cSJason Sarich ierr = PetscCalloc1(na,&resid);CHKERRQ(ierr); 2526ae93cb3cSJason Sarich ierr = PetscCalloc1(na,&cnorm);CHKERRQ(ierr); 2527ae93cb3cSJason Sarich ierr = PetscCalloc1(na,&lits);CHKERRQ(ierr); 2528ae93cb3cSJason Sarich tao->hist_malloc=PETSC_TRUE; 2529ae93cb3cSJason Sarich } 2530ae93cb3cSJason Sarich 2531a7e14dcfSSatish Balay tao->hist_obj = obj; 2532a7e14dcfSSatish Balay tao->hist_resid = resid; 2533a7e14dcfSSatish Balay tao->hist_cnorm = cnorm; 2534ae93cb3cSJason Sarich tao->hist_lits = lits; 2535a7e14dcfSSatish Balay tao->hist_max = na; 2536a7e14dcfSSatish Balay tao->hist_reset = reset; 2537ae93cb3cSJason Sarich tao->hist_len = 0; 2538a7e14dcfSSatish Balay PetscFunctionReturn(0); 2539a7e14dcfSSatish Balay } 2540a7e14dcfSSatish Balay 2541a7e14dcfSSatish Balay #undef __FUNCT__ 2542ae93cb3cSJason Sarich #define __FUNCT__ "TaoGetConvergenceHistory" 2543a7e14dcfSSatish Balay /*@C 2544ae93cb3cSJason Sarich TaoGetConvergenceHistory - Gets the arrays used to hold the convergence history. 2545a7e14dcfSSatish Balay 2546441846f8SBarry Smith Collective on Tao 2547a7e14dcfSSatish Balay 2548a7e14dcfSSatish Balay Input Parameter: 2549441846f8SBarry Smith . tao - the Tao context 2550a7e14dcfSSatish Balay 2551a7e14dcfSSatish Balay Output Parameters: 2552a7e14dcfSSatish Balay + obj - array used to hold objective value history 2553a7e14dcfSSatish Balay . resid - array used to hold residual history 2554a7e14dcfSSatish Balay . cnorm - array used to hold constraint violation history 2555ae93cb3cSJason Sarich . lits - integer array used to hold linear solver iteration count 2556ae93cb3cSJason Sarich - nhist - size of obj, resid, cnorm, and lits (will be less than or equal to na given in TaoSetHistory) 2557a7e14dcfSSatish Balay 2558a7e14dcfSSatish Balay Notes: 2559ae93cb3cSJason Sarich This routine must be preceded by calls to TaoSetConvergenceHistory() 2560ae93cb3cSJason Sarich and TaoSolve(), otherwise it returns useless information. 2561ae93cb3cSJason Sarich 2562a7e14dcfSSatish Balay The calling sequence for this routine in Fortran is 2563ae93cb3cSJason Sarich $ call TaoGetConvergenceHistory(Tao tao, PetscInt nhist, PetscErrorCode ierr) 2564a7e14dcfSSatish Balay 2565a7e14dcfSSatish Balay This routine is useful, e.g., when running a code for purposes 2566a7e14dcfSSatish Balay of accurate performance monitoring, when no I/O should be done 2567a7e14dcfSSatish Balay during the section of code that is being timed. 2568a7e14dcfSSatish Balay 2569a7e14dcfSSatish Balay Level: advanced 2570a7e14dcfSSatish Balay 2571ae93cb3cSJason Sarich .seealso: TaoSetConvergenceHistory() 2572a7e14dcfSSatish Balay 2573a7e14dcfSSatish Balay @*/ 2574ae93cb3cSJason Sarich PetscErrorCode TaoGetConvergenceHistory(Tao tao, PetscReal **obj, PetscReal **resid, PetscReal **cnorm, PetscInt **lits, PetscInt *nhist) 2575a7e14dcfSSatish Balay { 2576a7e14dcfSSatish Balay PetscFunctionBegin; 2577441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2578a7e14dcfSSatish Balay if (obj) *obj = tao->hist_obj; 2579a7e14dcfSSatish Balay if (cnorm) *cnorm = tao->hist_cnorm; 2580a7e14dcfSSatish Balay if (resid) *resid = tao->hist_resid; 2581a7e14dcfSSatish Balay if (nhist) *nhist = tao->hist_len; 2582a7e14dcfSSatish Balay PetscFunctionReturn(0); 2583a7e14dcfSSatish Balay } 2584a7e14dcfSSatish Balay 2585a7e14dcfSSatish Balay #undef __FUNCT__ 2586a7e14dcfSSatish Balay #define __FUNCT__ "TaoSetApplicationContext" 2587a7e14dcfSSatish Balay /*@ 2588a7e14dcfSSatish Balay TaoSetApplicationContext - Sets the optional user-defined context for 2589a7e14dcfSSatish Balay a solver. 2590a7e14dcfSSatish Balay 2591441846f8SBarry Smith Logically Collective on Tao 2592a7e14dcfSSatish Balay 2593a7e14dcfSSatish Balay Input Parameters: 2594441846f8SBarry Smith + tao - the Tao context 2595a7e14dcfSSatish Balay - usrP - optional user context 2596a7e14dcfSSatish Balay 2597a7e14dcfSSatish Balay Level: intermediate 2598a7e14dcfSSatish Balay 2599a7e14dcfSSatish Balay .seealso: TaoGetApplicationContext(), TaoSetApplicationContext() 2600a7e14dcfSSatish Balay @*/ 2601441846f8SBarry Smith PetscErrorCode TaoSetApplicationContext(Tao tao,void *usrP) 2602a7e14dcfSSatish Balay { 2603a7e14dcfSSatish Balay PetscFunctionBegin; 2604441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2605a7e14dcfSSatish Balay tao->user = usrP; 2606a7e14dcfSSatish Balay PetscFunctionReturn(0); 2607a7e14dcfSSatish Balay } 2608a7e14dcfSSatish Balay 2609a7e14dcfSSatish Balay #undef __FUNCT__ 2610a7e14dcfSSatish Balay #define __FUNCT__ "TaoGetApplicationContext" 2611a7e14dcfSSatish Balay /*@ 2612a7e14dcfSSatish Balay TaoGetApplicationContext - Gets the user-defined context for a 2613a7e14dcfSSatish Balay TAO solvers. 2614a7e14dcfSSatish Balay 2615a7e14dcfSSatish Balay Not Collective 2616a7e14dcfSSatish Balay 2617a7e14dcfSSatish Balay Input Parameter: 2618441846f8SBarry Smith . tao - Tao context 2619a7e14dcfSSatish Balay 2620a7e14dcfSSatish Balay Output Parameter: 2621a7e14dcfSSatish Balay . usrP - user context 2622a7e14dcfSSatish Balay 2623a7e14dcfSSatish Balay Level: intermediate 2624a7e14dcfSSatish Balay 2625a7e14dcfSSatish Balay .seealso: TaoSetApplicationContext() 2626a7e14dcfSSatish Balay @*/ 2627441846f8SBarry Smith PetscErrorCode TaoGetApplicationContext(Tao tao,void *usrP) 2628a7e14dcfSSatish Balay { 2629a7e14dcfSSatish Balay PetscFunctionBegin; 2630441846f8SBarry Smith PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2631a7e14dcfSSatish Balay *(void**)usrP = tao->user; 2632a7e14dcfSSatish Balay PetscFunctionReturn(0); 2633a7e14dcfSSatish Balay } 2634a9603a14SPatrick Farrell 2635a9603a14SPatrick Farrell #undef __FUNCT__ 2636a9603a14SPatrick Farrell #define __FUNCT__ "TaoSetGradientNorm" 2637a9603a14SPatrick Farrell /*@ 2638a9603a14SPatrick Farrell TaoSetGradientNorm - Sets the matrix used to define the inner product that measures the size of the gradient. 2639a9603a14SPatrick Farrell 2640a9603a14SPatrick Farrell Collective on tao 2641a9603a14SPatrick Farrell 2642a9603a14SPatrick Farrell Input Parameters: 2643a9603a14SPatrick Farrell + tao - the Tao context 2644a9603a14SPatrick Farrell - M - gradient norm 2645a9603a14SPatrick Farrell 2646a9603a14SPatrick Farrell Level: beginner 2647a9603a14SPatrick Farrell 2648a9603a14SPatrick Farrell .seealso: TaoGetGradientNorm(), TaoGradientNorm() 2649a9603a14SPatrick Farrell @*/ 2650a9603a14SPatrick Farrell PetscErrorCode TaoSetGradientNorm(Tao tao, Mat M) 2651a9603a14SPatrick Farrell { 2652a9603a14SPatrick Farrell PetscErrorCode ierr; 2653a9603a14SPatrick Farrell 2654a9603a14SPatrick Farrell PetscFunctionBegin; 2655a9603a14SPatrick Farrell PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2656a9603a14SPatrick Farrell 2657a9603a14SPatrick Farrell if (tao->gradient_norm) { 2658a9603a14SPatrick Farrell ierr = PetscObjectDereference((PetscObject)tao->gradient_norm);CHKERRQ(ierr); 2659a9603a14SPatrick Farrell ierr = VecDestroy(&tao->gradient_norm_tmp);CHKERRQ(ierr); 2660a9603a14SPatrick Farrell } 2661a9603a14SPatrick Farrell 2662a9603a14SPatrick Farrell ierr = PetscObjectReference((PetscObject)M);CHKERRQ(ierr); 2663a9603a14SPatrick Farrell tao->gradient_norm = M; 2664a9603a14SPatrick Farrell ierr = MatCreateVecs(M, NULL, &tao->gradient_norm_tmp);CHKERRQ(ierr); 2665a9603a14SPatrick Farrell PetscFunctionReturn(0); 2666a9603a14SPatrick Farrell } 2667a9603a14SPatrick Farrell 2668a9603a14SPatrick Farrell #undef __FUNCT__ 2669a9603a14SPatrick Farrell #define __FUNCT__ "TaoGetGradientNorm" 2670a9603a14SPatrick Farrell /*@ 2671a9603a14SPatrick Farrell TaoGetGradientNorm - Returns the matrix used to define the inner product for measuring the size of the gradient. 2672a9603a14SPatrick Farrell 2673a9603a14SPatrick Farrell Not Collective 2674a9603a14SPatrick Farrell 2675a9603a14SPatrick Farrell Input Parameter: 2676a9603a14SPatrick Farrell . tao - Tao context 2677a9603a14SPatrick Farrell 2678a9603a14SPatrick Farrell Output Parameter: 2679a9603a14SPatrick Farrell . M - gradient norm 2680a9603a14SPatrick Farrell 2681a9603a14SPatrick Farrell Level: beginner 2682a9603a14SPatrick Farrell 2683a9603a14SPatrick Farrell .seealso: TaoSetGradientNorm(), TaoGradientNorm() 2684a9603a14SPatrick Farrell @*/ 2685a9603a14SPatrick Farrell PetscErrorCode TaoGetGradientNorm(Tao tao, Mat *M) 2686a9603a14SPatrick Farrell { 2687a9603a14SPatrick Farrell PetscFunctionBegin; 2688a9603a14SPatrick Farrell PetscValidHeaderSpecific(tao,TAO_CLASSID,1); 2689a9603a14SPatrick Farrell *M = tao->gradient_norm; 2690a9603a14SPatrick Farrell PetscFunctionReturn(0); 2691a9603a14SPatrick Farrell } 2692a9603a14SPatrick Farrell 2693a9603a14SPatrick Farrell #undef __FUNCT__ 2694a9603a14SPatrick Farrell #define __FUNCT__ "TaoGradientNorm" 2695a9603a14SPatrick Farrell /*c 2696a9603a14SPatrick Farrell TaoGradientNorm - Compute the norm with respect to the inner product the user has set. 2697a9603a14SPatrick Farrell 2698a9603a14SPatrick Farrell Collective on tao 2699a9603a14SPatrick Farrell 2700a9603a14SPatrick Farrell Input Parameter: 2701a9603a14SPatrick Farrell . tao - the Tao context 2702a9603a14SPatrick Farrell . gradient - the gradient to be computed 2703a9603a14SPatrick Farrell . norm - the norm type 2704a9603a14SPatrick Farrell 2705a9603a14SPatrick Farrell Output Parameter: 2706a9603a14SPatrick Farrell . gnorm - the gradient norm 2707a9603a14SPatrick Farrell 2708a9603a14SPatrick Farrell Level: developer 2709a9603a14SPatrick Farrell 2710a9603a14SPatrick Farrell .seealso: TaoSetGradientNorm(), TaoGetGradientNorm() 2711a9603a14SPatrick Farrell @*/ 2712a9603a14SPatrick Farrell PetscErrorCode TaoGradientNorm(Tao tao, Vec gradient, NormType type, PetscReal *gnorm) 2713a9603a14SPatrick Farrell { 2714a9603a14SPatrick Farrell PetscErrorCode ierr; 2715a9603a14SPatrick Farrell 2716a9603a14SPatrick Farrell PetscFunctionBegin; 2717a9603a14SPatrick Farrell PetscValidHeaderSpecific(gradient,VEC_CLASSID,1); 2718a9603a14SPatrick Farrell 2719a9603a14SPatrick Farrell if (tao->gradient_norm) { 2720680e2bc7SPatrick Farrell PetscScalar gnorms; 2721680e2bc7SPatrick Farrell 2722a9603a14SPatrick 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."); 2723a9603a14SPatrick Farrell ierr = MatMult(tao->gradient_norm, gradient, tao->gradient_norm_tmp);CHKERRQ(ierr); 2724680e2bc7SPatrick Farrell ierr = VecDot(gradient, tao->gradient_norm_tmp, &gnorms);CHKERRQ(ierr); 27257bb79937SPatrick Farrell *gnorm = PetscRealPart(PetscSqrtScalar(gnorms)); 2726a9603a14SPatrick Farrell } else { 2727a9603a14SPatrick Farrell ierr = VecNorm(gradient, type, gnorm);CHKERRQ(ierr); 2728a9603a14SPatrick Farrell } 2729a9603a14SPatrick Farrell PetscFunctionReturn(0); 2730a9603a14SPatrick Farrell } 2731a9603a14SPatrick Farrell 2732a9603a14SPatrick Farrell 2733