1421d9b32SPeter Brune /* Defines the basic SNES object */ 2421d9b32SPeter Brune #include <../src/snes/impls/fas/fasimpls.h> 3421d9b32SPeter Brune 4421d9b32SPeter Brune /*MC 5421d9b32SPeter Brune Full Approximation Scheme nonlinear multigrid solver. 6421d9b32SPeter Brune 7421d9b32SPeter Brune The nonlinear problem is solved via the repeated application of nonlinear preconditioners and coarse-grid corrections 8421d9b32SPeter Brune 9421d9b32SPeter Brune .seealso: SNESCreate(), SNES, SNESSetType(), SNESType (for list of available types) 10421d9b32SPeter Brune M*/ 11421d9b32SPeter Brune 12421d9b32SPeter Brune extern PetscErrorCode SNESDestroy_FAS(SNES snes); 13421d9b32SPeter Brune extern PetscErrorCode SNESSetUp_FAS(SNES snes); 14421d9b32SPeter Brune extern PetscErrorCode SNESSetFromOptions_FAS(SNES snes); 15421d9b32SPeter Brune extern PetscErrorCode SNESView_FAS(SNES snes, PetscViewer viewer); 16421d9b32SPeter Brune extern PetscErrorCode SNESSolve_FAS(SNES snes); 17421d9b32SPeter Brune extern PetscErrorCode SNESReset_FAS(SNES snes); 18421d9b32SPeter Brune 19421d9b32SPeter Brune EXTERN_C_BEGIN 20421d9b32SPeter Brune 21421d9b32SPeter Brune #undef __FUNCT__ 22421d9b32SPeter Brune #define __FUNCT__ "SNESCreate_FAS" 23421d9b32SPeter Brune PetscErrorCode SNESCreate_FAS(SNES snes) 24421d9b32SPeter Brune { 25421d9b32SPeter Brune SNES_FAS * fas; 26421d9b32SPeter Brune PetscErrorCode ierr; 27421d9b32SPeter Brune 28421d9b32SPeter Brune PetscFunctionBegin; 29421d9b32SPeter Brune snes->ops->destroy = SNESDestroy_FAS; 30421d9b32SPeter Brune snes->ops->setup = SNESSetUp_FAS; 31421d9b32SPeter Brune snes->ops->setfromoptions = SNESSetFromOptions_FAS; 32421d9b32SPeter Brune snes->ops->view = SNESView_FAS; 33421d9b32SPeter Brune snes->ops->solve = SNESSolve_FAS; 34421d9b32SPeter Brune snes->ops->reset = SNESReset_FAS; 35421d9b32SPeter Brune 36ed020824SBarry Smith snes->usesksp = PETSC_FALSE; 37ed020824SBarry Smith snes->usespc = PETSC_FALSE; 38ed020824SBarry Smith 39421d9b32SPeter Brune ierr = PetscNewLog(snes, SNES_FAS, &fas);CHKERRQ(ierr); 40421d9b32SPeter Brune snes->data = (void*) fas; 41421d9b32SPeter Brune fas->level = 0; 42293a7e31SPeter Brune fas->levels = 1; 43ee78dd50SPeter Brune fas->n_cycles = 1; 44ee78dd50SPeter Brune fas->max_up_it = 1; 45ee78dd50SPeter Brune fas->max_down_it = 1; 46ee78dd50SPeter Brune fas->upsmooth = PETSC_NULL; 47ee78dd50SPeter Brune fas->downsmooth = PETSC_NULL; 48421d9b32SPeter Brune fas->next = PETSC_NULL; 49421d9b32SPeter Brune fas->interpolate = PETSC_NULL; 50421d9b32SPeter Brune fas->restrct = PETSC_NULL; 51421d9b32SPeter Brune 52421d9b32SPeter Brune PetscFunctionReturn(0); 53421d9b32SPeter Brune } 54421d9b32SPeter Brune EXTERN_C_END 55421d9b32SPeter Brune 56421d9b32SPeter Brune #undef __FUNCT__ 57421d9b32SPeter Brune #define __FUNCT__ "SNESFASGetLevels" 58421d9b32SPeter Brune PetscErrorCode SNESFASGetLevels(SNES snes, PetscInt * levels) { 59421d9b32SPeter Brune SNES_FAS * fas = (SNES_FAS *)snes->data; 60421d9b32SPeter Brune PetscFunctionBegin; 61ee1fd11aSPeter Brune *levels = fas->levels; 62421d9b32SPeter Brune PetscFunctionReturn(0); 63421d9b32SPeter Brune } 64421d9b32SPeter Brune 65421d9b32SPeter Brune #undef __FUNCT__ 66421d9b32SPeter Brune #define __FUNCT__ "SNESFASGetSNES" 67421d9b32SPeter Brune PetscErrorCode SNESFASGetSNES(SNES snes, PetscInt level, SNES * lsnes) { 68421d9b32SPeter Brune SNES_FAS * fas = (SNES_FAS *)snes->data; 69421d9b32SPeter Brune PetscInt levels = fas->level; 70421d9b32SPeter Brune PetscInt i; 71421d9b32SPeter Brune PetscFunctionBegin; 72421d9b32SPeter Brune *lsnes = snes; 73421d9b32SPeter Brune if (fas->level < level) { 74421d9b32SPeter Brune SETERRQ(((PetscObject)snes)->comm, PETSC_ERR_ARG_OUTOFRANGE, "SNESFASGetSNES should only be called on a finer SNESFAS instance than the level."); 75421d9b32SPeter Brune } 76421d9b32SPeter Brune if (level > levels - 1) { 77421d9b32SPeter Brune SETERRQ(((PetscObject)snes)->comm, PETSC_ERR_ARG_OUTOFRANGE, "Level %d doesn't exist in the SNESFAS."); 78421d9b32SPeter Brune } 79421d9b32SPeter Brune for (i = fas->level; i > level; i--) { 80421d9b32SPeter Brune *lsnes = fas->next; 81421d9b32SPeter Brune fas = (SNES_FAS *)(*lsnes)->data; 82421d9b32SPeter Brune } 83421d9b32SPeter Brune if (fas->level != level) SETERRQ(((PetscObject)snes)->comm, PETSC_ERR_ARG_OUTOFRANGE, "SNESFASGetSNES didn't return the right level!"); 84421d9b32SPeter Brune PetscFunctionReturn(0); 85421d9b32SPeter Brune } 86421d9b32SPeter Brune 87421d9b32SPeter Brune #undef __FUNCT__ 88421d9b32SPeter Brune #define __FUNCT__ "SNESFASSetLevels" 89421d9b32SPeter Brune PetscErrorCode SNESFASSetLevels(SNES snes, PetscInt levels, MPI_Comm * comms) { 90421d9b32SPeter Brune PetscErrorCode ierr; 91421d9b32SPeter Brune PetscInt i; 92421d9b32SPeter Brune SNES_FAS * fas = (SNES_FAS *)snes->data; 93421d9b32SPeter Brune MPI_Comm comm; 94421d9b32SPeter Brune PetscFunctionBegin; 95ee1fd11aSPeter Brune comm = ((PetscObject)snes)->comm; 96ee1fd11aSPeter Brune if (levels == fas->levels) { 97ee1fd11aSPeter Brune if (!comms) 98ee1fd11aSPeter Brune PetscFunctionReturn(0); 99ee1fd11aSPeter Brune } 100421d9b32SPeter Brune /* user has changed the number of levels; reset */ 101421d9b32SPeter Brune ierr = SNESReset(snes);CHKERRQ(ierr); 102421d9b32SPeter Brune /* destroy any coarser levels if necessary */ 103421d9b32SPeter Brune if (fas->next) SNESDestroy(&fas->next);CHKERRQ(ierr); 104ee1fd11aSPeter Brune fas->next = PETSC_NULL; 105421d9b32SPeter Brune /* setup the finest level */ 106421d9b32SPeter Brune for (i = levels - 1; i >= 0; i--) { 107421d9b32SPeter Brune if (comms) comm = comms[i]; 108421d9b32SPeter Brune fas->level = i; 109421d9b32SPeter Brune fas->levels = levels; 110ee1fd11aSPeter Brune fas->next = PETSC_NULL; 111421d9b32SPeter Brune if (i > 0) { 112421d9b32SPeter Brune ierr = SNESCreate(comm, &fas->next);CHKERRQ(ierr); 113293a7e31SPeter Brune ierr = PetscObjectIncrementTabLevel((PetscObject)fas->next, (PetscObject)snes, levels - i);CHKERRQ(ierr); 114421d9b32SPeter Brune ierr = SNESSetType(fas->next, SNESFAS);CHKERRQ(ierr); 115421d9b32SPeter Brune fas = (SNES_FAS *)fas->next->data; 116421d9b32SPeter Brune } 117421d9b32SPeter Brune } 118421d9b32SPeter Brune PetscFunctionReturn(0); 119421d9b32SPeter Brune } 120421d9b32SPeter Brune 121421d9b32SPeter Brune #undef __FUNCT__ 122421d9b32SPeter Brune #define __FUNCT__ "SNESFASSetInterpolation" 123421d9b32SPeter Brune PetscErrorCode SNESFASSetInterpolation(SNES snes, PetscInt level, Mat mat) { 124421d9b32SPeter Brune SNES_FAS * fas = (SNES_FAS *)snes->data; 125d9ce41dcSBarry Smith PetscInt top_level = fas->level,i; 126421d9b32SPeter Brune 127421d9b32SPeter Brune PetscFunctionBegin; 128421d9b32SPeter Brune if (level > top_level) 129421d9b32SPeter Brune SETERRQ1(((PetscObject)snes)->comm, PETSC_ERR_ARG_OUTOFRANGE, "Bad level number %d in SNESFASSetInterpolation", level); 130421d9b32SPeter Brune /* get to the correct level */ 131d9ce41dcSBarry Smith for (i = fas->level; i > level; i--) { 132421d9b32SPeter Brune fas = (SNES_FAS *)fas->next->data; 133421d9b32SPeter Brune } 134421d9b32SPeter Brune if (fas->level != level) 135421d9b32SPeter Brune SETERRQ(((PetscObject)snes)->comm, PETSC_ERR_ARG_WRONG, "Inconsistent level labelling in SNESFASSetInterpolation"); 136421d9b32SPeter Brune fas->interpolate = mat; 137421d9b32SPeter Brune PetscFunctionReturn(0); 138421d9b32SPeter Brune } 139421d9b32SPeter Brune 140421d9b32SPeter Brune #undef __FUNCT__ 141421d9b32SPeter Brune #define __FUNCT__ "SNESFASSetRestriction" 142421d9b32SPeter Brune PetscErrorCode SNESFASSetRestriction(SNES snes, PetscInt level, Mat mat) { 143421d9b32SPeter Brune SNES_FAS * fas = (SNES_FAS *)snes->data; 144d9ce41dcSBarry Smith PetscInt top_level = fas->level,i; 145421d9b32SPeter Brune 146421d9b32SPeter Brune PetscFunctionBegin; 147421d9b32SPeter Brune if (level > top_level) 148421d9b32SPeter Brune SETERRQ1(((PetscObject)snes)->comm, PETSC_ERR_ARG_OUTOFRANGE, "Bad level number %d in SNESFASSetRestriction", level); 149421d9b32SPeter Brune /* get to the correct level */ 150d9ce41dcSBarry Smith for (i = fas->level; i > level; i--) { 151421d9b32SPeter Brune fas = (SNES_FAS *)fas->next->data; 152421d9b32SPeter Brune } 153421d9b32SPeter Brune if (fas->level != level) 154421d9b32SPeter Brune SETERRQ(((PetscObject)snes)->comm, PETSC_ERR_ARG_WRONG, "Inconsistent level labelling in SNESFASSetRestriction"); 155421d9b32SPeter Brune fas->restrct = mat; 156421d9b32SPeter Brune PetscFunctionReturn(0); 157421d9b32SPeter Brune } 158421d9b32SPeter Brune 159421d9b32SPeter Brune #undef __FUNCT__ 160421d9b32SPeter Brune #define __FUNCT__ "SNESFASSetRScale" 161421d9b32SPeter Brune PetscErrorCode SNESFASSetRScale(SNES snes, PetscInt level, Vec rscale) { 162421d9b32SPeter Brune SNES_FAS * fas = (SNES_FAS *)snes->data; 163d9ce41dcSBarry Smith PetscInt top_level = fas->level,i; 164421d9b32SPeter Brune 165421d9b32SPeter Brune PetscFunctionBegin; 166421d9b32SPeter Brune if (level > top_level) 167421d9b32SPeter Brune SETERRQ1(((PetscObject)snes)->comm, PETSC_ERR_ARG_OUTOFRANGE, "Bad level number %d in SNESFASSetRestriction", level); 168421d9b32SPeter Brune /* get to the correct level */ 169d9ce41dcSBarry Smith for (i = fas->level; i > level; i--) { 170421d9b32SPeter Brune fas = (SNES_FAS *)fas->next->data; 171421d9b32SPeter Brune } 172421d9b32SPeter Brune if (fas->level != level) 173421d9b32SPeter Brune SETERRQ(((PetscObject)snes)->comm, PETSC_ERR_ARG_WRONG, "Inconsistent level labelling in SNESFASSetRestriction"); 174421d9b32SPeter Brune fas->rscale = rscale; 175421d9b32SPeter Brune PetscFunctionReturn(0); 176421d9b32SPeter Brune } 177421d9b32SPeter Brune 178421d9b32SPeter Brune #undef __FUNCT__ 179421d9b32SPeter Brune #define __FUNCT__ "SNESReset_FAS" 180421d9b32SPeter Brune PetscErrorCode SNESReset_FAS(SNES snes) 181421d9b32SPeter Brune { 18277df8cc4SPeter Brune PetscErrorCode ierr = 0; 183421d9b32SPeter Brune SNES_FAS * fas = (SNES_FAS *)snes->data; 184421d9b32SPeter Brune 185421d9b32SPeter Brune PetscFunctionBegin; 186421d9b32SPeter Brune /* destroy local data created in SNESSetup_FAS */ 18751e86f29SPeter Brune #if 0 188293a7e31SPeter Brune /* recurse -- reset should destroy the structures -- destroy should destroy the structures recursively */ 18951e86f29SPeter Brune #endif 190ee1fd11aSPeter Brune if (fas->next) ierr = SNESReset_FAS(fas->next);CHKERRQ(ierr); 19151e86f29SPeter Brune #if 0 19251e86f29SPeter Brune #endif 193421d9b32SPeter Brune PetscFunctionReturn(0); 194421d9b32SPeter Brune } 195421d9b32SPeter Brune 196421d9b32SPeter Brune #undef __FUNCT__ 197421d9b32SPeter Brune #define __FUNCT__ "SNESDestroy_FAS" 198421d9b32SPeter Brune PetscErrorCode SNESDestroy_FAS(SNES snes) 199421d9b32SPeter Brune { 200421d9b32SPeter Brune SNES_FAS * fas = (SNES_FAS *)snes->data; 201421d9b32SPeter Brune PetscErrorCode ierr; 202421d9b32SPeter Brune 203421d9b32SPeter Brune PetscFunctionBegin; 204421d9b32SPeter Brune /* recursively resets and then destroys */ 205421d9b32SPeter Brune ierr = SNESReset_FAS(snes);CHKERRQ(ierr); 20651e86f29SPeter Brune if (fas->upsmooth) ierr = SNESDestroy(&fas->upsmooth);CHKERRQ(ierr); 20751e86f29SPeter Brune if (fas->downsmooth) ierr = SNESDestroy(&fas->downsmooth);CHKERRQ(ierr); 20851e86f29SPeter Brune if (fas->interpolate == fas->restrct) { 20951e86f29SPeter Brune if (fas->interpolate) ierr = MatDestroy(&fas->interpolate);CHKERRQ(ierr); 21051e86f29SPeter Brune fas->restrct = PETSC_NULL; 21151e86f29SPeter Brune } else { 21251e86f29SPeter Brune if (fas->interpolate) ierr = MatDestroy(&fas->interpolate);CHKERRQ(ierr); 21351e86f29SPeter Brune if (fas->restrct) ierr = MatDestroy(&fas->restrct);CHKERRQ(ierr); 21451e86f29SPeter Brune } 21551e86f29SPeter Brune if (fas->rscale) ierr = VecDestroy(&fas->rscale);CHKERRQ(ierr); 21651e86f29SPeter Brune if (snes->work) ierr = VecDestroyVecs(snes->nwork,&snes->work);CHKERRQ(ierr); 217421d9b32SPeter Brune if (fas->next) ierr = SNESDestroy(&fas->next);CHKERRQ(ierr); 218421d9b32SPeter Brune ierr = PetscFree(fas);CHKERRQ(ierr); 219ee1fd11aSPeter Brune 220421d9b32SPeter Brune PetscFunctionReturn(0); 221421d9b32SPeter Brune } 222421d9b32SPeter Brune 223421d9b32SPeter Brune #undef __FUNCT__ 224421d9b32SPeter Brune #define __FUNCT__ "SNESSetUp_FAS" 225421d9b32SPeter Brune PetscErrorCode SNESSetUp_FAS(SNES snes) 226421d9b32SPeter Brune { 227*1a266240SBarry Smith SNES_FAS *fas = (SNES_FAS *) snes->data,*tmp; 228421d9b32SPeter Brune PetscErrorCode ierr; 229421d9b32SPeter Brune 230421d9b32SPeter Brune PetscFunctionBegin; 231*1a266240SBarry Smith /* should call the SNESSetFromOptions() only when approriate */ 232*1a266240SBarry Smith tmp = fas; 233*1a266240SBarry Smith while (tmp) { 234*1a266240SBarry Smith if (tmp->upsmooth) {ierr = SNESSetFromOptions(tmp->upsmooth);} 235*1a266240SBarry Smith if (tmp->downsmooth) {ierr = SNESSetFromOptions(tmp->upsmooth);} 236*1a266240SBarry Smith tmp = tmp->next ? (SNES_FAS*) tmp->next->data : 0; 237*1a266240SBarry Smith } 238*1a266240SBarry Smith 239*1a266240SBarry Smith if (!snes->work || snes->nwork != 2) {ierr = SNESDefaultGetWork(snes, 2);CHKERRQ(ierr);} /* work vectors used for intergrid transfers */ 240421d9b32SPeter Brune /* gets the solver ready for solution */ 241421d9b32SPeter Brune if (snes->dm) { 242421d9b32SPeter Brune /* construct EVERYTHING from the DM -- including the progressive set of smoothers */ 243421d9b32SPeter Brune if (fas->next) { 244421d9b32SPeter Brune /* for now -- assume the DM and the evaluation functions have been set externally */ 245ee78dd50SPeter Brune if (!fas->next->dm) { 246ee78dd50SPeter Brune ierr = DMCoarsen(snes->dm, ((PetscObject)fas->next)->comm, &fas->next->dm);CHKERRQ(ierr); 247ee78dd50SPeter Brune ierr = SNESSetDM(fas->next, fas->next->dm);CHKERRQ(ierr); 248ee78dd50SPeter Brune } 249421d9b32SPeter Brune /* set the interpolation and restriction from the DM */ 250ee78dd50SPeter Brune if (!fas->interpolate) { 251421d9b32SPeter Brune ierr = DMGetInterpolation(fas->next->dm, snes->dm, &fas->interpolate, &fas->rscale);CHKERRQ(ierr); 252421d9b32SPeter Brune fas->restrct = fas->interpolate; 253421d9b32SPeter Brune } 254421d9b32SPeter Brune } 255ee78dd50SPeter Brune /* set the DMs of the pre and post-smoothers here */ 256ee78dd50SPeter Brune if (fas->upsmooth) SNESSetDM(fas->upsmooth, snes->dm);CHKERRQ(ierr); 257ee78dd50SPeter Brune if (fas->downsmooth)SNESSetDM(fas->downsmooth, snes->dm);CHKERRQ(ierr); 258421d9b32SPeter Brune } 259fa9694d7SPeter Brune if (fas->next) { 260fa9694d7SPeter Brune /* gotta set up the solution vector for this to work */ 26151e86f29SPeter Brune if (!fas->next->vec_sol)ierr = VecDuplicate(fas->rscale, &fas->next->vec_sol);CHKERRQ(ierr); 262fa9694d7SPeter Brune ierr = SNESSetUp(fas->next);CHKERRQ(ierr); 263fa9694d7SPeter Brune } 264fa9694d7SPeter Brune /* got to set them all up at once */ 265421d9b32SPeter Brune PetscFunctionReturn(0); 266421d9b32SPeter Brune } 267421d9b32SPeter Brune 268421d9b32SPeter Brune #undef __FUNCT__ 269421d9b32SPeter Brune #define __FUNCT__ "SNESSetFromOptions_FAS" 270421d9b32SPeter Brune PetscErrorCode SNESSetFromOptions_FAS(SNES snes) 271421d9b32SPeter Brune { 272ee78dd50SPeter Brune SNES_FAS *fas = (SNES_FAS *) snes->data; 273ee78dd50SPeter Brune PetscInt levels = 1; 274ee78dd50SPeter Brune PetscBool flg, monflg; 275421d9b32SPeter Brune PetscErrorCode ierr; 276ee78dd50SPeter Brune const char * def_smooth = SNESNRICHARDSON; 277ee78dd50SPeter Brune char pre_type[256]; 278ee78dd50SPeter Brune char post_type[256]; 279ee78dd50SPeter Brune char monfilename[PETSC_MAX_PATH_LEN]; 280421d9b32SPeter Brune 281421d9b32SPeter Brune PetscFunctionBegin; 282c90fad12SPeter Brune ierr = PetscOptionsHead("SNESFAS Options-----------------------------------");CHKERRQ(ierr); 283ee78dd50SPeter Brune 284ee78dd50SPeter Brune /* number of levels -- only process on the finest level */ 285ee78dd50SPeter Brune if (fas->levels - 1 == fas->level) { 286ee78dd50SPeter Brune ierr = PetscOptionsInt("-snes_fas_levels", "Number of Levels", "SNESFASSetLevels", levels, &levels, &flg);CHKERRQ(ierr); 287c732cbdbSBarry Smith if (!flg && snes->dm) { 288c732cbdbSBarry Smith ierr = DMGetRefineLevel(snes->dm,&levels);CHKERRQ(ierr); 289c732cbdbSBarry Smith levels++; 290c732cbdbSBarry Smith } 291ee78dd50SPeter Brune ierr = SNESFASSetLevels(snes, levels, PETSC_NULL);CHKERRQ(ierr); 292ee78dd50SPeter Brune } 293ee78dd50SPeter Brune 294ee78dd50SPeter Brune /* type of pre and/or post smoothers -- set both at once */ 295ee78dd50SPeter Brune ierr = PetscMemcpy(post_type, def_smooth, 256);CHKERRQ(ierr); 296ee78dd50SPeter Brune ierr = PetscMemcpy(pre_type, def_smooth, 256);CHKERRQ(ierr); 297ee78dd50SPeter Brune ierr = PetscOptionsList("-snes_fas_smoother_type","Nonlinear smoother method","SNESSetType",SNESList,def_smooth,pre_type,256,&flg);CHKERRQ(ierr); 298ee78dd50SPeter Brune if (flg) { 299ee78dd50SPeter Brune ierr = PetscMemcpy(post_type, pre_type, 256);CHKERRQ(ierr); 300ee78dd50SPeter Brune } else { 301ee78dd50SPeter Brune ierr = PetscOptionsList("-snes_fas_smoothup_type", "Nonlinear smoother method","SNESSetType",SNESList,def_smooth,pre_type, 256,&flg);CHKERRQ(ierr); 302ee78dd50SPeter Brune ierr = PetscOptionsList("-snes_fas_smoothdown_type","Nonlinear smoother method","SNESSetType",SNESList,def_smooth,post_type,256,&flg);CHKERRQ(ierr); 303ee78dd50SPeter Brune } 304ee78dd50SPeter Brune 305ee78dd50SPeter Brune /* options for the number of preconditioning cycles and cycle type */ 306ee78dd50SPeter Brune ierr = PetscOptionsInt("-snes_fas_up_it","Number of upsmoother iterations","PCMGSetNumberSmoothUp",fas->max_up_it,&fas->max_up_it,&flg);CHKERRQ(ierr); 307ee78dd50SPeter Brune ierr = PetscOptionsInt("-snes_fas_down_it","Number of downsmoother iterations","PCMGSetNumberSmoothUp",fas->max_down_it,&fas->max_down_it,&flg);CHKERRQ(ierr); 308ee78dd50SPeter Brune ierr = PetscOptionsInt("-snes_fas_cycles","Number of cycles","PCMGSetNumberSmoothUp",fas->n_cycles,&fas->n_cycles,&flg);CHKERRQ(ierr); 309ee78dd50SPeter Brune 310ee78dd50SPeter Brune ierr = PetscOptionsString("-snes_fas_monitor","Monitor for smoothers","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&monflg);CHKERRQ(ierr); 311ee78dd50SPeter Brune 312ee78dd50SPeter Brune /* other options for the coarsest level */ 313ee78dd50SPeter Brune if (fas->level == 0) { 314ee78dd50SPeter Brune ierr = PetscOptionsList("-snes_fas_coarse_smoother_type","Coarsest smoother method","SNESSetType",SNESList,def_smooth,pre_type,256,&flg);CHKERRQ(ierr); 315ee78dd50SPeter Brune if (flg) { 316ee78dd50SPeter Brune ierr = PetscMemcpy(post_type, pre_type, 256);CHKERRQ(ierr); 317ee78dd50SPeter Brune } else { 318ee78dd50SPeter Brune ierr = PetscOptionsList("-snes_fas_coarse_smoothup_type", "Nonlinear smoother method","SNESSetType",SNESList,def_smooth,pre_type, 256,&flg);CHKERRQ(ierr); 319ee78dd50SPeter Brune ierr = PetscOptionsList("-snes_fas_coarse_smoothdown_type","Nonlinear smoother method","SNESSetType",SNESList,def_smooth,post_type,256,&flg);CHKERRQ(ierr); 320ee78dd50SPeter Brune } 321ee78dd50SPeter Brune } 322ee78dd50SPeter Brune 323421d9b32SPeter Brune ierr = PetscOptionsTail();CHKERRQ(ierr); 324ee78dd50SPeter Brune /* setup from the determined types if the smoothers don't exist */ 325ee78dd50SPeter Brune if (!fas->upsmooth) { 32667339d5cSBarry Smith const char *prefix; 32767339d5cSBarry Smith ierr = SNESGetOptionsPrefix(snes,&prefix);CHKERRQ(ierr); 328ee78dd50SPeter Brune ierr = SNESCreate(((PetscObject)snes)->comm, &fas->upsmooth);CHKERRQ(ierr); 32967339d5cSBarry Smith ierr = SNESSetOptionsPrefix(fas->upsmooth,prefix);CHKERRQ(ierr); 330*1a266240SBarry Smith if (fas->level || (fas->levels == 1)) { 33167339d5cSBarry Smith ierr = SNESAppendOptionsPrefix(fas->upsmooth,"fas_levels_");CHKERRQ(ierr); 33267339d5cSBarry Smith } else { 33367339d5cSBarry Smith ierr = SNESAppendOptionsPrefix(fas->upsmooth,"fas_coarse_");CHKERRQ(ierr); 33467339d5cSBarry Smith } 335293a7e31SPeter Brune ierr = PetscObjectIncrementTabLevel((PetscObject)fas->upsmooth, (PetscObject)snes, 1);CHKERRQ(ierr); 336ee78dd50SPeter Brune ierr = SNESSetType(fas->upsmooth, pre_type);CHKERRQ(ierr); 33769bed9afSBarry Smith if (snes->ops->computefunction) { 33869bed9afSBarry Smith ierr = SNESSetFunction(fas->upsmooth,PETSC_NULL,snes->ops->computefunction,snes->funP);CHKERRQ(ierr); 33969bed9afSBarry Smith } 340ee78dd50SPeter Brune } 341*1a266240SBarry Smith if (fas->upsmooth) { 342*1a266240SBarry Smith ierr = SNESSetTolerances(fas->upsmooth, 0.0, 0.0, 0.0, fas->max_up_it, 1000);CHKERRQ(ierr); 343*1a266240SBarry Smith } 344*1a266240SBarry Smith 345293a7e31SPeter Brune if (!fas->downsmooth && fas->level != 0) { 34667339d5cSBarry Smith const char *prefix; 34767339d5cSBarry Smith ierr = SNESGetOptionsPrefix(snes,&prefix);CHKERRQ(ierr); 348ee78dd50SPeter Brune ierr = SNESCreate(((PetscObject)snes)->comm, &fas->downsmooth);CHKERRQ(ierr); 34967339d5cSBarry Smith ierr = SNESSetOptionsPrefix(fas->downsmooth,prefix);CHKERRQ(ierr); 35067339d5cSBarry Smith ierr = SNESAppendOptionsPrefix(fas->downsmooth,"fas_levels_");CHKERRQ(ierr); 351293a7e31SPeter Brune ierr = PetscObjectIncrementTabLevel((PetscObject)fas->downsmooth, (PetscObject)snes, 1);CHKERRQ(ierr); 352ee78dd50SPeter Brune ierr = SNESSetType(fas->downsmooth, pre_type);CHKERRQ(ierr); 35369bed9afSBarry Smith if (snes->ops->computefunction) { 35469bed9afSBarry Smith ierr = SNESSetFunction(fas->downsmooth,PETSC_NULL,snes->ops->computefunction,snes->funP);CHKERRQ(ierr); 35569bed9afSBarry Smith } 356ee78dd50SPeter Brune } 357*1a266240SBarry Smith if (fas->downsmooth) { 358*1a266240SBarry Smith ierr = SNESSetTolerances(fas->downsmooth, 0.0, 0.0, 0.0, fas->max_down_it, 1000);CHKERRQ(ierr); 359*1a266240SBarry Smith } 360ee78dd50SPeter Brune 361ee78dd50SPeter Brune if (monflg) { 362293a7e31SPeter Brune if (fas->upsmooth) ierr = SNESMonitorSet(fas->upsmooth,SNESMonitorDefault,PETSC_NULL,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 363293a7e31SPeter Brune if (fas->downsmooth) ierr = SNESMonitorSet(fas->downsmooth,SNESMonitorDefault,PETSC_NULL,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 364ee78dd50SPeter Brune } 365ee78dd50SPeter Brune 366ee78dd50SPeter Brune /* recursive option setting for the smoothers */ 367*1a266240SBarry Smith if (fas->next) {ierr = SNESSetFromOptions_FAS(fas->next);CHKERRQ(ierr);} 368421d9b32SPeter Brune PetscFunctionReturn(0); 369421d9b32SPeter Brune } 370421d9b32SPeter Brune 371421d9b32SPeter Brune #undef __FUNCT__ 372421d9b32SPeter Brune #define __FUNCT__ "SNESView_FAS" 373421d9b32SPeter Brune PetscErrorCode SNESView_FAS(SNES snes, PetscViewer viewer) 374421d9b32SPeter Brune { 375421d9b32SPeter Brune SNES_FAS *fas = (SNES_FAS *) snes->data; 376421d9b32SPeter Brune PetscBool iascii; 377421d9b32SPeter Brune PetscErrorCode ierr; 378421d9b32SPeter Brune PetscInt levels = fas->levels; 379421d9b32SPeter Brune PetscInt i; 380421d9b32SPeter Brune 381421d9b32SPeter Brune PetscFunctionBegin; 382421d9b32SPeter Brune ierr = PetscTypeCompare((PetscObject) viewer, PETSCVIEWERASCII, &iascii);CHKERRQ(ierr); 383421d9b32SPeter Brune if (iascii) { 384421d9b32SPeter Brune ierr = PetscViewerASCIIPrintf(viewer, "FAS, levels = %d\n", fas->levels);CHKERRQ(ierr); 385421d9b32SPeter Brune ierr = PetscViewerASCIIPushTab(viewer); 386421d9b32SPeter Brune for (i = levels - 1; i >= 0; i--) { 387421d9b32SPeter Brune ierr = PetscViewerASCIIPrintf(viewer, "level: %d\n", fas->level);CHKERRQ(ierr); 388ee78dd50SPeter Brune if (fas->upsmooth) { 389ee78dd50SPeter Brune ierr = PetscViewerASCIIPrintf(viewer, "up-smoother on level %D\n", fas->level);CHKERRQ(ierr); 390421d9b32SPeter Brune ierr = PetscViewerASCIIPushTab(viewer); 391ee78dd50SPeter Brune ierr = SNESView(fas->upsmooth, viewer);CHKERRQ(ierr); 392421d9b32SPeter Brune ierr = PetscViewerASCIIPopTab(viewer); 393421d9b32SPeter Brune } else { 394ee78dd50SPeter Brune ierr = PetscViewerASCIIPrintf(viewer, "no up-smoother on level %D\n", fas->level);CHKERRQ(ierr); 395421d9b32SPeter Brune } 396ee78dd50SPeter Brune if (fas->downsmooth) { 397ee78dd50SPeter Brune ierr = PetscViewerASCIIPrintf(viewer, "down-smoother on level %D\n", fas->level);CHKERRQ(ierr); 398421d9b32SPeter Brune ierr = PetscViewerASCIIPushTab(viewer); 399ee78dd50SPeter Brune ierr = SNESView(fas->downsmooth, viewer);CHKERRQ(ierr); 400421d9b32SPeter Brune ierr = PetscViewerASCIIPopTab(viewer); 401421d9b32SPeter Brune } else { 402ee78dd50SPeter Brune ierr = PetscViewerASCIIPrintf(viewer, "no down-smoother on level %D\n", fas->level);CHKERRQ(ierr); 403421d9b32SPeter Brune } 404421d9b32SPeter Brune if (fas->next) fas = (SNES_FAS *)fas->next->data; 405421d9b32SPeter Brune } 406421d9b32SPeter Brune ierr = PetscViewerASCIIPopTab(viewer); 407421d9b32SPeter Brune } else { 408421d9b32SPeter Brune SETERRQ1(((PetscObject)snes)->comm,PETSC_ERR_SUP,"Viewer type %s not supported for SNESFAS",((PetscObject)viewer)->type_name); 409421d9b32SPeter Brune } 410421d9b32SPeter Brune PetscFunctionReturn(0); 411421d9b32SPeter Brune } 412421d9b32SPeter Brune 413421d9b32SPeter Brune /* 414fa9694d7SPeter Brune 415fa9694d7SPeter Brune Defines the FAS cycle as: 416fa9694d7SPeter Brune 417fa9694d7SPeter Brune fine problem: F(x) = 0 418fa9694d7SPeter Brune coarse problem: F^c(x) = b^c 419fa9694d7SPeter Brune 420fa9694d7SPeter Brune b^c = F^c(I^c_fx^f - I^c_fF(x)) 421fa9694d7SPeter Brune 422fa9694d7SPeter Brune correction: 423fa9694d7SPeter Brune 424fa9694d7SPeter Brune x = x + I(x^c - Rx) 425fa9694d7SPeter Brune 426421d9b32SPeter Brune */ 427fa9694d7SPeter Brune 428421d9b32SPeter Brune #undef __FUNCT__ 429421d9b32SPeter Brune #define __FUNCT__ "FASCycle_Private" 430c90fad12SPeter Brune PetscErrorCode FASCycle_Private(SNES snes, Vec B, Vec X, Vec F) { 431fa9694d7SPeter Brune 432fa9694d7SPeter Brune PetscErrorCode ierr; 433fa9694d7SPeter Brune Vec X_c, Xo_c, F_c, B_c; 434fa9694d7SPeter Brune SNES_FAS * fas = (SNES_FAS *)snes->data; 435293a7e31SPeter Brune PetscInt i; 436421d9b32SPeter Brune 437421d9b32SPeter Brune PetscFunctionBegin; 438fa9694d7SPeter Brune /* pre-smooth -- just update using the pre-smoother */ 439ee78dd50SPeter Brune if (fas->upsmooth) { 440ee78dd50SPeter Brune ierr = SNESSolve(fas->upsmooth, B, X);CHKERRQ(ierr); 441c90fad12SPeter Brune } else if (snes->pc) { 442c90fad12SPeter Brune ierr = SNESSolve(snes->pc, B, X);CHKERRQ(ierr); 443fe6f9142SPeter Brune } 444fa9694d7SPeter Brune if (fas->next) { 445293a7e31SPeter Brune for (i = 0; i < fas->n_cycles; i++) { 446ee78dd50SPeter Brune ierr = SNESComputeFunction(snes, X, F);CHKERRQ(ierr); 447c90fad12SPeter Brune X_c = fas->next->vec_sol; 448293a7e31SPeter Brune Xo_c = fas->next->work[0]; 449c90fad12SPeter Brune F_c = fas->next->vec_func; 450293a7e31SPeter Brune B_c = fas->next->work[1]; 451293a7e31SPeter Brune /* inject the solution to coarse */ 452c90fad12SPeter Brune ierr = MatRestrict(fas->restrct, X, Xo_c);CHKERRQ(ierr); 453fa9694d7SPeter Brune ierr = VecPointwiseMult(Xo_c, fas->rscale, Xo_c);CHKERRQ(ierr); 454c90fad12SPeter Brune if (B) { 455293a7e31SPeter Brune ierr = VecAYPX(F, -1.0, B);CHKERRQ(ierr); /* F = B - F (defect) */ 456c90fad12SPeter Brune } else { 457293a7e31SPeter Brune ierr = VecScale(F, -1.0);CHKERRQ(ierr); 458c90fad12SPeter Brune } 459293a7e31SPeter Brune 460293a7e31SPeter Brune /* restrict the defect */ 461293a7e31SPeter Brune ierr = MatRestrict(fas->restrct, F, B_c);CHKERRQ(ierr); 462293a7e31SPeter Brune ierr = VecPointwiseMult(B_c, fas->rscale, B_c);CHKERRQ(ierr); 463293a7e31SPeter Brune 464c90fad12SPeter Brune /* solve the coarse problem corresponding to F^c(x^c) = b^c = Rb + F^c(Rx) - RF(x) */ 465ee78dd50SPeter Brune fas->next->vec_rhs = PETSC_NULL; /*unset the RHS to evaluate function instead of residual*/ 466c90fad12SPeter Brune ierr = SNESComputeFunction(fas->next, Xo_c, F_c);CHKERRQ(ierr); 467293a7e31SPeter Brune ierr = VecAXPY(B_c, 1.0, F_c);CHKERRQ(ierr); /* add F_c(X) to the RHS */ 468c90fad12SPeter Brune 469ee78dd50SPeter Brune /* set initial guess of the coarse problem to the projected fine solution */ 470ee78dd50SPeter Brune ierr = VecCopy(Xo_c, X_c);CHKERRQ(ierr); 471c90fad12SPeter Brune 472c90fad12SPeter Brune /* recurse to the next level */ 473c90fad12SPeter Brune ierr = FASCycle_Private(fas->next, B_c, X_c, F_c);CHKERRQ(ierr); 474ee78dd50SPeter Brune 475fa9694d7SPeter Brune /* correct as x <- x + I(x^c - Rx)*/ 476fa9694d7SPeter Brune ierr = VecAXPY(X_c, -1.0, Xo_c);CHKERRQ(ierr); 477ee78dd50SPeter Brune ierr = MatInterpolateAdd(fas->interpolate, X_c, X, X);CHKERRQ(ierr); 478293a7e31SPeter Brune } 479fa9694d7SPeter Brune } 480ee78dd50SPeter Brune /* down-smooth -- just update using the down-smoother */ 481c90fad12SPeter Brune if (fas->level != 0) { 482ee78dd50SPeter Brune if (fas->downsmooth) { 483ee78dd50SPeter Brune ierr = SNESSolve(fas->downsmooth, B, X);CHKERRQ(ierr); 484c90fad12SPeter Brune } else if (snes->pc) { 485c90fad12SPeter Brune ierr = SNESSolve(snes->pc, B, X);CHKERRQ(ierr); 486c90fad12SPeter Brune } 487fe6f9142SPeter Brune } 488fe6f9142SPeter Brune ierr = SNESComputeFunction(snes, X, F);CHKERRQ(ierr); 489fa9694d7SPeter Brune 490fa9694d7SPeter Brune PetscFunctionReturn(0); 491421d9b32SPeter Brune } 492421d9b32SPeter Brune 493421d9b32SPeter Brune #undef __FUNCT__ 494c90fad12SPeter Brune #define __FUNCT__ "FASInitialGuess_Private" 495293a7e31SPeter Brune PetscErrorCode FASInitialGuess_Private(SNES snes, Vec B, Vec X) { 496c90fad12SPeter Brune 497293a7e31SPeter Brune PetscErrorCode ierr; 498293a7e31SPeter Brune Vec X_c, B_c; 499ee1fd11aSPeter Brune SNES_FAS * fas; 500293a7e31SPeter Brune 501293a7e31SPeter Brune PetscFunctionBegin; 502ee1fd11aSPeter Brune fas = (SNES_FAS *)snes->data; 503293a7e31SPeter Brune /* pre-smooth -- just update using the pre-smoother */ 504293a7e31SPeter Brune if (fas->level == 0) { 505293a7e31SPeter Brune if (fas->upsmooth) { 506293a7e31SPeter Brune ierr = SNESSolve(fas->upsmooth, B, X);CHKERRQ(ierr); 507293a7e31SPeter Brune } else if (snes->pc) { 508293a7e31SPeter Brune ierr = SNESSolve(snes->pc, B, X);CHKERRQ(ierr); 509293a7e31SPeter Brune } 510293a7e31SPeter Brune } 511293a7e31SPeter Brune if (fas->next) { 512293a7e31SPeter Brune X_c = fas->next->vec_sol; 513293a7e31SPeter Brune B_c = fas->next->work[0]; 514293a7e31SPeter Brune /* inject the solution to coarse */ 515293a7e31SPeter Brune ierr = MatRestrict(fas->restrct, X, X_c);CHKERRQ(ierr); 516293a7e31SPeter Brune ierr = VecPointwiseMult(X_c, fas->rscale, X_c);CHKERRQ(ierr); 517293a7e31SPeter Brune if (B) { 518293a7e31SPeter Brune ierr = MatRestrict(fas->restrct, B, B_c);CHKERRQ(ierr); 519293a7e31SPeter Brune ierr = VecPointwiseMult(B_c, fas->rscale, B_c);CHKERRQ(ierr); 520293a7e31SPeter Brune } else { 521293a7e31SPeter Brune B_c = PETSC_NULL; 522293a7e31SPeter Brune } 523293a7e31SPeter Brune /* recurse to the next level */ 524293a7e31SPeter Brune ierr = FASInitialGuess_Private(fas->next, B_c, X_c);CHKERRQ(ierr); 525293a7e31SPeter Brune ierr = MatInterpolate(fas->interpolate, X_c, X);CHKERRQ(ierr); 526293a7e31SPeter Brune } 527293a7e31SPeter Brune /* down-smooth -- just update using the down-smoother */ 528293a7e31SPeter Brune if (fas->level != 0) { 529293a7e31SPeter Brune if (fas->downsmooth) { 530293a7e31SPeter Brune ierr = SNESSolve(fas->downsmooth, B, X);CHKERRQ(ierr); 531293a7e31SPeter Brune } else if (snes->pc) { 532293a7e31SPeter Brune ierr = SNESSolve(snes->pc, B, X);CHKERRQ(ierr); 533293a7e31SPeter Brune } 534293a7e31SPeter Brune } 535293a7e31SPeter Brune PetscFunctionReturn(0); 536293a7e31SPeter Brune } 537c90fad12SPeter Brune 538c90fad12SPeter Brune #undef __FUNCT__ 539421d9b32SPeter Brune #define __FUNCT__ "SNESSolve_FAS" 540421d9b32SPeter Brune 541421d9b32SPeter Brune PetscErrorCode SNESSolve_FAS(SNES snes) 542421d9b32SPeter Brune { 543fa9694d7SPeter Brune PetscErrorCode ierr; 544fe6f9142SPeter Brune PetscInt i, maxits; 545fe6f9142SPeter Brune Vec X, F, B; 546fe6f9142SPeter Brune PetscReal fnorm; 547421d9b32SPeter Brune PetscFunctionBegin; 548fe6f9142SPeter Brune maxits = snes->max_its; /* maximum number of iterations */ 549fe6f9142SPeter Brune snes->reason = SNES_CONVERGED_ITERATING; 550fa9694d7SPeter Brune X = snes->vec_sol; 551fa9694d7SPeter Brune F = snes->vec_func; 552fe6f9142SPeter Brune B = snes->vec_rhs; 553293a7e31SPeter Brune 554293a7e31SPeter Brune /*norm setup */ 555fe6f9142SPeter Brune ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 556fe6f9142SPeter Brune snes->iter = 0; 557fe6f9142SPeter Brune snes->norm = 0.; 558fe6f9142SPeter Brune ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 559fe6f9142SPeter Brune ierr = SNESComputeFunction(snes,X,F);CHKERRQ(ierr); 560fe6f9142SPeter Brune if (snes->domainerror) { 561fe6f9142SPeter Brune snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 562fe6f9142SPeter Brune PetscFunctionReturn(0); 563fe6f9142SPeter Brune } 564fe6f9142SPeter Brune ierr = VecNorm(F, NORM_2, &fnorm);CHKERRQ(ierr); /* fnorm <- ||F|| */ 565fe6f9142SPeter Brune if (PetscIsInfOrNanReal(fnorm)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FP,"Infinite or not-a-number generated in norm"); 566fe6f9142SPeter Brune ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 567fe6f9142SPeter Brune snes->norm = fnorm; 568fe6f9142SPeter Brune ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 569fe6f9142SPeter Brune SNESLogConvHistory(snes,fnorm,0); 570fe6f9142SPeter Brune ierr = SNESMonitor(snes,0,fnorm);CHKERRQ(ierr); 571fe6f9142SPeter Brune 572fe6f9142SPeter Brune /* set parameter for default relative tolerance convergence test */ 573fe6f9142SPeter Brune snes->ttol = fnorm*snes->rtol; 574fe6f9142SPeter Brune /* test convergence */ 575fe6f9142SPeter Brune ierr = (*snes->ops->converged)(snes,0,0.0,0.0,fnorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 576fe6f9142SPeter Brune if (snes->reason) PetscFunctionReturn(0); 577fe6f9142SPeter Brune for (i = 0; i < maxits; i++) { 578fe6f9142SPeter Brune /* Call general purpose update function */ 579fe6f9142SPeter Brune if (snes->ops->update) { 580fe6f9142SPeter Brune ierr = (*snes->ops->update)(snes, snes->iter);CHKERRQ(ierr); 581fe6f9142SPeter Brune } 582c90fad12SPeter Brune ierr = FASCycle_Private(snes, B, X, F);CHKERRQ(ierr); 583c90fad12SPeter Brune ierr = VecNorm(F, NORM_2, &fnorm);CHKERRQ(ierr); /* fnorm <- ||F|| */ 584c90fad12SPeter Brune /* Monitor convergence */ 585c90fad12SPeter Brune ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 586c90fad12SPeter Brune snes->iter = i+1; 587c90fad12SPeter Brune snes->norm = fnorm; 588c90fad12SPeter Brune ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 589c90fad12SPeter Brune SNESLogConvHistory(snes,snes->norm,0); 590c90fad12SPeter Brune ierr = SNESMonitor(snes,snes->iter,snes->norm);CHKERRQ(ierr); 591c90fad12SPeter Brune /* Test for convergence */ 592c90fad12SPeter Brune ierr = (*snes->ops->converged)(snes,snes->iter,0.0,0.0,fnorm,&snes->reason,snes->cnvP);CHKERRQ(ierr); 593c90fad12SPeter Brune if (snes->reason) break; 594fe6f9142SPeter Brune } 595fe6f9142SPeter Brune if (i == maxits) { 596fe6f9142SPeter Brune ierr = PetscInfo1(snes, "Maximum number of iterations has been reached: %D\n", maxits);CHKERRQ(ierr); 597fe6f9142SPeter Brune if (!snes->reason) snes->reason = SNES_DIVERGED_MAX_IT; 598fe6f9142SPeter Brune } 599421d9b32SPeter Brune PetscFunctionReturn(0); 600421d9b32SPeter Brune } 601