xref: /petsc/src/tao/bound/impls/bqnk/bqnktl.c (revision 5eb5f4d688081cf9b72ac57052277e637d17a8ab)
1e0ed867bSAlp Dener #include <../src/tao/bound/impls/bqnk/bqnk.h>
2e0ed867bSAlp Dener 
3*5eb5f4d6SAlp Dener static PetscErrorCode TaoSetUp_BQNKTL(Tao tao)
4*5eb5f4d6SAlp Dener {
5*5eb5f4d6SAlp Dener   TAO_BNK         *bnk = (TAO_BNK*)tao->data;
6*5eb5f4d6SAlp Dener   PetscErrorCode ierr;
7*5eb5f4d6SAlp Dener 
8*5eb5f4d6SAlp Dener   PetscFunctionBegin;
9*5eb5f4d6SAlp Dener   ierr = TaoSetUp_BQNK(tao);CHKERRQ(ierr);
10*5eb5f4d6SAlp Dener   if (!bnk->is_nash && !bnk->is_stcg && !bnk->is_gltr) SETERRQ(PetscObjectComm((PetscObject)tao),PETSC_ERR_SUP,"Must use a trust-region CG method for KSP (KSPNASH, KSPSTCG, KSPGLTR)");
11*5eb5f4d6SAlp Dener   PetscFunctionReturn(0);
12*5eb5f4d6SAlp Dener }
13*5eb5f4d6SAlp Dener 
143850be85SAlp Dener /*MC
153850be85SAlp Dener   TAOBQNKTL - Bounded Quasi-Newton-Krylov Trust-region with Line-search fallback, for nonlinear
163850be85SAlp Dener               minimization with bound constraints. This method approximates the Hessian-vector
173850be85SAlp Dener               product using a limited-memory quasi-Newton formula, and iteratively inverts the
183850be85SAlp Dener               Hessian with a Krylov solver. The quasi-Newton matrix and its settings can be
193850be85SAlp Dener               accessed via the prefix `-tao_bqnk_`
203850be85SAlp Dener 
213850be85SAlp Dener   Options Database Keys:
223850be85SAlp Dener + -tao_bqnk_max_cg_its - maximum number of bounded conjugate-gradient iterations taken in each Newton loop
233850be85SAlp Dener . -tao_bqnk_init_type - trust radius initialization method ("constant", "direction", "interpolation")
243850be85SAlp Dener . -tao_bqnk_update_type - trust radius update method ("step", "direction", "interpolation")
253850be85SAlp Dener - -tao_bqnk_as_type - active-set estimation method ("none", "bertsekas")
263850be85SAlp Dener 
273850be85SAlp Dener   Level: beginner
283850be85SAlp Dener M*/
29e0ed867bSAlp Dener PETSC_EXTERN PetscErrorCode TaoCreate_BQNKTL(Tao tao)
30e0ed867bSAlp Dener {
31414d97d3SAlp Dener   TAO_BNK        *bnk;
32414d97d3SAlp Dener   TAO_BQNK       *bqnk;
33e0ed867bSAlp Dener   PetscErrorCode ierr;
34e0ed867bSAlp Dener 
35e0ed867bSAlp Dener   PetscFunctionBegin;
36e0ed867bSAlp Dener   ierr = TaoCreate_BQNK(tao);CHKERRQ(ierr);
37*5eb5f4d6SAlp Dener   tao->ops->setup = TaoSetUp_BQNKTL;
38414d97d3SAlp Dener   bnk = (TAO_BNK*)tao->data;
39414d97d3SAlp Dener   bqnk = (TAO_BQNK*)bnk->ctx;
40414d97d3SAlp Dener   bqnk->solve = TaoSolve_BNTL;
41e0ed867bSAlp Dener   PetscFunctionReturn(0);
42e0ed867bSAlp Dener }
43