xref: /petsc/src/snes/impls/ngmres/snesngmres.h (revision 13a62661d0525ff64d8b6ff69405cd2b20448c7e)
119653cdaSPeter Brune #ifndef _SNESNGMRES_H
219653cdaSPeter Brune #define _SNESNGMRES_H
319653cdaSPeter Brune 
4b45d2f2cSJed Brown #include <petsc-private/snesimpl.h>
519653cdaSPeter Brune 
619653cdaSPeter Brune /*  Data structure for the Nonlinear GMRES method.  */
719653cdaSPeter Brune typedef struct {
819653cdaSPeter Brune 
998b3e84cSPeter Brune   /* Solver parameters and counters */
1098b3e84cSPeter Brune   PetscInt     msize;          /* maximum size of krylov space */
1128ed4a04SPeter Brune   PetscInt     restart_it;     /* number of iterations the restart conditions persist before restart */
12dfbf837cSBarry Smith   PetscViewer  monitor;        /* debugging output for NGMRES */
13*13a62661SPeter Brune   PetscInt    restart_periodic;/* number of iterations to restart after */
14*13a62661SPeter Brune 
15*13a62661SPeter Brune   SNESNGMRESRestartType   restart_type;
16*13a62661SPeter Brune   SNESNGMRESSelectType    select_type;
1728ed4a04SPeter Brune 
1898b3e84cSPeter Brune   /* History and subspace data */
19f109b39eSPeter Brune   Vec          *Fdot;          /* residual history -- length msize */
20f109b39eSPeter Brune   Vec          *Xdot;          /* solution history -- length msize */
21f109b39eSPeter Brune   PetscReal    *fnorms;        /* the residual norm history  */
2218aa0c0cSPeter Brune   PetscReal    *xnorms;        /* the solution norm history */
2319653cdaSPeter Brune 
2498b3e84cSPeter Brune   /* General minimization problem context */
2598b3e84cSPeter Brune   PetscScalar  *h;             /* the constraint matrix */
2698b3e84cSPeter Brune   PetscScalar  *beta;          /* rhs for the minimization problem */
2798b3e84cSPeter Brune   PetscScalar  *xi;            /* the dot-product of the current and previous res. */
2819653cdaSPeter Brune 
29e7058c64SPeter Brune   /* Line searches */
30f1c6b773SPeter Brune   SNESLineSearch   additive_linesearch; /* Line search for the additive variant */
31e7058c64SPeter Brune 
3298b3e84cSPeter Brune   /* Selection constants */
33d2e16ddcSPeter Brune   PetscBool    anderson;       /* use anderson-mixing approach */
3418aa0c0cSPeter Brune   PetscBool    singlereduction;/* use a single reduction (with more local work) for tolerance selection */
3598b3e84cSPeter Brune   PetscReal    gammaA;         /* Criterion A residual tolerance */
3698b3e84cSPeter Brune   PetscReal    epsilonB;       /* Criterion B difference tolerance */
3798b3e84cSPeter Brune   PetscReal    deltaB;         /* Criterion B residual tolerance */
3898b3e84cSPeter Brune   PetscReal    gammaC;         /* Restart residual tolerance */
3919653cdaSPeter Brune 
40e7058c64SPeter Brune   /* Least squares minimization solve context */
4198b3e84cSPeter Brune   PetscScalar  *q;             /* the matrix formed as q_ij = (rdot_i, rdot_j) */
4298b3e84cSPeter Brune   PetscBLASInt m;              /* matrix dimension */
4398b3e84cSPeter Brune   PetscBLASInt n;              /* matrix dimension */
4498b3e84cSPeter Brune   PetscBLASInt nrhs;           /* the number of right hand sides */
4598b3e84cSPeter Brune   PetscBLASInt lda;            /* the padded matrix dimension */
4698b3e84cSPeter Brune   PetscBLASInt ldb;            /* the padded vector dimension */
4798b3e84cSPeter Brune   PetscReal    *s;             /* the singular values */
4898b3e84cSPeter Brune   PetscReal    rcond;          /* the exit condition */
4998b3e84cSPeter Brune   PetscBLASInt rank;           /* the effective rank */
5098b3e84cSPeter Brune   PetscScalar  *work;          /* the work vector */
5198b3e84cSPeter Brune   PetscReal    *rwork;         /* the real work vector used for complex */
5298b3e84cSPeter Brune   PetscBLASInt lwork;          /* the size of the work vector */
5398b3e84cSPeter Brune   PetscBLASInt info;           /* the output condition */
5419653cdaSPeter Brune 
5578440776SJed Brown   PetscBool    setup_called;    /* indicates whether SNESSetUp_NGMRES() has been called  */
5619653cdaSPeter Brune } SNES_NGMRES;
5719653cdaSPeter Brune 
5819653cdaSPeter Brune #define H(i,j)  ngmres->h[i*ngmres->msize + j]
5919653cdaSPeter Brune #define Q(i,j)  ngmres->q[i*ngmres->msize + j]
6019653cdaSPeter Brune 
6119653cdaSPeter Brune #endif
62