/usr/lib/petscdir/3.4.2/include/petsc-private/kspimpl.h is in libpetsc3.4.2-dev 3.4.2.dfsg1-8.1+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 | #ifndef _KSPIMPL_H
#define _KSPIMPL_H
#include <petscksp.h>
#include <petsc-private/petscimpl.h>
typedef struct _KSPOps *KSPOps;
struct _KSPOps {
PetscErrorCode (*buildsolution)(KSP,Vec,Vec*); /* Returns a pointer to the solution, or
calculates the solution in a
user-provided area. */
PetscErrorCode (*buildresidual)(KSP,Vec,Vec,Vec*); /* Returns a pointer to the residual, or
calculates the residual in a
user-provided area. */
PetscErrorCode (*solve)(KSP); /* actual solver */
PetscErrorCode (*setup)(KSP);
PetscErrorCode (*setfromoptions)(KSP);
PetscErrorCode (*publishoptions)(KSP);
PetscErrorCode (*computeextremesingularvalues)(KSP,PetscReal*,PetscReal*);
PetscErrorCode (*computeeigenvalues)(KSP,PetscInt,PetscReal*,PetscReal*,PetscInt *);
PetscErrorCode (*destroy)(KSP);
PetscErrorCode (*view)(KSP,PetscViewer);
PetscErrorCode (*reset)(KSP);
PetscErrorCode (*load)(KSP,PetscViewer);
};
typedef struct {PetscInt model,curl,maxl;Mat mat; KSP ksp;}* KSPGuessFischer;
/*
Maximum number of monitors you can run with a single KSP
*/
#define MAXKSPMONITORS 5
typedef enum {KSP_SETUP_NEW, KSP_SETUP_NEWMATRIX, KSP_SETUP_NEWRHS} KSPSetUpStage;
/*
Defines the KSP data structure.
*/
struct _p_KSP {
PETSCHEADER(struct _KSPOps);
DM dm;
PetscBool dmAuto; /* DM was created automatically by KSP */
PetscBool dmActive; /* KSP should use DM for computing operators */
/*------------------------- User parameters--------------------------*/
PetscInt max_it; /* maximum number of iterations */
KSPFischerGuess guess;
PetscBool guess_zero, /* flag for whether initial guess is 0 */
calc_sings, /* calculate extreme Singular Values */
guess_knoll; /* use initial guess of PCApply(ksp->B,b */
PCSide pc_side; /* flag for left, right, or symmetric preconditioning */
PetscInt normsupporttable[KSP_NORM_MAX][PC_SIDE_MAX]; /* Table of supported norms and pc_side, see KSPSetSupportedNorm() */
PetscReal rtol, /* relative tolerance */
abstol, /* absolute tolerance */
ttol, /* (not set by user) */
divtol; /* divergence tolerance */
PetscReal rnorm0; /* initial residual norm (used for divergence testing) */
PetscReal rnorm; /* current residual norm */
KSPConvergedReason reason;
PetscBool printreason; /* prints converged reason after solve */
PetscBool errorifnotconverged; /* create an error if the KSPSolve() does not converge */
Vec vec_sol,vec_rhs; /* pointer to where user has stashed
the solution and rhs, these are
never touched by the code, only
passed back to the user */
PetscReal *res_hist; /* If !0 stores residual at iterations*/
PetscReal *res_hist_alloc; /* If !0 means user did not provide buffer, needs deallocation */
PetscInt res_hist_len; /* current size of residual history array */
PetscInt res_hist_max; /* actual amount of data in residual_history */
PetscBool res_hist_reset; /* reset history to size zero for each new solve */
PetscInt chknorm; /* only compute/check norm if iterations is great than this */
PetscBool lagnorm; /* Lag the residual norm calculation so that it is computed as part of the
MPI_Allreduce() for computing the inner products for the next iteration. */
/* --------User (or default) routines (most return -1 on error) --------*/
PetscErrorCode (*monitor[MAXKSPMONITORS])(KSP,PetscInt,PetscReal,void*); /* returns control to user after */
PetscErrorCode (*monitordestroy[MAXKSPMONITORS])(void**); /* */
void *monitorcontext[MAXKSPMONITORS]; /* residual calculation, allows user */
PetscInt numbermonitors; /* to, for instance, print residual norm, etc. */
PetscErrorCode (*converged)(KSP,PetscInt,PetscReal,KSPConvergedReason*,void*);
PetscErrorCode (*convergeddestroy)(void*);
void *cnvP;
void *user; /* optional user-defined context */
PC pc;
void *data; /* holder for misc stuff associated
with a particular iterative solver */
/* ----------------Default work-area management -------------------- */
PetscInt nwork;
Vec *work;
KSPSetUpStage setupstage;
PetscInt its; /* number of iterations so far computed */
PetscBool transpose_solve; /* solve transpose system instead */
KSPNormType normtype; /* type of norm used for convergence tests */
/* Allow diagonally scaling the matrix before computing the preconditioner or using
the Krylov method. Note this is NOT just Jacobi preconditioning */
PetscBool dscale; /* diagonal scale system; used with KSPSetDiagonalScale() */
PetscBool dscalefix; /* unscale system after solve */
PetscBool dscalefix2; /* system has been unscaled */
Vec diagonal; /* 1/sqrt(diag of matrix) */
Vec truediagonal;
MatNullSpace nullsp; /* Null space of the operator, removed from Krylov space */
PetscViewer eigviewer; /* Viewer where computed eigenvalues are displayed */
PetscErrorCode (*presolve)(KSP,Vec,Vec,void*);
PetscErrorCode (*postsolve)(KSP,Vec,Vec,void*);
void *prectx,*postctx;
};
typedef struct { /* dummy data structure used in KSPMonitorDynamicTolerance() */
PetscReal coef;
PetscReal bnrm;
} KSPDynTolCtx;
typedef struct {
PetscBool initialrtol; /* default relative residual decrease is computing from initial residual, not rhs */
PetscBool mininitialrtol; /* default relative residual decrease is computing from min of initial residual and rhs */
Vec work;
} KSPDefaultConvergedCtx;
#undef __FUNCT__
#define __FUNCT__ "KSPLogResidualHistory"
PETSC_STATIC_INLINE PetscErrorCode KSPLogResidualHistory(KSP ksp,PetscReal norm)
{
PetscErrorCode ierr;
PetscFunctionBegin;
ierr = PetscObjectAMSTakeAccess((PetscObject)ksp);CHKERRQ(ierr);
if (ksp->res_hist && ksp->res_hist_max > ksp->res_hist_len) {
ksp->res_hist[ksp->res_hist_len++] = norm;
}
ierr = PetscObjectAMSGrantAccess((PetscObject)ksp);CHKERRQ(ierr);
PetscFunctionReturn(0);
}
PETSC_INTERN PetscErrorCode KSPSetUpNorms_Private(KSP,KSPNormType*,PCSide*);
PETSC_INTERN PetscErrorCode KSPPlotEigenContours_Private(KSP,PetscInt,const PetscReal*,const PetscReal*);
typedef struct _p_DMKSP *DMKSP;
typedef struct _DMKSPOps *DMKSPOps;
struct _DMKSPOps {
PetscErrorCode (*computeoperators)(KSP,Mat,Mat,MatStructure*,void*);
PetscErrorCode (*computerhs)(KSP,Vec,void*);
PetscErrorCode (*computeinitialguess)(KSP,Vec,void*);
PetscErrorCode (*destroy)(DMKSP*);
PetscErrorCode (*duplicate)(DMKSP,DMKSP);
};
struct _p_DMKSP {
PETSCHEADER(struct _DMKSPOps);
void *operatorsctx;
void *rhsctx;
void *initialguessctx;
void *data;
/* This is NOT reference counted. The DM on which this context was first created is cached here to implement one-way
* copy-on-write. When DMGetDMKSPWrite() sees a request using a different DM, it makes a copy. Thus, if a user
* only interacts directly with one level, e.g., using KSPSetComputeOperators(), then coarse levels are constructed by
* PCMG, then the user changes the routine with another call to KSPSetComputeOperators(), it automatically propagates
* to all the levels. If instead, they get out a specific level and set the routines on that level, subsequent changes
* to the original level will no longer propagate to that level.
*/
DM originaldm;
void (*fortran_func_pointers[3])(void); /* Store our own function pointers so they are associated with the DMKSP instead of the DM */
};
PETSC_EXTERN PetscErrorCode DMGetDMKSP(DM,DMKSP*);
PETSC_EXTERN PetscErrorCode DMGetDMKSPWrite(DM,DMKSP*);
PETSC_EXTERN PetscErrorCode DMCopyDMKSP(DM,DM);
/*
These allow the various Krylov methods to apply to either the linear system or its transpose.
*/
#undef __FUNCT__
#define __FUNCT__ "KSP_RemoveNullSpace"
PETSC_STATIC_INLINE PetscErrorCode KSP_RemoveNullSpace(KSP ksp,Vec y)
{
PetscErrorCode ierr;
PetscFunctionBegin;
if (ksp->nullsp && ksp->pc_side == PC_LEFT) {ierr = MatNullSpaceRemove(ksp->nullsp,y,NULL);CHKERRQ(ierr);}
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "KSP_MatMult"
PETSC_STATIC_INLINE PetscErrorCode KSP_MatMult(KSP ksp,Mat A,Vec x,Vec y)
{
PetscErrorCode ierr;
PetscFunctionBegin;
if (!ksp->transpose_solve) {ierr = MatMult(A,x,y);CHKERRQ(ierr);}
else {ierr = MatMultTranspose(A,x,y);CHKERRQ(ierr);}
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "KSP_MatMultTranspose"
PETSC_STATIC_INLINE PetscErrorCode KSP_MatMultTranspose(KSP ksp,Mat A,Vec x,Vec y)
{
PetscErrorCode ierr;
PetscFunctionBegin;
if (!ksp->transpose_solve) {ierr = MatMultTranspose(A,x,y);CHKERRQ(ierr);}
else {ierr = MatMult(A,x,y);CHKERRQ(ierr);}
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "KSP_PCApply"
PETSC_STATIC_INLINE PetscErrorCode KSP_PCApply(KSP ksp,Vec x,Vec y)
{
PetscErrorCode ierr;
PetscFunctionBegin;
if (!ksp->transpose_solve) {
ierr = PCApply(ksp->pc,x,y);CHKERRQ(ierr);
ierr = KSP_RemoveNullSpace(ksp,y);CHKERRQ(ierr);
} else {
ierr = PCApplyTranspose(ksp->pc,x,y);CHKERRQ(ierr);
}
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "KSP_PCApplyTranspose"
PETSC_STATIC_INLINE PetscErrorCode KSP_PCApplyTranspose(KSP ksp,Vec x,Vec y)
{
PetscErrorCode ierr;
PetscFunctionBegin;
if (!ksp->transpose_solve) {
ierr = PCApplyTranspose(ksp->pc,x,y);CHKERRQ(ierr);
} else {
ierr = PCApply(ksp->pc,x,y);CHKERRQ(ierr);
ierr = KSP_RemoveNullSpace(ksp,y);CHKERRQ(ierr);
}
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "KSP_PCApplyBAorAB"
PETSC_STATIC_INLINE PetscErrorCode KSP_PCApplyBAorAB(KSP ksp,Vec x,Vec y,Vec w)
{
PetscErrorCode ierr;
PetscFunctionBegin;
if (!ksp->transpose_solve) {
ierr = PCApplyBAorAB(ksp->pc,ksp->pc_side,x,y,w);CHKERRQ(ierr);
ierr = KSP_RemoveNullSpace(ksp,y);CHKERRQ(ierr);
} else {
ierr = PCApplyBAorABTranspose(ksp->pc,ksp->pc_side,x,y,w);CHKERRQ(ierr);
}
PetscFunctionReturn(0);
}
#undef __FUNCT__
#define __FUNCT__ "KSP_PCApplyBAorABTranspose"
PETSC_STATIC_INLINE PetscErrorCode KSP_PCApplyBAorABTranspose(KSP ksp,Vec x,Vec y,Vec w)
{
PetscErrorCode ierr;
PetscFunctionBegin;
if (!ksp->transpose_solve) {
ierr = PCApplyBAorABTranspose(ksp->pc,ksp->pc_side,x,y,w);CHKERRQ(ierr);
ierr = KSP_RemoveNullSpace(ksp,y);CHKERRQ(ierr);
} else {
ierr = PCApplyBAorAB(ksp->pc,ksp->pc_side,x,y,w);CHKERRQ(ierr);
}
PetscFunctionReturn(0);
}
PETSC_EXTERN PetscLogEvent KSP_GMRESOrthogonalization, KSP_SetUp, KSP_Solve;
PETSC_INTERN PetscErrorCode MatGetSchurComplement_Basic(Mat,IS,IS,IS,IS,MatReuse,Mat*,MatReuse,Mat*);
#endif
|