xref: /petsc/src/tao/bound/impls/bqnk/bqnktr.c (revision 5eb5f4d688081cf9b72ac57052277e637d17a8ab)
1e0ed867bSAlp Dener #include <../src/tao/bound/impls/bqnk/bqnk.h>
2e0ed867bSAlp Dener #include <petscksp.h>
3*5eb5f4d6SAlp Dener 
4*5eb5f4d6SAlp Dener static PetscErrorCode TaoSetUp_BQNKTR(Tao tao)
5*5eb5f4d6SAlp Dener {
6*5eb5f4d6SAlp Dener   TAO_BNK         *bnk = (TAO_BNK*)tao->data;
7*5eb5f4d6SAlp Dener   PetscErrorCode ierr;
8*5eb5f4d6SAlp Dener 
9*5eb5f4d6SAlp Dener   PetscFunctionBegin;
10*5eb5f4d6SAlp Dener   ierr = TaoSetUp_BQNK(tao);CHKERRQ(ierr);
11*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)");
12*5eb5f4d6SAlp Dener   PetscFunctionReturn(0);
13*5eb5f4d6SAlp Dener }
14*5eb5f4d6SAlp Dener 
153850be85SAlp Dener /*MC
163850be85SAlp Dener   TAOBQNKTR - Bounded Quasi-Newton-Krylov Trust Region method for nonlinear minimization with
173850be85SAlp Dener               bound constraints. This method approximates the Hessian-vector product using a
183850be85SAlp Dener               limited-memory quasi-Newton formula, and iteratively inverts the Hessian with a
193850be85SAlp Dener               Krylov solver. The quasi-Newton matrix and its settings can be accessed via the
203850be85SAlp Dener               prefix `-tao_bqnk_`
21e0ed867bSAlp Dener 
223850be85SAlp Dener   Options Database Keys:
233850be85SAlp Dener + -tao_bqnk_max_cg_its - maximum number of bounded conjugate-gradient iterations taken in each Newton loop
243850be85SAlp Dener . -tao_bqnk_init_type - trust radius initialization method ("constant", "direction", "interpolation")
253850be85SAlp Dener . -tao_bqnk_update_type - trust radius update method ("step", "direction", "interpolation")
263850be85SAlp Dener - -tao_bqnk_as_type - active-set estimation method ("none", "bertsekas")
273850be85SAlp Dener 
283850be85SAlp Dener   Level: beginner
293850be85SAlp Dener M*/
30e0ed867bSAlp Dener PETSC_EXTERN PetscErrorCode TaoCreate_BQNKTR(Tao tao)
31e0ed867bSAlp Dener {
32414d97d3SAlp Dener   TAO_BNK        *bnk;
33414d97d3SAlp Dener   TAO_BQNK       *bqnk;
34e0ed867bSAlp Dener   PetscErrorCode ierr;
35e0ed867bSAlp Dener 
36e0ed867bSAlp Dener   PetscFunctionBegin;
37e0ed867bSAlp Dener   ierr = TaoCreate_BQNK(tao);CHKERRQ(ierr);
38*5eb5f4d6SAlp Dener   tao->ops->setup = TaoSetUp_BQNKTR;
39414d97d3SAlp Dener   bnk = (TAO_BNK*)tao->data;
40414d97d3SAlp Dener   bqnk = (TAO_BQNK*)bnk->ctx;
41414d97d3SAlp Dener   bqnk->solve = TaoSolve_BNTR;
42e0ed867bSAlp Dener   PetscFunctionReturn(0);
43e0ed867bSAlp Dener }
44