1 #if !defined(PETSCTAO_H) 2 #define PETSCTAO_H 3 4 #include <petscsnes.h> 5 6 /* SUBMANSEC = Tao */ 7 8 PETSC_EXTERN PetscErrorCode VecFischer(Vec,Vec,Vec,Vec,Vec); 9 PETSC_EXTERN PetscErrorCode VecSFischer(Vec,Vec,Vec,Vec,PetscReal,Vec); 10 PETSC_EXTERN PetscErrorCode MatDFischer(Mat,Vec,Vec,Vec,Vec,Vec,Vec,Vec,Vec); 11 PETSC_EXTERN PetscErrorCode MatDSFischer(Mat,Vec,Vec,Vec,Vec,PetscReal,Vec,Vec,Vec,Vec,Vec); 12 PETSC_EXTERN PetscErrorCode TaoSoftThreshold(Vec,PetscReal,PetscReal,Vec); 13 14 /*E 15 TaoSubsetType - Type representing the way Tao handles active sets 16 17 + `TAO_SUBSET_SUBVEC` - Tao uses `MatCreateSubMatrix()` and `VecGetSubVector()` 18 . `TAO_SUBSET_MASK` - Matrices are zeroed out corresponding to active set entries 19 - `TAO_SUBSET_MATRIXFREE` - Same as `TAO_SUBSET_MASK` but it can be applied to matrix-free operators 20 21 Options database keys: 22 . -different_hessian - Tao will use a copy of the hessian operator for masking. By default 23 Tao will directly alter the hessian operator. 24 Level: intermediate 25 26 E*/ 27 typedef enum {TAO_SUBSET_SUBVEC,TAO_SUBSET_MASK,TAO_SUBSET_MATRIXFREE} TaoSubsetType; 28 PETSC_EXTERN const char *const TaoSubsetTypes[]; 29 30 /*S 31 Tao - Abstract PETSc object that manages nonlinear optimization solves 32 33 Level: advanced 34 35 .seealso `TaoCreate()`, `TaoDestroy()`, `TaoSetType()`, `TaoType` 36 S*/ 37 typedef struct _p_Tao* Tao; 38 39 /*E 40 TaoADMMUpdateType - Determine spectral penalty update routine for Lagrange augmented term for `TAOADMM`. 41 42 Level: advanced 43 44 .seealso `TaoADMMSetUpdateType()` 45 E*/ 46 typedef enum {TAO_ADMM_UPDATE_BASIC,TAO_ADMM_UPDATE_ADAPTIVE,TAO_ADMM_UPDATE_ADAPTIVE_RELAXED} TaoADMMUpdateType; 47 PETSC_EXTERN const char *const TaoADMMUpdateTypes[]; 48 49 /*MC 50 TAO_ADMM_UPDATE_BASIC - Use same spectral penalty set at the beginning. No update 51 52 Level: advanced 53 54 Note: 55 Most basic implementation. Generally slower than adaptive or adaptive relaxed version. 56 57 .seealso: `TaoADMMSetUpdateType()`, `TAO_ADMM_UPDATE_ADAPTIVE`, `TAO_ADMM_UPDATE_ADAPTIVE_RELAXED` 58 M*/ 59 60 /*MC 61 TAO_ADMM_UPDATE_ADAPTIVE - Adaptively update spectral penalty 62 63 Level: advanced 64 65 Note: 66 Adaptively updates spectral penalty by using both steepest descent and minimum gradient. 67 68 .seealso: `TaoADMMSetUpdateType()`, `TAO_ADMM_UPDATE_BASIC`, `TAO_ADMM_UPDATE_ADAPTIVE_RELAXED` 69 M*/ 70 71 /*MC 72 ADMM_UPDATE_ADAPTIVE_RELAXED - Adaptively update spectral penalty, and relaxes parameter update 73 74 Level: advanced 75 76 Note: 77 With adaptive spectral penalty update, it also relaxes x vector update by a factor. 78 79 .seealso: `TaoADMMSetUpdateType()`, `TAO_ADMM_UPDATE_BASIC`, `TAO_ADMM_UPDATE_ADAPTIVE` 80 M*/ 81 82 /*E 83 TaoADMMRegularizerType - Determine regularizer routine - either user provided or soft threshold 84 85 Level: advanced 86 87 .seealso `TaoADMMSetRegularizerType()` 88 E*/ 89 typedef enum {TAO_ADMM_REGULARIZER_USER,TAO_ADMM_REGULARIZER_SOFT_THRESH} TaoADMMRegularizerType; 90 PETSC_EXTERN const char *const TaoADMMRegularizerTypes[]; 91 92 /*MC 93 TAO_ADMM_REGULARIZER_USER - User provided routines for regularizer part of `TAOADMM` 94 95 Level: advanced 96 97 Note: 98 User needs to provided appropriate routines and type for regularizer solver 99 100 .seealso: `TaoADMMSetRegularizerType()`, `TAO_ADMM_REGULARIZER_SOFT_THRESH` 101 M*/ 102 103 /*MC 104 TAO_ADMM_REGULARIZER_SOFT_THRESH - Soft threshold to solve regularizer part of `TAOADMM` 105 106 Level: advanced 107 108 Note: 109 Utilizes built-in SoftThreshold routines 110 111 .seealso: `TaoSoftThreshold()`, `TaoADMMSetRegularizerObjectiveAndGradientRoutine()`, 112 `TaoADMMSetRegularizerHessianRoutine()`, `TaoADMMSetRegularizerType()`, `TAO_ADMM_REGULARIZER_USER` 113 M*/ 114 115 /*E 116 TaoALMMType - Determine the augmented Lagrangian formulation used in the `TAOALMM` subproblem. 117 118 $ `TAO_ALMM_CLASSIC` - classic augmented Lagrangian definition including slack variables for inequality constraints 119 $ `TAO_ALMM_PHR` - Powell-Hestenes-Rockafellar formulation without slack variables, uses pointwise min() for inequalities 120 121 Level: advanced 122 123 .seealso `TAOALMM`, `TaoALMMSetType()`, `TaoALMMGetType()` 124 E*/ 125 typedef enum {TAO_ALMM_CLASSIC,TAO_ALMM_PHR} TaoALMMType; 126 PETSC_EXTERN const char *const TaoALMMTypes[]; 127 128 /*J 129 TaoType - String with the name of a `Tao` method 130 131 Level: beginner 132 133 .seealso `Tao`, `TaoCreate()`, `TaoSetType()` 134 J*/ 135 typedef const char *TaoType; 136 #define TAOLMVM "lmvm" 137 #define TAONLS "nls" 138 #define TAONTR "ntr" 139 #define TAONTL "ntl" 140 #define TAOCG "cg" 141 #define TAOTRON "tron" 142 #define TAOOWLQN "owlqn" 143 #define TAOBMRM "bmrm" 144 #define TAOBLMVM "blmvm" 145 #define TAOBQNLS "bqnls" 146 #define TAOBNCG "bncg" 147 #define TAOBNLS "bnls" 148 #define TAOBNTR "bntr" 149 #define TAOBNTL "bntl" 150 #define TAOBQNKLS "bqnkls" 151 #define TAOBQNKTR "bqnktr" 152 #define TAOBQNKTL "bqnktl" 153 #define TAOBQPIP "bqpip" 154 #define TAOGPCG "gpcg" 155 #define TAONM "nm" 156 #define TAOPOUNDERS "pounders" 157 #define TAOBRGN "brgn" 158 #define TAOLCL "lcl" 159 #define TAOSSILS "ssils" 160 #define TAOSSFLS "ssfls" 161 #define TAOASILS "asils" 162 #define TAOASFLS "asfls" 163 #define TAOIPM "ipm" 164 #define TAOPDIPM "pdipm" 165 #define TAOSHELL "shell" 166 #define TAOADMM "admm" 167 #define TAOALMM "almm" 168 #define TAOPYTHON "python" 169 170 PETSC_EXTERN PetscClassId TAO_CLASSID; 171 PETSC_EXTERN PetscFunctionList TaoList; 172 173 /*E 174 TaoConvergedReason - reason a Tao method was said to have converged or diverged 175 176 Level: beginner 177 178 The two most common reasons for divergence are 179 $ 1) an incorrectly coded or computed gradient or Hessian 180 $ 2) failure or lack of convergence in the linear system (in this case we recommend 181 $ testing with -pc_type lu to eliminate the linear solver as the cause of the problem). 182 183 Developer Notes: 184 This must match petsc/finclude/petsctao.h 185 186 The string versions of these are in `TAOConvergedReasons`, if you change any value here you must 187 also adjust that array. 188 189 .seealso: `Tao`, `TaoSolve()`, `TaoGetConvergedReason()`, `KSPConvergedReason`, `SNESConvergedReason`, `TSConvergedReason` 190 E*/ 191 typedef enum {/* converged */ 192 TAO_CONVERGED_GATOL = 3, /* ||g(X)|| < gatol */ 193 TAO_CONVERGED_GRTOL = 4, /* ||g(X)|| / f(X) < grtol */ 194 TAO_CONVERGED_GTTOL = 5, /* ||g(X)|| / ||g(X0)|| < gttol */ 195 TAO_CONVERGED_STEPTOL = 6, /* step size small */ 196 TAO_CONVERGED_MINF = 7, /* F < F_min */ 197 TAO_CONVERGED_USER = 8, /* User defined */ 198 /* diverged */ 199 TAO_DIVERGED_MAXITS = -2, 200 TAO_DIVERGED_NAN = -4, 201 TAO_DIVERGED_MAXFCN = -5, 202 TAO_DIVERGED_LS_FAILURE = -6, 203 TAO_DIVERGED_TR_REDUCTION = -7, 204 TAO_DIVERGED_USER = -8, /* User defined */ 205 /* keep going */ 206 TAO_CONTINUE_ITERATING = 0} TaoConvergedReason; 207 208 PETSC_EXTERN const char **TaoConvergedReasons; 209 210 PETSC_EXTERN PetscErrorCode TaoInitializePackage(void); 211 PETSC_EXTERN PetscErrorCode TaoFinalizePackage(void); 212 PETSC_EXTERN PetscErrorCode TaoCreate(MPI_Comm,Tao*); 213 PETSC_EXTERN PetscErrorCode TaoSetFromOptions(Tao); 214 PETSC_EXTERN PetscErrorCode TaoSetUp(Tao); 215 PETSC_EXTERN PetscErrorCode TaoSetType(Tao,TaoType); 216 PETSC_EXTERN PetscErrorCode TaoGetType(Tao,TaoType*); 217 PETSC_EXTERN PetscErrorCode TaoSetApplicationContext(Tao,void*); 218 PETSC_EXTERN PetscErrorCode TaoGetApplicationContext(Tao,void*); 219 PETSC_EXTERN PetscErrorCode TaoDestroy(Tao*); 220 221 PETSC_EXTERN PetscErrorCode TaoSetOptionsPrefix(Tao,const char[]); 222 PETSC_EXTERN PetscErrorCode TaoView(Tao,PetscViewer); 223 PETSC_EXTERN PetscErrorCode TaoViewFromOptions(Tao,PetscObject,const char[]); 224 225 PETSC_EXTERN PetscErrorCode TaoSolve(Tao); 226 227 PETSC_EXTERN PetscErrorCode TaoRegister(const char[],PetscErrorCode (*)(Tao)); 228 PETSC_EXTERN PetscErrorCode TaoRegisterDestroy(void); 229 230 PETSC_EXTERN PetscErrorCode TaoGetConvergedReason(Tao,TaoConvergedReason*); 231 PETSC_EXTERN PetscErrorCode TaoGetSolutionStatus(Tao,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,TaoConvergedReason*); 232 PETSC_EXTERN PetscErrorCode TaoSetConvergedReason(Tao,TaoConvergedReason); 233 PETSC_EXTERN PetscErrorCode TaoSetSolution(Tao,Vec); 234 PETSC_EXTERN PetscErrorCode TaoGetSolution(Tao,Vec*); 235 PETSC_DEPRECATED_FUNCTION("Use TaoSetSolution() (since version 3.17)") static inline PetscErrorCode TaoSetInitialVector(Tao t,Vec v) { return TaoSetSolution(t,v); } 236 PETSC_DEPRECATED_FUNCTION("Use TaoGetSolution() (since version 3.17)") static inline PetscErrorCode TaoGetInitialVector(Tao t,Vec *v) { return TaoGetSolution(t,v); } 237 238 PETSC_EXTERN PetscErrorCode TaoSetObjective(Tao,PetscErrorCode(*)(Tao,Vec,PetscReal*,void*),void*); 239 PETSC_EXTERN PetscErrorCode TaoGetObjective(Tao,PetscErrorCode(**)(Tao,Vec,PetscReal*,void*),void**); 240 PETSC_EXTERN PetscErrorCode TaoSetGradient(Tao,Vec,PetscErrorCode(*)(Tao,Vec,Vec,void*),void*); 241 PETSC_EXTERN PetscErrorCode TaoGetGradient(Tao,Vec*,PetscErrorCode(**)(Tao,Vec,Vec,void*),void**); 242 PETSC_EXTERN PetscErrorCode TaoSetObjectiveAndGradient(Tao,Vec,PetscErrorCode(*)(Tao,Vec,PetscReal*,Vec,void*),void*); 243 PETSC_EXTERN PetscErrorCode TaoGetObjectiveAndGradient(Tao,Vec*,PetscErrorCode(**)(Tao,Vec,PetscReal*,Vec,void*),void**); 244 PETSC_EXTERN PetscErrorCode TaoSetHessian(Tao,Mat,Mat,PetscErrorCode(*)(Tao,Vec,Mat,Mat,void*),void*); 245 PETSC_EXTERN PetscErrorCode TaoGetHessian(Tao,Mat*,Mat*,PetscErrorCode(**)(Tao,Vec,Mat,Mat,void*),void**); 246 PETSC_DEPRECATED_FUNCTION("Use TaoSetObjective() (since version 3.17)") static inline PetscErrorCode TaoSetObjectiveRoutine(Tao t,PetscErrorCode (*f)(Tao,Vec,PetscReal*,void*),void *c) { return TaoSetObjective(t,f,c); } 247 PETSC_DEPRECATED_FUNCTION("Use TaoGetGradient() (since version 3.17)") static inline PetscErrorCode TaoGetGradientVector(Tao t,Vec *v) { return TaoGetGradient(t,v,NULL,NULL); } 248 PETSC_DEPRECATED_FUNCTION("Use TaoSetGradient() (since version 3.17)") static inline PetscErrorCode TaoSetGradientRoutine(Tao t,PetscErrorCode (*f)(Tao,Vec,Vec,void*),void *c) { return TaoSetGradient(t,NULL,f,c); } 249 PETSC_DEPRECATED_FUNCTION("Use TaoSetObjectiveAndGradient() (since version 3.17)") static inline PetscErrorCode TaoSetObjectiveAndGradientRoutine(Tao t,PetscErrorCode (*f)(Tao,Vec,PetscReal*,Vec,void*),void *c) { return TaoSetObjectiveAndGradient(t,NULL,f,c); } 250 PETSC_DEPRECATED_FUNCTION("Use TaoSetHessian() (since version 3.17)") static inline PetscErrorCode TaoSetHessianRoutine(Tao t,Mat H,Mat P,PetscErrorCode (*f)(Tao,Vec,Mat,Mat,void*),void *c) { return TaoSetHessian(t,H,P,f,c); } 251 252 PETSC_EXTERN PetscErrorCode TaoSetGradientNorm(Tao,Mat); 253 PETSC_EXTERN PetscErrorCode TaoGetGradientNorm(Tao,Mat*); 254 PETSC_EXTERN PetscErrorCode TaoSetLMVMMatrix(Tao,Mat); 255 PETSC_EXTERN PetscErrorCode TaoGetLMVMMatrix(Tao,Mat*); 256 PETSC_EXTERN PetscErrorCode TaoSetRecycleHistory(Tao,PetscBool); 257 PETSC_EXTERN PetscErrorCode TaoGetRecycleHistory(Tao,PetscBool*); 258 PETSC_EXTERN PetscErrorCode TaoLMVMSetH0(Tao,Mat); 259 PETSC_EXTERN PetscErrorCode TaoLMVMGetH0(Tao,Mat*); 260 PETSC_EXTERN PetscErrorCode TaoLMVMGetH0KSP(Tao,KSP*); 261 PETSC_EXTERN PetscErrorCode TaoLMVMRecycle(Tao,PetscBool); 262 PETSC_EXTERN PetscErrorCode TaoSetResidualRoutine(Tao,Vec,PetscErrorCode(*)(Tao,Vec,Vec,void*),void*); 263 PETSC_EXTERN PetscErrorCode TaoSetResidualWeights(Tao,Vec,PetscInt,PetscInt*,PetscInt*,PetscReal*); 264 PETSC_EXTERN PetscErrorCode TaoSetConstraintsRoutine(Tao,Vec,PetscErrorCode(*)(Tao,Vec,Vec,void*),void*); 265 PETSC_EXTERN PetscErrorCode TaoSetInequalityConstraintsRoutine(Tao,Vec,PetscErrorCode(*)(Tao,Vec,Vec,void*),void*); 266 PETSC_EXTERN PetscErrorCode TaoSetEqualityConstraintsRoutine(Tao,Vec,PetscErrorCode(*)(Tao,Vec,Vec,void*),void*); 267 PETSC_EXTERN PetscErrorCode TaoSetJacobianResidualRoutine(Tao,Mat,Mat,PetscErrorCode(*)(Tao,Vec,Mat,Mat,void*),void*); 268 PETSC_EXTERN PetscErrorCode TaoSetJacobianRoutine(Tao,Mat,Mat,PetscErrorCode(*)(Tao,Vec,Mat,Mat,void*),void*); 269 PETSC_EXTERN PetscErrorCode TaoSetJacobianStateRoutine(Tao,Mat,Mat,Mat,PetscErrorCode(*)(Tao,Vec,Mat,Mat,Mat,void*),void*); 270 PETSC_EXTERN PetscErrorCode TaoSetJacobianDesignRoutine(Tao,Mat,PetscErrorCode(*)(Tao,Vec,Mat,void*),void*); 271 PETSC_EXTERN PetscErrorCode TaoSetJacobianInequalityRoutine(Tao,Mat,Mat,PetscErrorCode(*)(Tao,Vec,Mat,Mat,void*),void*); 272 PETSC_EXTERN PetscErrorCode TaoSetJacobianEqualityRoutine(Tao,Mat,Mat,PetscErrorCode(*)(Tao,Vec,Mat,Mat,void*),void*); 273 274 PETSC_EXTERN PetscErrorCode TaoPythonSetType(Tao,const char[]); 275 PETSC_EXTERN PetscErrorCode TaoPythonGetType(Tao,const char*[]); 276 277 PETSC_EXTERN PetscErrorCode TaoShellSetSolve(Tao,PetscErrorCode(*)(Tao)); 278 PETSC_EXTERN PetscErrorCode TaoShellSetContext(Tao,void*); 279 PETSC_EXTERN PetscErrorCode TaoShellGetContext(Tao,void*); 280 281 PETSC_DEPRECATED_FUNCTION("Use TaoSetResidualRoutine() (since version 3.11)") static inline PetscErrorCode TaoSetSeparableObjectiveRoutine(Tao tao,Vec res,PetscErrorCode (*func)(Tao,Vec,Vec,void*),void *ctx) {return TaoSetResidualRoutine(tao,res,func,ctx);} 282 PETSC_DEPRECATED_FUNCTION("Use TaoSetResidualWeights() (since version 3.11)") static inline PetscErrorCode TaoSetSeparableObjectiveWeights(Tao tao,Vec sigma_v,PetscInt n,PetscInt *rows,PetscInt *cols,PetscReal *vals) {return TaoSetResidualWeights(tao,sigma_v,n,rows,cols,vals);} 283 284 PETSC_EXTERN PetscErrorCode TaoSetStateDesignIS(Tao,IS,IS); 285 286 PETSC_EXTERN PetscErrorCode TaoComputeObjective(Tao,Vec,PetscReal*); 287 PETSC_EXTERN PetscErrorCode TaoComputeResidual(Tao,Vec,Vec); 288 PETSC_EXTERN PetscErrorCode TaoTestGradient(Tao,Vec,Vec); 289 PETSC_EXTERN PetscErrorCode TaoComputeGradient(Tao,Vec,Vec); 290 PETSC_EXTERN PetscErrorCode TaoComputeObjectiveAndGradient(Tao,Vec,PetscReal*,Vec); 291 PETSC_EXTERN PetscErrorCode TaoComputeConstraints(Tao,Vec,Vec); 292 PETSC_EXTERN PetscErrorCode TaoComputeInequalityConstraints(Tao,Vec,Vec); 293 PETSC_EXTERN PetscErrorCode TaoComputeEqualityConstraints(Tao,Vec,Vec); 294 PETSC_EXTERN PetscErrorCode TaoDefaultComputeGradient(Tao,Vec,Vec,void*); 295 PETSC_EXTERN PetscErrorCode TaoIsObjectiveDefined(Tao,PetscBool*); 296 PETSC_EXTERN PetscErrorCode TaoIsGradientDefined(Tao,PetscBool*); 297 PETSC_EXTERN PetscErrorCode TaoIsObjectiveAndGradientDefined(Tao,PetscBool*); 298 299 PETSC_DEPRECATED_FUNCTION("Use TaoComputeResidual() (since version 3.11)") static inline PetscErrorCode TaoComputeSeparableObjective(Tao tao,Vec X,Vec F) {return TaoComputeResidual(tao,X,F);} 300 301 PETSC_EXTERN PetscErrorCode TaoTestHessian(Tao); 302 PETSC_EXTERN PetscErrorCode TaoComputeHessian(Tao,Vec,Mat,Mat); 303 PETSC_EXTERN PetscErrorCode TaoComputeResidualJacobian(Tao,Vec,Mat,Mat); 304 PETSC_EXTERN PetscErrorCode TaoComputeJacobian(Tao,Vec,Mat,Mat); 305 PETSC_EXTERN PetscErrorCode TaoComputeJacobianState(Tao,Vec,Mat,Mat,Mat); 306 PETSC_EXTERN PetscErrorCode TaoComputeJacobianEquality(Tao,Vec,Mat,Mat); 307 PETSC_EXTERN PetscErrorCode TaoComputeJacobianInequality(Tao,Vec,Mat,Mat); 308 PETSC_EXTERN PetscErrorCode TaoComputeJacobianDesign(Tao,Vec,Mat); 309 310 PETSC_EXTERN PetscErrorCode TaoDefaultComputeHessian(Tao,Vec,Mat,Mat,void*); 311 PETSC_EXTERN PetscErrorCode TaoDefaultComputeHessianColor(Tao,Vec,Mat,Mat,void*); 312 PETSC_EXTERN PetscErrorCode TaoDefaultComputeHessianMFFD(Tao,Vec,Mat,Mat,void*); 313 PETSC_EXTERN PetscErrorCode TaoComputeDualVariables(Tao,Vec,Vec); 314 PETSC_EXTERN PetscErrorCode TaoSetVariableBounds(Tao,Vec,Vec); 315 PETSC_EXTERN PetscErrorCode TaoGetVariableBounds(Tao,Vec*,Vec*); 316 PETSC_EXTERN PetscErrorCode TaoGetDualVariables(Tao,Vec*,Vec*); 317 PETSC_EXTERN PetscErrorCode TaoSetInequalityBounds(Tao,Vec,Vec); 318 PETSC_EXTERN PetscErrorCode TaoGetInequalityBounds(Tao,Vec*,Vec*); 319 PETSC_EXTERN PetscErrorCode TaoSetVariableBoundsRoutine(Tao,PetscErrorCode(*)(Tao,Vec,Vec,void*),void*); 320 PETSC_EXTERN PetscErrorCode TaoComputeVariableBounds(Tao); 321 322 PETSC_EXTERN PetscErrorCode TaoGetTolerances(Tao,PetscReal*,PetscReal*,PetscReal*); 323 PETSC_EXTERN PetscErrorCode TaoSetTolerances(Tao,PetscReal,PetscReal,PetscReal); 324 PETSC_EXTERN PetscErrorCode TaoGetConstraintTolerances(Tao,PetscReal*,PetscReal*); 325 PETSC_EXTERN PetscErrorCode TaoSetConstraintTolerances(Tao,PetscReal,PetscReal); 326 PETSC_EXTERN PetscErrorCode TaoSetFunctionLowerBound(Tao,PetscReal); 327 PETSC_EXTERN PetscErrorCode TaoSetInitialTrustRegionRadius(Tao,PetscReal); 328 PETSC_EXTERN PetscErrorCode TaoSetMaximumIterations(Tao,PetscInt); 329 PETSC_EXTERN PetscErrorCode TaoSetMaximumFunctionEvaluations(Tao,PetscInt); 330 PETSC_EXTERN PetscErrorCode TaoGetFunctionLowerBound(Tao,PetscReal*); 331 PETSC_EXTERN PetscErrorCode TaoGetInitialTrustRegionRadius(Tao,PetscReal*); 332 PETSC_EXTERN PetscErrorCode TaoGetCurrentTrustRegionRadius(Tao,PetscReal*); 333 PETSC_EXTERN PetscErrorCode TaoGetMaximumIterations(Tao,PetscInt*); 334 PETSC_EXTERN PetscErrorCode TaoGetCurrentFunctionEvaluations(Tao,PetscInt*); 335 PETSC_EXTERN PetscErrorCode TaoGetMaximumFunctionEvaluations(Tao,PetscInt*); 336 PETSC_EXTERN PetscErrorCode TaoGetIterationNumber(Tao,PetscInt*); 337 PETSC_EXTERN PetscErrorCode TaoSetIterationNumber(Tao,PetscInt); 338 PETSC_EXTERN PetscErrorCode TaoGetTotalIterationNumber(Tao,PetscInt*); 339 PETSC_EXTERN PetscErrorCode TaoSetTotalIterationNumber(Tao,PetscInt); 340 PETSC_EXTERN PetscErrorCode TaoGetResidualNorm(Tao,PetscReal*); 341 342 PETSC_EXTERN PetscErrorCode TaoAppendOptionsPrefix(Tao,const char[]); 343 PETSC_EXTERN PetscErrorCode TaoGetOptionsPrefix(Tao,const char*[]); 344 PETSC_EXTERN PetscErrorCode TaoResetStatistics(Tao); 345 PETSC_EXTERN PetscErrorCode TaoSetUpdate(Tao,PetscErrorCode(*)(Tao,PetscInt,void*),void*); 346 347 PETSC_EXTERN PetscErrorCode TaoGetKSP(Tao,KSP*); 348 PETSC_EXTERN PetscErrorCode TaoGetLinearSolveIterations(Tao,PetscInt*); 349 PETSC_EXTERN PetscErrorCode TaoKSPSetUseEW(Tao,PetscBool); 350 351 #include <petsctaolinesearch.h> 352 353 PETSC_EXTERN PetscErrorCode TaoGetLineSearch(Tao,TaoLineSearch*); 354 355 PETSC_EXTERN PetscErrorCode TaoSetConvergenceHistory(Tao,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt,PetscBool); 356 PETSC_EXTERN PetscErrorCode TaoGetConvergenceHistory(Tao,PetscReal**,PetscReal**,PetscReal**,PetscInt**,PetscInt*); 357 PETSC_EXTERN PetscErrorCode TaoSetMonitor(Tao,PetscErrorCode (*)(Tao,void*),void *,PetscErrorCode (*)(void**)); 358 PETSC_EXTERN PetscErrorCode TaoCancelMonitors(Tao); 359 PETSC_EXTERN PetscErrorCode TaoMonitorDefault(Tao,void*); 360 PETSC_DEPRECATED_FUNCTION("Use TaoMonitorDefault() (since version 3.9)") static inline PetscErrorCode TaoDefaultMonitor(Tao tao,void*ctx) {return TaoMonitorDefault(tao,ctx);} 361 PETSC_EXTERN PetscErrorCode TaoDefaultGMonitor(Tao,void*); 362 PETSC_EXTERN PetscErrorCode TaoDefaultSMonitor(Tao,void*); 363 PETSC_EXTERN PetscErrorCode TaoDefaultCMonitor(Tao,void*); 364 PETSC_EXTERN PetscErrorCode TaoSolutionMonitor(Tao,void*); 365 PETSC_EXTERN PetscErrorCode TaoResidualMonitor(Tao,void*); 366 PETSC_EXTERN PetscErrorCode TaoGradientMonitor(Tao,void*); 367 PETSC_EXTERN PetscErrorCode TaoStepDirectionMonitor(Tao,void*); 368 PETSC_EXTERN PetscErrorCode TaoDrawSolutionMonitor(Tao,void*); 369 PETSC_EXTERN PetscErrorCode TaoDrawStepMonitor(Tao,void*); 370 PETSC_EXTERN PetscErrorCode TaoDrawGradientMonitor(Tao,void*); 371 PETSC_EXTERN PetscErrorCode TaoAddLineSearchCounts(Tao); 372 373 PETSC_EXTERN PetscErrorCode TaoDefaultConvergenceTest(Tao,void*); 374 PETSC_EXTERN PetscErrorCode TaoSetConvergenceTest(Tao,PetscErrorCode (*)(Tao,void*),void *); 375 376 PETSC_EXTERN PetscErrorCode TaoLCLSetStateDesignIS(Tao,IS,IS); 377 PETSC_EXTERN PetscErrorCode TaoMonitor(Tao,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal); 378 typedef struct _n_TaoMonitorDrawCtx* TaoMonitorDrawCtx; 379 PETSC_EXTERN PetscErrorCode TaoMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TaoMonitorDrawCtx*); 380 PETSC_EXTERN PetscErrorCode TaoMonitorDrawCtxDestroy(TaoMonitorDrawCtx*); 381 382 PETSC_EXTERN PetscErrorCode TaoBRGNGetSubsolver(Tao,Tao *); 383 PETSC_EXTERN PetscErrorCode TaoBRGNSetRegularizerObjectiveAndGradientRoutine(Tao,PetscErrorCode (*)(Tao,Vec,PetscReal*,Vec,void*),void*); 384 PETSC_EXTERN PetscErrorCode TaoBRGNSetRegularizerHessianRoutine(Tao,Mat,PetscErrorCode (*)(Tao,Vec,Mat,void*),void*); 385 PETSC_EXTERN PetscErrorCode TaoBRGNSetRegularizerWeight(Tao,PetscReal); 386 PETSC_EXTERN PetscErrorCode TaoBRGNSetL1SmoothEpsilon(Tao,PetscReal); 387 PETSC_EXTERN PetscErrorCode TaoBRGNSetDictionaryMatrix(Tao,Mat); 388 PETSC_EXTERN PetscErrorCode TaoBRGNGetDampingVector(Tao,Vec *); 389 390 PETSC_EXTERN PetscErrorCode TaoADMMGetMisfitSubsolver(Tao,Tao *); 391 PETSC_EXTERN PetscErrorCode TaoADMMGetRegularizationSubsolver(Tao,Tao *); 392 PETSC_EXTERN PetscErrorCode TaoADMMGetDualVector(Tao,Vec*); 393 PETSC_EXTERN PetscErrorCode TaoADMMGetSpectralPenalty(Tao,PetscReal*); 394 PETSC_EXTERN PetscErrorCode TaoADMMSetSpectralPenalty(Tao,PetscReal); 395 PETSC_EXTERN PetscErrorCode TaoGetADMMParentTao(Tao,Tao *); 396 PETSC_EXTERN PetscErrorCode TaoADMMSetConstraintVectorRHS(Tao,Vec); 397 PETSC_EXTERN PetscErrorCode TaoADMMSetRegularizerCoefficient(Tao,PetscReal); 398 PETSC_EXTERN PetscErrorCode TaoADMMSetMisfitConstraintJacobian(Tao,Mat,Mat,PetscErrorCode (*)(Tao,Vec,Mat,Mat,void*),void*); 399 PETSC_EXTERN PetscErrorCode TaoADMMSetRegularizerConstraintJacobian(Tao,Mat,Mat,PetscErrorCode (*)(Tao,Vec,Mat,Mat,void*),void*); 400 PETSC_EXTERN PetscErrorCode TaoADMMSetRegularizerHessianRoutine(Tao,Mat,Mat,PetscErrorCode (*)(Tao,Vec,Mat,Mat,void*),void*); 401 PETSC_EXTERN PetscErrorCode TaoADMMSetRegularizerObjectiveAndGradientRoutine(Tao,PetscErrorCode (*)(Tao,Vec,PetscReal *,Vec,void*),void*); 402 PETSC_EXTERN PetscErrorCode TaoADMMSetMisfitHessianRoutine(Tao,Mat,Mat,PetscErrorCode (*)(Tao,Vec,Mat,Mat,void*),void*); 403 PETSC_EXTERN PetscErrorCode TaoADMMSetMisfitObjectiveAndGradientRoutine(Tao,PetscErrorCode (*)(Tao,Vec,PetscReal *,Vec,void*),void*); 404 PETSC_EXTERN PetscErrorCode TaoADMMSetMisfitHessianChangeStatus(Tao,PetscBool); 405 PETSC_EXTERN PetscErrorCode TaoADMMSetRegHessianChangeStatus(Tao,PetscBool); 406 PETSC_EXTERN PetscErrorCode TaoADMMSetMinimumSpectralPenalty(Tao,PetscReal); 407 PETSC_EXTERN PetscErrorCode TaoADMMSetRegularizerType(Tao,TaoADMMRegularizerType); 408 PETSC_EXTERN PetscErrorCode TaoADMMGetRegularizerType(Tao,TaoADMMRegularizerType*); 409 PETSC_EXTERN PetscErrorCode TaoADMMSetUpdateType(Tao,TaoADMMUpdateType); 410 PETSC_EXTERN PetscErrorCode TaoADMMGetUpdateType(Tao,TaoADMMUpdateType*); 411 412 PETSC_EXTERN PetscErrorCode TaoALMMGetType(Tao,TaoALMMType*); 413 PETSC_EXTERN PetscErrorCode TaoALMMSetType(Tao,TaoALMMType); 414 PETSC_EXTERN PetscErrorCode TaoALMMGetSubsolver(Tao,Tao*); 415 PETSC_EXTERN PetscErrorCode TaoALMMSetSubsolver(Tao,Tao); 416 PETSC_EXTERN PetscErrorCode TaoALMMGetMultipliers(Tao,Vec*); 417 PETSC_EXTERN PetscErrorCode TaoALMMSetMultipliers(Tao,Vec); 418 PETSC_EXTERN PetscErrorCode TaoALMMGetPrimalIS(Tao,IS*,IS*); 419 PETSC_EXTERN PetscErrorCode TaoALMMGetDualIS(Tao,IS*,IS*); 420 #endif 421