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