Actual source code: cr.c
petsc-3.12.2 2019-11-22
2: #include <petsc/private/kspimpl.h>
4: static PetscErrorCode KSPSetUp_CR(KSP ksp)
5: {
9: if (ksp->pc_side == PC_RIGHT) SETERRQ(PetscObjectComm((PetscObject)ksp),PETSC_ERR_SUP,"no right preconditioning for KSPCR");
10: else if (ksp->pc_side == PC_SYMMETRIC) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"no symmetric preconditioning for KSPCR");
11: KSPSetWorkVecs(ksp,6);
12: return(0);
13: }
15: static PetscErrorCode KSPSolve_CR(KSP ksp)
16: {
18: PetscInt i = 0;
19: PetscReal dp;
20: PetscScalar ai, bi;
21: PetscScalar apq,btop, bbot;
22: Vec X,B,R,RT,P,AP,ART,Q;
23: Mat Amat, Pmat;
26: X = ksp->vec_sol;
27: B = ksp->vec_rhs;
28: R = ksp->work[0];
29: RT = ksp->work[1];
30: P = ksp->work[2];
31: AP = ksp->work[3];
32: ART = ksp->work[4];
33: Q = ksp->work[5];
35: /* R is the true residual norm, RT is the preconditioned residual norm */
36: PCGetOperators(ksp->pc,&Amat,&Pmat);
37: if (!ksp->guess_zero) {
38: KSP_MatMult(ksp,Amat,X,R); /* R <- A*X */
39: VecAYPX(R,-1.0,B); /* R <- B-R == B-A*X */
40: } else {
41: VecCopy(B,R); /* R <- B (X is 0) */
42: }
43: KSP_PCApply(ksp,R,P); /* P <- B*R */
44: KSP_MatMult(ksp,Amat,P,AP); /* AP <- A*P */
45: VecCopy(P,RT); /* RT <- P */
46: VecCopy(AP,ART); /* ART <- AP */
47: VecDotBegin(RT,ART,&btop); /* (RT,ART) */
49: if (ksp->normtype == KSP_NORM_PRECONDITIONED) {
50: VecNormBegin(RT,NORM_2,&dp); /* dp <- RT'*RT */
51: VecDotEnd (RT,ART,&btop); /* (RT,ART) */
52: VecNormEnd (RT,NORM_2,&dp); /* dp <- RT'*RT */
53: KSPCheckNorm(ksp,dp);
54: } else if (ksp->normtype == KSP_NORM_NONE) {
55: dp = 0.0; /* meaningless value that is passed to monitor and convergence test */
56: } else if (ksp->normtype == KSP_NORM_UNPRECONDITIONED) {
57: VecNormBegin(R,NORM_2,&dp); /* dp <- R'*R */
58: VecDotEnd (RT,ART,&btop); /* (RT,ART) */
59: VecNormEnd (R,NORM_2,&dp); /* dp <- RT'*RT */
60: KSPCheckNorm(ksp,dp);
61: } else if (ksp->normtype == KSP_NORM_NATURAL) {
62: VecDotEnd (RT,ART,&btop); /* (RT,ART) */
63: dp = PetscSqrtReal(PetscAbsScalar(btop)); /* dp = sqrt(R,AR) */
64: } else SETERRQ1(PetscObjectComm((PetscObject)ksp),PETSC_ERR_SUP,"KSPNormType of %d not supported",(int)ksp->normtype);
65: if (PetscAbsScalar(btop) < 0.0) {
66: ksp->reason = KSP_DIVERGED_INDEFINITE_MAT;
67: PetscInfo(ksp,"diverging due to indefinite or negative definite matrix\n");
68: return(0);
69: }
71: ksp->its = 0;
72: KSPMonitor(ksp,0,dp);
73: PetscObjectSAWsTakeAccess((PetscObject)ksp);
74: ksp->rnorm = dp;
75: PetscObjectSAWsGrantAccess((PetscObject)ksp);
76: KSPLogResidualHistory(ksp,dp);
77: (*ksp->converged)(ksp,0,dp,&ksp->reason,ksp->cnvP);
78: if (ksp->reason) return(0);
80: i = 0;
81: do {
82: KSP_PCApply(ksp,AP,Q); /* Q <- B* AP */
84: VecDot(AP,Q,&apq);
85: KSPCheckDot(ksp,apq);
86: if (PetscRealPart(apq) <= 0.0) {
87: ksp->reason = KSP_DIVERGED_INDEFINITE_PC;
88: PetscInfo(ksp,"KSPSolve_CR:diverging due to indefinite or negative definite PC\n");
89: break;
90: }
91: ai = btop/apq; /* ai = (RT,ART)/(AP,Q) */
93: VecAXPY(X,ai,P); /* X <- X + ai*P */
94: VecAXPY(RT,-ai,Q); /* RT <- RT - ai*Q */
95: KSP_MatMult(ksp,Amat,RT,ART); /* ART <- A*RT */
96: bbot = btop;
97: VecDotBegin(RT,ART,&btop);
99: if (ksp->normtype == KSP_NORM_PRECONDITIONED) {
100: VecNormBegin(RT,NORM_2,&dp); /* dp <- || RT || */
101: VecDotEnd (RT,ART,&btop);
102: VecNormEnd (RT,NORM_2,&dp); /* dp <- || RT || */
103: KSPCheckNorm(ksp,dp);
104: } else if (ksp->normtype == KSP_NORM_NATURAL) {
105: VecDotEnd(RT,ART,&btop);
106: dp = PetscSqrtReal(PetscAbsScalar(btop)); /* dp = sqrt(R,AR) */
107: } else if (ksp->normtype == KSP_NORM_NONE) {
108: VecDotEnd(RT,ART,&btop);
109: dp = 0.0; /* meaningless value that is passed to monitor and convergence test */
110: } else if (ksp->normtype == KSP_NORM_UNPRECONDITIONED) {
111: VecAXPY(R,ai,AP); /* R <- R - ai*AP */
112: VecNormBegin(R,NORM_2,&dp); /* dp <- R'*R */
113: VecDotEnd (RT,ART,&btop);
114: VecNormEnd (R,NORM_2,&dp); /* dp <- R'*R */
115: KSPCheckNorm(ksp,dp);
116: } else SETERRQ1(PetscObjectComm((PetscObject)ksp),PETSC_ERR_SUP,"KSPNormType of %d not supported",(int)ksp->normtype);
117: if (PetscAbsScalar(btop) < 0.0) {
118: ksp->reason = KSP_DIVERGED_INDEFINITE_MAT;
119: PetscInfo(ksp,"diverging due to indefinite or negative definite PC\n");
120: break;
121: }
123: PetscObjectSAWsTakeAccess((PetscObject)ksp);
124: ksp->its++;
125: ksp->rnorm = dp;
126: PetscObjectSAWsGrantAccess((PetscObject)ksp);
128: KSPLogResidualHistory(ksp,dp);
129: KSPMonitor(ksp,i+1,dp);
130: (*ksp->converged)(ksp,i+1,dp,&ksp->reason,ksp->cnvP);
131: if (ksp->reason) break;
133: bi = btop/bbot;
134: VecAYPX(P,bi,RT); /* P <- RT + Bi P */
135: VecAYPX(AP,bi,ART); /* AP <- ART + Bi AP */
136: i++;
137: } while (i<ksp->max_it);
138: if (i >= ksp->max_it) ksp->reason = KSP_DIVERGED_ITS;
139: return(0);
140: }
143: /*MC
144: KSPCR - This code implements the (preconditioned) conjugate residuals method
146: Options Database Keys:
147: . see KSPSolve()
149: Level: beginner
151: Notes:
152: The operator and the preconditioner must be symmetric for this method. The
153: preconditioner must be POSITIVE-DEFINITE and the operator POSITIVE-SEMIDEFINITE.
154: Support only for left preconditioning.
156: References:
157: . 1. - Magnus R. Hestenes and Eduard Stiefel, Methods of Conjugate Gradients for Solving Linear Systems,
158: Journal of Research of the National Bureau of Standards Vol. 49, No. 6, December 1952 Research Paper 2379
160: .seealso: KSPCreate(), KSPSetType(), KSPType (for list of available types), KSP, KSPCG
161: M*/
162: PETSC_EXTERN PetscErrorCode KSPCreate_CR(KSP ksp)
163: {
167: KSPSetSupportedNorm(ksp,KSP_NORM_PRECONDITIONED,PC_LEFT,3);
168: KSPSetSupportedNorm(ksp,KSP_NORM_UNPRECONDITIONED,PC_LEFT,2);
169: KSPSetSupportedNorm(ksp,KSP_NORM_NATURAL,PC_LEFT,2);
170: KSPSetSupportedNorm(ksp,KSP_NORM_NONE,PC_LEFT,1);
172: ksp->ops->setup = KSPSetUp_CR;
173: ksp->ops->solve = KSPSolve_CR;
174: ksp->ops->destroy = KSPDestroyDefault;
175: ksp->ops->buildsolution = KSPBuildSolutionDefault;
176: ksp->ops->buildresidual = KSPBuildResidualDefault;
177: ksp->ops->setfromoptions = 0;
178: ksp->ops->view = 0;
179: return(0);
180: }