xref: /petsc/src/snes/impls/ngmres/snesngmres.h (revision 9f425c49b5c3655aba6deffb5eb98e039b4692ff)
119653cdaSPeter Brune #ifndef _SNESNGMRES_H
219653cdaSPeter Brune #define _SNESNGMRES_H
319653cdaSPeter Brune 
419653cdaSPeter Brune #include <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 */
11*28ed4a04SPeter Brune   PetscInt     restart_it;     /* number of iterations the restart conditions persist before restart */
12dfbf837cSBarry Smith   PetscViewer  monitor;        /* debugging output for NGMRES */
13*28ed4a04SPeter Brune 
1498b3e84cSPeter Brune   /* History and subspace data */
15f109b39eSPeter Brune   Vec          *Fdot;          /* residual history -- length msize */
16f109b39eSPeter Brune   Vec          *Xdot;          /* solution history -- length msize */
17f109b39eSPeter Brune   PetscReal    *fnorms;        /* the residual norm history  */
1819653cdaSPeter Brune 
1998b3e84cSPeter Brune   /* General minimization problem context */
2098b3e84cSPeter Brune   PetscScalar  *h;             /* the constraint matrix */
2198b3e84cSPeter Brune   PetscScalar  *beta;          /* rhs for the minimization problem */
2298b3e84cSPeter Brune   PetscScalar  *xi;            /* the dot-product of the current and previous res. */
2319653cdaSPeter Brune 
2498b3e84cSPeter Brune   /* Selection constants */
259f425c49SPeter Brune   PetscBool    additive;       /* use additive variant instead of selection */
2698b3e84cSPeter Brune   PetscReal    gammaA;         /* Criterion A residual tolerance */
2798b3e84cSPeter Brune   PetscReal    epsilonB;       /* Criterion B difference tolerance */
2898b3e84cSPeter Brune   PetscReal    deltaB;         /* Criterion B residual tolerance */
2998b3e84cSPeter Brune   PetscReal    gammaC;         /* Restart residual tolerance */
3019653cdaSPeter Brune 
3198b3e84cSPeter Brune   /* LS Minimization solve context */
3298b3e84cSPeter Brune   PetscScalar  *q;             /* the matrix formed as q_ij = (rdot_i, rdot_j) */
3398b3e84cSPeter Brune   PetscBLASInt m;              /* matrix dimension */
3498b3e84cSPeter Brune   PetscBLASInt n;              /* matrix dimension */
3598b3e84cSPeter Brune   PetscBLASInt nrhs;           /* the number of right hand sides */
3698b3e84cSPeter Brune   PetscBLASInt lda;            /* the padded matrix dimension */
3798b3e84cSPeter Brune   PetscBLASInt ldb;            /* the padded vector dimension */
3898b3e84cSPeter Brune   PetscReal    *s;             /* the singular values */
3998b3e84cSPeter Brune   PetscReal    rcond;          /* the exit condition */
4098b3e84cSPeter Brune   PetscBLASInt rank;           /* the effective rank */
4198b3e84cSPeter Brune   PetscScalar  *work;          /* the work vector */
4298b3e84cSPeter Brune   PetscReal    *rwork;         /* the real work vector used for complex */
4398b3e84cSPeter Brune   PetscBLASInt lwork;          /* the size of the work vector */
4498b3e84cSPeter Brune   PetscBLASInt info;           /* the output condition */
4519653cdaSPeter Brune 
4619653cdaSPeter Brune } SNES_NGMRES;
4719653cdaSPeter Brune 
4819653cdaSPeter Brune #define H(i,j)  ngmres->h[i*ngmres->msize + j]
4919653cdaSPeter Brune #define Q(i,j)  ngmres->q[i*ngmres->msize + j]
5019653cdaSPeter Brune 
5119653cdaSPeter Brune #endif
52