Actual source code: tsirm.c
1: #include <petsc/private/kspimpl.h>
3: typedef struct {
4: PetscReal tol_ls;
5: PetscInt size_ls, maxiter_ls, cgls, size, Istart, Iend;
6: Mat A, S;
7: Vec Alpha, r;
8: } KSP_TSIRM;
10: static PetscErrorCode KSPSetUp_TSIRM(KSP ksp)
11: {
12: KSP_TSIRM *tsirm = (KSP_TSIRM *)ksp->data;
14: PetscFunctionBegin;
15: /* Initialization */
16: #if defined(PETSC_USE_REAL_SINGLE)
17: tsirm->tol_ls = 1e-25;
18: #else
19: tsirm->tol_ls = 1e-50;
20: #endif
21: tsirm->size_ls = 12;
22: tsirm->maxiter_ls = 15;
23: tsirm->cgls = 0;
25: /* Matrix of the system */
26: PetscCall(KSPGetOperators(ksp, &tsirm->A, NULL)); /* Matrix of the system */
27: PetscCall(MatGetSize(tsirm->A, &tsirm->size, NULL)); /* Size of the system */
28: PetscCall(MatGetOwnershipRange(tsirm->A, &tsirm->Istart, &tsirm->Iend));
30: /* Matrix S of residuals */
31: PetscCall(MatCreate(PetscObjectComm((PetscObject)ksp), &tsirm->S));
32: PetscCall(MatSetSizes(tsirm->S, tsirm->Iend - tsirm->Istart, PETSC_DECIDE, tsirm->size, tsirm->size_ls));
33: PetscCall(MatSetType(tsirm->S, MATDENSE));
34: PetscCall(MatSetUp(tsirm->S));
36: /* Residual and vector Alpha computed in the minimization step */
37: PetscCall(MatCreateVecs(tsirm->S, &tsirm->Alpha, &tsirm->r));
38: PetscFunctionReturn(PETSC_SUCCESS);
39: }
41: static PetscErrorCode KSPSolve_TSIRM(KSP ksp)
42: {
43: KSP_TSIRM *tsirm = (KSP_TSIRM *)ksp->data;
44: KSP sub_ksp;
45: PC pc;
46: Mat AS = NULL;
47: Vec x, b;
48: PetscScalar *array;
49: PetscReal norm = 20;
50: PetscInt i, *ind_row, first_iteration = 1, its = 0, total = 0, col = 0;
51: KSP ksp_min; /* KSP for minimization */
52: PC pc_min; /* PC for minimization */
53: PetscBool isksp;
55: PetscFunctionBegin;
56: x = ksp->vec_sol; /* Solution vector */
57: b = ksp->vec_rhs; /* Right-hand side vector */
59: /* Row indexes (these indexes are global) */
60: PetscCall(PetscMalloc1(tsirm->Iend - tsirm->Istart, &ind_row));
61: for (i = 0; i < tsirm->Iend - tsirm->Istart; i++) ind_row[i] = i + tsirm->Istart;
63: /* Inner solver */
64: PetscCall(KSPGetPC(ksp, &pc));
65: PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCKSP, &isksp));
66: PetscCheck(isksp, PetscObjectComm((PetscObject)pc), PETSC_ERR_USER, "PC must be of type PCKSP");
67: PetscCall(PCKSPGetKSP(pc, &sub_ksp));
69: /* previously it seemed good but with SNES it seems not good... */
70: PetscCall(KSP_MatMult(sub_ksp, tsirm->A, x, tsirm->r));
71: PetscCall(VecAXPY(tsirm->r, -1, b));
72: PetscCall(VecNorm(tsirm->r, NORM_2, &norm));
73: KSPCheckNorm(ksp, norm);
74: ksp->its = 0;
75: PetscCall(KSPConvergedDefault(ksp, ksp->its, norm, &ksp->reason, ksp->cnvP));
76: PetscCall(KSPMonitor(ksp, ksp->its, norm));
77: PetscCall(KSPSetInitialGuessNonzero(sub_ksp, PETSC_TRUE));
78: do {
79: for (col = 0; col < tsirm->size_ls && ksp->reason == KSP_CONVERGED_ITERATING; col++) {
80: /* Solve (inner iteration) */
81: PetscCall(KSPSolve(sub_ksp, b, x));
82: PetscCall(KSPGetIterationNumber(sub_ksp, &its));
83: total += its;
85: /* Build S^T */
86: PetscCall(VecGetArray(x, &array));
87: PetscCall(MatSetValues(tsirm->S, tsirm->Iend - tsirm->Istart, ind_row, 1, &col, array, INSERT_VALUES));
88: PetscCall(VecRestoreArray(x, &array));
90: PetscCall(KSPGetResidualNorm(sub_ksp, &norm));
91: ksp->rnorm = norm;
92: ksp->its++;
93: PetscCall(KSPConvergedDefault(ksp, ksp->its, norm, &ksp->reason, ksp->cnvP));
94: PetscCall(KSPMonitor(ksp, ksp->its, norm));
95: }
97: /* Minimization step */
98: if (ksp->reason == KSP_CONVERGED_ITERATING) {
99: PetscCall(MatAssemblyBegin(tsirm->S, MAT_FINAL_ASSEMBLY));
100: PetscCall(MatAssemblyEnd(tsirm->S, MAT_FINAL_ASSEMBLY));
101: if (first_iteration) {
102: PetscCall(MatMatMult(tsirm->A, tsirm->S, MAT_INITIAL_MATRIX, PETSC_DEFAULT, &AS));
103: first_iteration = 0;
104: } else {
105: PetscCall(MatMatMult(tsirm->A, tsirm->S, MAT_REUSE_MATRIX, PETSC_DEFAULT, &AS));
106: }
108: /* CGLS or LSQR method to minimize the residuals*/
109: PetscCall(KSPCreate(PetscObjectComm((PetscObject)ksp), &ksp_min));
110: if (tsirm->cgls) {
111: PetscCall(KSPSetType(ksp_min, KSPCGLS));
112: } else {
113: PetscCall(KSPSetType(ksp_min, KSPLSQR));
114: }
115: PetscCall(KSPSetOperators(ksp_min, AS, AS));
116: PetscCall(KSPSetTolerances(ksp_min, tsirm->tol_ls, PETSC_DEFAULT, PETSC_DEFAULT, tsirm->maxiter_ls));
117: PetscCall(KSPGetPC(ksp_min, &pc_min));
118: PetscCall(PCSetType(pc_min, PCNONE));
119: PetscCall(KSPSolve(ksp_min, b, tsirm->Alpha)); /* Find Alpha such that ||AS Alpha = b|| */
120: PetscCall(KSPDestroy(&ksp_min));
121: /* Apply minimization */
122: PetscCall(MatMult(tsirm->S, tsirm->Alpha, x)); /* x = S * Alpha */
123: }
124: } while (ksp->its < ksp->max_it && !ksp->reason);
125: PetscCall(MatDestroy(&AS));
126: PetscCall(PetscFree(ind_row));
127: ksp->its = total;
128: PetscFunctionReturn(PETSC_SUCCESS);
129: }
131: static PetscErrorCode KSPSetFromOptions_TSIRM(KSP ksp, PetscOptionItems *PetscOptionsObject)
132: {
133: KSP_TSIRM *tsirm = (KSP_TSIRM *)ksp->data;
135: PetscFunctionBegin;
136: PetscOptionsHeadBegin(PetscOptionsObject, "KSP TSIRM options");
137: PetscCall(PetscOptionsInt("-ksp_tsirm_cgls", "Method used for the minimization step", "", tsirm->cgls, &tsirm->cgls, NULL)); /*0:LSQR, 1:CGLS*/
138: PetscCall(PetscOptionsReal("-ksp_tsirm_tol_ls", "Tolerance threshold for the minimization step", "", tsirm->tol_ls, &tsirm->tol_ls, NULL));
139: PetscCall(PetscOptionsInt("-ksp_tsirm_max_it_ls", "Maximum number of iterations for the minimization step", "", tsirm->maxiter_ls, &tsirm->maxiter_ls, NULL));
140: PetscCall(PetscOptionsInt("-ksp_tsirm_size_ls", "Number of residuals for minimization", "", tsirm->size_ls, &tsirm->size_ls, NULL));
141: PetscOptionsHeadEnd();
142: PetscFunctionReturn(PETSC_SUCCESS);
143: }
145: static PetscErrorCode KSPDestroy_TSIRM(KSP ksp)
146: {
147: KSP_TSIRM *tsirm = (KSP_TSIRM *)ksp->data;
149: PetscFunctionBegin;
150: PetscCall(MatDestroy(&tsirm->S));
151: PetscCall(VecDestroy(&tsirm->Alpha));
152: PetscCall(VecDestroy(&tsirm->r));
153: PetscCall(PetscFree(ksp->data));
154: PetscFunctionReturn(PETSC_SUCCESS);
155: }
157: /*MC
158: KSPTSIRM - Implements the two-stage iteration with least-squares residual minimization method {cite}`couturier2016tsirm`
160: Options Database Keys:
161: + -ksp_ksp_type <solver> - the type of the inner solver (GMRES or any of its variants for instance)
162: . -ksp_pc_type <preconditioner> - the type of the preconditioner applied to the inner solver
163: . -ksp_ksp_max_it <maxits> - the maximum number of inner iterations (iterations of the inner solver)
164: . -ksp_ksp_rtol <tol> - sets the relative convergence tolerance of the inner solver
165: . -ksp_tsirm_cgls <number> - if 1 use CGLS solver in the minimization step, otherwise use LSQR solver
166: . -ksp_tsirm_max_it_ls <maxits> - the maximum number of iterations for the least-squares minimization solver
167: . -ksp_tsirm_tol_ls <tol> - sets the convergence tolerance of the least-squares minimization solver
168: - -ksp_tsirm_size_ls <size> - the number of residuals for the least-squares minimization step
170: Level: advanced
172: Notes:
173: `KSPTSIRM` is a two-stage iteration method for solving large sparse linear systems of the form $Ax=b$. The main idea behind this new
174: method is the use a least-squares residual minimization to improve the convergence of Krylov based iterative methods, typically those of GMRES variants.
175: The principle of `TSIRM` algorithm is to build an outer iteration over a Krylov method, called the inner solver, and to frequently store the current residual
176: computed by the given Krylov method in a matrix of residuals S. After a few outer iterations, a least-squares minimization step is applied on the matrix
177: composed by the saved residuals, in order to compute a better solution and to make new iterations if required.
178: The minimization step consists in solving the least-squares problem $\min||b-ASa||$ to find 'a' which minimizes the
179: residuals $(b-AS)$. The minimization step is performed using two solvers of linear least-squares problems: `KSPCGLS` or `KSPLSQR`. A new solution x with
180: a minimal residual is computed with $x=Sa$.
182: Defaults to 30 iterations for the inner solve, use option `-ksp_ksp_max_it <it>` to change it.
184: Contributed by:
185: Lilia Ziane Khodja
187: .seealso: [](ch_ksp), `KSPCreate()`, `KSPSetType()`, `KSPType`, `KSP`, `KSPFGMRES`, `KSPLGMRES`,
188: `KSPGMRESSetRestart()`, `KSPGMRESSetHapTol()`, `KSPGMRESSetPreAllocateVectors()`, `KSPGMRESSetOrthogonalization()`, `KSPGMRESGetOrthogonalization()`,
189: `KSPGMRESClassicalGramSchmidtOrthogonalization()`, `KSPGMRESModifiedGramSchmidtOrthogonalization()`,
190: `KSPGMRESCGSRefinementType`, `KSPGMRESSetCGSRefinementType()`, `KSPGMRESGetCGSRefinementType()`, `KSPGMRESMonitorKrylov()`, `KSPSetPCSide()`
191: M*/
192: PETSC_EXTERN PetscErrorCode KSPCreate_TSIRM(KSP ksp)
193: {
194: KSP_TSIRM *tsirm;
195: PC pc;
196: KSP sub_ksp;
198: PetscFunctionBegin;
199: PetscCall(PetscNew(&tsirm));
200: ksp->data = (void *)tsirm;
201: PetscCall(KSPSetSupportedNorm(ksp, KSP_NORM_PRECONDITIONED, PC_LEFT, 2));
202: PetscCall(KSPSetSupportedNorm(ksp, KSP_NORM_UNPRECONDITIONED, PC_RIGHT, 1));
203: ksp->ops->setup = KSPSetUp_TSIRM;
204: ksp->ops->solve = KSPSolve_TSIRM;
205: ksp->ops->destroy = KSPDestroy_TSIRM;
206: ksp->ops->buildsolution = KSPBuildSolutionDefault;
207: ksp->ops->buildresidual = KSPBuildResidualDefault;
208: ksp->ops->setfromoptions = KSPSetFromOptions_TSIRM;
209: ksp->ops->view = NULL;
211: PetscCall(KSPGetPC(ksp, &pc));
212: PetscCall(PCSetType(pc, PCKSP));
213: PetscCall(PCKSPGetKSP(pc, &sub_ksp));
214: PetscCall(KSPSetTolerances(sub_ksp, PETSC_DEFAULT, PETSC_DEFAULT, PETSC_DEFAULT, 30));
215: #if defined(PETSC_USE_COMPLEX)
216: SETERRQ(PetscObjectComm((PetscObject)ksp), PETSC_ERR_SUP, "This is not supported for complex numbers");
217: #else
218: PetscFunctionReturn(PETSC_SUCCESS);
219: #endif
220: }