1 2 #include <../src/snes/impls/vi/rs/virsimpl.h> /*I "petscsnes.h" I*/ 3 #include <petsc-private/kspimpl.h> 4 #include <petsc-private/matimpl.h> 5 #include <petsc-private/dmimpl.h> 6 #include <petsc-private/vecimpl.h> 7 8 #undef __FUNCT__ 9 #define __FUNCT__ "SNESVIGetInactiveSet" 10 /* 11 SNESVIGetInactiveSet - Gets the global indices for the inactive set variables (these correspond to the degrees of freedom the linear 12 system is solved on) 13 14 Input parameter 15 . snes - the SNES context 16 17 Output parameter 18 . ISact - active set index set 19 20 */ 21 PetscErrorCode SNESVIGetInactiveSet(SNES snes,IS *inact) 22 { 23 SNES_VINEWTONRSLS *vi = (SNES_VINEWTONRSLS*)snes->data; 24 25 PetscFunctionBegin; 26 *inact = vi->IS_inact_prev; 27 PetscFunctionReturn(0); 28 } 29 30 /* 31 Provides a wrapper to a DM to allow it to be used to generated the interpolation/restriction from the DM for the smaller matrices and vectors 32 defined by the reduced space method. 33 34 Simple calls the regular DM interpolation and restricts it to operation on the variables not associated with active constraints. 35 36 <*/ 37 typedef struct { 38 PetscInt n; /* size of vectors in the reduced DM space */ 39 IS inactive; 40 41 PetscErrorCode (*createinterpolation)(DM,DM,Mat*,Vec*); /* DM's original routines */ 42 PetscErrorCode (*coarsen)(DM, MPI_Comm, DM*); 43 PetscErrorCode (*createglobalvector)(DM,Vec*); 44 45 DM dm; /* when destroying this object we need to reset the above function into the base DM */ 46 } DM_SNESVI; 47 48 #undef __FUNCT__ 49 #define __FUNCT__ "DMCreateGlobalVector_SNESVI" 50 /* 51 DMCreateGlobalVector_SNESVI - Creates global vector of the size of the reduced space 52 53 */ 54 PetscErrorCode DMCreateGlobalVector_SNESVI(DM dm,Vec *vec) 55 { 56 PetscErrorCode ierr; 57 PetscContainer isnes; 58 DM_SNESVI *dmsnesvi; 59 60 PetscFunctionBegin; 61 ierr = PetscObjectQuery((PetscObject)dm,"VI",(PetscObject*)&isnes);CHKERRQ(ierr); 62 if (!isnes) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_PLIB,"Composed SNES is missing"); 63 ierr = PetscContainerGetPointer(isnes,(void**)&dmsnesvi);CHKERRQ(ierr); 64 ierr = VecCreateMPI(PetscObjectComm((PetscObject)dm),dmsnesvi->n,PETSC_DETERMINE,vec);CHKERRQ(ierr); 65 PetscFunctionReturn(0); 66 } 67 68 #undef __FUNCT__ 69 #define __FUNCT__ "DMCreateInterpolation_SNESVI" 70 /* 71 DMCreateInterpolation_SNESVI - Modifieds the interpolation obtained from the DM by removing all rows and columns associated with active constraints. 72 73 */ 74 PetscErrorCode DMCreateInterpolation_SNESVI(DM dm1,DM dm2,Mat *mat,Vec *vec) 75 { 76 PetscErrorCode ierr; 77 PetscContainer isnes; 78 DM_SNESVI *dmsnesvi1,*dmsnesvi2; 79 Mat interp; 80 81 PetscFunctionBegin; 82 ierr = PetscObjectQuery((PetscObject)dm1,"VI",(PetscObject*)&isnes);CHKERRQ(ierr); 83 if (!isnes) SETERRQ(PetscObjectComm((PetscObject)dm1),PETSC_ERR_PLIB,"Composed VI data structure is missing"); 84 ierr = PetscContainerGetPointer(isnes,(void**)&dmsnesvi1);CHKERRQ(ierr); 85 ierr = PetscObjectQuery((PetscObject)dm2,"VI",(PetscObject*)&isnes);CHKERRQ(ierr); 86 if (!isnes) SETERRQ(PetscObjectComm((PetscObject)dm2),PETSC_ERR_PLIB,"Composed VI data structure is missing"); 87 ierr = PetscContainerGetPointer(isnes,(void**)&dmsnesvi2);CHKERRQ(ierr); 88 89 ierr = (*dmsnesvi1->createinterpolation)(dm1,dm2,&interp,NULL);CHKERRQ(ierr); 90 ierr = MatGetSubMatrix(interp,dmsnesvi2->inactive,dmsnesvi1->inactive,MAT_INITIAL_MATRIX,mat);CHKERRQ(ierr); 91 ierr = MatDestroy(&interp);CHKERRQ(ierr); 92 *vec = 0; 93 PetscFunctionReturn(0); 94 } 95 96 extern PetscErrorCode DMSetVI(DM,IS); 97 98 #undef __FUNCT__ 99 #define __FUNCT__ "DMCoarsen_SNESVI" 100 /* 101 DMCoarsen_SNESVI - Computes the regular coarsened DM then computes additional information about its inactive set 102 103 */ 104 PetscErrorCode DMCoarsen_SNESVI(DM dm1,MPI_Comm comm,DM *dm2) 105 { 106 PetscErrorCode ierr; 107 PetscContainer isnes; 108 DM_SNESVI *dmsnesvi1; 109 Vec finemarked,coarsemarked; 110 IS inactive; 111 VecScatter inject; 112 const PetscInt *index; 113 PetscInt n,k,cnt = 0,rstart,*coarseindex; 114 PetscScalar *marked; 115 116 PetscFunctionBegin; 117 ierr = PetscObjectQuery((PetscObject)dm1,"VI",(PetscObject*)&isnes);CHKERRQ(ierr); 118 if (!isnes) SETERRQ(PetscObjectComm((PetscObject)dm1),PETSC_ERR_PLIB,"Composed VI data structure is missing"); 119 ierr = PetscContainerGetPointer(isnes,(void**)&dmsnesvi1);CHKERRQ(ierr); 120 121 /* get the original coarsen */ 122 ierr = (*dmsnesvi1->coarsen)(dm1,comm,dm2);CHKERRQ(ierr); 123 124 /* not sure why this extra reference is needed, but without the dm2 disappears too early */ 125 ierr = PetscObjectReference((PetscObject)*dm2);CHKERRQ(ierr); 126 127 /* need to set back global vectors in order to use the original injection */ 128 ierr = DMClearGlobalVectors(dm1);CHKERRQ(ierr); 129 130 dm1->ops->createglobalvector = dmsnesvi1->createglobalvector; 131 132 ierr = DMCreateGlobalVector(dm1,&finemarked);CHKERRQ(ierr); 133 ierr = DMCreateGlobalVector(*dm2,&coarsemarked);CHKERRQ(ierr); 134 135 /* 136 fill finemarked with locations of inactive points 137 */ 138 ierr = ISGetIndices(dmsnesvi1->inactive,&index);CHKERRQ(ierr); 139 ierr = ISGetLocalSize(dmsnesvi1->inactive,&n);CHKERRQ(ierr); 140 ierr = VecSet(finemarked,0.0);CHKERRQ(ierr); 141 for (k=0; k<n; k++) { 142 ierr = VecSetValue(finemarked,index[k],1.0,INSERT_VALUES);CHKERRQ(ierr); 143 } 144 ierr = VecAssemblyBegin(finemarked);CHKERRQ(ierr); 145 ierr = VecAssemblyEnd(finemarked);CHKERRQ(ierr); 146 147 ierr = DMCreateInjection(*dm2,dm1,&inject);CHKERRQ(ierr); 148 ierr = VecScatterBegin(inject,finemarked,coarsemarked,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 149 ierr = VecScatterEnd(inject,finemarked,coarsemarked,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 150 ierr = VecScatterDestroy(&inject);CHKERRQ(ierr); 151 152 /* 153 create index set list of coarse inactive points from coarsemarked 154 */ 155 ierr = VecGetLocalSize(coarsemarked,&n);CHKERRQ(ierr); 156 ierr = VecGetOwnershipRange(coarsemarked,&rstart,NULL);CHKERRQ(ierr); 157 ierr = VecGetArray(coarsemarked,&marked);CHKERRQ(ierr); 158 for (k=0; k<n; k++) { 159 if (marked[k] != 0.0) cnt++; 160 } 161 ierr = PetscMalloc1(cnt,&coarseindex);CHKERRQ(ierr); 162 cnt = 0; 163 for (k=0; k<n; k++) { 164 if (marked[k] != 0.0) coarseindex[cnt++] = k + rstart; 165 } 166 ierr = VecRestoreArray(coarsemarked,&marked);CHKERRQ(ierr); 167 ierr = ISCreateGeneral(PetscObjectComm((PetscObject)coarsemarked),cnt,coarseindex,PETSC_OWN_POINTER,&inactive);CHKERRQ(ierr); 168 169 ierr = DMClearGlobalVectors(dm1);CHKERRQ(ierr); 170 171 dm1->ops->createglobalvector = DMCreateGlobalVector_SNESVI; 172 173 ierr = DMSetVI(*dm2,inactive);CHKERRQ(ierr); 174 175 ierr = VecDestroy(&finemarked);CHKERRQ(ierr); 176 ierr = VecDestroy(&coarsemarked);CHKERRQ(ierr); 177 ierr = ISDestroy(&inactive);CHKERRQ(ierr); 178 PetscFunctionReturn(0); 179 } 180 181 #undef __FUNCT__ 182 #define __FUNCT__ "DMDestroy_SNESVI" 183 PetscErrorCode DMDestroy_SNESVI(DM_SNESVI *dmsnesvi) 184 { 185 PetscErrorCode ierr; 186 187 PetscFunctionBegin; 188 /* reset the base methods in the DM object that were changed when the DM_SNESVI was reset */ 189 dmsnesvi->dm->ops->createinterpolation = dmsnesvi->createinterpolation; 190 dmsnesvi->dm->ops->coarsen = dmsnesvi->coarsen; 191 dmsnesvi->dm->ops->createglobalvector = dmsnesvi->createglobalvector; 192 /* need to clear out this vectors because some of them may not have a reference to the DM 193 but they are counted as having references to the DM in DMDestroy() */ 194 ierr = DMClearGlobalVectors(dmsnesvi->dm);CHKERRQ(ierr); 195 196 ierr = ISDestroy(&dmsnesvi->inactive);CHKERRQ(ierr); 197 ierr = PetscFree(dmsnesvi);CHKERRQ(ierr); 198 PetscFunctionReturn(0); 199 } 200 201 #undef __FUNCT__ 202 #define __FUNCT__ "DMSetVI" 203 /* 204 DMSetVI - Marks a DM as associated with a VI problem. This causes the interpolation/restriction operators to 205 be restricted to only those variables NOT associated with active constraints. 206 207 */ 208 PetscErrorCode DMSetVI(DM dm,IS inactive) 209 { 210 PetscErrorCode ierr; 211 PetscContainer isnes; 212 DM_SNESVI *dmsnesvi; 213 214 PetscFunctionBegin; 215 if (!dm) PetscFunctionReturn(0); 216 217 ierr = PetscObjectReference((PetscObject)inactive);CHKERRQ(ierr); 218 219 ierr = PetscObjectQuery((PetscObject)dm,"VI",(PetscObject*)&isnes);CHKERRQ(ierr); 220 if (!isnes) { 221 ierr = PetscContainerCreate(PetscObjectComm((PetscObject)dm),&isnes);CHKERRQ(ierr); 222 ierr = PetscContainerSetUserDestroy(isnes,(PetscErrorCode (*)(void*))DMDestroy_SNESVI);CHKERRQ(ierr); 223 ierr = PetscNew(&dmsnesvi);CHKERRQ(ierr); 224 ierr = PetscContainerSetPointer(isnes,(void*)dmsnesvi);CHKERRQ(ierr); 225 ierr = PetscObjectCompose((PetscObject)dm,"VI",(PetscObject)isnes);CHKERRQ(ierr); 226 ierr = PetscContainerDestroy(&isnes);CHKERRQ(ierr); 227 228 dmsnesvi->createinterpolation = dm->ops->createinterpolation; 229 dm->ops->createinterpolation = DMCreateInterpolation_SNESVI; 230 dmsnesvi->coarsen = dm->ops->coarsen; 231 dm->ops->coarsen = DMCoarsen_SNESVI; 232 dmsnesvi->createglobalvector = dm->ops->createglobalvector; 233 dm->ops->createglobalvector = DMCreateGlobalVector_SNESVI; 234 } else { 235 ierr = PetscContainerGetPointer(isnes,(void**)&dmsnesvi);CHKERRQ(ierr); 236 ierr = ISDestroy(&dmsnesvi->inactive);CHKERRQ(ierr); 237 } 238 ierr = DMClearGlobalVectors(dm);CHKERRQ(ierr); 239 ierr = ISGetLocalSize(inactive,&dmsnesvi->n);CHKERRQ(ierr); 240 241 dmsnesvi->inactive = inactive; 242 dmsnesvi->dm = dm; 243 PetscFunctionReturn(0); 244 } 245 246 #undef __FUNCT__ 247 #define __FUNCT__ "DMDestroyVI" 248 /* 249 DMDestroyVI - Frees the DM_SNESVI object contained in the DM 250 - also resets the function pointers in the DM for createinterpolation() etc to use the original DM 251 */ 252 PetscErrorCode DMDestroyVI(DM dm) 253 { 254 PetscErrorCode ierr; 255 256 PetscFunctionBegin; 257 if (!dm) PetscFunctionReturn(0); 258 ierr = PetscObjectCompose((PetscObject)dm,"VI",(PetscObject)NULL);CHKERRQ(ierr); 259 PetscFunctionReturn(0); 260 } 261 262 /* --------------------------------------------------------------------------------------------------------*/ 263 264 265 266 267 #undef __FUNCT__ 268 #define __FUNCT__ "SNESCreateIndexSets_VINEWTONRSLS" 269 PetscErrorCode SNESCreateIndexSets_VINEWTONRSLS(SNES snes,Vec X,Vec F,IS *ISact,IS *ISinact) 270 { 271 PetscErrorCode ierr; 272 273 PetscFunctionBegin; 274 ierr = SNESVIGetActiveSetIS(snes,X,F,ISact);CHKERRQ(ierr); 275 ierr = ISComplement(*ISact,X->map->rstart,X->map->rend,ISinact);CHKERRQ(ierr); 276 PetscFunctionReturn(0); 277 } 278 279 /* Create active and inactive set vectors. The local size of this vector is set and petsc computes the global size */ 280 #undef __FUNCT__ 281 #define __FUNCT__ "SNESCreateSubVectors_VINEWTONRSLS" 282 PetscErrorCode SNESCreateSubVectors_VINEWTONRSLS(SNES snes,PetscInt n,Vec *newv) 283 { 284 PetscErrorCode ierr; 285 Vec v; 286 287 PetscFunctionBegin; 288 ierr = VecCreate(PetscObjectComm((PetscObject)snes),&v);CHKERRQ(ierr); 289 ierr = VecSetSizes(v,n,PETSC_DECIDE);CHKERRQ(ierr); 290 ierr = VecSetType(v,VECSTANDARD);CHKERRQ(ierr); 291 *newv = v; 292 PetscFunctionReturn(0); 293 } 294 295 /* Resets the snes PC and KSP when the active set sizes change */ 296 #undef __FUNCT__ 297 #define __FUNCT__ "SNESVIResetPCandKSP" 298 PetscErrorCode SNESVIResetPCandKSP(SNES snes,Mat Amat,Mat Pmat) 299 { 300 PetscErrorCode ierr; 301 KSP snesksp; 302 303 PetscFunctionBegin; 304 ierr = SNESGetKSP(snes,&snesksp);CHKERRQ(ierr); 305 ierr = KSPReset(snesksp);CHKERRQ(ierr); 306 307 /* 308 KSP kspnew; 309 PC pcnew; 310 const MatSolverPackage stype; 311 312 313 ierr = KSPCreate(PetscObjectComm((PetscObject)snes),&kspnew);CHKERRQ(ierr); 314 kspnew->pc_side = snesksp->pc_side; 315 kspnew->rtol = snesksp->rtol; 316 kspnew->abstol = snesksp->abstol; 317 kspnew->max_it = snesksp->max_it; 318 ierr = KSPSetType(kspnew,((PetscObject)snesksp)->type_name);CHKERRQ(ierr); 319 ierr = KSPGetPC(kspnew,&pcnew);CHKERRQ(ierr); 320 ierr = PCSetType(kspnew->pc,((PetscObject)snesksp->pc)->type_name);CHKERRQ(ierr); 321 ierr = PCSetOperators(kspnew->pc,Amat,Pmat,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr); 322 ierr = PCFactorGetMatSolverPackage(snesksp->pc,&stype);CHKERRQ(ierr); 323 ierr = PCFactorSetMatSolverPackage(kspnew->pc,stype);CHKERRQ(ierr); 324 ierr = KSPDestroy(&snesksp);CHKERRQ(ierr); 325 snes->ksp = kspnew; 326 ierr = PetscLogObjectParent((PetscObject)snes,(PetscObject)kspnew);CHKERRQ(ierr); 327 ierr = KSPSetFromOptions(kspnew);CHKERRQ(ierr);*/ 328 PetscFunctionReturn(0); 329 } 330 331 /* Variational Inequality solver using reduce space method. No semismooth algorithm is 332 implemented in this algorithm. It basically identifies the active constraints and does 333 a linear solve on the other variables (those not associated with the active constraints). */ 334 #undef __FUNCT__ 335 #define __FUNCT__ "SNESSolve_VINEWTONRSLS" 336 PetscErrorCode SNESSolve_VINEWTONRSLS(SNES snes) 337 { 338 SNES_VINEWTONRSLS *vi = (SNES_VINEWTONRSLS*)snes->data; 339 PetscErrorCode ierr; 340 PetscInt maxits,i,lits; 341 PetscBool lssucceed; 342 MatStructure flg = DIFFERENT_NONZERO_PATTERN; 343 PetscReal fnorm,gnorm,xnorm=0,ynorm; 344 Vec Y,X,F; 345 KSPConvergedReason kspreason; 346 347 PetscFunctionBegin; 348 snes->numFailures = 0; 349 snes->numLinearSolveFailures = 0; 350 snes->reason = SNES_CONVERGED_ITERATING; 351 352 maxits = snes->max_its; /* maximum number of iterations */ 353 X = snes->vec_sol; /* solution vector */ 354 F = snes->vec_func; /* residual vector */ 355 Y = snes->work[0]; /* work vectors */ 356 357 ierr = SNESLineSearchSetVIFunctions(snes->linesearch, SNESVIProjectOntoBounds, SNESVIComputeInactiveSetFnorm);CHKERRQ(ierr); 358 ierr = SNESLineSearchSetVecs(snes->linesearch, X, NULL, NULL, NULL, NULL);CHKERRQ(ierr); 359 ierr = SNESLineSearchSetUp(snes->linesearch);CHKERRQ(ierr); 360 361 ierr = PetscObjectSAWsTakeAccess((PetscObject)snes);CHKERRQ(ierr); 362 snes->iter = 0; 363 snes->norm = 0.0; 364 ierr = PetscObjectSAWsGrantAccess((PetscObject)snes);CHKERRQ(ierr); 365 366 ierr = SNESVIProjectOntoBounds(snes,X);CHKERRQ(ierr); 367 ierr = SNESComputeFunction(snes,X,F);CHKERRQ(ierr); 368 if (snes->domainerror) { 369 snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 370 PetscFunctionReturn(0); 371 } 372 ierr = SNESVIComputeInactiveSetFnorm(snes,F,X,&fnorm);CHKERRQ(ierr); 373 ierr = VecNormBegin(X,NORM_2,&xnorm);CHKERRQ(ierr); /* xnorm <- ||x|| */ 374 ierr = VecNormEnd(X,NORM_2,&xnorm);CHKERRQ(ierr); 375 if (PetscIsInfOrNanReal(fnorm)) SETERRQ(PetscObjectComm((PetscObject)X),PETSC_ERR_FP,"User provided compute function generated a Not-a-Number"); 376 377 ierr = PetscObjectSAWsTakeAccess((PetscObject)snes);CHKERRQ(ierr); 378 snes->norm = fnorm; 379 ierr = PetscObjectSAWsGrantAccess((PetscObject)snes);CHKERRQ(ierr); 380 ierr = SNESLogConvergenceHistory(snes,fnorm,0);CHKERRQ(ierr); 381 ierr = SNESMonitor(snes,0,fnorm);CHKERRQ(ierr); 382 383 /* test convergence */ 384 ierr = (*snes->ops->converged)(snes,0,0.0,0.0,fnorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 385 if (snes->reason) PetscFunctionReturn(0); 386 387 388 for (i=0; i<maxits; i++) { 389 390 IS IS_act,IS_inact; /* _act -> active set _inact -> inactive set */ 391 IS IS_redact; /* redundant active set */ 392 VecScatter scat_act,scat_inact; 393 PetscInt nis_act,nis_inact; 394 Vec Y_act,Y_inact,F_inact; 395 Mat jac_inact_inact,prejac_inact_inact; 396 PetscBool isequal; 397 398 /* Call general purpose update function */ 399 if (snes->ops->update) { 400 ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr); 401 } 402 ierr = SNESComputeJacobian(snes,X,&snes->jacobian,&snes->jacobian_pre,&flg);CHKERRQ(ierr); 403 404 405 /* Create active and inactive index sets */ 406 407 /*original 408 ierr = SNESVICreateIndexSets_RS(snes,X,F,&IS_act,&IS_inact);CHKERRQ(ierr); 409 */ 410 ierr = SNESVIGetActiveSetIS(snes,X,F,&IS_act);CHKERRQ(ierr); 411 412 if (vi->checkredundancy) { 413 (*vi->checkredundancy)(snes,IS_act,&IS_redact,vi->ctxP);CHKERRQ(ierr); 414 if (IS_redact) { 415 ierr = ISSort(IS_redact);CHKERRQ(ierr); 416 ierr = ISComplement(IS_redact,X->map->rstart,X->map->rend,&IS_inact);CHKERRQ(ierr); 417 ierr = ISDestroy(&IS_redact);CHKERRQ(ierr); 418 } else { 419 ierr = ISComplement(IS_act,X->map->rstart,X->map->rend,&IS_inact);CHKERRQ(ierr); 420 } 421 } else { 422 ierr = ISComplement(IS_act,X->map->rstart,X->map->rend,&IS_inact);CHKERRQ(ierr); 423 } 424 425 426 /* Create inactive set submatrix */ 427 ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&jac_inact_inact);CHKERRQ(ierr); 428 429 if (0) { /* Dead code (temporary developer hack) */ 430 IS keptrows; 431 ierr = MatFindNonzeroRows(jac_inact_inact,&keptrows);CHKERRQ(ierr); 432 if (keptrows) { 433 PetscInt cnt,*nrows,k; 434 const PetscInt *krows,*inact; 435 PetscInt rstart=jac_inact_inact->rmap->rstart; 436 437 ierr = MatDestroy(&jac_inact_inact);CHKERRQ(ierr); 438 ierr = ISDestroy(&IS_act);CHKERRQ(ierr); 439 440 ierr = ISGetLocalSize(keptrows,&cnt);CHKERRQ(ierr); 441 ierr = ISGetIndices(keptrows,&krows);CHKERRQ(ierr); 442 ierr = ISGetIndices(IS_inact,&inact);CHKERRQ(ierr); 443 ierr = PetscMalloc1(cnt,&nrows);CHKERRQ(ierr); 444 for (k=0; k<cnt; k++) nrows[k] = inact[krows[k]-rstart]; 445 ierr = ISRestoreIndices(keptrows,&krows);CHKERRQ(ierr); 446 ierr = ISRestoreIndices(IS_inact,&inact);CHKERRQ(ierr); 447 ierr = ISDestroy(&keptrows);CHKERRQ(ierr); 448 ierr = ISDestroy(&IS_inact);CHKERRQ(ierr); 449 450 ierr = ISCreateGeneral(PetscObjectComm((PetscObject)snes),cnt,nrows,PETSC_OWN_POINTER,&IS_inact);CHKERRQ(ierr); 451 ierr = ISComplement(IS_inact,F->map->rstart,F->map->rend,&IS_act);CHKERRQ(ierr); 452 ierr = MatGetSubMatrix(snes->jacobian,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&jac_inact_inact);CHKERRQ(ierr); 453 } 454 } 455 ierr = DMSetVI(snes->dm,IS_inact);CHKERRQ(ierr); 456 /* remove later */ 457 458 /* 459 ierr = VecView(vi->xu,PETSC_VIEWER_BINARY_(((PetscObject)(vi->xu))->comm));CHKERRQ(ierr); 460 ierr = VecView(vi->xl,PETSC_VIEWER_BINARY_(((PetscObject)(vi->xl))->comm));CHKERRQ(ierr); 461 ierr = VecView(X,PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)X)));CHKERRQ(ierr); 462 ierr = VecView(F,PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)F)));CHKERRQ(ierr); 463 ierr = ISView(IS_inact,PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)IS_inact)));CHKERRQ(ierr); 464 */ 465 466 /* Get sizes of active and inactive sets */ 467 ierr = ISGetLocalSize(IS_act,&nis_act);CHKERRQ(ierr); 468 ierr = ISGetLocalSize(IS_inact,&nis_inact);CHKERRQ(ierr); 469 470 /* Create active and inactive set vectors */ 471 ierr = SNESCreateSubVectors_VINEWTONRSLS(snes,nis_inact,&F_inact);CHKERRQ(ierr); 472 ierr = SNESCreateSubVectors_VINEWTONRSLS(snes,nis_act,&Y_act);CHKERRQ(ierr); 473 ierr = SNESCreateSubVectors_VINEWTONRSLS(snes,nis_inact,&Y_inact);CHKERRQ(ierr); 474 475 /* Create scatter contexts */ 476 ierr = VecScatterCreate(Y,IS_act,Y_act,NULL,&scat_act);CHKERRQ(ierr); 477 ierr = VecScatterCreate(Y,IS_inact,Y_inact,NULL,&scat_inact);CHKERRQ(ierr); 478 479 /* Do a vec scatter to active and inactive set vectors */ 480 ierr = VecScatterBegin(scat_inact,F,F_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 481 ierr = VecScatterEnd(scat_inact,F,F_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 482 483 ierr = VecScatterBegin(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 484 ierr = VecScatterEnd(scat_act,Y,Y_act,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 485 486 ierr = VecScatterBegin(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 487 ierr = VecScatterEnd(scat_inact,Y,Y_inact,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr); 488 489 /* Active set direction = 0 */ 490 ierr = VecSet(Y_act,0);CHKERRQ(ierr); 491 if (snes->jacobian != snes->jacobian_pre) { 492 ierr = MatGetSubMatrix(snes->jacobian_pre,IS_inact,IS_inact,MAT_INITIAL_MATRIX,&prejac_inact_inact);CHKERRQ(ierr); 493 } else prejac_inact_inact = jac_inact_inact; 494 495 ierr = ISEqual(vi->IS_inact_prev,IS_inact,&isequal);CHKERRQ(ierr); 496 if (!isequal) { 497 ierr = SNESVIResetPCandKSP(snes,jac_inact_inact,prejac_inact_inact);CHKERRQ(ierr); 498 flg = DIFFERENT_NONZERO_PATTERN; 499 } 500 501 /* ierr = ISView(IS_inact,0);CHKERRQ(ierr); */ 502 /* ierr = ISView(IS_act,0);CHKERRQ(ierr);*/ 503 /* ierr = MatView(snes->jacobian_pre,0); */ 504 505 506 507 ierr = KSPSetOperators(snes->ksp,jac_inact_inact,prejac_inact_inact,flg);CHKERRQ(ierr); 508 ierr = KSPSetUp(snes->ksp);CHKERRQ(ierr); 509 { 510 PC pc; 511 PetscBool flg; 512 ierr = KSPGetPC(snes->ksp,&pc);CHKERRQ(ierr); 513 ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&flg);CHKERRQ(ierr); 514 if (flg) { 515 KSP *subksps; 516 ierr = PCFieldSplitGetSubKSP(pc,NULL,&subksps);CHKERRQ(ierr); 517 ierr = KSPGetPC(subksps[0],&pc);CHKERRQ(ierr); 518 ierr = PetscFree(subksps);CHKERRQ(ierr); 519 ierr = PetscObjectTypeCompare((PetscObject)pc,PCBJACOBI,&flg);CHKERRQ(ierr); 520 if (flg) { 521 PetscInt n,N = 101*101,j,cnts[3] = {0,0,0}; 522 const PetscInt *ii; 523 524 ierr = ISGetSize(IS_inact,&n);CHKERRQ(ierr); 525 ierr = ISGetIndices(IS_inact,&ii);CHKERRQ(ierr); 526 for (j=0; j<n; j++) { 527 if (ii[j] < N) cnts[0]++; 528 else if (ii[j] < 2*N) cnts[1]++; 529 else if (ii[j] < 3*N) cnts[2]++; 530 } 531 ierr = ISRestoreIndices(IS_inact,&ii);CHKERRQ(ierr); 532 533 ierr = PCBJacobiSetTotalBlocks(pc,3,cnts);CHKERRQ(ierr); 534 } 535 } 536 } 537 538 ierr = KSPSolve(snes->ksp,F_inact,Y_inact);CHKERRQ(ierr); 539 ierr = KSPGetConvergedReason(snes->ksp,&kspreason);CHKERRQ(ierr); 540 if (kspreason < 0) { 541 if (++snes->numLinearSolveFailures >= snes->maxLinearSolveFailures) { 542 ierr = PetscInfo2(snes,"iter=%D, number linear solve failures %D greater than current SNES allowed, stopping solve\n",snes->iter,snes->numLinearSolveFailures);CHKERRQ(ierr); 543 snes->reason = SNES_DIVERGED_LINEAR_SOLVE; 544 break; 545 } 546 } 547 548 ierr = VecScatterBegin(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 549 ierr = VecScatterEnd(scat_act,Y_act,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 550 ierr = VecScatterBegin(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 551 ierr = VecScatterEnd(scat_inact,Y_inact,Y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr); 552 553 ierr = VecDestroy(&F_inact);CHKERRQ(ierr); 554 ierr = VecDestroy(&Y_act);CHKERRQ(ierr); 555 ierr = VecDestroy(&Y_inact);CHKERRQ(ierr); 556 ierr = VecScatterDestroy(&scat_act);CHKERRQ(ierr); 557 ierr = VecScatterDestroy(&scat_inact);CHKERRQ(ierr); 558 ierr = ISDestroy(&IS_act);CHKERRQ(ierr); 559 if (!isequal) { 560 ierr = ISDestroy(&vi->IS_inact_prev);CHKERRQ(ierr); 561 ierr = ISDuplicate(IS_inact,&vi->IS_inact_prev);CHKERRQ(ierr); 562 } 563 ierr = ISDestroy(&IS_inact);CHKERRQ(ierr); 564 ierr = MatDestroy(&jac_inact_inact);CHKERRQ(ierr); 565 if (snes->jacobian != snes->jacobian_pre) { 566 ierr = MatDestroy(&prejac_inact_inact);CHKERRQ(ierr); 567 } 568 ierr = KSPGetIterationNumber(snes->ksp,&lits);CHKERRQ(ierr); 569 snes->linear_its += lits; 570 ierr = PetscInfo2(snes,"iter=%D, linear solve iterations=%D\n",snes->iter,lits);CHKERRQ(ierr); 571 /* 572 if (snes->ops->precheck) { 573 PetscBool changed_y = PETSC_FALSE; 574 ierr = (*snes->ops->precheck)(snes,X,Y,snes->precheck,&changed_y);CHKERRQ(ierr); 575 } 576 577 if (PetscLogPrintInfo) { 578 ierr = SNESVICheckResidual_Private(snes,snes->jacobian,F,Y,G,W);CHKERRQ(ierr); 579 } 580 */ 581 /* Compute a (scaled) negative update in the line search routine: 582 Y <- X - lambda*Y 583 and evaluate G = function(Y) (depends on the line search). 584 */ 585 ierr = VecCopy(Y,snes->vec_sol_update);CHKERRQ(ierr); 586 ynorm = 1; gnorm = fnorm; 587 ierr = SNESLineSearchApply(snes->linesearch, X, F, &gnorm, Y);CHKERRQ(ierr); 588 ierr = SNESLineSearchGetSuccess(snes->linesearch, &lssucceed);CHKERRQ(ierr); 589 ierr = SNESLineSearchGetNorms(snes->linesearch, &xnorm, &gnorm, &ynorm);CHKERRQ(ierr); 590 ierr = PetscInfo4(snes,"fnorm=%18.16e, gnorm=%18.16e, ynorm=%18.16e, lssucceed=%d\n",(double)fnorm,(double)gnorm,(double)ynorm,(int)lssucceed);CHKERRQ(ierr); 591 if (snes->reason == SNES_DIVERGED_FUNCTION_COUNT) break; 592 if (snes->domainerror) { 593 snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 594 ierr = DMDestroyVI(snes->dm);CHKERRQ(ierr); 595 PetscFunctionReturn(0); 596 } 597 if (!lssucceed) { 598 if (++snes->numFailures >= snes->maxFailures) { 599 PetscBool ismin; 600 snes->reason = SNES_DIVERGED_LINE_SEARCH; 601 ierr = SNESVICheckLocalMin_Private(snes,snes->jacobian,F,X,gnorm,&ismin);CHKERRQ(ierr); 602 if (ismin) snes->reason = SNES_DIVERGED_LOCAL_MIN; 603 break; 604 } 605 } 606 /* Update function and solution vectors */ 607 fnorm = gnorm; 608 /* Monitor convergence */ 609 ierr = PetscObjectSAWsTakeAccess((PetscObject)snes);CHKERRQ(ierr); 610 snes->iter = i+1; 611 snes->norm = fnorm; 612 ierr = PetscObjectSAWsGrantAccess((PetscObject)snes);CHKERRQ(ierr); 613 ierr = SNESLogConvergenceHistory(snes,snes->norm,lits);CHKERRQ(ierr); 614 ierr = SNESMonitor(snes,snes->iter,snes->norm);CHKERRQ(ierr); 615 /* Test for convergence, xnorm = || X || */ 616 if (snes->ops->converged != SNESConvergedSkip) { ierr = VecNorm(X,NORM_2,&xnorm);CHKERRQ(ierr); } 617 ierr = (*snes->ops->converged)(snes,snes->iter,xnorm,ynorm,fnorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 618 if (snes->reason) break; 619 } 620 ierr = DMDestroyVI(snes->dm);CHKERRQ(ierr); 621 if (i == maxits) { 622 ierr = PetscInfo1(snes,"Maximum number of iterations has been reached: %D\n",maxits);CHKERRQ(ierr); 623 if (!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT; 624 } 625 PetscFunctionReturn(0); 626 } 627 628 #undef __FUNCT__ 629 #define __FUNCT__ "SNESVISetRedundancyCheck" 630 PetscErrorCode SNESVISetRedundancyCheck(SNES snes,PetscErrorCode (*func)(SNES,IS,IS*,void*),void *ctx) 631 { 632 SNES_VINEWTONRSLS *vi = (SNES_VINEWTONRSLS*)snes->data; 633 634 PetscFunctionBegin; 635 PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 636 vi->checkredundancy = func; 637 vi->ctxP = ctx; 638 PetscFunctionReturn(0); 639 } 640 641 #if defined(PETSC_HAVE_MATLAB_ENGINE) 642 #include <engine.h> 643 #include <mex.h> 644 typedef struct {char *funcname; mxArray *ctx;} SNESMatlabContext; 645 646 #undef __FUNCT__ 647 #define __FUNCT__ "SNESVIRedundancyCheck_Matlab" 648 PetscErrorCode SNESVIRedundancyCheck_Matlab(SNES snes,IS is_act,IS *is_redact,void *ctx) 649 { 650 PetscErrorCode ierr; 651 SNESMatlabContext *sctx = (SNESMatlabContext*)ctx; 652 int nlhs = 1, nrhs = 5; 653 mxArray *plhs[1], *prhs[5]; 654 long long int l1 = 0, l2 = 0, ls = 0; 655 PetscInt *indices=NULL; 656 657 PetscFunctionBegin; 658 PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 659 PetscValidHeaderSpecific(is_act,IS_CLASSID,2); 660 PetscValidPointer(is_redact,3); 661 PetscCheckSameComm(snes,1,is_act,2); 662 663 /* Create IS for reduced active set of size 0, its size and indices will 664 bet set by the Matlab function */ 665 ierr = ISCreateGeneral(PetscObjectComm((PetscObject)snes),0,indices,PETSC_OWN_POINTER,is_redact);CHKERRQ(ierr); 666 /* call Matlab function in ctx */ 667 ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 668 ierr = PetscMemcpy(&l1,&is_act,sizeof(is_act));CHKERRQ(ierr); 669 ierr = PetscMemcpy(&l2,is_redact,sizeof(is_act));CHKERRQ(ierr); 670 prhs[0] = mxCreateDoubleScalar((double)ls); 671 prhs[1] = mxCreateDoubleScalar((double)l1); 672 prhs[2] = mxCreateDoubleScalar((double)l2); 673 prhs[3] = mxCreateString(sctx->funcname); 674 prhs[4] = sctx->ctx; 675 ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESVIRedundancyCheckInternal");CHKERRQ(ierr); 676 ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 677 mxDestroyArray(prhs[0]); 678 mxDestroyArray(prhs[1]); 679 mxDestroyArray(prhs[2]); 680 mxDestroyArray(prhs[3]); 681 mxDestroyArray(plhs[0]); 682 PetscFunctionReturn(0); 683 } 684 685 #undef __FUNCT__ 686 #define __FUNCT__ "SNESVISetRedundancyCheckMatlab" 687 PetscErrorCode SNESVISetRedundancyCheckMatlab(SNES snes,const char *func,mxArray *ctx) 688 { 689 PetscErrorCode ierr; 690 SNESMatlabContext *sctx; 691 692 PetscFunctionBegin; 693 /* currently sctx is memory bleed */ 694 ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr); 695 ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr); 696 sctx->ctx = mxDuplicateArray(ctx); 697 ierr = SNESVISetRedundancyCheck(snes,SNESVIRedundancyCheck_Matlab,sctx);CHKERRQ(ierr); 698 PetscFunctionReturn(0); 699 } 700 701 #endif 702 703 /* -------------------------------------------------------------------------- */ 704 /* 705 SNESSetUp_VINEWTONRSLS - Sets up the internal data structures for the later use 706 of the SNESVI nonlinear solver. 707 708 Input Parameter: 709 . snes - the SNES context 710 . x - the solution vector 711 712 Application Interface Routine: SNESSetUp() 713 714 Notes: 715 For basic use of the SNES solvers, the user need not explicitly call 716 SNESSetUp(), since these actions will automatically occur during 717 the call to SNESSolve(). 718 */ 719 #undef __FUNCT__ 720 #define __FUNCT__ "SNESSetUp_VINEWTONRSLS" 721 PetscErrorCode SNESSetUp_VINEWTONRSLS(SNES snes) 722 { 723 PetscErrorCode ierr; 724 SNES_VINEWTONRSLS *vi = (SNES_VINEWTONRSLS*) snes->data; 725 PetscInt *indices; 726 PetscInt i,n,rstart,rend; 727 SNESLineSearch linesearch; 728 729 PetscFunctionBegin; 730 ierr = SNESSetUp_VI(snes);CHKERRQ(ierr); 731 732 /* Set up previous active index set for the first snes solve 733 vi->IS_inact_prev = 0,1,2,....N */ 734 735 ierr = VecGetOwnershipRange(snes->vec_sol,&rstart,&rend);CHKERRQ(ierr); 736 ierr = VecGetLocalSize(snes->vec_sol,&n);CHKERRQ(ierr); 737 ierr = PetscMalloc1(n,&indices);CHKERRQ(ierr); 738 for (i=0; i < n; i++) indices[i] = rstart + i; 739 ierr = ISCreateGeneral(PetscObjectComm((PetscObject)snes),n,indices,PETSC_OWN_POINTER,&vi->IS_inact_prev);CHKERRQ(ierr); 740 741 /* set the line search functions */ 742 if (!snes->linesearch) { 743 ierr = SNESGetLineSearch(snes, &linesearch);CHKERRQ(ierr); 744 ierr = SNESLineSearchSetType(linesearch, SNESLINESEARCHBT);CHKERRQ(ierr); 745 } 746 PetscFunctionReturn(0); 747 } 748 /* -------------------------------------------------------------------------- */ 749 #undef __FUNCT__ 750 #define __FUNCT__ "SNESReset_VINEWTONRSLS" 751 PetscErrorCode SNESReset_VINEWTONRSLS(SNES snes) 752 { 753 SNES_VINEWTONRSLS *vi = (SNES_VINEWTONRSLS*) snes->data; 754 PetscErrorCode ierr; 755 756 PetscFunctionBegin; 757 ierr = SNESReset_VI(snes);CHKERRQ(ierr); 758 ierr = ISDestroy(&vi->IS_inact_prev);CHKERRQ(ierr); 759 PetscFunctionReturn(0); 760 } 761 762 /* -------------------------------------------------------------------------- */ 763 /*MC 764 SNESVINEWTONRSLS - Reduced space active set solvers for variational inequalities based on Newton's method 765 766 Options Database: 767 + -snes_vi_type <ss,rs,rsaug> a semi-smooth solver, a reduced space active set method, and a reduced space active set method that does not eliminate the active constraints from the Jacobian instead augments the Jacobian with additional variables that enforce the constraints 768 - -snes_vi_monitor - prints the number of active constraints at each iteration. 769 770 Level: beginner 771 772 References: 773 - T. S. Munson, and S. Benson. Flexible Complementarity Solvers for Large-Scale 774 Applications, Optimization Methods and Software, 21 (2006). 775 776 .seealso: SNESVISetVariableBounds(), SNESVISetComputeVariableBounds(), SNESCreate(), SNES, SNESSetType(), SNESVINEWTONRSLS, SNESVINEWTONSSLS, SNESNEWTONTR, SNESLineSearchSet(), 777 SNESLineSearchSetPostCheck(), SNESLineSearchNo(), SNESLineSearchCubic(), SNESLineSearchQuadratic(), 778 SNESLineSearchSet(), SNESLineSearchNoNorms(), SNESLineSearchSetPreCheck(), SNESLineSearchSetParams(), SNESLineSearchGetParams() 779 780 M*/ 781 #undef __FUNCT__ 782 #define __FUNCT__ "SNESCreate_VINEWTONRSLS" 783 PETSC_EXTERN PetscErrorCode SNESCreate_VINEWTONRSLS(SNES snes) 784 { 785 PetscErrorCode ierr; 786 SNES_VINEWTONRSLS *vi; 787 788 PetscFunctionBegin; 789 snes->ops->reset = SNESReset_VINEWTONRSLS; 790 snes->ops->setup = SNESSetUp_VINEWTONRSLS; 791 snes->ops->solve = SNESSolve_VINEWTONRSLS; 792 snes->ops->destroy = SNESDestroy_VI; 793 snes->ops->setfromoptions = SNESSetFromOptions_VI; 794 snes->ops->view = NULL; 795 snes->ops->converged = SNESConvergedDefault_VI; 796 797 snes->usesksp = PETSC_TRUE; 798 snes->usespc = PETSC_FALSE; 799 800 ierr = PetscNewLog(snes,&vi);CHKERRQ(ierr); 801 snes->data = (void*)vi; 802 vi->checkredundancy = NULL; 803 804 ierr = PetscObjectComposeFunction((PetscObject)snes,"SNESVISetVariableBounds_C",SNESVISetVariableBounds_VI);CHKERRQ(ierr); 805 ierr = PetscObjectComposeFunction((PetscObject)snes,"SNESVISetComputeVariableBounds_C",SNESVISetComputeVariableBounds_VI);CHKERRQ(ierr); 806 PetscFunctionReturn(0); 807 } 808 809