1 2 /* 3 This file implements FBiCGStab-R. 4 Only allow right preconditioning. 5 FBiCGStab-R is a mathematically equivalent variant of FBiCGStab. Differences are: 6 (1) There are fewer MPI_Allreduce calls. 7 (2) The convergence occasionally is much faster than that of FBiCGStab. 8 */ 9 #include <../src/ksp/ksp/impls/bcgs/bcgsimpl.h> /*I "petscksp.h" I*/ 10 #include <petsc-private/vecimpl.h> 11 12 #undef __FUNCT__ 13 #define __FUNCT__ "KSPSetUp_FBCGSR" 14 PetscErrorCode KSPSetUp_FBCGSR(KSP ksp) 15 { 16 PetscErrorCode ierr; 17 18 PetscFunctionBegin; 19 ierr = KSPSetWorkVecs(ksp,8);CHKERRQ(ierr); 20 PetscFunctionReturn(0); 21 } 22 23 #include <petsc-private/pcimpl.h> /*I "petscksp.h" I*/ 24 #undef __FUNCT__ 25 #define __FUNCT__ "KSPSolve_FBCGSR" 26 PetscErrorCode KSPSolve_FBCGSR(KSP ksp) 27 { 28 PetscErrorCode ierr; 29 PetscInt i,j,N; 30 PetscScalar tau,sigma,alpha,omega,beta; 31 PetscReal rho; 32 PetscScalar xi1,xi2,xi3,xi4; 33 Vec X,B,P,P2,RP,R,V,S,T,S2; 34 PetscScalar *PETSC_RESTRICT rp, *PETSC_RESTRICT r, *PETSC_RESTRICT p; 35 PetscScalar *PETSC_RESTRICT v, *PETSC_RESTRICT s, *PETSC_RESTRICT t, *PETSC_RESTRICT s2; 36 PetscScalar insums[4],outsums[4]; 37 KSP_BCGS *bcgs = (KSP_BCGS*)ksp->data; 38 PC pc; 39 40 PetscFunctionBegin; 41 if (!ksp->vec_rhs->petscnative) SETERRQ(PetscObjectComm((PetscObject)ksp),PETSC_ERR_SUP,"Only coded for PETSc vectors"); 42 ierr = VecGetLocalSize(ksp->vec_sol,&N);CHKERRQ(ierr); 43 44 X = ksp->vec_sol; 45 B = ksp->vec_rhs; 46 P2 = ksp->work[0]; 47 48 /* The followings are involved in modified inner product calculations and vector updates */ 49 RP = ksp->work[1]; ierr = VecGetArray(RP,(PetscScalar**)&rp);CHKERRQ(ierr); ierr = VecRestoreArray(RP,NULL);CHKERRQ(ierr); 50 R = ksp->work[2]; ierr = VecGetArray(R,(PetscScalar**)&r);CHKERRQ(ierr); ierr = VecRestoreArray(R,NULL);CHKERRQ(ierr); 51 P = ksp->work[3]; ierr = VecGetArray(P,(PetscScalar**)&p);CHKERRQ(ierr); ierr = VecRestoreArray(P,NULL);CHKERRQ(ierr); 52 V = ksp->work[4]; ierr = VecGetArray(V,(PetscScalar**)&v);CHKERRQ(ierr); ierr = VecRestoreArray(V,NULL);CHKERRQ(ierr); 53 S = ksp->work[5]; ierr = VecGetArray(S,(PetscScalar**)&s);CHKERRQ(ierr); ierr = VecRestoreArray(S,NULL);CHKERRQ(ierr); 54 T = ksp->work[6]; ierr = VecGetArray(T,(PetscScalar**)&t);CHKERRQ(ierr); ierr = VecRestoreArray(T,NULL);CHKERRQ(ierr); 55 S2 = ksp->work[7]; ierr = VecGetArray(S2,(PetscScalar**)&s2);CHKERRQ(ierr); ierr = VecRestoreArray(S2,NULL);CHKERRQ(ierr); 56 57 /* Only supports right preconditioning */ 58 if (ksp->pc_side != PC_RIGHT) SETERRQ1(PetscObjectComm((PetscObject)ksp),PETSC_ERR_SUP,"KSP fbcgsr does not support %s",PCSides[ksp->pc_side]); 59 if (!ksp->guess_zero) { 60 if (!bcgs->guess) { 61 ierr = VecDuplicate(X,&bcgs->guess);CHKERRQ(ierr); 62 } 63 ierr = VecCopy(X,bcgs->guess);CHKERRQ(ierr); 64 } else { 65 ierr = VecSet(X,0.0);CHKERRQ(ierr); 66 } 67 68 /* Compute initial residual */ 69 ierr = KSPGetPC(ksp,&pc);CHKERRQ(ierr); 70 ierr = PCSetUp(pc);CHKERRQ(ierr); 71 if (!ksp->guess_zero) { 72 ierr = MatMult(pc->mat,X,P2);CHKERRQ(ierr); /* P2 is used as temporary storage */ 73 ierr = VecCopy(B,R);CHKERRQ(ierr); 74 ierr = VecAXPY(R,-1.0,P2);CHKERRQ(ierr); 75 } else { 76 ierr = VecCopy(B,R);CHKERRQ(ierr); 77 } 78 79 /* Test for nothing to do */ 80 if (ksp->normtype != KSP_NORM_NONE) { 81 ierr = VecNorm(R,NORM_2,&rho);CHKERRQ(ierr); 82 } 83 ierr = PetscObjectSAWsTakeAccess((PetscObject)ksp);CHKERRQ(ierr); 84 ksp->its = 0; 85 ksp->rnorm = rho; 86 ierr = PetscObjectSAWsGrantAccess((PetscObject)ksp);CHKERRQ(ierr); 87 ierr = KSPLogResidualHistory(ksp,rho);CHKERRQ(ierr); 88 ierr = KSPMonitor(ksp,0,rho);CHKERRQ(ierr); 89 ierr = (*ksp->converged)(ksp,0,rho,&ksp->reason,ksp->cnvP);CHKERRQ(ierr); 90 if (ksp->reason) PetscFunctionReturn(0); 91 92 /* Initialize iterates */ 93 ierr = VecCopy(R,RP);CHKERRQ(ierr); /* rp <- r */ 94 ierr = VecCopy(R,P);CHKERRQ(ierr); /* p <- r */ 95 96 /* Big loop */ 97 for (i=0; i<ksp->max_it; i++) { 98 99 /* matmult and pc */ 100 ierr = PCApply(pc,P,P2);CHKERRQ(ierr); /* p2 <- K p */ 101 ierr = MatMult(pc->mat,P2,V);CHKERRQ(ierr); /* v <- A p2 */ 102 103 /* inner prodcuts */ 104 if (i==0) { 105 tau = rho*rho; 106 ierr = VecDot(V,RP,&sigma);CHKERRQ(ierr); /* sigma <- (v,rp) */ 107 } else { 108 ierr = PetscLogEventBegin(VEC_ReduceArithmetic,0,0,0,0);CHKERRQ(ierr); 109 tau = sigma = 0.0; 110 for (j=0; j<N; j++) { 111 tau += r[j]*rp[j]; /* tau <- (r,rp) */ 112 sigma += v[j]*rp[j]; /* sigma <- (v,rp) */ 113 } 114 PetscLogFlops(4.0*N); 115 ierr = PetscLogEventEnd(VEC_ReduceArithmetic,0,0,0,0);CHKERRQ(ierr); 116 insums[0] = tau; 117 insums[1] = sigma; 118 ierr = PetscLogEventBarrierBegin(VEC_ReduceBarrier,0,0,0,0,PetscObjectComm((PetscObject)ksp));CHKERRQ(ierr); 119 ierr = MPI_Allreduce(insums,outsums,2,MPIU_SCALAR,MPIU_SUM,PetscObjectComm((PetscObject)ksp));CHKERRQ(ierr); 120 ierr = PetscLogEventBarrierEnd(VEC_ReduceBarrier,0,0,0,0,PetscObjectComm((PetscObject)ksp));CHKERRQ(ierr); 121 tau = outsums[0]; 122 sigma = outsums[1]; 123 } 124 125 /* scalar update */ 126 alpha = tau / sigma; 127 128 /* vector update */ 129 ierr = VecWAXPY(S,-alpha,V,R);CHKERRQ(ierr); /* s <- r - alpha v */ 130 131 /* matmult and pc */ 132 ierr = PCApply(pc,S,S2);CHKERRQ(ierr); /* s2 <- K s */ 133 ierr = MatMult(pc->mat,S2,T);CHKERRQ(ierr); /* t <- A s2 */ 134 135 /* inner prodcuts */ 136 ierr = PetscLogEventBegin(VEC_ReduceArithmetic,0,0,0,0);CHKERRQ(ierr); 137 xi1 = xi2 = xi3 = xi4 = 0.0; 138 for (j=0; j<N; j++) { 139 xi1 += s[j]*s[j]; /* xi1 <- (s,s) */ 140 xi2 += t[j]*s[j]; /* xi2 <- (t,s) */ 141 xi3 += t[j]*t[j]; /* xi3 <- (t,t) */ 142 xi4 += t[j]*rp[j]; /* xi4 <- (t,rp) */ 143 } 144 PetscLogFlops(8.0*N); 145 ierr = PetscLogEventEnd(VEC_ReduceArithmetic,0,0,0,0);CHKERRQ(ierr); 146 147 insums[0] = xi1; 148 insums[1] = xi2; 149 insums[2] = xi3; 150 insums[3] = xi4; 151 152 ierr = PetscLogEventBarrierBegin(VEC_ReduceBarrier,0,0,0,0,PetscObjectComm((PetscObject)ksp));CHKERRQ(ierr); 153 ierr = MPI_Allreduce(insums,outsums,4,MPIU_SCALAR,MPIU_SUM,PetscObjectComm((PetscObject)ksp));CHKERRQ(ierr); 154 ierr = PetscLogEventBarrierEnd(VEC_ReduceBarrier,0,0,0,0,PetscObjectComm((PetscObject)ksp));CHKERRQ(ierr); 155 xi1 = outsums[0]; 156 xi2 = outsums[1]; 157 xi3 = outsums[2]; 158 xi4 = outsums[3]; 159 160 /* test denominator */ 161 if (xi3 == 0.0) SETERRQ(PetscObjectComm((PetscObject)ksp),PETSC_ERR_PLIB,"Divide by zero"); 162 if (sigma == 0.0) SETERRQ(PetscObjectComm((PetscObject)ksp),PETSC_ERR_PLIB,"Divide by zero"); 163 164 /* scalar updates */ 165 omega = xi2 / xi3; 166 beta = -xi4 / sigma; 167 rho = PetscSqrtReal(PetscAbsScalar(xi1 - omega * xi2)); /* residual norm */ 168 169 /* vector updates */ 170 ierr = VecAXPBYPCZ(X,alpha,omega,1.0,P2,S2);CHKERRQ(ierr); /* x <- alpha * p2 + omega * s2 + x */ 171 172 /* convergence test */ 173 ierr = PetscObjectSAWsTakeAccess((PetscObject)ksp);CHKERRQ(ierr); 174 ksp->its++; 175 ksp->rnorm = rho; 176 ierr = PetscObjectSAWsGrantAccess((PetscObject)ksp);CHKERRQ(ierr); 177 ierr = KSPLogResidualHistory(ksp,rho);CHKERRQ(ierr); 178 ierr = KSPMonitor(ksp,i+1,rho);CHKERRQ(ierr); 179 ierr = (*ksp->converged)(ksp,i+1,rho,&ksp->reason,ksp->cnvP);CHKERRQ(ierr); 180 if (ksp->reason) break; 181 182 /* vector updates */ 183 ierr = PetscLogEventBegin(VEC_Ops,0,0,0,0);CHKERRQ(ierr); 184 for (j=0; j<N; j++) { 185 r[j] = s[j] - omega * t[j]; /* r <- s - omega t */ 186 p[j] = r[j] + beta * (p[j] - omega * v[j]); /* p <- r + beta * (p - omega v) */ 187 } 188 PetscLogFlops(6.0*N); 189 ierr = PetscLogEventEnd(VEC_Ops,0,0,0,0);CHKERRQ(ierr); 190 191 } 192 193 if (i >= ksp->max_it) ksp->reason = KSP_DIVERGED_ITS; 194 PetscFunctionReturn(0); 195 } 196 197 /*MC 198 KSPFBCGSR - Implements a mathematically equivalent variant of FBiCGSTab. 199 200 Options Database Keys: 201 . see KSPSolve() 202 203 Level: beginner 204 205 Notes: Only allow right preconditioning 206 207 .seealso: KSPCreate(), KSPSetType(), KSPType (for list of available types), KSP, KSPBICG, KSPFBCGSL, KSPSetPCSide() 208 M*/ 209 #undef __FUNCT__ 210 #define __FUNCT__ "KSPCreate_FBCGSR" 211 PETSC_EXTERN PetscErrorCode KSPCreate_FBCGSR(KSP ksp) 212 { 213 PetscErrorCode ierr; 214 KSP_BCGS *bcgs; 215 216 PetscFunctionBegin; 217 ierr = PetscNewLog(ksp,KSP_BCGS,&bcgs);CHKERRQ(ierr); 218 219 ksp->data = bcgs; 220 ksp->ops->setup = KSPSetUp_FBCGSR; 221 ksp->ops->solve = KSPSolve_FBCGSR; 222 ksp->ops->destroy = KSPDestroy_BCGS; 223 ksp->ops->reset = KSPReset_BCGS; 224 ksp->ops->buildsolution = KSPBuildSolution_BCGS; 225 ksp->ops->buildresidual = KSPBuildResidualDefault; 226 ksp->ops->setfromoptions = KSPSetFromOptions_BCGS; 227 ksp->pc_side = PC_RIGHT; /* set default PC side */ 228 229 ierr = KSPSetSupportedNorm(ksp,KSP_NORM_PRECONDITIONED,PC_LEFT,2);CHKERRQ(ierr); 230 ierr = KSPSetSupportedNorm(ksp,KSP_NORM_UNPRECONDITIONED,PC_RIGHT,1);CHKERRQ(ierr); 231 PetscFunctionReturn(0); 232 } 233