xref: /petsc/src/snes/impls/ngmres/snesngmres.h (revision dfbf837ceda522a229a71d32092ab9f9eca39995)
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 */
1198b3e84cSPeter Brune   PetscInt     k_rmax;         /* maximum number of iterations before restart */
12*dfbf837cSBarry Smith   PetscViewer  monitor;          /* debugging output for NGMRES */
1398b3e84cSPeter Brune   /* History and subspace data */
1498b3e84cSPeter Brune   Vec          *rdot;          /* residual history -- length msize */
1598b3e84cSPeter Brune   Vec          *xdot;          /* solution history -- length msize */
1698b3e84cSPeter Brune   PetscReal     *r_norms;      /* the residual norm history  */
1719653cdaSPeter Brune 
1898b3e84cSPeter Brune   /* General minimization problem context */
1998b3e84cSPeter Brune   PetscScalar  *h;             /* the constraint matrix */
2098b3e84cSPeter Brune   PetscScalar  *beta;          /* rhs for the minimization problem */
2198b3e84cSPeter Brune   PetscScalar    *xi;          /* the dot-product of the current and previous res. */
2219653cdaSPeter Brune 
2398b3e84cSPeter Brune   /* Selection constants */
2498b3e84cSPeter Brune   PetscReal gammaA;          /* Criterion A residual tolerance */
2598b3e84cSPeter Brune   PetscReal epsilonB;        /* Criterion B difference tolerance */
2698b3e84cSPeter Brune   PetscReal deltaB;          /* Criterion B residual tolerance */
2798b3e84cSPeter Brune   PetscReal gammaC;          /* Restart residual tolerance */
2819653cdaSPeter Brune 
2998b3e84cSPeter Brune   /* LS Minimization solve context */
3098b3e84cSPeter Brune   PetscScalar  *q;    /* the matrix formed as q_ij = (rdot_i, rdot_j) */
3198b3e84cSPeter Brune   PetscBLASInt m;     /* matrix dimension */
3298b3e84cSPeter Brune   PetscBLASInt n;     /* matrix dimension */
3398b3e84cSPeter Brune   PetscBLASInt nrhs;  /* the number of right hand sides */
3498b3e84cSPeter Brune   PetscBLASInt lda;   /* the padded matrix dimension */
3598b3e84cSPeter Brune   PetscBLASInt ldb;   /* the padded vector dimension */
3698b3e84cSPeter Brune   PetscReal * s;      /* the singular values */
3798b3e84cSPeter Brune   PetscReal rcond;    /* the exit condition */
3898b3e84cSPeter Brune   PetscBLASInt rank;  /* the effective rank */
3998b3e84cSPeter Brune   PetscScalar * work; /* the work vector */
4098b3e84cSPeter Brune   PetscReal  * rwork; /* the real work vector used for complex */
4198b3e84cSPeter Brune   PetscBLASInt lwork; /* the size of the work vector */
4298b3e84cSPeter Brune   PetscBLASInt info;  /* the output condition */
4319653cdaSPeter Brune 
4419653cdaSPeter Brune } SNES_NGMRES;
4519653cdaSPeter Brune 
4619653cdaSPeter Brune #define H(i,j)  ngmres->h[i*ngmres->msize + j]
4719653cdaSPeter Brune #define Q(i,j)  ngmres->q[i*ngmres->msize + j]
4819653cdaSPeter Brune 
4919653cdaSPeter Brune #endif
50