19b94acceSBarry Smith 2b45d2f2cSJed Brown #include <petsc-private/snesimpl.h> /*I "petscsnes.h" I*/ 307475bc1SBarry Smith #include <petscdmshell.h> 49b94acceSBarry Smith 5ace3abfcSBarry Smith PetscBool SNESRegisterAllCalled = PETSC_FALSE; 60298fd71SBarry Smith PetscFunctionList SNESList = NULL; 78ba1e511SMatthew Knepley 88ba1e511SMatthew Knepley /* Logging support */ 922c6f798SBarry Smith PetscClassId SNES_CLASSID, DMSNES_CLASSID; 1063e7833aSPeter Brune PetscLogEvent SNES_Solve, SNES_FunctionEval, SNES_JacobianEval, SNES_GSEval, SNES_NPCSolve; 11a09944afSBarry Smith 12a09944afSBarry Smith #undef __FUNCT__ 13e113a28aSBarry Smith #define __FUNCT__ "SNESSetErrorIfNotConverged" 14e113a28aSBarry Smith /*@ 15e113a28aSBarry Smith SNESSetErrorIfNotConverged - Causes SNESSolve() to generate an error if the solver has not converged. 16e113a28aSBarry Smith 173f9fe445SBarry Smith Logically Collective on SNES 18e113a28aSBarry Smith 19e113a28aSBarry Smith Input Parameters: 20e113a28aSBarry Smith + snes - iterative context obtained from SNESCreate() 21e113a28aSBarry Smith - flg - PETSC_TRUE indicates you want the error generated 22e113a28aSBarry Smith 23e113a28aSBarry Smith Options database keys: 24e113a28aSBarry Smith . -snes_error_if_not_converged : this takes an optional truth value (0/1/no/yes/true/false) 25e113a28aSBarry Smith 26e113a28aSBarry Smith Level: intermediate 27e113a28aSBarry Smith 28e113a28aSBarry Smith Notes: 29e113a28aSBarry Smith Normally PETSc continues if a linear solver fails to converge, you can call SNESGetConvergedReason() after a SNESSolve() 30e113a28aSBarry Smith to determine if it has converged. 31e113a28aSBarry Smith 32e113a28aSBarry Smith .keywords: SNES, set, initial guess, nonzero 33e113a28aSBarry Smith 34e113a28aSBarry Smith .seealso: SNESGetErrorIfNotConverged(), KSPGetErrorIfNotConverged(), KSPSetErrorIFNotConverged() 35e113a28aSBarry Smith @*/ 367087cfbeSBarry Smith PetscErrorCode SNESSetErrorIfNotConverged(SNES snes,PetscBool flg) 37e113a28aSBarry Smith { 38e113a28aSBarry Smith PetscFunctionBegin; 39e113a28aSBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 40acfcf0e5SJed Brown PetscValidLogicalCollectiveBool(snes,flg,2); 41e113a28aSBarry Smith snes->errorifnotconverged = flg; 42e113a28aSBarry Smith PetscFunctionReturn(0); 43e113a28aSBarry Smith } 44e113a28aSBarry Smith 45e113a28aSBarry Smith #undef __FUNCT__ 46e113a28aSBarry Smith #define __FUNCT__ "SNESGetErrorIfNotConverged" 47e113a28aSBarry Smith /*@ 48e113a28aSBarry Smith SNESGetErrorIfNotConverged - Will SNESSolve() generate an error if the solver does not converge? 49e113a28aSBarry Smith 50e113a28aSBarry Smith Not Collective 51e113a28aSBarry Smith 52e113a28aSBarry Smith Input Parameter: 53e113a28aSBarry Smith . snes - iterative context obtained from SNESCreate() 54e113a28aSBarry Smith 55e113a28aSBarry Smith Output Parameter: 56e113a28aSBarry Smith . flag - PETSC_TRUE if it will generate an error, else PETSC_FALSE 57e113a28aSBarry Smith 58e113a28aSBarry Smith Level: intermediate 59e113a28aSBarry Smith 60e113a28aSBarry Smith .keywords: SNES, set, initial guess, nonzero 61e113a28aSBarry Smith 62e113a28aSBarry Smith .seealso: SNESSetErrorIfNotConverged(), KSPGetErrorIfNotConverged(), KSPSetErrorIFNotConverged() 63e113a28aSBarry Smith @*/ 647087cfbeSBarry Smith PetscErrorCode SNESGetErrorIfNotConverged(SNES snes,PetscBool *flag) 65e113a28aSBarry Smith { 66e113a28aSBarry Smith PetscFunctionBegin; 67e113a28aSBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 68e113a28aSBarry Smith PetscValidPointer(flag,2); 69e113a28aSBarry Smith *flag = snes->errorifnotconverged; 70e113a28aSBarry Smith PetscFunctionReturn(0); 71e113a28aSBarry Smith } 72e113a28aSBarry Smith 73e113a28aSBarry Smith #undef __FUNCT__ 744936397dSBarry Smith #define __FUNCT__ "SNESSetFunctionDomainError" 75e725d27bSBarry Smith /*@ 76bf388a1fSBarry Smith SNESSetFunctionDomainError - tells SNES that the input vector to your SNESFunction is not 774936397dSBarry Smith in the functions domain. For example, negative pressure. 784936397dSBarry Smith 793f9fe445SBarry Smith Logically Collective on SNES 804936397dSBarry Smith 814936397dSBarry Smith Input Parameters: 826a388c36SPeter Brune . snes - the SNES context 834936397dSBarry Smith 8428529972SSatish Balay Level: advanced 854936397dSBarry Smith 864936397dSBarry Smith .keywords: SNES, view 874936397dSBarry Smith 88bf388a1fSBarry Smith .seealso: SNESCreate(), SNESSetFunction(), SNESFunction 894936397dSBarry Smith @*/ 907087cfbeSBarry Smith PetscErrorCode SNESSetFunctionDomainError(SNES snes) 914936397dSBarry Smith { 924936397dSBarry Smith PetscFunctionBegin; 930700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 944936397dSBarry Smith snes->domainerror = PETSC_TRUE; 954936397dSBarry Smith PetscFunctionReturn(0); 964936397dSBarry Smith } 974936397dSBarry Smith 986a388c36SPeter Brune #undef __FUNCT__ 996a388c36SPeter Brune #define __FUNCT__ "SNESGetFunctionDomainError" 1006a388c36SPeter Brune /*@ 101c77b2880SPeter Brune SNESGetFunctionDomainError - Gets the status of the domain error after a call to SNESComputeFunction; 1026a388c36SPeter Brune 1036a388c36SPeter Brune Logically Collective on SNES 1046a388c36SPeter Brune 1056a388c36SPeter Brune Input Parameters: 1066a388c36SPeter Brune . snes - the SNES context 1076a388c36SPeter Brune 1086a388c36SPeter Brune Output Parameters: 109bf388a1fSBarry Smith . domainerror - Set to PETSC_TRUE if there's a domain error; PETSC_FALSE otherwise. 1106a388c36SPeter Brune 1116a388c36SPeter Brune Level: advanced 1126a388c36SPeter Brune 1136a388c36SPeter Brune .keywords: SNES, view 1146a388c36SPeter Brune 115bf388a1fSBarry Smith .seealso: SNESSetFunctionDomainError(), SNESComputeFunction() 1166a388c36SPeter Brune @*/ 1176a388c36SPeter Brune PetscErrorCode SNESGetFunctionDomainError(SNES snes, PetscBool *domainerror) 1186a388c36SPeter Brune { 1196a388c36SPeter Brune PetscFunctionBegin; 1206a388c36SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1216a388c36SPeter Brune PetscValidPointer(domainerror, 2); 1226a388c36SPeter Brune *domainerror = snes->domainerror; 1236a388c36SPeter Brune PetscFunctionReturn(0); 1246a388c36SPeter Brune } 1256a388c36SPeter Brune 12655849f57SBarry Smith #undef __FUNCT__ 12755849f57SBarry Smith #define __FUNCT__ "SNESLoad" 12855849f57SBarry Smith /*@C 12955849f57SBarry Smith SNESLoad - Loads a SNES that has been stored in binary with SNESView(). 13055849f57SBarry Smith 13155849f57SBarry Smith Collective on PetscViewer 13255849f57SBarry Smith 13355849f57SBarry Smith Input Parameters: 13455849f57SBarry Smith + newdm - the newly loaded SNES, this needs to have been created with SNESCreate() or 13555849f57SBarry Smith some related function before a call to SNESLoad(). 13655849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() 13755849f57SBarry Smith 13855849f57SBarry Smith Level: intermediate 13955849f57SBarry Smith 14055849f57SBarry Smith Notes: 14155849f57SBarry Smith The type is determined by the data in the file, any type set into the SNES before this call is ignored. 14255849f57SBarry Smith 14355849f57SBarry Smith Notes for advanced users: 14455849f57SBarry Smith Most users should not need to know the details of the binary storage 14555849f57SBarry Smith format, since SNESLoad() and TSView() completely hide these details. 14655849f57SBarry Smith But for anyone who's interested, the standard binary matrix storage 14755849f57SBarry Smith format is 14855849f57SBarry Smith .vb 14955849f57SBarry Smith has not yet been determined 15055849f57SBarry Smith .ve 15155849f57SBarry Smith 15255849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), SNESView(), MatLoad(), VecLoad() 15355849f57SBarry Smith @*/ 1542d53ad75SBarry Smith PetscErrorCode SNESLoad(SNES snes, PetscViewer viewer) 15555849f57SBarry Smith { 15655849f57SBarry Smith PetscErrorCode ierr; 15755849f57SBarry Smith PetscBool isbinary; 15855849f57SBarry Smith PetscInt classid; 15955849f57SBarry Smith char type[256]; 16055849f57SBarry Smith KSP ksp; 1612d53ad75SBarry Smith DM dm; 1622d53ad75SBarry Smith DMSNES dmsnes; 16355849f57SBarry Smith 16455849f57SBarry Smith PetscFunctionBegin; 1652d53ad75SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 16655849f57SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 16755849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 16855849f57SBarry Smith if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()"); 16955849f57SBarry Smith 17055849f57SBarry Smith ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr); 171*ce94432eSBarry Smith if (classid != SNES_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_WRONG,"Not SNES next in file"); 17255849f57SBarry Smith ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr); 1732d53ad75SBarry Smith ierr = SNESSetType(snes, type);CHKERRQ(ierr); 1742d53ad75SBarry Smith if (snes->ops->load) { 1752d53ad75SBarry Smith ierr = (*snes->ops->load)(snes,viewer);CHKERRQ(ierr); 176f2c2a1b9SBarry Smith } 1772d53ad75SBarry Smith ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 1782d53ad75SBarry Smith ierr = DMGetDMSNES(dm,&dmsnes);CHKERRQ(ierr); 1792d53ad75SBarry Smith ierr = DMSNESLoad(dmsnes,viewer);CHKERRQ(ierr); 1802d53ad75SBarry Smith ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 18155849f57SBarry Smith ierr = KSPLoad(ksp,viewer);CHKERRQ(ierr); 18255849f57SBarry Smith PetscFunctionReturn(0); 18355849f57SBarry Smith } 1846a388c36SPeter Brune 1854936397dSBarry Smith #undef __FUNCT__ 1864a2ae208SSatish Balay #define __FUNCT__ "SNESView" 1877e2c5f70SBarry Smith /*@C 1889b94acceSBarry Smith SNESView - Prints the SNES data structure. 1899b94acceSBarry Smith 1904c49b128SBarry Smith Collective on SNES 191fee21e36SBarry Smith 192c7afd0dbSLois Curfman McInnes Input Parameters: 193c7afd0dbSLois Curfman McInnes + SNES - the SNES context 194c7afd0dbSLois Curfman McInnes - viewer - visualization context 195c7afd0dbSLois Curfman McInnes 1969b94acceSBarry Smith Options Database Key: 197c8a8ba5cSLois Curfman McInnes . -snes_view - Calls SNESView() at end of SNESSolve() 1989b94acceSBarry Smith 1999b94acceSBarry Smith Notes: 2009b94acceSBarry Smith The available visualization contexts include 201b0a32e0cSBarry Smith + PETSC_VIEWER_STDOUT_SELF - standard output (default) 202b0a32e0cSBarry Smith - PETSC_VIEWER_STDOUT_WORLD - synchronized standard 203c8a8ba5cSLois Curfman McInnes output where only the first processor opens 204c8a8ba5cSLois Curfman McInnes the file. All other processors send their 205c8a8ba5cSLois Curfman McInnes data to the first processor to print. 2069b94acceSBarry Smith 2073e081fefSLois Curfman McInnes The user can open an alternative visualization context with 208b0a32e0cSBarry Smith PetscViewerASCIIOpen() - output to a specified file. 2099b94acceSBarry Smith 21036851e7fSLois Curfman McInnes Level: beginner 21136851e7fSLois Curfman McInnes 2129b94acceSBarry Smith .keywords: SNES, view 2139b94acceSBarry Smith 214b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen() 2159b94acceSBarry Smith @*/ 2167087cfbeSBarry Smith PetscErrorCode SNESView(SNES snes,PetscViewer viewer) 2179b94acceSBarry Smith { 218fa9f3622SBarry Smith SNESKSPEW *kctx; 219dfbe8321SBarry Smith PetscErrorCode ierr; 22094b7f48cSBarry Smith KSP ksp; 2217f1410a3SPeter Brune SNESLineSearch linesearch; 22272a02f06SBarry Smith PetscBool iascii,isstring,isbinary,isdraw; 2232d53ad75SBarry Smith DMSNES dmsnes; 2249b94acceSBarry Smith 2253a40ed3dSBarry Smith PetscFunctionBegin; 2260700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2273050cee2SBarry Smith if (!viewer) { 228*ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)snes),&viewer);CHKERRQ(ierr); 2293050cee2SBarry Smith } 2300700a824SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 231c9780b6fSBarry Smith PetscCheckSameComm(snes,1,viewer,2); 23274679c65SBarry Smith 233251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 234251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr); 23555849f57SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr); 23672a02f06SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr); 23732077d6dSBarry Smith if (iascii) { 238317d6ea6SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)snes,viewer,"SNES Object");CHKERRQ(ierr); 239e7788613SBarry Smith if (snes->ops->view) { 240b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 241e7788613SBarry Smith ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr); 242b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 2430ef38995SBarry Smith } 24477431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," maximum iterations=%D, maximum function evaluations=%D\n",snes->max_its,snes->max_funcs);CHKERRQ(ierr); 245f5af7f23SKarl Rupp ierr = PetscViewerASCIIPrintf(viewer," tolerances: relative=%G, absolute=%G, solution=%G\n",snes->rtol,snes->abstol,snes->stol);CHKERRQ(ierr); 24677431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of linear solver iterations=%D\n",snes->linear_its);CHKERRQ(ierr); 24777431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," total number of function evaluations=%D\n",snes->nfuncs);CHKERRQ(ierr); 24817fe4bdfSPeter Brune if (snes->gridsequence) { 24917fe4bdfSPeter Brune ierr = PetscViewerASCIIPrintf(viewer," total number of grid sequence refinements=%D\n",snes->gridsequence);CHKERRQ(ierr); 25017fe4bdfSPeter Brune } 2519b94acceSBarry Smith if (snes->ksp_ewconv) { 252fa9f3622SBarry Smith kctx = (SNESKSPEW*)snes->kspconvctx; 2539b94acceSBarry Smith if (kctx) { 25477431f27SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Eisenstat-Walker computation of KSP relative tolerance (version %D)\n",kctx->version);CHKERRQ(ierr); 255a83599f4SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," rtol_0=%G, rtol_max=%G, threshold=%G\n",kctx->rtol_0,kctx->rtol_max,kctx->threshold);CHKERRQ(ierr); 256a83599f4SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," gamma=%G, alpha=%G, alpha2=%G\n",kctx->gamma,kctx->alpha,kctx->alpha2);CHKERRQ(ierr); 2579b94acceSBarry Smith } 2589b94acceSBarry Smith } 259eb1f6c34SBarry Smith if (snes->lagpreconditioner == -1) { 260eb1f6c34SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioned is never rebuilt\n");CHKERRQ(ierr); 261eb1f6c34SBarry Smith } else if (snes->lagpreconditioner > 1) { 262eb1f6c34SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Preconditioned is rebuilt every %D new Jacobians\n",snes->lagpreconditioner);CHKERRQ(ierr); 263eb1f6c34SBarry Smith } 264eb1f6c34SBarry Smith if (snes->lagjacobian == -1) { 265eb1f6c34SBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Jacobian is never rebuilt\n");CHKERRQ(ierr); 266eb1f6c34SBarry Smith } else if (snes->lagjacobian > 1) { 26742f4f86dSBarry Smith ierr = PetscViewerASCIIPrintf(viewer," Jacobian is rebuilt every %D SNES iterations\n",snes->lagjacobian);CHKERRQ(ierr); 268eb1f6c34SBarry Smith } 2690f5bd95cSBarry Smith } else if (isstring) { 270317d6ea6SBarry Smith const char *type; 271454a90a3SBarry Smith ierr = SNESGetType(snes,&type);CHKERRQ(ierr); 272b0a32e0cSBarry Smith ierr = PetscViewerStringSPrintf(viewer," %-3.3s",type);CHKERRQ(ierr); 27355849f57SBarry Smith } else if (isbinary) { 27455849f57SBarry Smith PetscInt classid = SNES_FILE_CLASSID; 27555849f57SBarry Smith MPI_Comm comm; 27655849f57SBarry Smith PetscMPIInt rank; 27755849f57SBarry Smith char type[256]; 27855849f57SBarry Smith 27955849f57SBarry Smith ierr = PetscObjectGetComm((PetscObject)snes,&comm);CHKERRQ(ierr); 28055849f57SBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 28155849f57SBarry Smith if (!rank) { 28255849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr); 28355849f57SBarry Smith ierr = PetscStrncpy(type,((PetscObject)snes)->type_name,256);CHKERRQ(ierr); 28455849f57SBarry Smith ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr); 28555849f57SBarry Smith } 28655849f57SBarry Smith if (snes->ops->view) { 28755849f57SBarry Smith ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr); 28855849f57SBarry Smith } 28972a02f06SBarry Smith } else if (isdraw) { 29072a02f06SBarry Smith PetscDraw draw; 29172a02f06SBarry Smith char str[36]; 29289fd9fafSBarry Smith PetscReal x,y,bottom,h; 29372a02f06SBarry Smith 29472a02f06SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 29572a02f06SBarry Smith ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr); 29672a02f06SBarry Smith ierr = PetscStrcpy(str,"SNES: ");CHKERRQ(ierr); 29772a02f06SBarry Smith ierr = PetscStrcat(str,((PetscObject)snes)->type_name);CHKERRQ(ierr); 2980298fd71SBarry Smith ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLUE,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr); 29989fd9fafSBarry Smith bottom = y - h; 30072a02f06SBarry Smith ierr = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr); 301c4646bacSPeter Brune if (snes->ops->view) { 302c4646bacSPeter Brune ierr = (*snes->ops->view)(snes,viewer);CHKERRQ(ierr); 303c4646bacSPeter Brune } 30472a02f06SBarry Smith } 30572a02f06SBarry Smith if (snes->linesearch) { 30672a02f06SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 30772a02f06SBarry Smith ierr = SNESGetSNESLineSearch(snes, &linesearch);CHKERRQ(ierr); 30872a02f06SBarry Smith ierr = SNESLineSearchView(linesearch, viewer);CHKERRQ(ierr); 30972a02f06SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 31019bcc07fSBarry Smith } 31142f4f86dSBarry Smith if (snes->pc && snes->usespc) { 3124a0c5b0cSMatthew G Knepley ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 3134a0c5b0cSMatthew G Knepley ierr = SNESView(snes->pc, viewer);CHKERRQ(ierr); 3144a0c5b0cSMatthew G Knepley ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 3154a0c5b0cSMatthew G Knepley } 3162d53ad75SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 3172d53ad75SBarry Smith ierr = DMGetDMSNES(snes->dm,&dmsnes);CHKERRQ(ierr); 3182d53ad75SBarry Smith ierr = DMSNESView(dmsnes, viewer);CHKERRQ(ierr); 3192d53ad75SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 3202c155ee1SBarry Smith if (snes->usesksp) { 3212c155ee1SBarry Smith ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 322b0a32e0cSBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 32394b7f48cSBarry Smith ierr = KSPView(ksp,viewer);CHKERRQ(ierr); 324b0a32e0cSBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 3252c155ee1SBarry Smith } 32672a02f06SBarry Smith if (isdraw) { 32772a02f06SBarry Smith PetscDraw draw; 32872a02f06SBarry Smith ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr); 32972a02f06SBarry Smith ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr); 3307f1410a3SPeter Brune } 3313a40ed3dSBarry Smith PetscFunctionReturn(0); 3329b94acceSBarry Smith } 3339b94acceSBarry Smith 33476b2cf59SMatthew Knepley /* 33576b2cf59SMatthew Knepley We retain a list of functions that also take SNES command 33676b2cf59SMatthew Knepley line options. These are called at the end SNESSetFromOptions() 33776b2cf59SMatthew Knepley */ 33876b2cf59SMatthew Knepley #define MAXSETFROMOPTIONS 5 339a7cc72afSBarry Smith static PetscInt numberofsetfromoptions; 3406849ba73SBarry Smith static PetscErrorCode (*othersetfromoptions[MAXSETFROMOPTIONS])(SNES); 34176b2cf59SMatthew Knepley 342e74ef692SMatthew Knepley #undef __FUNCT__ 343e74ef692SMatthew Knepley #define __FUNCT__ "SNESAddOptionsChecker" 344ac226902SBarry Smith /*@C 34576b2cf59SMatthew Knepley SNESAddOptionsChecker - Adds an additional function to check for SNES options. 34676b2cf59SMatthew Knepley 34776b2cf59SMatthew Knepley Not Collective 34876b2cf59SMatthew Knepley 34976b2cf59SMatthew Knepley Input Parameter: 35076b2cf59SMatthew Knepley . snescheck - function that checks for options 35176b2cf59SMatthew Knepley 35276b2cf59SMatthew Knepley Level: developer 35376b2cf59SMatthew Knepley 35476b2cf59SMatthew Knepley .seealso: SNESSetFromOptions() 35576b2cf59SMatthew Knepley @*/ 3567087cfbeSBarry Smith PetscErrorCode SNESAddOptionsChecker(PetscErrorCode (*snescheck)(SNES)) 35776b2cf59SMatthew Knepley { 35876b2cf59SMatthew Knepley PetscFunctionBegin; 359f23aa3ddSBarry Smith if (numberofsetfromoptions >= MAXSETFROMOPTIONS) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "Too many options checkers, only %D allowed", MAXSETFROMOPTIONS); 36076b2cf59SMatthew Knepley othersetfromoptions[numberofsetfromoptions++] = snescheck; 36176b2cf59SMatthew Knepley PetscFunctionReturn(0); 36276b2cf59SMatthew Knepley } 36376b2cf59SMatthew Knepley 3647087cfbeSBarry Smith extern PetscErrorCode SNESDefaultMatrixFreeCreate2(SNES,Vec,Mat*); 365aa3661deSLisandro Dalcin 366aa3661deSLisandro Dalcin #undef __FUNCT__ 367aa3661deSLisandro Dalcin #define __FUNCT__ "SNESSetUpMatrixFree_Private" 368ace3abfcSBarry Smith static PetscErrorCode SNESSetUpMatrixFree_Private(SNES snes, PetscBool hasOperator, PetscInt version) 369aa3661deSLisandro Dalcin { 370aa3661deSLisandro Dalcin Mat J; 371aa3661deSLisandro Dalcin KSP ksp; 372aa3661deSLisandro Dalcin PC pc; 373ace3abfcSBarry Smith PetscBool match; 374aa3661deSLisandro Dalcin PetscErrorCode ierr; 375aa3661deSLisandro Dalcin 376aa3661deSLisandro Dalcin PetscFunctionBegin; 3770700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 378aa3661deSLisandro Dalcin 37998613b67SLisandro Dalcin if (!snes->vec_func && (snes->jacobian || snes->jacobian_pre)) { 38098613b67SLisandro Dalcin Mat A = snes->jacobian, B = snes->jacobian_pre; 3810298fd71SBarry Smith ierr = MatGetVecs(A ? A : B, NULL,&snes->vec_func);CHKERRQ(ierr); 38298613b67SLisandro Dalcin } 38398613b67SLisandro Dalcin 384aa3661deSLisandro Dalcin if (version == 1) { 385aa3661deSLisandro Dalcin ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr); 38698613b67SLisandro Dalcin ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr); 3879c6ac3b3SBarry Smith ierr = MatSetFromOptions(J);CHKERRQ(ierr); 388aa3661deSLisandro Dalcin } else if (version == 2) { 389e32f2f54SBarry Smith if (!snes->vec_func) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"SNESSetFunction() must be called first"); 39082a7e548SBarry Smith #if !defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_REAL_SINGLE) && !defined(PETSC_USE_REAL___FLOAT128) 391aa3661deSLisandro Dalcin ierr = SNESDefaultMatrixFreeCreate2(snes,snes->vec_func,&J);CHKERRQ(ierr); 392aa3661deSLisandro Dalcin #else 393e32f2f54SBarry Smith SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP, "matrix-free operator rutines (version 2)"); 394aa3661deSLisandro Dalcin #endif 395a8248277SBarry Smith } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE, "matrix-free operator rutines, only version 1 and 2"); 396aa3661deSLisandro Dalcin 397aa3661deSLisandro Dalcin ierr = PetscInfo1(snes,"Setting default matrix-free operator routines (version %D)\n", version);CHKERRQ(ierr); 398d3462f78SMatthew Knepley if (hasOperator) { 3993232da50SPeter Brune 400aa3661deSLisandro Dalcin /* This version replaces the user provided Jacobian matrix with a 401aa3661deSLisandro Dalcin matrix-free version but still employs the user-provided preconditioner matrix. */ 402aa3661deSLisandro Dalcin ierr = SNESSetJacobian(snes,J,0,0,0);CHKERRQ(ierr); 403aa3661deSLisandro Dalcin } else { 404aa3661deSLisandro Dalcin /* This version replaces both the user-provided Jacobian and the user- 4053232da50SPeter Brune provided preconditioner Jacobian with the default matrix free version. */ 406172a4300SPeter Brune if ((snes->pcside == PC_LEFT) && snes->pc) { 407172a4300SPeter Brune ierr = SNESSetJacobian(snes,J,0,0,0);CHKERRQ(ierr); 408172a4300SPeter Brune } else { 40928a52e04SBarry Smith ierr = SNESSetJacobian(snes,J,J,MatMFFDComputeJacobian,0);CHKERRQ(ierr); 410172a4300SPeter Brune } 411aa3661deSLisandro Dalcin /* Force no preconditioner */ 412aa3661deSLisandro Dalcin ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 413aa3661deSLisandro Dalcin ierr = KSPGetPC(ksp,&pc);CHKERRQ(ierr); 414251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)pc,PCSHELL,&match);CHKERRQ(ierr); 415aa3661deSLisandro Dalcin if (!match) { 416aa3661deSLisandro Dalcin ierr = PetscInfo(snes,"Setting default matrix-free preconditioner routines\nThat is no preconditioner is being used\n");CHKERRQ(ierr); 417aa3661deSLisandro Dalcin ierr = PCSetType(pc,PCNONE);CHKERRQ(ierr); 418aa3661deSLisandro Dalcin } 419aa3661deSLisandro Dalcin } 4206bf464f9SBarry Smith ierr = MatDestroy(&J);CHKERRQ(ierr); 421aa3661deSLisandro Dalcin PetscFunctionReturn(0); 422aa3661deSLisandro Dalcin } 423aa3661deSLisandro Dalcin 4244a2ae208SSatish Balay #undef __FUNCT__ 425dfe15315SJed Brown #define __FUNCT__ "DMRestrictHook_SNESVecSol" 426dfe15315SJed Brown static PetscErrorCode DMRestrictHook_SNESVecSol(DM dmfine,Mat Restrict,Vec Rscale,Mat Inject,DM dmcoarse,void *ctx) 427dfe15315SJed Brown { 428dfe15315SJed Brown SNES snes = (SNES)ctx; 429dfe15315SJed Brown PetscErrorCode ierr; 4300298fd71SBarry Smith Vec Xfine,Xfine_named = NULL,Xcoarse; 431dfe15315SJed Brown 432dfe15315SJed Brown PetscFunctionBegin; 43316ebb321SJed Brown if (PetscLogPrintInfo) { 43416ebb321SJed Brown PetscInt finelevel,coarselevel,fineclevel,coarseclevel; 43516ebb321SJed Brown ierr = DMGetRefineLevel(dmfine,&finelevel);CHKERRQ(ierr); 43616ebb321SJed Brown ierr = DMGetCoarsenLevel(dmfine,&fineclevel);CHKERRQ(ierr); 43716ebb321SJed Brown ierr = DMGetRefineLevel(dmcoarse,&coarselevel);CHKERRQ(ierr); 43816ebb321SJed Brown ierr = DMGetCoarsenLevel(dmcoarse,&coarseclevel);CHKERRQ(ierr); 43916ebb321SJed Brown ierr = PetscInfo4(dmfine,"Restricting SNES solution vector from level %D-%D to level %D-%D\n",finelevel,fineclevel,coarselevel,coarseclevel);CHKERRQ(ierr); 44016ebb321SJed Brown } 441dfe15315SJed Brown if (dmfine == snes->dm) Xfine = snes->vec_sol; 442dfe15315SJed Brown else { 443dfe15315SJed Brown ierr = DMGetNamedGlobalVector(dmfine,"SNESVecSol",&Xfine_named);CHKERRQ(ierr); 444dfe15315SJed Brown Xfine = Xfine_named; 445dfe15315SJed Brown } 446dfe15315SJed Brown ierr = DMGetNamedGlobalVector(dmcoarse,"SNESVecSol",&Xcoarse);CHKERRQ(ierr); 447dfe15315SJed Brown ierr = MatRestrict(Restrict,Xfine,Xcoarse);CHKERRQ(ierr); 448dfe15315SJed Brown ierr = VecPointwiseMult(Xcoarse,Xcoarse,Rscale);CHKERRQ(ierr); 449dfe15315SJed Brown ierr = DMRestoreNamedGlobalVector(dmcoarse,"SNESVecSol",&Xcoarse);CHKERRQ(ierr); 450dfe15315SJed Brown if (Xfine_named) {ierr = DMRestoreNamedGlobalVector(dmfine,"SNESVecSol",&Xfine_named);CHKERRQ(ierr);} 451dfe15315SJed Brown PetscFunctionReturn(0); 452dfe15315SJed Brown } 453dfe15315SJed Brown 454dfe15315SJed Brown #undef __FUNCT__ 45516ebb321SJed Brown #define __FUNCT__ "DMCoarsenHook_SNESVecSol" 45616ebb321SJed Brown static PetscErrorCode DMCoarsenHook_SNESVecSol(DM dm,DM dmc,void *ctx) 45716ebb321SJed Brown { 45816ebb321SJed Brown PetscErrorCode ierr; 45916ebb321SJed Brown 46016ebb321SJed Brown PetscFunctionBegin; 46116ebb321SJed Brown ierr = DMCoarsenHookAdd(dmc,DMCoarsenHook_SNESVecSol,DMRestrictHook_SNESVecSol,ctx);CHKERRQ(ierr); 46216ebb321SJed Brown PetscFunctionReturn(0); 46316ebb321SJed Brown } 46416ebb321SJed Brown 46516ebb321SJed Brown #undef __FUNCT__ 466caa4e7f2SJed Brown #define __FUNCT__ "KSPComputeOperators_SNES" 467a6950cb2SJed Brown /* This may be called to rediscretize the operator on levels of linear multigrid. The DM shuffle is so the user can 468a6950cb2SJed Brown * safely call SNESGetDM() in their residual evaluation routine. */ 469caa4e7f2SJed Brown static PetscErrorCode KSPComputeOperators_SNES(KSP ksp,Mat A,Mat B,MatStructure *mstruct,void *ctx) 470caa4e7f2SJed Brown { 471caa4e7f2SJed Brown SNES snes = (SNES)ctx; 472caa4e7f2SJed Brown PetscErrorCode ierr; 473caa4e7f2SJed Brown Mat Asave = A,Bsave = B; 4740298fd71SBarry Smith Vec X,Xnamed = NULL; 475dfe15315SJed Brown DM dmsave; 4764e269d77SPeter Brune void *ctxsave; 4774e269d77SPeter Brune PetscErrorCode (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 478caa4e7f2SJed Brown 479caa4e7f2SJed Brown PetscFunctionBegin; 480dfe15315SJed Brown dmsave = snes->dm; 481dfe15315SJed Brown ierr = KSPGetDM(ksp,&snes->dm);CHKERRQ(ierr); 482dfe15315SJed Brown if (dmsave == snes->dm) X = snes->vec_sol; /* We are on the finest level */ 483dfe15315SJed Brown else { /* We are on a coarser level, this vec was initialized using a DM restrict hook */ 484dfe15315SJed Brown ierr = DMGetNamedGlobalVector(snes->dm,"SNESVecSol",&Xnamed);CHKERRQ(ierr); 485dfe15315SJed Brown X = Xnamed; 4860298fd71SBarry Smith ierr = SNESGetJacobian(snes,NULL,NULL,&jac,&ctxsave);CHKERRQ(ierr); 4874e269d77SPeter Brune /* If the DM's don't match up, the MatFDColoring context needed for the jacobian won't match up either -- fixit. */ 4884e269d77SPeter Brune if (jac == SNESDefaultComputeJacobianColor) { 4890298fd71SBarry Smith ierr = SNESSetJacobian(snes,NULL,NULL,SNESDefaultComputeJacobianColor,0);CHKERRQ(ierr); 490dfe15315SJed Brown } 4914e269d77SPeter Brune } 4924e269d77SPeter Brune /* put the previous context back */ 4934e269d77SPeter Brune 494dfe15315SJed Brown ierr = SNESComputeJacobian(snes,X,&A,&B,mstruct);CHKERRQ(ierr); 4954e269d77SPeter Brune if (snes->dm != dmsave && jac == SNESDefaultComputeJacobianColor) { 4960298fd71SBarry Smith ierr = SNESSetJacobian(snes,NULL,NULL,jac,ctxsave);CHKERRQ(ierr); 4974e269d77SPeter Brune } 4984e269d77SPeter Brune 499*ce94432eSBarry Smith if (A != Asave || B != Bsave) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_SUP,"No support for changing matrices at this time"); 500dfe15315SJed Brown if (Xnamed) { 501dfe15315SJed Brown ierr = DMRestoreNamedGlobalVector(snes->dm,"SNESVecSol",&Xnamed);CHKERRQ(ierr); 502dfe15315SJed Brown } 503dfe15315SJed Brown snes->dm = dmsave; 504caa4e7f2SJed Brown PetscFunctionReturn(0); 505caa4e7f2SJed Brown } 506caa4e7f2SJed Brown 507caa4e7f2SJed Brown #undef __FUNCT__ 5086cab3a1bSJed Brown #define __FUNCT__ "SNESSetUpMatrices" 5096cab3a1bSJed Brown /*@ 5106cab3a1bSJed Brown SNESSetUpMatrices - ensures that matrices are available for SNES, to be called by SNESSetUp_XXX() 5116cab3a1bSJed Brown 5126cab3a1bSJed Brown Collective 5136cab3a1bSJed Brown 5146cab3a1bSJed Brown Input Arguments: 5156cab3a1bSJed Brown . snes - snes to configure 5166cab3a1bSJed Brown 5176cab3a1bSJed Brown Level: developer 5186cab3a1bSJed Brown 5196cab3a1bSJed Brown .seealso: SNESSetUp() 5206cab3a1bSJed Brown @*/ 5216cab3a1bSJed Brown PetscErrorCode SNESSetUpMatrices(SNES snes) 5226cab3a1bSJed Brown { 5236cab3a1bSJed Brown PetscErrorCode ierr; 5246cab3a1bSJed Brown DM dm; 525942e3340SBarry Smith DMSNES sdm; 5266cab3a1bSJed Brown 5276cab3a1bSJed Brown PetscFunctionBegin; 5286cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 529942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 530*ce94432eSBarry Smith if (!sdm->ops->computejacobian) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_PLIB,"DMSNES not properly configured"); 531f5af7f23SKarl Rupp else if (!snes->jacobian && snes->mf) { 5326cab3a1bSJed Brown Mat J; 5336cab3a1bSJed Brown void *functx; 5346cab3a1bSJed Brown ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr); 5356cab3a1bSJed Brown ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr); 5366cab3a1bSJed Brown ierr = MatSetFromOptions(J);CHKERRQ(ierr); 5370298fd71SBarry Smith ierr = SNESGetFunction(snes,NULL,NULL,&functx);CHKERRQ(ierr); 5383232da50SPeter Brune ierr = SNESSetJacobian(snes,J,J,0,0);CHKERRQ(ierr); 5396cab3a1bSJed Brown ierr = MatDestroy(&J);CHKERRQ(ierr); 540caa4e7f2SJed Brown } else if (snes->mf_operator && !snes->jacobian_pre && !snes->jacobian) { 5416cab3a1bSJed Brown Mat J,B; 5426cab3a1bSJed Brown ierr = MatCreateSNESMF(snes,&J);CHKERRQ(ierr); 5436cab3a1bSJed Brown ierr = MatMFFDSetOptionsPrefix(J,((PetscObject)snes)->prefix);CHKERRQ(ierr); 5446cab3a1bSJed Brown ierr = MatSetFromOptions(J);CHKERRQ(ierr); 5456cab3a1bSJed Brown ierr = DMCreateMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr); 54606f20277SJed Brown /* sdm->computejacobian was already set to reach here */ 5470298fd71SBarry Smith ierr = SNESSetJacobian(snes,J,B,NULL,NULL);CHKERRQ(ierr); 5486cab3a1bSJed Brown ierr = MatDestroy(&J);CHKERRQ(ierr); 5496cab3a1bSJed Brown ierr = MatDestroy(&B);CHKERRQ(ierr); 550caa4e7f2SJed Brown } else if (!snes->jacobian_pre) { 5516cab3a1bSJed Brown Mat J,B; 5526cab3a1bSJed Brown J = snes->jacobian; 5536cab3a1bSJed Brown ierr = DMCreateMatrix(snes->dm,MATAIJ,&B);CHKERRQ(ierr); 5540298fd71SBarry Smith ierr = SNESSetJacobian(snes,J ? J : B,B,NULL,NULL);CHKERRQ(ierr); 5556cab3a1bSJed Brown ierr = MatDestroy(&B);CHKERRQ(ierr); 5566cab3a1bSJed Brown } 557caa4e7f2SJed Brown { 558caa4e7f2SJed Brown KSP ksp; 559caa4e7f2SJed Brown ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 560caa4e7f2SJed Brown ierr = KSPSetComputeOperators(ksp,KSPComputeOperators_SNES,snes);CHKERRQ(ierr); 56116ebb321SJed Brown ierr = DMCoarsenHookAdd(snes->dm,DMCoarsenHook_SNESVecSol,DMRestrictHook_SNESVecSol,snes);CHKERRQ(ierr); 562caa4e7f2SJed Brown } 5636cab3a1bSJed Brown PetscFunctionReturn(0); 5646cab3a1bSJed Brown } 5656cab3a1bSJed Brown 5666cab3a1bSJed Brown #undef __FUNCT__ 5674a2ae208SSatish Balay #define __FUNCT__ "SNESSetFromOptions" 5689b94acceSBarry Smith /*@ 56994b7f48cSBarry Smith SNESSetFromOptions - Sets various SNES and KSP parameters from user options. 5709b94acceSBarry Smith 571c7afd0dbSLois Curfman McInnes Collective on SNES 572c7afd0dbSLois Curfman McInnes 5739b94acceSBarry Smith Input Parameter: 5749b94acceSBarry Smith . snes - the SNES context 5759b94acceSBarry Smith 57636851e7fSLois Curfman McInnes Options Database Keys: 577ea630c6eSPeter Brune + -snes_type <type> - ls, tr, ngmres, ncg, richardson, qn, vi, fas 57882738288SBarry Smith . -snes_stol - convergence tolerance in terms of the norm 57982738288SBarry Smith of the change in the solution between steps 58070441072SBarry Smith . -snes_atol <abstol> - absolute tolerance of residual norm 581b39c3a46SLois Curfman McInnes . -snes_rtol <rtol> - relative decrease in tolerance norm from initial 582b39c3a46SLois Curfman McInnes . -snes_max_it <max_it> - maximum number of iterations 583b39c3a46SLois Curfman McInnes . -snes_max_funcs <max_funcs> - maximum number of function evaluations 5844839bfe8SBarry Smith . -snes_max_fail <max_fail> - maximum number of line search failures allowed before stopping, default is none 585ddf469c8SBarry Smith . -snes_max_linear_solve_fail - number of linear solver failures before SNESSolve() stops 586a8054027SBarry Smith . -snes_lag_preconditioner <lag> - how often preconditioner is rebuilt (use -1 to never rebuild) 587e35cf81dSBarry Smith . -snes_lag_jacobian <lag> - how often Jacobian is rebuilt (use -1 to never rebuild) 588b39c3a46SLois Curfman McInnes . -snes_trtol <trtol> - trust region tolerance 5892492ecdbSBarry Smith . -snes_no_convergence_test - skip convergence test in nonlinear 59082738288SBarry Smith solver; hence iterations will continue until max_it 5911fbbfb26SLois Curfman McInnes or some other criterion is reached. Saves expense 59282738288SBarry Smith of convergence test 593e8105e01SRichard Katz . -snes_monitor <optional filename> - prints residual norm at each iteration. if no 594e8105e01SRichard Katz filename given prints to stdout 595a6570f20SBarry Smith . -snes_monitor_solution - plots solution at each iteration 596a6570f20SBarry Smith . -snes_monitor_residual - plots residual (not its norm) at each iteration 597a6570f20SBarry Smith . -snes_monitor_solution_update - plots update to solution at each iteration 5984619e776SBarry Smith . -snes_monitor_lg_residualnorm - plots residual norm at each iteration 599459f5d12SBarry Smith . -snes_monitor_lg_range - plots residual norm at each iteration 600e24b481bSBarry Smith . -snes_fd - use finite differences to compute Jacobian; very slow, only for testing 601e2e60de9SPeter Brune . -snes_fd_color - use finite differences with coloring to compute Jacobian 6025968eb51SBarry Smith . -snes_mf_ksp_monitor - if using matrix-free multiply then print h at each KSP iteration 603fee2055bSBarry Smith - -snes_converged_reason - print the reason for convergence/divergence after each solve 60482738288SBarry Smith 60582738288SBarry Smith Options Database for Eisenstat-Walker method: 606fa9f3622SBarry Smith + -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence 6074b27c08aSLois Curfman McInnes . -snes_ksp_ew_version ver - version of Eisenstat-Walker method 60836851e7fSLois Curfman McInnes . -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0 60936851e7fSLois Curfman McInnes . -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax 61036851e7fSLois Curfman McInnes . -snes_ksp_ew_gamma <gamma> - Sets gamma 61136851e7fSLois Curfman McInnes . -snes_ksp_ew_alpha <alpha> - Sets alpha 61236851e7fSLois Curfman McInnes . -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2 61336851e7fSLois Curfman McInnes - -snes_ksp_ew_threshold <threshold> - Sets threshold 61482738288SBarry Smith 61511ca99fdSLois Curfman McInnes Notes: 61611ca99fdSLois Curfman McInnes To see all options, run your program with the -help option or consult 6170598bfebSBarry Smith the <A href="../../docs/manual.pdf#nameddest=ch_snes">SNES chapter of the users manual</A>. 61883e2fdc7SBarry Smith 61936851e7fSLois Curfman McInnes Level: beginner 62036851e7fSLois Curfman McInnes 6219b94acceSBarry Smith .keywords: SNES, nonlinear, set, options, database 6229b94acceSBarry Smith 62369ed319cSSatish Balay .seealso: SNESSetOptionsPrefix() 6249b94acceSBarry Smith @*/ 6257087cfbeSBarry Smith PetscErrorCode SNESSetFromOptions(SNES snes) 6269b94acceSBarry Smith { 627d8f46077SPeter Brune PetscBool flg,pcset; 628d8f46077SPeter Brune PetscInt i,indx,lag,grids; 629aa3661deSLisandro Dalcin MatStructure matflag; 63004d7464bSBarry Smith const char *deft = SNESNEWTONLS; 63185385478SLisandro Dalcin const char *convtests[] = {"default","skip"}; 63285385478SLisandro Dalcin SNESKSPEW *kctx = NULL; 633e8105e01SRichard Katz char type[256], monfilename[PETSC_MAX_PATH_LEN]; 634649052a6SBarry Smith PetscViewer monviewer; 63585385478SLisandro Dalcin PetscErrorCode ierr; 636c40d0f55SPeter Brune PCSide pcside; 637a64e098fSPeter Brune const char *optionsprefix; 6389b94acceSBarry Smith 6393a40ed3dSBarry Smith PetscFunctionBegin; 6400700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 641ca161407SBarry Smith 6420298fd71SBarry Smith if (!SNESRegisterAllCalled) {ierr = SNESRegisterAll(NULL);CHKERRQ(ierr);} 6433194b578SJed Brown ierr = PetscObjectOptionsBegin((PetscObject)snes);CHKERRQ(ierr); 644639ff905SBarry Smith if (((PetscObject)snes)->type_name) deft = ((PetscObject)snes)->type_name; 645b0a32e0cSBarry Smith ierr = PetscOptionsList("-snes_type","Nonlinear solver method","SNESSetType",SNESList,deft,type,256,&flg);CHKERRQ(ierr); 646d64ed03dSBarry Smith if (flg) { 647186905e3SBarry Smith ierr = SNESSetType(snes,type);CHKERRQ(ierr); 6487adad957SLisandro Dalcin } else if (!((PetscObject)snes)->type_name) { 649186905e3SBarry Smith ierr = SNESSetType(snes,deft);CHKERRQ(ierr); 650d64ed03dSBarry Smith } 65190d69ab7SBarry Smith /* not used here, but called so will go into help messaage */ 652909c8a9fSBarry Smith ierr = PetscOptionsName("-snes_view","Print detailed information on solver used","SNESView",0);CHKERRQ(ierr); 65393c39befSBarry Smith 654c60f73f4SPeter Brune ierr = PetscOptionsReal("-snes_stol","Stop if step length less than","SNESSetTolerances",snes->stol,&snes->stol,0);CHKERRQ(ierr); 65557034d6fSHong Zhang ierr = PetscOptionsReal("-snes_atol","Stop if function norm less than","SNESSetTolerances",snes->abstol,&snes->abstol,0);CHKERRQ(ierr); 656186905e3SBarry Smith 65757034d6fSHong Zhang ierr = PetscOptionsReal("-snes_rtol","Stop if decrease in function norm less than","SNESSetTolerances",snes->rtol,&snes->rtol,0);CHKERRQ(ierr); 6580298fd71SBarry Smith ierr = PetscOptionsInt("-snes_max_it","Maximum iterations","SNESSetTolerances",snes->max_its,&snes->max_its,NULL);CHKERRQ(ierr); 6590298fd71SBarry Smith ierr = PetscOptionsInt("-snes_max_funcs","Maximum function evaluations","SNESSetTolerances",snes->max_funcs,&snes->max_funcs,NULL);CHKERRQ(ierr); 6600298fd71SBarry Smith ierr = PetscOptionsInt("-snes_max_fail","Maximum nonlinear step failures","SNESSetMaxNonlinearStepFailures",snes->maxFailures,&snes->maxFailures,NULL);CHKERRQ(ierr); 6610298fd71SBarry Smith ierr = PetscOptionsInt("-snes_max_linear_solve_fail","Maximum failures in linear solves allowed","SNESSetMaxLinearSolveFailures",snes->maxLinearSolveFailures,&snes->maxLinearSolveFailures,NULL);CHKERRQ(ierr); 6620298fd71SBarry Smith ierr = PetscOptionsBool("-snes_error_if_not_converged","Generate error if solver does not converge","SNESSetErrorIfNotConverged",snes->errorifnotconverged,&snes->errorifnotconverged,NULL);CHKERRQ(ierr); 66385385478SLisandro Dalcin 664a8054027SBarry Smith ierr = PetscOptionsInt("-snes_lag_preconditioner","How often to rebuild preconditioner","SNESSetLagPreconditioner",snes->lagpreconditioner,&lag,&flg);CHKERRQ(ierr); 665a8054027SBarry Smith if (flg) { 666a8054027SBarry Smith ierr = SNESSetLagPreconditioner(snes,lag);CHKERRQ(ierr); 667a8054027SBarry Smith } 668e35cf81dSBarry Smith ierr = PetscOptionsInt("-snes_lag_jacobian","How often to rebuild Jacobian","SNESSetLagJacobian",snes->lagjacobian,&lag,&flg);CHKERRQ(ierr); 669e35cf81dSBarry Smith if (flg) { 670e35cf81dSBarry Smith ierr = SNESSetLagJacobian(snes,lag);CHKERRQ(ierr); 671e35cf81dSBarry Smith } 672efd51863SBarry Smith ierr = PetscOptionsInt("-snes_grid_sequence","Use grid sequencing to generate initial guess","SNESSetGridSequence",snes->gridsequence,&grids,&flg);CHKERRQ(ierr); 673efd51863SBarry Smith if (flg) { 674efd51863SBarry Smith ierr = SNESSetGridSequence(snes,grids);CHKERRQ(ierr); 675efd51863SBarry Smith } 676a8054027SBarry Smith 67785385478SLisandro Dalcin ierr = PetscOptionsEList("-snes_convergence_test","Convergence test","SNESSetConvergenceTest",convtests,2,"default",&indx,&flg);CHKERRQ(ierr); 67885385478SLisandro Dalcin if (flg) { 67985385478SLisandro Dalcin switch (indx) { 6800298fd71SBarry Smith case 0: ierr = SNESSetConvergenceTest(snes,SNESDefaultConverged,NULL,NULL);CHKERRQ(ierr); break; 6810298fd71SBarry Smith case 1: ierr = SNESSetConvergenceTest(snes,SNESSkipConverged,NULL,NULL);CHKERRQ(ierr); break; 68285385478SLisandro Dalcin } 68385385478SLisandro Dalcin } 68485385478SLisandro Dalcin 6850298fd71SBarry Smith ierr = PetscOptionsBool("-snes_converged_reason","Print reason for converged or diverged","SNESSolve",snes->printreason,&snes->printreason,NULL);CHKERRQ(ierr); 686186905e3SBarry Smith 687fdacfa88SPeter Brune ierr = PetscOptionsEList("-snes_norm_type","SNES Norm type","SNESSetNormType",SNESNormTypes,5,"function",&indx,&flg);CHKERRQ(ierr); 688fdacfa88SPeter Brune if (flg) { ierr = SNESSetNormType(snes,(SNESNormType)indx);CHKERRQ(ierr); } 689fdacfa88SPeter Brune 69085385478SLisandro Dalcin kctx = (SNESKSPEW*)snes->kspconvctx; 69185385478SLisandro Dalcin 6920298fd71SBarry Smith ierr = PetscOptionsBool("-snes_ksp_ew","Use Eisentat-Walker linear system convergence test","SNESKSPSetUseEW",snes->ksp_ewconv,&snes->ksp_ewconv,NULL);CHKERRQ(ierr); 693186905e3SBarry Smith 694fa9f3622SBarry Smith ierr = PetscOptionsInt("-snes_ksp_ew_version","Version 1, 2 or 3","SNESKSPSetParametersEW",kctx->version,&kctx->version,0);CHKERRQ(ierr); 695fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_rtol0","0 <= rtol0 < 1","SNESKSPSetParametersEW",kctx->rtol_0,&kctx->rtol_0,0);CHKERRQ(ierr); 696fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_rtolmax","0 <= rtolmax < 1","SNESKSPSetParametersEW",kctx->rtol_max,&kctx->rtol_max,0);CHKERRQ(ierr); 697fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_gamma","0 <= gamma <= 1","SNESKSPSetParametersEW",kctx->gamma,&kctx->gamma,0);CHKERRQ(ierr); 698fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_alpha","1 < alpha <= 2","SNESKSPSetParametersEW",kctx->alpha,&kctx->alpha,0);CHKERRQ(ierr); 699fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_alpha2","alpha2","SNESKSPSetParametersEW",kctx->alpha2,&kctx->alpha2,0);CHKERRQ(ierr); 700fa9f3622SBarry Smith ierr = PetscOptionsReal("-snes_ksp_ew_threshold","0 < threshold < 1","SNESKSPSetParametersEW",kctx->threshold,&kctx->threshold,0);CHKERRQ(ierr); 701186905e3SBarry Smith 70290d69ab7SBarry Smith flg = PETSC_FALSE; 7030298fd71SBarry Smith ierr = PetscOptionsBool("-snes_check_jacobian","Check each Jacobian with a differenced one","SNESUpdateCheckJacobian",flg,&flg,NULL);CHKERRQ(ierr); 7045341784dSBarry Smith if (flg) { 7055341784dSBarry Smith ierr = SNESSetUpdate(snes,SNESUpdateCheckJacobian);CHKERRQ(ierr); 7065341784dSBarry Smith } 7075341784dSBarry Smith 7085341784dSBarry Smith flg = PETSC_FALSE; 7090298fd71SBarry Smith ierr = PetscOptionsBool("-snes_monitor_cancel","Remove all monitors","SNESMonitorCancel",flg,&flg,NULL);CHKERRQ(ierr); 710a6570f20SBarry Smith if (flg) {ierr = SNESMonitorCancel(snes);CHKERRQ(ierr);} 711eabae89aSBarry Smith 712a6570f20SBarry Smith ierr = PetscOptionsString("-snes_monitor","Monitor norm of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 713e8105e01SRichard Katz if (flg) { 714*ce94432eSBarry Smith ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)snes),monfilename,&monviewer);CHKERRQ(ierr); 715649052a6SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 716e8105e01SRichard Katz } 717eabae89aSBarry Smith 718b271bb04SBarry Smith ierr = PetscOptionsString("-snes_monitor_range","Monitor range of elements of function","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 719b271bb04SBarry Smith if (flg) { 720b271bb04SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorRange,0,0);CHKERRQ(ierr); 721b271bb04SBarry Smith } 722b271bb04SBarry Smith 723a6570f20SBarry Smith ierr = PetscOptionsString("-snes_ratiomonitor","Monitor ratios of norms of function","SNESMonitorSetRatio","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 724eabae89aSBarry Smith if (flg) { 725*ce94432eSBarry Smith ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)snes),monfilename,&monviewer);CHKERRQ(ierr); 726f1bef1bcSMatthew Knepley ierr = SNESMonitorSetRatio(snes,monviewer);CHKERRQ(ierr); 727e8105e01SRichard Katz } 728eabae89aSBarry Smith 729a6570f20SBarry Smith ierr = PetscOptionsString("-snes_monitor_short","Monitor norm of function (fewer digits)","SNESMonitorSet","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 730eabae89aSBarry Smith if (flg) { 731*ce94432eSBarry Smith ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)snes),monfilename,&monviewer);CHKERRQ(ierr); 732649052a6SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorDefaultShort,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 733eabae89aSBarry Smith } 734eabae89aSBarry Smith 7355180491cSLisandro Dalcin ierr = PetscOptionsString("-snes_monitor_python","Use Python function","SNESMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr); 7365180491cSLisandro Dalcin if (flg) {ierr = PetscPythonMonitorSet((PetscObject)snes,monfilename);CHKERRQ(ierr);} 7375180491cSLisandro Dalcin 73890d69ab7SBarry Smith flg = PETSC_FALSE; 7390298fd71SBarry Smith ierr = PetscOptionsBool("-snes_monitor_solution","Plot solution at each iteration","SNESMonitorSolution",flg,&flg,NULL);CHKERRQ(ierr); 740a6570f20SBarry Smith if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolution,0,0);CHKERRQ(ierr);} 74190d69ab7SBarry Smith flg = PETSC_FALSE; 7420298fd71SBarry Smith ierr = PetscOptionsBool("-snes_monitor_solution_update","Plot correction at each iteration","SNESMonitorSolutionUpdate",flg,&flg,NULL);CHKERRQ(ierr); 743a6570f20SBarry Smith if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorSolutionUpdate,0,0);CHKERRQ(ierr);} 74490d69ab7SBarry Smith flg = PETSC_FALSE; 7450298fd71SBarry Smith ierr = PetscOptionsBool("-snes_monitor_residual","Plot residual at each iteration","SNESMonitorResidual",flg,&flg,NULL);CHKERRQ(ierr); 746a6570f20SBarry Smith if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorResidual,0,0);CHKERRQ(ierr);} 74790d69ab7SBarry Smith flg = PETSC_FALSE; 7480298fd71SBarry Smith ierr = PetscOptionsBool("-snes_monitor_lg_residualnorm","Plot function norm at each iteration","SNESMonitorLGResidualNorm",flg,&flg,NULL);CHKERRQ(ierr); 749459f5d12SBarry Smith if (flg) { 750459f5d12SBarry Smith PetscDrawLG ctx; 751459f5d12SBarry Smith 752459f5d12SBarry Smith ierr = SNESMonitorLGCreate(0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&ctx);CHKERRQ(ierr); 753459f5d12SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorLGResidualNorm,ctx,(PetscErrorCode (*)(void**))SNESMonitorLGDestroy);CHKERRQ(ierr); 754459f5d12SBarry Smith } 75590d69ab7SBarry Smith flg = PETSC_FALSE; 7560298fd71SBarry Smith ierr = PetscOptionsBool("-snes_monitor_lg_range","Plot function range at each iteration","SNESMonitorLGRange",flg,&flg,NULL);CHKERRQ(ierr); 757459f5d12SBarry Smith if (flg) { 758459f5d12SBarry Smith PetscViewer ctx; 759e24b481bSBarry Smith 760*ce94432eSBarry Smith ierr = PetscViewerDrawOpen(PetscObjectComm((PetscObject)snes),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,&ctx);CHKERRQ(ierr); 761459f5d12SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitorLGRange,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr); 762459f5d12SBarry Smith } 7632e7541e6SPeter Brune 7642e7541e6SPeter Brune flg = PETSC_FALSE; 7650298fd71SBarry Smith ierr = PetscOptionsBool("-snes_monitor_jacupdate_spectrum","Print the change in the spectrum of the Jacobian","SNESMonitorJacUpdateSpectrum",flg,&flg,NULL);CHKERRQ(ierr); 7662e7541e6SPeter Brune if (flg) {ierr = SNESMonitorSet(snes,SNESMonitorJacUpdateSpectrum,0,0);CHKERRQ(ierr);} 7672e7541e6SPeter Brune 76890d69ab7SBarry Smith flg = PETSC_FALSE; 7690298fd71SBarry Smith ierr = PetscOptionsBool("-snes_fd","Use finite differences (slow) to compute Jacobian","SNESDefaultComputeJacobian",flg,&flg,NULL);CHKERRQ(ierr); 7704b27c08aSLois Curfman McInnes if (flg) { 7716cab3a1bSJed Brown void *functx; 7720298fd71SBarry Smith ierr = SNESGetFunction(snes,NULL,NULL,&functx);CHKERRQ(ierr); 7736cab3a1bSJed Brown ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESDefaultComputeJacobian,functx);CHKERRQ(ierr); 774ae15b995SBarry Smith ierr = PetscInfo(snes,"Setting default finite difference Jacobian matrix\n");CHKERRQ(ierr); 7759b94acceSBarry Smith } 776639f9d9dSBarry Smith 77744848bc4SPeter Brune flg = PETSC_FALSE; 7780298fd71SBarry Smith ierr = PetscOptionsBool("-snes_fd_function","Use finite differences (slow) to compute function from user objective","SNESDefaultObjectiveComputeFunctionFD",flg,&flg,NULL);CHKERRQ(ierr); 77997584545SPeter Brune if (flg) { 7800298fd71SBarry Smith ierr = SNESSetFunction(snes,NULL,SNESDefaultObjectiveComputeFunctionFD,NULL);CHKERRQ(ierr); 78197584545SPeter Brune } 78297584545SPeter Brune 78397584545SPeter Brune flg = PETSC_FALSE; 7840298fd71SBarry Smith ierr = PetscOptionsBool("-snes_fd_color","Use finite differences with coloring to compute Jacobian","SNESDefaultComputeJacobianColor",flg,&flg,NULL);CHKERRQ(ierr); 78544848bc4SPeter Brune if (flg) { 78644848bc4SPeter Brune void *functx; 7870298fd71SBarry Smith ierr = SNESGetFunction(snes,NULL,NULL,&functx);CHKERRQ(ierr); 7880171d955SPeter Brune ierr = SNESSetJacobian(snes,snes->jacobian,snes->jacobian_pre,SNESDefaultComputeJacobianColor,0);CHKERRQ(ierr); 78944848bc4SPeter Brune ierr = PetscInfo(snes,"Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr); 79044848bc4SPeter Brune } 79144848bc4SPeter Brune 792aa3661deSLisandro Dalcin flg = PETSC_FALSE; 793d8f46077SPeter Brune ierr = PetscOptionsBool("-snes_mf_operator","Use a Matrix-Free Jacobian with user-provided preconditioner matrix","MatCreateSNESMF",PETSC_FALSE,&snes->mf_operator,&flg);CHKERRQ(ierr); 794d8f46077SPeter Brune if (flg && snes->mf_operator) { 795a8248277SBarry Smith snes->mf_operator = PETSC_TRUE; 796d8f46077SPeter Brune snes->mf = PETSC_TRUE; 797a8248277SBarry Smith } 798aa3661deSLisandro Dalcin flg = PETSC_FALSE; 799d8f46077SPeter Brune ierr = PetscOptionsBool("-snes_mf","Use a Matrix-Free Jacobian with no preconditioner matrix","MatCreateSNESMF",PETSC_FALSE,&snes->mf,&flg);CHKERRQ(ierr); 800d8f46077SPeter Brune if (!flg && snes->mf_operator) snes->mf = PETSC_TRUE; 801d8f46077SPeter Brune ierr = PetscOptionsInt("-snes_mf_version","Matrix-Free routines version 1 or 2","None",snes->mf_version,&snes->mf_version,0);CHKERRQ(ierr); 802d28543b3SPeter Brune 803c40d0f55SPeter Brune flg = PETSC_FALSE; 80422d28d08SBarry Smith ierr = SNESGetPCSide(snes,&pcside);CHKERRQ(ierr); 805c40d0f55SPeter Brune ierr = PetscOptionsEnum("-snes_npc_side","SNES nonlinear preconditioner side","SNESSetPCSide",PCSides,(PetscEnum)pcside,(PetscEnum*)&pcside,&flg);CHKERRQ(ierr); 806c40d0f55SPeter Brune if (flg) {ierr = SNESSetPCSide(snes,pcside);CHKERRQ(ierr);} 807c40d0f55SPeter Brune 80876b2cf59SMatthew Knepley for (i = 0; i < numberofsetfromoptions; i++) { 80976b2cf59SMatthew Knepley ierr = (*othersetfromoptions[i])(snes);CHKERRQ(ierr); 81076b2cf59SMatthew Knepley } 81176b2cf59SMatthew Knepley 812e7788613SBarry Smith if (snes->ops->setfromoptions) { 813e7788613SBarry Smith ierr = (*snes->ops->setfromoptions)(snes);CHKERRQ(ierr); 814639f9d9dSBarry Smith } 8155d973c19SBarry Smith 8165d973c19SBarry Smith /* process any options handlers added with PetscObjectAddOptionsHandler() */ 8175d973c19SBarry Smith ierr = PetscObjectProcessOptionsHandlers((PetscObject)snes);CHKERRQ(ierr); 818b0a32e0cSBarry Smith ierr = PetscOptionsEnd();CHKERRQ(ierr); 8194bbc92c1SBarry Smith 8201cee3971SBarry Smith if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);} 8210298fd71SBarry Smith ierr = KSPGetOperators(snes->ksp,NULL,NULL,&matflag);CHKERRQ(ierr); 822aa3661deSLisandro Dalcin ierr = KSPSetOperators(snes->ksp,snes->jacobian,snes->jacobian_pre,matflag);CHKERRQ(ierr); 82385385478SLisandro Dalcin ierr = KSPSetFromOptions(snes->ksp);CHKERRQ(ierr); 82493993e2dSLois Curfman McInnes 8259e764e56SPeter Brune if (!snes->linesearch) { 826f1c6b773SPeter Brune ierr = SNESGetSNESLineSearch(snes, &snes->linesearch);CHKERRQ(ierr); 8279e764e56SPeter Brune } 828f1c6b773SPeter Brune ierr = SNESLineSearchSetFromOptions(snes->linesearch);CHKERRQ(ierr); 8299e764e56SPeter Brune 83051e86f29SPeter Brune /* if someone has set the SNES PC type, create it. */ 83151e86f29SPeter Brune ierr = SNESGetOptionsPrefix(snes, &optionsprefix);CHKERRQ(ierr); 83251e86f29SPeter Brune ierr = PetscOptionsHasName(optionsprefix, "-npc_snes_type", &pcset);CHKERRQ(ierr); 83351e86f29SPeter Brune if (pcset && (!snes->pc)) { 83451e86f29SPeter Brune ierr = SNESGetPC(snes, &snes->pc);CHKERRQ(ierr); 83551e86f29SPeter Brune } 8363a40ed3dSBarry Smith PetscFunctionReturn(0); 8379b94acceSBarry Smith } 8389b94acceSBarry Smith 839d25893d9SBarry Smith #undef __FUNCT__ 840d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeApplicationContext" 841d25893d9SBarry Smith /*@ 842d25893d9SBarry Smith SNESSetComputeApplicationContext - Sets an optional function to compute a user-defined context for 843d25893d9SBarry Smith the nonlinear solvers. 844d25893d9SBarry Smith 845d25893d9SBarry Smith Logically Collective on SNES 846d25893d9SBarry Smith 847d25893d9SBarry Smith Input Parameters: 848d25893d9SBarry Smith + snes - the SNES context 849d25893d9SBarry Smith . compute - function to compute the context 850d25893d9SBarry Smith - destroy - function to destroy the context 851d25893d9SBarry Smith 852d25893d9SBarry Smith Level: intermediate 853d25893d9SBarry Smith 854d25893d9SBarry Smith .keywords: SNES, nonlinear, set, application, context 855d25893d9SBarry Smith 856d25893d9SBarry Smith .seealso: SNESGetApplicationContext(), SNESSetComputeApplicationContext(), SNESGetApplicationContext() 857d25893d9SBarry Smith @*/ 858d25893d9SBarry Smith PetscErrorCode SNESSetComputeApplicationContext(SNES snes,PetscErrorCode (*compute)(SNES,void**),PetscErrorCode (*destroy)(void**)) 859d25893d9SBarry Smith { 860d25893d9SBarry Smith PetscFunctionBegin; 861d25893d9SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 862d25893d9SBarry Smith snes->ops->usercompute = compute; 863d25893d9SBarry Smith snes->ops->userdestroy = destroy; 864d25893d9SBarry Smith PetscFunctionReturn(0); 865d25893d9SBarry Smith } 866a847f771SSatish Balay 8674a2ae208SSatish Balay #undef __FUNCT__ 8684a2ae208SSatish Balay #define __FUNCT__ "SNESSetApplicationContext" 869b07ff414SBarry Smith /*@ 8709b94acceSBarry Smith SNESSetApplicationContext - Sets the optional user-defined context for 8719b94acceSBarry Smith the nonlinear solvers. 8729b94acceSBarry Smith 8733f9fe445SBarry Smith Logically Collective on SNES 874fee21e36SBarry Smith 875c7afd0dbSLois Curfman McInnes Input Parameters: 876c7afd0dbSLois Curfman McInnes + snes - the SNES context 877c7afd0dbSLois Curfman McInnes - usrP - optional user context 878c7afd0dbSLois Curfman McInnes 87936851e7fSLois Curfman McInnes Level: intermediate 88036851e7fSLois Curfman McInnes 8819b94acceSBarry Smith .keywords: SNES, nonlinear, set, application, context 8829b94acceSBarry Smith 883ecaffddaSVictor Eijkhout .seealso: SNESGetApplicationContext() 8849b94acceSBarry Smith @*/ 8857087cfbeSBarry Smith PetscErrorCode SNESSetApplicationContext(SNES snes,void *usrP) 8869b94acceSBarry Smith { 8871b2093e4SBarry Smith PetscErrorCode ierr; 888b07ff414SBarry Smith KSP ksp; 8891b2093e4SBarry Smith 8903a40ed3dSBarry Smith PetscFunctionBegin; 8910700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 892b07ff414SBarry Smith ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 893b07ff414SBarry Smith ierr = KSPSetApplicationContext(ksp,usrP);CHKERRQ(ierr); 8949b94acceSBarry Smith snes->user = usrP; 8953a40ed3dSBarry Smith PetscFunctionReturn(0); 8969b94acceSBarry Smith } 89774679c65SBarry Smith 8984a2ae208SSatish Balay #undef __FUNCT__ 8994a2ae208SSatish Balay #define __FUNCT__ "SNESGetApplicationContext" 900b07ff414SBarry Smith /*@ 9019b94acceSBarry Smith SNESGetApplicationContext - Gets the user-defined context for the 9029b94acceSBarry Smith nonlinear solvers. 9039b94acceSBarry Smith 904c7afd0dbSLois Curfman McInnes Not Collective 905c7afd0dbSLois Curfman McInnes 9069b94acceSBarry Smith Input Parameter: 9079b94acceSBarry Smith . snes - SNES context 9089b94acceSBarry Smith 9099b94acceSBarry Smith Output Parameter: 9109b94acceSBarry Smith . usrP - user context 9119b94acceSBarry Smith 91236851e7fSLois Curfman McInnes Level: intermediate 91336851e7fSLois Curfman McInnes 9149b94acceSBarry Smith .keywords: SNES, nonlinear, get, application, context 9159b94acceSBarry Smith 9169b94acceSBarry Smith .seealso: SNESSetApplicationContext() 9179b94acceSBarry Smith @*/ 918e71120c6SJed Brown PetscErrorCode SNESGetApplicationContext(SNES snes,void *usrP) 9199b94acceSBarry Smith { 9203a40ed3dSBarry Smith PetscFunctionBegin; 9210700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 922e71120c6SJed Brown *(void**)usrP = snes->user; 9233a40ed3dSBarry Smith PetscFunctionReturn(0); 9249b94acceSBarry Smith } 92574679c65SBarry Smith 9264a2ae208SSatish Balay #undef __FUNCT__ 9274a2ae208SSatish Balay #define __FUNCT__ "SNESGetIterationNumber" 9289b94acceSBarry Smith /*@ 929c8228a4eSBarry Smith SNESGetIterationNumber - Gets the number of nonlinear iterations completed 930c8228a4eSBarry Smith at this time. 9319b94acceSBarry Smith 932c7afd0dbSLois Curfman McInnes Not Collective 933c7afd0dbSLois Curfman McInnes 9349b94acceSBarry Smith Input Parameter: 9359b94acceSBarry Smith . snes - SNES context 9369b94acceSBarry Smith 9379b94acceSBarry Smith Output Parameter: 9389b94acceSBarry Smith . iter - iteration number 9399b94acceSBarry Smith 940c8228a4eSBarry Smith Notes: 941c8228a4eSBarry Smith For example, during the computation of iteration 2 this would return 1. 942c8228a4eSBarry Smith 943c8228a4eSBarry Smith This is useful for using lagged Jacobians (where one does not recompute the 94408405cd6SLois Curfman McInnes Jacobian at each SNES iteration). For example, the code 94508405cd6SLois Curfman McInnes .vb 94608405cd6SLois Curfman McInnes ierr = SNESGetIterationNumber(snes,&it); 94708405cd6SLois Curfman McInnes if (!(it % 2)) { 94808405cd6SLois Curfman McInnes [compute Jacobian here] 94908405cd6SLois Curfman McInnes } 95008405cd6SLois Curfman McInnes .ve 951c8228a4eSBarry Smith can be used in your ComputeJacobian() function to cause the Jacobian to be 95208405cd6SLois Curfman McInnes recomputed every second SNES iteration. 953c8228a4eSBarry Smith 95436851e7fSLois Curfman McInnes Level: intermediate 95536851e7fSLois Curfman McInnes 9562b668275SBarry Smith .keywords: SNES, nonlinear, get, iteration, number, 9572b668275SBarry Smith 958b850b91aSLisandro Dalcin .seealso: SNESGetFunctionNorm(), SNESGetLinearSolveIterations() 9599b94acceSBarry Smith @*/ 9607087cfbeSBarry Smith PetscErrorCode SNESGetIterationNumber(SNES snes,PetscInt *iter) 9619b94acceSBarry Smith { 9623a40ed3dSBarry Smith PetscFunctionBegin; 9630700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 9644482741eSBarry Smith PetscValidIntPointer(iter,2); 9659b94acceSBarry Smith *iter = snes->iter; 9663a40ed3dSBarry Smith PetscFunctionReturn(0); 9679b94acceSBarry Smith } 96874679c65SBarry Smith 9694a2ae208SSatish Balay #undef __FUNCT__ 970360c497dSPeter Brune #define __FUNCT__ "SNESSetIterationNumber" 971360c497dSPeter Brune /*@ 972360c497dSPeter Brune SNESSetIterationNumber - Sets the current iteration number. 973360c497dSPeter Brune 974360c497dSPeter Brune Not Collective 975360c497dSPeter Brune 976360c497dSPeter Brune Input Parameter: 977360c497dSPeter Brune . snes - SNES context 978360c497dSPeter Brune . iter - iteration number 979360c497dSPeter Brune 980360c497dSPeter Brune Level: developer 981360c497dSPeter Brune 982360c497dSPeter Brune .keywords: SNES, nonlinear, set, iteration, number, 983360c497dSPeter Brune 984360c497dSPeter Brune .seealso: SNESGetFunctionNorm(), SNESGetLinearSolveIterations() 985360c497dSPeter Brune @*/ 986360c497dSPeter Brune PetscErrorCode SNESSetIterationNumber(SNES snes,PetscInt iter) 987360c497dSPeter Brune { 988360c497dSPeter Brune PetscErrorCode ierr; 989360c497dSPeter Brune 990360c497dSPeter Brune PetscFunctionBegin; 991360c497dSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 992360c497dSPeter Brune ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 993360c497dSPeter Brune snes->iter = iter; 994360c497dSPeter Brune ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 995360c497dSPeter Brune PetscFunctionReturn(0); 996360c497dSPeter Brune } 997360c497dSPeter Brune 998360c497dSPeter Brune #undef __FUNCT__ 9994a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunctionNorm" 10009b94acceSBarry Smith /*@ 10019b94acceSBarry Smith SNESGetFunctionNorm - Gets the norm of the current function that was set 10029b94acceSBarry Smith with SNESSSetFunction(). 10039b94acceSBarry Smith 1004c7afd0dbSLois Curfman McInnes Collective on SNES 1005c7afd0dbSLois Curfman McInnes 10069b94acceSBarry Smith Input Parameter: 10079b94acceSBarry Smith . snes - SNES context 10089b94acceSBarry Smith 10099b94acceSBarry Smith Output Parameter: 10109b94acceSBarry Smith . fnorm - 2-norm of function 10119b94acceSBarry Smith 101236851e7fSLois Curfman McInnes Level: intermediate 101336851e7fSLois Curfman McInnes 10149b94acceSBarry Smith .keywords: SNES, nonlinear, get, function, norm 1015a86d99e1SLois Curfman McInnes 1016b850b91aSLisandro Dalcin .seealso: SNESGetFunction(), SNESGetIterationNumber(), SNESGetLinearSolveIterations() 10179b94acceSBarry Smith @*/ 10187087cfbeSBarry Smith PetscErrorCode SNESGetFunctionNorm(SNES snes,PetscReal *fnorm) 10199b94acceSBarry Smith { 10203a40ed3dSBarry Smith PetscFunctionBegin; 10210700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 10224482741eSBarry Smith PetscValidScalarPointer(fnorm,2); 10239b94acceSBarry Smith *fnorm = snes->norm; 10243a40ed3dSBarry Smith PetscFunctionReturn(0); 10259b94acceSBarry Smith } 102674679c65SBarry Smith 1027360c497dSPeter Brune 1028360c497dSPeter Brune #undef __FUNCT__ 1029360c497dSPeter Brune #define __FUNCT__ "SNESSetFunctionNorm" 1030360c497dSPeter Brune /*@ 1031360c497dSPeter Brune SNESSetFunctionNorm - Sets the 2-norm of the current function computed using VecNorm(). 1032360c497dSPeter Brune 1033360c497dSPeter Brune Collective on SNES 1034360c497dSPeter Brune 1035360c497dSPeter Brune Input Parameter: 1036360c497dSPeter Brune . snes - SNES context 1037360c497dSPeter Brune . fnorm - 2-norm of function 1038360c497dSPeter Brune 1039360c497dSPeter Brune Level: developer 1040360c497dSPeter Brune 1041360c497dSPeter Brune .keywords: SNES, nonlinear, set, function, norm 1042360c497dSPeter Brune 1043360c497dSPeter Brune .seealso: SNESSetFunction(), SNESSetIterationNumber(), VecNorm(). 1044360c497dSPeter Brune @*/ 1045360c497dSPeter Brune PetscErrorCode SNESSetFunctionNorm(SNES snes,PetscReal fnorm) 1046360c497dSPeter Brune { 1047360c497dSPeter Brune 1048360c497dSPeter Brune PetscErrorCode ierr; 1049360c497dSPeter Brune 1050360c497dSPeter Brune PetscFunctionBegin; 1051360c497dSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1052360c497dSPeter Brune ierr = PetscObjectTakeAccess(snes);CHKERRQ(ierr); 1053360c497dSPeter Brune snes->norm = fnorm; 1054360c497dSPeter Brune ierr = PetscObjectGrantAccess(snes);CHKERRQ(ierr); 1055360c497dSPeter Brune PetscFunctionReturn(0); 1056360c497dSPeter Brune } 1057360c497dSPeter Brune 10584a2ae208SSatish Balay #undef __FUNCT__ 1059b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetNonlinearStepFailures" 10609b94acceSBarry Smith /*@ 1061b850b91aSLisandro Dalcin SNESGetNonlinearStepFailures - Gets the number of unsuccessful steps 10629b94acceSBarry Smith attempted by the nonlinear solver. 10639b94acceSBarry Smith 1064c7afd0dbSLois Curfman McInnes Not Collective 1065c7afd0dbSLois Curfman McInnes 10669b94acceSBarry Smith Input Parameter: 10679b94acceSBarry Smith . snes - SNES context 10689b94acceSBarry Smith 10699b94acceSBarry Smith Output Parameter: 10709b94acceSBarry Smith . nfails - number of unsuccessful steps attempted 10719b94acceSBarry Smith 1072c96a6f78SLois Curfman McInnes Notes: 1073c96a6f78SLois Curfman McInnes This counter is reset to zero for each successive call to SNESSolve(). 1074c96a6f78SLois Curfman McInnes 107536851e7fSLois Curfman McInnes Level: intermediate 107636851e7fSLois Curfman McInnes 10779b94acceSBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps 107858ebbce7SBarry Smith 1079e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(), 108058ebbce7SBarry Smith SNESSetMaxNonlinearStepFailures(), SNESGetMaxNonlinearStepFailures() 10819b94acceSBarry Smith @*/ 10827087cfbeSBarry Smith PetscErrorCode SNESGetNonlinearStepFailures(SNES snes,PetscInt *nfails) 10839b94acceSBarry Smith { 10843a40ed3dSBarry Smith PetscFunctionBegin; 10850700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 10864482741eSBarry Smith PetscValidIntPointer(nfails,2); 108750ffb88aSMatthew Knepley *nfails = snes->numFailures; 108850ffb88aSMatthew Knepley PetscFunctionReturn(0); 108950ffb88aSMatthew Knepley } 109050ffb88aSMatthew Knepley 109150ffb88aSMatthew Knepley #undef __FUNCT__ 1092b850b91aSLisandro Dalcin #define __FUNCT__ "SNESSetMaxNonlinearStepFailures" 109350ffb88aSMatthew Knepley /*@ 1094b850b91aSLisandro Dalcin SNESSetMaxNonlinearStepFailures - Sets the maximum number of unsuccessful steps 109550ffb88aSMatthew Knepley attempted by the nonlinear solver before it gives up. 109650ffb88aSMatthew Knepley 109750ffb88aSMatthew Knepley Not Collective 109850ffb88aSMatthew Knepley 109950ffb88aSMatthew Knepley Input Parameters: 110050ffb88aSMatthew Knepley + snes - SNES context 110150ffb88aSMatthew Knepley - maxFails - maximum of unsuccessful steps 110250ffb88aSMatthew Knepley 110350ffb88aSMatthew Knepley Level: intermediate 110450ffb88aSMatthew Knepley 110550ffb88aSMatthew Knepley .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps 110658ebbce7SBarry Smith 1107e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(), 110858ebbce7SBarry Smith SNESGetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures() 110950ffb88aSMatthew Knepley @*/ 11107087cfbeSBarry Smith PetscErrorCode SNESSetMaxNonlinearStepFailures(SNES snes, PetscInt maxFails) 111150ffb88aSMatthew Knepley { 111250ffb88aSMatthew Knepley PetscFunctionBegin; 11130700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 111450ffb88aSMatthew Knepley snes->maxFailures = maxFails; 111550ffb88aSMatthew Knepley PetscFunctionReturn(0); 111650ffb88aSMatthew Knepley } 111750ffb88aSMatthew Knepley 111850ffb88aSMatthew Knepley #undef __FUNCT__ 1119b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetMaxNonlinearStepFailures" 112050ffb88aSMatthew Knepley /*@ 1121b850b91aSLisandro Dalcin SNESGetMaxNonlinearStepFailures - Gets the maximum number of unsuccessful steps 112250ffb88aSMatthew Knepley attempted by the nonlinear solver before it gives up. 112350ffb88aSMatthew Knepley 112450ffb88aSMatthew Knepley Not Collective 112550ffb88aSMatthew Knepley 112650ffb88aSMatthew Knepley Input Parameter: 112750ffb88aSMatthew Knepley . snes - SNES context 112850ffb88aSMatthew Knepley 112950ffb88aSMatthew Knepley Output Parameter: 113050ffb88aSMatthew Knepley . maxFails - maximum of unsuccessful steps 113150ffb88aSMatthew Knepley 113250ffb88aSMatthew Knepley Level: intermediate 113350ffb88aSMatthew Knepley 113450ffb88aSMatthew Knepley .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps 113558ebbce7SBarry Smith 1136e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures(), 113758ebbce7SBarry Smith SNESSetMaxNonlinearStepFailures(), SNESGetNonlinearStepFailures() 113858ebbce7SBarry Smith 113950ffb88aSMatthew Knepley @*/ 11407087cfbeSBarry Smith PetscErrorCode SNESGetMaxNonlinearStepFailures(SNES snes, PetscInt *maxFails) 114150ffb88aSMatthew Knepley { 114250ffb88aSMatthew Knepley PetscFunctionBegin; 11430700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 11444482741eSBarry Smith PetscValidIntPointer(maxFails,2); 114550ffb88aSMatthew Knepley *maxFails = snes->maxFailures; 11463a40ed3dSBarry Smith PetscFunctionReturn(0); 11479b94acceSBarry Smith } 1148a847f771SSatish Balay 11494a2ae208SSatish Balay #undef __FUNCT__ 11502541af92SBarry Smith #define __FUNCT__ "SNESGetNumberFunctionEvals" 11512541af92SBarry Smith /*@ 11522541af92SBarry Smith SNESGetNumberFunctionEvals - Gets the number of user provided function evaluations 11532541af92SBarry Smith done by SNES. 11542541af92SBarry Smith 11552541af92SBarry Smith Not Collective 11562541af92SBarry Smith 11572541af92SBarry Smith Input Parameter: 11582541af92SBarry Smith . snes - SNES context 11592541af92SBarry Smith 11602541af92SBarry Smith Output Parameter: 11612541af92SBarry Smith . nfuncs - number of evaluations 11622541af92SBarry Smith 11632541af92SBarry Smith Level: intermediate 11642541af92SBarry Smith 11652541af92SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps 116658ebbce7SBarry Smith 1167e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), SNESGetLinearSolveFailures() 11682541af92SBarry Smith @*/ 11697087cfbeSBarry Smith PetscErrorCode SNESGetNumberFunctionEvals(SNES snes, PetscInt *nfuncs) 11702541af92SBarry Smith { 11712541af92SBarry Smith PetscFunctionBegin; 11720700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 11732541af92SBarry Smith PetscValidIntPointer(nfuncs,2); 11742541af92SBarry Smith *nfuncs = snes->nfuncs; 11752541af92SBarry Smith PetscFunctionReturn(0); 11762541af92SBarry Smith } 11772541af92SBarry Smith 11782541af92SBarry Smith #undef __FUNCT__ 11793d4c4710SBarry Smith #define __FUNCT__ "SNESGetLinearSolveFailures" 11803d4c4710SBarry Smith /*@ 11813d4c4710SBarry Smith SNESGetLinearSolveFailures - Gets the number of failed (non-converged) 11823d4c4710SBarry Smith linear solvers. 11833d4c4710SBarry Smith 11843d4c4710SBarry Smith Not Collective 11853d4c4710SBarry Smith 11863d4c4710SBarry Smith Input Parameter: 11873d4c4710SBarry Smith . snes - SNES context 11883d4c4710SBarry Smith 11893d4c4710SBarry Smith Output Parameter: 11903d4c4710SBarry Smith . nfails - number of failed solves 11913d4c4710SBarry Smith 11923d4c4710SBarry Smith Notes: 11933d4c4710SBarry Smith This counter is reset to zero for each successive call to SNESSolve(). 11943d4c4710SBarry Smith 11953d4c4710SBarry Smith Level: intermediate 11963d4c4710SBarry Smith 11973d4c4710SBarry Smith .keywords: SNES, nonlinear, get, number, unsuccessful, steps 119858ebbce7SBarry Smith 1199e1c61ce8SBarry Smith .seealso: SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures() 12003d4c4710SBarry Smith @*/ 12017087cfbeSBarry Smith PetscErrorCode SNESGetLinearSolveFailures(SNES snes,PetscInt *nfails) 12023d4c4710SBarry Smith { 12033d4c4710SBarry Smith PetscFunctionBegin; 12040700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 12053d4c4710SBarry Smith PetscValidIntPointer(nfails,2); 12063d4c4710SBarry Smith *nfails = snes->numLinearSolveFailures; 12073d4c4710SBarry Smith PetscFunctionReturn(0); 12083d4c4710SBarry Smith } 12093d4c4710SBarry Smith 12103d4c4710SBarry Smith #undef __FUNCT__ 12113d4c4710SBarry Smith #define __FUNCT__ "SNESSetMaxLinearSolveFailures" 12123d4c4710SBarry Smith /*@ 12133d4c4710SBarry Smith SNESSetMaxLinearSolveFailures - the number of failed linear solve attempts 12143d4c4710SBarry Smith allowed before SNES returns with a diverged reason of SNES_DIVERGED_LINEAR_SOLVE 12153d4c4710SBarry Smith 12163f9fe445SBarry Smith Logically Collective on SNES 12173d4c4710SBarry Smith 12183d4c4710SBarry Smith Input Parameters: 12193d4c4710SBarry Smith + snes - SNES context 12203d4c4710SBarry Smith - maxFails - maximum allowed linear solve failures 12213d4c4710SBarry Smith 12223d4c4710SBarry Smith Level: intermediate 12233d4c4710SBarry Smith 1224a6796414SBarry Smith Notes: By default this is 0; that is SNES returns on the first failed linear solve 12253d4c4710SBarry Smith 12263d4c4710SBarry Smith .keywords: SNES, nonlinear, set, maximum, unsuccessful, steps 12273d4c4710SBarry Smith 122858ebbce7SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures(), SNESGetLinearSolveIterations() 12293d4c4710SBarry Smith @*/ 12307087cfbeSBarry Smith PetscErrorCode SNESSetMaxLinearSolveFailures(SNES snes, PetscInt maxFails) 12313d4c4710SBarry Smith { 12323d4c4710SBarry Smith PetscFunctionBegin; 12330700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1234c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,maxFails,2); 12353d4c4710SBarry Smith snes->maxLinearSolveFailures = maxFails; 12363d4c4710SBarry Smith PetscFunctionReturn(0); 12373d4c4710SBarry Smith } 12383d4c4710SBarry Smith 12393d4c4710SBarry Smith #undef __FUNCT__ 12403d4c4710SBarry Smith #define __FUNCT__ "SNESGetMaxLinearSolveFailures" 12413d4c4710SBarry Smith /*@ 12423d4c4710SBarry Smith SNESGetMaxLinearSolveFailures - gets the maximum number of linear solve failures that 12433d4c4710SBarry Smith are allowed before SNES terminates 12443d4c4710SBarry Smith 12453d4c4710SBarry Smith Not Collective 12463d4c4710SBarry Smith 12473d4c4710SBarry Smith Input Parameter: 12483d4c4710SBarry Smith . snes - SNES context 12493d4c4710SBarry Smith 12503d4c4710SBarry Smith Output Parameter: 12513d4c4710SBarry Smith . maxFails - maximum of unsuccessful solves allowed 12523d4c4710SBarry Smith 12533d4c4710SBarry Smith Level: intermediate 12543d4c4710SBarry Smith 12553d4c4710SBarry Smith Notes: By default this is 1; that is SNES returns on the first failed linear solve 12563d4c4710SBarry Smith 12573d4c4710SBarry Smith .keywords: SNES, nonlinear, get, maximum, unsuccessful, steps 12583d4c4710SBarry Smith 1259e1c61ce8SBarry Smith .seealso: SNESGetLinearSolveFailures(), SNESGetLinearSolveIterations(), SNESSetMaxLinearSolveFailures(), 12603d4c4710SBarry Smith @*/ 12617087cfbeSBarry Smith PetscErrorCode SNESGetMaxLinearSolveFailures(SNES snes, PetscInt *maxFails) 12623d4c4710SBarry Smith { 12633d4c4710SBarry Smith PetscFunctionBegin; 12640700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 12653d4c4710SBarry Smith PetscValidIntPointer(maxFails,2); 12663d4c4710SBarry Smith *maxFails = snes->maxLinearSolveFailures; 12673d4c4710SBarry Smith PetscFunctionReturn(0); 12683d4c4710SBarry Smith } 12693d4c4710SBarry Smith 12703d4c4710SBarry Smith #undef __FUNCT__ 1271b850b91aSLisandro Dalcin #define __FUNCT__ "SNESGetLinearSolveIterations" 1272c96a6f78SLois Curfman McInnes /*@ 1273b850b91aSLisandro Dalcin SNESGetLinearSolveIterations - Gets the total number of linear iterations 1274c96a6f78SLois Curfman McInnes used by the nonlinear solver. 1275c96a6f78SLois Curfman McInnes 1276c7afd0dbSLois Curfman McInnes Not Collective 1277c7afd0dbSLois Curfman McInnes 1278c96a6f78SLois Curfman McInnes Input Parameter: 1279c96a6f78SLois Curfman McInnes . snes - SNES context 1280c96a6f78SLois Curfman McInnes 1281c96a6f78SLois Curfman McInnes Output Parameter: 1282c96a6f78SLois Curfman McInnes . lits - number of linear iterations 1283c96a6f78SLois Curfman McInnes 1284c96a6f78SLois Curfman McInnes Notes: 1285c96a6f78SLois Curfman McInnes This counter is reset to zero for each successive call to SNESSolve(). 1286c96a6f78SLois Curfman McInnes 128736851e7fSLois Curfman McInnes Level: intermediate 128836851e7fSLois Curfman McInnes 1289c96a6f78SLois Curfman McInnes .keywords: SNES, nonlinear, get, number, linear, iterations 12902b668275SBarry Smith 12918c7482ecSBarry Smith .seealso: SNESGetIterationNumber(), SNESGetFunctionNorm(), SNESGetLinearSolveFailures(), SNESGetMaxLinearSolveFailures() 1292c96a6f78SLois Curfman McInnes @*/ 12937087cfbeSBarry Smith PetscErrorCode SNESGetLinearSolveIterations(SNES snes,PetscInt *lits) 1294c96a6f78SLois Curfman McInnes { 12953a40ed3dSBarry Smith PetscFunctionBegin; 12960700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 12974482741eSBarry Smith PetscValidIntPointer(lits,2); 1298c96a6f78SLois Curfman McInnes *lits = snes->linear_its; 12993a40ed3dSBarry Smith PetscFunctionReturn(0); 1300c96a6f78SLois Curfman McInnes } 1301c96a6f78SLois Curfman McInnes 13024a2ae208SSatish Balay #undef __FUNCT__ 130394b7f48cSBarry Smith #define __FUNCT__ "SNESGetKSP" 130452baeb72SSatish Balay /*@ 130594b7f48cSBarry Smith SNESGetKSP - Returns the KSP context for a SNES solver. 13069b94acceSBarry Smith 130794b7f48cSBarry Smith Not Collective, but if SNES object is parallel, then KSP object is parallel 1308c7afd0dbSLois Curfman McInnes 13099b94acceSBarry Smith Input Parameter: 13109b94acceSBarry Smith . snes - the SNES context 13119b94acceSBarry Smith 13129b94acceSBarry Smith Output Parameter: 131394b7f48cSBarry Smith . ksp - the KSP context 13149b94acceSBarry Smith 13159b94acceSBarry Smith Notes: 131694b7f48cSBarry Smith The user can then directly manipulate the KSP context to set various 13179b94acceSBarry Smith options, etc. Likewise, the user can then extract and manipulate the 13182999313aSBarry Smith PC contexts as well. 13199b94acceSBarry Smith 132036851e7fSLois Curfman McInnes Level: beginner 132136851e7fSLois Curfman McInnes 132294b7f48cSBarry Smith .keywords: SNES, nonlinear, get, KSP, context 13239b94acceSBarry Smith 13242999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP() 13259b94acceSBarry Smith @*/ 13267087cfbeSBarry Smith PetscErrorCode SNESGetKSP(SNES snes,KSP *ksp) 13279b94acceSBarry Smith { 13281cee3971SBarry Smith PetscErrorCode ierr; 13291cee3971SBarry Smith 13303a40ed3dSBarry Smith PetscFunctionBegin; 13310700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 13324482741eSBarry Smith PetscValidPointer(ksp,2); 13331cee3971SBarry Smith 13341cee3971SBarry Smith if (!snes->ksp) { 1335*ce94432eSBarry Smith ierr = KSPCreate(PetscObjectComm((PetscObject)snes),&snes->ksp);CHKERRQ(ierr); 13361cee3971SBarry Smith ierr = PetscObjectIncrementTabLevel((PetscObject)snes->ksp,(PetscObject)snes,1);CHKERRQ(ierr); 13371cee3971SBarry Smith ierr = PetscLogObjectParent(snes,snes->ksp);CHKERRQ(ierr); 13381cee3971SBarry Smith } 133994b7f48cSBarry Smith *ksp = snes->ksp; 13403a40ed3dSBarry Smith PetscFunctionReturn(0); 13419b94acceSBarry Smith } 134282bf6240SBarry Smith 13434a2ae208SSatish Balay #undef __FUNCT__ 13442999313aSBarry Smith #define __FUNCT__ "SNESSetKSP" 13452999313aSBarry Smith /*@ 13462999313aSBarry Smith SNESSetKSP - Sets a KSP context for the SNES object to use 13472999313aSBarry Smith 13482999313aSBarry Smith Not Collective, but the SNES and KSP objects must live on the same MPI_Comm 13492999313aSBarry Smith 13502999313aSBarry Smith Input Parameters: 13512999313aSBarry Smith + snes - the SNES context 13522999313aSBarry Smith - ksp - the KSP context 13532999313aSBarry Smith 13542999313aSBarry Smith Notes: 13552999313aSBarry Smith The SNES object already has its KSP object, you can obtain with SNESGetKSP() 13562999313aSBarry Smith so this routine is rarely needed. 13572999313aSBarry Smith 13582999313aSBarry Smith The KSP object that is already in the SNES object has its reference count 13592999313aSBarry Smith decreased by one. 13602999313aSBarry Smith 13612999313aSBarry Smith Level: developer 13622999313aSBarry Smith 13632999313aSBarry Smith .keywords: SNES, nonlinear, get, KSP, context 13642999313aSBarry Smith 13652999313aSBarry Smith .seealso: KSPGetPC(), SNESCreate(), KSPCreate(), SNESSetKSP() 13662999313aSBarry Smith @*/ 13677087cfbeSBarry Smith PetscErrorCode SNESSetKSP(SNES snes,KSP ksp) 13682999313aSBarry Smith { 13692999313aSBarry Smith PetscErrorCode ierr; 13702999313aSBarry Smith 13712999313aSBarry Smith PetscFunctionBegin; 13720700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 13730700a824SBarry Smith PetscValidHeaderSpecific(ksp,KSP_CLASSID,2); 13742999313aSBarry Smith PetscCheckSameComm(snes,1,ksp,2); 13757dcf0eaaSdalcinl ierr = PetscObjectReference((PetscObject)ksp);CHKERRQ(ierr); 1376906ed7ccSBarry Smith if (snes->ksp) {ierr = PetscObjectDereference((PetscObject)snes->ksp);CHKERRQ(ierr);} 13772999313aSBarry Smith snes->ksp = ksp; 13782999313aSBarry Smith PetscFunctionReturn(0); 13792999313aSBarry Smith } 13802999313aSBarry Smith 13817adad957SLisandro Dalcin #if 0 13822999313aSBarry Smith #undef __FUNCT__ 13834a2ae208SSatish Balay #define __FUNCT__ "SNESPublish_Petsc" 13846849ba73SBarry Smith static PetscErrorCode SNESPublish_Petsc(PetscObject obj) 1385e24b481bSBarry Smith { 1386e24b481bSBarry Smith PetscFunctionBegin; 1387e24b481bSBarry Smith PetscFunctionReturn(0); 1388e24b481bSBarry Smith } 13897adad957SLisandro Dalcin #endif 1390e24b481bSBarry Smith 13919b94acceSBarry Smith /* -----------------------------------------------------------*/ 13924a2ae208SSatish Balay #undef __FUNCT__ 13934a2ae208SSatish Balay #define __FUNCT__ "SNESCreate" 139452baeb72SSatish Balay /*@ 13959b94acceSBarry Smith SNESCreate - Creates a nonlinear solver context. 13969b94acceSBarry Smith 1397c7afd0dbSLois Curfman McInnes Collective on MPI_Comm 1398c7afd0dbSLois Curfman McInnes 1399c7afd0dbSLois Curfman McInnes Input Parameters: 1400906ed7ccSBarry Smith . comm - MPI communicator 14019b94acceSBarry Smith 14029b94acceSBarry Smith Output Parameter: 14039b94acceSBarry Smith . outsnes - the new SNES context 14049b94acceSBarry Smith 1405c7afd0dbSLois Curfman McInnes Options Database Keys: 1406c7afd0dbSLois Curfman McInnes + -snes_mf - Activates default matrix-free Jacobian-vector products, 1407c7afd0dbSLois Curfman McInnes and no preconditioning matrix 1408c7afd0dbSLois Curfman McInnes . -snes_mf_operator - Activates default matrix-free Jacobian-vector 1409c7afd0dbSLois Curfman McInnes products, and a user-provided preconditioning matrix 1410c7afd0dbSLois Curfman McInnes as set by SNESSetJacobian() 1411c7afd0dbSLois Curfman McInnes - -snes_fd - Uses (slow!) finite differences to compute Jacobian 1412c1f60f51SBarry Smith 141336851e7fSLois Curfman McInnes Level: beginner 141436851e7fSLois Curfman McInnes 14159b94acceSBarry Smith .keywords: SNES, nonlinear, create, context 14169b94acceSBarry Smith 1417a8054027SBarry Smith .seealso: SNESSolve(), SNESDestroy(), SNES, SNESSetLagPreconditioner() 1418a8054027SBarry Smith 14199b94acceSBarry Smith @*/ 14207087cfbeSBarry Smith PetscErrorCode SNESCreate(MPI_Comm comm,SNES *outsnes) 14219b94acceSBarry Smith { 1422dfbe8321SBarry Smith PetscErrorCode ierr; 14239b94acceSBarry Smith SNES snes; 1424fa9f3622SBarry Smith SNESKSPEW *kctx; 142537fcc0dbSBarry Smith 14263a40ed3dSBarry Smith PetscFunctionBegin; 1427ed1caa07SMatthew Knepley PetscValidPointer(outsnes,2); 14280298fd71SBarry Smith *outsnes = NULL; 1429519f805aSKarl Rupp #if !defined(PETSC_USE_DYNAMIC_LIBRARIES) 14300298fd71SBarry Smith ierr = SNESInitializePackage(NULL);CHKERRQ(ierr); 14318ba1e511SMatthew Knepley #endif 14328ba1e511SMatthew Knepley 143367c2884eSBarry Smith ierr = PetscHeaderCreate(snes,_p_SNES,struct _SNESOps,SNES_CLASSID,"SNES","Nonlinear solver","SNES",comm,SNESDestroy,SNESView);CHKERRQ(ierr); 14347adad957SLisandro Dalcin 143585385478SLisandro Dalcin snes->ops->converged = SNESDefaultConverged; 14362c155ee1SBarry Smith snes->usesksp = PETSC_TRUE; 143788976e71SPeter Brune snes->tolerancesset = PETSC_FALSE; 14389b94acceSBarry Smith snes->max_its = 50; 14399750a799SBarry Smith snes->max_funcs = 10000; 14409b94acceSBarry Smith snes->norm = 0.0; 1441fdacfa88SPeter Brune snes->normtype = SNES_NORM_FUNCTION; 1442b4874afaSBarry Smith snes->rtol = 1.e-8; 1443b4874afaSBarry Smith snes->ttol = 0.0; 144470441072SBarry Smith snes->abstol = 1.e-50; 1445c60f73f4SPeter Brune snes->stol = 1.e-8; 14464b27c08aSLois Curfman McInnes snes->deltatol = 1.e-12; 14479b94acceSBarry Smith snes->nfuncs = 0; 144850ffb88aSMatthew Knepley snes->numFailures = 0; 144950ffb88aSMatthew Knepley snes->maxFailures = 1; 14507a00f4a9SLois Curfman McInnes snes->linear_its = 0; 1451e35cf81dSBarry Smith snes->lagjacobian = 1; 1452a8054027SBarry Smith snes->lagpreconditioner = 1; 1453639f9d9dSBarry Smith snes->numbermonitors = 0; 14549b94acceSBarry Smith snes->data = 0; 14554dc4c822SBarry Smith snes->setupcalled = PETSC_FALSE; 1456186905e3SBarry Smith snes->ksp_ewconv = PETSC_FALSE; 14576f24a144SLois Curfman McInnes snes->nwork = 0; 145858c9b817SLisandro Dalcin snes->work = 0; 145958c9b817SLisandro Dalcin snes->nvwork = 0; 146058c9b817SLisandro Dalcin snes->vwork = 0; 1461758f92a0SBarry Smith snes->conv_hist_len = 0; 1462758f92a0SBarry Smith snes->conv_hist_max = 0; 14630298fd71SBarry Smith snes->conv_hist = NULL; 14640298fd71SBarry Smith snes->conv_hist_its = NULL; 1465758f92a0SBarry Smith snes->conv_hist_reset = PETSC_TRUE; 1466e4ed7901SPeter Brune snes->vec_func_init_set = PETSC_FALSE; 1467e4ed7901SPeter Brune snes->norm_init = 0.; 1468e4ed7901SPeter Brune snes->norm_init_set = PETSC_FALSE; 1469184914b5SBarry Smith snes->reason = SNES_CONVERGED_ITERATING; 1470c40d0f55SPeter Brune snes->pcside = PC_RIGHT; 1471c40d0f55SPeter Brune 1472d8f46077SPeter Brune snes->mf = PETSC_FALSE; 1473d8f46077SPeter Brune snes->mf_operator = PETSC_FALSE; 1474d8f46077SPeter Brune snes->mf_version = 1; 1475d8f46077SPeter Brune 14763d4c4710SBarry Smith snes->numLinearSolveFailures = 0; 14773d4c4710SBarry Smith snes->maxLinearSolveFailures = 1; 14783d4c4710SBarry Smith 14799b94acceSBarry Smith /* Create context to compute Eisenstat-Walker relative tolerance for KSP */ 148038f2d2fdSLisandro Dalcin ierr = PetscNewLog(snes,SNESKSPEW,&kctx);CHKERRQ(ierr); 1481f5af7f23SKarl Rupp 14829b94acceSBarry Smith snes->kspconvctx = (void*)kctx; 14839b94acceSBarry Smith kctx->version = 2; 14849b94acceSBarry Smith kctx->rtol_0 = .3; /* Eisenstat and Walker suggest rtol_0=.5, but 14859b94acceSBarry Smith this was too large for some test cases */ 148675567043SBarry Smith kctx->rtol_last = 0.0; 14879b94acceSBarry Smith kctx->rtol_max = .9; 14889b94acceSBarry Smith kctx->gamma = 1.0; 148962d1f40fSBarry Smith kctx->alpha = .5*(1.0 + PetscSqrtReal(5.0)); 149071f87433Sdalcinl kctx->alpha2 = kctx->alpha; 14919b94acceSBarry Smith kctx->threshold = .1; 149275567043SBarry Smith kctx->lresid_last = 0.0; 149375567043SBarry Smith kctx->norm_last = 0.0; 14949b94acceSBarry Smith 14959b94acceSBarry Smith *outsnes = snes; 14963a40ed3dSBarry Smith PetscFunctionReturn(0); 14979b94acceSBarry Smith } 14989b94acceSBarry Smith 149988f0584fSBarry Smith /*MC 150018e2ec27SBarry Smith SNESFunction - functional form used to convey the nonlinear function to be solved by SNES 150188f0584fSBarry Smith 150288f0584fSBarry Smith Synopsis: 1503f2ba6396SBarry Smith #include "petscsnes.h" 150488f0584fSBarry Smith SNESFunction(SNES snes,Vec x,Vec f,void *ctx); 150588f0584fSBarry Smith 150688f0584fSBarry Smith Input Parameters: 150788f0584fSBarry Smith + snes - the SNES context 150888f0584fSBarry Smith . x - state at which to evaluate residual 150988f0584fSBarry Smith - ctx - optional user-defined function context, passed in with SNESSetFunction() 151088f0584fSBarry Smith 151188f0584fSBarry Smith Output Parameter: 151288f0584fSBarry Smith . f - vector to put residual (function value) 151388f0584fSBarry Smith 151488f0584fSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction() 151588f0584fSBarry Smith M*/ 151688f0584fSBarry Smith 15174a2ae208SSatish Balay #undef __FUNCT__ 15184a2ae208SSatish Balay #define __FUNCT__ "SNESSetFunction" 15199b94acceSBarry Smith /*@C 15209b94acceSBarry Smith SNESSetFunction - Sets the function evaluation routine and function 15219b94acceSBarry Smith vector for use by the SNES routines in solving systems of nonlinear 15229b94acceSBarry Smith equations. 15239b94acceSBarry Smith 15243f9fe445SBarry Smith Logically Collective on SNES 1525fee21e36SBarry Smith 1526c7afd0dbSLois Curfman McInnes Input Parameters: 1527c7afd0dbSLois Curfman McInnes + snes - the SNES context 1528c7afd0dbSLois Curfman McInnes . r - vector to store function value 152988f0584fSBarry Smith . SNESFunction - function evaluation routine 1530c7afd0dbSLois Curfman McInnes - ctx - [optional] user-defined context for private data for the 15310298fd71SBarry Smith function evaluation routine (may be NULL) 15329b94acceSBarry Smith 15339b94acceSBarry Smith Notes: 15349b94acceSBarry Smith The Newton-like methods typically solve linear systems of the form 15359b94acceSBarry Smith $ f'(x) x = -f(x), 1536c7afd0dbSLois Curfman McInnes where f'(x) denotes the Jacobian matrix and f(x) is the function. 15379b94acceSBarry Smith 153836851e7fSLois Curfman McInnes Level: beginner 153936851e7fSLois Curfman McInnes 15409b94acceSBarry Smith .keywords: SNES, nonlinear, set, function 15419b94acceSBarry Smith 1542bf388a1fSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetPicard(), SNESFunction 15439b94acceSBarry Smith @*/ 154488f0584fSBarry Smith PetscErrorCode SNESSetFunction(SNES snes,Vec r,PetscErrorCode (*SNESFunction)(SNES,Vec,Vec,void*),void *ctx) 15459b94acceSBarry Smith { 154685385478SLisandro Dalcin PetscErrorCode ierr; 15476cab3a1bSJed Brown DM dm; 15486cab3a1bSJed Brown 15493a40ed3dSBarry Smith PetscFunctionBegin; 15500700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1551d2a683ecSLisandro Dalcin if (r) { 1552d2a683ecSLisandro Dalcin PetscValidHeaderSpecific(r,VEC_CLASSID,2); 1553d2a683ecSLisandro Dalcin PetscCheckSameComm(snes,1,r,2); 155485385478SLisandro Dalcin ierr = PetscObjectReference((PetscObject)r);CHKERRQ(ierr); 15556bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr); 1556f5af7f23SKarl Rupp 155785385478SLisandro Dalcin snes->vec_func = r; 1558d2a683ecSLisandro Dalcin } 15596cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 156088f0584fSBarry Smith ierr = DMSNESSetFunction(dm,SNESFunction,ctx);CHKERRQ(ierr); 15613a40ed3dSBarry Smith PetscFunctionReturn(0); 15629b94acceSBarry Smith } 15639b94acceSBarry Smith 1564646217ecSPeter Brune 1565646217ecSPeter Brune #undef __FUNCT__ 1566e4ed7901SPeter Brune #define __FUNCT__ "SNESSetInitialFunction" 1567e4ed7901SPeter Brune /*@C 1568e4ed7901SPeter Brune SNESSetInitialFunction - Sets the function vector to be used as the 1569e4ed7901SPeter Brune function norm at the initialization of the method. In some 1570e4ed7901SPeter Brune instances, the user has precomputed the function before calling 1571e4ed7901SPeter Brune SNESSolve. This function allows one to avoid a redundant call 1572e4ed7901SPeter Brune to SNESComputeFunction in that case. 1573e4ed7901SPeter Brune 1574e4ed7901SPeter Brune Logically Collective on SNES 1575e4ed7901SPeter Brune 1576e4ed7901SPeter Brune Input Parameters: 1577e4ed7901SPeter Brune + snes - the SNES context 1578e4ed7901SPeter Brune - f - vector to store function value 1579e4ed7901SPeter Brune 1580e4ed7901SPeter Brune Notes: 1581e4ed7901SPeter Brune This should not be modified during the solution procedure. 1582e4ed7901SPeter Brune 1583e4ed7901SPeter Brune This is used extensively in the SNESFAS hierarchy and in nonlinear preconditioning. 1584e4ed7901SPeter Brune 1585e4ed7901SPeter Brune Level: developer 1586e4ed7901SPeter Brune 1587e4ed7901SPeter Brune .keywords: SNES, nonlinear, set, function 1588e4ed7901SPeter Brune 1589e4ed7901SPeter Brune .seealso: SNESSetFunction(), SNESComputeFunction(), SNESSetInitialFunctionNorm() 1590e4ed7901SPeter Brune @*/ 1591e4ed7901SPeter Brune PetscErrorCode SNESSetInitialFunction(SNES snes, Vec f) 1592e4ed7901SPeter Brune { 1593e4ed7901SPeter Brune PetscErrorCode ierr; 1594e4ed7901SPeter Brune Vec vec_func; 1595e4ed7901SPeter Brune 1596e4ed7901SPeter Brune PetscFunctionBegin; 1597e4ed7901SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1598e4ed7901SPeter Brune PetscValidHeaderSpecific(f,VEC_CLASSID,2); 1599e4ed7901SPeter Brune PetscCheckSameComm(snes,1,f,2); 16000298fd71SBarry Smith ierr = SNESGetFunction(snes,&vec_func,NULL,NULL);CHKERRQ(ierr); 1601e4ed7901SPeter Brune ierr = VecCopy(f, vec_func);CHKERRQ(ierr); 1602f5af7f23SKarl Rupp 1603217b9c2eSPeter Brune snes->vec_func_init_set = PETSC_TRUE; 1604e4ed7901SPeter Brune PetscFunctionReturn(0); 1605e4ed7901SPeter Brune } 1606e4ed7901SPeter Brune 1607e4ed7901SPeter Brune 1608e4ed7901SPeter Brune #undef __FUNCT__ 1609e4ed7901SPeter Brune #define __FUNCT__ "SNESSetInitialFunctionNorm" 1610e4ed7901SPeter Brune /*@C 1611e4ed7901SPeter Brune SNESSetInitialFunctionNorm - Sets the function norm to be used as the function norm 1612e4ed7901SPeter Brune at the initialization of the method. In some instances, the user has precomputed 1613e4ed7901SPeter Brune the function and its norm before calling SNESSolve. This function allows one to 1614e4ed7901SPeter Brune avoid a redundant call to SNESComputeFunction() and VecNorm() in that case. 1615e4ed7901SPeter Brune 1616e4ed7901SPeter Brune Logically Collective on SNES 1617e4ed7901SPeter Brune 1618e4ed7901SPeter Brune Input Parameters: 1619e4ed7901SPeter Brune + snes - the SNES context 1620e4ed7901SPeter Brune - fnorm - the norm of F as set by SNESSetInitialFunction() 1621e4ed7901SPeter Brune 1622e4ed7901SPeter Brune This is used extensively in the SNESFAS hierarchy and in nonlinear preconditioning. 1623e4ed7901SPeter Brune 1624e4ed7901SPeter Brune Level: developer 1625e4ed7901SPeter Brune 1626e4ed7901SPeter Brune .keywords: SNES, nonlinear, set, function, norm 1627e4ed7901SPeter Brune 1628e4ed7901SPeter Brune .seealso: SNESSetFunction(), SNESComputeFunction(), SNESSetInitialFunction() 1629e4ed7901SPeter Brune @*/ 1630e4ed7901SPeter Brune PetscErrorCode SNESSetInitialFunctionNorm(SNES snes, PetscReal fnorm) 1631e4ed7901SPeter Brune { 1632e4ed7901SPeter Brune PetscFunctionBegin; 1633e4ed7901SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1634e4ed7901SPeter Brune snes->norm_init = fnorm; 1635e4ed7901SPeter Brune snes->norm_init_set = PETSC_TRUE; 1636e4ed7901SPeter Brune PetscFunctionReturn(0); 1637e4ed7901SPeter Brune } 1638e4ed7901SPeter Brune 1639e4ed7901SPeter Brune #undef __FUNCT__ 1640534ebe21SPeter Brune #define __FUNCT__ "SNESSetNormType" 1641534ebe21SPeter Brune /*@ 1642534ebe21SPeter Brune SNESSetNormType - Sets the SNESNormType used in covergence and monitoring 1643534ebe21SPeter Brune of the SNES method. 1644534ebe21SPeter Brune 1645534ebe21SPeter Brune Logically Collective on SNES 1646534ebe21SPeter Brune 1647534ebe21SPeter Brune Input Parameters: 1648534ebe21SPeter Brune + snes - the SNES context 1649534ebe21SPeter Brune - normtype - the type of the norm used 1650534ebe21SPeter Brune 1651534ebe21SPeter Brune Notes: 1652534ebe21SPeter Brune Only certain SNES methods support certain SNESNormTypes. Most require evaluation 1653534ebe21SPeter Brune of the nonlinear function and the taking of its norm at every iteration to 1654534ebe21SPeter Brune even ensure convergence at all. However, methods such as custom Gauss-Seidel methods 1655534ebe21SPeter Brune (SNESGS) and the like do not require the norm of the function to be computed, and therfore 1656534ebe21SPeter Brune may either be monitored for convergence or not. As these are often used as nonlinear 1657534ebe21SPeter Brune preconditioners, monitoring the norm of their error is not a useful enterprise within 1658534ebe21SPeter Brune their solution. 1659534ebe21SPeter Brune 1660534ebe21SPeter Brune Level: developer 1661534ebe21SPeter Brune 1662534ebe21SPeter Brune .keywords: SNES, nonlinear, set, function, norm, type 1663534ebe21SPeter Brune 1664534ebe21SPeter Brune .seealso: SNESGetNormType(), SNESComputeFunction(), VecNorm(), SNESSetFunction(), SNESSetInitialFunction(), SNESNormType 1665534ebe21SPeter Brune @*/ 1666534ebe21SPeter Brune PetscErrorCode SNESSetNormType(SNES snes, SNESNormType normtype) 1667534ebe21SPeter Brune { 1668534ebe21SPeter Brune PetscFunctionBegin; 1669534ebe21SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1670534ebe21SPeter Brune snes->normtype = normtype; 1671534ebe21SPeter Brune PetscFunctionReturn(0); 1672534ebe21SPeter Brune } 1673534ebe21SPeter Brune 1674534ebe21SPeter Brune 1675534ebe21SPeter Brune #undef __FUNCT__ 1676534ebe21SPeter Brune #define __FUNCT__ "SNESGetNormType" 1677534ebe21SPeter Brune /*@ 1678534ebe21SPeter Brune SNESGetNormType - Gets the SNESNormType used in covergence and monitoring 1679534ebe21SPeter Brune of the SNES method. 1680534ebe21SPeter Brune 1681534ebe21SPeter Brune Logically Collective on SNES 1682534ebe21SPeter Brune 1683534ebe21SPeter Brune Input Parameters: 1684534ebe21SPeter Brune + snes - the SNES context 1685534ebe21SPeter Brune - normtype - the type of the norm used 1686534ebe21SPeter Brune 1687534ebe21SPeter Brune Level: advanced 1688534ebe21SPeter Brune 1689534ebe21SPeter Brune .keywords: SNES, nonlinear, set, function, norm, type 1690534ebe21SPeter Brune 1691534ebe21SPeter Brune .seealso: SNESSetNormType(), SNESComputeFunction(), VecNorm(), SNESSetFunction(), SNESSetInitialFunction(), SNESNormType 1692534ebe21SPeter Brune @*/ 1693534ebe21SPeter Brune PetscErrorCode SNESGetNormType(SNES snes, SNESNormType *normtype) 1694534ebe21SPeter Brune { 1695534ebe21SPeter Brune PetscFunctionBegin; 1696534ebe21SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1697534ebe21SPeter Brune *normtype = snes->normtype; 1698534ebe21SPeter Brune PetscFunctionReturn(0); 1699534ebe21SPeter Brune } 1700534ebe21SPeter Brune 1701bf388a1fSBarry Smith /*MC 1702bf388a1fSBarry Smith SNESGSFunction - function used to convey a Gauss-Seidel sweep on the nonlinear function 1703bf388a1fSBarry Smith 1704bf388a1fSBarry Smith Synopsis: 1705bf388a1fSBarry Smith #include "petscsnes.h" 1706bf388a1fSBarry Smith $ SNESGSFunction(SNES snes,Vec x,Vec b,void *ctx); 1707bf388a1fSBarry Smith 1708bf388a1fSBarry Smith + X - solution vector 1709bf388a1fSBarry Smith . B - RHS vector 1710bf388a1fSBarry Smith - ctx - optional user-defined Gauss-Seidel context 1711bf388a1fSBarry Smith 1712bf388a1fSBarry Smith .seealso: SNESSetGS(), SNESGetGS() 1713bf388a1fSBarry Smith M*/ 1714bf388a1fSBarry Smith 1715534ebe21SPeter Brune #undef __FUNCT__ 1716646217ecSPeter Brune #define __FUNCT__ "SNESSetGS" 1717c79ef259SPeter Brune /*@C 1718c79ef259SPeter Brune SNESSetGS - Sets the user nonlinear Gauss-Seidel routine for 1719c79ef259SPeter Brune use with composed nonlinear solvers. 1720c79ef259SPeter Brune 1721c79ef259SPeter Brune Input Parameters: 1722c79ef259SPeter Brune + snes - the SNES context 1723bf388a1fSBarry Smith . SNESGSFunction - function evaluation routine 1724c79ef259SPeter Brune - ctx - [optional] user-defined context for private data for the 17250298fd71SBarry Smith smoother evaluation routine (may be NULL) 1726c79ef259SPeter Brune 1727c79ef259SPeter Brune Notes: 1728c79ef259SPeter Brune The GS routines are used by the composed nonlinear solver to generate 1729c79ef259SPeter Brune a problem appropriate update to the solution, particularly FAS. 1730c79ef259SPeter Brune 1731d28543b3SPeter Brune Level: intermediate 1732c79ef259SPeter Brune 1733d28543b3SPeter Brune .keywords: SNES, nonlinear, set, Gauss-Seidel 1734c79ef259SPeter Brune 1735c79ef259SPeter Brune .seealso: SNESGetFunction(), SNESComputeGS() 1736c79ef259SPeter Brune @*/ 1737bf388a1fSBarry Smith PetscErrorCode SNESSetGS(SNES snes,PetscErrorCode (*SNESGSFunction)(SNES,Vec,Vec,void*),void *ctx) 17386cab3a1bSJed Brown { 17396cab3a1bSJed Brown PetscErrorCode ierr; 17406cab3a1bSJed Brown DM dm; 17416cab3a1bSJed Brown 1742646217ecSPeter Brune PetscFunctionBegin; 17436cab3a1bSJed Brown PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 17446cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 1745bf388a1fSBarry Smith ierr = DMSNESSetGS(dm,SNESGSFunction,ctx);CHKERRQ(ierr); 1746646217ecSPeter Brune PetscFunctionReturn(0); 1747646217ecSPeter Brune } 1748646217ecSPeter Brune 1749d25893d9SBarry Smith #undef __FUNCT__ 17508b0a5094SBarry Smith #define __FUNCT__ "SNESPicardComputeFunction" 17518b0a5094SBarry Smith PetscErrorCode SNESPicardComputeFunction(SNES snes,Vec x,Vec f,void *ctx) 17528b0a5094SBarry Smith { 17538b0a5094SBarry Smith PetscErrorCode ierr; 1754e03ab78fSPeter Brune DM dm; 1755942e3340SBarry Smith DMSNES sdm; 17566cab3a1bSJed Brown 17578b0a5094SBarry Smith PetscFunctionBegin; 1758e03ab78fSPeter Brune ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 1759942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 17608b0a5094SBarry Smith /* A(x)*x - b(x) */ 176122c6f798SBarry Smith if (sdm->ops->computepfunction) { 176222c6f798SBarry Smith ierr = (*sdm->ops->computepfunction)(snes,x,f,sdm->pctx);CHKERRQ(ierr); 176322c6f798SBarry Smith } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetPicard() to provide Picard function."); 1764e03ab78fSPeter Brune 176522c6f798SBarry Smith if (sdm->ops->computepjacobian) { 176622c6f798SBarry Smith ierr = (*sdm->ops->computepjacobian)(snes,x,&snes->jacobian,&snes->jacobian_pre,&snes->matstruct,sdm->pctx);CHKERRQ(ierr); 176774e1e8c1SBarry Smith } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetPicard() to provide Picard matrix."); 17688b0a5094SBarry Smith ierr = VecScale(f,-1.0);CHKERRQ(ierr); 176995eabcedSBarry Smith ierr = MatMultAdd(snes->jacobian,x,f,f);CHKERRQ(ierr); 17708b0a5094SBarry Smith PetscFunctionReturn(0); 17718b0a5094SBarry Smith } 17728b0a5094SBarry Smith 17738b0a5094SBarry Smith #undef __FUNCT__ 17748b0a5094SBarry Smith #define __FUNCT__ "SNESPicardComputeJacobian" 17758b0a5094SBarry Smith PetscErrorCode SNESPicardComputeJacobian(SNES snes,Vec x1,Mat *J,Mat *B,MatStructure *flag,void *ctx) 17768b0a5094SBarry Smith { 17778b0a5094SBarry Smith PetscFunctionBegin; 1778e03ab78fSPeter Brune /* the jacobian matrix should be pre-filled in SNESPicardComputeFunction */ 17798b0a5094SBarry Smith *flag = snes->matstruct; 17808b0a5094SBarry Smith PetscFunctionReturn(0); 17818b0a5094SBarry Smith } 17828b0a5094SBarry Smith 17838b0a5094SBarry Smith #undef __FUNCT__ 17848b0a5094SBarry Smith #define __FUNCT__ "SNESSetPicard" 17858b0a5094SBarry Smith /*@C 17860d04baf8SBarry Smith SNESSetPicard - Use SNES to solve the semilinear-system A(x) x = b(x) via a Picard type iteration (Picard linearization) 17878b0a5094SBarry Smith 17888b0a5094SBarry Smith Logically Collective on SNES 17898b0a5094SBarry Smith 17908b0a5094SBarry Smith Input Parameters: 17918b0a5094SBarry Smith + snes - the SNES context 17928b0a5094SBarry Smith . r - vector to store function value 1793bf388a1fSBarry Smith . SNESFunction - function evaluation routine 1794f450aa47SBarry Smith . jmat - normally the same as mat but you can pass another matrix for which you compute A(x) x - b(x) (see jmat below) 17958b0a5094SBarry Smith . mat - matrix to store A 1796bf388a1fSBarry Smith . SNESJacobianFunction - function to compute matrix value 17978b0a5094SBarry Smith - ctx - [optional] user-defined context for private data for the 17980298fd71SBarry Smith function evaluation routine (may be NULL) 17998b0a5094SBarry Smith 18008b0a5094SBarry Smith Notes: 1801f450aa47SBarry Smith We do not recomemend using this routine. It is far better to provide the nonlinear function F() and some approximation to the Jacobian and use 1802f450aa47SBarry Smith an approximate Newton solver. This interface is provided to allow porting/testing a previous Picard based code in PETSc before converting it to approximate Newton. 1803f450aa47SBarry Smith 18048b0a5094SBarry Smith One can call SNESSetPicard() or SNESSetFunction() (and possibly SNESSetJacobian()) but cannot call both 18058b0a5094SBarry Smith 18068b0a5094SBarry Smith $ Solves the equation A(x) x = b(x) via the defect correction algorithm A(x^{n}) (x^{n+1} - x^{n}) = b(x^{n}) - A(x^{n})x^{n} 18078b0a5094SBarry Smith $ Note that when an exact solver is used this corresponds to the "classic" Picard A(x^{n}) x^{n+1} = b(x^{n}) iteration. 18088b0a5094SBarry Smith 18098b0a5094SBarry Smith Run with -snes_mf_operator to solve the system with Newton's method using A(x^{n}) to construct the preconditioner. 18108b0a5094SBarry Smith 18110d04baf8SBarry Smith We implement the defect correction form of the Picard iteration because it converges much more generally when inexact linear solvers are used then 18120d04baf8SBarry Smith the direct Picard iteration A(x^n) x^{n+1} = b(x^n) 18138b0a5094SBarry Smith 18148b0a5094SBarry Smith There is some controversity over the definition of a Picard iteration for nonlinear systems but almost everyone agrees that it involves a linear solve and some 18158b0a5094SBarry Smith believe it is the iteration A(x^{n}) x^{n+1} = b(x^{n}) hence we use the name Picard. If anyone has an authoritative reference that defines the Picard iteration 18168b0a5094SBarry Smith different please contact us at petsc-dev@mcs.anl.gov and we'll have an entirely new argument :-). 18178b0a5094SBarry Smith 1818f450aa47SBarry Smith Level: intermediate 18198b0a5094SBarry Smith 18208b0a5094SBarry Smith .keywords: SNES, nonlinear, set, function 18218b0a5094SBarry Smith 18220d04baf8SBarry Smith .seealso: SNESGetFunction(), SNESSetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESGetPicard(), SNESLineSearchPreCheckPicard() 18238b0a5094SBarry Smith @*/ 1824bf388a1fSBarry Smith PetscErrorCode SNESSetPicard(SNES snes,Vec r,PetscErrorCode (*SNESFunction)(SNES,Vec,Vec,void*),Mat jmat, Mat mat, PetscErrorCode (*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx) 18258b0a5094SBarry Smith { 18268b0a5094SBarry Smith PetscErrorCode ierr; 1827e03ab78fSPeter Brune DM dm; 1828e03ab78fSPeter Brune 18298b0a5094SBarry Smith PetscFunctionBegin; 18308b0a5094SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1831e03ab78fSPeter Brune ierr = SNESGetDM(snes, &dm);CHKERRQ(ierr); 1832bf388a1fSBarry Smith ierr = DMSNESSetPicard(dm,SNESFunction,SNESJacobianFunction,ctx);CHKERRQ(ierr); 18338b0a5094SBarry Smith ierr = SNESSetFunction(snes,r,SNESPicardComputeFunction,ctx);CHKERRQ(ierr); 18348b0a5094SBarry Smith ierr = SNESSetJacobian(snes,jmat,mat,SNESPicardComputeJacobian,ctx);CHKERRQ(ierr); 18358b0a5094SBarry Smith PetscFunctionReturn(0); 18368b0a5094SBarry Smith } 18378b0a5094SBarry Smith 18387971a8bfSPeter Brune #undef __FUNCT__ 18397971a8bfSPeter Brune #define __FUNCT__ "SNESGetPicard" 18407971a8bfSPeter Brune /*@C 18417971a8bfSPeter Brune SNESGetPicard - Returns the context for the Picard iteration 18427971a8bfSPeter Brune 18437971a8bfSPeter Brune Not Collective, but Vec is parallel if SNES is parallel. Collective if Vec is requested, but has not been created yet. 18447971a8bfSPeter Brune 18457971a8bfSPeter Brune Input Parameter: 18467971a8bfSPeter Brune . snes - the SNES context 18477971a8bfSPeter Brune 18487971a8bfSPeter Brune Output Parameter: 18490298fd71SBarry Smith + r - the function (or NULL) 18500298fd71SBarry Smith . SNESFunction - the function (or NULL) 18510298fd71SBarry Smith . jmat - the picard matrix (or NULL) 18520298fd71SBarry Smith . mat - the picard preconditioner matrix (or NULL) 18530298fd71SBarry Smith . SNESJacobianFunction - the function for matrix evaluation (or NULL) 18540298fd71SBarry Smith - ctx - the function context (or NULL) 18557971a8bfSPeter Brune 18567971a8bfSPeter Brune Level: advanced 18577971a8bfSPeter Brune 18587971a8bfSPeter Brune .keywords: SNES, nonlinear, get, function 18597971a8bfSPeter Brune 1860bf388a1fSBarry Smith .seealso: SNESSetPicard, SNESGetFunction, SNESGetJacobian, SNESGetDM, SNESFunction, SNESJacobianFunction 18617971a8bfSPeter Brune @*/ 1862bf388a1fSBarry Smith PetscErrorCode SNESGetPicard(SNES snes,Vec *r,PetscErrorCode (**SNESFunction)(SNES,Vec,Vec,void*),Mat *jmat, Mat *mat, PetscErrorCode (**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx) 18637971a8bfSPeter Brune { 18647971a8bfSPeter Brune PetscErrorCode ierr; 18657971a8bfSPeter Brune DM dm; 18667971a8bfSPeter Brune 18677971a8bfSPeter Brune PetscFunctionBegin; 18687971a8bfSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 18690298fd71SBarry Smith ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr); 18700298fd71SBarry Smith ierr = SNESGetJacobian(snes,jmat,mat,NULL,NULL);CHKERRQ(ierr); 18717971a8bfSPeter Brune ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 1872bf388a1fSBarry Smith ierr = DMSNESGetPicard(dm,SNESFunction,SNESJacobianFunction,ctx);CHKERRQ(ierr); 18737971a8bfSPeter Brune PetscFunctionReturn(0); 18747971a8bfSPeter Brune } 18757971a8bfSPeter Brune 18768b0a5094SBarry Smith #undef __FUNCT__ 1877d25893d9SBarry Smith #define __FUNCT__ "SNESSetComputeInitialGuess" 1878d25893d9SBarry Smith /*@C 1879d25893d9SBarry Smith SNESSetComputeInitialGuess - Sets a routine used to compute an initial guess for the problem 1880d25893d9SBarry Smith 1881d25893d9SBarry Smith Logically Collective on SNES 1882d25893d9SBarry Smith 1883d25893d9SBarry Smith Input Parameters: 1884d25893d9SBarry Smith + snes - the SNES context 1885d25893d9SBarry Smith . func - function evaluation routine 1886d25893d9SBarry Smith - ctx - [optional] user-defined context for private data for the 18870298fd71SBarry Smith function evaluation routine (may be NULL) 1888d25893d9SBarry Smith 1889d25893d9SBarry Smith Calling sequence of func: 1890d25893d9SBarry Smith $ func (SNES snes,Vec x,void *ctx); 1891d25893d9SBarry Smith 1892d25893d9SBarry Smith . f - function vector 1893d25893d9SBarry Smith - ctx - optional user-defined function context 1894d25893d9SBarry Smith 1895d25893d9SBarry Smith Level: intermediate 1896d25893d9SBarry Smith 1897d25893d9SBarry Smith .keywords: SNES, nonlinear, set, function 1898d25893d9SBarry Smith 1899d25893d9SBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian() 1900d25893d9SBarry Smith @*/ 1901d25893d9SBarry Smith PetscErrorCode SNESSetComputeInitialGuess(SNES snes,PetscErrorCode (*func)(SNES,Vec,void*),void *ctx) 1902d25893d9SBarry Smith { 1903d25893d9SBarry Smith PetscFunctionBegin; 1904d25893d9SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 1905d25893d9SBarry Smith if (func) snes->ops->computeinitialguess = func; 1906d25893d9SBarry Smith if (ctx) snes->initialguessP = ctx; 1907d25893d9SBarry Smith PetscFunctionReturn(0); 1908d25893d9SBarry Smith } 1909d25893d9SBarry Smith 19103ab0aad5SBarry Smith /* --------------------------------------------------------------- */ 19113ab0aad5SBarry Smith #undef __FUNCT__ 19121096aae1SMatthew Knepley #define __FUNCT__ "SNESGetRhs" 19131096aae1SMatthew Knepley /*@C 19141096aae1SMatthew Knepley SNESGetRhs - Gets the vector for solving F(x) = rhs. If rhs is not set 19151096aae1SMatthew Knepley it assumes a zero right hand side. 19161096aae1SMatthew Knepley 19173f9fe445SBarry Smith Logically Collective on SNES 19181096aae1SMatthew Knepley 19191096aae1SMatthew Knepley Input Parameter: 19201096aae1SMatthew Knepley . snes - the SNES context 19211096aae1SMatthew Knepley 19221096aae1SMatthew Knepley Output Parameter: 19230298fd71SBarry Smith . rhs - the right hand side vector or NULL if the right hand side vector is null 19241096aae1SMatthew Knepley 19251096aae1SMatthew Knepley Level: intermediate 19261096aae1SMatthew Knepley 19271096aae1SMatthew Knepley .keywords: SNES, nonlinear, get, function, right hand side 19281096aae1SMatthew Knepley 192985385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction() 19301096aae1SMatthew Knepley @*/ 19317087cfbeSBarry Smith PetscErrorCode SNESGetRhs(SNES snes,Vec *rhs) 19321096aae1SMatthew Knepley { 19331096aae1SMatthew Knepley PetscFunctionBegin; 19340700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 19351096aae1SMatthew Knepley PetscValidPointer(rhs,2); 193685385478SLisandro Dalcin *rhs = snes->vec_rhs; 19371096aae1SMatthew Knepley PetscFunctionReturn(0); 19381096aae1SMatthew Knepley } 19391096aae1SMatthew Knepley 19401096aae1SMatthew Knepley #undef __FUNCT__ 19414a2ae208SSatish Balay #define __FUNCT__ "SNESComputeFunction" 19429b94acceSBarry Smith /*@ 1943bf388a1fSBarry Smith SNESComputeFunction - Calls the function that has been set with SNESSetFunction(). 19449b94acceSBarry Smith 1945c7afd0dbSLois Curfman McInnes Collective on SNES 1946c7afd0dbSLois Curfman McInnes 19479b94acceSBarry Smith Input Parameters: 1948c7afd0dbSLois Curfman McInnes + snes - the SNES context 1949c7afd0dbSLois Curfman McInnes - x - input vector 19509b94acceSBarry Smith 19519b94acceSBarry Smith Output Parameter: 19523638b69dSLois Curfman McInnes . y - function vector, as set by SNESSetFunction() 19539b94acceSBarry Smith 19541bffabb2SLois Curfman McInnes Notes: 195536851e7fSLois Curfman McInnes SNESComputeFunction() is typically used within nonlinear solvers 195636851e7fSLois Curfman McInnes implementations, so most users would not generally call this routine 195736851e7fSLois Curfman McInnes themselves. 195836851e7fSLois Curfman McInnes 195936851e7fSLois Curfman McInnes Level: developer 196036851e7fSLois Curfman McInnes 19619b94acceSBarry Smith .keywords: SNES, nonlinear, compute, function 19629b94acceSBarry Smith 1963a86d99e1SLois Curfman McInnes .seealso: SNESSetFunction(), SNESGetFunction() 19649b94acceSBarry Smith @*/ 19657087cfbeSBarry Smith PetscErrorCode SNESComputeFunction(SNES snes,Vec x,Vec y) 19669b94acceSBarry Smith { 1967dfbe8321SBarry Smith PetscErrorCode ierr; 19686cab3a1bSJed Brown DM dm; 1969942e3340SBarry Smith DMSNES sdm; 19709b94acceSBarry Smith 19713a40ed3dSBarry Smith PetscFunctionBegin; 19720700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 19730700a824SBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,2); 19740700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 1975c9780b6fSBarry Smith PetscCheckSameComm(snes,1,x,2); 1976c9780b6fSBarry Smith PetscCheckSameComm(snes,1,y,3); 19774ec14c9cSBarry Smith VecValidValues(x,2,PETSC_TRUE); 1978184914b5SBarry Smith 19796cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 1980942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 1981c40d0f55SPeter Brune if (snes->pc && snes->pcside == PC_LEFT) { 1982c40d0f55SPeter Brune ierr = VecCopy(x,y);CHKERRQ(ierr); 198363e7833aSPeter Brune ierr = PetscLogEventBegin(SNES_NPCSolve,snes->pc,x,y,0);CHKERRQ(ierr); 1984c40d0f55SPeter Brune ierr = SNESSolve(snes->pc,snes->vec_rhs,y);CHKERRQ(ierr); 198563e7833aSPeter Brune ierr = PetscLogEventEnd(SNES_NPCSolve,snes->pc,x,y,0);CHKERRQ(ierr); 1986c40d0f55SPeter Brune ierr = VecAYPX(y,-1.0,x);CHKERRQ(ierr); 198722c6f798SBarry Smith } else if (sdm->ops->computefunction) { 1988ccf3c845SPeter Brune ierr = PetscLogEventBegin(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr); 1989d64ed03dSBarry Smith PetscStackPush("SNES user function"); 199022c6f798SBarry Smith ierr = (*sdm->ops->computefunction)(snes,x,y,sdm->functionctx);CHKERRQ(ierr); 1991d64ed03dSBarry Smith PetscStackPop; 1992ccf3c845SPeter Brune ierr = PetscLogEventEnd(SNES_FunctionEval,snes,x,y,0);CHKERRQ(ierr); 1993c90fad12SPeter Brune } else if (snes->vec_rhs) { 1994c90fad12SPeter Brune ierr = MatMult(snes->jacobian, x, y);CHKERRQ(ierr); 1995644e2e5bSBarry Smith } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetFunction() or SNESSetDM() before SNESComputeFunction(), likely called from SNESSolve()."); 199685385478SLisandro Dalcin if (snes->vec_rhs) { 199785385478SLisandro Dalcin ierr = VecAXPY(y,-1.0,snes->vec_rhs);CHKERRQ(ierr); 19983ab0aad5SBarry Smith } 1999ae3c334cSLois Curfman McInnes snes->nfuncs++; 20004ec14c9cSBarry Smith VecValidValues(y,3,PETSC_FALSE); 20013a40ed3dSBarry Smith PetscFunctionReturn(0); 20029b94acceSBarry Smith } 20039b94acceSBarry Smith 20044a2ae208SSatish Balay #undef __FUNCT__ 2005646217ecSPeter Brune #define __FUNCT__ "SNESComputeGS" 2006c79ef259SPeter Brune /*@ 2007bf388a1fSBarry Smith SNESComputeGS - Calls the Gauss-Seidel function that has been set with SNESSetGS(). 2008c79ef259SPeter Brune 2009c79ef259SPeter Brune Collective on SNES 2010c79ef259SPeter Brune 2011c79ef259SPeter Brune Input Parameters: 2012c79ef259SPeter Brune + snes - the SNES context 2013c79ef259SPeter Brune . x - input vector 2014c79ef259SPeter Brune - b - rhs vector 2015c79ef259SPeter Brune 2016c79ef259SPeter Brune Output Parameter: 2017c79ef259SPeter Brune . x - new solution vector 2018c79ef259SPeter Brune 2019c79ef259SPeter Brune Notes: 2020c79ef259SPeter Brune SNESComputeGS() is typically used within composed nonlinear solver 2021c79ef259SPeter Brune implementations, so most users would not generally call this routine 2022c79ef259SPeter Brune themselves. 2023c79ef259SPeter Brune 2024c79ef259SPeter Brune Level: developer 2025c79ef259SPeter Brune 2026c79ef259SPeter Brune .keywords: SNES, nonlinear, compute, function 2027c79ef259SPeter Brune 2028c79ef259SPeter Brune .seealso: SNESSetGS(), SNESComputeFunction() 2029c79ef259SPeter Brune @*/ 2030646217ecSPeter Brune PetscErrorCode SNESComputeGS(SNES snes,Vec b,Vec x) 2031646217ecSPeter Brune { 2032646217ecSPeter Brune PetscErrorCode ierr; 20336cab3a1bSJed Brown DM dm; 2034942e3340SBarry Smith DMSNES sdm; 2035646217ecSPeter Brune 2036646217ecSPeter Brune PetscFunctionBegin; 2037646217ecSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2038646217ecSPeter Brune PetscValidHeaderSpecific(x,VEC_CLASSID,2); 2039646217ecSPeter Brune if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,3); 2040646217ecSPeter Brune PetscCheckSameComm(snes,1,x,2); 2041646217ecSPeter Brune if (b) PetscCheckSameComm(snes,1,b,3); 20424ec14c9cSBarry Smith if (b) VecValidValues(b,2,PETSC_TRUE); 2043701cf23dSPeter Brune ierr = PetscLogEventBegin(SNES_GSEval,snes,x,b,0);CHKERRQ(ierr); 20446cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2045942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 204622c6f798SBarry Smith if (sdm->ops->computegs) { 2047646217ecSPeter Brune PetscStackPush("SNES user GS"); 204822c6f798SBarry Smith ierr = (*sdm->ops->computegs)(snes,x,b,sdm->gsctx);CHKERRQ(ierr); 2049646217ecSPeter Brune PetscStackPop; 2050646217ecSPeter Brune } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE, "Must call SNESSetGS() before SNESComputeGS(), likely called from SNESSolve()."); 2051701cf23dSPeter Brune ierr = PetscLogEventEnd(SNES_GSEval,snes,x,b,0);CHKERRQ(ierr); 20524ec14c9cSBarry Smith VecValidValues(x,3,PETSC_FALSE); 2053646217ecSPeter Brune PetscFunctionReturn(0); 2054646217ecSPeter Brune } 2055646217ecSPeter Brune 2056646217ecSPeter Brune #undef __FUNCT__ 20574a2ae208SSatish Balay #define __FUNCT__ "SNESComputeJacobian" 205862fef451SLois Curfman McInnes /*@ 2059bf388a1fSBarry Smith SNESComputeJacobian - Computes the Jacobian matrix that has been set with SNESSetJacobian(). 206062fef451SLois Curfman McInnes 2061c7afd0dbSLois Curfman McInnes Collective on SNES and Mat 2062c7afd0dbSLois Curfman McInnes 206362fef451SLois Curfman McInnes Input Parameters: 2064c7afd0dbSLois Curfman McInnes + snes - the SNES context 2065c7afd0dbSLois Curfman McInnes - x - input vector 206662fef451SLois Curfman McInnes 206762fef451SLois Curfman McInnes Output Parameters: 2068c7afd0dbSLois Curfman McInnes + A - Jacobian matrix 206962fef451SLois Curfman McInnes . B - optional preconditioning matrix 20702b668275SBarry Smith - flag - flag indicating matrix structure (one of, SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER) 2071fee21e36SBarry Smith 2072e35cf81dSBarry Smith Options Database Keys: 2073e35cf81dSBarry Smith + -snes_lag_preconditioner <lag> 2074693365a8SJed Brown . -snes_lag_jacobian <lag> 2075693365a8SJed Brown . -snes_compare_explicit - Compare the computed Jacobian to the finite difference Jacobian and output the differences 2076693365a8SJed Brown . -snes_compare_explicit_draw - Compare the computed Jacobian to the finite difference Jacobian and draw the result 2077693365a8SJed Brown . -snes_compare_explicit_contour - Compare the computed Jacobian to the finite difference Jacobian and draw a contour plot with the result 20784c30e9fbSJed Brown . -snes_compare_operator - Make the comparison options above use the operator instead of the preconditioning matrix 2079c01495d3SJed Brown . -snes_compare_coloring - Compute the finite differece Jacobian using coloring and display norms of difference 2080c01495d3SJed Brown . -snes_compare_coloring_display - Compute the finite differece Jacobian using coloring and display verbose differences 2081c01495d3SJed Brown . -snes_compare_coloring_threshold - Display only those matrix entries that differ by more than a given threshold 2082c01495d3SJed Brown . -snes_compare_coloring_threshold_atol - Absolute tolerance for difference in matrix entries to be displayed by -snes_compare_coloring_threshold 2083c01495d3SJed Brown . -snes_compare_coloring_threshold_rtol - Relative tolerance for difference in matrix entries to be displayed by -snes_compare_coloring_threshold 20844c30e9fbSJed Brown . -snes_compare_coloring_draw - Compute the finite differece Jacobian using coloring and draw differences 2085c01495d3SJed Brown - -snes_compare_coloring_draw_contour - Compute the finite differece Jacobian using coloring and show contours of matrices and differences 2086c01495d3SJed Brown 2087e35cf81dSBarry Smith 208862fef451SLois Curfman McInnes Notes: 208962fef451SLois Curfman McInnes Most users should not need to explicitly call this routine, as it 209062fef451SLois Curfman McInnes is used internally within the nonlinear solvers. 209162fef451SLois Curfman McInnes 209294b7f48cSBarry Smith See KSPSetOperators() for important information about setting the 2093dc5a77f8SLois Curfman McInnes flag parameter. 209462fef451SLois Curfman McInnes 209536851e7fSLois Curfman McInnes Level: developer 209636851e7fSLois Curfman McInnes 209762fef451SLois Curfman McInnes .keywords: SNES, compute, Jacobian, matrix 209862fef451SLois Curfman McInnes 2099e35cf81dSBarry Smith .seealso: SNESSetJacobian(), KSPSetOperators(), MatStructure, SNESSetLagPreconditioner(), SNESSetLagJacobian() 210062fef451SLois Curfman McInnes @*/ 21017087cfbeSBarry Smith PetscErrorCode SNESComputeJacobian(SNES snes,Vec X,Mat *A,Mat *B,MatStructure *flg) 21029b94acceSBarry Smith { 2103dfbe8321SBarry Smith PetscErrorCode ierr; 2104ace3abfcSBarry Smith PetscBool flag; 21056cab3a1bSJed Brown DM dm; 2106942e3340SBarry Smith DMSNES sdm; 21073a40ed3dSBarry Smith 21083a40ed3dSBarry Smith PetscFunctionBegin; 21090700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 21100700a824SBarry Smith PetscValidHeaderSpecific(X,VEC_CLASSID,2); 21114482741eSBarry Smith PetscValidPointer(flg,5); 2112c9780b6fSBarry Smith PetscCheckSameComm(snes,1,X,2); 21134ec14c9cSBarry Smith VecValidValues(X,2,PETSC_TRUE); 21146cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2115942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 21163232da50SPeter Brune 2117*ce94432eSBarry Smith if (!sdm->ops->computejacobian) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_USER,"Must call SNESSetJacobian(), DMSNESSetJacobian(), DMDASNESSetJacobianLocal(), etc"); 2118ebd3b9afSBarry Smith 2119ebd3b9afSBarry Smith /* make sure that MatAssemblyBegin/End() is called on A matrix if it is matrix free */ 2120ebd3b9afSBarry Smith 2121fe3ffe1eSBarry Smith if (snes->lagjacobian == -2) { 2122fe3ffe1eSBarry Smith snes->lagjacobian = -1; 2123f5af7f23SKarl Rupp 2124fe3ffe1eSBarry Smith ierr = PetscInfo(snes,"Recomputing Jacobian/preconditioner because lag is -2 (means compute Jacobian, but then never again) \n");CHKERRQ(ierr); 2125fe3ffe1eSBarry Smith } else if (snes->lagjacobian == -1) { 2126e35cf81dSBarry Smith *flg = SAME_PRECONDITIONER; 2127e35cf81dSBarry Smith ierr = PetscInfo(snes,"Reusing Jacobian/preconditioner because lag is -1\n");CHKERRQ(ierr); 2128251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr); 2129ebd3b9afSBarry Smith if (flag) { 2130ebd3b9afSBarry Smith ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 2131ebd3b9afSBarry Smith ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 2132ebd3b9afSBarry Smith } 2133e35cf81dSBarry Smith PetscFunctionReturn(0); 2134e35cf81dSBarry Smith } else if (snes->lagjacobian > 1 && snes->iter % snes->lagjacobian) { 2135e35cf81dSBarry Smith *flg = SAME_PRECONDITIONER; 2136e35cf81dSBarry Smith ierr = PetscInfo2(snes,"Reusing Jacobian/preconditioner because lag is %D and SNES iteration is %D\n",snes->lagjacobian,snes->iter);CHKERRQ(ierr); 2137251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)*A,MATMFFD,&flag);CHKERRQ(ierr); 2138ebd3b9afSBarry Smith if (flag) { 2139ebd3b9afSBarry Smith ierr = MatAssemblyBegin(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 2140ebd3b9afSBarry Smith ierr = MatAssemblyEnd(*A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr); 2141ebd3b9afSBarry Smith } 2142e35cf81dSBarry Smith PetscFunctionReturn(0); 2143e35cf81dSBarry Smith } 2144e35cf81dSBarry Smith 2145c4fc05e7SBarry Smith *flg = DIFFERENT_NONZERO_PATTERN; 2146e35cf81dSBarry Smith ierr = PetscLogEventBegin(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr); 21473232da50SPeter Brune 2148d64ed03dSBarry Smith PetscStackPush("SNES user Jacobian function"); 214922c6f798SBarry Smith ierr = (*sdm->ops->computejacobian)(snes,X,A,B,flg,sdm->jacobianctx);CHKERRQ(ierr); 2150d64ed03dSBarry Smith PetscStackPop; 21513232da50SPeter Brune 2152d5ba7fb7SMatthew Knepley ierr = PetscLogEventEnd(SNES_JacobianEval,snes,X,*A,*B);CHKERRQ(ierr); 2153a8054027SBarry Smith 21543b4f5425SBarry Smith if (snes->lagpreconditioner == -2) { 21553b4f5425SBarry Smith ierr = PetscInfo(snes,"Rebuilding preconditioner exactly once since lag is -2\n");CHKERRQ(ierr); 2156f5af7f23SKarl Rupp 21573b4f5425SBarry Smith snes->lagpreconditioner = -1; 21583b4f5425SBarry Smith } else if (snes->lagpreconditioner == -1) { 2159a8054027SBarry Smith *flg = SAME_PRECONDITIONER; 2160a8054027SBarry Smith ierr = PetscInfo(snes,"Reusing preconditioner because lag is -1\n");CHKERRQ(ierr); 2161a8054027SBarry Smith } else if (snes->lagpreconditioner > 1 && snes->iter % snes->lagpreconditioner) { 2162a8054027SBarry Smith *flg = SAME_PRECONDITIONER; 2163a8054027SBarry Smith ierr = PetscInfo2(snes,"Reusing preconditioner because lag is %D and SNES iteration is %D\n",snes->lagpreconditioner,snes->iter);CHKERRQ(ierr); 2164a8054027SBarry Smith } 2165a8054027SBarry Smith 21666d84be18SBarry Smith /* make sure user returned a correct Jacobian and preconditioner */ 21670700a824SBarry Smith /* PetscValidHeaderSpecific(*A,MAT_CLASSID,3); 21680700a824SBarry Smith PetscValidHeaderSpecific(*B,MAT_CLASSID,4); */ 2169693365a8SJed Brown { 2170693365a8SJed Brown PetscBool flag = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_operator = PETSC_FALSE; 21710298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit",&flag,NULL);CHKERRQ(ierr); 21720298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw",&flag_draw,NULL);CHKERRQ(ierr); 21730298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_explicit_draw_contour",&flag_contour,NULL);CHKERRQ(ierr); 21740298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_operator",&flag_operator,NULL);CHKERRQ(ierr); 2175693365a8SJed Brown if (flag || flag_draw || flag_contour) { 21760298fd71SBarry Smith Mat Bexp_mine = NULL,Bexp,FDexp; 2177693365a8SJed Brown MatStructure mstruct; 2178693365a8SJed Brown PetscViewer vdraw,vstdout; 21796b3a5b13SJed Brown PetscBool flg; 2180693365a8SJed Brown if (flag_operator) { 2181693365a8SJed Brown ierr = MatComputeExplicitOperator(*A,&Bexp_mine);CHKERRQ(ierr); 2182693365a8SJed Brown Bexp = Bexp_mine; 2183693365a8SJed Brown } else { 2184693365a8SJed Brown /* See if the preconditioning matrix can be viewed and added directly */ 2185251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompareAny((PetscObject)*B,&flg,MATSEQAIJ,MATMPIAIJ,MATSEQDENSE,MATMPIDENSE,MATSEQBAIJ,MATMPIBAIJ,MATSEQSBAIJ,MATMPIBAIJ,"");CHKERRQ(ierr); 2186693365a8SJed Brown if (flg) Bexp = *B; 2187693365a8SJed Brown else { 2188693365a8SJed Brown /* If the "preconditioning" matrix is itself MATSHELL or some other type without direct support */ 2189693365a8SJed Brown ierr = MatComputeExplicitOperator(*B,&Bexp_mine);CHKERRQ(ierr); 2190693365a8SJed Brown Bexp = Bexp_mine; 2191693365a8SJed Brown } 2192693365a8SJed Brown } 2193693365a8SJed Brown ierr = MatConvert(Bexp,MATSAME,MAT_INITIAL_MATRIX,&FDexp);CHKERRQ(ierr); 2194693365a8SJed Brown ierr = SNESDefaultComputeJacobian(snes,X,&FDexp,&FDexp,&mstruct,NULL);CHKERRQ(ierr); 2195*ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)snes),&vstdout);CHKERRQ(ierr); 2196693365a8SJed Brown if (flag_draw || flag_contour) { 2197*ce94432eSBarry Smith ierr = PetscViewerDrawOpen(PetscObjectComm((PetscObject)snes),0,"Explicit Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr); 2198693365a8SJed Brown if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);} 21990298fd71SBarry Smith } else vdraw = NULL; 2200693365a8SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"Explicit %s\n",flag_operator ? "Jacobian" : "preconditioning Jacobian");CHKERRQ(ierr); 2201693365a8SJed Brown if (flag) {ierr = MatView(Bexp,vstdout);CHKERRQ(ierr);} 2202693365a8SJed Brown if (vdraw) {ierr = MatView(Bexp,vdraw);CHKERRQ(ierr);} 2203693365a8SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"Finite difference Jacobian\n");CHKERRQ(ierr); 2204693365a8SJed Brown if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);} 2205693365a8SJed Brown if (vdraw) {ierr = MatView(FDexp,vdraw);CHKERRQ(ierr);} 2206693365a8SJed Brown ierr = MatAYPX(FDexp,-1.0,Bexp,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 2207693365a8SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian\n");CHKERRQ(ierr); 2208693365a8SJed Brown if (flag) {ierr = MatView(FDexp,vstdout);CHKERRQ(ierr);} 2209693365a8SJed Brown if (vdraw) { /* Always use contour for the difference */ 2210693365a8SJed Brown ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr); 2211693365a8SJed Brown ierr = MatView(FDexp,vdraw);CHKERRQ(ierr); 2212693365a8SJed Brown ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr); 2213693365a8SJed Brown } 2214693365a8SJed Brown if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);} 2215693365a8SJed Brown ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr); 2216693365a8SJed Brown ierr = MatDestroy(&Bexp_mine);CHKERRQ(ierr); 2217693365a8SJed Brown ierr = MatDestroy(&FDexp);CHKERRQ(ierr); 2218693365a8SJed Brown } 2219693365a8SJed Brown } 22204c30e9fbSJed Brown { 22216719d8e4SJed Brown PetscBool flag = PETSC_FALSE,flag_display = PETSC_FALSE,flag_draw = PETSC_FALSE,flag_contour = PETSC_FALSE,flag_threshold = PETSC_FALSE; 22226719d8e4SJed Brown PetscReal threshold_atol = PETSC_SQRT_MACHINE_EPSILON,threshold_rtol = 10*PETSC_SQRT_MACHINE_EPSILON; 22230298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring",&flag,NULL);CHKERRQ(ierr); 22240298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_display",&flag_display,NULL);CHKERRQ(ierr); 22250298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_draw",&flag_draw,NULL);CHKERRQ(ierr); 22260298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_draw_contour",&flag_contour,NULL);CHKERRQ(ierr); 22270298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold",&flag_threshold,NULL);CHKERRQ(ierr); 22280298fd71SBarry Smith ierr = PetscOptionsGetReal(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold_rtol",&threshold_rtol,NULL);CHKERRQ(ierr); 22290298fd71SBarry Smith ierr = PetscOptionsGetReal(((PetscObject)snes)->prefix,"-snes_compare_coloring_threshold_atol",&threshold_atol,NULL);CHKERRQ(ierr); 22306719d8e4SJed Brown if (flag || flag_display || flag_draw || flag_contour || flag_threshold) { 22314c30e9fbSJed Brown Mat Bfd; 22324c30e9fbSJed Brown MatStructure mstruct; 22334c30e9fbSJed Brown PetscViewer vdraw,vstdout; 22344c30e9fbSJed Brown ISColoring iscoloring; 22354c30e9fbSJed Brown MatFDColoring matfdcoloring; 22364c30e9fbSJed Brown PetscErrorCode (*func)(SNES,Vec,Vec,void*); 22374c30e9fbSJed Brown void *funcctx; 22386719d8e4SJed Brown PetscReal norm1,norm2,normmax; 22394c30e9fbSJed Brown 22404c30e9fbSJed Brown ierr = MatDuplicate(*B,MAT_DO_NOT_COPY_VALUES,&Bfd);CHKERRQ(ierr); 22414c30e9fbSJed Brown ierr = MatGetColoring(Bfd,MATCOLORINGSL,&iscoloring);CHKERRQ(ierr); 22424c30e9fbSJed Brown ierr = MatFDColoringCreate(Bfd,iscoloring,&matfdcoloring);CHKERRQ(ierr); 22434c30e9fbSJed Brown ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr); 22444c30e9fbSJed Brown 22454c30e9fbSJed Brown /* This method of getting the function is currently unreliable since it doesn't work for DM local functions. */ 22460298fd71SBarry Smith ierr = SNESGetFunction(snes,NULL,&func,&funcctx);CHKERRQ(ierr); 22474c30e9fbSJed Brown ierr = MatFDColoringSetFunction(matfdcoloring,(PetscErrorCode (*)(void))func,funcctx);CHKERRQ(ierr); 22484c30e9fbSJed Brown ierr = PetscObjectSetOptionsPrefix((PetscObject)matfdcoloring,((PetscObject)snes)->prefix);CHKERRQ(ierr); 22494c30e9fbSJed Brown ierr = PetscObjectAppendOptionsPrefix((PetscObject)matfdcoloring,"coloring_");CHKERRQ(ierr); 22504c30e9fbSJed Brown ierr = MatFDColoringSetFromOptions(matfdcoloring);CHKERRQ(ierr); 22514c30e9fbSJed Brown ierr = MatFDColoringApply(Bfd,matfdcoloring,X,&mstruct,snes);CHKERRQ(ierr); 22524c30e9fbSJed Brown ierr = MatFDColoringDestroy(&matfdcoloring);CHKERRQ(ierr); 22534c30e9fbSJed Brown 2254*ce94432eSBarry Smith ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)snes),&vstdout);CHKERRQ(ierr); 22554c30e9fbSJed Brown if (flag_draw || flag_contour) { 2256*ce94432eSBarry Smith ierr = PetscViewerDrawOpen(PetscObjectComm((PetscObject)snes),0,"Colored Jacobians",PETSC_DECIDE,PETSC_DECIDE,300,300,&vdraw);CHKERRQ(ierr); 22574c30e9fbSJed Brown if (flag_contour) {ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr);} 22580298fd71SBarry Smith } else vdraw = NULL; 22594c30e9fbSJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"Explicit preconditioning Jacobian\n");CHKERRQ(ierr); 22606719d8e4SJed Brown if (flag_display) {ierr = MatView(*B,vstdout);CHKERRQ(ierr);} 22614c30e9fbSJed Brown if (vdraw) {ierr = MatView(*B,vdraw);CHKERRQ(ierr);} 22624c30e9fbSJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"Colored Finite difference Jacobian\n");CHKERRQ(ierr); 22636719d8e4SJed Brown if (flag_display) {ierr = MatView(Bfd,vstdout);CHKERRQ(ierr);} 22644c30e9fbSJed Brown if (vdraw) {ierr = MatView(Bfd,vdraw);CHKERRQ(ierr);} 22654c30e9fbSJed Brown ierr = MatAYPX(Bfd,-1.0,*B,SAME_NONZERO_PATTERN);CHKERRQ(ierr); 22664c30e9fbSJed Brown ierr = MatNorm(Bfd,NORM_1,&norm1);CHKERRQ(ierr); 22676719d8e4SJed Brown ierr = MatNorm(Bfd,NORM_FROBENIUS,&norm2);CHKERRQ(ierr); 22684c30e9fbSJed Brown ierr = MatNorm(Bfd,NORM_MAX,&normmax);CHKERRQ(ierr); 22696719d8e4SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"User-provided matrix minus finite difference Jacobian, norm1=%G normFrob=%G normmax=%G\n",norm1,norm2,normmax);CHKERRQ(ierr); 22706719d8e4SJed Brown if (flag_display) {ierr = MatView(Bfd,vstdout);CHKERRQ(ierr);} 22714c30e9fbSJed Brown if (vdraw) { /* Always use contour for the difference */ 22724c30e9fbSJed Brown ierr = PetscViewerPushFormat(vdraw,PETSC_VIEWER_DRAW_CONTOUR);CHKERRQ(ierr); 22734c30e9fbSJed Brown ierr = MatView(Bfd,vdraw);CHKERRQ(ierr); 22744c30e9fbSJed Brown ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr); 22754c30e9fbSJed Brown } 22764c30e9fbSJed Brown if (flag_contour) {ierr = PetscViewerPopFormat(vdraw);CHKERRQ(ierr);} 22776719d8e4SJed Brown 22786719d8e4SJed Brown if (flag_threshold) { 22796719d8e4SJed Brown PetscInt bs,rstart,rend,i; 22806719d8e4SJed Brown ierr = MatGetBlockSize(*B,&bs);CHKERRQ(ierr); 22816719d8e4SJed Brown ierr = MatGetOwnershipRange(*B,&rstart,&rend);CHKERRQ(ierr); 22826719d8e4SJed Brown for (i=rstart; i<rend; i++) { 22836719d8e4SJed Brown const PetscScalar *ba,*ca; 22846719d8e4SJed Brown const PetscInt *bj,*cj; 22856719d8e4SJed Brown PetscInt bn,cn,j,maxentrycol = -1,maxdiffcol = -1,maxrdiffcol = -1; 22866719d8e4SJed Brown PetscReal maxentry = 0,maxdiff = 0,maxrdiff = 0; 22876719d8e4SJed Brown ierr = MatGetRow(*B,i,&bn,&bj,&ba);CHKERRQ(ierr); 22886719d8e4SJed Brown ierr = MatGetRow(Bfd,i,&cn,&cj,&ca);CHKERRQ(ierr); 22896719d8e4SJed Brown if (bn != cn) SETERRQ(((PetscObject)*A)->comm,PETSC_ERR_PLIB,"Unexpected different nonzero pattern in -snes_compare_coloring_threshold"); 22906719d8e4SJed Brown for (j=0; j<bn; j++) { 22916719d8e4SJed Brown PetscReal rdiff = PetscAbsScalar(ca[j]) / (threshold_atol + threshold_rtol*PetscAbsScalar(ba[j])); 22926719d8e4SJed Brown if (PetscAbsScalar(ba[j]) > PetscAbs(maxentry)) { 22936719d8e4SJed Brown maxentrycol = bj[j]; 22946719d8e4SJed Brown maxentry = PetscRealPart(ba[j]); 22956719d8e4SJed Brown } 22966719d8e4SJed Brown if (PetscAbsScalar(ca[j]) > PetscAbs(maxdiff)) { 22976719d8e4SJed Brown maxdiffcol = bj[j]; 22986719d8e4SJed Brown maxdiff = PetscRealPart(ca[j]); 22996719d8e4SJed Brown } 23006719d8e4SJed Brown if (rdiff > maxrdiff) { 23016719d8e4SJed Brown maxrdiffcol = bj[j]; 23026719d8e4SJed Brown maxrdiff = rdiff; 23036719d8e4SJed Brown } 23046719d8e4SJed Brown } 23056719d8e4SJed Brown if (maxrdiff > 1) { 23066719d8e4SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"row %D (maxentry=%G at %D, maxdiff=%G at %D, maxrdiff=%G at %D):",i,maxentry,maxentrycol,maxdiff,maxdiffcol,maxrdiff,maxrdiffcol);CHKERRQ(ierr); 23076719d8e4SJed Brown for (j=0; j<bn; j++) { 23086719d8e4SJed Brown PetscReal rdiff; 23096719d8e4SJed Brown rdiff = PetscAbsScalar(ca[j]) / (threshold_atol + threshold_rtol*PetscAbsScalar(ba[j])); 23106719d8e4SJed Brown if (rdiff > 1) { 23116719d8e4SJed Brown ierr = PetscViewerASCIIPrintf(vstdout," (%D,%G:%G)",bj[j],PetscRealPart(ba[j]),PetscRealPart(ca[j]));CHKERRQ(ierr); 23126719d8e4SJed Brown } 23136719d8e4SJed Brown } 23146719d8e4SJed Brown ierr = PetscViewerASCIIPrintf(vstdout,"\n",i,maxentry,maxdiff,maxrdiff);CHKERRQ(ierr); 23156719d8e4SJed Brown } 23166719d8e4SJed Brown ierr = MatRestoreRow(*B,i,&bn,&bj,&ba);CHKERRQ(ierr); 23176719d8e4SJed Brown ierr = MatRestoreRow(Bfd,i,&cn,&cj,&ca);CHKERRQ(ierr); 23186719d8e4SJed Brown } 23196719d8e4SJed Brown } 23204c30e9fbSJed Brown ierr = PetscViewerDestroy(&vdraw);CHKERRQ(ierr); 23214c30e9fbSJed Brown ierr = MatDestroy(&Bfd);CHKERRQ(ierr); 23224c30e9fbSJed Brown } 23234c30e9fbSJed Brown } 23243a40ed3dSBarry Smith PetscFunctionReturn(0); 23259b94acceSBarry Smith } 23269b94acceSBarry Smith 2327bf388a1fSBarry Smith /*MC 2328bf388a1fSBarry Smith SNESJacobianFunction - function used to convey the nonlinear Jacobian of the function to be solved by SNES 2329bf388a1fSBarry Smith 2330bf388a1fSBarry Smith Synopsis: 2331bf388a1fSBarry Smith #include "petscsnes.h" 2332bf388a1fSBarry Smith $ SNESJacobianFunction(SNES snes,Vec x,Mat *A,Mat *B,int *flag,void *ctx); 2333bf388a1fSBarry Smith 2334bf388a1fSBarry Smith + x - input vector 2335bf388a1fSBarry Smith . A - Jacobian matrix 2336bf388a1fSBarry Smith . B - preconditioner matrix, usually the same as A 2337bf388a1fSBarry Smith . flag - flag indicating information about the preconditioner matrix 2338bf388a1fSBarry Smith structure (same as flag in KSPSetOperators()), one of SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER 2339bf388a1fSBarry Smith - ctx - [optional] user-defined Jacobian context 2340bf388a1fSBarry Smith 2341bf388a1fSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction(), SNESSetJacobian(), SNESGetJacobian() 2342bf388a1fSBarry Smith M*/ 2343bf388a1fSBarry Smith 23444a2ae208SSatish Balay #undef __FUNCT__ 23454a2ae208SSatish Balay #define __FUNCT__ "SNESSetJacobian" 23469b94acceSBarry Smith /*@C 23479b94acceSBarry Smith SNESSetJacobian - Sets the function to compute Jacobian as well as the 2348044dda88SLois Curfman McInnes location to store the matrix. 23499b94acceSBarry Smith 23503f9fe445SBarry Smith Logically Collective on SNES and Mat 2351c7afd0dbSLois Curfman McInnes 23529b94acceSBarry Smith Input Parameters: 2353c7afd0dbSLois Curfman McInnes + snes - the SNES context 23549b94acceSBarry Smith . A - Jacobian matrix 23559b94acceSBarry Smith . B - preconditioner matrix (usually same as the Jacobian) 23560298fd71SBarry Smith . SNESJacobianFunction - Jacobian evaluation routine (if NULL then SNES retains any previously set value) 2357c7afd0dbSLois Curfman McInnes - ctx - [optional] user-defined context for private data for the 23580298fd71SBarry Smith Jacobian evaluation routine (may be NULL) (if NULL then SNES retains any previously set value) 23599b94acceSBarry Smith 23609b94acceSBarry Smith Notes: 236194b7f48cSBarry Smith See KSPSetOperators() for important information about setting the flag 23622cd2dfdcSLois Curfman McInnes output parameter in the routine func(). Be sure to read this information! 2363ac21db08SLois Curfman McInnes 2364ac21db08SLois Curfman McInnes The routine func() takes Mat * as the matrix arguments rather than Mat. 23659b94acceSBarry Smith This allows the Jacobian evaluation routine to replace A and/or B with a 23669b94acceSBarry Smith completely new new matrix structure (not just different matrix elements) 23679b94acceSBarry Smith when appropriate, for instance, if the nonzero structure is changing 23689b94acceSBarry Smith throughout the global iterations. 23699b94acceSBarry Smith 237016913363SBarry Smith If the A matrix and B matrix are different you must call MatAssemblyBegin/End() on 237116913363SBarry Smith each matrix. 237216913363SBarry Smith 2373a8a26c1eSJed Brown If using SNESDefaultComputeJacobianColor() to assemble a Jacobian, the ctx argument 2374a8a26c1eSJed Brown must be a MatFDColoring. 2375a8a26c1eSJed Brown 2376c3cc8fd1SJed Brown Other defect-correction schemes can be used by computing a different matrix in place of the Jacobian. One common 2377c3cc8fd1SJed Brown example is to use the "Picard linearization" which only differentiates through the highest order parts of each term. 2378c3cc8fd1SJed Brown 237936851e7fSLois Curfman McInnes Level: beginner 238036851e7fSLois Curfman McInnes 23819b94acceSBarry Smith .keywords: SNES, nonlinear, set, Jacobian, matrix 23829b94acceSBarry Smith 2383bf388a1fSBarry Smith .seealso: KSPSetOperators(), SNESSetFunction(), MatMFFDComputeJacobian(), SNESDefaultComputeJacobianColor(), MatStructure, SNESJacobianFunction 23849b94acceSBarry Smith @*/ 2385bf388a1fSBarry Smith PetscErrorCode SNESSetJacobian(SNES snes,Mat A,Mat B,PetscErrorCode (*SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx) 23869b94acceSBarry Smith { 2387dfbe8321SBarry Smith PetscErrorCode ierr; 23886cab3a1bSJed Brown DM dm; 23893a7fca6bSBarry Smith 23903a40ed3dSBarry Smith PetscFunctionBegin; 23910700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 23920700a824SBarry Smith if (A) PetscValidHeaderSpecific(A,MAT_CLASSID,2); 23930700a824SBarry Smith if (B) PetscValidHeaderSpecific(B,MAT_CLASSID,3); 2394c9780b6fSBarry Smith if (A) PetscCheckSameComm(snes,1,A,2); 239506975374SJed Brown if (B) PetscCheckSameComm(snes,1,B,3); 23966cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2397bf388a1fSBarry Smith ierr = DMSNESSetJacobian(dm,SNESJacobianFunction,ctx);CHKERRQ(ierr); 23983a7fca6bSBarry Smith if (A) { 23997dcf0eaaSdalcinl ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr); 24006bf464f9SBarry Smith ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr); 2401f5af7f23SKarl Rupp 24029b94acceSBarry Smith snes->jacobian = A; 24033a7fca6bSBarry Smith } 24043a7fca6bSBarry Smith if (B) { 24057dcf0eaaSdalcinl ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr); 24066bf464f9SBarry Smith ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr); 2407f5af7f23SKarl Rupp 24089b94acceSBarry Smith snes->jacobian_pre = B; 24093a7fca6bSBarry Smith } 24103a40ed3dSBarry Smith PetscFunctionReturn(0); 24119b94acceSBarry Smith } 241262fef451SLois Curfman McInnes 24134a2ae208SSatish Balay #undef __FUNCT__ 24144a2ae208SSatish Balay #define __FUNCT__ "SNESGetJacobian" 2415c2aafc4cSSatish Balay /*@C 2416b4fd4287SBarry Smith SNESGetJacobian - Returns the Jacobian matrix and optionally the user 2417b4fd4287SBarry Smith provided context for evaluating the Jacobian. 2418b4fd4287SBarry Smith 2419c7afd0dbSLois Curfman McInnes Not Collective, but Mat object will be parallel if SNES object is 2420c7afd0dbSLois Curfman McInnes 2421b4fd4287SBarry Smith Input Parameter: 2422b4fd4287SBarry Smith . snes - the nonlinear solver context 2423b4fd4287SBarry Smith 2424b4fd4287SBarry Smith Output Parameters: 24250298fd71SBarry Smith + A - location to stash Jacobian matrix (or NULL) 24260298fd71SBarry Smith . B - location to stash preconditioner matrix (or NULL) 24270298fd71SBarry Smith . SNESJacobianFunction - location to put Jacobian function (or NULL) 24280298fd71SBarry Smith - ctx - location to stash Jacobian ctx (or NULL) 2429fee21e36SBarry Smith 243036851e7fSLois Curfman McInnes Level: advanced 243136851e7fSLois Curfman McInnes 2432b4fd4287SBarry Smith .seealso: SNESSetJacobian(), SNESComputeJacobian() 2433b4fd4287SBarry Smith @*/ 2434bf388a1fSBarry Smith PetscErrorCode SNESGetJacobian(SNES snes,Mat *A,Mat *B,PetscErrorCode (**SNESJacobianFunction)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx) 2435b4fd4287SBarry Smith { 24366cab3a1bSJed Brown PetscErrorCode ierr; 24376cab3a1bSJed Brown DM dm; 2438942e3340SBarry Smith DMSNES sdm; 24396cab3a1bSJed Brown 24403a40ed3dSBarry Smith PetscFunctionBegin; 24410700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2442b4fd4287SBarry Smith if (A) *A = snes->jacobian; 2443b4fd4287SBarry Smith if (B) *B = snes->jacobian_pre; 24446cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2445942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 2446bf388a1fSBarry Smith if (SNESJacobianFunction) *SNESJacobianFunction = sdm->ops->computejacobian; 24476cab3a1bSJed Brown if (ctx) *ctx = sdm->jacobianctx; 24483a40ed3dSBarry Smith PetscFunctionReturn(0); 2449b4fd4287SBarry Smith } 2450b4fd4287SBarry Smith 24514a2ae208SSatish Balay #undef __FUNCT__ 24524a2ae208SSatish Balay #define __FUNCT__ "SNESSetUp" 24539b94acceSBarry Smith /*@ 24549b94acceSBarry Smith SNESSetUp - Sets up the internal data structures for the later use 2455272ac6f2SLois Curfman McInnes of a nonlinear solver. 24569b94acceSBarry Smith 2457fee21e36SBarry Smith Collective on SNES 2458fee21e36SBarry Smith 2459c7afd0dbSLois Curfman McInnes Input Parameters: 246070e92668SMatthew Knepley . snes - the SNES context 2461c7afd0dbSLois Curfman McInnes 2462272ac6f2SLois Curfman McInnes Notes: 2463272ac6f2SLois Curfman McInnes For basic use of the SNES solvers the user need not explicitly call 2464272ac6f2SLois Curfman McInnes SNESSetUp(), since these actions will automatically occur during 2465272ac6f2SLois Curfman McInnes the call to SNESSolve(). However, if one wishes to control this 2466272ac6f2SLois Curfman McInnes phase separately, SNESSetUp() should be called after SNESCreate() 2467272ac6f2SLois Curfman McInnes and optional routines of the form SNESSetXXX(), but before SNESSolve(). 2468272ac6f2SLois Curfman McInnes 246936851e7fSLois Curfman McInnes Level: advanced 247036851e7fSLois Curfman McInnes 24719b94acceSBarry Smith .keywords: SNES, nonlinear, setup 24729b94acceSBarry Smith 24739b94acceSBarry Smith .seealso: SNESCreate(), SNESSolve(), SNESDestroy() 24749b94acceSBarry Smith @*/ 24757087cfbeSBarry Smith PetscErrorCode SNESSetUp(SNES snes) 24769b94acceSBarry Smith { 2477dfbe8321SBarry Smith PetscErrorCode ierr; 24786cab3a1bSJed Brown DM dm; 2479942e3340SBarry Smith DMSNES sdm; 2480c35f09e5SBarry Smith SNESLineSearch linesearch, pclinesearch; 24816e2a1849SPeter Brune void *lsprectx,*lspostctx; 24826b2b7091SBarry Smith PetscErrorCode (*precheck)(SNESLineSearch,Vec,Vec,PetscBool*,void*); 24836b2b7091SBarry Smith PetscErrorCode (*postcheck)(SNESLineSearch,Vec,Vec,Vec,PetscBool*,PetscBool*,void*); 24846e2a1849SPeter Brune PetscErrorCode (*func)(SNES,Vec,Vec,void*); 24856e2a1849SPeter Brune Vec f,fpc; 24866e2a1849SPeter Brune void *funcctx; 24876e2a1849SPeter Brune PetscErrorCode (*jac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 24881eb13d49SPeter Brune void *jacctx,*appctx; 24896e2a1849SPeter Brune Mat A,B; 24903a40ed3dSBarry Smith 24913a40ed3dSBarry Smith PetscFunctionBegin; 24920700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 24934dc4c822SBarry Smith if (snes->setupcalled) PetscFunctionReturn(0); 24949b94acceSBarry Smith 24957adad957SLisandro Dalcin if (!((PetscObject)snes)->type_name) { 249604d7464bSBarry Smith ierr = SNESSetType(snes,SNESNEWTONLS);CHKERRQ(ierr); 249785385478SLisandro Dalcin } 249885385478SLisandro Dalcin 24990298fd71SBarry Smith ierr = SNESGetFunction(snes,&snes->vec_func,NULL,NULL);CHKERRQ(ierr); 250017186662SBarry Smith if (snes->vec_func == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be function vector"); 250158c9b817SLisandro Dalcin if (snes->vec_rhs == snes->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_IDN,"Solution vector cannot be right hand side vector"); 250258c9b817SLisandro Dalcin 250358c9b817SLisandro Dalcin if (!snes->vec_sol_update /* && snes->vec_sol */) { 250458c9b817SLisandro Dalcin ierr = VecDuplicate(snes->vec_sol,&snes->vec_sol_update);CHKERRQ(ierr); 250558c9b817SLisandro Dalcin ierr = PetscLogObjectParent(snes,snes->vec_sol_update);CHKERRQ(ierr); 250658c9b817SLisandro Dalcin } 250758c9b817SLisandro Dalcin 25086cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 2509d8f46077SPeter Brune ierr = DMShellSetGlobalVector(snes->dm,snes->vec_sol);CHKERRQ(ierr); 2510942e3340SBarry Smith ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr); 2511*ce94432eSBarry Smith if (!sdm->ops->computefunction) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE,"Function never provided to SNES object"); 251222c6f798SBarry Smith if (!sdm->ops->computejacobian) { 25130298fd71SBarry Smith ierr = DMSNESSetJacobian(dm,SNESDefaultComputeJacobianColor,NULL);CHKERRQ(ierr); 251419f7a02aSBarry Smith } 25156cab3a1bSJed Brown if (!snes->vec_func) { 25166cab3a1bSJed Brown ierr = DMCreateGlobalVector(dm,&snes->vec_func);CHKERRQ(ierr); 2517214df951SJed Brown } 2518efd51863SBarry Smith 251922d28d08SBarry Smith if (!snes->ksp) { 252022d28d08SBarry Smith ierr = SNESGetKSP(snes, &snes->ksp);CHKERRQ(ierr); 252122d28d08SBarry Smith } 2522b710008aSBarry Smith 252322d28d08SBarry Smith if (!snes->linesearch) { 252422d28d08SBarry Smith ierr = SNESGetSNESLineSearch(snes, &snes->linesearch);CHKERRQ(ierr); 252522d28d08SBarry Smith } 25269e764e56SPeter Brune 2527172a4300SPeter Brune if (snes->pc && (snes->pcside == PC_LEFT)) { 2528172a4300SPeter Brune snes->mf = PETSC_TRUE; 2529172a4300SPeter Brune snes->mf_operator = PETSC_FALSE; 2530172a4300SPeter Brune } 2531d8f46077SPeter Brune 253228a52e04SBarry Smith if (snes->mf) { 253328a52e04SBarry Smith ierr = SNESSetUpMatrixFree_Private(snes, snes->mf_operator, snes->mf_version);CHKERRQ(ierr); 253428a52e04SBarry Smith } 2535d8f46077SPeter Brune 2536d25893d9SBarry Smith if (snes->ops->usercompute && !snes->user) { 2537d25893d9SBarry Smith ierr = (*snes->ops->usercompute)(snes,(void**)&snes->user);CHKERRQ(ierr); 2538d25893d9SBarry Smith } 2539d25893d9SBarry Smith 25406e2a1849SPeter Brune if (snes->pc) { 25416e2a1849SPeter Brune /* copy the DM over */ 25426e2a1849SPeter Brune ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 25436e2a1849SPeter Brune ierr = SNESSetDM(snes->pc,dm);CHKERRQ(ierr); 25446e2a1849SPeter Brune 25456e2a1849SPeter Brune ierr = SNESGetFunction(snes,&f,&func,&funcctx);CHKERRQ(ierr); 25466e2a1849SPeter Brune ierr = VecDuplicate(f,&fpc);CHKERRQ(ierr); 25476e2a1849SPeter Brune ierr = SNESSetFunction(snes->pc,fpc,func,funcctx);CHKERRQ(ierr); 25486e2a1849SPeter Brune ierr = SNESGetJacobian(snes,&A,&B,&jac,&jacctx);CHKERRQ(ierr); 25496e2a1849SPeter Brune ierr = SNESSetJacobian(snes->pc,A,B,jac,jacctx);CHKERRQ(ierr); 25501eb13d49SPeter Brune ierr = SNESGetApplicationContext(snes,&appctx);CHKERRQ(ierr); 25511eb13d49SPeter Brune ierr = SNESSetApplicationContext(snes->pc,appctx);CHKERRQ(ierr); 25526e2a1849SPeter Brune ierr = VecDestroy(&fpc);CHKERRQ(ierr); 25536e2a1849SPeter Brune 25546e2a1849SPeter Brune /* copy the function pointers over */ 25556e2a1849SPeter Brune ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)snes,(PetscObject)snes->pc);CHKERRQ(ierr); 25566e2a1849SPeter Brune 25576e2a1849SPeter Brune /* default to 1 iteration */ 2558140836e4SPeter Brune ierr = SNESSetTolerances(snes->pc,0.0,0.0,0.0,1,snes->pc->max_funcs);CHKERRQ(ierr); 2559a9936a0cSPeter Brune if (snes->pcside==PC_RIGHT) { 25606e2a1849SPeter Brune ierr = SNESSetNormType(snes->pc,SNES_NORM_FINAL_ONLY);CHKERRQ(ierr); 2561a9936a0cSPeter Brune } else { 2562a9936a0cSPeter Brune ierr = SNESSetNormType(snes->pc,SNES_NORM_NONE);CHKERRQ(ierr); 2563a9936a0cSPeter Brune } 25646e2a1849SPeter Brune ierr = SNESSetFromOptions(snes->pc);CHKERRQ(ierr); 25656e2a1849SPeter Brune 25666e2a1849SPeter Brune /* copy the line search context over */ 25676e2a1849SPeter Brune ierr = SNESGetSNESLineSearch(snes,&linesearch);CHKERRQ(ierr); 25686e2a1849SPeter Brune ierr = SNESGetSNESLineSearch(snes->pc,&pclinesearch);CHKERRQ(ierr); 25696b2b7091SBarry Smith ierr = SNESLineSearchGetPreCheck(linesearch,&precheck,&lsprectx);CHKERRQ(ierr); 25706b2b7091SBarry Smith ierr = SNESLineSearchGetPostCheck(linesearch,&postcheck,&lspostctx);CHKERRQ(ierr); 25716b2b7091SBarry Smith ierr = SNESLineSearchSetPreCheck(pclinesearch,precheck,lsprectx);CHKERRQ(ierr); 25726b2b7091SBarry Smith ierr = SNESLineSearchSetPostCheck(pclinesearch,postcheck,lspostctx);CHKERRQ(ierr); 25736e2a1849SPeter Brune ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)linesearch, (PetscObject)pclinesearch);CHKERRQ(ierr); 25746e2a1849SPeter Brune } 25756e2a1849SPeter Brune 2576410397dcSLisandro Dalcin if (snes->ops->setup) { 2577410397dcSLisandro Dalcin ierr = (*snes->ops->setup)(snes);CHKERRQ(ierr); 2578410397dcSLisandro Dalcin } 257958c9b817SLisandro Dalcin 25807aaed0d8SBarry Smith snes->setupcalled = PETSC_TRUE; 25813a40ed3dSBarry Smith PetscFunctionReturn(0); 25829b94acceSBarry Smith } 25839b94acceSBarry Smith 25844a2ae208SSatish Balay #undef __FUNCT__ 258537596af1SLisandro Dalcin #define __FUNCT__ "SNESReset" 258637596af1SLisandro Dalcin /*@ 258737596af1SLisandro Dalcin SNESReset - Resets a SNES context to the snessetupcalled = 0 state and removes any allocated Vecs and Mats 258837596af1SLisandro Dalcin 258937596af1SLisandro Dalcin Collective on SNES 259037596af1SLisandro Dalcin 259137596af1SLisandro Dalcin Input Parameter: 259237596af1SLisandro Dalcin . snes - iterative context obtained from SNESCreate() 259337596af1SLisandro Dalcin 2594d25893d9SBarry Smith Level: intermediate 2595d25893d9SBarry Smith 2596d25893d9SBarry Smith Notes: Also calls the application context destroy routine set with SNESSetComputeApplicationContext() 259737596af1SLisandro Dalcin 259837596af1SLisandro Dalcin .keywords: SNES, destroy 259937596af1SLisandro Dalcin 260037596af1SLisandro Dalcin .seealso: SNESCreate(), SNESSetUp(), SNESSolve() 260137596af1SLisandro Dalcin @*/ 260237596af1SLisandro Dalcin PetscErrorCode SNESReset(SNES snes) 260337596af1SLisandro Dalcin { 260437596af1SLisandro Dalcin PetscErrorCode ierr; 260537596af1SLisandro Dalcin 260637596af1SLisandro Dalcin PetscFunctionBegin; 260737596af1SLisandro Dalcin PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2608d25893d9SBarry Smith if (snes->ops->userdestroy && snes->user) { 2609d25893d9SBarry Smith ierr = (*snes->ops->userdestroy)((void**)&snes->user);CHKERRQ(ierr); 26100298fd71SBarry Smith snes->user = NULL; 2611d25893d9SBarry Smith } 26128a23116dSBarry Smith if (snes->pc) { 26138a23116dSBarry Smith ierr = SNESReset(snes->pc);CHKERRQ(ierr); 26148a23116dSBarry Smith } 26158a23116dSBarry Smith 261637596af1SLisandro Dalcin if (snes->ops->reset) { 261737596af1SLisandro Dalcin ierr = (*snes->ops->reset)(snes);CHKERRQ(ierr); 261837596af1SLisandro Dalcin } 26199e764e56SPeter Brune if (snes->ksp) { 26209e764e56SPeter Brune ierr = KSPReset(snes->ksp);CHKERRQ(ierr); 26219e764e56SPeter Brune } 26229e764e56SPeter Brune 26239e764e56SPeter Brune if (snes->linesearch) { 2624f1c6b773SPeter Brune ierr = SNESLineSearchReset(snes->linesearch);CHKERRQ(ierr); 26259e764e56SPeter Brune } 26269e764e56SPeter Brune 26276bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr); 26286bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr); 26296bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_sol_update);CHKERRQ(ierr); 26306bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_func);CHKERRQ(ierr); 26316bf464f9SBarry Smith ierr = MatDestroy(&snes->jacobian);CHKERRQ(ierr); 26326bf464f9SBarry Smith ierr = MatDestroy(&snes->jacobian_pre);CHKERRQ(ierr); 2633c41d97abSJed Brown ierr = VecDestroyVecs(snes->nwork,&snes->work);CHKERRQ(ierr); 2634c41d97abSJed Brown ierr = VecDestroyVecs(snes->nvwork,&snes->vwork);CHKERRQ(ierr); 2635f5af7f23SKarl Rupp 263637596af1SLisandro Dalcin snes->nwork = snes->nvwork = 0; 263737596af1SLisandro Dalcin snes->setupcalled = PETSC_FALSE; 263837596af1SLisandro Dalcin PetscFunctionReturn(0); 263937596af1SLisandro Dalcin } 264037596af1SLisandro Dalcin 264137596af1SLisandro Dalcin #undef __FUNCT__ 26424a2ae208SSatish Balay #define __FUNCT__ "SNESDestroy" 264352baeb72SSatish Balay /*@ 26449b94acceSBarry Smith SNESDestroy - Destroys the nonlinear solver context that was created 26459b94acceSBarry Smith with SNESCreate(). 26469b94acceSBarry Smith 2647c7afd0dbSLois Curfman McInnes Collective on SNES 2648c7afd0dbSLois Curfman McInnes 26499b94acceSBarry Smith Input Parameter: 26509b94acceSBarry Smith . snes - the SNES context 26519b94acceSBarry Smith 265236851e7fSLois Curfman McInnes Level: beginner 265336851e7fSLois Curfman McInnes 26549b94acceSBarry Smith .keywords: SNES, nonlinear, destroy 26559b94acceSBarry Smith 265663a78c88SLois Curfman McInnes .seealso: SNESCreate(), SNESSolve() 26579b94acceSBarry Smith @*/ 26586bf464f9SBarry Smith PetscErrorCode SNESDestroy(SNES *snes) 26599b94acceSBarry Smith { 26606849ba73SBarry Smith PetscErrorCode ierr; 26613a40ed3dSBarry Smith 26623a40ed3dSBarry Smith PetscFunctionBegin; 26636bf464f9SBarry Smith if (!*snes) PetscFunctionReturn(0); 26646bf464f9SBarry Smith PetscValidHeaderSpecific((*snes),SNES_CLASSID,1); 26656bf464f9SBarry Smith if (--((PetscObject)(*snes))->refct > 0) {*snes = 0; PetscFunctionReturn(0);} 2666d4bb536fSBarry Smith 26676bf464f9SBarry Smith ierr = SNESReset((*snes));CHKERRQ(ierr); 26688a23116dSBarry Smith ierr = SNESDestroy(&(*snes)->pc);CHKERRQ(ierr); 26696b8b9a38SLisandro Dalcin 2670be0abb6dSBarry Smith /* if memory was published with AMS then destroy it */ 26716bf464f9SBarry Smith ierr = PetscObjectDepublish((*snes));CHKERRQ(ierr); 26726bf464f9SBarry Smith if ((*snes)->ops->destroy) {ierr = (*((*snes))->ops->destroy)((*snes));CHKERRQ(ierr);} 26736d4c513bSLisandro Dalcin 26746bf464f9SBarry Smith ierr = DMDestroy(&(*snes)->dm);CHKERRQ(ierr); 26756bf464f9SBarry Smith ierr = KSPDestroy(&(*snes)->ksp);CHKERRQ(ierr); 2676f1c6b773SPeter Brune ierr = SNESLineSearchDestroy(&(*snes)->linesearch);CHKERRQ(ierr); 26776b8b9a38SLisandro Dalcin 26786bf464f9SBarry Smith ierr = PetscFree((*snes)->kspconvctx);CHKERRQ(ierr); 26796bf464f9SBarry Smith if ((*snes)->ops->convergeddestroy) { 26806bf464f9SBarry Smith ierr = (*(*snes)->ops->convergeddestroy)((*snes)->cnvP);CHKERRQ(ierr); 26816b8b9a38SLisandro Dalcin } 26826bf464f9SBarry Smith if ((*snes)->conv_malloc) { 26836bf464f9SBarry Smith ierr = PetscFree((*snes)->conv_hist);CHKERRQ(ierr); 26846bf464f9SBarry Smith ierr = PetscFree((*snes)->conv_hist_its);CHKERRQ(ierr); 268558c9b817SLisandro Dalcin } 26866bf464f9SBarry Smith ierr = SNESMonitorCancel((*snes));CHKERRQ(ierr); 2687a79aaaedSSatish Balay ierr = PetscHeaderDestroy(snes);CHKERRQ(ierr); 26883a40ed3dSBarry Smith PetscFunctionReturn(0); 26899b94acceSBarry Smith } 26909b94acceSBarry Smith 26919b94acceSBarry Smith /* ----------- Routines to set solver parameters ---------- */ 26929b94acceSBarry Smith 26934a2ae208SSatish Balay #undef __FUNCT__ 2694a8054027SBarry Smith #define __FUNCT__ "SNESSetLagPreconditioner" 2695a8054027SBarry Smith /*@ 2696a8054027SBarry Smith SNESSetLagPreconditioner - Determines when the preconditioner is rebuilt in the nonlinear solve. 2697a8054027SBarry Smith 26983f9fe445SBarry Smith Logically Collective on SNES 2699a8054027SBarry Smith 2700a8054027SBarry Smith Input Parameters: 2701a8054027SBarry Smith + snes - the SNES context 2702a8054027SBarry Smith - lag - -1 indicates NEVER rebuild, 1 means rebuild every time the Jacobian is computed within a single nonlinear solve, 2 means every second time 27033b4f5425SBarry Smith the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that 2704a8054027SBarry Smith 2705a8054027SBarry Smith Options Database Keys: 2706a8054027SBarry Smith . -snes_lag_preconditioner <lag> 2707a8054027SBarry Smith 2708a8054027SBarry Smith Notes: 2709a8054027SBarry Smith The default is 1 2710a8054027SBarry Smith The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1 2711a8054027SBarry Smith If -1 is used before the very first nonlinear solve the preconditioner is still built because there is no previous preconditioner to use 2712a8054027SBarry Smith 2713a8054027SBarry Smith Level: intermediate 2714a8054027SBarry Smith 2715a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2716a8054027SBarry Smith 2717e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian() 2718a8054027SBarry Smith 2719a8054027SBarry Smith @*/ 27207087cfbeSBarry Smith PetscErrorCode SNESSetLagPreconditioner(SNES snes,PetscInt lag) 2721a8054027SBarry Smith { 2722a8054027SBarry Smith PetscFunctionBegin; 27230700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2724e32f2f54SBarry Smith if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater"); 2725e32f2f54SBarry Smith if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0"); 2726c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,lag,2); 2727a8054027SBarry Smith snes->lagpreconditioner = lag; 2728a8054027SBarry Smith PetscFunctionReturn(0); 2729a8054027SBarry Smith } 2730a8054027SBarry Smith 2731a8054027SBarry Smith #undef __FUNCT__ 2732efd51863SBarry Smith #define __FUNCT__ "SNESSetGridSequence" 2733efd51863SBarry Smith /*@ 2734efd51863SBarry Smith SNESSetGridSequence - sets the number of steps of grid sequencing that SNES does 2735efd51863SBarry Smith 2736efd51863SBarry Smith Logically Collective on SNES 2737efd51863SBarry Smith 2738efd51863SBarry Smith Input Parameters: 2739efd51863SBarry Smith + snes - the SNES context 2740efd51863SBarry Smith - steps - the number of refinements to do, defaults to 0 2741efd51863SBarry Smith 2742efd51863SBarry Smith Options Database Keys: 2743efd51863SBarry Smith . -snes_grid_sequence <steps> 2744efd51863SBarry Smith 2745efd51863SBarry Smith Level: intermediate 2746efd51863SBarry Smith 2747c0df2a02SJed Brown Notes: 2748c0df2a02SJed Brown Use SNESGetSolution() to extract the fine grid solution after grid sequencing. 2749c0df2a02SJed Brown 2750efd51863SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2751efd51863SBarry Smith 2752efd51863SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagJacobian(), SNESGetLagJacobian() 2753efd51863SBarry Smith 2754efd51863SBarry Smith @*/ 2755efd51863SBarry Smith PetscErrorCode SNESSetGridSequence(SNES snes,PetscInt steps) 2756efd51863SBarry Smith { 2757efd51863SBarry Smith PetscFunctionBegin; 2758efd51863SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2759efd51863SBarry Smith PetscValidLogicalCollectiveInt(snes,steps,2); 2760efd51863SBarry Smith snes->gridsequence = steps; 2761efd51863SBarry Smith PetscFunctionReturn(0); 2762efd51863SBarry Smith } 2763efd51863SBarry Smith 2764efd51863SBarry Smith #undef __FUNCT__ 2765a8054027SBarry Smith #define __FUNCT__ "SNESGetLagPreconditioner" 2766a8054027SBarry Smith /*@ 2767a8054027SBarry Smith SNESGetLagPreconditioner - Indicates how often the preconditioner is rebuilt 2768a8054027SBarry Smith 27693f9fe445SBarry Smith Not Collective 2770a8054027SBarry Smith 2771a8054027SBarry Smith Input Parameter: 2772a8054027SBarry Smith . snes - the SNES context 2773a8054027SBarry Smith 2774a8054027SBarry Smith Output Parameter: 2775a8054027SBarry Smith . lag - -1 indicates NEVER rebuild, 1 means rebuild every time the Jacobian is computed within a single nonlinear solve, 2 means every second time 27763b4f5425SBarry Smith the Jacobian is built etc. -2 indicates rebuild preconditioner at next chance but then never rebuild after that 2777a8054027SBarry Smith 2778a8054027SBarry Smith Options Database Keys: 2779a8054027SBarry Smith . -snes_lag_preconditioner <lag> 2780a8054027SBarry Smith 2781a8054027SBarry Smith Notes: 2782a8054027SBarry Smith The default is 1 2783a8054027SBarry Smith The preconditioner is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1 2784a8054027SBarry Smith 2785a8054027SBarry Smith Level: intermediate 2786a8054027SBarry Smith 2787a8054027SBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2788a8054027SBarry Smith 2789a8054027SBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagPreconditioner() 2790a8054027SBarry Smith 2791a8054027SBarry Smith @*/ 27927087cfbeSBarry Smith PetscErrorCode SNESGetLagPreconditioner(SNES snes,PetscInt *lag) 2793a8054027SBarry Smith { 2794a8054027SBarry Smith PetscFunctionBegin; 27950700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2796a8054027SBarry Smith *lag = snes->lagpreconditioner; 2797a8054027SBarry Smith PetscFunctionReturn(0); 2798a8054027SBarry Smith } 2799a8054027SBarry Smith 2800a8054027SBarry Smith #undef __FUNCT__ 2801e35cf81dSBarry Smith #define __FUNCT__ "SNESSetLagJacobian" 2802e35cf81dSBarry Smith /*@ 2803e35cf81dSBarry Smith SNESSetLagJacobian - Determines when the Jacobian is rebuilt in the nonlinear solve. See SNESSetLagPreconditioner() for determining how 2804e35cf81dSBarry Smith often the preconditioner is rebuilt. 2805e35cf81dSBarry Smith 28063f9fe445SBarry Smith Logically Collective on SNES 2807e35cf81dSBarry Smith 2808e35cf81dSBarry Smith Input Parameters: 2809e35cf81dSBarry Smith + snes - the SNES context 2810e35cf81dSBarry Smith - lag - -1 indicates NEVER rebuild, 1 means rebuild every time the Jacobian is computed within a single nonlinear solve, 2 means every second time 2811fe3ffe1eSBarry Smith the Jacobian is built etc. -2 means rebuild at next chance but then never again 2812e35cf81dSBarry Smith 2813e35cf81dSBarry Smith Options Database Keys: 2814e35cf81dSBarry Smith . -snes_lag_jacobian <lag> 2815e35cf81dSBarry Smith 2816e35cf81dSBarry Smith Notes: 2817e35cf81dSBarry Smith The default is 1 2818e35cf81dSBarry Smith The Jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1 2819fe3ffe1eSBarry Smith If -1 is used before the very first nonlinear solve the CODE WILL FAIL! because no Jacobian is used, use -2 to indicate you want it recomputed 2820fe3ffe1eSBarry Smith at the next Newton step but never again (unless it is reset to another value) 2821e35cf81dSBarry Smith 2822e35cf81dSBarry Smith Level: intermediate 2823e35cf81dSBarry Smith 2824e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2825e35cf81dSBarry Smith 2826e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESGetLagPreconditioner(), SNESSetLagPreconditioner(), SNESGetLagJacobian() 2827e35cf81dSBarry Smith 2828e35cf81dSBarry Smith @*/ 28297087cfbeSBarry Smith PetscErrorCode SNESSetLagJacobian(SNES snes,PetscInt lag) 2830e35cf81dSBarry Smith { 2831e35cf81dSBarry Smith PetscFunctionBegin; 28320700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2833e32f2f54SBarry Smith if (lag < -2) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag must be -2, -1, 1 or greater"); 2834e32f2f54SBarry Smith if (!lag) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Lag cannot be 0"); 2835c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,lag,2); 2836e35cf81dSBarry Smith snes->lagjacobian = lag; 2837e35cf81dSBarry Smith PetscFunctionReturn(0); 2838e35cf81dSBarry Smith } 2839e35cf81dSBarry Smith 2840e35cf81dSBarry Smith #undef __FUNCT__ 2841e35cf81dSBarry Smith #define __FUNCT__ "SNESGetLagJacobian" 2842e35cf81dSBarry Smith /*@ 2843e35cf81dSBarry Smith SNESGetLagJacobian - Indicates how often the Jacobian is rebuilt. See SNESGetLagPreconditioner() to determine when the preconditioner is rebuilt 2844e35cf81dSBarry Smith 28453f9fe445SBarry Smith Not Collective 2846e35cf81dSBarry Smith 2847e35cf81dSBarry Smith Input Parameter: 2848e35cf81dSBarry Smith . snes - the SNES context 2849e35cf81dSBarry Smith 2850e35cf81dSBarry Smith Output Parameter: 2851e35cf81dSBarry Smith . lag - -1 indicates NEVER rebuild, 1 means rebuild every time the Jacobian is computed within a single nonlinear solve, 2 means every second time 2852e35cf81dSBarry Smith the Jacobian is built etc. 2853e35cf81dSBarry Smith 2854e35cf81dSBarry Smith Options Database Keys: 2855e35cf81dSBarry Smith . -snes_lag_jacobian <lag> 2856e35cf81dSBarry Smith 2857e35cf81dSBarry Smith Notes: 2858e35cf81dSBarry Smith The default is 1 2859e35cf81dSBarry Smith The jacobian is ALWAYS built in the first iteration of a nonlinear solve unless lag is -1 2860e35cf81dSBarry Smith 2861e35cf81dSBarry Smith Level: intermediate 2862e35cf81dSBarry Smith 2863e35cf81dSBarry Smith .keywords: SNES, nonlinear, set, convergence, tolerances 2864e35cf81dSBarry Smith 2865e35cf81dSBarry Smith .seealso: SNESSetTrustRegionTolerance(), SNESSetLagJacobian(), SNESSetLagPreconditioner(), SNESGetLagPreconditioner() 2866e35cf81dSBarry Smith 2867e35cf81dSBarry Smith @*/ 28687087cfbeSBarry Smith PetscErrorCode SNESGetLagJacobian(SNES snes,PetscInt *lag) 2869e35cf81dSBarry Smith { 2870e35cf81dSBarry Smith PetscFunctionBegin; 28710700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2872e35cf81dSBarry Smith *lag = snes->lagjacobian; 2873e35cf81dSBarry Smith PetscFunctionReturn(0); 2874e35cf81dSBarry Smith } 2875e35cf81dSBarry Smith 2876e35cf81dSBarry Smith #undef __FUNCT__ 28774a2ae208SSatish Balay #define __FUNCT__ "SNESSetTolerances" 28789b94acceSBarry Smith /*@ 2879d7a720efSLois Curfman McInnes SNESSetTolerances - Sets various parameters used in convergence tests. 28809b94acceSBarry Smith 28813f9fe445SBarry Smith Logically Collective on SNES 2882c7afd0dbSLois Curfman McInnes 28839b94acceSBarry Smith Input Parameters: 2884c7afd0dbSLois Curfman McInnes + snes - the SNES context 288570441072SBarry Smith . abstol - absolute convergence tolerance 288633174efeSLois Curfman McInnes . rtol - relative convergence tolerance 28875358d0d4SBarry Smith . stol - convergence tolerance in terms of the norm of the change in the solution between steps, || delta x || < stol*|| x || 288833174efeSLois Curfman McInnes . maxit - maximum number of iterations 2889c7afd0dbSLois Curfman McInnes - maxf - maximum number of function evaluations 2890fee21e36SBarry Smith 289133174efeSLois Curfman McInnes Options Database Keys: 289270441072SBarry Smith + -snes_atol <abstol> - Sets abstol 2893c7afd0dbSLois Curfman McInnes . -snes_rtol <rtol> - Sets rtol 2894c7afd0dbSLois Curfman McInnes . -snes_stol <stol> - Sets stol 2895c7afd0dbSLois Curfman McInnes . -snes_max_it <maxit> - Sets maxit 2896c7afd0dbSLois Curfman McInnes - -snes_max_funcs <maxf> - Sets maxf 28979b94acceSBarry Smith 2898d7a720efSLois Curfman McInnes Notes: 28999b94acceSBarry Smith The default maximum number of iterations is 50. 29009b94acceSBarry Smith The default maximum number of function evaluations is 1000. 29019b94acceSBarry Smith 290236851e7fSLois Curfman McInnes Level: intermediate 290336851e7fSLois Curfman McInnes 290433174efeSLois Curfman McInnes .keywords: SNES, nonlinear, set, convergence, tolerances 29059b94acceSBarry Smith 29062492ecdbSBarry Smith .seealso: SNESSetTrustRegionTolerance() 29079b94acceSBarry Smith @*/ 29087087cfbeSBarry Smith PetscErrorCode SNESSetTolerances(SNES snes,PetscReal abstol,PetscReal rtol,PetscReal stol,PetscInt maxit,PetscInt maxf) 29099b94acceSBarry Smith { 29103a40ed3dSBarry Smith PetscFunctionBegin; 29110700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 2912c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,abstol,2); 2913c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,rtol,3); 2914c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,stol,4); 2915c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,maxit,5); 2916c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,maxf,6); 2917c5eb9154SBarry Smith 2918ab54825eSJed Brown if (abstol != PETSC_DEFAULT) { 2919*ce94432eSBarry Smith if (abstol < 0.0) SETERRQ1(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_OUTOFRANGE,"Absolute tolerance %G must be non-negative",abstol); 2920ab54825eSJed Brown snes->abstol = abstol; 2921ab54825eSJed Brown } 2922ab54825eSJed Brown if (rtol != PETSC_DEFAULT) { 2923*ce94432eSBarry Smith if (rtol < 0.0 || 1.0 <= rtol) SETERRQ1(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_OUTOFRANGE,"Relative tolerance %G must be non-negative and less than 1.0",rtol); 2924ab54825eSJed Brown snes->rtol = rtol; 2925ab54825eSJed Brown } 2926ab54825eSJed Brown if (stol != PETSC_DEFAULT) { 2927*ce94432eSBarry Smith if (stol < 0.0) SETERRQ1(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_OUTOFRANGE,"Step tolerance %G must be non-negative",stol); 2928c60f73f4SPeter Brune snes->stol = stol; 2929ab54825eSJed Brown } 2930ab54825eSJed Brown if (maxit != PETSC_DEFAULT) { 2931*ce94432eSBarry Smith if (maxit < 0) SETERRQ1(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of iterations %D must be non-negative",maxit); 2932ab54825eSJed Brown snes->max_its = maxit; 2933ab54825eSJed Brown } 2934ab54825eSJed Brown if (maxf != PETSC_DEFAULT) { 2935*ce94432eSBarry Smith if (maxf < 0) SETERRQ1(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of function evaluations %D must be non-negative",maxf); 2936ab54825eSJed Brown snes->max_funcs = maxf; 2937ab54825eSJed Brown } 293888976e71SPeter Brune snes->tolerancesset = PETSC_TRUE; 29393a40ed3dSBarry Smith PetscFunctionReturn(0); 29409b94acceSBarry Smith } 29419b94acceSBarry Smith 29424a2ae208SSatish Balay #undef __FUNCT__ 29434a2ae208SSatish Balay #define __FUNCT__ "SNESGetTolerances" 29449b94acceSBarry Smith /*@ 294533174efeSLois Curfman McInnes SNESGetTolerances - Gets various parameters used in convergence tests. 294633174efeSLois Curfman McInnes 2947c7afd0dbSLois Curfman McInnes Not Collective 2948c7afd0dbSLois Curfman McInnes 294933174efeSLois Curfman McInnes Input Parameters: 2950c7afd0dbSLois Curfman McInnes + snes - the SNES context 295185385478SLisandro Dalcin . atol - absolute convergence tolerance 295233174efeSLois Curfman McInnes . rtol - relative convergence tolerance 295333174efeSLois Curfman McInnes . stol - convergence tolerance in terms of the norm 295433174efeSLois Curfman McInnes of the change in the solution between steps 295533174efeSLois Curfman McInnes . maxit - maximum number of iterations 2956c7afd0dbSLois Curfman McInnes - maxf - maximum number of function evaluations 2957fee21e36SBarry Smith 295833174efeSLois Curfman McInnes Notes: 29590298fd71SBarry Smith The user can specify NULL for any parameter that is not needed. 296033174efeSLois Curfman McInnes 296136851e7fSLois Curfman McInnes Level: intermediate 296236851e7fSLois Curfman McInnes 296333174efeSLois Curfman McInnes .keywords: SNES, nonlinear, get, convergence, tolerances 296433174efeSLois Curfman McInnes 296533174efeSLois Curfman McInnes .seealso: SNESSetTolerances() 296633174efeSLois Curfman McInnes @*/ 29677087cfbeSBarry Smith PetscErrorCode SNESGetTolerances(SNES snes,PetscReal *atol,PetscReal *rtol,PetscReal *stol,PetscInt *maxit,PetscInt *maxf) 296833174efeSLois Curfman McInnes { 29693a40ed3dSBarry Smith PetscFunctionBegin; 29700700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 297185385478SLisandro Dalcin if (atol) *atol = snes->abstol; 297233174efeSLois Curfman McInnes if (rtol) *rtol = snes->rtol; 2973c60f73f4SPeter Brune if (stol) *stol = snes->stol; 297433174efeSLois Curfman McInnes if (maxit) *maxit = snes->max_its; 297533174efeSLois Curfman McInnes if (maxf) *maxf = snes->max_funcs; 29763a40ed3dSBarry Smith PetscFunctionReturn(0); 297733174efeSLois Curfman McInnes } 297833174efeSLois Curfman McInnes 29794a2ae208SSatish Balay #undef __FUNCT__ 29804a2ae208SSatish Balay #define __FUNCT__ "SNESSetTrustRegionTolerance" 298133174efeSLois Curfman McInnes /*@ 29829b94acceSBarry Smith SNESSetTrustRegionTolerance - Sets the trust region parameter tolerance. 29839b94acceSBarry Smith 29843f9fe445SBarry Smith Logically Collective on SNES 2985fee21e36SBarry Smith 2986c7afd0dbSLois Curfman McInnes Input Parameters: 2987c7afd0dbSLois Curfman McInnes + snes - the SNES context 2988c7afd0dbSLois Curfman McInnes - tol - tolerance 2989c7afd0dbSLois Curfman McInnes 29909b94acceSBarry Smith Options Database Key: 2991c7afd0dbSLois Curfman McInnes . -snes_trtol <tol> - Sets tol 29929b94acceSBarry Smith 299336851e7fSLois Curfman McInnes Level: intermediate 299436851e7fSLois Curfman McInnes 29959b94acceSBarry Smith .keywords: SNES, nonlinear, set, trust region, tolerance 29969b94acceSBarry Smith 29972492ecdbSBarry Smith .seealso: SNESSetTolerances() 29989b94acceSBarry Smith @*/ 29997087cfbeSBarry Smith PetscErrorCode SNESSetTrustRegionTolerance(SNES snes,PetscReal tol) 30009b94acceSBarry Smith { 30013a40ed3dSBarry Smith PetscFunctionBegin; 30020700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3003c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,tol,2); 30049b94acceSBarry Smith snes->deltatol = tol; 30053a40ed3dSBarry Smith PetscFunctionReturn(0); 30069b94acceSBarry Smith } 30079b94acceSBarry Smith 3008df9fa365SBarry Smith /* 3009df9fa365SBarry Smith Duplicate the lg monitors for SNES from KSP; for some reason with 3010df9fa365SBarry Smith dynamic libraries things don't work under Sun4 if we just use 3011df9fa365SBarry Smith macros instead of functions 3012df9fa365SBarry Smith */ 30134a2ae208SSatish Balay #undef __FUNCT__ 30144619e776SBarry Smith #define __FUNCT__ "SNESMonitorLGResidualNorm" 30154619e776SBarry Smith PetscErrorCode SNESMonitorLGResidualNorm(SNES snes,PetscInt it,PetscReal norm,void *ctx) 3016ce1608b8SBarry Smith { 3017dfbe8321SBarry Smith PetscErrorCode ierr; 3018ce1608b8SBarry Smith 3019ce1608b8SBarry Smith PetscFunctionBegin; 30200700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 30211d1e9da1SBarry Smith ierr = KSPMonitorLGResidualNorm((KSP)snes,it,norm,ctx);CHKERRQ(ierr); 3022ce1608b8SBarry Smith PetscFunctionReturn(0); 3023ce1608b8SBarry Smith } 3024ce1608b8SBarry Smith 30254a2ae208SSatish Balay #undef __FUNCT__ 3026a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGCreate" 30277087cfbeSBarry Smith PetscErrorCode SNESMonitorLGCreate(const char host[],const char label[],int x,int y,int m,int n,PetscDrawLG *draw) 3028df9fa365SBarry Smith { 3029dfbe8321SBarry Smith PetscErrorCode ierr; 3030df9fa365SBarry Smith 3031df9fa365SBarry Smith PetscFunctionBegin; 30321d1e9da1SBarry Smith ierr = KSPMonitorLGResidualNormCreate(host,label,x,y,m,n,draw);CHKERRQ(ierr); 3033df9fa365SBarry Smith PetscFunctionReturn(0); 3034df9fa365SBarry Smith } 3035df9fa365SBarry Smith 30364a2ae208SSatish Balay #undef __FUNCT__ 3037a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorLGDestroy" 30386bf464f9SBarry Smith PetscErrorCode SNESMonitorLGDestroy(PetscDrawLG *draw) 3039df9fa365SBarry Smith { 3040dfbe8321SBarry Smith PetscErrorCode ierr; 3041df9fa365SBarry Smith 3042df9fa365SBarry Smith PetscFunctionBegin; 30431d1e9da1SBarry Smith ierr = KSPMonitorLGResidualNormDestroy(draw);CHKERRQ(ierr); 3044df9fa365SBarry Smith PetscFunctionReturn(0); 3045df9fa365SBarry Smith } 3046df9fa365SBarry Smith 30477087cfbeSBarry Smith extern PetscErrorCode SNESMonitorRange_Private(SNES,PetscInt,PetscReal*); 3048b271bb04SBarry Smith #undef __FUNCT__ 3049b271bb04SBarry Smith #define __FUNCT__ "SNESMonitorLGRange" 30507087cfbeSBarry Smith PetscErrorCode SNESMonitorLGRange(SNES snes,PetscInt n,PetscReal rnorm,void *monctx) 3051b271bb04SBarry Smith { 3052b271bb04SBarry Smith PetscDrawLG lg; 3053b271bb04SBarry Smith PetscErrorCode ierr; 3054b271bb04SBarry Smith PetscReal x,y,per; 3055b271bb04SBarry Smith PetscViewer v = (PetscViewer)monctx; 3056b271bb04SBarry Smith static PetscReal prev; /* should be in the context */ 3057b271bb04SBarry Smith PetscDraw draw; 3058b271bb04SBarry Smith 3059459f5d12SBarry Smith PetscFunctionBegin; 3060b271bb04SBarry Smith ierr = PetscViewerDrawGetDrawLG(v,0,&lg);CHKERRQ(ierr); 3061b271bb04SBarry Smith if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 3062b271bb04SBarry Smith ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr); 3063b271bb04SBarry Smith ierr = PetscDrawSetTitle(draw,"Residual norm");CHKERRQ(ierr); 3064b271bb04SBarry Smith x = (PetscReal)n; 306594c9c6d3SKarl Rupp if (rnorm > 0.0) y = log10(rnorm); 306694c9c6d3SKarl Rupp else y = -15.0; 3067b271bb04SBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 3068b271bb04SBarry Smith if (n < 20 || !(n % 5)) { 3069b271bb04SBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 3070b271bb04SBarry Smith } 3071b271bb04SBarry Smith 3072b271bb04SBarry Smith ierr = PetscViewerDrawGetDrawLG(v,1,&lg);CHKERRQ(ierr); 3073b271bb04SBarry Smith if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 3074b271bb04SBarry Smith ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr); 3075b271bb04SBarry Smith ierr = PetscDrawSetTitle(draw,"% elemts > .2*max elemt");CHKERRQ(ierr); 3076b271bb04SBarry Smith ierr = SNESMonitorRange_Private(snes,n,&per);CHKERRQ(ierr); 3077b271bb04SBarry Smith x = (PetscReal)n; 3078b271bb04SBarry Smith y = 100.0*per; 3079b271bb04SBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 3080b271bb04SBarry Smith if (n < 20 || !(n % 5)) { 3081b271bb04SBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 3082b271bb04SBarry Smith } 3083b271bb04SBarry Smith 3084b271bb04SBarry Smith ierr = PetscViewerDrawGetDrawLG(v,2,&lg);CHKERRQ(ierr); 3085b271bb04SBarry Smith if (!n) {prev = rnorm;ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 3086b271bb04SBarry Smith ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr); 3087b271bb04SBarry Smith ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm");CHKERRQ(ierr); 3088b271bb04SBarry Smith x = (PetscReal)n; 3089b271bb04SBarry Smith y = (prev - rnorm)/prev; 3090b271bb04SBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 3091b271bb04SBarry Smith if (n < 20 || !(n % 5)) { 3092b271bb04SBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 3093b271bb04SBarry Smith } 3094b271bb04SBarry Smith 3095b271bb04SBarry Smith ierr = PetscViewerDrawGetDrawLG(v,3,&lg);CHKERRQ(ierr); 3096b271bb04SBarry Smith if (!n) {ierr = PetscDrawLGReset(lg);CHKERRQ(ierr);} 3097b271bb04SBarry Smith ierr = PetscDrawLGGetDraw(lg,&draw);CHKERRQ(ierr); 3098b271bb04SBarry Smith ierr = PetscDrawSetTitle(draw,"(norm -oldnorm)/oldnorm*(% > .2 max)");CHKERRQ(ierr); 3099b271bb04SBarry Smith x = (PetscReal)n; 3100b271bb04SBarry Smith y = (prev - rnorm)/(prev*per); 3101b271bb04SBarry Smith if (n > 2) { /*skip initial crazy value */ 3102b271bb04SBarry Smith ierr = PetscDrawLGAddPoint(lg,&x,&y);CHKERRQ(ierr); 3103b271bb04SBarry Smith } 3104b271bb04SBarry Smith if (n < 20 || !(n % 5)) { 3105b271bb04SBarry Smith ierr = PetscDrawLGDraw(lg);CHKERRQ(ierr); 3106b271bb04SBarry Smith } 3107b271bb04SBarry Smith prev = rnorm; 3108b271bb04SBarry Smith PetscFunctionReturn(0); 3109b271bb04SBarry Smith } 3110b271bb04SBarry Smith 3111b271bb04SBarry Smith #undef __FUNCT__ 31127a03ce2fSLisandro Dalcin #define __FUNCT__ "SNESMonitor" 3113228d79bcSJed Brown /*@ 3114228d79bcSJed Brown SNESMonitor - runs the user provided monitor routines, if they exist 3115228d79bcSJed Brown 3116228d79bcSJed Brown Collective on SNES 3117228d79bcSJed Brown 3118228d79bcSJed Brown Input Parameters: 3119228d79bcSJed Brown + snes - nonlinear solver context obtained from SNESCreate() 3120228d79bcSJed Brown . iter - iteration number 3121228d79bcSJed Brown - rnorm - relative norm of the residual 3122228d79bcSJed Brown 3123228d79bcSJed Brown Notes: 3124228d79bcSJed Brown This routine is called by the SNES implementations. 3125228d79bcSJed Brown It does not typically need to be called by the user. 3126228d79bcSJed Brown 3127228d79bcSJed Brown Level: developer 3128228d79bcSJed Brown 3129228d79bcSJed Brown .seealso: SNESMonitorSet() 3130228d79bcSJed Brown @*/ 31317a03ce2fSLisandro Dalcin PetscErrorCode SNESMonitor(SNES snes,PetscInt iter,PetscReal rnorm) 31327a03ce2fSLisandro Dalcin { 31337a03ce2fSLisandro Dalcin PetscErrorCode ierr; 31347a03ce2fSLisandro Dalcin PetscInt i,n = snes->numbermonitors; 31357a03ce2fSLisandro Dalcin 31367a03ce2fSLisandro Dalcin PetscFunctionBegin; 31377a03ce2fSLisandro Dalcin for (i=0; i<n; i++) { 31387a03ce2fSLisandro Dalcin ierr = (*snes->monitor[i])(snes,iter,rnorm,snes->monitorcontext[i]);CHKERRQ(ierr); 31397a03ce2fSLisandro Dalcin } 31407a03ce2fSLisandro Dalcin PetscFunctionReturn(0); 31417a03ce2fSLisandro Dalcin } 31427a03ce2fSLisandro Dalcin 31439b94acceSBarry Smith /* ------------ Routines to set performance monitoring options ----------- */ 31449b94acceSBarry Smith 3145bf388a1fSBarry Smith /*MC 3146bf388a1fSBarry Smith SNESMonitorFunction - functional form passed to SNESMonitorSet() to monitor convergence of nonlinear solver 3147bf388a1fSBarry Smith 3148bf388a1fSBarry Smith Synopsis: 3149bf388a1fSBarry Smith #include "petscsnes.h" 3150bf388a1fSBarry Smith $ PetscErrorCode SNESMonitorFunction(SNES snes,PetscInt its, PetscReal norm,void *mctx) 3151bf388a1fSBarry Smith 3152bf388a1fSBarry Smith + snes - the SNES context 3153bf388a1fSBarry Smith . its - iteration number 3154bf388a1fSBarry Smith . norm - 2-norm function value (may be estimated) 3155bf388a1fSBarry Smith - mctx - [optional] monitoring context 3156bf388a1fSBarry Smith 3157bf388a1fSBarry Smith .seealso: SNESMonitorSet(), SNESMonitorGet() 3158bf388a1fSBarry Smith M*/ 3159bf388a1fSBarry Smith 31604a2ae208SSatish Balay #undef __FUNCT__ 3161a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorSet" 31629b94acceSBarry Smith /*@C 3163a6570f20SBarry Smith SNESMonitorSet - Sets an ADDITIONAL function that is to be used at every 31649b94acceSBarry Smith iteration of the nonlinear solver to display the iteration's 31659b94acceSBarry Smith progress. 31669b94acceSBarry Smith 31673f9fe445SBarry Smith Logically Collective on SNES 3168fee21e36SBarry Smith 3169c7afd0dbSLois Curfman McInnes Input Parameters: 3170c7afd0dbSLois Curfman McInnes + snes - the SNES context 3171bf388a1fSBarry Smith . SNESMonitorFunction - monitoring routine 3172b8a78c4aSBarry Smith . mctx - [optional] user-defined context for private data for the 31730298fd71SBarry Smith monitor routine (use NULL if no context is desired) 3174b3006f0bSLois Curfman McInnes - monitordestroy - [optional] routine that frees monitor context 31750298fd71SBarry Smith (may be NULL) 31769b94acceSBarry Smith 31779665c990SLois Curfman McInnes Options Database Keys: 3178a6570f20SBarry Smith + -snes_monitor - sets SNESMonitorDefault() 31794619e776SBarry Smith . -snes_monitor_lg_residualnorm - sets line graph monitor, 3180a6570f20SBarry Smith uses SNESMonitorLGCreate() 3181cca6129bSJed Brown - -snes_monitor_cancel - cancels all monitors that have 3182c7afd0dbSLois Curfman McInnes been hardwired into a code by 3183a6570f20SBarry Smith calls to SNESMonitorSet(), but 3184c7afd0dbSLois Curfman McInnes does not cancel those set via 3185c7afd0dbSLois Curfman McInnes the options database. 31869665c990SLois Curfman McInnes 3187639f9d9dSBarry Smith Notes: 31886bc08f3fSLois Curfman McInnes Several different monitoring routines may be set by calling 3189a6570f20SBarry Smith SNESMonitorSet() multiple times; all will be called in the 31906bc08f3fSLois Curfman McInnes order in which they were set. 3191639f9d9dSBarry Smith 3192025f1a04SBarry Smith Fortran notes: Only a single monitor function can be set for each SNES object 3193025f1a04SBarry Smith 319436851e7fSLois Curfman McInnes Level: intermediate 319536851e7fSLois Curfman McInnes 31969b94acceSBarry Smith .keywords: SNES, nonlinear, set, monitor 31979b94acceSBarry Smith 3198bf388a1fSBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorCancel(), SNESMonitorFunction 31999b94acceSBarry Smith @*/ 3200bf388a1fSBarry Smith PetscErrorCode SNESMonitorSet(SNES snes,PetscErrorCode (*SNESMonitorFunction)(SNES,PetscInt,PetscReal,void*),void *mctx,PetscErrorCode (*monitordestroy)(void**)) 32019b94acceSBarry Smith { 3202b90d0a6eSBarry Smith PetscInt i; 3203649052a6SBarry Smith PetscErrorCode ierr; 3204b90d0a6eSBarry Smith 32053a40ed3dSBarry Smith PetscFunctionBegin; 32060700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 320717186662SBarry Smith if (snes->numbermonitors >= MAXSNESMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set"); 3208b90d0a6eSBarry Smith for (i=0; i<snes->numbermonitors;i++) { 3209bf388a1fSBarry Smith if (SNESMonitorFunction == snes->monitor[i] && monitordestroy == snes->monitordestroy[i] && mctx == snes->monitorcontext[i]) { 3210649052a6SBarry Smith if (monitordestroy) { 3211c2efdce3SBarry Smith ierr = (*monitordestroy)(&mctx);CHKERRQ(ierr); 3212649052a6SBarry Smith } 3213b90d0a6eSBarry Smith PetscFunctionReturn(0); 3214b90d0a6eSBarry Smith } 3215b90d0a6eSBarry Smith } 3216bf388a1fSBarry Smith snes->monitor[snes->numbermonitors] = SNESMonitorFunction; 3217b8a78c4aSBarry Smith snes->monitordestroy[snes->numbermonitors] = monitordestroy; 3218639f9d9dSBarry Smith snes->monitorcontext[snes->numbermonitors++] = (void*)mctx; 32193a40ed3dSBarry Smith PetscFunctionReturn(0); 32209b94acceSBarry Smith } 32219b94acceSBarry Smith 32224a2ae208SSatish Balay #undef __FUNCT__ 3223a6570f20SBarry Smith #define __FUNCT__ "SNESMonitorCancel" 32245cd90555SBarry Smith /*@C 3225a6570f20SBarry Smith SNESMonitorCancel - Clears all the monitor functions for a SNES object. 32265cd90555SBarry Smith 32273f9fe445SBarry Smith Logically Collective on SNES 3228c7afd0dbSLois Curfman McInnes 32295cd90555SBarry Smith Input Parameters: 32305cd90555SBarry Smith . snes - the SNES context 32315cd90555SBarry Smith 32321a480d89SAdministrator Options Database Key: 3233a6570f20SBarry Smith . -snes_monitor_cancel - cancels all monitors that have been hardwired 3234a6570f20SBarry Smith into a code by calls to SNESMonitorSet(), but does not cancel those 3235c7afd0dbSLois Curfman McInnes set via the options database 32365cd90555SBarry Smith 32375cd90555SBarry Smith Notes: 32385cd90555SBarry Smith There is no way to clear one specific monitor from a SNES object. 32395cd90555SBarry Smith 324036851e7fSLois Curfman McInnes Level: intermediate 324136851e7fSLois Curfman McInnes 32425cd90555SBarry Smith .keywords: SNES, nonlinear, set, monitor 32435cd90555SBarry Smith 3244a6570f20SBarry Smith .seealso: SNESMonitorDefault(), SNESMonitorSet() 32455cd90555SBarry Smith @*/ 32467087cfbeSBarry Smith PetscErrorCode SNESMonitorCancel(SNES snes) 32475cd90555SBarry Smith { 3248d952e501SBarry Smith PetscErrorCode ierr; 3249d952e501SBarry Smith PetscInt i; 3250d952e501SBarry Smith 32515cd90555SBarry Smith PetscFunctionBegin; 32520700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3253d952e501SBarry Smith for (i=0; i<snes->numbermonitors; i++) { 3254d952e501SBarry Smith if (snes->monitordestroy[i]) { 32553c4aec1bSBarry Smith ierr = (*snes->monitordestroy[i])(&snes->monitorcontext[i]);CHKERRQ(ierr); 3256d952e501SBarry Smith } 3257d952e501SBarry Smith } 32585cd90555SBarry Smith snes->numbermonitors = 0; 32595cd90555SBarry Smith PetscFunctionReturn(0); 32605cd90555SBarry Smith } 32615cd90555SBarry Smith 3262bf388a1fSBarry Smith /*MC 3263bf388a1fSBarry Smith SNESConvergenceTestFunction - functional form used for testing of convergence of nonlinear solver 3264bf388a1fSBarry Smith 3265bf388a1fSBarry Smith Synopsis: 3266bf388a1fSBarry Smith #include "petscsnes.h" 3267bf388a1fSBarry Smith $ PetscErrorCode SNESConvergenceTest(SNES snes,PetscInt it,PetscReal xnorm,PetscReal gnorm,PetscReal f,SNESConvergedReason *reason,void *cctx) 3268bf388a1fSBarry Smith 3269bf388a1fSBarry Smith + snes - the SNES context 3270bf388a1fSBarry Smith . it - current iteration (0 is the first and is before any Newton step) 3271bf388a1fSBarry Smith . cctx - [optional] convergence context 3272bf388a1fSBarry Smith . reason - reason for convergence/divergence 3273bf388a1fSBarry Smith . xnorm - 2-norm of current iterate 3274bf388a1fSBarry Smith . gnorm - 2-norm of current step 3275bf388a1fSBarry Smith - f - 2-norm of function 3276bf388a1fSBarry Smith 3277bf388a1fSBarry Smith 3278bf388a1fSBarry Smith .seealso: SNESSetConvergenceTest(), SNESGetConvergenceTest() 3279bf388a1fSBarry Smith M*/ 3280bf388a1fSBarry Smith 32814a2ae208SSatish Balay #undef __FUNCT__ 32824a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceTest" 32839b94acceSBarry Smith /*@C 32849b94acceSBarry Smith SNESSetConvergenceTest - Sets the function that is to be used 32859b94acceSBarry Smith to test for convergence of the nonlinear iterative solution. 32869b94acceSBarry Smith 32873f9fe445SBarry Smith Logically Collective on SNES 3288fee21e36SBarry Smith 3289c7afd0dbSLois Curfman McInnes Input Parameters: 3290c7afd0dbSLois Curfman McInnes + snes - the SNES context 3291bf388a1fSBarry Smith . SNESConvergenceTestFunction - routine to test for convergence 32920298fd71SBarry Smith . cctx - [optional] context for private data for the convergence routine (may be NULL) 32930298fd71SBarry Smith - destroy - [optional] destructor for the context (may be NULL; NULL_FUNCTION in Fortran) 32949b94acceSBarry Smith 329536851e7fSLois Curfman McInnes Level: advanced 329636851e7fSLois Curfman McInnes 32979b94acceSBarry Smith .keywords: SNES, nonlinear, set, convergence, test 32989b94acceSBarry Smith 3299bf388a1fSBarry Smith .seealso: SNESDefaultConverged(), SNESSkipConverged(), SNESConvergenceTestFunction 33009b94acceSBarry Smith @*/ 3301bf388a1fSBarry Smith PetscErrorCode SNESSetConvergenceTest(SNES snes,PetscErrorCode (*SNESConvergenceTestFunction)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void *cctx,PetscErrorCode (*destroy)(void*)) 33029b94acceSBarry Smith { 33037f7931b9SBarry Smith PetscErrorCode ierr; 33047f7931b9SBarry Smith 33053a40ed3dSBarry Smith PetscFunctionBegin; 33060700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3307bf388a1fSBarry Smith if (!SNESConvergenceTestFunction) SNESConvergenceTestFunction = SNESSkipConverged; 33087f7931b9SBarry Smith if (snes->ops->convergeddestroy) { 33097f7931b9SBarry Smith ierr = (*snes->ops->convergeddestroy)(snes->cnvP);CHKERRQ(ierr); 33107f7931b9SBarry Smith } 3311bf388a1fSBarry Smith snes->ops->converged = SNESConvergenceTestFunction; 33127f7931b9SBarry Smith snes->ops->convergeddestroy = destroy; 331385385478SLisandro Dalcin snes->cnvP = cctx; 33143a40ed3dSBarry Smith PetscFunctionReturn(0); 33159b94acceSBarry Smith } 33169b94acceSBarry Smith 33174a2ae208SSatish Balay #undef __FUNCT__ 33184a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergedReason" 331952baeb72SSatish Balay /*@ 3320184914b5SBarry Smith SNESGetConvergedReason - Gets the reason the SNES iteration was stopped. 3321184914b5SBarry Smith 3322184914b5SBarry Smith Not Collective 3323184914b5SBarry Smith 3324184914b5SBarry Smith Input Parameter: 3325184914b5SBarry Smith . snes - the SNES context 3326184914b5SBarry Smith 3327184914b5SBarry Smith Output Parameter: 33284d0a8057SBarry Smith . reason - negative value indicates diverged, positive value converged, see SNESConvergedReason or the 3329184914b5SBarry Smith manual pages for the individual convergence tests for complete lists 3330184914b5SBarry Smith 3331184914b5SBarry Smith Level: intermediate 3332184914b5SBarry Smith 3333184914b5SBarry Smith Notes: Can only be called after the call the SNESSolve() is complete. 3334184914b5SBarry Smith 3335184914b5SBarry Smith .keywords: SNES, nonlinear, set, convergence, test 3336184914b5SBarry Smith 333785385478SLisandro Dalcin .seealso: SNESSetConvergenceTest(), SNESConvergedReason 3338184914b5SBarry Smith @*/ 33397087cfbeSBarry Smith PetscErrorCode SNESGetConvergedReason(SNES snes,SNESConvergedReason *reason) 3340184914b5SBarry Smith { 3341184914b5SBarry Smith PetscFunctionBegin; 33420700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 33434482741eSBarry Smith PetscValidPointer(reason,2); 3344184914b5SBarry Smith *reason = snes->reason; 3345184914b5SBarry Smith PetscFunctionReturn(0); 3346184914b5SBarry Smith } 3347184914b5SBarry Smith 33484a2ae208SSatish Balay #undef __FUNCT__ 33494a2ae208SSatish Balay #define __FUNCT__ "SNESSetConvergenceHistory" 3350c9005455SLois Curfman McInnes /*@ 3351c9005455SLois Curfman McInnes SNESSetConvergenceHistory - Sets the array used to hold the convergence history. 3352c9005455SLois Curfman McInnes 33533f9fe445SBarry Smith Logically Collective on SNES 3354fee21e36SBarry Smith 3355c7afd0dbSLois Curfman McInnes Input Parameters: 3356c7afd0dbSLois Curfman McInnes + snes - iterative context obtained from SNESCreate() 33578c7482ecSBarry Smith . a - array to hold history, this array will contain the function norms computed at each step 3358cd5578b5SBarry Smith . its - integer array holds the number of linear iterations for each solve. 3359758f92a0SBarry Smith . na - size of a and its 336064731454SLois Curfman McInnes - reset - PETSC_TRUE indicates each new nonlinear solve resets the history counter to zero, 3361758f92a0SBarry Smith else it continues storing new values for new nonlinear solves after the old ones 3362c7afd0dbSLois Curfman McInnes 3363308dcc3eSBarry Smith Notes: 33640298fd71SBarry Smith If 'a' and 'its' are NULL then space is allocated for the history. If 'na' PETSC_DECIDE or PETSC_DEFAULT then a 3365308dcc3eSBarry Smith default array of length 10000 is allocated. 3366308dcc3eSBarry Smith 3367c9005455SLois Curfman McInnes This routine is useful, e.g., when running a code for purposes 3368c9005455SLois Curfman McInnes of accurate performance monitoring, when no I/O should be done 3369c9005455SLois Curfman McInnes during the section of code that is being timed. 3370c9005455SLois Curfman McInnes 337136851e7fSLois Curfman McInnes Level: intermediate 337236851e7fSLois Curfman McInnes 3373c9005455SLois Curfman McInnes .keywords: SNES, set, convergence, history 3374758f92a0SBarry Smith 337508405cd6SLois Curfman McInnes .seealso: SNESGetConvergenceHistory() 3376758f92a0SBarry Smith 3377c9005455SLois Curfman McInnes @*/ 33787087cfbeSBarry Smith PetscErrorCode SNESSetConvergenceHistory(SNES snes,PetscReal a[],PetscInt its[],PetscInt na,PetscBool reset) 3379c9005455SLois Curfman McInnes { 3380308dcc3eSBarry Smith PetscErrorCode ierr; 3381308dcc3eSBarry Smith 33823a40ed3dSBarry Smith PetscFunctionBegin; 33830700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 33844482741eSBarry Smith if (na) PetscValidScalarPointer(a,2); 3385a562a398SLisandro Dalcin if (its) PetscValidIntPointer(its,3); 3386308dcc3eSBarry Smith if (na == PETSC_DECIDE || na == PETSC_DEFAULT || !a) { 3387308dcc3eSBarry Smith if (na == PETSC_DECIDE || na == PETSC_DEFAULT) na = 1000; 3388308dcc3eSBarry Smith ierr = PetscMalloc(na*sizeof(PetscReal),&a);CHKERRQ(ierr); 3389308dcc3eSBarry Smith ierr = PetscMalloc(na*sizeof(PetscInt),&its);CHKERRQ(ierr); 3390f5af7f23SKarl Rupp 3391308dcc3eSBarry Smith snes->conv_malloc = PETSC_TRUE; 3392308dcc3eSBarry Smith } 3393c9005455SLois Curfman McInnes snes->conv_hist = a; 3394758f92a0SBarry Smith snes->conv_hist_its = its; 3395758f92a0SBarry Smith snes->conv_hist_max = na; 3396a12bc48fSLisandro Dalcin snes->conv_hist_len = 0; 3397758f92a0SBarry Smith snes->conv_hist_reset = reset; 3398758f92a0SBarry Smith PetscFunctionReturn(0); 3399758f92a0SBarry Smith } 3400758f92a0SBarry Smith 3401308dcc3eSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 3402c6db04a5SJed Brown #include <engine.h> /* MATLAB include file */ 3403c6db04a5SJed Brown #include <mex.h> /* MATLAB include file */ 3404308dcc3eSBarry Smith EXTERN_C_BEGIN 3405308dcc3eSBarry Smith #undef __FUNCT__ 3406308dcc3eSBarry Smith #define __FUNCT__ "SNESGetConvergenceHistoryMatlab" 3407308dcc3eSBarry Smith mxArray *SNESGetConvergenceHistoryMatlab(SNES snes) 3408308dcc3eSBarry Smith { 3409308dcc3eSBarry Smith mxArray *mat; 3410308dcc3eSBarry Smith PetscInt i; 3411308dcc3eSBarry Smith PetscReal *ar; 3412308dcc3eSBarry Smith 3413308dcc3eSBarry Smith PetscFunctionBegin; 3414308dcc3eSBarry Smith mat = mxCreateDoubleMatrix(snes->conv_hist_len,1,mxREAL); 3415308dcc3eSBarry Smith ar = (PetscReal*) mxGetData(mat); 3416f5af7f23SKarl Rupp for (i=0; i<snes->conv_hist_len; i++) ar[i] = snes->conv_hist[i]; 3417308dcc3eSBarry Smith PetscFunctionReturn(mat); 3418308dcc3eSBarry Smith } 3419308dcc3eSBarry Smith EXTERN_C_END 3420308dcc3eSBarry Smith #endif 3421308dcc3eSBarry Smith 34224a2ae208SSatish Balay #undef __FUNCT__ 34234a2ae208SSatish Balay #define __FUNCT__ "SNESGetConvergenceHistory" 34240c4c9dddSBarry Smith /*@C 3425758f92a0SBarry Smith SNESGetConvergenceHistory - Gets the array used to hold the convergence history. 3426758f92a0SBarry Smith 34273f9fe445SBarry Smith Not Collective 3428758f92a0SBarry Smith 3429758f92a0SBarry Smith Input Parameter: 3430758f92a0SBarry Smith . snes - iterative context obtained from SNESCreate() 3431758f92a0SBarry Smith 3432758f92a0SBarry Smith Output Parameters: 3433758f92a0SBarry Smith . a - array to hold history 3434758f92a0SBarry Smith . its - integer array holds the number of linear iterations (or 3435758f92a0SBarry Smith negative if not converged) for each solve. 3436758f92a0SBarry Smith - na - size of a and its 3437758f92a0SBarry Smith 3438758f92a0SBarry Smith Notes: 3439758f92a0SBarry Smith The calling sequence for this routine in Fortran is 3440758f92a0SBarry Smith $ call SNESGetConvergenceHistory(SNES snes, integer na, integer ierr) 3441758f92a0SBarry Smith 3442758f92a0SBarry Smith This routine is useful, e.g., when running a code for purposes 3443758f92a0SBarry Smith of accurate performance monitoring, when no I/O should be done 3444758f92a0SBarry Smith during the section of code that is being timed. 3445758f92a0SBarry Smith 3446758f92a0SBarry Smith Level: intermediate 3447758f92a0SBarry Smith 3448758f92a0SBarry Smith .keywords: SNES, get, convergence, history 3449758f92a0SBarry Smith 3450758f92a0SBarry Smith .seealso: SNESSetConvergencHistory() 3451758f92a0SBarry Smith 3452758f92a0SBarry Smith @*/ 34537087cfbeSBarry Smith PetscErrorCode SNESGetConvergenceHistory(SNES snes,PetscReal *a[],PetscInt *its[],PetscInt *na) 3454758f92a0SBarry Smith { 3455758f92a0SBarry Smith PetscFunctionBegin; 34560700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3457758f92a0SBarry Smith if (a) *a = snes->conv_hist; 3458758f92a0SBarry Smith if (its) *its = snes->conv_hist_its; 3459758f92a0SBarry Smith if (na) *na = snes->conv_hist_len; 34603a40ed3dSBarry Smith PetscFunctionReturn(0); 3461c9005455SLois Curfman McInnes } 3462c9005455SLois Curfman McInnes 3463e74ef692SMatthew Knepley #undef __FUNCT__ 3464e74ef692SMatthew Knepley #define __FUNCT__ "SNESSetUpdate" 3465ac226902SBarry Smith /*@C 346676b2cf59SMatthew Knepley SNESSetUpdate - Sets the general-purpose update function called 3467eec8f646SJed Brown at the beginning of every iteration of the nonlinear solve. Specifically 34687e4bb74cSBarry Smith it is called just before the Jacobian is "evaluated". 346976b2cf59SMatthew Knepley 34703f9fe445SBarry Smith Logically Collective on SNES 347176b2cf59SMatthew Knepley 347276b2cf59SMatthew Knepley Input Parameters: 347376b2cf59SMatthew Knepley . snes - The nonlinear solver context 347476b2cf59SMatthew Knepley . func - The function 347576b2cf59SMatthew Knepley 347676b2cf59SMatthew Knepley Calling sequence of func: 3477b5d30489SBarry Smith . func (SNES snes, PetscInt step); 347876b2cf59SMatthew Knepley 347976b2cf59SMatthew Knepley . step - The current step of the iteration 348076b2cf59SMatthew Knepley 3481fe97e370SBarry Smith Level: advanced 3482fe97e370SBarry Smith 3483fe97e370SBarry Smith Note: This is NOT what one uses to update the ghost points before a function evaluation, that should be done at the beginning of your FormFunction() 3484fe97e370SBarry Smith This is not used by most users. 348576b2cf59SMatthew Knepley 348676b2cf59SMatthew Knepley .keywords: SNES, update 3487b5d30489SBarry Smith 348885385478SLisandro Dalcin .seealso SNESDefaultUpdate(), SNESSetJacobian(), SNESSolve() 348976b2cf59SMatthew Knepley @*/ 34907087cfbeSBarry Smith PetscErrorCode SNESSetUpdate(SNES snes, PetscErrorCode (*func)(SNES, PetscInt)) 349176b2cf59SMatthew Knepley { 349276b2cf59SMatthew Knepley PetscFunctionBegin; 34930700a824SBarry Smith PetscValidHeaderSpecific(snes, SNES_CLASSID,1); 3494e7788613SBarry Smith snes->ops->update = func; 349576b2cf59SMatthew Knepley PetscFunctionReturn(0); 349676b2cf59SMatthew Knepley } 349776b2cf59SMatthew Knepley 3498e74ef692SMatthew Knepley #undef __FUNCT__ 3499e74ef692SMatthew Knepley #define __FUNCT__ "SNESDefaultUpdate" 350076b2cf59SMatthew Knepley /*@ 350176b2cf59SMatthew Knepley SNESDefaultUpdate - The default update function which does nothing. 350276b2cf59SMatthew Knepley 350376b2cf59SMatthew Knepley Not collective 350476b2cf59SMatthew Knepley 350576b2cf59SMatthew Knepley Input Parameters: 350676b2cf59SMatthew Knepley . snes - The nonlinear solver context 350776b2cf59SMatthew Knepley . step - The current step of the iteration 350876b2cf59SMatthew Knepley 3509205452f4SMatthew Knepley Level: intermediate 3510205452f4SMatthew Knepley 351176b2cf59SMatthew Knepley .keywords: SNES, update 3512a6570f20SBarry Smith .seealso SNESSetUpdate(), SNESDefaultRhsBC(), SNESDefaultShortolutionBC() 351376b2cf59SMatthew Knepley @*/ 35147087cfbeSBarry Smith PetscErrorCode SNESDefaultUpdate(SNES snes, PetscInt step) 351576b2cf59SMatthew Knepley { 351676b2cf59SMatthew Knepley PetscFunctionBegin; 351776b2cf59SMatthew Knepley PetscFunctionReturn(0); 351876b2cf59SMatthew Knepley } 351976b2cf59SMatthew Knepley 35204a2ae208SSatish Balay #undef __FUNCT__ 35214a2ae208SSatish Balay #define __FUNCT__ "SNESScaleStep_Private" 35229b94acceSBarry Smith /* 35239b94acceSBarry Smith SNESScaleStep_Private - Scales a step so that its length is less than the 35249b94acceSBarry Smith positive parameter delta. 35259b94acceSBarry Smith 35269b94acceSBarry Smith Input Parameters: 3527c7afd0dbSLois Curfman McInnes + snes - the SNES context 35289b94acceSBarry Smith . y - approximate solution of linear system 35299b94acceSBarry Smith . fnorm - 2-norm of current function 3530c7afd0dbSLois Curfman McInnes - delta - trust region size 35319b94acceSBarry Smith 35329b94acceSBarry Smith Output Parameters: 3533c7afd0dbSLois Curfman McInnes + gpnorm - predicted function norm at the new point, assuming local 35349b94acceSBarry Smith linearization. The value is zero if the step lies within the trust 35359b94acceSBarry Smith region, and exceeds zero otherwise. 3536c7afd0dbSLois Curfman McInnes - ynorm - 2-norm of the step 35379b94acceSBarry Smith 35389b94acceSBarry Smith Note: 353904d7464bSBarry Smith For non-trust region methods such as SNESNEWTONLS, the parameter delta 35409b94acceSBarry Smith is set to be the maximum allowable step size. 35419b94acceSBarry Smith 35429b94acceSBarry Smith .keywords: SNES, nonlinear, scale, step 35439b94acceSBarry Smith */ 3544dfbe8321SBarry Smith PetscErrorCode SNESScaleStep_Private(SNES snes,Vec y,PetscReal *fnorm,PetscReal *delta,PetscReal *gpnorm,PetscReal *ynorm) 35459b94acceSBarry Smith { 3546064f8208SBarry Smith PetscReal nrm; 3547ea709b57SSatish Balay PetscScalar cnorm; 3548dfbe8321SBarry Smith PetscErrorCode ierr; 35493a40ed3dSBarry Smith 35503a40ed3dSBarry Smith PetscFunctionBegin; 35510700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 35520700a824SBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,2); 3553c9780b6fSBarry Smith PetscCheckSameComm(snes,1,y,2); 3554184914b5SBarry Smith 3555064f8208SBarry Smith ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr); 3556064f8208SBarry Smith if (nrm > *delta) { 3557064f8208SBarry Smith nrm = *delta/nrm; 3558064f8208SBarry Smith *gpnorm = (1.0 - nrm)*(*fnorm); 3559064f8208SBarry Smith cnorm = nrm; 35602dcb1b2aSMatthew Knepley ierr = VecScale(y,cnorm);CHKERRQ(ierr); 35619b94acceSBarry Smith *ynorm = *delta; 35629b94acceSBarry Smith } else { 35639b94acceSBarry Smith *gpnorm = 0.0; 3564064f8208SBarry Smith *ynorm = nrm; 35659b94acceSBarry Smith } 35663a40ed3dSBarry Smith PetscFunctionReturn(0); 35679b94acceSBarry Smith } 35689b94acceSBarry Smith 35694a2ae208SSatish Balay #undef __FUNCT__ 35704a2ae208SSatish Balay #define __FUNCT__ "SNESSolve" 35716ce558aeSBarry Smith /*@C 3572f69a0ea3SMatthew Knepley SNESSolve - Solves a nonlinear system F(x) = b. 3573f69a0ea3SMatthew Knepley Call SNESSolve() after calling SNESCreate() and optional routines of the form SNESSetXXX(). 35749b94acceSBarry Smith 3575c7afd0dbSLois Curfman McInnes Collective on SNES 3576c7afd0dbSLois Curfman McInnes 3577b2002411SLois Curfman McInnes Input Parameters: 3578c7afd0dbSLois Curfman McInnes + snes - the SNES context 35790298fd71SBarry Smith . b - the constant part of the equation F(x) = b, or NULL to use zero. 358085385478SLisandro Dalcin - x - the solution vector. 35819b94acceSBarry Smith 3582b2002411SLois Curfman McInnes Notes: 35838ddd3da0SLois Curfman McInnes The user should initialize the vector,x, with the initial guess 35848ddd3da0SLois Curfman McInnes for the nonlinear solve prior to calling SNESSolve. In particular, 35858ddd3da0SLois Curfman McInnes to employ an initial guess of zero, the user should explicitly set 35868ddd3da0SLois Curfman McInnes this vector to zero by calling VecSet(). 35878ddd3da0SLois Curfman McInnes 358836851e7fSLois Curfman McInnes Level: beginner 358936851e7fSLois Curfman McInnes 35909b94acceSBarry Smith .keywords: SNES, nonlinear, solve 35919b94acceSBarry Smith 3592c0df2a02SJed Brown .seealso: SNESCreate(), SNESDestroy(), SNESSetFunction(), SNESSetJacobian(), SNESSetGridSequence(), SNESGetSolution() 35939b94acceSBarry Smith @*/ 35947087cfbeSBarry Smith PetscErrorCode SNESSolve(SNES snes,Vec b,Vec x) 35959b94acceSBarry Smith { 3596dfbe8321SBarry Smith PetscErrorCode ierr; 3597ace3abfcSBarry Smith PetscBool flg; 3598eabae89aSBarry Smith PetscViewer viewer; 3599efd51863SBarry Smith PetscInt grid; 36000298fd71SBarry Smith Vec xcreated = NULL; 3601caa4e7f2SJed Brown DM dm; 3602cffb1e40SBarry Smith PetscViewerFormat format; 3603052efed2SBarry Smith 36043a40ed3dSBarry Smith PetscFunctionBegin; 36050700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3606a69afd8bSBarry Smith if (x) PetscValidHeaderSpecific(x,VEC_CLASSID,3); 3607a69afd8bSBarry Smith if (x) PetscCheckSameComm(snes,1,x,3); 36080700a824SBarry Smith if (b) PetscValidHeaderSpecific(b,VEC_CLASSID,2); 360985385478SLisandro Dalcin if (b) PetscCheckSameComm(snes,1,b,2); 361085385478SLisandro Dalcin 3611caa4e7f2SJed Brown if (!x) { 3612caa4e7f2SJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 3613caa4e7f2SJed Brown ierr = DMCreateGlobalVector(dm,&xcreated);CHKERRQ(ierr); 3614a69afd8bSBarry Smith x = xcreated; 3615a69afd8bSBarry Smith } 3616a69afd8bSBarry Smith 3617*ce94432eSBarry Smith for (grid=0; grid<snes->gridsequence; grid++) {ierr = PetscViewerASCIIPushTab(PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)snes)));CHKERRQ(ierr);} 3618efd51863SBarry Smith for (grid=0; grid<snes->gridsequence+1; grid++) { 3619efd51863SBarry Smith 362085385478SLisandro Dalcin /* set solution vector */ 3621efd51863SBarry Smith if (!grid) {ierr = PetscObjectReference((PetscObject)x);CHKERRQ(ierr);} 36226bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_sol);CHKERRQ(ierr); 362385385478SLisandro Dalcin snes->vec_sol = x; 3624caa4e7f2SJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 3625caa4e7f2SJed Brown 3626caa4e7f2SJed Brown /* set affine vector if provided */ 362785385478SLisandro Dalcin if (b) { ierr = PetscObjectReference((PetscObject)b);CHKERRQ(ierr); } 36286bf464f9SBarry Smith ierr = VecDestroy(&snes->vec_rhs);CHKERRQ(ierr); 362985385478SLisandro Dalcin snes->vec_rhs = b; 363085385478SLisandro Dalcin 363170e92668SMatthew Knepley ierr = SNESSetUp(snes);CHKERRQ(ierr); 36323f149594SLisandro Dalcin 36337eee914bSBarry Smith if (!grid) { 36347eee914bSBarry Smith if (snes->ops->computeinitialguess) { 3635d25893d9SBarry Smith ierr = (*snes->ops->computeinitialguess)(snes,snes->vec_sol,snes->initialguessP);CHKERRQ(ierr); 3636d25893d9SBarry Smith } 3637dd568438SSatish Balay } 3638d25893d9SBarry Smith 3639abc0a331SBarry Smith if (snes->conv_hist_reset) snes->conv_hist_len = 0; 364050ffb88aSMatthew Knepley snes->nfuncs = 0; snes->linear_its = 0; snes->numFailures = 0; 3641d5e45103SBarry Smith 36423f149594SLisandro Dalcin ierr = PetscLogEventBegin(SNES_Solve,snes,0,0,0);CHKERRQ(ierr); 36434936397dSBarry Smith ierr = (*snes->ops->solve)(snes);CHKERRQ(ierr); 364485385478SLisandro Dalcin ierr = PetscLogEventEnd(SNES_Solve,snes,0,0,0);CHKERRQ(ierr); 36454936397dSBarry Smith if (snes->domainerror) { 36464936397dSBarry Smith snes->reason = SNES_DIVERGED_FUNCTION_DOMAIN; 36474936397dSBarry Smith snes->domainerror = PETSC_FALSE; 36484936397dSBarry Smith } 364917186662SBarry Smith if (!snes->reason) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Internal error, solver returned without setting converged reason"); 36503f149594SLisandro Dalcin 365190d69ab7SBarry Smith flg = PETSC_FALSE; 36520298fd71SBarry Smith ierr = PetscOptionsGetBool(((PetscObject)snes)->prefix,"-snes_test_local_min",&flg,NULL);CHKERRQ(ierr); 3653da9b6338SBarry Smith if (flg && !PetscPreLoadingOn) { ierr = SNESTestLocalMin(snes);CHKERRQ(ierr); } 36545968eb51SBarry Smith if (snes->printreason) { 3655*ce94432eSBarry Smith ierr = PetscViewerASCIIAddTab(PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)snes)),((PetscObject)snes)->tablevel);CHKERRQ(ierr); 36565968eb51SBarry Smith if (snes->reason > 0) { 3657*ce94432eSBarry Smith ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)snes)),"Nonlinear solve converged due to %s iterations %D\n",SNESConvergedReasons[snes->reason],snes->iter);CHKERRQ(ierr); 36585968eb51SBarry Smith } else { 3659*ce94432eSBarry Smith ierr = PetscViewerASCIIPrintf(PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)snes)),"Nonlinear solve did not converge due to %s iterations %D\n",SNESConvergedReasons[snes->reason],snes->iter);CHKERRQ(ierr); 36605968eb51SBarry Smith } 3661*ce94432eSBarry Smith ierr = PetscViewerASCIISubtractTab(PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)snes)),((PetscObject)snes)->tablevel);CHKERRQ(ierr); 36625968eb51SBarry Smith } 36635968eb51SBarry Smith 3664*ce94432eSBarry Smith if (snes->errorifnotconverged && snes->reason < 0) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_NOT_CONVERGED,"SNESSolve has not converged"); 3665efd51863SBarry Smith if (grid < snes->gridsequence) { 3666efd51863SBarry Smith DM fine; 3667efd51863SBarry Smith Vec xnew; 3668efd51863SBarry Smith Mat interp; 3669efd51863SBarry Smith 3670*ce94432eSBarry Smith ierr = DMRefine(snes->dm,PetscObjectComm((PetscObject)snes),&fine);CHKERRQ(ierr); 3671*ce94432eSBarry Smith if (!fine) SETERRQ(PetscObjectComm((PetscObject)snes),PETSC_ERR_ARG_INCOMP,"DMRefine() did not perform any refinement, cannot continue grid sequencing"); 36720298fd71SBarry Smith ierr = DMCreateInterpolation(snes->dm,fine,&interp,NULL);CHKERRQ(ierr); 3673efd51863SBarry Smith ierr = DMCreateGlobalVector(fine,&xnew);CHKERRQ(ierr); 3674efd51863SBarry Smith ierr = MatInterpolate(interp,x,xnew);CHKERRQ(ierr); 3675c833c3b5SJed Brown ierr = DMInterpolate(snes->dm,interp,fine);CHKERRQ(ierr); 3676efd51863SBarry Smith ierr = MatDestroy(&interp);CHKERRQ(ierr); 3677efd51863SBarry Smith x = xnew; 3678efd51863SBarry Smith 3679efd51863SBarry Smith ierr = SNESReset(snes);CHKERRQ(ierr); 3680efd51863SBarry Smith ierr = SNESSetDM(snes,fine);CHKERRQ(ierr); 3681efd51863SBarry Smith ierr = DMDestroy(&fine);CHKERRQ(ierr); 3682*ce94432eSBarry Smith ierr = PetscViewerASCIIPopTab(PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)snes)));CHKERRQ(ierr); 3683efd51863SBarry Smith } 3684efd51863SBarry Smith } 36853f7e2da0SPeter Brune /* monitoring and viewing */ 3686*ce94432eSBarry Smith ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)snes),((PetscObject)snes)->prefix,"-snes_view",&viewer,&format,&flg);CHKERRQ(ierr); 36873f7e2da0SPeter Brune if (flg && !PetscPreLoadingOn) { 3688cffb1e40SBarry Smith ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 36893f7e2da0SPeter Brune ierr = SNESView(snes,viewer);CHKERRQ(ierr); 3690cffb1e40SBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 3691cffb1e40SBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 369272a02f06SBarry Smith } 36930d2bece7SBarry Smith ierr = VecViewFromOptions(snes->vec_sol,"-snes_view_solution");CHKERRQ(ierr); 36943f7e2da0SPeter Brune 3695a69afd8bSBarry Smith ierr = VecDestroy(&xcreated);CHKERRQ(ierr); 36963a40ed3dSBarry Smith PetscFunctionReturn(0); 36979b94acceSBarry Smith } 36989b94acceSBarry Smith 36999b94acceSBarry Smith /* --------- Internal routines for SNES Package --------- */ 37009b94acceSBarry Smith 37014a2ae208SSatish Balay #undef __FUNCT__ 37024a2ae208SSatish Balay #define __FUNCT__ "SNESSetType" 370382bf6240SBarry Smith /*@C 37044b0e389bSBarry Smith SNESSetType - Sets the method for the nonlinear solver. 37059b94acceSBarry Smith 3706fee21e36SBarry Smith Collective on SNES 3707fee21e36SBarry Smith 3708c7afd0dbSLois Curfman McInnes Input Parameters: 3709c7afd0dbSLois Curfman McInnes + snes - the SNES context 3710454a90a3SBarry Smith - type - a known method 3711c7afd0dbSLois Curfman McInnes 3712c7afd0dbSLois Curfman McInnes Options Database Key: 3713454a90a3SBarry Smith . -snes_type <type> - Sets the method; use -help for a list 371404d7464bSBarry Smith of available methods (for instance, newtonls or newtontr) 3715ae12b187SLois Curfman McInnes 37169b94acceSBarry Smith Notes: 3717e090d566SSatish Balay See "petsc/include/petscsnes.h" for available methods (for instance) 371804d7464bSBarry Smith + SNESNEWTONLS - Newton's method with line search 3719c7afd0dbSLois Curfman McInnes (systems of nonlinear equations) 372004d7464bSBarry Smith . SNESNEWTONTR - Newton's method with trust region 3721c7afd0dbSLois Curfman McInnes (systems of nonlinear equations) 37229b94acceSBarry Smith 3723ae12b187SLois Curfman McInnes Normally, it is best to use the SNESSetFromOptions() command and then 3724ae12b187SLois Curfman McInnes set the SNES solver type from the options database rather than by using 3725ae12b187SLois Curfman McInnes this routine. Using the options database provides the user with 3726ae12b187SLois Curfman McInnes maximum flexibility in evaluating the many nonlinear solvers. 3727ae12b187SLois Curfman McInnes The SNESSetType() routine is provided for those situations where it 3728ae12b187SLois Curfman McInnes is necessary to set the nonlinear solver independently of the command 3729ae12b187SLois Curfman McInnes line or options database. This might be the case, for example, when 3730ae12b187SLois Curfman McInnes the choice of solver changes during the execution of the program, 3731ae12b187SLois Curfman McInnes and the user's application is taking responsibility for choosing the 3732b0a32e0cSBarry Smith appropriate method. 373336851e7fSLois Curfman McInnes 373436851e7fSLois Curfman McInnes Level: intermediate 3735a703fe33SLois Curfman McInnes 3736454a90a3SBarry Smith .keywords: SNES, set, type 3737435da068SBarry Smith 3738435da068SBarry Smith .seealso: SNESType, SNESCreate() 3739435da068SBarry Smith 37409b94acceSBarry Smith @*/ 374119fd82e9SBarry Smith PetscErrorCode SNESSetType(SNES snes,SNESType type) 37429b94acceSBarry Smith { 3743dfbe8321SBarry Smith PetscErrorCode ierr,(*r)(SNES); 3744ace3abfcSBarry Smith PetscBool match; 37453a40ed3dSBarry Smith 37463a40ed3dSBarry Smith PetscFunctionBegin; 37470700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 37484482741eSBarry Smith PetscValidCharPointer(type,2); 374982bf6240SBarry Smith 3750251f4c67SDmitry Karpeev ierr = PetscObjectTypeCompare((PetscObject)snes,type,&match);CHKERRQ(ierr); 37510f5bd95cSBarry Smith if (match) PetscFunctionReturn(0); 375292ff6ae8SBarry Smith 3753*ce94432eSBarry Smith ierr = PetscFunctionListFind(PetscObjectComm((PetscObject)snes),SNESList,type,PETSC_TRUE,(void (**)(void)) &r);CHKERRQ(ierr); 3754e32f2f54SBarry Smith if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested SNES type %s",type); 375575396ef9SLisandro Dalcin /* Destroy the previous private SNES context */ 3756b5c23020SJed Brown if (snes->ops->destroy) { 3757b5c23020SJed Brown ierr = (*(snes)->ops->destroy)(snes);CHKERRQ(ierr); 37580298fd71SBarry Smith snes->ops->destroy = NULL; 3759b5c23020SJed Brown } 376075396ef9SLisandro Dalcin /* Reinitialize function pointers in SNESOps structure */ 376175396ef9SLisandro Dalcin snes->ops->setup = 0; 376275396ef9SLisandro Dalcin snes->ops->solve = 0; 376375396ef9SLisandro Dalcin snes->ops->view = 0; 376475396ef9SLisandro Dalcin snes->ops->setfromoptions = 0; 376575396ef9SLisandro Dalcin snes->ops->destroy = 0; 376675396ef9SLisandro Dalcin /* Call the SNESCreate_XXX routine for this particular Nonlinear solver */ 376775396ef9SLisandro Dalcin snes->setupcalled = PETSC_FALSE; 3768f5af7f23SKarl Rupp 3769454a90a3SBarry Smith ierr = PetscObjectChangeTypeName((PetscObject)snes,type);CHKERRQ(ierr); 377003bfa161SLisandro Dalcin ierr = (*r)(snes);CHKERRQ(ierr); 37719fb22e1aSBarry Smith #if defined(PETSC_HAVE_AMS) 37729fb22e1aSBarry Smith if (PetscAMSPublishAll) { 37739fb22e1aSBarry Smith ierr = PetscObjectAMSPublish((PetscObject)snes);CHKERRQ(ierr); 37749fb22e1aSBarry Smith } 37759fb22e1aSBarry Smith #endif 37763a40ed3dSBarry Smith PetscFunctionReturn(0); 37779b94acceSBarry Smith } 37789b94acceSBarry Smith 37799b94acceSBarry Smith /* --------------------------------------------------------------------- */ 37804a2ae208SSatish Balay #undef __FUNCT__ 37814a2ae208SSatish Balay #define __FUNCT__ "SNESRegisterDestroy" 378252baeb72SSatish Balay /*@ 37839b94acceSBarry Smith SNESRegisterDestroy - Frees the list of nonlinear solvers that were 3784f1af5d2fSBarry Smith registered by SNESRegisterDynamic(). 37859b94acceSBarry Smith 3786fee21e36SBarry Smith Not Collective 3787fee21e36SBarry Smith 378836851e7fSLois Curfman McInnes Level: advanced 378936851e7fSLois Curfman McInnes 37909b94acceSBarry Smith .keywords: SNES, nonlinear, register, destroy 37919b94acceSBarry Smith 379277f415f2SJed Brown .seealso: SNESRegisterAll() 37939b94acceSBarry Smith @*/ 37947087cfbeSBarry Smith PetscErrorCode SNESRegisterDestroy(void) 37959b94acceSBarry Smith { 3796dfbe8321SBarry Smith PetscErrorCode ierr; 379782bf6240SBarry Smith 37983a40ed3dSBarry Smith PetscFunctionBegin; 3799140e18c1SBarry Smith ierr = PetscFunctionListDestroy(&SNESList);CHKERRQ(ierr); 3800f5af7f23SKarl Rupp 38014c49b128SBarry Smith SNESRegisterAllCalled = PETSC_FALSE; 38023a40ed3dSBarry Smith PetscFunctionReturn(0); 38039b94acceSBarry Smith } 38049b94acceSBarry Smith 38054a2ae208SSatish Balay #undef __FUNCT__ 38064a2ae208SSatish Balay #define __FUNCT__ "SNESGetType" 38079b94acceSBarry Smith /*@C 38089a28b0a6SLois Curfman McInnes SNESGetType - Gets the SNES method type and name (as a string). 38099b94acceSBarry Smith 3810c7afd0dbSLois Curfman McInnes Not Collective 3811c7afd0dbSLois Curfman McInnes 38129b94acceSBarry Smith Input Parameter: 38134b0e389bSBarry Smith . snes - nonlinear solver context 38149b94acceSBarry Smith 38159b94acceSBarry Smith Output Parameter: 38163a7fca6bSBarry Smith . type - SNES method (a character string) 38179b94acceSBarry Smith 381836851e7fSLois Curfman McInnes Level: intermediate 381936851e7fSLois Curfman McInnes 3820454a90a3SBarry Smith .keywords: SNES, nonlinear, get, type, name 38219b94acceSBarry Smith @*/ 382219fd82e9SBarry Smith PetscErrorCode SNESGetType(SNES snes,SNESType *type) 38239b94acceSBarry Smith { 38243a40ed3dSBarry Smith PetscFunctionBegin; 38250700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 38264482741eSBarry Smith PetscValidPointer(type,2); 38277adad957SLisandro Dalcin *type = ((PetscObject)snes)->type_name; 38283a40ed3dSBarry Smith PetscFunctionReturn(0); 38299b94acceSBarry Smith } 38309b94acceSBarry Smith 38314a2ae208SSatish Balay #undef __FUNCT__ 38324a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolution" 383352baeb72SSatish Balay /*@ 38349b94acceSBarry Smith SNESGetSolution - Returns the vector where the approximate solution is 3835c0df2a02SJed Brown stored. This is the fine grid solution when using SNESSetGridSequence(). 38369b94acceSBarry Smith 3837c7afd0dbSLois Curfman McInnes Not Collective, but Vec is parallel if SNES is parallel 3838c7afd0dbSLois Curfman McInnes 38399b94acceSBarry Smith Input Parameter: 38409b94acceSBarry Smith . snes - the SNES context 38419b94acceSBarry Smith 38429b94acceSBarry Smith Output Parameter: 38439b94acceSBarry Smith . x - the solution 38449b94acceSBarry Smith 384570e92668SMatthew Knepley Level: intermediate 384636851e7fSLois Curfman McInnes 38479b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution 38489b94acceSBarry Smith 384985385478SLisandro Dalcin .seealso: SNESGetSolutionUpdate(), SNESGetFunction() 38509b94acceSBarry Smith @*/ 38517087cfbeSBarry Smith PetscErrorCode SNESGetSolution(SNES snes,Vec *x) 38529b94acceSBarry Smith { 38533a40ed3dSBarry Smith PetscFunctionBegin; 38540700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 38554482741eSBarry Smith PetscValidPointer(x,2); 385685385478SLisandro Dalcin *x = snes->vec_sol; 385770e92668SMatthew Knepley PetscFunctionReturn(0); 385870e92668SMatthew Knepley } 385970e92668SMatthew Knepley 386070e92668SMatthew Knepley #undef __FUNCT__ 38614a2ae208SSatish Balay #define __FUNCT__ "SNESGetSolutionUpdate" 386252baeb72SSatish Balay /*@ 38639b94acceSBarry Smith SNESGetSolutionUpdate - Returns the vector where the solution update is 38649b94acceSBarry Smith stored. 38659b94acceSBarry Smith 3866c7afd0dbSLois Curfman McInnes Not Collective, but Vec is parallel if SNES is parallel 3867c7afd0dbSLois Curfman McInnes 38689b94acceSBarry Smith Input Parameter: 38699b94acceSBarry Smith . snes - the SNES context 38709b94acceSBarry Smith 38719b94acceSBarry Smith Output Parameter: 38729b94acceSBarry Smith . x - the solution update 38739b94acceSBarry Smith 387436851e7fSLois Curfman McInnes Level: advanced 387536851e7fSLois Curfman McInnes 38769b94acceSBarry Smith .keywords: SNES, nonlinear, get, solution, update 38779b94acceSBarry Smith 387885385478SLisandro Dalcin .seealso: SNESGetSolution(), SNESGetFunction() 38799b94acceSBarry Smith @*/ 38807087cfbeSBarry Smith PetscErrorCode SNESGetSolutionUpdate(SNES snes,Vec *x) 38819b94acceSBarry Smith { 38823a40ed3dSBarry Smith PetscFunctionBegin; 38830700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 38844482741eSBarry Smith PetscValidPointer(x,2); 388585385478SLisandro Dalcin *x = snes->vec_sol_update; 38863a40ed3dSBarry Smith PetscFunctionReturn(0); 38879b94acceSBarry Smith } 38889b94acceSBarry Smith 38894a2ae208SSatish Balay #undef __FUNCT__ 38904a2ae208SSatish Balay #define __FUNCT__ "SNESGetFunction" 38919b94acceSBarry Smith /*@C 38923638b69dSLois Curfman McInnes SNESGetFunction - Returns the vector where the function is stored. 38939b94acceSBarry Smith 3894a63bb30eSJed Brown Not Collective, but Vec is parallel if SNES is parallel. Collective if Vec is requested, but has not been created yet. 3895c7afd0dbSLois Curfman McInnes 38969b94acceSBarry Smith Input Parameter: 38979b94acceSBarry Smith . snes - the SNES context 38989b94acceSBarry Smith 38999b94acceSBarry Smith Output Parameter: 39000298fd71SBarry Smith + r - the vector that is used to store residuals (or NULL if you don't want it) 39010298fd71SBarry Smith . SNESFunction- the function (or NULL if you don't want it) 39020298fd71SBarry Smith - ctx - the function context (or NULL if you don't want it) 39039b94acceSBarry Smith 390436851e7fSLois Curfman McInnes Level: advanced 390536851e7fSLois Curfman McInnes 3906a86d99e1SLois Curfman McInnes .keywords: SNES, nonlinear, get, function 39079b94acceSBarry Smith 3908bf388a1fSBarry Smith .seealso: SNESSetFunction(), SNESGetSolution(), SNESFunction 39099b94acceSBarry Smith @*/ 3910bf388a1fSBarry Smith PetscErrorCode SNESGetFunction(SNES snes,Vec *r,PetscErrorCode (**SNESFunction)(SNES,Vec,Vec,void*),void **ctx) 39119b94acceSBarry Smith { 3912a63bb30eSJed Brown PetscErrorCode ierr; 39136cab3a1bSJed Brown DM dm; 3914a63bb30eSJed Brown 39153a40ed3dSBarry Smith PetscFunctionBegin; 39160700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3917a63bb30eSJed Brown if (r) { 3918a63bb30eSJed Brown if (!snes->vec_func) { 3919a63bb30eSJed Brown if (snes->vec_rhs) { 3920a63bb30eSJed Brown ierr = VecDuplicate(snes->vec_rhs,&snes->vec_func);CHKERRQ(ierr); 3921a63bb30eSJed Brown } else if (snes->vec_sol) { 3922a63bb30eSJed Brown ierr = VecDuplicate(snes->vec_sol,&snes->vec_func);CHKERRQ(ierr); 3923a63bb30eSJed Brown } else if (snes->dm) { 3924a63bb30eSJed Brown ierr = DMCreateGlobalVector(snes->dm,&snes->vec_func);CHKERRQ(ierr); 3925a63bb30eSJed Brown } 3926a63bb30eSJed Brown } 3927a63bb30eSJed Brown *r = snes->vec_func; 3928a63bb30eSJed Brown } 39296cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 3930bf388a1fSBarry Smith ierr = DMSNESGetFunction(dm,SNESFunction,ctx);CHKERRQ(ierr); 39313a40ed3dSBarry Smith PetscFunctionReturn(0); 39329b94acceSBarry Smith } 39339b94acceSBarry Smith 3934c79ef259SPeter Brune /*@C 3935c79ef259SPeter Brune SNESGetGS - Returns the GS function and context. 3936c79ef259SPeter Brune 3937c79ef259SPeter Brune Input Parameter: 3938c79ef259SPeter Brune . snes - the SNES context 3939c79ef259SPeter Brune 3940c79ef259SPeter Brune Output Parameter: 39410298fd71SBarry Smith + SNESGSFunction - the function (or NULL) 39420298fd71SBarry Smith - ctx - the function context (or NULL) 3943c79ef259SPeter Brune 3944c79ef259SPeter Brune Level: advanced 3945c79ef259SPeter Brune 3946c79ef259SPeter Brune .keywords: SNES, nonlinear, get, function 3947c79ef259SPeter Brune 3948c79ef259SPeter Brune .seealso: SNESSetGS(), SNESGetFunction() 3949c79ef259SPeter Brune @*/ 3950c79ef259SPeter Brune 39514a2ae208SSatish Balay #undef __FUNCT__ 3952646217ecSPeter Brune #define __FUNCT__ "SNESGetGS" 3953bf388a1fSBarry Smith PetscErrorCode SNESGetGS (SNES snes, PetscErrorCode (**SNESGSFunction)(SNES, Vec, Vec, void*), void ** ctx) 3954646217ecSPeter Brune { 39556cab3a1bSJed Brown PetscErrorCode ierr; 39566cab3a1bSJed Brown DM dm; 39576cab3a1bSJed Brown 3958646217ecSPeter Brune PetscFunctionBegin; 3959646217ecSPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 39606cab3a1bSJed Brown ierr = SNESGetDM(snes,&dm);CHKERRQ(ierr); 3961bf388a1fSBarry Smith ierr = DMSNESGetGS(dm,SNESGSFunction,ctx);CHKERRQ(ierr); 3962646217ecSPeter Brune PetscFunctionReturn(0); 3963646217ecSPeter Brune } 3964646217ecSPeter Brune 39654a2ae208SSatish Balay #undef __FUNCT__ 39664a2ae208SSatish Balay #define __FUNCT__ "SNESSetOptionsPrefix" 39673c7409f5SSatish Balay /*@C 39683c7409f5SSatish Balay SNESSetOptionsPrefix - Sets the prefix used for searching for all 3969d850072dSLois Curfman McInnes SNES options in the database. 39703c7409f5SSatish Balay 39713f9fe445SBarry Smith Logically Collective on SNES 3972fee21e36SBarry Smith 3973c7afd0dbSLois Curfman McInnes Input Parameter: 3974c7afd0dbSLois Curfman McInnes + snes - the SNES context 3975c7afd0dbSLois Curfman McInnes - prefix - the prefix to prepend to all option names 3976c7afd0dbSLois Curfman McInnes 3977d850072dSLois Curfman McInnes Notes: 3978a83b1b31SSatish Balay A hyphen (-) must NOT be given at the beginning of the prefix name. 3979c7afd0dbSLois Curfman McInnes The first character of all runtime options is AUTOMATICALLY the hyphen. 3980d850072dSLois Curfman McInnes 398136851e7fSLois Curfman McInnes Level: advanced 398236851e7fSLois Curfman McInnes 39833c7409f5SSatish Balay .keywords: SNES, set, options, prefix, database 3984a86d99e1SLois Curfman McInnes 3985a86d99e1SLois Curfman McInnes .seealso: SNESSetFromOptions() 39863c7409f5SSatish Balay @*/ 39877087cfbeSBarry Smith PetscErrorCode SNESSetOptionsPrefix(SNES snes,const char prefix[]) 39883c7409f5SSatish Balay { 3989dfbe8321SBarry Smith PetscErrorCode ierr; 39903c7409f5SSatish Balay 39913a40ed3dSBarry Smith PetscFunctionBegin; 39920700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 3993639f9d9dSBarry Smith ierr = PetscObjectSetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr); 39941cee3971SBarry Smith if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);} 399535f5d045SPeter Brune if (snes->linesearch) { 399635f5d045SPeter Brune ierr = SNESGetSNESLineSearch(snes,&snes->linesearch);CHKERRQ(ierr); 399708b6c495SPeter Brune ierr = PetscObjectSetOptionsPrefix((PetscObject)snes->linesearch,prefix);CHKERRQ(ierr); 399835f5d045SPeter Brune } 399935f5d045SPeter Brune ierr = KSPSetOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr); 40003a40ed3dSBarry Smith PetscFunctionReturn(0); 40013c7409f5SSatish Balay } 40023c7409f5SSatish Balay 40034a2ae208SSatish Balay #undef __FUNCT__ 40044a2ae208SSatish Balay #define __FUNCT__ "SNESAppendOptionsPrefix" 40053c7409f5SSatish Balay /*@C 4006f525115eSLois Curfman McInnes SNESAppendOptionsPrefix - Appends to the prefix used for searching for all 4007d850072dSLois Curfman McInnes SNES options in the database. 40083c7409f5SSatish Balay 40093f9fe445SBarry Smith Logically Collective on SNES 4010fee21e36SBarry Smith 4011c7afd0dbSLois Curfman McInnes Input Parameters: 4012c7afd0dbSLois Curfman McInnes + snes - the SNES context 4013c7afd0dbSLois Curfman McInnes - prefix - the prefix to prepend to all option names 4014c7afd0dbSLois Curfman McInnes 4015d850072dSLois Curfman McInnes Notes: 4016a83b1b31SSatish Balay A hyphen (-) must NOT be given at the beginning of the prefix name. 4017c7afd0dbSLois Curfman McInnes The first character of all runtime options is AUTOMATICALLY the hyphen. 4018d850072dSLois Curfman McInnes 401936851e7fSLois Curfman McInnes Level: advanced 402036851e7fSLois Curfman McInnes 40213c7409f5SSatish Balay .keywords: SNES, append, options, prefix, database 4022a86d99e1SLois Curfman McInnes 4023a86d99e1SLois Curfman McInnes .seealso: SNESGetOptionsPrefix() 40243c7409f5SSatish Balay @*/ 40257087cfbeSBarry Smith PetscErrorCode SNESAppendOptionsPrefix(SNES snes,const char prefix[]) 40263c7409f5SSatish Balay { 4027dfbe8321SBarry Smith PetscErrorCode ierr; 40283c7409f5SSatish Balay 40293a40ed3dSBarry Smith PetscFunctionBegin; 40300700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4031639f9d9dSBarry Smith ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr); 40321cee3971SBarry Smith if (!snes->ksp) {ierr = SNESGetKSP(snes,&snes->ksp);CHKERRQ(ierr);} 403335f5d045SPeter Brune if (snes->linesearch) { 403435f5d045SPeter Brune ierr = SNESGetSNESLineSearch(snes,&snes->linesearch);CHKERRQ(ierr); 403508b6c495SPeter Brune ierr = PetscObjectAppendOptionsPrefix((PetscObject)snes->linesearch,prefix);CHKERRQ(ierr); 403635f5d045SPeter Brune } 403735f5d045SPeter Brune ierr = KSPAppendOptionsPrefix(snes->ksp,prefix);CHKERRQ(ierr); 40383a40ed3dSBarry Smith PetscFunctionReturn(0); 40393c7409f5SSatish Balay } 40403c7409f5SSatish Balay 40414a2ae208SSatish Balay #undef __FUNCT__ 40424a2ae208SSatish Balay #define __FUNCT__ "SNESGetOptionsPrefix" 40439ab63eb5SSatish Balay /*@C 40443c7409f5SSatish Balay SNESGetOptionsPrefix - Sets the prefix used for searching for all 40453c7409f5SSatish Balay SNES options in the database. 40463c7409f5SSatish Balay 4047c7afd0dbSLois Curfman McInnes Not Collective 4048c7afd0dbSLois Curfman McInnes 40493c7409f5SSatish Balay Input Parameter: 40503c7409f5SSatish Balay . snes - the SNES context 40513c7409f5SSatish Balay 40523c7409f5SSatish Balay Output Parameter: 40533c7409f5SSatish Balay . prefix - pointer to the prefix string used 40543c7409f5SSatish Balay 40554ef407dbSRichard Tran Mills Notes: On the fortran side, the user should pass in a string 'prefix' of 40569ab63eb5SSatish Balay sufficient length to hold the prefix. 40579ab63eb5SSatish Balay 405836851e7fSLois Curfman McInnes Level: advanced 405936851e7fSLois Curfman McInnes 40603c7409f5SSatish Balay .keywords: SNES, get, options, prefix, database 4061a86d99e1SLois Curfman McInnes 4062a86d99e1SLois Curfman McInnes .seealso: SNESAppendOptionsPrefix() 40633c7409f5SSatish Balay @*/ 40647087cfbeSBarry Smith PetscErrorCode SNESGetOptionsPrefix(SNES snes,const char *prefix[]) 40653c7409f5SSatish Balay { 4066dfbe8321SBarry Smith PetscErrorCode ierr; 40673c7409f5SSatish Balay 40683a40ed3dSBarry Smith PetscFunctionBegin; 40690700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4070639f9d9dSBarry Smith ierr = PetscObjectGetOptionsPrefix((PetscObject)snes,prefix);CHKERRQ(ierr); 40713a40ed3dSBarry Smith PetscFunctionReturn(0); 40723c7409f5SSatish Balay } 40733c7409f5SSatish Balay 4074b2002411SLois Curfman McInnes 40754a2ae208SSatish Balay #undef __FUNCT__ 40764a2ae208SSatish Balay #define __FUNCT__ "SNESRegister" 40773cea93caSBarry Smith /*@C 40783cea93caSBarry Smith SNESRegister - See SNESRegisterDynamic() 40793cea93caSBarry Smith 40807f6c08e0SMatthew Knepley Level: advanced 40813cea93caSBarry Smith @*/ 40827087cfbeSBarry Smith PetscErrorCode SNESRegister(const char sname[],const char path[],const char name[],PetscErrorCode (*function)(SNES)) 4083b2002411SLois Curfman McInnes { 4084e2d1d2b7SBarry Smith char fullname[PETSC_MAX_PATH_LEN]; 4085dfbe8321SBarry Smith PetscErrorCode ierr; 4086b2002411SLois Curfman McInnes 4087b2002411SLois Curfman McInnes PetscFunctionBegin; 4088140e18c1SBarry Smith ierr = PetscFunctionListConcat(path,name,fullname);CHKERRQ(ierr); 4089140e18c1SBarry Smith ierr = PetscFunctionListAdd(PETSC_COMM_WORLD,&SNESList,sname,fullname,(void (*)(void))function);CHKERRQ(ierr); 4090b2002411SLois Curfman McInnes PetscFunctionReturn(0); 4091b2002411SLois Curfman McInnes } 4092da9b6338SBarry Smith 4093da9b6338SBarry Smith #undef __FUNCT__ 4094da9b6338SBarry Smith #define __FUNCT__ "SNESTestLocalMin" 40957087cfbeSBarry Smith PetscErrorCode SNESTestLocalMin(SNES snes) 4096da9b6338SBarry Smith { 4097dfbe8321SBarry Smith PetscErrorCode ierr; 409877431f27SBarry Smith PetscInt N,i,j; 4099da9b6338SBarry Smith Vec u,uh,fh; 4100da9b6338SBarry Smith PetscScalar value; 4101da9b6338SBarry Smith PetscReal norm; 4102da9b6338SBarry Smith 4103da9b6338SBarry Smith PetscFunctionBegin; 4104da9b6338SBarry Smith ierr = SNESGetSolution(snes,&u);CHKERRQ(ierr); 4105da9b6338SBarry Smith ierr = VecDuplicate(u,&uh);CHKERRQ(ierr); 4106da9b6338SBarry Smith ierr = VecDuplicate(u,&fh);CHKERRQ(ierr); 4107da9b6338SBarry Smith 4108da9b6338SBarry Smith /* currently only works for sequential */ 410922d28d08SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"Testing FormFunction() for local min\n");CHKERRQ(ierr); 4110da9b6338SBarry Smith ierr = VecGetSize(u,&N);CHKERRQ(ierr); 4111da9b6338SBarry Smith for (i=0; i<N; i++) { 4112da9b6338SBarry Smith ierr = VecCopy(u,uh);CHKERRQ(ierr); 411377431f27SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD,"i = %D\n",i);CHKERRQ(ierr); 4114da9b6338SBarry Smith for (j=-10; j<11; j++) { 4115ccae9161SBarry Smith value = PetscSign(j)*exp(PetscAbs(j)-10.0); 4116da9b6338SBarry Smith ierr = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr); 41173ab0aad5SBarry Smith ierr = SNESComputeFunction(snes,uh,fh);CHKERRQ(ierr); 4118da9b6338SBarry Smith ierr = VecNorm(fh,NORM_2,&norm);CHKERRQ(ierr); 411977431f27SBarry Smith ierr = PetscPrintf(PETSC_COMM_WORLD," j norm %D %18.16e\n",j,norm);CHKERRQ(ierr); 4120da9b6338SBarry Smith value = -value; 4121da9b6338SBarry Smith ierr = VecSetValue(uh,i,value,ADD_VALUES);CHKERRQ(ierr); 4122da9b6338SBarry Smith } 4123da9b6338SBarry Smith } 41246bf464f9SBarry Smith ierr = VecDestroy(&uh);CHKERRQ(ierr); 41256bf464f9SBarry Smith ierr = VecDestroy(&fh);CHKERRQ(ierr); 4126da9b6338SBarry Smith PetscFunctionReturn(0); 4127da9b6338SBarry Smith } 412871f87433Sdalcinl 412971f87433Sdalcinl #undef __FUNCT__ 4130fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetUseEW" 413171f87433Sdalcinl /*@ 4132fa9f3622SBarry Smith SNESKSPSetUseEW - Sets SNES use Eisenstat-Walker method for 413371f87433Sdalcinl computing relative tolerance for linear solvers within an inexact 413471f87433Sdalcinl Newton method. 413571f87433Sdalcinl 41363f9fe445SBarry Smith Logically Collective on SNES 413771f87433Sdalcinl 413871f87433Sdalcinl Input Parameters: 413971f87433Sdalcinl + snes - SNES context 414071f87433Sdalcinl - flag - PETSC_TRUE or PETSC_FALSE 414171f87433Sdalcinl 414264ba62caSBarry Smith Options Database: 414364ba62caSBarry Smith + -snes_ksp_ew - use Eisenstat-Walker method for determining linear system convergence 414464ba62caSBarry Smith . -snes_ksp_ew_version ver - version of Eisenstat-Walker method 414564ba62caSBarry Smith . -snes_ksp_ew_rtol0 <rtol0> - Sets rtol0 414664ba62caSBarry Smith . -snes_ksp_ew_rtolmax <rtolmax> - Sets rtolmax 414764ba62caSBarry Smith . -snes_ksp_ew_gamma <gamma> - Sets gamma 414864ba62caSBarry Smith . -snes_ksp_ew_alpha <alpha> - Sets alpha 414964ba62caSBarry Smith . -snes_ksp_ew_alpha2 <alpha2> - Sets alpha2 415064ba62caSBarry Smith - -snes_ksp_ew_threshold <threshold> - Sets threshold 415164ba62caSBarry Smith 415271f87433Sdalcinl Notes: 415371f87433Sdalcinl Currently, the default is to use a constant relative tolerance for 415471f87433Sdalcinl the inner linear solvers. Alternatively, one can use the 415571f87433Sdalcinl Eisenstat-Walker method, where the relative convergence tolerance 415671f87433Sdalcinl is reset at each Newton iteration according progress of the nonlinear 415771f87433Sdalcinl solver. 415871f87433Sdalcinl 415971f87433Sdalcinl Level: advanced 416071f87433Sdalcinl 416171f87433Sdalcinl Reference: 416271f87433Sdalcinl S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an 416371f87433Sdalcinl inexact Newton method", SISC 17 (1), pp.16-32, 1996. 416471f87433Sdalcinl 416571f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton 416671f87433Sdalcinl 4167fa9f3622SBarry Smith .seealso: SNESKSPGetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW() 416871f87433Sdalcinl @*/ 41697087cfbeSBarry Smith PetscErrorCode SNESKSPSetUseEW(SNES snes,PetscBool flag) 417071f87433Sdalcinl { 417171f87433Sdalcinl PetscFunctionBegin; 41720700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4173acfcf0e5SJed Brown PetscValidLogicalCollectiveBool(snes,flag,2); 417471f87433Sdalcinl snes->ksp_ewconv = flag; 417571f87433Sdalcinl PetscFunctionReturn(0); 417671f87433Sdalcinl } 417771f87433Sdalcinl 417871f87433Sdalcinl #undef __FUNCT__ 4179fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetUseEW" 418071f87433Sdalcinl /*@ 4181fa9f3622SBarry Smith SNESKSPGetUseEW - Gets if SNES is using Eisenstat-Walker method 418271f87433Sdalcinl for computing relative tolerance for linear solvers within an 418371f87433Sdalcinl inexact Newton method. 418471f87433Sdalcinl 418571f87433Sdalcinl Not Collective 418671f87433Sdalcinl 418771f87433Sdalcinl Input Parameter: 418871f87433Sdalcinl . snes - SNES context 418971f87433Sdalcinl 419071f87433Sdalcinl Output Parameter: 419171f87433Sdalcinl . flag - PETSC_TRUE or PETSC_FALSE 419271f87433Sdalcinl 419371f87433Sdalcinl Notes: 419471f87433Sdalcinl Currently, the default is to use a constant relative tolerance for 419571f87433Sdalcinl the inner linear solvers. Alternatively, one can use the 419671f87433Sdalcinl Eisenstat-Walker method, where the relative convergence tolerance 419771f87433Sdalcinl is reset at each Newton iteration according progress of the nonlinear 419871f87433Sdalcinl solver. 419971f87433Sdalcinl 420071f87433Sdalcinl Level: advanced 420171f87433Sdalcinl 420271f87433Sdalcinl Reference: 420371f87433Sdalcinl S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an 420471f87433Sdalcinl inexact Newton method", SISC 17 (1), pp.16-32, 1996. 420571f87433Sdalcinl 420671f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, convergence, test, inexact, Newton 420771f87433Sdalcinl 4208fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetParametersEW(), SNESKSPSetParametersEW() 420971f87433Sdalcinl @*/ 42107087cfbeSBarry Smith PetscErrorCode SNESKSPGetUseEW(SNES snes, PetscBool *flag) 421171f87433Sdalcinl { 421271f87433Sdalcinl PetscFunctionBegin; 42130700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 421471f87433Sdalcinl PetscValidPointer(flag,2); 421571f87433Sdalcinl *flag = snes->ksp_ewconv; 421671f87433Sdalcinl PetscFunctionReturn(0); 421771f87433Sdalcinl } 421871f87433Sdalcinl 421971f87433Sdalcinl #undef __FUNCT__ 4220fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPSetParametersEW" 422171f87433Sdalcinl /*@ 4222fa9f3622SBarry Smith SNESKSPSetParametersEW - Sets parameters for Eisenstat-Walker 422371f87433Sdalcinl convergence criteria for the linear solvers within an inexact 422471f87433Sdalcinl Newton method. 422571f87433Sdalcinl 42263f9fe445SBarry Smith Logically Collective on SNES 422771f87433Sdalcinl 422871f87433Sdalcinl Input Parameters: 422971f87433Sdalcinl + snes - SNES context 423071f87433Sdalcinl . version - version 1, 2 (default is 2) or 3 423171f87433Sdalcinl . rtol_0 - initial relative tolerance (0 <= rtol_0 < 1) 423271f87433Sdalcinl . rtol_max - maximum relative tolerance (0 <= rtol_max < 1) 423371f87433Sdalcinl . gamma - multiplicative factor for version 2 rtol computation 423471f87433Sdalcinl (0 <= gamma2 <= 1) 423571f87433Sdalcinl . alpha - power for version 2 rtol computation (1 < alpha <= 2) 423671f87433Sdalcinl . alpha2 - power for safeguard 423771f87433Sdalcinl - threshold - threshold for imposing safeguard (0 < threshold < 1) 423871f87433Sdalcinl 423971f87433Sdalcinl Note: 424071f87433Sdalcinl Version 3 was contributed by Luis Chacon, June 2006. 424171f87433Sdalcinl 424271f87433Sdalcinl Use PETSC_DEFAULT to retain the default for any of the parameters. 424371f87433Sdalcinl 424471f87433Sdalcinl Level: advanced 424571f87433Sdalcinl 424671f87433Sdalcinl Reference: 424771f87433Sdalcinl S. C. Eisenstat and H. F. Walker, "Choosing the forcing terms in an 424871f87433Sdalcinl inexact Newton method", Utah State University Math. Stat. Dept. Res. 424971f87433Sdalcinl Report 6/94/75, June, 1994, to appear in SIAM J. Sci. Comput. 425071f87433Sdalcinl 425171f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, set, parameters 425271f87433Sdalcinl 4253fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPGetParametersEW() 425471f87433Sdalcinl @*/ 4255f5af7f23SKarl Rupp PetscErrorCode SNESKSPSetParametersEW(SNES snes,PetscInt version,PetscReal rtol_0,PetscReal rtol_max,PetscReal gamma,PetscReal alpha,PetscReal alpha2,PetscReal threshold) 425671f87433Sdalcinl { 4257fa9f3622SBarry Smith SNESKSPEW *kctx; 42585fd66863SKarl Rupp 425971f87433Sdalcinl PetscFunctionBegin; 42600700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4261fa9f3622SBarry Smith kctx = (SNESKSPEW*)snes->kspconvctx; 4262e32f2f54SBarry Smith if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing"); 4263c5eb9154SBarry Smith PetscValidLogicalCollectiveInt(snes,version,2); 4264c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,rtol_0,3); 4265c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,rtol_max,4); 4266c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,gamma,5); 4267c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,alpha,6); 4268c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,alpha2,7); 4269c5eb9154SBarry Smith PetscValidLogicalCollectiveReal(snes,threshold,8); 427071f87433Sdalcinl 427171f87433Sdalcinl if (version != PETSC_DEFAULT) kctx->version = version; 427271f87433Sdalcinl if (rtol_0 != PETSC_DEFAULT) kctx->rtol_0 = rtol_0; 427371f87433Sdalcinl if (rtol_max != PETSC_DEFAULT) kctx->rtol_max = rtol_max; 427471f87433Sdalcinl if (gamma != PETSC_DEFAULT) kctx->gamma = gamma; 427571f87433Sdalcinl if (alpha != PETSC_DEFAULT) kctx->alpha = alpha; 427671f87433Sdalcinl if (alpha2 != PETSC_DEFAULT) kctx->alpha2 = alpha2; 427771f87433Sdalcinl if (threshold != PETSC_DEFAULT) kctx->threshold = threshold; 427871f87433Sdalcinl 4279f23aa3ddSBarry Smith if (kctx->version < 1 || kctx->version > 3) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 and 3 are supported: %D",kctx->version); 4280f23aa3ddSBarry Smith if (kctx->rtol_0 < 0.0 || kctx->rtol_0 >= 1.0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_0 < 1.0: %G",kctx->rtol_0); 4281f23aa3ddSBarry Smith if (kctx->rtol_max < 0.0 || kctx->rtol_max >= 1.0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= rtol_max (%G) < 1.0\n",kctx->rtol_max); 4282f23aa3ddSBarry Smith if (kctx->gamma < 0.0 || kctx->gamma > 1.0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 <= gamma (%G) <= 1.0\n",kctx->gamma); 4283f23aa3ddSBarry Smith if (kctx->alpha <= 1.0 || kctx->alpha > 2.0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"1.0 < alpha (%G) <= 2.0\n",kctx->alpha); 4284f23aa3ddSBarry Smith if (kctx->threshold <= 0.0 || kctx->threshold >= 1.0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"0.0 < threshold (%G) < 1.0\n",kctx->threshold); 428571f87433Sdalcinl PetscFunctionReturn(0); 428671f87433Sdalcinl } 428771f87433Sdalcinl 428871f87433Sdalcinl #undef __FUNCT__ 4289fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPGetParametersEW" 429071f87433Sdalcinl /*@ 4291fa9f3622SBarry Smith SNESKSPGetParametersEW - Gets parameters for Eisenstat-Walker 429271f87433Sdalcinl convergence criteria for the linear solvers within an inexact 429371f87433Sdalcinl Newton method. 429471f87433Sdalcinl 429571f87433Sdalcinl Not Collective 429671f87433Sdalcinl 429771f87433Sdalcinl Input Parameters: 429871f87433Sdalcinl snes - SNES context 429971f87433Sdalcinl 430071f87433Sdalcinl Output Parameters: 430171f87433Sdalcinl + version - version 1, 2 (default is 2) or 3 430271f87433Sdalcinl . rtol_0 - initial relative tolerance (0 <= rtol_0 < 1) 430371f87433Sdalcinl . rtol_max - maximum relative tolerance (0 <= rtol_max < 1) 4304bf388a1fSBarry Smith . gamma - multiplicative factor for version 2 rtol computation (0 <= gamma2 <= 1) 430571f87433Sdalcinl . alpha - power for version 2 rtol computation (1 < alpha <= 2) 430671f87433Sdalcinl . alpha2 - power for safeguard 430771f87433Sdalcinl - threshold - threshold for imposing safeguard (0 < threshold < 1) 430871f87433Sdalcinl 430971f87433Sdalcinl Level: advanced 431071f87433Sdalcinl 431171f87433Sdalcinl .keywords: SNES, KSP, Eisenstat, Walker, get, parameters 431271f87433Sdalcinl 4313fa9f3622SBarry Smith .seealso: SNESKSPSetUseEW(), SNESKSPGetUseEW(), SNESKSPSetParametersEW() 431471f87433Sdalcinl @*/ 4315bf388a1fSBarry Smith PetscErrorCode SNESKSPGetParametersEW(SNES snes,PetscInt *version,PetscReal *rtol_0,PetscReal *rtol_max,PetscReal *gamma,PetscReal *alpha,PetscReal *alpha2,PetscReal *threshold) 431671f87433Sdalcinl { 4317fa9f3622SBarry Smith SNESKSPEW *kctx; 43185fd66863SKarl Rupp 431971f87433Sdalcinl PetscFunctionBegin; 43200700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4321fa9f3622SBarry Smith kctx = (SNESKSPEW*)snes->kspconvctx; 4322e32f2f54SBarry Smith if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context existing"); 432371f87433Sdalcinl if (version) *version = kctx->version; 432471f87433Sdalcinl if (rtol_0) *rtol_0 = kctx->rtol_0; 432571f87433Sdalcinl if (rtol_max) *rtol_max = kctx->rtol_max; 432671f87433Sdalcinl if (gamma) *gamma = kctx->gamma; 432771f87433Sdalcinl if (alpha) *alpha = kctx->alpha; 432871f87433Sdalcinl if (alpha2) *alpha2 = kctx->alpha2; 432971f87433Sdalcinl if (threshold) *threshold = kctx->threshold; 433071f87433Sdalcinl PetscFunctionReturn(0); 433171f87433Sdalcinl } 433271f87433Sdalcinl 433371f87433Sdalcinl #undef __FUNCT__ 4334fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PreSolve" 4335fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PreSolve(SNES snes, KSP ksp, Vec b, Vec x) 433671f87433Sdalcinl { 433771f87433Sdalcinl PetscErrorCode ierr; 4338fa9f3622SBarry Smith SNESKSPEW *kctx = (SNESKSPEW*)snes->kspconvctx; 433971f87433Sdalcinl PetscReal rtol = PETSC_DEFAULT,stol; 434071f87433Sdalcinl 434171f87433Sdalcinl PetscFunctionBegin; 4342e32f2f54SBarry Smith if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists"); 4343f5af7f23SKarl Rupp if (!snes->iter) rtol = kctx->rtol_0; /* first time in, so use the original user rtol */ 4344f5af7f23SKarl Rupp else { 434571f87433Sdalcinl if (kctx->version == 1) { 434671f87433Sdalcinl rtol = (snes->norm - kctx->lresid_last)/kctx->norm_last; 434771f87433Sdalcinl if (rtol < 0.0) rtol = -rtol; 434871f87433Sdalcinl stol = pow(kctx->rtol_last,kctx->alpha2); 434971f87433Sdalcinl if (stol > kctx->threshold) rtol = PetscMax(rtol,stol); 435071f87433Sdalcinl } else if (kctx->version == 2) { 435171f87433Sdalcinl rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha); 435271f87433Sdalcinl stol = kctx->gamma * pow(kctx->rtol_last,kctx->alpha); 435371f87433Sdalcinl if (stol > kctx->threshold) rtol = PetscMax(rtol,stol); 435471f87433Sdalcinl } else if (kctx->version == 3) { /* contributed by Luis Chacon, June 2006. */ 435571f87433Sdalcinl rtol = kctx->gamma * pow(snes->norm/kctx->norm_last,kctx->alpha); 435671f87433Sdalcinl /* safeguard: avoid sharp decrease of rtol */ 435771f87433Sdalcinl stol = kctx->gamma*pow(kctx->rtol_last,kctx->alpha); 435871f87433Sdalcinl stol = PetscMax(rtol,stol); 435971f87433Sdalcinl rtol = PetscMin(kctx->rtol_0,stol); 436071f87433Sdalcinl /* safeguard: avoid oversolving */ 436171f87433Sdalcinl stol = kctx->gamma*(snes->ttol)/snes->norm; 436271f87433Sdalcinl stol = PetscMax(rtol,stol); 436371f87433Sdalcinl rtol = PetscMin(kctx->rtol_0,stol); 4364e32f2f54SBarry Smith } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only versions 1, 2 or 3 are supported: %D",kctx->version); 436571f87433Sdalcinl } 436671f87433Sdalcinl /* safeguard: avoid rtol greater than one */ 436771f87433Sdalcinl rtol = PetscMin(rtol,kctx->rtol_max); 436871f87433Sdalcinl ierr = KSPSetTolerances(ksp,rtol,PETSC_DEFAULT,PETSC_DEFAULT,PETSC_DEFAULT);CHKERRQ(ierr); 436971f87433Sdalcinl ierr = PetscInfo3(snes,"iter %D, Eisenstat-Walker (version %D) KSP rtol=%G\n",snes->iter,kctx->version,rtol);CHKERRQ(ierr); 437071f87433Sdalcinl PetscFunctionReturn(0); 437171f87433Sdalcinl } 437271f87433Sdalcinl 437371f87433Sdalcinl #undef __FUNCT__ 4374fa9f3622SBarry Smith #define __FUNCT__ "SNESKSPEW_PostSolve" 4375fa9f3622SBarry Smith static PetscErrorCode SNESKSPEW_PostSolve(SNES snes, KSP ksp, Vec b, Vec x) 437671f87433Sdalcinl { 437771f87433Sdalcinl PetscErrorCode ierr; 4378fa9f3622SBarry Smith SNESKSPEW *kctx = (SNESKSPEW*)snes->kspconvctx; 437971f87433Sdalcinl PCSide pcside; 438071f87433Sdalcinl Vec lres; 438171f87433Sdalcinl 438271f87433Sdalcinl PetscFunctionBegin; 4383e32f2f54SBarry Smith if (!kctx) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"No Eisenstat-Walker context exists"); 438471f87433Sdalcinl ierr = KSPGetTolerances(ksp,&kctx->rtol_last,0,0,0);CHKERRQ(ierr); 438571f87433Sdalcinl ierr = SNESGetFunctionNorm(snes,&kctx->norm_last);CHKERRQ(ierr); 438671f87433Sdalcinl if (kctx->version == 1) { 4387b037da10SBarry Smith ierr = KSPGetPCSide(ksp,&pcside);CHKERRQ(ierr); 438871f87433Sdalcinl if (pcside == PC_RIGHT) { /* XXX Should we also test KSP_UNPRECONDITIONED_NORM ? */ 438971f87433Sdalcinl /* KSP residual is true linear residual */ 439071f87433Sdalcinl ierr = KSPGetResidualNorm(ksp,&kctx->lresid_last);CHKERRQ(ierr); 439171f87433Sdalcinl } else { 439271f87433Sdalcinl /* KSP residual is preconditioned residual */ 439371f87433Sdalcinl /* compute true linear residual norm */ 439471f87433Sdalcinl ierr = VecDuplicate(b,&lres);CHKERRQ(ierr); 439571f87433Sdalcinl ierr = MatMult(snes->jacobian,x,lres);CHKERRQ(ierr); 439671f87433Sdalcinl ierr = VecAYPX(lres,-1.0,b);CHKERRQ(ierr); 439771f87433Sdalcinl ierr = VecNorm(lres,NORM_2,&kctx->lresid_last);CHKERRQ(ierr); 43986bf464f9SBarry Smith ierr = VecDestroy(&lres);CHKERRQ(ierr); 439971f87433Sdalcinl } 440071f87433Sdalcinl } 440171f87433Sdalcinl PetscFunctionReturn(0); 440271f87433Sdalcinl } 440371f87433Sdalcinl 440471f87433Sdalcinl #undef __FUNCT__ 440571f87433Sdalcinl #define __FUNCT__ "SNES_KSPSolve" 440671f87433Sdalcinl PetscErrorCode SNES_KSPSolve(SNES snes, KSP ksp, Vec b, Vec x) 440771f87433Sdalcinl { 440871f87433Sdalcinl PetscErrorCode ierr; 440971f87433Sdalcinl 441071f87433Sdalcinl PetscFunctionBegin; 4411fa9f3622SBarry Smith if (snes->ksp_ewconv) { ierr = SNESKSPEW_PreSolve(snes,ksp,b,x);CHKERRQ(ierr); } 441271f87433Sdalcinl ierr = KSPSolve(ksp,b,x);CHKERRQ(ierr); 4413fa9f3622SBarry Smith if (snes->ksp_ewconv) { ierr = SNESKSPEW_PostSolve(snes,ksp,b,x);CHKERRQ(ierr); } 441471f87433Sdalcinl PetscFunctionReturn(0); 441571f87433Sdalcinl } 44166c699258SBarry Smith 4417b4615a05SBarry Smith #include <petsc-private/dmimpl.h> 44186c699258SBarry Smith #undef __FUNCT__ 44196c699258SBarry Smith #define __FUNCT__ "SNESSetDM" 44206c699258SBarry Smith /*@ 44216c699258SBarry Smith SNESSetDM - Sets the DM that may be used by some preconditioners 44226c699258SBarry Smith 44233f9fe445SBarry Smith Logically Collective on SNES 44246c699258SBarry Smith 44256c699258SBarry Smith Input Parameters: 44266c699258SBarry Smith + snes - the preconditioner context 44276c699258SBarry Smith - dm - the dm 44286c699258SBarry Smith 44296c699258SBarry Smith Level: intermediate 44306c699258SBarry Smith 44316c699258SBarry Smith .seealso: SNESGetDM(), KSPSetDM(), KSPGetDM() 44326c699258SBarry Smith @*/ 44337087cfbeSBarry Smith PetscErrorCode SNESSetDM(SNES snes,DM dm) 44346c699258SBarry Smith { 44356c699258SBarry Smith PetscErrorCode ierr; 4436345fed2cSBarry Smith KSP ksp; 4437942e3340SBarry Smith DMSNES sdm; 44386c699258SBarry Smith 44396c699258SBarry Smith PetscFunctionBegin; 44400700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4441d0660788SBarry Smith if (dm) {ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);} 4442942e3340SBarry Smith if (snes->dm) { /* Move the DMSNES context over to the new DM unless the new DM already has one */ 4443b4615a05SBarry Smith if (snes->dm->dmsnes && snes->dmAuto && !dm->dmsnes) { 4444942e3340SBarry Smith ierr = DMCopyDMSNES(snes->dm,dm);CHKERRQ(ierr); 4445942e3340SBarry Smith ierr = DMGetDMSNES(snes->dm,&sdm);CHKERRQ(ierr); 4446f5af7f23SKarl Rupp if (sdm->originaldm == snes->dm) sdm->originaldm = dm; /* Grant write privileges to the replacement DM */ 44476cab3a1bSJed Brown } 44486bf464f9SBarry Smith ierr = DMDestroy(&snes->dm);CHKERRQ(ierr); 44496cab3a1bSJed Brown } 44506c699258SBarry Smith snes->dm = dm; 4451116d1032SJed Brown snes->dmAuto = PETSC_FALSE; 4452f5af7f23SKarl Rupp 4453345fed2cSBarry Smith ierr = SNESGetKSP(snes,&ksp);CHKERRQ(ierr); 4454345fed2cSBarry Smith ierr = KSPSetDM(ksp,dm);CHKERRQ(ierr); 4455f22f69f0SBarry Smith ierr = KSPSetDMActive(ksp,PETSC_FALSE);CHKERRQ(ierr); 44562c155ee1SBarry Smith if (snes->pc) { 44572c155ee1SBarry Smith ierr = SNESSetDM(snes->pc, snes->dm);CHKERRQ(ierr); 4458c40d0f55SPeter Brune ierr = SNESSetPCSide(snes,snes->pcside);CHKERRQ(ierr); 44592c155ee1SBarry Smith } 44606c699258SBarry Smith PetscFunctionReturn(0); 44616c699258SBarry Smith } 44626c699258SBarry Smith 44636c699258SBarry Smith #undef __FUNCT__ 44646c699258SBarry Smith #define __FUNCT__ "SNESGetDM" 44656c699258SBarry Smith /*@ 44666c699258SBarry Smith SNESGetDM - Gets the DM that may be used by some preconditioners 44676c699258SBarry Smith 44683f9fe445SBarry Smith Not Collective but DM obtained is parallel on SNES 44696c699258SBarry Smith 44706c699258SBarry Smith Input Parameter: 44716c699258SBarry Smith . snes - the preconditioner context 44726c699258SBarry Smith 44736c699258SBarry Smith Output Parameter: 44746c699258SBarry Smith . dm - the dm 44756c699258SBarry Smith 44766c699258SBarry Smith Level: intermediate 44776c699258SBarry Smith 44786c699258SBarry Smith .seealso: SNESSetDM(), KSPSetDM(), KSPGetDM() 44796c699258SBarry Smith @*/ 44807087cfbeSBarry Smith PetscErrorCode SNESGetDM(SNES snes,DM *dm) 44816c699258SBarry Smith { 44826cab3a1bSJed Brown PetscErrorCode ierr; 44836cab3a1bSJed Brown 44846c699258SBarry Smith PetscFunctionBegin; 44850700a824SBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 44866cab3a1bSJed Brown if (!snes->dm) { 4487*ce94432eSBarry Smith ierr = DMShellCreate(PetscObjectComm((PetscObject)snes),&snes->dm);CHKERRQ(ierr); 4488116d1032SJed Brown snes->dmAuto = PETSC_TRUE; 44896cab3a1bSJed Brown } 44906c699258SBarry Smith *dm = snes->dm; 44916c699258SBarry Smith PetscFunctionReturn(0); 44926c699258SBarry Smith } 44930807856dSBarry Smith 449431823bd8SMatthew G Knepley #undef __FUNCT__ 449531823bd8SMatthew G Knepley #define __FUNCT__ "SNESSetPC" 449631823bd8SMatthew G Knepley /*@ 4497fd4b34e9SJed Brown SNESSetPC - Sets the nonlinear preconditioner to be used. 449831823bd8SMatthew G Knepley 449931823bd8SMatthew G Knepley Collective on SNES 450031823bd8SMatthew G Knepley 450131823bd8SMatthew G Knepley Input Parameters: 450231823bd8SMatthew G Knepley + snes - iterative context obtained from SNESCreate() 450331823bd8SMatthew G Knepley - pc - the preconditioner object 450431823bd8SMatthew G Knepley 450531823bd8SMatthew G Knepley Notes: 450631823bd8SMatthew G Knepley Use SNESGetPC() to retrieve the preconditioner context (for example, 450731823bd8SMatthew G Knepley to configure it using the API). 450831823bd8SMatthew G Knepley 450931823bd8SMatthew G Knepley Level: developer 451031823bd8SMatthew G Knepley 451131823bd8SMatthew G Knepley .keywords: SNES, set, precondition 451231823bd8SMatthew G Knepley .seealso: SNESGetPC() 451331823bd8SMatthew G Knepley @*/ 451431823bd8SMatthew G Knepley PetscErrorCode SNESSetPC(SNES snes, SNES pc) 451531823bd8SMatthew G Knepley { 451631823bd8SMatthew G Knepley PetscErrorCode ierr; 451731823bd8SMatthew G Knepley 451831823bd8SMatthew G Knepley PetscFunctionBegin; 451931823bd8SMatthew G Knepley PetscValidHeaderSpecific(snes, SNES_CLASSID, 1); 452031823bd8SMatthew G Knepley PetscValidHeaderSpecific(pc, SNES_CLASSID, 2); 452131823bd8SMatthew G Knepley PetscCheckSameComm(snes, 1, pc, 2); 452231823bd8SMatthew G Knepley ierr = PetscObjectReference((PetscObject) pc);CHKERRQ(ierr); 4523bf11d3b6SBarry Smith ierr = SNESDestroy(&snes->pc);CHKERRQ(ierr); 452431823bd8SMatthew G Knepley snes->pc = pc; 452531823bd8SMatthew G Knepley ierr = PetscLogObjectParent(snes, snes->pc);CHKERRQ(ierr); 452631823bd8SMatthew G Knepley PetscFunctionReturn(0); 452731823bd8SMatthew G Knepley } 452831823bd8SMatthew G Knepley 452931823bd8SMatthew G Knepley #undef __FUNCT__ 453031823bd8SMatthew G Knepley #define __FUNCT__ "SNESGetPC" 453131823bd8SMatthew G Knepley /*@ 4532fd4b34e9SJed Brown SNESGetPC - Returns a pointer to the nonlinear preconditioning context set with SNESSetPC(). 453331823bd8SMatthew G Knepley 453431823bd8SMatthew G Knepley Not Collective 453531823bd8SMatthew G Knepley 453631823bd8SMatthew G Knepley Input Parameter: 453731823bd8SMatthew G Knepley . snes - iterative context obtained from SNESCreate() 453831823bd8SMatthew G Knepley 453931823bd8SMatthew G Knepley Output Parameter: 454031823bd8SMatthew G Knepley . pc - preconditioner context 454131823bd8SMatthew G Knepley 454231823bd8SMatthew G Knepley Level: developer 454331823bd8SMatthew G Knepley 454431823bd8SMatthew G Knepley .keywords: SNES, get, preconditioner 454531823bd8SMatthew G Knepley .seealso: SNESSetPC() 454631823bd8SMatthew G Knepley @*/ 454731823bd8SMatthew G Knepley PetscErrorCode SNESGetPC(SNES snes, SNES *pc) 454831823bd8SMatthew G Knepley { 454931823bd8SMatthew G Knepley PetscErrorCode ierr; 4550a64e098fSPeter Brune const char *optionsprefix; 455131823bd8SMatthew G Knepley 455231823bd8SMatthew G Knepley PetscFunctionBegin; 455331823bd8SMatthew G Knepley PetscValidHeaderSpecific(snes, SNES_CLASSID, 1); 455431823bd8SMatthew G Knepley PetscValidPointer(pc, 2); 455531823bd8SMatthew G Knepley if (!snes->pc) { 455631823bd8SMatthew G Knepley ierr = SNESCreate(((PetscObject) snes)->comm,&snes->pc);CHKERRQ(ierr); 45574a0c5b0cSMatthew G Knepley ierr = PetscObjectIncrementTabLevel((PetscObject)snes->pc,(PetscObject)snes,1);CHKERRQ(ierr); 455831823bd8SMatthew G Knepley ierr = PetscLogObjectParent(snes,snes->pc);CHKERRQ(ierr); 4559a64e098fSPeter Brune ierr = SNESGetOptionsPrefix(snes,&optionsprefix);CHKERRQ(ierr); 4560a64e098fSPeter Brune ierr = SNESSetOptionsPrefix(snes->pc,optionsprefix);CHKERRQ(ierr); 4561a64e098fSPeter Brune ierr = SNESAppendOptionsPrefix(snes->pc,"npc_");CHKERRQ(ierr); 456231823bd8SMatthew G Knepley } 456331823bd8SMatthew G Knepley *pc = snes->pc; 456431823bd8SMatthew G Knepley PetscFunctionReturn(0); 456531823bd8SMatthew G Knepley } 456631823bd8SMatthew G Knepley 4567c40d0f55SPeter Brune #undef __FUNCT__ 4568c40d0f55SPeter Brune #define __FUNCT__ "SNESSetPCSide" 4569c40d0f55SPeter Brune /*@ 4570c40d0f55SPeter Brune SNESSetPCSide - Sets the preconditioning side. 4571c40d0f55SPeter Brune 4572c40d0f55SPeter Brune Logically Collective on SNES 4573c40d0f55SPeter Brune 4574c40d0f55SPeter Brune Input Parameter: 4575c40d0f55SPeter Brune . snes - iterative context obtained from SNESCreate() 4576c40d0f55SPeter Brune 4577c40d0f55SPeter Brune Output Parameter: 4578c40d0f55SPeter Brune . side - the preconditioning side, where side is one of 4579c40d0f55SPeter Brune .vb 4580c40d0f55SPeter Brune PC_LEFT - left preconditioning (default) 4581c40d0f55SPeter Brune PC_RIGHT - right preconditioning 4582c40d0f55SPeter Brune .ve 4583c40d0f55SPeter Brune 4584c40d0f55SPeter Brune Options Database Keys: 4585c40d0f55SPeter Brune . -snes_pc_side <right,left> 4586c40d0f55SPeter Brune 4587c40d0f55SPeter Brune Level: intermediate 4588c40d0f55SPeter Brune 4589c40d0f55SPeter Brune .keywords: SNES, set, right, left, side, preconditioner, flag 4590c40d0f55SPeter Brune 4591c40d0f55SPeter Brune .seealso: SNESGetPCSide(), KSPSetPCSide() 4592c40d0f55SPeter Brune @*/ 4593c40d0f55SPeter Brune PetscErrorCode SNESSetPCSide(SNES snes,PCSide side) 4594c40d0f55SPeter Brune { 4595c40d0f55SPeter Brune PetscFunctionBegin; 4596c40d0f55SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4597c40d0f55SPeter Brune PetscValidLogicalCollectiveEnum(snes,side,2); 4598c40d0f55SPeter Brune snes->pcside = side; 4599c40d0f55SPeter Brune PetscFunctionReturn(0); 4600c40d0f55SPeter Brune } 4601c40d0f55SPeter Brune 4602c40d0f55SPeter Brune #undef __FUNCT__ 4603c40d0f55SPeter Brune #define __FUNCT__ "SNESGetPCSide" 4604c40d0f55SPeter Brune /*@ 4605c40d0f55SPeter Brune SNESGetPCSide - Gets the preconditioning side. 4606c40d0f55SPeter Brune 4607c40d0f55SPeter Brune Not Collective 4608c40d0f55SPeter Brune 4609c40d0f55SPeter Brune Input Parameter: 4610c40d0f55SPeter Brune . snes - iterative context obtained from SNESCreate() 4611c40d0f55SPeter Brune 4612c40d0f55SPeter Brune Output Parameter: 4613c40d0f55SPeter Brune . side - the preconditioning side, where side is one of 4614c40d0f55SPeter Brune .vb 4615c40d0f55SPeter Brune PC_LEFT - left preconditioning (default) 4616c40d0f55SPeter Brune PC_RIGHT - right preconditioning 4617c40d0f55SPeter Brune .ve 4618c40d0f55SPeter Brune 4619c40d0f55SPeter Brune Level: intermediate 4620c40d0f55SPeter Brune 4621c40d0f55SPeter Brune .keywords: SNES, get, right, left, side, preconditioner, flag 4622c40d0f55SPeter Brune 4623c40d0f55SPeter Brune .seealso: SNESSetPCSide(), KSPGetPCSide() 4624c40d0f55SPeter Brune @*/ 4625c40d0f55SPeter Brune PetscErrorCode SNESGetPCSide(SNES snes,PCSide *side) 4626c40d0f55SPeter Brune { 4627c40d0f55SPeter Brune PetscFunctionBegin; 4628c40d0f55SPeter Brune PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4629c40d0f55SPeter Brune PetscValidPointer(side,2); 4630c40d0f55SPeter Brune *side = snes->pcside; 4631c40d0f55SPeter Brune PetscFunctionReturn(0); 4632c40d0f55SPeter Brune } 4633c40d0f55SPeter Brune 46349e764e56SPeter Brune #undef __FUNCT__ 4635f1c6b773SPeter Brune #define __FUNCT__ "SNESSetSNESLineSearch" 46369e764e56SPeter Brune /*@ 46378141a3b9SPeter Brune SNESSetSNESLineSearch - Sets the linesearch on the SNES instance. 46389e764e56SPeter Brune 46399e764e56SPeter Brune Collective on SNES 46409e764e56SPeter Brune 46419e764e56SPeter Brune Input Parameters: 46429e764e56SPeter Brune + snes - iterative context obtained from SNESCreate() 46439e764e56SPeter Brune - linesearch - the linesearch object 46449e764e56SPeter Brune 46459e764e56SPeter Brune Notes: 4646f1c6b773SPeter Brune Use SNESGetSNESLineSearch() to retrieve the preconditioner context (for example, 46479e764e56SPeter Brune to configure it using the API). 46489e764e56SPeter Brune 46499e764e56SPeter Brune Level: developer 46509e764e56SPeter Brune 46519e764e56SPeter Brune .keywords: SNES, set, linesearch 4652f1c6b773SPeter Brune .seealso: SNESGetSNESLineSearch() 46539e764e56SPeter Brune @*/ 4654f1c6b773SPeter Brune PetscErrorCode SNESSetSNESLineSearch(SNES snes, SNESLineSearch linesearch) 46559e764e56SPeter Brune { 46569e764e56SPeter Brune PetscErrorCode ierr; 46579e764e56SPeter Brune 46589e764e56SPeter Brune PetscFunctionBegin; 46599e764e56SPeter Brune PetscValidHeaderSpecific(snes, SNES_CLASSID, 1); 4660f1c6b773SPeter Brune PetscValidHeaderSpecific(linesearch, SNESLINESEARCH_CLASSID, 2); 46619e764e56SPeter Brune PetscCheckSameComm(snes, 1, linesearch, 2); 46629e764e56SPeter Brune ierr = PetscObjectReference((PetscObject) linesearch);CHKERRQ(ierr); 4663f1c6b773SPeter Brune ierr = SNESLineSearchDestroy(&snes->linesearch);CHKERRQ(ierr); 4664f5af7f23SKarl Rupp 46659e764e56SPeter Brune snes->linesearch = linesearch; 4666f5af7f23SKarl Rupp 46679e764e56SPeter Brune ierr = PetscLogObjectParent(snes, snes->linesearch);CHKERRQ(ierr); 46689e764e56SPeter Brune PetscFunctionReturn(0); 46699e764e56SPeter Brune } 46709e764e56SPeter Brune 46719e764e56SPeter Brune #undef __FUNCT__ 4672f1c6b773SPeter Brune #define __FUNCT__ "SNESGetSNESLineSearch" 4673ea5d4fccSPeter Brune /*@C 46748141a3b9SPeter Brune SNESGetSNESLineSearch - Returns a pointer to the line search context set with SNESSetLineSearch() 46758141a3b9SPeter Brune or creates a default line search instance associated with the SNES and returns it. 46769e764e56SPeter Brune 46779e764e56SPeter Brune Not Collective 46789e764e56SPeter Brune 46799e764e56SPeter Brune Input Parameter: 46809e764e56SPeter Brune . snes - iterative context obtained from SNESCreate() 46819e764e56SPeter Brune 46829e764e56SPeter Brune Output Parameter: 46839e764e56SPeter Brune . linesearch - linesearch context 46849e764e56SPeter Brune 46859e764e56SPeter Brune Level: developer 46869e764e56SPeter Brune 46879e764e56SPeter Brune .keywords: SNES, get, linesearch 4688f1c6b773SPeter Brune .seealso: SNESSetSNESLineSearch() 46899e764e56SPeter Brune @*/ 4690f1c6b773SPeter Brune PetscErrorCode SNESGetSNESLineSearch(SNES snes, SNESLineSearch *linesearch) 46919e764e56SPeter Brune { 46929e764e56SPeter Brune PetscErrorCode ierr; 46939e764e56SPeter Brune const char *optionsprefix; 46949e764e56SPeter Brune 46959e764e56SPeter Brune PetscFunctionBegin; 46969e764e56SPeter Brune PetscValidHeaderSpecific(snes, SNES_CLASSID, 1); 46979e764e56SPeter Brune PetscValidPointer(linesearch, 2); 46989e764e56SPeter Brune if (!snes->linesearch) { 46999e764e56SPeter Brune ierr = SNESGetOptionsPrefix(snes, &optionsprefix);CHKERRQ(ierr); 4700f1c6b773SPeter Brune ierr = SNESLineSearchCreate(((PetscObject) snes)->comm, &snes->linesearch);CHKERRQ(ierr); 4701f1c6b773SPeter Brune ierr = SNESLineSearchSetSNES(snes->linesearch, snes);CHKERRQ(ierr); 4702b1dca40bSPeter Brune ierr = SNESLineSearchAppendOptionsPrefix(snes->linesearch, optionsprefix);CHKERRQ(ierr); 47039e764e56SPeter Brune ierr = PetscObjectIncrementTabLevel((PetscObject) snes->linesearch, (PetscObject) snes, 1);CHKERRQ(ierr); 47049e764e56SPeter Brune ierr = PetscLogObjectParent(snes, snes->linesearch);CHKERRQ(ierr); 47059e764e56SPeter Brune } 47069e764e56SPeter Brune *linesearch = snes->linesearch; 47079e764e56SPeter Brune PetscFunctionReturn(0); 47089e764e56SPeter Brune } 47099e764e56SPeter Brune 471069b4f73cSBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE) 4711c6db04a5SJed Brown #include <mex.h> 471269b4f73cSBarry Smith 47138f6e6473SBarry Smith typedef struct {char *funcname; mxArray *ctx;} SNESMatlabContext; 47148f6e6473SBarry Smith 47150807856dSBarry Smith #undef __FUNCT__ 47160807856dSBarry Smith #define __FUNCT__ "SNESComputeFunction_Matlab" 47170807856dSBarry Smith /* 4718bf388a1fSBarry Smith SNESComputeFunction_Matlab - Calls the function that has been set with SNESSetFunctionMatlab(). 47190807856dSBarry Smith 47200807856dSBarry Smith Collective on SNES 47210807856dSBarry Smith 47220807856dSBarry Smith Input Parameters: 47230807856dSBarry Smith + snes - the SNES context 47240807856dSBarry Smith - x - input vector 47250807856dSBarry Smith 47260807856dSBarry Smith Output Parameter: 47270807856dSBarry Smith . y - function vector, as set by SNESSetFunction() 47280807856dSBarry Smith 47290807856dSBarry Smith Notes: 47300807856dSBarry Smith SNESComputeFunction() is typically used within nonlinear solvers 47310807856dSBarry Smith implementations, so most users would not generally call this routine 47320807856dSBarry Smith themselves. 47330807856dSBarry Smith 47340807856dSBarry Smith Level: developer 47350807856dSBarry Smith 47360807856dSBarry Smith .keywords: SNES, nonlinear, compute, function 47370807856dSBarry Smith 47380807856dSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction() 473961b2408cSBarry Smith */ 47407087cfbeSBarry Smith PetscErrorCode SNESComputeFunction_Matlab(SNES snes,Vec x,Vec y, void *ctx) 47410807856dSBarry Smith { 4742e650e774SBarry Smith PetscErrorCode ierr; 47438f6e6473SBarry Smith SNESMatlabContext *sctx = (SNESMatlabContext*)ctx; 47448f6e6473SBarry Smith int nlhs = 1,nrhs = 5; 47458f6e6473SBarry Smith mxArray *plhs[1],*prhs[5]; 474691621f2eSBarry Smith long long int lx = 0,ly = 0,ls = 0; 4747e650e774SBarry Smith 47480807856dSBarry Smith PetscFunctionBegin; 47490807856dSBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 47500807856dSBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,2); 47510807856dSBarry Smith PetscValidHeaderSpecific(y,VEC_CLASSID,3); 47520807856dSBarry Smith PetscCheckSameComm(snes,1,x,2); 47530807856dSBarry Smith PetscCheckSameComm(snes,1,y,3); 47540807856dSBarry Smith 47550807856dSBarry Smith /* call Matlab function in ctx with arguments x and y */ 4756e650e774SBarry Smith 475791621f2eSBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 4758e650e774SBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 4759e650e774SBarry Smith ierr = PetscMemcpy(&ly,&y,sizeof(x));CHKERRQ(ierr); 476091621f2eSBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 476191621f2eSBarry Smith prhs[1] = mxCreateDoubleScalar((double)lx); 476291621f2eSBarry Smith prhs[2] = mxCreateDoubleScalar((double)ly); 47638f6e6473SBarry Smith prhs[3] = mxCreateString(sctx->funcname); 47648f6e6473SBarry Smith prhs[4] = sctx->ctx; 4765b807a863SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeFunctionInternal");CHKERRQ(ierr); 4766e650e774SBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4767e650e774SBarry Smith mxDestroyArray(prhs[0]); 4768e650e774SBarry Smith mxDestroyArray(prhs[1]); 4769e650e774SBarry Smith mxDestroyArray(prhs[2]); 47708f6e6473SBarry Smith mxDestroyArray(prhs[3]); 4771e650e774SBarry Smith mxDestroyArray(plhs[0]); 47720807856dSBarry Smith PetscFunctionReturn(0); 47730807856dSBarry Smith } 47740807856dSBarry Smith 47750807856dSBarry Smith #undef __FUNCT__ 47760807856dSBarry Smith #define __FUNCT__ "SNESSetFunctionMatlab" 477761b2408cSBarry Smith /* 47780807856dSBarry Smith SNESSetFunctionMatlab - Sets the function evaluation routine and function 47790807856dSBarry Smith vector for use by the SNES routines in solving systems of nonlinear 4780e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 47810807856dSBarry Smith 47820807856dSBarry Smith Logically Collective on SNES 47830807856dSBarry Smith 47840807856dSBarry Smith Input Parameters: 47850807856dSBarry Smith + snes - the SNES context 47860807856dSBarry Smith . r - vector to store function value 4787bf388a1fSBarry Smith - SNESFunction - function evaluation routine 47880807856dSBarry Smith 47890807856dSBarry Smith Notes: 47900807856dSBarry Smith The Newton-like methods typically solve linear systems of the form 47910807856dSBarry Smith $ f'(x) x = -f(x), 47920807856dSBarry Smith where f'(x) denotes the Jacobian matrix and f(x) is the function. 47930807856dSBarry Smith 47940807856dSBarry Smith Level: beginner 47950807856dSBarry Smith 47960807856dSBarry Smith .keywords: SNES, nonlinear, set, function 47970807856dSBarry Smith 47980807856dSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction() 479961b2408cSBarry Smith */ 4800bf388a1fSBarry Smith PetscErrorCode SNESSetFunctionMatlab(SNES snes,Vec r,const char *SNESFunction,mxArray *ctx) 48010807856dSBarry Smith { 48020807856dSBarry Smith PetscErrorCode ierr; 48038f6e6473SBarry Smith SNESMatlabContext *sctx; 48040807856dSBarry Smith 48050807856dSBarry Smith PetscFunctionBegin; 48068f6e6473SBarry Smith /* currently sctx is memory bleed */ 48078f6e6473SBarry Smith ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr); 4808bf388a1fSBarry Smith ierr = PetscStrallocpy(SNESFunction,&sctx->funcname);CHKERRQ(ierr); 48098f6e6473SBarry Smith /* 48108f6e6473SBarry Smith This should work, but it doesn't 48118f6e6473SBarry Smith sctx->ctx = ctx; 48128f6e6473SBarry Smith mexMakeArrayPersistent(sctx->ctx); 48138f6e6473SBarry Smith */ 48148f6e6473SBarry Smith sctx->ctx = mxDuplicateArray(ctx); 48158f6e6473SBarry Smith ierr = SNESSetFunction(snes,r,SNESComputeFunction_Matlab,sctx);CHKERRQ(ierr); 48160807856dSBarry Smith PetscFunctionReturn(0); 48170807856dSBarry Smith } 481869b4f73cSBarry Smith 481961b2408cSBarry Smith #undef __FUNCT__ 482061b2408cSBarry Smith #define __FUNCT__ "SNESComputeJacobian_Matlab" 482161b2408cSBarry Smith /* 4822bf388a1fSBarry Smith SNESComputeJacobian_Matlab - Calls the function that has been set with SNESSetJacobianMatlab(). 482361b2408cSBarry Smith 482461b2408cSBarry Smith Collective on SNES 482561b2408cSBarry Smith 482661b2408cSBarry Smith Input Parameters: 482761b2408cSBarry Smith + snes - the SNES context 482861b2408cSBarry Smith . x - input vector 482961b2408cSBarry Smith . A, B - the matrices 483061b2408cSBarry Smith - ctx - user context 483161b2408cSBarry Smith 483261b2408cSBarry Smith Output Parameter: 483361b2408cSBarry Smith . flag - structure of the matrix 483461b2408cSBarry Smith 483561b2408cSBarry Smith Level: developer 483661b2408cSBarry Smith 483761b2408cSBarry Smith .keywords: SNES, nonlinear, compute, function 483861b2408cSBarry Smith 483961b2408cSBarry Smith .seealso: SNESSetFunction(), SNESGetFunction() 484061b2408cSBarry Smith @*/ 48417087cfbeSBarry Smith PetscErrorCode SNESComputeJacobian_Matlab(SNES snes,Vec x,Mat *A,Mat *B,MatStructure *flag, void *ctx) 484261b2408cSBarry Smith { 484361b2408cSBarry Smith PetscErrorCode ierr; 484461b2408cSBarry Smith SNESMatlabContext *sctx = (SNESMatlabContext*)ctx; 484561b2408cSBarry Smith int nlhs = 2,nrhs = 6; 484661b2408cSBarry Smith mxArray *plhs[2],*prhs[6]; 484761b2408cSBarry Smith long long int lx = 0,lA = 0,ls = 0, lB = 0; 484861b2408cSBarry Smith 484961b2408cSBarry Smith PetscFunctionBegin; 485061b2408cSBarry Smith PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 485161b2408cSBarry Smith PetscValidHeaderSpecific(x,VEC_CLASSID,2); 485261b2408cSBarry Smith 485361b2408cSBarry Smith /* call Matlab function in ctx with arguments x and y */ 485461b2408cSBarry Smith 485561b2408cSBarry Smith ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 485661b2408cSBarry Smith ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 485761b2408cSBarry Smith ierr = PetscMemcpy(&lA,A,sizeof(x));CHKERRQ(ierr); 485861b2408cSBarry Smith ierr = PetscMemcpy(&lB,B,sizeof(x));CHKERRQ(ierr); 485961b2408cSBarry Smith prhs[0] = mxCreateDoubleScalar((double)ls); 486061b2408cSBarry Smith prhs[1] = mxCreateDoubleScalar((double)lx); 486161b2408cSBarry Smith prhs[2] = mxCreateDoubleScalar((double)lA); 486261b2408cSBarry Smith prhs[3] = mxCreateDoubleScalar((double)lB); 486361b2408cSBarry Smith prhs[4] = mxCreateString(sctx->funcname); 486461b2408cSBarry Smith prhs[5] = sctx->ctx; 4865b807a863SBarry Smith ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESComputeJacobianInternal");CHKERRQ(ierr); 486661b2408cSBarry Smith ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 486761b2408cSBarry Smith *flag = (MatStructure) mxGetScalar(plhs[1]);CHKERRQ(ierr); 486861b2408cSBarry Smith mxDestroyArray(prhs[0]); 486961b2408cSBarry Smith mxDestroyArray(prhs[1]); 487061b2408cSBarry Smith mxDestroyArray(prhs[2]); 487161b2408cSBarry Smith mxDestroyArray(prhs[3]); 487261b2408cSBarry Smith mxDestroyArray(prhs[4]); 487361b2408cSBarry Smith mxDestroyArray(plhs[0]); 487461b2408cSBarry Smith mxDestroyArray(plhs[1]); 487561b2408cSBarry Smith PetscFunctionReturn(0); 487661b2408cSBarry Smith } 487761b2408cSBarry Smith 487861b2408cSBarry Smith #undef __FUNCT__ 487961b2408cSBarry Smith #define __FUNCT__ "SNESSetJacobianMatlab" 488061b2408cSBarry Smith /* 488161b2408cSBarry Smith SNESSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices 488261b2408cSBarry Smith vector for use by the SNES routines in solving systems of nonlinear 4883e3c5b3baSBarry Smith equations from MATLAB. Here the function is a string containing the name of a MATLAB function 488461b2408cSBarry Smith 488561b2408cSBarry Smith Logically Collective on SNES 488661b2408cSBarry Smith 488761b2408cSBarry Smith Input Parameters: 488861b2408cSBarry Smith + snes - the SNES context 488961b2408cSBarry Smith . A,B - Jacobian matrices 4890bf388a1fSBarry Smith . SNESJacobianFunction - function evaluation routine 489161b2408cSBarry Smith - ctx - user context 489261b2408cSBarry Smith 489361b2408cSBarry Smith Level: developer 489461b2408cSBarry Smith 489561b2408cSBarry Smith .keywords: SNES, nonlinear, set, function 489661b2408cSBarry Smith 4897bf388a1fSBarry Smith .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction(), SNESJacobianFunction 489861b2408cSBarry Smith */ 4899bf388a1fSBarry Smith PetscErrorCode SNESSetJacobianMatlab(SNES snes,Mat A,Mat B,const char *SNESJacobianFunction,mxArray *ctx) 490061b2408cSBarry Smith { 490161b2408cSBarry Smith PetscErrorCode ierr; 490261b2408cSBarry Smith SNESMatlabContext *sctx; 490361b2408cSBarry Smith 490461b2408cSBarry Smith PetscFunctionBegin; 490561b2408cSBarry Smith /* currently sctx is memory bleed */ 490661b2408cSBarry Smith ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr); 4907bf388a1fSBarry Smith ierr = PetscStrallocpy(SNESJacobianFunction,&sctx->funcname);CHKERRQ(ierr); 490861b2408cSBarry Smith /* 490961b2408cSBarry Smith This should work, but it doesn't 491061b2408cSBarry Smith sctx->ctx = ctx; 491161b2408cSBarry Smith mexMakeArrayPersistent(sctx->ctx); 491261b2408cSBarry Smith */ 491361b2408cSBarry Smith sctx->ctx = mxDuplicateArray(ctx); 491461b2408cSBarry Smith ierr = SNESSetJacobian(snes,A,B,SNESComputeJacobian_Matlab,sctx);CHKERRQ(ierr); 491561b2408cSBarry Smith PetscFunctionReturn(0); 491661b2408cSBarry Smith } 491769b4f73cSBarry Smith 4918f9eb7ae2SShri Abhyankar #undef __FUNCT__ 4919f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitor_Matlab" 4920f9eb7ae2SShri Abhyankar /* 4921f9eb7ae2SShri Abhyankar SNESMonitor_Matlab - Calls the function that has been set with SNESMonitorSetMatlab(). 4922f9eb7ae2SShri Abhyankar 4923f9eb7ae2SShri Abhyankar Collective on SNES 4924f9eb7ae2SShri Abhyankar 4925f9eb7ae2SShri Abhyankar .seealso: SNESSetFunction(), SNESGetFunction() 4926f9eb7ae2SShri Abhyankar @*/ 49277087cfbeSBarry Smith PetscErrorCode SNESMonitor_Matlab(SNES snes,PetscInt it, PetscReal fnorm, void *ctx) 4928f9eb7ae2SShri Abhyankar { 4929f9eb7ae2SShri Abhyankar PetscErrorCode ierr; 493048f37e70SShri Abhyankar SNESMatlabContext *sctx = (SNESMatlabContext*)ctx; 4931f9eb7ae2SShri Abhyankar int nlhs = 1,nrhs = 6; 4932f9eb7ae2SShri Abhyankar mxArray *plhs[1],*prhs[6]; 4933f9eb7ae2SShri Abhyankar long long int lx = 0,ls = 0; 4934f9eb7ae2SShri Abhyankar Vec x = snes->vec_sol; 4935f9eb7ae2SShri Abhyankar 4936f9eb7ae2SShri Abhyankar PetscFunctionBegin; 4937f9eb7ae2SShri Abhyankar PetscValidHeaderSpecific(snes,SNES_CLASSID,1); 4938f9eb7ae2SShri Abhyankar 4939f9eb7ae2SShri Abhyankar ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr); 4940f9eb7ae2SShri Abhyankar ierr = PetscMemcpy(&lx,&x,sizeof(x));CHKERRQ(ierr); 4941f9eb7ae2SShri Abhyankar prhs[0] = mxCreateDoubleScalar((double)ls); 4942f9eb7ae2SShri Abhyankar prhs[1] = mxCreateDoubleScalar((double)it); 4943f9eb7ae2SShri Abhyankar prhs[2] = mxCreateDoubleScalar((double)fnorm); 4944f9eb7ae2SShri Abhyankar prhs[3] = mxCreateDoubleScalar((double)lx); 4945f9eb7ae2SShri Abhyankar prhs[4] = mxCreateString(sctx->funcname); 4946f9eb7ae2SShri Abhyankar prhs[5] = sctx->ctx; 4947f9eb7ae2SShri Abhyankar ierr = mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscSNESMonitorInternal");CHKERRQ(ierr); 4948f9eb7ae2SShri Abhyankar ierr = mxGetScalar(plhs[0]);CHKERRQ(ierr); 4949f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[0]); 4950f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[1]); 4951f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[2]); 4952f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[3]); 4953f9eb7ae2SShri Abhyankar mxDestroyArray(prhs[4]); 4954f9eb7ae2SShri Abhyankar mxDestroyArray(plhs[0]); 4955f9eb7ae2SShri Abhyankar PetscFunctionReturn(0); 4956f9eb7ae2SShri Abhyankar } 4957f9eb7ae2SShri Abhyankar 4958f9eb7ae2SShri Abhyankar #undef __FUNCT__ 4959f9eb7ae2SShri Abhyankar #define __FUNCT__ "SNESMonitorSetMatlab" 4960f9eb7ae2SShri Abhyankar /* 4961e3c5b3baSBarry Smith SNESMonitorSetMatlab - Sets the monitor function from MATLAB 4962f9eb7ae2SShri Abhyankar 4963f9eb7ae2SShri Abhyankar Level: developer 4964f9eb7ae2SShri Abhyankar 4965f9eb7ae2SShri Abhyankar .keywords: SNES, nonlinear, set, function 4966f9eb7ae2SShri Abhyankar 4967f9eb7ae2SShri Abhyankar .seealso: SNESGetFunction(), SNESComputeFunction(), SNESSetJacobian(), SNESSetFunction() 4968f9eb7ae2SShri Abhyankar */ 4969bf388a1fSBarry Smith PetscErrorCode SNESMonitorSetMatlab(SNES snes,const char *SNESMonitorFunction,mxArray *ctx) 4970f9eb7ae2SShri Abhyankar { 4971f9eb7ae2SShri Abhyankar PetscErrorCode ierr; 4972f9eb7ae2SShri Abhyankar SNESMatlabContext *sctx; 4973f9eb7ae2SShri Abhyankar 4974f9eb7ae2SShri Abhyankar PetscFunctionBegin; 4975f9eb7ae2SShri Abhyankar /* currently sctx is memory bleed */ 4976f9eb7ae2SShri Abhyankar ierr = PetscMalloc(sizeof(SNESMatlabContext),&sctx);CHKERRQ(ierr); 4977bf388a1fSBarry Smith ierr = PetscStrallocpy(SNESMonitorFunction,&sctx->funcname);CHKERRQ(ierr); 4978f9eb7ae2SShri Abhyankar /* 4979f9eb7ae2SShri Abhyankar This should work, but it doesn't 4980f9eb7ae2SShri Abhyankar sctx->ctx = ctx; 4981f9eb7ae2SShri Abhyankar mexMakeArrayPersistent(sctx->ctx); 4982f9eb7ae2SShri Abhyankar */ 4983f9eb7ae2SShri Abhyankar sctx->ctx = mxDuplicateArray(ctx); 49840298fd71SBarry Smith ierr = SNESMonitorSet(snes,SNESMonitor_Matlab,sctx,NULL);CHKERRQ(ierr); 4985f9eb7ae2SShri Abhyankar PetscFunctionReturn(0); 4986f9eb7ae2SShri Abhyankar } 4987f9eb7ae2SShri Abhyankar 498869b4f73cSBarry Smith #endif 4989